voly 0.0.94__py3-none-any.whl → 0.0.96__py3-none-any.whl

voly/formulas.py

@@ -15,72 +15,72 @@ def vectorize_inputs(func):
     """
     Decorator to vectorize Black-Scholes functions to handle both scalar and array inputs.
     """
-    def wrapper(s, k, r, vol, t, option_type='call'):
+    def wrapper(s, K, r, o, t, option_type='call'):
         # Check if inputs are scalar
-        k_scalar = np.isscalar(k)
-        vol_scalar = np.isscalar(vol)
+        K_scalar = np.isscalar(K)
+        o_scalar = np.isscalar(o)
 
         # If both inputs are scalar, use the original function directly
-        if k_scalar and vol_scalar:
-            return func(s, k, r, vol, t, option_type)
+        if K_scalar and o_scalar:
+            return func(s, K, r, o, t, option_type)
 
         # Use NumPy's vectorize to handle array inputs
-        vectorized_func = np.vectorize(lambda k_val, vol_val:
-                                       func(s, k_val, r, vol_val, t, option_type))
+        vectorized_func = np.vectorize(lambda K_val, o_val:
+                                       func(s, K_val, r, o_val, t, option_type))
 
         # Call the vectorized function with the inputs
-        return vectorized_func(k, vol)
+        return vectorized_func(K, o)
 
     return wrapper
 
 
 @catch_exception
 @vectorize_inputs
-def d1(s: float, k: float, r: float, vol: float, t: float, option_type: str = 'call') -> float:
+def d1(s: float, K: float, r: float, o: float, t: float, option_type: str = 'call') -> float:
     # option_type is ignored in this function but included for compatibility
-    if vol <= 0 or t <= 0:
+    if o <= 0 or t <= 0:
         return np.nan
-    return (np.log(s / k) + (r + vol ** 2 / 2) * t) / (vol * np.sqrt(t))
+    return (np.log(s / K) + (r + o ** 2 / 2) * t) / (o * np.sqrt(t))
 
 @catch_exception
 @vectorize_inputs
-def d2(s: float, k: float, r: float, vol: float, t: float, option_type: str = 'call') -> float:
+def d2(s: float, K: float, r: float, o: float, t: float, option_type: str = 'call') -> float:
     # option_type is ignored in this function but included for compatibility
-    if vol <= 0 or t <= 0:
+    if o <= 0 or t <= 0:
         return np.nan
-    return d1(s, k, r, vol, t, option_type) - vol * np.sqrt(t)
+    return d1(s, K, r, o, t, option_type) - o * np.sqrt(t)
 
 
 @catch_exception
 @vectorize_inputs
-def bs(s: float, k: float, r: float, vol: float, t: float, option_type: str = 'call') -> float:
-    if vol <= 0 or t <= 0:
+def bs(s: float, K: float, r: float, o: float, t: float, option_type: str = 'call') -> float:
+    if o <= 0 or t <= 0:
         # Intrinsic value at expiry
         if option_type.lower() in ["call", "c"]:
-            return max(0, s - k)
+            return max(0, s - K)
         else:
-            return max(0, k - s)
+            return max(0, K - s)
 
-    d1_val = d1(s, k, r, vol, t)
-    d2_val = d2(s, k, r, vol, t)
+    d1_val = d1(s, K, r, o, t)
+    d2_val = d2(s, K, r, o, t)
 
     if option_type.lower() in ["call", "c"]:
-        return s * norm.cdf(d1_val) - k * np.exp(-r * t) * norm.cdf(d2_val)
+        return s * norm.cdf(d1_val) - K * np.exp(-r * t) * norm.cdf(d2_val)
     else:  # put
-        return k * np.exp(-r * t) * norm.cdf(-d2_val) - s * norm.cdf(-d1_val)
+        return K * np.exp(-r * t) * norm.cdf(-d2_val) - s * norm.cdf(-d1_val)
 
 
 @catch_exception
 @vectorize_inputs
