xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/dynamic_fusion/sketch/gpu/operators/GpuReshape.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2023 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_DYNAMIC_FUSION_SKETCH_GPU_OPERATORS_GPURESHAPE
25 #define ARM_COMPUTE_DYNAMIC_FUSION_SKETCH_GPU_OPERATORS_GPURESHAPE
26 
27 #include "arm_compute/dynamic_fusion/sketch/attributes/ReshapeAttributes.h"
28 
29 namespace arm_compute
30 {
31 /** Forward declaration */
32 class ITensorInfo;
33 
34 namespace experimental
35 {
36 namespace dynamic_fusion
37 {
38 /** Forward declaration */
39 class GpuWorkloadContext;
40 class GpuWorkloadSketch;
41 
42 /** Operator interface. */
43 class GpuReshape final
44 {
45 public:
46     /** Attributes are a set of backend-agnostic parameters that define what an operator does */
47     using Attributes = ReshapeAttributes;
48 
49     /** Create an operator and fuse it into the workload sketch.
50      *    @note If @ref validate_op() fails, the creation also fails and may throw an error.
51      *    @note If @ref validate_op() fails, @p sketch remains unchanged and valid.
52      *
53      * Valid data type configurations:
54      * - Any
55      *
56      * Valid data layouts:
57      * - Any
58      *
59      * @param[in,out] sketch     Workload sketch into which the operator will be fused
60      * @param[in]     src        Input tensor info. Data type supported: All
61      * @param[in]     attributes Operator attributes
62      *
63      * @return Pointer for the destination tensor info
64      */
65     static ITensorInfo *create_op(GpuWorkloadSketch &sketch,
66                                   ITensorInfo       *src,
67                                   const Attributes &attributes);
68     /** Check if the operator configuration is supported, irrespective of fusion
69      *
70      * @param[in] context    Workload context within which the operator is running
71      * @param[in] src        Input tensor info.
72      * @param[in] attributes Operator attributes
73      *
74      * @return Status
75      */
76     static Status is_supported_op(const GpuWorkloadContext &context,
77                                   const ITensorInfo        *src,
78                                   const Attributes         &attributes);
79     /** Validate the operator and check if the its configuration is supported and if it can be fused into the workload sketch.
80      *
81      *  Parameters are similar to @ref GpuReshape::create_op()
82      *
83      * @return Status
84      */
85     static Status validate_op(const GpuWorkloadSketch &sketch,
86                               const ITensorInfo       *src,
87                               const Attributes        &attributes);
88 };
89 
90 } // namespace dynamic_fusion
91 } // namespace experimental
92 } // namespace arm_compute
93 #endif /* ARM_COMPUTE_DYNAMIC_FUSION_SKETCH_GPU_OPERATORS_GPURESHAPE */
94