java.lang.Object
- org.ojalgo.series.TreeSeries<K,V,I>

All Implemented Interfaces:: java.util.Map<K,V>, java.util.NavigableMap<K,V>, java.util.SortedMap<K,V>, BasicSeries<K,V>

Direct Known Subclasses:: CalendarDateSeries, NumberSeries, SimpleSeries

abstract class TreeSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>,I extends TreeSeries<K,V,I>>
extends java.lang.Object
implements java.util.NavigableMap<K,V>, BasicSeries<K,V>

Nested Class Summary
- 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

private ColourData myColour

private java.util.NavigableMap<K,V> myDelegate

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
Modifier Constructor Description

protected TreeSeries(java.util.NavigableMap<K,V> delegate)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) void`	`appendLastPartToString(java.lang.StringBuilder builder)`
`java.util.Map.Entry<K,V>`	`ceilingEntry(K key)`
`K`	`ceilingKey(K key)`
`void`	`clear()`
`I`	`colour(ColourData colour)`
`java.util.Comparator<? super K>`	`comparator()`
`V`	`compute(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)`
`V`	`computeIfAbsent(K key, java.util.function.Function<? super K,? extends V> mappingFunction)`
`V`	`computeIfPresent(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.NavigableSet<K>`	`descendingKeySet()`
`java.util.NavigableMap<K,V>`	`descendingMap()`
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()`
`boolean`	`equals(java.lang.Object o)`
`java.util.Map.Entry<K,V>`	`firstEntry()`
`K`	`firstKey()`
`java.util.Map.Entry<K,V>`	`floorEntry(K key)`
`K`	`floorKey(K key)`
`void`	`forEach(java.util.function.BiConsumer<? super K,? super V> action)`
`V`	`get(java.lang.Object key)`
`V`	`get(K key)`
`ColourData`	`getColour()`
`java.lang.String`	`getName()`
`V`	`getOrDefault(java.lang.Object key, V defaultValue)`
`int`	`hashCode()`
`java.util.SortedMap<K,V>`	`headMap(K toKey)`
`java.util.NavigableMap<K,V>`	`headMap(K toKey, boolean inclusive)`
`java.util.Map.Entry<K,V>`	`higherEntry(K key)`
`K`	`higherKey(K key)`
`boolean`	`isEmpty()`
`java.util.Set<K>`	`keySet()`
`java.util.Map.Entry<K,V>`	`lastEntry()`
`K`	`lastKey()`
`java.util.Map.Entry<K,V>`	`lowerEntry(K key)`
`K`	`lowerKey(K key)`
`V`	`merge(K key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)`
`I`	`name(java.lang.String name)`
`java.util.NavigableSet<K>`	`navigableKeySet()`
`java.util.Map.Entry<K,V>`	`pollFirstEntry()`
`java.util.Map.Entry<K,V>`	`pollLastEntry()`
`V`	`put(K key, V value)`
`void`	`putAll(java.util.Map<? extends K,? extends V> m)`
`V`	`putIfAbsent(K key, V value)`
`V`	`remove(java.lang.Object key)`
`boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`V`	`replace(K key, V value)`
`boolean`	`replace(K key, V oldValue, V newValue)`
`void`	`replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)`
`void`	`setColour(ColourData colour)`
`void`	`setName(java.lang.String name)`
`int`	`size()`
`java.util.NavigableMap<K,V>`	`subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)`
`java.util.SortedMap<K,V>`	`subMap(K fromKey, K toKey)`
`java.util.SortedMap<K,V>`	`tailMap(K fromKey)`
`java.util.NavigableMap<K,V>`	`tailMap(K fromKey, boolean inclusive)`
`java.lang.String`	`toString()`
`(package private) java.lang.StringBuilder`	`toStringFirstPart()`
`java.util.Collection<V>`	`values()`

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

Methods inherited from interface org.ojalgo.series.BasicSeries
asPrimitive, complete, doubleValue, firstValue, lastValue, put, put, putAll, resample, resample

- Field Detail
  - myColour
```
private ColourData myColour
```
  - myDelegate
```
private final java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>> myDelegate
```
  - myName
```
private java.lang.String myName
```
- Constructor Detail
  - TreeSeries
```
protected TreeSeries(java.util.NavigableMap<K,V> delegate)
```
- Method Detail
  - ceilingEntry
```
public java.util.Map.Entry<K,V> ceilingEntry(K key)
```
    Specified by:
    
    ceilingEntry in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - ceilingKey
```
public K ceilingKey(K key)
```
    Specified by:
    
    ceilingKey in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - colour
```
public final I colour(ColourData colour)
```
    Specified by:
    
    colour in interface BasicSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - comparator
```
public java.util.Comparator<? super K> comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - compute
```
public V compute(K key,
                 java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)
```
    Specified by:
    
    compute in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - computeIfAbsent
