Ginkgo: gko::stop::CriterionArgs Struct Reference

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
gko::stop::CriterionArgs Struct Reference

This struct is used to pass parameters to the EnableDefaultCriterionFactoryCriterionFactory::generate() method. More...

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

Collaboration diagram for gko::stop::CriterionArgs:
[legend]

## 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 LinOp > | system_matrix
std::shared_ptr< const LinOp > | b
const LinOp * | x
const LinOp * | initial_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:

- ginkgo/core/stop/criterion.hpp