View source for System.Math.SimpleRoundTo

{{#lst:API:System.Math.SimpleRoundTo|api}}
<!--Start API Documentation-->
==Description==
<section begin=short />Rounds a floating-point value to a specified digit or power of ten using symmetric arithmetic rounding.<section end=short />

Call [[System.Math.SimpleRoundTo|SimpleRoundTo]] to round <code>AValue</code> to a specified power of ten.

<code>ADigit</code> indicates the power of ten to which you want <code>AValue</code> rounded. It can be any value in the range from –37 through 37.

[[System.Math.SimpleRoundTo|SimpleRoundTo]] returns the nearest value that has the specified power of ten. In case <code>AValue</code> is exactly in the middle of the two nearest values that have the specified power of ten (above and below), this function returns:
* The value toward plus infinity if <code>AValue</code> is positive.
* The value toward minus infinity if <code>AValue</code> is negative and the FPU rounding mode is '''not''' set to <code>rmUp</code>.

<blockquote>'''Note:''' The result of this function depends on the current FPU rounding mode. You can change the FPU rounding mode using the [[System.Math.SetRoundMode|SetRoundMode]] function.</blockquote>

The following examples illustrate the results of [[System.Math.SimpleRoundTo|SimpleRoundTo]]: 

{|
!
Expression
!
Value
|-
| 
<code>SimpleRoundTo(1234567, 3)</code>
| align="right" |
1235000
|-
| 
<code>SimpleRoundTo(1.234, -2)</code>
| align="right" | 
1.23
|-
| 
<code>SimpleRoundTo(1.235, -2)</code>
| align="right" | 
1.24
|-
| 
<code>SimpleRoundTo(-1.235, -2)</code>
| align="right" | 
-1.23 or -1.24 (depending on the current FPU rounding mode)
|}

To round in "Banker's mode", use [[System.Math.RoundTo]].

===See Also===

* [[System.Round]]
* [[System.Math.RoundTo]]
* [[rad_en:Mathematical Routines|Mathematical Routines]]


[[Category:API Documentation]]
[[Category:Floating-Point]]

<!--End API Documentation-->