```
public V computeIfAbsent(K key,
                         java.util.function.Function<? super K,? extends V> mappingFunction)
```
    Specified by:
    
    computeIfAbsent in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - computeIfPresent
```
public V computeIfPresent(K key,
                          java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)
```
    Specified by:
    
    computeIfPresent in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - descendingKeySet
```
public java.util.NavigableSet<K> descendingKeySet()
```
    Specified by:
    
    descendingKeySet in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - descendingMap
```
public java.util.NavigableMap<K,V> descendingMap()
```
    Specified by:
    
    descendingMap in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
    
    Specified by:
    
    entrySet in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
    
    Overrides:
    
    equals in class java.lang.Object
  - firstEntry
```
public java.util.Map.Entry<K,V> firstEntry()
```
    Specified by:
    
    firstEntry in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - firstKey
```
public K firstKey()
```
    Specified by:
    
    firstKey in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - floorEntry
```
public java.util.Map.Entry<K,V> floorEntry(K key)
```
    Specified by:
    
    floorEntry in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - floorKey
```
public K floorKey(K key)
```
    Specified by:
    
    floorKey in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - forEach
```
public void forEach(java.util.function.BiConsumer<? super K,? super V> action)
```
    Specified by:
    
    forEach in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - get
```
public V get(K key)
```
    Specified by:
    
    get in interface BasicSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - get
```
public V get(java.lang.Object key)
```
    Specified by:
    
    get in interface BasicSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
    
    Specified by:
    
    get in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - getColour
```
public ColourData getColour()
```
    Specified by:
    
    getColour in interface BasicSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface BasicSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - getOrDefault
```
public V getOrDefault(java.lang.Object key,
                      V defaultValue)
```
    Specified by:
    
    getOrDefault in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - headMap
```
public java.util.SortedMap<K,V> headMap(K toKey)
```
    Specified by:
    
    headMap in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
    
    Specified by:
    
    headMap in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - headMap
```
public java.util.NavigableMap<K,V> headMap(K toKey,
                                                 boolean inclusive)
```
    Specified by:
    
    headMap in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - higherEntry
```
public java.util.Map.Entry<K,V> higherEntry(K key)
```
    Specified by:
    
    higherEntry in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - higherKey
```
public K higherKey(K key)
```
    Specified by:
    
    higherKey in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - keySet
```
public java.util.Set<K> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - lastEntry
```
public java.util.Map.Entry<K,V> lastEntry()
```
    Specified by:
    
    lastEntry in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - lastKey
```
public K lastKey()
```
    Specified by:
    
    lastKey in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - lowerEntry
```
public java.util.Map.Entry<K,V> lowerEntry(K key)
```
    Specified by:
    
    lowerEntry in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - lowerKey
```
public K lowerKey(K key)
```
    Specified by:
    
    lowerKey in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - merge
```
public V merge(K key,
               V value,
               java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)
