AnimaL

Tutorial

Documentation

---

Documentation

• Overview
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Compound List
• File List
• Namespace Members
• Compound Members
• File Members
• Examples

---

nr::dlinmin< TraitsT > Struct Template Reference

#include <dlinmin.h>

List of all members.

---

Detailed Description

template<class TraitsT = Old_Traits<>>
struct nr::dlinmin< TraitsT >

Minimization of an n-dimensional function along a given line, using information on gradient.

The constructor performs the minimization.

Examples:

optimization_N_test.cpp.

Definition at line 13 of file dlinmin.h.

Public Types
typedef TraitsT	Traits
	Traits.
typedef Traits::Real	Real
	Floating point value.
typedef Traits::Vector	Vector
	Vector.
Public Member Functions
Constructor
template<class Func, class DFunc>	dlinmin (Vector &p, Vector &xi, unsigned int n, Real *fret, Func(*func), DFunc(*dfunc), Real TOL=2.0e-4)
	Given an n-dimensional point p[0..n-1] and an n-dimensional direction xi[0..n-1], moves and resets p to where the function takes on a minimum along the direction xi from p, and replaces xi by the actual vector displacement that p was moved.
Private Attributes
Vector	pcom
	auxiliary vector
Vector	xicom
	auxiliary vector
Vector	xt
	auxiliary vector
Vector	df
	auxiliary vector
unsigned int	n
	size of the vectors

---

Member Typedef Documentation

template<class TraitsT = Old_Traits<>> typedef Traits::Real nr::dlinmin< TraitsT >::Real

Floating point value. Definition at line 19 of file dlinmin.h.

template<class TraitsT = Old_Traits<>> typedef TraitsT nr::dlinmin< TraitsT >::Traits

Traits. Definition at line 17 of file dlinmin.h.

template<class TraitsT = Old_Traits<>> typedef Traits::Vector nr::dlinmin< TraitsT >::Vector

Vector. Definition at line 21 of file dlinmin.h.

---

Constructor & Destructor Documentation

template<class TraitsT = Old_Traits<>> template<class Func, class DFunc> nr::dlinmin< TraitsT >::dlinmin (  Vector &  p, Vector &  xi, unsigned int  n, Real *  fret, Func *  func, DFunc *  dfunc, Real  TOL = 2.0e-4 )  [inline]

Given an n-dimensional point p[0..n-1] and an n-dimensional direction xi[0..n-1], moves and resets p to where the function takes on a minimum along the direction xi from p, and replaces xi by the actual vector displacement that p was moved. Also returns as fret the value of the function at the returned location p. This is actually all accomplished by calling the routines mnbrak and dbrent. Template Func must be similar with Real( Vector ) Template DFunc must be similar with void( Vector location, Vector gradient ) Definition at line 32 of file dlinmin.h. References nr::dbrent(), and nr::mnbrak().

---

Member Data Documentation

template<class TraitsT = Old_Traits<>> Vector nr::dlinmin< TraitsT >::df [private]

auxiliary vector Definition at line 86 of file dlinmin.h.

template<class TraitsT = Old_Traits<>> unsigned int nr::dlinmin< TraitsT >::n [private]

size of the vectors Definition at line 87 of file dlinmin.h.

template<class TraitsT = Old_Traits<>> Vector nr::dlinmin< TraitsT >::pcom [private]

auxiliary vector Definition at line 83 of file dlinmin.h.

template<class TraitsT = Old_Traits<>> Vector nr::dlinmin< TraitsT >::xicom [private]

auxiliary vector Definition at line 84 of file dlinmin.h.

template<class TraitsT = Old_Traits<>> Vector nr::dlinmin< TraitsT >::xt [private]

auxiliary vector Definition at line 85 of file dlinmin.h.

---

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

• dlinmin.h

---