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

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

Computes moments of low order in the online processing mode. More...

Class Declaration

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

Template Parameters
methodComputation method for the low order moments algorithm, daal::algorithms::low_order_moments::Method
algorithmFPTypeData type to use in intermediate computations of low order moments, double or float
Enumerations
  • Method Computation methods for the low order moments algorithm
  • InputId Identifiers of input objects for the low order moments algorithm
  • PartialResultId Identifiers of partial result of the low order moments algorithm
  • ResultId Identifiers of the results of the low order moments algorithm

Constructor & Destructor Documentation

◆ Online() [1/2]

Online ( )
inline

Default constructor

◆ Online() [2/2]

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

Constructs and algorithm that computes moments of low order by copying input objects and parameters of another algorithm that computes moments of low order

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

Member Function Documentation

◆ clone()

services::SharedPtr<Online<algorithmFPType, method> > clone ( ) const
inline

Returns a pointer to the newly allocated algorithm that computes moments of low order with a copy of input objects of this algorithm

Returns
Pointer to the newly allocated algorithm

◆ getMethod()

virtual int getMethod ( ) const
inlinevirtual

Returns method of the algorithm

Returns
Method of the algorithm

Implements AlgorithmIface.

◆ getPartialResult()

PartialResultPtr getPartialResult ( )
inline

Returns the structure that contains partial results of the low order moments algorithm

Returns
Structure that contains partial results

◆ getResult()

ResultPtr getResult ( )
inline

Returns the structure that contains the results of the low order moments algorithm

Returns
Structure that contains the results

◆ setPartialResult()

services::Status setPartialResult ( const PartialResultPtr partialResult,
bool  initFlag = false 
)
inline

Registers user-allocated memory to store partial results of the low order momemnts algorithm

Parameters
[in]partialResultStructure for storing partial results of the low order moments algorithm
[in]initFlagFlag that specifies whether the partial results are initialized

◆ setResult()

services::Status setResult ( const ResultPtr result)
inline

Registers user-allocated memory to store final results of the low order moments algorithm

Parameters
[in]resultStructure for storing the results of the low order moments algorithm

Member Data Documentation

◆ input

InputType input

Input data structure

◆ parameter

ParameterType parameter

Parameters structure


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

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