aboutsummaryrefslogtreecommitdiff
path: root/arm_compute/runtime/CL/functions/CLComparison.h
blob: fca4b168b02379372b3eaf92beb36b29f9c61e2a (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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*
 * Copyright (c) 2018-2021 Arm Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef ARM_COMPUTE_CLCOMPARISON_H
#define ARM_COMPUTE_CLCOMPARISON_H

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

namespace arm_compute
{
// Forward declarations
class CLCompileContext;
class ICLTensor;
class ITensorInfo;

/** Basic function to run @ref CLComparisonKernel */
class CLComparison : public ICLSimpleFunction
{
public:
    /** Initialise the kernel's inputs and outputs.
     *
     * Valid data layouts:
     * - All
     *
     * Valid data type configurations:
     * |src0     |src1     |dst      |
     * |:--------|:--------|:--------|
     * |All      |All      |U8       |
     *
     * @param[in]  input1    Source tensor. Data types supported: All.
     *                       The input1 tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
     * @param[in]  input2    Source tensor. Data types supported: Same as @p input1.
     *                       The input2 tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
     * @param[out] output    Destination tensor. Data types supported: U8.
     * @param[out] operation Comparison operation to be used.
     */
    void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output, ComparisonOperation operation);
    /** Initialise the kernel's inputs and outputs.
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input1          Source tensor. Data types supported: All.
     *                             The input1 tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
     * @param[in]  input2          Source tensor. Data types supported: Same as @p input1.
     *                             The input2 tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
     * @param[out] output          Destination tensor. Data types supported: U8.
     * @param[out] operation       Comparison operation to be used.
     */
    void configure(const CLCompileContext &compile_context,
                   ICLTensor              *input1,
                   ICLTensor              *input2,
                   ICLTensor              *output,
                   ComparisonOperation     operation);
    /** Static function to check if given info will lead to a valid configuration of @ref CLComparison
     *
     * @param[in]  input1    Source tensor. Data types supported: All.
     * @param[in]  input2    Source tensor. Data types supported: Same as @p input1.
     * @param[in]  output    Destination tensor. Data types supported: U8.
     * @param[out] operation Comparison operation to be used.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo  *input1,
                           const ITensorInfo  *input2,
                           const ITensorInfo  *output,
                           ComparisonOperation operation);
};

/** Basic function to run @ref CLComparisonKernel */
template <ComparisonOperation COP>
class CLComparisonStatic : public ICLSimpleFunction
{
public:
    static constexpr ComparisonOperation operation = COP; /** Comparison operations used by the class */

public:
    /** Initialise the kernel's inputs and outputs.
     *
     * @param[in]  input1 Source tensor. Data types supported: All.
     *                    The input1 tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
     * @param[in]  input2 Source tensor. Data types supported: Same as @p input1.
     *                    The input2 tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
     * @param[out] output Destination tensor. Data types supported: U8.
     */
    void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output);
    /** Comparison operations used by the class */

public:
    /** Initialise the kernel's inputs and outputs.
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input1          Source tensor. Data types supported: All.
     *                             The input1 tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
     * @param[in]  input2          Source tensor. Data types supported: Same as @p input1.
     *                             The input2 tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0.
     * @param[out] output          Destination tensor. Data types supported: U8.
     */
    void configure(const CLCompileContext &compile_context, ICLTensor *input1, ICLTensor *input2, ICLTensor *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLComparison
     *
     * @param[in] input1 Source tensor. Data types supported: All.
     * @param[in] input2 Source tensor. Data types supported: Same as @p input1.
     * @param[in] output Destination tensor. Data types supported: U8.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output);
};

/** Basic function to run equal comparison. */
using CLEqual = CLComparisonStatic<ComparisonOperation::Equal>;
/** Basic function to run not equal comparison. */
using CLNotEqual = CLComparisonStatic<ComparisonOperation::NotEqual>;
/** Basic function to run greater comparison. */
using CLGreater = CLComparisonStatic<ComparisonOperation::Greater>;
/** Basic function to run greater-equal comparison. */
using CLGreaterEqual = CLComparisonStatic<ComparisonOperation::GreaterEqual>;
/** Basic function to run less comparison. */
using CLLess = CLComparisonStatic<ComparisonOperation::Less>;
/** Basic function to run less-equal comparison. */
using CLLessEqual = CLComparisonStatic<ComparisonOperation::LessEqual>;
} // namespace arm_compute
#endif /* ARM_COMPUTE_CLCOMPARISON_H */