org.ojalgo.series

Interface BasicSeries.NaturallySequenced<K extends Comparable<? super K>,V extends Number>

All Superinterfaces:

Access1D<V>, BasicSeries<K,V>, Map<K,V>, SortedMap<K,V>, Structure1D

All Known Implementing Classes:

CalendarDateSeries

Enclosing interface:

BasicSeries<K extends Comparable<? super K>,V extends Number>

public static interface BasicSeries.NaturallySequenced<K extends Comparable<? super K>,V extends Number>
extends BasicSeries<K,V>, Access1D<V>

A series with naturally sequenced keys - given any key there is a natural "next" key, e.g. with a series of daily values the natural next key is the next day. Further, natural sequencing implies a bidirectional mapping between the keys and long indices.

Author:

apete

Nested Class Summary

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

Method Summary

Modifier and Type	Method and Description
default PrimitiveSeries	asPrimitive()
default void	complete() Will fill in missing values, inbetween the first and last keys.
Structure1D.IndexMapper<K>	mapper() A natural sequence implies a bidirectional mapping between the keys and long indices.
default K	nextKey()
double	put(long index, double value)
V	put(long index, V value)
default int	size()
K	step(K key)

Methods inherited from interface org.ojalgo.series.BasicSeries

colour, coordinate, doubleValue, findEarliestFirstKey, findEarliestLastKey, findLatestFirstKey, findLatestLastKey, firstValue, get, getColour, getName, lastValue, make, make, make, make, name, put, put, putAll

Methods inherited from interface java.util.SortedMap

comparator, entrySet, firstKey, headMap, keySet, lastKey, subMap, tailMap, values

Methods inherited from interface java.util.Map

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

Methods inherited from interface org.ojalgo.structure.Access1D

asCollectable1D, asPrimitive1D, axpy, byteValue, dot, doubleValue, elements, equals, floatValue, get, hashCode, intValue, longValue, nonzeros, shortValue, supplyTo, toRawCopy1D, toString, wrap, wrap, wrap

Methods inherited from interface org.ojalgo.structure.Structure1D

count, index, loopAll, loopMatching, loopRange, mapper

Method Detail

asPrimitive

default PrimitiveSeries asPrimitive()

Specified by:

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

complete

default void complete()

Will fill in missing values, inbetween the first and last keys.

mapper

Structure1D.IndexMapper<K> mapper()

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.

nextKey

default K nextKey()

Returns:

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

put

double put(long index,
           double value)

put

V put(long index,
      V value)

size

default int size()

Specified by:

size in interface Map<K extends Comparable<? super K>,V extends Number>

Specified by:

size in interface Structure1D

step

K step(K key)