CalendarDateSeries (ojAlgo 47.2.0 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.TreeMap<K,N>
  - - org.ojalgo.series.CalendarDateSeries<N>

All Implemented Interfaces:

Serializable, Cloneable, Map<CalendarDate,N>, NavigableMap<CalendarDate,N>, SortedMap<CalendarDate,N>, BasicSeries<CalendarDate,N>, BasicSeries.NaturallySequenced<CalendarDate,N>, Access1D<N>, Structure1D
```
public final class CalendarDateSeries<N extends Number>
extends TreeMap<K,N>
implements BasicSeries.NaturallySequenced<CalendarDate,N>
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface org.ojalgo.series.BasicSeries
  BasicSeries.NaturallySequenced<K extends Comparable<? super K>,V extends Number>, BasicSeries.TimeSeriesBuilder<K extends Comparable<? super K>>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>
- Nested classes/interfaces inherited from interface org.ojalgo.structure.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.structure.Structure1D
  Structure1D.BasicMapper<T>, Structure1D.IndexCallback, Structure1D.IndexMapper<T>, Structure1D.IntIndex, Structure1D.Logical<S extends Structure1D,B extends Structure1D.Logical<S,?>>, Structure1D.LongIndex, Structure1D.LoopCallback

Field Summary
- 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 and Description

CalendarDateSeries()

CalendarDateSeries(CalendarDateUnit resolution)

Constructors
Constructor and Description
`CalendarDateSeries()`
`CalendarDateSeries(CalendarDateUnit resolution)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PrimitiveSeries`	`asPrimitive()`
`I`	`colour(ColourData colour)`
`long`	`count()`
`double`	`doubleValue(K key)`
`double`	`doubleValue(long index)`
`N`	`firstValue()`
`N`	`get(CalendarDate key)`
`N`	`get(long index)`
`long`	`getAverageStepSize()`
`ColourData`	`getColour()`
`String`	`getName()`
`long[]`	`getPrimitiveKeys()`
`ExplicitTimeSeries`	`getPrimitiveTimeSeries()`
`CalendarDateUnit`	`getResolution()`
`CalendarDateSeries<N>`	`headMap(CalendarDate newToKey)`
`CalendarDateSeries<N>`	`headMap(CalendarDate newToKey, boolean newInclusive)`
`N`	`lastValue()`
`Structure1D.IndexMapper<CalendarDate>`	`mapper()` A natural sequence implies a bidirectional mapping between the keys and long indices.
`I`	`name(String name)`
`CalendarDate`	`nextKey()`
`double`	`put(CalendarDate key, double value)` Will only work if values are types as Double.
`N`	`put(CalendarDate key, N value)` Some implementations may specify an accumulator function to be used with subsequent put operation with the same key.
`N`	`put(Calendar key, N value)`
`N`	`put(Date key, N value)`
`double`	`put(long index, double value)`
`N`	`put(long index, N value)`
`void`	`putAll(Map<? extends CalendarDate,? extends N> data)`
`CalendarDateSeries<N>`	`resample(CalendarDate.Resolution resolution)`
`CalendarDateSeries<N>`	`resample(CalendarDate firstKey, CalendarDate lastKey, CalendarDate.Resolution resolution)`
`CalendarDate`	`step(CalendarDate key)`
`CalendarDateSeries<N>`	`subMap(CalendarDate fromKey, boolean inclusiveFromKey, CalendarDate toKey, boolean inclusiveToKey)`
`CalendarDateSeries<N>`	`subMap(CalendarDate fromKey, CalendarDate keyLimit)`
`CalendarDateSeries<N>`	`tailMap(CalendarDate fromKey)`
`CalendarDateSeries<N>`	`tailMap(CalendarDate fromKey, boolean inclusive)`
`String`	`toString()`

Methods inherited from class java.util.TreeMap
ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap
equals, hashCode, isEmpty

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

Methods inherited from interface org.ojalgo.series.BasicSeries.NaturallySequenced
asPrimitive, complete, size

Methods inherited from interface org.ojalgo.series.BasicSeries
colour, coordinate, doubleValue, findEarliestFirstKey, findEarliestLastKey, findLatestFirstKey, findLatestLastKey, firstValue, getColour, getName, lastValue, make, make, make, make, name, putAll

Methods inherited from interface java.util.SortedMap
comparator, entrySet, firstKey, keySet, lastKey, values

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, remove, replace, replace, replaceAll

Methods inherited from interface org.ojalgo.structure.Access1D
asCollectable1D, asPrimitive1D, axpy, byteValue, dot, elements, equals, floatValue, hashCode, intValue, longValue, nonzeros, shortValue, supplyTo, toRawCopy1D, toString, wrap, wrap, wrap

Methods inherited from interface org.ojalgo.structure.Structure1D
index, loopAll, loopMatching, loopRange, mapper

- Constructor Detail
  - CalendarDateSeries
```
public CalendarDateSeries()
```
  - CalendarDateSeries
```
public CalendarDateSeries(CalendarDateUnit resolution)
```
- Method Detail
  - count
```
public long count()
```
    Specified by:
    
    count in interface Structure1D
    
    Returns:
    
    The total number of elements in this structure.
  - doubleValue
```
public double doubleValue(long index)
```
    Specified by:
    
    doubleValue in interface Access1D<N extends Number>
  - get
```
public N get(CalendarDate key)
```
    Specified by:
    
    get in interface BasicSeries<CalendarDate,N extends Number>
  - get
```
public N get(long index)
```
    Specified by:
    
    get in interface Access1D<N extends Number>
  - getAverageStepSize
```
public long getAverageStepSize()
```
  - getPrimitiveKeys
```
public long[] getPrimitiveKeys()
```
  - getPrimitiveTimeSeries
```
public ExplicitTimeSeries getPrimitiveTimeSeries()
```
  - getResolution
```
public CalendarDateUnit getResolution()
```
  - headMap
```
public CalendarDateSeries<N> headMap(CalendarDate newToKey)
```
    Specified by:
    
    headMap in interface NavigableMap<CalendarDate,N extends Number>
    
    Specified by:
    
    headMap in interface SortedMap<CalendarDate,N extends Number>
    
    Overrides:
    
    headMap in class TreeMap<CalendarDate,N extends Number>
  - headMap
```
public CalendarDateSeries<N> headMap(CalendarDate newToKey,
                                     boolean newInclusive)
```
    Specified by:
    
    headMap in interface NavigableMap<CalendarDate,N extends Number>
    
    Overrides:
    
    headMap in class TreeMap<CalendarDate,N extends Number>
  - mapper
```
public Structure1D.IndexMapper<CalendarDate> mapper()
```
    Description copied from interface: BasicSeries.NaturallySequenced
    
    A natural sequence implies a bidirectional mapping between the keys and long indices. This Structure1D.IndexMapper specifies that mapping. Please note that multiple instaces of the key type could correspnd to the same index, and not all long values are valid indices. The conversions key -> index -> key may not return the original key.
    
    Specified by:
    
    mapper in interface BasicSeries.NaturallySequenced<CalendarDate,N extends Number>
  - nextKey
```
public CalendarDate nextKey()
```
    Specified by:
    
    nextKey in interface BasicSeries.NaturallySequenced<CalendarDate,N extends Number>
    
    Returns:
    
    The next, after the SortedMap.lastKey(), key.
  - put
```
public N put(Calendar key,
             N value)
```
  - put
```
public double put(CalendarDate key,
                  double value)
```
    Will only work if values are types as Double.
    
    Specified by:
    
    put in interface BasicSeries<CalendarDate,N extends Number>
    
    See Also:
    
    BasicSeries.put(java.lang.Comparable, double)
  - put
```
public N put(CalendarDate key,
             N value)
```
    Description copied from interface: BasicSeries
    
    Some implementations may specify an accumulator function to be used with subsequent put operation with the same key. If such an accumulator is present it should be used here, and in that case the method returns the new/accumulated/mixed value. With out an accumulator this method should behave exactly as with any other Map.
    
    Specified by:
    
    put in interface Map<CalendarDate,N extends Number>
    
    Specified by:
    
    put in interface BasicSeries<CalendarDate,N extends Number>
    
    Overrides:
    
    put in class TreeMap<CalendarDate,N extends Number>
    
    See Also:
    
    Map.put(java.lang.Object, java.lang.Object)
  - put
```
public N put(Date key,
             N value)
```
  - put
```
public double put(long index,
                  double value)
```
    Specified by:
    
    put in interface BasicSeries.NaturallySequenced<CalendarDate,N extends Number>
  - put
```
public N put(long index,
             N value)
```
    Specified by:
    
    put in interface BasicSeries.NaturallySequenced<CalendarDate,N extends Number>
  - putAll
```
public void putAll(Map<? extends CalendarDate,? extends N> data)
```
    Specified by:
    
    putAll in interface Map<CalendarDate,N extends Number>
    
    Overrides:
    
    putAll in class TreeMap<CalendarDate,N extends Number>
  - resample
```
public CalendarDateSeries<N> resample(CalendarDate firstKey,
                                      CalendarDate lastKey,
                                      CalendarDate.Resolution resolution)
```
  - resample
```
public CalendarDateSeries<N> resample(CalendarDate.Resolution resolution)
```
  - step
```
public CalendarDate step(CalendarDate key)
```
    Specified by:
    
    step in interface BasicSeries.NaturallySequenced<CalendarDate,N extends Number>
  - subMap
```
public CalendarDateSeries<N> subMap(CalendarDate fromKey,
                                    boolean inclusiveFromKey,
                                    CalendarDate toKey,
                                    boolean inclusiveToKey)
```
    Specified by:
    
    subMap in interface NavigableMap<CalendarDate,N extends Number>
    
    Overrides:
    
    subMap in class TreeMap<CalendarDate,N extends Number>
  - subMap
```
public CalendarDateSeries<N> subMap(CalendarDate fromKey,
                                    CalendarDate keyLimit)
```
    Specified by:
    
    subMap in interface NavigableMap<CalendarDate,N extends Number>
    
    Specified by:
    
    subMap in interface SortedMap<CalendarDate,N extends Number>
    
    Overrides:
    
    subMap in class TreeMap<CalendarDate,N extends Number>
  - tailMap
```
public CalendarDateSeries<N> tailMap(CalendarDate fromKey)
```
    Specified by:
    
    tailMap in interface NavigableMap<CalendarDate,N extends Number>
    
    Specified by:
    
    tailMap in interface SortedMap<CalendarDate,N extends Number>
    
    Overrides:
    
    tailMap in class TreeMap<CalendarDate,N extends Number>
  - tailMap
```
public CalendarDateSeries<N> tailMap(CalendarDate fromKey,
                                     boolean inclusive)
```
    Specified by:
    
    tailMap in interface NavigableMap<CalendarDate,N extends Number>
    
    Overrides:
    
    tailMap in class TreeMap<CalendarDate,N extends Number>
  - toString
```
public String toString()
```
  - asPrimitive
```
public PrimitiveSeries asPrimitive()
```
    Specified by:
    
    asPrimitive in interface BasicSeries<K extends Comparable<? super K>,N extends Number>
  - colour
```
public I colour(ColourData colour)
```
    Specified by:
    
    colour in interface BasicSeries<K extends Comparable<? super K>,N extends Number>
  - doubleValue
```
public final double doubleValue(K key)
```
    Specified by:
    
    doubleValue in interface BasicSeries<K extends Comparable<? super K>,N extends Number>
  - firstValue
```
public N firstValue()
```
    Specified by:
    
    firstValue in interface BasicSeries<K extends Comparable<? super K>,N extends Number>
  - getColour
```
public ColourData getColour()
```
    Specified by:
    
    getColour in interface BasicSeries<K extends Comparable<? super K>,N extends Number>
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface BasicSeries<K extends Comparable<? super K>,N extends Number>
  - lastValue
```
public N lastValue()
```
    Specified by:
    
    lastValue in interface BasicSeries<K extends Comparable<? super K>,N extends Number>
  - name
```
public I name(String name)
```
    Specified by:
    
    name in interface BasicSeries<K extends Comparable<? super K>,N extends Number>

Class CalendarDateSeries<N extends Number>

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

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

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

Field Summary

Fields inherited from interface org.ojalgo.series.BasicSeries

Constructor Summary

Method Summary

Methods inherited from class java.util.TreeMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface org.ojalgo.series.BasicSeries.NaturallySequenced

Methods inherited from interface org.ojalgo.series.BasicSeries

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Methods inherited from interface org.ojalgo.structure.Access1D

Methods inherited from interface org.ojalgo.structure.Structure1D

Constructor Detail

CalendarDateSeries

CalendarDateSeries

Method Detail

count

doubleValue

get

get

getAverageStepSize

getPrimitiveKeys

getPrimitiveTimeSeries

getResolution

headMap

headMap

mapper

nextKey

put

put

put

put

put

put

putAll

resample

resample

step

subMap

subMap

tailMap

tailMap

toString

asPrimitive

colour

doubleValue

firstValue

getColour

getName

lastValue

name