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

quantiles_types.h
1 /* file: quantiles_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 common types of quantiles.
45 //--
46 */
47 
48 #ifndef __QUANTILES_TYPES_H__
49 #define __QUANTILES_TYPES_H__
50 
51 #include "data_management/data/homogen_numeric_table.h"
52 
53 namespace daal
54 {
55 namespace algorithms
56 {
66 namespace quantiles
67 {
72 enum Method
73 {
74  defaultDense = 0
75 };
76 
81 enum InputId
82 {
83  data,
84  lastInputId = data
85 };
86 
91 enum ResultId
92 {
93  quantiles,
94  lastResultId = quantiles
95 };
96 
100 namespace interface1
101 {
106 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
107 {
108  Parameter(const data_management::NumericTablePtr quantileOrders = data_management::NumericTablePtr());
109  data_management::NumericTablePtr quantileOrders;
110 };
111 
116 class DAAL_EXPORT Input : public daal::algorithms::Input
117 {
118 public:
119  Input();
120  Input(const Input& other);
121 
122  virtual ~Input() {}
123 
129  data_management::NumericTablePtr get(InputId id) const;
130 
136  void set(InputId id, const data_management::NumericTablePtr &ptr);
137 
143  virtual services::Status check(const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
144 };
145 
151 class DAAL_EXPORT Result : public daal::algorithms::Result
152 {
153 public:
154  DECLARE_SERIALIZABLE_CAST(Result);
155  Result();
156 
157  virtual ~Result() {};
158 
165  template <typename algorithmFPType>
166  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
167 
173  data_management::NumericTablePtr get(ResultId id) const;
174 
180  void set(ResultId id, const data_management::NumericTablePtr &value);
181 
188  virtual services::Status check(const daal::algorithms::Input *in, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
189 
190 protected:
192  template<typename Archive, bool onDeserialize>
193  services::Status serialImpl(Archive *arch)
194  {
195  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
196  }
197 };
198 typedef services::SharedPtr<Result> ResultPtr;
199 
201 } // namespace interface1
202 using interface1::Parameter;
203 using interface1::Input;
204 using interface1::Result;
205 using interface1::ResultPtr;
206 
207 } // namespace daal::algorithms::quantiles
208 } // namespace daal::algorithms
209 } // namespace daal
210 #endif
daal::algorithms::quantiles::data
Definition: quantiles_types.h:83
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::quantiles::InputId
InputId
Definition: quantiles_types.h:81
daal::algorithms::quantiles::interface1::Input
Input objects for the quantiles algorithm
Definition: quantiles_types.h:116
daal::algorithms::quantiles::interface1::Result
Provides methods to access final results obtained with the compute() method of the quantiles algorith...
Definition: quantiles_types.h:151
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::quantiles::interface1::Parameter::quantileOrders
data_management::NumericTablePtr quantileOrders
Definition: quantiles_types.h:109
daal::algorithms::quantiles::defaultDense
Definition: quantiles_types.h:74
daal::algorithms::math::abs::value
Definition: abs_types.h:112
daal::algorithms::quantiles::ResultId
ResultId
Definition: quantiles_types.h:91
daal::algorithms::quantiles::Method
Method
Definition: quantiles_types.h:72
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217
daal::algorithms::quantiles::interface1::Parameter
Parameters of the quantiles algorithm.
Definition: quantiles_types.h:106
daal::algorithms::quantiles::quantiles
Definition: quantiles_types.h:93

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