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

quantiles_types.h
1 /* file: quantiles_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 common types of quantiles.
21 //--
22 */
23 
24 #ifndef __QUANTILES_TYPES_H__
25 #define __QUANTILES_TYPES_H__
26 
27 #include "data_management/data/homogen_numeric_table.h"
28 
29 namespace daal
30 {
31 namespace algorithms
32 {
42 namespace quantiles
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  quantiles,
70  lastResultId = quantiles
71 };
72 
76 namespace interface1
77 {
82 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
83 {
84  Parameter(const data_management::NumericTablePtr quantileOrders = data_management::NumericTablePtr());
85  data_management::NumericTablePtr quantileOrders;
86 };
87 
92 class DAAL_EXPORT Input : public daal::algorithms::Input
93 {
94 public:
95  Input();
96  Input(const Input& other);
97 
98  virtual ~Input() {}
99 
105  data_management::NumericTablePtr get(InputId id) const;
106 
112  void set(InputId id, const data_management::NumericTablePtr &ptr);
113 
119  virtual services::Status check(const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
120 };
121 
127 class DAAL_EXPORT Result : public daal::algorithms::Result
128 {
129 public:
130  DECLARE_SERIALIZABLE_CAST(Result);
131  Result();
132 
133  virtual ~Result() {};
134 
141  template <typename algorithmFPType>
142  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
143 
149  data_management::NumericTablePtr get(ResultId id) const;
150 
156  void set(ResultId id, const data_management::NumericTablePtr &value);
157 
164  virtual services::Status check(const daal::algorithms::Input *in, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
165 
166 protected:
168  template<typename Archive, bool onDeserialize>
169  services::Status serialImpl(Archive *arch)
170  {
171  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
172  }
173 };
174 typedef services::SharedPtr<Result> ResultPtr;
175 
177 } // namespace interface1
178 using interface1::Parameter;
179 using interface1::Input;
180 using interface1::Result;
181 using interface1::ResultPtr;
182 
183 } // namespace daal::algorithms::quantiles
184 } // namespace daal::algorithms
185 } // namespace daal
186 #endif
daal::algorithms::quantiles::ResultId
ResultId
Definition: quantiles_types.h:67
daal::algorithms::quantiles::InputId
InputId
Definition: quantiles_types.h:57
daal::algorithms::quantiles::interface1::Input
Input objects for the quantiles algorithm
Definition: quantiles_types.h:92
daal::algorithms::quantiles::defaultDense
Definition: quantiles_types.h:50
daal::algorithms::quantiles::data
Definition: quantiles_types.h:59
daal::algorithms::quantiles::interface1::Parameter
Parameters of the quantiles algorithm.
Definition: quantiles_types.h:82
daal::algorithms::quantiles::quantiles
Definition: quantiles_types.h:69
daal::algorithms::quantiles::interface1::Result
Provides methods to access final results obtained with the compute() method of the quantiles algorith...
Definition: quantiles_types.h:127
daal::algorithms::quantiles::Method
Method
Definition: quantiles_types.h:48
daal::algorithms::quantiles::interface1::Parameter::quantileOrders
data_management::NumericTablePtr quantileOrders
Definition: quantiles_types.h:85
daal::algorithms::math::abs::value
Definition: abs_types.h:88

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