The SDL Component Suite is an industry leading collection of components supporting scientific and engineering computing. Please visit the SDL Web site for more information....


Home MathPack Matrix Classes TIntMatrix, TMatrix and TMat3D Methods Percentile
See also: Quartiles, QuickSelect 

Percentile


Unit: SDL_matrix
Class: TMatrix, TIntMatrix, TMat3D
Declaration: [1] function Percentile (prob: double; LowCol, LowRow, HighCol, HighRow: integer): double; { classes TMatrix, TIntMatrix }
[2] function Percentile (prob: double; LowCol, LowRow, HighCol, HighRow: integer; SampleSize: integer): double; { classes TMatrix, TIntMatrix }
[1] function Percentile (prob: double; LowCol, HighCol, LowRow, HighRow, LowLayer, HighLayer: integer): double; { class TMat3D }
[2] function Percentile (prob: double; LowCol, HighCol, LowRow, HighRow, LowLayer, HighLayer: integer; SampleSize: integer): double; { class TMat3D }

The function Percentile returns the percentile with the probability of prob percent. The calculation of the percentile is based on QuickSelect and includes all matrix elements between (and including) LowCol, LowRow, HighCol, HighRow, LowLayer, and HighLayer. The function returns a zero value if any error occurs.

Version [1] of the function performs an exact calculation, version [2] calculates the percentile of a random sample taken from the specified data range. The size of the random sample is controlled by the parameter SampleSize. If SampleSize is zero, version [1] is automatically executed. If SampleSize is larger than the number of elements in the specified data range, oversampling occurs (which does no harm to the result but is slower than version [1]). The big advantage of version [2] is that it is much faster than version [1] if the specified data range is large. Typically, version [2] should be used if the number of specified elements exceeds 50000 cells, using a sample size of 10000.

Please note that the 50%-percentile (prob = 50) is also known as the median of the distribution.

Hint 1: Setting both the low and high parameter of a dimension (i.e. LowCol and HighCol) to zero values forces the method to use all elements of that dimension.

Hint 2: The calculated percentile is not interpolated and simply returns the closest value of the distribution, which may differ from other statistical packages and from the results obtained by TVector.Percentile if the number of included values is low.


Last Update: 2023-Feb-06