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_CLSCALE_H 25 #define ARM_COMPUTE_CLSCALE_H 26 27 #include "arm_compute/core/KernelDescriptors.h" 28 #include "arm_compute/core/Types.h" 29 #include "arm_compute/runtime/IFunction.h" 30 31 #include <memory> 32 33 namespace arm_compute 34 { 35 class CLCompileContext; 36 class ICLTensor; 37 class ITensorInfo; 38 39 /** Basic function to run @ref opencl::ClScale */ 40 class CLScale : public IFunction 41 { 42 public: 43 /** Default Constructor */ 44 CLScale(); 45 /** Default Destructor */ 46 ~CLScale(); 47 /** Prevent instances of this class from being copied (As this class contains pointers) */ 48 CLScale(const CLScale &) = delete; 49 /** Default move constructor */ 50 CLScale(CLScale &&) = default; 51 /** Prevent instances of this class from being copied (As this class contains pointers) */ 52 CLScale &operator=(const CLScale &) = delete; 53 /** Default move assignment operator */ 54 CLScale &operator=(CLScale &&) = default; 55 56 /** Initialize the function's source, destination, interpolation type and border_mode. 57 * 58 * Valid data layouts: 59 * - NHWC 60 * - NCHW 61 * 62 * Valid data type configurations: 63 * |src |dst | 64 * |:--------------|:--------------| 65 * |QASYMM8 |QASYMM8 | 66 * |QASYMM8_SIGNED |QASYMM8_SIGNED | 67 * |F16 |F16 | 68 * |F32 |F32 | 69 * |U8 |U8 | 70 * |S16 |S16 | 71 * 72 * @param[in,out] input Source tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. (Written to only for @p border_mode != UNDEFINED) 73 * @param[out] output Destination tensor. Data types supported: Same as @p input 74 * 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. 75 * @param[in] info @ref ScaleKernelInfo descriptor to be used to configure 76 */ 77 void configure(ICLTensor *input, ICLTensor *output, const ScaleKernelInfo &info); 78 /** Initialize the function's source, destination, interpolation type and border_mode. 79 * 80 * @param[in] compile_context The compile context to be used. 81 * @param[in,out] input Source tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. (Written to only for @p border_mode != UNDEFINED) 82 * @param[out] output Destination tensor. Data types supported: Same as @p input 83 * 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. 84 * @param[in] info @ref ScaleKernelInfo descriptor to be used to configure 85 */ 86 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const ScaleKernelInfo &info); 87 88 /** Static function to check if given info will lead to a valid configuration of @ref CLScale 89 * 90 * @param[in] input Source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. 91 * @param[in] output Output tensor info. Data type supported: Same as @p input 92 * 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. 93 * @param[in] info @ref ScaleKernelInfo descriptor to be used to validate 94 * 95 * @return a status 96 */ 97 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ScaleKernelInfo &info); 98 99 // Inherited methods overridden: 100 void run() override; 101 102 private: 103 struct Impl; 104 std::unique_ptr<Impl> _impl; 105 }; 106 } // namespace arm_compute 107 #endif /*ARM_COMPUTE_CLSCALE_H */ 108