Package com.amalgamasimulation.utils.time

Class RelativeTimeSeries

java.lang.Object

com.amalgamasimulation.utils.time.TimeSeries

com.amalgamasimulation.utils.time.RelativeTimeSeries

public class RelativeTimeSeries
extends TimeSeries

Time series that is obtained from some specified base time series by shifting all its instants by the specified amount of the specified time units.

Author:

Andrey Malykhanov

Field Summary

Fields inherited from class com.amalgamasimulation.utils.time.TimeSeries

timeable

Constructor Summary

Constructors

Constructor	Description
RelativeTimeSeries(TimeSeries baseTimeSeries, double offset, ChronoUnit offsetChronoUnit)	Creates a new instance of TimeSeries that is obtained from the specified base time series by shifting all its instants by the specified amount of the specified time units.

Method Summary

Modifier and Type	Method	Description
List<Double>	getInstantsTimes(double beginTime, double endTime, boolean beginTimeInclusive, boolean endTimeInclusive)	Returns an unmodifiable list containing all times of instants of this time series between the specified times.
double	getNextInstantTime(double time, boolean timeInclusive)	Returns the time of the smallest instant of this time series after the specified time, or Double.POSITIVE_INFINITY if there are no such instants in this time series.
double	getPreviousInstantTime(double time)	Returns the time of the biggest instant of this time series that is strictly less than the the specified time, or Double.NEGATIVE_INFINITY if there is no such instant.

Methods inherited from class com.amalgamasimulation.utils.time.TimeSeries

everyMonth, everyMonthLastDay, everyNDaysTimeSeries, everyWeekTimeSeries, getInstantsTimes, getNextInstantTime, of, of, of, relativeTimeSeries, singleTimeSeries

Methods inherited from class java.lang.Object

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

Constructor Details

RelativeTimeSeries

public RelativeTimeSeries(TimeSeries baseTimeSeries,
 double offset,
 ChronoUnit offsetChronoUnit)

Creates a new instance of TimeSeries that is obtained from the specified base time series by shifting all its instants by the specified amount of the specified time units.

Parameters:

baseTimeSeries - specified base time series that is being shifted

offset - offset shift, can be positive or negative, must be finite

offsetChronoUnit - time unit of the offset

Method Details

getPreviousInstantTime

public double getPreviousInstantTime(double time)

Description copied from class: TimeSeries

Returns the time of the biggest instant of this time series that is strictly less than the the specified time, or Double.NEGATIVE_INFINITY if there is no such instant.

Specified by:

getPreviousInstantTime in class TimeSeries

Parameters:

time - specified time

Returns:

time of the biggest instant of this time series that is strictly less than the the specified time, or Double.NEGATIVE_INFINITY

getNextInstantTime

public double getNextInstantTime(double time,
 boolean timeInclusive)

Description copied from class: TimeSeries

Returns the time of the smallest instant of this time series after the specified time, or Double.POSITIVE_INFINITY if there are no such instants in this time series. Allows to include or exclude the specified time itself.

Specified by:

getNextInstantTime in class TimeSeries

Parameters:

time - specified time

timeInclusive - whether to include or exclude the specified time

Returns:

time of the smallest instant of this time series after the specified time, or Double.POSITIVE_INFINITY

getInstantsTimes

public List<Double> getInstantsTimes(double beginTime,
 double endTime,
 boolean beginTimeInclusive,
 boolean endTimeInclusive)

Description copied from class: TimeSeries

Returns an unmodifiable list containing all times of instants of this time series between the specified times. If there are no such instants, an empty list is returned. Allows to include or exclude the boundaries of the specified time interval.

Specified by:

getInstantsTimes in class TimeSeries

Parameters:

beginTime - smallest time of instants being returned

endTime - biggest time of instants being returned

beginTimeInclusive - whether to include or exclude the right boundary (beginTime)

endTimeInclusive - whether to include or exclude the left boundary (endTime)

Returns:

unmodifiable list containing all times of instants of this time series between the specified times