freealg 0.7.17__py3-none-any.whl → 0.7.18__py3-none-any.whl

freealg/distributions/_meixner.py

@@ -12,15 +12,9 @@
 # =======
 
 import numpy
-from scipy.interpolate import interp1d
-from .._free_form._plot_util import plot_density, plot_hilbert, \
-    plot_stieltjes, plot_stieltjes_on_disk, plot_samples
-
-try:
-    from scipy.integrate import cumtrapz
-except ImportError:
-    from scipy.integrate import cumulative_trapezoid as cumtrapz
-from scipy.stats import qmc
+from ..visualization._plot_util import plot_density, plot_hilbert, \
+    plot_stieltjes, plot_stieltjes_on_disk
+from ._base_distribution import BaseDistribution
 
 __all__ = ['Meixner']
 
@@ -29,7 +23,7 @@ __all__ = ['Meixner']
 # Meixner
 # =======
 
-class Meixner(object):
+class Meixner(BaseDistribution):
     """
     Meixner distribution.
 
@@ -461,126 +455,6 @@ class Meixner(object):
 
         return m1, m2
 
-    # ======
-    # sample
-    # ======
-
-    def sample(self, size, x_min=None, x_max=None, method='qmc', seed=None,
-               plot=False, latex=False, save=False):
-        """
-        Sample from distribution.
-
-        Parameters
-        ----------
-
-        size : int
-            Size of sample.
-
-        x_min : float, default=None
-            Minimum of sample values. If `None`, the left edge of the support
-            is used.
-
-        x_max : float, default=None
-            Maximum of sample values. If `None`, the right edge of the support
-            is used.
-
-        method : {``'mc'``, ``'qmc'``}, default= ``'qmc'``
-            Method of drawing samples from uniform distribution:
-
-            * ``'mc'``: Monte Carlo
-            * ``'qmc'``: Quasi Monte Carlo
-
-        seed : int, default=None,
-            Seed for random number generator.
-
-        plot : bool, default=False
-            If `True`, samples histogram is plotted.
-
-        latex : bool, default=False
-            If `True`, the plot is rendered using LaTeX. This option is
-            relevant only if ``plot=True``.
-
-        save : bool, default=False
-            If not `False`, the plot is saved. If a string is given, it is
-            assumed to the save filename (with the file extension). This option
-            is relevant only if ``plot=True``.
-
-        Returns
-        -------
-
-        s : numpy.ndarray
-            Samples.
-
-        Notes
-        -----
-
-        This method uses inverse transform sampling.
-
-        Examples
-        --------
-
-        .. code-block::python
-
-            >>> from freealg.distributions import Meixner
-            >>> mx = Meixner(2, 3)
-            >>> s = mx.sample(2000)
-
-        .. image:: ../_static/images/plots/mx_samples.png
-            :align: center
-            :class: custom-dark
-        """
-
-        if x_min is None:
-            x_min = self.lam_m
-
-        if x_max is None:
-            x_max = self.lam_p
-
-        # Grid and PDF
-        xs = numpy.linspace(x_min, x_max, size)
-        pdf = self.density(xs)
-
-        # CDF (using cumulative trapezoidal rule)
-        cdf = cumtrapz(pdf, xs, initial=0)
-        cdf /= cdf[-1]  # normalize CDF to 1
-
-        # Inverse CDF interpolator
-        inv_cdf = interp1d(cdf, xs, bounds_error=False,
-                           fill_value=(x_min, x_max))
-
-        # Random generator
-        rng = numpy.random.default_rng(seed)
-
-        # Draw from uniform distribution
-        if method == 'mc':
-            u = rng.random(size)
-
-        elif method == 'qmc':
-            try:
-                engine = qmc.Halton(d=1, scramble=True, rng=rng)
-            except TypeError:
-                # Older scipy versions
-                engine = qmc.Halton(d=1, scramble=True, seed=rng)
-            u = engine.random(size).ravel()
-
-        else:
-            raise NotImplementedError('"method" is invalid.')
-
-        # Draw from distribution by mapping from inverse CDF
-        samples = inv_cdf(u).ravel()
-
-        if plot:
-            radius = 0.5 * (self.lam_p - self.lam_m)
-            center = 0.5 * (self.lam_p + self.lam_m)
-            scale = 1.25
-            x_min = numpy.floor(center - radius * scale)
-            x_max = numpy.ceil(center + radius * scale)
-            x = numpy.linspace(x_min, x_max, 500)
-            rho = self.density(x)
-            plot_samples(x, rho, x_min, x_max, samples, latex=latex, save=save)
-
-        return samples
-
     # ======
     # matrix
     # ======

freealg/distributions/_wachter.py

@@ -12,15 +12,9 @@
 # =======
 
 import numpy
-from scipy.interpolate import interp1d
-from .._free_form._plot_util import plot_density, plot_hilbert, \
-    plot_stieltjes, plot_stieltjes_on_disk, plot_samples
-
-try:
-    from scipy.integrate import cumtrapz
-except ImportError:
-    from scipy.integrate import cumulative_trapezoid as cumtrapz
-from scipy.stats import qmc
+from ..visualization._plot_util import plot_density, plot_hilbert, \
+    plot_stieltjes, plot_stieltjes_on_disk
+from ._base_distribution import BaseDistribution
 
 __all__ = ['Wachter']
 
@@ -29,7 +23,7 @@ __all__ = ['Wachter']
 # Wachter
 # =======
 
-class Wachter(object):
+class Wachter(BaseDistribution):
     """
     Wachter distribution.
 
