dev.nm.analysis.function.matrix

Class R2toMatrix

java.lang.Object

dev.nm.analysis.function.matrix.R2toMatrix

All Implemented Interfaces:

Function<Vector,Matrix>, RntoMatrix

Direct Known Subclasses:

MultivariateAutoCorrelationFunction, MultivariateAutoCovarianceFunction

public abstract class R2toMatrix
extends Object
implements RntoMatrix

This is a function that maps from \(R^{2}\) to a Matrix space. It takes two real arguments and outputs one matrix value. That is, \[ f(x_1, x_2) = A \]

Nested Class Summary

Nested classes/interfaces inherited from interface dev.nm.analysis.function.Function

Function.EvaluationException

Constructor Summary

Constructors

Constructor and Description
R2toMatrix()

Method Summary

Modifier and Type	Method and Description
int	dimensionOfDomain() Get the number of variables the function has.
int	dimensionOfRange() Get the dimension of the range space of the function.
abstract Matrix	evaluate(double x1, double x2) Evaluate \(f(x_{1}, x_{2}) = A\).
Matrix	evaluate(Vector x) Evaluate the function f at x, where x is from the domain.

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

dimensionOfDomain

public int dimensionOfDomain()

Description copied from interface: Function

Get the number of variables the function has. For example, for a univariate function, the domain dimension is 1; for a bivariate function, the domain dimension is 2.

Specified by:

dimensionOfDomain in interface Function<Vector,Matrix>

Returns:

the number of variables

dimensionOfRange

public int dimensionOfRange()

Description copied from interface: Function

Get the dimension of the range space of the function. For example, for a \(R^{n}\to R^{m}\) function, the dimension of the range is m.

Specified by:

dimensionOfRange in interface Function<Vector,Matrix>

Returns:

the dimension of the range

evaluate

public Matrix evaluate(Vector x)

Description copied from interface: Function

Evaluate the function f at x, where x is from the domain.

Specified by:

evaluate in interface Function<Vector,Matrix>

Parameters:

x - x

Returns:

f(x)

evaluate

public abstract Matrix evaluate(double x1,
                                double x2)

Evaluate \(f(x_{1}, x_{2}) = A\).

Parameters:

x1 - x1

x2 - x2

Returns:

f(x1, x2)