DateSeries (tech.bitey:dataframe 0.3.2 API)

All Superinterfaces:

Collection<Row>, DataFrame, Iterable<Row>, List<Row>, RandomAccess

All Known Implementing Classes:

DateSeriesImpl
```
public interface DateSeries
extends DataFrame
```
A time series specialization of DataFrame. A DateSeries is a DataFrame with exactly two columns:
1. The first column must be a unique index of ColumnType.DATE.
2. The second column must be a non-null column of ColumnType.DOUBLE.
A Row in a time series can be thought of as a (date,value) point.
Author:

biteytech@protonmail.com

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`DateSeries`	`append(DateSeries df)` Appends the specified `DateSeries` to this one by calling `Column.append(Column)` on both the key and value columns, and keeping the meta-data from this dataframe.
`Map<LocalDate,Double>`	`asMap()` Returns an immutable `Map` view of this time series.
`DateSeries`	`empty()` Returns an empty `DateSeries`.
`DateSeries`	`filter(Predicate<Row> criteria)` Returns a `DateSeries` containing the points which pass the specified `Predicate`.
`default LocalDate`	`getDate(int index)` Returns the date for the point at the specified index.
`default double`	`getValue(int index)` Returns the value for the point at the specified index.
`DateSeries`	`head()` Returns a `DateSeries` containing the first 10 points from this time series, or this time series if it contains fewer than 10 points.
`DateSeries`	`head(int count)` Returns a `DateSeries` containing the first `count` points from this time series, or this time series if it contains fewer than `count` points.
`DateSeries`	`headTo(LocalDate toKey)` Returns a `DateSeries` containing the points with dates strictly less than `toKey`.
`DateSeries`	`sampleN(int sampleSize)` Returns a `DateSeries` containing `sampleSize` points selected at random.
`DateSeries`	`sampleX(double proportion)` Returns a `DateSeries` containing `size()*proportion` points selected at random.
`DateSeries`	`subSeries(int fromIndex, int toIndex)` Returns a `DateSeries` containing the points between the specified `fromIndex`, inclusive, and `toIndex`, exclusive (if `fromIndex` and `toIndex` are equal, the returned time series is empty).
`DateSeries`	`subSeries(LocalDate fromKey, boolean fromInclusive, LocalDate toKey, boolean toInclusive)` Returns a `DateSeries` containing the points with dates between `fromKey` and `toKey`.
`DateSeries`	`subSeries(LocalDate fromKey, LocalDate toKey)` Returns a `DateSeries` containing the points with dates are greater than or equal to `fromKey` and strictly less than `toKey`.
`DateSeries`	`tail()` Returns a `DateSeries` containing the last 10 points from this time series, or this time series if it contains fewer than 10 points.
`DateSeries`	`tail(int count)` Returns a `DateSeries` containing the last `count` points from this dataframe, or this time series if it contains fewer than `count` points.
`DateSeries`	`tailFrom(LocalDate fromKey)` Returns a `DateSeries` containing the points with dates greater than or equal to `fromKey`.
`default DateSeries`	`toDateSeries(int columnIndex)` Returns this time series
`default DateSeries`	`toDateSeries(String columnName)` Returns this time series
`DateSeries`	`transform(DateSeries series, DoubleBinaryOperator op)` Joins this time series with the specifies series, and combines their values point-wise using the specified operation.
`DateSeries`	`transform(DoubleUnaryOperator op)` Returns a new time series where the values have been transformed by the provided operation.
`default int`	`yyyymmdd(int index)` Returns the yyyymmdd-format date for the point at the specified index.

Methods inherited from interface tech.bitey.dataframe.DataFrame
append, append, booleanColumn, booleanColumn, column, column, columnCount, columnIndex, columnMap, columnName, columnNames, columns, columnType, columnType, columnTypes, copy, cursor, cursor, dateColumn, dateColumn, dateTimeColumn, dateTimeColumn, decimalColumn, decimalColumn, deriveColumn, deriveColumn, deriveColumn, deriveColumn, deriveColumn, deriveColumn, doubleColumn, doubleColumn, dropColumns, dropColumns, dropColumns, equals, filterNulls, floatColumn, floatColumn, get, get, getBigDecimal, getBigDecimal, getBoolean, getBoolean, getDate, getDate, getDateTime, getDateTime, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getOrDefaultDouble, getOrDefaultDouble, getOrDefaultFloat, getOrDefaultFloat, getOrDefaultInt, getOrDefaultInt, getOrDefaultLong, getOrDefaultLong, getOrDefaultShort, getOrDefaultShort, getShort, getShort, getString, getString, hasKeyColumn, headTo, indexOrganize, indexOrganize, intColumn, intColumn, isNull, isNull, join, join, joinLeftOneToMany, joinManyToOne, joinOneToMany, keyColumnIndex, keyColumnName, keyColumnType, longColumn, longColumn, selectColumns, selectColumns, selectColumns, shortColumn, shortColumn, spliterator, stringColumn, stringColumn, subFrame, subFrameByValue, subFrameByValue, tailFrom, toMap, toMap, withColumn, withColumns, withColumns, withColumns, withKeyColumn, withKeyColumn, writeCsvTo, writeCsvTo, writeTo, writeTo, writeTo, writeTo, yyyymmdd, yyyymmdd

Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, subList, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - transform
```
DateSeries transform(DoubleUnaryOperator op)
```
    Returns a new time series where the values have been transformed by the provided operation.
    The resulting time series will have the same column names.
    
    Parameters:
    
    op - - the operation used to transform the values
    
    Returns:
    
    a new time series where the values have been transformed by the provided operation.
  - transform
