Documentation

nr::frprmn< TraitsT >::TooManyIterations Struct Reference

#include <frprmn.h>

List of all members.

Detailed Description

template<class TraitsT = Old_Traits<>>
struct nr::frprmn< TraitsT >::TooManyIterations

Exception thrown when the maximum number of iterations is reached.

Definition at line 113 of file frprmn.h.

Public Member Functions

 TooManyIterations (unsigned int n, Real f)
 Constructor.

Member method used to display the exception:
void print (std::ostream &str) const
 Print exception on output stream str.


Public Attributes

unsigned int nbIterations
 number of iterations

Real functionValue
 current value of the function

Constructor & Destructor Documentation

template<class TraitsT = Old_Traits<>>
nr::frprmn< TraitsT >::TooManyIterations::TooManyIterations (  unsigned int  n,
Real  f
)  [inline]
 

Constructor.

Definition at line 119 of file frprmn.h.

References nr::frprmn< TraitsT >::TooManyIterations::functionValue.

Member Function Documentation

template<class TraitsT = Old_Traits<>>
void nr::frprmn< TraitsT >::TooManyIterations::print (  std::ostream &  str  )  const [inline]
 

Print exception on output stream str.

Definition at line 128 of file frprmn.h.

References nr::frprmn< TraitsT >::TooManyIterations::functionValue.

Member Data Documentation

template<class TraitsT = Old_Traits<>>
Real nr::frprmn< TraitsT >::TooManyIterations::functionValue
 

current value of the function

Definition at line 116 of file frprmn.h.

Referenced by nr::frprmn< TraitsT >::TooManyIterations::print(), and nr::frprmn< TraitsT >::TooManyIterations::TooManyIterations().

template<class TraitsT = Old_Traits<>>
unsigned int nr::frprmn< TraitsT >::TooManyIterations::nbIterations
 

number of iterations

Definition at line 115 of file frprmn.h.

The documentation for this struct was generated from the following file:
Generated on Thu Dec 23 13:52:34 2004 by doxygen 1.3.6