Differences

This shows you the differences between two versions of the page.

--- syntax:functions:round [2016/07/09 08:48] – dmitry
+++ syntax:functions:round [2023/02/28 20:13] (current) – [See also] fix MRound page reference -CT craigt
@@ Line 1: / Line 1: @@
-===== Round(number, N) =====
+====== Round(number, dec_places) ======
+Category:  Number function
-Rounds a number to N decimal digits.
+\\
+=====Description=====
+This function rounds a number to //dec_places// number of decimal digits.
-Note: there exist two types of rounding in general -- "Rounding away from zero" (a.k.a symmetric rounding) and "Rounding to the nearest even number" (a.k.a. banker's rounding). This function is using the latter, as it's the standard way of rounding as described in IEEE Standard 754, section 4. For Excel-type rounding (away from zero) use [[[syntax:functions:roundxl]] function.
+\\
-^  Example  ^  Result  ^
+=====Alternative syntax=====
-| round( 5.55, 1 )  |  5.6 |
+The 2nd argument in this function is optional. If omitted, it's assumed to be 0.
-| round( 5.65, 1 )  |  5.6 |
+  Round(number)  //The same as Round(number, 0)
+\\
+=====Arguments=====
+^Argument^Type^Description^
+|number|Number|The value, usually fractional, to be rounded.|
+|dec_places|Number (from -9 to 28)|The number of decimal places to round //number// to.|
+\\
+**Return value type:**  Number
-=== See also ===
+\\
-  * [[syntax:functions:floor]]
+=====Remarks=====
-  * [[syntax:functions:ceiling]]
+There exist two types of rounding in general - "Rounding away from zero" (a.k.a symmetric rounding) and "Rounding to the nearest even number" (a.k.a. banker's rounding). This function is using the latter, as it's the standard way of rounding as described in IEEE Standard 754, section 4. For Excel-type rounding (away from zero) use [[[syntax:functions:roundxl|RoundXL(number, dec_places)]] function.
-  * [[syntax:functions:roundxl]]
+Using a //dec_places// value of "0" rounds to the nearest whole number.
+\\
+=====Examples=====
+  round(5.55, 1) //Returns 5.6
+  round(5.65, 1) //Returns 5.6
+  round(101.567, 2) //Returns 101.57
+  round(101.5784, 3) //Returns 101.578
+  round(92.523, 0) //Returns 93
+  round(12345, -2) //Returns 12300
+\\
+===== See also =====
+  * [[syntax:functions:ceiling|Ceiling(number)]]
+  * [[syntax:functions:floor|Floor(number)]]
+  * [[syntax:functions:mround|MRound(number, grain)]]
+  * [[syntax:functions:roundxl|RoundXL(number, dec_places)]]
+  * [[syntax:functions:truncate|Truncate(number)]]