C++ API Reference for Intel® Data Analytics Acceleration Library 2018 Update 2

cholesky_types.h
1 /* file: cholesky_types.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 Intel Corporation
4 * All Rights Reserved.
5 *
6 * If this software was obtained under the Intel Simplified Software License,
7 * the following terms apply:
8 *
9 * The source code, information and material ("Material") contained herein is
10 * owned by Intel Corporation or its suppliers or licensors, and title to such
11 * Material remains with Intel Corporation or its suppliers or licensors. The
12 * Material contains proprietary information of Intel or its suppliers and
13 * licensors. The Material is protected by worldwide copyright laws and treaty
14 * provisions. No part of the Material may be used, copied, reproduced,
15 * modified, published, uploaded, posted, transmitted, distributed or disclosed
16 * in any way without Intel's prior express written permission. No license under
17 * any patent, copyright or other intellectual property rights in the Material
18 * is granted to or conferred upon you, either expressly, by implication,
19 * inducement, estoppel or otherwise. Any license under such intellectual
20 * property rights must be express and approved by Intel in writing.
21 *
22 * Unless otherwise agreed by Intel in writing, you may not remove or alter this
23 * notice or any other notice embedded in Materials by Intel or Intel's
24 * suppliers or licensors in any way.
25 *
26 *
27 * If this software was obtained under the Apache License, Version 2.0 (the
28 * "License"), the following terms apply:
29 *
30 * You may not use this file except in compliance with the License. You may
31 * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
32 *
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 *
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
40 *******************************************************************************/
41 
42 /*
43 //++
44 // Implementation of Cholesky algorithm interface.
45 //--
46 */
47 
48 #ifndef __CHOLESKY_TYPES_H__
49 #define __CHOLESKY_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/numeric_table.h"
53 #include "data_management/data/homogen_numeric_table.h"
54 #include "services/daal_defines.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
69 namespace cholesky
70 {
75 enum Method
76 {
77  defaultDense = 0
78 };
79 
84 enum InputId
85 {
86  data,
87  lastInputId = data
88 };
89 
94 enum ResultId
95 {
96  choleskyFactor,
97  lastResultId = choleskyFactor
98 };
99 
103 namespace interface1
104 {
109 class DAAL_EXPORT Input : public daal::algorithms::Input
110 {
111 public:
112  Input();
113  Input(const Input& other) : daal::algorithms::Input(other){}
114 
115  virtual ~Input() {}
116 
122  data_management::NumericTablePtr get(InputId id) const;
123 
129  void set(InputId id, const data_management::NumericTablePtr &ptr);
130 
138  virtual services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
139 };
140 
145 class DAAL_EXPORT Result : public daal::algorithms::Result
146 {
147 public:
148  DECLARE_SERIALIZABLE_CAST(Result);
149  Result();
150 
151  virtual ~Result() {};
152 
161  template <typename algorithmFPType>
162  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method);
163 
169  data_management::NumericTablePtr get(ResultId id) const;
170 
176  void set(ResultId id, const data_management::NumericTablePtr &ptr);
177 
186  virtual services::Status check(const algorithms::Input *input, const algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
187 
188 protected:
190  template<typename Archive, bool onDeserialize>
191  services::Status serialImpl(Archive *arch)
192  {
193  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
194  }
195 };
196 typedef services::SharedPtr<Result> ResultPtr;
198 } // namespace interface1
199 using interface1::Input;
200 using interface1::Result;
201 using interface1::ResultPtr;
202 
203 } // namespace cholesky
204 } // namespace algorithm
205 } // namespace daal
206 #endif
daal::services::interface1::Status
Class that holds the results of API calls. In case of API routine failure it contains the list of err...
Definition: error_handling.h:491
daal
Definition: algorithm_base_common.h:57
daal::algorithms::cholesky::data
Definition: cholesky_types.h:86
daal::algorithms::cholesky::Method
Method
Definition: cholesky_types.h:75
daal::algorithms::interface1::Result
Base class to represent final results of the computation. Algorithm-specific final results are repres...
Definition: algorithm_types.h:331
daal::algorithms::cholesky::defaultDense
Definition: cholesky_types.h:77
daal::algorithms::cholesky::choleskyFactor
Definition: cholesky_types.h:96
daal_defines.h
daal::algorithms::cholesky::interface1::Result
Results obtained with the compute() method of the Cholesky algorithm in the batch processing mode...
Definition: cholesky_types.h:145
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
daal::services::interface1::SharedPtr
Shared pointer that retains shared ownership of an object through a pointer. Several SharedPtr object...
Definition: daal_shared_ptr.h:187
daal::algorithms::cholesky::interface1::Input
Input parameters for the Cholesky algorithm
Definition: cholesky_types.h:109
daal::algorithms::cholesky::InputId
InputId
Definition: cholesky_types.h:84
daal::algorithms::cholesky::ResultId
ResultId
Definition: cholesky_types.h:94
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217

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