summaryrefslogtreecommitdiff
path: root/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLArithmeticSubtractionExKernel.h
blob: 9a765f310ba1fda093816bff0a14e16367e53155 (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
/*
 * 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.
 */
#ifndef __ARM_COMPUTE_CLARITHMETICSUBTRACTIONEXKERNEL_H__
#define __ARM_COMPUTE_CLARITHMETICSUBTRACTIONEXKERNEL_H__

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

namespace arm_compute
{
class ICLTensor;

/** Interface for the arithmetic subtraction kernel (support broadcasting)
 *
 * Arithmetic subtraction is computed by:
 * @f[ output(x,y) = input1(x,y) - input2(x,y) @f]
 */
class CLArithmeticSubtractionExKernel : public ICLKernel
{
public:
  /** Default constructor */
  CLArithmeticSubtractionExKernel();
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  CLArithmeticSubtractionExKernel(const CLArithmeticSubtractionExKernel &) = delete;
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  CLArithmeticSubtractionExKernel &operator=(const CLArithmeticSubtractionExKernel &) = delete;
  /** Allow instances of this class to be moved */
  CLArithmeticSubtractionExKernel(CLArithmeticSubtractionExKernel &&) = default;
  /** Allow instances of this class to be moved */
  CLArithmeticSubtractionExKernel &operator=(CLArithmeticSubtractionExKernel &&) = default;
  /** Default destructor */
  ~CLArithmeticSubtractionExKernel() = default;

  /** Initialise the kernel's inputs, output and convertion policy.
   *
   * @param[in]  input1 First tensor input. Data types supported: U8/S16/F16/F32.
   * @param[in]  input2 Second tensor input. Data types supported: U8/S16/F16/F32.
   * @param[out] output Output tensor. Data types supported: U8 (Only if both inputs are U8),
   * S16/F16/F32.
   * @param[in]  policy Policy to use to handle overflow.
   */
  void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output,
                 ConvertPolicy policy);
  /** Static function to check if given info will lead to a valid configuration of @ref
   * CLArithmeticSubtractionExKernel
   *
   * @param[in] input1 First tensor input info. Data types supported: U8/S16/F16/F32.
   * @param[in] input2 Second tensor input info. Data types supported: U8/S16/F16/F32.
   * @param[in] output Output tensor info. Data types supported: U8 (Only if both inputs are U8),
   * S16/F16/F32.
   * @param[in] policy Policy to use to handle overflow.
   *
   * @return a status
   */
  static Status validate(const ITensorInfo *input1, const ITensorInfo *input2,
                         const ITensorInfo *output, ConvertPolicy policy);

  // Inherited methods overridden:
  void run(const Window &window, cl::CommandQueue &queue) override;
  BorderSize border_size() const override;

private:
  const ICLTensor *_input1; /**< Source tensor 1 */
  const ICLTensor *_input2; /**< Source tensor 2 */
  ICLTensor *_output;       /**< Destination tensor */
};
} // namespace arm_compute
#endif /* __ARM_COMPUTE_CLARITHMETICSUBTRACTIONEXKERNEL_H__ */