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

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

Computes results of the SVD algorithm in the online processing mode. More...

Class Declaration

template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
class daal::algorithms::svd::interface1::Online< algorithmFPType, method >

Template Parameters
algorithmFPTypeData type to use in intermediate computations for the SVD algorithm, double or float
methodSVD computation method, daal::algorithms::svd::Method
Enumerations
  • Method SVD computation methods

Constructor & Destructor Documentation

Online ( const Online< algorithmFPType, method > &  other)
inline

Constructs an SVD algorithm by copying input objects and parameters of another SVD algorithm

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

Member Function Documentation

services::Status checkFinalizeComputeParams ( )
inline

Validates parameters of the finalizeCompute() method

Returns
Status of computations
services::SharedPtr<Online<algorithmFPType, method> > clone ( ) const
inline

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

Returns
Pointer to the newly allocated algorithm
virtual int getMethod ( ) const
inlinevirtual

Returns method of the algorithm

Returns
Method of the algorithm
PartialResultPtr getPartialResult ( )
inline

Returns the structure that contains computed partial results of the SVD algorithm

Returns
Structure that contains computed partial results of the SVD algorithm
ResultPtr getResult ( )
inline

Returns the structure that contains computed partial results of the SVD algorithm

Returns
Structure that contains computed partial results of the SVD algorithm
services::Status setPartialResult ( const PartialResultPtr &  partialResult,
bool  initFlag = false 
)
inline

Registers user-allocated memory to store computed results of the SVD algorithm

Parameters
[in]partialResultStructure for storing partial results of the SVD algorithm
[in]initFlagFlag that specifies whether the partial results are initialized
Returns
Status of computations
services::Status setResult ( const ResultPtr &  res)
inline

Registers user-allocated memory to store computed results of the SVD algorithm

Returns
Status of computations

Member Data Documentation

InputType input

Input data structure

ParameterType parameter

SVD parameters structure


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

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