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

pca_transform_batch.h
1 /* file: pca_transform_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 transformation algorithm in the
45 // batch processing mode
46 //--
47 */
48 
49 #ifndef __PCA_TRANSFORM_BATCH_H__
50 #define __PCA_TRANSFORM_BATCH_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "services/daal_defines.h"
54 #include "algorithms/pca/transform/pca_transform_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace pca
61 {
62 namespace transform
63 {
64 namespace interface1
65 {
79 template<typename algorithmFPType, Method method, CpuType cpu>
80 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
81 {
82 public:
88  BatchContainer(daal::services::Environment::env *daalEnv);
90  virtual ~BatchContainer();
94  virtual services::Status compute() DAAL_C11_OVERRIDE;
95 };
96 
108 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
109 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
110 {
111 public:
112  Input input;
113  Parameter parameter;
119  Batch(size_t nComponents = 0): parameter(nComponents)
120  {
121  initialize();
122  }
123 
130  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
131  {
132  initialize();
133  }
134 
139  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
140 
145  ResultPtr getResult()
146  {
147  return _result;
148  }
149 
154  services::Status setResult(const ResultPtr& res)
155  {
156  DAAL_CHECK(res, services::ErrorNullResult)
157  _result = res;
158  _res = _result.get();
159  return services::Status();
160  }
161 
167  services::SharedPtr<daal::algorithms::pca::transform::interface1::Batch<algorithmFPType, method> > clone() const
168  {
169  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
170  }
171 
172 protected:
173  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
174  {
175  return new Batch<algorithmFPType, method>(*this);
176  }
177 
178  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
179  {
180  _result.reset(new Result());
181  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, 0);
182  _res = _result.get();
183  return s;
184  }
185 
186  void initialize()
187  {
188  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
189  _in = &input;
190  _par = &parameter;
191  }
192 
193 private:
194  ResultPtr _result;
195 };
197 } // namespace interface1
198 using interface1::BatchContainer;
199 using interface1::Batch;
200 
201 } // namespace transform
202 } // namespace pca
203 } // namespace algorithms
204 } // namespace daal
205 #endif
daal::algorithms::pca::transform::interface1::Parameter
Parameters for the PCA transformation compute method.
Definition: pca_transform_types.h:254
daal::algorithms::pca::transform::interface1::Batch::clone
services::SharedPtr< daal::algorithms::pca::transform::interface1::Batch< algorithmFPType, method > > clone() const
Definition: pca_transform_batch.h:167
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::transform::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: pca_transform_batch.h:154
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:80
daal::algorithms::pca::transform::interface1::Input
Input objects for the PCA transformation algorithm in the batch and online processing modes and for t...
Definition: pca_transform_types.h:135
daal::algorithms::pca::transform::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: pca_transform_batch.h:130
daal_defines.h
daal::batch
Definition: daal_defines.h:131
daal::algorithms::pca::transform::interface1::Batch::parameter
Parameter parameter
Definition: pca_transform_batch.h:113
daal::algorithms::pca::transform::interface1::Batch::Batch
Batch(size_t nComponents=0)
Definition: pca_transform_batch.h:119
daal::algorithms::pca::transform::interface1::Batch::getResult
ResultPtr getResult()
Definition: pca_transform_batch.h:145
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::transform::interface1::Batch::input
Input input
Definition: pca_transform_batch.h:112
daal::algorithms::pca::transform::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: pca_transform_batch.h:139
daal::algorithms::pca::transform::interface1::Batch
Computes the results of the PCA transformation algorithm in the batch processing mode.
Definition: pca_transform_batch.h:109
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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