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

cholesky_types.h
1 /* file: cholesky_types.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 Cholesky algorithm interface.
21 //--
22 */
23 
24 #ifndef __CHOLESKY_TYPES_H__
25 #define __CHOLESKY_TYPES_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "data_management/data/numeric_table.h"
29 #include "data_management/data/homogen_numeric_table.h"
30 #include "services/daal_defines.h"
31 
32 namespace daal
33 {
34 namespace algorithms
35 {
45 namespace cholesky
46 {
51 enum Method
52 {
53  defaultDense = 0
54 };
55 
60 enum InputId
61 {
62  data,
63  lastInputId = data
64 };
65 
70 enum ResultId
71 {
72  choleskyFactor,
73  lastResultId = choleskyFactor
74 };
75 
79 namespace interface1
80 {
85 class DAAL_EXPORT Input : public daal::algorithms::Input
86 {
87 public:
88  Input();
89  Input(const Input& other) : daal::algorithms::Input(other){}
90 
91  virtual ~Input() {}
92 
98  data_management::NumericTablePtr get(InputId id) const;
99 
105  void set(InputId id, const data_management::NumericTablePtr &ptr);
106 
114  virtual services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
115 };
116 
121 class DAAL_EXPORT Result : public daal::algorithms::Result
122 {
123 public:
124  DECLARE_SERIALIZABLE_CAST(Result);
125  Result();
126 
127  virtual ~Result() {};
128 
137  template <typename algorithmFPType>
138  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method);
139 
145  data_management::NumericTablePtr get(ResultId id) const;
146 
152  void set(ResultId id, const data_management::NumericTablePtr &ptr);
153 
162  virtual services::Status check(const algorithms::Input *input, const algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
163 
164 protected:
166  template<typename Archive, bool onDeserialize>
167  services::Status serialImpl(Archive *arch)
168  {
169  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
170  }
171 };
172 typedef services::SharedPtr<Result> ResultPtr;
174 } // namespace interface1
175 using interface1::Input;
176 using interface1::Result;
177 using interface1::ResultPtr;
178 
179 } // namespace cholesky
180 } // namespace algorithm
181 } // namespace daal
182 #endif
daal::algorithms::cholesky::interface1::Result
Results obtained with the compute() method of the Cholesky algorithm in the batch processing mode...
Definition: cholesky_types.h:121
daal::algorithms::cholesky::defaultDense
Definition: cholesky_types.h:53
daal_defines.h
daal::algorithms::cholesky::data
Definition: cholesky_types.h:62
daal::algorithms::cholesky::InputId
InputId
Definition: cholesky_types.h:60
daal::algorithms::cholesky::ResultId
ResultId
Definition: cholesky_types.h:70
daal::algorithms::cholesky::Method
Method
Definition: cholesky_types.h:51
daal::algorithms::cholesky::choleskyFactor
Definition: cholesky_types.h:72
daal::algorithms::cholesky::interface1::Input
Input parameters for the Cholesky algorithm
Definition: cholesky_types.h:85

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