com.ftlabs.fisa.calc.indexed
Class InflationIndexedLastPeriodCalculator

java.lang.Object
  com.ftlabs.fisa.calc.AbstractCalculator
      com.ftlabs.fisa.calc.LastPeriodCalculator
          com.ftlabs.fisa.calc.LastPeriodSimpleInterestCalculator
              com.ftlabs.fisa.calc.indexed.InflationIndexedLastPeriodCalculator

All Implemented Interfaces:

Calculator, InflationIndexedCalculator, YieldConvergable, java.io.Serializable

public class InflationIndexedLastPeriodCalculator
extends LastPeriodSimpleInterestCalculator
implements InflationIndexedCalculator

Treasury-Inflation Protected Securities multiple period.

See Also:

Serialized Form

Field Summary

protected int	interestFrequency
protected double	parValue
protected Redemption	redemption
protected FISADate	settlementDate

Fields inherited from class com.ftlabs.fisa.calc.LastPeriodSimpleInterestCalculator

interestRate, taxAdjustedInterestRate, taxAdjustedRedemptionValue

Fields inherited from class com.ftlabs.fisa.calc.LastPeriodCalculator

act_df, aif, df, lcf

Constructor Summary

InflationIndexedLastPeriodCalculator(FISADate settlementDate, Redemption redemption, double parValue, double interestRate, DayCountBasis dayCountBasis, int interestFrequency, boolean eomAdjust, FISADate datedDate, CPIFactory cpiFactory)

Method Summary

Analytics	calculate(AnalyticValueType givenType, double givenValue) Calculate an Analytics object using the provided AnalyticValueType and value.
double	calculateConvexity(double periodicYield) Calculate the actual convexity.
double	calculateInterestOnInterest(double reinvestmentYield) Calculate the interest earned on reinvested interest cashflows using the provided reinvestmentYield.
double	calculateMacaulayDuration(double periodicYield) Calculate the actual Macaulay duration.
double	calculateModifiedDuration(double periodicYield) Calculate the actual modified duration.
double	calculateModifiedDuration(double macaulayDuration, double periodicYield) Calculate the actual modified duration, given the Macaulay Duration.
double	calculatePeriodicYield(double price) Calculate a periodic discounted cash flow yield for use with convexity/duration methods.
double	getAdjustedAccruedInterest()
double	getAdjustedPrice(double price) Get a price adjusted by the indexRatio.
int	getCashFlowCount() Get the number of cashflows within the supported settlement to Redemption period.
FISADate	getCashFlowDate(int cashFlowIndex) Get a cash flow date for a particular cashflow, as specified by the provided cashFlowIndex.
void	getCashFlowDate(int cashFlowIndex, FISADate date) Set the provided FISADate to the cash flow date of a particular cashflow, as specified by the provided cashFlowIndex.
double	getIndexRatio() Get the Index Ratio for the datedDate and settlementDate to which this calculator is bound.
Redemption	getRedemption() Get the Redemption to which this Calculator is bound.
FISADate	getSettlementDate() Get the settlement date to which this Calculator is bound.
double	getTotalCashFlow(int cashFlowIndex) Get the principal and interest to be paid for a particular cashflow, as specified by cashFlowIndex.
void	setValues(FISADate settlementDate, Redemption redemption, double parValue, double interestRate, DayCountBasis dayCountBasis, int interestFrequency, boolean eomAdjust, FISADate datedDate, CPIFactory cpiFactory)
protected void	setValues(FISADate settlementDate, Redemption redemption, double parValue, int interestFrequency)

Methods inherited from class com.ftlabs.fisa.calc.LastPeriodSimpleInterestCalculator

calculateAccruedInterest, calculateCurrentYield, calculatePrice, calculateYield, getInterest, setValues, setValues

Methods inherited from class com.ftlabs.fisa.calc.LastPeriodCalculator

calculateEstimatedConvexity, calculateEstimatedMacaulayDuration, calculateEstimatedModifiedDuration, calculateEstimatedModifiedDuration, calculatePriceValue1BP, calculateYieldValue1_32, getPeriodicTimeToFlow, getPrincipal, getTimeToFlow, setValues

Methods inherited from class com.ftlabs.fisa.calc.AbstractCalculator

calculateApproximateYield, calculateMPCIPrice, calculateSPSIPrice, calculateSPSIYield, calculateTotalInterestFlows

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ftlabs.fisa.calc.Calculator

calculate, calculateAccruedInterest, calculateConvexity, calculateCurrentYield, calculateEstimatedConvexity, calculateEstimatedMacaulayDuration, calculateEstimatedModifiedDuration, calculateEstimatedModifiedDuration, calculateInterestOnInterest, calculateMacaulayDuration, calculateModifiedDuration, calculateModifiedDuration, calculatePeriodicYield, calculatePrice, calculatePriceValue1BP, calculateTotalInterestFlows, calculateYield, calculateYieldValue1_32, getCashFlowCount, getCashFlowDate, getCashFlowDate, getInterest, getPeriodicTimeToFlow, getPrincipal, getRedemption, getSettlementDate, getTimeToFlow, getTotalCashFlow

Field Detail

settlementDate

protected FISADate settlementDate

redemption

protected Redemption redemption

parValue

protected double parValue

interestFrequency

protected int interestFrequency

Constructor Detail

InflationIndexedLastPeriodCalculator

public InflationIndexedLastPeriodCalculator(FISADate settlementDate,
                                            Redemption redemption,
                                            double parValue,
                                            double interestRate,
                                            DayCountBasis dayCountBasis,
                                            int interestFrequency,
                                            boolean eomAdjust,
                                            FISADate datedDate,
                                            CPIFactory cpiFactory)
                                     throws CalculationException

