Compute Library
 21.02
ICPPSimpleKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2019 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_ICPPSIMPLEKERNEL_H
25 #define ARM_COMPUTE_ICPPSIMPLEKERNEL_H
26 
28 
29 namespace arm_compute
30 {
31 class ITensor;
32 
33 /** Interface for simple C++ kernels having 1 tensor input and 1 tensor output */
35 {
36 public:
37  /** Constructor */
39  /** Prevent instances of this class from being copied (As this class contains pointers) */
40  ICPPSimpleKernel(const ICPPSimpleKernel &) = delete;
41  /** Prevent instances of this class from being copied (As this class contains pointers) */
42  ICPPSimpleKernel &operator=(const ICPPSimpleKernel &) = delete;
43  /** Allow instances of this class to be moved */
44  ICPPSimpleKernel(ICPPSimpleKernel &&) = default;
45  /** Allow instances of this class to be moved */
47  /** Default destructor */
48  ~ICPPSimpleKernel() = default;
49 
50 protected:
51  /** Configure the kernel
52  *
53  * @param[in] input Source tensor.
54  * @param[out] output Destination tensor.
55  * @param[in] num_elems_processed_per_iteration Number of processed elements per iteration.
56  * @param[in] border_undefined (Optional) True if the border mode is undefined. False if it's replicate or constant.
57  * @param[in] border_size (Optional) Size of the border.
58  */
59  void configure(const ITensor *input, ITensor *output, unsigned int num_elems_processed_per_iteration, bool border_undefined = false, const BorderSize &border_size = BorderSize());
60  /** Static function to check if given info will lead to a valid configuration of @ref ICPPSimpleKernel.
61  *
62  * @param[in] input Source tensor info.
63  * @param[in] output Destination tensor info.
64  * @param[in] num_elems_processed_per_iteration Number of processed elements per iteration.
65  * @param[in] border_undefined (Optional) True if the border mode is undefined. False if it's replicate or constant.
66  * @param[in] border_size (Optional) Size of the border.
67  */
68  static Status validate(const ITensorInfo *input, const ITensorInfo *output, unsigned int num_elems_processed_per_iteration,
69  bool border_undefined = false, const BorderSize &border_size = BorderSize());
70 
71 protected:
72  const ITensor *_input;
73  ITensor *_output;
74 };
75 } // namespace arm_compute
76 #endif /*ARM_COMPUTE_ICPPSIMPLEKERNEL_H */
Container for 2D border size.
Definition: Types.h:273
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for simple C++ kernels having 1 tensor input and 1 tensor output.
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
virtual BorderSize border_size() const
The size of the border for that kernel.
Definition: IKernel.cpp:46
~ICPPSimpleKernel()=default
Default destructor.
unsigned int num_elems_processed_per_iteration
ICPPSimpleKernel & operator=(const ICPPSimpleKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...