Update description and documentation

beutlich · beutlich · commit 728fd63d4919 · 2025-03-18T20:19:41.000+01:00
diff --git a/Modelica/Blocks/Math.mo b/Modelica/Blocks/Math.mo
@@ -1931,7 +1931,7 @@ Otherwise the input angle <code>u</code> is wrapped to the <a href=\"https://en.
 </html>"));
   end WrapAngle;
 
-  block RealToInteger "Convert Real to Integer signal"
+  block RealToInteger "Convert Real to Integer signal (by rounding away from zero)"
     extends Modelica.Blocks.Icons.IntegerBlock;
   public
     Interfaces.RealInput u "Connector of Real input signal" annotation (
@@ -1959,7 +1959,7 @@ Otherwise the input angle <code>u</code> is wrapped to the <a href=\"https://en.
                 30.0,-10.0},{30.0,-20.0},{50.0,0.0}})}), Documentation(info="<html>
 <p>
 This block computes the output <strong>y</strong>
-as <em>nearest integer value</em> of the input <strong>u</strong>:
+as <em>nearest integer value</em> of the input <strong>u</strong> (by rounding away from zero):
 </p>
 <blockquote><pre>
 y = <strong>integer</strong>( <strong>floor</strong>( u + 0.5 ) )  for  u &gt; 0;
diff --git a/Modelica/Math/nearestInteger.mo b/Modelica/Math/nearestInteger.mo
@@ -1,9 +1,9 @@
 within Modelica.Math;
-function nearestInteger "Convert real number to nearest integer value"
+function nearestInteger "Convert real number to nearest integer value (by rounding away from zero)"
   extends Modelica.Icons.Function;
 
   input Real r "Real number to convert to integer";
-  output Integer i "Integer value, which is closest to the given real number";
+  output Integer i "Integer value, which is nearest to the given real number (rounded away from zero)";
 
 algorithm
   i :=if (r > 0) then integer(floor(r + 0.5)) else integer(ceil(r - 0.5));
@@ -17,12 +17,11 @@ Math.<strong>nearestInteger</strong>(r);
 
 <h4>Description</h4>
 <p>
-The input value \"r\" of type Real is converted to the closest Integer value \"i\",
-using the <em>round half away from zero</em> rule with the equation:
+The input value <code>r</code> of type Real is converted to the nearest integer value <code>i</code> (by rounding away from zero):
 </p>
 <blockquote><pre>
 i = <strong>integer</strong>( <strong>floor</strong>( r + 0.5 ) )  for  r &gt; 0;
-i = <strong>integer</strong>(  <strong>ceil</strong>( r - 0.5 ) )  for  r &lt; 0;
+i = <strong>integer</strong>( <strong>ceil </strong>( r - 0.5 ) )  for  r &lt; 0;
 </pre></blockquote>
 
 <h4>Example</h4>
