Package org.hipparchus.analysis.differentiation

Class GradientField

java.lang.Object

org.hipparchus.analysis.differentiation.GradientField

All Implemented Interfaces:

Field<Gradient>

public class GradientField
extends Object
implements Field<Gradient>

Field for Gradient instances.

Since:

1.7

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
static GradientField	getField(int parameters)	Get the field for number of free parameters.
Gradient	getOne()	Get the multiplicative identity of the field.
Class<Gradient>	getRuntimeClass()	Returns the runtime class of the FieldElement.
Gradient	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 Details

getField

public static GradientField getField(int parameters)

Get the field for number of free parameters.

Parameters:

parameters - number of free parameters

Returns:

cached field

getOne

public Gradient 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<Gradient>

Returns:

multiplicative identity of the field

getZero

public Gradient 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<Gradient>

Returns:

additive identity of the field

getRuntimeClass

public Class<Gradient> getRuntimeClass()

Returns the runtime class of the FieldElement.

Specified by:

getRuntimeClass in interface Field<Gradient>

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