Source code for naginterfaces.library.math

# -*- coding: utf-8 -*-
r"""
Module Summary
--------------
Interfaces for the NAG Mark 30.3 `math` Chapter.

``math`` - Mathematical Constants

This module is concerned with the provision of mathematical constants required by other functions within the NAG Library.

Functionality Index
-------------------

:math:`\pi`: :meth:`pi`

Euler's constant, :math:`\gamma`: :meth:`euler`

For full information please refer to the NAG Library document

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/x01/x01intro.html
"""

# NAG Copyright 2017-2024.


[docs]def pi():
    r"""
    ``pi`` returns the numerical value of :math:`\pi`.

    .. _x01aa-py2-py-doc:

    For full information please refer to the NAG Library document for x01aa

    https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/x01/x01aaf.html

    **Returns**
        **pi_nag** : float
            The numerical value of :math:`\pi`.
    """
    raise NotImplementedError



[docs]def euler():
    r"""
    ``euler`` returns the numerical value of :math:`\gamma` (Euler's constant).

    .. _x01ab-py2-py-doc:

    For full information please refer to the NAG Library document for x01ab

    https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/x01/x01abf.html

    **Returns**
        **euler** : float
            The numerical value of :math:`\gamma` (Euler's constant).
    """
    raise NotImplementedError