iterative_method Class Reference

#include <iterativemethod.h>

Inheritance diagram for iterative_method:

List of all members.

Public Member Functions
	iterative_method (unsigned int iterations=100, double relative_error=1.0e-10)
unsigned int	maximum_iterations () const
void	maximum_iterations (unsigned int iterations)
double	maximum_relative_error () const
void	maximum_relative_error (double relative_error)

---

Detailed Description

A method to solve generic problems by finding successive (and hopefully better) approximations to the solution.

---

Constructor & Destructor Documentation

iterative_method::iterative_method	(	unsigned int	iterations = 100,
		double	relative_error = 1.0e-10
	)			[inline]

Construct an iterative method using the given maximum relative error and maximum number of iterations.

Parameters:

	iterations	maximum number of iterations.
	relative_error	maximum relative error.

---

Member Function Documentation

unsigned int iterative_method::maximum_iterations

(

)

const [inline]

Access the maximum number of iterations.

Returns:

the maximum number of iterations.

void iterative_method::maximum_iterations

(

unsigned int

iterations

)

[inline]

Modify the maximum number of iterations.

Parameters:

iterations

the new maximum number of iterations.

double iterative_method::maximum_relative_error

(

)

const [inline]

Access the maximum relative error.

Returns:

the maximum relative error.

void iterative_method::maximum_relative_error

(

double

relative_error

)

[inline]

Modify the maximum relative error.

Parameters:

relative_error

the new maximum relative error.

---

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

• src/main/cpp/numerics4cpp/iterativemethod.h

---