@sheetxl/formulas-extended 0.8.0-beta.1 → 0.8.0-beta.11

package/types/src/financial/ODD.d.ts

@@ -1,106 +0,0 @@
-/**
- * Odd first and last coupon bond price/yield functions.
- *
- * "Odd" means the first or last coupon period is irregular — shorter or longer
- * than a standard coupon period.  This happens when a bond is issued between
- * coupon dates (odd first) or the final coupon date doesn't align with
- * maturity (odd last).
- *
- * Why ODDLPRICE lives here and not in financialHelpers:
- * The odd-last formula uses a different internal structure (_getCoupDate,
- * _getFrac) that is not shared by any other function.  Keeping it here avoids
- * polluting the shared helper module with single-use private math.
- *
- * Date ordering requirements:
- *   ODDFPRICE/ODDFYIELD: issue < settlement < firstCoupon < maturity
- *   ODDLPRICE/ODDLYIELD: lastInterest < settlement < maturity
- */
-/**
- * @summary Returns the price per $100 face value of a security with an odd first period.
- * @param settlement is the security's settlement date, expressed as a serial date number.
- * @param maturity is the security's maturity date, expressed as a serial date number.
- * @param issue is the security's issue date, expressed as a serial date number.
- * @param firstCoupon is the security's first coupon date, expressed as a serial date number.
- * @param yld is the security's annual yield.
- * @param redemption is the security's redemption value per $100 face value.
- * @param frequency is the number of coupon payments per year.
- * @param basis is the type of day count basis to use.
- *
- * @remarks
- * The first coupon period is "odd" (shorter or longer than normal) when the
- * bond is issued between standard coupon dates.
- */
-export declare function ODDFPRICE(settlement: number, // date
-maturity: number, // date
-issue: number, // date
-firstCoupon: number, // date
-rate: number, yld: number, redemption: number, frequency: number, basis?: number): number;
-/**
- * @summary Returns the yield of a security with an odd first period.
- * @param settlement is the security's settlement date, expressed as a serial date number.
- * @param maturity is the security's maturity date, expressed as a serial date number.
- * @param issue is the security's issue date, expressed as a serial date number.
- * @param firstCoupon is the security's first coupon date, expressed as a serial date number.
- * @param rate is the security's interest rate.
- * @param pr is the security's price.
- * @param redemption is the security's redemption value per $100 face value.
- * @param frequency is the number of coupon payments per year.
- * @param basis is the type of day count basis to use.
- *
- * @remarks
- * Numerically inverts ODDFPRICE via Newton-Raphson.  The initial guess uses
- * the same heuristic as Excel: a linear approximation of yield from the
- * price/day-count relationship.
- */
-export declare function ODDFYIELD(settlement: number, // date
-maturity: number, // date
-issue: number, // date
-firstCoupon: number, // date
-rate: number, pr: number, redemption: number, frequency: number, basis?: number): number;
-/**
- * @summary Returns the price per $100 face value of a security with an odd last period.
- * @param settlement is the security's settlement date, expressed as a serial date number.
- * @param maturity is the security's maturity date, expressed as a serial date number.
- * @param lastInterest is the security's last coupon date, expressed as a serial date number.
- * @param rate is the interest rate.
- * @param yld is the security's annual yield.
- * @param redemption is the amount to be received at maturity.
- * @param frequency is the number of coupon payments per year.
- * @param basis is the type of day count basis to use.
- *
- * @remarks
- * The last coupon period is "odd" when the final coupon date and maturity do
- * not coincide — i.e. the bond matures between regular coupon dates.
- *
- * Unlike the odd-first functions, the odd-last formula is derived from a
- * different spec formula that expresses price as a function of three
- * fractional period lengths (fAi, fDCi, fDSCi — see _calculateOddLPrice).
- */
-export declare function ODDLPRICE(settlement: number, // date
-maturity: number, // date
-lastInterest: number, // date
-rate: number, yld: number, redemption: number, frequency: number, basis?: number): number;
-/**
- * @summary Returns the yield of a security with an odd last period.
- * @param settlement is the security's settlement date, expressed as a serial date number.
- * @param maturity is the security's maturity date, expressed as a serial date number.
- * @param lastInterest is the security's last coupon date, expressed as a serial date number.
- * @param rate is the interest rate.
- * @param pr is the security's price.
- * @param redemption is the amount to be received at maturity.
- * @param frequency is the number of coupon payments per year.
- * @param basis is the type of day count basis to use.
- *
- * @remarks
- * For the odd-last case Excel uses a closed-form yield formula (not Newton)
- * because the price formula is linear in yield.  We follow the same approach.
- *
- * Formula from the Excel spec:
- *   yield = (freq*(redemption−pr) + 100*rate*(fDCi−fAi))
- *           / (fDSCi*pr + 100*rate*fAi*fDSCi/freq)
- */
-export declare function ODDLYIELD(settlement: number, // date
-maturity: number, // date
-lastInterest: number, // date
-rate: number, pr: number, redemption: number, frequency: number, basis?: number): number;
-//# sourceMappingURL=ODD.d.ts.map