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

Classes | Functions | Variables
Distributed

Classes

class  DistributedContainer< step, algorithmFPType, method, cpu >
 Provides methods to run implementations of initialization of K-Means algorithm. This class is associated with the daal::algorithms::kmeans::init::Distributed class and supports the method of computing initial clusters for K-Means algorithm in the distributed processing mode. More...
 
class  DistributedContainer< step1Local, algorithmFPType, method, cpu >
 Class containing methods for computing initial clusters for K-Means algorithm in the first step of the distributed processing mode. More...
 
class  DistributedContainer< step2Master, algorithmFPType, method, cpu >
 Class containing methods for computing initial clusters for K-Means algorithm in the 2nd step of the distributed processing mode. More...
 
class  DistributedContainer< step2Local, algorithmFPType, method, cpu >
 Class containing methods for computing initial clusters for K-Means algorithm in the 2nd step of the distributed processing mode performed on a local node. More...
 
class  DistributedContainer< step3Master, algorithmFPType, method, cpu >
 Class containing methods for computing initial clusters for K-Means algorithm in the 3rd step of the distributed processing mode performed on the master mode. More...
 
class  DistributedContainer< step4Local, algorithmFPType, method, cpu >
 Class containing methods for computing initial clusters for K-Means algorithm in the 4th step of the distributed processing mode performed on a local node. More...
 
class  DistributedContainer< step5Master, algorithmFPType, method, cpu >
 Class containing methods for computing initial clusters for K-Means algorithm in the 5th step of the distributed processing mode performed on the master node. More...
 
class  DistributedBase
 Base class representing K-Means algorithm initialization in the distributed processing mode. More...
 
class  Distributed< step1Local, algorithmFPType, method >
 Computes initial clusters for K-Means algorithm in the first step of the distributed processing mode. More...
 
class  Distributed< step2Master, algorithmFPType, method >
 Computes initial clusters for K-Means algorithm in the 2nd step of the distributed processing mode. More...
 
class  DistributedStep2LocalPlusPlusBase
 Base class representing K-Means algorithm initialization in the distributed processing mode. More...
 
class  Distributed< step2Local, algorithmFPType, method >
 Computes initial clusters for K-Means algorithm in the 2nd step of the distributed processing mode. Used with plusPlus and parallelPlus methods only on a local node. More...
 
class  Distributed< step3Master, algorithmFPType, method >
 Computes initial clusters for K-Means algorithm in the 3rd step of the distributed processing mode. Used with plusPlus and parallelPlus methods only on the master node. More...
 
class  Distributed< step4Local, algorithmFPType, method >
 Computes initial clusters for K-Means algorithm in the 4th step of the distributed processing mode. Used with plusPlus and parallelPlus methods only on a local node. More...
 
class  Distributed< step5Master, algorithmFPType, method >
 Computes initial clusters for K-Means algorithm in the 5th step of the distributed processing mode. Used with parallelPlus method only. More...
 

Functions

 DistributedContainer (daal::services::Environment::env *daalEnv)
 
virtual ~DistributedContainer ()
 
virtual services::Status compute () DAAL_C11_OVERRIDE
 
virtual services::Status finalizeCompute () DAAL_C11_OVERRIDE
 
 DistributedContainer (daal::services::Environment::env *daalEnv)
 
virtual ~DistributedContainer ()
 
virtual services::Status compute () DAAL_C11_OVERRIDE
 
virtual services::Status finalizeCompute () DAAL_C11_OVERRIDE
 
 DistributedContainer (daal::services::Environment::env *daalEnv)
 
virtual ~DistributedContainer ()
 
virtual services::Status compute () DAAL_C11_OVERRIDE
 
virtual services::Status finalizeCompute () DAAL_C11_OVERRIDE
 
 DistributedContainer (daal::services::Environment::env *daalEnv)
 
virtual ~DistributedContainer ()
 
virtual services::Status compute () DAAL_C11_OVERRIDE
 
virtual services::Status finalizeCompute () DAAL_C11_OVERRIDE
 
 DistributedContainer (daal::services::Environment::env *daalEnv)
 
virtual ~DistributedContainer ()
 
virtual services::Status compute () DAAL_C11_OVERRIDE
 
virtual services::Status finalizeCompute () DAAL_C11_OVERRIDE
 
 DistributedContainer (daal::services::Environment::env *daalEnv)
 
virtual ~DistributedContainer ()
 
virtual services::Status compute () DAAL_C11_OVERRIDE
 
