xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/operators/CpuFlatten.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2021 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_CPU_FLATTEN_H
25 #define ARM_COMPUTE_CPU_FLATTEN_H
26 
27 #include "src/cpu/ICpuOperator.h"
28 
29 namespace arm_compute
30 {
31 namespace cpu
32 {
33 /** Basic function to flatten a given input */
34 class CpuFlatten : public ICpuOperator
35 {
36 public:
37     /** Configure operator for a given list of arguments
38      *
39      * Valid data layouts:
40      * - All
41      *
42      * Valid data type configurations:
43      * |src            |dst            |
44      * |:--------------|:--------------|
45      * |All            |All            |
46      *
47      * @param[in] src Source tensor to flatten with at least 3 dimensions.
48      *                The dimensions above the third will be interpreted as batches. Data types supported: All
49      * @param[in] dst Destination tensor with shape [w*h*d, input_batches] where:
50      *                            w = width input tensor, h = height input tensor and d = depth input tensor.
51      *                            Data type supported: same as @p src
52      */
53     void configure(const ITensorInfo *src, ITensorInfo *dst);
54     /** Static function to check if given info will lead to a valid configuration
55      *
56      * Similar to @ref CpuFlatten::configure()
57      *
58      * @return a status
59      */
60     static Status validate(const ITensorInfo *src, const ITensorInfo *dst);
61 };
62 } // namespace cpu
63 } // namespace arm_compute
64 #endif /* ARM_COMPUTE_CPU_FLATTEN_H */
65