xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/Array.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2016-2021 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_ARRAY_H
25 #define ARM_COMPUTE_ARRAY_H
26 
27 #include "arm_compute/core/IArray.h"
28 #include "arm_compute/core/Types.h"
29 
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 /** Basic implementation of the IArray interface which allocates a static number of T values  */
35 template <class T>
36 class Array : public IArray<T>
37 {
38 public:
39     /** Default constructor: empty array */
Array()40     Array()
41         : IArray<T>(0), _values(nullptr)
42     {
43     }
44     /** Constructor: initializes an array which can contain up to max_num_points values
45      *
46      * @param[in] max_num_values Maximum number of values the array will be able to stored
47      */
Array(size_t max_num_values)48     Array(size_t max_num_values)
49         : IArray<T>(max_num_values), _values(std::make_unique<T[]>(max_num_values))
50     {
51     }
52 
53     // Inherited methods overridden:
buffer()54     T *buffer() const override
55     {
56         return _values.get();
57     }
58 
59 private:
60     std::unique_ptr<T[]> _values;
61 };
62 
63 /** Array of uint8s. */
64 using UInt8Array = Array<uint8_t>;
65 /** Array of uint16s. */
66 using UInt16Array = Array<uint16_t>;
67 /** Array of uint32s. */
68 using UInt32Array = Array<uint32_t>;
69 /** Array of int16s. */
70 using Int16Array = Array<int16_t>;
71 /** Array of int32s. */
72 using Int32Array = Array<int32_t>;
73 /** Array of floats. */
74 using FloatArray = Array<float>;
75 }
76 #endif /* ARM_COMPUTE_ARRAY_H */
77