org.ojalgo.series

Class CoordinationSet<N extends Number>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,CalendarDateSeries<N>>

org.ojalgo.series.CoordinationSet<N>

All Implemented Interfaces:

Serializable, Cloneable, Map<String,CalendarDateSeries<N>>

public class CoordinationSet<N extends Number>
extends HashMap<String,CalendarDateSeries<N>>

A CoordinationSet is used to coordinate a set of CalendarDateSeries instances.

Author:

apete

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 java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CoordinationSet()
CoordinationSet(CalendarDateUnit resolution)
CoordinationSet(Collection<CalendarDateSeries<N>> seriesCollection)
CoordinationSet(Collection<CalendarDateSeries<N>> seriesCollection, CalendarDateUnit resolution)
CoordinationSet(int initialCapacity)
CoordinationSet(int initialCapacity, float loadFactor)
CoordinationSet(Map<? extends String,? extends CalendarDateSeries<N>> members)

Method Summary

Modifier and Type	Method and Description
void	complete() Will call BasicSeries.NaturallySequenced.complete() on each of the instances in this set.
CoordinationSet<N>	copy()
CalendarDateSeries<N>	get(Object key)
CalendarDateSeries<N>	get(String seriesName)
List<CalendarDate>	getAllCalendarDates()
List<String>	getAllSeriesNames()
CalendarDate	getEarliestFirstKey()
CalendarDate	getEarliestLastKey()
CalendarDate	getLatestFirstKey()
CalendarDate	getLatestLastKey()
CalendarDateUnit	getResolution()
N	getValue(String series, CalendarDate date)
CoordinationSet<N>	prune()
CoordinationSet<N>	prune(CalendarDateUnit resolution) Will prune and resample the data
CalendarDateSeries<N>	put(CalendarDateSeries<N> series) Vill use the series' name as the key.
CoordinationSet<N>	resample(CalendarDateUnit resolution)
String	toString()

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

CoordinationSet

public CoordinationSet()

CoordinationSet

public CoordinationSet(CalendarDateUnit resolution)

CoordinationSet

public CoordinationSet(Collection<CalendarDateSeries<N>> seriesCollection)

CoordinationSet

public CoordinationSet(Collection<CalendarDateSeries<N>> seriesCollection,
                       CalendarDateUnit resolution)

CoordinationSet

public CoordinationSet(int initialCapacity)

CoordinationSet

public CoordinationSet(int initialCapacity,
                       float loadFactor)

CoordinationSet

public CoordinationSet(Map<? extends String,? extends CalendarDateSeries<N>> members)

Method Detail

complete

public void complete()

Will call BasicSeries.NaturallySequenced.complete() on each of the instances in this set.

copy

public CoordinationSet<N> copy()

get

public CalendarDateSeries<N> get(Object key)

Specified by:

get in interface Map<String,CalendarDateSeries<N extends Number>>

Overrides:

get in class HashMap<String,CalendarDateSeries<N extends Number>>

get

public CalendarDateSeries<N> get(String seriesName)

getAllCalendarDates

public List<CalendarDate> getAllCalendarDates()

getAllSeriesNames

public List<String> getAllSeriesNames()

getEarliestFirstKey

public CalendarDate getEarliestFirstKey()

getEarliestLastKey

public CalendarDate getEarliestLastKey()

getLatestFirstKey

public CalendarDate getLatestFirstKey()

getLatestLastKey

public CalendarDate getLatestLastKey()

getResolution

public CalendarDateUnit getResolution()

getValue

public N getValue(String series,
                  CalendarDate date)

prune

public CoordinationSet<N> prune()

Returns:

A new CoordinationSet where all series have the same first and last keys.

prune

public CoordinationSet<N> prune(CalendarDateUnit resolution)

Will prune and resample the data

put

public CalendarDateSeries<N> put(CalendarDateSeries<N> series)

Vill use the series' name as the key. Make sure you have set the name to something that uniquely identifies the series.

resample

public CoordinationSet<N> resample(CalendarDateUnit resolution)

Parameters:

resolution - The new resolution

Returns:

A new set of series each resampled to the supplied resolution

toString

public String toString()

Overrides:

toString in class AbstractMap<String,CalendarDateSeries<N extends Number>>