text: /* file: decision_tree_classification_training_types.h */
  /*******************************************************************************
  * Copyright 2014-2017 Intel Corporation
  * All Rights Reserved.
  *
  * If this  software was obtained  under the  Intel Simplified  Software License,
  * the following terms apply:
  *
  * The source code,  information  and material  ("Material") contained  herein is
  * owned by Intel Corporation or its  suppliers or licensors,  and  title to such
  * Material remains with Intel  Corporation or its  suppliers or  licensors.  The
  * Material  contains  proprietary  information  of  Intel or  its suppliers  and
  * licensors.  The Material is protected by  worldwide copyright  laws and treaty
  * provisions.  No part  of  the  Material   may  be  used,  copied,  reproduced,
  * modified, published,  uploaded, posted, transmitted,  distributed or disclosed
  * in any way without Intel's prior express written permission.  No license under
  * any patent,  copyright or other  intellectual property rights  in the Material
  * is granted to  or  conferred  upon  you,  either   expressly,  by implication,
  * inducement,  estoppel  or  otherwise.  Any  license   under such  intellectual
  * property rights must be express and approved by Intel in writing.
  *
  * Unless otherwise agreed by Intel in writing,  you may not remove or alter this
  * notice or  any  other  notice   embedded  in  Materials  by  Intel  or Intel's
  * suppliers or licensors in any way.
  *
  *
  * If this  software  was obtained  under the  Apache License,  Version  2.0 (the
  * "License"), the following terms apply:
  *
  * 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 Decision tree algorithm interface
  //--
  */
  
  #ifndef __DECISION_TREE_CLASSIFICATION_TRAINING_TYPES_H__
  #define __DECISION_TREE_CLASSIFICATION_TRAINING_TYPES_H__
  
  #include "algorithms/algorithm.h"
  #include "data_management/data/data_serialize.h"
  #include "algorithms/decision_tree/decision_tree_classification_model.h"
  #include "algorithms/classifier/classifier_training_types.h"
  
  namespace daal
  {
  namespace algorithms
  {
  
  /**
   * \brief Contains classes of the Decision tree algorithm
   */
  namespace decision_tree
  {
  
  /**
   * \brief Contains classes of the Decision tree classification algorithm
   */
  namespace classification
  {
  
  /**
   * @defgroup decision_tree_classification_training Training
   * \copydoc daal::algorithms::decision_tree::classification::training
   * @ingroup decision_tree_classification
   * @{
   */
  /**
   * \brief Contains a class for Decision tree model-based training
   */
  namespace training
  {
  
  /**
   * <a name="DAAL-ENUM-ALGORITHMS__DECISION_TREE__CLASSIFICATION__TRAINING__METHOD"></a>
   * \brief Computation methods for Decision tree model-based training
   */
  enum Method
  {
      defaultDense = 0 /*!< Default method */
  };
  
  /**
   * <a name="DAAL-ENUM-ALGORITHMS__DECISION_TREE__CLASSIFICATION__TRAINING__INPUTID"></a>
   * Available identifiers of the results in the training stage of Decision tree
   */
  enum InputId
  {
      dataForPruning      = algorithms::classifier::training::lastInputId + 1,  /*!< Pruning data set */
      labelsForPruning,                                                         /*!< Labels of the pruning data set */
      lastInputId = labelsForPruning
  };
  
  /**
   * \brief Contains version 1.0 of the Intel(R) Data Analytics Acceleration Library (Intel(R) DAAL) interface
   */
  namespace interface1
  {
  
  /**
   * <a name="DAAL-CLASS-ALGORITHMS__CLASSIFIER__TRAINING__INPUT"></a>
   * \brief Base class for the input objects in the training stage of the classification algorithms
   */
  class DAAL_EXPORT Input : public classifier::training::Input
  {
  public:
      Input();
      Input(const Input& other) : classifier::training::Input(other){}
  
      using classifier::training::Input::get;
      using classifier::training::Input::set;
  
      /**
       * Returns the input object in the training stage of the classification algorithm
       * \param[in] id   Identifier of the input object, \ref InputId
       * \return         Input object that corresponds to the given identifier
       */
      data_management::NumericTablePtr get(decision_tree::classification::training::InputId id) const;
  
      /**
       * Sets the input object in the training stage of the classification algorithm
       * \param[in] id    Identifier of the input object, \ref InputId
       * \param[in] value Pointer to the input object
       */
      void set(decision_tree::classification::training::InputId id, const data_management::NumericTablePtr & value);
  
      /**
       * Checks the correctness of the input object
       * \param[in] parameter Pointer to the structure of the algorithm parameters
       * \param[in] method    Computation method
       */
      services::Status check(const daal::algorithms::Parameter * parameter, int method) const DAAL_C11_OVERRIDE;
  
  protected:
      services::Status checkImpl(const daal::algorithms::Parameter * parameter) const;
  };
  
  typedef services::SharedPtr<Input> InputPtr;
  typedef services::SharedPtr<const Input> InputConstPtr;
  
  /**
   * <a name="DAAL-CLASS-ALGORITHMS__DECISION_TREE__CLASSIFICATION__TRAINING__RESULT"></a>
   * \brief Provides methods to access the result obtained with the compute() method of Decision tree model-based training
   */
  class DAAL_EXPORT Result : public classifier::training::Result
  {
  public:
      DECLARE_SERIALIZABLE_CAST(Result);
      Result();
  
      /**
       * Returns the result of Decision tree model-based training
       * \param[in] id    Identifier of the result
       * \return          Result that corresponds to the given identifier
       */
      ModelPtr get(classifier::training::ResultId id) const;
  
      /**
       * Allocates memory to store the result of Decision tree model-based training
       * \param[in] input Pointer to an object containing the input data
       * \param[in] parameter %Parameter of Decision tree model-based training
       * \param[in] method Computation method for the algorithm
       */
      template<typename algorithmFPType>
      DAAL_EXPORT services::Status allocate(const daal::algorithms::Input * input, const Parameter * parameter, int method);
  
  protected:
      /** \private */
      template<typename Archive, bool onDeserialize>
      services::Status serialImpl(Archive * arch)
      {
          return classifier::training::Result::serialImpl<Archive, onDeserialize>(arch);
      }
  };
  
  typedef services::SharedPtr<Result> ResultPtr;
  typedef services::SharedPtr<const Result> ResultConstPtr;
  
  } // namespace interface1
  
  using interface1::Input;
  using interface1::InputPtr;
  using interface1::InputConstPtr;
  using interface1::Result;
  using interface1::ResultPtr;
  using interface1::ResultConstPtr;
  
  } // namespace training
  /** @} */
  } // namespace classification
  } // namespace decision_tree
  } // namespace algorithms
  } // namespace daal
  
  #endif
  