umontreal.ssj.functions.AverageMathFunction Class Reference

Represents a function computing the average of several functions. More...

Inheritance diagram for umontreal.ssj.functions.AverageMathFunction:

Public Member Functions
	AverageMathFunction (MathFunction... func)
	Constructs a function computing the average of the functions in the array func.
MathFunction[]	getFunctions ()
	Returns the functions being averaged.
double	evaluate (double x)
	Returns the value of the function evaluated at \(x\).
double	derivative (double x, int n)
	Computes (or estimates) the \(n\)th derivative of the function at point x.
double	derivative (double x)
	Computes (or estimates) the first derivative of the function at point x.
double	integral (double a, double b)
	Computes (or estimates) the integral of the function over the interval \([a, b]\).

Detailed Description

Represents a function computing the average of several functions.

Let \(f_0(x), …, f_{n-1}(x)\) be a set of \(n\) functions. This function represents the average

\[ f(x)=\frac{1}{n}\sum_{i=0}^{n-1} f_i(x). \]

Definition at line 33 of file AverageMathFunction.java.

Constructor & Destructor Documentation

AverageMathFunction()

umontreal.ssj.functions.AverageMathFunction.AverageMathFunction

(

MathFunction...

func

)

Constructs a function computing the average of the functions in the array func.

Parameters

func	the array of functions to average.

Definition at line 44 of file AverageMathFunction.java.

Member Function Documentation

derivative() [1/2]

double umontreal.ssj.functions.AverageMathFunction.derivative

(

double

x

)

Computes (or estimates) the first derivative of the function at point x.

Parameters

x	the point to evaluate the derivative to.

Returns

the value of the derivative.

Implements umontreal.ssj.functions.MathFunctionWithFirstDerivative.

Definition at line 77 of file AverageMathFunction.java.

derivative() [2/2]

double umontreal.ssj.functions.AverageMathFunction.derivative	(	double	x,
		int	n )

Computes (or estimates) the \(n\)th derivative of the function at point x.

For \(n=0\), this returns the result of umontreal.ssj.functions.MathFunction.evaluate(double).

Parameters

x	the point to evaluate the derivate to.
n	the order of the derivative.

Returns

the resulting derivative.

Exceptions

IllegalArgumentException

if `n` is negative or 0.

Implements umontreal.ssj.functions.MathFunctionWithDerivative.

Definition at line 66 of file AverageMathFunction.java.

evaluate()

double umontreal.ssj.functions.AverageMathFunction.evaluate

(

double

x

)

Returns the value of the function evaluated at \(x\).

Parameters

x	value at which the function is evaluated

Returns

function evaluated at x

Implements umontreal.ssj.functions.MathFunction.

Definition at line 59 of file AverageMathFunction.java.

getFunctions()

MathFunction[] umontreal.ssj.functions.AverageMathFunction.getFunctions

(

)

Returns the functions being averaged.

Returns

the averaged functions.

Definition at line 55 of file AverageMathFunction.java.

integral()

double umontreal.ssj.functions.AverageMathFunction.integral	(	double	a,
		double	b )

Computes (or estimates) the integral of the function over the interval \([a, b]\).

Parameters

a	the starting point of the interval.
b	the ending point of the interval.

Returns

the value of the integral.

Implements umontreal.ssj.functions.MathFunctionWithIntegral.

Definition at line 84 of file AverageMathFunction.java.

---

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

• src/main/java/umontreal/ssj/functions/AverageMathFunction.java