typing

compression_safeguards.utils.typing

Commonly used type variables.

C module-attribute 

C = TypeVar('C', bound=unsignedinteger, covariant=True)

The numpy data type for safeguard corrections (covariant).

Returned by: Used by:

F module-attribute 

F = TypeVar('F', bound=floating, covariant=True)

Any numpy floating-point data type (covariant).

Returned by: Used by:

Fi module-attribute 

Fi = TypeVar('Fi', bound=floating)

Any numpy floating-point data type (invariant).

S module-attribute 

S = TypeVar('S', bound=tuple[int, ...], covariant=True)

Any array shape (covariant).

Returned by: Used by:

Si module-attribute 

Si = TypeVar('Si', bound=tuple[int, ...])

Any array shape (invariant).

Returned by: Used by:

T module-attribute 

T = TypeVar('T', bound=number, covariant=True)

Any numpy number data type (covariant).

Returned by: Used by:

Ti module-attribute 

Ti = TypeVar('Ti', bound=number)

Any numpy number data type (invariant).

TB module-attribute 

TB = TypeVar('TB', bound=number | bool, covariant=True)

Any numpy number or boolean data type (covariant).

U module-attribute 

U = TypeVar('U', bound=unsignedinteger, covariant=True)

Any numpy unsignedinteger data type (covariant).

Returned by: Used by:

Ui module-attribute 

Ui = TypeVar('Ui', bound=unsignedinteger)

Any numpy unsignedinteger data type (invariant).

JSON module-attribute 

JSON: TypeAlias = (
    None
    | int
    | float
    | str
    | bool
    | list["JSON"]
    | dict[str, "JSON"]
)

Types that are valid JSON and can be encoded with json.dumps.

Returned by: Used by: