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

List of all members
DistributedPartialResult Class Reference

Provides methods to access partial results obtained with the compute() method of the SVD algorithm in the second step in the distributed processing mode. More...

Additional Inherited Members

- Static Protected Member Functions inherited from Argument
static data_management::DataCollectionPtr & getStorage (Argument &a)
 
static const data_management::DataCollectionPtr & getStorage (const Argument &a)
 

Class Declaration

Constructor & Destructor Documentation

◆ DistributedPartialResult()

Default constructor

◆ ~DistributedPartialResult()

virtual ~DistributedPartialResult ( )
inlinevirtual

Default destructor

Member Function Documentation

◆ allocate()

DAAL_EXPORT services::Status allocate ( const daal::algorithms::Input input,
const daal::algorithms::Parameter parameter,
const int  method 
)

Allocates memory to store partial results of the SVD algorithm

Returns
Status of allocation

◆ check() [1/2]

services::Status check ( const daal::algorithms::Parameter parameter,
int  method 
) const
virtual

Checks partial results of the algorithm

Parameters
[in]parameterPointer to parameters
[in]methodComputation method
Returns
Errors detected while checking

Reimplemented from PartialResult.

◆ check() [2/2]

services::Status check ( const daal::algorithms::Input input,
const daal::algorithms::Parameter parameter,
int  method 
) const
virtual

Checks final results of the algorithm

Parameters
[in]inputPointer to input objects
[in]parameterPointer to parameters
[in]methodComputation method
Returns
Errors detected while checking

Reimplemented from PartialResult.

◆ get() [1/3]

data_management::KeyValueDataCollectionPtr get ( DistributedPartialResultCollectionId  id) const

Returns partial results of the SVD algorithm. KeyValueDataCollection under outputOfStep2ForStep3 id is structured the same as KeyValueDataCollection under inputOfStep2FromStep1 id of the algorithm input

Parameters
[in]idIdentifier of the partial result
Returns
Value that corresponds to the given identifier

◆ get() [2/3]

data_management::DataCollectionPtr get ( DistributedPartialResultCollectionId  id,
size_t  idx 
) const

Returns the DataCollection from outputOfStep2ForStep3 results of the SVD algorithm.

Parameters
[in]idIdentifier of the partial result
[in]idxIndex of the DataCollection within KeyValueDataCollcetion of the partial result
Returns
Value that corresponds to the given identifier and index

◆ get() [3/3]

Returns results of the SVD algorithm with singular values and the left orthogonal matrix calculated

Parameters
[in]idIdentifier of the parameter
Returns
Parameter that corresponds to the given identifier

◆ set() [1/2]

void set ( DistributedPartialResultCollectionId  id,
const data_management::KeyValueDataCollectionPtr &  value 
)

Sets KeyValueDataCollection to store partial results of the SVD algorithm

Parameters
[in]idIdentifier of the partial result
[in]valueValue that corresponds to the given identifier

◆ set() [2/2]

void set ( DistributedPartialResultId  id,
const ResultPtr value 
)

Sets the Result object to store results of the SVD algorithm

Parameters
[in]idIdentifier of the parameter
[in]valuePointer to the Result object

◆ setPartialResultStorage()

DAAL_EXPORT services::Status setPartialResultStorage ( data_management::KeyValueDataCollection *  inCollection,
size_t &  nBlocks 
)

Allocates memory to store partial results of the SVD algorithm based on the known structure of partial results from step 1 in the distributed processing mode. KeyValueDataCollection under outputOfStep2ForStep3 id is structured the same as KeyValueDataCollection under inputOfStep2FromStep1 id of the algorithm input

Template Parameters
algorithmFPTypeData type to use for storage in the resulting HomogenNumericTable
Parameters
[in]inCollectionKeyValueDataCollection of all partial results from the first step of the SVD algorithm in the distributed processing mode
[out]nBlocksNumber of rows in the input data set

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

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