1 /* 2 * Copyright (c) 2018-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_NERANGE_H 25 #define ARM_COMPUTE_NERANGE_H 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/runtime/IFunction.h" 29 #include <memory> 30 31 namespace arm_compute 32 { 33 class ITensor; 34 class ITensorInfo; 35 class NERangeKernel; 36 37 /** Basic function to run @ref NERangeKernel 38 * 39 * @note The tensor data type for the output must be U8/S8/U16/S16/U32/S32/F16/F32. 40 * @note The function performs generates a sequence with the given start, end and step. 41 * 42 */ 43 class NERange : public IFunction 44 { 45 public: 46 /** Default constructor */ 47 NERange(); 48 /** Prevent instances of this class from being copied (As this class contains pointers) */ 49 NERange(const NERange &) = delete; 50 /** Prevent instances of this class from being copied (As this class contains pointers) */ 51 NERange &operator=(const NERange &) = delete; 52 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 53 NERange(NERange &&) = delete; 54 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 55 NERange &operator=(NERange &&) = delete; 56 /** Default destructor */ 57 ~NERange(); 58 /** Initialize the kernel's start, end, step and output tensor. 59 * 60 * Valid data layouts: 61 * - All 62 * 63 * Valid data type configurations: 64 * |dst | 65 * |:---------| 66 * |U8 | 67 * |S8 | 68 * |U16 | 69 * |S16 | 70 * |U32 | 71 * |S32 | 72 * |F16 | 73 * |F32 | 74 * 75 * @param[out] output Output tensor. Data types supported: U8/S8/U16/S16/U32/S32/F16/F32. 76 * @param[in] start The starting value of the sequence. 77 * @param[in] end The ending (not including) value of the sequence. 78 * @param[in] step The gap between each pair of values in the sequence. Default is 1. 79 */ 80 void configure(ITensor *output, float start, float end, float step = 1.f); 81 /** Static function to check if given info will lead to a valid configuration of @ref NERange 82 * 83 * @param[in] output Output tensor info. Data types supported: U8/S8/U16/S16/U32/S32/F16/F32. 84 * @param[in] start The starting value of the sequence. 85 * @param[in] end The ending (not including) value of the sequence. 86 * @param[in] step The gap between each pair of values in the sequence. Default is 1. 87 * 88 * @return a status 89 */ 90 static Status validate(const ITensorInfo *output, float start, float end, float step = 1.f); 91 92 // Inherited methods overridden: 93 void run() override; 94 95 private: 96 std::unique_ptr<NERangeKernel> _kernel; 97 }; 98 } // namespace arm_compute 99 #endif /* ARM_COMPUTE_NERANGE_H */ 100