aerosandbox.numpy.spacing
=========================

.. py:module:: aerosandbox.numpy.spacing


Functions
---------

.. autoapisummary::

   aerosandbox.numpy.spacing.linspace
   aerosandbox.numpy.spacing.cosspace
   aerosandbox.numpy.spacing.sinspace
   aerosandbox.numpy.spacing.logspace
   aerosandbox.numpy.spacing.geomspace


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

.. py:function:: linspace(start = 0.0, stop = 1.0, num = 50)

   Returns evenly spaced numbers over a specified interval.

   See syntax here: https://numpy.org/doc/stable/reference/generated/numpy.linspace.html


.. py:function:: cosspace(start = 0.0, stop = 1.0, num = 50)

   Makes a cosine-spaced vector.

   Cosine spacing is useful because these correspond to Chebyshev nodes: https://en.wikipedia.org/wiki/Chebyshev_nodes

   To learn more about cosine spacing, see this: https://youtu.be/VSvsVgGbN7I

   :param start: Value to start at.
   :param end: Value to end at.
   :param num: Number of points in the vector.


.. py:function:: sinspace(start = 0.0, stop = 1.0, num = 50, reverse_spacing = False)

   Makes a sine-spaced vector. By default, bunches points near the start.

   Sine spacing is exactly identical to half of a cosine-spaced distrubution, in terms of relative separations.

   To learn more about sine spacing and cosine spacing, see this: https://youtu.be/VSvsVgGbN7I

   :param start: Value to start at.
   :param end: Value to end at.
   :param num: Number of points in the vector.
   :param reverse_spacing: Does negative-sine spacing. In other words, if this is True, the points will be bunched near
   :param the `stop` rather than at the `start`.:

   Points are bunched up near the `start` of the interval by default. To reverse this, use the `reverse_spacing`
   parameter.


.. py:function:: logspace(start = 0.0, stop = 1.0, num = 50)

   Return numbers spaced evenly on a log scale.

   See syntax here: https://numpy.org/doc/stable/reference/generated/numpy.logspace.html


.. py:function:: geomspace(start = 1.0, stop = 10.0, num = 50)

   Return numbers spaced evenly on a log scale (a geometric progression).

   This is similar to logspace, but with endpoints specified directly.

   See syntax here: https://numpy.org/doc/stable/reference/generated/numpy.geomspace.html