virtual services::Status finalizeCompute () DAAL_C11_OVERRIDE
 
virtual ~DistributedBase ()
 
 Distributed (size_t nClusters, size_t nRowsTotal, size_t offset=0)
 
 Distributed (const Distributed< step1Local, algorithmFPType, method > &other)
 
virtual int getMethod () const DAAL_C11_OVERRIDE
 
ResultPtr getResult ()
 
services::Status setResult (const ResultPtr &result)
 
PartialResultPtr getPartialResult ()
 
services::Status setPartialResult (const PartialResultPtr &partialRes)
 
services::Status checkFinalizeComputeParams () DAAL_C11_OVERRIDE
 
services::SharedPtr
< Distributed< step1Local,
algorithmFPType, method > > 
clone () const
 
 Distributed (size_t nClusters, size_t offset=0)
 
virtual int getMethod () const DAAL_C11_OVERRIDE
 
ResultPtr getResult ()
 
services::Status setResult (const ResultPtr &result)
 
PartialResultPtr getPartialResult ()
 
services::Status setPartialResult (const PartialResultPtr &partialRes)
 
services::Status checkFinalizeComputeParams () DAAL_C11_OVERRIDE
 
services::SharedPtr
< Distributed< step2Master,
algorithmFPType, method > > 
clone () const
 
virtual ~DistributedStep2LocalPlusPlusBase ()
 
 Distributed (size_t nClusters, bool bFirstIteration)
 
 Distributed (const Distributed< step2Local, algorithmFPType, method > &other)
 
virtual int getMethod () const DAAL_C11_OVERRIDE
 
DistributedStep2LocalPlusPlusPartialResultPtr getPartialResult ()
 
services::Status setPartialResult (const DistributedStep2LocalPlusPlusPartialResultPtr &partialRes)
 
services::Status checkFinalizeComputeParams () DAAL_C11_OVERRIDE
 
services::SharedPtr
< Distributed< step2Local,
algorithmFPType, method > > 
clone () const
 
 Distributed (size_t nClusters)
 
 Distributed (const Distributed< step3Master, algorithmFPType, method > &other)
 
virtual int getMethod () const DAAL_C11_OVERRIDE
 
DistributedStep3MasterPlusPlusPartialResultPtr getPartialResult ()
 
services::Status setPartialResult (const DistributedStep3MasterPlusPlusPartialResultPtr &partialRes)
 
services::Status checkFinalizeComputeParams () DAAL_C11_OVERRIDE
 
services::SharedPtr
< Distributed< step3Master,
algorithmFPType, method > > 
clone () const
 
 Distributed (size_t nClusters)
 
 Distributed (const Distributed< step4Local, algorithmFPType, method > &other)
 
virtual int getMethod () const DAAL_C11_OVERRIDE
 
DistributedStep4LocalPlusPlusPartialResultPtr getPartialResult ()
 
services::Status setPartialResult (const DistributedStep4LocalPlusPlusPartialResultPtr &partialRes)
 
services::Status checkFinalizeComputeParams () DAAL_C11_OVERRIDE
 
services::SharedPtr
< Distributed< step4Local,
algorithmFPType, method > > 
clone () const
 
 Distributed (size_t nClusters)
 
 Distributed (const Distributed< step5Master, algorithmFPType, method > &other)
 
virtual int getMethod () const DAAL_C11_OVERRIDE
 
ResultPtr getResult ()
 
services::Status setResult (const ResultPtr &result)
 
DistributedStep5MasterPlusPlusPartialResultPtr getPartialResult ()
 
services::Status setPartialResult (const DistributedStep5MasterPlusPlusPartialResultPtr &partialRes)
 
services::Status checkFinalizeComputeParams () DAAL_C11_OVERRIDE
 
services::SharedPtr
< Distributed< step5Master,
algorithmFPType, method > > 
clone () const
 

Variables

template<ComputeStep step, typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
class DAAL_EXPORT Distributed
 Computes initial clusters for K-Means algorithm in the distributed processing mode. More...
 
InputType input
 
ParameterType & parameter
 
InputType input
 
ParameterType & parameter
 
InputType input
 
ParameterType & parameter
 
InputType input
 
ParameterType & parameter
 
InputType input
 
ParameterType & parameter
 
InputType input
 
ParameterType & parameter
 

Function Documentation

services::Status checkFinalizeComputeParams ( )
inline

Validates the parameters of the finalizeCompute() method

