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

pca_batch.h
1 /* file: pca_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 // Implementation of the interface for the PCA algorithm in the batch processing mode
45 //--
46 */
47 
48 #ifndef __PCA_BATCH_H__
49 #define __PCA_BATCH_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/numeric_table.h"
53 #include "services/daal_defines.h"
54 #include "services/daal_memory.h"
55 #include "algorithms/pca/pca_types.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
61 namespace pca
62 {
63 
64 namespace interface2
65 {
74 template<typename algorithmFPType, Method method, CpuType cpu>
75 class DAAL_EXPORT BatchContainer : public AnalysisContainerIface<batch>
76 {};
77 
81 template<typename algorithmFPType, CpuType cpu>
82 class DAAL_EXPORT BatchContainer<algorithmFPType, correlationDense, cpu> : public AnalysisContainerIface<batch>
83 {
84 public:
90  BatchContainer(daal::services::Environment::env *daalEnv);
92  ~BatchContainer();
96  services::Status compute() DAAL_C11_OVERRIDE;
97 };
98 
102 template<typename algorithmFPType, CpuType cpu>
103 class DAAL_EXPORT BatchContainer<algorithmFPType, svdDense, cpu> : public AnalysisContainerIface<batch>
104 {
105 public:
111  BatchContainer(daal::services::Environment::env *daalEnv);
113  ~BatchContainer();
117  services::Status compute() DAAL_C11_OVERRIDE;
118 };
119 
131 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = correlationDense>
132 class DAAL_EXPORT Batch : public Analysis<batch>
133 {
134 public:
136  Batch()
137  {
138  initialize();
139  }
140 
146  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
147  {
148  initialize();
149  }
150 
151  ~Batch() {}
152 
157  virtual int getMethod() const DAAL_C11_OVERRIDE { return method; };
158 
163  services::Status setResult(const ResultPtr& res)
164  {
165  DAAL_CHECK(res, services::ErrorNullResult)
166  _result = res;
167  _res = _result.get();
168  return services::Status();
169  }
170 
175  ResultPtr getResult() { return _result; }
176 
182  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
183  {
184  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
185  }
186 
187  Input input;
188  BatchParameter<algorithmFPType, method> parameter;
190 protected:
191  ResultPtr _result;
192 
193  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
194  {
195  return new Batch<algorithmFPType, method>(*this);
196  }
197 
198  services::Status allocateResult() DAAL_C11_OVERRIDE
199  {
200  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, method);
201  _res = _result.get();
202  return s;
203  }
204 
205  void initialize()
206  {
207  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
208  _in = &input;
209  _par = &parameter;
210  _result.reset(new Result());
211  }
212 };
214 } // namespace interface1
215 using interface2::BatchContainer;
216 using interface2::Batch;
217 
218 }
219 }
220 }
221 #endif
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::interface2::Batch::input
Input input
Definition: pca_batch.h:187
daal::algorithms::pca::interface2::Batch::getResult
ResultPtr getResult()
Definition: pca_batch.h:175
daal_defines.h
daal::batch
Definition: daal_defines.h:131
daal::algorithms::pca::interface2::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: pca_batch.h:146
daal::algorithms::pca::interface2::BatchContainer
Class containing methods to compute the results of the PCA algorithm.
Definition: pca_batch.h:75
daal::algorithms::pca::svdDense
Definition: pca_types.h:83
daal::algorithms::pca::interface2::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: pca_batch.h:182
daal::algorithms::pca::interface2::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: pca_batch.h:163
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::interface2::Batch::Batch
Batch()
Definition: pca_batch.h:136
daal::algorithms::pca::interface2::Batch
Computes the results of the PCA algorithm.
Definition: pca_batch.h:132
daal::algorithms::pca::interface2::Batch::parameter
BatchParameter< algorithmFPType, method > parameter
Definition: pca_batch.h:188
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::pca::interface2::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: pca_batch.h:157
daal::algorithms::pca::interface2::BatchParameter
Class that specifies the parameters of the PCA algorithm in the batch computing mode.
Definition: pca_types.h:699
daal::algorithms::pca::correlationDense
Definition: pca_types.h:81

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