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

ridge_regression_model.h
1 /* file: ridge_regression_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 ridge regression model
45 //--
46 */
47 
48 #ifndef __RIDGE_REGRESSION_MODEL_H__
49 #define __RIDGE_REGRESSION_MODEL_H__
50 
51 #include "data_management/data/numeric_table.h"
52 #include "algorithms/linear_model/linear_model_model.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
63 namespace ridge_regression
64 {
65 
69 namespace interface1
70 {
81 /* [Parameter source code] */
82 struct Parameter : public linear_model::Parameter
83 {
84 };
85 /* [Parameter source code] */
86 
93 /* [TrainParameter source code] */
94 struct DAAL_EXPORT TrainParameter : public Parameter
95 {
96  TrainParameter();
97 
98  services::Status check() const DAAL_C11_OVERRIDE;
99 
100  data_management::NumericTablePtr ridgeParameters;
101 };
102 /* [TrainParameter source code] */
103 
116 class DAAL_EXPORT Model : public linear_model::Model
117 {
118 public:
119  DAAL_CAST_OPERATOR(Model)
120 };
121 typedef services::SharedPtr<Model> ModelPtr;
122 typedef services::SharedPtr<const Model> ModelConstPtr;
124 } // namespace interface1
125 
126 using interface1::Parameter;
127 using interface1::TrainParameter;
128 using interface1::Model;
129 using interface1::ModelPtr;
130 using interface1::ModelConstPtr;
131 
142 DAAL_EXPORT services::Status checkModel(
143  ridge_regression::Model* model, const daal::algorithms::Parameter &par, size_t nBeta, size_t nResponses, int method);
144 
145 } // namespace ridge_regression
146 } // namespace algorithms
147 } // namespace daal
148 
149 #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::ridge_regression::interface1::TrainParameter::ridgeParameters
data_management::NumericTablePtr ridgeParameters
Definition: ridge_regression_model.h:100
daal::algorithms::ridge_regression::interface1::Parameter
Parameters for the ridge regression algorithm.
Definition: ridge_regression_model.h:82
daal::algorithms::ridge_regression::checkModel
DAAL_EXPORT services::Status checkModel(ridge_regression::Model *model, const daal::algorithms::Parameter &par, size_t nBeta, size_t nResponses, int method)
daal::algorithms::linear_model::interface1::Parameter
Parameters for the regression algorithm.
Definition: linear_model_model.h:85
daal::algorithms::ridge_regression::interface1::TrainParameter
Parameters for the ridge regression algorithm.
Definition: ridge_regression_model.h:94
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::linear_regression::training::model
Definition: linear_regression_training_types.h:125
daal::algorithms::ridge_regression::interface1::Model
Base class for models trained with the ridge regression algorithm
Definition: ridge_regression_model.h:116

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