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

pivoted_qr_types.h
1 /* file: pivoted_qr_types.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 // Definition of Pivoted QR common types.
19 //--
20 */
21 
22 
23 #ifndef __PIVOTED_QR_TYPES_H__
24 #define __PIVOTED_QR_TYPES_H__
25 
26 #include "algorithms/algorithm.h"
27 #include "data_management/data/numeric_table.h"
28 #include "data_management/data/homogen_numeric_table.h"
29 #include "services/daal_defines.h"
30 
31 namespace daal
32 {
33 namespace algorithms
34 {
42 namespace pivoted_qr
43 {
48 enum Method
49 {
50  defaultDense = 0
51 };
52 
57 enum InputId
58 {
59  data ,
60  lastInputId = data
61 };
62 
67 enum ResultId
68 {
69  matrixQ,
70  matrixR,
71  permutationMatrix,
72  lastResultId = permutationMatrix
73 };
74 
78 namespace interface1
79 {
84 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
85 {
86  Parameter(const data_management::NumericTablePtr permutedColumns = data_management::NumericTablePtr());
87 
88  data_management::NumericTablePtr permutedColumns;
94 };
95 
100 class DAAL_EXPORT Input : public daal::algorithms::Input
101 {
102 public:
104  Input();
105 
107  Input(const Input& other);
108 
110  virtual ~Input() {}
111 
117  data_management::NumericTablePtr get(InputId id) const;
118 
124  void set(InputId id, const data_management::NumericTablePtr &value);
125 
126  virtual services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
127 };
128 
133 class DAAL_EXPORT Result : public daal::algorithms::Result
134 {
135 public:
136  DECLARE_SERIALIZABLE_CAST(Result);
138  Result();
140  virtual ~Result() {}
141 
148  template <typename algorithmFPType>
149  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
150 
156  data_management::NumericTablePtr get(ResultId id) const;
157 
163  void set(ResultId id, const data_management::NumericTablePtr &value);
164 
171  virtual services::Status check(const daal::algorithms::Input *in, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
172 
173 protected:
175  template<typename Archive, bool onDeserialize>
176  services::Status serialImpl(Archive *arch)
177  {
178  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
179  }
180 };
181 typedef services::SharedPtr<Result> ResultPtr;
182 
184 } // namespace interface1
185 using interface1::Parameter;
186 using interface1::Input;
187 using interface1::Result;
188 using interface1::ResultPtr;
189 
190 } // namespace daal::algorithms::pivoted_qr
191 } // namespace daal::algorithms
192 } // namespace daal
193 #endif
daal::algorithms::pivoted_qr::interface1::Result
Provides methods to access final results obtained with the compute() method of the pivoted QR algorit...
Definition: pivoted_qr_types.h:133
daal
Definition: algorithm_base_common.h:31
daal::algorithms::pivoted_qr::data
Definition: pivoted_qr_types.h:59
daal::algorithms::pivoted_qr::interface1::Parameter
Parameter for the pivoted QR computation method.
Definition: pivoted_qr_types.h:84
daal::algorithms::pivoted_qr::interface1::Input::~Input
virtual ~Input()
Definition: pivoted_qr_types.h:110
daal::algorithms::pivoted_qr::Method
Method
Definition: pivoted_qr_types.h:48
daal_defines.h
daal::algorithms::pivoted_qr::permutationMatrix
Definition: pivoted_qr_types.h:71
daal::algorithms::pivoted_qr::ResultId
ResultId
Definition: pivoted_qr_types.h:67
daal::algorithms::pivoted_qr::interface1::Input
Input objects for the pivoted QR algorithm in the batch processing mode.
Definition: pivoted_qr_types.h:100
daal::algorithms::math::abs::value
Definition: abs_types.h:86
daal::algorithms::pivoted_qr::interface1::Result::~Result
virtual ~Result()
Definition: pivoted_qr_types.h:140
daal::algorithms::pivoted_qr::InputId
InputId
Definition: pivoted_qr_types.h:57
daal::algorithms::pivoted_qr::interface1::Parameter::permutedColumns
data_management::NumericTablePtr permutedColumns
Definition: pivoted_qr_types.h:88
daal::algorithms::pivoted_qr::matrixQ
Definition: pivoted_qr_types.h:69
daal::algorithms::pivoted_qr::defaultDense
Definition: pivoted_qr_types.h:50
daal::algorithms::pivoted_qr::matrixR
Definition: pivoted_qr_types.h:70

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