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

All Superinterfaces:

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

All Known Subinterfaces:

BasicSeries.NaturallySequenced<K,V>

All Known Implementing Classes:

CalendarDateSeries, MappedIndexSeries, NumberSeries, SimpleSeries, TreeSeries

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

A BasicSeries is a SortedMap with:

• Keys restricted to Comparable (the keys have a natural order)
• Values restricted to Comparable (the values are "numeric" as in extending Number or implementing NumberDefinition.
• The option to associate a name and colour with the data.
• A few additional methods to help access and modify series entries.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
default PrimitiveSeries	asPrimitive()
default BasicSeries<K,V>	colour(ColourData colour)
default void	complete(UnaryOperator<K> keyIncrementor)	Will fill in missing values, inbetween the first and last keys.
static <K extends Comparable<? super K>> CoordinatedSet<K>	coordinate(List<? extends BasicSeries<K,?>> uncoordinated)
default 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)
default V	firstValue()
default V	get(Object key)
V	get(K key)
ColourData	getColour()
String	getName()
default V	lastValue()
static BasicSeries<Double,Double>	make(PlainArray.Factory<Double,?> arrayFactory)
static BasicSeries<Double,Double>	make(PlainArray.Factory<Double,?> arrayFactory, BinaryFunction<Double> accumulator)
static <N extends Comparable<N>> BasicSeries<N,N>	make(PlainArray.Factory<N,?> arrayFactory, Structure1D.IndexMapper<N> indexMapper)
static <N extends Comparable<N>> BasicSeries<N,N>	make(PlainArray.Factory<N,?> arrayFactory, Structure1D.IndexMapper<N> indexMapper, BinaryFunction<N> accumulator)
default BasicSeries<K,V>	name(String name)
default double	put(K key, double value)	Will only work if values are types as Double.
default double	put(EntryPair.KeyedPrimitive<K> entry)
default void	putAll(Collection<? extends EntryPair<? extends K, ? extends V>> data)
default <K2 extends Comparable<? super K2>> void	resample(Function<K,K2> keyTranslator, BasicSeries<K2,V> destination)
BasicSeries<K,V>	resample(UnaryOperator<K> keyTranslator)
void	setColour(ColourData colour)
void	setName(String name)

Methods inherited from interface Map

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

Methods inherited from interface SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface SortedMap

comparator, entrySet, firstKey, headMap, keySet, lastKey, putFirst, putLast, reversed, subMap, tailMap, values

Field Details

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 Details

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(PlainArray.Factory<Double,?> arrayFactory)

make

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

make

static <N extends Comparable<N>> BasicSeries<N,N> make(PlainArray.Factory<N,?> arrayFactory,
 Structure1D.IndexMapper<N> indexMapper)

make

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

asPrimitive

default PrimitiveSeries asPrimitive()

colour

default BasicSeries<K,V> colour(ColourData colour)

complete

default void complete(UnaryOperator<K> keyIncrementor)

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

doubleValue

default double doubleValue(K key)

firstValue

default V firstValue()

get

V get(K key)

get

default V get(Object key)

Specified by:

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

getColour

ColourData getColour()

getName

String getName()

lastValue

default V lastValue()

name

default BasicSeries<K,V> name(String name)

put

default double put(EntryPair.KeyedPrimitive<K> entry)

put

default double put(K key,
 double value)

Will only work if values are types as Double.

See Also:

• invalid reference

  #put(Comparable, Number)

putAll

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

resample

default <K2 extends Comparable<? super K2>> void resample(Function<K,K2> keyTranslator,
 BasicSeries<K2,V> destination)

resample

BasicSeries<K,V> resample(UnaryOperator<K> keyTranslator)

setColour

void setColour(ColourData colour)

setName

void setName(String name)