• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_CLTHRESHOLD_H
25 #define ARM_COMPUTE_CLTHRESHOLD_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 // Forward declarations
36 class CLCompileContext;
37 class ICLTensor;
38 
39 /** Basic function to run @ref CLThresholdKernel
40  *
41  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
42  *
43 */
44 class CLThreshold : public ICLSimpleFunction
45 {
46 public:
47     /** Initialise the function's source, destination, thresholds and threshold type
48      *
49      * @param[in]  input       First tensor input. Data types supported: U8.
50      * @param[out] output      Output tensor. Data types supported: U8.
51      * @param[in]  threshold   Threshold. If upper threshold is specified, this will be used as the lower threshold.
52      * @param[in]  false_value Value to assign when the condition is false.
53      * @param[in]  true_value  value to assign when the condition is true.
54      * @param[in]  type        Thresholding type. Can either be BINARY or RANGE.
55      * @param[in]  upper       Upper threshold. Only used with RANGE thresholding
56      */
57     ARM_COMPUTE_DEPRECATED_REL(20.08)
58     void configure(const ICLTensor *input, ICLTensor *output, uint8_t threshold,
59                    uint8_t false_value = 0, uint8_t true_value = 0,
60                    ThresholdType type = ThresholdType::BINARY, uint8_t upper = 0);
61     /** Initialise the function's source, destination, thresholds and threshold type
62      *
63      * @param[in]  input  First tensor input. Data types supported: U8.
64      * @param[out] output Output tensor. Data types supported: U8.
65      * @param[in]  info   Threshold  descriptor
66      */
67     void configure(const ICLTensor *input, ICLTensor *output, const ThresholdKernelInfo &info);
68     /** Initialise the function's source, destination, thresholds and threshold type
69      *
70      * @param[in]  compile_context The compile context to be used.
71      * @param[in]  input           First tensor input. Data types supported: U8.
72      * @param[out] output          Output tensor. Data types supported: U8.
73      * @param[in]  info            Threshold descriptor
74      */
75     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const ThresholdKernelInfo &info);
76 };
77 } // namespace arm_compute
78 #endif /*ARM_COMPUTE_CLTHRESHOLD_H */
79