Skip to content

Commit

Permalink
Edit documentation; nonsubstantive code edits
Browse files Browse the repository at this point in the history
  • Loading branch information
peteroupc committed Dec 22, 2024
1 parent 3276bb4 commit 544ef95
Show file tree
Hide file tree
Showing 18 changed files with 44 additions and 44 deletions.
2 changes: 1 addition & 1 deletion Numbers/PeterO/Numbers/EDecimal.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1063,7 +1063,7 @@ public static EDecimal FromEFloat(EFloat bigfloat) {
}
}

/// <summary>Converts a boolean value (true or false) to an
/// <summary>Converts a Boolean value (true or false) to an
/// arbitrary-precision decimal number.</summary>
/// <param name='boolValue'>Either true or false.</param>
/// <returns>The number 1 if <paramref name='boolValue'/> is true;
Expand Down
2 changes: 1 addition & 1 deletion Numbers/PeterO/Numbers/EDecimalExtra.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public static EDecimal FromDecimal(decimal dec) {
dec.ToString(System.Globalization.CultureInfo.InvariantCulture));
}

/// <summary>Converts a boolean value (true or false) to an arbitrary
/// <summary>Converts a Boolean value (true or false) to an arbitrary
/// precision decimal.</summary>
/// <param name='boolValue'>Either true or false.</param>
/// <returns>The number 1 if <paramref name='boolValue'/> is true;
Expand Down
4 changes: 2 additions & 2 deletions Numbers/PeterO/Numbers/EDecimals.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public static EDecimal Int32ToEDecimal(int i32, EContext ec) {
return EDecimal.FromInt32(i32).RoundToPrecision(ec);
}

