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

pca_explained_variance_batch.h
1 /* file: pca_explained_variance_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2017 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 single beta quality metric in the batch processing mode.
45 //--
46 */
47 
48 #ifndef __PCA_EXPLAINED_VARIANCE_BATCH_H__
49 #define __PCA_EXPLAINED_VARIANCE_BATCH_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/pca/pca_explained_variance_types.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
58 namespace pca
59 {
60 namespace quality_metric
61 {
65 namespace explained_variance
66 {
67 
68 namespace interface1
69 {
82 template<typename algorithmFPType, Method method, CpuType cpu>
83 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
84 {
85 public:
87  BatchContainer(daal::services::Environment::env *daalEnv);
89  virtual ~BatchContainer();
90 
96  virtual services::Status compute() DAAL_C11_OVERRIDE;
97 };
98 
111 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
112 class DAAL_EXPORT Batch : public daal::algorithms::quality_metric::Batch
113 {
114 public:
115  Input input;
116  Parameter parameter;
119  Batch(size_t nFeatures = 0, size_t nComponents = 0): parameter(nFeatures, nComponents)
120  {
121  initialize();
122  }
123 
130  Batch(const Batch<algorithmFPType, method> &other): parameter(other.parameter)
131  {
132  initialize();
133  input.set(eigenvalues, other.input.get(eigenvalues));
134  }
135 
140  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
141 
146  ResultPtr getResult() const
147  {
148  return _result;
149  }
150 
157  services::Status setResult(const ResultPtr& result)
158  {
159  DAAL_CHECK(result, services::ErrorNullResult)
160  _result = result;
161  _res = _result.get();
162  return services::Status();
163  }
164 
169  virtual void setInput(const algorithms::Input *other) DAAL_C11_OVERRIDE
170  {
171  const Input *inputPtr = static_cast<const Input *>(other);
172  input.set(eigenvalues, inputPtr->get(eigenvalues));
173  }
174 
180  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
181  {
182  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
183  }
184 
185 protected:
186  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
187  {
188  return new Batch<algorithmFPType, method>(*this);
189  }
190 
191  services::Status allocateResult() DAAL_C11_OVERRIDE
192  {
193  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, (int) method);
194  _res = _result.get();
195  return s;
196  }
197 
198  virtual algorithms::ResultPtr getResultImpl() const DAAL_C11_OVERRIDE
199  {
200  return _result;
201  }
202 
203  void initialize()
204  {
205  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
206  _in = &input;
207  _par = &parameter;
208  _result.reset(new Result());
209  }
210 
211 private:
212  ResultPtr _result;
213 };
215 } // namespace interface1
216 using interface1::BatchContainer;
217 using interface1::Batch;
218 
219 }
220 }
221 }
222 }
223 }
224 #endif
daal::algorithms::pca::quality_metric::explained_variance::interface1::BatchContainer
Class containing methods to compute regression quality metric.
Definition: pca_explained_variance_batch.h:83
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::pca::quality_metric::explained_variance::interface1::Batch::input
Input input
Definition: pca_explained_variance_batch.h:115
daal::algorithms::pca::quality_metric::explained_variance::interface1::Batch::setInput
virtual void setInput(const algorithms::Input *other) DAAL_C11_OVERRIDE
Definition: pca_explained_variance_batch.h:169
daal::batch
Definition: daal_defines.h:131
daal::algorithms::pca::quality_metric::explained_variance::interface1::Parameter
Parameters for the compute() method of explained variance quality metrics.
Definition: pca_explained_variance_types.h:116
daal::algorithms::pca::quality_metric::explained_variance::interface1::Batch::parameter
Parameter parameter
Definition: pca_explained_variance_batch.h:116
daal::algorithms::pca::quality_metric::explained_variance::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: pca_explained_variance_batch.h:180
daal::algorithms::pca::quality_metric::explained_variance::interface1::Batch::Batch
Batch(size_t nFeatures=0, size_t nComponents=0)
Definition: pca_explained_variance_batch.h:119
daal::algorithms::pca::quality_metric::explained_variance::interface1::Input
Input objects for explained variance quality metrics
Definition: pca_explained_variance_types.h:137
daal::algorithms::pca::quality_metric::explained_variance::interface1::Input::set
void set(InputId id, const data_management::NumericTablePtr &value)
daal::algorithms::pca::quality_metric::explained_variance::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: pca_explained_variance_batch.h:130
daal::algorithms::pca::quality_metric::explained_variance::interface1::Input::get
data_management::NumericTablePtr get(InputId id) const
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::pca::quality_metric::explained_variance::eigenvalues
Definition: pca_explained_variance_types.h:87
daal::algorithms::pca::quality_metric::explained_variance::interface1::Batch::getResult
ResultPtr getResult() const
Definition: pca_explained_variance_batch.h:146
daal::algorithms::pca::quality_metric::explained_variance::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: pca_explained_variance_batch.h:157
daal::algorithms::pca::quality_metric::explained_variance::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: pca_explained_variance_batch.h:140
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::pca::quality_metric::explained_variance::interface1::Batch
Computes the linear regression quality metric in the batch processing mode.
Definition: pca_explained_variance_batch.h:112

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