Documentation

ClassicStats
in package
implements StatsInterface, ExportableInterface uses DataProcessorTrait, ExportableTrait

ClassicStats - Classical descriptive statistics library.

  • Implements calculations based on mean and traditional standard deviation.
  • Useful for bias comparisons against robust statistics.

Table of Contents

Interfaces

StatsInterface
ExportableInterface

Methods

getCoefficientOfVariation()  : float
Contract implementation: returns the coefficient of variation (CV%).
getDeviation()  : float
Contract implementation: returns the sample standard deviation.
getMean()  : float
Calculate the simple arithmetic mean.
getMedian()  : float
Calculate the median (sorting data first).
getOutliers()  : array<string|int, mixed>
Detect outliers using the traditional Z-Score method (|Z| > 3).
getPopulationVariance()  : float
Calculate the population variance (divide by n).
getSampleVariance()  : float
Calculate the sample variance (Bessel correction: divide by n-1).
getStandardDeviation()  : float
Calculate the sample standard deviation (square root of sample variance).
getSummary()  : array<string|int, mixed>
Get a complete summary of classic metrics.
getVariance()  : float
Contract implementation: returns the sample variance (Bessel correction).
toCsv()  : string
Export the statistical summary to CSV.
toJson()  : string
Export the statistical summary to JSON.
calculateMean()  : float
calculateVariance()  : float
prepareData()  : array<string|int, mixed>
validateData()  : array<string|int, mixed>

Methods

getCoefficientOfVariation()

Contract implementation: returns the coefficient of variation (CV%).

public getCoefficientOfVariation(array<string|int, mixed> $data) : float
Parameters
$data : array<string|int, mixed>
Return values
float

getDeviation()

Contract implementation: returns the sample standard deviation.

public getDeviation(array<string|int, mixed> $data) : float
Parameters
$data : array<string|int, mixed>
Return values
float

getMean()

Calculate the simple arithmetic mean.

public getMean(array<string|int, mixed> $data) : float
Parameters
$data : array<string|int, mixed>
Return values
float

getMedian()

Calculate the median (sorting data first).

public getMedian(array<string|int, mixed> $data) : float
Parameters
$data : array<string|int, mixed>
Return values
float

getOutliers()

Detect outliers using the traditional Z-Score method (|Z| > 3).

public getOutliers(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
Return values
array<string|int, mixed>

getPopulationVariance()

Calculate the population variance (divide by n).

public getPopulationVariance(array<string|int, mixed> $data) : float
Parameters
$data : array<string|int, mixed>
Return values
float

getSampleVariance()

Calculate the sample variance (Bessel correction: divide by n-1).

public getSampleVariance(array<string|int, mixed> $data) : float
Parameters
$data : array<string|int, mixed>
Return values
float

getStandardDeviation()

Calculate the sample standard deviation (square root of sample variance).

public getStandardDeviation(array<string|int, mixed> $data) : float
Parameters
$data : array<string|int, mixed>
Return values
float

getSummary()

Get a complete summary of classic metrics.

public getSummary(array<string|int, mixed> $data[, bool $sort = true ][, int $decimals = 2 ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$sort : bool = true
$decimals : int = 2
Return values
array<string|int, mixed>

getVariance()

Contract implementation: returns the sample variance (Bessel correction).

public getVariance(array<string|int, mixed> $data) : float
Parameters
$data : array<string|int, mixed>
Return values
float

toCsv()

Export the statistical summary to CSV.

public toCsv(array<string|int, mixed> $data[, string $delimiter = "," ]) : string
Parameters
$data : array<string|int, mixed>
$delimiter : string = ","
Return values
string —

CSV content (Header + Values)

toJson()

Export the statistical summary to JSON.

public toJson(array<string|int, mixed> $data[, int $options = JSON_PRETTY_PRINT ]) : string
Parameters
$data : array<string|int, mixed>
$options : int = JSON_PRETTY_PRINT
Return values
string

calculateMean()

private calculateMean(array<string|int, mixed> $data) : float
Parameters
$data : array<string|int, mixed>
Return values
float

calculateVariance()

private calculateVariance(array<string|int, mixed> $data[, bool $sample = true ]) : float
Parameters
$data : array<string|int, mixed>
$sample : bool = true
Return values
float

prepareData()

private prepareData(array<string|int, mixed> $data[, bool $sort = true ][, bool $alreadyProcessed = false ][, bool $alreadySorted = false ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$sort : bool = true
$alreadyProcessed : bool = false
$alreadySorted : bool = false
Return values
array<string|int, mixed>

validateData()

private validateData(array<string|int, mixed> $data[, bool $alreadyProcessed = false ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$alreadyProcessed : bool = false
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results