/// <summary>Converts a boolean value (either true or false) to an
/// <summary>Converts a Boolean value (either true or false) to an
/// arbitrary-precision decimal number.</summary>
/// <param name='b'>Either true or false.</param>
/// <param name='ec'>A context used for rounding the result. Can be
Expand All @@ -43,7 +43,7 @@ public static EDecimal Int32ToEDecimal(int i32, EContext ec) {
public static EDecimal BooleanToEDecimal(bool b, EContext ec) {
// NOTE: Not a miscellaneous operation in the General Decimal
// Arithmetic Specification 1.70, but required since some of the
// miscellaneous operations here return booleans
// miscellaneous operations here return Boolean values
return EDecimal.FromInt32(b ? 1 : 0).RoundToPrecision(ec);
}

Expand Down
2 changes: 1 addition & 1 deletion Numbers/PeterO/Numbers/EFloat.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5095,7 +5095,7 @@ public int ToInt32IfExact() {
return this.IsZero ? ((int)0) : this.ToEIntegerIfExact().ToInt32Checked();
}

/// <summary>Converts a boolean value (either true or false) to an
/// <summary>Converts a Boolean value (either true or false) to an
/// arbitrary-precision binary floating-point number.</summary>
/// <param name='boolValue'>Either true or false.</param>
/// <returns>The number 1 if <paramref name='boolValue'/> is true,
Expand Down
2 changes: 1 addition & 1 deletion Numbers/PeterO/Numbers/EFloatExtra.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Any copyright to this work is released to the Public Domain.

namespace PeterO.Numbers {
public sealed partial class EFloat {
/// <summary>Converts a boolean value (true or false) to an
/// <summary>Converts a Boolean value (true or false) to an
/// arbitrary-precision binary floating-point number.</summary>
/// <param name='boolValue'>Either true or false.</param>
/// <returns>The number 1 if <paramref name='boolValue'/> is true;
Expand Down
4 changes: 2 additions & 2 deletions Numbers/PeterO/Numbers/EFloats.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public static EFloat Int32ToEFloat(int i32, EContext ec) {
return EFloat.FromInt32(i32).RoundToPrecision(ec);
}

/// <summary>Converts a boolean value (either true or false) to an
/// <summary>Converts a Boolean value (either true or false) to an
/// arbitrary-precision binary floating-point number.</summary>
/// <param name='b'>Either true or false.</param>
/// <param name='ec'>A context used for rounding the result. Can be
Expand All @@ -41,7 +41,7 @@ public static EFloat Int32ToEFloat(int i32, EContext ec) {
public static EFloat BooleanToEFloat(bool b, EContext ec) {
// NOTE: Not a miscellaneous operation in the General Decimal
// Arithmetic Specification 1.70, but required since some of the
// miscellaneous operations here return booleans
// miscellaneous operations here return Boolean values
return EFloat.FromInt32(b ? 1 : 0).RoundToPrecision(ec);
}

Expand Down
2 changes: 1 addition & 1 deletion Numbers/PeterO/Numbers/EInteger.cs
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ public static EInteger FromBytes(
new EInteger(newwordCount, newreg, numIsNegative);
}

/// <summary>Converts a boolean value (true or false) to an
/// <summary>Converts a Boolean value (true or false) to an
/// arbitrary-precision integer.</summary>
/// <param name='boolValue'>Either true or false.</param>
/// <returns>The number 1 if <paramref name='boolValue'/> is true;
Expand Down
2 changes: 1 addition & 1 deletion Numbers/PeterO/Numbers/ERational.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2760,7 +2760,7 @@ public int ToInt32IfExact() {
return this.IsZero ? ((int)0) : this.ToEIntegerIfExact().ToInt32Checked();
}

/// <summary>Converts a boolean value (true or false) to an
/// <summary>Converts a Boolean value (true or false) to an
/// arbitrary-precision rational number.</summary>
/// <param name='boolValue'>Either true or false.</param>
/// <returns>The number 1 if <paramref name='boolValue'/> is true;
Expand Down
2 changes: 1 addition & 1 deletion Numbers/PeterO/Numbers/ERationalExtra.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Any copyright to this work is released to the Public Domain.

namespace PeterO.Numbers {
public sealed partial class ERational {
/// <summary>Converts a boolean value (true or false) to an
/// <summary>Converts a Boolean value (true or false) to an
/// arbitrary-precision rational number.</summary>
/// <param name='boolValue'>Either true or false.</param>
/// <returns>1 if <paramref name='boolValue'/> is true; otherwise,
Expand Down
18 changes: 9 additions & 9 deletions Numbers/docs.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2010,7 +2010,7 @@
</doc>
<doc name="M:PeterO.Numbers.EDecimal.FromBoolean(System.Boolean)">

<summary>Converts a boolean value (true or false) to an
<summary>Converts a Boolean value (true or false) to an
arbitrary-precision decimal number.</summary>
<param name='boolValue'>Either true or false.</param>
<returns>The number 1 if <paramref name='boolValue'/> is true;
Expand Down Expand Up @@ -4940,7 +4940,7 @@
</doc>
<doc name="M:PeterO.Numbers.EDecimal.op_Explicit(System.Boolean)~PeterO.Numbers.EDecimal">

<summary>Converts a boolean value (true or false) to an arbitrary
<summary>Converts a Boolean value (true or false) to an arbitrary
precision decimal.</summary>
<param name='boolValue'>Either true or false.</param>
<returns>The number 1 if <paramref name='boolValue'/> is true;
Expand Down Expand Up @@ -5153,7 +5153,7 @@
</doc>
<doc name="M:PeterO.Numbers.EDecimals.BooleanToEDecimal(System.Boolean,PeterO.Numbers.EContext)">

<summary>Converts a boolean value (either true or false) to an
<summary>Converts a Boolean value (either true or false) to an
arbitrary-precision decimal number.</summary>
<param name='b'>Either true or false.</param>
<param name='ec'>A context used for rounding the result. Can be
Expand Down Expand Up @@ -6805,7 +6805,7 @@
</doc>
<doc name="M:PeterO.Numbers.EFloat.FromBoolean(System.Boolean)">

<summary>Converts a boolean value (either true or false) to an
<summary>Converts a Boolean value (either true or false) to an
arbitrary-precision binary floating-point number.</summary>
<param name='boolValue'>Either true or false.</param>
<returns>The number 1 if <paramref name='boolValue'/> is true,
Expand Down Expand Up @@ -9537,7 +9537,7 @@
</doc>
<doc name="M:PeterO.Numbers.EFloat.op_Explicit(System.Boolean)~PeterO.Numbers.EFloat">

<summary>Converts a boolean value (true or false) to an
<summary>Converts a Boolean value (true or false) to an
arbitrary-precision binary floating-point number.</summary>
<param name='boolValue'>Either true or false.</param>
<returns>The number 1 if <paramref name='boolValue'/> is true;
Expand Down Expand Up @@ -9759,7 +9759,7 @@
</doc>
<doc name="M:PeterO.Numbers.EFloats.BooleanToEFloat(System.Boolean,PeterO.Numbers.EContext)">

<summary>Converts a boolean value (either true or false) to an
<summary>Converts a Boolean value (either true or false) to an
arbitrary-precision binary floating-point number.</summary>
<param name='b'>Either true or false.</param>
<param name='ec'>A context used for rounding the result. Can be
Expand Down Expand Up @@ -10747,7 +10747,7 @@
</doc>
<doc name="M:PeterO.Numbers.EInteger.FromBoolean(System.Boolean)">

<summary>Converts a boolean value (true or false) to an
<summary>Converts a Boolean value (true or false) to an
arbitrary-precision integer.</summary>
<param name='boolValue'>Either true or false.</param>
<returns>The number 1 if <paramref name='boolValue'/> is true;
Expand Down Expand Up @@ -13154,7 +13154,7 @@
</doc>
<doc name="M:PeterO.Numbers.ERational.FromBoolean(System.Boolean)">

<summary>Converts a boolean value (true or false) to an
<summary>Converts a Boolean value (true or false) to an
arbitrary-precision rational number.</summary>
<param name='boolValue'>Either true or false.</param>
<returns>The number 1 if <paramref name='boolValue'/> is true;
Expand Down Expand Up @@ -14713,7 +14713,7 @@
</doc>
<doc name="M:PeterO.Numbers.ERational.op_Explicit(System.Boolean)~PeterO.Numbers.ERational">

<summary>Converts a boolean value (true or false) to an
<summary>Converts a Boolean value (true or false) to an
arbitrary-precision rational number.</summary>
<param name='boolValue'>Either true or false.</param>
<returns>1 if <paramref name='boolValue'/> is true; otherwise,
Expand Down
8 changes: 4 additions & 4 deletions docs/PeterO.Numbers.EDecimal.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ The elements described above are in the same order as the order of each bit of e
* <code>[explicit operator float(PeterO.Numbers.EDecimal)](#explicit_operator_float_PeterO_Numbers_EDecimal)</code> - Converts this value to its closest equivalent as a 32-bit floating-point number.
* <code>[explicit operator int(PeterO.Numbers.EDecimal)](#explicit_operator_int_PeterO_Numbers_EDecimal)</code> - Converts an arbitrary-precision decimal number to a 32-bit signed integer if it can fit in a 32-bit signed integer after converting it to an integer by discarding its fractional part.
* <code>[explicit operator long(PeterO.Numbers.EDecimal)](#explicit_operator_long_PeterO_Numbers_EDecimal)</code> - Converts an arbitrary-precision decimal number to a 64-bit signed integer if it can fit in a 64-bit signed integer after converting it to an integer by discarding its fractional part.
* <code>[explicit operator PeterO.Numbers.EDecimal(bool)](#explicit_operator_PeterO_Numbers_EDecimal_bool)</code> - Converts a boolean value (true or false) to an arbitrary precision decimal.
* <code>[explicit operator PeterO.Numbers.EDecimal(bool)](#explicit_operator_PeterO_Numbers_EDecimal_bool)</code> - Converts a Boolean value (true or false) to an arbitrary precision decimal.
* <code>[explicit operator PeterO.Numbers.EInteger(PeterO.Numbers.EDecimal)](#explicit_operator_PeterO_Numbers_EInteger_PeterO_Numbers_EDecimal)</code> - Converts an arbitrary-precision decimal floating-point number to an arbitrary-precision integer.
* <code>[explicit operator sbyte(PeterO.Numbers.EDecimal)](#explicit_operator_sbyte_PeterO_Numbers_EDecimal)</code> - Converts an arbitrary-precision decimal number to an 8-bit signed integer if it can fit in an 8-bit signed integer after converting it to an integer by discarding its fractional part.
* <code>[explicit operator short(PeterO.Numbers.EDecimal)](#explicit_operator_short_PeterO_Numbers_EDecimal)</code> - Converts an arbitrary-precision decimal number to a 16-bit signed integer if it can fit in a 16-bit signed integer after converting it to an integer by discarding its fractional part.
Expand All @@ -222,7 +222,7 @@ The elements described above are in the same order as the order of each bit of e
* <code>[explicit operator ushort(PeterO.Numbers.EDecimal)](#explicit_operator_ushort_PeterO_Numbers_EDecimal)</code> - Converts an arbitrary-precision decimal number to a 16-bit unsigned integer if it can fit in a 16-bit unsigned integer after converting it to an integer by discarding its fractional part.
* <code>[ExpM1(PeterO.Numbers.EContext)](#ExpM1_PeterO_Numbers_EContext)</code> - Finds e (the base of natural logarithms) raised to the power of this object's value, and subtracts the result by 1 and returns the final result, in a way that avoids loss of precision if the true result is very close to 0.
* <code>[Exponent](#Exponent)</code> - Gets this object's exponent.
* <code>[FromBoolean(bool)](#FromBoolean_bool)</code> - Converts a boolean value (true or false) to an arbitrary-precision decimal number.
* <code>[FromBoolean(bool)](#FromBoolean_bool)</code> - Converts a Boolean value (true or false) to an arbitrary-precision decimal number.
* <code>[FromByte(byte)](#FromByte_byte)</code> - Converts a byte (from 0 to 255) to an arbitrary-precision decimal number.
* <code>[FromDecimal(decimal)](#FromDecimal_decimal)</code> - Converts a decimal under the Common Language Infrastructure (see T:PeterO.
* <code>[FromDouble(double)](#FromDouble_double)</code> - Creates an arbitrary-precision decimal number from a 64-bit binary floating-point number.
Expand Down Expand Up @@ -1659,7 +1659,7 @@ Exponential of this object, minus 1. Signals FlagInvalid and returns not-a-numbe
public static PeterO.Numbers.EDecimal FromBoolean(
bool boolValue);

Converts a boolean value (true or false) to an arbitrary-precision decimal number.
Converts a Boolean value (true or false) to an arbitrary-precision decimal number.

<b>Parameters:</b>

Expand Down Expand Up @@ -3428,7 +3428,7 @@ The parameter <i>input</i>
public static explicit operator PeterO.Numbers.EDecimal(
bool boolValue);

Converts a boolean value (true or false) to an arbitrary precision decimal.
Converts a Boolean value (true or false) to an arbitrary precision decimal.

<b>Parameters:</b>

Expand Down
4 changes: 2 additions & 2 deletions docs/PeterO.Numbers.EDecimalExtras.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A class that implements additional operations on arbitrary-precision decimal num

### Member Summary
* <code>[And(PeterO.Numbers.EDecimal, PeterO.Numbers.EDecimal, PeterO.Numbers.EContext)](#And_PeterO_Numbers_EDecimal_PeterO_Numbers_EDecimal_PeterO_Numbers_EContext)</code> - Performs a logical AND operation on two decimal numbers in the form oflogical operands.
* <code>[BooleanToEDecimal(bool, PeterO.Numbers.EContext)](#BooleanToEDecimal_bool_PeterO_Numbers_EContext)</code> - Converts a boolean value (either true or false) to an arbitrary-precision decimal number.
* <code>[BooleanToEDecimal(bool, PeterO.Numbers.EContext)](#BooleanToEDecimal_bool_PeterO_Numbers_EContext)</code> - Converts a Boolean value (either true or false) to an arbitrary-precision decimal number.
* <code>[Canonical(PeterO.Numbers.EDecimal)](#Canonical_PeterO_Numbers_EDecimal)</code> - Returns a canonical version of the given arbitrary-precision number object.
* <code>[CompareTotalMagnitude(PeterO.Numbers.EDecimal, PeterO.Numbers.EDecimal, PeterO.Numbers.EContext)](#CompareTotalMagnitude_PeterO_Numbers_EDecimal_PeterO_Numbers_EDecimal_PeterO_Numbers_EContext)</code> - Compares the absolute values of two arbitrary-precision number objects, imposing a total ordering on all possible values (ignoring their signs).
* <code>[CompareTotal(PeterO.Numbers.EDecimal, PeterO.Numbers.EDecimal, PeterO.Numbers.EContext)](#CompareTotal_PeterO_Numbers_EDecimal_PeterO_Numbers_EDecimal_PeterO_Numbers_EContext)</code> - Compares the values of one arbitrary-precision number object and another object, imposing a total ordering on all possible values.
Expand Down Expand Up @@ -70,7 +70,7 @@ The result of the logical AND operation as a logical operand. Signals an invalid
bool b,
PeterO.Numbers.EContext ec);

Converts a boolean value (either true or false) to an arbitrary-precision decimal number.
Converts a Boolean value (either true or false) to an arbitrary-precision decimal number.

<b>Parameters:</b>

Expand Down
4 changes: 2 additions & 2 deletions docs/PeterO.Numbers.EDecimals.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A class that implements additional operations on arbitrary-precision decimal num

### Member Summary
* <code>[And(PeterO.Numbers.EDecimal, PeterO.Numbers.EDecimal, PeterO.Numbers.EContext)](#And_PeterO_Numbers_EDecimal_PeterO_Numbers_EDecimal_PeterO_Numbers_EContext)</code> - Performs a logical AND operation on two decimal numbers in the form of logical operands.
* <code>[BooleanToEDecimal(bool, PeterO.Numbers.EContext)](#BooleanToEDecimal_bool_PeterO_Numbers_EContext)</code> - Converts a boolean value (either true or false) to an arbitrary-precision decimal number.
* <code>[BooleanToEDecimal(bool, PeterO.Numbers.EContext)](#BooleanToEDecimal_bool_PeterO_Numbers_EContext)</code> - Converts a Boolean value (either true or false) to an arbitrary-precision decimal number.
* <code>[Canonical(PeterO.Numbers.EDecimal)](#Canonical_PeterO_Numbers_EDecimal)</code> - Returns a canonical version of the given arbitrary-precision number object.
* <code>[CompareTotal(PeterO.Numbers.EDecimal, PeterO.Numbers.EDecimal, PeterO.Numbers.EContext)](#CompareTotal_PeterO_Numbers_EDecimal_PeterO_Numbers_EDecimal_PeterO_Numbers_EContext)</code> - Compares the values of one arbitrary-precision number object and another object, imposing a total ordering on all possible values.
* <code>[CompareTotalMagnitude(PeterO.Numbers.EDecimal, PeterO.Numbers.EDecimal, PeterO.Numbers.EContext)](#CompareTotalMagnitude_PeterO_Numbers_EDecimal_PeterO_Numbers_EDecimal_PeterO_Numbers_EContext)</code> - Compares the absolute values of two arbitrary-precision number objects, imposing a total ordering on all possible values (ignoring their signs).
Expand Down Expand Up @@ -70,7 +70,7 @@ The result of the logical AND operation as a logical operand. Signals an invalid
bool b,
PeterO.Numbers.EContext ec);

Converts a boolean value (either true or false) to an arbitrary-precision decimal number.
Converts a Boolean value (either true or false) to an arbitrary-precision decimal number.

<b>Parameters:</b>

Expand Down
Loading

0 comments on commit 544ef95

Please sign in to comment.