xref: /aosp_15_r20/external/ComputeLibrary/tests/CL/CLArrayAccessor.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_CLARRAYACCESSOR_H
25 #define ARM_COMPUTE_TEST_CLARRAYACCESSOR_H
26 
27 #include "arm_compute/runtime/CL/CLArray.h"
28 #include "tests/IArrayAccessor.h"
29 
30 namespace arm_compute
31 {
32 namespace test
33 {
34 /** Accessor implementation for @ref CLArray objects. */
35 template <typename T>
36 class CLArrayAccessor : public IArrayAccessor<T>
37 {
38 public:
39     /** Create an accessor for the given @p array.
40      *
41      * @param[in, out] array To be accessed array.
42      *
43      * @note The CL memory is mapped by the constructor.
44      *
45      */
CLArrayAccessor(CLArray<T> & array)46     CLArrayAccessor(CLArray<T> &array)
47         : _array{ array }
48     {
49         _array.map();
50     }
51 
52     /** Prevent instances of this class from being copy constructed */
53     CLArrayAccessor(const CLArrayAccessor &) = delete;
54     /** Prevent instances of this class from being copied */
55     CLArrayAccessor &operator=(const CLArrayAccessor &) = delete;
56     /** Allow instances of this class to be move constructed */
57     CLArrayAccessor(CLArrayAccessor &&) = default;
58     /** Allow instances of this class to be moved */
59     CLArrayAccessor &operator=(CLArrayAccessor &&) = default;
60 
61     /** Destructor that unmaps the CL memory. */
~CLArrayAccessor()62     ~CLArrayAccessor()
63     {
64         _array.unmap();
65     }
66 
num_values()67     size_t num_values() const override
68     {
69         return _array.num_values();
70     }
71 
buffer()72     T *buffer() override
73     {
74         return _array.buffer();
75     }
76 
resize(size_t num)77     void resize(size_t num) override
78     {
79         _array.resize(num);
80     }
81 
at(size_t index)82     T &at(size_t index) const override
83     {
84         ARM_COMPUTE_ERROR_ON(_array.buffer() == nullptr);
85         ARM_COMPUTE_ERROR_ON(index >= num_values());
86         return _array.buffer()[index];
87     }
88 
89 private:
90     CLArray<T> &_array;
91 };
92 } // namespace test
93 } // namespace arm_compute
94 #endif /* ARM_COMPUTE_TEST_CLARRAYACCESSOR_H */
95