org.ojalgo.array

Class LongToNumberMap<N extends Number>

java.lang.Object

org.ojalgo.array.LongToNumberMap<N>

All Implemented Interfaces:

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

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

A SortedMap with primitive valued long keys and Number 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.

Author:

apete

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Nested classes/interfaces inherited from interface org.ojalgo.access.Access1D

Access1D.Aggregatable<N extends Number>, Access1D.Collectable<N extends Number,R extends Mutate1D.Receiver<N>>, Access1D.Elements, Access1D.ElementView<N extends Number>, Access1D.IndexOf, Access1D.Sliceable<N extends Number>, Access1D.Visitable<N extends Number>

Nested classes/interfaces inherited from interface org.ojalgo.access.Structure1D

Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.LongIndex, Structure1D.LoopCallback

Method Summary

Modifier and Type	Method and 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()
double	doubleValue(long key)
Set<Map.Entry<Long,N>>	entrySet()
static <N extends Number> LongToNumberMap.MapFactory<N>	factory(DenseArray.Factory<N> denseFactory)
Long	firstKey()
N	get(long key)
N	get(Object key)
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)
double	put(long key, double value)
N	put(long key, N value)
N	put(Long key, N value)
void	putAll(LongToNumberMap<N> m)
void	putAll(Map<? extends Long,? extends N> m)
N	remove(long key)
N	remove(Object key)
int	size()
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 java.lang.Object

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

Methods inherited from interface java.util.Map

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

Methods inherited from interface org.ojalgo.access.Access1D

asCollectable1D, asPrimitive1D, axpy, dot, elements, equals, hashCode, iterator, nonzeros, stream, supplyTo, toRawCopy1D, wrap, wrap, wrap, wrapAccess1D, wrapAccess1D, wrapAccess1D

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.ojalgo.access.Structure1D

loopAll, loopMatching, loopRange, mapper

Method Detail

factory

public static <N extends Number> LongToNumberMap.MapFactory<N> factory(DenseArray.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 Number>

comparator

public Comparator<? super Long> comparator()

Specified by:

comparator in interface SortedMap<Long,N extends Number>

containsKey

public boolean containsKey(long key)

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<Long,N extends Number>

containsValue

public boolean containsValue(double value)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<Long,N extends Number>

count

public long count()

Specified by:

count in interface Structure1D

Returns:

The total number of elements in this structure.

doubleValue

public double doubleValue(long key)

Specified by:

doubleValue in interface Access1D<N extends Number>

entrySet

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

Specified by:

entrySet in interface Map<Long,N extends Number>

Specified by:

entrySet in interface SortedMap<Long,N extends Number>

firstKey

public Long firstKey()

Specified by:

firstKey in interface SortedMap<Long,N extends Number>

get

public N get(long key)

Specified by:

get in interface Access1D<N extends Number>

get

public N get(Object key)

Specified by:

get in interface Map<Long,N extends Number>

headMap

public LongToNumberMap<N> headMap(long toKey)

headMap

public LongToNumberMap<N> headMap(Long toKey)

Specified by:

headMap in interface SortedMap<Long,N extends Number>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Long,N extends Number>

keySet

public Set<Long> keySet()

Specified by:

keySet in interface Map<Long,N extends Number>

Specified by:

keySet in interface SortedMap<Long,N extends Number>

lastKey

public Long lastKey()

Specified by:

lastKey in interface SortedMap<Long,N extends Number>

mix

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

Specified by:

mix in interface Mutate1D.Mixable<N extends Number>

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 Number>

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 Number>

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 Number>

remove

public N remove(long key)

remove

public N remove(Object key)

Specified by:

remove in interface Map<Long,N extends Number>

size

public int size()

Specified by:

size in interface Map<Long,N extends Number>

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 Number>

tailMap

public LongToNumberMap<N> tailMap(long fromKey)

tailMap

public LongToNumberMap<N> tailMap(Long fromKey)

Specified by:

tailMap in interface SortedMap<Long,N extends Number>

toString

public String toString()

Overrides:

toString in class Object

values

public NumberList<N> values()

Specified by:

values in interface Map<Long,N extends Number>

Specified by:

values in interface SortedMap<Long,N extends Number>

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.