-  3.41.0
matfaust::factparams::StoppingCriterion Class Reference

This class defines a StoppingCriterion for the FAuST's algorithms. More...

Public Member Functions

function display (self)
 Displays a StoppingCriterion instance. More...
 
function StoppingCriterion (varargin)
 Constructor. More...
 

Public Attributes

Property num_its
 see matfaust.factparams.StoppingCriterion More...
 
Property tol
 see matfaust.factparams.StoppingCriterion More...
 
Property maxiter
 see matfaust.factparams.StoppingCriterion More...
 
Property relerr
 see matfaust.factparams.StoppingCriterion More...
 
Property erreps
 see matfaust.factparams.StoppingCriterion More...
 
Constant Property DEFAULT_MAXITER = 10000
 
Constant Property DEFAULT_NUMITS = 500
 
Constant Property DEFAULT_TOL = .3
 

Detailed Description

This class defines a StoppingCriterion for the FAuST's algorithms.

A stopping criterion can be of two kinds:

- number of iterations,
- error treshold for the approximation of the matrix.

Constructor & Destructor Documentation

◆ StoppingCriterion()

function matfaust::factparams::StoppingCriterion::StoppingCriterion ( varargin  )

Constructor.

Parameters
'numits',intthe fixed number of iterations of the algorithm. By default the value is DEFAULT_NUMITS. If arguments num_its and tol are used together only the last one in the argument list is taken into account.
'tol',realerror target according to the algorithm is stopped. If arguments num_its and tol are used together only the last one in the argument list is taken into account.
'maxiter',intthe maximum number of iterations to run the algorithm, whatever is the criterion used (tol or num_its).
'relerr',boolfalse to define a absolute error with tol, true for a relative error (in this case the 'relmat' matrix will be used to convert internally the given 'tol' to the corresponding absolute error).
'relmat',matrixthe matrix against which is defined the relative error. if relerr is True, this argument is mandatory.

Example:

maxiter 10000:
tol: 0.500000
maxiter: 10000
>> s = StoppingCriterion('tol', .5)
tol: 0.500000
maxiter: 10000
>> s = StoppingCriterion('numits', 5)
num_its 500:
maxiter 10000:
>> s = StoppingCriterion('tol', .2, 'relerr', true, 'relmat', rand(10,10))
tol: 1.210149
maxiter: 10000

Member Function Documentation

◆ display()

function matfaust::factparams::StoppingCriterion::display ( self  )

Displays a StoppingCriterion instance.

Member Data Documentation

◆ DEFAULT_MAXITER

Constant Property matfaust::factparams::StoppingCriterion::DEFAULT_MAXITER = 10000

◆ DEFAULT_NUMITS

Constant Property matfaust::factparams::StoppingCriterion::DEFAULT_NUMITS = 500

◆ DEFAULT_TOL

Constant Property matfaust::factparams::StoppingCriterion::DEFAULT_TOL = .3

◆ erreps

Property matfaust::factparams::StoppingCriterion::erreps

◆ maxiter

Property matfaust::factparams::StoppingCriterion::maxiter

◆ num_its

Property matfaust::factparams::StoppingCriterion::num_its

◆ relerr

Property matfaust::factparams::StoppingCriterion::relerr

◆ tol

Property matfaust::factparams::StoppingCriterion::tol

The documentation for this class was generated from the following file:
matfaust::factparams::StoppingCriterion::StoppingCriterion
function StoppingCriterion(varargin)
Constructor.
matfaust::factparams::StoppingCriterion
This class defines a StoppingCriterion for the FAuST's algorithms.
Definition: StoppingCriterion.m:21
matfaust
The FAuST Matlab Wrapper
Definition: bsl.m:1
matfaust::rand
function rand(M, N, varargin)
Generates a random Faust.
matfaust::factparams::StoppingCriterion::num_its
Property num_its
see matfaust.factparams.StoppingCriterion
Definition: StoppingCriterion.m:26
matfaust::factparams::StoppingCriterion::maxiter
Property maxiter
see matfaust.factparams.StoppingCriterion
Definition: StoppingCriterion.m:32
matfaust::factparams::StoppingCriterion::relerr
Property relerr
see matfaust.factparams.StoppingCriterion
Definition: StoppingCriterion.m:35
matfaust::factparams::StoppingCriterion::tol
Property tol
see matfaust.factparams.StoppingCriterion
Definition: StoppingCriterion.m:29
matfaust::factparams
The module for the parametrization of FAuST's algorithms (Palm4MSA and Hierarchical Factorization)