Skip to content

Commit 71abadb

Browse files
Updating the Math and MathF docs to indicate which functions may vary across OS or architecture (#5264)
1 parent d19373f commit 71abadb

File tree

2 files changed

+116
-4
lines changed

2 files changed

+116
-4
lines changed

xml/System/Math.xml

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -616,6 +616,8 @@
616616
## Remarks
617617
Multiply the return value by 180/<xref:System.Math.PI?displayProperty=nameWithType> to convert from radians to degrees.
618618
619+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
620+
619621
620622
621623
## Examples
@@ -673,6 +675,8 @@
673675
## Remarks
674676
Multiply the return value by 180/<xref:System.Math.PI?displayProperty=nameWithType> to convert from radians to degrees.
675677
678+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
679+
676680
]]></format>
677681
</remarks>
678682
</Docs>
@@ -738,6 +742,8 @@
738742
739743
Multiply the return value by 180/<xref:System.Math.PI?displayProperty=nameWithType> to convert from radians to degrees.
740744
745+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
746+
741747
742748
743749
## Examples
@@ -795,6 +801,8 @@
795801
## Remarks
796802
Multiply the return value by 180/<xref:System.Math.PI?displayProperty=nameWithType> to convert from radians to degrees.
797803
804+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
805+
798806
]]></format>
799807
</remarks>
800808
</Docs>
@@ -860,6 +868,8 @@
860868
861869
Multiply the return value by 180/<xref:System.Math.PI?displayProperty=nameWithType> to convert from radians to degrees.
862870
871+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
872+
863873
864874
865875
## Examples
@@ -952,6 +962,8 @@
952962
## Remarks
953963
The return value is the angle in the Cartesian plane formed by the x-axis, and a vector starting from the origin, (0,0), and terminating at the point, (x,y).
954964
965+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
966+
955967
956968
957969
## Examples
@@ -1009,6 +1021,8 @@
10091021
## Remarks
10101022
Multiply the return value by 180/<xref:System.Math.PI?displayProperty=nameWithType> to convert from radians to degrees.
10111023
1024+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
1025+
10121026
]]></format>
10131027
</remarks>
10141028
</Docs>
@@ -1277,7 +1291,14 @@
12771291
-or-
12781292

