| File: System\Numerics\Tensors\netcore\TensorPrimitives.IsComplexNumber.cs | Web Access |
| Project: src\runtime\src\libraries\System.Numerics.Tensors\src\System.Numerics.Tensors.csproj (System.Numerics.Tensors) |
// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. using System.Runtime.Intrinsics; namespace System.Numerics.Tensors { public static partial class TensorPrimitives { /// <summary>Computes for each value in the specified tensor whether it's a complex number.</summary> /// <param name="x">The tensor, represented as a span.</param> /// <param name="destination">The destination tensor, represented as a span.</param> /// <exception cref="ArgumentException">Destination is too short.</exception> /// <exception cref="ArgumentException"><paramref name="x"/> and <paramref name="destination"/> reference overlapping memory locations and do not begin at the same location.</exception> /// <remarks> /// This method effectively computes <c><paramref name="destination" />[i] = <typeparamref name="T"/>.IsComplexNumber(<paramref name="x" />[i])</c>. /// </remarks> public static void IsComplexNumber<T>(ReadOnlySpan<T> x, Span<bool> destination) where T : INumberBase<T> { if (!MayBeComplex<T>()) { if (x.Length > destination.Length) { ThrowHelper.ThrowArgument_DestinationTooShort(); } destination.Slice(0, x.Length).Clear(); return; } InvokeSpanIntoSpan<T, IsComplexNumberOperator<T>>(x, destination); } /// <summary>Computes whether all of the values in the specified tensor are complex numbers.</summary> /// <param name="x">The tensor, represented as a span.</param> /// <returns> /// <see langword="true"/> if all of the values in <paramref name="x"/> are complex numbers; otherwise, <see langword="false"/>. /// If <paramref name="x"/> is empty, <see langword="false"/> is returned. /// </returns> public static bool IsComplexNumberAll<T>(ReadOnlySpan<T> x) where T : INumberBase<T> => !x.IsEmpty && MayBeComplex<T>() && All<T, IsComplexNumberOperator<T>>(x); /// <summary>Computes whether any of the values in the specified tensor is a complex number.</summary> /// <param name="x">The tensor, represented as a span.</param> /// <returns> /// <see langword="true"/> if any of the values in <paramref name="x"/> is a complex number; otherwise, <see langword="false"/>. /// If <paramref name="x"/> is empty, <see langword="false"/> is returned. /// </returns> public static bool IsComplexNumberAny<T>(ReadOnlySpan<T> x) where T : INumberBase<T> => !x.IsEmpty && MayBeComplex<T>() && Any<T, IsComplexNumberOperator<T>>(x); /// <summary>Gets whether any value could be complex.</summary> private static bool MayBeComplex<T>() => !IsPrimitiveBinaryInteger<T>() && !IsPrimitiveFloatingPoint<T>() && typeof(T) != typeof(decimal); /// <summary>T.IsComplexNumber(x)</summary> private readonly struct IsComplexNumberOperator<T> : IBooleanUnaryOperator<T> where T : INumberBase<T> { public static bool Vectorizable => false; // no vectorizable Ts are possibly complex public static bool Invoke(T x) => T.IsComplexNumber(x); public static Vector128<T> Invoke(Vector128<T> x) => throw new NotSupportedException(); public static Vector256<T> Invoke(Vector256<T> x) => throw new NotSupportedException(); public static Vector512<T> Invoke(Vector512<T> x) => throw new NotSupportedException(); } } }