Evolve::ExtremumInformation Class Reference

Infomation about an extremum of a function. More...

#include <OrbitSolver.h>

Collaboration diagram for Evolve::ExtremumInformation:

Public Member Functions
	ExtremumInformation (double x=Core::Inf, double y=Core::NaN)
	Create an object to hold information about a function extremum. More...
double	x () const
	The value of the argument where the extremum occurs. More...
double &	x ()
	The value of the argument where the extremum occurs. More...
double	y () const
	The value of the function at the extremum. More...
double &	y ()
	The value of the function at the extremum. More...

Private Attributes
double	__x
	The value of the argument where the extremum occurs. More...
double	__y
	The value of the function at the extremum. More...

Detailed Description

Infomation about an extremum of a function.

Definition at line 84 of file OrbitSolver.h.

Constructor & Destructor Documentation

ExtremumInformation()

Evolve::ExtremumInformation::ExtremumInformation ( double  x = Core::Inf, double  y = Core::NaN  )

inline

Create an object to hold information about a function extremum.

Parameters

x	The value of the argument where the extremum occurs.
y	The value of the function at the extremum.

Definition at line 93 of file OrbitSolver.h.

Member Function Documentation

x() [1/2]

double Evolve::ExtremumInformation::x ( ) const

inline

The value of the argument where the extremum occurs.

Definition at line 101 of file OrbitSolver.h.

x() [2/2]

double& Evolve::ExtremumInformation::x ( )

inline

The value of the argument where the extremum occurs.

Definition at line 103 of file OrbitSolver.h.

y() [1/2]

double Evolve::ExtremumInformation::y ( ) const

inline

The value of the function at the extremum.

Definition at line 106 of file OrbitSolver.h.

y() [2/2]

double& Evolve::ExtremumInformation::y ( )

inline

The value of the function at the extremum.

Definition at line 108 of file OrbitSolver.h.

Member Data Documentation

__x

double Evolve::ExtremumInformation::__x

private

The value of the argument where the extremum occurs.

Definition at line 87 of file OrbitSolver.h.

__y

double Evolve::ExtremumInformation::__y

private

The value of the function at the extremum.

Definition at line 87 of file OrbitSolver.h.

---

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

• /home/kpenev/projects/git/poet/poet_src/Evolve/OrbitSolver.h