Compute Library
 22.05
CLLogicalNot.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020-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_CLLOGICALNOT_H
25 #define ARM_COMPUTE_CLLOGICALNOT_H
26 
28 
29 #include "arm_compute/core/Types.h"
30 
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 class CLCompileContext;
36 class ICLTensor;
37 class ITensorInfo;
38 
39 /** Basic function to do logical NOT operation
40  *
41  * @note The tensor data type for the inputs must be U8.
42  * @note The function performs a logical NOT operation on input tensor.
43  */
44 class CLLogicalNot : public IFunction
45 {
46 public:
47  /** Default Constructor */
48  CLLogicalNot();
49  /** Default Destructor */
50  ~CLLogicalNot();
51  /** Prevent instances of this class from being copied (As this class contains pointers) */
52  CLLogicalNot(const CLLogicalNot &) = delete;
53  /** Default move constructor */
55  /** Prevent instances of this class from being copied (As this class contains pointers) */
56  CLLogicalNot &operator=(const CLLogicalNot &) = delete;
57  /** Default move assignment operator */
59  /** Initialize the function
60  *
61  * Valid data layouts:
62  * - All
63  *
64  * Valid data type configurations:
65  * |src |dst |
66  * |:--------------|:------------|
67  * |U8 |U8 |
68  *
69  * @param[in] input Input tensor. Data types supported: U8.
70  * @param[out] output Output tensor. Data types supported: same as @p input.
71  */
72  void configure(const ICLTensor *input, ICLTensor *output);
73  /** Initialize the function
74  *
75  * @param[in] compile_context The compile context to be used.
76  * @param[in] input Input tensor. Data types supported: U8.
77  * @param[out] output Output tensor. Data types supported: same as @p input.
78  */
79  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
80  /** Static function to check if given info will lead to a valid configuration
81  *
82  * @param[in] input Tensor input info. Data types supported: U8.
83  * @param[in] output Output tensor info. Data types supported: same as @p input.
84  *
85  * @return a status
86  */
87  static Status validate(const ITensorInfo *input, const ITensorInfo *output);
88  void run() override;
89 
90 private:
91  struct Impl;
92  std::unique_ptr<Impl> _impl;
93 };
94 } // namespace arm_compute
95 #endif /* ARM_COMPUTE_CLLOGICALNOT_H */
Base class for all functions.
Definition: IFunction.h:30
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
static Status validate(const ITensorInfo *input, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration.
Copyright (c) 2017-2022 Arm Limited.
CLLogicalNot & operator=(const CLLogicalNot &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Basic function to do logical NOT operation.
Definition: CLLogicalNot.h:44
~CLLogicalNot()
Default Destructor.
void run() override
Run the kernels contained in the function.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
CLLogicalNot()
Default Constructor.
void configure(const ICLTensor *input, ICLTensor *output)
Initialize the function.