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

List of all members
Parameter Struct Reference

Parameter base class for the iterative solver algorithm More...

Class Declaration

struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
{
Parameter(const sum_of_functions::BatchPtr &function_, size_t nIterations_ = 100,
double accuracyThreshold_ = 1.0e-05, bool optionalResultReq_ = false, size_t batchSize_ = 1);
Parameter(const Parameter &other);
virtual ~Parameter() {}
virtual services::Status check() const;
sum_of_functions::BatchPtr function;
size_t nIterations;
size_t batchSize;
};

Constructor & Destructor Documentation

Parameter ( const sum_of_functions::BatchPtr &  function_,
size_t  nIterations_ = 100,
double  accuracyThreshold_ = 1.0e-05,
bool  optionalResultReq_ = false,
size_t  batchSize_ = 1 
)

Constructs the parameter base class of the iterative solver algorithm

Parameters
[in]function_Objective function represented as sum of functions
[in]nIterations_Maximal number of iterations of the algorithm
[in]accuracyThreshold_Accuracy of the algorithm. The algorithm terminates when this accuracy is achieved
[in]optionalResultReq_Flag indicating if algorithm-specific result data generation is needed
[in]batchSize_Batch size
Parameter ( const Parameter other)

Constructs an Parameter by copying input objects and parameters of another Parameter

Parameters
[in]otherAn object to be used as the source to initialize object

Member Function Documentation

virtual services::Status check ( ) const
virtual

Checks the correctness of the parameter

Returns
Status of computations

Member Data Documentation

double accuracyThreshold

Accuracy of the algorithm. The algorithm terminates when this accuracy is achieved

size_t batchSize

Number of batch indices to compute the stochastic gradient. If batchSize is equal to the number of terms in objective function then no random sampling is performed, and all terms are used to calculate the gradient. This parameter is ignored if batchIndices is provided.

sum_of_functions::BatchPtr function

Objective function represented as sum of functions

size_t nIterations

Maximal number of iterations of the algorithm

bool optionalResultRequired

Indicates whether optional result is required


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

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