xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/operators/CpuScale.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2021-2022 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_CPU_SCALE_H
25 #define ARM_COMPUTE_CPU_SCALE_H
26 
27 #include "arm_compute/core/ITensorInfo.h"
28 #include "arm_compute/core/KernelDescriptors.h"
29 #include "arm_compute/core/experimental/Types.h"
30 #include "src/cpu/ICpuKernel.h"
31 #include "src/cpu/ICpuOperator.h"
32 
33 #include <memory>
34 
35 namespace arm_compute
36 {
37 namespace cpu
38 {
39 /** Basic function to compute Scale */
40 class CpuScale : public ICpuOperator
41 {
42 public:
43     /** Initialize the function's source, destination, interpolation type and border_mode.
44      *
45      * @param[in, out] src  Source tensor info. Data type supported: QASYMM8/QASYMM8_SIGNED/U8/S16/F16/F32. (Written to only for @p border_mode != UNDEFINED)
46      * @param[out]     dst  Destination tensor info. Data type supported: Same as @p src. 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.
47      * @param[in]      info @ref ScaleKernelInfo to be used for configuration
48      *
49      * @note Using S8 data type only supports NHWC, @p border_mode Replicate, and @p policy Bilinear
50      */
51     void configure(ITensorInfo *src, ITensorInfo *dst, const ScaleKernelInfo &info);
52     /** Static function to check if given info will lead to a valid configuration
53      *
54      * Similar to @ref CpuScale::configure()
55      *
56      * @return a status
57      */
58     static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const ScaleKernelInfo &info);
59 
60     // Inherited methods overridden:
61     void prepare(ITensorPack &tensors) override;
62     void run(ITensorPack &tensors) override;
63 
64 private:
65     ScaleKernelInfo _scale_info{ InterpolationPolicy::NEAREST_NEIGHBOR, BorderMode::UNDEFINED };
66     DataLayout      _data_layout{ DataLayout::UNKNOWN };
67     bool            _is_prepared{ false };
68 };
69 } // namespace cpu
70 } // namespace arm_compute
71 #endif /* ARM_COMPUTE_CPU_SCALE_H */
72