Compute Library
 22.05
CLFloor.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_CLFLOOR_H
25 #define ARM_COMPUTE_CLFLOOR_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 run @ref opencl::kernels::ClFloorKernel */
40 class CLFloor : public IFunction
41 {
42 public:
43  /** Constructor */
44  CLFloor();
45  /** Destructor */
46  ~CLFloor();
47  /** Prevent instances of this class from being copied (As this class contains pointers) */
48  CLFloor(const CLFloor &) = delete;
49  /** Default move constructor */
50  CLFloor(CLFloor &&);
51  /** Prevent instances of this class from being copied (As this class contains pointers) */
52  CLFloor &operator=(const CLFloor &) = delete;
53  /** Default move assignment operator */
55  /** Set the source, destination of the kernel
56  *
57  * Valid data layouts:
58  * - All
59  *
60  * Valid data type configurations:
61  * |src |dst |
62  * |:------|:------|
63  * |F32 |F32 |
64  * |F16 |F16 |
65  *
66  * @param[in] input Source tensor. Data type supported: F16/F32.
67  * @param[out] output Destination tensor. Same as @p input
68  */
69  void configure(const ICLTensor *input, ICLTensor *output);
70  /** Set the source, destination of the kernel
71  *
72  * @param[in] compile_context The compile context to be used.
73  * @param[in] input Source tensor. Data type supported: F16/F32.
74  * @param[out] output Destination tensor. Same as @p input
75  */
76  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
77  /** Static function to check if given info will lead to a valid configuration of @ref CLFloor
78  *
79  * @param[in] input Source tensor info. Data type supported: F16/F32.
80  * @param[in] output Destination tensor info. Same as @p input
81  *
82  * @return a status
83  */
84  static Status validate(const ITensorInfo *input, const ITensorInfo *output);
85 
86  // Inherited methods overridden:
87  void run() override;
88 
89 private:
90  struct Impl;
91  std::unique_ptr<Impl> _impl;
92 };
93 } // namespace arm_compute
94 #endif /* ARM_COMPUTE_CLFLOOR_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
Copyright (c) 2017-2022 Arm Limited.
CLCompileContext class.
void configure(const ICLTensor *input, ICLTensor *output)
Set the source, destination of the kernel.
Definition: CLFloor.cpp:50
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
~CLFloor()
Destructor.
CLFloor & operator=(const CLFloor &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
static Status validate(const ITensorInfo *input, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of CLFloor.
Definition: CLFloor.cpp:66
void run() override
Run the kernels contained in the function.
Definition: CLFloor.cpp:71
CLFloor()
Constructor.
Definition: CLFloor.cpp:42
Basic function to run opencl::kernels::ClFloorKernel.
Definition: CLFloor.h:40