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

linear_model_model.h
1 /* file: linear_model_model.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 class defining the linear regression model
45 //--
46 */
47 
48 #ifndef __LINEAR_MODEL_MODEL_H__
49 #define __LINEAR_MODEL_MODEL_H__
50 
51 #include "algorithms/algorithm_types.h"
52 #include "algorithms/regression/regression_model.h"
53 #include "data_management/data/numeric_table.h"
54 
55 namespace daal
56 {
57 namespace algorithms
58 {
67 namespace linear_model
68 {
72 namespace interface1
73 {
84 /* [Parameter source code] */
85 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
86 {
87  Parameter();
88  Parameter(const Parameter &other);
89  bool interceptFlag;
90 };
91 /* [Parameter source code] */
92 
101 class DAAL_EXPORT Model : public regression::Model
102 {
103 public:
104  DAAL_CAST_OPERATOR(Model)
105 
106  virtual ~Model()
107  {}
108 
112  virtual services::Status initialize() = 0;
113 
118  virtual size_t getNumberOfBetas() const = 0;
119 
124  virtual size_t getNumberOfResponses() const = 0;
125 
130  virtual bool getInterceptFlag() const = 0;
131 
136  virtual data_management::NumericTablePtr getBeta() = 0;
137 };
138 
139 typedef services::SharedPtr<Model> ModelPtr;
140 typedef services::SharedPtr<const Model> ModelConstPtr;
142 }
143 using interface1::Parameter;
144 using interface1::Model;
145 using interface1::ModelPtr;
146 using interface1::ModelConstPtr;
147 
157 DAAL_EXPORT services::Status checkModel(
158  linear_model::Model *model, const daal::algorithms::Parameter &par, size_t nBeta, size_t nResponses);
159 
160 }
161 }
162 }
163 #endif
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::linear_model::checkModel
DAAL_EXPORT services::Status checkModel(linear_model::Model *model, const daal::algorithms::Parameter &par, size_t nBeta, size_t nResponses)
daal::algorithms::linear_model::interface1::Parameter
Parameters for the regression algorithm.
Definition: linear_model_model.h:85
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::algorithms::linear_model::interface1::Model
Base class for models trained with the regression algorithm
Definition: linear_model_model.h:101
daal::algorithms::regression::interface1::Model
Base class for models trained with the regression algorithm
Definition: regression_model.h:89
daal::algorithms::linear_model::interface1::Parameter::interceptFlag
bool interceptFlag
Definition: linear_model_model.h:89
daal::algorithms::linear_regression::training::model
Definition: linear_regression_training_types.h:125

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