forcedimension_core.typing module

class forcedimension_core.typing.Array(*args, **kwargs)

Bases: Sized, Container[_VT_co], Protocol[_KT_contra, _VT_co]

A set of values (all the same type) indexed by keys (all the same type).

class forcedimension_core.typing.CType

Generic type representing a C data type (e.g. int, float, etc.)

alias of TypeVar(‘CType’)

forcedimension_core.typing.FloatDOFTuple

Represents a tuple of floats, one for each DOF.

alias of Tuple[float, float, float, float, float, float, float, float]

forcedimension_core.typing.IntDOFTuple

Represents a tuple of integers, one for each DOF.

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

class forcedimension_core.typing.MutableArray(*args, **kwargs)

Bases: Array[_KT_contra, _VT], Protocol[_KT_contra, _VT]

A set of values (all the same type) indexed by keys (all the same type) that allows setting items.

class forcedimension_core.typing.Pointer

Bases: object

Generic type representing a C pointer

class forcedimension_core.typing.SupportsPtr(*args, **kwargs)

Bases: Protocol, Generic[CType]

A type which supports direct memory addressing of the front of a contiguous array.

property ptr: None

A pointer to the front of a contiguous section of data.

class forcedimension_core.typing.SupportsPtrs3(*args, **kwargs)

Bases: Protocol, Generic[CType]

A type which supports direct memory addressing of its stored values.

property ptrs: Tuple[None, None, None]

A tuple of 3 pointers to sequentially ordered set of 3 values.

forcedimension_core.typing.c_double_ptr

alias of LP_c_double

forcedimension_core.typing.c_int_ptr

alias of LP_c_int

forcedimension_core.typing.c_ubyte_ptr

alias of LP_c_ubyte

forcedimension_core.typing.c_uint_ptr

alias of LP_c_uint

forcedimension_core.typing.c_ushort_ptr

alias of LP_c_ushort