C++ API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1
Contains classes for computing the results of the principal component analysis (PCA) algorithm. More...
References | |
Batch | |
Distributed | |
Online | |
PCA Transformation | |
Contains classes for computing the results of the PCA transformation algorithm. | |
Quality Metrics | |
Contains classes to check the quality of the pca algorithm. | |
Namespaces | |
daal::algorithms::pca | |
Contains classes for computing the results of the principal component analysis (PCA) algorithm. | |
daal::algorithms::pca::interface1 | |
Contains version 1.0 of Intel(R) Data Analytics Acceleration Library (Intel(R) DAAL) interface. | |
daal::algorithms::pca::interface3 | |
Contains version 3.0 of Intel(R) Data Analytics Acceleration Library (Intel(R) DAAL) interface. | |
Classes | |
class | InputIface |
Abstract class that specifies interface for classes that declare input of the PCA algorithm. More... | |
class | Input |
Input objects for the PCA algorithm. More... | |
class | PartialResultBase |
Provides interface to access partial results obtained with the compute() method of the PCA algorithm in the online or distributed processing mode. More... | |
class | PartialResult< method > |
Provides methods to access partial results obtained with the compute() method of the PCA algorithm in the online or distributed processing mode. More... | |
class | PartialResult< daal::algorithms::pca::correlationDense > |
Provides methods to access partial results obtained with the compute() method of the PCA Correlation algorithm in the online or distributed processing mode. More... | |
class | PartialResult< daal::algorithms::pca::svdDense > |
Provides methods to access partial results obtained with the compute() method of PCA SVD algorithm in the online or distributed processing mode. More... | |
class | BaseParameter< algorithmFPType, method > |
Class that specifies the common parameters of the PCA algorithm. More... | |
class | OnlineParameter< algorithmFPType, method > |
Class that specifies the parameters of the PCA algorithm in the online computing mode. More... | |
class | OnlineParameter< algorithmFPType, correlationDense > |
Class that specifies the parameters of the PCA Correlation algorithm in the online computing mode. More... | |
class | OnlineParameter< algorithmFPType, svdDense > |
Class that specifies the parameters of the PCA SVD algorithm in the online computing mode. More... | |
class | DistributedParameter< step, algorithmFPType, method > |
Class that specifies the parameters of the PCA algorithm in the distributed computing mode. More... | |
class | DistributedParameter< step2Master, algorithmFPType, correlationDense > |
Class that specifies the parameters of the PCA Correlation algorithm in the distributed computing mode. More... | |
class | DistributedInput< method > |
Input objects for the PCA algorithm in the distributed processing mode. More... | |
class | DistributedInput< correlationDense > |
Input objects for the PCA Correlation algorithm in the distributed processing mode. More... | |
class | DistributedInput< svdDense > |
Input objects of the PCA SVD algorithm in the distributed processing mode. More... | |
class | BaseBatchParameter |
Class that specifies the common parameters of the PCA Batch algorithms. More... | |
class | BatchParameter< algorithmFPType, method > |
Class that specifies the parameters of the PCA algorithm in the batch computing mode. More... | |
class | BatchParameter< algorithmFPType, correlationDense > |
Class that specifies the parameters of the PCA Correlation algorithm in the batch computing mode. More... | |
class | BatchParameter< algorithmFPType, svdDense > |
Class that specifies the parameters of the PCA SVD algorithm in the batch computing mode. More... | |
class | Result |
Provides methods to access results obtained with the PCA algorithm. More... | |
Enumerations | |
enum | Method { correlationDense = 0, defaultDense = 0, svdDense = 1 } |
enum | InputDatasetId { data } |
enum | InputCorrelationId { correlation } |
enum | Step2MasterInputId { partialResults } |
enum | PartialCorrelationResultId |
enum | PartialSVDTableResultId |
enum | PartialSVDCollectionResultId { auxiliaryData = lastPartialSVDTableResultId + 1, distributedInputs } |
enum | ResultId { eigenvalues, eigenvectors, means, variances } |
enum | ResultCollectionId { dataForTransform } |
Functions | |
virtual size_t | getNFeatures () const =0 |
virtual bool | isCorrelation () const |
data_management::NumericTablePtr | get (InputDatasetId id) const |
void | set (InputDatasetId id, const data_management::NumericTablePtr &value) |
void | set (InputCorrelationId id, const data_management::NumericTablePtr &value) |
size_t | getNFeatures () const DAAL_C11_OVERRIDE |
services::Status | check (const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE |
data_management::NumericTablePtr | get (PartialCorrelationResultId id) const |
void | set (const PartialCorrelationResultId id, const data_management::NumericTablePtr &value) |
services::Status | check (const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE |
services::Status | check (const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE |
template<typename algorithmFPType > | |
DAAL_EXPORT services::Status | allocate (const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method) |
template<typename algorithmFPType > | |
DAAL_EXPORT services::Status | initialize (const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method) |
data_management::NumericTablePtr | get (PartialSVDTableResultId id) const |
data_management::DataCollectionPtr | get (PartialSVDCollectionResultId id) const |
data_management::NumericTablePtr | get (PartialSVDCollectionResultId id, const size_t &elementId) const |
void | set (PartialSVDTableResultId id, const data_management::NumericTablePtr &value) |
void | set (PartialSVDCollectionResultId id, const data_management::DataCollectionPtr &value) |
void | add (const PartialSVDCollectionResultId &id, const data_management::DataCollectionPtr &value) |
services::Status | check (const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE |
services::Status | check (const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE |
template<typename algorithmFPType > | |
DAAL_EXPORT services::Status | allocate (const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method) |
template<typename algorithmFPType > | |
DAAL_EXPORT services::Status | initialize (const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method) |
BaseParameter () | |
OnlineParameter (const services::SharedPtr< covariance::OnlineImpl > &covarianceForOnlineParameter=services::SharedPtr< covariance::Online< algorithmFPType, covariance::defaultDense > >(new covariance::Online< algorithmFPType, covariance::defaultDense >())) | |
services::Status | check () const DAAL_C11_OVERRIDE |
OnlineParameter () | |
services::Status | check () const DAAL_C11_OVERRIDE |
DistributedParameter (const services::SharedPtr< covariance::DistributedIface< step2Master > > &covarianceForDistributedParameter=services::SharedPtr< covariance::Distributed< step2Master, algorithmFPType, covariance::defaultDense > >(new covariance::Distributed< step2Master, algorithmFPType, covariance::defaultDense >())) | |
services::Status | check () const DAAL_C11_OVERRIDE |
void | set (Step2MasterInputId id, const data_management::DataCollectionPtr &ptr) |
data_management::DataCollectionPtr | get (Step2MasterInputId id) const |
services::SharedPtr < PartialResult < correlationDense > > | getPartialResult (size_t id) const |
void | add (Step2MasterInputId id, const services::SharedPtr< PartialResult< correlationDense > > &value) |
size_t | getNFeatures () const DAAL_C11_OVERRIDE |
services::Status | check (const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE |
void | set (Step2MasterInputId id, const data_management::DataCollectionPtr &ptr) |
data_management::DataCollectionPtr | get (Step2MasterInputId id) const |
void | add (Step2MasterInputId id, const services::SharedPtr< PartialResult< svdDense > > &value) |
services::SharedPtr < PartialResult< svdDense > > | getPartialResult (size_t id) const |
services::Status | check (const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE |
size_t | getNFeatures () const DAAL_C11_OVERRIDE |
BaseBatchParameter () | |
BatchParameter (const services::SharedPtr< covariance::BatchImpl > &covarianceForBatchParameter=services::SharedPtr< covariance::Batch< algorithmFPType, covariance::defaultDense > >(new covariance::Batch< algorithmFPType, covariance::defaultDense >())) | |
services::Status | check () const DAAL_C11_OVERRIDE |
BatchParameter (const services::SharedPtr< normalization::zscore::BatchImpl > &normalizationForBatchParameter=services::SharedPtr< normalization::zscore::Batch< algorithmFPType, normalization::zscore::defaultDense > >(new normalization::zscore::Batch< algorithmFPType, normalization::zscore::defaultDense >())) | |
services::Status | check () const DAAL_C11_OVERRIDE |
data_management::NumericTablePtr | get (ResultId id) const |
data_management::KeyValueDataCollectionPtr | get (ResultCollectionId id) const |
void | set (ResultCollectionId id, data_management::KeyValueDataCollectionPtr &collection) |
void | set (ResultId id, const data_management::NumericTablePtr &value) |
template<typename algorithmFPType > | |
DAAL_EXPORT services::Status | allocate (const daal::algorithms::Input *input, daal::algorithms::Parameter *parameter, const Method method) |
template<typename algorithmFPType > | |
DAAL_EXPORT services::Status | allocate (const daal::algorithms::PartialResult *partialResult, daal::algorithms::Parameter *parameter, const Method method) |
services::Status | check (const daal::algorithms::Input *_input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE |
services::Status | check (const daal::algorithms::PartialResult *pr, const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE |
services::Status | checkImpl (size_t nFeatures, size_t nComponents, DAAL_UINT64 resultsToCompute) const |
Variables | |
services::SharedPtr < covariance::OnlineImpl > | covariance |
services::SharedPtr < covariance::DistributedIface < step2Master > > | covariance |
DAAL_UINT64 | resultsToCompute |
size_t | nComponents |
bool | isDeterministic |
services::SharedPtr < covariance::BatchImpl > | covariance |
services::SharedPtr < normalization::zscore::BatchImpl > | normalization |
enum InputCorrelationId |
enum InputDatasetId |
enum Method |
enum PartialCorrelationResultId |
enum PartialSVDCollectionResultId |
enum ResultCollectionId |
enum ResultId |
enum Step2MasterInputId |
void add | ( | const PartialSVDCollectionResultId & | id, |
const data_management::DataCollectionPtr & | value | ||
) |
Adds partial result of the PCA SVD algorithm
[in] | id | Identifier of the argument |
[in] | value | Pointer to the object |
void add | ( | Step2MasterInputId | id, |
const services::SharedPtr< PartialResult< correlationDense > > & | value | ||
) |
Adds input objects of the PCA algorithm on the second step in the distributed processing mode
[in] | id | Identifier of the argument |
[in] | value | Pointer to the argument |
void add | ( | Step2MasterInputId | id, |
const services::SharedPtr< PartialResult< svdDense > > & | value | ||
) |
Adds input objects of the PCA algorithm on the second step in the distributed processing mode
[in] | id | Identifier of the input object |
[in] | value | Pointer to the input object |
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 PCA SVD algorithm
[in] | input | Pointer to an object containing input data |
[in] | parameter | Pointer to the structure of algorithm parameters |
[in] | method | Computation method |
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 PCA SVD algorithm
[in] | input | Pointer to an object containing input data |
[in] | parameter | Pointer to the structure of algorithm parameters |
[in] | method | Computation method |
DAAL_EXPORT services::Status allocate | ( | const daal::algorithms::Input * | input, |
daal::algorithms::Parameter * | parameter, | ||
const Method | method | ||
) |
Allocates memory for storing partial results of the PCA algorithm
[in] | input | Pointer to an object containing input data |
[in] | parameter | Algorithm parameter |
[in] | method | Computation method |
DAAL_EXPORT services::Status allocate | ( | const daal::algorithms::PartialResult * | partialResult, |
daal::algorithms::Parameter * | parameter, | ||
const Method | method | ||
) |
Allocates memory for storing partial results of the PCA algorithm *
[in] | partialResult | Pointer to an object containing input data |
[in] | parameter | Parameter of the algorithm |
[in] | method | Computation method |
BaseBatchParameter | ( | ) |
Constructs PCA parameters
BaseParameter | ( | ) |
Constructs PCA parameters
BatchParameter | ( | const services::SharedPtr< covariance::BatchImpl > & | covarianceForBatchParameter = services::SharedPtr< covariance::Batch< algorithmFPType, covariance::defaultDense > >(new covariance::Batch< algorithmFPType, covariance::defaultDense >()) | ) |
Constructs PCA parameters
BatchParameter | ( | const services::SharedPtr< normalization::zscore::BatchImpl > & | normalizationForBatchParameter = services::SharedPtr< normalization::zscore::Batch< algorithmFPType, normalization::zscore::defaultDense > >(new normalization::zscore::Batch< algorithmFPType, normalization::zscore::defaultDense >()) | ) |
Constructs PCA parameters
services::Status check | ( | const daal::algorithms::Parameter * | par, |
int | method | ||
) | const |
Checks input algorithm parameters
[in] | par | Algorithm parameter |
[in] | method | Computation method |
services::Status check | ( | const daal::algorithms::Input * | input, |
const daal::algorithms::Parameter * | parameter, | ||
int | method | ||
) | const |
Checks partial results of the PCA Correlation algorithm
[in] | input | Input object of the algorithm |
[in] | parameter | Algorithm parameter |
[in] | method | Computation method |
services::Status check | ( | const daal::algorithms::Parameter * | par, |
int | method | ||
) | const |
Checks partial results of the PCA Ccorrelation algorithm
[in] | par | Algorithm parameter |
[in] | method | Computation method |
services::Status check | ( | const daal::algorithms::Input * | input, |
const daal::algorithms::Parameter * | parameter, | ||
int | method | ||
) | const |
Checks partial results of the PCA SVD algorithm
[in] | input | Input of algorithm |
[in] | parameter | Parameter of algorithm |
[in] | method | Computation method |
services::Status check | ( | const daal::algorithms::Parameter * | par, |
int | method | ||
) | const |
Checks partial results of the PCA SVD algorithm
[in] | method | Computation method |
[in] | par | Parameter of algorithm |
services::Status check | ( | ) | const |
Checks online parameter of the PCA correlation algorithm
services::Status check | ( | ) | const |
Checks online parameter of the PCA SVD algorithm
services::Status check | ( | ) | const |
Checks distributed parameter of the PCA correlation algorithm
services::Status check | ( | const daal::algorithms::Parameter * | parameter, |
int | method | ||
) | const |
Checks the input of the PCA algorithm
[in] | parameter | Algorithm parameter |
[in] | method | Computation method |
services::Status check | ( | const daal::algorithms::Parameter * | parameter, |
int | method | ||
) | const |
Checks the input of the PCA algorithm
[in] | parameter | Algorithm parameter |
[in] | method | Computation method |
services::Status check | ( | ) | const |
Checks batch parameter of the PCA correlation algorithm
services::Status check | ( | ) | const |
Checks batch parameter of the PCA svd algorithm
services::Status check | ( | const daal::algorithms::Input * | _input, |
const daal::algorithms::Parameter * | par, | ||
int | method | ||
) | const |
Checks the results of the PCA algorithm
[in] | _input | Input object of algorithm |
[in] | par | Algorithm parameter |
[in] | method | Computation method |
services::Status check | ( | const daal::algorithms::PartialResult * | pr, |
const daal::algorithms::Parameter * | parameter, | ||
int | method | ||
) | const |
Checks the results of the PCA algorithm
[in] | pr | Partial results of the algorithm |
[in] | method | Computation method |
[in] | parameter | Algorithm parameter |
|
protected |
Checks the results of the PCA algorithm implementation
[in] | nFeatures | Number of features |
[in] | nComponents | Number of components |
[in] | resultsToCompute | Results to compute |
DistributedParameter | ( | const services::SharedPtr< covariance::DistributedIface< step2Master > > & | covarianceForDistributedParameter = services::SharedPtr< covariance::Distributed< step2Master, algorithmFPType, covariance::defaultDense > >(new covariance::Distributed< step2Master, algorithmFPType, covariance::defaultDense >()) | ) |
Constructs PCA parameters
data_management::NumericTablePtr get | ( | InputDatasetId | id | ) | const |
Returns the input object of the PCA algorithm
[in] | id | Identifier of the input object |
data_management::NumericTablePtr get | ( | PartialCorrelationResultId | id | ) | const |
Gets partial results of the PCA Correlation algorithm
[in] | id | Identifier of the input object |
data_management::NumericTablePtr get | ( | PartialSVDTableResultId | id | ) | const |
Gets partial results of the PCA SVD algorithm
[in] | id | Identifier of the input object |
data_management::DataCollectionPtr get | ( | PartialSVDCollectionResultId | id | ) | const |
Gets partial results of the PCA SVD algorithm
[in] | id | Identifier of the input object |
data_management::NumericTablePtr get | ( | PartialSVDCollectionResultId | id, |
const size_t & | elementId | ||
) | const |
Gets partial results of the PCA SVD algorithm
[in] | id | Identifier of the input object |
[in] | elementId | Identifier of the collection element |
data_management::DataCollectionPtr get | ( | Step2MasterInputId | id | ) | const |
Gets input objects for the PCA on the second step in the distributed processing mode
[in] | id | Identifier of the input object |
data_management::DataCollectionPtr get | ( | Step2MasterInputId | id | ) | const |
Gets input objects for the PCA algorithm on the second step in the distributed processing mode
[in] | id | Identifier of the input object |
data_management::NumericTablePtr get | ( | ResultId | id | ) | const |
Gets the results of the PCA algorithm
[in] | id | Identifier of the input object |
data_management::KeyValueDataCollectionPtr get | ( | ResultCollectionId | id | ) | const |
Gets the results collection of the PCA algorithm
[in] | id | Identifier of the results collection |
|
pure virtual |
Returns the number of columns in the input data set
Implemented in DistributedInput< svdDense >, DistributedInput< correlationDense >, and Input.
|
virtual |
Returns the number of columns in the input data set
Implements InputIface.
|
virtual |
Returns the number of columns in the input data set
Implements InputIface.
|
virtual |
Returns the number of columns in the input data set
Implements InputIface.
services::SharedPtr<PartialResult<correlationDense> > getPartialResult | ( | size_t | id | ) | const |
Retrieves specific partial result from the input objects of the PCA algorithm on the second step in the distributed processing mode
[in] | id | Identifier of the partial result |
services::SharedPtr<PartialResult<svdDense> > getPartialResult | ( | size_t | id | ) | const |
Retrieves specific partial result from the input objects of the PCA algorithm on the second step in the distributed processing mode
[in] | id | Identifier of the partial result |
DAAL_EXPORT services::Status initialize | ( | const daal::algorithms::Input * | input, |
const daal::algorithms::Parameter * | parameter, | ||
const int | method | ||
) |
Initializes memory to store partial results of the PCA SVD algorithm
[in] | input | Pointer to an object containing input data |
[in] | parameter | Pointer to the structure of algorithm parameters |
[in] | method | Computation method |
DAAL_EXPORT services::Status initialize | ( | const daal::algorithms::Input * | input, |
const daal::algorithms::Parameter * | parameter, | ||
const int | method | ||
) |
Initializes memory to store partial results of the PCA SVD algorithm
[in] | input | Pointer to an object containing input data |
[in] | parameter | Pointer to the structure of algorithm parameters |
[in] | method | Computation method |
|
inlinevirtual |
Returns flag defining whether the input data contains correlation matrix or not
OnlineParameter | ( | const services::SharedPtr< covariance::OnlineImpl > & | covarianceForOnlineParameter = services::SharedPtr< covariance::Online< algorithmFPType, covariance::defaultDense > >(new covariance::Online< algorithmFPType, covariance::defaultDense >()) | ) |
Constructs PCA parameters
OnlineParameter | ( | ) |
Constructs PCA parameters
void set | ( | InputDatasetId | id, |
const data_management::NumericTablePtr & | value | ||
) |
Sets input dataset for the PCA algorithm
[in] | id | Identifier of the input object |
[in] | value | Pointer to the input object |
void set | ( | InputCorrelationId | id, |
const data_management::NumericTablePtr & | value | ||
) |
Sets input correlation matrix for the PCA algorithm
[in] | id | Identifier of the input object |
[in] | value | Pointer to the input object |
void set | ( | const PartialCorrelationResultId | id, |
const data_management::NumericTablePtr & | value | ||
) |
Sets partial result of the PCA Correlation algorithm
[in] | id | Identifier of the result |
[in] | value | Pointer to the object |
void set | ( | PartialSVDTableResultId | id, |
const data_management::NumericTablePtr & | value | ||
) |
Sets partial result of the PCA SVD algorithm
[in] | id | Identifier of the result |
[in] | value | Pointer to the object |
void set | ( | PartialSVDCollectionResultId | id, |
const data_management::DataCollectionPtr & | value | ||
) |
Sets partial result of the PCA SVD algorithm
[in] | id | Identifier of the result |
[in] | value | Pointer to the object |
void set | ( | Step2MasterInputId | id, |
const data_management::DataCollectionPtr & | ptr | ||
) |
Sets input objects for the PCA on the second step in the distributed processing mode
[in] | id | Identifier of the input object |
[in] | ptr | Input object that corresponds to the given identifier |
void set | ( | Step2MasterInputId | id, |
const data_management::DataCollectionPtr & | ptr | ||
) |
Sets input objects for the PCA on the second step in the distributed processing mode
[in] | id | Identifier of the input object |
[in] | ptr | Input object that corresponds to the given identifier |
void set | ( | ResultCollectionId | id, |
data_management::KeyValueDataCollectionPtr & | collection | ||
) |
Sets the results collection of the PCA algorithm only not NULL tables from collection collection will be set to result
[in] | id | Identifier of the results collection |
[in] | collection | PCA results collection |
void set | ( | ResultId | id, |
const data_management::NumericTablePtr & | value | ||
) |
Sets results of the PCA algorithm
[in] | id | Identifier of the result |
[in] | value | Pointer to the object |
services::SharedPtr<covariance::OnlineImpl> covariance |
Pointer to Online covariance
services::SharedPtr<covariance::DistributedIface<step2Master> > covariance |
Pointer to Distributed covariance
services::SharedPtr<covariance::BatchImpl> covariance |
Pointer to batch covariance
bool isDeterministic |
sign flip if required
size_t nComponents |
number of components for reduced implementation
services::SharedPtr<normalization::zscore::BatchImpl> normalization |
Pointer to batch covariance
DAAL_UINT64 resultsToCompute |
64 bit integer flag that indicates the results to compute
For more complete information about compiler optimizations, see our Optimization Notice.