Compute Library
 21.02
NECopy.h
Go to the documentation of this file.
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_NECOPY_H
25 #define ARM_COMPUTE_NECOPY_H
26 
28 
29 #include "arm_compute/core/Types.h"
30 
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 class ITensor;
36 class ITensorInfo;
37 
38 /** Basic function to run @ref cpu::kernels::CpuCopyKernel */
39 class NECopy : public IFunction
40 {
41 public:
42  /** Default Constructor */
43  NECopy();
44  /** Default Destructor */
45  ~NECopy();
46  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  NECopy(const NECopy &) = delete;
48  /** Default move constructor */
49  NECopy(NECopy &&);
50  /** Prevent instances of this class from being copied (As this class contains pointers) */
51  NECopy &operator=(const NECopy &) = delete;
52  /** Default move assignment operator */
53  NECopy &operator=(NECopy &&);
54  /** Initialise the function's source and destination.
55  *
56  * @param[in] input Source tensor. Data types supported: All
57  * @param[out] output Output tensor. Data types supported: Same as @p input.
58  *
59  */
60  void configure(ITensor *input, ITensor *output);
61  /** Static function to check if given info will lead to a valid configuration of @ref NECopy
62  *
63  * @param[in] input Source tensor. Data types supported: All
64  * @param[in] output Output tensor. Data types supported: Same as @p input.
65  *
66  * @return a status
67  */
68  static Status validate(const ITensorInfo *input, const ITensorInfo *output);
69 
70  // Inherited methods overridden
71  void run() override;
72 
73 private:
74  struct Impl;
75  std::unique_ptr<Impl> _impl;
76 };
77 } // namespace arm_compute
78 #endif /*ARM_COMPUTE_NECOPY_H */
Base class for all functions.
Definition: IFunction.h:30
NECopy & operator=(const NECopy &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
NECopy()
Default Constructor.
Definition: NECopy.cpp:40
static Status validate(const ITensorInfo *input, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of NECopy.
Definition: NECopy.cpp:58
~NECopy()
Default Destructor.
void run() override
Run the kernels contained in the function.
Definition: NECopy.cpp:66
void configure(ITensor *input, ITensor *output)
Initialise the function&#39;s source and destination.
Definition: NECopy.cpp:48
Basic function to run cpu::kernels::CpuCopyKernel.
Definition: NECopy.h:39