tests/IAccessor.h

   1 /*
   2  * Copyright (c) 2017 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
  27 #include "arm_compute/core/Coordinates.h"
  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     virtual TensorShape shape() const = 0;
  45
  46     /** Size of each element in the tensor in bytes. */
  47     virtual size_t element_size() const = 0;
  48
  49     /** Total size of the tensor in bytes. */
  50     virtual size_t size() const = 0;
  51
  52     /** Image format of the tensor. */
  53     virtual Format format() const = 0;
  54
  55     /** Data type of the tensor. */
  56     virtual DataType data_type() const = 0;
  57
  58     /** Number of channels of the tensor. */
  59     virtual int num_channels() const = 0;
  60
  61     /** Number of elements of the tensor. */
  62     virtual int num_elements() const = 0;
  63
  64     /** Available padding around the tensor. */
  65     virtual PaddingSize padding() const = 0;
  66
  67     /** Number of bits for the fractional part. */
  68     virtual int fixed_point_position() const = 0;
  69
  70     /** Read only access to the specified element.
  71      *
  72      * @param[in] coord Coordinates of the desired element.
  73      *
  74      * @return A pointer to the desired element.
  75      */
  76     virtual const void *operator()(const Coordinates &coord) const = 0;
  77
  78     /** Access to the specified element.
  79      *
  80      * @param[in] coord Coordinates of the desired element.
  81      *
  82      * @return A pointer to the desired element.
  83      */
  84     virtual void *operator()(const Coordinates &coord) = 0;
  85 };
  86 } // namespace test
  87 } // namespace arm_compute
  88 #endif /* __ARM_COMPUTE_TEST_IACCESSOR_H__ */