@@ -440,126 +434,6 @@ class Wachter(object):
 
         return m1, m2
 
-    # ======
-    # sample
-    # ======
-
-    def sample(self, size, x_min=None, x_max=None, method='qmc', seed=None,
-               plot=False, latex=False, save=False):
-        """
-        Sample from distribution.
-
-        Parameters
-        ----------
-
-        size : int
-            Size of sample.
-
-        x_min : float, default=None
-            Minimum of sample values. If `None`, the left edge of the support
-            is used.
-
-        x_max : float, default=None
-            Maximum of sample values. If `None`, the right edge of the support
-            is used.
-
-        method : {``'mc'``, ``'qmc'``}, default= ``'qmc'``
-            Method of drawing samples from uniform distribution:
-
-            * ``'mc'``: Monte Carlo
-            * ``'qmc'``: Quasi Monte Carlo
-
-        seed : int, default=None,
-            Seed for random number generator.
-
-        plot : bool, default=False
-            If `True`, samples histogram is plotted.
-
-        latex : bool, default=False
-            If `True`, the plot is rendered using LaTeX. This option is
-            relevant only if ``plot=True``.
-
-        save : bool, default=False
-            If not `False`, the plot is saved. If a string is given, it is
-            assumed to the save filename (with the file extension). This option
-            is relevant only if ``plot=True``.
-
-        Returns
-        -------
-
-        s : numpy.ndarray
-            Samples.
-
-        Notes
-        -----
-
-        This method uses inverse transform sampling.
-
-        Examples
-        --------
-
-        .. code-block::python
-
-            >>> from freealg.distributions import Wachter
-            >>> wa = Wachter(2, 3)
-            >>> s = wa.sample(2000)
-
-        .. image:: ../_static/images/plots/wa_samples.png
-            :align: center
-            :class: custom-dark
-        """
-
-        if x_min is None:
-            x_min = self.lam_m
-
-        if x_max is None:
-            x_max = self.lam_p
-
-        # Grid and PDF
-        xs = numpy.linspace(x_min, x_max, size)
-        pdf = self.density(xs)
-
-        # CDF (using cumulative trapezoidal rule)
-        cdf = cumtrapz(pdf, xs, initial=0)
-        cdf /= cdf[-1]  # normalize CDF to 1
-
-        # Inverse CDF interpolator
-        inv_cdf = interp1d(cdf, xs, bounds_error=False,
-                           fill_value=(x_min, x_max))
-
-        # Random generator
-        rng = numpy.random.default_rng(seed)
-
-        # Draw from uniform distribution
-        if method == 'mc':
-            u = rng.random(size)
-
-        elif method == 'qmc':
-            try:
-                engine = qmc.Halton(d=1, scramble=True, rng=rng)
-            except TypeError:
-                # Older scipy versions
-                engine = qmc.Halton(d=1, scramble=True, seed=rng)
-            u = engine.random(size).ravel()
-
-        else:
-            raise NotImplementedError('"method" is invalid.')
-
-        # Draw from distribution by mapping from inverse CDF
-        samples = inv_cdf(u).ravel()
-
-        if plot:
-            radius = 0.5 * (self.lam_p - self.lam_m)
-            center = 0.5 * (self.lam_p + self.lam_m)
-            scale = 1.25
-            x_min = numpy.floor(center - radius * scale)
-            x_max = numpy.ceil(center + radius * scale)
-            x = numpy.linspace(x_min, x_max, 500)
-            rho = self.density(x)
-            plot_samples(x, rho, x_min, x_max, samples, latex=latex, save=save)
-
-        return samples
-
     # ======
     # matrix
     # ======

freealg/distributions/_wigner.py

@@ -12,15 +12,9 @@
 # =======
 
 import numpy
