runtime/onert/core/src/exec/feature/Reader.h

   1 /*
   2  * Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *    http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file     Reader.h
  19  * @brief    This file contains Reader class
  20  */
  21
  22 #ifndef __ONERT_EXEC_FEATURE_READER_H__
  23 #define __ONERT_EXEC_FEATURE_READER_H__
  24
  25 #include <cstdint>
  26
  27 namespace onert
  28 {
  29 namespace exec
  30 {
  31 namespace feature
  32 {
  33
  34 /**
  35  * @brief  Class reads values of feature
  36  *         The interface class
  37  */
  38 template <typename T> struct Reader
  39 {
  40   /**
  41    * @brief  Destruct Reader object using default destructor
  42    */
  43   virtual ~Reader() = default;
  44
  45   /**
  46    * @brief     Get the value used by three indexes
  47    * @param[in] ch  The depth index
  48    * @param[in] row The height index
  49    * @param[in] col The width index
  50    * @return    The value at the offset
  51    */
  52   virtual T at(uint32_t ch, uint32_t row, uint32_t col) const = 0;
  53   /**
  54    * @brief     Get the value used by four indexes
  55    * @param[in] batch The batch index
  56    * @param[in] ch    The depth index
  57    * @param[in] row   The height index
  58    * @param[in] col   The width index
  59    * @return    The value at the offset
  60    */
  61   virtual T at(uint32_t batch, uint32_t ch, uint32_t row, uint32_t col) const = 0;
  62 };
  63
  64 } // namespace feature
  65 } // namespace exec
  66 } // namespace onert
  67
  68 #endif // __ONERT_EXEC_FEATURE_READER_H__