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

regression_predict.h
1 /* file: regression_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 the regression model-based prediction
45 //--
46 */
47 
48 #ifndef __REGRESSION_PREDICT_H__
49 #define __REGRESSION_PREDICT_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/regression/regression_predict_types.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
58 namespace regression
59 {
60 namespace prediction
61 {
62 namespace interface1
63 {
77 class Batch : public daal::algorithms::Prediction
78 {
79 public:
80  typedef algorithms::regression::prediction::Input InputType;
81  typedef algorithms::Parameter ParameterType;
82  typedef algorithms::regression::prediction::Result ResultType;
83 
84  virtual ~Batch() {}
85  virtual InputType* getInput() = 0;
86 
93  services::Status setResult(const ResultPtr& res)
94  {
95  DAAL_CHECK(res, services::ErrorNullResult)
96  _result = res;
97  _res = _result.get();
98  return services::Status();
99  }
100 
105  ResultPtr getResult() { return _result; }
106 
107 protected:
108  ResultPtr _result;
109 };
111 }
112 using interface1::Batch;
113 }
114 }
115 }
116 }
117 #endif
daal::algorithms::regression::prediction::interface1::Result
Provides interface for the result of the regression model-based prediction.
Definition: regression_predict_types.h:159
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::neural_networks::prediction::prediction
Definition: neural_networks_prediction_result.h:79
daal::algorithms::Prediction
Provides prediction methods depending on the model such as linear_regression::Model. The methods of the class support different computation modes: batch, distributed, and online(see ComputeMode). Classes that implement specific algorithms of the model based data prediction are derived classes of the Prediction class. The class additionally provides virtual methods for validation of input and output parameters of the algorithms.
Definition: prediction.h:76
daal::algorithms::regression::prediction::interface1::Batch::getResult
ResultPtr getResult()
Definition: regression_predict.h:105
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::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::regression::prediction::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: regression_predict.h:93
daal::algorithms::regression::prediction::interface1::Input
Provides an interface for input objects for making the regression model-based prediction.
Definition: regression_predict_types.h:111
daal::algorithms::regression::prediction::interface1::Batch
Provides methods to run implementations of the regression model-based prediction. ...
Definition: regression_predict.h:77
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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