Welcome to Python-flavored Magnum! Please note that, while already being rather stable, this functionality is still considered experimental and some APIs might get changed without preserving full backwards compatibility.

magnum.Matrix2x3 class

2x3 float matrix

Static methods

def from_diagonal(diagonal: Vector2) -> Matrix2x3: Construct a diagonal matrix
def zero_init() -> Matrix2x3: Construct a zero-filled matrix

Methods

def diagonal(self, /) -> Vector2: Values on diagonal
def flipped_cols(self, /) -> Matrix2x3: Matrix with flipped cols
def flipped_rows(self, /) -> Matrix2x3: Matrix with flipped rows
def transposed(self, /) -> Matrix3x2: Transposed matrix

Special methods

def __add__(self, arg0: Matrix2x3, /) -> Matrix2x3: Add a matrix
def __buffer__(self, flags, /): Return a buffer object that exposes the underlying memory of the object.
def __eq__(self, arg0: Matrix2x3, /) -> bool: Equality comparison
def __getitem__(self, arg0: int, /) -> Vector3: Column at given position
def __getitem__(self, arg0: tuple[int, int], /) -> float: Value at given col/row
def __getstate__(self, /) -> bytes: Dumps the in-memory representation of matrix components
def __iadd__(self, arg0: Matrix2x3, /) -> Matrix2x3: Add and assign a matrix
def __imul__(self, arg0: float, /) -> Matrix2x3: Multiply with a scalar and assign
def __init__(self, arg0: Matrix2x3d, /) -> None: Construct from different underlying type
def __init__(self, arg0: Buffer, /) -> None: Construct from a buffer
def __init__(self, /) -> None: Default constructor
def __init__(self, arg0: float, /) -> None: Construct a matrix with one value for all components
def __init__(self, arg0: Vector3, arg1: Vector3, /) -> None: Construct from column vectors
def __init__(self, arg0: tuple[Vector3, Vector3], /) -> None: Construct from a column vector tuple
def __init__(self, arg0: tuple[tuple[float, float, float], tuple[float, float, float]], /) -> None: Construct from a column tuple
def __isub__(self, arg0: Matrix2x3, /) -> Matrix2x3: Subtract and assign a matrix
def __itruediv__(self, arg0: float, /) -> Matrix2x3: Divide with a scalar and assign
def __len__() -> int: Matrix column count. Returns 2.
def __matmul__(self, arg0: Matrix2x2, /) -> Matrix2x3: Multiply a matrix
def __matmul__(self, arg0: Matrix3x2, /) -> Matrix3x3: Multiply a matrix
def __matmul__(self, arg0: Matrix4x2, /) -> Matrix4x3: Multiply a matrix
def __mul__(self, arg0: float, /) -> Matrix2x3: Multiply with a scalar
def __mul__(self, arg0: Vector2, /) -> Vector3: Multiply a vector
def __ne__(self, arg0: Matrix2x3, /) -> bool: Non-equality comparison
def __neg__(self, /) -> Matrix2x3: Negated matrix
def __release_buffer__(self, buffer, /): Release the buffer object that exposes the underlying memory of the object.
def __repr__(self, /) -> str: Object representation
def __rmul__(self, arg0: float, /) -> Matrix2x3: Multiply a scalar with a matrix
def __rtruediv__(self, arg0: float, /) -> Matrix2x3: Divide a matrix with a scalar and invert
def __setitem__(self, arg0: int, arg1: Vector3, /) -> None: Set a column at given position
def __setitem__(self, arg0: tuple[int, int], arg1: float, /) -> None: Set a value at given col/row
def __setstate__(self, arg0: bytes, /) -> None: Treats the data as the in-memory representation of matrix components
def __sub__(self, arg0: Matrix2x3, /) -> Matrix2x3: Subtract a matrix
def __truediv__(self, arg0: float, /) -> Matrix2x3: Divide with a scalar

Method documentation

def magnum.Matrix2x3.setstate(self, arg0: bytes, /) -> None

Treats the data as the in-memory representation of matrix components