Intel® oneAPI Data Analytics Library Developer Guide and Reference

Developer Guide and Reference

  • 2021.4
  • 09/27/2021
  • Public Content
Contents

Batch and Online Processing

Online processing computation mode assumes that the data arrives in blocks LaTex Math image..

Algorithm Input

The SVD algorithm accepts the input described below. Pass the
Input ID
 as a parameter to the methods that provide input for your algorithm.
Input ID
Input
data
Pointer to the numeric table that represents:
  • For batch processing, the entire LaTex Math image. matrix
    X
     to be factorized.
  • For online processing, the LaTex Math image. submatrix of
    X
     that represents the current data block in the online processing mode.
The input can be an object of any class derived from
NumericTable
.

Algorithm Parameters

The SVD algorithm has the following parameters:
Parameter
Default Value
Description
algorithmFPType
float
The floating-point type that the algorithm uses for intermediate computations. Can be
float
 or
double
.
method
defaultDense
Performance-oriented computation method, the only method supported by the algorithm.
leftSingularMatrix
requiredInPackedForm
Specifies whether the matrix of left singular vectors is required. Can be:
  • notRequired
     - the matrix is not required
  • requiredInPackedForm
     - the matrix in the packed format is required
rightSingularMatrix
requiredInPackedForm
Specifies whether the matrix of left singular vectors is required. Can be:
  • notRequired
     - the matrix is not required
  • requiredInPackedForm
     - the matrix in the packed format is required

Algorithm Output

The SVD algorithm calculates the results described below. Pass the
Result ID
 as a parameter to the methods that access the results of your algorithm.
Result ID
Result
singularValues
Pointer to the LaTex Math image. numeric table with singular values (the diagonal of the matrix LaTex Math image.).
leftSingularMatrix
Pointer to the LaTex Math image. numeric table with left singular vectors (matrix
U
). Pass
NULL
 if left singular vectors are not required.
rightSingularMatrix
Pointer to the LaTex Math image. numeric table with right singular vectors (matrix
V
). Pass
NULL
 if right singular vectors are not required.
By default, these results are objects of the
HomogenNumericTable
 class, but you can define the result as an object of any class derived from
NumericTable
 except
PackedSymmetricMatrix
,
PackedTriangularMatrix
, and
CSRNumericTable
.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.