Compute Library
 21.08
IAccessor.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_IACCESSOR_H
25 #define ARM_COMPUTE_TEST_IACCESSOR_H
26 
28 #include "arm_compute/core/Types.h"
29 
30 namespace arm_compute
31 {
32 namespace test
33 {
34 /** Common interface to provide information and access to tensor like
35  * structures.
36  */
37 class IAccessor
38 {
39 public:
40  /** Virtual destructor. */
41  virtual ~IAccessor() = default;
42 
43  /** Shape of the tensor.
44  *
45  * @return the shape of the tensor.
46  */
47  virtual TensorShape shape() const = 0;
48 
49  /** Size of each element in the tensor in bytes.
50  *
51  * @return the size of each element in the tensor in bytes.
52  */
53  virtual size_t element_size() const = 0;
54 
55  /** Total size of the tensor in bytes.
56  *
57  * @return the total size of the tensor in bytes.
58  */
59  virtual size_t size() const = 0;
60 
61  /** Image format of the tensor.
62  *
63  * @return the format of the tensor.
64  */
65  virtual Format format() const = 0;
66 
67  /** Data layout of the tensor.
68  *
69  * @return the data layout of the tensor.
70  */
71  virtual DataLayout data_layout() const = 0;
72 
73  /** Data type of the tensor.
74  *
75  * @return the data type of the tensor.
76  */
77  virtual DataType data_type() const = 0;
78 
79  /** Number of channels of the tensor.
80  *
81  * @return the number of channels of the tensor.
82  */
83  virtual int num_channels() const = 0;
84 
85  /** Number of elements of the tensor.
86  *
87  * @return the number of elements of the tensor.
88  */
89  virtual int num_elements() const = 0;
90 
91  /** Available padding around the tensor.
92  *
93  * @return the available padding around the tensor.
94  */
95  virtual PaddingSize padding() const = 0;
96 
97  /** Quantization info in case of asymmetric quantized type
98  *
99  * @return
100  */
101  virtual QuantizationInfo quantization_info() const = 0;
102 
103  /** Read only access to the specified element.
104  *
105  * @param[in] coord Coordinates of the desired element.
106  *
107  * @return A pointer to the desired element.
108  */
109  virtual const void *operator()(const Coordinates &coord) const = 0;
110 
111  /** Access to the specified element.
112  *
113  * @param[in] coord Coordinates of the desired element.
114  *
115  * @return A pointer to the desired element.
116  */
117  virtual void *operator()(const Coordinates &coord) = 0;
118 };
119 } // namespace test
120 } // namespace arm_compute
121 #endif /* ARM_COMPUTE_TEST_IACCESSOR_H */
Shape of a tensor.
Definition: TensorShape.h:39
virtual Format format() const =0
Image format of the tensor.
Container for 2D border size.
Definition: Types.h:264
virtual size_t size() const =0
Total size of the tensor in bytes.
virtual TensorShape shape() const =0
Shape of the tensor.
Copyright (c) 2017-2021 Arm Limited.
virtual PaddingSize padding() const =0
Available padding around the tensor.
Quantization information.
virtual QuantizationInfo quantization_info() const =0
Quantization info in case of asymmetric quantized type.
Format
Image colour formats.
Definition: Types.h:54
Coordinates of an item.
Definition: Coordinates.h:37
virtual int num_elements() const =0
Number of elements of the tensor.
virtual DataLayout data_layout() const =0
Data layout of the tensor.
virtual const void * operator()(const Coordinates &coord) const =0
Read only access to the specified element.
virtual DataType data_type() const =0
Data type of the tensor.
Common interface to provide information and access to tensor like structures.
Definition: IAccessor.h:37
virtual size_t element_size() const =0
Size of each element in the tensor in bytes.
virtual ~IAccessor()=default
Virtual destructor.
virtual int num_channels() const =0
Number of channels of the tensor.
DataType
Available data types.
Definition: Types.h:77
DataLayout
[DataLayout enum definition]
Definition: Types.h:111