Skip to content

Commit

Permalink
– updated readme with the definition of the SimpleInterestCalculator …
Browse files Browse the repository at this point in the history
…class
  • Loading branch information
uruba committed Sep 25, 2015
1 parent 4921945 commit 51d39b9
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,33 @@ namespace `FinanCalc\Calculators\Factories`

* * *

### SimpleInterestCalculator
namespace `FinanCalc\Calculators`
* **__construct($principal, $annualInterestRate, TimeSpan $time)**
* *$principal* = **'P'** – amount of principal
* *$annualInterestRate* = **'i'** – annual interest rate (i.e., a decimal number typically lower than 1 and greater than 0)
* *$time* = (converted to years) **'t'** – the total time as a TimeSpan object

##### Setters
* **setPrincipal($principal)** – sets P
* **setAnnualInterestRate($annualInterestRate)** – sets i
* **setTime(TimeSpan $time)** – sets the total time

##### Getters
* **getPrincipal()** – gets P
* **getAnnualInterestRate()** – gets i
* **getTime()** – gets the total time as a TimeSpan object
* **getTimeInYears()** – gets the total time in years
* **getTimeInMonths()** – gets the total time in months
* **getTimeInDays()** – gets the total time in days
* **getInterestAmount()** – gets the interest amount ('n')

#### SimpleInterestCalculatorFactory (*SimpleInterestCalculator's factory object*)
namespace `FinanCalc\Calculators\Factories`
* **newSimpleInterest($principal, $annualInterestRate, TimeSpan $time)**

* * *

### StockDividendDiscountModelCalculator
namespace `FinanCalc\Calculators`
* **__construct(StockDDMTypes $dividendDiscountModelType, $stockVIR, $stockAnnualDividendValue, $stockAnnualDividendsGrowth = null)**
Expand Down

0 comments on commit 51d39b9

Please sign in to comment.