HuasoFoundries / math_histogram

src/Histogram/AbstractHistogram.php

Doc Comments +2 added lines, -2 removed lines

@@ -99,7 +99,7 @@ 
      *
      * @access  public
      * @param   int $type one of HISTOGRAM_SIMPLE or HISTOGRAM_CUMMULATIVE
-     * @return  mixed   boolean true on success, a PEAR_Error object otherwise
+     * @return  boolean   boolean true on success, a PEAR_Error object otherwise
      */
     public function setType($type)
     {
@@ -117,7 +117,7 @@ 
      *
      * @access  public
      * @param   array   $binOptions associative array of bin options
-     * @return  mixed   true on succcess, a PEAR_Error object otherwise
+     * @return  boolean   true on succcess, a PEAR_Error object otherwise
      */
     public function setBinOptions($binOptions)
     {

src/Histogram/Histogram.php

Doc Comments +3 added lines, -3 removed lines

@@ -67,7 +67,7 @@ 
      *
      * @access  public
      * @param   array   $data   the numeric array
-     * @return  mixed   boolean true on success, a \PEAR_Error object otherwise
+     * @return  boolean   boolean true on success, a \PEAR_Error object otherwise
      *
      * @see _clear()
      * @see Math_AbstractHistogram::getData()
@@ -106,7 +106,7 @@ 
      *
      * @access  public
      * @param   optional    $statsMode  calculate basic statistics (STATS_BASIC) or full (STATS_FULL)
-     * @return  mixed   boolean true on success, a \PEAR_Error object otherwise
+     * @return  boolean   boolean true on success, a \PEAR_Error object otherwise
      *
      * @see Math_Stats
      */
@@ -270,7 +270,7 @@ 
      * @deprecated
      * @access  public
      * @param   optional    int $mode   one of HISTOGRAM_LO_BINS, HISTOGRAM_MID_BINS, or HISTOGRAM_HI_BINS (default)
-     * @return  mixed   a string on success, a \PEAR_Error object otherwise
+     * @return  string   a string on success, a \PEAR_Error object otherwise
      */
     public function printHistogram($mode = self::HISTOGRAM_HI_BINS)
     {

src/Histogram/Histogram3D.php

Doc Comments +4 added lines, -4 removed lines

@@ -43,8 +43,8 @@ 
  * Sets the binning options. Overrides parent's method.
  *
  * @access  public
- * @param   array $binOptions  an array of options for binning the data
- * @return  void
+ * @param   string $binOptions  an array of options for binning the data
+ * @return  boolean
  */
 
     public function setBinOptions($binOptions)
@@ -64,7 +64,7 @@ 
      *
      * @access  public
      * @param   array   $data   the numeric array
-     * @return  mixed   boolean true on success, a \PEAR_Error object otherwise
+     * @return  boolean   boolean true on success, a \PEAR_Error object otherwise
      *
      * @see _clear()
      * @see Math_AbstractHistogram::getData()
@@ -248,7 +248,7 @@ 
      * array
      *
      * @access  private
-     * @param   array   $elem
+     * @param   string   $elem
      * @return  array   of values: array(min, max)
      */
     public function _getMinMax($elem)

src/Histogram/Histogram4D.php

Doc Comments +4 added lines, -4 removed lines

@@ -42,8 +42,8 @@ 
      * Sets the binning options. Overrides parent's method.
      *
      * @access  public
-     * @param   array $binOptions  an array of options for binning the data
-     * @return  void
+     * @param   string $binOptions  an array of options for binning the data
+     * @return  boolean
      */
     public function setBinOptions($binOptions)
     {
@@ -62,7 +62,7 @@ 
      *
      * @access  public
      * @param   array   $data   the numeric array
-     * @return  mixed   boolean true on success, a \PEAR_Error object otherwise
+     * @return  boolean   boolean true on success, a \PEAR_Error object otherwise
      *
      * @see _clear()
      * @see Math_AbstractHistogram::getData()
@@ -265,7 +265,7 @@ 
      * array
      *
      * @access  private
-     * @param   array   $elem
+     * @param   string   $elem
      * @return  array   of values: array(min, max)
      */
     public function _getMinMax($elem)

src/Histogram/Printer/Common.php

Doc Comments +2 added lines, -2 removed lines

@@ -56,7 +56,7 @@ 
      *              Common options:
      *              'useHTTPHeaders' (default = false), whether to output HTTP headers when using printOutput()
      *              'outputStatistics' (default = false), whether to include histogram statistics when generating the output
-     * @return  boolean TRUE on success, FALSE otherwise
+     * @return  boolean|null TRUE on success, FALSE otherwise
      */
     public function setOptions($options)
     {
@@ -142,7 +142,7 @@ 
      *
      * @static
      * @access private
-     * @param object $printer An instance of a Histogram_Printer_* class
+     * @param Text $printer An instance of a Histogram_Printer_* class
      * @param object Histogram $hist A Histogram instance
      * @param array $options An array of options for the printer object
      * @return boolean|PEAR_Error TRUE on success, a \PEAR_Error otherwise

src/Histogram/Printer/Text.php

Doc Comments +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
      * Returns a string representation of a Histogram plot
      *
      * @access public
-     * @return string|PEAR_Error A string on succcess, a \PEAR_Error otherwise
+     * @return string A string on succcess, a \PEAR_Error otherwise
      */
     public function generateOutput()
     {
@@ -64,7 +64,7 @@ 
      * Prints out a graphic representation of a Histogram
      *
      * @access public
-     * @return boolean|PEAR_Error TRUE on success, a \PEAR_Error otherwise
+     * @return string|null TRUE on success, a \PEAR_Error otherwise
      */
     public function printOutput()
     {

src/Math/Stats.php

Doc Comments +9 added lines, -9 removed lines

@@ -120,7 +120,7 @@ 
      * @access public
      * @param   array   $arr    the data set
      * @param   optional    int $opt    data format: STATS_DATA_CUMMULATIVE or STATS_DATA_SIMPLE (default)
-     * @return  mixed   true on success, a PEAR_Error object otherwise
+     * @return  boolean   true on success, a PEAR_Error object otherwise
      */
     public function setData($arr, $opt = self::STATS_DATA_SIMPLE)
     {
@@ -170,7 +170,7 @@ 
      * Must be called before assigning a new data set containing null values
      *
      * @access  public
-     * @return  mixed   true on success, a PEAR_Error object otherwise
+     * @return  boolean   true on success, a PEAR_Error object otherwise
      * @see _validate()
      */
     public function setNullOption($nullOption)
@@ -481,7 +481,7 @@ 
      * Handles cummulative data sets correctly
      *
      * @access  public
-     * @param   numeric $n  the exponent
+     * @param   integer $n  the exponent
      * @return  mixed   the sum on success, a PEAR_Error object otherwise
      * @see calc()
      * @see sum()
@@ -536,7 +536,7 @@ 
      * Handles cummulative data sets correctly
      *
      * @access  public
-     * @param   numeric $n  the exponent
+     * @param   integer $n  the exponent
      * @return  numeric|array|PEAR_Error  the product as a number or an array of numbers
      *                                    (if there is numeric overflow) on success,
      *                                    a PEAR_Error object otherwise
@@ -731,7 +731,7 @@ 
      *
      * @access  public
      * @param   numeric $mean   the fixed mean value
-     * @return  mixed   the variance on success, a PEAR_Error object otherwise
+     * @return  double   the variance on success, a PEAR_Error object otherwise
      * @see __sumdiff()
      * @see count()
      * @see variance()
@@ -1502,7 +1502,7 @@ 
      * @todo need to double check generality of the algorithm
      *
      * @access public
-     * @param numeric $p the percentile to estimate, e.g. 25 for 25th percentile
+     * @param integer $p the percentile to estimate, e.g. 25 for 25th percentile
      * @return mixed a numeric value on success, a PEAR_Error otherwise
      * @see quartiles()
      * @see median()
@@ -1540,7 +1540,7 @@ 
      * Utility function to calculate: SUM { (xi - mean)^n }
      *
      * @access private
-     * @param   numeric $power  the exponent
+     * @param   integer $power  the exponent
      * @param   optional    double   $mean   the data set mean value
      * @return  mixed   the sum on success, a PEAR_Error object otherwise
      *
@@ -1678,7 +1678,7 @@ 
      *
      * @access private
      * @param mixed $v value to be formatted
-     * @param boolean $returnErrorObject whether the raw PEAR_Error (when true, default),
+     * @param boolean $useErrorObject whether the raw PEAR_Error (when true, default),
      *                  or only the error message will be returned (when false)
      * @return mixed if the value is a PEAR_Error object, and $useErrorObject
      *              is false, then a string with the error message will be returned,
@@ -1699,7 +1699,7 @@ 
      * according to the current null handling option
      *
      * @access  private
-     * @return  mixed true on success, a PEAR_Error object otherwise
+     * @return  boolean true on success, a PEAR_Error object otherwise
      *
      * @see setData()
      */