Package org.ojalgo.series
Interface BasicSeries<K extends Comparable<? super K>,V extends Comparable<V>>
- All Superinterfaces:
Map<K,
,V> SequencedMap<K,
,V> SortedMap<K,
V>
- All Known Subinterfaces:
BasicSeries.NaturallySequenced<K,
V>
- All Known Implementing Classes:
CalendarDateSeries
,MappedIndexSeries
,NumberSeries
,SimpleSeries
,TreeSeries
public interface BasicSeries<K extends Comparable<? super K>,V extends Comparable<V>>
extends 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 ClassesModifier and TypeInterfaceDescriptionstatic interface
BasicSeries.NaturallySequenced<K extends Comparable<? super K>,
V extends Comparable<V>> A series with naturally sequenced keys - given any key there is a natural "next" key, e.g.static final class
BasicSeries.TimeSeriesBuilder<K extends Comparable<? super K>>
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final BasicSeries.TimeSeriesBuilder
<Calendar> static final BasicSeries.TimeSeriesBuilder
<CalendarDate> static final BasicSeries.TimeSeriesBuilder
<Date> static final BasicSeries.TimeSeriesBuilder
<Instant> static final BasicSeries.TimeSeriesBuilder
<LocalDate> static final BasicSeries.TimeSeriesBuilder
<LocalDateTime> static final BasicSeries.TimeSeriesBuilder
<LocalTime> static final BasicSeries.TimeSeriesBuilder
<OffsetDateTime> static final BasicSeries.TimeSeriesBuilder
<ZonedDateTime> -
Method Summary
Modifier and TypeMethodDescriptiondefault PrimitiveSeries
default BasicSeries
<K, V> colour
(ColourData colour) default void
complete
(UnaryOperator<K> keyIncrementor) Will fill in missing values, inbetween the first and last keys.static <K extends Comparable<? super K>>
CoordinatedSet<K> coordinate
(List<? extends BasicSeries<K, ?>> uncoordinated) default double
doubleValue
(K key) static <K extends Comparable<? super K>>
KfindEarliestFirstKey
(Collection<? extends BasicSeries<K, ?>> collection) static <K extends Comparable<? super K>>
KfindEarliestLastKey
(Collection<? extends BasicSeries<K, ?>> collection) static <K extends Comparable<? super K>>
KfindLatestFirstKey
(Collection<? extends BasicSeries<K, ?>> collection) static <K extends Comparable<? super K>>
KfindLatestLastKey
(Collection<? extends BasicSeries<K, ?>> collection) default V
default V
getName()
default V
static BasicSeries
<Double, Double> make
(DenseArray.Factory<Double> arrayFactory) static BasicSeries
<Double, Double> make
(DenseArray.Factory<Double> arrayFactory, BinaryFunction<Double> accumulator) static <N extends Comparable<N>>
BasicSeries<N, N> make
(DenseArray.Factory<N> arrayFactory, Structure1D.IndexMapper<N> indexMapper) static <N extends Comparable<N>>
BasicSeries<N, N> make
(DenseArray.Factory<N> arrayFactory, Structure1D.IndexMapper<N> indexMapper, BinaryFunction<N> accumulator) default BasicSeries
<K, V> default double
Will only work if values are types as Double.default double
put
(EntryPair.KeyedPrimitive<K> entry) default void
putAll
(Collection<? extends EntryPair<? extends K, ? extends V>> data) default <K2 extends Comparable<? super K2>>
voidresample
(Function<K, K2> keyTranslator, BasicSeries<K2, V> destination) resample
(UnaryOperator<K> keyTranslator) void
setColour
(ColourData colour) void
Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size
Methods inherited from interface java.util.SequencedMap
firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues
-
Field Details
-
CALENDAR
-
CALENDAR_DATE
-
DATE
-
INSTANT
-
LOCAL_DATE
-
LOCAL_DATE_TIME
-
LOCAL_TIME
-
OFFSET_DATE_TIME
-
ZONED_DATE_TIME
-
-
Method Details
-
coordinate
static <K extends Comparable<? super K>> CoordinatedSet<K> coordinate(List<? extends BasicSeries<K, ?>> uncoordinated) -
findEarliestFirstKey
static <K extends Comparable<? super K>> K findEarliestFirstKey(Collection<? extends BasicSeries<K, ?>> collection) -
findEarliestLastKey
static <K extends Comparable<? super K>> K findEarliestLastKey(Collection<? extends BasicSeries<K, ?>> collection) -
findLatestFirstKey
static <K extends Comparable<? super K>> K findLatestFirstKey(Collection<? extends BasicSeries<K, ?>> collection) -
findLatestLastKey
static <K extends Comparable<? super K>> K findLatestLastKey(Collection<? extends BasicSeries<K, ?>> collection) -
make
-
make
static BasicSeries<Double,Double> make(DenseArray.Factory<Double> arrayFactory, BinaryFunction<Double> accumulator) -
make
static <N extends Comparable<N>> BasicSeries<N,N> make(DenseArray.Factory<N> arrayFactory, Structure1D.IndexMapper<N> indexMapper) -
make
static <N extends Comparable<N>> BasicSeries<N,N> make(DenseArray.Factory<N> arrayFactory, Structure1D.IndexMapper<N> indexMapper, BinaryFunction<N> accumulator) -
asPrimitive
-
colour
-
complete
Will fill in missing values, inbetween the first and last keys. -
doubleValue
-
firstValue
-
get
-
get
- Specified by:
get
in interfaceMap<K extends Comparable<? super K>,
V extends Comparable<V>>
-
getColour
ColourData getColour() -
getName
String getName() -
lastValue
-
name
-
put
-
put
Will only work if values are types as Double.- See Also:
-
putAll
-
resample
default <K2 extends Comparable<? super K2>> void resample(Function<K, K2> keyTranslator, BasicSeries<K2, V> destination) -
resample
-
setColour
-
setName
-