public static function PHPExcel_Calculation_Financial::YIELDDISC in Loft Data Grids 7.2

Same name and namespace in other branches

1. 6.2 vendor/phpoffice/phpexcel/Classes/PHPExcel/Calculation/Financial.php \PHPExcel_Calculation_Financial::YIELDDISC()

* YIELDDISC * * Returns the annual yield of a security that pays interest at maturity. * *

Parameters

mixed settlement The security's settlement date.: * The security's settlement date is the date after the issue date when the security is traded to the buyer. * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. * @param int price The security's price per $100 face value. * @param int redemption The security's redemption value per $100 face value. * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 * 3 Actual/365 * 4 European 30/360 * @return float

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Calculation/Financial.php, line 2200

Class

PHPExcel_Calculation_Financial

PHPExcel_Calculation_Financial

Code

public static function YIELDDISC($settlement, $maturity, $price, $redemption, $basis = 0) {
  $settlement = PHPExcel_Calculation_Functions::flattenSingleValue($settlement);
  $maturity = PHPExcel_Calculation_Functions::flattenSingleValue($maturity);
  $price = PHPExcel_Calculation_Functions::flattenSingleValue($price);
  $redemption = PHPExcel_Calculation_Functions::flattenSingleValue($redemption);
  $basis = (int) PHPExcel_Calculation_Functions::flattenSingleValue($basis);

  //	Validate
  if (is_numeric($price) && is_numeric($redemption)) {
    if ($price <= 0 || $redemption <= 0) {
      return PHPExcel_Calculation_Functions::NaN();
    }
    $daysPerYear = self::_daysPerYear(PHPExcel_Calculation_DateTime::YEAR($settlement), $basis);
    if (!is_numeric($daysPerYear)) {
      return $daysPerYear;
    }
    $daysBetweenSettlementAndMaturity = PHPExcel_Calculation_DateTime::YEARFRAC($settlement, $maturity, $basis);
    if (!is_numeric($daysBetweenSettlementAndMaturity)) {

      //	return date error
      return $daysBetweenSettlementAndMaturity;
    }
    $daysBetweenSettlementAndMaturity *= $daysPerYear;
    return ($redemption - $price) / $price * ($daysPerYear / $daysBetweenSettlementAndMaturity);
  }
  return PHPExcel_Calculation_Functions::VALUE();
}