gemseo.typing module#

Common typing definitions.

class RealOrComplexArrayT#

A NumPy array of real or complex numbers generic type.

alias of TypeVar('RealOrComplexArrayT', ~numpy.ndarray[tuple[~typing.Any, ...], ~numpy.dtype[~numpy.floating[~typing.Any]]], ~numpy.ndarray[tuple[~typing.Any, ...], ~numpy.dtype[~numpy.complexfloating[~typing.Any, ~typing.Any]]])

BooleanArray(*args, **kwargs)#

A NumPy array of boolean numbers.

alias of ndarray[tuple[Any, ...], dtype[bool]]

ComplexArray(*args, **kwargs)#

A NumPy array of complex numbers.

alias of ndarray[tuple[Any, ...], dtype[complexfloating[Any, Any]]]

IntegerArray(*args, **kwargs)#

A NumPy array of integer numbers.

alias of ndarray[tuple[Any, ...], dtype[integer[Any]]]

JacobianData(*args, **kwargs)#

jacobian}}.

Type:

A Jacobian data structure of the form ``{output_name

Type:

{input_name

alias of MutableMapping[str, MutableMapping[str, ndarray[tuple[Any, ...], dtype[floating[Any]]] | coo_matrix | spmatrix | sparray | JacobianOperator]]

MutableStrKeyMapping(*args, **kwargs)#

A mutable mapping from strings to anything.

alias of MutableMapping[str, Any]

NumberArray(*args, **kwargs)#

A NumPy array of integer or real or complex numbers.

alias of ndarray[tuple[Any, ...], dtype[number[Any]]]

RealArray(*args, **kwargs)#

A NumPy array of real numbers.

alias of ndarray[tuple[Any, ...], dtype[floating[Any]]]

RealOrComplexArray(*args, **kwargs)#

A NumPy array of real or complex numbers.

alias of ndarray[tuple[Any, ...], dtype[inexact[Any]]]

SparseOrDenseRealArray = numpy.ndarray[tuple[typing.Any, ...], numpy.dtype[numpy.floating[typing.Any]]] | scipy.sparse._coo.coo_matrix | scipy.sparse._matrix.spmatrix | scipy.sparse._base.sparray#

A dense NumPy array or a sparse SciPy array.

StrKeyMapping(*args, **kwargs)#

A read-only mapping from strings to anything.

alias of Mapping[str, Any]

StringArray(*args, **kwargs)#

A NumPy array of strings.

alias of ndarray[tuple[Any, ...], dtype[str_]]