xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEFill.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2019-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_NEFILL_H
25 #define ARM_COMPUTE_NEFILL_H
26 
27 #include "arm_compute/runtime/IFunction.h"
28 
29 #include "arm_compute/core/PixelValue.h"
30 #include "arm_compute/core/Types.h"
31 
32 #include <memory>
33 
34 namespace arm_compute
35 {
36 class ITensor;
37 
38 /** Basic function to run @ref cpu::kernels::CpuFillKernel */
39 class NEFill : public IFunction
40 {
41 public:
42     /** Default Constructor */
43     NEFill();
44     /** Default Destructor */
45     ~NEFill();
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     NEFill(const NEFill &) = delete;
48     /** Default move constructor */
49     NEFill(NEFill &&);
50     /** Prevent instances of this class from being copied (As this class contains pointers) */
51     NEFill &operator=(const NEFill &) = delete;
52     /** Default move assignment operator */
53     NEFill &operator=(NEFill &&);
54     /** Initialize the function
55      *
56      * Valid data layouts:
57      * - All
58      *
59      * Valid data type configurations:
60      * |src    |dst    |
61      * |:------|:------|
62      * |All    |All    |
63      *
64      * @param[in,out] tensor         Source tensor. Data types supported: All
65      * @param[in]     constant_value Constant value to use to fill tensor.
66      */
67     void configure(ITensor *tensor, PixelValue constant_value);
68 
69     // Inherited methods overridden
70     void run() override;
71 
72 private:
73     struct Impl;
74     std::unique_ptr<Impl> _impl;
75 };
76 } // namespace arm_compute
77 #endif /*ARM_COMPUTE_FILL_H */
78