services::Status checkFinalizeComputeParams ( )
inline

Validates the parameters of the finalizeCompute() method

services::Status checkFinalizeComputeParams ( )
inline

Validates the parameters of the finalizeCompute() method

services::Status checkFinalizeComputeParams ( )
inline

Validates the parameters of the finalizeCompute() method

services::Status checkFinalizeComputeParams ( )
inline

Validates the parameters of the finalizeCompute() method

services::Status checkFinalizeComputeParams ( )
inline

Validates the parameters of the finalizeCompute() method

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

Returns a pointer to the newly allocated algorithm that computes initial clusters for K-Means algorithm with a copy of input objects and parameters of this algorithm

Returns
Pointer to the newly allocated algorithm
services::SharedPtr<Distributed<step2Master, algorithmFPType, method> > clone ( ) const
inline

Returns a pointer to the newly allocated algorithm that computes initial clusters for K-Means algorithm with a copy of input objects and parameters of this algorithm

Returns
Pointer to the newly allocated algorithm
services::SharedPtr<Distributed<step2Local, algorithmFPType, method> > clone ( ) const
inline

Returns a pointer to the newly allocated algorithm that computes initial clusters for K-Means algorithm with a copy of input objects and parameters of this algorithm

Returns
Pointer to the newly allocated algorithm
services::SharedPtr<Distributed<step3Master, algorithmFPType, method> > clone ( ) const
inline

Returns a pointer to the newly allocated algorithm that computes initial clusters for K-Means algorithm with a copy of input objects and parameters of this algorithm

Returns
Pointer to the newly allocated algorithm
services::SharedPtr<Distributed<step4Local, algorithmFPType, method> > clone ( ) const
inline

Returns a pointer to the newly allocated algorithm that computes initial clusters for K-Means algorithm with a copy of input objects and parameters of this algorithm

Returns
Pointer to the newly allocated algorithm
services::SharedPtr<Distributed<step5Master, algorithmFPType, method> > clone ( ) const
inline

Returns a pointer to the newly allocated algorithm that computes initial clusters for K-Means algorithm with a copy of input objects and parameters of this algorithm

Returns
Pointer to the newly allocated algorithm
virtual services::Status compute ( )
virtual

Computes a partial result of K-Means initialization algorithm in the first step of the distributed processing mode

virtual services::Status compute ( )
virtual

Computes a partial result of K-Means initialization algorithm in the 2nd step of the distributed processing mode

virtual services::Status compute ( )
virtual

Computes a partial result of K-Means initialization algorithm in the 2nd step of the distributed processing mode

virtual services::Status compute ( )
virtual

Computes a partial result of K-Means initialization algorithm in the 3rd step of the distributed processing mode

virtual services::Status compute ( )
virtual

Computes a partial result of K-Means initialization algorithm in the 4th step of the distributed processing mode

virtual services::Status compute ( )
virtual

Computes a partial result of K-Means initialization algorithm in the 5th step of the distributed processing mode

Distributed ( size_t  nClusters,
size_t  nRowsTotal,
size_t  offset = 0 
)

Main constructor

Parameters
[in]nClustersNumber of clusters
[in]nRowsTotalNumber of rows in all data sets
[in]offsetOffset in the total data set specifying the start of a block stored on a given local node
Distributed ( const Distributed< step1Local, algorithmFPType, method > &  other)

Copy constructor

Parameters
[in]otherAn algorithm to be used as the source to initialize the input objects and parameters of the algorithm
Distributed ( size_t  nClusters,
size_t  offset = 0 
)

Main constructor

Parameters
[in]nClustersNumber of clusters
[in]offsetOffset in the total data set specifying the start of a block stored on a given local node
Distributed ( size_t  nClusters,
bool  bFirstIteration 
)

Main constructor

Parameters
[in]nClustersNumber of clusters
[in]bFirstIterationtrue if this is the first iteration in the loop of steps 2-4.
Distributed ( const Distributed< step2Local, algorithmFPType, method > &  other)

Copy constructor

Parameters
[in]otherAn algorithm to be used as the source to initialize the input objects and parameters of the algorithm
Distributed ( size_t  nClusters)

Main constructor

Parameters
[in]nClustersNumber of clusters
Distributed ( const Distributed< step3Master, algorithmFPType, method > &  other)

Copy constructor

Parameters
[in]otherAn algorithm to be used as the source to initialize the input objects and parameters of the algorithm
Distributed ( size_t  nClusters)

