java.lang.Object
- java.util.AbstractMap<K,N>
- - org.ojalgo.series.MappedIndexSeries<K,N>

All Implemented Interfaces:: java.util.Map<K,N>, java.util.SortedMap<K,N>, BasicSeries<K,N>, BasicSeries.NaturallySequenced<K,N>

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

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,V extends java.lang.Object>
- Nested classes/interfaces inherited from interface org.ojalgo.series.BasicSeries
  BasicSeries.NaturallySequenced<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>, BasicSeries.TimeSeriesBuilder<K extends java.lang.Comparable<? super K>>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

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

Fields inherited from interface org.ojalgo.series.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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PrimitiveSeries`	`asPrimitive()`
`MappedIndexSeries<K,N>`	`colour(ColourData colour)`
`java.util.Comparator<? super K>`	`comparator()`
`void`	`complete()`	Using the natural sequencing as the key incrementor.
`double`	`doubleValue(K key)`
`java.util.Set<java.util.Map.Entry<K,N>>`	`entrySet()`
`K`	`firstKey()`
`N`	`firstValue()`
`N`	`get(java.lang.Object key)`
`N`	`get(K key)`
`(package private) BinaryFunction<N>`	`getAccumulator()`
`ColourData`	`getColour()`
`java.lang.String`	`getName()`
`MappedIndexSeries<K,N>`	`headMap(K toKey)`
`K`	`lastKey()`
`N`	`lastValue()`
`Structure1D.IndexMapper<K>`	`mapper()`
`MappedIndexSeries<K,N>`	`name(java.lang.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(java.util.function.UnaryOperator<K> keyTranslator)`
`void`	`setColour(ColourData colour)`
`void`	`setName(java.lang.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)`
`java.lang.String`	`toString()`

Methods inherited from class java.util.AbstractMap
clear, clone, containsKey, containsValue, equals, hashCode, isEmpty, keySet, putAll, remove, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ojalgo.series.BasicSeries
complete, put, putAll, resample

Methods inherited from interface java.util.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 java.util.SortedMap
keySet, values

- Field Detail
  - MAPPER
```
static final Structure1D.IndexMapper<java.lang.Double> MAPPER
```
  - myAccumulator
```
private final BinaryFunction<N extends java.lang.Comparable<N>> myAccumulator
```
  - myColour
```
private ColourData myColour
```
  - myDelegate
```
private final LongToNumberMap<N extends java.lang.Comparable<N>> myDelegate
```
  - myMapper
```
private final Structure1D.IndexMapper<K extends java.lang.Comparable<? super K>> myMapper
```
  - myName
```
private java.lang.String myName
```
- Constructor Detail
  - 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 Detail
  - toIndex
```
static long toIndex(double key)
```
  - toKey
```
static double toKey(long index)
```
  - asPrimitive
```
public PrimitiveSeries asPrimitive()
```
    Specified by:
    
    asPrimitive in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - colour
```
public MappedIndexSeries<K,N> colour(ColourData colour)
```
    Specified by:
    
    colour in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - comparator
```
public java.util.Comparator<? super K> comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,N extends java.lang.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 java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
    
    See Also:
    
    BasicSeries.complete(UnaryOperator)
  - doubleValue
```
public double doubleValue(K key)
```
    Specified by:
    
    doubleValue in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<K,N>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
    
    Specified by:
    
    entrySet in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
    
    Specified by:
    
    entrySet in class java.util.AbstractMap<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - firstKey
```
public K firstKey()
```
    Specified by:
    
    firstKey in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - firstValue
```
public N firstValue()
```
    Specified by:
    
    firstValue in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - get
```
public N get(K key)
```
    Specified by:
    
    get in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - get
```
public N get(java.lang.Object key)
```
    Specified by:
    
    get in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
    
    Specified by:
    
    get in interface java.util.Map<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
    
    Overrides:
    
    get in class java.util.AbstractMap<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - getColour
```
public ColourData getColour()
```
    Specified by:
    
    getColour in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - headMap
```
public MappedIndexSeries<K,N> headMap(K toKey)
```
    Specified by:
    
    headMap in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - lastKey
```
public K lastKey()
```
    Specified by:
    
    lastKey in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - lastValue
```
public N lastValue()
```
    Specified by:
    
    lastValue in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - mapper
```
public Structure1D.IndexMapper<K> mapper()
```
  - name
```
public MappedIndexSeries<K,N> name(java.lang.String name)
```
    Specified by:
    
    name in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - nextKey
```
public K nextKey()
```
    Specified by:
    
    nextKey in interface BasicSeries.NaturallySequenced<K extends java.lang.Comparable<? super K>,N extends java.lang.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 java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
    
    See Also:
    
    #put(Comparable, Number)
  - put
```
public N put(K key,
             N value)
```
    Specified by:
    
    put in interface java.util.Map<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
    
    Overrides:
    
    put in class java.util.AbstractMap<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - resample
```
public BasicSeries<K,N> resample(java.util.function.UnaryOperator<K> keyTranslator)
```
    Specified by:
    
    resample in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - setColour
```
public void setColour(ColourData colour)
```
    Specified by:
    
    setColour in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - setName
```
public void setName(java.lang.String name)
```
    Specified by:
    
    setName in interface BasicSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.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 java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - subMap
```
public MappedIndexSeries<K,N> subMap(K fromKey,
                                           K toKey)
```
    Specified by:
    
    subMap in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - tailMap
```
public MappedIndexSeries<K,N> tailMap(K fromKey)
```
    Specified by:
    
    tailMap in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.util.AbstractMap<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>
  - newDelegateInstance
```
private LongToNumberMap<N> newDelegateInstance()
```
    A "hack" that will create a new empty delegate LongToNumberMap instance.
  - getAccumulator
```
BinaryFunction<N> getAccumulator()
```

Class MappedIndexSeries<K extends java.lang.Comparable<? super K>,​N extends java.lang.Comparable<N>>

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface org.ojalgo.series.BasicSeries

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

Field Summary

Fields inherited from interface org.ojalgo.series.BasicSeries

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface org.ojalgo.series.BasicSeries

Methods inherited from interface java.util.Map

Methods inherited from interface java.util.SortedMap

Field Detail

MAPPER

myAccumulator

myColour

myDelegate

myMapper

myName

Constructor Detail

MappedIndexSeries

MappedIndexSeries

Method Detail

toIndex

toKey

asPrimitive

colour

comparator

complete

doubleValue

entrySet

firstKey

firstValue

get

get

getColour

getName

headMap

lastKey

lastValue

mapper

name

nextKey

put

put

resample

setColour

setName

step

subMap

tailMap

toString

newDelegateInstance

getAccumulator

Class MappedIndexSeries<K extends java.lang.Comparable<? super K>,N extends java.lang.Comparable<N>>