C++ API Reference for Intel® Data Analytics Acceleration Library 2019 Update 4

decision_forest_classification_training_types.h
1 /* file: decision_forest_classification_training_types.h */
2 /*******************************************************************************
3 * Copyright 2014-2019 Intel Corporation.
4 *
5 * This software and the related documents are Intel copyrighted materials, and
6 * your use of them is governed by the express license under which they were
7 * provided to you (License). Unless the License provides otherwise, you may not
8 * use, modify, copy, publish, distribute, disclose or transmit this software or
9 * the related documents without Intel's prior written permission.
10 *
11 * This software and the related documents are provided as is, with no express
12 * or implied warranties, other than those that are expressly stated in the
13 * License.
14 *******************************************************************************/
15 
16 /*
17 //++
18 // Implementation of decision forest classification training algorithm interface.
19 //--
20 */
21 
22 #ifndef __DECISION_FOREST_CLASSIFICATION_TRAINING_TYPES_H__
23 #define __DECISION_FOREST_CLASSIFICATION_TRAINING_TYPES_H__
24 
25 #include "algorithms/algorithm.h"
26 #include "algorithms/classifier/classifier_training_types.h"
27 #include "algorithms/decision_forest/decision_forest_classification_model.h"
28 #include "algorithms/decision_forest/decision_forest_training_parameter.h"
29 
30 namespace daal
31 {
32 namespace algorithms
33 {
34 namespace decision_forest
35 {
36 namespace classification
37 {
47 namespace training
48 {
53 enum Method
54 {
55  defaultDense = 0
56 };
57 
62 enum ResultNumericTableId
63 {
64  outOfBagError = classifier::training::model + 1,
66  variableImportance,
68  outOfBagErrorPerObservation,
70  lastResultId = outOfBagErrorPerObservation
71 };
72 
77 enum ResultEngineId
78 {
79  updatedEngine = lastResultId + 1,
80  lastResultEngineId = updatedEngine
81 };
82 
86 namespace interface1
87 {
94 /* [Parameter source code] */
95 struct DAAL_EXPORT Parameter : public classifier::Parameter, public daal::algorithms::decision_forest::training::Parameter
96 {
98  Parameter(size_t nClasses) : classifier::Parameter(nClasses) {}
99  services::Status check() const DAAL_C11_OVERRIDE;
100 };
101 /* [Parameter source code] */
102 
103 
109 class DAAL_EXPORT Result : public classifier::training::Result
110 {
111 public:
112  DECLARE_SERIALIZABLE_CAST(Result);
113 
114  Result();
115  virtual ~Result();
116 
122  ModelPtr get(classifier::training::ResultId id) const;
123 
129  void set(classifier::training::ResultId id, const ModelPtr &value);
130 
136  data_management::NumericTablePtr get(ResultNumericTableId id) const;
137 
143  void set(ResultNumericTableId id, const data_management::NumericTablePtr &value);
144 
152  template <typename algorithmFPType>
153  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
154 
162  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
163 
169  engines::EnginePtr get(ResultEngineId id) const;
170 
171 protected:
173  template<typename Archive, bool onDeserialize>
174  services::Status serialImpl(Archive *arch)
175  {
176  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
177  }
178 
179 public:
180  class ResultImpl;
181 
182  ResultImpl* impl() { return _impl; }
183 
184  Result( const Result& other );
185 
186 private:
187  ResultImpl* _impl;
188 };
189 typedef services::SharedPtr<Result> ResultPtr;
190 
191 } // namespace interface1
192 using interface1::Parameter;
193 using interface1::Result;
194 using interface1::ResultPtr;
195 
196 } // namespace daal::algorithms::decision_forest::classification::training
198 }
199 }
200 }
201 } // namespace daal
202 #endif // __DECISION_FOREST_CLASSIFICATION_TRAINING_TYPES_H__
daal::algorithms::decision_forest::classification::training::Method
Method
Computation methods for decision forest classification model-based training.
Definition: decision_forest_classification_training_types.h:53
daal::algorithms::decision_forest::classification::training::interface1::Result
Provides methods to access final results obtained with the compute() method of the LogitBoost trainin...
Definition: decision_forest_classification_training_types.h:109
daal::algorithms::classifier::training::model
Definition: classifier_training_types.h:82
daal
Definition: algorithm_base_common.h:31
daal::algorithms::decision_forest::classification::training::outOfBagError
Definition: decision_forest_classification_training_types.h:64
daal::algorithms::decision_forest::classification::training::outOfBagErrorPerObservation
Definition: decision_forest_classification_training_types.h:68
daal::algorithms::decision_forest::classification::training::interface1::Parameter
Decision forest algorithm parameters.
Definition: decision_forest_classification_training_types.h:95
daal::algorithms::decision_forest::classification::training::updatedEngine
Definition: decision_forest_classification_training_types.h:79
daal::algorithms::decision_forest::classification::training::variableImportance
Definition: decision_forest_classification_training_types.h:66
daal::algorithms::decision_forest::classification::training::defaultDense
Definition: decision_forest_classification_training_types.h:55
daal::algorithms::decision_forest::classification::training::ResultNumericTableId
ResultNumericTableId
Available identifiers of the result of decision forest model-based training.
Definition: decision_forest_classification_training_types.h:62
daal::algorithms::decision_forest::classification::training::ResultEngineId
ResultEngineId
Available identifiers of the result of decision forest model-based training.
Definition: decision_forest_classification_training_types.h:77
daal::algorithms::decision_forest::classification::training::interface1::Parameter::Parameter
Parameter(size_t nClasses)
Definition: decision_forest_classification_training_types.h:98
daal::algorithms::classifier::training::ResultId
ResultId
Definition: classifier_training_types.h:80
daal::algorithms::math::abs::value
Definition: abs_types.h:86

For more complete information about compiler optimizations, see our Optimization Notice.