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

kmeans_batch.h
1 /* file: kmeans_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 K-Means algorithm in the batch
45 // processing mode
46 //--
47 */
48 
49 #ifndef __KMEANS_BATCH_H__
50 #define __KMEANS_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/kmeans/kmeans_types.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
61 namespace kmeans
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 = lloydDense>
112 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
113 {
114 public:
120  Batch(size_t nClusters, size_t nIterations = 1) : parameter(nClusters, nIterations)
121  {
122  initialize();
123  }
124 
131  Batch(const Batch<algorithmFPType, method> &other) : parameter(other.parameter)
132  {
133  initialize();
134  input.set(data, other.input.get(data));
135  input.set(inputCentroids, other.input.get(inputCentroids));
136  }
137 
142  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
143 
148  ResultPtr getResult()
149  {
150  return _result;
151  }
152 
157  services::Status setResult(const ResultPtr& result)
158  {
159  DAAL_CHECK(result, services::ErrorNullResult)
160  _result = result;
161  _res = _result.get();
162  return services::Status();
163  }
164 
170  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
171  {
172  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
173  }
174 
175 protected:
176  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
177  {
178  return new Batch<algorithmFPType, method>(*this);
179  }
180 
181  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
182  {
183  _result.reset(new Result());
184  services::Status s = _result->allocate<algorithmFPType>(_in, _par, (int) method);
185  _res = _result.get();
186  return s;
187  }
188 
189  void initialize()
190  {
191  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
192  _in = &input;
193  _par = &parameter;
194  }
195 
196 public:
197  Input input;
198  Parameter parameter;
200 private:
201  ResultPtr _result;
202 };
204 } // namespace interface1
205 using interface1::BatchContainer;
206 using interface1::Batch;
207 
208 } // namespace daal::algorithms::kmeans
209 } // namespace daal::algorithms
210 } // namespace daal
211 #endif
daal::algorithms::kmeans::interface1::Batch::Batch
Batch(size_t nClusters, size_t nIterations=1)
Definition: kmeans_batch.h:120
daal::algorithms::kmeans::interface1::Parameter
Parameters for the K-Means algorithm.
Definition: kmeans_types.h:153
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::kmeans::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: kmeans_batch.h:170
daal::algorithms::kmeans::nIterations
Definition: kmeans_types.h:135
daal::algorithms::kmeans::inputCentroids
Definition: kmeans_types.h:97
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:81
daal::algorithms::kmeans::interface1::Input
Input objects for the K-Means algorithm
Definition: kmeans_types.h:195
daal_defines.h
daal::algorithms::kmeans::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: kmeans_batch.h:142
daal::batch
Definition: daal_defines.h:131
daal::algorithms::kmeans::data
Definition: kmeans_types.h:96
daal::algorithms::kmeans::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: kmeans_batch.h:157
daal::algorithms::kmeans::interface1::Batch::getResult
ResultPtr getResult()
Definition: kmeans_batch.h:148
daal::algorithms::kmeans::interface1::Batch::input
Input input
Definition: kmeans_batch.h:197
daal::algorithms::kmeans::interface1::Batch
Computes the results of the K-Means algorithm in the batch processing mode.
Definition: kmeans_batch.h:112
daal::algorithms::kmeans::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: kmeans_batch.h:131
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::kmeans::interface1::Batch::parameter
Parameter parameter
Definition: kmeans_batch.h:198

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