org.ojalgo.series

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

All Superinterfaces:

Map<K,V>, SortedMap<K,V>

All Known Subinterfaces:

BasicSeries.NaturallySequenced<K,V>

All Known Implementing Classes:

CalendarDateSeries, NumberSeries

public interface BasicSeries<K extends Comparable<? super K>,V extends Number>
extends SortedMap<K,V>

A BasicSeries is a SortedMap with:

• Keys restricted to Comparable (the keys have a natural order)
• Values restricted to Number (you can do maths on the values)
• The option to associate a name and colour with the data
• The option to define an accumlator function to be used with multilple/subsequent put operations on the same key
• Some additional methods to work with primitive keys and values more efficiently
• A few additional methods to help access and modify series entries

The extension BasicSeries.NaturallySequenced is typically used with time series data.

Author:

apete

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BasicSeries.NaturallySequenced<K extends Comparable<? super K>,V extends Number> A series with naturally sequenced keys - given any key there is a natural "next" key, e.g.
static class	BasicSeries.TimeSeriesBuilder<K extends Comparable<? super K>>

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static BasicSeries.TimeSeriesBuilder<Calendar>	CALENDAR
static BasicSeries.TimeSeriesBuilder<CalendarDate>	CALENDAR_DATE
static BasicSeries.TimeSeriesBuilder<Date>	DATE
static BasicSeries.TimeSeriesBuilder<Instant>	INSTANT
static BasicSeries.TimeSeriesBuilder<LocalDate>	LOCAL_DATE
static BasicSeries.TimeSeriesBuilder<LocalDateTime>	LOCAL_DATE_TIME
static BasicSeries.TimeSeriesBuilder<LocalTime>	LOCAL_TIME
static BasicSeries.TimeSeriesBuilder<OffsetDateTime>	OFFSET_DATE_TIME
static BasicSeries.TimeSeriesBuilder<ZonedDateTime>	ZONED_DATE_TIME

Method Summary

Modifier and Type	Method and Description
PrimitiveSeries	asPrimitive()
BasicSeries<K,V>	colour(ColourData colour)
static <K extends Comparable<? super K>> CoordinatedSet<K>	coordinate(List<? extends BasicSeries<K,?>> uncoordinated)
double	doubleValue(K key)
static <K extends Comparable<? super K>> K	findEarliestFirstKey(Collection<? extends BasicSeries<K,?>> collection)
static <K extends Comparable<? super K>> K	findEarliestLastKey(Collection<? extends BasicSeries<K,?>> collection)
static <K extends Comparable<? super K>> K	findLatestFirstKey(Collection<? extends BasicSeries<K,?>> collection)
static <K extends Comparable<? super K>> K	findLatestLastKey(Collection<? extends BasicSeries<K,?>> collection)
V	firstValue()
V	get(K key)
ColourData	getColour()
String	getName()
V	lastValue()
static BasicSeries<Double,Double>	make(DenseArray.Factory<Double> arrayFactory)
static BasicSeries<Double,Double>	make(DenseArray.Factory<Double> arrayFactory, BinaryFunction<Double> accumulator)
static <N extends Number & Comparable<? super N>> BasicSeries<N,N>	make(DenseArray.Factory<N> arrayFactory, Structure1D.IndexMapper<N> indexMapper)
static <N extends Number & Comparable<? super N>> BasicSeries<N,N>	make(DenseArray.Factory<N> arrayFactory, Structure1D.IndexMapper<N> indexMapper, BinaryFunction<N> accumulator)
BasicSeries<K,V>	name(String name)
double	put(K key, double value)
V	put(K key, V value) Some implementations may specify an accumulator function to be used with subsequent put operation with the same key.
default void	putAll(Collection<? extends KeyValue<? extends K,? extends V>> data)

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, size

Field Detail

CALENDAR

static final BasicSeries.TimeSeriesBuilder<Calendar> CALENDAR

CALENDAR_DATE

static final BasicSeries.TimeSeriesBuilder<CalendarDate> CALENDAR_DATE

DATE

static final BasicSeries.TimeSeriesBuilder<Date> DATE

INSTANT

static final BasicSeries.TimeSeriesBuilder<Instant> INSTANT

LOCAL_DATE

static final BasicSeries.TimeSeriesBuilder<LocalDate> LOCAL_DATE

LOCAL_DATE_TIME

static final BasicSeries.TimeSeriesBuilder<LocalDateTime> LOCAL_DATE_TIME

LOCAL_TIME

static final BasicSeries.TimeSeriesBuilder<LocalTime> LOCAL_TIME

OFFSET_DATE_TIME

static final BasicSeries.TimeSeriesBuilder<OffsetDateTime> OFFSET_DATE_TIME

ZONED_DATE_TIME

static final BasicSeries.TimeSeriesBuilder<ZonedDateTime> ZONED_DATE_TIME

Method Detail

coordinate

static <K extends Comparable<? super K>> CoordinatedSet<K> coordinate(List<? extends BasicSeries<K,?>> uncoordinated)

findEarliestFirstKey

static <K extends Comparable<? super K>> K findEarliestFirstKey(Collection<? extends BasicSeries<K,?>> collection)

findEarliestLastKey

static <K extends Comparable<? super K>> K findEarliestLastKey(Collection<? extends BasicSeries<K,?>> collection)

findLatestFirstKey

static <K extends Comparable<? super K>> K findLatestFirstKey(Collection<? extends BasicSeries<K,?>> collection)

findLatestLastKey

static <K extends Comparable<? super K>> K findLatestLastKey(Collection<? extends BasicSeries<K,?>> collection)

make

static BasicSeries<Double,Double> make(DenseArray.Factory<Double> arrayFactory)

make

static BasicSeries<Double,Double> make(DenseArray.Factory<Double> arrayFactory,
                                       BinaryFunction<Double> accumulator)

make

static <N extends Number & Comparable<? super N>> BasicSeries<N,N> make(DenseArray.Factory<N> arrayFactory,
                                                                        Structure1D.IndexMapper<N> indexMapper)

make

static <N extends Number & Comparable<? super N>> BasicSeries<N,N> make(DenseArray.Factory<N> arrayFactory,
                                                                        Structure1D.IndexMapper<N> indexMapper,
                                                                        BinaryFunction<N> accumulator)

asPrimitive

PrimitiveSeries asPrimitive()

colour

BasicSeries<K,V> colour(ColourData colour)

doubleValue

double doubleValue(K key)

firstValue

V firstValue()

get

V get(K key)

getColour

ColourData getColour()

getName

String getName()

lastValue

V lastValue()

name

BasicSeries<K,V> name(String name)

put

double put(K key,
           double value)

See Also:

put(Comparable, Number)

put

V put(K key,
      V value)

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<K extends Comparable<? super K>,V extends Number>

See Also:

Map.put(java.lang.Object, java.lang.Object)

putAll

default void putAll(Collection<? extends KeyValue<? extends K,? extends V>> data)