Package org.ojalgo.series
Interface BasicSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
-
- All Superinterfaces:
java.util.Map<K,V>
,java.util.SortedMap<K,V>
- All Known Subinterfaces:
BasicSeries.NaturallySequenced<K,V>
- All Known Implementing Classes:
CalendarDateSeries
,MappedIndexSeries
,NumberSeries
,SimpleSeries
,TreeSeries
public interface BasicSeries<K extends java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>> extends java.util.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 implementingNumberDefinition
. - 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 java.lang.Comparable<? super K>,V extends java.lang.Comparable<V>>
A series with naturally sequenced keys - given any key there is a natural "next" key, e.g.static class
BasicSeries.TimeSeriesBuilder<K extends java.lang.Comparable<? super K>>
-
Field Summary
Fields Modifier and Type Field Description static BasicSeries.TimeSeriesBuilder<java.util.Calendar>
CALENDAR
static BasicSeries.TimeSeriesBuilder<CalendarDate>
CALENDAR_DATE
static BasicSeries.TimeSeriesBuilder<java.util.Date>
DATE
static BasicSeries.TimeSeriesBuilder<java.time.Instant>
INSTANT
static BasicSeries.TimeSeriesBuilder<java.time.LocalDate>
LOCAL_DATE
static BasicSeries.TimeSeriesBuilder<java.time.LocalDateTime>
LOCAL_DATE_TIME
static BasicSeries.TimeSeriesBuilder<java.time.LocalTime>
LOCAL_TIME
static BasicSeries.TimeSeriesBuilder<java.time.OffsetDateTime>
OFFSET_DATE_TIME
static BasicSeries.TimeSeriesBuilder<java.time.ZonedDateTime>
ZONED_DATE_TIME
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default PrimitiveSeries
asPrimitive()
default BasicSeries<K,V>
colour(ColourData colour)
default void
complete(java.util.function.UnaryOperator<K> keyIncrementor)
Will fill in missing values, inbetween the first and last keys.static <K extends java.lang.Comparable<? super K>>
CoordinatedSet<K>coordinate(java.util.List<? extends BasicSeries<K,?>> uncoordinated)
default double
doubleValue(K key)
static <K extends java.lang.Comparable<? super K>>
KfindEarliestFirstKey(java.util.Collection<? extends BasicSeries<K,?>> collection)
static <K extends java.lang.Comparable<? super K>>
KfindEarliestLastKey(java.util.Collection<? extends BasicSeries<K,?>> collection)
static <K extends java.lang.Comparable<? super K>>
KfindLatestFirstKey(java.util.Collection<? extends BasicSeries<K,?>> collection)
static <K extends java.lang.Comparable<? super K>>
KfindLatestLastKey(java.util.Collection<? extends BasicSeries<K,?>> collection)
default V
firstValue()
default V
get(java.lang.Object key)
V
get(K key)
ColourData
getColour()
java.lang.String
getName()
default V
lastValue()
static BasicSeries<java.lang.Double,java.lang.Double>
make(DenseArray.Factory<java.lang.Double> arrayFactory)
static BasicSeries<java.lang.Double,java.lang.Double>
make(DenseArray.Factory<java.lang.Double> arrayFactory, BinaryFunction<java.lang.Double> accumulator)
static <N extends java.lang.Comparable<N>>
BasicSeries<N,N>make(DenseArray.Factory<N> arrayFactory, Structure1D.IndexMapper<N> indexMapper)
static <N extends java.lang.Comparable<N>>
BasicSeries<N,N>make(DenseArray.Factory<N> arrayFactory, Structure1D.IndexMapper<N> indexMapper, BinaryFunction<N> accumulator)
default BasicSeries<K,V>
name(java.lang.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(java.util.Collection<? extends EntryPair<? extends K,? extends V>> data)
default <K2 extends java.lang.Comparable<? super K2>>
voidresample(java.util.function.Function<K,K2> keyTranslator, BasicSeries<K2,V> destination)
BasicSeries<K,V>
resample(java.util.function.UnaryOperator<K> keyTranslator)
void
setColour(ColourData colour)
void
setName(java.lang.String name)
-
-
-
Field Detail
-
CALENDAR
static final BasicSeries.TimeSeriesBuilder<java.util.Calendar> CALENDAR
-
CALENDAR_DATE
static final BasicSeries.TimeSeriesBuilder<CalendarDate> CALENDAR_DATE
-
DATE
static final BasicSeries.TimeSeriesBuilder<java.util.Date> DATE
-
INSTANT
static final BasicSeries.TimeSeriesBuilder<java.time.Instant> INSTANT
-
LOCAL_DATE
static final BasicSeries.TimeSeriesBuilder<java.time.LocalDate> LOCAL_DATE
-
LOCAL_DATE_TIME
static final BasicSeries.TimeSeriesBuilder<java.time.LocalDateTime> LOCAL_DATE_TIME
-
LOCAL_TIME
static final BasicSeries.TimeSeriesBuilder<java.time.LocalTime> LOCAL_TIME
-
OFFSET_DATE_TIME
static final BasicSeries.TimeSeriesBuilder<java.time.OffsetDateTime> OFFSET_DATE_TIME
-
ZONED_DATE_TIME
static final BasicSeries.TimeSeriesBuilder<java.time.ZonedDateTime> ZONED_DATE_TIME
-
-
Method Detail
-
coordinate
static <K extends java.lang.Comparable<? super K>> CoordinatedSet<K> coordinate(java.util.List<? extends BasicSeries<K,?>> uncoordinated)
-
findEarliestFirstKey
static <K extends java.lang.Comparable<? super K>> K findEarliestFirstKey(java.util.Collection<? extends BasicSeries<K,?>> collection)
-
findEarliestLastKey
static <K extends java.lang.Comparable<? super K>> K findEarliestLastKey(java.util.Collection<? extends BasicSeries<K,?>> collection)
-
findLatestFirstKey
static <K extends java.lang.Comparable<? super K>> K findLatestFirstKey(java.util.Collection<? extends BasicSeries<K,?>> collection)
-
findLatestLastKey
static <K extends java.lang.Comparable<? super K>> K findLatestLastKey(java.util.Collection<? extends BasicSeries<K,?>> collection)
-
make
static BasicSeries<java.lang.Double,java.lang.Double> make(DenseArray.Factory<java.lang.Double> arrayFactory)
-
make
static BasicSeries<java.lang.Double,java.lang.Double> make(DenseArray.Factory<java.lang.Double> arrayFactory, BinaryFunction<java.lang.Double> accumulator)
-
make
static <N extends java.lang.Comparable<N>> BasicSeries<N,N> make(DenseArray.Factory<N> arrayFactory, Structure1D.IndexMapper<N> indexMapper)
-
make
static <N extends java.lang.Comparable<N>> BasicSeries<N,N> make(DenseArray.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(java.util.function.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
default V get(java.lang.Object key)
-
getColour
ColourData getColour()
-
getName
java.lang.String getName()
-
lastValue
default V lastValue()
-
name
default BasicSeries<K,V> name(java.lang.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:
#put(Comparable, Number)
-
putAll
default void putAll(java.util.Collection<? extends EntryPair<? extends K,? extends V>> data)
-
resample
default <K2 extends java.lang.Comparable<? super K2>> void resample(java.util.function.Function<K,K2> keyTranslator, BasicSeries<K2,V> destination)
-
resample
BasicSeries<K,V> resample(java.util.function.UnaryOperator<K> keyTranslator)
-
setColour
void setColour(ColourData colour)
-
setName
void setName(java.lang.String name)
-
-