From 0787b0073655a4063bf3ae164f184fdabc8471fd Mon Sep 17 00:00:00 2001
From: Dennis Eichhorn <spl1nes.com@googlemail.com>
Date: Fri, 18 Aug 2017 21:11:50 +0200
Subject: [PATCH] Added docblocks

---
 Math/Finance/Lorenzkurve.php | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/Math/Finance/Lorenzkurve.php b/Math/Finance/Lorenzkurve.php
index f30663a2c..ed04d5e9b 100644
--- a/Math/Finance/Lorenzkurve.php
+++ b/Math/Finance/Lorenzkurve.php
@@ -26,7 +26,16 @@ namespace phpOMS\Math\Finance;
  */
 class Lorenzkurve
 {
-    public static function getGiniCoefficient(array $data)
+    /**
+     * Calculate Gini coefficient
+     *
+     * @param array $data Datapoints (can be unsorted)
+     *
+     * @return float
+     *
+     * @since  1.0.0
+     */
+    public static function getGiniCoefficient(array $data) : float
     {
         $sum1 = 0;
         $sum2 = 0;
@@ -36,9 +45,9 @@ class Lorenzkurve
         sort($data);
 
         foreach ($data as $key => $value) {
-                $sum1 += $i * $value;
-                $sum2 += $value;
-                $i++;
+            $sum1 += $i * $value;
+            $sum2 += $value;
+            $i++;
         }
 
         return 2 * $sum1 / ($n * $sum2) - ($n + 1) / $n;