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

quantiles_batch.h
1 /* file: quantiles_batch.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 // Implementation of the interface for the quantiles algorithm in the batch processing mode
21 //--
22 */
23 
24 #ifndef __QUANTILES_BATCH_H__
25 #define __QUANTILES_BATCH_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "data_management/data/numeric_table.h"
29 #include "services/daal_defines.h"
30 #include "algorithms/quantiles/quantiles_types.h"
31 
32 namespace daal
33 {
34 namespace algorithms
35 {
36 namespace quantiles
37 {
38 
39 namespace interface1
40 {
55 template<typename algorithmFPType, Method method, CpuType cpu>
56 class BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
57 {
58 public:
64  BatchContainer(daal::services::Environment::env *daalEnv);
66  virtual ~BatchContainer();
70  virtual services::Status compute() DAAL_C11_OVERRIDE;
71 };
72 
86 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
87 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
88 {
89 public:
90  typedef algorithms::quantiles::Input InputType;
91  typedef algorithms::quantiles::Parameter ParameterType;
92  typedef algorithms::quantiles::Result ResultType;
93 
94  InputType input;
95  ParameterType parameter;
98  Batch()
99  {
100  initialize();
101  }
102 
109  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
110  {
111  initialize();
112  }
113 
114  virtual ~Batch() {}
115 
120  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
121 
126  ResultPtr getResult()
127  {
128  return _result;
129  }
130 
135  services::Status setResult(const ResultPtr &result)
136  {
137  DAAL_CHECK(result, services::ErrorNullResult)
138  if(!result) return services::Status(services::ErrorNullResult);
139  _result = result;
140  _res = _result.get();
141  return services::Status();
142  }
143 
149  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
150  {
151  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
152  }
153 
154 protected:
155  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
156  {
157  return new Batch<algorithmFPType, method>(*this);
158  }
159 
160  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
161  {
162  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, method);
163  _res = _result.get();
164  return s;
165  }
166 
167  void initialize()
168  {
169  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
170  _in = &input;
171  _par = &parameter;
172  _result.reset(new ResultType());
173  }
174 
175  ResultPtr _result;
176 };
178 } // namespace interface1
179 using interface1::BatchContainer;
180 using interface1::Batch;
181 
182 } // namespace daal::algorithms::quantiles
183 } // namespace daal::algorithms
184 } // namespace daal
185 #endif
daal::algorithms::quantiles::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: quantiles_batch.h:135
daal::algorithms::quantiles::interface1::Batch::getResult
ResultPtr getResult()
Definition: quantiles_batch.h:126
daal::batch
Definition: daal_defines.h:112
daal::algorithms::quantiles::interface1::Batch
Computes values of quantiles in the batch processing mode.
Definition: quantiles_batch.h:87
daal::algorithms::quantiles::interface1::Batch::parameter
ParameterType parameter
Definition: quantiles_batch.h:95
daal::algorithms::quantiles::interface1::Batch::input
InputType input
Definition: quantiles_batch.h:94
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:55
daal::algorithms::quantiles::interface1::Batch::Batch
Batch()
Definition: quantiles_batch.h:98
daal::algorithms::quantiles::interface1::BatchContainer::~BatchContainer
virtual ~BatchContainer()
daal_defines.h
daal::algorithms::quantiles::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: quantiles_batch.h:149
daal::algorithms::quantiles::interface1::BatchContainer::BatchContainer
BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::quantiles::quantiles
Definition: quantiles_types.h:69
daal::algorithms::quantiles::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: quantiles_batch.h:109
daal::algorithms::quantiles::interface1::BatchContainer::compute
virtual services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::quantiles::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: quantiles_batch.h:120
daal::algorithms::quantiles::interface1::BatchContainer
Provides methods to run implementations of the quantiles algorithm. It is associated with the daal::a...
Definition: quantiles_batch.h:56

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