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

cholesky.h
1 /* file: cholesky.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 Cholesky decomposition algorithm
21 //--
22 */
23 
24 #ifndef __CHOLESKY_H__
25 #define __CHOLESKY_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "data_management/data/numeric_table.h"
29 #include "services/daal_defines.h"
30 #include "algorithms/cholesky/cholesky_types.h"
31 
32 namespace daal
33 {
34 namespace algorithms
35 {
36 namespace cholesky
37 {
38 namespace interface1
39 {
53 template<typename algorithmFPType, Method method, CpuType cpu>
54 class BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
55 {
56 public:
61  BatchContainer(daal::services::Environment::env *daalEnv);
63  ~BatchContainer();
67  virtual services::Status compute() DAAL_C11_OVERRIDE;
68 };
69 
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::cholesky::Input InputType;
89  typedef algorithms::cholesky::Result ResultType;
90 
92  Batch()
93  {
94  initialize();
95  }
96 
103  Batch(const Batch<algorithmFPType, method> &other) : input(other.input)
104  {
105  initialize();
106  }
107 
109  virtual ~Batch() {}
110 
115  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
116 
121  ResultPtr getResult()
122  {
123  return _result;
124  }
125 
132  services::Status setResult(const ResultPtr& result)
133  {
134  DAAL_CHECK(result, services::ErrorNullResult)
135  _result = result;
136  _res = _result.get();
137  return services::Status();
138  }
139 
145  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
146  {
147  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
148  }
149 
150 protected:
151  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
152  {
153  return new Batch<algorithmFPType, method>(*this);
154  }
155 
156  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
157  {
158  services::Status s = _result->allocate<algorithmFPType>(&input, NULL, (int)method);
159  _res = _result.get();
160  return s;
161  }
162 
163  void initialize()
164  {
165  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
166  _in = &input;
167  _result.reset(new ResultType());
168  }
169 
170 public:
171  InputType input;
173 private:
174  ResultPtr _result;
175 };
177 } // namespace interface1
178 using interface1::BatchContainer;
179 using interface1::Batch;
180 
181 } // namespace cholesky
182 } // namespace algorithm
183 } // namespace daal
184 #endif
daal::algorithms::cholesky::interface1::BatchContainer::~BatchContainer
~BatchContainer()
daal::algorithms::cholesky::interface1::BatchContainer
Provides methods to run implementations of the Cholesky decomposition algorithm. This class is associ...
Definition: cholesky.h:54
daal::batch
Definition: daal_defines.h:112
daal::algorithms::cholesky::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: cholesky.h:145
daal::algorithms::cholesky::interface1::Batch::~Batch
virtual ~Batch()
Definition: cholesky.h:109
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::cholesky::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: cholesky.h:132
daal::algorithms::cholesky::interface1::Batch::getResult
ResultPtr getResult()
Definition: cholesky.h:121
daal::algorithms::cholesky::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: cholesky.h:103
daal::algorithms::cholesky::interface1::Batch
Computes Cholesky decomposition in the batch processing mode.
Definition: cholesky.h:85
daal::algorithms::cholesky::interface1::Batch::Batch
Batch()
Definition: cholesky.h:92
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::cholesky::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: cholesky.h:115
daal::algorithms::cholesky::interface1::Batch::input
InputType input
Definition: cholesky.h:171
daal::algorithms::cholesky::interface1::BatchContainer::BatchContainer
BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::cholesky::interface1::BatchContainer::compute
virtual services::Status compute() DAAL_C11_OVERRIDE

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