Package org.orekit.utils
Class DoubleArrayDictionary
- java.lang.Object
-
- org.orekit.utils.DoubleArrayDictionary
-
- All Implemented Interfaces:
Serializable
public class DoubleArrayDictionary extends Object implements Serializable
String → double[] mapping, for small number of keys.This class is a low overhead for a very small number of keys. It is based on simple array and string comparison. It plays the same role a
Map<String, double[]>
but with reduced features and not intended for large number of keys. For such needs the regularMap<String, double[]>
should be preferred.- Since:
- 11.1
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DoubleArrayDictionary.Entry
Entry in a dictionary.
-
Constructor Summary
Constructors Constructor Description DoubleArrayDictionary()
Constructor withdefault initial capacity
.DoubleArrayDictionary(int initialCapacity)
Constructor with specified capacity.DoubleArrayDictionary(Map<String,double[]> map)
Constructor from a map.DoubleArrayDictionary(DoubleArrayDictionary dictionary)
Constructor from another dictionary.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Remove all entries.double[]
get(String key)
Get the value corresponding to a key.List<DoubleArrayDictionary.Entry>
getData()
Get an unmodifiable view of the dictionary entries.DoubleArrayDictionary.Entry
getEntry(String key)
Get a complete entry.void
put(String key, double[] value)
Add an entry.void
putAll(Map<String,double[]> map)
Put all the entries from the map in the dictionary.void
putAll(DoubleArrayDictionary dictionary)
Put all the entries from another dictionary.boolean
remove(String key)
Remove an entry.int
size()
Get the number of dictionary entries.Map<String,double[]>
toMap()
Create a map from the instance.String
toString()
Get a string representation of the dictionary.DoubleArrayDictionary
unmodifiableView()
Get an unmodifiable view of the dictionary.
-
-
-
Constructor Detail
-
DoubleArrayDictionary
public DoubleArrayDictionary()
Constructor withdefault initial capacity
.
-
DoubleArrayDictionary
public DoubleArrayDictionary(int initialCapacity)
Constructor with specified capacity.- Parameters:
initialCapacity
- initial capacity
-
DoubleArrayDictionary
public DoubleArrayDictionary(DoubleArrayDictionary dictionary)
Constructor from another dictionary.- Parameters:
dictionary
- dictionary to use for initializing entries
-
-
Method Detail
-
getData
public List<DoubleArrayDictionary.Entry> getData()
Get an unmodifiable view of the dictionary entries.- Returns:
- unmodifiable view of the dictionary entries
-
size
public int size()
Get the number of dictionary entries.- Returns:
- number of dictionary entries
-
toMap
public Map<String,double[]> toMap()
Create a map from the instance.The map contains a copy of the instance data
- Returns:
- copy of the dictionary, as an independent map
-
clear
public void clear()
Remove all entries.
-
put
public void put(String key, double[] value)
Add an entry.If an entry with the same key already exists, it will be removed first.
The new entry is always put at the end.
- Parameters:
key
- entry keyvalue
- entry value
-
putAll
public void putAll(Map<String,double[]> map)
Put all the entries from the map in the dictionary.- Parameters:
map
- map to copy into the instance
-
putAll
public void putAll(DoubleArrayDictionary dictionary)
Put all the entries from another dictionary.- Parameters:
dictionary
- dictionary to copy into the instance
-
get
public double[] get(String key)
Get the value corresponding to a key.- Parameters:
key
- entry key- Returns:
- copy of the value corresponding to the key or null if key not present
-
getEntry
public DoubleArrayDictionary.Entry getEntry(String key)
Get a complete entry.- Parameters:
key
- entry key- Returns:
- entry with key if it exists, null otherwise
-
remove
public boolean remove(String key)
Remove an entry.- Parameters:
key
- key of the entry to remove- Returns:
- true if an entry has been removed, false if the key was not present
-
unmodifiableView
public DoubleArrayDictionary unmodifiableView()
Get an unmodifiable view of the dictionary.The return dictionary is backed by the original instance and offers
read-only
access to it, but all operations that modify it throw anUnsupportedOperationException
.- Returns:
- unmodifiable view of the dictionary
-
-