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

dbscan_batch.h
1 /* file: dbscan_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 DBSCAN algorithm in the batch
19 // processing mode
20 //--
21 */
22 
23 #ifndef __DBSCAN_BATCH_H__
24 #define __DBSCAN_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/dbscan/dbscan_types.h"
30 
31 namespace daal
32 {
33 namespace algorithms
34 {
35 namespace dbscan
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 = defaultDense>
86 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
87 {
88 public:
89  typedef algorithms::dbscan::Input InputType;
90  typedef algorithms::dbscan::Parameter ParameterType;
91  typedef algorithms::dbscan::Result ResultType;
92 
98  Batch(algorithmFPType epsilon, size_t minObservations);
99 
106  Batch(const Batch<algorithmFPType, method> &other);
107 
108  ~Batch()
109  {
110  delete _par;
111  }
112 
117  ParameterType& parameter() { return *static_cast<ParameterType*>(_par); }
118 
123  const ParameterType& parameter() const { return *static_cast<const ParameterType*>(_par); }
124 
129  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
130 
135  ResultPtr getResult()
136  {
137  return _result;
138  }
139 
144  services::Status setResult(const ResultPtr& result)
145  {
146  DAAL_CHECK(result, services::ErrorNullResult)
147  _result = result;
148  _res = _result.get();
149  return services::Status();
150  }
151 
157  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
158  {
159  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
160  }
161 
162 protected:
163  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
164  {
165  return new Batch<algorithmFPType, method>(*this);
166  }
167 
168  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
169  {
170  _result.reset(new ResultType());
171  services::Status s = _result->allocate<algorithmFPType>(_in, _par, (int) method);
172  _res = _result.get();
173  return s;
174  }
175 
176  void initialize()
177  {
178  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
179  _in = &input;
180  _result.reset(new ResultType());
181  }
182 
183 public:
184  InputType input;
186 private:
187  ResultPtr _result;
188 };
190 } // namespace interface1
191 using interface1::BatchContainer;
192 using interface1::Batch;
193 
194 } // namespace daal::algorithms::dbscan
195 } // namespace daal::algorithms
196 } // namespace daal
197 #endif
daal::algorithms::dbscan::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: dbscan_batch.h:144
daal::algorithms::dbscan::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: dbscan_batch.h:157
daal::algorithms::dbscan::interface1::Batch::parameter
const ParameterType & parameter() const
Definition: dbscan_batch.h:123
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::dbscan::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: dbscan_batch.h:129
daal::algorithms::dbscan::interface1::Batch::getResult
ResultPtr getResult()
Definition: dbscan_batch.h:135
daal_defines.h
daal::batch
Definition: daal_defines.h:110
daal::algorithms::dbscan::interface1::Batch::input
InputType input
Definition: dbscan_batch.h:184
daal::algorithms::dbscan::interface1::Batch
Computes the results of the DBSCAN algorithm in the batch processing mode.
Definition: dbscan_batch.h:86
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:68
daal::algorithms::dbscan::interface1::BatchContainer
Provides methods to run implementations of the DBSCAN algorithm. This class is associated with the da...
Definition: dbscan_batch.h:55
daal::services::ErrorNullResult
Definition: error_indexes.h:96
daal::algorithms::dbscan::interface1::Batch::parameter
ParameterType & parameter()
Definition: dbscan_batch.h:117

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