Merge branch 'feature/31-add-geometric-mean-functions' into develop

Fixes #31

Author: delphidabbler

Diff for: collection/643.dat

@@ -12,7 +12,7 @@ begin
   for Elem in A do
   begin
     if Elem = 0 then
-      raise SysUtils.EArgumentOutOfRangeException(sNotPositive);
+      raise SysUtils.EArgumentOutOfRangeException.Create(sNotPositive);
     Result := Result + System.Ln(Elem);
   end;
 end;

Diff for: collection/644.dat

@@ -12,7 +12,7 @@ begin
   for Elem in A do
   begin
     if Elem <= 0 then
-      raise SysUtils.EArgumentOutOfRangeException(sNotPositive);
+      raise SysUtils.EArgumentOutOfRangeException.Create(sNotPositive);
     Result := Result + System.Ln(Elem);
   end;
 end;

Diff for: collection/645.dat

@@ -12,7 +12,7 @@ begin
   for Elem in A do
   begin
     if Elem <= 0 then
-      raise SysUtils.EArgumentOutOfRangeException(sNotPositive);
+      raise SysUtils.EArgumentOutOfRangeException.Create(sNotPositive);
     Result := Result + System.Ln(Elem);
   end;
 end;

Diff for: collection/646.dat

@@ -12,7 +12,7 @@ begin
   for Elem in A do
   begin
     if Elem = 0 then
-      raise SysUtils.EArgumentOutOfRangeException(sNotPositive);
+      raise SysUtils.EArgumentOutOfRangeException.Create(sNotPositive);
     Result := Result + System.Ln(Elem);
   end;
 end;

Diff for: collection/647.dat

@@ -12,7 +12,7 @@ begin
   for Elem in A do
   begin
     if Math.Sign(Elem) <> Math.PositiveValue then
-      raise SysUtils.EArgumentOutOfRangeException(sNotPositive);
+      raise SysUtils.EArgumentOutOfRangeException.Create(sNotPositive);
     Result := Result + System.Ln(Elem);
   end;
 end;

Diff for: collection/648.dat

@@ -12,7 +12,7 @@ begin
   for Elem in A do
   begin
     if Math.Sign(Elem) <> Math.PositiveValue then
-      raise SysUtils.EArgumentOutOfRangeException(sNotPositive);
+      raise SysUtils.EArgumentOutOfRangeException.Create(sNotPositive);
     Result := Result + System.Ln(Elem);
   end;
 end;

Diff for: collection/649.dat

@@ -12,7 +12,7 @@ begin
   for Elem in A do
   begin
     if Math.Sign(Elem) <> Math.PositiveValue then
-      raise SysUtils.EArgumentOutOfRangeException(sNotPositive);
+      raise SysUtils.EArgumentOutOfRangeException.Create(sNotPositive);
     Result := Result + System.Ln(Elem);
   end;
 end;

Diff for: collection/675.dat

@@ -0,0 +1,6 @@
+function GeoMean(const A: array of Double): Double; overload;
+begin
+  if System.Length(A) = 0 then
+    raise SysUtils.EArgumentException.Create('Array is empty');
+  Result := System.Exp(SumOfLogs(A) / System.Length(A));
+end;

Diff for: collection/676.dat

@@ -0,0 +1,6 @@
+function GeoMean(const A: array of Cardinal): Double; overload;
+begin
+  if System.Length(A) = 0 then
+    raise SysUtils.EArgumentException.Create('Array is empty');
+  Result := System.Exp(SumOfLogs(A) / System.Length(A));
+end;

Diff for: collection/677.dat

@@ -0,0 +1,6 @@
+function GeoMean(const A: array of Integer): Double; overload;
+begin
+  if System.Length(A) = 0 then
+    raise SysUtils.EArgumentException.Create('Array is empty');
+  Result := System.Exp(SumOfLogs(A) / System.Length(A));
+end;

Diff for: collection/678.dat

@@ -0,0 +1,19 @@
+function WeightedGeoMean(const Values: array of Double;
+  const Weights: array of Double): Double; overload;
+var
+  Sum: Double;
+  Idx: Integer;
+  NormalisedWeights: Types.TDoubleDynArray;
+begin
+  if System.Length(Values) = 0 then
+    raise SysUtils.EArgumentException.Create('Array of values is empty');
+  if System.Length(Values) <> System.Length(Weights) then
+    raise SysUtils.EArgumentException.Create(
+      'Number of values and number of weights must be the same'
+    );
+  NormalisedWeights := NormaliseByWeight(Weights);
+  Sum := 0.0;
+  for Idx := 0 to Pred(System.Length(Values)) do
+    Sum := Sum + NormalisedWeights[Idx] * System.Ln(Values[Idx]);
+  Result := System.Exp(Sum);
+end;

