type_annotations

class wrenfold.type_annotations.FloatScalar

Denote a floating-point scalar variable.

class wrenfold.type_annotations.IntScalar

Denote an integer valued scalar variable.

class wrenfold.type_annotations.Matrix1

A 1x1 square matrix.

class wrenfold.type_annotations.Matrix2

A 2x2 square matrix.

class wrenfold.type_annotations.Matrix3

A 3x3 square matrix.

class wrenfold.type_annotations.Matrix4

A 4x4 square matrix.

class wrenfold.type_annotations.Matrix5

A 5x5 square matrix.

class wrenfold.type_annotations.Matrix6

A 6x6 square matrix.

class wrenfold.type_annotations.Matrix7

A 7x7 square matrix.

class wrenfold.type_annotations.Matrix8

A 8x8 square matrix.

class wrenfold.type_annotations.Matrix9

A 9x9 square matrix.

class wrenfold.type_annotations.Opaque(provenance: CompoundExpr | None = None)

Base class used to indicate a custom type that exposes no symbolic expression members. Opaque types are employed to represent user-provided types the user may wish to pass to their generated functions (and subsequently to external functions).

Caution

You should not construct Opaque directly. Instead, inherit from it to create a new type. This new type is then intended for use as a type annotation on functions passed to wrenfold.code_generation.create_function_description().

__init__(provenance: CompoundExpr | None = None) → None

class wrenfold.type_annotations.Vector1

A 1x1 column vector.

class wrenfold.type_annotations.Vector2

A 2x1 column vector.

class wrenfold.type_annotations.Vector3

A 3x1 column vector.

class wrenfold.type_annotations.Vector4

A 4x1 column vector.

class wrenfold.type_annotations.Vector5

A 5x1 column vector.

class wrenfold.type_annotations.Vector6

A 6x1 column vector.

class wrenfold.type_annotations.Vector7

A 7x1 column vector.

class wrenfold.type_annotations.Vector8

A 8x1 column vector.

class wrenfold.type_annotations.Vector9

A 9x1 column vector.