Module ojalgo

Package org.ojalgo.series

Class NumberSeries<N extends Comparable<N>>

java.lang.Object

org.ojalgo.series.NumberSeries<N>

All Implemented Interfaces:

Map<N,N>, NavigableMap<N,N>, SequencedMap<N,N>, SortedMap<N,N>, BasicSeries<N,N>

public class NumberSeries<N extends Comparable<N>>
extends Object

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
NumberSeries()
NumberSeries(Map<? extends N,? extends N> map)
NumberSeries(SortedMap<N,? extends N> sortedMap)

Method Summary

Modifier and Type	Method	Description
Access1D<N>	accessKeys()
Access1D<N>	accessValues()
Map.Entry<N,N>	ceilingEntry(N key)
N	ceilingKey(N key)
void	clear()
final NumberSeries<N>	colour(ColourData colour)
Comparator<? super N>	comparator()
N	compute(N key, BiFunction<? super N,? super N,? extends N> remappingFunction)
N	computeIfAbsent(N key, Function<? super N,? extends N> mappingFunction)
N	computeIfPresent(N key, BiFunction<? super N,? super N,? extends N> remappingFunction)
boolean	containsKey(Object key)
boolean	containsValue(Object value)
NavigableSet<N>	descendingKeySet()
NavigableMap<N,N>	descendingMap()
double	doubleValue(N key)
Set<Map.Entry<N,N>>	entrySet()
boolean	equals(Object o)
Map.Entry<N,N>	firstEntry()
N	firstKey()
Map.Entry<N,N>	floorEntry(N key)
N	floorKey(N key)
void	forEach(BiConsumer<? super N,? super N> action)
N	get(Object key)
N	get(N key)
ColourData	getColour()
String	getName()
N	getOrDefault(Object key, N defaultValue)
int	hashCode()
SortedMap<N,N>	headMap(N toKey)
NavigableMap<N,N>	headMap(N toKey, boolean inclusive)
Map.Entry<N,N>	higherEntry(N key)
N	higherKey(N key)
boolean	isEmpty()
Set<N>	keySet()
Map.Entry<N,N>	lastEntry()
N	lastKey()
Map.Entry<N,N>	lowerEntry(N key)
N	lowerKey(N key)
N	merge(N key, N value, BiFunction<? super N,? super N,? extends N> remappingFunction)
final NumberSeries<N>	name(String name)
NavigableSet<N>	navigableKeySet()
Map.Entry<N,N>	pollFirstEntry()
Map.Entry<N,N>	pollLastEntry()
N	put(N key, N value)
void	putAll(Map<? extends N,? extends N> m)
N	putIfAbsent(N key, N value)
N	remove(Object key)
boolean	remove(Object key, Object value)
N	replace(N key, N value)
boolean	replace(N key, N oldValue, N newValue)
void	replaceAll(BiFunction<? super N,? super N,? extends N> function)
BasicSeries<N,N>	resample(UnaryOperator<N> keyTranslator)
void	setColour(ColourData colour)
void	setName(String name)
int	size()
NavigableMap<N,N>	subMap(N fromKey, boolean fromInclusive, N toKey, boolean toInclusive)
SortedMap<N,N>	subMap(N fromKey, N toKey)
SortedMap<N,N>	tailMap(N fromKey)
NavigableMap<N,N>	tailMap(N 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, complete, firstValue, lastValue, put, put, putAll, resample

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

putFirst, putLast

Constructor Details

NumberSeries

public NumberSeries()

NumberSeries

public NumberSeries(Map<? extends N,? extends N> map)

NumberSeries

public NumberSeries(SortedMap<N,? extends N> sortedMap)

Method Details

accessKeys

public Access1D<N> accessKeys()

accessValues

public Access1D<N> accessValues()

doubleValue

public double doubleValue(N key)

get

public N get(N key)

Specified by:

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

resample

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

ceilingEntry

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

Specified by:

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

ceilingKey

public N ceilingKey(N 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 NumberSeries<N> colour(ColourData colour)

Specified by:

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

comparator

public Comparator<? super N> comparator()

Specified by:

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

compute

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

Specified by:

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

computeIfAbsent

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

Specified by:

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

computeIfPresent

public N computeIfPresent(N key,
 BiFunction<? super N,? 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<N> descendingKeySet()

Specified by:

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

descendingMap

public NavigableMap<N,N> descendingMap()

Specified by:

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

entrySet

public Set<Map.Entry<N,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<N,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 N firstKey()

Specified by:

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

floorEntry

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

Specified by:

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

floorKey

public N floorKey(N key)

Specified by:

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

forEach

public void forEach(BiConsumer<? super N,? 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

headMap

public SortedMap<N,N> headMap(N toKey)

Specified by:

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

Specified by:

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

headMap

public NavigableMap<N,N> headMap(N toKey,
 boolean inclusive)

Specified by:

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

higherEntry

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

Specified by:

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

higherKey

public N higherKey(N 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<N> 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<N,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 N lastKey()

Specified by:

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

lowerEntry

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

Specified by:

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

lowerKey

public N lowerKey(N key)

Specified by:

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

merge

public N merge(N 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 NumberSeries<N> name(String name)

Specified by:

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

navigableKeySet

public NavigableSet<N> navigableKeySet()

Specified by:

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

pollFirstEntry

public Map.Entry<N,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<N,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>>

put

public N put(N key,
 N value)

Specified by:

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

putAll

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

Specified by:

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

putIfAbsent

public N putIfAbsent(N 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(N key,
 N value)

Specified by:

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

replace

public boolean replace(N 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 N,? 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>>

subMap

public NavigableMap<N,N> subMap(N fromKey,
 boolean fromInclusive,
 N toKey,
 boolean toInclusive)

Specified by:

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

subMap

public SortedMap<N,N> subMap(N fromKey,
 N toKey)

Specified by:

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

Specified by:

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

tailMap

public SortedMap<N,N> tailMap(N fromKey)

Specified by:

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

Specified by:

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

tailMap

public NavigableMap<N,N> tailMap(N fromKey,
 boolean inclusive)

Specified by:

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

toString

public String toString()

Overrides:

toString in class Object

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