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

decision_tree_classification_predict.h
1 /* file: decision_tree_classification_predict.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 interface for Decision tree classification model-based prediction
45 //--
46 */
47 
48 #ifndef __DECISION_TREE_CLASSIFICATION_PREDICT_H__
49 #define __DECISION_TREE_CLASSIFICATION_PREDICT_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/decision_tree/decision_tree_classification_predict_types.h"
53 #include "algorithms/decision_tree/decision_tree_classification_model.h"
54 #include "algorithms/classifier/classifier_predict.h"
55 #include "data_management/data/homogen_numeric_table.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
61 namespace decision_tree
62 {
63 namespace classification
64 {
65 namespace prediction
66 {
67 namespace interface1
68 {
79 template<typename algorithmFPType, Method method, CpuType cpu>
80 class DAAL_EXPORT BatchContainer : public PredictionContainerIface
81 {
82 public:
87  BatchContainer(daal::services::Environment::env *daalEnv);
88 
89  ~BatchContainer();
90 
94  services::Status compute() DAAL_C11_OVERRIDE;
95 };
96 
113 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
114 class Batch : public classifier::prediction::Batch
115 {
116 public:
117  typedef classifier::prediction::Batch super;
118 
119  typedef algorithms::decision_tree::classification::prediction::Input InputType;
120  typedef algorithms::decision_tree::classification::Parameter ParameterType;
121  typedef typename super::ResultType ResultType;
122 
123  InputType input;
124  ParameterType parameter;
127  Batch() : classifier::prediction::Batch(), input(), parameter()
128  {
129  initialize();
130  }
131 
138  Batch(const Batch<algorithmFPType, method> & other) : classifier::prediction::Batch(other), input(other.input), parameter(other.parameter)
139  {
140  initialize();
141  }
142 
147  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
148 
153  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
154 
160  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
161  {
162  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
163  }
164 
165 protected:
166  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
167  {
168  return new Batch<algorithmFPType, method>(*this);
169  }
170 
171  services::Status allocateResult() DAAL_C11_OVERRIDE
172  {
173  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, (int)method);
174  _res = _result.get();
175  return s;
176  }
177 
178  void initialize()
179  {
180  _in = &input;
181  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
182  _par = &parameter;
183  }
184 };
185 
187 } // namespace interface1
188 
189 using interface1::BatchContainer;
190 using interface1::Batch;
191 
192 } // namespace prediction
193 } // namespace classification
194 } // namespace decision_tree
195 } // namespace algorithms
196 } // namespace daal
197 
198 #endif
daal::algorithms::classifier::prediction::interface1::Result
Provides methods to access prediction results obtained with the compute() method of the classifier pr...
Definition: classifier_predict_types.h:190
daal::services::interface1::Environment::_envStruct
The environment structure.
Definition: env_detect.h:95
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::algorithms::classifier::interface1::Parameter
Base class for the parameters of the classification algorithm.
Definition: classifier_model.h:81
daal::algorithms::classifier::prediction::interface1::Input
Input objects in the prediction stage of the classification algorithm.
Definition: classifier_predict_types.h:133
daal::algorithms::neural_networks::prediction::prediction
Definition: neural_networks_prediction_result.h:79
daal::algorithms::PredictionContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the algor...
Definition: prediction.h:66
daal::algorithms::decision_tree::classification::prediction::interface1::Batch::input
InputType input
Definition: decision_tree_classification_predict.h:123
daal::algorithms::decision_tree::classification::prediction::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: decision_tree_classification_predict.h:147
daal::algorithms::classifier::prediction::interface1::Batch
Base class for making predictions based on the model of the classification algorithms.
Definition: classifier_predict.h:85
daal::batch
Definition: daal_defines.h:132
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::classification::prediction::interface1::Batch
Provides methods to run implementations of the Decision tree model-based prediction.
Definition: decision_tree_classification_predict.h:114
daal::algorithms::decision_tree::classification::interface1::Parameter
Decision tree algorithm parameters.
Definition: decision_tree_classification_model.h:107
daal::algorithms::decision_tree::classification::prediction::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: decision_tree_classification_predict.h:153
daal::algorithms::decision_tree::classification::prediction::interface1::Input
Provides an interface for input objects for making Decision tree model-based prediction.
Definition: decision_tree_classification_predict_types.h:104
daal::algorithms::decision_tree::classification::prediction::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: decision_tree_classification_predict.h:138
daal::algorithms::decision_tree::classification::prediction::interface1::Batch::Batch
Batch()
Definition: decision_tree_classification_predict.h:127
daal::algorithms::decision_tree::classification::prediction::interface1::Batch::parameter
ParameterType parameter
Definition: decision_tree_classification_predict.h:124
daal::algorithms::decision_tree::classification::prediction::interface1::BatchContainer
Class containing computation methods for Decision tree model-based prediction.
Definition: decision_tree_classification_predict.h:80
daal::algorithms::decision_tree::classification::prediction::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: decision_tree_classification_predict.h:160

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