:mod:`heat.sparse.dcsx_matrix`
==============================
.. py:module:: heat.sparse.dcsx_matrix

.. autoapi-nested-parse::

   Provides DCSR_matrix, a distributed compressed sparse row matrix



Module Contents
---------------


.. py:class:: DCSR_matrix(array: torch.Tensor, gnnz: int, gshape: Tuple[int, Ellipsis], dtype: heat.core.types.datatype, split: Union[int, None], device: heat.core.devices.Device, comm: Communication, balanced: bool)

   Bases: :class:`__DCSX_matrix`

   Distributed Compressed Sparse Row Matrix. It is composed of
   PyTorch sparse_csr_tensors local to each process.

   :param array: Local sparse array
   :type array: torch.Tensor (layout ==> torch.sparse_csr)
   :param gnnz: Total number of non-zero elements across all processes
   :type gnnz: int
   :param gshape: The global shape of the array
   :type gshape: Tuple[int,...]
   :param dtype: The datatype of the array
   :type dtype: datatype
   :param split: If split is not None, it denotes the axis on which the array is divided between processes.
                 DCSR_matrix only supports distribution along axis 0.
   :type split: int or None
   :param device: The device on which the local arrays are using (cpu or gpu)
   :type device: Device
   :param comm: The communications object for sending and receiving data
   :type comm: Communication
   :param balanced: Describes whether the data are evenly distributed across processes.
   :type balanced: bool or None


   .. role:: raw-html(raw)
      :format: html

.. py:class:: DCSC_matrix(array: torch.Tensor, gnnz: int, gshape: Tuple[int, Ellipsis], dtype: heat.core.types.datatype, split: Union[int, None], device: heat.core.devices.Device, comm: Communication, balanced: bool)

   Bases: :class:`__DCSX_matrix`

   Distributed Compressed Sparse Column Matrix. It is composed of
   PyTorch sparse_csc_tensors local to each process.

   :param array: Local sparse array
   :type array: torch.Tensor (layout ==> torch.sparse_csc)
   :param gnnz: Total number of non-zero elements across all processes
   :type gnnz: int
   :param gshape: The global shape of the array
   :type gshape: Tuple[int,...]
   :param dtype: The datatype of the array
   :type dtype: datatype
   :param split: If split is not None, it denotes the axis on which the array is divided between processes.
                 DCSR_matrix only supports distribution along axis 0.
   :type split: int or None
   :param device: The device on which the local arrays are using (cpu or gpu)
   :type device: Device
   :param comm: The communications object for sending and receiving data
   :type comm: Communication
   :param balanced: Describes whether the data are evenly distributed across processes.
   :type balanced: bool or None


   .. role:: raw-html(raw)
      :format: html