Main Page Namespace List Class Hierarchy Compound List File List Header Files Sources Namespace Members Compound Members File Members

func::multi_dimensional_with_derivatives Class Reference

A continuous function that maps a vector to a real number. More...

#include <func.h>

Class diagram for func::multi_dimensional_with_derivatives:

List of all members.

Public Members
		virtual double	operator() ( const vector<double> &x ) const = 0
			Calculate the function for a given argument. More...
		virtual void	evaluate ( const vector<double> &x, double &f, vector<double> &gradient ) const = 0
			Calculate the function and its derivatives for a given argument. More...

Detailed Description

A continuous function that maps a vector to a real number.

The class provides additional member functions for calculating the derivative of the function.

Definition at line 196 of file func.h.

Member Function Documentation

virtual double func::multi_dimensional_with_derivatives::operator() (const vector<double>& x) const [pure virtual]

Calculate the function for a given argument.

Parameters:

x	the argument for which the function is to be calculated

Returns:: The value of the function for argument x.

Reimplemented from func::multi_dimensional.

Reimplemented in test::mag2, test::vecone, and total_energy_function.

virtual void func::multi_dimensional_with_derivatives::evaluate (const vector<double>& x, double & e, vector<double>& gradient) const [pure virtual]

Calculate the function and its derivatives for a given argument.

Parameters:

x	the argument for which the function is to be calculated

Return values:

f	the value of the function for argument x
gradient	the derivative of the function for argument x

Reimplemented in test::mag2, test::vecone, and total_energy_function.

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

func.h

Generated at Sun Jul 14 20:38:19 2002 for Mapper by

1.0.0 written by Dimitri van Heesch, © 1997-1999