arm_compute v17.04
[platform/upstream/armcl.git] / arm_compute / core / NEON / kernels / NEGaussianPyramidKernel.h
1 /*
2  * Copyright (c) 2016, 2017 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_NEGAUSSIANPYRAMIDKERNEL_H__
25 #define __ARM_COMPUTE_NEGAUSSIANPYRAMIDKERNEL_H__
26
27 #include "arm_compute/core/NEON/INESimpleKernel.h"
28
29 namespace arm_compute
30 {
31 class ITensor;
32
33 /** NEON kernel to perform a GaussianPyramid (horizontal pass) */
34 class NEGaussianPyramidHorKernel : public INESimpleKernel
35 {
36 public:
37     /** Default constructor */
38     NEGaussianPyramidHorKernel();
39     /** Prevent instances of this class from being copied (As this class contains pointers) */
40     NEGaussianPyramidHorKernel(NEGaussianPyramidHorKernel &) = delete;
41     /** Prevent instances of this class from being copied (As this class contains pointers) */
42     NEGaussianPyramidHorKernel &operator=(NEGaussianPyramidHorKernel &) = delete;
43     /** Allow instances of this class to be moved */
44     NEGaussianPyramidHorKernel(NEGaussianPyramidHorKernel &&) = default;
45     /** Allow instances of this class to be moved */
46     NEGaussianPyramidHorKernel &operator=(NEGaussianPyramidHorKernel &&) = default;
47     /** Default destructor */
48     ~NEGaussianPyramidHorKernel() = default;
49
50     /** Initialise the kernel's source, destination and border mode.
51      *
52      * @param[in]  input            Source tensor. Data type supported: U8.
53      * @param[out] output           Destination tensor. Data type supported: S16.
54      * @param[in]  border_undefined True if the border mode is undefined. False if it's replicate or constant.
55      */
56     void configure(const ITensor *input, ITensor *output, bool border_undefined);
57
58     // Inherited methods overridden:
59     void run(const Window &window) override;
60     BorderSize border_size() const override;
61
62 private:
63     BorderSize _border_size;
64     int        _l2_load_offset;
65 };
66
67 /** NEON kernel to perform a GaussianPyramid (vertical pass) */
68 class NEGaussianPyramidVertKernel : public INESimpleKernel
69 {
70 public:
71     /** Default constructor */
72     NEGaussianPyramidVertKernel();
73     /** Prevent instances of this class from being copied (As this class contains pointers) */
74     NEGaussianPyramidVertKernel(NEGaussianPyramidVertKernel &) = delete;
75     /** Prevent instances of this class from being copied (As this class contains pointers) */
76     NEGaussianPyramidVertKernel &operator=(NEGaussianPyramidVertKernel &) = delete;
77     /** Allow instances of this class to be moved */
78     NEGaussianPyramidVertKernel(NEGaussianPyramidVertKernel &&) = default;
79     /** Allow instances of this class to be moved */
80     NEGaussianPyramidVertKernel &operator=(NEGaussianPyramidVertKernel &&) = default;
81     /** Default destructor */
82     ~NEGaussianPyramidVertKernel() = default;
83
84     /** Initialise the kernel's source, destination and border mode.
85      *
86      * @param[in]  input            Source tensor. Data type supported: S16.
87      * @param[out] output           Destination tensor. Data type supported: U8.
88      * @param[in]  border_undefined True if the border mode is undefined. False if it's replicate or constant.
89      */
90     void configure(const ITensor *input, ITensor *output, bool border_undefined);
91
92     // Inherited methods overridden:
93     void run(const Window &window) override;
94     BorderSize border_size() const override;
95
96 private:
97     int _t2_load_offset;
98 };
99 }
100 #endif /*__ARM_COMPUTE_NEGAUSSIANPYRAMIDKERNEL_H__ */