Compute Library
 21.02
ArrayAccessor.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_ARRAYACCESSOR_H
25 #define ARM_COMPUTE_TEST_ARRAYACCESSOR_H
26 
28 #include "tests/IArrayAccessor.h"
29 
30 namespace arm_compute
31 {
32 namespace test
33 {
34 /** ArrayAccessor implementation for @ref Array objects. */
35 template <typename T>
36 class ArrayAccessor : 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  */
44  : _array{ array }
45  {
46  }
47 
48  /** Prevent instances of this class from being copy constructed */
49  ArrayAccessor(const ArrayAccessor &) = delete;
50  /** Prevent instances of this class from being copied */
51  ArrayAccessor &operator=(const ArrayAccessor &) = delete;
52  /** Allow instances of this class to be move constructed */
53  ArrayAccessor(ArrayAccessor &&) = default;
54  /** Allow instances of this class to be moved */
55  ArrayAccessor &operator=(ArrayAccessor &&) = default;
56 
57  size_t num_values() const override
58  {
59  return _array.num_values();
60  }
61 
62  T *buffer() override
63  {
64  return _array.buffer();
65  }
66 
67  void resize(size_t num) override
68  {
69  _array.resize(num);
70  }
71 
72  T &at(size_t index) const override
73  {
74  ARM_COMPUTE_ERROR_ON(_array.buffer() == nullptr);
75  ARM_COMPUTE_ERROR_ON(index >= num_values());
76  return _array.buffer()[index];
77  }
78 
79 private:
80  Array<T> &_array;
81 };
82 } // namespace test
83 } // namespace arm_compute
84 #endif /* ARM_COMPUTE_TEST_ARRAYACCESSOR_H */
void resize(size_t num) override
Resize array.
Definition: ArrayAccessor.h:67
ArrayAccessor & operator=(const ArrayAccessor &)=delete
Prevent instances of this class from being copied.
ArrayAccessor(Array< T > &array)
Create an accessor for the given array.
Definition: ArrayAccessor.h:43
ArrayAccessor implementation for Array objects.
Definition: ArrayAccessor.h:36
size_t num_values() const override
Number of elements of the tensor.
Definition: ArrayAccessor.h:57
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
Copyright (c) 2017-2021 Arm Limited.
Basic implementation of the IArray interface which allocates a static number of T values...
Definition: Array.h:36
T & at(size_t index) const override
Reference to the element of the array located at the given index.
Definition: ArrayAccessor.h:72
T * buffer() override
Access to the buffer.
Definition: ArrayAccessor.h:62
Common interface to provide information and access to array like structures.