.. currentmodule:: sparse

Operations on :obj:`COO` and :obj:`GCXS` arrays
===============================================

.. _operations-operators:

Operators
---------

:obj:`COO` and :obj:`GCXS` objects support a number of operations. They interact with scalars,
:doc:`Numpy arrays <numpy:reference/generated/numpy.ndarray>`, other :obj:`COO` and :obj:`GCXS` objects,
and :obj:`scipy.sparse.spmatrix` objects, all following standard Python and Numpy
conventions.

For example, the following Numpy expression produces equivalent
results for both Numpy arrays, COO arrays, or a mix of the two:

.. code-block:: python

   np.log(X.dot(beta.T) + 1)

However some operations are not supported, like operations that
implicitly cause dense structures, or numpy functions that are not
yet implemented for sparse arrays.

.. code-block:: python

   np.linalg.cholesky(x)  # sparse cholesky not implemented


This page describes those valid operations, and their limitations.

:obj:`elemwise`
~~~~~~~~~~~~~~~
This function allows you to apply any arbitrary broadcasting function to any number of arguments
where the arguments can be :obj:`SparseArray` objects or :obj:`scipy.sparse.spmatrix` objects.
For example, the following will add two arrays:

.. code-block:: python

   sparse.elemwise(np.add, x, y)


.. warning:: Previously, :obj:`elemwise` was a method of the :obj:`COO` class. Now,
   it has been moved to the :obj:`sparse` module.

.. _operations-auto-densification:

Auto-Densification
~~~~~~~~~~~~~~~~~~
Operations that would result in dense matrices, such as
operations with :doc:`Numpy arrays <numpy:reference/generated/numpy.ndarray>`
raises a :obj:`ValueError`. For example, the following will raise a
:obj:`ValueError` if :code:`x` is a :obj:`numpy.ndarray`:

.. code-block:: python

   x + y

However, all of the following are valid operations.

.. code-block:: python

   x + 0
   x != y
   x + y
   x == 5
   5 * x
   x / 7.3
   x != 0
   x == 0
   ~x
   x + 5

We also support operations with a nonzero fill value. These are operations
that map zero values to nonzero values, such as :code:`x + 1` or :code:`~x`.
In these cases, they will produce an output with a fill value of :code:`1` or :code:`True`,
assuming the original array has a fill value of :code:`0` or :code:`False` respectively.

If densification is needed, it must be explicit. In other words, you must call
:obj:`SparseArray.todense` on the :obj:`SparseArray` object. If both operands are :obj:`SparseArray`,
both must be densified.

Operations with NumPy arrays
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In certain situations, operations with NumPy arrays are also supported. For example,
the following will work if :code:`x` is :obj:`COO` and :code:`y` is a NumPy array:

.. code-block:: python

   x * y

The following conditions must be met when performing element-wise operations with
NumPy arrays:

* The operation must produce a consistent fill-values. In other words, the resulting
  array must also be sparse.
* Operating on the NumPy arrays must not increase the size when broadcasting the arrays.

Operations with :obj:`scipy.sparse.spmatrix`
--------------------------------------------
Certain operations with :obj:`scipy.sparse.spmatrix` are also supported.
For example, the following are all allowed if :code:`y` is a :obj:`scipy.sparse.spmatrix`:

.. code-block:: python

   x + y
   x - y
   x * y
   x > y
   x < y

In general, operating on a :code:`scipy.sparse.spmatrix` is the same as operating
on :obj:`COO` or :obj:`GCXS`, as long as it is to the right of the operator.

.. note:: Results are not guaranteed if :code:`x` is a :obj:`scipy.sparse.spmatrix`.
   For this reason, we recommend that all Scipy sparse matrices should be explicitly
   converted to :obj:`COO` or :obj:`GCXS` before any operations.


Broadcasting
------------
All binary operators support :doc:`broadcasting <numpy:user/basics.broadcasting>`.
This means that (under certain conditions) you can perform binary operations
on arrays with unequal shape. Namely, when the shape is missing a dimension,
or when a dimension is :code:`1`. For example, performing a binary operation
on two :obj:`COO` arrays with shapes :code:`(4,)` and :code:`(5, 1)` yields
an object of shape :code:`(5, 4)`. The same happens with arrays of shape
:code:`(1, 4)` and :code:`(5, 1)`. However, :code:`(4, 1)` and :code:`(5, 1)`
will raise a :obj:`ValueError`.

.. _operations-elemwise:

Element-wise Operations
-----------------------
:obj:`COO` and :obj:`GCXS` arrays support a variety of element-wise operations. However, as
with operators, operations that map zero to a nonzero value are not supported.

