Package org.hipparchus.analysis.differentiation

Class DSFactory

java.lang.Object

org.hipparchus.analysis.differentiation.DSFactory

All Implemented Interfaces:

Serializable

public class DSFactory
extends Object
implements Serializable

Factory for DerivativeStructure.

This class is a factory for DerivativeStructure instances.

Instances of this class are guaranteed to be immutable.

Since:

1.1

See Also:

DerivativeStructure, Serialized Form

Constructor Summary

Constructors

Constructor	Description
DSFactory(int parameters, int order)	Simple constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DSFactory

public DSFactory(int parameters,
                 int order)

Simple constructor.

Parameters:

parameters - number of free parameters

order - derivation order

Method Detail

getDerivativeField

public Field<DerivativeStructure> getDerivativeField()

Get the Field the DerivativeStructure instances belong to.

Returns:

Field the DerivativeStructure instances belong to

constant

public DerivativeStructure constant(double value)

Build a DerivativeStructure representing a constant value.

Parameters:

value - value of the constant

Returns:

a DerivativeStructure representing a constant value

variable

public DerivativeStructure variable(int index,
                                    double value)
                             throws MathIllegalArgumentException

Build a DerivativeStructure 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 DerivativeStructure representing a variable

Throws:

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

build

@SafeVarargs
public final DerivativeStructure build(double... derivatives)
                                throws MathIllegalArgumentException

Build a DerivativeStructure from all its derivatives.

Parameters:

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

Returns:

a DerivativeStructure 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:

DerivativeStructure.getAllDerivatives()

getCompiler

public DSCompiler getCompiler()

Get the compiler for the current dimensions.

Returns:

compiler for the current dimensions