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

decision_forest_classification_predict.h
1 /* file: decision_forest_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 forest classification model-based prediction
45 //--
46 */
47 
48 #ifndef __DECISION_FOREST_CLASSIFICATION_PREDICT_H__
49 #define __DECISION_FOREST_CLASSIFICATION_PREDICT_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/classifier/classifier_predict.h"
53 #include "algorithms/decision_forest/decision_forest_classification_model.h"
54 #include "algorithms/decision_forest/decision_forest_classification_predict_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace decision_forest
61 {
62 namespace classification
63 {
67 namespace prediction
68 {
78 enum Method
79 {
80  defaultDense = 0
81 };
82 
86 namespace interface1
87 {
97 template<typename algorithmFPType, Method method, CpuType cpu>
98 class DAAL_EXPORT BatchContainer : public PredictionContainerIface
99 {
100 public:
105  BatchContainer(daal::services::Environment::env *daalEnv);
107  ~BatchContainer();
112  services::Status compute() DAAL_C11_OVERRIDE;
113 };
114 
135 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
136 class Batch : public classifier::prediction::Batch
137 {
138 public:
139  typedef classifier::prediction::Batch super;
140 
141  typedef algorithms::decision_forest::classification::prediction::Input InputType;
142  typedef typename super::ParameterType ParameterType;
143  typedef typename super::ResultType ResultType;
144 
145  InputType input;
146  ParameterType parameter;
152  Batch(size_t nClasses): parameter(nClasses)
153  {
154  initialize();
155  };
156 
163  Batch(const Batch<algorithmFPType, method> &other) : classifier::prediction::Batch(other),
164  input(other.input), parameter(other.parameter)
165  {
166  initialize();
167  }
168 
169  ~Batch() {}
170 
175  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
176 
181  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
182 
188  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
189  {
190  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
191  }
192 
193 protected:
194  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
195  {
196  return new Batch<algorithmFPType, method>(*this);
197  }
198 
199  services::Status allocateResult() DAAL_C11_OVERRIDE
200  {
201  services::Status s = _result->allocate<algorithmFPType>(&input, 0, 0);
202  _res = _result.get();
203  return s;
204  }
205 
206  void initialize()
207  {
208  _in = &input;
209  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
210  _par = &parameter;
211  }
212 };
214 } // namespace interface1
215 using interface1::BatchContainer;
216 using interface1::Batch;
217 
218 } // namespace daal::algorithms::decision_forest::classification::prediction
219 }
220 }
221 }
222 } // namespace daal
223 #endif
daal::algorithms::decision_forest::classification::prediction::interface1::BatchContainer
Provides methods to run implementations of the decision_forest algorithm. This class is associated wi...
Definition: decision_forest_classification_predict.h:98
daal::algorithms::decision_forest::classification::prediction::interface1::Batch::input
InputType input
Definition: decision_forest_classification_predict.h:145
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::algorithms::decision_forest::classification::prediction::Method
Method
Definition: decision_forest_classification_predict.h:78
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_forest::classification::prediction::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: decision_forest_classification_predict.h:175
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_forest::classification::prediction::interface1::Batch::Batch
Batch(size_t nClasses)
Definition: decision_forest_classification_predict.h:152
daal::algorithms::decision_forest::classification::prediction::defaultDense
Definition: decision_forest_classification_predict.h:80
daal::algorithms::decision_forest::classification::prediction::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: decision_forest_classification_predict.h:181
daal::algorithms::decision_forest::classification::prediction::interface1::Batch
Predicts decision_forest classification results.
Definition: decision_forest_classification_predict.h:136
daal::algorithms::decision_forest::classification::prediction::interface1::Input
Input objects in the prediction stage of the DECISION_FOREST_CLASSIFICATION algorithm.
Definition: decision_forest_classification_predict_types.h:85
daal::algorithms::decision_forest::classification::prediction::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: decision_forest_classification_predict.h:163
daal::algorithms::decision_forest::classification::prediction::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: decision_forest_classification_predict.h:188
daal::algorithms::decision_forest::classification::prediction::interface1::Batch::parameter
ParameterType parameter
Definition: decision_forest_classification_predict.h:146

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