symmray.common
==============

.. py:module:: symmray.common

.. autoapi-nested-parse::

   Common interfaces for all symmray array objects.



Attributes
----------

.. autoapisummary::

   symmray.common._symmray_namespace


Classes
-------

.. autoapisummary::

   symmray.common.SymmrayCommon


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

.. py:data:: _symmray_namespace
   :value: None


.. py:class:: SymmrayCommon

   Common functionality for all symmray array like objects.


   .. py:method:: __array_namespace__(api_version=None)

      Return the namespace for the symmray module.



   .. py:method:: _modify_or_copy(inplace=False, **kwargs) -> SymmrayCommon


   .. py:method:: __float__()


   .. py:method:: __complex__()


   .. py:method:: __int__()


   .. py:method:: __bool__()


   .. py:method:: __mul__(other, inplace=False)


   .. py:method:: __imul__(other)


   .. py:method:: __rmul__(other)


   .. py:method:: __neg__() -> SymmrayCommon


   .. py:method:: _do_unary_op(fn, inplace=False) -> SymmrayCommon

      Perform a unary operation on blocks of the array.



   .. py:method:: abs()

      Get the absolute value of all elements in the array.



   .. py:method:: isfinite()

      Check if all elements in the array are finite.



   .. py:method:: sqrt()

      Get the square root of all elements in the array.



   .. py:method:: clip(a_min, a_max)

      Clip the values in the array.



   .. py:method:: max()

      Get the maximum element from any block in the array.



   .. py:method:: min()

      Get the minimum element from any block in the array.



   .. py:method:: sum()

      Get the sum of all elements in the array.



   .. py:method:: all()

      Check if all elements in the array are True.



   .. py:method:: any()

      Check if any element in the array is True.



   .. py:property:: real

      Return the real part of the array.


   .. py:property:: imag

      Return the imaginary part of the array.