symmray.common

Common interfaces for all symmray array objects.

Attributes

_symmray_namespace

Classes

SymmrayCommon

Common functionality for all symmray array like objects.

Module Contents

symmray.common._symmray_namespace = None

class symmray.common.SymmrayCommon

Common functionality for all symmray array like objects.

__array_namespace__(api_version=None)

Return the namespace for the symmray module.

_modify_or_copy(inplace=False, **kwargs) → SymmrayCommon

__float__()

__complex__()

__int__()

__bool__()

to(like=None, *, backend=None, dtype=None, device=None, inplace=False)

Convert all underlying arrays to a backend, dtype, and/or device.

Parameters:

• like (str or array_like, optional) – Conversion target specification or example array. For example “torch-float32-cuda:0” or an example array with those attributes. Explicitly supplied backend, dtype or device override this.

• backend (str, optional) – Target backend.

• dtype (str or dtype, optional) – Target floating point or complex dtype.

• device (str or device_like, optional) – Target device.

• inplace (bool, optional) – Whether to convert this object in place.

Returns:

The converted object.

Return type:

SymmrayCommon

__mul__(other, inplace=False)

__imul__(other)

__rmul__(other)

__neg__() → SymmrayCommon

_do_unary_op(fn, inplace=False) → SymmrayCommon

Perform a unary operation on blocks of the array.

abs()

Get the absolute value of all elements in the array.

isfinite()

Check if all elements in the array are finite.

sqrt()

Get the square root of all elements in the array.

clip(a_min, a_max)

Clip the values in the array.

max()

Get the maximum element from any block in the array.

min()

Get the minimum element from any block in the array.

sum()

Get the sum of all elements in the array.

all()

Check if all elements in the array are True.

any()

Check if any element in the array is True.

property real

Return the real part of the array.

property imag

Return the imaginary part of the array.