C++ API Reference for Intel® Data Analytics Acceleration Library 2019 Update 4

kmeans_batch.h
1 /* file: kmeans_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2019 Intel Corporation.
4 *
5 * This software and the related documents are Intel copyrighted materials, and
6 * your use of them is governed by the express license under which they were
7 * provided to you (License). Unless the License provides otherwise, you may not
8 * use, modify, copy, publish, distribute, disclose or transmit this software or
9 * the related documents without Intel's prior written permission.
10 *
11 * This software and the related documents are provided as is, with no express
12 * or implied warranties, other than those that are expressly stated in the
13 * License.
14 *******************************************************************************/
15 
16 /*
17 //++
18 // Implementation of the interface for the K-Means algorithm in the batch
19 // processing mode
20 //--
21 */
22 
23 #ifndef __KMEANS_BATCH_H__
24 #define __KMEANS_BATCH_H__
25 
26 #include "algorithms/algorithm.h"
27 #include "data_management/data/numeric_table.h"
28 #include "services/daal_defines.h"
29 #include "algorithms/kmeans/kmeans_types.h"
30 
31 namespace daal
32 {
33 namespace algorithms
34 {
35 namespace kmeans
36 {
37 
38 namespace interface1
39 {
54 template<typename algorithmFPType, Method method, CpuType cpu>
55 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
56 {
57 public:
63  BatchContainer(daal::services::Environment::env *daalEnv);
65  virtual ~BatchContainer();
69  virtual services::Status compute() DAAL_C11_OVERRIDE;
70 };
71 
85 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = lloydDense>
86 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
87 {
88 public:
89  typedef algorithms::kmeans::Input InputType;
90  typedef algorithms::kmeans::Parameter ParameterType;
91  typedef algorithms::kmeans::Result ResultType;
92 
98  Batch(size_t nClusters, size_t nIterations = 1) : parameter(nClusters, nIterations)
99  {
100  initialize();
101  }
102 
109  Batch(const Batch<algorithmFPType, method> &other) : parameter(other.parameter)
110  {
111  initialize();
112  input.set(data, other.input.get(data));
113  input.set(inputCentroids, other.input.get(inputCentroids));
114  }
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  _result = result;
139  _res = _result.get();
140  return services::Status();
141  }
142 
148  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
149  {
150  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
151  }
152 
153 protected:
154  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
155  {
156  return new Batch<algorithmFPType, method>(*this);
157  }
158 
159  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
160  {
161  _result.reset(new ResultType());
162  services::Status s = _result->allocate<algorithmFPType>(_in, _par, (int) 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  }
173 
174 public:
175  InputType input;
176  ParameterType parameter;
178 private:
179  ResultPtr _result;
180 };
182 } // namespace interface1
183 using interface1::BatchContainer;
184 using interface1::Batch;
185 
186 } // namespace daal::algorithms::kmeans
187 } // namespace daal::algorithms
188 } // namespace daal
189 #endif
daal::algorithms::kmeans::interface1::Batch::Batch
Batch(size_t nClusters, size_t nIterations=1)
Definition: kmeans_batch.h:98
daal
Definition: algorithm_base_common.h:31
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:53
daal::algorithms::kmeans::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: kmeans_batch.h:148
daal::algorithms::kmeans::nIterations
Definition: kmeans_types.h:111
daal::algorithms::kmeans::inputCentroids
Definition: kmeans_types.h:71
daal::algorithms::kmeans::interface1::BatchContainer
Provides methods to run implementations of the K-Means algorithm. This class is associated with the d...
Definition: kmeans_batch.h:55
daal_defines.h
daal::algorithms::kmeans::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: kmeans_batch.h:120
daal::batch
Definition: daal_defines.h:110
daal::algorithms::kmeans::data
Definition: kmeans_types.h:70
daal::algorithms::kmeans::interface1::Batch::input
InputType input
Definition: kmeans_batch.h:175
daal::algorithms::kmeans::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: kmeans_batch.h:135
daal::algorithms::kmeans::interface1::Batch::getResult
ResultPtr getResult()
Definition: kmeans_batch.h:126
daal::algorithms::kmeans::interface1::Batch
Computes the results of the K-Means algorithm in the batch processing mode.
Definition: kmeans_batch.h:86
daal::algorithms::kmeans::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: kmeans_batch.h:109
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:68
daal::algorithms::kmeans::interface1::Batch::parameter
ParameterType parameter
Definition: kmeans_batch.h:176
daal::services::ErrorNullResult
Definition: error_indexes.h:96

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