Module ojalgo

Package org.ojalgo.series

Class CalendarDateSeries<N extends Comparable<N>>

java.lang.Object

org.ojalgo.series.CalendarDateSeries<N>

All Implemented Interfaces:

Map<CalendarDate,N>, NavigableMap<CalendarDate,N>, SequencedMap<CalendarDate,N>, SortedMap<CalendarDate,N>, BasicSeries<CalendarDate,N>, BasicSeries.NaturallySequenced<CalendarDate,N>

public final class CalendarDateSeries<N extends Comparable<N>>
extends Object
implements BasicSeries.NaturallySequenced<CalendarDate,N>

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojalgo.series.BasicSeries

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

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

Map.Entry<K,V>

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

Constructor Summary

Constructors

Constructor	Description
CalendarDateSeries()
CalendarDateSeries(CalendarDateUnit resolution)

Method Summary

Modifier and Type	Method	Description
Map.Entry<CalendarDate,N>	ceilingEntry(CalendarDate key)
CalendarDate	ceilingKey(CalendarDate key)
void	clear()
final CalendarDateSeries<N>	colour(ColourData colour)
Comparator<? super CalendarDate>	comparator()
void	complete()	Using the natural sequencing as the key incrementor.
N	compute(CalendarDate key, BiFunction<? super CalendarDate,? super N,? extends N> remappingFunction)
N	computeIfAbsent(CalendarDate key, Function<? super CalendarDate,? extends N> mappingFunction)
N	computeIfPresent(CalendarDate key, BiFunction<? super CalendarDate,? super N,? extends N> remappingFunction)
boolean	containsKey(Object key)
boolean	containsValue(Object value)
NavigableSet<CalendarDate>	descendingKeySet()
NavigableMap<CalendarDate,N>	descendingMap()
Set<Map.Entry<CalendarDate,N>>	entrySet()
boolean	equals(Object o)
Map.Entry<CalendarDate,N>	firstEntry()
CalendarDate	firstKey()
Map.Entry<CalendarDate,N>	floorEntry(CalendarDate key)
CalendarDate	floorKey(CalendarDate key)
void	forEach(BiConsumer<? super CalendarDate,? super N> action)
N	get(Object key)
N	get(CalendarDate key)
long	getAverageStepSize()
ColourData	getColour()
String	getName()
N	getOrDefault(Object key, N defaultValue)
long[]	getPrimitiveKeys()
ExplicitTimeSeries	getPrimitiveTimeSeries()
CalendarDateUnit	getResolution()
int	hashCode()
CalendarDateSeries<N>	headMap(CalendarDate toKey)
CalendarDateSeries<N>	headMap(CalendarDate toKey, boolean inclusive)
Map.Entry<CalendarDate,N>	higherEntry(CalendarDate key)
CalendarDate	higherKey(CalendarDate key)
boolean	isEmpty()
Set<CalendarDate>	keySet()
Map.Entry<CalendarDate,N>	lastEntry()
CalendarDate	lastKey()
Map.Entry<CalendarDate,N>	lowerEntry(CalendarDate key)
CalendarDate	lowerKey(CalendarDate key)
N	merge(CalendarDate key, N value, BiFunction<? super N,? super N,? extends N> remappingFunction)
final CalendarDateSeries<N>	name(String name)
NavigableSet<CalendarDate>	navigableKeySet()
CalendarDate	nextKey()
Map.Entry<CalendarDate,N>	pollFirstEntry()
Map.Entry<CalendarDate,N>	pollLastEntry()
N	put(Calendar key, N value)
N	put(Date key, N value)
N	put(CalendarDate key, N value)
void	putAll(Map<? extends CalendarDate,? extends N> data)
N	putIfAbsent(CalendarDate key, N value)
N	remove(Object key)
boolean	remove(Object key, Object value)
N	replace(CalendarDate key, N value)
boolean	replace(CalendarDate key, N oldValue, N newValue)
void	replaceAll(BiFunction<? super CalendarDate,? super N,? extends N> function)
BasicSeries<CalendarDate,N>	resample(UnaryOperator<CalendarDate> keyTranslator)
BasicSeries<CalendarDate,N>	resample(CalendarDateUnit resolution)
void	setColour(ColourData colour)
void	setName(String name)
int	size()
CalendarDate	step(CalendarDate key)	Will step (increment) the key given to the next in the natural sequence.
CalendarDateSeries<N>	subMap(CalendarDate fromKey, boolean inclusiveFromKey, CalendarDate toKey, boolean inclusiveToKey)
CalendarDateSeries<N>	subMap(CalendarDate fromKey, CalendarDate toKey)
CalendarDateSeries<N>	tailMap(CalendarDate fromKey)
CalendarDateSeries<N>	tailMap(CalendarDate fromKey, boolean inclusive)
String	toString()
Collection<N>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojalgo.series.BasicSeries

