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

sorting_types.h
1 /* file: sorting_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 sorting.
45 //--
46 */
47 
48 #ifndef __SORTING_TYPES_H__
49 #define __SORTING_TYPES_H__
50 
51 #include "data_management/data/homogen_numeric_table.h"
52 
53 namespace daal
54 {
55 namespace algorithms
56 {
66 namespace sorting
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  sortedData,
94  lastResultId = sortedData
95 };
96 
100 namespace interface1
101 {
106 class DAAL_EXPORT Input : public daal::algorithms::Input
107 {
108 public:
109  Input();
110  Input(const Input& other);
111 
112  virtual ~Input() {}
113 
119  data_management::NumericTablePtr get(InputId id) const;
120 
126  void set(InputId id, const data_management::NumericTablePtr &ptr);
127 
133  virtual services::Status check(const Parameter *par, int method) const DAAL_C11_OVERRIDE;
134 };
135 
141 class DAAL_EXPORT Result : public daal::algorithms::Result
142 {
143 public:
144  DECLARE_SERIALIZABLE_CAST(Result);
145  Result();
146 
147  virtual ~Result() {};
148 
154  template <typename algorithmFPType>
155  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const int method);
156 
162  data_management::NumericTablePtr get(ResultId id) const;
163 
169  void set(ResultId id, const data_management::NumericTablePtr &value);
170 
177  virtual services::Status check(const daal::algorithms::Input *in, const Parameter *par, int method) const DAAL_C11_OVERRIDE;
178 
179 protected:
181  template<typename Archive, bool onDeserialize>
182  services::Status serialImpl(Archive *arch)
183  {
184  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
185  }
186 };
187 typedef services::SharedPtr<Result> ResultPtr;
188 
190 } // namespace interface1
191 using interface1::Input;
192 using interface1::Result;
193 using interface1::ResultPtr;
194 
195 } // namespace daal::algorithms::sorting
196 } // namespace daal::algorithms
197 } // namespace daal
198 #endif
daal::algorithms::sorting::Method
Method
Definition: sorting_types.h:72
daal::algorithms::sorting::data
Definition: sorting_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::sorting::interface1::Input
Input objects for the sorting algorithm
Definition: sorting_types.h:106
daal::algorithms::sorting::sortedData
Definition: sorting_types.h:93
daal::algorithms::sorting::defaultDense
Definition: sorting_types.h:74
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::sorting::ResultId
ResultId
Definition: sorting_types.h:91
daal::algorithms::sorting::interface1::Result
Provides methods to access final results obtained with the compute() method of the sorting algorithm ...
Definition: sorting_types.h:141
daal::algorithms::sorting::InputId
InputId
Definition: sorting_types.h:81
daal::algorithms::math::abs::value
Definition: abs_types.h:112
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217

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