Skip to content

lmlib.statespace.rls

Functions:

  • create_rls –

    Deprecated: instantiate RLS classes directly instead.

Functions

create_rls 

create_rls(cost, multi_channel_set=False, steady_state=False, kappa_diag=True, steady_state_method='closed_form', **kwargs)

Deprecated: instantiate RLS classes directly instead.

Source code in lmlib/statespace/rls.py 
17
18
19
20
21
22
23
24
25
def create_rls(cost, multi_channel_set=False, steady_state=False, kappa_diag=True, steady_state_method='closed_form', **kwargs):
    """Deprecated: instantiate RLS classes directly instead."""
    warnings.warn(
        "create_rls() is deprecated and will be removed in a future version. "
        "Instantiate RLSAlssm object directly with e.g. rls = lm.RLSAlssm(cost)",
        FutureWarning,
        stacklevel=2,
    )
    return RLSAlssm(cost, steady_state=steady_state, **kwargs)

Classes

  • RLSAlssm — Recursive Least Square Alssm Class to compute and minimize Alssm Cost Functions.