C++ API Reference for Intel® Data Analytics Acceleration Library 2018 Update 2

decision_tree_regression_model.h
1 /* file: decision_tree_regression_model.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 Intel Corporation
4 * All Rights Reserved.
5 *
6 * If this software was obtained under the Intel Simplified Software License,
7 * the following terms apply:
8 *
9 * The source code, information and material ("Material") contained herein is
10 * owned by Intel Corporation or its suppliers or licensors, and title to such
11 * Material remains with Intel Corporation or its suppliers or licensors. The
12 * Material contains proprietary information of Intel or its suppliers and
13 * licensors. The Material is protected by worldwide copyright laws and treaty
14 * provisions. No part of the Material may be used, copied, reproduced,
15 * modified, published, uploaded, posted, transmitted, distributed or disclosed
16 * in any way without Intel's prior express written permission. No license under
17 * any patent, copyright or other intellectual property rights in the Material
18 * is granted to or conferred upon you, either expressly, by implication,
19 * inducement, estoppel or otherwise. Any license under such intellectual
20 * property rights must be express and approved by Intel in writing.
21 *
22 * Unless otherwise agreed by Intel in writing, you may not remove or alter this
23 * notice or any other notice embedded in Materials by Intel or Intel's
24 * suppliers or licensors in any way.
25 *
26 *
27 * If this software was obtained under the Apache License, Version 2.0 (the
28 * "License"), the following terms apply:
29 *
30 * You may not use this file except in compliance with the License. You may
31 * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
32 *
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 *
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
40 *******************************************************************************/
41 
42 /*
43 //++
44 // Implementation of the class defining the Decision tree regression model
45 //--
46 */
47 
48 #ifndef __DECISION_TREE_REGRESSION_MODEL_H__
49 #define __DECISION_TREE_REGRESSION_MODEL_H__
50 
51 #include "data_management/data/numeric_table.h"
52 #include "data_management/data/aos_numeric_table.h"
53 #include "data_management/data/soa_numeric_table.h"
54 #include "data_management/data/homogen_numeric_table.h"
55 #include "algorithms/model.h"
56 #include "decision_tree_model.h"
57 #include "algorithms/regression/regression_model.h"
58 #include "algorithms/regression/tree_traverse.h"
59 
60 namespace daal
61 {
62 namespace algorithms
63 {
67 namespace decision_tree
68 {
77 namespace regression
78 {
79 
83 namespace interface1
84 {
95 /* [Parameter source code] */
96 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
97 {
101  Parameter() : daal::algorithms::Parameter(),
102  pruning(reducedErrorPruning), maxTreeDepth(0), minObservationsInLeafNodes(5)
103  {}
104 
108  services::Status check() const DAAL_C11_OVERRIDE;
109 
110  Pruning pruning;
111  size_t maxTreeDepth;
112  size_t minObservationsInLeafNodes;
113 };
114 /* [Parameter source code] */
115 
125 class DAAL_EXPORT Model : public algorithms::regression::Model
126 {
127 public:
128  DECLARE_MODEL_IFACE(Model, algorithms::regression::Model);
129 
134  Model();
135 
136  virtual ~Model();
137 
138  class ModelImpl;
139  typedef services::SharedPtr<ModelImpl> ModelImplPtr;
140 
145  const ModelImpl * impl() const { return _impl.get(); }
146 
151  ModelImpl * impl() { return _impl.get(); }
152 
157  static services::SharedPtr<Model> create(services::Status *stat = NULL);
158 
162  virtual size_t getNumberOfFeatures() const DAAL_C11_OVERRIDE;
163 
168  void traverseDF(algorithms::regression::TreeNodeVisitor& visitor) const;
169 
174  void traverseBF(algorithms::regression::TreeNodeVisitor& visitor) const;
175 
176 protected:
177  Model(services::Status &st);
178 
179  services::Status serializeImpl(data_management::InputDataArchive * arch) DAAL_C11_OVERRIDE;
180 
181  services::Status deserializeImpl(const data_management::OutputDataArchive * arch) DAAL_C11_OVERRIDE;
182 
183 private:
184  ModelImplPtr _impl;
185 };
186 
187 typedef services::SharedPtr<Model> ModelPtr;
188 typedef services::SharedPtr<const Model> ModelConstPtr;
189 
190 } // namespace interface1
191 
192 using interface1::Parameter;
193 using interface1::Model;
194 using interface1::ModelPtr;
195 using interface1::ModelConstPtr;
196 
198 } // namespace regression
199 } // namespace decision_tree
200 } // namespace algorithms
201 } // namespace daal
202 
203 #endif
daal::algorithms::decision_tree::regression::interface1::Model::impl
const ModelImpl * impl() const
Definition: decision_tree_regression_model.h:145
daal::algorithms::decision_tree::regression::interface1::Parameter::Parameter
Parameter()
Definition: decision_tree_regression_model.h:101
daal::services::interface1::Status
Class that holds the results of API calls. In case of API routine failure it contains the list of err...
Definition: error_handling.h:491
daal
Definition: algorithm_base_common.h:57
daal::data_management::interface1::InputDataArchive
Provides methods to create an archive data object (serialized) and access this object.
Definition: data_archive.h:715
daal::algorithms::regression::interface1::TreeNodeVisitor
Interface of abstract visitor used in tree traversal methods.
Definition: regression/tree_traverse.h:86
daal::algorithms::decision_tree::regression::interface1::Parameter::minObservationsInLeafNodes
size_t minObservationsInLeafNodes
Definition: decision_tree_regression_model.h:112
daal::algorithms::decision_tree::regression::interface1::Parameter
Decision tree algorithm parameters.
Definition: decision_tree_regression_model.h:96
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
daal::services::interface1::SharedPtr
Shared pointer that retains shared ownership of an object through a pointer. Several SharedPtr object...
Definition: daal_shared_ptr.h:187
daal::algorithms::decision_tree::reducedErrorPruning
Definition: decision_tree_model.h:76
daal::algorithms::regression::interface1::Model
Base class for models trained with the regression algorithm
Definition: regression_model.h:89
daal::data_management::interface1::OutputDataArchive
Provides methods to restore an object from its serialized counterpart and access the restored object...
Definition: data_archive.h:978
daal::algorithms::decision_tree::regression::interface1::Model
Base class for models trained with the Decision tree algorithm
Definition: decision_tree_regression_model.h:125
daal::algorithms::decision_tree::regression::interface1::Model::impl
ModelImpl * impl()
Definition: decision_tree_regression_model.h:151
daal::algorithms::decision_tree::regression::interface1::Parameter::pruning
Pruning pruning
Definition: decision_tree_regression_model.h:110
daal::algorithms::decision_tree::Pruning
Pruning
Pruning method for Decision tree algorithm.
Definition: decision_tree_model.h:73
daal::algorithms::decision_tree::regression::interface1::Parameter::maxTreeDepth
size_t maxTreeDepth
Definition: decision_tree_regression_model.h:111

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