Luminosity and stellar mass functions
=====================================

The **stellar mass function (SMF)** estimators are production-ready and
validated.  The **luminosity function (LF)** estimators share the same
underlying code but have not yet been validated against reference datasets;
they are marked as development below.

Stable: SMF estimators
-----------------------

1/Vmax (SMF)
~~~~~~~~~~~~

.. note::

   The 1/Vmax module contains both SMF and LF functions.  Only the SMF
   functions (:func:`~sum_stat.stellar_mass_function_vmax`) are stable.
   LF functions in this module are in development.

.. automodule:: sum_stat.lf_smf.vmax
   :members:

SWML (SMF)
~~~~~~~~~~

.. note::

   The SWML module contains both SMF and LF functions.  Only the SMF
   functions (:func:`~sum_stat.lf_smf.swml.stellar_mass_function_swml`)
   are stable.  LF functions in this module are in development.

.. automodule:: sum_stat.lf_smf.swml
   :members:

C⁻ cumulative (SMF)
~~~~~~~~~~~~~~~~~~~~

.. note::

   The C⁻ module contains both SMF and LF functions.  Only the SMF
   function (:func:`~sum_stat.lf_smf.cminus.cumulative_stellar_mass_function_cminus`)
   is stable.  LF functions in this module are in development.

.. automodule:: sum_stat.lf_smf.cminus
   :members:

Completeness scan
~~~~~~~~~~~~~~~~~

.. automodule:: sum_stat.lf_smf.completeness_scan
   :members:

Statistical independence tests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: sum_stat.lf_smf.independence
   :members:

.. note::

   The **luminosity function (LF)** counterparts of the estimators above
   (``luminosity_function_vmax``, ``luminosity_function_swml``,
   ``cumulative_luminosity_function_cminus``) share the same modules but are
   **in active development** — validation against COSMOS and GAMA is not yet
   complete.  See :doc:`../development_estimators` for the full status.

Deprecated: Schechter model functions
--------------------------------------

.. deprecated:: 0.1

   The modules below are deprecated and will be removed in a future release.
   Schechter model evaluation functions and reference data have moved to the
   **gga_model** package.

.. automodule:: sum_stat.lf_smf.zalesky25
   :members:

.. automodule:: sum_stat.lf_smf.ilbert2013
   :members: