com.numericalmethod.suanshu.analysis.function.matrix
Class R2toMatrix

java.lang.Object
  com.numericalmethod.suanshu.analysis.function.matrix.R2toMatrix

All Implemented Interfaces:

Function, RntoMatrix

Direct Known Subclasses:

AutoCorrelationFunction, AutoCovarianceFunction

public abstract class R2toMatrix
extends java.lang.Object
implements RntoMatrix

This abstract class represents a R² → Matrix space function. It takes two real arguments and outputs one matrix value. That is,

 M = f(x1, x2)
 

Nested Class Summary

Nested classes/interfaces inherited from interface com.numericalmethod.suanshu.analysis.function.Function

Function.EvaluationException

Constructor Summary

R2toMatrix()

Method Summary

int	dimension4Domain() Get the number of variables of the function.
int	dimension4Range() Get the dimension of the range space the function.
Matrix	evaluate(double... x) A RntoMatrix function, f, takes a double array double[], {x0, x1, ..., xn} and maps it to a Matrix, M = f(x0, x1, ..., xn)
abstract Matrix	evaluate(double x1, double x2) Compute f(x1, x2).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

R2toMatrix

public R2toMatrix()

Method Detail

dimension4Domain

public int dimension4Domain()

Description copied from interface: Function

Get the number of variables of the function.

For example, for a univariate function, the domain dimension is 1. For a bivariate function, the domain dimension is 2.

Specified by:

dimension4Domain in interface Function

Returns:

the number of variables

dimension4Range

public int dimension4Range()

Description copied from interface: Function

Get the dimension of the range space the function.

For example, for a Rn->Rm function, the dimension of the range is m.

Specified by:

dimension4Range in interface Function

Returns:

the dimension of the range

evaluate

public Matrix evaluate(double... x)

Description copied from interface: RntoMatrix

A RntoMatrix function, f, takes a double array double[],

{x0, x1, ..., xn}

and maps it to a Matrix,

M = f(x0, x1, ..., xn)

Specified by:

evaluate in interface RntoMatrix

Parameters:

x - {x} = {x0, x1, ... xn}

Returns:

M = f({x}) as output

evaluate

public abstract Matrix evaluate(double x1,
                                double x2)

Compute f(x1, x2).

Parameters:

x1 - x1

x2 - x2

Returns:

f(x1, x2)