To illustrate, the following are all possible, and will produce another
:obj:`SparseArray`:

.. code-block:: python

   np.abs(x)
   np.sin(x)
   np.sqrt(x)
   np.conj(x)
   np.expm1(x)
   np.log1p(x)
   np.exp(x)
   np.cos(x)
   np.log(x)

As above, in the last three cases, an array with a nonzero fill value will be produced.

Notice that you can apply any unary or binary :doc:`numpy.ufunc <numpy:reference/ufuncs>` to :obj:`COO`
arrays, and :obj:`numpy.ndarray` objects and scalars and it will work so
long as the result is not dense. When applying to :obj:`numpy.ndarray` objects,
we check that operating on the array with zero would always produce a zero.

.. _operations-reductions:

Reductions
----------
:obj:`COO` and :obj:`GCXS` objects support a number of reductions. However, not all important
reductions are currently implemented (help welcome!) All of the following
currently work:

.. code-block:: python

   x.sum(axis=1)
   np.max(x)
   np.min(x, axis=(0, 2))
   x.prod()


:obj:`SparseArray.reduce`
~~~~~~~~~~~~~~~~~~~~~~~~~
This method can take an arbitrary :doc:`numpy.ufunc <numpy:reference/ufuncs>` and performs a
reduction using that method. For example, the following will perform
a sum:

.. code-block:: python

   x.reduce(np.add, axis=1)

.. note::
   This library currently performs reductions by grouping together all
   coordinates along the supplied axes and reducing those. Then, if the
   number in a group is deficient, it reduces an extra time with zero.
   As a result, if reductions can change by adding multiple zeros to
   it, this method won't be accurate. However, it works in most cases.

Partial List of Supported Reductions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Although any binary :doc:`numpy.ufunc <numpy:reference/ufuncs>` should work for reductions, when calling
in the form :code:`x.reduction()`, the following reductions are supported:

* :obj:`COO.sum`
* :obj:`COO.max`
* :obj:`COO.min`
* :obj:`COO.prod`

.. _operations-indexing:

Indexing
--------
:obj:`COO` and :obj:`GCXS` arrays can be :obj:`indexed <numpy.doc.indexing>` just like regular
:obj:`numpy.ndarray` objects. They support integer, slice and boolean indexing.
However, currently, numpy advanced indexing is not properly supported. This
means that all of the following work like in Numpy, except that they will produce
:obj:`SparseArray` arrays rather than :obj:`numpy.ndarray` objects, and will produce
scalars where expected. Assume that :code:`z.shape` is :code:`(5, 6, 7)`

.. code-block:: python

   z[0]
   z[1, 3]
   z[1, 4, 3]
   z[:3, :2, 3]
   z[::-1, 1, 3]
   z[-1]

All of the following will raise an :obj:`IndexError`, like in Numpy 1.13 and later.

.. code-block:: python

   z[6]
   z[3, 6]
   z[1, 4, 8]
   z[-6]


Advanced Indexing
~~~~~~~~~~~~~~~~~

Advanced indexing (indexing arrays with other arrays) is supported, but only for indexing
with a *single array*. Indexing a single array with multiple arrays is not supported at
this time. As above, if  :code:`z.shape` is :code:`(5, 6, 7)`, all of the following will
work like NumPy:

.. code-block:: python

   z[[0, 1, 2]]
   z[1, [3]]
   z[1, 4, [3, 6]]
   z[:3, :2, [1, 5]]


Package Configuration
---------------------

By default, when performing something like ``np.array(COO)``, we allow the array
to be converted into a dense one. To prevent this and raise a :obj:`RuntimeError`
instead, set the environment variable ``SPARSE_AUTO_DENSIFY`` to ``0``.

If it is desired to raise a warning if creating a sparse array that takes no less
memory than an equivalent desne array, set the environment variable
``SPARSE_WARN_ON_TOO_DENSE`` to ``1``.

.. _operations-other:

Other Operations
----------------
:obj:`COO` and :obj:`GCXS` arrays support a number of other common operations. Among them are
:obj:`dot`, :obj:`tensordot`, :obj:`einsum`, :obj:`concatenate`
and :obj:`stack`, :obj:`transpose <COO.transpose>` and :obj:`reshape <COO.reshape>`.
You can view the full list on the :doc:`API reference page <generated/sparse>`.

.. note:: Some operations require zero fill-values (such as :obj:`nonzero <COO.nonzero>`)
   and others (such as :obj:`concatenate`) require that all inputs have consistent fill-values.
   For details, check the API reference.
