arm_compute/runtime/Distribution1D.h

   1 /*
   2  * Copyright (c) 2016, 2017 ARM Limited.
   3  *
   4  * SPDX-License-Identifier: MIT
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to
   8  * deal in the Software without restriction, including without limitation the
   9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24 #ifndef __ARM_COMPUTE_DISTRIBUTION1D_H__
  25 #define __ARM_COMPUTE_DISTRIBUTION1D_H__
  26
  27 #include "arm_compute/core/IDistribution1D.h"
  28
  29 #include <cstddef>
  30 #include <cstdint>
  31 #include <memory>
  32
  33 namespace arm_compute
  34 {
  35 /** Basic implementation of the 1D distribution interface */
  36 class Distribution1D : public IDistribution1D
  37 {
  38 public:
  39     /** Constructor: Creates a 1D Distribution of a consecutive interval [offset, offset + range - 1]
  40      *               defined by a start offset and valid range, divided equally into num_bins parts.
  41      *
  42      * @param[in] num_bins The number of bins the distribution is divided in.
  43      * @param[in] offset   The start of the values to use.
  44      * @param[in] range    The total number of the consecutive values of the distribution interval.
  45      */
  46     Distribution1D(size_t num_bins, int32_t offset, uint32_t range);
  47
  48     // Inherited methods overridden:
  49     uint32_t *buffer() const override;
  50
  51 private:
  52     std::unique_ptr<uint32_t[]> _data; /**< The distribution data. */
  53 };
  54 }
  55 #endif /* __ARM_COMPUTE_DISTRIBUTION1D_H__ */