Main constructor

Parameters
[in]nClustersNumber of clusters
Distributed ( const Distributed< step4Local, algorithmFPType, method > &  other)

Copy constructor

Parameters
[in]otherAn algorithm to be used as the source to initialize the input objects and parameters of the algorithm
Distributed ( size_t  nClusters)

Main constructor

Parameters
[in]nClustersNumber of clusters
Distributed ( const Distributed< step5Master, algorithmFPType, method > &  other)

Copy constructor

Parameters
[in]otherAn algorithm to be used as the source to initialize the input objects and parameters of the algorithm
DistributedContainer ( daal::services::Environment::env *  daalEnv)

Constructs a container for initializing K-Means algorithm with a specified environment in the first step of the distributed processing mode

Parameters
[in]daalEnvEnvironment object
DistributedContainer ( daal::services::Environment::env *  daalEnv)

Constructs a container for initializing K-Means algorithm with a specified environment in the 2nd step of the distributed processing mode

Parameters
[in]daalEnvEnvironment object
DistributedContainer ( daal::services::Environment::env *  daalEnv)

Constructs a container for initializing K-Means algorithm with a specified environment in the 2nd step of the distributed processing mode

Parameters
[in]daalEnvEnvironment object
DistributedContainer ( daal::services::Environment::env *  daalEnv)

Constructs a container for initializing K-Means algorithm with a specified environment in the 3rd step of the distributed processing mode

Parameters
[in]daalEnvEnvironment object
DistributedContainer ( daal::services::Environment::env *  daalEnv)

Constructs a container for initializing K-Means algorithm with a specified environment in the 4th step of the distributed processing mode

Parameters
[in]daalEnvEnvironment object
DistributedContainer ( daal::services::Environment::env *  daalEnv)

Constructs a container for initializing K-Means algorithm with a specified environment in the 5th step of the distributed processing mode

Parameters
[in]daalEnvEnvironment object
virtual services::Status finalizeCompute ( )
virtual

Computes the result of K-Means initialization algorithm in the first step of the distributed processing mode

virtual services::Status finalizeCompute ( )
virtual

Computes the result of K-Means initialization algorithm in the 2nd step of the distributed processing mode

virtual services::Status finalizeCompute ( )
virtual

Computes the result of K-Means initialization algorithm in the 2nd step of the distributed processing mode

virtual services::Status finalizeCompute ( )
virtual

Computes the result of K-Means initialization algorithm in the 3rd step of the distributed processing mode

virtual services::Status finalizeCompute ( )
virtual

Computes the result of K-Means initialization algorithm in the 4th step of the distributed processing mode

virtual services::Status finalizeCompute ( )
virtual

Computes the result of K-Means initialization algorithm in the 5th step of the distributed processing mode

virtual int getMethod ( ) const
inlinevirtual

Returns the method of the algorithm

Returns
Method of the algorithm
virtual int getMethod ( ) const
inlinevirtual

Returns the method of the algorithm

Returns
Method of the algorithm
virtual int getMethod ( ) const
inlinevirtual

Returns the method of the algorithm

Returns
Method of the algorithm
virtual int getMethod ( ) const
inlinevirtual

Returns the method of the algorithm

Returns
Method of the algorithm
virtual int getMethod ( ) const
inlinevirtual

Returns the method of the algorithm

Returns
Method of the algorithm
virtual int getMethod ( ) const
inlinevirtual

Returns the method of the algorithm

Returns
Method of the algorithm
PartialResultPtr getPartialResult ( )
inline

Returns the structure that contains computed partial results

Returns
Structure that contains computed partial results
PartialResultPtr getPartialResult ( )
inline

Returns the structure that contains computed partial results

Returns
Structure that contains computed partial results
DistributedStep2LocalPlusPlusPartialResultPtr getPartialResult ( )
inline

Returns the structure that contains computed partial results

Returns
Structure that contains computed partial results
DistributedStep3MasterPlusPlusPartialResultPtr getPartialResult ( )
inline

Returns the structure that contains computed partial results

Returns
Structure that contains computed partial results
DistributedStep4LocalPlusPlusPartialResultPtr getPartialResult ( )
inline

Returns the structure that contains computed partial results

Returns
Structure that contains computed partial results
DistributedStep5MasterPlusPlusPartialResultPtr getPartialResult ( )
inline

Returns the structure that contains computed partial results

Returns
Structure that contains computed partial results
ResultPtr getResult ( )
inline

