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

linear_regression_single_beta_types.h
1 /* file: linear_regression_single_beta_types.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 for the linear regression algorithm quality metrics for a single beta coefficient
45 //--
46 */
47 
48 #ifndef __LINEAR_REGRESSION_SINGLE_BETA_TYPES_H__
49 #define __LINEAR_REGRESSION_SINGLE_BETA_TYPES_H__
50 
51 #include "services/daal_shared_ptr.h"
52 #include "algorithms/algorithm.h"
53 #include "algorithms/linear_regression/linear_regression_model.h"
54 #include "data_management/data/homogen_numeric_table.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace linear_regression
61 {
62 namespace quality_metric
63 {
70 namespace single_beta
71 {
72 
77 enum Method
78 {
79  defaultDense = 0
80 };
81 
86 enum DataInputId
87 {
88  expectedResponses,
89  predictedResponses,
90  lastDataInputId = predictedResponses
91 };
92 
97 enum ModelInputId
98 {
99  model = lastDataInputId + 1,
100  lastModelInputId = model
101 };
102 
107 enum ResultId
108 {
109  rms,
110  variance,
111  zScore,
112  confidenceIntervals,
113  inverseOfXtX,
114  lastResultId = inverseOfXtX
115 };
116 
121 enum ResultDataCollectionId
122 {
123  betaCovariances = lastResultId + 1,
124  lastResultDataCollectionId = betaCovariances
125 };
126 
130 namespace interface1
131 {
132 
139 /* [Parameter source code] */
140 struct DAAL_EXPORT Parameter: public daal::algorithms::Parameter
141 {
142  Parameter(double alphaVal = 0.05, double accuracyVal = 0.001);
143  virtual ~Parameter() {}
144 
145  double alpha;
146  double accuracyThreshold;
152  virtual services::Status check() const;
153 };
154 /* [Parameter source code] */
155 
160 class DAAL_EXPORT Input: public daal::algorithms::Input
161 {
162 public:
163  DAAL_CAST_OPERATOR(Input);
164  DAAL_DOWN_CAST_OPERATOR(Input, daal::algorithms::Input);
165 
167  Input();
168 
169  virtual ~Input() {}
170 
176  data_management::NumericTablePtr get(DataInputId id) const;
177 
183  void set(DataInputId id, const data_management::NumericTablePtr &value);
184 
190  linear_regression::ModelPtr get(ModelInputId id) const;
191 
197  void set(ModelInputId id, const linear_regression::ModelPtr &value);
198 
206  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
207 };
208 typedef services::SharedPtr<Input> InputPtr;
209 
214 class DAAL_EXPORT Result: public daal::algorithms::Result
215 {
216 public:
217  DAAL_CAST_OPERATOR(Result);
218  DAAL_DOWN_CAST_OPERATOR(Result, daal::algorithms::Result);
219 
220  Result();
221 
227  data_management::NumericTablePtr get(ResultId id) const;
228 
234  void set(ResultId id, const data_management::NumericTablePtr &value);
235 
241  data_management::DataCollectionPtr get(ResultDataCollectionId id) const;
242 
249  data_management::NumericTablePtr get(ResultDataCollectionId id, size_t index) const;
250 
256  void set(ResultDataCollectionId id, const data_management::DataCollectionPtr &value);
257 
266  template <typename algorithmFPType>
267  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method);
268 
277  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
278 
282  int getSerializationTag() const DAAL_C11_OVERRIDE { return SERIALIZATION_LINEAR_REGRESSION_SINGLE_BETA_RESULT_ID; }
283 
284 protected:
286  template<typename Archive, bool onDeserialize>
287  services::Status serialImpl(Archive *arch)
288  {
289  daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
290 
291  return services::Status();
292  }
293 
294  services::Status serializeImpl(data_management::InputDataArchive *arch) DAAL_C11_OVERRIDE
295  {
296  serialImpl<data_management::InputDataArchive, false>(arch);
297 
298  return services::Status();
299  }
300 
301  services::Status deserializeImpl(const data_management::OutputDataArchive *arch) DAAL_C11_OVERRIDE
302  {
303  serialImpl<const data_management::OutputDataArchive, true>(arch);
304 
305  return services::Status();
306  }
307 };
308 typedef services::SharedPtr<Result> ResultPtr;
309 
310 }
311 using interface1::Parameter;
312 using interface1::Result;
313 using interface1::ResultPtr;
314 using interface1::Input;
315 using interface1::InputPtr;
316 
317 }
319 }
320 }
321 }
322 }
323 
324 #endif // __LINEAR_REGRESSION_SINGLE_BETA_TYPES_H__
daal::algorithms::linear_regression::quality_metric::single_beta::variance
Definition: linear_regression_single_beta_types.h:110
daal::algorithms::linear_regression::quality_metric::single_beta::DataInputId
DataInputId
Available identifiers of input objects for a single beta quality metrics.
Definition: linear_regression_single_beta_types.h:86
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::interface1::Result
Base class to represent final results of the computation. Algorithm-specific final results are repres...
Definition: algorithm_types.h:331
daal::data_management::interface1::InputDataArchive
Provides methods to create an archive data object (serialized) and access this object.
Definition: data_archive.h:715
daal::algorithms::linear_regression::quality_metric::single_beta::ResultId
ResultId
Available identifiers of the result of single beta quality metrics.
Definition: linear_regression_single_beta_types.h:107
daal::algorithms::linear_regression::quality_metric::single_beta::defaultDense
Definition: linear_regression_single_beta_types.h:79
daal::algorithms::linear_regression::quality_metric::single_beta::interface1::Result::getSerializationTag
int getSerializationTag() const DAAL_C11_OVERRIDE
Definition: linear_regression_single_beta_types.h:282
daal::algorithms::linear_regression::quality_metric::single_beta::ResultDataCollectionId
ResultDataCollectionId
Available identifiers of the result of single beta quality metrics.
Definition: linear_regression_single_beta_types.h:121
daal::algorithms::linear_regression::quality_metric::single_beta::model
Definition: linear_regression_single_beta_types.h:99
daal::algorithms::linear_regression::quality_metric::single_beta::expectedResponses
Definition: linear_regression_single_beta_types.h:88
daal::algorithms::linear_regression::quality_metric::single_beta::zScore
Definition: linear_regression_single_beta_types.h:111
daal::algorithms::linear_regression::quality_metric::single_beta::interface1::Result::deserializeImpl
services::Status deserializeImpl(const data_management::OutputDataArchive *arch) DAAL_C11_OVERRIDE
Definition: linear_regression_single_beta_types.h:301
daal::algorithms::linear_regression::quality_metric::single_beta::predictedResponses
Definition: linear_regression_single_beta_types.h:89
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
daal::algorithms::linear_regression::quality_metric::single_beta::ModelInputId
ModelInputId
Available identifiers of input objects for single beta quality metrics.
Definition: linear_regression_single_beta_types.h:97
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_regression::quality_metric::single_beta::betaCovariances
Definition: linear_regression_single_beta_types.h:123
daal::data_management::interface1::OutputDataArchive
Provides methods to restore an object from its serialized counterpart and access the restored object...
Definition: data_archive.h:978
daal::algorithms::linear_regression::quality_metric::single_beta::interface1::Parameter::alpha
double alpha
Definition: linear_regression_single_beta_types.h:145
daal::algorithms::linear_regression::quality_metric::single_beta::interface1::Input
Input objects for single beta quality metrics
Definition: linear_regression_single_beta_types.h:160
daal::algorithms::linear_regression::quality_metric::single_beta::Method
Method
Definition: linear_regression_single_beta_types.h:77
daal::algorithms::linear_regression::quality_metric::single_beta::confidenceIntervals
Definition: linear_regression_single_beta_types.h:112
daal::algorithms::math::abs::value
Definition: abs_types.h:112
daal::algorithms::linear_regression::quality_metric::single_beta::interface1::Parameter
Parameters for the compute() method of single beta quality metrics.
Definition: linear_regression_single_beta_types.h:140
daal::algorithms::linear_regression::quality_metric::single_beta::interface1::Parameter::accuracyThreshold
double accuracyThreshold
Definition: linear_regression_single_beta_types.h:146
daal::algorithms::linear_regression::quality_metric::single_beta::inverseOfXtX
Definition: linear_regression_single_beta_types.h:113
daal::algorithms::linear_regression::quality_metric::single_beta::interface1::Result
Provides interface for the result of linear regression quality metrics.
Definition: linear_regression_single_beta_types.h:214
daal::algorithms::linear_regression::quality_metric::single_beta::interface1::Result::serializeImpl
services::Status serializeImpl(data_management::InputDataArchive *arch) DAAL_C11_OVERRIDE
Definition: linear_regression_single_beta_types.h:294
daal::algorithms::linear_regression::quality_metric::single_beta::rms
Definition: linear_regression_single_beta_types.h:109
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217

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