xref: /aosp_15_r20/external/armnn/src/armnn/layers/BatchMatMulLayer.hpp (revision 89c4ff92f2867872bb9e2354d150bf0c8c502810)
1 //
2 // Copyright © 2022 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 
6 #pragma once
7 
8 #include "LayerWithParameters.hpp"
9 
10 namespace armnn
11 {
12 
13 class BatchMatMulLayer : public LayerWithParameters<BatchMatMulDescriptor>
14 {
15 public:
16     /// Makes a workload for the BatchMatMul 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     BatchMatMulLayer* Clone(Graph &graph) const override;
25 
26     /// Infers the output shape from the given input shapes.
27     /// @param [in] inputShapes The vector of input shapes for BatchMatMul.
28     /// @return A vector of inferred output shape.
29     std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
30 
31     /// Check if the input tensor shapes
32     /// will lead to a valid configuration of @ref BatchMatMulLayer.
33     /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
34     void ValidateTensorShapesFromInputs() override;
35 
36 protected:
37     /// Constructor to create a BatchMatMulLayer.
38     /// @param [in] param BatchMatMulDescriptor to configure optional parameters for batch matrix multiplication
39     /// @param [in] name Optional name for the layer
40     BatchMatMulLayer(const BatchMatMulDescriptor& param, const char* name);
41 
42     /// Default destructor
43     ~BatchMatMulLayer() = default;
44 };
45 
46 }