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

List of all members
Distributed< step2Master, algorithmFPType, method > Class Template Reference

Computes the results of the K-Means algorithm in the second step of the distributed processing mode. More...

Class Declaration

template<typename algorithmFPType, Method method>
class daal::algorithms::kmeans::interface1::Distributed< step2Master, algorithmFPType, method >

Template Parameters
algorithmFPTypeData type to use in intermediate computations of K-Means, double or float
methodComputation method of the algorithm, Method
Enumerations
  • Method Computation methods for the K-Means algorithm
  • InputId Identifiers of input objects for the K-Means algorithm
  • ResultId Identifiers of results of the K-Means algorithm
References

Constructor & Destructor Documentation

◆ Distributed() [1/2]

Distributed ( size_t  nClusters,
size_t  nIterations = 1 
)
inline

Main constructor

Parameters
[in]nClustersNumber of clusters
[in]nIterationsNumber of iterations

◆ Distributed() [2/2]

Distributed ( const Distributed< step2Master, algorithmFPType, method > &  other)
inline

Constructs a K-Means algorithm by copying input objects and parameters of another K-Means algorithm

Parameters
[in]otherAn algorithm to be used as the source to initialize the input objects and parameters of the algorithm

Member Function Documentation

◆ checkFinalizeComputeParams()

services::Status checkFinalizeComputeParams ( )
inlinevirtual

Validates the parameters of the finalizeCompute() method

Reimplemented from AlgorithmImpl< mode >.

◆ clone()

services::SharedPtr<Distributed<step2Master, algorithmFPType, method> > clone ( ) const
inline

Returns a pointer to the newly allocated K-Means algorithm with a copy of input objects and parameters of this K-Means algorithm

Returns
Pointer to the newly allocated algorithm

◆ getMethod()

virtual int getMethod ( ) const
inlinevirtual

Returns the method of the algorithm

Returns
Method of the algorithm

Implements AlgorithmIface.

◆ getPartialResult()

PartialResultPtr getPartialResult ( )
inline

Returns the structure that contains computed partial results

Returns
Structure that contains computed partial results

◆ getResult()

ResultPtr getResult ( )
inline

Returns the structure that contains the results of the K-Means algorithm

Returns
Structure that contains the results of the K-Means algorithm

◆ setPartialResult()

services::Status setPartialResult ( const PartialResultPtr partialRes)
inline

Sets the structure that contains computed partial results

◆ setResult()

services::Status setResult ( const ResultPtr result)
inline

Registers user-allocated memory to store the results of the K-Means algorithm

Parameters
[in]resultStructure to store the results of the K-Means algorithm

Member Data Documentation

◆ input

InputType input

Input data structure

◆ parameter

ParameterType parameter

K-Means parameters structure


The documentation for this class was generated from the following file:

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