MutableMatrix#
- class pybrops.core.mat.MutableMatrix.MutableMatrix[source]#
Bases:
Matrix
An abstract class for mutable matrix wrapper objects.
- The purpose of this abstract class is to provide base functionality for:
Matrix in-place matrix shape changing routines.
The shape of a MutableMatrix is mutable.
Methods
Add additional elements to the end of the Matrix along an axis.
Append values to the Matrix.
Concatenate matrices together along an axis.
Make a shallow copy of the Matrix.
Make a deep copy of the Matrix.
Delete sub-arrays along an axis.
Read an object from an HDF5 file.
Incorporate values along the given axis before the given indices.
Insert values along the given axis before the given indices.
Remove sub-arrays along an axis.
Select certain values from the matrix.
Write an object to an HDF5 file.
Attributes
Pointer to raw matrix object.
Number of dimensions of the raw matrix.
Shape of the raw matrix.
- 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:
- abstract append(values, axis, **kwargs)[source]#
Append values to the Matrix.
- Parameters:
values (Matrix, numpy.ndarray) – Values are appended to append to the matrix.
axis (int) – The axis along which values are appended.
kwargs (dict) – Additional keyword arguments.
- Return type:
None
- 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:
- abstract copy()#
Make a shallow copy of the Matrix.
- Returns:
out – A shallow copy of the original Matrix.
- Return type:
- 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:
- 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:
- 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. IfPath
, an HDF5 file name from which to read. Ifh5py.File
, an opened HDF5 file from which to read.groupname (str, None) – If
str
, an HDF5 group name under which object data is stored. IfNone
, object is read from base HDF5 group.
- Returns:
out – An object read from an HDF5 file.
- Return type:
- abstract incorp(obj, values, axis, **kwargs)[source]#
Incorporate 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 incorporated.
values (numpy.ndarray) – Values to incorporate into the matrix.
axis (int) – The axis along which values are incorporated.
kwargs (dict) – Additional keyword arguments.
- Return type:
None
- 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:
- 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 remove(obj, axis, **kwargs)[source]#
Remove 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 remove the subarray defined by obj.
kwargs (dict) – Additional keyword arguments.
- Return type:
None
- 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:
- 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. IfPath
, an HDF5 file path to which to write. Ifh5py.File
, an opened HDF5 file to which to write.groupname (str, None) – If
str
, an HDF5 group name under which object data is stored. IfNone
, 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