SquareMatrix#

class pybrops.core.mat.SquareMatrix.SquareMatrix[source]#

Bases: Matrix

An abstract class for square matrices. A “square matrix” is defined as a matrix that has the same axis metadata associated with two or more axes. For example:

This is a square matrix since metadata applies to axes 0 and 1:
       taxa
     +-------+
taxa | (n,n) |
     +-------+

This is not a square matrix since unique metadata applies to each axis:
       vrnt
     +-------+
taxa | (n,p) |  Where: n == p
     +-------+

The purpose of this abstract class is to provide base functionality for:

Square matrix axis metadata.

Determination of square matrix conformity.

Methods

`adjoin`	Add additional elements to the end of the Matrix along an axis.
`concat`	Concatenate matrices together along an axis.
`copy`	Make a shallow copy of the Matrix.
`deepcopy`	Make a deep copy of the Matrix.
`delete`	Delete sub-arrays along an axis.
`from_hdf5`	Read an object from an HDF5 file.
`insert`	Insert values along the given axis before the given indices.
`is_square`	Determine whether the axes lengths for the square axes are identical.
`select`	Select certain values from the matrix.
`to_hdf5`	Write an object to an HDF5 file.

Attributes

`mat`	Pointer to raw matrix object.
`mat_ndim`	Number of dimensions of the raw matrix.
`mat_shape`	Shape of the raw matrix.
`nsquare`	Number of axes that are square.
`square_axes`	Axis indices for axes that are square.
`square_axes_len`	Axis lengths for axes that are square.

abstract __add__(value)#

Elementwise add matrices

Parameters:: value (object) – Object which to add.
Returns:: out – An object resulting from the addition.
Return type:: object

abstract __mul__(value)#

Elementwise multiply matrices

Parameters:: value (object) – Object which to multiply.
Returns:: out – An object resulting from the multiplication.
Return type:: object

abstract adjoin(values, axis, **kwargs)#

Add additional elements to the end of the Matrix along an axis.

Parameters:

values (Matrix or numpy.ndarray) – Values are appended to append to the Matrix.
axis (int) – The axis along which values are adjoined.
kwargs (dict) – Additional keyword arguments.

Returns:

out – A copy of mat with values appended to axis. Note that adjoin does not occur in-place: a new Matrix is allocated and filled.

Return type:

Matrix

abstract classmethod concat(mats, axis, **kwargs)#

Concatenate matrices together along an axis.

Parameters:

mats (Sequence of Matrix) – List of Matrix to concatenate. The matrices must have the same shape, except in the dimension corresponding to axis.
axis (int) – The axis along which the arrays will be joined.
kwargs (dict) – Additional keyword arguments

Returns:

out – The concatenated matrix. Note that concat does not occur in-place: a new Matrix is allocated and filled.

Return type:

Matrix

abstract copy()#

Make a shallow copy of the Matrix.

Returns:: out – A shallow copy of the original Matrix.
Return type:: Matrix

abstract deepcopy(memo)#

Make a deep copy of the Matrix.

Parameters:: memo (dict) – Dictionary of memo metadata.
Returns:: out – A deep copy of the original Matrix.
Return type:: Matrix

abstract delete(obj, axis, **kwargs)#

Delete sub-arrays along an axis.

Parameters:

obj (int, slice, or Sequence of ints) – Indicate indices of sub-arrays to remove along the specified axis.
axis (int) – The axis along which to delete the subarray defined by obj.
kwargs (dict) – Additional keyword arguments.

Returns:

out – A Matrix with deleted elements. Note that concat does not occur in-place: a new Matrix is allocated and filled.

Return type:

Matrix

abstract classmethod from_hdf5(filename, groupname)#

Read an object from an HDF5 file.

Parameters:

filename (str, Path, h5py.File) – If str, an HDF5 file name from which to read. If Path, an HDF5 file name from which to read. If h5py.File, an opened HDF5 file from which to read.
groupname (str, None) – If str, an HDF5 group name under which object data is stored. If None, object is read from base HDF5 group.

Returns:

out – An object read from an HDF5 file.

Return type:

HDF5InputOutput

abstract insert(obj, values, axis, **kwargs)#

Insert values along the given axis before the given indices.

Parameters:

obj (int, slice, or Sequence of ints) – Object that defines the index or indices before which values is inserted.
values (ArrayLike) – Values to insert into the matrix.
axis (int) – The axis along which values are inserted.
kwargs (dict) – Additional keyword arguments.

Returns:

out – A Matrix with values inserted. Note that insert does not occur in-place: a new Matrix is allocated and filled.

Return type:

Matrix

abstract is_square()[source]#

Determine whether the axes lengths for the square axes are identical.

Returns:: out – True if all square axes are the same length. False if not all square axes are the same length.
Return type:: bool

abstract property mat: object#: Pointer to raw matrix object.

abstract property mat_ndim: int#: Number of dimensions of the raw matrix.

abstract property mat_shape: tuple#: Shape of the raw matrix.

abstract property nsquare: int#: Number of axes that are square.

abstract select(indices, axis, **kwargs)#

Select certain values from the matrix.

Parameters:

indices (ArrayLike (Nj, ...)) – The indices of the values to select.
axis (int) – The axis along which values are selected.
kwargs (dict) – Additional keyword arguments.

Returns:

out – The output matrix with values selected. Note that select does not occur in-place: a new Matrix is allocated and filled.

Return type:

Matrix

abstract property square_axes: tuple#: Axis indices for axes that are square.

abstract property square_axes_len: tuple#: Axis lengths for axes that are square.

abstract to_hdf5(filename, groupname, overwrite)#

Write an object to an HDF5 file.

Parameters:

filename (str, Path, h5py.File) – If str, an HDF5 file name to which to write. If Path, an HDF5 file path to which to write. If h5py.File, an opened HDF5 file to which to write.
groupname (str, None) – If str, an HDF5 group name under which object data is stored. If None, object is written to the base HDF5 group.
overwrite (bool) – Whether to overwrite values in an HDF5 file if a field already exists.

Return type:

None