Compute Library
 20.11
ILut.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2019 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_ILUT_H
25 #define ARM_COMPUTE_ILUT_H
26 
27 #include "arm_compute/core/Types.h"
28 
29 #include <cstddef>
30 
31 namespace arm_compute
32 {
33 /** Lookup Table object interface. */
34 class ILut
35 {
36 public:
37  /** Default virtual destructor */
38  virtual ~ILut() = default;
39  /** Returns the total number of elements in the LUT.
40  *
41  * @return Total number of elements.
42  */
43  virtual size_t num_elements() const = 0;
44  /** Indicates the offset that needs to be applied to the raw index before performing a lookup in the LUT.
45  *
46  * @return The normalization offset.
47  */
48  virtual uint32_t index_offset() const = 0;
49  /** Returns the total size in bytes of the LUT.
50  *
51  * @return Total size of the LUT in bytes.
52  */
53  virtual size_t size_in_bytes() const = 0;
54  /** Returns the type of the LUT.
55  *
56  * @return The type of the LUT.
57  */
58  virtual DataType type() const = 0;
59  /** Returns a pointer to the start of the LUT.
60  * Other elements of the LUT can be accessed using buffer()[idx] for 0 <= idx < num_elements().
61  *
62  * @return Pointer to the start of the lut.
63  */
64  virtual uint8_t *buffer() const = 0;
65  /** Clears the LUT by setting every element to zero. */
66  virtual void clear() = 0;
67 };
68 }
69 #endif /* ARM_COMPUTE_ILUT_H */
virtual ~ILut()=default
Default virtual destructor.
virtual size_t size_in_bytes() const =0
Returns the total size in bytes of the LUT.
virtual size_t num_elements() const =0
Returns the total number of elements in the LUT.
Copyright (c) 2017-2020 Arm Limited.
Lookup Table object interface.
Definition: ILut.h:34
virtual void clear()=0
Clears the LUT by setting every element to zero.
virtual uint32_t index_offset() const =0
Indicates the offset that needs to be applied to the raw index before performing a lookup in the LUT.
virtual DataType type() const =0
Returns the type of the LUT.
virtual uint8_t * buffer() const =0
Returns a pointer to the start of the LUT.
DataType
Available data types.
Definition: Types.h:77