Class LongToNumberMap<N extends Comparable<N>>

java.lang.Object

org.ojalgo.array.LongToNumberMap<N>

All Implemented Interfaces:

Map<Long,N>, SequencedMap<Long,N>, SortedMap<Long,N>, Access1D<N>, Mutate1D.Mixable<N>, Structure1D

public final class LongToNumberMap<N extends Comparable<N>>
extends Object
implements SortedMap<Long,N>, Access1D<N>, Mutate1D.Mixable<N>

A SortedMap with primitive valued long keys and Comparable values (incl. possibly primitive double values). The main benefits of using this class is its use of primitive keys and values, and how it integrates with other parts of ojAlgo. As a general purpose Map implementation (usage with high frequency of randomly ordered put and remove operations) it is not very efficient.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LongToNumberMap.MapFactory<N extends Comparable<N>>

Nested classes/interfaces inherited from interface Access1D

Access1D.Aggregatable<N>, Access1D.Collectable<N,R>, Access1D.ElementView<N>, Access1D.SelectionView<N>, Access1D.Sliceable<N>, Access1D.Visitable<N>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Nested classes/interfaces inherited from interface Structure1D

Structure1D.BasicMapper<T>, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.Logical<S,B>, Structure1D.LongIndex, Structure1D.LoopCallback

Field Summary

Fields

Modifier and Type	Field	Description
private final PlainArray.Factory<N,?>	myDenseFactory
private final GrowthStrategy	myGrowthStrategy
private final SparseArray<N>	myStorage

Constructor Summary

Constructors

Constructor	Description
LongToNumberMap(PlainArray.Factory<N,?> denseFactory, GrowthStrategy growthStrategy)

Method Summary

Modifier and Type	Method	Description
long	capacity()	The current capacity of the underlying data structure.
void	clear()
Comparator<? super Long>	comparator()
boolean	containsKey(long key)
boolean	containsKey(Object key)
boolean	containsValue(double value)
boolean	containsValue(Object value)
long	count()	The total number of elements in this structure.
double	doubleValue(int key)
double	doubleValue(long key)
Set<Map.Entry<Long,N>>	entrySet()
static <N extends Comparable<N>> LongToNumberMap.MapFactory<N>	factory(PlainArray.Factory<N,?> denseFactory)
Long	firstKey()
N	get(long key)
N	get(Object key)
(package private) SparseArray<N>	getStorage()
LongToNumberMap<N>	headMap(long toKey)
LongToNumberMap<N>	headMap(Long toKey)
boolean	isEmpty()
Set<Long>	keySet()
Long	lastKey()
double	mix(long key, BinaryFunction<N> mixer, double addend)
N	mix(long key, BinaryFunction<N> mixer, N addend)
SparseArray.NonzeroView<N>	nonzeros()	Similar to Access1D.elements() but avoids elements that are structurally known to be zero.
double	put(long key, double value)
N	put(long key, N value)
N	put(Long key, N value)
void	putAll(Map<? extends Long, ? extends N> m)
void	putAll(LongToNumberMap<N> m)
N	remove(long key)
N	remove(Object key)
int	size()	The total number of elements in this structure.
LongToNumberMap<N>	subMap(long fromKey, long toKey)
LongToNumberMap<N>	subMap(Long fromKey, Long toKey)
LongToNumberMap<N>	tailMap(long fromKey)
LongToNumberMap<N>	tailMap(Long fromKey)
String	toString()
NumberList<N>	values()
Access1D<N>	values(long fromKey, long toKey)	Should return the same elements/values as first calling subMap(Long, Long) and then values() but this method does not create any copies.

Methods inherited from class Object

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

Methods inherited from interface Access1D

asCollectable1D, asKeyed1D, asList, axpy, byteValue, byteValue, dot, elements, floatValue, floatValue, intValue, intValue, longValue, longValue, select, shortValue, shortValue, supplyTo, toList, toRawCopy1D

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface SortedMap

putFirst, putLast, reversed

Field Details

myDenseFactory

private final PlainArray.Factory<N extends Comparable<N>, ?> myDenseFactory

myGrowthStrategy

private final GrowthStrategy myGrowthStrategy

myStorage

private final SparseArray<N extends Comparable<N>> myStorage

Constructor Details

LongToNumberMap

LongToNumberMap(PlainArray.Factory<N,?> denseFactory,
 GrowthStrategy growthStrategy)

Method Details

factory

public static <N extends Comparable<N>>
LongToNumberMap.MapFactory<N> factory(PlainArray.Factory<N,?> denseFactory)

capacity

public long capacity()

