C:/Users/kurt/normark/c/trying-2010/doxygen/root-c-doc-1-doxy.c File Reference

#include <stdio.h>
#include <math.h>

Go to the source code of this file.

Functions
double	f (double x)
	The function in which we search for a root.
int	sameSign (double x, double y)
	Return whether x and y have the same sign.
double	middleOf (double x, double y)
	Return the mid point in between x and y.
int	isSmallNumber (double x)
	Is x considered to be very close to 0.0.
double	findRootBetween (double l, double u)
	Search for a root of the continuous function f between the parameters l and u.
int	main (void)
	A sample interactive driver of the root searching for f.

---

Function Documentation

double f

(

double

x

)

The function in which we search for a root.

Parameters:

[in]

x

The input to the function f.

Definition at line 12 of file root-c-doc-1-doxy.c.

Here is the caller graph for this function:

double findRootBetween	(	double	l,
		double	u
	)

Search for a root of the continuous function f between the parameters l and u.

A root is a double r for which f(r) is very close to 0.0.

Parameters:

[in]	l	The lower limit of the interval in which to search for a root.
[in]	u	The upper limit of the interval in which to search for a root.

Returns:

The x-value r for which f(x) is close to zero.

Precondition:

The sign of f(l) and f(u) are different.

Definition at line 45 of file root-c-doc-1-doxy.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int isSmallNumber

(

double

x

)

Is x considered to be very close to 0.0.

Parameters:

[in]

x

The input to be evaluated.

Returns:

A boolean represented as an int in C (false = zero, true = non zero).

Definition at line 35 of file root-c-doc-1-doxy.c.

Here is the caller graph for this function:

int main

(

void

)

A sample interactive driver of the root searching for f.

Definition at line 56 of file root-c-doc-1-doxy.c.

Here is the call graph for this function:

double middleOf	(	double	x,
		double	y
	)

Return the mid point in between x and y.

Parameters:

[in]	x	The first double.
[in]	y	The second double.

Definition at line 28 of file root-c-doc-1-doxy.c.

Here is the caller graph for this function:

int sameSign	(	double	x,
		double	y
	)

Return whether x and y have the same sign.

Parameters:

[in]	x	The first double the sign of which is to be compared with y.
[in]	y	The second double the sign of which is to be compared with x.

Returns:

A boolean represented as an int in C (false = zero, true = non zero).

Definition at line 21 of file root-c-doc-1-doxy.c.

Here is the caller graph for this function: