Class MappedIndexSeries<K extends Comparable<? super K>, N extends Comparable<N>>

java.lang.Object

java.util.AbstractMap<K,N>

org.ojalgo.series.MappedIndexSeries<K,N>

All Implemented Interfaces:

Map<K,N>, SequencedMap<K,N>, SortedMap<K,N>, BasicSeries<K,N>, BasicSeries.NaturallySequenced<K,N>

final class MappedIndexSeries<K extends Comparable<? super K>, N extends Comparable<N>>
extends AbstractMap<K,N>
implements BasicSeries.NaturallySequenced<K,N>

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface BasicSeries

BasicSeries.NaturallySequenced<K,V>, BasicSeries.TimeSeriesBuilder<K>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final Structure1D.IndexMapper<Double>	MAPPER
private final BinaryFunction<N>	myAccumulator
private ColourData	myColour
private final LongToNumberMap<N>	myDelegate
private final Structure1D.IndexMapper<K>	myMapper
private String	myName

Fields inherited from interface BasicSeries

CALENDAR, CALENDAR_DATE, DATE, INSTANT, LOCAL_DATE, LOCAL_DATE_TIME, LOCAL_TIME, OFFSET_DATE_TIME, ZONED_DATE_TIME

Constructor Summary

Constructors

Constructor	Description
MappedIndexSeries(PlainArray.Factory<N,?> denseArrayFactory, Structure1D.IndexMapper<K> indexMapper, BinaryFunction<N> accumulator)
MappedIndexSeries(Structure1D.IndexMapper<K> indexMapper, LongToNumberMap<N> delegate, BinaryFunction<N> accumulator)

Method Summary

Modifier and Type	Method	Description
PrimitiveSeries	asPrimitive()
MappedIndexSeries<K,N>	colour(ColourData colour)
Comparator<? super K>	comparator()
void	complete()	Using the natural sequencing as the key incrementor.
double	doubleValue(K key)
Set<Map.Entry<K,N>>	entrySet()
K	firstKey()
N	firstValue()
N	get(Object key)
N	get(K key)
(package private) BinaryFunction<N>	getAccumulator()
ColourData	getColour()
String	getName()
MappedIndexSeries<K,N>	headMap(K toKey)
K	lastKey()
N	lastValue()
Structure1D.IndexMapper<K>	mapper()
MappedIndexSeries<K,N>	name(String name)
private LongToNumberMap<N>	newDelegateInstance()	A "hack" that will create a new empty delegate LongToNumberMap instance.
K	nextKey()
double	put(K key, double value)	Will only work if values are types as Double.
N	put(K key, N value)
BasicSeries<K,N>	resample(UnaryOperator<K> keyTranslator)
void	setColour(ColourData colour)
void	setName(String name)
K	step(K key)	Will step (increment) the key given to the next in the natural sequence.
MappedIndexSeries<K,N>	subMap(K fromKey, K toKey)
MappedIndexSeries<K,N>	tailMap(K fromKey)
(package private) static long	toIndex(double key)
(package private) static double	toKey(long index)
String	toString()

Methods inherited from class AbstractMap

clear, clone, containsKey, containsValue, equals, hashCode, isEmpty, keySet, putAll, remove, size, values

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface BasicSeries

complete, put, putAll, resample

Methods inherited from interface Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, getOrDefault, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Methods inherited from interface SequencedMap

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

Methods inherited from interface SortedMap

keySet, putFirst, putLast, reversed, values

Field Details

MAPPER

static final Structure1D.IndexMapper<Double> MAPPER

myAccumulator

private final BinaryFunction<N extends Comparable<N>> myAccumulator

myColour

private ColourData myColour

myDelegate

private final LongToNumberMap<N extends Comparable<N>> myDelegate

myMapper

private final Structure1D.IndexMapper<K extends Comparable<? super K>> myMapper

myName

private String myName

Constructor Details

MappedIndexSeries

MappedIndexSeries(Structure1D.IndexMapper<K> indexMapper,
 LongToNumberMap<N> delegate,
 BinaryFunction<N> accumulator)

MappedIndexSeries

MappedIndexSeries(PlainArray.Factory<N,?> denseArrayFactory,
 Structure1D.IndexMapper<K> indexMapper,
 BinaryFunction<N> accumulator)

