Compute Library
 21.05
ClPermute.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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_CL_PERMUTE_H
25 #define ARM_COMPUTE_CL_PERMUTE_H
26 
29 
30 namespace arm_compute
31 {
32 namespace opencl
33 {
34 /** Basic function to run @ref kernels::ClPermuteKernel */
35 class ClPermute : public IClOperator
36 {
37 public:
38  /** Constructor */
39  ClPermute() = default;
40  /** Initialise the kernel's inputs and outputs and permute vector
41  *
42  * @note Arbitrary permutation vectors are supported with rank not greater than 4
43  *
44  * @param[in] compile_context The compile context to be used.
45  * @param[in] src The src tensor info. Data types supported: All.
46  * @param[in] dst The dst tensor info. Data types supported: Same as @p src
47  * @param[in] perm Permutation vector
48  */
49  void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, const PermutationVector &perm);
50  /** Static function to check if given info will lead to a valid configuration of @ref kernels::ClPermuteKernel.
51  *
52  * @note Arbitrary permutation vectors are supported with rank not greater than 4
53  *
54  * @param[in] src First tensor src info. Data types supported: All.
55  * @param[in] dst Output tensor info. Data types supported: same as @p src.
56  * @param[in] perm Permutation vector
57  *
58  * @return a status
59  */
60  static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const PermutationVector &perm);
61 };
62 } // namespace opencl
63 } // namespace arm_compute
64 #endif /* ARM_COMPUTE_CL_PERMUTE_H */
ClPermute()=default
Constructor.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, const PermutationVector &perm)
Initialise the kernel's inputs and outputs and permute vector.
Definition: ClPermute.cpp:33
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
CLCompileContext class.
Strides of an item in bytes.
Definition: Strides.h:37
Basic interface for functions which have a single async CL kernel.
Definition: ICLOperator.h:41
Basic function to run kernels::ClPermuteKernel.
Definition: ClPermute.h:35
static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const PermutationVector &perm)
Static function to check if given info will lead to a valid configuration of kernels::ClPermuteKernel...
Definition: ClPermute.cpp:40