Mundy: Multibody Nonlocal Dynamics Version of the Day
Loading...
Searching...
No Matches
mundy::PGDResult< Scalar > Struct Template Reference

Result of a projected-gradient solve: iteration count, final residual, and whether it converged. More...

#include <pgd.hpp>

Inheritance diagram for mundy::PGDResult< Scalar >:
[legend]

Public Types

using value_type = Scalar

Public Attributes

unsigned num_iters {0}
Scalar residual {0}
bool converged {false}

Detailed Description

template<class Scalar>
struct mundy::PGDResult< Scalar >

This is the result type of the PGD method, not of any one problem. Every problem PGD solves (CQPP, and LCP via reduction) reports its solve as a PGDResult; a different method would define its own result type.

Member Typedef Documentation

◆ value_type

template<class Scalar>
using mundy::PGDResult< Scalar >::value_type = Scalar

Member Data Documentation

◆ num_iters

template<class Scalar>
unsigned mundy::PGDResult< Scalar >::num_iters {0}

◆ residual

template<class Scalar>
Scalar mundy::PGDResult< Scalar >::residual {0}

◆ converged

template<class Scalar>
bool mundy::PGDResult< Scalar >::converged {false}