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

classifier_training_batch.h
1 /* file: classifier_training_batch.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 the classifier model training algorithm.
45 //--
46 */
47 
48 #ifndef __CLASSIFIER_TRAINING_BATCH_H__
49 #define __CLASSIFIER_TRAINING_BATCH_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/classifier/classifier_training_types.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
58 namespace classifier
59 {
60 namespace training
61 {
62 
63 namespace interface1
64 {
82 class Batch : public Training<batch>
83 {
84 public:
85  typedef algorithms::classifier::training::Input InputType;
86  typedef algorithms::classifier::Parameter ParameterType;
87  typedef algorithms::classifier::training::Result ResultType;
88 
89  virtual ~Batch()
90  {}
91 
96  virtual InputType * getInput() = 0;
97 
102  services::Status setResult(const ResultPtr& res)
103  {
104  DAAL_CHECK(res, services::ErrorNullResult)
105  _result = res;
106  _res = _result.get();
107  return services::Status();
108  }
109 
114  ResultPtr getResult() { return _result; }
115 
120  virtual services::Status resetResult() = 0;
121 
127  services::SharedPtr<Batch> clone() const
128  {
129  return services::SharedPtr<Batch>(cloneImpl());
130  }
131 
132 protected:
133 
134  virtual Batch * cloneImpl() const DAAL_C11_OVERRIDE = 0;
135  ResultPtr _result;
136 };
138 } // namespace interface1
139 using interface1::Batch;
140 
141 }
142 }
143 }
144 }
145 #endif
daal::algorithms::classifier::training::interface1::Input
Base class for the input objects in the training stage of the classification algorithms.
Definition: classifier_training_types.h:134
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::training::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: classifier_training_batch.h:102
daal::algorithms::classifier::training::interface1::Batch::clone
services::SharedPtr< Batch > clone() const
Definition: classifier_training_batch.h:127
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::classifier::training::interface1::Batch::resetResult
virtual services::Status resetResult()=0
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::classifier::training::interface1::Batch
Algorithm class for training the classifier model.
Definition: classifier_training_batch.h:82
daal::algorithms::classifier::training::interface1::Result
Provides methods to access final results obtained with the compute() method in the batch processing m...
Definition: classifier_training_types.h:222
daal::algorithms::classifier::training::interface1::Batch::getInput
virtual InputType * getInput()=0
daal::algorithms::classifier::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: classifier_training_batch.h:114
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::Training
Provides methods to train models that depend on the data provided. For example, these methods enable ...
Definition: training.h:86

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