12791293
<see cref="F:System.Double.NaN" /> if <paramref name="x" /> equals <see cref="F:System.Double.NaN" />.</returns>
1280-
<remarks>To be added.</remarks>
1294+
<remarks>
1295+
<format type="text/markdown"><![CDATA[
1296+
1297+
## Remarks
1298+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
1299+
1300+
]]></format>
1301+
</remarks>
12811302
<altmember cref="M:System.Math.Pow(System.Double,System.Double)" />
12821303
</Docs>
12831304
</Member>
@@ -2123,7 +2144,7 @@ Dim i2 As Integer = CInt(Math.Ceiling(d2)) ' Result: 7969
21232144
## Remarks
21242145
The angle, `d`, must be in radians. Multiply by <xref:System.Math.PI?displayProperty=nameWithType>/180 to convert degrees to radians.
21252146
2126-
Acceptable values of `d` range from approximately -9223372036854775295 to approximately 9223372036854775295. For values outside this range, the <xref:System.Math.Cos%2A> method returns `d` unchanged rather than throwing an exception.
2147+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
21272148
21282149
21292150
@@ -2193,6 +2214,8 @@ Dim i2 As Integer = CInt(Math.Ceiling(d2)) ' Result: 7969
21932214
## Remarks
21942215
The angle, `value`, must be in radians. Multiply by <xref:System.Math.PI?displayProperty=nameWithType>/180 to convert degrees to radians.
21952216
2217+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
2218+
21962219
21972220
21982221
## Examples
@@ -2473,6 +2496,8 @@ Dim i2 As Integer = CInt(Math.Ceiling(d2)) ' Result: 7969
24732496
24742497
<xref:System.Math.Exp%2A> is the inverse of <xref:System.Math.Log%2A>.
24752498
2499+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
2500+
24762501
24772502
24782503
## Examples
@@ -2833,6 +2858,8 @@ Remainder = (Math.Abs(dividend) - (Math.Abs(divisor) *
28332858
## Remarks
28342859
Parameter `x` is specified as a base 10 number.
28352860
2861+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
2862+
28362863
]]></format>
28372864
</remarks>
28382865
</Docs>
@@ -2916,6 +2943,10 @@ Remainder = (Math.Abs(dividend) - (Math.Abs(divisor) *
29162943
## Remarks
29172944
Parameter `d` is specified as a base 10 number.
29182945
2946+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
2947+
2948+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
2949+
29192950
29202951
29212952
## Examples
@@ -3066,6 +3097,11 @@ Remainder = (Math.Abs(dividend) - (Math.Abs(divisor) *
30663097
<remarks>
30673098
<format type="text/markdown"><![CDATA[
30683099
3100+
## Remarks
3101+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
3102+
3103+
3104+
30693105
## Examples
30703106
The following example uses <xref:System.Math.Log%2A> to evaluate certain logarithmic identities for selected values.
30713107
@@ -3146,6 +3182,8 @@ Remainder = (Math.Abs(dividend) - (Math.Abs(divisor) *
31463182
## Remarks
31473183
Parameter `d` is specified as a base 10 number.
31483184
3185+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
3186+
31493187
31503188
31513189
## Examples
@@ -3211,6 +3249,8 @@ Remainder = (Math.Abs(dividend) - (Math.Abs(divisor) *
32113249
## Remarks
32123250
Parameter `x` is specified as a base 10 number.
32133251
3252+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
3253+
32143254
]]></format>
32153255
</remarks>
32163256
</Docs>
@@ -4783,6 +4823,8 @@ The following example demonstrates how to use the <xref:System.Math.Min%2A> meth
47834823
|`x` = `PositiveInfinity`; `y` < 0.|0|
47844824
|`x` = `PositiveInfinity`; `y` > 0.|`PositiveInfinity`|
47854825
4826+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
4827+
47864828
47874829
47884830
## Examples
@@ -5616,7 +5658,14 @@ The following example demonstrates how to use the <xref:System.Math.Round%28Syst
56165658
<param name="n">A 32-bit integer that specifies the power.</param>
56175659
<summary>Returns x * 2^n computed efficiently.</summary>
56185660
<returns>x * 2^n computed efficiently.</returns>
5619-
<remarks>To be added.</remarks>
5661+
<remarks>
5662+
<format type="text/markdown"><![CDATA[
5663+
5664+
## Remarks
5665+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
5666+
5667+
]]></format>
5668+
</remarks>
56205669
</Docs>
56215670
</Member>
56225671
<MemberGroup MemberName="Sign">
@@ -6261,7 +6310,7 @@ The following example demonstrates how to use the <xref:System.Math.Round%28Syst
62616310
## Remarks
62626311
The angle, `a`, must be in radians. Multiply by <xref:System.Math.PI?displayProperty=nameWithType>/180 to convert degrees to radians.
62636312
6264-
Acceptable values of `a` range from approximately -9223372036854775295 to approximately 9223372036854775295. For values outside of this range, the <xref:System.Math.Sin%2A> method returns `a` unchanged rather than throwing an exception.
6313+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
62656314
62666315
62676316
@@ -6331,6 +6380,8 @@ The following example demonstrates how to use the <xref:System.Math.Round%28Syst
63316380
## Remarks
63326381
The angle, `value`, must be in radians. Multiply by <xref:System.Math.PI?displayProperty=nameWithType>/180 to convert degrees to radians.
63336382
6383+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
6384+
63346385
63356386
63366387
## Examples
@@ -6479,6 +6530,8 @@ The following example demonstrates how to use the <xref:System.Math.Round%28Syst
64796530
## Remarks
64806531
The angle, `a`, must be in radians. Multiply by <xref:System.Math.PI?displayProperty=nameWithType>/180 to convert degrees to radians.
64816532
6533+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
6534+
64826535
64836536
64846537
## Examples
@@ -6547,6 +6600,8 @@ The following example demonstrates how to use the <xref:System.Math.Round%28Syst
65476600
## Remarks
65486601
The angle, `value`, must be in radians. Multiply by <xref:System.Math.PI?displayProperty=nameWithType>/180 to convert degrees to radians.
65496602
6603+
This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.
6604+
65506605
65516606
65526607
## Examples

0 commit comments

Comments
 (0)