oliverbooth/X10D
oliverbooth/X10D
1
0
Fork 0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-10 02:45:41 +00:00
Code Issues

Add Sqrt and ComplexSqrt for float/double

Browse Source
This commit is contained in:
Oliver Booth 2022-04-21 12:06:18 +01:00
parent b3a4342c77
commit 6f96ab795c
No known key found for this signature in database
GPG Key ID: 32A00B35503AF634
2 changed files with 107 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
X10D/src/DoubleExtensions/DoubleExtensions.cs
View File

@ -1,4 +1,5 @@
using System.Diagnostics.Contracts;
using System.Diagnostics.Contracts;
using System.Numerics;
using System.Runtime.CompilerServices;
namespace X10D;
@ -8,6 +9,19 @@ namespace X10D;
/// </summary>
public static class DoubleExtensions
{
/// <summary>
/// Returns the complex square root of this double-precision floating-point number.
/// </summary>
/// <param name="value">The number whose square root is to be found.</param>
/// <returns>The square root of <paramref name="value" />.</returns>
/// <seealso cref="Sqrt" />
[Pure]
[MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)]
public static Complex ComplexSqrt(this double value)
{
return Complex.Sqrt(value);
}
/// <summary>
/// Converts the current angle in degrees to its equivalent represented in radians.
/// </summary>
@ -161,4 +175,43 @@ public static class DoubleExtensions
{
return Math.Sign(value);
}
/// <summary>
/// Returns the square root of this double-precision floating-point number.
/// </summary>
/// <param name="value">The number whose square root is to be found.</param>
/// <returns>
/// One of the values in the following table.
///
/// <list type="table">
/// <listheader>
/// <term>Return value</term>
/// <description>Meaning</description>
/// </listheader>
///
/// <item>
/// <term>The positive square root of <paramref name="value" />.</term>
/// <description><paramref name="value" /> is greater than or equal to 0.</description>
/// </item>
/// <item>
/// <term><see cref="double.NaN" /></term>
/// <description><paramref name="value" /> is equal to <see cref="double.NaN" /> or is negative.</description>
/// </item>
/// <item>
/// <term><see cref="double.PositiveInfinity" /></term>
/// <description><paramref name="value" /> is equal to <see cref="double.PositiveInfinity" />.</description>
/// </item>
/// </list>
/// </returns>
/// <remarks>
/// For negative input, this method returns <see cref="double.NaN" />. To receive a complex number, see
/// <see cref="ComplexSqrt" />.
/// </remarks>
/// <seealso cref="ComplexSqrt" />
[Pure]
[MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)]
public static double Sqrt(this double value)
{
return Math.Sqrt(value);
}
}

53
X10D/src/SingleExtensions/SingleExtensions.cs
View File

@ -1,4 +1,5 @@
using System.Diagnostics.Contracts;
using System.Numerics;
using System.Runtime.CompilerServices;
namespace X10D;
@ -8,6 +9,19 @@ namespace X10D;
/// </summary>
public static class SingleExtensions
{
/// <summary>
/// Returns the complex square root of this single-precision floating-point number.
/// </summary>
/// <param name="value">The number whose square root is to be found.</param>
/// <returns>The square root of <paramref name="value" />.</returns>
/// <seealso cref="Sqrt" />
[Pure]
[MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)]
public static Complex ComplexSqrt(this float value)
{
return Complex.Sqrt(value);
}
/// <summary>
/// Converts the current angle in degrees to its equivalent represented in radians.
/// </summary>
@ -160,4 +174,43 @@ public static class SingleExtensions
{
return MathF.Sign(value);
}
/// <summary>
/// Returns the square root of this single-precision floating-point number.
/// </summary>
/// <param name="value">The number whose square root is to be found.</param>
/// <returns>
/// One of the values in the following table.
///
/// <list type="table">
/// <listheader>
/// <term>Return value</term>
/// <description>Meaning</description>
/// </listheader>
///
/// <item>
/// <term>The positive square root of <paramref name="value" />.</term>
/// <description><paramref name="value" /> is greater than or equal to 0.</description>
/// </item>
/// <item>
/// <term><see cref="float.NaN" /></term>
/// <description><paramref name="value" /> is equal to <see cref="float.NaN" /> or is negative.</description>
/// </item>
/// <item>
/// <term><see cref="float.PositiveInfinity" /></term>
/// <description><paramref name="value" /> is equal to <see cref="float.PositiveInfinity" />.</description>
/// </item>
/// </list>
/// </returns>
/// <remarks>
/// For negative input, this method returns <see cref="float.NaN" />. To receive a complex number, see
/// <see cref="ComplexSqrt" />.
/// </remarks>
/// <seealso cref="ComplexSqrt" />
[Pure]
[MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)]
public static float Sqrt(this float value)
{
return MathF.Sqrt(value);
}
}