Skip to content

Commit fc5f40f

Browse files
FilipTothFilipToth
authored
Add docs remarks for IsRealNumber handling of infinities (#10565)
1 parent 76b6f0e commit fc5f40f

File tree

5 files changed

+10
-0
lines changed

5 files changed

+10
-0
lines changed

‎xml/System.Numerics/INumberBase`1.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -758,6 +758,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%
758758
759759
This function returns `true` for a complex number `a + bi` where `b` is zero.
760760
761+
This function checks values against the extended real number line, thus returns `true` for positive and negative infinity.
762+
761763
]]></format>
762764
</remarks>
763765
</Docs>

‎xml/System.Runtime.InteropServices/NFloat.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2372,6 +2372,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%
23722372

23732373
This function returns `true` for a complex number `a + bi` where `b` is zero.
23742374

2375+
This function checks values against the extended real number line, thus returns `true` for <xref:System.Runtime.InteropServices.NFloat.PositiveInfinity> and <xref:System.Runtime.InteropServices.NFloat.NegativeInfinity>.
2376+
23752377
]]></format>
23762378
</remarks>
23772379
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />

‎xml/System/Double.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3112,6 +3112,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%
31123112

31133113
This function returns `true` for a complex number `a + bi` where `b` is zero.
31143114

3115+
This function checks values against the extended real number line, thus returns `true` for <xref:System.Double.PositiveInfinity> and <xref:System.Double.NegativeInfinity>.
3116+
31153117
]]></format>
31163118
</remarks>
31173119
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />

‎xml/System/Half.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2318,6 +2318,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%
23182318
23192319
This function returns `true` for a complex number `a + bi` where `b` is zero.
23202320
2321+
This function checks values against the extended real number line, thus returns `true` for <xref:System.Half.PositiveInfinity> and <xref:System.Half.NegativeInfinity>.
2322+
23212323
]]></format>
23222324
</remarks>
23232325
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />

‎xml/System/Single.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3129,6 +3129,8 @@ A return value of `false` does not imply that <xref:System.Numerics.INumberBase%
31293129

31303130
This function returns `true` for a complex number `a + bi` where `b` is zero.
31313131

3132+
This function checks values against the extended real number line, thus returns `true` for <xref:System.Single.PositiveInfinity> and <xref:System.Single.NegativeInfinity>.
3133+
31323134
]]></format>
31333135
</remarks>
31343136
<inheritdoc cref="M:System.Numerics.INumberBase`1.IsRealNumber(`0)" />

0 commit comments

Comments
 (0)