1 /* 2 * Copyright (c) 2016-2020 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/CL/ICLSimpleFunction.h" 30 31 #include <cstdint> 32 33 namespace arm_compute 34 { 35 class CLCompileContext; 36 class ICLTensor; 37 class ITensorInfo; 38 39 /** Basic function to run @ref CLScaleKernel */ 40 class CLScale : public ICLSimpleFunction 41 { 42 public: 43 /** Initialize the function's source, destination, interpolation type and border_mode. 44 * 45 * @param[in,out] input Source tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. (Written to only for @p border_mode != UNDEFINED) 46 * @param[out] output Destination tensor. Data types supported: Same as @p input 47 * 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. 48 * @param[in] info @ref ScaleKernelInfo descriptor to be used to configure 49 */ 50 void configure(ICLTensor *input, ICLTensor *output, const ScaleKernelInfo &info); 51 /** Initialize the function's source, destination, interpolation type and border_mode. 52 * 53 * @param[in] compile_context The compile context to be used. 54 * @param[in,out] input Source tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. (Written to only for @p border_mode != UNDEFINED) 55 * @param[out] output Destination tensor. Data types supported: Same as @p input 56 * 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. 57 * @param[in] info @ref ScaleKernelInfo descriptor to be used to configure 58 */ 59 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const ScaleKernelInfo &info); 60 /** Initialize the function's source, destination, interpolation type and border_mode. 61 * 62 * @param[in,out] input Source tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. (Written to only for @p border_mode != UNDEFINED) 63 * @param[out] output Destination tensor. Data types supported: Same as @p input 64 * 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. 65 * @param[in] policy The interpolation type. 66 * @param[in] border_mode Strategy to use for borders. 67 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 68 * @param[in] sampling_policy (Optional) Sampling policy used by the interpolation. Defaults to @ref SamplingPolicy::CENTER 69 * @param[in] use_padding (Optional) Is padding in use or not. Defaults to true. 70 * @param[in] align_corners (Optional) Align corners of input and output, only affecting bilinear policy with TOP_LEFT sampling policy. Defaults to false. 71 */ 72 ARM_COMPUTE_DEPRECATED_REL(20.08) 73 void configure(ICLTensor *input, ICLTensor *output, InterpolationPolicy policy, BorderMode border_mode, PixelValue constant_border_value = PixelValue(), 74 SamplingPolicy sampling_policy = SamplingPolicy::CENTER, bool use_padding = true, bool align_corners = false); 75 /** Initialize the function's source, destination, interpolation type and border_mode. 76 * 77 * @param[in] compile_context The compile context to be used. 78 * @param[in,out] input Source tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. (Written to only for @p border_mode != UNDEFINED) 79 * @param[out] output Destination tensor. Data types supported: Same as @p input 80 * 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. 81 * @param[in] policy The interpolation type. 82 * @param[in] border_mode Strategy to use for borders. 83 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 84 * @param[in] sampling_policy (Optional) Sampling policy used by the interpolation. Defaults to @ref SamplingPolicy::CENTER 85 * @param[in] use_padding (Optional) Is padding in use or not. Defaults to true. 86 * @param[in] align_corners (Optional) Align corners of input and output, only affecting bilinear policy with TOP_LEFT sampling policy. Defaults to false. 87 */ 88 ARM_COMPUTE_DEPRECATED_REL(20.08) 89 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, InterpolationPolicy policy, BorderMode border_mode, PixelValue constant_border_value = PixelValue(), 90 SamplingPolicy sampling_policy = SamplingPolicy::CENTER, bool use_padding = true, bool align_corners = false); 91 92 /** Static function to check if given info will lead to a valid configuration of @ref CLScale 93 * 94 * @param[in] input Source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. 95 * @param[in] output Output tensor info. Data type supported: Same as @p input 96 * 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. 97 * @param[in] info @ref ScaleKernelInfo descriptor to be used to validate 98 * 99 * @return a status 100 */ 101 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ScaleKernelInfo &info); 102 /** Static function to check if given info will lead to a valid configuration of @ref CLScale 103 * 104 * @param[in] input Source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. 105 * @param[in] output Output tensor info. Data type supported: Same as @p input 106 * 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. 107 * @param[in] policy The interpolation type. 108 * @param[in] border_mode Strategy to use for borders. 109 * @param[in] constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT. 110 * @param[in] sampling_policy (Optional) Sampling policy used by the interpolation. Defaults to @ref SamplingPolicy::CENTER 111 * @param[in] use_padding (Optional) Is padding in use or not. Defaults to true. 112 * @param[in] align_corners (Optional) Align corners of input and output, only affecting bilinear policy with TOP_LEFT sampling policy. Defaults to false. 113 * 114 * @return a status 115 */ 116 ARM_COMPUTE_DEPRECATED_REL(20.08) 117 static Status validate(const ITensorInfo *input, const ITensorInfo *output, InterpolationPolicy policy, BorderMode border_mode, PixelValue constant_border_value = PixelValue(), 118 SamplingPolicy sampling_policy = SamplingPolicy::CENTER, bool use_padding = true, bool align_corners = false); 119 }; 120 } 121 #endif /*ARM_COMPUTE_CLSCALE_H */ 122