Add new LogarithmicMean function to Maths category

delphidabbler · delphidabbler · commit 6fd864392e1c · 2025-01-14T11:35:40.000Z
Added source code .dat file for the function.

Added meta data for the function to maths.ini.
diff --git a/collection/690.dat b/collection/690.dat
@@ -0,0 +1,11 @@
+﻿function LogarithmicMean(const X, Y: Double): Double;
+begin
+  if (X <= 0) or (Y <= 0) then
+    raise SysUtils.EArgumentException.Create(
+      'Parameters X & Y must both be positive'
+    );
+  if Math.SameValue(X, Y) then
+    Result := X
+  else
+    Result := (Y - X) / (System.Ln(Y) - System.Ln(X));
+end;
diff --git a/collection/maths.ini b/collection/maths.ini
@@ -2211,3 +2211,17 @@ AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tes
 Snip=689.dat
 DelphiXE=Y
 Delphi12A=Y
+
+[LogarithmicMean]
+DisplayName="LogarithmicMean"
+DescEx="<p>Returns the logarithmic mean of two positive floating point values, <var>X</var> and <var>Y</var>.</p><p>Raises <var>EArgumentException</var> if either <var>X</var> or <var>Y</var> is not positive.</p>"
+Extra="<p>See <a href="https://www.ryantoomey.org/wiki/Logarithmic_mean_average">Chemepedia</a> for information about the logarithmic mean.</p>"
+Kind=routine
+Units=SysUtils,Math
+SeeAlso=ArithmeticMean_Double,GeometricMean_Double,HarmonicMean_Double
+TestInfo=advanced
+AdvancedTest.Level=unit-tests
+AdvancedTest.URL="https://github.com/delphidabbler/code-snippets/tree/master/tests/Cat-Maths"
+Snip=690.dat
+DelphiXE=Y
+Delphi12A=Y
