Class ExpectedBasicConsumption

java.lang.Object
org.drip.portfolioconstruction.alm.ExpectedBasicConsumption

public class ExpectedBasicConsumption
extends java.lang.Object
ExpectedBasicConsumption holds the Parameters required for estimating the Investor's Basic Consumption Profile.

Author:
Lakshmi Krishnamurthy
  • Constructor Summary

    Constructors
    Constructor Description
    ExpectedBasicConsumption​(double workingAgeConsumptionRate, double retirementAgeConsumptionRate)
    ExpectedBasicConsumption Constructor
  • Method Summary

    Modifier and Type Method Description
    double rate​(double age, InvestorCliffSettings investorCliffSettings)
    Compute the Expected Consumption Rate
    double retirementAgeConsumptionRate()
    Retrieve the Retirement Age Consumption Rate
    double workingAgeConsumptionRate()
    Retrieve the Working Age Consumption Rate

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • ExpectedBasicConsumption

      public ExpectedBasicConsumption​(double workingAgeConsumptionRate, double retirementAgeConsumptionRate) throws java.lang.Exception
      ExpectedBasicConsumption Constructor
      Parameters:
      workingAgeConsumptionRate - The Working Age Consumption Rate
      retirementAgeConsumptionRate - The Retirement Age Consumption Rate
      Throws:
      java.lang.Exception - Thrown if the Inputs are Invalid
  • Method Details

    • workingAgeConsumptionRate

      public double workingAgeConsumptionRate()
      Retrieve the Working Age Consumption Rate
      Returns:
      The Working Age Consumption Rate
    • retirementAgeConsumptionRate

      public double retirementAgeConsumptionRate()
      Retrieve the Retirement Age Consumption Rate
      Returns:
      The Retirement Age Consumption Rate
    • rate

      public double rate​(double age, InvestorCliffSettings investorCliffSettings) throws java.lang.Exception
      Compute the Expected Consumption Rate
      Parameters:
      age - The Age whose Investment Phase is needed
      investorCliffSettings - The Investor's Time Cliff Settings Instance
      Returns:
      The Expected Consumption Rate
      Throws:
      java.lang.Exception - Thrown if the Expected Consumption Rate cannot be computed