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

Static Public Member Functions | List of all members
Batch< algorithmFPType, method > Class Template Reference

Computes Stochastic average gradient descent in the batch processing mode. More...

Static Public Member Functions

static services::SharedPtr
< Batch< algorithmFPType,
method > > 
create ()
 

Class Declaration

template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
class daal::algorithms::optimization_solver::saga::interface2::Batch< algorithmFPType, method >

Template Parameters
algorithmFPTypeData type to use in intermediate computations for the Stochastic average gradient descent algorithm, double or float
methodStochastic average gradient descent computation method
Enumerations

Constructor & Destructor Documentation

Batch ( const sum_of_functions::BatchPtr &  objectiveFunction = sum_of_functions::BatchPtr())

Default constructor

Batch ( const Batch< algorithmFPType, method > &  other)

Constructs a Stochastic average gradient descent algorithm by copying input objects of another Stochastic average gradient descent 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::SharedPtr<Batch<algorithmFPType, method> > clone ( ) const
inline

Returns a pointer to the newly allocated Stochastic average gradient descent algorithm with a copy of input objects of this Stochastic average gradient descent algorithm

Returns
Pointer to the newly allocated algorithm
static services::SharedPtr<Batch<algorithmFPType, method> > create ( )
static

Creates the instance of the class

Returns
New instance of the class
virtual services::Status createResult ( )
inlinevirtual

Creates user-allocated memory to store results of the iterative solver algorithm

Returns
Status of computations
virtual iterative_solver::Input* getInput ( )
inlinevirtual

Get input objects for the iterative solver algorithm

Returns
Input objects for the iterative solver algorithm
virtual int getMethod ( ) const
inlinevirtual

Returns method of the algorithm

Returns
Method of the algorithm
virtual iterative_solver::Parameter* getParameter ( )
inlinevirtual

Get parameters of the iterative solver algorithm

Returns
Parameters of the iterative solver algorithm
ParameterType& parameter ( )
inline

Gets parameter of the algorithm

Returns
parameter of the algorithm
const ParameterType& parameter ( ) const
inline

Gets parameter of the algorithm

Returns
parameter of the algorithm

Member Data Documentation

InputType input

Input data structure


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

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