MathOpt::UzawaResult Struct Reference

Result for Uzawa constrained optimization. More...

#include <MathOpt_Uzawa.hxx>

Public Member Functions
bool	IsDone () const
	operator bool () const

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
std::optional< math_Vector >	Solution
	Solution vector X.
std::optional< math_Vector >	Dual
	Dual (Lagrange) variables.
std::optional< math_Vector >	Error
	X - X0 (difference from starting point)
std::optional< math_Vector >	InitialError
	C*X0 - S (initial constraint violation)
std::optional< math_Matrix >	InverseCTC
	(C * C^T)^-1 for gradient computation
int	NbIterations = 0

Detailed Description

Result for Uzawa constrained optimization.

Member Function Documentation

IsDone()

bool MathOpt::UzawaResult::IsDone ( ) const

inline

operator bool()

MathOpt::UzawaResult::operator bool ( ) const

inlineexplicit

Field Documentation

Dual

std::optional<math_Vector> MathOpt::UzawaResult::Dual

Dual (Lagrange) variables.

Error

std::optional<math_Vector> MathOpt::UzawaResult::Error

X - X0 (difference from starting point)

InitialError

std::optional<math_Vector> MathOpt::UzawaResult::InitialError

C*X0 - S (initial constraint violation)

InverseCTC

std::optional<math_Matrix> MathOpt::UzawaResult::InverseCTC

(C * C^T)^-1 for gradient computation

NbIterations

int MathOpt::UzawaResult::NbIterations = 0

Solution

std::optional<math_Vector> MathOpt::UzawaResult::Solution

Solution vector X.

Status

MathUtils::Status MathOpt::UzawaResult::Status = MathUtils::Status::NotConverged

---

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

• MathOpt_Uzawa.hxx