Package org.orekit.utils
Class FieldArrayDictionary.Entry
- java.lang.Object
-
- org.orekit.utils.FieldArrayDictionary.Entry
-
- Enclosing class:
- FieldArrayDictionary<T extends CalculusFieldElement<T>>
public class FieldArrayDictionary.Entry extends Object
Entry in a dictionary.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getKey()
Get the entry key.T[]
getValue()
Get the value.void
increment(double[] increment)
Increment the value.void
increment(T[] increment)
Increment the value.void
scaledIncrement(double factor, FieldArrayDictionary.Entry raw)
Increment the value with another scaled entry.void
scaledIncrement(T factor, FieldArrayDictionary.Entry raw)
Increment the value with another scaled entry.int
size()
Get the size of the value array.void
zero()
Reset the value to zero.
-
-
-
Method Detail
-
getKey
public String getKey()
Get the entry key.- Returns:
- entry key
-
getValue
public T[] getValue()
Get the value.- Returns:
- a copy of the value (independent from internal array)
-
size
public int size()
Get the size of the value array.- Returns:
- size of the value array
-
increment
public void increment(T[] increment)
Increment the value.For the sake of performance, no checks are done on argument.
- Parameters:
increment
- increment to apply to the entry value
-
increment
public void increment(double[] increment)
Increment the value.For the sake of performance, no checks are done on argument.
- Parameters:
increment
- increment to apply to the entry value
-
scaledIncrement
public void scaledIncrement(T factor, FieldArrayDictionary.Entry raw)
Increment the value with another scaled entry.Each component
value[i]
will be replaced byvalue[i] + factor * raw.value[i]
.For the sake of performance, no checks are done on arguments.
- Parameters:
factor
- multiplicative factor for incrementraw
- raw increment to be multiplied byfactor
and then added- Since:
- 11.1.1
-
scaledIncrement
public void scaledIncrement(double factor, FieldArrayDictionary.Entry raw)
Increment the value with another scaled entry.Each component
value[i]
will be replaced byvalue[i] + factor * raw.value[i]
.For the sake of performance, no checks are done on arguments.
- Parameters:
factor
- multiplicative factor for incrementraw
- raw increment to be multiplied byfactor
and then added- Since:
- 11.1.1
-
zero
public void zero()
Reset the value to zero.
-
-