Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify INumber.IsPositive and INumber.IsNegative documentation #80026

Merged
merged 2 commits into from
Jan 8, 2023
Merged

Clarify INumber.IsPositive and INumber.IsNegative documentation #80026

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c11a8e9
Clarify INumber.IsPositive and INumber.IsNegative documentation
JochCool Dec 28, 2022
30c0ecf
Add clarification for negative zero
JochCool Dec 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 12 additions & 6 deletions src/libraries/System.Private.CoreLib/src/System/Numerics/INumberBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,10 +166,13 @@ static virtual TSelf CreateTruncating<TOther>(TOther value)
/// <returns><c>true</c> if <paramref name="value" /> is NaN; otherwise, <c>false</c>.</returns>
static abstract bool IsNaN(TSelf value);

/// <summary>Determines if a value is negative.</summary>
/// <summary>Determines if a value represents a negative real number.</summary>
/// <param name="value">The value to be checked.</param>
/// <returns><c>true</c> if <paramref name="value" /> is negative; otherwise, <c>false</c>.</returns>
/// <remarks>This function returning <c>false</c> does not imply that <see cref="IsPositive(TSelf)" /> will return <c>true</c>. A complex number, <c>a + bi</c> for non-zero <c>b</c>, is not positive nor negative</remarks>
/// <returns><c>true</c> if <paramref name="value" /> represents negative zero or a negative real number; otherwise, <c>false</c>.</returns>
/// <remarks>
/// <para>If this type has signed zero, then <c>-0</c> is also considered negative.</para>
/// <para>This function returning <c>false</c> does not imply that <see cref="IsPositive(TSelf)" /> will return <c>true</c>. A complex number, <c>a + bi</c> for non-zero <c>b</c>, is not positive nor negative</para>
/// </remarks>
static abstract bool IsNegative(TSelf value);

/// <summary>Determines if a value is negative infinity.</summary>
Expand All @@ -191,10 +194,13 @@ static virtual TSelf CreateTruncating<TOther>(TOther value)
/// </remarks>
static abstract bool IsOddInteger(TSelf value);

/// <summary>Determines if a value is positive.</summary>
/// <summary>Determines if a value represents zero or a positive real number.</summary>
/// <param name="value">The value to be checked.</param>
/// <returns><c>true</c> if <paramref name="value" /> is positive; otherwise, <c>false</c>.</returns>
/// <remarks>This function returning <c>false</c> does not imply that <see cref="IsNegative(TSelf)" /> will return <c>true</c>. A complex number, <c>a + bi</c> for non-zero <c>b</c>, is not positive nor negative</remarks>
/// <returns><c>true</c> if <paramref name="value" /> represents (positive) zero or a positive real number; otherwise, <c>false</c>.</returns>
/// <remarks>
/// <para>If this type has signed zero, then <c>-0</c> is not considered positive, but <c>+0</c> is.</para>
/// <para>This function returning <c>false</c> does not imply that <see cref="IsNegative(TSelf)" /> will return <c>true</c>. A complex number, <c>a + bi</c> for non-zero <c>b</c>, is not positive nor negative</para>
/// </remarks>
static abstract bool IsPositive(TSelf value);

/// <summary>Determines if a value is positive infinity.</summary>
Expand Down