type_annotations¶
- wrenfold.type_annotations.FloatScalar¶
alias of
Annotated[Expr, NumericType.Float, ‘Denote a floating-point scalar variable.’]
- wrenfold.type_annotations.IntScalar¶
alias of
Annotated[Expr, NumericType.Integer, ‘Denote an integer valued scalar variable.’]
- wrenfold.type_annotations.Matrix1¶
alias of
Annotated[MatrixExpr,Shape(rows=1, cols=1), ‘A 1x1 square matrix.’]
- wrenfold.type_annotations.Matrix2¶
alias of
Annotated[MatrixExpr,Shape(rows=2, cols=2), ‘A 2x2 square matrix.’]
- wrenfold.type_annotations.Matrix3¶
alias of
Annotated[MatrixExpr,Shape(rows=3, cols=3), ‘A 3x3 square matrix.’]
- wrenfold.type_annotations.Matrix4¶
alias of
Annotated[MatrixExpr,Shape(rows=4, cols=4), ‘A 4x4 square matrix.’]
- wrenfold.type_annotations.Matrix5¶
alias of
Annotated[MatrixExpr,Shape(rows=5, cols=5), ‘A 5x5 square matrix.’]
- wrenfold.type_annotations.Matrix6¶
alias of
Annotated[MatrixExpr,Shape(rows=6, cols=6), ‘A 6x6 square matrix.’]
- wrenfold.type_annotations.Matrix7¶
alias of
Annotated[MatrixExpr,Shape(rows=7, cols=7), ‘A 7x7 square matrix.’]
- wrenfold.type_annotations.Matrix8¶
alias of
Annotated[MatrixExpr,Shape(rows=8, cols=8), ‘A 8x8 square matrix.’]
- wrenfold.type_annotations.Matrix9¶
alias of
Annotated[MatrixExpr,Shape(rows=9, cols=9), ‘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
Opaquedirectly. Instead, inherit from it to create a new type. This new type is then intended for use as a type annotation on functions passed towrenfold.code_generation.create_function_description().- __init__(provenance: CompoundExpr | None = None) None¶
- wrenfold.type_annotations.Vector1¶
alias of
Annotated[MatrixExpr,Shape(rows=1, cols=1), ‘A 1x1 column vector.’]
- wrenfold.type_annotations.Vector2¶
alias of
Annotated[MatrixExpr,Shape(rows=2, cols=1), ‘A 2x1 column vector.’]
- wrenfold.type_annotations.Vector3¶
alias of
Annotated[MatrixExpr,Shape(rows=3, cols=1), ‘A 3x1 column vector.’]
- wrenfold.type_annotations.Vector4¶
alias of
Annotated[MatrixExpr,Shape(rows=4, cols=1), ‘A 4x1 column vector.’]
- wrenfold.type_annotations.Vector5¶
alias of
Annotated[MatrixExpr,Shape(rows=5, cols=1), ‘A 5x1 column vector.’]
- wrenfold.type_annotations.Vector6¶
alias of
Annotated[MatrixExpr,Shape(rows=6, cols=1), ‘A 6x1 column vector.’]
- wrenfold.type_annotations.Vector7¶
alias of
Annotated[MatrixExpr,Shape(rows=7, cols=1), ‘A 7x1 column vector.’]
- wrenfold.type_annotations.Vector8¶
alias of
Annotated[MatrixExpr,Shape(rows=8, cols=1), ‘A 8x1 column vector.’]
- wrenfold.type_annotations.Vector9¶
alias of
Annotated[MatrixExpr,Shape(rows=9, cols=1), ‘A 9x1 column vector.’]