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

ridge_regression_training_batch.h
1 /* file: ridge_regression_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 ridge regression model-based training in the batch processing mode
45 //--
46 */
47 
48 #ifndef __RIDGE_REGRESSION_TRAINING_BATCH_H__
49 #define __RIDGE_REGRESSION_TRAINING_BATCH_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "services/daal_defines.h"
53 #include "services/daal_memory.h"
54 #include "algorithms/ridge_regression/ridge_regression_training_types.h"
55 #include "algorithms/ridge_regression/ridge_regression_model.h"
56 #include "algorithms/linear_model/linear_model_training_batch.h"
57 
58 namespace daal
59 {
60 namespace algorithms
61 {
62 namespace ridge_regression
63 {
64 namespace training
65 {
66 namespace interface1
67 {
77 template<typename algorithmFPType, Method method, CpuType cpu>
78 class DAAL_EXPORT BatchContainer : public TrainingContainerIface<batch>
79 {
80 public:
85  BatchContainer(daal::services::Environment::env *daalEnv);
86 
88  ~BatchContainer();
89 
95  services::Status compute() DAAL_C11_OVERRIDE;
96 };
97 
114 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = normEqDense>
115 class DAAL_EXPORT Batch : public linear_model::training::Batch
116 {
117 public:
118  typedef algorithms::ridge_regression::training::Input InputType;
119  typedef algorithms::ridge_regression::TrainParameter ParameterType;
120  typedef algorithms::ridge_regression::training::Result ResultType;
121 
122  InputType input;
123  ParameterType parameter;
126  Batch()
127  {
128  initialize();
129  }
130 
137  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
138  {
139  initialize();
140  }
141 
142  ~Batch() {}
143 
144  virtual regression::training::Input* getInput() DAAL_C11_OVERRIDE { return &input; }
145 
150  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
151 
156  ResultPtr getResult() { return ResultType::cast(_result); }
157 
164  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
165  {
166  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
167  }
168 
169 protected:
170 
171  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
172  {
173  return new Batch<algorithmFPType, method>(*this);
174  }
175 
176  services::Status allocateResult() DAAL_C11_OVERRIDE
177  {
178  services::Status s = getResult()->template allocate<algorithmFPType>(&input, &parameter, method);
179  _res = _result.get();
180  return s;
181  }
182 
183  void initialize()
184  {
185  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
186  _in = &input;
187  _par = &parameter;
188  _result.reset(new ResultType());
189  }
190 };
192 } // namespace interface1
193 
194 using interface1::BatchContainer;
195 using interface1::Batch;
196 
197 } // namespace training
198 } // namespace ridge_regression
199 } // namespace algorithms
200 } // namespace daal
201 
202 #endif
daal::algorithms::ridge_regression::training::interface1::Batch::parameter
ParameterType parameter
Definition: ridge_regression_training_batch.h:123
daal::algorithms::regression::training::interface1::Input
Input objects for the regression model-based training
Definition: regression_training_types.h:102
daal::algorithms::ridge_regression::training::interface1::Batch::input
InputType input
Definition: ridge_regression_training_batch.h:122
daal::algorithms::ridge_regression::training::interface1::Batch
Provides methods for ridge regression model-based training in the batch processing mode...
Definition: ridge_regression_training_batch.h:115
daal::services::interface1::Environment::_envStruct
The environment structure.
Definition: env_detect.h:95
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::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: ridge_regression_training_batch.h:150
daal::algorithms::ridge_regression::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: ridge_regression_training_batch.h:164
daal::algorithms::linear_model::training::interface1::Result
Provides methods to access the result obtained with the compute() method of the regression model-base...
Definition: linear_model_training_types.h:174
daal::algorithms::linear_model::interface1::Parameter
Parameters for the regression algorithm.
Definition: linear_model_model.h:85
daal_defines.h
daal::algorithms::ridge_regression::interface1::TrainParameter
Parameters for the ridge regression algorithm.
Definition: ridge_regression_model.h:94
daal::algorithms::linear_model::training::interface1::Input
Input objects for the regression model-based training
Definition: linear_model_training_types.h:103
daal::batch
Definition: daal_defines.h:132
daal::algorithms::ridge_regression::training::interface1::Batch::Batch
Batch()
Definition: ridge_regression_training_batch.h:126
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::ridge_regression::training::interface1::Batch::getInput
virtual regression::training::Input * getInput() DAAL_C11_OVERRIDE
Definition: ridge_regression_training_batch.h:144
daal::algorithms::ridge_regression::training::interface1::BatchContainer
Class containing methods for normal equations ridge regression model-based training using algorithmFP...
Definition: ridge_regression_training_batch.h:78
daal::algorithms::ridge_regression::training::interface1::Result
Provides methods to access the result obtained with the compute() method of ridge regression model-ba...
Definition: ridge_regression_training_types.h:358
daal::algorithms::ridge_regression::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: ridge_regression_training_batch.h:137
daal::algorithms::ridge_regression::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: ridge_regression_training_batch.h:156
daal::algorithms::ridge_regression::training::interface1::Input
Input objects for ridge regression model-based training
Definition: ridge_regression_training_types.h:158
daal::algorithms::linear_model::training::interface1::Batch
Provides methods for linear model model-based training in the batch processing mode.
Definition: linear_model_training_batch.h:78
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:76

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