Class swarmauri_core.matrices.IMatrix.IMatrix

swarmauri_core.matrices.IMatrix.IMatrix

Bases: ABC

Interface abstraction for matrix operations.

This interface defines the standard operations and properties that all matrix implementations must support, providing a common API for linear operators and 2D structures.

shape abstractmethod property

shape

Get the shape of the matrix.

Returns

Tuple[int, int] The dimensions of the matrix as (rows, columns)

dtype abstractmethod property

dtype

Get the data type of the matrix elements.

Returns

type The data type of the elements

reshape abstractmethod

reshape(shape)

Reshape the matrix to the specified dimensions.

Parameters

shape : Tuple[int, int] The new dimensions as (rows, columns)

Returns

IMatrix A reshaped matrix

Raises

ValueError If the new shape is incompatible with the total number of elements

Source code in swarmauri_core/matrices/IMatrix.py

@abstractmethod
def reshape(self, shape: Tuple[int, int]) -> "IMatrix":
    """
    Reshape the matrix to the specified dimensions.

    Parameters
    ----------
    shape : Tuple[int, int]
        The new dimensions as (rows, columns)

    Returns
    -------
    IMatrix
        A reshaped matrix

    Raises
    ------
    ValueError
        If the new shape is incompatible with the total number of elements
    """
    pass

tolist abstractmethod

tolist()

Convert the matrix to a nested list.

Returns

List[List[T]] A list of lists representing the matrix

Source code in swarmauri_core/matrices/IMatrix.py

@abstractmethod
def tolist(self) -> List[List[T]]:
    """
    Convert the matrix to a nested list.

    Returns
    -------
    List[List[T]]
        A list of lists representing the matrix
    """
    pass

row abstractmethod

row(index)

Get a specific row of the matrix.

Parameters

index : int The row index

Returns

IVector The specified row as a vector

Raises

IndexError If the index is out of bounds

Source code in swarmauri_core/matrices/IMatrix.py

@abstractmethod
def row(self, index: int) -> IVector:
    """
    Get a specific row of the matrix.

    Parameters
    ----------
    index : int
        The row index

    Returns
    -------
    IVector
        The specified row as a vector

    Raises
    ------
    IndexError
        If the index is out of bounds
    """
    pass

column abstractmethod

column(index)

Get a specific column of the matrix.

Parameters

index : int The column index

Returns

IVector The specified column as a vector

Raises

IndexError If the index is out of bounds

Source code in swarmauri_core/matrices/IMatrix.py

@abstractmethod
def column(self, index: int) -> IVector:
    """
    Get a specific column of the matrix.

    Parameters
    ----------
    index : int
        The column index

    Returns
    -------
    IVector
        The specified column as a vector

    Raises
    ------
    IndexError
        If the index is out of bounds
    """
    pass

transpose abstractmethod

transpose()

Transpose the matrix.

Returns

IMatrix The transposed matrix

Source code in swarmauri_core/matrices/IMatrix.py

@abstractmethod
def transpose(self) -> "IMatrix":
    """
    Transpose the matrix.

    Returns
    -------
    IMatrix
        The transposed matrix
    """
    pass