Diff for: collection/679.dat

@@ -0,0 +1,11 @@
+function WeightedGeoMean(const Values: array of Cardinal;
+  const Weights: array of Double): Double; overload;
+var
+  Idx: Integer;
+  FloatValues: Types.TDoubleDynArray;
+begin
+  System.Setlength(FloatValues, System.Length(Values));
+  for Idx := 0 to Pred(System.Length(Values)) do
+    FloatValues[Idx] := Values[Idx];
+  Result := WeightedGeoMean(FloatValues, Weights);
+end;

Diff for: collection/680.dat

@@ -0,0 +1,11 @@
+function WeightedGeoMean(const Values: array of Integer;
+  const Weights: array of Double): Double; overload;
+var
+  Idx: Integer;
+  FloatValues: Types.TDoubleDynArray;
+begin
+  System.Setlength(FloatValues, System.Length(Values));
+  for Idx := 0 to Pred(System.Length(Values)) do
+    FloatValues[Idx] := Values[Idx];
+  Result := WeightedGeoMean(FloatValues, Weights);
+end;

Diff for: collection/maths.ini

@@ -1958,6 +1958,7 @@ DescEx="<p>Normalises the values in floating point array <var>A</var> so that ea
 Kind=routine
 Units=SysUtils,Types,Math
 SeeAlso=RescaleRange_Double,WeightedArithMean_Double,NormaliseByWeight_Cardinal
+TestInfo=advanced
 AdvancedTest.Level=unit-tests
 AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tests/Cat-Maths"
 Snip=668.dat
@@ -1970,6 +1971,7 @@ DescEx="<p>Normalises the values in unsigned integer array <var>A</var> so that
 Kind=routine
 Units=SysUtils,Types
 SeeAlso=RescaleRange_Integer,WeightedArithMean_Integer,NormaliseByWeight_Double
+TestInfo=advanced
 AdvancedTest.Level=unit-tests
 AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tests/Cat-Maths"
 Snip=671.dat
@@ -1983,6 +1985,7 @@ Kind=routine
 Units=Math
 Depends=MinMaxOfArray_Double
 SeeAlso=RangeOf_Integer,RescaleRange_Double
+TestInfo=advanced
 AdvancedTest.Level=unit-tests
 AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tests/Cat-Maths"
 Snip=672.dat
@@ -1995,8 +1998,96 @@ DescEx="<p>Returns the length of the range of values in non-empty <var>Integer</
 Kind=routine
 Depends=MinMaxOfArray_Integer
 SeeAlso=RangeOf_Double,RescaleRange_Integer
+TestInfo=advanced
 AdvancedTest.Level=unit-tests
 AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tests/Cat-Maths"
 Snip=673.dat
 DelphiXE=Y
 Delphi12A=Y