```
DateSeries transform(DateSeries series,
                     DoubleBinaryOperator op)
```
    Joins this time series with the specifies series, and combines their values point-wise using the specified operation.
    The resulting time series will have the same column names as this one.
    
    Parameters:
    
    series - - the series to be joined with this one
    
    op - - the operation used to combine the values
    
    Returns:
    
    the new joint time series with value combined using the specified operation
  - asMap
```
Map<LocalDate,Double> asMap()
```
    Returns an immutable Map view of this time series.
    
    Returns:
    
    an immutable Map view of this time series.
  - getDate
```
default LocalDate getDate(int index)
```
    Returns the date for the point at the specified index.
    
    Parameters:
    
    index - - the point/row index
    
    Returns:
    
    the date for the point at the specified index.
    
    Throws:
    
    IndexOutOfBoundsException - if index is negative or is not less than List.size()
  - yyyymmdd
```
default int yyyymmdd(int index)
```
    Returns the yyyymmdd-format date for the point at the specified index.
    
    Parameters:
    
    index - - the point/row index
    
    Returns:
    
    the yyyymmdd-format date for the point at the specified index.
    
    Throws:
    
    IndexOutOfBoundsException - if index is negative or is not less than List.size()
  - getValue
```
default double getValue(int index)
```
    Returns the value for the point at the specified index.
    
    Parameters:
    
    index - - the point/row index
    
    Returns:
    
    the value for the point at the specified index.
    
    Throws:
    
    IndexOutOfBoundsException - if index is negative or is not less than List.size()
  - toDateSeries
```
default DateSeries toDateSeries(int columnIndex)
```
    Returns this time series
    
    Specified by:
    
    toDateSeries in interface DataFrame
    
    Parameters:
    
    columnIndex - - ignored
    
    Returns:
    
    this time series
  - toDateSeries
```
default DateSeries toDateSeries(String columnName)
```
    Returns this time series
    
    Specified by:
    
    toDateSeries in interface DataFrame
    
    Parameters:
    
    columnName - - ignored
    
    Returns:
    
    this time series
  - sampleN
```
DateSeries sampleN(int sampleSize)
```
    Returns a DateSeries containing sampleSize points selected at random.
    
    Specified by:
    
    sampleN in interface DataFrame
    
    Parameters:
    
    sampleSize - - the number of points to sample from this time series
    
    Returns:
    
    a dataframe containing sampleSize points selected at random.
    
    Throws:
    
    IndexOutOfBoundsException - if sampleSize is negative or is greater than #size()
  - sampleX
```
DateSeries sampleX(double proportion)
```
    Returns a DateSeries containing size()*proportion points selected at random.
    
    Specified by:
    
    sampleX in interface DataFrame
    
    Parameters:
    
    proportion - - a number between 0.0 and 1.0 inclusive
    
    Returns:
    
    a dataframe containing size()*proportion points selected at random.
  - filter
```
DateSeries filter(Predicate<Row> criteria)
```
    Returns a DateSeries containing the points which pass the specified Predicate.
    
    Specified by:
    
    filter in interface DataFrame
    
    Parameters:
    
    criteria - - the Predicate used to filter the points in this time series
    
    Returns:
    
    a DateSeries containing the points which pass the specified Predicate.
  - append
```
DateSeries append(DateSeries df)
```
    Appends the specified DateSeries to this one by calling Column.append(Column) on both the key and value columns, and keeping the meta-data from this dataframe.
    
    Parameters:
    
    df - - the time series to be appended to this one
    
    Returns:
    
    a new DateSeries resulting from appended the specified time series to this one.
  - head
