CriterionArgs Struct Reference

CriterionArgs Struct Reference#

Reference API: gko::stop::CriterionArgs Struct Reference
Reference API
gko::stop::CriterionArgs Struct Reference

#include <ginkgo/core/stop/criterion.hpp>

Public Member Functions

 CriterionArgs (std::shared_ptr< const LinOp > system_matrix, std::shared_ptr< const LinOp > b, const LinOp *x, const LinOp *initial_residual=nullptr)
 

Public Attributes

std::shared_ptr< const LinOpsystem_matrix
 
std::shared_ptr< const LinOpb
 
const LinOpx
 
const LinOpinitial_residual
 

Detailed Description

This struct is used to pass parameters to the EnableDefaultCriterionFactoryCriterionFactory::generate() method. It is the ComponentsType of CriterionFactory.

Note
Dependly on the use case, some of these parameters can be nullptr as only some stopping criterion require them to be set. An example is the ResidualNormReduction which really requires the initial_residual to be set.

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