arkouda.sparrayclass
====================

.. py:module:: arkouda.sparrayclass


Classes
-------

.. autoapisummary::

   arkouda.sparrayclass.sparray


Functions
---------

.. autoapisummary::

   arkouda.sparrayclass.create_sparray


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

.. py:function:: create_sparray(repMsg: str, max_bits=None) -> sparray

   Return a sparray instance pointing to an array created by the arkouda server.
   The user should not call this function directly.

   :param repMsg: space-delimited string containing the sparray name, datatype, size
                  dimension, shape,and itemsize
   :type repMsg: str

   :returns: A sparray with the same attributes as on the server
   :rtype: sparray

   :raises ValueError: If there's an error in parsing the repMsg parameter into the six
       values needed to create the pdarray instance
   :raises RuntimeError: Raised if a server-side error is thrown in the process of creating
       the pdarray instance


.. py:class:: sparray(name: str, mydtype: Union[numpy.dtype, str], size: arkouda.numpy.dtypes.int_scalars, nnz: arkouda.numpy.dtypes.int_scalars, ndim: arkouda.numpy.dtypes.int_scalars, shape: Sequence[int], layout: str, itemsize: arkouda.numpy.dtypes.int_scalars, max_bits: Optional[int] = None)

   The class for sparse arrays. This class contains only the
   attributies of the array; the data resides on the arkouda
   server. When a server operation results in a new array, arkouda
   will create a sparray instance that points to the array data on
   the server. As such, the user should not initialize sparray
   instances directly.

   .. attribute:: name

      The server-side identifier for the array

      :type: str

   .. attribute:: dtype

      The element type of the array

      :type: dtype

   .. attribute:: size

      The size of any one dimension of the array (all dimensions are assumed to be equal sized for now)

      :type: int_scalars

   .. attribute:: nnz

      The number of non-zero elements in the array

      :type: int_scalars

   .. attribute:: ndim

      The rank of the array (currently only rank 2 arrays supported)

      :type: int_scalars

   .. attribute:: shape

      A list or tuple containing the sizes of each dimension of the array

      :type: Sequence[int]

   .. attribute:: layout

      The layout of the array ("CSR" or "CSC" are the only valid values)

      :type: str

   .. attribute:: itemsize

      The size in bytes of each element

      :type: int_scalars


   .. py:attribute:: dtype


   .. py:method:: fill_vals(a: arkouda.pdarrayclass.pdarray)


   .. py:attribute:: itemsize


   .. py:attribute:: layout


   .. py:attribute:: name


   .. py:attribute:: ndim


   .. py:attribute:: nnz


   .. py:attribute:: shape


   .. py:attribute:: size


   .. py:method:: to_pdarray() -> List[arkouda.pdarrayclass.pdarray]