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 HarmonicMean
See also: MeanVar, GeometricMean 

HarmonicMean


Unit:SDL_matrix
Class: TMatrix, TIntMatrix
Declaration: function HarmonicMean (LowCol, LowRow, HighCol, HighRow: integer): double;

The method HarmonicMean calculates the harmonic mean of all matrix elements within a specific area. The range of the matrix elements to be used is determined by the parameters LowRow, LowCol, HighRow, and HighCol. If any of these elements holds a negative or zero value, an exception is raised.

Hint: 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.


Last Update: 2012-Oct-20