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

linear_regression_group_of_betas_batch.h
1 /* file: linear_regression_group_of_betas_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 // Interface of the linear regression group of betas quality metric in the batch processing mode.
45 //--
46 */
47 
48 #ifndef __LINEAR_REGRESSION_GROUP_OF_BETAS_BATCH_H__
49 #define __LINEAR_REGRESSION_GROUP_OF_BETAS_BATCH_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/linear_regression/linear_regression_group_of_betas_types.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
58 namespace linear_regression
59 {
63 namespace quality_metric
64 {
68 namespace group_of_betas
69 {
70 namespace interface1
71 {
84 template<typename algorithmFPType, Method method, CpuType cpu>
85 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
86 {
87 public:
89  BatchContainer(daal::services::Environment::env *daalEnv);
91  virtual ~BatchContainer();
92 
98  virtual services::Status compute() DAAL_C11_OVERRIDE;
99 };
100 
113 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
114 class DAAL_EXPORT Batch : public daal::algorithms::quality_metric::Batch
115 {
116 public:
117  typedef algorithms::linear_regression::quality_metric::group_of_betas::Input InputType;
118  typedef algorithms::linear_regression::quality_metric::group_of_betas::Parameter ParameterType;
119  typedef algorithms::linear_regression::quality_metric::group_of_betas::Result ResultType;
120 
121  InputType input;
122  ParameterType parameter;
125  Batch(size_t nBeta, size_t nBetaReducedModel) : parameter(nBeta, nBetaReducedModel)
126  {
127  initialize();
128  }
129 
136  Batch(const Batch<algorithmFPType, method> &other): parameter(other.parameter)
137  {
138  initialize();
139  input.set(expectedResponses, other.input.get(expectedResponses));
140  input.set(predictedResponses, other.input.get(predictedResponses));
141  input.set(predictedReducedModelResponses, other.input.get(predictedReducedModelResponses));
142  }
143 
148  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
149 
154  ResultPtr getResult() const
155  {
156  return _result;
157  }
158 
165  services::Status setResult(const ResultPtr& result)
166  {
167  DAAL_CHECK(result, services::ErrorNullResult)
168  _result = result;
169  _res = _result.get();
170  return services::Status();
171  }
172 
177  virtual void setInput(const algorithms::Input *other) DAAL_C11_OVERRIDE
178  {
179  const InputType *inputPtr = static_cast<const InputType *>(other);
180  input.set(expectedResponses, inputPtr->get(expectedResponses));
181  input.set(predictedResponses, inputPtr->get(predictedResponses));
182  input.set(predictedReducedModelResponses, inputPtr->get(predictedReducedModelResponses));
183  }
184 
190  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
191  {
192  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
193  }
194 
195 protected:
196  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
197  {
198  return new Batch<algorithmFPType, method>(*this);
199  }
200 
201  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
202  {
203  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, (int) method);
204  _res = _result.get();
205  return s;
206  }
207 
208  virtual algorithms::ResultPtr getResultImpl() const DAAL_C11_OVERRIDE
209  {
210  return _result;
211  }
212 
213  void initialize()
214  {
215  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
216  _in = &input;
217  _par = &parameter;
218  _result.reset(new ResultType());
219  }
220 
221 private:
222  ResultPtr _result;
223 };
225 } // namespace interface1
226 using interface1::BatchContainer;
227 using interface1::Batch;
228 
229 }
230 }
231 }
232 }
233 }
234 #endif
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: linear_regression_group_of_betas_batch.h:190
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Batch::parameter
ParameterType parameter
Definition: linear_regression_group_of_betas_batch.h:122
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::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Input::set
void set(DataInputId id, const data_management::NumericTablePtr &value)
Definition: linear_regression_group_of_betas_types.h:171
daal
Definition: algorithm_base_common.h:57
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:79
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Batch::input
InputType input
Definition: linear_regression_group_of_betas_batch.h:121
daal::algorithms::linear_regression::quality_metric::group_of_betas::expectedResponses
Definition: linear_regression_group_of_betas_types.h:87
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Result
Provides interface for the result of linear regression quality metrics.
Definition: linear_regression_group_of_betas_types.h:191
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Batch::setInput
virtual void setInput(const algorithms::Input *other) DAAL_C11_OVERRIDE
Definition: linear_regression_group_of_betas_batch.h:177
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: linear_regression_group_of_betas_batch.h:136
daal::batch
Definition: daal_defines.h:132
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::linear_regression::quality_metric::group_of_betas::interface1::Batch::Batch
Batch(size_t nBeta, size_t nBetaReducedModel)
Definition: linear_regression_group_of_betas_batch.h:125
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Batch::getResult
ResultPtr getResult() const
Definition: linear_regression_group_of_betas_batch.h:154
daal::algorithms::quality_metric::interface1::Batch
Provides methods to compute quality metrics of an algorithm in the batch processing mode...
Definition: algorithm_quality_metric_batch.h:79
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Batch
Computes the linear regression quality metric in the batch processing mode.
Definition: linear_regression_group_of_betas_batch.h:114
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: linear_regression_group_of_betas_batch.h:165
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::BatchContainer
Class containing methods to compute regression quality metric.
Definition: linear_regression_group_of_betas_batch.h:85
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Input::get
data_management::NumericTablePtr get(DataInputId id) const
Definition: linear_regression_group_of_betas_types.h:161
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Parameter
Parameters for the compute() method of a group of betas quality metrics.
Definition: linear_regression_group_of_betas_types.h:123
daal::algorithms::linear_regression::quality_metric::group_of_betas::predictedReducedModelResponses
Definition: linear_regression_group_of_betas_types.h:89
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: linear_regression_group_of_betas_batch.h:148
daal::algorithms::linear_regression::quality_metric::group_of_betas::predictedResponses
Definition: linear_regression_group_of_betas_types.h:88
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::linear_regression::quality_metric::group_of_betas::interface1::Input
Input objects for a group of betas quality metrics
Definition: linear_regression_group_of_betas_types.h:145

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