Compute Library
 22.08
NESelectKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2020, 2022 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_NESELECTKERNEL_H
25 #define ARM_COMPUTE_NESELECTKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 namespace arm_compute
31 {
32 // Forward declarations
33 class ITensor;
34 
35 /** Interface for the select kernel
36  *
37  * Select is computed by:
38  * @f[ output(i) = condition(i) ? x(i) : y(i) @f]
39  *
40  */
41 class NESelectKernel : public INEKernel
42 {
43 public:
44  const char *name() const override
45  {
46  return "NESelectKernel";
47  }
48  /** Default constructor */
50  /** Prevent instances of this class from being copied (As this class contains pointers) */
51  NESelectKernel(const NESelectKernel &) = delete;
52  /** Prevent instances of this class from being copied (As this class contains pointers) */
53  NESelectKernel &operator=(const NESelectKernel &) = delete;
54  /** Allow instances of this class to be moved */
55  NESelectKernel(NESelectKernel &&) = default;
56  /** Allow instances of this class to be moved */
58  /** Default destructor */
59  ~NESelectKernel() = default;
60 
61  /** Common signature for all the specialised elementwise functions
62  *
63  * @param[in] c Condition input tensor. Data types supported: U8.
64  * @param[in] x First input tensor. Data types supported: All.
65  * @param[out] y Second input tensor. Data types supported: Same as @p x
66  * @param[in] output Output tensor. Data types supported: Same as @p x
67  */
68  void configure(const ITensor *c, const ITensor *x, const ITensor *y, ITensor *output);
69 
70  /** Validate the argument passed to the kernel
71  *
72  * @param[in] c Condition input tensor. Data types supported: U8.
73  * @param[in] x First input tensor. Data types supported: All.
74  * @param[in] y Second input tensor. Data types supported: Same as @p x
75  * @param[in] output Output tensor. Data types supported: Same as @p x.
76  *
77  * @return a status
78  */
79  static Status validate(const ITensorInfo *c, const ITensorInfo *x, const ITensorInfo *y, const ITensorInfo *output);
80 
81  // Inherited methods overridden:
82  void run(const Window &window, const ThreadInfo &info) override;
83 
84 private:
85 
86  const ITensor *_c; /**< Condition tensor */
87  const ITensor *_x; /**< Source tensor 1 */
88  const ITensor *_y; /**< Source tensor 2 */
89  ITensor *_output; /**< Destination tensor */
90  bool _has_same_rank; /**< Flag that indicates if condition tensor and other inputs have the same rank */
91 };
92 } // namespace arm_compute
93 #endif /* ARM_COMPUTE_NESELECTKERNEL_H */
const char * name() const override
Name of the kernel.
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
NESelectKernel()
Default constructor.
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2022 Arm Limited.
~NESelectKernel()=default
Default destructor.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:179
Interface for the select kernel.
static Status validate(const ITensorInfo *c, const ITensorInfo *x, const ITensorInfo *y, const ITensorInfo *output)
Validate the argument passed to the kernel.
void configure(const ITensor *c, const ITensor *x, const ITensor *y, ITensor *output)
Common signature for all the specialised elementwise functions.
Describe a multidimensional execution window.
Definition: Window.h:39
NESelectKernel & operator=(const NESelectKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...