rms-polymath 0.0.1__py3-none-any.whl

polymath/__init__.py

@@ -0,0 +1,24 @@
+################################################################################
+# polymath/__init__.py
+################################################################################
+
+from polymath.boolean    import Boolean
+from polymath.matrix     import Matrix
+from polymath.matrix3    import Matrix3
+from polymath.pair       import Pair
+from polymath.polynomial import Polynomial
+from polymath.quaternion import Quaternion
+from polymath.qube       import Qube
+from polymath.scalar     import Scalar
+from polymath.units      import Units
+from polymath.vector     import Vector
+from polymath.vector3    import Vector3
+
+import polymath.extensions
+
+try:
+    from _version import __version__
+except ImportError as err:
+    __version__ = 'Version unspecified'
+
+################################################################################

polymath/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.0.1'
+__version_tuple__ = version_tuple = (0, 0, 1)

polymath/boolean.py

@@ -0,0 +1,224 @@
+################################################################################
+# polymath/boolean.py: Boolean subclass of PolyMath base class
+################################################################################
+
+from __future__ import division
+import numpy as np
+
+from polymath.qube   import Qube
+from polymath.scalar import Scalar
+
+class Boolean(Scalar):
+    """A PolyMath subclass involving booleans. Masked values are unknown,
+    neither True nor False.
+
+    Units and derivatives are disallowed.
+    """
+
+    NRANK = 0           # the number of numerator axes.
+    NUMER = ()          # shape of the numerator.
+
+    FLOATS_OK = False   # True to allow floating-point numbers.
+    INTS_OK = False     # True to allow integers.
+    BOOLS_OK = True     # True to allow booleans.
+
+    UNITS_OK = False    # True to allow units; False to disallow them.
+    DERIVS_OK = False   # True to allow derivatives and to allow this class to
+                        # have a denominator; False to disallow them.
+
+    DEFAULT_VALUE = False
+
+    #===========================================================================
+    @staticmethod
+    def as_boolean(arg, recursive=True):
+        """The argument converted to Boolean if possible."""
+
+        if isinstance(arg, Boolean):
+            return arg
+
+        if isinstance(arg, np.bool_):   # np.bool_ is not a subclass of bool
+            arg = bool(arg)
+
+        return Boolean(arg, units=False, derivs={})
+
+    #===========================================================================
+    def as_int(self):
+        """A Scalar equal to one where True, zero where False.
+
+        This method overrides the default behavior defined in the base class to
+        return a Scalar of ints instead of a Boolean. True become one; False
+        becomes zero.
+        """
+
+        if np.isscalar(self._values_):
+            result = Scalar(int(self._values_))
+        else:
+            result = Scalar(self._values_.astype('int'))
+
+        return result
+
+    #===========================================================================
+    def as_float(self):
+        """A floating-point numeric version of this object.
+
+        This method overrides the default behavior defined in the base class to
+        return a Scalar of floats instead of a Boolean. True become one; False
+        becomes zero.
+        """
+
+        if np.isscalar(self._values_):
+            result = Scalar(float(self._values_))
+        else:
+            result = Scalar(self._values_.astype('float'))
+
+        return result
+
+    #===========================================================================
+    def as_numeric(self):
+        """A numeric version of this object.
+
+        This method overrides the default behavior defined in the base class to
+        return a Scalar of ints instead of a Boolean.
+        """
+
+        return self.as_int()
+
+    #===========================================================================
+    def as_index(self):
+        """An object suitable for indexing a NumPy ndarray."""
+
+        return (self._values_ & self.antimask)
+
+    #===========================================================================
+    def is_numeric(self):
+        """True if this object is numeric; False otherwise.
+
+        This method overrides the default behavior in the base class to return
+        return False. Every other subclass is numeric.
+        """
+
+        return False
+
+    #===========================================================================
+    def sum(self, axis=None, value=True, builtins=None,
+                  recursive=True, out=None):
+        """The sum of the unmasked values along the specified axis.
+
+        Input:
+            axis        an integer axis or a tuple of axes. The sum is
+                        determined across these axes, leaving any remaining axes
+                        in the returned value. If None (the default), then the
+                        sum is performed across all axes if the object.
+            value       value to match.
+            builtins    if True and the result is a single unmasked scalar, the
+                        result is returned as a Python int or float instead of
+                        as an instance of Qube. Default is that specified by
+                        Qube.PREFER_BUILTIN_TYPES.
+            recursive   Ignored for class Boolean.
+            out         Ignored. Enables "np.sum(Qube)" to work.
+        """
+
+        if value:
+            return self.as_int().sum(axis=axis, builtins=builtins)
+        else:
+            return (Scalar.ONE - self.as_int()).sum(axis=axis,
+                                                    builtins=builtins)
+
+    #===========================================================================
+    def identity(self):
+        """An object of this subclass equivalent to the identity."""
+
+        return Boolean(True).as_readonly()
+
+    ############################################################################
+    # Arithmetic operators
+    ############################################################################
+
+    def __pos__(self, recursive=True):
+        return self.as_int()
+
+    def __neg__(self, recursive=True):
+        return -self.as_int()
+
+    def __abs__(self, recursive=True):
+        return self.as_int()
+
+    def __add__(self, arg, recursive=True):
+        return self.as_int() + arg
+
+    def __radd__(self, arg, recursive=True):
+        return self.as_int() + arg
+
+    def __iadd__(self, arg):
+        Qube._raise_unsupported_op('+=', self)
+
+    def __sub__(self, arg, recursive=True):
+        return self.as_int() - arg
+
+    def __rsub__(self, arg, recursive=True):
+        return -self.as_int() + arg
+
+    def __isub__(self, arg):
+        Qube._raise_unsupported_op('-=', self)
+
+    def __mul__(self, arg, recursive=True):
+        return self.as_int() * arg
+
+    def __rmul__(self, arg, recursive=True):
+        return self.as_int() * arg
+
+    def __imul__(self, arg):
+        Qube._raise_unsupported_op('*=', self)
+
+    def __truediv__(self, arg, recursive=True):
+        return self.as_int() / arg
+
+    def __rtruediv__(self, arg, recursive=True):
+        if not isinstance(arg, Qube):
+            arg = Scalar(arg)
+        return arg / self.as_int()
+
+    def __itruediv__(self, arg):
+        Qube._raise_unsupported_op('/=', self)
+
+    def __floordiv__(self, arg):
+        return self.as_int() // arg
+
+    def __rfloordiv__(self, arg):
+        if not isinstance(arg, Qube):
+            arg = Scalar(arg)
+        return arg // self.as_int()
+
+    def __ifloordiv__(self, arg):
+        Qube._raise_unsupported_op('//=', self)
+
+    def __mod__(self, arg):
+        return self.as_int() % arg
+
+    def __rmod__(self, arg):
+        if not isinstance(arg, Qube):
+            arg = Scalar(arg)
+        return arg % self.as_int()
+
+    def __imod__(self, arg):
+        Qube._raise_unsupported_op('%=', self)
+
+    def __pow__(self, arg):
+        return self.as_int()**arg
+
+################################################################################
+# Useful class constants
+################################################################################
+
+Boolean.TRUE = Boolean(True).as_readonly()
+Boolean.FALSE = Boolean(False).as_readonly()
+Boolean.MASKED = Boolean(False,True).as_readonly()
+
+################################################################################
+# Once the load is complete, we can fill in a reference to the Boolean class
+# inside the Qube object.
+################################################################################
+
+Qube.BOOLEAN_CLASS = Boolean
+
+################################################################################