Returns the structure that contains the results of computing initial clusters for K-Means algorithm

Returns
Structure that contains the results of computing initial clusters for K-Means algorithm
ResultPtr getResult ( )
inline

Returns the structure that contains the results of computing initial clusters for K-Means algorithm

Returns
Structure that contains the results of computing initial clusters for K-Means algorithm
ResultPtr getResult ( )
inline

Returns the structure that contains the results of computing initial clusters for K-Means algorithm

Returns
Structure that contains the results of computing initial clusters for K-Means algorithm
services::Status setPartialResult ( const PartialResultPtr &  partialRes)
inline

Registers user-allocated memory to store partial results of computing initial clusters for K-Means algorithm

Parameters
[in]partialResStructure to store partial results of computing initial clusters for K-Means algorithm
services::Status setPartialResult ( const PartialResultPtr &  partialRes)
inline

Registers user-allocated memory to store partial results of computing initial clusters for K-Means algorithm

Parameters
[in]partialResStructure to store partial results of computing initial clusters for K-Means algorithm
services::Status setPartialResult ( const DistributedStep2LocalPlusPlusPartialResultPtr &  partialRes)
inline

Registers user-allocated memory to store partial results of computing initial clusters for K-Means algorithm

Parameters
[in]partialResStructure to store partial results of computing initial clusters for K-Means algorithm
services::Status setPartialResult ( const DistributedStep3MasterPlusPlusPartialResultPtr &  partialRes)
inline

Registers user-allocated memory to store partial results of computing initial clusters for K-Means algorithm

Parameters
[in]partialResStructure to store partial results of computing initial clusters for K-Means algorithm
services::Status setPartialResult ( const DistributedStep4LocalPlusPlusPartialResultPtr &  partialRes)
inline

Registers user-allocated memory to store partial results of computing initial clusters for K-Means algorithm

Parameters
[in]partialResStructure to store partial results of computing initial clusters for K-Means algorithm
services::Status setPartialResult ( const DistributedStep5MasterPlusPlusPartialResultPtr &  partialRes)
inline

Registers user-allocated memory to store partial results of computing initial clusters for K-Means algorithm

Parameters
[in]partialResStructure to store partial results of computing initial clusters for K-Means algorithm
services::Status setResult ( const ResultPtr &  result)
inline

Registers user-allocated memory to store the results of computing initial clusters for K-Means algorithm

Parameters
[in]resultStructure to store the results of computing initial clusters for K-Means algorithm
services::Status setResult ( const ResultPtr &  result)
inline

Registers user-allocated memory to store the results of computing initial clusters for K-Means algorithm

Parameters
[in]resultStructure to store the results of computing initial clusters for K-Means algorithm
services::Status setResult ( const ResultPtr &  result)
inline

Registers user-allocated memory to store the results of computing initial clusters for K-Means algorithm

Parameters
[in]resultStructure to store the results of computing initial clusters for K-Means algorithm
virtual ~DistributedBase ( )
inlinevirtual

Default destructor

virtual ~DistributedContainer ( )
virtual

Default destructor

virtual ~DistributedContainer ( )
virtual

Default destructor

virtual ~DistributedContainer ( )
virtual

Default destructor

virtual ~DistributedContainer ( )
virtual

Default destructor

virtual ~DistributedContainer ( )
virtual

Default destructor

virtual ~DistributedContainer ( )
virtual

Default destructor

virtual ~DistributedStep2LocalPlusPlusBase ( )
inlinevirtual

Default destructor

Variable Documentation

class DAAL_EXPORT Distributed

Template Parameters
algorithmFPTypeData type to use in intermediate computations of initial clusters for K-Means algorithm, double or float
methodMethod of computing initial clusters for the algorithm, Method
Enumerations
  • Method Methods of computing initial clusters for K-Means algorithm
  • InputId Identifiers of input objects for computing initial clusters for K-Means algorithm
  • ResultId Identifiers of results of computing initial clusters for K-Means algorithm
References
  • Input class
  • Result class
InputType input

Input data structure

InputType input

Input data structure

InputType input

Input data structure

InputType input

Input data structure

InputType input

Input data structure

InputType input

Input data structure

ParameterType& parameter

K-Means init parameters structure

ParameterType& parameter

K-Means init parameters structure

ParameterType& parameter

Step2 parameters structure

ParameterType& parameter

K-means init parameters structure

ParameterType& parameter

K-means init parameters structure

ParameterType& parameter

Parameters structure

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