Class swarmauri_core.tensors.ITensor.ITensor

swarmauri_core.tensors.ITensor.ITensor

Bases: ABC

Core interface for tensorial algebra components.

This interface specifies required tensor operations and structural properties that all tensor implementations must support, providing a common API for n-dimensional arrays and mathematical operations.

shape abstractmethod property

shape

Get the shape of the tensor.

Returns

Shape The dimensions of the tensor

dtype abstractmethod property

dtype

Get the data type of the tensor elements.

Returns

type The data type of the elements

reshape abstractmethod

reshape(shape)

Reshape the tensor to the specified dimensions.

Parameters

shape : Shape The new dimensions

Returns

ITensor A reshaped tensor

Raises

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

Source code in swarmauri_core/tensors/ITensor.py

@abstractmethod
def reshape(self, shape: Shape) -> "ITensor":
    """
    Reshape the tensor to the specified dimensions.

    Parameters
    ----------
    shape : Shape
        The new dimensions

    Returns
    -------
    ITensor
        A reshaped tensor

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

tolist abstractmethod

tolist()

Convert the tensor to a nested list.

Returns

List A nested list representing the tensor

Source code in swarmauri_core/tensors/ITensor.py

@abstractmethod
def tolist(self) -> List:
    """
    Convert the tensor to a nested list.

    Returns
    -------
    List
        A nested list representing the tensor
    """
    pass

transpose abstractmethod

transpose(axes=None)

Transpose (permute) the tensor's axes.

Parameters

axes : Union[None, Tuple[int, ...]], optional The new order of dimensions. If None, reverse the dimensions.

Returns

ITensor The transposed tensor

Raises

ValueError If the axes specification is invalid

Source code in swarmauri_core/tensors/ITensor.py

@abstractmethod
def transpose(self, axes: Union[None, Tuple[int, ...]] = None) -> "ITensor":
    """
    Transpose (permute) the tensor's axes.

    Parameters
    ----------
    axes : Union[None, Tuple[int, ...]], optional
        The new order of dimensions. If None, reverse the dimensions.

    Returns
    -------
    ITensor
        The transposed tensor

    Raises
    ------
    ValueError
        If the axes specification is invalid
    """
    pass

broadcast abstractmethod

broadcast(shape)

Broadcast the tensor to a new shape.

Parameters

shape : Shape The shape to broadcast to

Returns

ITensor The broadcasted tensor

Raises

ValueError If the tensor cannot be broadcast to the given shape

Source code in swarmauri_core/tensors/ITensor.py

@abstractmethod
def broadcast(self, shape: Shape) -> "ITensor":
    """
    Broadcast the tensor to a new shape.

    Parameters
    ----------
    shape : Shape
        The shape to broadcast to

    Returns
    -------
    ITensor
        The broadcasted tensor

    Raises
    ------
    ValueError
        If the tensor cannot be broadcast to the given shape
    """
    pass

astype abstractmethod

astype(dtype)

Cast the tensor to a specified data type.

Parameters

dtype : type The target data type

Returns

ITensor A new tensor with the specified data type

Source code in swarmauri_core/tensors/ITensor.py

@abstractmethod
def astype(self, dtype: type) -> "ITensor":
    """
    Cast the tensor to a specified data type.

    Parameters
    ----------
    dtype : type
        The target data type

    Returns
    -------
    ITensor
        A new tensor with the specified data type
    """
    pass

to_matrix abstractmethod

to_matrix()

Convert the tensor to a matrix if possible.

Returns

IMatrix The tensor as a matrix

Raises

ValueError If the tensor cannot be converted to a matrix

Source code in swarmauri_core/tensors/ITensor.py

@abstractmethod
def to_matrix(self) -> Literal[IMatrix]:
    """
    Convert the tensor to a matrix if possible.

    Returns
    -------
    IMatrix
        The tensor as a matrix

    Raises
    ------
    ValueError
        If the tensor cannot be converted to a matrix
    """
    pass

to_vector abstractmethod

to_vector()

Convert the tensor to a vector if possible.

Returns

IVector The tensor as a vector

Raises

ValueError If the tensor cannot be converted to a vector

Source code in swarmauri_core/tensors/ITensor.py

@abstractmethod
def to_vector(self) -> Literal[IVector]:
    """
    Convert the tensor to a vector if possible.

    Returns
    -------
    IVector
        The tensor as a vector

    Raises
    ------
    ValueError
        If the tensor cannot be converted to a vector
    """
    pass