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

regression_training_online.h
1 /* file: regression_training_online.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 linear regression model-based training
45 // in the online processing mode
46 //--
47 */
48 
49 #ifndef __REGRESSION_TRAINING_ONLINE_H__
50 #define __REGRESSION_TRAINING_ONLINE_H__
51 
52 #include "algorithms/regression/regression_training_types.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
58 namespace regression
59 {
60 namespace training
61 {
62 
63 namespace interface1
64 {
79 class DAAL_EXPORT Online : public Training<online>
80 {
81 public:
82  typedef algorithms::regression::training::Input InputType;
83  typedef algorithms::regression::training::Result ResultType;
84  typedef algorithms::regression::training::PartialResult PartialResultType;
85 
86  virtual ~Online() {}
87  virtual InputType* getInput() = 0;
88 
95  services::Status setPartialResult(const PartialResultPtr& partialResult)
96  {
97  _partialResult = partialResult;
98  _pres = _partialResult.get();
99  return services::Status();
100  }
101 
108  services::Status setResult(const ResultPtr& res)
109  {
110  DAAL_CHECK(res, services::ErrorNullResult)
111  _result = res;
112  _res = _result.get();
113  return services::Status();
114  }
115 
120  PartialResultPtr getPartialResult() { return _partialResult; }
121 
126  ResultPtr getResult() { return _result; }
127 
128 protected:
129  PartialResultPtr _partialResult;
130  ResultPtr _result;
131 }; // class : public Online
133 } // namespace interface1
134 using interface1::Online;
135 
136 }
137 }
138 }
139 }
140 #endif
daal::algorithms::regression::training::interface1::Result
Provides methods to access the result obtained with the compute() method of the regression model-base...
Definition: regression_training_types.h:168
daal::algorithms::regression::training::interface1::Input
Input objects for the regression model-based training
Definition: regression_training_types.h:102
daal::algorithms::regression::training::interface1::Online::getPartialResult
PartialResultPtr getPartialResult()
Definition: regression_training_online.h:120
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::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::regression::training::interface1::Online
Provides methods for the regression model-based training in the online processing mode...
Definition: regression_training_online.h:79
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::regression::training::interface1::Online::setPartialResult
services::Status setPartialResult(const PartialResultPtr &partialResult)
Definition: regression_training_online.h:95
daal::algorithms::regression::training::interface1::PartialResult
Provides methods to access a partial result obtained with the compute() method of the regression mode...
Definition: regression_training_types.h:143
daal::algorithms::regression::training::interface1::Online::setResult
services::Status setResult(const ResultPtr &res)
Definition: regression_training_online.h:108
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::regression::training::interface1::Online::getResult
ResultPtr getResult()
Definition: regression_training_online.h:126
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.