xref: /aosp_15_r20/external/armnn/src/armnn/layers/BatchToSpaceNdLayer.hpp (revision 89c4ff92f2867872bb9e2354d150bf0c8c502810)
1 //
2 // Copyright © 2017 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 #pragma once
6 
7 #include "LayerWithParameters.hpp"
8 
9 namespace armnn
10 {
11 
12 /// This layer represents a BatchToSpaceNd operation.
13 class BatchToSpaceNdLayer : public LayerWithParameters<BatchToSpaceNdDescriptor>
14 {
15 public:
16     /// Makes a workload for the BatchToSpaceNd type.
17     /// @param [in] graph The graph where this layer can be found.
18     /// @param [in] factory The workload factory which will create the workload.
19     /// @return A pointer to the created workload, or nullptr if not created.
20     virtual std::unique_ptr<IWorkload> CreateWorkload(const IWorkloadFactory& factory) const override;
21 
22     /// Creates a dynamically-allocated copy of this layer.
23     /// @param [in] graph The graph into which this layer is being cloned.
24     BatchToSpaceNdLayer* Clone(Graph& graph) const override;
25 
26     /// Check if the input tensor shape(s)
27     /// will lead to a valid configuration of @ref BatchToSpaceNdLayer.
28     /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
29     void ValidateTensorShapesFromInputs() override;
30 
31     /// By default returns inputShapes if the number of inputs are equal to number of outputs,
32     /// otherwise infers the output shapes from given input shapes and layer properties.
33     /// @param [in] inputShapes The input shapes layer has.
34     /// @return A vector to the inferred output shape.
35     std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
36 
37     void ExecuteStrategy(IStrategy& strategy) const override;
38 
39 protected:
40     /// Constructor to create a BatchToSpaceNdLayer.
41     /// @param [in] param BatchToSpaceNdDescriptor to configure the BatchToSpaceNd operation.
42     /// @param [in] name Optional name for the layer.
43     BatchToSpaceNdLayer(const BatchToSpaceNdDescriptor& param, const char* name);
44 
45     /// Default destructor
46     ~BatchToSpaceNdLayer() = default;
47 };
48 
49 } // namespace
50