summaryrefslogtreecommitdiff
path: root/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLPixelWiseDivisionKernel.h
blob: d579f5d8fae94394ef7edeece98b97a833837050 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/*
 * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
 * Copyright (c) 2016-2018 ARM Limited.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file      CLPixelWiseDivisionKernel.h
 * @ingroup   COM_AI_RUNTIME
 * @brief     This file defines CLPixelWiseDivisionKernel class
 */

#ifndef __ARM_COMPUTE_CLPIXELWISEDIVISIONKERNEL_H__
#define __ARM_COMPUTE_CLPIXELWISEDIVISIONKERNEL_H__

#include "arm_compute/core/CL/ICLKernel.h"

namespace arm_compute
{
class ICLTensor;

/**
 * @brief Interface for the pixelwise division kernel.
 */
class CLPixelWiseDivisionKernel : public ICLKernel
{
public:
  /**
   * @brief Construct a CLPixelWiseDivisionKernel object
   */
  CLPixelWiseDivisionKernel();

  /**
   * @brief Prevent instances of this class from being copied (As this class contains pointers).
   */
  CLPixelWiseDivisionKernel(const CLPixelWiseDivisionKernel &) = delete;

  /**
   * @brief Prevent instances of this class from being copied (As this class contains pointers).
   */
  CLPixelWiseDivisionKernel &operator=(const CLPixelWiseDivisionKernel &) = delete;

  /**
   * @brief Construct a CLPixelWiseDivisionKernel object by using move constructor
   * @param[in] CLPixelWiseDivisionKernel object to move
   */
  CLPixelWiseDivisionKernel(CLPixelWiseDivisionKernel &&) = default;

  /**
   * @brief Allow instances of this class to be moved
   * @param[in] CLPixelWiseDivisionKernel object to move
   */
  CLPixelWiseDivisionKernel &operator=(CLPixelWiseDivisionKernel &&) = default;

  /**
   * @brief Initialise the kernel's input, output and border mode.
   * @param[in]  input1          An input tensor. Data types supported: U8/S16/F16/F32.
   * @param[in]  input2          An input tensor. Data types supported: same as @p input1.
   * @param[out] output          The output tensor, Data types supported: same as @p input1. Note:
   * U8 requires both inputs to be U8.
   * @param[in]  scale           Scale to apply after division.
   *                             Scale must be positive and its value must be either 1/255 or 1/2^n
   *                             where n is between 0 and 15.
   * @param[in]  overflow_policy Overflow policy. Supported overflow policies: Wrap, Saturate
   * @param[in]  rounding_policy Rounding policy. Supported rounding modes: to zero, to nearest
   * even.
   * @return N/A
   */
  void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, float scale,
                 ConvertPolicy overflow_policy, RoundingPolicy rounding_policy);

  /**
   * @brief Static function to check if given info will lead to a valid configuration of @ref
   * CLPixelWiseDivisionKernel
   * @param[in] input1          An input tensor info. Data types supported: U8/S16/F16/F32.
   * @param[in] input2          An input tensor info. Data types supported: same as @p input1.
   * @param[in] output          The output tensor info, Data types supported: same as @p input1.
   * Note: U8 requires both inputs to be U8.
   * @param[in] scale           Scale to apply after division.
   *                            Scale must be positive and its value must be either 1/255 or 1/2^n
   * where n is between 0 and 15.
   * @param[in] overflow_policy Overflow policy. Supported overflow policies: Wrap, Saturate
   * @param[in] rounding_policy Rounding policy. Supported rounding modes: to zero, to nearest even.
   * @return a status
   */
  static Status validate(const ITensorInfo *input1, const ITensorInfo *input2,
                         const ITensorInfo *output, float scale, ConvertPolicy overflow_policy,
                         RoundingPolicy rounding_policy);

  /**
   * @brief Enqueue the OpenCL kernel to process the given window on the passed OpenCL command
   *        queue.
   * @note  The queue is *not* flushed by this method, and therefore the kernel will not have
   *        been executed by the time this method returns.
   * @param[in] window      Region on which to execute the kernel. (Must be a valid region of
   *                        the window returned by window()).
   * @param[in,out] queue   Command queue on which to enqueue the kernel.@return N/A
   * @return N/A
   */
  void run(const Window &window, cl::CommandQueue &queue) override;

  /**
   * @brief The size of the border for that kernel
   * @return The width in number of elements of the border.
   */
  BorderSize border_size() const override;

private:
  const ICLTensor *_input1;
  const ICLTensor *_input2;
  ICLTensor *_output;
};
} // namespace arm_compute
#endif /*__ARM_COMPUTE_CLPIXELWISEDIVISIONKERNEL_H__ */