dca#

[[Source]]

import dataclass_array as dca

Dataclass Array.

Dataclass arrays are dataclasses which can be sliced, indexed, reshaped,… like numpy arrays.

All symbols#

Module#

dca

Dataclass Array.

dca.testing

Test utils.

dca.typing

Types utils.

Class#

dca.DataclassArray

Dataclass which behaves like an array.

dca.testing.Ray

Dummy dataclass array for testing.

dca.typing.Array

dca.typing.ArrayAliasMeta

Metaclass to create array aliases.

dca.typing.BoolArray

dca.typing.FloatArray

dca.typing.IntArray

dca.typing.StrArray

dca.typing.TypeAlias

Special type indicating an unconstrained type.

dca.typing.bool_

dca.typing.complex128

dca.typing.complex64

dca.typing.f16

dca.typing.f32

dca.typing.f64

dca.typing.i16

dca.typing.i32

dca.typing.i64

dca.typing.i8

dca.typing.ui16

dca.typing.ui32

dca.typing.ui64

dca.typing.ui8

Function#

dca.concat

Concatenate dataclasses together.

dca.dataclass_array

Optional decorator to customize dca.DataclassArray params.

dca.field

Dataclass array field.

dca.stack

Stack dataclasses together.

dca.testing.assert_allclose

Assert the trees are close.

dca.testing.assert_array_equal

Assert the 2 objects are equals.

dca.testing.assert_trees

Compare all values.

dca.testing.skip_vmap_unavailable

Skip the test when vmap not available.

dca.vectorize_method

Vectorize a dca.DataclassArray method.

Typing#

dca.typing.ArrayLike

dca.typing.Axes

One or multiple axis. None indicate all axes. This is the type of .mean(axis=…)

dca.typing.DTypeArg

dca.typing.DcOrArray

Typing representing xnp.ndarray or dca.DataclassArray

dca.typing.DcOrArrayT

dca.typing.DcT

dca.typing.DynamicShape

dca.typing.Shape