hirondelle.formula.function.builtin
Class Investment

Object
  hirondelle.formula.function.builtin.Investment

All Implemented Interfaces:

Function

public final class Investment
extends Object
implements Function

invest(principal, interest-rate, years, times-per-year): compound interest on an investment.

Constructor Summary

Investment()

Method Summary

Decimal

calculate(Decimal... aArgs) Returns the final value of a principal amount invested at a given interest rate, and over a given number of years.

Methods inherited from class Object

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

Constructor Detail

Investment

public Investment()

Method Detail

calculate

public Decimal calculate(Decimal... aArgs)

Returns the final value of a principal amount invested at a given interest rate, and over a given number of years. The result may have more than two decimal places.

There are 4 arguments to this method (in this order):

• principal, >= 0
• interest rate, >= 0
• number of years, integer >= 0
• number of times per year the interest is paid, integer >= 0

Example:

• principal = 100
• interest rate = 0.05 (that is, 5%)
• number of years = 2
• number of times per year the interest is paid = 2

Then

invest(100, 0.05, 2, 1) = 110.25

Specified by:

calculate in interface Function

Parameters:

aArgs - 0 or more arguments to the function.