Thyra::SolveMeasureType Struct Reference

Solve tolerance type. More...

#include <Thyra_SolveSupportTypes.hpp>

List of all members.

Public Member Functions
	SolveMeasureType ()
	SolveMeasureType (ESolveMeasureNormType _numerator, ESolveMeasureNormType _denominator)
void	set (ESolveMeasureNormType _numerator, ESolveMeasureNormType _denominator)
bool	useDefault () const
	Return if this is a default solve measure (default constructed).
bool	operator() (ESolveMeasureNormType numerator_in, ESolveMeasureNormType denominator_in) const
	Return if (numerator,denominataor) matches this.
bool	contains (ESolveMeasureNormType measure) const
Public Attributes
ESolveMeasureNormType	numerator
ESolveMeasureNormType	denominator
Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &out, const SolveMeasureType &solveMeasureType)
	Output operator.

---

Detailed Description

Solve tolerance type.

This represents the solve tolerance measure of the form:

 (numerator)/(denominator)
 

Note that numerator==SOLVE_MEASURE_ONE&&denominator==SOLVE_MEASURE_ONE (i.e. 1/1) means that there is no solve measure type specified.

Definition at line 99 of file Thyra_SolveSupportTypes.hpp.

---

Constructor & Destructor Documentation

Thyra::SolveMeasureType::SolveMeasureType

(

)

[inline]

Definition at line 105 of file Thyra_SolveSupportTypes.hpp.

Thyra::SolveMeasureType::SolveMeasureType	(	ESolveMeasureNormType	_numerator,
		ESolveMeasureNormType	_denominator
	)		[inline]

Definition at line 109 of file Thyra_SolveSupportTypes.hpp.

---

Member Function Documentation

void Thyra::SolveMeasureType::set	(	ESolveMeasureNormType	_numerator,
		ESolveMeasureNormType	_denominator
	)		[inline]

Definition at line 113 of file Thyra_SolveSupportTypes.hpp.

References denominator, and numerator.

bool Thyra::SolveMeasureType::useDefault

(

)

const [inline]

Return if this is a default solve measure (default constructed).

Definition at line 118 of file Thyra_SolveSupportTypes.hpp.

References denominator, numerator, and Thyra::SOLVE_MEASURE_ONE.

Referenced by Thyra::DampenedNewtonNonlinearSolver< Scalar >::solve(), and Thyra::LinearOpWithSolveBase< Scalar >::solveSupportsSolveMeasureTypeImpl().

bool Thyra::SolveMeasureType::operator()	(	ESolveMeasureNormType	numerator_in,
		ESolveMeasureNormType	denominator_in
	)		const [inline]

Return if (numerator,denominataor) matches this.

Definition at line 121 of file Thyra_SolveSupportTypes.hpp.

References denominator, and numerator.

bool Thyra::SolveMeasureType::contains

(

ESolveMeasureNormType

measure

)

const [inline]

Return if single measure matches numerator or denominator.

Definition at line 126 of file Thyra_SolveSupportTypes.hpp.

References denominator, and numerator.

---

Friends And Related Function Documentation

std::ostream & operator<<	(	std::ostream &	out,
		const SolveMeasureType &	solveMeasureType
	)		[related]

Output operator.

Definition at line 136 of file Thyra_SolveSupportTypes.hpp.

References denominator, numerator, and Thyra::toString().

---

Member Data Documentation

ESolveMeasureNormType Thyra::SolveMeasureType::numerator

Definition at line 101 of file Thyra_SolveSupportTypes.hpp.

Referenced by Thyra::assertSupportsSolveMeasureType(), contains(), operator()(), operator<<(), set(), Thyra::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL(), and useDefault().

ESolveMeasureNormType Thyra::SolveMeasureType::denominator

Definition at line 103 of file Thyra_SolveSupportTypes.hpp.

Referenced by Thyra::assertSupportsSolveMeasureType(), contains(), operator()(), operator<<(), set(), Thyra::TEUCHOS_UNIT_TEST_TEMPLATE_1_DECL(), and useDefault().

---

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

• Thyra_SolveSupportTypes.hpp