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

svd_batch.h
1 /* file: svd_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 SVD algorithm in the batch processing mode
21 //--
22 */
23 
24 #ifndef __SVD_BATCH_H__
25 #define __SVD_BATCH_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "data_management/data/numeric_table.h"
29 #include "services/daal_defines.h"
30 #include "algorithms/svd/svd_types.h"
31 
32 namespace daal
33 {
34 namespace algorithms
35 {
36 namespace svd
37 {
38 
39 namespace interface1
40 {
54 template<typename algorithmFPType, Method method, CpuType cpu>
55 class BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
56 {
57 public:
63  BatchContainer(daal::services::Environment::env *daalEnv);
65  virtual ~BatchContainer();
69  virtual services::Status compute() DAAL_C11_OVERRIDE;
70 };
71 
83 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
84 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
85 {
86 public:
87  typedef algorithms::svd::Input InputType;
88  typedef algorithms::svd::Parameter ParameterType;
89  typedef algorithms::svd::Result ResultType;
90 
91  InputType input;
92  ParameterType parameter;
94  Batch()
95  {
96  initialize();
97  }
98 
105  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
106  {
107  initialize();
108  }
109 
114  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
115 
120  ResultPtr getResult()
121  {
122  return _result;
123  }
124 
128  services::Status setResult(const ResultPtr& res)
129  {
130  DAAL_CHECK(res, services::ErrorNullResult)
131  _result = res;
132  _res = _result.get();
133  return services::Status();
134  }
135 
141  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
142  {
143  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
144  }
145 
146 protected:
147  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
148  {
149  return new Batch<algorithmFPType, method>(*this);
150  }
151 
152  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
153  {
154  _result.reset(new ResultType());
155  services::Status s = _result->allocate<algorithmFPType>(_in, 0, 0);
156  _res = _result.get();
157  return s;
158  }
159 
160  void initialize()
161  {
162  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
163  _in = &input;
164  _par = &parameter;
165  }
166 
167 private:
168  ResultPtr _result;
169 };
171 } // namespace interface1
172 using interface1::BatchContainer;
173 using interface1::Batch;
174 
175 } // namespace daal::algorithms::svd
176 }
177 } // namespace daal
178 #endif
daal::algorithms::svd::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: svd_batch.h:114
daal::batch
Definition: daal_defines.h:112
daal::algorithms::svd::interface1::Batch::parameter
ParameterType parameter
Definition: svd_batch.h:92
daal::algorithms::svd::interface1::BatchContainer::compute
virtual services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::svd::interface1::Batch::input
InputType input
Definition: svd_batch.h:91
daal::algorithms::svd::interface1::BatchContainer::~BatchContainer
virtual ~BatchContainer()
daal::algorithms::svd::interface1::BatchContainer::BatchContainer
BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::svd::interface1::Batch
Computes results of the SVD algorithm in the batch processing mode.
Definition: svd_batch.h:84
daal::algorithms::svd::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: svd_batch.h:141
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::svd::interface1::BatchContainer
Provides methods to run implementations of the SVD algorithm.
Definition: svd_batch.h:55
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:55
daal_defines.h
daal::algorithms::svd::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: svd_batch.h:105
daal::algorithms::svd::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: svd_batch.h:128
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::svd::interface1::Batch::getResult
ResultPtr getResult()
Definition: svd_batch.h:120

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