summaryrefslogtreecommitdiff
path: root/libs/ARMComputeEx/arm_compute/runtime/CL/functions/CLArithmeticSubtractionEx.h
blob: 34e6c6334a7a72120c5875223e8a1385686c4815 (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
/*
 * 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_CLARITHMETICSUBTRACTIONEX_H__
#define __ARM_COMPUTE_CLARITHMETICSUBTRACTIONEX_H__

#include "arm_compute/runtime/CL/ICLSimpleFunction.h"

namespace arm_compute
{
class ICLTensor;

/** Basic function to run @ref CLArithmeticSubtractionExKernel
 *
 * @note The tensor data type for the inputs must be U8/S16/F16/F32.
 * @note The function performs an arithmetic subtraction between two tensors.
 */
class CLArithmeticSubtractionEx : public ICLSimpleFunction
{
public:
  /** Initialise the kernel's inputs, output and convertion policy.
   *
   * @param[in, out] input1 An input tensor. Data types supported: U8/S16/F16/F32.
   *                        The input tensor is [in, out] because its TensorInfo might be modified
   * inside the kernel in case of broadcasting of dimension 0.
   * @param[in, out] input2 An input tensor. Data types supported: same as @p input1.
   *                        The input tensor is [in, out] because its TensorInfo might be modified
   * inside the kernel in case of broadcasting of dimension 0.
   * @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(ICLTensor *input1, ICLTensor *input2, ICLTensor *output, ConvertPolicy policy);
  /** Static function to check if given info will lead to a valid configuration of @ref
   * CLArithmeticSubtractionEx
   *
   * @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);
};
}
#endif /* __ARM_COMPUTE_CLARITHMETICSUBTRACTIONEX_H__ */