xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NESelect.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_NESELECT_H
25 #define ARM_COMPUTE_NESELECT_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/NEON/INESimpleFunctionNoBorder.h"
29 
30 namespace arm_compute
31 {
32 // Forward declarations
33 class ITensor;
34 class ITensorInfo;
35 
36 /** Basic function to run @ref NESelect */
37 class NESelect : public INESimpleFunctionNoBorder
38 {
39 public:
40     /** Initialise the kernel's inputs and output.
41      *
42      * Valid data layouts:
43      * - All
44      *
45      * Valid data type configurations:
46      * |src0           |src1           |src2   |dst            |
47      * |:--------------|:--------------|:------|:--------------|
48      * |U8             |All            |All    |All            |
49      *
50      * @param[in]  c      Condition input tensor. Data types supported: U8.
51      * @param[in]  x      First input tensor. Data types supported: All.
52      * @param[in]  y      Second input tensor. Data types supported: Same as @p x
53      * @param[out] output Output tensor. Data types supported: Same as @p x.
54      */
55     void configure(const ITensor *c, const ITensor *x, const ITensor *y, ITensor *output);
56     /** Static function to check if given info will lead to a valid configuration of @ref NESelect
57      *
58      * @param[in] c      Condition input tensor. Data types supported: U8.
59      * @param[in] x      First input tensor. Data types supported: All.
60      * @param[in] y      Second input tensor. Data types supported: Same as @p x
61      * @param[in] output Output tensor. Data types supported: Same as @p x.
62      *
63      * @return a status
64      */
65     static Status validate(const ITensorInfo *c, const ITensorInfo *x, const ITensorInfo *y, const ITensorInfo *output);
66 };
67 } // namespace arm_compute
68 #endif /* ARM_COMPUTE_NESELECT_H */
69