C++ API Reference for Intel® Data Analytics Acceleration Library 2019 Update 5

pivoted_qr_batch.h
1 /* file: pivoted_qr_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2019 Intel Corporation.
4 *
5 * This software and the related documents are Intel copyrighted materials, and
6 * your use of them is governed by the express license under which they were
7 * provided to you (License). Unless the License provides otherwise, you may not
8 * use, modify, copy, publish, distribute, disclose or transmit this software or
9 * the related documents without Intel's prior written permission.
10 *
11 * This software and the related documents are provided as is, with no express
12 * or implied warranties, other than those that are expressly stated in the
13 * License.
14 *******************************************************************************/
15 
16 /*
17 //++
18 // Implementation of the interface for the pivoted QR decomposition algorithm
19 // in the batch processing mode
20 //--
21 */
22 
23 #ifndef __PIVOTED_QR_BATCH_H__
24 #define __PIVOTED_QR_BATCH_H__
25 
26 #include "algorithms/algorithm.h"
27 #include "data_management/data/numeric_table.h"
28 #include "services/daal_defines.h"
29 #include "algorithms/pivoted_qr/pivoted_qr_types.h"
30 
31 namespace daal
32 {
33 namespace algorithms
34 {
35 namespace pivoted_qr
36 {
37 
38 namespace interface1
39 {
53 template<typename algorithmFPType, Method method, CpuType cpu>
54 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
55 {
56 public:
62  BatchContainer(daal::services::Environment::env *daalEnv);
64  virtual ~BatchContainer();
68  virtual services::Status compute() DAAL_C11_OVERRIDE;
69 };
70 
82 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
83 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
84 {
85 public:
86  typedef algorithms::pivoted_qr::Input InputType;
87  typedef algorithms::pivoted_qr::Parameter ParameterType;
88  typedef algorithms::pivoted_qr::Result ResultType;
89 
90  InputType input;
91  ParameterType parameter;
93  Batch()
94  {
95  initialize();
96  }
97 
104  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
105  {
106  initialize();
107  }
108 
113  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
114 
119  ResultPtr getResult()
120  {
121  return _result;
122  }
123 
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::pivoted_qr
176 }
177 } // namespace daal
178 #endif
daal
Definition: algorithm_base_common.h:31
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:53
daal::algorithms::pivoted_qr::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: pivoted_qr_batch.h:104
daal::algorithms::pivoted_qr::interface1::Batch::getResult
ResultPtr getResult()
Definition: pivoted_qr_batch.h:119
daal::algorithms::pivoted_qr::interface1::Batch
Computes the results of the pivoted QR algorithm in the batch processing mode.
Definition: pivoted_qr_batch.h:83
daal_defines.h
daal::batch
Definition: daal_defines.h:110
daal::algorithms::pivoted_qr::interface1::Batch::input
InputType input
Definition: pivoted_qr_batch.h:90
daal::algorithms::pivoted_qr::interface1::BatchContainer
Provides methods to run implementations of the pivoted QR decomposition algorithm.
Definition: pivoted_qr_batch.h:54
daal::algorithms::pivoted_qr::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: pivoted_qr_batch.h:113
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:68
daal::algorithms::pivoted_qr::interface1::Batch::parameter
ParameterType parameter
Definition: pivoted_qr_batch.h:91
daal::algorithms::pivoted_qr::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: pivoted_qr_batch.h:141
daal::algorithms::pivoted_qr::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: pivoted_qr_batch.h:128
daal::services::ErrorNullResult
Definition: error_indexes.h:96

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