Compute Library
 21.02
NEFlattenLayer.h
Go to the documentation of this file.
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_NEFLATTENLAYER_H
25 #define ARM_COMPUTE_NEFLATTENLAYER_H
26 
27 #include "arm_compute/core/Types.h"
30 
31 namespace arm_compute
32 {
33 class ITensor;
34 class ITensorInfo;
35 
36 /** Basic function to execute flatten layer kernel. */
37 class NEFlattenLayer : public IFunction
38 {
39 public:
40  /** Initialise the kernel's input and output.
41  *
42  * @param[in] input First input tensor to flatten with at least 3 dimensions. The dimensions over the third will be interpreted as batches. Data types supported: All
43  * @param[out] output Output tensor with shape [w*h*d, input_batches] where:
44  * w = width input tensor, h = height input tensor and d = depth input tensor. Data type supported: same as @p input
45  */
46  void configure(const ITensor *input, ITensor *output);
47 
48  /** Static function to check if given info will lead to a valid configuration of @ref NEFlattenLayer
49  *
50  * @param[in] input First input tensor to flatten with at least 3 dimensions.
51  * The dimensions above the third will be interpreted as batches. Data types supported: All
52  * @param[out] output Output tensor with shape [w*h*d, input_batches] where:
53  * w = width input tensor, h = height input tensor and d = depth input tensor. Data type supported: same as @p input
54  *
55  * @return a status
56  */
57  static Status validate(const ITensorInfo *input, const ITensorInfo *output);
58 
59  // Inherited methods overridden:
60  void run() override;
61 
62 private:
63  NEReshapeLayer _reshape{};
64 };
65 } // namespace arm_compute
66 
67 #endif /* ARM_COMPUTE_NEFLATTENLAYER_H */
Base class for all functions.
Definition: IFunction.h:30
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
void run() override
Run the kernels contained in the function.
void configure(const ITensor *input, ITensor *output)
Initialise the kernel's input and output.
Basic function to run cpu::kernels::CpuReshapeKernel.
Basic function to execute flatten layer kernel.
static Status validate(const ITensorInfo *input, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of NEFlattenLayer.