The current capacity of the underlying data structure. The capacity is always greater than or equal to the current number of entries in the map. When you add entries to the map the capacity may have to grow.

clear

public void clear()

Specified by:

clear in interface Map<Long, N extends Comparable<N>>

comparator

public Comparator<? super Long> comparator()

Specified by:

comparator in interface SortedMap<Long, N extends Comparable<N>>

containsKey

public boolean containsKey(long key)

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<Long, N extends Comparable<N>>

containsValue

public boolean containsValue(double value)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<Long, N extends Comparable<N>>

count

public long count()

Description copied from interface: Structure1D

The total number of elements in this structure.

You only need to implement this method if the structure can contain more than Integer.MAX_VALUE elements.

Specified by:

count in interface Structure1D

doubleValue

public double doubleValue(int key)

Specified by:

doubleValue in interface Access1D<N extends Comparable<N>>

doubleValue

public double doubleValue(long key)

Specified by:

doubleValue in interface Access1D<N extends Comparable<N>>

entrySet

public Set<Map.Entry<Long,N>> entrySet()

Specified by:

entrySet in interface Map<Long, N extends Comparable<N>>

Specified by:

entrySet in interface SortedMap<Long, N extends Comparable<N>>

firstKey

public Long firstKey()

Specified by:

firstKey in interface SortedMap<Long, N extends Comparable<N>>

get

public N get(long key)

Specified by:

get in interface Access1D<N extends Comparable<N>>

get

public N get(Object key)

Specified by:

get in interface Map<Long, N extends Comparable<N>>

headMap

public LongToNumberMap<N> headMap(long toKey)

headMap

public LongToNumberMap<N> headMap(Long toKey)

Specified by:

headMap in interface SortedMap<Long, N extends Comparable<N>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Long, N extends Comparable<N>>

keySet

public Set<Long> keySet()

Specified by:

keySet in interface Map<Long, N extends Comparable<N>>

Specified by:

keySet in interface SortedMap<Long, N extends Comparable<N>>

lastKey

public Long lastKey()

Specified by:

lastKey in interface SortedMap<Long, N extends Comparable<N>>

mix

public double mix(long key,
 BinaryFunction<N> mixer,
 double addend)

Specified by:

mix in interface Mutate1D.Mixable<N extends Comparable<N>>

Returns:

The new/mixed value

mix

public N mix(long key,
 BinaryFunction<N> mixer,
 N addend)

Specified by:

mix in interface Mutate1D.Mixable<N extends Comparable<N>>

nonzeros

public SparseArray.NonzeroView<N> nonzeros()

Description copied from interface: Access1D

Similar to Access1D.elements() but avoids elements that are structurally known to be zero. (That does not eliminate all zero-values from this view.) With an arbitrary (dense) unstructured implementation the Access1D.nonzeros() and Access1D.elements() methods do the same thing! Only some specific implementations are able to actually exploit structure/sparsity to view fewer elements.

Specified by:

nonzeros in interface Access1D<N extends Comparable<N>>

put

public double put(long key,
 double value)

put

public N put(long key,
 N value)

put

public N put(Long key,
 N value)

Specified by:

put in interface Map<Long, N extends Comparable<N>>

putAll

public void putAll(LongToNumberMap<N> m)

putAll

public void putAll(Map<? extends Long, ? extends N> m)

Specified by:

putAll in interface Map<Long, N extends Comparable<N>>

remove

public N remove(long key)

remove

public N remove(Object key)

Specified by:

remove in interface Map<Long, N extends Comparable<N>>

size

public int size()

Description copied from interface: Structure1D

The total number of elements in this structure.

Specified by:

size in interface Map<Long, N extends Comparable<N>>

Specified by:

size in interface Structure1D

subMap

public LongToNumberMap<N> subMap(long fromKey,
 long toKey)

subMap

public LongToNumberMap<N> subMap(Long fromKey,
 Long toKey)

Specified by:

subMap in interface SortedMap<Long, N extends Comparable<N>>

tailMap

public LongToNumberMap<N> tailMap(long fromKey)

tailMap

public LongToNumberMap<N> tailMap(Long fromKey)

Specified by:

tailMap in interface SortedMap<Long, N extends Comparable<N>>

toString

public String toString()

Overrides:

toString in class Object

values

public NumberList<N> values()

Specified by:

values in interface Map<Long, N extends Comparable<N>>

Specified by:

values in interface SortedMap<Long, N extends Comparable<N>>

values

public Access1D<N> values(long fromKey,
 long toKey)

Should return the same elements/values as first calling subMap(Long, Long) and then values() but this method does not create any copies. Any change in the underlying data structure (this map) will corrupt this method's output.

getStorage

SparseArray<N> getStorage()