Method Details

toIndex

static long toIndex(double key)

toKey

static double toKey(long index)

asPrimitive

public PrimitiveSeries asPrimitive()

Specified by:

asPrimitive in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

colour

public MappedIndexSeries<K,N> colour(ColourData colour)

Specified by:

colour in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

comparator

public Comparator<? super K> comparator()

Specified by:

comparator in interface SortedMap<K extends Comparable<? super K>, N extends Comparable<N>>

complete

public void complete()

Description copied from interface: BasicSeries.NaturallySequenced

Using the natural sequencing as the key incrementor.

Specified by:

complete in interface BasicSeries.NaturallySequenced<K extends Comparable<? super K>, N extends Comparable<N>>

See Also:

• BasicSeries.complete(UnaryOperator)

doubleValue

public double doubleValue(K key)

Specified by:

doubleValue in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

entrySet

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

Specified by:

entrySet in interface Map<K extends Comparable<? super K>, N extends Comparable<N>>

Specified by:

entrySet in interface SortedMap<K extends Comparable<? super K>, N extends Comparable<N>>

Specified by:

entrySet in class AbstractMap<K extends Comparable<? super K>, N extends Comparable<N>>

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K extends Comparable<? super K>, N extends Comparable<N>>

firstValue

public N firstValue()

Specified by:

firstValue in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

get

public N get(K key)

Specified by:

get in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

get

public N get(Object key)

Specified by:

get in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

Specified by:

get in interface Map<K extends Comparable<? super K>, N extends Comparable<N>>

Overrides:

get in class AbstractMap<K extends Comparable<? super K>, N extends Comparable<N>>

getColour

public ColourData getColour()

Specified by:

getColour in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

getName

public String getName()

Specified by:

getName in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

headMap

public MappedIndexSeries<K,N> headMap(K toKey)

Specified by:

headMap in interface SortedMap<K extends Comparable<? super K>, N extends Comparable<N>>

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K extends Comparable<? super K>, N extends Comparable<N>>

lastValue

public N lastValue()

Specified by:

lastValue in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

mapper

public Structure1D.IndexMapper<K> mapper()

name

public MappedIndexSeries<K,N> name(String name)

Specified by:

name in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

nextKey

public K nextKey()

Specified by:

nextKey in interface BasicSeries.NaturallySequenced<K extends Comparable<? super K>, N extends Comparable<N>>

Returns:

The next, after the SortedMap.lastKey(), key.

put

public double put(K key,
 double value)

Description copied from interface: BasicSeries

Will only work if values are types as Double.

Specified by:

put in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

See Also:

• invalid reference

  #put(Comparable, Number)

put

public N put(K key,
 N value)

Specified by:

put in interface Map<K extends Comparable<? super K>, N extends Comparable<N>>

Overrides:

put in class AbstractMap<K extends Comparable<? super K>, N extends Comparable<N>>

resample

public BasicSeries<K,N> resample(UnaryOperator<K> keyTranslator)

Specified by:

resample in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

setColour

public void setColour(ColourData colour)

Specified by:

setColour in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

setName

public void setName(String name)

Specified by:

setName in interface BasicSeries<K extends Comparable<? super K>, N extends Comparable<N>>

step

public K step(K key)

Description copied from interface: BasicSeries.NaturallySequenced

Will step (increment) the key given to the next in the natural sequence.

Specified by:

step in interface BasicSeries.NaturallySequenced<K extends Comparable<? super K>, N extends Comparable<N>>

subMap

public MappedIndexSeries<K,N> subMap(K fromKey,
 K toKey)

Specified by:

subMap in interface SortedMap<K extends Comparable<? super K>, N extends Comparable<N>>

tailMap

public MappedIndexSeries<K,N> tailMap(K fromKey)

Specified by:

tailMap in interface SortedMap<K extends Comparable<? super K>, N extends Comparable<N>>

toString

public String toString()

Overrides:

toString in class AbstractMap<K extends Comparable<? super K>, N extends Comparable<N>>

newDelegateInstance

private LongToNumberMap<N> newDelegateInstance()

A "hack" that will create a new empty delegate LongToNumberMap instance.

getAccumulator

BinaryFunction<N> getAccumulator()