<param name="value">A 64-bit signed integer.</param>
</member>
<member name="M:System.Numerics.BigInteger.#ctor(System.ReadOnlySpan{System.Byte},System.Boolean,System.Boolean)">
- <summary>Initializes a new instance of the <see cref="T:System.Numerics.BigInteger" /> structure using the values in a read-only span of bytes, and optionally indicating the signing encoding and the endianness byte order.</summary>
- <param name="value">A read-only span of bytes representing the big integer.</param>
- <param name="isUnsigned">
- <see langword="true" /> to indicate <paramref name="value" /> uses unsigned encoding; otherwise, <see langword="false" /> (the default value).</param>
- <param name="isBigEndian">
- <see langword="true" /> to indicate <paramref name="value" /> is in big-endian byte order; otherwise, <see langword="false" /> (the default value).</param>
+ <param name="value" />
+ <param name="isUnsigned" />
+ <param name="isBigEndian" />
</member>
<member name="M:System.Numerics.BigInteger.#ctor(System.Single)">
<summary>Initializes a new instance of the <see cref="T:System.Numerics.BigInteger" /> structure using a single-precision floating-point value.</summary>
<summary>Compares two <see cref="T:System.Numerics.BigInteger" /> values and returns an integer that indicates whether the first value is less than, equal to, or greater than the second value.</summary>
<param name="left">The first value to compare.</param>
<param name="right">The second value to compare.</param>
- <returns>A signed integer that indicates the relative values of <paramref name="left" /> and <paramref name="right" />, as shown in the following table.
+ <returns>A signed integer that indicates the relative values of <paramref name="left" /> and <paramref name="right" />, as shown in the following table.
+ Value
+
+ Condition
+
+ Less than zero
+
+ <paramref name="left" /> is less than <paramref name="right" />.
- <list type="table"><listheader><term> Value</term><description> Condition</description></listheader><item><term> Less than zero</term><description><paramref name="left" /> is less than <paramref name="right" />.</description></item><item><term> Zero</term><description><paramref name="left" /> equals <paramref name="right" />.</description></item><item><term> Greater than zero</term><description><paramref name="left" /> is greater than <paramref name="right" />.</description></item></list></returns>
+ Zero
+
+ <paramref name="left" /> equals <paramref name="right" />.
+
+ Greater than zero
+
+ <paramref name="left" /> is greater than <paramref name="right" />.</returns>
</member>
<member name="M:System.Numerics.BigInteger.CompareTo(System.Int64)">
<summary>Compares this instance to a signed 64-bit integer and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the signed 64-bit integer.</summary>
<param name="other">The signed 64-bit integer to compare.</param>
- <returns>A signed integer value that indicates the relationship of this instance to <paramref name="other" />, as shown in the following table.
+ <returns>A signed integer value that indicates the relationship of this instance to <paramref name="other" />, as shown in the following table.
+ Return value
+
+ Description
- <list type="table"><listheader><term> Return value</term><description> Description</description></listheader><item><term> Less than zero</term><description> The current instance is less than <paramref name="other" />.</description></item><item><term> Zero</term><description> The current instance equals <paramref name="other" />.</description></item><item><term> Greater than zero</term><description> The current instance is greater than <paramref name="other" />.</description></item></list></returns>
+ Less than zero
+
+ The current instance is less than <paramref name="other" />.
+
+ Zero
+
+ The current instance equals <paramref name="other" />.
+
+ Greater than zero
+
+ The current instance is greater than <paramref name="other" />.</returns>
</member>
<member name="M:System.Numerics.BigInteger.CompareTo(System.Numerics.BigInteger)">
<summary>Compares this instance to a second <see cref="T:System.Numerics.BigInteger" /> and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object.</summary>
<param name="other">The object to compare.</param>
- <returns>A signed integer value that indicates the relationship of this instance to <paramref name="other" />, as shown in the following table.
+ <returns>A signed integer value that indicates the relationship of this instance to <paramref name="other" />, as shown in the following table.
+ Return value
+
+ Description
+
+ Less than zero
+
+ The current instance is less than <paramref name="other" />.
- <list type="table"><listheader><term> Return value</term><description> Description</description></listheader><item><term> Less than zero</term><description> The current instance is less than <paramref name="other" />.</description></item><item><term> Zero</term><description> The current instance equals <paramref name="other" />.</description></item><item><term> Greater than zero</term><description> The current instance is greater than <paramref name="other" />.</description></item></list></returns>
+ Zero
+
+ The current instance equals <paramref name="other" />.
+
+ Greater than zero
+
+ The current instance is greater than <paramref name="other" />.</returns>
</member>
<member name="M:System.Numerics.BigInteger.CompareTo(System.Object)">
<summary>Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object.</summary>
<param name="obj">The object to compare.</param>
+ <returns>A signed integer that indicates the relationship of the current instance to the <paramref name="obj" /> parameter, as shown in the following table.
+ Return value
+
+ Description
+
+ Less than zero
+
+ The current instance is less than <paramref name="obj" />.
+
+ Zero
+
+ The current instance equals <paramref name="obj" />.
+
+ Greater than zero
+
+ The current instance is greater than <paramref name="obj" />, or the <paramref name="obj" /> parameter is <see langword="null" />.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="obj" /> is not a <see cref="T:System.Numerics.BigInteger" />.</exception>
- <returns>A signed integer that indicates the relationship of the current instance to the <paramref name="obj" /> parameter, as shown in the following table.
-
- <list type="table"><listheader><term> Return value</term><description> Description</description></listheader><item><term> Less than zero</term><description> The current instance is less than <paramref name="obj" />.</description></item><item><term> Zero</term><description> The current instance equals <paramref name="obj" />.</description></item><item><term> Greater than zero</term><description> The current instance is greater than <paramref name="obj" />, or the <paramref name="obj" /> parameter is <see langword="null" />.</description></item></list></returns>
</member>
<member name="M:System.Numerics.BigInteger.CompareTo(System.UInt64)">
<summary>Compares this instance to an unsigned 64-bit integer and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the unsigned 64-bit integer.</summary>
<param name="other">The unsigned 64-bit integer to compare.</param>
<returns>A signed integer that indicates the relative value of this instance and <paramref name="other" />, as shown in the following table.
- <list type="table"><listheader><term>Return value</term><description>Description</description></listheader><item><term>Less than zero</term><description>The current instance is less than <paramref name="other" />.</description></item><item><term>Zero</term><description>The current instance equals <paramref name="other" />.</description></item><item><term>Greater than zero</term><description>The current instance is greater than <paramref name="other" />.</description></item></list></returns>
+ Return value
+
+ Description
+
+ Less than zero
+
+ The current instance is less than <paramref name="other" />.
+
+ Zero
+
+ The current instance equals <paramref name="other" />.
+
+ Greater than zero
+
+ The current instance is greater than <paramref name="other" />.</returns>
</member>
<member name="M:System.Numerics.BigInteger.Divide(System.Numerics.BigInteger,System.Numerics.BigInteger)">
<summary>Divides one <see cref="T:System.Numerics.BigInteger" /> value by another and returns the result.</summary>
<param name="dividend">The value to be divided.</param>
<param name="divisor">The value to divide by.</param>
+ <returns>The quotient of the division.</returns>
<exception cref="T:System.DivideByZeroException">
<paramref name="divisor" /> is 0 (zero).</exception>
- <returns>The quotient of the division.</returns>
</member>
<member name="M:System.Numerics.BigInteger.DivRem(System.Numerics.BigInteger,System.Numerics.BigInteger,System.Numerics.BigInteger@)">
<summary>Divides one <see cref="T:System.Numerics.BigInteger" /> value by another, returns the result, and returns the remainder in an output parameter.</summary>
<param name="dividend">The value to be divided.</param>
<param name="divisor">The value to divide by.</param>
<param name="remainder">When this method returns, contains a <see cref="T:System.Numerics.BigInteger" /> value that represents the remainder from the division. This parameter is passed uninitialized.</param>
+ <returns>The quotient of the division.</returns>
<exception cref="T:System.DivideByZeroException">
<paramref name="divisor" /> is 0 (zero).</exception>
- <returns>The quotient of the division.</returns>
</member>
<member name="M:System.Numerics.BigInteger.Equals(System.Int64)">
<summary>Returns a value that indicates whether the current instance and a signed 64-bit integer have the same value.</summary>
<returns>
<see langword="true" /> if the current instance and the unsigned 64-bit integer have the same value; otherwise, <see langword="false" />.</returns>
</member>
- <member name="M:System.Numerics.BigInteger.GetBitLength">
- <summary>Gets the number of bits required for shortest two's complement representation of the current instance without the sign bit.</summary>
- <returns>The minimum non-negative number of bits in two's complement notation without the sign bit.</returns>
- </member>
<member name="M:System.Numerics.BigInteger.GetByteCount(System.Boolean)">
<summary>Gets the number of bytes that will be output by <see cref="M:System.Numerics.BigInteger.ToByteArray(System.Boolean,System.Boolean)" /> and <see cref="M:System.Numerics.BigInteger.TryWriteBytes(System.Span{System.Byte},System.Int32@,System.Boolean,System.Boolean)" />.</summary>
<param name="isUnsigned">
<param name="right">The second value.</param>
<returns>The greatest common divisor of <paramref name="left" /> and <paramref name="right" />.</returns>
</member>
+ <member name="P:System.Numerics.BigInteger.IsEven">
+ <summary>Indicates whether the value of the current <see cref="T:System.Numerics.BigInteger" /> object is an even number.</summary>
+ <returns>
+ <see langword="true" /> if the value of the <see cref="T:System.Numerics.BigInteger" /> object is an even number; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Numerics.BigInteger.IsOne">
+ <summary>Indicates whether the value of the current <see cref="T:System.Numerics.BigInteger" /> object is <see cref="P:System.Numerics.BigInteger.One" />.</summary>
+ <returns>
+ <see langword="true" /> if the value of the <see cref="T:System.Numerics.BigInteger" /> object is <see cref="P:System.Numerics.BigInteger.One" />; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Numerics.BigInteger.IsPowerOfTwo">
+ <summary>Indicates whether the value of the current <see cref="T:System.Numerics.BigInteger" /> object is a power of two.</summary>
+ <returns>
+ <see langword="true" /> if the value of the <see cref="T:System.Numerics.BigInteger" /> object is a power of two; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Numerics.BigInteger.IsZero">
+ <summary>Indicates whether the value of the current <see cref="T:System.Numerics.BigInteger" /> object is <see cref="P:System.Numerics.BigInteger.Zero" />.</summary>
+ <returns>
+ <see langword="true" /> if the value of the <see cref="T:System.Numerics.BigInteger" /> object is <see cref="P:System.Numerics.BigInteger.Zero" />; otherwise, <see langword="false" />.</returns>
+ </member>
<member name="M:System.Numerics.BigInteger.Log(System.Numerics.BigInteger)">
<summary>Returns the natural (base <see langword="e" />) logarithm of a specified number.</summary>
<param name="value">The number whose logarithm is to be found.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">The natural log of <paramref name="value" /> is out of range of the <see cref="T:System.Double" /> data type.</exception>
<returns>The natural (base <see langword="e" />) logarithm of <paramref name="value" />, as shown in the table in the Remarks section.</returns>
+ <exception cref="T:System.ArgumentOutOfRangeException">The natural log of <paramref name="value" /> is out of range of the <see cref="T:System.Double" /> data type.</exception>
</member>
<member name="M:System.Numerics.BigInteger.Log(System.Numerics.BigInteger,System.Double)">
<summary>Returns the logarithm of a specified number in a specified base.</summary>
<param name="value">A number whose logarithm is to be found.</param>
<param name="baseValue">The base of the logarithm.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">The log of <paramref name="value" /> is out of range of the <see cref="T:System.Double" /> data type.</exception>
<returns>The base <paramref name="baseValue" /> logarithm of <paramref name="value" />, as shown in the table in the Remarks section.</returns>
+ <exception cref="T:System.ArgumentOutOfRangeException">The log of <paramref name="value" /> is out of range of the <see cref="T:System.Double" /> data type.</exception>
</member>
<member name="M:System.Numerics.BigInteger.Log10(System.Numerics.BigInteger)">
<summary>Returns the base 10 logarithm of a specified number.</summary>
<param name="value">A number whose logarithm is to be found.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">The base 10 log of <paramref name="value" /> is out of range of the <see cref="T:System.Double" /> data type.</exception>
<returns>The base 10 logarithm of <paramref name="value" />, as shown in the table in the Remarks section.</returns>
+ <exception cref="T:System.ArgumentOutOfRangeException">The base 10 log of <paramref name="value" /> is out of range of the <see cref="T:System.Double" /> data type.</exception>
</member>
<member name="M:System.Numerics.BigInteger.Max(System.Numerics.BigInteger,System.Numerics.BigInteger)">
<summary>Returns the larger of two <see cref="T:System.Numerics.BigInteger" /> values.</summary>
<param name="right">The second value to compare.</param>
<returns>The <paramref name="left" /> or <paramref name="right" /> parameter, whichever is smaller.</returns>
</member>
+ <member name="P:System.Numerics.BigInteger.MinusOne">
+ <summary>Gets a value that represents the number negative one (-1).</summary>
+ <returns>An integer whose value is negative one (-1).</returns>
+ </member>
<member name="M:System.Numerics.BigInteger.ModPow(System.Numerics.BigInteger,System.Numerics.BigInteger,System.Numerics.BigInteger)">
<summary>Performs modulus division on a number raised to the power of another number.</summary>
<param name="value">The number to raise to the <paramref name="exponent" /> power.</param>
<param name="exponent">The exponent to raise <paramref name="value" /> by.</param>
<param name="modulus">The number by which to divide <paramref name="value" /> raised to the <paramref name="exponent" /> power.</param>
+ <returns>The remainder after dividing <paramref name="value" />exponent by <paramref name="modulus" />.</returns>
<exception cref="T:System.DivideByZeroException">
<paramref name="modulus" /> is zero.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="exponent" /> is negative.</exception>
- <returns>The remainder after dividing <paramref name="value" />exponent by <paramref name="modulus" />.</returns>
</member>
<member name="M:System.Numerics.BigInteger.Multiply(System.Numerics.BigInteger,System.Numerics.BigInteger)">
<summary>Returns the product of two <see cref="T:System.Numerics.BigInteger" /> values.</summary>
<param name="value">The value to negate.</param>
<returns>The result of the <paramref name="value" /> parameter multiplied by negative one (-1).</returns>
</member>
+ <member name="P:System.Numerics.BigInteger.One">
+ <summary>Gets a value that represents the number one (1).</summary>
+ <returns>An object whose value is one (1).</returns>
+ </member>
<member name="M:System.Numerics.BigInteger.op_Addition(System.Numerics.BigInteger,System.Numerics.BigInteger)">
<summary>Adds the values of two specified <see cref="T:System.Numerics.BigInteger" /> objects.</summary>
<param name="left">The first value to add.</param>
<summary>Divides a specified <see cref="T:System.Numerics.BigInteger" /> value by another specified <see cref="T:System.Numerics.BigInteger" /> value by using integer division.</summary>
<param name="dividend">The value to be divided.</param>
<param name="divisor">The value to divide by.</param>
+ <returns>The integral result of the division.</returns>
<exception cref="T:System.DivideByZeroException">
<paramref name="divisor" /> is 0 (zero).</exception>
- <returns>The integral result of the division.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Equality(System.Int64,System.Numerics.BigInteger)">
<summary>Returns a value that indicates whether a signed long integer value and a <see cref="T:System.Numerics.BigInteger" /> value are equal.</summary>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Double)~System.Numerics.BigInteger">
<summary>Defines an explicit conversion of a <see cref="T:System.Double" /> value to a <see cref="T:System.Numerics.BigInteger" /> value.</summary>
<param name="value">The value to convert to a <see cref="T:System.Numerics.BigInteger" />.</param>
+ <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.OverflowException">
<paramref name="value" /> is <see cref="F:System.Double.NaN" />, <see cref="F:System.Double.PositiveInfinity" />, or <see cref="F:System.Double.NegativeInfinity" />.</exception>
- <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Numerics.BigInteger)~System.Byte">
<summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to an unsigned byte value.</summary>
<param name="value">The value to convert to a <see cref="T:System.Byte" />.</param>
+ <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.OverflowException">
<paramref name="value" /> is less than <see cref="F:System.Byte.MinValue" /> or greater than <see cref="F:System.Byte.MaxValue" />.</exception>
- <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Numerics.BigInteger)~System.Decimal">
<summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to a <see cref="T:System.Decimal" /> value.</summary>
<param name="value">The value to convert to a <see cref="T:System.Decimal" />.</param>
+ <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.OverflowException">
<paramref name="value" /> is less than <see cref="F:System.Decimal.MinValue" /> or greater than <see cref="F:System.Decimal.MaxValue" />.</exception>
- <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Numerics.BigInteger)~System.Double">
<summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to a <see cref="T:System.Double" /> value.</summary>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Numerics.BigInteger)~System.Int16">
<summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to a 16-bit signed integer value.</summary>
<param name="value">The value to convert to a 16-bit signed integer.</param>
+ <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.OverflowException">
<paramref name="value" /> is less than <see cref="F:System.Int16.MinValue" /> or is greater than <see cref="F:System.Int16.MaxValue" />.</exception>
- <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Numerics.BigInteger)~System.Int32">
<summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to a 32-bit signed integer value.</summary>
<param name="value">The value to convert to a 32-bit signed integer.</param>
+ <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.OverflowException">
<paramref name="value" /> is less than <see cref="F:System.Int32.MinValue" /> or is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Numerics.BigInteger)~System.Int64">
<summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to a 64-bit signed integer value.</summary>
<param name="value">The value to convert to a 64-bit signed integer.</param>
+ <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.OverflowException">
<paramref name="value" /> is less than <see cref="F:System.Int64.MinValue" /> or is greater than <see cref="F:System.Int64.MaxValue" />.</exception>
- <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Numerics.BigInteger)~System.SByte">
- <summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to a signed 8-bit value.
-
- This API is not CLS-compliant. The compliant alternative is <see cref="T:System.Int16" />.</summary>
+ <summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to a signed 8-bit value.
+This API is not CLS-compliant. The compliant alternative is <see cref="T:System.Int16" />.</summary>
<param name="value">The value to convert to a signed 8-bit value.</param>
+ <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.OverflowException">
<paramref name="value" /> is less than <see cref="F:System.SByte.MinValue" /> or is greater than <see cref="F:System.SByte.MaxValue" />.</exception>
- <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Numerics.BigInteger)~System.Single">
<summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to a single-precision floating-point value.</summary>
<returns>An object that contains the closest possible representation of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Numerics.BigInteger)~System.UInt16">
- <summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to an unsigned 16-bit integer value.
-
- This API is not CLS-compliant. The compliant alternative is <see cref="T:System.Int32" />.</summary>
+ <summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to an unsigned 16-bit integer value.
+This API is not CLS-compliant. The compliant alternative is <see cref="T:System.Int32" />.</summary>
<param name="value">The value to convert to an unsigned 16-bit integer.</param>
+ <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.OverflowException">
<paramref name="value" /> is less than <see cref="F:System.UInt16.MinValue" /> or is greater than <see cref="F:System.UInt16.MaxValue" />.</exception>
- <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Numerics.BigInteger)~System.UInt32">
- <summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to an unsigned 32-bit integer value.
-
- This API is not CLS-compliant. The compliant alternative is <see cref="T:System.Int64" />.</summary>
+ <summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to an unsigned 32-bit integer value.
+This API is not CLS-compliant. The compliant alternative is <see cref="T:System.Int64" />.</summary>
<param name="value">The value to convert to an unsigned 32-bit integer.</param>
+ <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.OverflowException">
<paramref name="value" /> is less than <see cref="F:System.UInt32.MinValue" /> or is greater than <see cref="F:System.UInt32.MaxValue" />.</exception>
- <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Numerics.BigInteger)~System.UInt64">
- <summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to an unsigned 64-bit integer value.
-
- This API is not CLS-compliant. The compliant alternative is <see cref="T:System.Double" />.</summary>
+ <summary>Defines an explicit conversion of a <see cref="T:System.Numerics.BigInteger" /> object to an unsigned 64-bit integer value.
+This API is not CLS-compliant. The compliant alternative is <see cref="T:System.Double" />.</summary>
<param name="value">The value to convert to an unsigned 64-bit integer.</param>
+ <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.OverflowException">
<paramref name="value" /> is less than <see cref="F:System.UInt64.MinValue" /> or is greater than <see cref="F:System.UInt64.MaxValue" />.</exception>
- <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Explicit(System.Single)~System.Numerics.BigInteger">
<summary>Defines an explicit conversion of a <see cref="T:System.Single" /> value to a <see cref="T:System.Numerics.BigInteger" /> value.</summary>
<param name="value">The value to convert to a <see cref="T:System.Numerics.BigInteger" />.</param>
+ <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.OverflowException">
<paramref name="value" /> is <see cref="F:System.Single.NaN" />, <see cref="F:System.Single.PositiveInfinity" />, or <see cref="F:System.Single.NegativeInfinity" />.</exception>
- <returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_GreaterThan(System.Int64,System.Numerics.BigInteger)">
<summary>Returns a value that indicates whether a 64-bit signed integer is greater than a <see cref="T:System.Numerics.BigInteger" /> value.</summary>
<returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Implicit(System.SByte)~System.Numerics.BigInteger">
- <summary>Defines an implicit conversion of an 8-bit signed integer to a <see cref="T:System.Numerics.BigInteger" /> value.
-
- This API is not CLS-compliant. The compliant alternative is <see cref="M:System.Numerics.BigInteger.#ctor(System.Int32)" />.</summary>
+ <summary>Defines an implicit conversion of an 8-bit signed integer to a <see cref="T:System.Numerics.BigInteger" /> value.
+This API is not CLS-compliant. The compliant alternative is <see cref="M:System.Numerics.BigInteger.#ctor(System.Int32)" />.</summary>
<param name="value">The value to convert to a <see cref="T:System.Numerics.BigInteger" />.</param>
<returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Implicit(System.UInt16)~System.Numerics.BigInteger">
- <summary>Defines an implicit conversion of a 16-bit unsigned integer to a <see cref="T:System.Numerics.BigInteger" /> value.
-
- This API is not CLS-compliant. The compliant alternative is <see cref="M:System.Numerics.BigInteger.op_Implicit(System.Int32)~System.Numerics.BigInteger" />.</summary>
+ <summary>Defines an implicit conversion of a 16-bit unsigned integer to a <see cref="T:System.Numerics.BigInteger" /> value.
+This API is not CLS-compliant. The compliant alternative is <see cref="M:System.Numerics.BigInteger.op_Implicit(System.Int32)~System.Numerics.BigInteger" />.</summary>
<param name="value">The value to convert to a <see cref="T:System.Numerics.BigInteger" />.</param>
<returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Implicit(System.UInt32)~System.Numerics.BigInteger">
- <summary>Defines an implicit conversion of a 32-bit unsigned integer to a <see cref="T:System.Numerics.BigInteger" /> value.
-
- This API is not CLS-compliant. The compliant alternative is <see cref="M:System.Numerics.BigInteger.op_Implicit(System.Int64)~System.Numerics.BigInteger" />.</summary>
+ <summary>Defines an implicit conversion of a 32-bit unsigned integer to a <see cref="T:System.Numerics.BigInteger" /> value.
+This API is not CLS-compliant. The compliant alternative is <see cref="M:System.Numerics.BigInteger.op_Implicit(System.Int64)~System.Numerics.BigInteger" />.</summary>
<param name="value">The value to convert to a <see cref="T:System.Numerics.BigInteger" />.</param>
<returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Implicit(System.UInt64)~System.Numerics.BigInteger">
- <summary>Defines an implicit conversion of a 64-bit unsigned integer to a <see cref="T:System.Numerics.BigInteger" /> value.
-
- This API is not CLS-compliant. The compliant alternative is <see cref="T:System.Double" />.</summary>
+ <summary>Defines an implicit conversion of a 64-bit unsigned integer to a <see cref="T:System.Numerics.BigInteger" /> value.
+This API is not CLS-compliant. The compliant alternative is <see cref="T:System.Double" />.</summary>
<param name="value">The value to convert to a <see cref="T:System.Numerics.BigInteger" />.</param>
<returns>An object that contains the value of the <paramref name="value" /> parameter.</returns>
</member>
<summary>Returns the remainder that results from division with two specified <see cref="T:System.Numerics.BigInteger" /> values.</summary>
<param name="dividend">The value to be divided.</param>
<param name="divisor">The value to divide by.</param>
+ <returns>The remainder that results from the division.</returns>
<exception cref="T:System.DivideByZeroException">
<paramref name="divisor" /> is 0 (zero).</exception>
- <returns>The remainder that results from the division.</returns>
</member>
<member name="M:System.Numerics.BigInteger.op_Multiply(System.Numerics.BigInteger,System.Numerics.BigInteger)">
<summary>Multiplies two specified <see cref="T:System.Numerics.BigInteger" /> values.</summary>
<returns>The value of the <paramref name="value" /> operand.</returns>
</member>
<member name="M:System.Numerics.BigInteger.Parse(System.ReadOnlySpan{System.Char},System.Globalization.NumberStyles,System.IFormatProvider)">
- <summary>Converts the representation of a number, contained in the specified read-only span of characters, in a specified style to its <see cref="T:System.Numerics.BigInteger" /> equivalent.</summary>
- <param name="value">A read-only span of characters that contains the number to convert.</param>
- <param name="style">A bitwise combination of the enumeration values that specify the permitted format of <paramref name="value" />.</param>
- <param name="provider">An object that provides culture-specific formatting information about <paramref name="value" />.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="style" /> is not a <see cref="T:System.Globalization.NumberStyles" /> value.
-
- -or-
-
- <paramref name="style" /> includes the <see cref="F:System.Globalization.NumberStyles.AllowHexSpecifier" /> or <see cref="F:System.Globalization.NumberStyles.HexNumber" /> flag along with another value.</exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="value" /> is <see langword="null" />.</exception>
- <exception cref="T:System.FormatException">
- <paramref name="value" /> does not comply with the input pattern specified by <paramref name="style" />.</exception>
- <returns>A value that is equivalent to the number specified in the <paramref name="value" /> parameter.</returns>
+ <param name="value" />
+ <param name="style" />
+ <param name="provider" />
</member>
<member name="M:System.Numerics.BigInteger.Parse(System.String)">
<summary>Converts the string representation of a number to its <see cref="T:System.Numerics.BigInteger" /> equivalent.</summary>
<param name="value">A string that contains the number to convert.</param>
+ <returns>A value that is equivalent to the number specified in the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="value" /> is not in the correct format.</exception>
- <returns>A value that is equivalent to the number specified in the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.Parse(System.String,System.Globalization.NumberStyles)">
<summary>Converts the string representation of a number in a specified style to its <see cref="T:System.Numerics.BigInteger" /> equivalent.</summary>
<param name="value">A string that contains a number to convert.</param>
<param name="style">A bitwise combination of the enumeration values that specify the permitted format of <paramref name="value" />.</param>
+ <returns>A value that is equivalent to the number specified in the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.ArgumentException">
- <paramref name="style" /> is not a <see cref="T:System.Globalization.NumberStyles" /> value.
-
- -or-
-
- <paramref name="style" /> includes the <see cref="F:System.Globalization.NumberStyles.AllowHexSpecifier" /> or <see cref="F:System.Globalization.NumberStyles.HexNumber" /> flag along with another value.</exception>
+ <paramref name="style" /> is not a <see cref="T:System.Globalization.NumberStyles" /> value.
+-or-
+<paramref name="style" /> includes the <see cref="F:System.Globalization.NumberStyles.AllowHexSpecifier" /> or <see cref="F:System.Globalization.NumberStyles.HexNumber" /> flag along with another value.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="value" /> does not comply with the input pattern specified by <see cref="T:System.Globalization.NumberStyles" />.</exception>
- <returns>A value that is equivalent to the number specified in the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.Parse(System.String,System.Globalization.NumberStyles,System.IFormatProvider)">
<summary>Converts the string representation of a number in a specified style and culture-specific format to its <see cref="T:System.Numerics.BigInteger" /> equivalent.</summary>
<param name="value">A string that contains a number to convert.</param>
<param name="style">A bitwise combination of the enumeration values that specify the permitted format of <paramref name="value" />.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="value" />.</param>
+ <returns>A value that is equivalent to the number specified in the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.ArgumentException">
- <paramref name="style" /> is not a <see cref="T:System.Globalization.NumberStyles" /> value.
-
- -or-
-
- <paramref name="style" /> includes the <see cref="F:System.Globalization.NumberStyles.AllowHexSpecifier" /> or <see cref="F:System.Globalization.NumberStyles.HexNumber" /> flag along with another value.</exception>
+ <paramref name="style" /> is not a <see cref="T:System.Globalization.NumberStyles" /> value.
+-or-
+<paramref name="style" /> includes the <see cref="F:System.Globalization.NumberStyles.AllowHexSpecifier" /> or <see cref="F:System.Globalization.NumberStyles.HexNumber" /> flag along with another value.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="value" /> does not comply with the input pattern specified by <paramref name="style" />.</exception>
- <returns>A value that is equivalent to the number specified in the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.Parse(System.String,System.IFormatProvider)">
<summary>Converts the string representation of a number in a specified culture-specific format to its <see cref="T:System.Numerics.BigInteger" /> equivalent.</summary>
<param name="value">A string that contains a number to convert.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="value" />.</param>
+ <returns>A value that is equivalent to the number specified in the <paramref name="value" /> parameter.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="value" /> is not in the correct format.</exception>
- <returns>A value that is equivalent to the number specified in the <paramref name="value" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.Pow(System.Numerics.BigInteger,System.Int32)">
<summary>Raises a <see cref="T:System.Numerics.BigInteger" /> value to the power of a specified value.</summary>
<param name="value">The number to raise to the <paramref name="exponent" /> power.</param>
<param name="exponent">The exponent to raise <paramref name="value" /> by.</param>
+ <returns>The result of raising <paramref name="value" /> to the <paramref name="exponent" /> power.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="exponent" /> is negative.</exception>
- <returns>The result of raising <paramref name="value" /> to the <paramref name="exponent" /> power.</returns>
</member>
<member name="M:System.Numerics.BigInteger.Remainder(System.Numerics.BigInteger,System.Numerics.BigInteger)">
<summary>Performs integer division on two <see cref="T:System.Numerics.BigInteger" /> values and returns the remainder.</summary>
<param name="dividend">The value to be divided.</param>
<param name="divisor">The value to divide by.</param>
+ <returns>The remainder after dividing <paramref name="dividend" /> by <paramref name="divisor" />.</returns>
<exception cref="T:System.DivideByZeroException">
<paramref name="divisor" /> is 0 (zero).</exception>
- <returns>The remainder after dividing <paramref name="dividend" /> by <paramref name="divisor" />.</returns>
+ </member>
+ <member name="P:System.Numerics.BigInteger.Sign">
+ <summary>Gets a number that indicates the sign (negative, positive, or zero) of the current <see cref="T:System.Numerics.BigInteger" /> object.</summary>
+ <returns>A number that indicates the sign of the <see cref="T:System.Numerics.BigInteger" /> object, as shown in the following table.
+ Number
+
+ Description
+
+ -1
+
+ The value of this object is negative.
+
+ 0
+
+ The value of this object is 0 (zero).
+
+ 1
+
+ The value of this object is positive.</returns>
</member>
<member name="M:System.Numerics.BigInteger.Subtract(System.Numerics.BigInteger,System.Numerics.BigInteger)">
<summary>Subtracts one <see cref="T:System.Numerics.BigInteger" /> value from another and returns the result.</summary>
<see langword="true" /> to use unsigned encoding; otherwise, <see langword="false" />.</param>
<param name="isBigEndian">
<see langword="true" /> to write the bytes in a big-endian byte order; otherwise, <see langword="false" />.</param>
- <exception cref="T:System.OverflowException">If <paramref name="isUnsigned" /> is <see langword="true" /> and <see cref="P:System.Numerics.BigInteger.Sign" /> is negative.</exception>
<returns>The value of the current <see cref="T:System.Numerics.BigInteger" /> object converted to an array of bytes.</returns>
+ <exception cref="T:System.OverflowException">If <paramref name="isUnsigned" /> is <see langword="true" /> and <see cref="P:System.Numerics.BigInteger.Sign" /> is negative.</exception>
</member>
<member name="M:System.Numerics.BigInteger.ToString">
<summary>Converts the numeric value of the current <see cref="T:System.Numerics.BigInteger" /> object to its equivalent string representation.</summary>
<member name="M:System.Numerics.BigInteger.ToString(System.String)">
<summary>Converts the numeric value of the current <see cref="T:System.Numerics.BigInteger" /> object to its equivalent string representation by using the specified format.</summary>
<param name="format">A standard or custom numeric format string.</param>
+ <returns>The string representation of the current <see cref="T:System.Numerics.BigInteger" /> value in the format specified by the <paramref name="format" /> parameter.</returns>
<exception cref="T:System.FormatException">
<paramref name="format" /> is not a valid format string.</exception>
- <returns>The string representation of the current <see cref="T:System.Numerics.BigInteger" /> value in the format specified by the <paramref name="format" /> parameter.</returns>
</member>
<member name="M:System.Numerics.BigInteger.ToString(System.String,System.IFormatProvider)">
<summary>Converts the numeric value of the current <see cref="T:System.Numerics.BigInteger" /> object to its equivalent string representation by using the specified format and culture-specific format information.</summary>
<param name="format">A standard or custom numeric format string.</param>
<param name="provider">An object that supplies culture-specific formatting information.</param>
+ <returns>The string representation of the current <see cref="T:System.Numerics.BigInteger" /> value as specified by the <paramref name="format" /> and <paramref name="provider" /> parameters.</returns>
<exception cref="T:System.FormatException">
<paramref name="format" /> is not a valid format string.</exception>
- <returns>The string representation of the current <see cref="T:System.Numerics.BigInteger" /> value as specified by the <paramref name="format" /> and <paramref name="provider" /> parameters.</returns>
</member>
<member name="M:System.Numerics.BigInteger.TryFormat(System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)">
- <summary>Formats this big integer instance into a span of characters.</summary>
- <param name="destination">The span of characters into which this instance will be written.</param>
- <param name="charsWritten">When the method returns, contains the length of the span in number of characters.</param>
- <param name="format">A read-only span of characters that specifies the format for the formatting operation.</param>
- <param name="provider">An object that supplies culture-specific formatting information about <paramref name="value" />.</param>
- <returns>
- <see langword="true" /> if the formatting operation succeeds; <see langword="false" /> otherwise.</returns>
+ <param name="destination" />
+ <param name="charsWritten" />
+ <param name="format" />
+ <param name="provider" />
</member>
<member name="M:System.Numerics.BigInteger.TryParse(System.ReadOnlySpan{System.Char},System.Globalization.NumberStyles,System.IFormatProvider,System.Numerics.BigInteger@)">
- <summary>Tries to convert the string representation of a number to its <see cref="T:System.Numerics.BigInteger" /> equivalent, and returns a value that indicates whether the conversion succeeded.</summary>
- <param name="value">The representation of a number as a read-only span of characters.</param>
- <param name="style">A bitwise combination of enumeration values that indicates the style elements that can be present in <paramref name="value" />. A typical value to specify is <see cref="F:System.Globalization.NumberStyles.Integer" />.</param>
- <param name="provider">An object that supplies culture-specific formatting information about <paramref name="value" />.</param>
- <param name="result">When this method returns, contains the <see cref="T:System.Numerics.BigInteger" /> equivalent to the number that is contained in <paramref name="value" />, or <see cref="P:System.Numerics.BigInteger.Zero" /> if the conversion failed. The conversion fails if the <paramref name="value" /> parameter is an empty character span or is not in a format that is compliant with <paramref name="style" />. This parameter is passed uninitialized.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="style" /> is not a <see cref="T:System.Globalization.NumberStyles" /> value.
-
- -or-
-
- <paramref name="style" /> includes the <see cref="F:System.Globalization.NumberStyles.AllowHexSpecifier" /> or <see cref="F:System.Globalization.NumberStyles.HexNumber" /> flag along with another value.</exception>
- <returns>
- <see langword="true" /> if <paramref name="value" /> was converted successfully; otherwise, <see langword="false" />.</returns>
+ <param name="value" />
+ <param name="style" />
+ <param name="provider" />
+ <param name="result" />
</member>
<member name="M:System.Numerics.BigInteger.TryParse(System.ReadOnlySpan{System.Char},System.Numerics.BigInteger@)">
- <summary>Tries to convert the representation of a number contained in the specified read-only character span, to its <see cref="T:System.Numerics.BigInteger" /> equivalent, and returns a value that indicates whether the conversion succeeded.</summary>
- <param name="value">The representation of a number as a read-only span of characters.</param>
- <param name="result">When this method returns, contains the <see cref="T:System.Numerics.BigInteger" /> equivalent to the number that is contained in <paramref name="value" />, or zero (0) if the conversion fails. The conversion fails if the <paramref name="value" /> parameter is an empty character span or is not of the correct format. This parameter is passed uninitialized.</param>
- <returns>
- <see langword="true" /> if <paramref name="value" /> was converted successfully; otherwise, <see langword="false" />.</returns>
+ <param name="value" />
+ <param name="result" />
</member>
<member name="M:System.Numerics.BigInteger.TryParse(System.String,System.Globalization.NumberStyles,System.IFormatProvider,System.Numerics.BigInteger@)">
<summary>Tries to convert the string representation of a number in a specified style and culture-specific format to its <see cref="T:System.Numerics.BigInteger" /> equivalent, and returns a value that indicates whether the conversion succeeded.</summary>
<param name="style">A bitwise combination of enumeration values that indicates the style elements that can be present in <paramref name="value" />. A typical value to specify is <see cref="F:System.Globalization.NumberStyles.Integer" />.</param>
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="value" />.</param>
<param name="result">When this method returns, contains the <see cref="T:System.Numerics.BigInteger" /> equivalent to the number that is contained in <paramref name="value" />, or <see cref="P:System.Numerics.BigInteger.Zero" /> if the conversion failed. The conversion fails if the <paramref name="value" /> parameter is <see langword="null" /> or is not in a format that is compliant with <paramref name="style" />. This parameter is passed uninitialized.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="style" /> is not a <see cref="T:System.Globalization.NumberStyles" /> value.
-
- -or-
-
- <paramref name="style" /> includes the <see cref="F:System.Globalization.NumberStyles.AllowHexSpecifier" /> or <see cref="F:System.Globalization.NumberStyles.HexNumber" /> flag along with another value.</exception>
<returns>
<see langword="true" /> if the <paramref name="value" /> parameter was converted successfully; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentException">
+ <paramref name="style" /> is not a <see cref="T:System.Globalization.NumberStyles" /> value.
+-or-
+<paramref name="style" /> includes the <see cref="F:System.Globalization.NumberStyles.AllowHexSpecifier" /> or <see cref="F:System.Globalization.NumberStyles.HexNumber" /> flag along with another value.</exception>
</member>
<member name="M:System.Numerics.BigInteger.TryParse(System.String,System.Numerics.BigInteger@)">
<summary>Tries to convert the string representation of a number to its <see cref="T:System.Numerics.BigInteger" /> equivalent, and returns a value that indicates whether the conversion succeeded.</summary>
<param name="value">The string representation of a number.</param>
<param name="result">When this method returns, contains the <see cref="T:System.Numerics.BigInteger" /> equivalent to the number that is contained in <paramref name="value" />, or zero (0) if the conversion fails. The conversion fails if the <paramref name="value" /> parameter is <see langword="null" /> or is not of the correct format. This parameter is passed uninitialized.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="value" /> is <see langword="null" />.</exception>
<returns>
<see langword="true" /> if <paramref name="value" /> was converted successfully; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentNullException">
+ <paramref name="value" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Numerics.BigInteger.TryWriteBytes(System.Span{System.Byte},System.Int32@,System.Boolean,System.Boolean)">
<summary>Copies the value of this <see cref="T:System.Numerics.BigInteger" /> as little-endian twos-complement bytes, using the fewest number of bytes possible. If the value is zero, outputs one byte whose element is 0x00.</summary>
<see langword="true" /> to use unsigned encoding; otherwise, <see langword="false" />.</param>
<param name="isBigEndian">
<see langword="true" /> to write the bytes in a big-endian byte order; otherwise, <see langword="false" />.</param>
- <exception cref="T:System.OverflowException">
- <paramref name="isUnsigned" /> is <see langword="true" /> and <see cref="P:System.Numerics.BigInteger.Sign" /> is negative.</exception>
<returns>
<see langword="true" /> if the bytes fit in <paramref name="destination" />; <see langword="false" /> if not all bytes could be written due to lack of space.</returns>
- </member>
- <member name="P:System.Numerics.BigInteger.IsEven">
- <summary>Indicates whether the value of the current <see cref="T:System.Numerics.BigInteger" /> object is an even number.</summary>
- <returns>
- <see langword="true" /> if the value of the <see cref="T:System.Numerics.BigInteger" /> object is an even number; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Numerics.BigInteger.IsOne">
- <summary>Indicates whether the value of the current <see cref="T:System.Numerics.BigInteger" /> object is <see cref="P:System.Numerics.BigInteger.One" />.</summary>
- <returns>
- <see langword="true" /> if the value of the <see cref="T:System.Numerics.BigInteger" /> object is <see cref="P:System.Numerics.BigInteger.One" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Numerics.BigInteger.IsPowerOfTwo">
- <summary>Indicates whether the value of the current <see cref="T:System.Numerics.BigInteger" /> object is a power of two.</summary>
- <returns>
- <see langword="true" /> if the value of the <see cref="T:System.Numerics.BigInteger" /> object is a power of two; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Numerics.BigInteger.IsZero">
- <summary>Indicates whether the value of the current <see cref="T:System.Numerics.BigInteger" /> object is <see cref="P:System.Numerics.BigInteger.Zero" />.</summary>
- <returns>
- <see langword="true" /> if the value of the <see cref="T:System.Numerics.BigInteger" /> object is <see cref="P:System.Numerics.BigInteger.Zero" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Numerics.BigInteger.MinusOne">
- <summary>Gets a value that represents the number negative one (-1).</summary>
- <returns>An integer whose value is negative one (-1).</returns>
- </member>
- <member name="P:System.Numerics.BigInteger.One">
- <summary>Gets a value that represents the number one (1).</summary>
- <returns>An object whose value is one (1).</returns>
- </member>
- <member name="P:System.Numerics.BigInteger.Sign">
- <summary>Gets a number that indicates the sign (negative, positive, or zero) of the current <see cref="T:System.Numerics.BigInteger" /> object.</summary>
- <returns>A number that indicates the sign of the <see cref="T:System.Numerics.BigInteger" /> object, as shown in the following table.
-
- <list type="table"><listheader><term> Number</term><description> Description</description></listheader><item><term> -1</term><description> The value of this object is negative.</description></item><item><term> 0</term><description> The value of this object is 0 (zero).</description></item><item><term> 1</term><description> The value of this object is positive.</description></item></list></returns>
+ <exception cref="T:System.OverflowException">
+ <paramref name="isUnsigned" /> is <see langword="true" /> and <see cref="P:System.Numerics.BigInteger.Sign" /> is negative.</exception>
</member>
<member name="P:System.Numerics.BigInteger.Zero">
<summary>Gets a value that represents the number 0 (zero).</summary>
<member name="T:System.Numerics.Complex">
<summary>Represents a complex number.</summary>
</member>
- <member name="F:System.Numerics.Complex.ImaginaryOne">
- <summary>Returns a new <see cref="T:System.Numerics.Complex" /> instance with a real number equal to zero and an imaginary number equal to one.</summary>
- </member>
- <member name="F:System.Numerics.Complex.Infinity">
- <summary>Represents infinity as a complex number.</summary>
- </member>
- <member name="F:System.Numerics.Complex.NaN">
- <summary>Represents a complex instance that is not a number (NaN).</summary>
- </member>
- <member name="F:System.Numerics.Complex.One">
- <summary>Returns a new <see cref="T:System.Numerics.Complex" /> instance with a real number equal to one and an imaginary number equal to zero.</summary>
- </member>
- <member name="F:System.Numerics.Complex.Zero">
- <summary>Returns a new <see cref="T:System.Numerics.Complex" /> instance with a real number equal to zero and an imaginary number equal to zero.</summary>
- </member>
<member name="M:System.Numerics.Complex.#ctor(System.Double,System.Double)">
<summary>Initializes a new instance of the <see cref="T:System.Numerics.Complex" /> structure using the specified real and imaginary values.</summary>
<param name="real">The real part of the complex number.</param>
<summary>Returns the hash code for the current <see cref="T:System.Numerics.Complex" /> object.</summary>
<returns>A 32-bit signed integer hash code.</returns>
</member>
+ <member name="P:System.Numerics.Complex.Imaginary">
+ <summary>Gets the imaginary component of the current <see cref="T:System.Numerics.Complex" /> object.</summary>
+ <returns>The imaginary component of a complex number.</returns>
+ </member>
+ <member name="F:System.Numerics.Complex.ImaginaryOne">
+ <summary>Returns a new <see cref="T:System.Numerics.Complex" /> instance with a real number equal to zero and an imaginary number equal to one.</summary>
+ </member>
+ <member name="F:System.Numerics.Complex.Infinity">
+ <summary>Represents infinity as a complex number.</summary>
+ </member>
<member name="M:System.Numerics.Complex.IsFinite(System.Numerics.Complex)">
<summary>Determines whether the specified complex number is finite.</summary>
<param name="value">A complex number.</param>
<param name="value">A complex number.</param>
<returns>The base-10 logarithm of <paramref name="value" />.</returns>
</member>
+ <member name="P:System.Numerics.Complex.Magnitude">
+ <summary>Gets the magnitude (or absolute value) of a complex number.</summary>
+ <returns>The magnitude of the current instance.</returns>
+ </member>
<member name="M:System.Numerics.Complex.Multiply(System.Double,System.Numerics.Complex)">
<summary>Returns the product of a double-precision real number and a complex number.</summary>
<param name="left">The double-precision real number to multiply.</param>
<param name="right">The second complex number to multiply.</param>
<returns>The product of the <paramref name="left" /> and <paramref name="right" /> parameters.</returns>
</member>
+ <member name="F:System.Numerics.Complex.NaN">
+ <summary>Represents a complex instance that is not a number (NaN).</summary>
+ </member>
<member name="M:System.Numerics.Complex.Negate(System.Numerics.Complex)">
<summary>Returns the additive inverse of a specified complex number.</summary>
<param name="value">A complex number.</param>
<returns>The result of the <see cref="P:System.Numerics.Complex.Real" /> and <see cref="P:System.Numerics.Complex.Imaginary" /> components of the <paramref name="value" /> parameter multiplied by -1.</returns>
</member>
+ <member name="F:System.Numerics.Complex.One">
+ <summary>Returns a new <see cref="T:System.Numerics.Complex" /> instance with a real number equal to one and an imaginary number equal to zero.</summary>
+ </member>
<member name="M:System.Numerics.Complex.op_Addition(System.Double,System.Numerics.Complex)">
<summary>Adds a double-precision real number to a complex number.</summary>
<param name="left">The double-precision real value to add.</param>
<returns>An object that contains the value of the <paramref name="value" /> parameter as its real part and zero as its imaginary part.</returns>
</member>
<member name="M:System.Numerics.Complex.op_Implicit(System.SByte)~System.Numerics.Complex">
- <summary>Defines an implicit conversion of a signed byte to a complex number.
-
+ <summary>Defines an implicit conversion of a signed byte to a complex number.
This API is not CLS-compliant.</summary>
<param name="value">The value to convert to a complex number.</param>
<returns>An object that contains the value of the <paramref name="value" /> parameter as its real part and zero as its imaginary part.</returns>
<returns>An object that contains the value of the <paramref name="value" /> parameter as its real part and zero as its imaginary part.</returns>
</member>
<member name="M:System.Numerics.Complex.op_Implicit(System.UInt16)~System.Numerics.Complex">
- <summary>Defines an implicit conversion of a 16-bit unsigned integer to a complex number.
-
+ <summary>Defines an implicit conversion of a 16-bit unsigned integer to a complex number.
This API is not CLS-compliant.</summary>
<param name="value">The value to convert to a complex number.</param>
<returns>An object that contains the value of the <paramref name="value" /> parameter as its real part and zero as its imaginary part.</returns>
</member>
<member name="M:System.Numerics.Complex.op_Implicit(System.UInt32)~System.Numerics.Complex">
- <summary>Defines an implicit conversion of a 32-bit unsigned integer to a complex number.
-
+ <summary>Defines an implicit conversion of a 32-bit unsigned integer to a complex number.
This API is not CLS-compliant.</summary>
<param name="value">The value to convert to a complex number.</param>
<returns>An object that contains the value of the <paramref name="value" /> parameter as its real part and zero as its imaginary part.</returns>
</member>
<member name="M:System.Numerics.Complex.op_Implicit(System.UInt64)~System.Numerics.Complex">
- <summary>Defines an implicit conversion of a 64-bit unsigned integer to a complex number.
-
+ <summary>Defines an implicit conversion of a 64-bit unsigned integer to a complex number.
This API is not CLS-compliant.</summary>
<param name="value">The value to convert to a complex number.</param>
<returns>An object that contains the value of the <paramref name="value" /> parameter as its real part and zero as its imaginary part.</returns>
<param name="value">The value to negate.</param>
<returns>The result of the <see cref="P:System.Numerics.Complex.Real" /> and <see cref="P:System.Numerics.Complex.Imaginary" /> components of the <paramref name="value" /> parameter multiplied by -1.</returns>
</member>
+ <member name="P:System.Numerics.Complex.Phase">
+ <summary>Gets the phase of a complex number.</summary>
+ <returns>The phase of a complex number, in radians.</returns>
+ </member>
<member name="M:System.Numerics.Complex.Pow(System.Numerics.Complex,System.Double)">
<summary>Returns a specified complex number raised to a power specified by a double-precision floating-point number.</summary>
<param name="value">A complex number to be raised to a power.</param>
<param name="power">A complex number that specifies a power.</param>
<returns>The complex number <paramref name="value" /> raised to the power <paramref name="power" />.</returns>
</member>
+ <member name="P:System.Numerics.Complex.Real">
+ <summary>Gets the real component of the current <see cref="T:System.Numerics.Complex" /> object.</summary>
+ <returns>The real component of a complex number.</returns>
+ </member>
<member name="M:System.Numerics.Complex.Reciprocal(System.Numerics.Complex)">
<summary>Returns the multiplicative inverse of a complex number.</summary>
<param name="value">A complex number.</param>
<member name="M:System.Numerics.Complex.ToString(System.String)">
<summary>Converts the value of the current complex number to its equivalent string representation in Cartesian form by using the specified format for its real and imaginary parts.</summary>
<param name="format">A standard or custom numeric format string.</param>
+ <returns>The string representation of the current instance in Cartesian form.</returns>
<exception cref="T:System.FormatException">
<paramref name="format" /> is not a valid format string.</exception>
- <returns>The string representation of the current instance in Cartesian form.</returns>
</member>
<member name="M:System.Numerics.Complex.ToString(System.String,System.IFormatProvider)">
<summary>Converts the value of the current complex number to its equivalent string representation in Cartesian form by using the specified format and culture-specific format information for its real and imaginary parts.</summary>
<param name="format">A standard or custom numeric format string.</param>
<param name="provider">An object that supplies culture-specific formatting information.</param>
+ <returns>The string representation of the current instance in Cartesian form, as specified by <paramref name="format" /> and <paramref name="provider" />.</returns>
<exception cref="T:System.FormatException">
<paramref name="format" /> is not a valid format string.</exception>
- <returns>The string representation of the current instance in Cartesian form, as specified by <paramref name="format" /> and <paramref name="provider" />.</returns>
</member>
- <member name="P:System.Numerics.Complex.Imaginary">
- <summary>Gets the imaginary component of the current <see cref="T:System.Numerics.Complex" /> object.</summary>
- <returns>The imaginary component of a complex number.</returns>
- </member>
- <member name="P:System.Numerics.Complex.Magnitude">
- <summary>Gets the magnitude (or absolute value) of a complex number.</summary>
- <returns>The magnitude of the current instance.</returns>
- </member>
- <member name="P:System.Numerics.Complex.Phase">
- <summary>Gets the phase of a complex number.</summary>
- <returns>The phase of a complex number, in radians.</returns>
- </member>
- <member name="P:System.Numerics.Complex.Real">
- <summary>Gets the real component of the current <see cref="T:System.Numerics.Complex" /> object.</summary>
- <returns>The real component of a complex number.</returns>
+ <member name="F:System.Numerics.Complex.Zero">
+ <summary>Returns a new <see cref="T:System.Numerics.Complex" /> instance with a real number equal to zero and an imaginary number equal to zero.</summary>
</member>
</members>
</doc>
\ No newline at end of file
projects / platform / core / csapi / tizenfx.git / blobdiff