+
+[GeoMean_Double]
+DisplayName="GeoMean (Double overload)"
+DescEx="<p>Returns the geometric mean of an array of positive <var>Double</var> values.</p><p><var>EArgumentException</var> is raised if the array is empty while <var>EArgumentOutOfRangeException</var> is raised if any array element is not positive.</p>"
+Extra="<p>See <a href="https://en.m.wikipedia.org/wiki/Geometric_mean">Wikipedia</a> for information about the geometric mean.</p>"
+Kind=routine
+Units=SysUtils
+Depends=SumOfLogs_Double
+SeeAlso=ArithMean_Double,GeoMean_Integer,GeoMean_Cardinal,WeightedGeoMean_Double
+TestInfo=advanced
+AdvancedTest.Level=unit-tests
+AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tests/Cat-Maths"
+Snip=675.dat
+DelphiXE=Y
+Delphi12A=Y
+
+[GeoMean_Cardinal]
+DisplayName="GeoMean (Cardinal overload)"
+DescEx="<p>Returns the geometric mean of an array of positive <var>Cardinal</var> values.</p><p><var>EArgumentException</var> is raised if the array is empty while <var>EArgumentOutOfRangeException</var> is raised if any array element is not positive.</p>"
+Extra="<p>See <a href="https://en.m.wikipedia.org/wiki/Geometric_mean">Wikipedia</a> for information about the geometric mean.</p>"
+Kind=routine
+Units=SysUtils
+Depends=SumOfLogs_Cardinal
+SeeAlso=ArithMean_Cardinal,GeoMean_Integer,GeoMean_Double,WeightedGeoMean_Cardinal
+TestInfo=advanced
+AdvancedTest.Level=unit-tests
+AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tests/Cat-Maths"
+Snip=676.dat
+DelphiXE=Y
+Delphi12A=Y
+
+[GeoMean_Integer]
+DisplayName="GeoMean (Integer overload)"
+DescEx="<p>Returns the geometric mean of an array of positive <var>Integer</var> values.</p><p><var>EArgumentException</var> is raised if the array is empty while <var>EArgumentOutOfRangeException</var> is raised if any array element is not positive.</p>"
+Extra="<p>See <a href="https://en.m.wikipedia.org/wiki/Geometric_mean">Wikipedia</a> for information about the geometric mean.</p>"
+Kind=routine
+Units=SysUtils
+Depends=SumOfLogs_Integer
+SeeAlso=ArithMean_Integer,GeoMean_Cardinal,GeoMean_Double,WeightedGeoMean_Integer
+TestInfo=advanced
+AdvancedTest.Level=unit-tests
+AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tests/Cat-Maths"
+Snip=677.dat
+DelphiXE=Y
+Delphi12A=Y
+
+[WeightedGeoMean_Double]
+DisplayName="WeightedGeoMean (Double overload)"
+DescEx="<p>Calculates and returns the weighted geometric mean of the array <var>Value</var> of positive <var>Double</var> values where each element is weighted by the corresponding element in the array <var>Weights</var>.</p><p>An <var>EArgumentException</var> exception is raised if any of the following pre-conditions are not met: <var>Values</var> must be non-empty; all elements of <var>Values</var> must be positive; <var>Values</var> &amp; <var>Weights</var> must have the same number of elements; all elements of <var>Weights</var> must be non-negative, with at least one element being non-zero.</p>"
+Extra="<p>See <a href="https://en.m.wikipedia.org/wiki/Weighted_geometric_mean">Wikipedia</a> for information about the weighted geometric mean.</p>"
+Units=SysUtils,Types
+Depends=NormaliseByWeight_Double
+SeeAlso=GeoMean_Double,WeightedArithMean_Double,WeightedGeoMean_Cardinal,WeightedGeoMean_Integer
+TestInfo=advanced
+AdvancedTest.Level=unit-tests
+AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tests/Cat-Maths"
+Snip=678.dat
+DelphiXE=Y
+Delphi12A=Y
+
+[WeightedGeoMean_Cardinal]
+DisplayName="WeightedGeoMean (Cardinal overload)"
+DescEx="<p>Calculates and returns the weighted geometric mean of the array <var>Value</var> of positive <var>Cardinal</var> values where each element is weighted by the corresponding element in the array <var>Weights</var>.</p><p>An <var>EArgumentException</var> exception is raised if any of the following pre-conditions are not met: <var>Values</var> must be non-empty; all elements of <var>Values</var> must be positive; <var>Values</var> &amp; <var>Weights</var> must have the same number of elements; all elements of <var>Weights</var> must be non-negative, with at least one element being non-zero.</p>"
+Extra="<p>See <a href="https://en.m.wikipedia.org/wiki/Weighted_geometric_mean">Wikipedia</a> for information about the weighted geometric mean.</p>"
+Units=Types
+Depends=WeightedGeoMean_Double
+SeeAlso=GeoMean_Cardinal,WeightedArithMean_Cardinal,WeightedGeoMean_Double,WeightedGeoMean_Integer
+TestInfo=advanced
+AdvancedTest.Level=unit-tests
+AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tests/Cat-Maths"
+Snip=679.dat
+DelphiXE=Y
+Delphi12A=Y
+
+[WeightedGeoMean_Integer]
+DisplayName="WeightedGeoMean (Integer overload)"
+DescEx="<p>Calculates and returns the weighted geometric mean of the array <var>Value</var> of positive <var>Integer</var> values where each element is weighted by the corresponding element in the array <var>Weights</var>.</p><p>An <var>EArgumentException</var> exception is raised if any of the following pre-conditions are not met: <var>Values</var> must be non-empty; all elements of <var>Values</var> must be positive; <var>Values</var> &amp; <var>Weights</var> must have the same number of elements; all elements of <var>Weights</var> must be non-negative, with at least one element being non-zero.</p>"
+Extra="<p>See <a href="https://en.m.wikipedia.org/wiki/Weighted_geometric_mean">Wikipedia</a> for information about the weighted geometric mean.</p>"
+Units=Types
+Depends=WeightedGeoMean_Double
+SeeAlso=GeoMean_Integer,WeightedArithMean_Integer,WeightedGeoMean_Double,WeightedGeoMean_Cardinal
+TestInfo=advanced
+AdvancedTest.Level=unit-tests
+AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tests/Cat-Maths"
+Snip=680.dat
+DelphiXE=Y
+Delphi12A=Y