patch/Documentation/_batch_to_space_nd_layer_8cpp_source.html

 //
 // Copyright © 2017 Arm Ltd. All rights reserved.
 // SPDX-License-Identifier: MIT
 //

 #include "BatchToSpaceNdLayer.hpp"
 #include "LayerCloneBase.hpp"
 #include "LayerWithParameters.hpp"
 #include "BatchToSpaceNdLayer.hpp"

 #include <armnn/TypesUtils.hpp>

 #include <armnnUtils/DataLayoutIndexed.hpp>

 #include <backendsCommon/CpuTensorHandle.hpp>
 #include <backendsCommon/WorkloadData.hpp>
 #include <backendsCommon/WorkloadFactory.hpp>

 #include <numeric>

 using namespace armnnUtils;

 namespace armnn
 {

 BatchToSpaceNdLayer::BatchToSpaceNdLayer(const armnn::BatchToSpaceNdDescriptor& param, const char* name)
     : LayerWithParameters(1, 1, LayerType::BatchToSpaceNd, param, name)
 {
 }

 std::unique_ptr<IWorkload> BatchToSpaceNdLayer::CreateWorkload(const IWorkloadFactory& factory) const
 {
     BatchToSpaceNdQueueDescriptor descriptor;

     return factory.CreateBatchToSpaceNd(descriptor, PrepInfoAndDesc(descriptor));
 }

 BatchToSpaceNdLayer* BatchToSpaceNdLayer::Clone(Graph& graph) const
 {
     auto layer = CloneBase<BatchToSpaceNdLayer>(graph, m_Param, GetName());
     return std::move(layer);
 }

 void BatchToSpaceNdLayer::ValidateTensorShapesFromInputs()
 {
     VerifyLayerConnections(1, CHECK_LOCATION());

     auto inferredShapes = InferOutputShapes({GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape()});

     BOOST_ASSERT(inferredShapes.size() == 1);

     ConditionalThrowIfNotEqual<LayerValidationException>(
         "BatchToSpaceLayer: TensorShape set on OutputSlot[0] does not match the inferred shape.",
         GetOutputSlot(0).GetTensorInfo().GetShape(),inferredShapes[0]);
 }

 std::vector<TensorShape> BatchToSpaceNdLayer::InferOutputShapes(const std::vector<TensorShape>& inputShapes) const
 {
     BOOST_ASSERT(inputShapes.size() == 1);

     const TensorShape& inputShape = inputShapes[0];
     TensorShape outputShape(inputShape);

     unsigned int accumulatedBlockShape = std::accumulate(m_Param.m_BlockShape.begin(),
                                                          m_Param.m_BlockShape.end(),
                                                          1U,
                                                          std::multiplies<>());

     BOOST_ASSERT(inputShape[0] % accumulatedBlockShape == 0);

     outputShape[0] = inputShape[0] / accumulatedBlockShape;

     DataLayoutIndexed dimensionIndices = m_Param.m_DataLayout;
     unsigned int heightIndex = dimensionIndices.GetHeightIndex();
     unsigned int widthIndex = dimensionIndices.GetWidthIndex();

     unsigned int heightCrop = m_Param.m_Crops[0].first + m_Param.m_Crops[0].second;
     unsigned int widthCrop = m_Param.m_Crops[1].first + m_Param.m_Crops[1].second;

     unsigned int outputHeight = inputShape[heightIndex] * m_Param.m_BlockShape[0];
     unsigned int outputWidth = inputShape[widthIndex] * m_Param.m_BlockShape[1];

     BOOST_ASSERT_MSG(heightCrop <= outputHeight,
         "BatchToSpaceLayer: Overall height crop should be less than or equal to the uncropped output height.");

     BOOST_ASSERT_MSG(widthCrop <= outputWidth,
         "BatchToSpaceLayer: Overall width crop should be less than or equal to the uncropped output width.");

     outputShape[heightIndex] = outputHeight - heightCrop;
     outputShape[widthIndex] = outputWidth - widthCrop;

     return std::vector<TensorShape>({ outputShape });
 }

 void BatchToSpaceNdLayer::Accept(ILayerVisitor& visitor) const
 {
     visitor.VisitBatchToSpaceNdLayer(this, GetParameters(), GetName());
 }

 } // namespace armnn
armnn::BatchToSpaceNd
void BatchToSpaceNd(const DataLayoutIndexed &dataLayout, const TensorInfo &inputTensorInfo, const TensorInfo &outputTensorInfo, const std::vector< unsigned int > &blockShape, const std::vector< std::pair< unsigned int, unsigned int >> &cropsData, Decoder< float > &inputDecoder, Encoder< float > &outputEncoder)
Definition: BatchToSpaceNd.cpp:35

-armnn::BatchToSpaceNdQueueDescriptor
Definition: WorkloadData.hpp:420

-LayerWithParameters.hpp

-WorkloadFactory.hpp

-armnn::BatchToSpaceNdLayer
This layer represents a BatchToSpaceNd operation.
Definition: BatchToSpaceNdLayer.hpp:13