asPrimitive, colour, complete, doubleValue, firstValue, get, getColour, getName, lastValue, name, put, put, putAll, resample, setColour, setName

Methods inherited from interface java.util.Map

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

Methods inherited from interface java.util.NavigableMap

reversed

Methods inherited from interface java.util.SequencedMap

sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface java.util.SortedMap

comparator, entrySet, firstKey, keySet, lastKey, putFirst, putLast, values

Constructor Details

CalendarDateSeries

public CalendarDateSeries()

CalendarDateSeries

public CalendarDateSeries(CalendarDateUnit resolution)

Method Details

complete

public void complete()

Description copied from interface: BasicSeries.NaturallySequenced

Using the natural sequencing as the key incrementor.

Specified by:

complete in interface BasicSeries.NaturallySequenced<CalendarDate,N extends Comparable<N>>

See Also:

• BasicSeries.complete(UnaryOperator)

get

public N get(CalendarDate key)

Specified by:

get in interface BasicSeries<CalendarDate,N extends Comparable<N>>

getAverageStepSize

public long getAverageStepSize()

getPrimitiveKeys

public long[] getPrimitiveKeys()

getPrimitiveTimeSeries

public ExplicitTimeSeries getPrimitiveTimeSeries()

getResolution

public CalendarDateUnit getResolution()

headMap

public CalendarDateSeries<N> headMap(CalendarDate toKey)

Specified by:

headMap in interface NavigableMap<CalendarDate,N extends Comparable<N>>

Specified by:

headMap in interface SortedMap<CalendarDate,N extends Comparable<N>>

headMap

public CalendarDateSeries<N> headMap(CalendarDate toKey,
 boolean inclusive)

Specified by:

headMap in interface NavigableMap<CalendarDate,N extends Comparable<N>>

nextKey

public CalendarDate nextKey()

Specified by:

nextKey in interface BasicSeries.NaturallySequenced<CalendarDate,N extends Comparable<N>>

Returns:

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

put

public N put(Calendar key,
 N value)

put

public N put(CalendarDate key,
 N value)

Specified by:

put in interface Map<CalendarDate,N extends Comparable<N>>

put

public N put(Date key,
 N value)

putAll

public void putAll(Map<? extends CalendarDate,? extends N> data)

Specified by:

putAll in interface Map<CalendarDate,N extends Comparable<N>>

resample

public BasicSeries<CalendarDate,N> resample(CalendarDateUnit resolution)

resample

public BasicSeries<CalendarDate,N> resample(UnaryOperator<CalendarDate> keyTranslator)

Specified by:

resample in interface BasicSeries<CalendarDate,N extends Comparable<N>>

step

public CalendarDate step(CalendarDate key)

Description copied from interface: BasicSeries.NaturallySequenced

Will step (increment) the key given to the next in the natural sequence.

Specified by:

step in interface BasicSeries.NaturallySequenced<CalendarDate,N extends Comparable<N>>

subMap

public CalendarDateSeries<N> subMap(CalendarDate fromKey,
 boolean inclusiveFromKey,
 CalendarDate toKey,
 boolean inclusiveToKey)

Specified by:

subMap in interface NavigableMap<CalendarDate,N extends Comparable<N>>

subMap

public CalendarDateSeries<N> subMap(CalendarDate fromKey,
 CalendarDate toKey)

Specified by:

subMap in interface NavigableMap<CalendarDate,N extends Comparable<N>>

Specified by:

subMap in interface SortedMap<CalendarDate,N extends Comparable<N>>

tailMap

public CalendarDateSeries<N> tailMap(CalendarDate fromKey)

Specified by:

tailMap in interface NavigableMap<CalendarDate,N extends Comparable<N>>

Specified by:

tailMap in interface SortedMap<CalendarDate,N extends Comparable<N>>

tailMap

public CalendarDateSeries<N> tailMap(CalendarDate fromKey,
 boolean inclusive)

Specified by:

tailMap in interface NavigableMap<CalendarDate,N extends Comparable<N>>

toString

public String toString()

ceilingEntry

public Map.Entry<CalendarDate,N> ceilingEntry(CalendarDate key)

Specified by:

ceilingEntry in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

ceilingKey

public CalendarDate ceilingKey(CalendarDate key)

Specified by:

ceilingKey in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

clear

public void clear()

Specified by:

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

colour

public final CalendarDateSeries<N> colour(ColourData colour)

Specified by:

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

comparator

public Comparator<? super CalendarDate> comparator()

Specified by:

comparator in interface SortedMap<K extends Comparable<? super K>,V extends Comparable<V>>

compute

public N compute(CalendarDate key,
 BiFunction<? super CalendarDate,? super N,? extends N> remappingFunction)

Specified by:

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

computeIfAbsent

public N computeIfAbsent(CalendarDate key,
 Function<? super CalendarDate,? extends N> mappingFunction)

