Python* API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1

Public Member Functions | Static Public Attributes | List of all members
Online Class Reference

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

Public Member Functions

def __init__
 
def getMethod
 
def getResult
 
def getPartialResult
 
def setResult
 
def setPartialResult
 
def checkFinalizeComputeParams
 
def clone
 
def compute
 
def finalizeCompute
 

Static Public Attributes

 input = ...
 
 parameter = ...
 

Detailed Description

Parameters
fptypeData 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
Aliases
  • Online_Float64DefaultDense is an alias of Online(fptype=float64, method=daal.algorithms.svd.defaultDense)
  • Online_Float32DefaultDense is an alias of Online(fptype=float32, method=daal.algorithms.svd.defaultDense)

Constructor & Destructor Documentation

def __init__ (   self,
  args 
)

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

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

Member Function Documentation

def checkFinalizeComputeParams (   self)

Validates parameters of the finalizeCompute() method

Returns
Status of computations
def clone (   self)

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
def compute (   self)

Invokes computations and returns partial result

def finalizeCompute (   self)

Finalizes computations and returns (final) result

def getMethod (   self)

Returns method of the algorithm

Returns
Method of the algorithm
def getPartialResult (   self)

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

Returns
Structure that contains computed partial results of the SVD algorithm
def getResult (   self)

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

Returns
Structure that contains computed partial results of the SVD algorithm
def setPartialResult (   self,
  partialResult,
  initFlag = False 
)

Variant 1

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

Parameters
partialResultStructure for storing partial results of the SVD algorithm
initFlagFlag that specifies whether the partial results are initialized
Returns
Status of computations

Variant 2

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

Parameters
partialResultStructure for storing partial results of the SVD algorithm
initFlagFlag that specifies whether the partial results are initialized
Returns
Status of computations
def setResult (   self,
  res 
)

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

Returns
Status of computations

Member Data Documentation

input = ...
static

Input data structure

parameter = ...
static

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.