Compute Library
 22.02
NERangeKernel.h
Go to the documentation of this file.
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_NERANGEKERNEL_H
25 #define ARM_COMPUTE_NERANGEKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 namespace arm_compute
31 {
32 class ITensor;
33 
34 /** Kernel class for Range
35  *
36  * range generates a 1-D tensor containing a sequence of numbers that begins at 'start' and extends by increments
37  * of 'step' up to but not including 'end'.
38  */
39 class NERangeKernel : public INEKernel
40 {
41 public:
42  const char *name() const override
43  {
44  return "NERangeKernel";
45  }
46  /** Default constructor */
47  NERangeKernel();
48  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  NERangeKernel(const NERangeKernel &) = delete;
50  /** Prevent instances of this class from being copied (As this class contains pointers) */
51  NERangeKernel &operator=(const NERangeKernel &) = delete;
52  /** Allow instances of this class to be moved */
53  NERangeKernel(NERangeKernel &&) = default;
54  /** Allow instances of this class to be moved */
55  NERangeKernel &operator=(NERangeKernel &&) = default;
56  /** Default destructor */
57  ~NERangeKernel() = default;
58  /** Initialize the kernel's output tensor, start, end and step of the sequence.
59  *
60  * @param[out] output Output tensor. Data types supported: U8/S8/U16/S16/U32/S32/F16/F32.
61  * @param[in] start The starting value of the sequence.
62  * @param[in] end The ending (not including) value of the sequence.
63  * @param[in] step The gap between each pair of values in the sequence.
64  */
65  void configure(ITensor *output, float start, float end, float step);
66  /** Static function to check if given info will lead to a valid configuration of @ref NERangeKernel
67  *
68  * @param[in] output Output tensor info. Data types supported: U8/S8/U16/S16/U32/S32/F16/F32.
69  * @param[in] start The starting value of the sequence.
70  * @param[in] end The ending (not including) value of the sequence.
71  * @param[in] step The gap between each pair of values in the sequence.
72  *
73  * @return a status
74  */
75  static Status validate(const ITensorInfo *output, float start, float end, float step);
76 
77  // Inherited methods overridden:
78  void run(const Window &window, const ThreadInfo &info) override;
79 
80 private:
81  using RangeFunction = void(ITensor *output, float start, float step, const Window &window);
82 
83  float _start; /**< Start of sequence */
84  float _end; /**< End of sequence */
85  float _step; /**< Increment/step value */
86  ITensor *_output; /**< Destination tensor */
87 };
88 } // namespace arm_compute
89 #endif /* ARM_COMPUTE_NERANGEKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
NERangeKernel & operator=(const NERangeKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
void configure(ITensor *output, float start, float end, float step)
Initialize the kernel&#39;s output tensor, start, end and step of the sequence.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Kernel class for Range.
Definition: NERangeKernel.h:39
Status class.
Definition: Error.h:52
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
static Status validate(const ITensorInfo *output, float start, float end, float step)
Static function to check if given info will lead to a valid configuration of NERangeKernel.
~NERangeKernel()=default
Default destructor.
void end(TokenStream &in, bool &valid)
Definition: MLGOParser.cpp:290
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:169
const char * name() const override
Name of the kernel.
Definition: NERangeKernel.h:42
constexpr int step
Definition: fp32.cpp:35
Describe a multidimensional execution window.
Definition: Window.h:39
NERangeKernel()
Default constructor.