```
    Specified by:
    
    merge in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - name
```
public final I name(java.lang.String name)
```
    Specified by:
    
    name in interface BasicSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - navigableKeySet
```
public java.util.NavigableSet<K> navigableKeySet()
```
    Specified by:
    
    navigableKeySet in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - pollFirstEntry
```
public java.util.Map.Entry<K,V> pollFirstEntry()
```
    Specified by:
    
    pollFirstEntry in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - pollLastEntry
```
public java.util.Map.Entry<K,V> pollLastEntry()
```
    Specified by:
    
    pollLastEntry in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - put
```
public V put(K key,
             V value)
```
    Specified by:
    
    put in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - putAll
```
public void putAll(java.util.Map<? extends K,? extends V> m)
```
    Specified by:
    
    putAll in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - putIfAbsent
```
public V putIfAbsent(K key,
                     V value)
```
    Specified by:
    
    putIfAbsent in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - remove
```
public V remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - remove
```
public boolean remove(java.lang.Object key,
                      java.lang.Object value)
```
    Specified by:
    
    remove in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - replace
```
public V replace(K key,
                 V value)
```
    Specified by:
    
    replace in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - replace
```
public boolean replace(K key,
                       V oldValue,
                       V newValue)
```
    Specified by:
    
    replace in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - replaceAll
```
public void replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)
```
    Specified by:
    
    replaceAll in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - setColour
```
public void setColour(ColourData colour)
```
    Specified by:
    
    setColour in interface BasicSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - setName
```
public void setName(java.lang.String name)
```
    Specified by:
    
    setName in interface BasicSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - subMap
```
public java.util.NavigableMap<K,V> subMap(K fromKey,
                                                boolean fromInclusive,
                                                K toKey,
                                                boolean toInclusive)
```
    Specified by:
    
    subMap in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - subMap
```
public java.util.SortedMap<K,V> subMap(K fromKey,
                                             K toKey)
```
    Specified by:
    
    subMap in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
    
    Specified by:
    
    subMap in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - tailMap
```
public java.util.SortedMap<K,V> tailMap(K fromKey)
```
    Specified by:
    
    tailMap in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
    
    Specified by:
    
    tailMap in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - tailMap
```
public java.util.NavigableMap<K,V> tailMap(K fromKey,
                                                 boolean inclusive)
```
    Specified by:
    
    tailMap in interface java.util.NavigableMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - values
```
public java.util.Collection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
    
    Specified by:
    
    values in interface java.util.SortedMap<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
  - appendLastPartToString
```
final void appendLastPartToString(java.lang.StringBuilder builder)
```
  - toStringFirstPart
```
final java.lang.StringBuilder toStringFirstPart()
```

Modifier and Type	Field	Description
`private ColourData`	`myColour`
`private java.util.NavigableMap<K,V>`	`myDelegate`
`private java.lang.String`	`myName`

Class TreeSeries<K extends java.lang.Comparable<? super K>,​V extends java.lang.Comparable<V>,​I extends TreeSeries<K,​V,​I>>

Nested Class Summary

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.lang.Object

Methods inherited from interface org.ojalgo.series.BasicSeries

Field Detail

myColour

myDelegate

myName

Constructor Detail

TreeSeries

Method Detail

ceilingEntry

ceilingKey

clear

colour

comparator

compute

computeIfAbsent

computeIfPresent

containsKey

containsValue

descendingKeySet

descendingMap

entrySet

equals

firstEntry

firstKey

floorEntry

floorKey

forEach

get

get

getColour

getName

getOrDefault

hashCode

headMap

headMap

higherEntry

higherKey

isEmpty

keySet

lastEntry

lastKey

lowerEntry

lowerKey

merge

name

navigableKeySet

pollFirstEntry

pollLastEntry

put

putAll

putIfAbsent

remove

remove

replace

replace

replaceAll

setColour

setName

size

subMap

subMap

tailMap

tailMap

toString

values

appendLastPartToString

toStringFirstPart

Class TreeSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>,I extends TreeSeries<K,V,I>>