mx::AO::analysis::clGainOpt< _realT >::optGainReport Struct Reference

template<typename _realT>
struct mx::AO::analysis::clGainOpt< _realT >::optGainReport

Diagnostic summary of an open-loop optimum-gain search.

Definition at line 108 of file clGainOpt.hpp.

#include <ao/analysis/clGainOpt.hpp>

Public Attributes
optGainStatus	status { optGainStatus::notRun }
	Search termination state.
uintmax_t	iterations { 0 }
	Minimizer iterations attempted.
size_t	evaluations { 0 }
	Objective evaluations performed.
realT	requestedMaximumGain { std::numeric_limits<realT>::quiet_NaN() }
	Caller-supplied gain limit.
realT	searchMinimumGain { std::numeric_limits<realT>::quiet_NaN() }
	Final minimizer lower bound.
realT	searchMaximumGain { std::numeric_limits<realT>::quiet_NaN() }
	Final minimizer upper bound.
realT	minimumEvaluatedGain { std::numeric_limits<realT>::quiet_NaN() }
	Smallest evaluated gain.
realT	maximumEvaluatedGain { std::numeric_limits<realT>::quiet_NaN() }
	Largest evaluated gain.
realT	gain { std::numeric_limits<realT>::quiet_NaN() }
	Best gain returned by the minimizer.
realT	variance { std::numeric_limits<realT>::quiet_NaN() }
	Variance at the best gain.
maxStableGainReport	stability
	Automatic stability-search diagnostics, when requested.

Member Data Documentation

evaluations

template<typename _realT>

size_t mx::AO::analysis::clGainOpt< _realT >::optGainReport::evaluations { 0 }

Objective evaluations performed.

Definition at line 112 of file clGainOpt.hpp.

Referenced by mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

gain

template<typename _realT>

realT mx::AO::analysis::clGainOpt< _realT >::optGainReport::gain { std::numeric_limits<realT>::quiet_NaN() }

Best gain returned by the minimizer.

Definition at line 118 of file clGainOpt.hpp.

Referenced by mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

iterations

template<typename _realT>

uintmax_t mx::AO::analysis::clGainOpt< _realT >::optGainReport::iterations { 0 }

Minimizer iterations attempted.

Definition at line 111 of file clGainOpt.hpp.

Referenced by mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

maximumEvaluatedGain

template<typename _realT>

realT mx::AO::analysis::clGainOpt< _realT >::optGainReport::maximumEvaluatedGain { std::numeric_limits<realT>::quiet_NaN() }

Largest evaluated gain.

Definition at line 117 of file clGainOpt.hpp.

Referenced by mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

minimumEvaluatedGain

template<typename _realT>

realT mx::AO::analysis::clGainOpt< _realT >::optGainReport::minimumEvaluatedGain { std::numeric_limits<realT>::quiet_NaN() }

Smallest evaluated gain.

Definition at line 116 of file clGainOpt.hpp.

Referenced by mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

requestedMaximumGain

template<typename _realT>

realT mx::AO::analysis::clGainOpt< _realT >::optGainReport::requestedMaximumGain { std::numeric_limits<realT>::quiet_NaN() }

Caller-supplied gain limit.

Definition at line 113 of file clGainOpt.hpp.

Referenced by mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

searchMaximumGain

template<typename _realT>

realT mx::AO::analysis::clGainOpt< _realT >::optGainReport::searchMaximumGain { std::numeric_limits<realT>::quiet_NaN() }

Final minimizer upper bound.

Definition at line 115 of file clGainOpt.hpp.

Referenced by mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

searchMinimumGain

template<typename _realT>

realT mx::AO::analysis::clGainOpt< _realT >::optGainReport::searchMinimumGain { std::numeric_limits<realT>::quiet_NaN() }

Final minimizer lower bound.

Definition at line 114 of file clGainOpt.hpp.

Referenced by mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

stability

template<typename _realT>

maxStableGainReport mx::AO::analysis::clGainOpt< _realT >::optGainReport::stability

Automatic stability-search diagnostics, when requested.

Definition at line 120 of file clGainOpt.hpp.

Referenced by mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

status

template<typename _realT>

optGainStatus mx::AO::analysis::clGainOpt< _realT >::optGainReport::status { optGainStatus::notRun }

Search termination state.

Definition at line 110 of file clGainOpt.hpp.

Referenced by mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop(), and mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

variance

template<typename _realT>

realT mx::AO::analysis::clGainOpt< _realT >::optGainReport::variance { std::numeric_limits<realT>::quiet_NaN() }

Variance at the best gain.

Definition at line 119 of file clGainOpt.hpp.

Referenced by mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

---

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

• ao/analysis/clGainOpt.hpp