Compute Library
 21.02
CLLutAccessor.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_TEST_CL_CLLUTACCESSOR_H
25 #define ARM_COMPUTE_TEST_CL_CLLUTACCESSOR_H
26 
27 #include "tests/ILutAccessor.h"
28 
30 
31 namespace arm_compute
32 {
33 namespace test
34 {
35 /** Accessor implementation for @ref CLLut objects. */
36 template <typename T>
37 class CLLutAccessor : public ILutAccessor<T>
38 {
39 public:
40  /** Create an accessor for the given @p CLLut.
41  */
43  : _lut{ lut }
44  {
45  _lut.map(true);
46  }
47  /** Default destructor */
49  {
50  _lut.unmap();
51  }
52 
53  /** Prevent instances of this class from being copy constructed */
54  CLLutAccessor(const CLLutAccessor &) = delete;
55  /** Prevent instances of this class from being copied */
56  CLLutAccessor &operator=(const CLLutAccessor &) = delete;
57  /** Allow instances of this class to be move constructed */
58  CLLutAccessor(CLLutAccessor &&) = default;
59  /** Allow instance of this class to be moved */
60  CLLutAccessor &operator=(CLLutAccessor &&) = default;
61 
62  int num_elements() const override
63  {
64  return _lut.num_elements();
65  }
66 
67  const T &operator[](T input_value) const override
68  {
69  auto lut = reinterpret_cast<T *>(_lut.buffer());
70  int32_t real_index = _lut.index_offset() + static_cast<int32_t>(input_value);
71 
72  if(0 <= real_index && real_index < num_elements())
73  {
74  return lut[real_index];
75  }
76  ARM_COMPUTE_ERROR("Error index not in range.");
77  }
78 
79  T &operator[](T input_value) override
80  {
81  auto lut = reinterpret_cast<T *>(_lut.buffer());
82  int32_t real_index = _lut.index_offset() + static_cast<int32_t>(input_value);
83 
84  if(0 <= real_index && real_index < num_elements())
85  {
86  return lut[real_index];
87  }
88  ARM_COMPUTE_ERROR("Error index not in range.");
89  }
90 
91 private:
92  CLLut &_lut;
93 };
94 } // namespace test
95 } // namespace arm_compute
96 #endif /* ARM_COMPUTE_TEST_CL_CLLUTACCESSOR_H */
~CLLutAccessor()
Default destructor.
Definition: CLLutAccessor.h:48
const T & operator[](T input_value) const override
Read access to the specified element.
Definition: CLLutAccessor.h:67
size_t num_elements() const override
Returns the total number of elements in the LUT.
Definition: CLLut.cpp:43
#define ARM_COMPUTE_ERROR(msg)
Print the given message then throw an std::runtime_error.
Definition: Error.h:352
void unmap()
Enqueue an unmap operation of the allocated and mapped buffer.
Definition: CLLut.cpp:86
uint32_t index_offset() const override
Indicates the offset that needs to be applied to the raw index before performing a lookup in the LUT...
Definition: CLLut.cpp:48
Copyright (c) 2017-2021 Arm Limited.
Accessor implementation for CLLut objects.
Definition: CLLutAccessor.h:37
int num_elements() const override
Number of elements of the Lut.
Definition: CLLutAccessor.h:62
T & operator[](T input_value) override
Write access to the specified element.
Definition: CLLutAccessor.h:79
uint8_t * buffer() const override
Returns a pointer to the start of the LUT.
Definition: ICLLut.cpp:44
CLLutAccessor(CLLut &lut)
Create an accessor for the given CLLut.
Definition: CLLutAccessor.h:42
Basic implementation of the OpenCL lut interface.
Definition: CLLut.h:40
CLLutAccessor & operator=(const CLLutAccessor &)=delete
Prevent instances of this class from being copied.
void map(bool blocking=true)
Enqueue a map operation of the allocated buffer.
Definition: CLLut.cpp:81
Common interface to provide information and access to Lut like structures.
Definition: ILutAccessor.h:38