-from scipy.interpolate import interp1d
-from .._free_form._plot_util import plot_density, plot_hilbert, \
-    plot_stieltjes, plot_stieltjes_on_disk, plot_samples
-
-try:
-    from scipy.integrate import cumtrapz
-except ImportError:
-    from scipy.integrate import cumulative_trapezoid as cumtrapz
-from scipy.stats import qmc
+from ..visualization._plot_util import plot_density, plot_hilbert, \
+    plot_stieltjes, plot_stieltjes_on_disk
+from ._base_distribution import BaseDistribution
 
 __all__ = ['Wigner']
 
@@ -29,10 +23,16 @@ __all__ = ['Wigner']
 # Wigner
 # ======
 
-class Wigner(object):
+class Wigner(BaseDistribution):
     """
     Wigner semicircle distribution.
 
+    Parameters
+    ----------
+
+    r : float
+        Parameter :math:`r` of the distribution. See Notes.
+
     Methods
     -------
 
@@ -420,123 +420,6 @@ class Wigner(object):
 
         return m1, m2
 
-    # ======
-    # sample
-    # ======
-
-    def sample(self, size, x_min=None, x_max=None, method='qmc', seed=None,
-               plot=False, latex=False, save=False):
-        """
-        Sample from distribution.
-
-        Parameters
-        ----------
-
-        size : int
-            Size of sample.
-
-        x_min : float, default=None
-            Minimum of sample values. If `None`, the left edge of the support
-            is used.
-
-        x_max : float, default=None
-            Maximum of sample values. If `None`, the right edge of the support
-            is used.
-
-        method : {``'mc'``, ``'qmc'``}, default= ``'qmc'``
-            Method of drawing samples from uniform distribution:
-
-            * ``'mc'``: Monte Carlo
-            * ``'qmc'``: Quasi Monte Carlo
-
-        plot : bool, default=False
-            If `True`, samples histogram is plotted.
-
-        latex : bool, default=False
-            If `True`, the plot is rendered using LaTeX. This option is
-            relevant only if ``plot=True``.
-
-        save : bool, default=False
-            If not `False`, the plot is saved. If a string is given, it is
-            assumed to the save filename (with the file extension). This option
-            is relevant only if ``plot=True``.
-
-        Returns
-        -------
-
-        s : numpy.ndarray
-            Samples.
-
-        Notes
-        -----
-
-        This method uses inverse transform sampling.
-
-        Examples
-        --------
-
-        .. code-block::python
-
-            >>> from freealg.distributions import Wigner
-            >>> wg = Wigner(1)
-            >>> s = wg.sample(2000)
-
-        .. image:: ../_static/images/plots/wg_samples.png
-            :align: center
-            :class: custom-dark
-        """
-
-        if x_min is None:
-            x_min = self.lam_m
-
-        if x_max is None:
-            x_max = self.lam_p
-
-        # Grid and PDF
-        xs = numpy.linspace(x_min, x_max, size)
-        pdf = self.density(xs)
-
-        # CDF (using cumulative trapezoidal rule)
-        cdf = cumtrapz(pdf, xs, initial=0)
-        cdf /= cdf[-1]  # normalize CDF to 1
-
-        # Inverse CDF interpolator
-        inv_cdf = interp1d(cdf, xs, bounds_error=False,
-                           fill_value=(x_min, x_max))
-
-        # Random generator
-        rng = numpy.random.default_rng(seed)
-
-        # Draw from uniform distribution
-        if method == 'mc':
-            u = rng.random(size)
-
-        elif method == 'qmc':
-            try:
-                engine = qmc.Halton(d=1, scramble=True, rng=rng)
-            except TypeError:
-                # Older scipy versions
-                engine = qmc.Halton(d=1, scramble=True, seed=rng)
-            u = engine.random(size).ravel()
-
-        else:
-            raise NotImplementedError('"method" is invalid.')
-
-        # Draw from distribution by mapping from inverse CDF
-        samples = inv_cdf(u).ravel()
-
-        if plot:
-            radius = 0.5 * (self.lam_p - self.lam_m)
-            center = 0.5 * (self.lam_p + self.lam_m)
-            scale = 1.25
-            x_min = numpy.floor(center - radius * scale)
-            x_max = numpy.ceil(center + radius * scale)
-            x = numpy.linspace(x_min, x_max, 500)
-            rho = self.density(x)
-            plot_samples(x, rho, x_min, x_max, samples, latex=latex, save=save)
-
-        return samples
-
     # ======
     # matrix
     # ======

freealg/visualization/__init__.py

@@ -6,7 +6,7 @@
 # under the terms of the license found in the LICENSE.txt file in the root
 # directory of this source tree.
 
-from ._rgb_hsv import rgb_hsv
+from ._domain_coloring import domain_coloring
 from ._glue_util import glue_branches
 
-__all__ = ['rgb_hsv', 'glue_branches']
+__all__ = ['domain_coloring', 'glue_branches']

freealg/visualization/{_rgb_hsv.py → _domain_coloring.py}

@@ -14,54 +14,62 @@
 import numpy
 import matplotlib
 
-__all__ = ['rgb_hsv']
+__all__ = ['domain_coloring']
 
 
-# =======
-# rgb hsv
-# =======
+# ===============
+# domain coloring
+# ===============
 
-def rgb_hsv(c, shift=0.0, thresh=numpy.inf, n_mod=12.0, n_ph=12.0, vmin=0.35,
-            vmax=1.0, tile_gamma=1.0, tile_mix=1.0):
+def domain_coloring(c, shift=0.0, thresh=numpy.inf, n_mod=12.0, n_ph=12.0,
+                    vmin=0.35, vmax=1.0, tile_gamma=1.0, tile_mix=0.0):
     """
     Convert complex field c to RGB via HSV domain coloring.
 
     Parameters
     ----------
