Compute Library
 22.08
NEScale.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-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_NESCALEIMAGE_H
25 #define ARM_COMPUTE_NESCALEIMAGE_H
26 
28 
30 #include "arm_compute/core/Types.h"
31 
32 #include <memory>
33 
34 namespace arm_compute
35 {
36 class ITensor;
37 class ITensorInfo;
38 
39 /** Basic function to compute Scale */
40 class NEScale : public IFunction
41 {
42 public:
43  /** Constructor */
44  NEScale();
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
46  NEScale(const NEScale &) = delete;
47  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
48  NEScale(NEScale &&) = delete;
49  /** Prevent instances of this class from being copied (As this class contains pointers) */
50  NEScale &operator=(const NEScale &) = delete;
51  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
52  NEScale &operator=(NEScale &&) = delete;
53  /** Destructor */
54  ~NEScale();
55  /** Initialize the function's source, destination, interpolation type and border_mode.
56  *
57  * Valid data layouts:
58  * - NHWC
59  * - NCHW
60  *
61  * Valid data type configurations:
62  * |src |dst |
63  * |:--------------|:--------------|
64  * |QASYMM8 |QASYMM8 |
65  * |QASYMM8_SIGNED |QASYMM8_SIGNED |
66  * |F16 |F16 |
67  * |F32 |F32 |
68  * |U8 |U8 |
69  * |S16 |S16 |
70  *
71  * @param[in, out] input Source tensor. Data type supported: QASYMM8/QASYMM8_SIGNED/U8/S16/F16/F32. (Written to only for @p border_mode != UNDEFINED)
72  * @param[out] output Destination tensor. Data type supported: Same as @p input. All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
73  * @param[in] info @ref ScaleKernelInfo to be used for configuration
74  */
75  void configure(ITensor *input, ITensor *output, const ScaleKernelInfo &info);
76  /** Static function to check if given info will lead to a valid configuration of @ref NEScale
77  *
78  * @param[in] input Source tensor. Data type supported: QASYMM8/QASYMM8_SIGNED/U8/S16/F16/F32. (Written to only for @p border_mode != UNDEFINED)
79  * @param[in] output Destination tensor. Data type supported: Same as @p input. All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
80  * @param[in] info @ref ScaleKernelInfo to be used for validation
81  *
82  * @return a status
83  */
84  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ScaleKernelInfo &info);
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_NESCALEIMAGE_H */
Base class for all functions.
Definition: IFunction.h:30
NEScale()
Constructor.
Definition: NEScale.cpp:45
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Basic function to compute Scale.
Definition: NEScale.h:40
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2022 Arm Limited.
~NEScale()
Destructor.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ScaleKernelInfo &info)
Static function to check if given info will lead to a valid configuration of NEScale.
Definition: NEScale.cpp:109
void configure(ITensor *input, ITensor *output, const ScaleKernelInfo &info)
Initialize the function&#39;s source, destination, interpolation type and border_mode.
Definition: NEScale.cpp:51
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
void run() override
Run the kernels contained in the function.
Definition: NEScale.cpp:114
NEScale & operator=(const NEScale &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...