```
DateSeries head(int count)
```
    Returns a DateSeries containing the first count points from this time series, or this time series if it contains fewer than count points.
    
    Specified by:
    
    head in interface DataFrame
    
    Parameters:
    
    count - - number of points to return from the "top" or "head" of this time series.
    
    Returns:
    
    a DateSeries containing the first count points from this time series.
  - empty
```
DateSeries empty()
```
    Returns an empty DateSeries. The resulting time series will have the same meta-data (column names) as this one, but the key and value columns will be empty.
    
    Specified by:
    
    empty in interface DataFrame
    
    Returns:
    
    an empty DateSeries with the same meta-data as this one.
  - head
```
DateSeries head()
```
    Returns a DateSeries containing the first 10 points from this time series, or this time series if it contains fewer than 10 points.
    
    Specified by:
    
    head in interface DataFrame
    
    Returns:
    
    a DateSeries containing the first 10 points from this time series.
  - tail
```
DateSeries tail(int count)
```
    Returns a DateSeries containing the last count points from this dataframe, or this time series if it contains fewer than count points.
    
    Specified by:
    
    tail in interface DataFrame
    
    Parameters:
    
    count - - number of points to return from the "end" or "tail" of this time series.
    
    Returns:
    
    a DateSeries containing the last count points from this time series.
  - tail
```
DateSeries tail()
```
    Returns a DateSeries containing the last 10 points from this time series, or this time series if it contains fewer than 10 points.
    
    Specified by:
    
    tail in interface DataFrame
    
    Returns:
    
    a DateSeries containing the last 10 points from this time series.
  - subSeries
```
DateSeries subSeries(int fromIndex,
                     int toIndex)
```
    Returns a DateSeries containing the points between the specified fromIndex, inclusive, and toIndex, exclusive (if fromIndex and toIndex are equal, the returned time series is empty).
    
    Parameters:
    
    fromIndex - - index of the lowest point (inclusive)
    
    toIndex - - index of the highest point (exclusive)
    
    Returns:
    
    a DateSeries containing the points between the specified fromIndex, inclusive, and toIndex, exclusive
    
    Throws:
    
    IndexOutOfBoundsException - if either index is negative or is greater than List.size(), or if toIndex is less than fromIndex
  - headTo
```
DateSeries headTo(LocalDate toKey)
```
    Returns a DateSeries containing the points with dates strictly less than toKey.
    
    Parameters:
    
    toKey - high endpoint (exclusive) of the dates in the returned time series
    
    Returns:
    
    the points from this time series whose dates are strictly less than toKey.
    
    Throws:
    
    NullPointerException - if toKey is null
  - tailFrom
```
DateSeries tailFrom(LocalDate fromKey)
```
    Returns a DateSeries containing the points with dates greater than or equal to fromKey.
    
    Parameters:
    
    fromKey - low endpoint (inclusive) of the dates in the returned time series
    
    Returns:
    
    the points from this dataframe whose dates are greater than or equal to fromKey.
    
    Throws:
    
    NullPointerException - if fromKey is null
  - subSeries
```
DateSeries subSeries(LocalDate fromKey,
                     LocalDate toKey)
```
    Returns a DateSeries containing the points with dates are greater than or equal to fromKey and strictly less than toKey.
    
    Parameters:
    
    fromKey - low endpoint (inclusive) of the dates in the returned time series
    
    toKey - high endpoint (exclusive) of the dates in the returned time series
    
    Returns:
    
    the points from this time series whose dates are greater than or equal to fromKey and strictly less than toKey.
    
    Throws:
    
    NullPointerException - if either key is null
  - subSeries
```
DateSeries subSeries(LocalDate fromKey,
                     boolean fromInclusive,
                     LocalDate toKey,
                     boolean toInclusive)
```
    Returns a DateSeries containing the points with dates between fromKey and toKey. If fromKey and toKey are equal, the resulting time series is empty unless fromInclusive and toInclusive are both true.
    
    Parameters:
    
    fromKey - low endpoint (inclusive) of the dates in the returned time series
    
    fromInclusive - true if the low endpoint is to be included in the result
    
    toKey - high endpoint (exclusive) of the dates in the returned time series
    
    toInclusive - true if the high endpoint is to be included in the result
    
    Returns:
    
    the points from this dataframe whose dates are between fromKey and toKey.
    
    Throws:
    
    NullPointerException - if either key is null

Interface DateSeries

Method Summary

Methods inherited from interface tech.bitey.dataframe.DataFrame

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Method Detail

transform

transform

asMap

getDate

yyyymmdd

getValue

toDateSeries

toDateSeries

sampleN

sampleX

filter

append

head

empty

head

tail

tail

subSeries

headTo

tailFrom

subSeries

subSeries