JordanRL / Fermat

src/Samsara/Fermat/Context/GaussianContext.php

Doc Comments +6 added lines

@@ -69,6 +69,9 @@ 
         );

     }

 

+    /**
+     * @param NumberInterface $standardDev
+     */
     public function SDToValue($standardDev)

     {

         $standardDev = Numbers::makeOrDont($this->numberType, $standardDev);

@@ -85,6 +88,9 @@ 
         return $this->PDFByValue($value);

     }

 

+    /**
+     * @param NumberInterface $value
+     */
     public function PDFByValue($value)

     {

         $value = Numbers::makeOrDont($this->numberType, $value);

src/Samsara/Fermat/Provider/Stats/Distribution/Normal.php

Doc Comments +4 added lines

@@ -19,6 +19,10 @@
      */

     private $sd;

 

+    /**
+     * @param NumberInterface $mean
+     * @param NumberInterface $sd
+     */
     public function __construct($mean, $sd)

     {

         $mean = Numbers::makeOrDont(Numbers::IMMUTABLE, $mean);

src/Samsara/Fermat/Provider/Stats/Stats.php

Doc Comments +18 added lines

@@ -56,6 +56,9 @@ 
         return $one->subtract($p);
     }
 
+    /**
+     * @param NumberInterface $x
+     */
     public static function gaussErrorFunction($x)
     {
 
@@ -68,14 +71,26 @@ 
         $answer = $answer->multiply(
             SeriesProvider::maclaurinSeries(
                 $x,
+
+                /**
+                 * @param NumberInterface $n
+                 */
                 function ($n) {
                     $negOne = Numbers::make(Numbers::IMMUTABLE, -1);
 
                     return $negOne->pow($n);
                 },
+
+                /**
+                 * @param NumberInterface $n
+                 */
                 function ($n) {
                     return SequenceProvider::nthOddNumber($n);
                 },
+
+                /**
+                 * @param NumberInterface $n
+                 */
                 function ($n) {
                     $n = Numbers::makeOrDont(Numbers::IMMUTABLE, $n);
 
@@ -88,6 +103,9 @@ 
 
     }
 
+    /**
+     * @param NumberInterface $p
+     */
     public static function inverseNormalCDF($p, $precision = 10)
     {
         $pi = Numbers::makePi();

src/Samsara/Fermat/Provider/SequenceProvider.php

Doc Comments +2 added lines, -2 removed lines

@@ -52,8 +52,8 @@
     /**
      * WARNING: This function is VERY unoptimized. Be careful of large m values.
      *
-     * @param $m
-     * @param $n
+     * @param string $m
+     * @param integer $n
      *
      * @return NumberInterface
      */

src/Samsara/Fermat/Types/Number.php

Doc Comments +20 added lines, -2 removed lines

@@ -20,6 +20,9 @@ 
 

     protected $base;

 

+    /**
+     * @param integer $precision
+     */
     public function __construct($value, $precision = null, $base = 10)

     {

         $this->base = $base;

@@ -47,6 +50,9 @@ 
         return $this->precision;

     }

 

+    /**
+     * @param NumberInterface $num
+     */
     public function add($num)

     {

         $num = Numbers::makeOrDont($this, $num, $this->getPrecision());

@@ -77,6 +83,9 @@ 
         return $this->setValue($value);

     }

 

+    /**
+     * @param string $num
+     */
     public function multiply($num)

     {

         $num = Numbers::makeOrDont($this, $num, $this->getPrecision());

@@ -95,8 +104,8 @@ 
     /**

      * Note about precision: it uses the smaller of the two precisions (significant figures).

      *

-     * @param $num

-     * @return mixed

+     * @param NumberInterface $num

+     * @return NumberInterface

      */

     public function divide($num)

     {

@@ -486,6 +495,9 @@ 
         return $comparison;

     }

     

+    /**
+     * @param integer $value
+     */
     public function equals($value)

     {

         $value = Numbers::makeOrDont(Numbers::IMMUTABLE, $value, $this->getPrecision());

@@ -497,6 +509,9 @@ 
         }

     }

     

+    /**
+     * @param integer $value
+     */
     public function greaterThan($value)

     {

         $value = Numbers::makeOrDont(Numbers::IMMUTABLE, $value, $this->getPrecision());

@@ -529,6 +544,9 @@ 
         }

     }

 

+    /**
+     * @param integer $value
+     */
     public function lessThanOrEqualTo($value)

     {

         $value = Numbers::makeOrDont(Numbers::IMMUTABLE, $value, $this->getPrecision());