-armnn::Layer::GetName
const char * GetName() const override
Definition: Layer.hpp:305

-armnn::IWorkloadFactory
Definition: WorkloadFactory.hpp:21

-armnn::BatchToSpaceNdDescriptor
A BatchToSpaceNdDescriptor for the BatchToSpaceNdLayer.
Definition: Descriptors.hpp:657

-armnn::IOutputSlot::GetTensorInfo
virtual const TensorInfo & GetTensorInfo() const =0

-armnnUtils::DataLayoutIndexed::GetHeightIndex
unsigned int GetHeightIndex() const
Definition: DataLayoutIndexed.hpp:24

-armnn::BatchToSpaceNdDescriptor::m_DataLayout
DataLayout m_DataLayout
The data layout to be used (NCHW, NHWC).
Definition: Descriptors.hpp:684

-CHECK_LOCATION
#define CHECK_LOCATION()
Definition: Exceptions.hpp:169

-TypesUtils.hpp

-armnnUtils::DataLayoutIndexed::GetWidthIndex
unsigned int GetWidthIndex() const
Definition: DataLayoutIndexed.hpp:25

-armnnUtils
Definition: DataLayoutIndexed.hpp:13

-armnn::InputSlot::GetConnection
const IOutputSlot * GetConnection() const override
Definition: Layer.hpp:199

-LayerCloneBase.hpp

-armnn::ILayerVisitor
Definition: ILayerVisitor.hpp:16

-armnn::BatchToSpaceNdLayer::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Definition: BatchToSpaceNdLayer.cpp:31

-armnn::LayerWithParameters< BatchToSpaceNdDescriptor >::GetParameters
const BatchToSpaceNdDescriptor & GetParameters() const
Definition: LayerWithParameters.hpp:18

-armnn::BatchToSpaceNdLayer::BatchToSpaceNdLayer
BatchToSpaceNdLayer(const BatchToSpaceNdDescriptor &param, const char *name)
Definition: BatchToSpaceNdLayer.cpp:26

-armnn::LayerWithParameters< BatchToSpaceNdDescriptor >::m_Param
BatchToSpaceNdDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
Definition: LayerWithParameters.hpp:50

-armnn::Layer::VerifyLayerConnections
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:337

-armnn::LayerWithParameters
Definition: LayerWithParameters.hpp:13

-armnn::LayerWithParameters< BatchToSpaceNdDescriptor >::PrepInfoAndDesc
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *LayerCreateWorkload.
Definition: LayerWithParameters.hpp:43

-WorkloadData.hpp

-armnn
Definition: BackendHelper.hpp:11

-DataLayoutIndexed.hpp

-armnn::BatchToSpaceNdLayer::Clone
BatchToSpaceNdLayer * Clone(Graph &graph) const override
Definition: BatchToSpaceNdLayer.cpp:38

-armnn::BatchToSpaceNdLayer::InferOutputShapes
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
Definition: BatchToSpaceNdLayer.cpp:57

-CpuTensorHandle.hpp

-armnn::TensorShape
Definition: Tensor.hpp:20

-armnn::IWorkloadFactory::CreateBatchToSpaceNd
virtual std::unique_ptr< IWorkload > CreateBatchToSpaceNd(const BatchToSpaceNdQueueDescriptor &descriptor, const WorkloadInfo &Info) const
Definition: WorkloadFactory.cpp:1106

-armnn::Graph
Definition: Graph.hpp:29

-armnnUtils::DataLayoutIndexed
Definition: DataLayoutIndexed.hpp:17

-armnn::BatchToSpaceNdLayer::Accept
void Accept(ILayerVisitor &visitor) const override
Definition: BatchToSpaceNdLayer.cpp:95

-armnn::BatchToSpaceNdDescriptor::m_Crops
std::vector< std::pair< unsigned int, unsigned int > > m_Crops
The values to crop from the input dimension.
Definition: Descriptors.hpp:682

-BatchToSpaceNdLayer.hpp

-armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:88

-armnn::OutputSlot::GetTensorInfo
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:63

-armnn::ILayerVisitor::VisitBatchToSpaceNdLayer
virtual void VisitBatchToSpaceNdLayer(const IConnectableLayer *layer, const BatchToSpaceNdDescriptor &batchToSpaceNdDescriptor, const char *name=nullptr)=0

-armnn::BatchToSpaceNdLayer::ValidateTensorShapesFromInputs
void ValidateTensorShapesFromInputs() override
Definition: BatchToSpaceNdLayer.cpp:44

-armnn::Layer::GetOutputSlot
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Definition: Layer.hpp:312

-armnn::BatchToSpaceNdDescriptor::m_BlockShape
std::vector< unsigned int > m_BlockShape
Block shape values.
Definition: Descriptors.hpp:680

-armnn::LayerType
LayerType
Definition: InternalTypes.hpp:14

-armnn::Layer::GetInputSlot
const InputSlot & GetInputSlot(unsigned int index) const override
Definition: Layer.hpp:310

-