Package org.ojalgo.series
Class CoordinationSet<N extends java.lang.Comparable<N>>
- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.HashMap<java.lang.String,CalendarDateSeries<N>>
-
- org.ojalgo.series.CoordinationSet<N>
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.util.Map<java.lang.String,CalendarDateSeries<N>>
public class CoordinationSet<N extends java.lang.Comparable<N>> extends java.util.HashMap<java.lang.String,CalendarDateSeries<N>>
ACoordinationSet
is used to coordinate a set ofCalendarDateSeries
instances.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private CalendarDateUnit
myResolution
private static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description CoordinationSet()
CoordinationSet(int initialCapacity)
CoordinationSet(int initialCapacity, float loadFactor)
CoordinationSet(java.util.Collection<CalendarDateSeries<N>> seriesCollection)
CoordinationSet(java.util.Collection<CalendarDateSeries<N>> seriesCollection, CalendarDateUnit resolution)
CoordinationSet(java.util.Map<? extends java.lang.String,? extends CalendarDateSeries<N>> members)
CoordinationSet(CalendarDateUnit resolution)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
complete()
Will callCalendarDateSeries.complete()
on each of the instances in this set.CoordinationSet<N>
copy()
private CoordinationSet<N>
doPruneAndResample(CalendarDate firstKey, CalendarDate lastKey, CalendarDateUnit resolution)
CalendarDateSeries<N>
get(java.lang.Object key)
CalendarDateSeries<N>
get(java.lang.String seriesName)
java.util.List<CalendarDate>
getAllCalendarDates()
java.util.List<java.lang.String>
getAllSeriesNames()
CalendarDate
getEarliestFirstKey()
CalendarDate
getEarliestLastKey()
CalendarDate
getLatestFirstKey()
CalendarDate
getLatestLastKey()
CalendarDateUnit
getResolution()
N
getValue(java.lang.String series, CalendarDate date)
CoordinationSet<N>
prune()
Returns a new CoordinationSet where all series have the same first and last keys, as well as a common (the highest common) resolution.CoordinationSet<N>
prune(CalendarDateUnit resolution)
Returns a new CoordinationSet where all series have the same first and last keys, as well as the specified resolution.CalendarDateSeries<N>
put(CalendarDateSeries<N> series)
Vill use the series' name as the key.CoordinationSet<N>
resample(CalendarDateUnit resolution)
Returns a new set of series each resampled to the supplied resolution.java.lang.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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
myResolution
private transient CalendarDateUnit myResolution
-
-
Constructor Detail
-
CoordinationSet
public CoordinationSet()
-
CoordinationSet
public CoordinationSet(CalendarDateUnit resolution)
-
CoordinationSet
public CoordinationSet(java.util.Collection<CalendarDateSeries<N>> seriesCollection)
-
CoordinationSet
public CoordinationSet(java.util.Collection<CalendarDateSeries<N>> seriesCollection, CalendarDateUnit resolution)
-
CoordinationSet
public CoordinationSet(int initialCapacity)
-
CoordinationSet
public CoordinationSet(int initialCapacity, float loadFactor)
-
CoordinationSet
public CoordinationSet(java.util.Map<? extends java.lang.String,? extends CalendarDateSeries<N>> members)
-
-
Method Detail
-
complete
public void complete()
Will callCalendarDateSeries.complete()
on each of the instances in this set.
-
copy
public CoordinationSet<N> copy()
-
get
public CalendarDateSeries<N> get(java.lang.Object key)
- Specified by:
get
in interfacejava.util.Map<java.lang.String,CalendarDateSeries<N extends java.lang.Comparable<N>>>
- Overrides:
get
in classjava.util.HashMap<java.lang.String,CalendarDateSeries<N extends java.lang.Comparable<N>>>
-
get
public CalendarDateSeries<N> get(java.lang.String seriesName)
-
getAllCalendarDates
public java.util.List<CalendarDate> getAllCalendarDates()
-
getAllSeriesNames
public java.util.List<java.lang.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(java.lang.String series, CalendarDate date)
-
prune
public CoordinationSet<N> prune()
Returns a new CoordinationSet where all series have the same first and last keys, as well as a common (the highest common) resolution.
-
prune
public CoordinationSet<N> prune(CalendarDateUnit resolution)
Returns a new CoordinationSet where all series have the same first and last keys, as well as the specified resolution.
-
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)
Returns a new set of series each resampled to the supplied resolution. No pruning!
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.util.AbstractMap<java.lang.String,CalendarDateSeries<N extends java.lang.Comparable<N>>>
-
doPruneAndResample
private CoordinationSet<N> doPruneAndResample(CalendarDate firstKey, CalendarDate lastKey, CalendarDateUnit resolution)
-
-