com.github.signaflo.timeseries

Class Ts

java.lang.Object

com.github.signaflo.timeseries.Ts

public final class Ts
extends Object

Static factory constructors for TimeSeries objects.

Method Summary

Modifier and Type	Method and Description
static TimeSeries	newAnnualSeries(double... series) Construct a new time series with observations made annually, without regard to the observation dates.
static TimeSeries	newAnnualSeries(int startYear, double... series) Construct a new time series with observations made annually starting at the given year.
static TimeSeries	newMonthlySeries(double... series) Construct a new time series of monthly observations without regard to the observation dates.
static TimeSeries	newMonthlySeries(int startYear, int startMonth, double... series) Construct a new time series with monthly observations starting at the given year and month.
static TimeSeries	newMonthlySeries(int startYear, int startMonth, int startDay, double... series) Construct a new time series with monthly observations starting at the given year, month, and day.
static TimeSeries	newQuarterlySeries(double... series) Construct a new time series with quarterly observations without regard to the observation dates.
static TimeSeries	newQuarterlySeries(int startYear, int startQuarter, double... series) Construct a new time series with quarterly observations starting at the given year and quarter.
static TimeSeries	newWeeklySeries(double... series)
static TimeSeries	newWeeklySeries(int startYear, int startMonth, int startDay, double... series) Construct a new time series with weekly observations starting at the given year, month, and day.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newAnnualSeries

public static TimeSeries newAnnualSeries(int startYear,
                                         double... series)

Construct a new time series with observations made annually starting at the given year.

Parameters:

startYear - the year of the first observation.

series - the sequence of observations constituting this time series.

Returns:

a new time series with the given series data and start year.

newAnnualSeries

public static TimeSeries newAnnualSeries(double... series)

Construct a new time series with observations made annually, without regard to the observation dates.

Parameters:

series - the sequence of observations constituting this time series.

Returns:

a new time series with the given series data.

newMonthlySeries

public static TimeSeries newMonthlySeries(double... series)

Construct a new time series of monthly observations without regard to the observation dates.

Parameters:

series - the sequence of observations constituting this time series.

Returns:

a new time series with the given series data.

newMonthlySeries

public static TimeSeries newMonthlySeries(int startYear,
                                          int startMonth,
                                          double... series)

Construct a new time series with monthly observations starting at the given year and month.

Parameters:

startYear - the year of the first observation.

startMonth - the month of the first observation - an integer between 1 and 12 corresponding to the months January through December.

series - the sequence of observations constituting this time series.

Returns:

a new time series with the given series data, start year, and start month.

newMonthlySeries

public static TimeSeries newMonthlySeries(int startYear,
                                          int startMonth,
                                          int startDay,
                                          double... series)

Construct a new time series with monthly observations starting at the given year, month, and day.

Parameters:

startYear - The year of the first observation.

startMonth - The month of the first observation - an integer between 1 and 12 corresponding to the months January through December.

startDay - The day of the first observation - an integer between 1 and 31.

series - The sequence of observations constituting this time series.

Returns:

A new time series with the given year, month, day, and series data.

newQuarterlySeries

public static TimeSeries newQuarterlySeries(double... series)

Construct a new time series with quarterly observations without regard to the observation dates.

Parameters:

series - The sequence of observations constituting this time series.

Returns:

A new time series with the given year, quarter, and series data.

newQuarterlySeries

public static TimeSeries newQuarterlySeries(int startYear,
                                            int startQuarter,
                                            double... series)

Construct a new time series with quarterly observations starting at the given year and quarter.

Parameters:

startYear - The year of the first observation.

startQuarter - The quarter of the first observation - an integer between 1 and 4 corresponding to the four quarters of a year.

series - The sequence of observations constituting this time series.

Returns:

A new time series with the given year, quarter, and series data.

newWeeklySeries

public static TimeSeries newWeeklySeries(double... series)

newWeeklySeries

public static TimeSeries newWeeklySeries(int startYear,
                                         int startMonth,
                                         int startDay,
                                         double... series)

Construct a new time series with weekly observations starting at the given year, month, and day.

Parameters:

startYear - The year of the first observation.

startMonth - The month of the first observation - an integer between 1 and 12 corresponding to the months January through December.

startDay - The day of the first observation - an integer between 1 and 31.

series - The sequence of observations constituting this time series.

Returns:

A new time series with the given year, month, day, and series data.