+
     c : array_like of complex
         Complex field.
 
-    shift : float, default 0.0
-        Phase offset in turns (1.0 = full 2*pi rotation). Applied to hue.
+    shift : float, default=0.0
+        Phase offset in turns (1.0 = full :math:`2 \\pi` rotation). Applied to
+        hue.
 
-    thresh : float, default numpy.inf
-        Optional cap on |c| used for magnitude-related terms. Use to prevent
-        very large magnitudes from dominating the encoding.
+    thresh : float, default=numpy.inf
+        Optional cap on :math:`\\vert c \\vert` used for magnitude-related
+        terms. Use to prevent very large magnitudes from dominating the
+        encoding.
 
-    n_mod : float, default 12.0
-        Number of modulus steps per 2*pi in log(|c|). Higher -> more concentric
-        rings. Set to 0.0 to disable modulus stepping.
+    n_mod : float, default=12.0
+        Number of modulus steps per :math:`2 \\pi` in
+        :math:`\\log(\\vert c \\vert`). Higher means more concentric rings. Set
+        to 0.0 to disable modulus stepping.
 
-    n_ph : float, default 12.0
-        Number of phase steps per 2*pi in arg(c). Higher -> more angular
-        sectors. Set to 0.0 to disable phase stepping.
+    n_ph : float, default=12.0
+        Number of phase steps per :math:`2 \\pi` in :math:`\\mathrm{arg}(c)`.
+        Higher means more angular sectors. Set to 0.0 to disable phase
+        stepping.
 
-    vmin : float, default 0.35
+    vmin : float, default=0.35
         Minimum brightness for the tiling shading (darkest parts of tiles).
 
-    vmax : float, default 1.0
+    vmax : float, default=1.0
         Maximum brightness for the tiling shading (brightest parts of tiles).
         Lowering vmax (e.g. 0.8-0.9) can reduce the "neon" look.
 
-    tile_gamma : float, default 1.0
-        Shapes the within-tile ramp. 1.0 = linear sawtooth. >1.0 makes tiles
-        stay darker longer and brighten sharply near boundaries. <1.0 brightens
-        earlier.
+    tile_gamma : float, default=1.0
+        Shapes the within-tile ramp. 1.0 = linear sawtooth. Larger than 1.0
+        makes tiles stay darker longer and brighten sharply near boundaries.
+        Smaller than  1.0 brightens earlier.
 
-    tile_mix : float in [0, 1], default 1.0
+    tile_mix : float in [0, 1], default=0.0
         Mix between original magnitude brightness and tiling shading:
-          0.0 -> value = 1 - exp(-|c|) (your original, no tiling influence)
-          1.0 -> value = tiling shading only (Wegert-style tiling look)
+
+        * 0.0:  value is :math:`1 - \\exp(- \\vert c \\vert)` (original
+          coloring, no tiling influence)
+        * 1.0:  value is tiling shading only (Wegert-style tiling look)
+
         Intermediate values overlay tiling onto the original magnitude shading.
 
     Notes
@@ -72,9 +80,9 @@ def rgb_hsv(c, shift=0.0, thresh=numpy.inf, n_mod=12.0, n_ph=12.0, vmin=0.35,
     References
     ----------
 
-    [1] Wegert, E. (2015) "Visual Complex Functions: An Introduction +with
-        Phase Portraits", Springer.
-        doi: https://doi.org/10.1007/978-3-0348-0180-5
+    .. [1] Wegert, E. (2015) "Visual Complex Functions: An Introduction +with
+           Phase Portraits", Springer.
+           doi: https://doi.org/10.1007/978-3-0348-0180-5
     """
 
     hue = (numpy.angle(c) + numpy.pi) / (2.0 * numpy.pi)