`scipy.linalg._solvers:_are_validate_args`

source: /scipy/linalg/_solvers.py :776

Signature

   def     _are_validate_args (    a    ,    b    ,    q    ,    r    ,    e    ,    s    ,    eq_type    =  care     )

Summary

A helper function to validate the arguments supplied to the Riccati equation solvers. Any discrepancy found in the input matrices leads to a ValueError exception.

Extended Summary

Essentially, it performs:

a check whether the input is free of NaN and Infs
a pass for the data through numpy.atleast_2d()
squareness check of the relevant arrays
shape consistency check of the arrays
singularity check of the relevant arrays
symmetricity check of the relevant matrices
a check whether the regular or the generalized version is asked.

This function is used by solve_continuous_are and solve_discrete_are.

Parameters

a, b, q, r, e, s : array_like: Input data
eq_type : str: Accepted arguments are 'care' and 'dare'.

Returns

a, b, q, r, e, s : ndarray: Regularized input data
m, n : int: shape of the problem
r_or_c : type: Data type of the problem, returns float or complex
gen_or_not : bool: Type of the equation, True for generalized and False for regular ARE.

Aliases

scipy.linalg._solvers._are_validate_args