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

pivoted_qr_types.h
1 /* file: pivoted_qr_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 // Definition of Pivoted QR common types.
45 //--
46 */
47 
48 
49 #ifndef __PIVOTED_QR_TYPES_H__
50 #define __PIVOTED_QR_TYPES_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "data_management/data/numeric_table.h"
54 #include "data_management/data/homogen_numeric_table.h"
55 #include "services/daal_defines.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
68 namespace pivoted_qr
69 {
74 enum Method
75 {
76  defaultDense = 0
77 };
78 
83 enum InputId
84 {
85  data ,
86  lastInputId = data
87 };
88 
93 enum ResultId
94 {
95  matrixQ,
96  matrixR,
97  permutationMatrix,
98  lastResultId = permutationMatrix
99 };
100 
104 namespace interface1
105 {
110 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
111 {
112  Parameter(const data_management::NumericTablePtr permutedColumns = data_management::NumericTablePtr());
113 
114  data_management::NumericTablePtr permutedColumns;
120 };
121 
126 class DAAL_EXPORT Input : public daal::algorithms::Input
127 {
128 public:
130  Input();
131 
133  Input(const Input& other);
134 
136  virtual ~Input() {}
137 
143  data_management::NumericTablePtr get(InputId id) const;
144 
150  void set(InputId id, const data_management::NumericTablePtr &value);
151 
152  virtual services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
153 };
154 
159 class DAAL_EXPORT Result : public daal::algorithms::Result
160 {
161 public:
162  DECLARE_SERIALIZABLE_CAST(Result);
164  Result();
166  virtual ~Result() {}
167 
174  template <typename algorithmFPType>
175  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
176 
182  data_management::NumericTablePtr get(ResultId id) const;
183 
189  void set(ResultId id, const data_management::NumericTablePtr &value);
190 
197  virtual services::Status check(const daal::algorithms::Input *in, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
198 
199 protected:
201  template<typename Archive, bool onDeserialize>
202  services::Status serialImpl(Archive *arch)
203  {
204  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
205  }
206 };
207 typedef services::SharedPtr<Result> ResultPtr;
208 
210 } // namespace interface1
211 using interface1::Parameter;
212 using interface1::Input;
213 using interface1::Result;
214 using interface1::ResultPtr;
215 
216 } // namespace daal::algorithms::pivoted_qr
217 } // namespace daal::algorithms
218 } // namespace daal
219 #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:159
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::interface1::Result
Base class to represent final results of the computation. Algorithm-specific final results are repres...
Definition: algorithm_types.h:331
daal::algorithms::pivoted_qr::data
Definition: pivoted_qr_types.h:85
daal::algorithms::pivoted_qr::interface1::Parameter
Parameter for the pivoted QR computation method.
Definition: pivoted_qr_types.h:110
daal::algorithms::pivoted_qr::interface1::Input::~Input
virtual ~Input()
Definition: pivoted_qr_types.h:136
daal::algorithms::pivoted_qr::Method
Method
Definition: pivoted_qr_types.h:74
daal_defines.h
daal::algorithms::pivoted_qr::permutationMatrix
Definition: pivoted_qr_types.h:97
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
daal::algorithms::pivoted_qr::ResultId
ResultId
Definition: pivoted_qr_types.h:93
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::pivoted_qr::interface1::Input
Input objects for the pivoted QR algorithm in the batch processing mode.
Definition: pivoted_qr_types.h:126
daal::algorithms::math::abs::value
Definition: abs_types.h:112
daal::algorithms::pivoted_qr::interface1::Result::~Result
virtual ~Result()
Definition: pivoted_qr_types.h:166
daal::algorithms::pivoted_qr::InputId
InputId
Definition: pivoted_qr_types.h:83
daal::algorithms::pivoted_qr::interface1::Parameter::permutedColumns
data_management::NumericTablePtr permutedColumns
Definition: pivoted_qr_types.h:114
daal::algorithms::pivoted_qr::matrixQ
Definition: pivoted_qr_types.h:95
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217
daal::algorithms::pivoted_qr::defaultDense
Definition: pivoted_qr_types.h:76
daal::algorithms::pivoted_qr::matrixR
Definition: pivoted_qr_types.h:96

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