src/armnn/layers/BatchNormalizationLayer.hpp

//
// Copyright © 2017 Arm Ltd and Contributors. All rights reserved.
// SPDX-License-Identifier: MIT
//
#pragma once

#include "LayerWithParameters.hpp"

namespace armnn
{

class ScopedTensorHandle;

/// This layer represents a batch normalization operation.
class BatchNormalizationLayer : public LayerWithParameters<BatchNormalizationDescriptor>
{
public:
    /// A unique pointer to store Mean values
    std::shared_ptr<ConstTensorHandle> m_Mean;
    /// A unique pointer to store Variance values
    std::shared_ptr<ConstTensorHandle> m_Variance;
    /// A unique pointer to store Beta values
    std::shared_ptr<ConstTensorHandle> m_Beta;
    /// A unique pointer to store Gamma values
    std::shared_ptr<ConstTensorHandle> m_Gamma;

    /// Makes a workload for the BatchNormalization type.
    /// @param [in] graph The graph where this layer can be found.
    /// @param [in] factory The workload factory which will create the workload.
    /// @return A pointer to the created workload, or nullptr if not created.
    virtual std::unique_ptr<IWorkload> CreateWorkload(const IWorkloadFactory& factory) const override;

    /// Creates a dynamically-allocated copy of this layer.
    /// @param [in] graph The graph into which this layer is being cloned.
    BatchNormalizationLayer* Clone(Graph& graph) const override;

    /// Check if the input tensor shape(s)
    /// will lead to a valid configuration of @ref BatchNormalizationLayer.
    /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
    void ValidateTensorShapesFromInputs() override;

    void ExecuteStrategy(IStrategy& strategy) const override;

protected:
    /// Constructor to create a BatchNormalizationLayer.
    /// @param [in] param BatchNormalizationDescriptor to configure the batch normalization operation.
    /// @param [in] name Optional name for the layer.
    BatchNormalizationLayer(const BatchNormalizationDescriptor& param, const char* name);

    /// Default destructor
    ~BatchNormalizationLayer() = default;

    /// Retrieve the handles to the constant values stored by the layer.
    /// @return A vector of the constant tensors stored by this layer.
    ImmutableConstantTensors GetConstantTensorsByRef() const override;
};

} // namespace