Specified by:

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

computeIfPresent

public N computeIfPresent(CalendarDate key,
 BiFunction<? super CalendarDate,? super N,? extends N> remappingFunction)

Specified by:

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

containsKey

public boolean containsKey(Object key)

Specified by:

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

containsValue

public boolean containsValue(Object value)

Specified by:

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

descendingKeySet

public NavigableSet<CalendarDate> descendingKeySet()

Specified by:

descendingKeySet in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

descendingMap

public NavigableMap<CalendarDate,N> descendingMap()

Specified by:

descendingMap in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

entrySet

public Set<Map.Entry<CalendarDate,N>> entrySet()

Specified by:

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

Specified by:

entrySet in interface SortedMap<K extends Comparable<? super K>,V extends Comparable<V>>

equals

public boolean equals(Object o)

Specified by:

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

Overrides:

equals in class Object

firstEntry

public Map.Entry<CalendarDate,N> firstEntry()

Specified by:

firstEntry in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

Specified by:

firstEntry in interface SequencedMap<K extends Comparable<? super K>,V extends Comparable<V>>

firstKey

public CalendarDate firstKey()

Specified by:

firstKey in interface SortedMap<K extends Comparable<? super K>,V extends Comparable<V>>

floorEntry

public Map.Entry<CalendarDate,N> floorEntry(CalendarDate key)

Specified by:

floorEntry in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

floorKey

public CalendarDate floorKey(CalendarDate key)

Specified by:

floorKey in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

forEach

public void forEach(BiConsumer<? super CalendarDate,? super N> action)

Specified by:

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

get

public N get(Object key)

Specified by:

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

Specified by:

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

getColour

public ColourData getColour()

Specified by:

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

getName

public String getName()

Specified by:

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

getOrDefault

public N getOrDefault(Object key,
 N defaultValue)

Specified by:

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

hashCode

public int hashCode()

Specified by:

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

Overrides:

hashCode in class Object

higherEntry

public Map.Entry<CalendarDate,N> higherEntry(CalendarDate key)

Specified by:

higherEntry in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

higherKey

public CalendarDate higherKey(CalendarDate key)

Specified by:

higherKey in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

isEmpty

public boolean isEmpty()

Specified by:

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

keySet

public Set<CalendarDate> keySet()

Specified by:

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

Specified by:

keySet in interface SortedMap<K extends Comparable<? super K>,V extends Comparable<V>>

lastEntry

public Map.Entry<CalendarDate,N> lastEntry()

Specified by:

lastEntry in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

Specified by:

lastEntry in interface SequencedMap<K extends Comparable<? super K>,V extends Comparable<V>>

lastKey

public CalendarDate lastKey()

Specified by:

lastKey in interface SortedMap<K extends Comparable<? super K>,V extends Comparable<V>>

lowerEntry

public Map.Entry<CalendarDate,N> lowerEntry(CalendarDate key)

Specified by:

lowerEntry in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

lowerKey

public CalendarDate lowerKey(CalendarDate key)

Specified by:

lowerKey in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

merge

public N merge(CalendarDate key,
 N value,
 BiFunction<? super N,? super N,? extends N> remappingFunction)

Specified by:

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

name

public final CalendarDateSeries<N> name(String name)

Specified by:

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

navigableKeySet

public NavigableSet<CalendarDate> navigableKeySet()

Specified by:

navigableKeySet in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

pollFirstEntry

public Map.Entry<CalendarDate,N> pollFirstEntry()

Specified by:

pollFirstEntry in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

Specified by:

pollFirstEntry in interface SequencedMap<K extends Comparable<? super K>,V extends Comparable<V>>

pollLastEntry

public Map.Entry<CalendarDate,N> pollLastEntry()

Specified by:

pollLastEntry in interface NavigableMap<K extends Comparable<? super K>,V extends Comparable<V>>

Specified by:

pollLastEntry in interface SequencedMap<K extends Comparable<? super K>,V extends Comparable<V>>

putIfAbsent

public N putIfAbsent(CalendarDate key,
 N value)

Specified by:

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

remove

public N remove(Object key)

Specified by:

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

remove

public boolean remove(Object key,
 Object value)

Specified by:

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

replace

public N replace(CalendarDate key,
 N value)

Specified by:

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

replace

public boolean replace(CalendarDate key,
 N oldValue,
 N newValue)

Specified by:

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

replaceAll

public void replaceAll(BiFunction<? super CalendarDate,? super N,? extends N> function)

Specified by:

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

setColour

public void setColour(ColourData colour)

Specified by:

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

setName

public void setName(String name)

Specified by:

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

size

public int size()

Specified by:

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

values

public Collection<N> values()

Specified by:

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

Specified by:

values in interface SortedMap<K extends Comparable<? super K>,V extends Comparable<V>>