API Reference

state_space_analysis.stateTransTool.cli

state_space_analysis.stateTransTool.cli.build_parser()

Return type:

ArgumentParser

state_space_analysis.stateTransTool.cli.main(argv=None)

Parameters:

argv (list[str] | None)

Return type:

int

state_space_analysis.stateTransTool.apis

class state_space_analysis.stateTransTool.apis.StateTransRequest(tf: 'Optional[str]' = None, num: 'Optional[str]' = None, den: 'Optional[str]' = None, example: 'Optional[str]' = None, canonical: 'str' = 'controllable', eval_time: 'Optional[float]' = None, inverse: 'bool' = False, numeric: 'bool' = False, digits: 'int' = 8, pretty: 'bool' = False, export_json: 'Optional[str]' = None, log_level: 'str' = 'INFO')

Bases: object

Parameters:

• tf (str | None)

• num (str | None)

• den (str | None)

• example (str | None)

• canonical (str)

• eval_time (float | None)

• inverse (bool)

• numeric (bool)

• digits (int)

• pretty (bool)

• export_json (str | None)

• log_level (str)

canonical: str = 'controllable'

den: str | None = None

digits: int = 8

eval_time: float | None = None

example: str | None = None

export_json: str | None = None

inverse: bool = False

log_level: str = 'INFO'

num: str | None = None

numeric: bool = False

pretty: bool = False

tf: str | None = None

class state_space_analysis.stateTransTool.apis.StateTransResult(A: 'sp.Matrix', canonical: 'str', Phi: 'sp.Matrix', Phi_inv: 'Optional[sp.Matrix]' = None, Phi_eval: 'Optional[sp.Matrix]' = None, Phi_inv_eval: 'Optional[sp.Matrix]' = None, messages: 'List[str]' = <factory>)

Bases: object

Parameters:

• A (MutableDenseMatrix)

• canonical (str)

• Phi (MutableDenseMatrix)

• Phi_inv (MutableDenseMatrix | None)

• Phi_eval (MutableDenseMatrix | None)

• Phi_inv_eval (MutableDenseMatrix | None)

• messages (List[str])

A: MutableDenseMatrix

Phi: MutableDenseMatrix

Phi_eval: MutableDenseMatrix | None = None

Phi_inv: MutableDenseMatrix | None = None

Phi_inv_eval: MutableDenseMatrix | None = None

canonical: str

messages: List[str]

state_space_analysis.stateTransTool.app

state_space_analysis.stateTransTool.app.run(req)

Run the app and return a human-readable report string.

Parameters:

req (StateTransRequest)

Return type:

str

state_space_analysis.stateTransTool.core

class state_space_analysis.stateTransTool.core.StateTransitionEngine(canonical='controllable')

Bases: object

Compute Φ(t)=e^{At} given a TF and a canonical realization choice.

Parameters:

canonical (str)

build_A(num_desc, den_desc)

Parameters:

• num_desc (List[Expr])

• den_desc (List[Expr])

Return type:

MutableDenseMatrix

parse_inputs(tf, num, den, example)

Parameters:

• tf (str | None)

• num (str | None)

• den (str | None)

• example (str | None)

phi_inverse_symbolic(A)

Parameters:

A (MutableDenseMatrix)

Return type:

MutableDenseMatrix

phi_symbolic(A)

Parameters:

A (MutableDenseMatrix)

Return type:

MutableDenseMatrix

state_space_analysis.stateTransTool.core.controllable_A(num_desc, den_desc)

Parameters:

• num_desc (List[Expr])

• den_desc (List[Expr])

Return type:

MutableDenseMatrix

state_space_analysis.stateTransTool.core.diagonal_A_pf(den_desc)

Parameters:

den_desc (List[Expr])

Return type:

MutableDenseMatrix | None

state_space_analysis.stateTransTool.core.get_canonical_names()

Return type:

List[str]

state_space_analysis.stateTransTool.core.jordan_form(A)

Parameters:

A (MutableDenseMatrix)

state_space_analysis.stateTransTool.core.observable_A_from(Ac)

Parameters:

Ac (MutableDenseMatrix)

Return type:

MutableDenseMatrix

state_space_analysis.stateTransTool.core.register_canonical(name)

Parameters:

name (str)

state_space_analysis.stateTransTool.design

class state_space_analysis.stateTransTool.design.StateTransApp(req)

Bases: object

High-level orchestrator: parse → build A → compute Φ(t) → format/export.

Parameters:

req (StateTransRequest)

run()

Return type:

StateTransResult

state_space_analysis.stateTransTool.io

state_space_analysis.stateTransTool.io.export_json_phi(path, Phi, Phi_inv)

Parameters:

• path (str)

• Phi (MutableDenseMatrix)

• Phi_inv (MutableDenseMatrix | None)

state_space_analysis.stateTransTool.io.format_matrix(M, numeric=False, digits=8, pretty=False)

Parameters:

• M (MutableDenseMatrix)

• numeric (bool)

• digits (int)

• pretty (bool)

Return type:

str

state_space_analysis.stateTransTool.utils

state_space_analysis.stateTransTool.utils.coeffs_asc(desc, n)

Parameters:

• desc (List[Expr])

• n (int)

Return type:

List[Expr]

state_space_analysis.stateTransTool.utils.ensure_proper(num_desc, den_desc)

Parameters:

• num_desc (List[Expr])

• den_desc (List[Expr])

state_space_analysis.stateTransTool.utils.normalize_monic(num_desc, den_desc)

Parameters:

• num_desc (List[Expr])

• den_desc (List[Expr])

state_space_analysis.stateTransTool.utils.parse_poly(arg)

Return type:

List[Expr]

state_space_analysis.stateTransTool.utils.parse_tf_string(tf_str)

Parameters:

tf_str (str)

Return type:

Tuple[List[Expr], List[Expr]]

state_space_analysis.stateTransTool.utils.pretty_matrix(M)

Return type:

str

state_space_analysis.stateTransTool.utils.square_free(poly)

Parameters:

poly (Poly)

Return type:

bool

state_space_analysis.stateTransTool.utils.sym_s()

Return type:

Symbol

state_space_analysis.stateTransTool.utils.sym_t()

Return type:

Symbol

state_space_analysis.stateTransTool.utils.to_expr(text)

Parameters:

text (str)

Return type:

Expr

state_space_analysis.stateTransTool.utils.to_numeric(M, digits=8)

Parameters:

digits (int)