core_analytics\local\time_splitting\upcoming_periodic Class Reference

Time splitting method that generates predictions periodically. More...

Inheritance diagram for core_analytics\local\time_splitting\upcoming_periodic:

Public Member Functions
	append_rangeindex ($sampleid, $rangeindex)
	Generates a unique sample id (sample in a range index).
	cache_indicator_calculations ()
	Whether to cache or not the indicator calculations.
	get_all_ranges ()
	Returns the ranges used by this time splitting method.
	get_analysable ()
	get_analysable
	get_distinct_ranges ()
	Returns the distinct range indexes in this time splitting method.
	get_id ()
	Returns the time splitting method id.
	get_most_recent_prediction_range ()
	Returns the most recent range that can be used to predict.
	get_range_by_index ($rangeindex)
	Returns range data by its index.
	get_training_ranges ()
	Overwritting as the last range may be for prediction.
	include_range_info_in_training_data ()
	Overwritten as all generated rows are comparable.
	infer_sample_info ($uniquesampleid)
	Returns the sample id and the range index from a uniquesampleid.
	is_valid_analysable (\core_analytics\analysable $analysable)
	Returns whether the analysable can be processed by this time splitting method or not.
	ready_to_predict ($range)
	Should we predict this time range now?
	ready_to_train ($range)
	Should we use this time range for training?
	set_analysable (\core_analytics\analysable $analysable)
	Assigns the analysable and updates the time ranges according to the analysable start and end dates.
	set_modelid (int $modelid)
	Assigns the model id to this time-splitting method it case it needs it.
	valid_for_evaluation ()
	Overriden as these time-splitting methods are based on future dates.

Static Public Member Functions
static	get_name ()
	Returns a lang_string object representing the name for the time splitting method.

Protected Member Functions
	define_ranges ()
	define_ranges
	get_first_start ()
	Get the start of the first time range.
	get_next_range (\DateTimeImmutable $time)
	Gets the next range with start on the provided time.
	periodicity ()
	The periodicity of the predictions / training data generation.
	update_last_range (array $ranges)
	Allows child classes to update the last range provided.
	validate_ranges ()
	Validates the time splitting method ranges.

Protected Attributes
core_analytics analysable	$analysable
string	$id
int	$modelid
	The model id.
array	$ranges = []

Detailed Description

Time splitting method that generates predictions periodically.

Copyright

2019 David Monllao

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

append_rangeindex()

core_analytics\local\time_splitting\base::append_rangeindex ( $sampleid, $rangeindex )

finalinherited

Generates a unique sample id (sample in a range index).

Parameters

int	$sampleid
int	$rangeindex

Return values

string

cache_indicator_calculations()

core_analytics\local\time_splitting\upcoming_periodic::cache_indicator_calculations

(

)

Whether to cache or not the indicator calculations.

Return values

bool

Reimplemented from core_analytics\local\time_splitting\base.

define_ranges()

core_analytics\local\time_splitting\periodic::define_ranges ( )

protectedinherited

define_ranges

Return values

array

Reimplemented from core_analytics\local\time_splitting\base.

get_all_ranges()

core_analytics\local\time_splitting\base::get_all_ranges ( )

inherited

Returns the ranges used by this time splitting method.

Return values

array

get_analysable()

core_analytics\local\time_splitting\base::get_analysable ( )

inherited

get_analysable

Return values

core_analytics\analysable

get_distinct_ranges()

core_analytics\local\time_splitting\base::get_distinct_ranges ( )

inherited

Returns the distinct range indexes in this time splitting method.

Return values

int[]

get_first_start()

core_analytics\local\time_splitting\upcoming_periodic::get_first_start ( )

protected

Get the start of the first time range.

Overwriten to start generating predictions about upcoming stuff from time().

Return values

int	A timestamp.

Reimplemented from core_analytics\local\time_splitting\periodic.

get_id()

core_analytics\local\time_splitting\base::get_id ( )

inherited

Returns the time splitting method id.

Return values

string

get_most_recent_prediction_range()

core_analytics\local\time_splitting\base::get_most_recent_prediction_range ( )

inherited

Returns the most recent range that can be used to predict.

This method is only called when calculating predictions.

Return values

array

get_name()

static core_analytics\local\time_splitting\base::get_name ( )

staticabstractinherited

Returns a lang_string object representing the name for the time splitting method.

Used as column identificator.

If there is a corresponding '_help' string this will be shown as well.

Return values

lang_string

