wavepacket.typing
=================

.. py:module:: wavepacket.typing

.. autoapi-nested-parse::

   
   Several aliases and definitions for type checking.
















   ..
       !! processed by numpydoc !!


Attributes
----------

.. autoapisummary::

   wavepacket.typing.ComplexData
   wavepacket.typing.RealData
   wavepacket.typing.Generator
   wavepacket.typing.RealGenerator


Package Contents
----------------

.. py:type:: ComplexData
   :canonical: npt.NDArray[np.float64] | npt.NDArray[np.complex128]


   
   Type for complex-valued input or output data.

   Note that all client places should be able to consume real-valued data as well.















   ..
       !! processed by numpydoc !!

.. py:type:: RealData
   :canonical: npt.NDArray[np.float64]


   
   Type for real-valued input or output data.
















   ..
       !! processed by numpydoc !!

.. py:type:: Generator
   :canonical: Callable[[RealData], ComplexData]


   
   A callable that transforms an real-valued input into complex-valued output.

   Typical applications are transformations from grids or a time series, for
   example for creating initial wave functions or potentials.















   ..
       !! processed by numpydoc !!

.. py:type:: RealGenerator
   :canonical: Callable[[RealData], RealData]


   
   Similar to `Generator`, but outputs real-value data.

   This is meant for cases where we deliberately want to constrain
   the values.















   ..
       !! processed by numpydoc !!