Source code for py_vollib.black.greeks.numerical

# -*- coding: utf-8 -*-

"""
py_vollib.black.greeks.numerical
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A library for option pricing, implied volatility, and
greek calculation.  py_vollib is based on lets_be_rational,
a Python wrapper for LetsBeRational by Peter Jaeckel as
described below.

:copyright: © 2023 Larry Richards
:license: MIT, see LICENSE for more details.

About LetsBeRational:
~~~~~~~~~~~~~~~~~~~~~

The source code of LetsBeRational resides at www.jaeckel.org/LetsBeRational.7z .

::

    ========================================================================================
    Copyright © 2013-2014 Peter Jäckel.

    Permission to use, copy, modify, and distribute this software is freely granted,
    provided that this notice is preserved.

    WARRANTY DISCLAIMER
    The Software is provided "as is" without warranty of any kind, either express or implied,
    including without limitation any implied warranties of condition, uninterrupted use,
    merchantability, fitness for a particular purpose, or non-infringement.
    ========================================================================================


"""


# -----------------------------------------------------------------------------
# IMPORTS

# Standard library imports

# Related third party imports

# Local application/library specific imports
from py_vollib.black import black
from py_vollib.helpers.numerical_greeks import delta as numerical_delta
from py_vollib.helpers.numerical_greeks import vega as numerical_vega
from py_vollib.helpers.numerical_greeks import theta as numerical_theta
from py_vollib.helpers.numerical_greeks import rho as numerical_rho
from py_vollib.helpers.numerical_greeks import gamma as numerical_gamma
from py_vollib.black.greeks.analytical import gamma as agamma
from py_vollib.black.greeks.analytical import delta as adelta
from py_vollib.black.greeks.analytical import vega as avega
from py_vollib.black.greeks.analytical import rho as arho
from py_vollib.black.greeks.analytical import theta as atheta


f = lambda flag, F, K, t, r, sigma, b: black(flag, F, K, t, r, sigma)# sphinx-doc-exclude


[docs]def delta(flag, F, K, t, r, sigma): """Returns the Black delta of an option. :param flag: 'c' or 'p' for call or put. :type flag: str :param F: underlying futures price :type F: float :param K: strike price :type K: float :param t: time to expiration in years :type t: float :param r: annual risk-free interest rate :type r: float :param sigma: volatility :type sigma: float :returns: float """ b = 0 return numerical_delta(flag, F, K, t, r, sigma, b, f)
[docs]def theta(flag, F, K, t, r, sigma): """Returns the Black theta of an option. :param flag: 'c' or 'p' for call or put. :type flag: str :param F: underlying futures price :type F: float :param K: strike price :type K: float :param t: time to expiration in years :type t: float :param r: annual risk-free interest rate :type r: float :param sigma: volatility :type sigma: float :returns: float """ b = 0 return numerical_theta(flag, F, K, t, r, sigma, b, f)
[docs]def vega(flag, F, K, t, r, sigma): """Returns the Black vega of an option. :param flag: 'c' or 'p' for call or put. :type flag: str :param F: underlying futures price :type F: float :param K: strike price :type K: float :param t: time to expiration in years :type t: float :param r: annual risk-free interest rate :type r: float :param sigma: volatility :type sigma: float :returns: float """ b = 0 return numerical_vega(flag, F, K, t, r, sigma, b, f)
[docs]def rho(flag, F, K, t, r, sigma): """Returns the Black rho of an option. :param flag: 'c' or 'p' for call or put. :type flag: str :param F: underlying futures price :type F: float :param K: strike price :type K: float :param t: time to expiration in years :type t: float :param r: annual risk-free interest rate :type r: float :param sigma: volatility :type sigma: float :returns: float """ b = 0 return numerical_rho(flag, F, K, t, r, sigma, b, f)
[docs]def gamma(flag, F, K, t, r, sigma): """Returns the Black gamma of an option. :param flag: 'c' or 'p' for call or put. :type flag: str :param F: underlying futures price :type F: float :param K: strike price :type K: float :param t: time to expiration in years :type t: float :param r: annual risk-free interest rate :type r: float :param sigma: volatility :type sigma: float :returns: float """ b = 0 return numerical_gamma(flag, F, K, t, r, sigma, b, f)
[docs]def test(): '''Tests by comparing the analytical and numerical greek values. >>> S = 49 >>> K = 50 >>> r = .05 >>> t = 0.3846 >>> sigma = 0.2 >>> flag = 'c' >>> epsilon = .0001 >>> v1 = delta(flag, S, K, t, r, sigma) >>> v2 = adelta(flag, S, K, t, r, sigma) >>> abs(v1-v2)<epsilon True >>> v1 = gamma(flag, S, K, t, r, sigma) >>> v2 = agamma(flag, S, K, t, r, sigma) >>> abs(v1-v2)<epsilon True >>> v1 = rho(flag, S, K, t, r, sigma) >>> v2 = arho(flag, S, K, t, r, sigma) >>> abs(v1-v2)<epsilon True >>> v1 = vega(flag, S, K, t, r, sigma) >>> v2 = avega(flag, S, K, t, r, sigma) >>> abs(v1-v2)<epsilon True >>> v1 = theta(flag, S, K, t, r, sigma) >>> v2 = atheta(flag, S, K, t, r, sigma) >>> abs(v1-v2)<epsilon True Test PUT flag >>> flag = 'p' >>> v1 = delta(flag, S, K, t, r, sigma) >>> v2 = adelta(flag, S, K, t, r, sigma) >>> abs(v1-v2)<epsilon True >>> v1 = gamma(flag, S, K, t, r, sigma) >>> v2 = agamma(flag, S, K, t, r, sigma) >>> abs(v1-v2)<epsilon True >>> v1 = rho(flag, S, K, t, r, sigma) >>> v2 = arho(flag, S, K, t, r, sigma) >>> abs(v1-v2)<epsilon True >>> v1 = vega(flag, S, K, t, r, sigma) >>> v2 = avega(flag, S, K, t, r, sigma) >>> abs(v1-v2)<epsilon True >>> v1 = theta(flag, S, K, t, r, sigma) >>> v2 = atheta(flag, S, K, t, r, sigma) >>> abs(v1-v2)<epsilon True ''' pass
if __name__ == "__main__": from py_vollib.helpers.doctest_helper import run_doctest run_doctest()