# SuanShu, a Java numerical and statistical library

## com.numericalmethod.suanshu.analysis.function.matrix Class R1toMatrix

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

All Implemented Interfaces:
Function<Vector,Matrix>, RntoMatrix
Direct Known Subclasses:
R1toConstantMatrix

public abstract class R1toMatrixextends Objectimplements RntoMatrix

This is a function that maps from R1 to a Matrix space. It takes one real argument and outputs one matrix value. That is, /[ f(x) = A /]

Nested Class Summary

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

Constructor Summary
R1toMatrix()

Method Summary
 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 x)
Evaluate f(x) = 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

### R1toMatrix

public R1toMatrix()
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 Rn->Rm 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 x)
Evaluate f(x) = A.

Parameters:
x - x
Returns:
f(x)