polymath/extensions/__init__.py

@@ -0,0 +1,103 @@
+################################################################################
+# polymath/extensions/__init__.py
+################################################################################
+
+from polymath.qube import Qube
+
+from polymath.extensions import indexer
+Qube.__getitem__        = indexer.__getitem__
+Qube.__setitem__        = indexer.__setitem__
+Qube._prep_index        = indexer._prep_index
+Qube._prep_scalar_index = indexer._prep_scalar_index
+
+from polymath.extensions import item_ops
+Qube.extract_numer      = item_ops.extract_numer
+Qube.extract_denom      = item_ops.extract_denom
+Qube.extract_denoms     = item_ops.extract_denoms
+Qube.slice_numer        = item_ops.slice_numer
+Qube.transpose_numer    = item_ops.transpose_numer
+Qube.reshape_numer      = item_ops.reshape_numer
+Qube.flatten_numer      = item_ops.flatten_numer
+Qube.transpose_denom    = item_ops.transpose_denom
+Qube.reshape_denom      = item_ops.reshape_denom
+Qube.flatten_denom      = item_ops.flatten_denom
+Qube.join_items         = item_ops.join_items
+Qube.split_items        = item_ops.split_items
+Qube.swap_items         = item_ops.swap_items
+Qube.chain              = item_ops.chain
+
+from polymath.extensions import iterator
+Qube.__iter__           = iterator.__iter__
+Qube.ndenumerate        = iterator.ndenumerate
+
+from polymath.extensions import mask_ops
+Qube.mask_where         = mask_ops.mask_where
+Qube.mask_where_eq      = mask_ops.mask_where_eq
+Qube.mask_where_ne      = mask_ops.mask_where_ne
+Qube.mask_where_le      = mask_ops.mask_where_le
+Qube.mask_where_ge      = mask_ops.mask_where_ge
+Qube.mask_where_lt      = mask_ops.mask_where_lt
+Qube.mask_where_gt      = mask_ops.mask_where_gt
+Qube.mask_where_between = mask_ops.mask_where_between
+Qube.mask_where_outside = mask_ops.mask_where_outside
+Qube.clip               = mask_ops.clip
+Qube.is_below           = mask_ops.is_below
+Qube.is_above           = mask_ops.is_above
+Qube.is_outside         = mask_ops.is_outside
+Qube.is_inside          = mask_ops.is_inside
+
+from polymath.extensions import math_ops
+Qube._mean_or_sum       = math_ops._mean_or_sum
+Qube._check_axis        = math_ops._check_axis
+Qube._zero_sized_result = math_ops._zero_sized_result
+Qube.dot                = math_ops.dot
+Qube.norm               = math_ops.norm
+Qube.norm_sq            = math_ops.norm_sq
+Qube.cross              = math_ops.cross
+Qube.outer              = math_ops.outer
+Qube.as_diagonal        = math_ops.as_diagonal
+Qube.rms                = math_ops.rms
+
+from polymath.extensions import pickler
+Qube.pickle             = pickler       # help(Qube.pickle) shows the docstring
+Qube.__getstate__       = pickler.__getstate__
+Qube.__setstate__       = pickler.__setstate__
+Qube._encode_floats     = pickler._encode_floats
+Qube._decode_floats     = pickler._decode_floats
+Qube._encode_ints       = pickler._encode_ints
+Qube._decode_ints       = pickler._decode_ints
+Qube._encode_bools      = pickler._encode_bools
+Qube._decode_bools      = pickler._decode_bools
+Qube.pickle_digits      = pickler.pickle_digits
+Qube.pickle_reference   = pickler.pickle_reference
+Qube.set_pickle_digits         = pickler.set_pickle_digits
+Qube.set_default_pickle_digits = pickler.set_default_pickle_digits
+Qube._check_pickle_digits      = pickler._check_pickle_digits
+Qube._pickle_debug             = pickler._pickle_debug
+
+from polymath.extensions import shaper
+Qube.reshape            = shaper.reshape
+Qube.flatten            = shaper.flatten
+Qube.swap_axes          = shaper.swap_axes
+Qube.roll_axis          = shaper.roll_axis
+Qube.move_axis          = shaper.move_axis
+Qube.stack              = shaper.stack
+
+from polymath.extensions import shrinker
+Qube.shrink             = shrinker.shrink
+Qube.unshrink           = shrinker.unshrink
+
+from polymath.extensions import tvl
+Qube.tvl_and            = tvl.tvl_and
+Qube.tvl_or             = tvl.tvl_or
+Qube.tvl_any            = tvl.tvl_any
+Qube.tvl_all            = tvl.tvl_all
+Qube.tvl_eq             = tvl.tvl_eq
+Qube.tvl_ne             = tvl.tvl_ne
+Qube.tvl_lt             = tvl.tvl_lt
+Qube.tvl_gt             = tvl.tvl_gt
+Qube.tvl_le             = tvl.tvl_le
+Qube.tvl_ge             = tvl.tvl_ge
+Qube._tvl_op            = tvl._tvl_op
+
+################################################################################