-def delta(s: float, k: float, r: float, vol: float, t: float, option_type: str = 'call') -> float:
-    if vol <= 0 or t <= 0:
+def delta(s: float, K: float, r: float, o: float, t: float, option_type: str = 'call') -> float:
+    if o <= 0 or t <= 0:
         # At expiry, delta is either 0 or 1 for call, 0 or -1 for put
         if option_type.lower() in ["call", "c"]:
-            return 1.0 if s > k else 0.0
+            return 1.0 if s > K else 0.0
         else:
-            return -1.0 if s < k else 0.0
+            return -1.0 if s < K else 0.0
 
-    d1_val = d1(s, k, r, vol, t)
+    d1_val = d1(s, K, r, o, t)
 
     if option_type.lower() in ["call", "c"]:
         return norm.cdf(d1_val)
@@ -90,41 +90,41 @@ def delta(s: float, k: float, r: float, vol: float, t: float, option_type: str =
 
 @catch_exception
 @vectorize_inputs
-def gamma(s: float, k: float, r: float, vol: float, t: float, option_type: str = 'call') -> float:
-    if vol <= 0 or t <= 0:
+def gamma(s: float, K: float, r: float, o: float, t: float, option_type: str = 'call') -> float:
+    if o <= 0 or t <= 0:
         return 0.0
 
-    d1_val = d1(s, k, r, vol, t, option_type)
-    return norm.pdf(d1_val) / (s * vol * np.sqrt(t))
+    d1_val = d1(s, K, r, o, t, option_type)
+    return norm.pdf(d1_val) / (s * o * np.sqrt(t))
 
 
 @catch_exception
 @vectorize_inputs
-def vega(s: float, k: float, r: float, vol: float, t: float, option_type: str = 'call') -> float:
-    if vol <= 0 or t <= 0:
+def vega(s: float, K: float, r: float, o: float, t: float, option_type: str = 'call') -> float:
+    if o <= 0 or t <= 0:
         return 0.0
 
-    d1_val = d1(s, k, r, vol, t, option_type)
+    d1_val = d1(s, K, r, o, t, option_type)
     return s * norm.pdf(d1_val) * np.sqrt(t) / 100  # Divided by 100 for 1% change
 
 
 @catch_exception
 @vectorize_inputs
-def theta(s: float, k: float, r: float, vol: float, t: float, option_type: str = 'call') -> float:
-    if vol <= 0 or t <= 0:
+def theta(s: float, K: float, r: float, o: float, t: float, option_type: str = 'call') -> float:
+    if o <= 0 or t <= 0:
         return 0.0
 
-    d1_val = d1(s, k, r, vol, t, option_type)
-    d2_val = d2(s, k, r, vol, t, option_type)
+    d1_val = d1(s, K, r, o, t, option_type)
+    d2_val = d2(s, K, r, o, t, option_type)
 
     # First part of theta (same for both call and put)
-    theta_part1 = -s * norm.pdf(d1_val) * vol / (2 * np.sqrt(t))
+    theta_part1 = -s * norm.pdf(d1_val) * o / (2 * np.sqrt(t))
 
     # Second part depends on option type
     if option_type.lower() in ["call", "c"]:
-        theta_part2 = -r * k * np.exp(-r * t) * norm.cdf(d2_val)
+        theta_part2 = -r * K * np.exp(-r * t) * norm.cdf(d2_val)
     else:  # put
-        theta_part2 = r * k * np.exp(-r * t) * norm.cdf(-d2_val)
+        theta_part2 = r * K * np.exp(-r * t) * norm.cdf(-d2_val)
 
     # Return theta per day (t is in years)
     return (theta_part1 + theta_part2) / 365.0
@@ -132,50 +132,50 @@ def theta(s: float, k: float, r: float, vol: float, t: float, option_type: str =
 
 @catch_exception
 @vectorize_inputs
-def rho(s: float, k: float, r: float, vol: float, t: float, option_type: str = 'call') -> float:
-    if vol <= 0 or t <= 0:
+def rho(s: float, K: float, r: float, o: float, t: float, option_type: str = 'call') -> float:
+    if o <= 0 or t <= 0:
         return 0.0
 
-    d2_val = d2(s, k, r, vol, t, option_type)
+    d2_val = d2(s, K, r, o, t, option_type)
 
     if option_type.lower() in ["call", "c"]:
-        return k * t * np.exp(-r * t) * norm.cdf(d2_val) / 100
+        return K * t * np.exp(-r * t) * norm.cdf(d2_val) / 100
     else:  # put
-        return -k * t * np.exp(-r * t) * norm.cdf(-d2_val) / 100
+        return -K * t * np.exp(-r * t) * norm.cdf(-d2_val) / 100
 
 
 @catch_exception
 @vectorize_inputs
-def vanna(s: float, k: float, r: float, vol: float, t: float, option_type: str = 'call') -> float:
-    if vol <= 0 or t <= 0:
+def vanna(s: float, K: float, r: float, o: float, t: float, option_type: str = 'call') -> float:
+    if o <= 0 or t <= 0:
         return 0.0
 
-    d1_val = d1(s, k, r, vol, t, option_type)
-    d2_val = d2(s, k, r, vol, t, option_type)
+    d1_val = d1(s, K, r, o, t, option_type)
+    d2_val = d2(s, K, r, o, t, option_type)
 
-    return -norm.pdf(d1_val) * d2_val / vol
+    return -norm.pdf(d1_val) * d2_val / o
 
 
 @catch_exception
 @vectorize_inputs
-def volga(s: float, k: float, r: float, vol: float, t: float, option_type: str = 'call') -> float:
-    if vol <= 0 or t <= 0:
+def volga(s: float, K: float, r: float, o: float, t: float, option_type: str = 'call') -> float:
+    if o <= 0 or t <= 0:
         return 0.0
 
-    d1_val = d1(s, k, r, vol, t, option_type)
-    d2_val = d2(s, k, r, vol, t, option_type)
+    d1_val = d1(s, K, r, o, t, option_type)
+    d2_val = d2(s, K, r, o, t, option_type)
 
-    return s * norm.pdf(d1_val) * np.sqrt(t) * d1_val * d2_val / vol
+    return s * norm.pdf(d1_val) * np.sqrt(t) * d1_val * d2_val / o
 
 
 @catch_exception
 @vectorize_inputs
-def charm(s: float, k: float, r: float, vol: float, t: float, option_type: str = 'call') -> float:
-    if vol <= 0 or t <= 0:
+def charm(s: float, K: float, r: float, o: float, t: float, option_type: str = 'call') -> float:
+    if o <= 0 or t <= 0:
         return 0.0
 
-    d1_val = d1(s, k, r, vol, t, option_type)
-    d2_val = d2(s, k, r, vol, t, option_type)
+    d1_val = d1(s, K, r, o, t, option_type)
+    d2_val = d2(s, K, r, o, t, option_type)
 
     # First term is the same for calls and puts
     term1 = -norm.pdf(d1_val) * d1_val / (2 * t)
@@ -192,34 +192,34 @@ def charm(s: float, k: float, r: float, vol: float, t: float, option_type: str =
 
 @catch_exception
 @vectorize_inputs
-def greeks(s: float, k: float, r: float, vol: float, t: float,
+def greeks(s: float, K: float, r: float, o: float, t: float,
            option_type: str = 'call') -> Dict[str, float]:
     return {
-        'price': bs(s, k, r, vol, t, option_type),
-        'delta': delta(s, k, r, vol, t, option_type),
-        'gamma': gamma(s, k, r, vol, t, option_type),
-        'vega': vega(s, k, r, vol, t, option_type),
-        'theta': theta(s, k, r, vol, t, option_type),
-        'rho': rho(s, k, r, vol, t, option_type),
-        'vanna': vanna(s, k, r, vol, t, option_type),
-        'volga': volga(s, k, r, vol, t, option_type),
-        'charm': charm(s, k, r, vol, t, option_type)
+        'price': bs(s, K, r, o, t, option_type),
+        'delta': delta(s, K, r, o, t, option_type),
+        'gamma': gamma(s, K, r, o, t, option_type),
+        'vega': vega(s, K, r, o, t, option_type),
+        'theta': theta(s, K, r, o, t, option_type),
+        'rho': rho(s, K, r, o, t, option_type),
+        'vanna': vanna(s, K, r, o, t, option_type),
+        'volga': volga(s, K, r, o, t, option_type),
+        'charm': charm(s, K, r, o, t, option_type)
     }
 
 
 @catch_exception
 @vectorize_inputs
-def iv(option_price: float, s: float, k: float, r: float, t: float,
+def iv(option_price: float, s: float, K: float, r: float, t: float,
        option_type: str = 'call', precision: float = 1e-8,
        max_iterations: int = 100) -> float:
     """
     Calculate implied volatility using Newton-Raphson method.
 
     Parameters:
-    - option_price: Market price of the option
+    - option_price: MarKet price of the option
     - s: Underlying price
-    - k: Strike price
-    - r: Risk-free rate
+    - K: Strike price
+    - r: RisK-free rate
     - t: Time to expiry in years
     - option_type: 'call' or 'put'
     - precision: Desired precision
@@ -233,46 +233,46 @@ def iv(option_price: float, s: float, k: float, r: float, t: float,
 
     # Check if option price is within theoretical bounds
     if option_type.lower() in ["call", "c"]:
-        intrinsic = max(0, s - k * np.exp(-r * t))
+        intrinsic = max(0, s - K * np.exp(-r * t))
         if option_price < intrinsic:
             return np.nan  # Price below intrinsic value
         if option_price >= s:
             return np.inf  # Price exceeds underlying
     else:  # put
-        intrinsic = max(0, k * np.exp(-r * t) - s)
+        intrinsic = max(0, K * np.exp(-r * t) - s)
         if option_price < intrinsic:
             return np.nan  # Price below intrinsic value
-        if option_price >= k:
+        if option_price >= K:
             return np.inf  # Price exceeds strike
 
     # Initial guess - Manaster and Koehler (1982) method
-    vol = np.sqrt(2 * np.pi / t) * option_price / s
+    o = np.sqrt(2 * np.pi / t) * option_price / s
 
     # Ensure initial guess is reasonable
-    vol = max(0.001, min(vol, 5.0))
+    o = max(0.001, min(o, 5.0))
 
     for _ in range(max_iterations):
         # Calculate option price and vega with current volatility
-        price = bs(s, k, r, vol, t, option_type)
-        v = vega(s, k, r, vol, t, option_type)
+        price = bs(s, K, r, o, t, option_type)
+        v = vega(s, K, r, o, t, option_type)
 
         # Calculate price difference
         price_diff = price - option_price
 
         # Check if precision reached
         if abs(price_diff) < precision:
-            return vol
+            return o
 
         # Avoid division by zero
         if abs(v) < 1e-10:
             # Change direction based on whether price is too high or too low
-            vol = vol * 1.5 if price_diff < 0 else vol * 0.5
+            o = o * 1.5 if price_diff < 0 else o * 0.5
         else:
             # Newton-Raphson update
-            vol = vol - price_diff / (v * 100)  # Vega is for 1% change
+            o = o - price_diff / (v * 100)  # Vega is for 1% change
 
         # Ensure volatility stays in reasonable bounds
-        vol = max(0.001, min(vol, 5.0))
+        o = max(0.001, min(o, 5.0))
 
     # If we reach here, we didn't converge
     return np.nan
@@ -286,7 +286,7 @@ def get_domain(domain_params: Tuple[float, float, int] = (-1.5, 1.5, 1000),
                t: float = None,
                return_domain: str = 'log_moneyness') -> np.ndarray:
     """
-    Compute the x-domain for a given return type (log-moneyness, moneyness, strikes, or delta).
+    Compute the x-domain for a given return type (log-moneyness, moneyness, returns, strikes, or delta).
 
     Parameters:
     -----------
@@ -336,7 +336,7 @@ def get_domain(domain_params: Tuple[float, float, int] = (-1.5, 1.5, 1000),
 
     elif return_domain == 'delta':
         # Check for required parameters
-        required_params = {'s': s, 'o': o, 'r': r, 't': t}
+        required_params = {'s': s, 'r': r, 'o': o, 't': t}
         missing_params = [param for param, value in required_params.items() if value is None]
         if missing_params:
             raise ValueError(f"The following parameters are required for return_domain='delta': {missing_params}")
@@ -350,9 +350,9 @@ def get_domain(domain_params: Tuple[float, float, int] = (-1.5, 1.5, 1000),
         K = s / np.exp(LM)
 
         # Compute deltas
-        D = np.array([delta(s, K, r, o, t, 'call') for K, o in zip(K, o)])
+        D = delta(s, K, r, o, t, 'call')
         return D
 
     else:
         raise ValueError(
-            f"Invalid return_domain: {return_domain}. Must be one of ['log_moneyness', 'moneyness', 'returns', 'strikes', 'delta'].")
+            f"Invalid return_domain: {return_domain}. Must be one of ['log_moneyness', 'moneyness', 'returns', 'striKes', 'delta'].")

{voly-0.0.94.dist-info → voly-0.0.96.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: voly
-Version: 0.0.94
+Version: 0.0.96
 Summary: Options & volatility research package
 Author-email: Manu de Cara <manu.de.cara@gmail.com>
 License: MIT

{voly-0.0.94.dist-info → voly-0.0.96.dist-info}/RECORD

@@ -1,7 +1,7 @@
 voly/__init__.py,sha256=8xyDk7rFCn_MOD5hxuv5cxxKZvBVRiSIM7TgaMPpwpw,211
 voly/client.py,sha256=M_XmGQAheVSPOBJPXVYJzm1s8ZOcBZ6keeZhb9Yu0R4,15367
 voly/exceptions.py,sha256=PBsbn1vNMvKcCJwwJ4lBO6glD85jo1h2qiEmD7ArAjs,92
-voly/formulas.py,sha256=DgWw_RYYUcOsiUHrW2h4m0_tgPpGXFYowoFJOwrETIQ,11750
+voly/formulas.py,sha256=6yuu0-vO6TkV7p94W8d_akuC_byySs02-yhy62W8eA4,11575
 voly/models.py,sha256=Vs69QZYQ_Tt6hkaZ6Mfnq3II1dHDqQrZTzBNiaOIbwo,3516
 voly/core/__init__.py,sha256=bu6fS2I1Pj9fPPnl-zY3L7NqrZSY5Zy6NY2uMUvdhKs,183
 voly/core/charts.py,sha256=E21OZB5lTY4YL2flgaFJ6s5g3_ExtAQT2zryZZxLPyM,12735
@@ -11,8 +11,8 @@ voly/core/interpolate.py,sha256=JkK172-FXyhesW3hY4pEeuJWG3Bugq7QZXbeKoRpLuo,5305
 voly/core/rnd.py,sha256=yNkQuiiw--exiJLHa9Wd9zy5sZN5_QJ3itKmr04zg-Q,10047
 voly/utils/__init__.py,sha256=E05mWatyC-PDOsCxQV1p5Xi1IgpOomxrNURyCx_gB-w,200
 voly/utils/logger.py,sha256=4-_2bVJmq17Q0d7Rd2mPg1AeR8gxv6EPvcmBDMFWcSM,1744
-voly-0.0.94.dist-info/LICENSE,sha256=wcHIVbE12jfcBOai_wqBKY6xvNQU5E909xL1zZNq_2Q,1065
-voly-0.0.94.dist-info/METADATA,sha256=yzEyWT7dvnY8qViyVbgNhuhHSL_Z4P_fN0TYFZZPzcc,4092
-voly-0.0.94.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
-voly-0.0.94.dist-info/top_level.txt,sha256=ZfLw2sSxF-LrKAkgGjOmeTcw6_gD-30zvtdEY5W4B7c,5
-voly-0.0.94.dist-info/RECORD,,
+voly-0.0.96.dist-info/LICENSE,sha256=wcHIVbE12jfcBOai_wqBKY6xvNQU5E909xL1zZNq_2Q,1065
+voly-0.0.96.dist-info/METADATA,sha256=235T9rVu_SsCzwKU9dK1ZEwdBI_4-ztB5akF-A-tS7E,4092
+voly-0.0.96.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
+voly-0.0.96.dist-info/top_level.txt,sha256=ZfLw2sSxF-LrKAkgGjOmeTcw6_gD-30zvtdEY5W4B7c,5
+voly-0.0.96.dist-info/RECORD,,