arm_compute/runtime/CL/functions/CLThreshold.h

/*
 * Copyright (c) 2016-2020 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_CLTHRESHOLD_H
#define ARM_COMPUTE_CLTHRESHOLD_H

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

#include <cstdint>

namespace arm_compute
{
// Forward declarations
class ICLTensor;

/** Basic function to run @ref CLThresholdKernel */
class CLThreshold : public ICLSimpleFunction
{
public:
    /** Initialise the function's source, destination, thresholds and threshold type
     *
     * @param[in]  input       First tensor input. Data types supported: U8.
     * @param[out] output      Output tensor. Data types supported: U8.
     * @param[in]  threshold   Threshold. If upper threshold is specified, this will be used as the lower threshold.
     * @param[in]  false_value Value to assign when the condition is false.
     * @param[in]  true_value  value to assign when the condition is true.
     * @param[in]  type        Thresholding type. Can either be BINARY or RANGE.
     * @param[in]  upper       Upper threshold. Only used with RANGE thresholding
     */
    ARM_COMPUTE_DEPRECATED_REL(20.08)
    void configure(const ICLTensor *input, ICLTensor *output, uint8_t threshold,
                   uint8_t false_value = 0, uint8_t true_value = 0,
                   ThresholdType type = ThresholdType::BINARY, uint8_t upper = 0);
    /** Initialise the function's source, destination, thresholds and threshold type
     *
     * @param[in]  input  First tensor input. Data types supported: U8.
     * @param[out] output Output tensor. Data types supported: U8.
     * @param[in]  info   Threshold  descriptor
     */
    void configure(const ICLTensor *input, ICLTensor *output, const ThresholdKernelInfo &info);
    /** Initialise the function's source, destination, thresholds and threshold type
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           First tensor input. Data types supported: U8.
     * @param[out] output          Output tensor. Data types supported: U8.
     * @param[in]  info            Threshold descriptor
     */
    void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const ThresholdKernelInfo &info);
};
} // namespace arm_compute
#endif /*ARM_COMPUTE_CLTHRESHOLD_H */