Stats Package
This package contains a set of statisticial calculations for numeric arrays,
including calculating averages, standard deviations and more.
r := stats.average( a )
|
Calculate the average (mean) value of the array. |
Example |
r := stats.average( numbers_collected );
|
Parameters |
Param |
Mode |
Type |
Default |
Description |
r |
result |
element type |
required |
the array to average |
a |
in out |
numeric array type |
required |
the array to evaluate |
|
Exceptions |
- |
See Also |
- |
Compare With |
- |
r := stats.max( a )
|
Find the maximum (largest) value of the array. |
Example |
r := stats.max( numbers_collected );
|
Parameters |
Param |
Mode |
Type |
Default |
Description |
r |
result |
element type |
required |
the maximum value |
a |
in out |
numeric array type |
required |
the array to search |
|
Exceptions |
- |
See Also |
stats.min |
Compare With |
PHP: max |
r := stats.min( a )
|
Find the minimum (smallest) value of the array. |
Example |
r := stats.min( numbers_collected );
|
Parameters |
Param |
Mode |
Type |
Default |
Description |
r |
result |
element type |
required |
the minimum value |
a |
in out |
numeric array type |
required |
the array to search |
|
Exceptions |
- |
See Also |
stats.max |
Compare With |
PHP: min |
r := stats.standard_deviation( a )
|
Calculate the standard deviation of the array elements. |
Example |
r := stats.standard_deviation( numbers_collected );
|
Parameters |
Param |
Mode |
Type |
Default |
Description |
r |
result |
element type |
required |
the standard deviation |
a |
in out |
numeric array type |
required |
the array to evaluate |
|
Exceptions |
- |
See Also |
- |
Compare With |
PHP: stats_standard_deviation |
r := stats.sum( a )
|
Calculate the total value of the array by adding all elements. |
Example |
r := stats.sum( numbers_collected );
|
Parameters |
Param |
Mode |
Type |
Default |
Description |
r |
result |
element type |
required |
the total value |
a |
in out |
numeric array type |
required |
the array to sum |
|
Exceptions |
- |
See Also |
- |
Compare With |
PHP: array_sum |
r := stats.variance( a )
|
Calculate the variance of the array elements. |
Example |
r := stats.variance( numbers_collected );
|
Parameters |
Param |
Mode |
Type |
Default |
Description |
r |
result |
element type |
required |
the variance |
a |
in out |
numeric array type |
required |
the array to evaluate |
|
Exceptions |
- |
See Also |
- |
Compare With |
PHP: stats_variance |
|
![[Right Submenu]](art/right_menu_top.png)
|