Package org.hipparchus.analysis.differentiation

Class FDSFactory<T extends RealFieldElement<T>>

java.lang.Object

org.hipparchus.analysis.differentiation.FDSFactory<T>

Type Parameters:

T - the type of the function parameters and value

public class FDSFactory<T extends RealFieldElement<T>>
extends Object

Factory for FieldDerivativeStructure.

This class is a factory for FieldDerivativeStructure instances.

Instances of this class are guaranteed to be immutable.

See Also:

FieldDerivativeStructure

Constructor Summary

Constructors

Constructor	Description
FDSFactory(Field<T> valueField, int parameters, int order)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
FieldDerivativeStructure<T>	build(double... derivatives)	Build a FieldDerivativeStructure from all its derivatives.
FieldDerivativeStructure<T>	build(T... derivatives)	Build a FieldDerivativeStructure from all its derivatives.
FieldDerivativeStructure<T>	constant(double value)	Build a FieldDerivativeStructure representing a constant value.
FieldDerivativeStructure<T>	constant(T value)	Build a FieldDerivativeStructure representing a constant value.
DSCompiler	getCompiler()	Get the compiler for the current dimensions.
Field<FieldDerivativeStructure<T>>	getDerivativeField()	Get the Field the FieldDerivativeStructure instances belong to.
Field<T>	getValueField()	Get the Field the value and parameters of the function belongs to.
FieldDerivativeStructure<T>	variable(int index, double value)	Build a FieldDerivativeStructure representing a variable.
FieldDerivativeStructure<T>	variable(int index, T value)	Build a FieldDerivativeStructure representing a variable.

Methods inherited from class java.lang.Object

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

Constructor Detail

FDSFactory

public FDSFactory(Field<T> valueField,
                  int parameters,
                  int order)

Simple constructor.

Parameters:

valueField - field for the function parameters and value

parameters - number of free parameters

order - derivation order

Method Detail

getValueField

public Field<T> getValueField()

Get the Field the value and parameters of the function belongs to.

Returns:

Field the value and parameters of the function belongs to

getDerivativeField

public Field<FieldDerivativeStructure<T>> getDerivativeField()

Get the Field the FieldDerivativeStructure instances belong to.

Returns:

Field the FieldDerivativeStructure instances belong to

constant

public FieldDerivativeStructure<T> constant(double value)

Build a FieldDerivativeStructure representing a constant value.

Parameters:

value - value of the constant

Returns:

a FieldDerivativeStructure representing a constant value

constant

public FieldDerivativeStructure<T> constant(T value)

Build a FieldDerivativeStructure representing a constant value.

Parameters:

value - value of the constant

Returns:

a FieldDerivativeStructure representing a constant value

variable

public FieldDerivativeStructure<T> variable(int index,
                                            T value)
                                     throws MathIllegalArgumentException

Build a FieldDerivativeStructure representing a variable.

Instances built using this method are considered to be the free variables with respect to which differentials are computed. As such, their differential with respect to themselves is +1.

Parameters:

index - index of the variable (from 0 to getCompiler().getFreeParameters() - 1)

value - value of the variable

Returns:

a FieldDerivativeStructure representing a variable

Throws:

MathIllegalArgumentException - if index if greater or equal to getCompiler().getFreeParameters().

variable

public FieldDerivativeStructure<T> variable(int index,
                                            double value)
                                     throws MathIllegalArgumentException

Build a FieldDerivativeStructure representing a variable.

Instances built using this method are considered to be the free variables with respect to which differentials are computed. As such, their differential with respect to themselves is +1.

Parameters:

index - index of the variable (from 0 to getCompiler().getFreeParameters() - 1)

value - value of the variable

Returns:

a FieldDerivativeStructure representing a variable

Throws:

MathIllegalArgumentException - if index if greater or equal to getCompiler().getFreeParameters().

build

@SafeVarargs
public final FieldDerivativeStructure<T> build(T... derivatives)
                                        throws MathIllegalArgumentException

Build a FieldDerivativeStructure from all its derivatives.

Parameters:

derivatives - derivatives sorted according to DSCompiler.getPartialDerivativeIndex(int...)

Returns:

FieldDerivativeStructure with specified derivatives

Throws:

MathIllegalArgumentException - if derivatives array does not match the size expected by the compiler

MathIllegalArgumentException - if order is too large

See Also:

FieldDerivativeStructure.getAllDerivatives()

build

public FieldDerivativeStructure<T> build(double... derivatives)
                                  throws MathIllegalArgumentException

Build a FieldDerivativeStructure from all its derivatives.

Parameters:

derivatives - derivatives sorted according to DSCompiler.getPartialDerivativeIndex(int...)

Returns:

FieldDerivativeStructure with specified derivatives

Throws:

MathIllegalArgumentException - if derivatives array does not match the size expected by the compiler

MathIllegalArgumentException - if order is too large

See Also:

FieldDerivativeStructure.getAllDerivatives()

getCompiler

public DSCompiler getCompiler()

Get the compiler for the current dimensions.

Returns:

compiler for the current dimensions