edu.rit.numeric

Interface VectorFunction

All Known Implementing Classes:

SpinSignalDifference

public interface VectorFunction

Interface VectorFunction specifies the interface for a function whose argument is a vector of real values and whose result is a vector of real values.

Method Summary

Modifier and Type	Method and Description
int	argumentLength() Returns the length of the argument vector, N.
void	df(double[] x, double[][] dydx) Calculate this function's Jacobian matrix with the given argument vector.
void	f(double[] x, double[] y) Evaluate this function with the given argument vector.
int	resultLength() Returns the length of the result vector, M.

Method Detail

resultLength

int resultLength()

Returns the length of the result vector, M.

Returns:

M.

argumentLength

int argumentLength()

Returns the length of the argument vector, N.

Returns:

N.

f

void f(double[] x,
       double[] y)

Evaluate this function with the given argument vector. The result is stored in the vector y. Specifically, for i = 0 to M−1, y_i = f_i(x).

Parameters:

x - Argument vector (input). Must be an N-element array.

y - Result vector (output). Must be an M-element array.

Throws:

DomainException - (unchecked exception) Thrown if any argument in x is outside the allowed set of values for this function.

RangeException - (unchecked exception) Thrown if any element of the result vector is outside the range of type double.

df

void df(double[] x,
        double[][] dydx)

Calculate this function's Jacobian matrix with the given argument vector. The result is stored in the matrix dydx. Specifically, for i = 0 to M−1 and j = 0 to N−1, dydx_i,j = ∂f_i(x) ⁄ ∂x_j .

Parameters:

x - Argument vector (input). Must be an N-element array.

dydx - Jacobian matrix (output). Must be an M×N-element matrix.

Throws:

DomainException - (unchecked exception) Thrown if any argument in x is outside the allowed set of values for this function.

RangeException - (unchecked exception) Thrown if any element of the Jacobian matrix is outside the range of type double.