• 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_CLERODE_H
25 #define ARM_COMPUTE_CLERODE_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
29 
30 #include <cstdint>
31 
32 namespace arm_compute
33 {
34 class CLCompileContext;
35 class ICLTensor;
36 
37 /** Basic function to execute erode. This function calls the following OpenCL kernels:
38 *
39 * -# @ref CLFillBorderKernel (executed if border_mode == CONSTANT or border_mode == REPLICATE)
40 * -# @ref CLErodeKernel
41  *
42  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
43  *
44 */
45 class CLErode : public ICLSimpleFunction
46 {
47 public:
48     /** Initialise the kernel's inputs, output and border mode
49      *
50      * @param[in,out] input                 First tensor input. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED)
51      * @param[out]    output                Output tensor. Data types supported: U8.
52      * @param[in]     border_mode           Border mode to use for the convolution.
53      * @param[in]     constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
54      */
55     void configure(ICLTensor *input, ICLTensor *output, BorderMode border_mode, uint8_t constant_border_value = 0);
56     /** Initialise the kernel's inputs, output and border mode
57      *
58      * @param[in]     compile_context       The compile context to be used.
59      * @param[in,out] input                 First tensor input. Data types supported: U8. (Written to only for @p border_mode != UNDEFINED)
60      * @param[out]    output                Output tensor. Data types supported: U8.
61      * @param[in]     border_mode           Border mode to use for the convolution.
62      * @param[in]     constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
63      */
64     void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, BorderMode border_mode, uint8_t constant_border_value = 0);
65 };
66 }
67 #endif /*ARM_COMPUTE_CLERODE_H */
68