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

qr_batch.h
1 /* file: qr_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 QR decomposition algorithm in the
21 // batch processing mode
22 //--
23 */
24 
25 #ifndef __QR_BATCH_H__
26 #define __QR_BATCH_H__
27 
28 #include "algorithms/algorithm.h"
29 #include "data_management/data/numeric_table.h"
30 #include "services/daal_defines.h"
31 #include "algorithms/qr/qr_types.h"
32 
33 namespace daal
34 {
35 namespace algorithms
36 {
37 namespace qr
38 {
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::qr::Input InputType;
89  typedef algorithms::qr::Parameter ParameterType;
90  typedef algorithms::qr::Result ResultType;
91 
92  InputType input;
93  ParameterType parameter;
95  Batch()
96  {
97  initialize();
98  }
99 
106  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
107  {
108  initialize();
109  }
110 
115  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
116 
121  ResultPtr getResult()
122  {
123  return _result;
124  }
125 
130  services::Status setResult(const ResultPtr& res)
131  {
132  DAAL_CHECK(res, services::ErrorNullResult)
133  _result = res;
134  _res = _result.get();
135  return services::Status();
136  }
137 
143  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
144  {
145  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
146  }
147 
148 protected:
149  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
150  {
151  return new Batch<algorithmFPType, method>(*this);
152  }
153 
154  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
155  {
156  _result.reset(new ResultType());
157  services::Status s = _result->allocate<algorithmFPType>(&input, 0, 0);
158  _res = _result.get();
159  return s;
160  }
161 
162  void initialize()
163  {
164  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
165  _in = &input;
166  _par = &parameter;
167  }
168 
169 private:
170  ResultPtr _result;
171 };
173 } // namespace interface1
174 using interface1::BatchContainer;
175 using interface1::Batch;
176 
177 } // namespace daal::algorithms::qr
178 }
179 } // namespace daal
180 #endif
daal::algorithms::qr::interface1::BatchContainer::compute
virtual services::Status compute() DAAL_C11_OVERRIDE
daal::batch
Definition: daal_defines.h:112
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_defines.h
daal::algorithms::qr::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: qr_batch.h:106
daal::algorithms::qr::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: qr_batch.h:115
daal::algorithms::qr::interface1::BatchContainer::BatchContainer
BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::qr::interface1::Batch::input
InputType input
Definition: qr_batch.h:92
daal::algorithms::qr::interface1::BatchContainer
Provides methods to run implementations of the QR decomposition algorithm in the batch processing mod...
Definition: qr_batch.h:56
daal::algorithms::qr::interface1::Batch
Computes the results of the QR decomposition algorithm in the batch processing mode.
Definition: qr_batch.h:85
daal::algorithms::qr::interface1::Batch::parameter
ParameterType parameter
Definition: qr_batch.h:93
daal::algorithms::qr::interface1::Batch::setResult
services::Status setResult(const ResultPtr &res)
Definition: qr_batch.h:130
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::qr::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: qr_batch.h:143
daal::algorithms::qr::interface1::BatchContainer::~BatchContainer
virtual ~BatchContainer()
daal::algorithms::qr::interface1::Batch::getResult
ResultPtr getResult()
Definition: qr_batch.h:121

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