Compute Library
 22.02
CLReverse.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_CLREVERSE_H
25 #define ARM_COMPUTE_CLREVERSE_H
26 
27 #include "arm_compute/core/Error.h"
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class ICLTensor;
34 class ITensorInfo;
35 
36 /** Basic function to run @ref CLReverseKernel */
38 {
39 public:
40  /** Initialize the function
41  *
42  * Valid data layouts:
43  * - All
44  *
45  * Valid data type configurations:
46  * |src0 |src1 |dst |
47  * |:--------------|:--------------|:--------------|
48  * |All |U32 |All |
49  *
50  * @param[in] input Input tensor. Data types supported: All.
51  * @param[out] output Output tensor. Data type supported: Same as @p input
52  * @param[in] axis Axis tensor. Contains the indices of the dimensions to reverse. Data type supported: U32
53  */
54  void configure(const ICLTensor *input, ICLTensor *output, const ICLTensor *axis);
55  /** Initialize the function
56  *
57  * @param[in] compile_context The compile context to be used.
58  * @param[in] input Input tensor. Data types supported: All.
59  * @param[out] output Output tensor. Data type supported: Same as @p input
60  * @param[in] axis Axis tensor. Contains the indices of the dimensions to reverse. Data type supported: U32
61  */
62  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const ICLTensor *axis);
63  /** Static function to check if given info will lead to a valid configuration of @ref CLReverseKernel
64  *
65  * @param[in] input Input tensor info. Data types supported: All.
66  * @param[in] output Output tensor info. Data type supported: Same as @p input
67  * @param[in] axis Axis tensor info. Contains the indices of the dimensions to reverse. Data type supported: U32
68  *
69  * @return a status
70  */
71  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *axis);
72 };
73 } // namespace arm_compute
74 #endif /* ARM_COMPUTE_CLREVERSE_H */
Basic function to run CLReverseKernel.
Definition: CLReverse.h:37
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2021 Arm Limited.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *axis)
Static function to check if given info will lead to a valid configuration of CLReverseKernel.
Definition: CLReverse.cpp:46
Basic interface for functions which have a single OpenCL kernel.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
void configure(const ICLTensor *input, ICLTensor *output, const ICLTensor *axis)
Initialize the function.
Definition: CLReverse.cpp:33