Compute Library
 22.08
ClScale.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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_CL_SCALE_H
25 #define ARM_COMPUTE_CL_SCALE_H
26 
29 #include "src/gpu/cl/IClOperator.h"
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 /** Basic function to simulate a scale layer. This function calls the following OpenCL kernels:
36  *
37  * -# @ref kernels::ClScaleKernel
38  */
39 class ClScale : public IClOperator
40 {
41 public:
42  /** Constructor */
43  ClScale() = default;
44  /** Initialize the function's source, destination, interpolation type and border_mode.
45  *
46  * @param[in] compile_context The compile context to be used.
47  * @param[in,out] src Source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. (Written to only for @p border_mode != UNDEFINED)
48  * @param[out] dst Destination tensor info. Data types supported: Same as @p src
49  * 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.
50  * @param[in] info @ref ScaleKernelInfo descriptor to be used to configure
51  */
52  void configure(const CLCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, const ScaleKernelInfo &info);
53  /** Static function to check if given info will lead to a valid configuration
54  *
55  * Similar to ClScale::configure()
56  *
57  * @return a status
58  */
59  static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const ScaleKernelInfo &info);
60 
61  // Inherited method overridden
62  void run(ITensorPack &tensors) override;
63 };
64 } // namespace opencl
65 } // namespace arm_compute
66 #endif /* ARM_COMPUTE_CLSCALE_H */
Store the tensor's metadata.
Definition: ITensorInfo.h:40
void configure(const CLCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, const ScaleKernelInfo &info)
Initialize the function's source, destination, interpolation type and border_mode.
Definition: ClScale.cpp:38
Status class.
Definition: Error.h:52
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2022 Arm Limited.
void run(ITensorPack &tensors) override
Run the kernels contained in the function.
Definition: ClScale.cpp:58
Basic function to simulate a scale layer.
Definition: ClScale.h:39
static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const ScaleKernelInfo &info)
Static function to check if given info will lead to a valid configuration.
Definition: ClScale.cpp:53
CLCompileContext class.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
ClScale()=default
Constructor.
Tensor packing service.
Definition: ITensorPack.h:39
Basic interface for functions which have a single async CL kernel.
Definition: ICLOperator.h:41