Array

class kgpy.labeled.Array(array=<Quantity 0.>, axes=None)

Bases: AbstractArray[ArrT]

__init__(array=<Quantity 0.>, axes=None)

Parameters

• array (ArrT) –

• axes (Optional[List[str]]) –

Return type

None

Attributes

array
axes
ndim
shape
type_array
type_array_auxiliary
unit

Methods

__init__([array, axes])
add_axes(axes)	rtype typing.TypeVar(AbstractArrayT, bound= AbstractArray)
broadcast_shapes(*arrs)	rtype typing.Dict[str, int]
combine_axes(axes[, axis_new])	rtype kgpy.labeled.Array
copy()	rtype typing.TypeVar(CopyableT, bound= Copyable)
copy_shallow()	rtype typing.TypeVar(CopyableT, bound= Copyable)
empty(shape[, dtype])	rtype typing.TypeVar(ArrayT, bound= Array)
matrix_determinant(axis_rows, axis_columns)	rtype kgpy.labeled.Array
matrix_inverse(axis_rows, axis_columns)	rtype kgpy.labeled.Array
matrix_multiply(other, axis_rows, axis_columns)	rtype kgpy.labeled.Array
max([axis, where])	rtype typing.TypeVar(NDArrayMethodsMixinT, bound= NDArrayMethodsMixin)
mean([axis, where])	rtype typing.TypeVar(NDArrayMethodsMixinT, bound= NDArrayMethodsMixin)
min([axis, where])	rtype typing.TypeVar(NDArrayMethodsMixinT, bound= NDArrayMethodsMixin)
ndindex(shape)	rtype typing.Iterator[typing.Dict[str, int]]
ones(shape[, dtype])	rtype typing.TypeVar(ArrayT, bound= Array)
shape_broadcasted(*arrs)	rtype typing.Dict[str, int]
zeros(shape[, dtype])	rtype typing.TypeVar(ArrayT, bound= Array)

Inheritance Diagram

type_array_primary

alias of ndarray

add_axes(axes)

Return type

typing.TypeVar(AbstractArrayT, bound= AbstractArray)

Parameters

• self (AbstractArrayT) –

• axes (List) –

classmethod broadcast_shapes(*arrs)

Return type

typing.Dict[str, int]

Parameters

arrs (AbstractArrayT) –

combine_axes(axes, axis_new=None)

Return type

kgpy.labeled.Array

Parameters

• self (AbstractArrayT) –

• axes (Sequence[str]) –

• axis_new (Optional[str]) –

copy()

Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

copy_shallow()

Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

classmethod empty(shape, dtype=<class 'float'>)

Return type

typing.TypeVar(ArrayT, bound= Array)

Parameters

• shape (Dict[str, int]) –

• dtype (Union[dtype, None, type, _SupportsDType[dtype], str, Tuple[Any, int], Tuple[Any, Union[SupportsIndex, Sequence[SupportsIndex]]], List[Any], _DTypeDict, Tuple[Any, Any]]) –

matrix_determinant(axis_rows, axis_columns)

Return type

kgpy.labeled.Array

Parameters

• self (AbstractArrayT) –

• axis_rows (str) –

• axis_columns (str) –

matrix_inverse(axis_rows, axis_columns)

Return type

kgpy.labeled.Array

Parameters

• self (AbstractArrayT) –

• axis_rows (str) –

• axis_columns (str) –

matrix_multiply(other, axis_rows, axis_columns)

Return type

kgpy.labeled.Array

Parameters

• self (AbstractArrayT) –

• other (OtherAbstractArrayT) –

• axis_rows (str) –

• axis_columns (str) –

max(axis=None, where=<no value>)

Return type

typing.TypeVar(NDArrayMethodsMixinT, bound= NDArrayMethodsMixin)

Parameters

• self (NDArrayMethodsMixinT) –

• axis (Optional[Union[str, Sequence[str]]]) –

• where (NDArrayMethodsMixinT) –

mean(axis=None, where=<no value>)

Return type

typing.TypeVar(NDArrayMethodsMixinT, bound= NDArrayMethodsMixin)

Parameters

• self (NDArrayMethodsMixinT) –

• axis (Optional[Union[str, Sequence[str]]]) –

• where (NDArrayMethodsMixinT) –

min(axis=None, where=<no value>)

Return type

typing.TypeVar(NDArrayMethodsMixinT, bound= NDArrayMethodsMixin)

Parameters

• self (NDArrayMethodsMixinT) –

• axis (Optional[Union[str, Sequence[str]]]) –

• where (NDArrayMethodsMixinT) –

classmethod ndindex(shape)

Return type

typing.Iterator[typing.Dict[str, int]]

Parameters

shape (Dict[str, int]) –

classmethod ones(shape, dtype=<class 'float'>)

Return type

typing.TypeVar(ArrayT, bound= Array)

Parameters

• shape (Dict[str, int]) –

• dtype (Union[dtype, None, type, _SupportsDType[dtype], str, Tuple[Any, int], Tuple[Any, Union[SupportsIndex, Sequence[SupportsIndex]]], List[Any], _DTypeDict, Tuple[Any, Any]]) –

shape_broadcasted(*arrs)

Return type

typing.Dict[str, int]

Parameters

• self (AbstractArrayT) –

• arrs (AbstractArrayT) –

classmethod zeros(shape, dtype=<class 'float'>)

Return type

typing.TypeVar(ArrayT, bound= Array)

Parameters

• shape (Dict[str, int]) –

• dtype (Union[dtype, None, type, _SupportsDType[dtype], str, Tuple[Any, int], Tuple[Any, Union[SupportsIndex, Sequence[SupportsIndex]]], List[Any], _DTypeDict, Tuple[Any, Any]]) –

array: typing.TypeVar(ArrT, bound= typing.Union[typing.Sequence[typing.Sequence[typing.Sequence[typing.Sequence[typing.Sequence[typing.Any]]]]], numpy.typing._array_like._SupportsArray[numpy.dtype], typing.Sequence[numpy.typing._array_like._SupportsArray[numpy.dtype]], typing.Sequence[typing.Sequence[numpy.typing._array_like._SupportsArray[numpy.dtype]]], typing.Sequence[typing.Sequence[typing.Sequence[numpy.typing._array_like._SupportsArray[numpy.dtype]]]], typing.Sequence[typing.Sequence[typing.Sequence[typing.Sequence[numpy.typing._array_like._SupportsArray[numpy.dtype]]]]], bool, int, float, complex, str, bytes, typing.Sequence[typing.Union[bool, int, float, complex, str, bytes]], typing.Sequence[typing.Sequence[typing.Union[bool, int, float, complex, str, bytes]]], typing.Sequence[typing.Sequence[typing.Sequence[typing.Union[bool, int, float, complex, str, bytes]]]], typing.Sequence[typing.Sequence[typing.Sequence[typing.Sequence[typing.Union[bool, int, float, complex, str, bytes]]]]], astropy.units.Quantity]) = <Quantity 0.>

axes: typing.Optional[typing.List[str]] = None

property ndim: int

property shape: Dict[str, int]

type_array: typing.ClassVar[typing.Tuple[typing.Type, ...]] = (<class 'bool'>, <class 'int'>, <class 'float'>, <class 'complex'>, <class 'numpy.generic'>, <class 'numpy.ndarray'>)

type_array_auxiliary: typing.ClassVar[typing.Tuple[typing.Type, ...]] = (<class 'bool'>, <class 'int'>, <class 'float'>, <class 'complex'>, <class 'numpy.generic'>)

property unit: Optional[Unit]