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

sorting_batch.h
1 /* file: sorting_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2017 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 // Implementation of the interface for the observation sorting algorithm
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __SORTING_BATCH_H__
50 #define __SORTING_BATCH_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "data_management/data/numeric_table.h"
54 #include "services/daal_defines.h"
55 #include "algorithms/sorting/sorting_types.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
61 namespace sorting
62 {
63 
64 namespace interface1
65 {
80 template<typename algorithmFPType, Method method, CpuType cpu>
81 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
82 {
83 public:
89  BatchContainer(daal::services::Environment::env *daalEnv);
91  virtual ~BatchContainer();
95  virtual services::Status compute() DAAL_C11_OVERRIDE;
96 };
97 
111 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
112 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
113 {
114 public:
115  Input input;
118  Batch()
119  {
120  initialize();
121  }
122 
129  Batch(const Batch<algorithmFPType, method> &other) : input(other.input)
130  {
131  initialize();
132  }
133 
134  virtual ~Batch() {}
135 
140  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
141 
146  ResultPtr getResult()
147  {
148  return _result;
149  }
150 
155  services::Status setResult(const ResultPtr &result)
156  {
157  DAAL_CHECK(result, services::ErrorNullResult)
158  _result = result;
159  _res = _result.get();
160  return services::Status();
161  }
162 
168  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
169  {
170  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
171  }
172 
173 protected:
174  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
175  {
176  return new Batch<algorithmFPType, method>(*this);
177  }
178 
179  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
180  {
181  services::Status s = _result->allocate<algorithmFPType>(&input, method);
182  _res = _result.get();
183  return s;
184  }
185 
186  void initialize()
187  {
188  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
189  _in = &input;
190  _result.reset(new Result());
191  }
192 
193  ResultPtr _result;
194 
195 };
197 } // namespace interface1
198 using interface1::BatchContainer;
199 using interface1::Batch;
200 
201 } // namespace daal::algorithms::sorting
202 } // namespace daal::algorithms
203 } // namespace daal
204 #endif
daal::algorithms::sorting::interface1::Batch::getResult
ResultPtr getResult()
Definition: sorting_batch.h:146
daal::algorithms::sorting::interface1::Batch::Batch
Batch()
Definition: sorting_batch.h:118
daal::algorithms::sorting::interface1::BatchContainer
Provides methods to run implementations of the sorting algorithm. It is associated with the daal::alg...
Definition: sorting_batch.h:81
daal
Definition: algorithm_base_common.h:57
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:79
daal::algorithms::sorting::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: sorting_batch.h:140
daal::algorithms::sorting::interface1::Input
Input objects for the sorting algorithm
Definition: sorting_types.h:106
daal_defines.h
daal::algorithms::sorting::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: sorting_batch.h:129
daal::batch
Definition: daal_defines.h:131
daal::algorithms::sorting::interface1::Batch::input
Input input
Definition: sorting_batch.h:115
daal::algorithms::sorting::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: sorting_batch.h:168
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::sorting::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: sorting_batch.h:155
daal::algorithms::sorting::interface1::Batch
Sorts the datasets by components of the random vector in the batch processing mode.
Definition: sorting_batch.h:112
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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