scico.typing

Type definitions.

Module Attributes

PRNGKey	A key for jax random number generators (see jax.random).
DType	A jax dtype.
Shape	A shape of a numpy or jax array.
BlockShape	A shape of a BlockArray.
Axes	Specification of one or more array axes.
AxisIndex	An entity suitable for indexing/slicing of a single array axis; either a slice object, Ellipsis, or int.
ArrayIndex	An entity suitable for indexing/slicing of multi-dimentional arrays.

scico.typing.PRNGKey

A key for jax random number generators (see jax.random).

scico.typing.DType

A jax dtype.

alias of int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | float16 | float32 | float64 | complex64 | complex128 | bool

scico.typing.Shape

A shape of a numpy or jax array.

alias of Tuple[int, …]

scico.typing.BlockShape

A shape of a BlockArray.

alias of Tuple[Tuple[int, …], …]

scico.typing.Axes

Specification of one or more array axes.

alias of int | Tuple[int, …]

scico.typing.AxisIndex

An entity suitable for indexing/slicing of a single array axis; either a slice object, Ellipsis, or int.

alias of slice | ellipsis | int

scico.typing.ArrayIndex

An entity suitable for indexing/slicing of multi-dimentional arrays.

alias of slice | ellipsis | int | Tuple[slice | ellipsis | int, …]