org.hipparchus.analysis.differentiation

Class FieldGradientField<T extends RealFieldElement<T>>

java.lang.Object

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

Type Parameters:

T - the type of the function parameters and value

All Implemented Interfaces:

Field<FieldGradient<T>>

public class FieldGradientField<T extends RealFieldElement<T>>
extends Object
implements Field<FieldGradient<T>>

Field for Gradient instances.

Since:

1.7

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
static <T extends RealFieldElement<T>> FieldGradientField<T>	getField(Field<T> valueField, int parameters) Get the field for number of free parameters.
FieldGradient<T>	getOne() Get the multiplicative identity of the field.
Class<? extends FieldElement<FieldGradient<T>>>	getRuntimeClass() Returns the runtime class of the FieldElement.
FieldGradient<T>	getZero() Get the additive identity of the field.
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Detail

getField

public static <T extends RealFieldElement<T>> FieldGradientField<T> getField(Field<T> valueField,
                                                                             int parameters)

Get the field for number of free parameters.

Type Parameters:

T - the type of the function parameters and value

Parameters:

valueField - field for the function parameters and value

parameters - number of free parameters

Returns:

cached field

getOne

public FieldGradient<T> getOne()

Get the multiplicative identity of the field.

The multiplicative identity is the element e₁ of the field such that for all elements a of the field, the equalities a × e₁ = e₁ × a = a hold.

Specified by:

getOne in interface Field<FieldGradient<T extends RealFieldElement<T>>>

Returns:

multiplicative identity of the field

getZero

public FieldGradient<T> getZero()

Get the additive identity of the field.

The additive identity is the element e₀ of the field such that for all elements a of the field, the equalities a + e₀ = e₀ + a = a hold.

Specified by:

getZero in interface Field<FieldGradient<T extends RealFieldElement<T>>>

Returns:

additive identity of the field

getRuntimeClass

public Class<? extends FieldElement<FieldGradient<T>>> getRuntimeClass()

Returns the runtime class of the FieldElement.

Specified by:

getRuntimeClass in interface Field<FieldGradient<T extends RealFieldElement<T>>>

Returns:

The Class object that represents the runtime class of this object.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object