Added docblocks

This commit is contained in:
Dennis Eichhorn 2017-08-18 21:11:50 +02:00
parent c2544b18c3
commit 0787b00736

View File

@ -26,7 +26,16 @@ namespace phpOMS\Math\Finance;
*/ */
class Lorenzkurve 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; $sum1 = 0;
$sum2 = 0; $sum2 = 0;
@ -36,9 +45,9 @@ class Lorenzkurve
sort($data); sort($data);
foreach ($data as $key => $value) { foreach ($data as $key => $value) {
$sum1 += $i * $value; $sum1 += $i * $value;
$sum2 += $value; $sum2 += $value;
$i++; $i++;
} }
return 2 * $sum1 / ($n * $sum2) - ($n + 1) / $n; return 2 * $sum1 / ($n * $sum2) - ($n + 1) / $n;