text: /* file: softmax_layer_forward.h */
  /*******************************************************************************
  * Copyright 2014-2019 Intel Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *******************************************************************************/
  
  /*
  //++
  //  Implementation of the interface for the forward softmax layer in the batch
  //  processing mode
  //--
  */
  
  #ifndef __SOFTMAX_LAYER_FORWARD_H__
  #define __SOFTMAX_LAYER_FORWARD_H__
  
  #include "algorithms/algorithm.h"
  #include "data_management/data/tensor.h"
  #include "services/daal_defines.h"
  #include "algorithms/neural_networks/layers/layer.h"
  #include "algorithms/neural_networks/layers/softmax/softmax_layer_types.h"
  #include "algorithms/neural_networks/layers/softmax/softmax_layer_forward_types.h"
  
  namespace daal
  {
  namespace algorithms
  {
  namespace neural_networks
  {
  namespace layers
  {
  namespace softmax
  {
  namespace forward
  {
  namespace interface1
  {
  /**
   * @defgroup softmax_layers_forward_batch Batch
   * @ingroup softmax_layers_forward
   * @{
   */
  /**
   * <a name="DAAL-CLASS-ALGORITHMS__NEURAL_NETWORKS__LAYERS__SOFTMAX__FORWARD__BATCHCONTAINER"></a>
   * \brief Class containing methods for the forward softmax layer using algorithmFPType precision arithmetic
   */
  template<typename algorithmFPType, Method method, CpuType cpu>
  class BatchContainer : public layers::forward::LayerContainerIfaceImpl
  {
  public:
      /**
      * Constructs a container for the forward softmax layer with a specified environment
      * in the batch processing mode
      * \param[in] daalEnv   Environment object
      */
      BatchContainer(daal::services::Environment::env *daalEnv);
      /** Default destructor */
      ~BatchContainer();
      /**
       * Computes the result of the forward softmax layer in the batch processing mode
       *
       * \return Status of computations
       */
      services::Status compute() DAAL_C11_OVERRIDE;
  };
  
  /**
   * <a name="DAAL-CLASS-ALGORITHMS__NEURAL_NETWORKS__LAYERS__SOFTMAX__FORWARD__BATCH"></a>
   * \brief Computes the results of the forward softmax layer in the batch processing mode
   * <!-- \n<a href="DAAL-REF-SOFTMAXFORWARD-ALGORITHM">Forward softmax layer description and usage models</a> -->
   *
   * \tparam algorithmFPType  Data type to use in intermediate computations of the forward softmax layer, double or float
   * \tparam method           Forward softmax layer method, \ref Method
   *
   * \par Enumerations
   *      - \ref Method                     Computation methods for the forward softmax layer
   *      - \ref forward::InputId           Identifiers of input objects for the forward softmax layer
   *      - \ref forward::ResultId          Identifiers of result objects for the forward softmax layer
   *
   * \par References
   *      - \ref backward::interface1::Batch "backward::Batch" class
   */
  template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
  class Batch : public layers::forward::LayerIfaceImpl
  {
  public:
      typedef layers::forward::LayerIfaceImpl super;
  
      typedef algorithms::neural_networks::layers::softmax::forward::Input     InputType;
      typedef algorithms::neural_networks::layers::softmax::Parameter          ParameterType;
      typedef algorithms::neural_networks::layers::softmax::forward::Result    ResultType;
  
      ParameterType &parameter;  /*!< softmax layer \ref interface1::Parameter "parameters" structure */
      InputType input;          /*!< %Input objects of the layer */
  
      /** Default constructor */
      Batch() : parameter(_defaultParameter)
      {
          initialize();
      };
  
      /**
       * Constructs a forward softmax layer in the batch processing mode
       * and initializes its parameter with the provided parameter
       * \param[in] parameter Parameter to initialize the parameter of the layer
       */
      Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
      {
          initialize();
      }
  
      /**
       * Constructs a forward softmax layer by copying input objects
       * and parameters of another forward softmax layer in the batch processing mode
       * \param[in] other Algorithm to use as the source to initialize the input objects
       *                  and parameters of the layer
       */
      Batch(const Batch<algorithmFPType, method> &other) : super(other),
          _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
      {
          initialize();
      }
  
      /**
      * Returns the method of the layer
      * \return Method of the layer
      */
      virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
  
      /**
       * Returns the structure that contains input objects of the softmax forward layer
       * \return Structure that contains input objects of the softmax forward layer
       */
      virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
  
      /**
       * Returns the structure that contains parameters of the forward softmax layer
       * \return Structure that contains parameters of the forward softmax layer
       */
      virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
  
      /**
       * Returns the structure that contains result of the forward softmax layer
       * \return Structure that contains result of the forward softmax layer
       */
      layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
      {
          return getResult();
      }
  
      /**
       * Returns the structure that contains result of the forward softmax layer
       * \return Structure that contains result of the forward softmax layer
       */
      ResultPtr getResult()
      {
          return _result;
      }
  
      /**
       * Registers user-allocated memory to store result of the forward softmax layer
       * \param[in] result  Structure to store result of the forward softmax layer
       *
       * \return Status of computations
       */
      services::Status setResult(const ResultPtr& result)
      {
          DAAL_CHECK(result, services::ErrorNullResult)
          _result = result;
          _res = _result.get();
          return services::Status();
      }
  
      /**
       * Returns a pointer to the newly allocated forward softmax layer
       * with a copy of input objects and parameters of this forward softmax layer
       * in the batch processing mode
       * \return Pointer to the newly allocated algorithm
       */
      services::SharedPtr<Batch<algorithmFPType, method> > clone() const
      {
          return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
      }
  
      /**
      * Allocates memory to store the result of the forward softmax layer
      *
       * \return Status of computations
      */
      virtual services::Status allocateResult() DAAL_C11_OVERRIDE
      {
          services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
          this->_res = this->_result.get();
          return s;
      }
  
  protected:
      virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
      {
          return new Batch<algorithmFPType, method>(*this);
      }
  
      void initialize()
      {
          Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
          _in = &input;
          _par = &parameter;
          _result.reset(new ResultType());
      }
  
  private:
      ResultPtr _result;
      ParameterType _defaultParameter;
  };
  /** @} */
  } // namespace interface1
  using interface1::BatchContainer;
  using interface1::Batch;
  } // namespace forward
  } // namespace softmax
  } // namespace layers
  } // namespace neural_networks
  } // namespace algorithms
  } // namespace daal
  #endif
  