Thyra Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Related Symbols | List of all members

Solve tolerance type. More...

#include <Thyra_SolveSupportTypes.hpp>

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 Symbols

(Note that these are not member symbols.)

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 112 of file Thyra_SolveSupportTypes.hpp.

Constructor & Destructor Documentation

◆ SolveMeasureType() [1/2]

Thyra::SolveMeasureType::SolveMeasureType ( )
inline

Definition at line 118 of file Thyra_SolveSupportTypes.hpp.

◆ SolveMeasureType() [2/2]

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

Definition at line 122 of file Thyra_SolveSupportTypes.hpp.

Member Function Documentation

◆ set()

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

Definition at line 126 of file Thyra_SolveSupportTypes.hpp.

◆ useDefault()

bool Thyra::SolveMeasureType::useDefault ( ) const
inline

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

Definition at line 131 of file Thyra_SolveSupportTypes.hpp.

◆ operator()()

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

Return if (numerator,denominataor) matches this.

Definition at line 134 of file Thyra_SolveSupportTypes.hpp.

◆ contains()

bool Thyra::SolveMeasureType::contains ( ESolveMeasureNormType measure) const
inline

\breif Return if single measure matches numerator or denominator.

Definition at line 139 of file Thyra_SolveSupportTypes.hpp.

Friends And Related Symbol Documentation

◆ operator<<()

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

Output operator.

Definition at line 149 of file Thyra_SolveSupportTypes.hpp.

Member Data Documentation

◆ numerator

ESolveMeasureNormType Thyra::SolveMeasureType::numerator

Definition at line 114 of file Thyra_SolveSupportTypes.hpp.

◆ denominator

ESolveMeasureNormType Thyra::SolveMeasureType::denominator

Definition at line 116 of file Thyra_SolveSupportTypes.hpp.


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