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

pca_transform_batch.h
1 /* file: pca_transform_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2020 Intel Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *******************************************************************************/
17 
18 /*
19 //++
20 // Implementation of the interface for the PCA transformation algorithm in the
21 // batch processing mode
22 //--
23 */
24 
25 #ifndef __PCA_TRANSFORM_BATCH_H__
26 #define __PCA_TRANSFORM_BATCH_H__
27 
28 #include "algorithms/algorithm.h"
29 #include "services/daal_defines.h"
30 #include "algorithms/pca/transform/pca_transform_types.h"
31 
32 namespace daal
33 {
34 namespace algorithms
35 {
36 namespace pca
37 {
38 namespace transform
39 {
40 namespace interface1
41 {
55 template<typename algorithmFPType, Method method, CpuType cpu>
56 class BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
57 {
58 public:
64  BatchContainer(daal::services::Environment::env *daalEnv);
66  virtual ~BatchContainer();
70  virtual services::Status compute() DAAL_C11_OVERRIDE;
71 };
72 
84 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
85 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
86 {
87 public:
88  typedef algorithms::pca::transform::Input InputType;
89  typedef algorithms::pca::transform::Parameter ParameterType;
90  typedef algorithms::pca::transform::Result ResultType;
91 
92  InputType input;
93  ParameterType parameter;
99  Batch(size_t nComponents = 0): parameter(nComponents)
100  {
101  initialize();
102  }
103 
110  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
111  {
112  initialize();
113  }
114 
119  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
120 
125  ResultPtr getResult()
126  {
127  return _result;
128  }
129 
134  services::Status setResult(const ResultPtr& res)
135  {
136  DAAL_CHECK(res, services::ErrorNullResult)
137  _result = res;
138  _res = _result.get();
139  return services::Status();
140  }
141 
147  services::SharedPtr<daal::algorithms::pca::transform::interface1::Batch<algorithmFPType, method> > clone() const
148  {
149  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
150  }
151 
152 protected:
153  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
154  {
155  return new Batch<algorithmFPType, method>(*this);
156  }
157 
158  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
159  {
160  _result.reset(new ResultType());
161  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, 0);
162  _res = _result.get();
163  return s;
164  }
165 
166  void initialize()
167  {
168  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
169  _in = &input;
170  _par = &parameter;
171  }
172 
173 private:
174  ResultPtr _result;
175 };
177 } // namespace interface1
178 using interface1::BatchContainer;
179 using interface1::Batch;
180 
181 } // namespace transform
182 } // namespace pca
183 } // namespace algorithms
184 } // namespace daal
185 #endif
daal::algorithms::pca::transform::interface1::BatchContainer::compute
virtual services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::pca::transform::interface1::Batch::input
InputType input
Definition: pca_transform_batch.h:92
daal::batch
Definition: daal_defines.h:112
daal::algorithms::pca::transform::interface1::Batch::getResult
ResultPtr getResult()
Definition: pca_transform_batch.h:125
daal::algorithms::pca::transform::interface1::Batch::parameter
ParameterType parameter
Definition: pca_transform_batch.h:93
daal::algorithms::pca::transform::interface1::BatchContainer
Provides methods to run implementations of the PCA transformation algorithm in the batch processing m...
Definition: pca_transform_batch.h:56
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:55
daal::algorithms::pca::transform::interface1::Batch::Batch
Batch(size_t nComponents=0)
Definition: pca_transform_batch.h:99
daal::algorithms::pca::transform::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: pca_transform_batch.h:134
daal::algorithms::pca::transform::interface1::Batch::clone
services::SharedPtr< daal::algorithms::pca::transform::interface1::Batch< algorithmFPType, method > > clone() const
Definition: pca_transform_batch.h:147
daal_defines.h
daal::algorithms::pca::transform::interface1::Batch
Computes the results of the PCA transformation algorithm in the batch processing mode.
Definition: pca_transform_batch.h:85
daal::algorithms::pca::transform::interface1::BatchContainer::BatchContainer
BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::pca::transform::interface1::BatchContainer::~BatchContainer
virtual ~BatchContainer()
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::pca::transform::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: pca_transform_batch.h:110
daal::algorithms::pca::transform::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: pca_transform_batch.h:119

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