text: /* file: brownboost_predict.h */
  /*******************************************************************************
  * Copyright 2014-2020 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 BrownBoost model-based prediction
  //--
  */
  
  #ifndef __BROWN_BOOST_PREDICT_H__
  #define __BROWN_BOOST_PREDICT_H__
  
  #include "algorithms/algorithm.h"
  #include "algorithms/boosting/boosting_predict.h"
  #include "algorithms/boosting/brownboost_model.h"
  #include "algorithms/boosting/brownboost_predict_types.h"
  
  namespace daal
  {
  namespace algorithms
  {
  namespace brownboost
  {
  /**
   * \brief Contains classes for prediction based on BrownBoost models
   */
  namespace prediction
  {
  /**
   * @defgroup brownboost_prediction_batch Batch
   * @ingroup brownboost_prediction
   * @{
   */
  /**
   * <a name="DAAL-ENUM-ALGORITHMS__BROWNBOOST__PREDICTION__METHOD"></a>
   * Available methods for predictions based on the BrownBoost model
   */
  enum Method
  {
      defaultDense = 0 /*!< Default method */
  };
  
  /**
   * \brief Contains version 1.0 of Intel(R) oneAPI Data Analytics Library interface.
   */
  namespace interface1
  {
  /**
   * <a name="DAAL-CLASS-ALGORITHMS__BROWNBOOST__PREDICTION__BATCHCONTAINER"></a>
   * \brief Provides methods to run implementations of the BrownBoost algorithm.   \DAAL_DEPRECATED
   *        This class is associated with daal::algorithms::brownboost::prediction::interface1::Batch class
  *
   * \tparam algorithmFPType  Data type to use in intermediate computations for BrownBoost, double or float
   * \tparam method           BrownBoost computation method, \ref Method
   */
  template <typename algorithmFPType, Method method, CpuType cpu>
  class BatchContainer : public PredictionContainerIface
  {
  public:
      /**
       * Constructs a container for BrownBoost model-based prediction with a specified environment
       * \param[in] daalEnv   Environment object
       */
      DAAL_DEPRECATED BatchContainer(daal::services::Environment::env * daalEnv);
      /** Default destructor */
      DAAL_DEPRECATED ~BatchContainer();
      /**
       * Computes the result of BrownBoost model-based prediction
       */
      DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE;
  };
  
  /**
   * <a name="DAAL-CLASS-ALGORITHMS__BROWNBOOST__PREDICTION__BATCH"></a>
   * \brief Predicts BrownBoost classification results
   * <!-- \n<a href="DAAL-REF-BROWNBOOST-ALGORITHM">BrownBoost algorithm description and usage models</a> -->
   *
   * \tparam algorithmFPType  Data type to use in intermediate computations for the BrownBoost algorithm, double or float
   * \tparam method           BrownBoost computation method, \ref Method
   *
   * \par Enumerations
   *      - \ref Method                                       BrownBoost prediction methods
   *      - \ref classifier::prediction::NumericTableInputId  Identifiers of input Numeric Table objects
   *                                                          for the BrownBoost prediction algorithm
   *      - \ref classifier::prediction::ModelInputId         identifiers of input Model objects for the BrownBoost prediction algorithm
   *      - \ref classifier::prediction::ResultId             Identifiers of BrownBoost prediction results
   *
   * \par References
   *      - \ref interface1::Model "Model" class
   *      - \ref classifier::prediction::interface1::Input "classifier::prediction::interface1::Input" class
   *      - \ref classifier::prediction::interface1::Result "classifier::prediction::interface1::Result" class */
  template <typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
  class DAAL_EXPORT Batch : public boosting::prediction::Batch
  {
  public:
      typedef boosting::prediction::Batch super;
  
      typedef algorithms::brownboost::prediction::interface1::Input InputType;
      typedef algorithms::brownboost::interface1::Parameter ParameterType;
      typedef typename super::ResultType ResultType;
  
      InputType input;         /*!< %Input objects of the algorithm */
      ParameterType parameter; /*!< \ref interface1::Parameter "Parameters" of the algorithm */
  
      DAAL_DEPRECATED Batch() { initialize(); }
  
      /**
       * Constructs a BrownBoost prediction algorithm by copying input objects and parameters
       * of another BrownBoost prediction algorithm
       * \param[in] other An algorithm to be used as the source to initialize the input objects
       *                  and parameters of the algorithm
       */
      DAAL_DEPRECATED Batch(const Batch<algorithmFPType, method> & other)
          : boosting::prediction::Batch(other), input(other.input), parameter(other.parameter)
      {
          initialize();
      }
  
      DAAL_DEPRECATED ~Batch() {}
  
      /**
       * Get input objects for the BrownBoost prediction algorithm
       * \return %Input objects for the BrownBoost prediction algorithm
       */
      DAAL_DEPRECATED InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
  
      /**
       * Returns method of the algorithm
       * \return Method of the algorithm
       */
      DAAL_DEPRECATED_VIRTUAL virtual int getMethod() const DAAL_C11_OVERRIDE { return (int)method; }
  
      /**
       * Returns a pointer to the newly allocated BrownBoost prediction algorithm with a copy of input objects
       * and parameters of this BrownBoost prediction algorithm
       * \return Pointer to the newly allocated algorithm
       */
      DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
      {
          return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
      }
  
  protected:
      virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE { return new Batch<algorithmFPType, method>(*this); }
  
      services::Status allocateResult() DAAL_C11_OVERRIDE
      {
          services::Status s = _result->allocate<algorithmFPType>(&input, 0, 0);
          _res               = _result.get();
          return s;
      }
  
      void initialize()
      {
          _in  = &input;
          _ac  = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
          _par = &parameter;
      }
  
  private:
      Batch & operator=(const Batch &);
  };
  } // namespace interface1
  
  /**
   * \brief Contains version 2.0 of Intel(R) oneAPI Data Analytics Library interface.
   */
  namespace interface2
  {
  /**
   * <a name="DAAL-CLASS-ALGORITHMS__BROWNBOOST__PREDICTION__BATCHCONTAINER"></a>
   * \brief Provides methods to run implementations of the BrownBoost algorithm.
   *        This class is associated with daal::algorithms::brownboost::prediction::interface1::Batch class
  *
   * \tparam algorithmFPType  Data type to use in intermediate computations for BrownBoost, double or float
   * \tparam method           BrownBoost computation method, \ref Method
   */
  template <typename algorithmFPType, Method method, CpuType cpu>
  class BatchContainer : public PredictionContainerIface
  {
  public:
      /**
       * Constructs a container for BrownBoost model-based prediction with a specified environment
       * \param[in] daalEnv   Environment object
       */
      BatchContainer(daal::services::Environment::env * daalEnv);
      /** Default destructor */
      ~BatchContainer();
      /**
       * Computes the result of BrownBoost model-based prediction
       */
      services::Status compute() DAAL_C11_OVERRIDE;
  };
  /**
   * <a name="DAAL-CLASS-ALGORITHMS__BROWNBOOST__PREDICTION__BATCH"></a>
   * \brief Predicts BrownBoost classification results
   * <!-- \n<a href="DAAL-REF-BROWNBOOST-ALGORITHM">BrownBoost algorithm description and usage models</a> -->
   *
   * \tparam algorithmFPType  Data type to use in intermediate computations for the BrownBoost algorithm, double or float
   * \tparam method           BrownBoost computation method, \ref Method
   *
   * \par Enumerations
   *      - \ref Method                                       BrownBoost prediction methods
   *      - \ref classifier::prediction::NumericTableInputId  Identifiers of input Numeric Table objects
   *                                                          for the BrownBoost prediction algorithm
   *      - \ref classifier::prediction::ModelInputId         identifiers of input Model objects for the BrownBoost prediction algorithm
   *      - \ref classifier::prediction::ResultId             Identifiers of BrownBoost prediction results
   *
   * \par References
   *      - \ref interface2::Model "Model" class
   *      - classifier::prediction::Input class
   *      - \ref classifier::prediction::interface2::Result "classifier::prediction::Result" class */
  template <typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
  class DAAL_EXPORT Batch : public classifier::prediction::Batch
  {
  public:
      typedef classifier::prediction::Batch super;
  
      typedef algorithms::brownboost::prediction::Input InputType;
      typedef algorithms::brownboost::Parameter ParameterType;
      typedef typename super::ResultType ResultType;
  
      InputType input; /*!< %Input objects of the algorithm */
  
      Batch();
  
      /**
       * Constructs a BrownBoost prediction algorithm by copying input objects and parameters
       * of another BrownBoost prediction algorithm
       * \param[in] other An algorithm to be used as the source to initialize the input objects
       *                  and parameters of the algorithm
       */
      Batch(const Batch<algorithmFPType, method> & other);
  
      ~Batch() { delete _par; }
  
      /**
      * Gets parameter of the algorithm
      * \return parameter of the algorithm
      */
      ParameterType & parameter() { return *static_cast<ParameterType *>(_par); }
  
      /**
      * Gets parameter of the algorithm
      * \return parameter of the algorithm
      */
      const ParameterType & parameter() const { return *static_cast<const ParameterType *>(_par); }
  
      /**
       * Get input objects for the BrownBoost prediction algorithm
       * \return %Input objects for the BrownBoost prediction algorithm
       */
      InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
  
      /**
       * Returns method of the algorithm
       * \return Method of the algorithm
       */
      virtual int getMethod() const DAAL_C11_OVERRIDE { return (int)method; }
  
      /**
       * Returns a pointer to the newly allocated BrownBoost prediction algorithm with a copy of input objects
       * and parameters of this BrownBoost prediction algorithm
       * \return Pointer to the newly allocated algorithm
       */
      services::SharedPtr<Batch<algorithmFPType, method> > clone() const { return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl()); }
  
  protected:
      virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE { return new Batch<algorithmFPType, method>(*this); }
  
      services::Status allocateResult() DAAL_C11_OVERRIDE
      {
          services::Status s = _result->allocate<algorithmFPType>(&input, _par, 0);
          _res               = _result.get();
          return s;
      }
  
      void initialize()
      {
          _in = &input;
          _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
      }
  
  private:
      Batch & operator=(const Batch &);
  };
  } // namespace interface2
  using interface2::Batch;
  using interface2::BatchContainer;
  
  /** @} */
  } // namespace prediction
  } // namespace brownboost
  } // namespace algorithms
  } // namespace daal
  #endif
  