Throws:

CalculationException

Method Detail

setValues

public void setValues(FISADate settlementDate,
                      Redemption redemption,
                      double parValue,
                      double interestRate,
                      DayCountBasis dayCountBasis,
                      int interestFrequency,
                      boolean eomAdjust,
                      FISADate datedDate,
                      CPIFactory cpiFactory)
               throws CalculationException

Throws:

CalculationException

getIndexRatio

public double getIndexRatio()
                     throws CalculationException

Get the Index Ratio for the datedDate and settlementDate to which this calculator is bound.

Specified by:

getIndexRatio in interface InflationIndexedCalculator

Returns:

The Index Ratio for the datedDate and settlementDate to which this calculator is bound.

Throws:

CalculationException

getAdjustedPrice

public double getAdjustedPrice(double price)
                        throws CalculationException

Get a price adjusted by the indexRatio.

Specified by:

getAdjustedPrice in interface InflationIndexedCalculator

Parameters:

price - A price to adjust.

Returns:

A price adjusted by the indexRatio.

Throws:

CalculationException

getAdjustedAccruedInterest

public double getAdjustedAccruedInterest()
                                  throws CalculationException

Specified by:

getAdjustedAccruedInterest in interface InflationIndexedCalculator

Returns:

The accrued interest adjusted by the indexRatio.

Throws:

CalculationException

setValues

protected void setValues(FISADate settlementDate,
                         Redemption redemption,
                         double parValue,
                         int interestFrequency)

getSettlementDate

public FISADate getSettlementDate()

Description copied from interface: Calculator

Get the settlement date to which this Calculator is bound.

Returns:

Settlement date.

getRedemption

public Redemption getRedemption()

Description copied from interface: Calculator

Get the Redemption to which this Calculator is bound.

Returns:

Redemption.

getCashFlowCount

public int getCashFlowCount()

Description copied from interface: Calculator

Get the number of cashflows within the supported settlement to Redemption period.

Returns:

The number of cashflows within the supported settlement to Redemption period.

getTotalCashFlow

public double getTotalCashFlow(int cashFlowIndex)

Description copied from interface: Calculator

Get the principal and interest to be paid for a particular cashflow, as specified by cashFlowIndex.

Parameters:

cashFlowIndex - The cashflow index. cashFlowIndex is zero based and must be a number from 0 to getCashFlowCount() - 1.

Returns:

The principal + interest to be paid for the specified cashflow.

getCashFlowDate

public FISADate getCashFlowDate(int cashFlowIndex)

Description copied from interface: Calculator

Get a cash flow date for a particular cashflow, as specified by the provided cashFlowIndex.

Parameters:

cashFlowIndex - The cashflow index. cashFlowIndex is zero based and must be a number from 0 to getCashFlowCount() - 1.

Returns:

The cash flow date for the provided cash flow index.

getCashFlowDate

public void getCashFlowDate(int cashFlowIndex,
                            FISADate date)

Description copied from interface: Calculator

Set the provided FISADate to the cash flow date of a particular cashflow, as specified by the provided cashFlowIndex.

Parameters:

cashFlowIndex - The cashflow index. cashFlowIndex is zero based and must be a number from 0 to getCashFlowCount() - 1.

date - A FISADate to be set to the specified cash flow date.

calculatePeriodicYield

public double calculatePeriodicYield(double price)
                              throws CalculationException

Calculate a periodic discounted cash flow yield for use with convexity/duration methods.

Parameters:

price - the price.

Returns:

Periodic discounted cash flow yield.

Throws:

CalculationException

calculateMacaulayDuration

public double calculateMacaulayDuration(double periodicYield)
                                 throws CalculationException

Calculate the actual Macaulay duration.

Parameters:

periodicYield - The periodicYield as returned from the calculatePeriodicYield method.

Returns:

Macaulay duration.

Throws:

CalculationException

calculateModifiedDuration

public double calculateModifiedDuration(double periodicYield)
                                 throws CalculationException

Calculate the actual modified duration.

Parameters:

periodicYield - The periodicYield as returned from the calculatePeriodicYield method.

Returns:

modified duration.

Throws:

CalculationException

calculateModifiedDuration

public double calculateModifiedDuration(double macaulayDuration,
                                        double periodicYield)
                                 throws CalculationException

Calculate the actual modified duration, given the Macaulay Duration.

Parameters:

macaulayDuration - The macaulayDuration as returned from the calculateMacaulayDuration method.

periodicYield - The periodicYield as returned from the calculatePeriodicYield method.

Returns:

modified duration.

Throws:

CalculationException

calculateConvexity

public double calculateConvexity(double periodicYield)
                          throws CalculationException

Calculate the actual convexity.

Parameters:

periodicYield - The periodicYield as returned from the calculatePeriodicYield method.

Returns:

convexity.

Throws:

CalculationException

calculate

public Analytics calculate(AnalyticValueType givenType,
                           double givenValue)
                    throws CalculationException

Description copied from interface: Calculator

Calculate an Analytics object using the provided AnalyticValueType and value.

Parameters:

givenType - The AnalyticValueType of the givenValue.

givenValue - The value to calculate the Analytics from.

Throws:

CalculationException

calculateInterestOnInterest

public double calculateInterestOnInterest(double reinvestmentYield)
                                   throws CalculationException

Description copied from interface: Calculator

Calculate the interest earned on reinvested interest cashflows using the provided reinvestmentYield.

Parameters:

reinvestmentYield - The assumed yield of the reinvested interest cashflows.

Returns:

The interest earned on reinvested interest cashflows.

Throws:

CalculationException