arm_compute/runtime/Lut.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_LUT_H__
  25 #define __ARM_COMPUTE_LUT_H__
  26
  27 #include "arm_compute/core/ILut.h"
  28 #include "arm_compute/core/Types.h"
  29 #include "arm_compute/runtime/LutAllocator.h"
  30
  31 #include <cstddef>
  32 #include <cstdint>
  33
  34 namespace arm_compute
  35 {
  36 class ILutAllocator;
  37
  38 /** Basic implementation of the LUT interface */
  39 class Lut : public ILut
  40 {
  41 public:
  42     /** Constructor */
  43     Lut();
  44     /** Constructor: initializes a LUT which can contain num_values values of data_type type.
  45      *
  46      * @param[in] num_elements Number of elements of the LUT.
  47      * @param[in] data_type    Data type of each element.
  48      */
  49     Lut(size_t num_elements, DataType data_type);
  50     /** Return a pointer to the lut's allocator
  51      *
  52      * @return A pointer to the lut's allocator
  53      */
  54     ILutAllocator *allocator();
  55
  56     // Inherited methods overridden:
  57     size_t   num_elements() const override;
  58     uint32_t index_offset() const override;
  59     size_t   size_in_bytes() const override;
  60     DataType type() const override;
  61     uint8_t *buffer() const override;
  62     void     clear() override;
  63
  64 private:
  65     LutAllocator _allocator; /**< Instance of the basic CPU allocator.*/
  66 };
  67 }
  68 #endif /* __ARM_COMPUTE_LUT_H__ */