Added Rounded #s for Debt Payments

src/Calculators/DebtAmortizator.php

@@ -48,7 +48,9 @@ class DebtAmortizator extends CalculatorAbstract
                     "days" => "debtLengthInDays"
                 ],
             "debtSingleRepayment",
-            "debtRepayments" => "debtRepaymentsAsArrays"
+            "debtSingleRepaymentRounded",
+            "debtRepayments" => "debtRepaymentsAsArrays",
+            "debtRepaymentsRounded" => "debtRepaymentsAsArraysRounded"
         ];
 
         /**
@@ -288,6 +290,27 @@ public function getDebtSingleRepayment()
                 )
             );
         }
+
+        /**
+         * @return string [Value of a single debt repayment instance as a string]
+         */
+        public function getDebtSingleRepaymentRounded() {
+            // single repayment 'K = PV/((1-v^n)/i)'
+            return MathFuncs::roundUp(
+                MathFuncs::div(
+                $this->debtPrincipal,
+                MathFuncs::div(
+                    MathFuncs::sub(
+                        1,
+                        MathFuncs::pow(
+                            $this->getDebtDiscountFactor(),
+                            $this->debtNoOfCompoundingPeriods
+                        )
+                    ),
+                    $this->debtInterest
+                )
+            ), 2);
+        }
 
         /**
          * @return RepaymentInstance[] [Array of individual debt repayments (RepaymentInstances)]
@@ -314,7 +337,43 @@ public function getDebtRepaymentsAsArrays()
 
             return $repayments;
         }
+
+				 /**
+         * @return array
+         */
+        public function getDebtRepaymentsAsArraysRounded()
+        {
+            $repayments = array();
+            $i = 1;
+            $balance = $this->debtPrincipal;            
+            foreach ($this->debtRepayments as $repayment) {
+                if($balance > $repayment->getTotalAmount()) {      
+                    $totalAmount = MathFuncs::roundUp($repayment->getTotalAmount(), 2);
+                    $interestAmount = MathFuncs::round($repayment->getInterestAmount(), 2);
+                    $principalAmount = MathFuncs::round($totalAmount - $interestAmount, 2);
+                }
+                else {
+                    $interestAmount = MathFuncs::round($repayment->getInterestAmount(), 2);
+                    $totalAmount = MathFuncs::round(MathFuncs::add($balance, $interestAmount), 2);
+                    $principalAmount = MathFuncs::round($balance, 2);
+                }
+
+                $beginningBalance = $balance;
+                $endingBalance = MathFuncs::sub($balance, $principalAmount);
+                $balance = MathFuncs::sub($balance, $principalAmount);
 
+                $repayments[$i++] = [
+                    "beginningBalance" => MathFuncs::round($beginningBalance, 2),
+                    "totalAmount" => $totalAmount,
+                    "principalAmount" => $principalAmount,
+                    "interestAmount" => $interestAmount,
+                    "endingBalance" => MathFuncs::round($endingBalance, 2)
+                ];
+            }
+
+            return $repayments;
+        }
+
     }
 
     /**

src/Utils/MathFuncs.php

@@ -79,5 +79,25 @@ public static function round($roundedNumber, $precision = 2)
         {
             return (string)number_format((float)$roundedNumber, $precision);
         }
+
+         /**
+         * @param $roundedNumber
+         * @param $precision
+         * @return string
+         */
+        public static function roundUp($roundedNumber, $precision = 2) 
+        {
+            return (string)ceil((float)$roundedNumber * pow(10, $precision)) / pow(10, $precision);
+        }
+
+        /**
+         * @param $roundedNumber
+         * @param $precision
+         * @return string
+         */
+        public static function roundDown($roundedNumber, $precision = 2) 
+        {
+            return (string)floor((float)$roundedNumber * pow(10, $precision)) / pow(10, $precision);
+        }
     }
 }

tests/DebtAmortizatorTest.php

@@ -281,6 +281,33 @@ private function processArray(array $resultArray)
         $this->assertEquals("8686.63", round($repayments[6]["principalAmount"], 2));
         $this->assertEquals("1042.4", round($repayments[6]["interestAmount"], 2));
         $this->assertEquals($INDIVIDUAL_REPAYMENT, round($repayments[6]["totalAmount"], 2));
+
+        $repaymentsRounded = $resultArray["debtRepaymentsRounded"];
+
+        $INDIVIDUAL_REPAYMENT = "9729.03";
+        $this->assertEquals("4929.03", round($repaymentsRounded[1]["principalAmount"], 2));
+        $this->assertEquals("4800.00", round($repaymentsRounded[1]["interestAmount"], 2));
+        $this->assertEquals($INDIVIDUAL_REPAYMENT, round($repaymentsRounded[1]["totalAmount"], 2));
+
+        $this->assertEquals("5520.51", round($repaymentsRounded[2]["principalAmount"], 2));
+        $this->assertEquals("4208.52", round($repaymentsRounded[2]["interestAmount"], 2));
+        $this->assertEquals($INDIVIDUAL_REPAYMENT, round($repaymentsRounded[2]["totalAmount"], 2));
+
+        $this->assertEquals("6182.97", round($repaymentsRounded[3]["principalAmount"], 2));
+        $this->assertEquals("3546.06", round($repaymentsRounded[3]["interestAmount"], 2));
+        $this->assertEquals($INDIVIDUAL_REPAYMENT, round($repaymentsRounded[3]["totalAmount"], 2));
+
+        $this->assertEquals("6924.93", round($repaymentsRounded[4]["principalAmount"], 2));
+        $this->assertEquals("2804.10", round($repaymentsRounded[4]["interestAmount"], 2));
+        $this->assertEquals($INDIVIDUAL_REPAYMENT, round($repaymentsRounded[4]["totalAmount"], 2));
+
+        $this->assertEquals("7755.92", round($repaymentsRounded[5]["principalAmount"], 2));
+        $this->assertEquals("1973.11", round($repaymentsRounded[5]["interestAmount"], 2));
+        $this->assertEquals($INDIVIDUAL_REPAYMENT, round($repaymentsRounded[5]["totalAmount"], 2));
+
+        $this->assertEquals("8686.63", round($repaymentsRounded[6]["principalAmount"], 2));
+        $this->assertEquals("1042.4", round($repaymentsRounded[6]["interestAmount"], 2));
+        $this->assertEquals($INDIVIDUAL_REPAYMENT, round($repaymentsRounded[6]["totalAmount"], 2));
     }
 
     /**

tests/MathFuncsTest.php

@@ -42,4 +42,14 @@ public function testRound()
     {
         $this->assertEquals("3.68", MathFuncs::round(3.675624));
     }
+
+    public function testRoundUp()
+    {
+        $this->assertEquals("3.69", MathFuncs::round(3.675624));
+    }
+
+    public function testRoundDown()
+    {
+        $this->assertEquals("3.67", MathFuncs::round(3.675624));
+    }
 }