Singularity/Library/PackageCache/com.unity.burst@1.8.4/Runtime/CompilerServices/Hint.cs

29 lines
1.1 KiB
C#
Raw Normal View History

2024-05-06 14:45:45 -04:00
namespace Unity.Burst.CompilerServices
{
/// <summary>
/// Compile-time hint intrinsics.
/// </summary>
public static class Hint
{
/// <summary>
/// Hints to the compiler that the condition is likely to be true.
/// </summary>
/// <param name="condition">The boolean condition that is likely to be true.</param>
/// <returns>The condition.</returns>
public static bool Likely(bool condition) => condition;
/// <summary>
/// Hints to the compiler that the condition is unlikely to be true.
/// </summary>
/// <param name="condition">The boolean condition that is unlikely to be true.</param>
/// <returns>The condition.</returns>
public static bool Unlikely(bool condition) => condition;
/// <summary>
/// Hints to the compiler that the condition can be assumed to be true.
/// </summary>
/// <param name="condition">The boolean condition that can be assumed to be true.</param>
public static void Assume(bool condition) { }
}
}