• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2018-2020 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_CLRANGE_H
25 #define ARM_COMPUTE_CLRANGE_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class ICLTensor;
34 class ITensorInfo;
35 
36 /** Basic function to run @ref CLRangeKernel
37  *
38  * @note The tensor data type for the output must be U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32.
39  * @note The function performs generates a sequence with the given start, end and step.
40  */
41 class CLRange : public ICLSimpleFunction
42 {
43 public:
44     /** Initialize the kernel's start, end, step and output tensor.
45      *
46      * @param[out] output Output tensor. Data types supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32.
47      * @param[in]  start  The starting value of the sequence.
48      * @param[in]  end    The ending (not including) value of the sequence.
49      * @param[in]  step   The gap between each pair of values in the sequence. Default is 1.
50      */
51     void configure(ICLTensor *output, float start, float end, float step = 1.f);
52     /** Initialize the kernel's start, end, step and output tensor.
53      *
54      * @param[in]  compile_context The compile context to be used.
55      * @param[out] output          Output tensor. Data types supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32.
56      * @param[in]  start           The starting value of the sequence.
57      * @param[in]  end             The ending (not including) value of the sequence.
58      * @param[in]  step            The gap between each pair of values in the sequence. Default is 1.
59      */
60     void configure(const CLCompileContext &compile_context, ICLTensor *output, float start, float end, float step = 1.f);
61     /** Static function to check if given info will lead to a valid configuration of @ref CLRange
62      *
63      * @param[in] output Output tensor info. Data types supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32.
64      * @param[in] start  The starting value of the sequence.
65      * @param[in] end    The ending (not including) value of the sequence.
66      * @param[in] step   The gap between each pair of values in the sequence. Default is 1.
67      *
68      * @return a status
69      */
70     static Status validate(const ITensorInfo *output, float start, float end, float step = 1.f);
71 };
72 } // namespace arm_compute
73 #endif /* ARM_COMPUTE_CLRANGE_H */
74