Reimplemented in core\analytics\time_splitting\deciles, core\analytics\time_splitting\deciles_accum, core\analytics\time_splitting\no_splitting, core\analytics\time_splitting\one_month_after_start, core\analytics\time_splitting\one_week_after_start, core\analytics\time_splitting\past_3_days, core\analytics\time_splitting\past_month, core\analytics\time_splitting\past_week, core\analytics\time_splitting\quarters, core\analytics\time_splitting\quarters_accum, core\analytics\time_splitting\single_range, core\analytics\time_splitting\ten_percent_after_start, core\analytics\time_splitting\upcoming_3_days, core\analytics\time_splitting\upcoming_fortnight, and core\analytics\time_splitting\upcoming_week.

get_next_range()

core_analytics\local\time_splitting\upcoming_periodic::get_next_range ( \DateTimeImmutable $time )

protected

Gets the next range with start on the provided time.

The next range is based on the upcoming period so we add this range's periodicity to $time.

Parameters

DateTimeImmutable

$time

Return values

array

Reimplemented from core_analytics\local\time_splitting\periodic.

get_range_by_index()

core_analytics\local\time_splitting\base::get_range_by_index ( $rangeindex )

inherited

Returns range data by its index.

Parameters

int

$rangeindex

Return values

array|false

Range data or false if the index is not part of the existing ranges.

get_training_ranges()

core_analytics\local\time_splitting\periodic::get_training_ranges ( )

inherited

Overwritting as the last range may be for prediction.

Return values

array

Reimplemented from core_analytics\local\time_splitting\base.

include_range_info_in_training_data()

core_analytics\local\time_splitting\periodic::include_range_info_in_training_data ( )

inherited

Overwritten as all generated rows are comparable.

Return values

bool

Reimplemented from core_analytics\local\time_splitting\base.

infer_sample_info()

core_analytics\local\time_splitting\base::infer_sample_info ( $uniquesampleid )

finalinherited

Returns the sample id and the range index from a uniquesampleid.

Parameters

string

$uniquesampleid

Return values

array

array($sampleid, $rangeindex)

is_valid_analysable()

core_analytics\local\time_splitting\periodic::is_valid_analysable ( \core_analytics\analysable $analysable )

inherited

Returns whether the analysable can be processed by this time splitting method or not.

Parameters

core_analytics\analysable

$analysable

Return values

bool

Reimplemented from core_analytics\local\time_splitting\base.

periodicity()

core_analytics\local\time_splitting\periodic::periodicity ( )

abstractprotectedinherited

The periodicity of the predictions / training data generation.

Return values

DateInterval

Reimplemented in core\analytics\time_splitting\past_3_days, core\analytics\time_splitting\past_month, core\analytics\time_splitting\past_week, core\analytics\time_splitting\upcoming_3_days, core\analytics\time_splitting\upcoming_fortnight, and core\analytics\time_splitting\upcoming_week.

ready_to_predict()

core_analytics\local\time_splitting\base::ready_to_predict ( $range )

inherited

Should we predict this time range now?

Parameters

array

$range

Return values

bool

Reimplemented in core\analytics\time_splitting\no_splitting.

ready_to_train()

core_analytics\local\time_splitting\base::ready_to_train ( $range )

inherited

Should we use this time range for training?

Parameters

array

$range

Return values

bool

set_analysable()

core_analytics\local\time_splitting\base::set_analysable ( \core_analytics\analysable $analysable )

inherited

Assigns the analysable and updates the time ranges according to the analysable start and end dates.

Parameters

core_analytics\analysable

$analysable

Return values

void

set_modelid()

core_analytics\local\time_splitting\base::set_modelid ( int $modelid )

inherited

Assigns the model id to this time-splitting method it case it needs it.

Parameters

int

$modelid

update_last_range()

core_analytics\local\time_splitting\periodic::update_last_range ( array $ranges )

protectedinherited

Allows child classes to update the last range provided.

Parameters

array

$ranges

Return values

array

Reimplemented in core_analytics\local\time_splitting\past_periodic.

valid_for_evaluation()

core_analytics\local\time_splitting\upcoming_periodic::valid_for_evaluation

(

)

Overriden as these time-splitting methods are based on future dates.

Return values

bool

Reimplemented from core_analytics\local\time_splitting\base.

validate_ranges()

core_analytics\local\time_splitting\base::validate_ranges ( )

protectedinherited

Validates the time splitting method ranges.

Exceptions

coding_exception

Return values

void

---

The documentation for this class was generated from the following file:

• analytics/classes/local/time_splitting/upcoming_periodic.php