make_time_shift_ids#

fastcan.narx.make_time_shift_ids(n_features=1, max_delay=1, include_zero_delay=False)#

Generate ids for time shift features. (variable_index, delay_number)

Parameters:
  • n_features (int, default=1) – The number of input features.

  • max_delay (int, default=1) – The maximum delay of time shift features.

  • include_zero_delay ({bool, array-like} of shape (n_features,) default=False) – Whether to include the original (zero-delay) features.

Returns:

ids – The unique id numbers of output features.

Return type:

array-like of shape (n_output_features_, 2)

Examples

>>> from fastcan.narx import make_time_shift_ids
>>> make_time_shift_ids(2, max_delay=3, include_zero_delay=[True, False])
array([[0, 0],
       [0, 1],
       [0, 2],
       [0, 3],
       [1, 1],
       [1, 2],
       [1, 3]])