symmray.interface
=================

.. py:module:: symmray.interface

.. autoapi-nested-parse::

   Functional interface for `symmray` array objects.



Functions
---------

.. autoapisummary::

   symmray.interface.conj
   symmray.interface.max
   symmray.interface.min
   symmray.interface.sum
   symmray.interface.all
   symmray.interface.any
   symmray.interface.isfinite
   symmray.interface.abs
   symmray.interface.sqrt
   symmray.interface.log
   symmray.interface.log2
   symmray.interface.log10
   symmray.interface.real
   symmray.interface.imag
   symmray.interface.clip
   symmray.interface.squeeze
   symmray.interface.expand_dims
   symmray.interface.reshape
   symmray.interface.tensordot
   symmray.interface.einsum
   symmray.interface.transpose
   symmray.interface.trace
   symmray.interface.take
   symmray.interface.multiply_diagonal
   symmray.interface.ldmul
   symmray.interface.rdmul
   symmray.interface.lddiv
   symmray.interface.rddiv
   symmray.interface.align_axes
   symmray.interface.fuse


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

.. py:function:: conj(x, **kwargs)

   Conjugate a `symmray` array.


.. py:function:: max(x)

   Return the maximum value of a `symmray` array.


.. py:function:: min(x)

   Return the minimum value of a `symmray` array.


.. py:function:: sum(x)

   Return the sum of a `symmray` array.


.. py:function:: all(x)

   Check if all elements of a `symmray` array are true.


.. py:function:: any(x)

   Check if any elements of a `symmray` array are true.


.. py:function:: isfinite(x)

   Check if a `symmray` array contains only finite values.


.. py:function:: abs(x)

   Return the absolute value of a `symmray` array.


.. py:function:: sqrt(x)

   Return the square root of a `symmray` array.


.. py:function:: log(x)

   Return the natural logarithm of a `symmray` array.


.. py:function:: log2(x)

   Return the base-2 logarithm of a `symmray` array.


.. py:function:: log10(x)

   Return the base-10 logarithm of a `symmray` array.


.. py:function:: real(x)

   Return the real part of a `symmray` array.


.. py:function:: imag(x)

   Return the imaginary part of a `symmray` array.


.. py:function:: clip(x, a_min, a_max)

   Clip the values of a `symmray` array.


.. py:function:: squeeze(x, axis=None)

   Remove single-dimensional entries from shape of a `symmray` array.


.. py:function:: expand_dims(x, axis)

   Expand the shape of a `symmray` array.


.. py:function:: reshape(a, newshape, **kwargs)

   Reshape a `symmray` array, via fusing or unfusing.


.. py:function:: tensordot(a, b, axes=2, **kwargs)

   Contract two `symmray` arrays along the specified axes.

   :param a: First array to contract.
   :type a: AbelianArray or FermionicArray
   :param b: Second array to contract, with same type as `a`.
   :type b: AbelianArray or FermionicArray
   :param axes: If an integer, the number of axes to contract. If a tuple, the axes
                to contract. Default is 2.
   :type axes: int or tuple of int, optional


.. py:function:: einsum(*args, **kwargs)

   Perform an Einstein summation on a `symmray` array, this simply uses
   `cotengra` to dispatch the full expression into pairwise tensordot (or
   einsum if necessary) calls.


.. py:function:: transpose(a, axes=None, **kwargs)

   Transpose a `symmray` array.


.. py:function:: trace(a)

   Return the trace of a `symmray` array.


.. py:function:: take(a, indices, axis, **kwargs)

   Take elements from a `symmray` array along an axis.


.. py:function:: multiply_diagonal(x, v, axis)

   Multiply a `symmray` array by a vector as if contracting a diagonal
   matrix into one axis.


.. py:function:: ldmul(v, x)

   Left multiply a `symmray` matrix `x` by a vector `v`.


.. py:function:: rdmul(x, v)

   Right multiply a `symmray` matrix `x` by a vector `v`.


.. py:function:: lddiv(v, x)

   Left divide a `symmray` matrix `x` by a vector `v`.


.. py:function:: rddiv(x, v)

   Right divide a `symmray` matrix `x` by a vector `v`.


.. py:function:: align_axes(x, y, axes)

.. py:function:: fuse(x, *axes_groups)

   Fuse multiple axes of a `symmray` array.