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

pivoted_qr_types.h
1 /* file: pivoted_qr_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 // Definition of Pivoted QR common types.
21 //--
22 */
23 
24 
25 #ifndef __PIVOTED_QR_TYPES_H__
26 #define __PIVOTED_QR_TYPES_H__
27 
28 #include "algorithms/algorithm.h"
29 #include "data_management/data/numeric_table.h"
30 #include "data_management/data/homogen_numeric_table.h"
31 #include "services/daal_defines.h"
32 
33 namespace daal
34 {
35 namespace algorithms
36 {
44 namespace pivoted_qr
45 {
50 enum Method
51 {
52  defaultDense = 0
53 };
54 
59 enum InputId
60 {
61  data ,
62  lastInputId = data
63 };
64 
69 enum ResultId
70 {
71  matrixQ,
72  matrixR,
73  permutationMatrix,
74  lastResultId = permutationMatrix
75 };
76 
80 namespace interface1
81 {
86 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
87 {
88  Parameter(const data_management::NumericTablePtr permutedColumns = data_management::NumericTablePtr());
89 
90  data_management::NumericTablePtr permutedColumns;
96 };
97 
102 class DAAL_EXPORT Input : public daal::algorithms::Input
103 {
104 public:
106  Input();
107 
109  Input(const Input& other);
110 
112  virtual ~Input() {}
113 
119  data_management::NumericTablePtr get(InputId id) const;
120 
126  void set(InputId id, const data_management::NumericTablePtr &value);
127 
128  virtual services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
129 };
130 
135 class DAAL_EXPORT Result : public daal::algorithms::Result
136 {
137 public:
138  DECLARE_SERIALIZABLE_CAST(Result);
140  Result();
142  virtual ~Result() {}
143 
150  template <typename algorithmFPType>
151  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
152 
158  data_management::NumericTablePtr get(ResultId id) const;
159 
165  void set(ResultId id, const data_management::NumericTablePtr &value);
166 
173  virtual services::Status check(const daal::algorithms::Input *in, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
174 
175 protected:
177  template<typename Archive, bool onDeserialize>
178  services::Status serialImpl(Archive *arch)
179  {
180  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
181  }
182 };
183 typedef services::SharedPtr<Result> ResultPtr;
184 
186 } // namespace interface1
187 using interface1::Parameter;
188 using interface1::Input;
189 using interface1::Result;
190 using interface1::ResultPtr;
191 
192 } // namespace daal::algorithms::pivoted_qr
193 } // namespace daal::algorithms
194 } // namespace daal
195 #endif
daal::algorithms::pivoted_qr::matrixR
Definition: pivoted_qr_types.h:72
daal::algorithms::pivoted_qr::interface1::Input
Input objects for the pivoted QR algorithm in the batch processing mode.
Definition: pivoted_qr_types.h:102
daal::algorithms::pivoted_qr::matrixQ
Definition: pivoted_qr_types.h:71
daal::algorithms::pivoted_qr::interface1::Input::~Input
virtual ~Input()
Definition: pivoted_qr_types.h:112
daal::algorithms::pivoted_qr::defaultDense
Definition: pivoted_qr_types.h:52
daal::algorithms::pivoted_qr::ResultId
ResultId
Definition: pivoted_qr_types.h:69
daal::algorithms::pivoted_qr::interface1::Result::~Result
virtual ~Result()
Definition: pivoted_qr_types.h:142
daal_defines.h
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:135
daal::algorithms::pivoted_qr::data
Definition: pivoted_qr_types.h:61
daal::algorithms::pivoted_qr::interface1::Parameter::permutedColumns
data_management::NumericTablePtr permutedColumns
Definition: pivoted_qr_types.h:90
daal::algorithms::pivoted_qr::interface1::Parameter
Parameter for the pivoted QR computation method.
Definition: pivoted_qr_types.h:86
daal::algorithms::pivoted_qr::Method
Method
Definition: pivoted_qr_types.h:50
daal::algorithms::math::abs::value
Definition: abs_types.h:88
daal::algorithms::pivoted_qr::InputId
InputId
Definition: pivoted_qr_types.h:59
daal::algorithms::pivoted_qr::permutationMatrix
Definition: pivoted_qr_types.h:73

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