• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2017-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_CLMINMAXLAYERKERNEL_H
25 #define ARM_COMPUTE_CLMINMAXLAYERKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
32 
33 /** Interface for the kernel to perform min max search on a 3D tensor.
34  */
35 class CLMinMaxLayerKernel : public ICLKernel
36 {
37 public:
38     /** Default constructor */
39     CLMinMaxLayerKernel();
40     /** Prevent instances of this class from being copied (As this class contains pointers) */
41     CLMinMaxLayerKernel(const CLMinMaxLayerKernel &) = delete;
42     /** Prevent instances of this class from being copied (As this class contains pointers) */
43     CLMinMaxLayerKernel &operator=(const CLMinMaxLayerKernel &) = delete;
44     /** Allow instances of this class to be moved */
45     CLMinMaxLayerKernel(CLMinMaxLayerKernel &&) = default;
46     /** Allow instances of this class to be moved */
47     CLMinMaxLayerKernel &operator=(CLMinMaxLayerKernel &&) = default;
48     /** Initialise the kernel's input and output.
49      *
50      * @param[in]  input  Input tensor with at least 3 dimensions. The dimensions over the third will be interpreted as batches.Data types supported: F32.
51      * @param[out] output Output tensor with shape [2, batches, ...] which stores the minimum and maximum values for each 3D input tensor.
52      *                    The dimensions over the second must match the batched dimensions of the input tensor. Data types supported: F32.
53      */
54     void configure(const ICLTensor *input, ICLTensor *output);
55     /** Initialise the kernel's input and output.
56      *
57      * @param[in]  compile_context The compile context to be used.
58      * @param[in]  input           Input tensor with at least 3 dimensions. The dimensions over the third will be interpreted as batches.Data types supported: F32.
59      * @param[out] output          Output tensor with shape [2, batches, ...] which stores the minimum and maximum values for each 3D input tensor.
60      *                    The dimensions over the second must match the batched dimensions of the input tensor. Data types supported: F32.
61      */
62     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
63     /** Static function to check if given info will lead to a valid configuration of @ref CLMinMaxLayerKernel
64      *
65      * @param[in] input  Input tensor info.  Data types supported: F32.
66      * @param[in] output Output tensor info with shape [2, batches, ...] which stores the minimum and maximum values for each 3D input tensor.
67      *                   The dimensions over the second must match the batched dimensions of the input tensor. Data types supported: F32.
68      *
69      * @return a status
70      */
71     static Status validate(const ITensorInfo *input, const ITensorInfo *output);
72 
73     /** Resets global minimum and maximum
74      *
75      * @param[in,out] queue Command queue on which to map and unmap the min_max tensor
76      */
77     void reset(cl::CommandQueue &queue);
78 
79     // Inherited methods overridden:
80     void run(const Window &window, cl::CommandQueue &queue) override;
81 
82 private:
83     const ICLTensor *_input;
84     ICLTensor       *_output;
85 };
86 } // namespace arm_compute
87 #endif /*ARM_COMPUTE_CLMINMAXLAYERKERNEL_H */
88