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