Skip to content

Data Types

 import minuteman.utils.types

Basic minuteman types

Typedefs

minuteman.utils.types.ArraylikeFloat module-attribute 

ArraylikeFloat: TypeAlias = NDArrayFloat | list[float] | tuple[float, ...] | Floatlike

Scalar or array-like float

minuteman.utils.types.EqSolutionArraylike module-attribute 

EqSolutionArraylike: TypeAlias = ct.Solution | ct.SolutionArray

minuteman.utils.types.Floatlike module-attribute 

Floatlike: TypeAlias = float | np.floating

Any float type

minuteman.utils.types.NDArrayBool module-attribute 

NDArrayBool: TypeAlias = npt.NDArray[np.bool]

Numpy array of boolean

minuteman.utils.types.NDArrayFloat module-attribute 

NDArrayFloat: TypeAlias = npt.NDArray[np.floating]

Numpy array of any floating type

Errors

minuteman.utils.types.DeveloperError

Bases: Exception

Error meaning the developer needs to fix something

minuteman.utils.types.InvalidArrayShapeError

Bases: Exception

Array shapes do not match

minuteman.utils.types.RootFindingError

Bases: Exception

Error from fsolve, find_root, or a similar optimization function