From 2d5824aa46919b2eb88e9c75b7ab6c926a97e183 Mon Sep 17 00:00:00 2001 From: YoshiRulz Date: Wed, 10 Jul 2024 13:30:02 +1000 Subject: [PATCH] Monomorphisise `Range` to `Int{32,64}Interval` --- .../controls/components/AnalogStickPanel.cs | 8 +- src/BizHawk.Common/Ranges.cs | 302 +++++------------- .../Base Implementations/Axes/AxisSpec.cs | 4 +- .../Base Implementations/MemoryDomain.cs | 6 +- .../Base Implementations/MemoryDomainImpls.cs | 22 +- src/BizHawk.Emulation.Common/Extensions.cs | 33 +- .../Waterbox/WaterboxMemoryDomain.cs | 4 +- 7 files changed, 131 insertions(+), 248 deletions(-) diff --git a/src/BizHawk.Client.EmuHawk/tools/VirtualPads/controls/components/AnalogStickPanel.cs b/src/BizHawk.Client.EmuHawk/tools/VirtualPads/controls/components/AnalogStickPanel.cs index 84f26da6ac..751952dbc6 100644 --- a/src/BizHawk.Client.EmuHawk/tools/VirtualPads/controls/components/AnalogStickPanel.cs +++ b/src/BizHawk.Client.EmuHawk/tools/VirtualPads/controls/components/AnalogStickPanel.cs @@ -76,8 +76,10 @@ namespace BizHawk.Client.EmuHawk Rerange(); } - private Range _rangeX = 0.RangeTo(0); - private Range _rangeY = 0.RangeTo(0); + private Int32Interval _rangeX = 0.RangeTo(0); + + private Int32Interval _rangeY = 0.RangeTo(0); + private AxisSpec _fullRangeX; private AxisSpec _fullRangeY; @@ -286,6 +288,6 @@ namespace BizHawk.Client.EmuHawk Refresh(); } - private static readonly Range PercentRange = 0.RangeTo(100); + private static readonly Int32Interval PercentRange = 0.RangeTo(100); } } diff --git a/src/BizHawk.Common/Ranges.cs b/src/BizHawk.Common/Ranges.cs index 451e669f05..df70379da7 100644 --- a/src/BizHawk.Common/Ranges.cs +++ b/src/BizHawk.Common/Ranges.cs @@ -1,251 +1,109 @@ -using System.Collections.Generic; -using System.Linq; - -using BizHawk.Common.NumberExtensions; +using System.Runtime.CompilerServices; namespace BizHawk.Common { - /// represents a closed range of (class invariant: ≤ ) - public interface Range where T : unmanaged, IComparable + /// + /// represents a closed interval (a.k.a. range) of s32s + /// (class invariant: ≤ ) + /// + public sealed class Int32Interval { - T Start { get; } + public readonly int Start; - T EndInclusive { get; } - } + public readonly int EndInclusive; - /// represents a closed range of which can be grown or shrunk (class invariant: ≤ ) - public class MutableRange : Range where T : unmanaged, IComparable - { - private (T Start, T EndInclusive) r; - - /// - internal MutableRange(T start, T endInclusive) => Overwrite(start, endInclusive); - - /// (from setter) > - public T Start - { - get => r.Start; - set => r.Start = r.EndInclusive.CompareTo(value) < 0 - ? throw new ArgumentOutOfRangeException(nameof(value), value, "attempted to set start > end") - : value; - } - - /// (from setter) < - public T EndInclusive - { - get => r.EndInclusive; - set => r.EndInclusive = value.CompareTo(r.Start) < 0 - ? throw new ArgumentOutOfRangeException(nameof(value), value, "attempted to set end < start") - : value; - } - - /// is / and either bound is /// < - public void Overwrite(T start, T endInclusive) + internal Int32Interval(int start, int endInclusive) { - if (endInclusive.CompareTo(start) < 0) throw new ArgumentOutOfRangeException(nameof(endInclusive), endInclusive, "range end < start"); - if (start is float fs) - { - if (float.IsNaN(fs)) throw new ArgumentException("range start is NaN", nameof(start)); - if (endInclusive is float fe && float.IsNaN(fe)) throw new ArgumentException("range end is NaN", nameof(endInclusive)); - } - else if (start is double ds) - { - if (double.IsNaN(ds)) throw new ArgumentException("range start is NaN", nameof(start)); - if (endInclusive is double de && double.IsNaN(de)) throw new ArgumentException("range end is NaN", nameof(endInclusive)); - } - r = (start, endInclusive); + if (endInclusive < start) throw new ArgumentOutOfRangeException(paramName: nameof(endInclusive), actualValue: endInclusive, message: "interval end < start"); + Start = start; + EndInclusive = endInclusive; } + + /// true iff is contained in this interval ( is considered to be in the interval if it's exactly equal to either bound) + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public bool Contains(int value) + => Start <= value && value <= EndInclusive; + + /// beware integer overflow when this interval spans every value + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public uint Count() + => (uint) ((long) EndInclusive - Start) + 1U; } - /// contains most of the logic for ranges - /// - /// non-generic overloads are used where the method requires an increment or decrement
- /// TODO which Enumerate algorithm is faster - yield return in loop or ? - /// - public static class RangeExtensions + /// + /// represents a closed interval (a.k.a. range) of s64s + /// (class invariant: ≤ ) + /// + public sealed class Int64Interval { private const ulong MIN_LONG_NEGATION_AS_ULONG = 9223372036854775808UL; + public readonly long Start; + + public readonly long EndInclusive; + + /// + internal Int64Interval(long start, long endInclusive) + { + if (endInclusive < start) throw new ArgumentOutOfRangeException(paramName: nameof(endInclusive), actualValue: endInclusive, message: "interval end < start"); + Start = start; + EndInclusive = endInclusive; + } + + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public bool Contains(long value) + => Start <= value && value <= EndInclusive; + + /// + public ulong Count() + => (Contains(0L) + ? (Start == long.MinValue ? MIN_LONG_NEGATION_AS_ULONG : (ulong) -Start) + (ulong) EndInclusive + : (ulong) (EndInclusive - Start) + ) + 1UL; + } + + public static class RangeExtensions + { private static ArithmeticException ExclusiveRangeMinValExc => new("exclusive range end is min value of integral type"); /// if it's contained in , or else whichever bound of is closest to - public static T ConstrainWithin(this T value, Range range) where T : unmanaged, IComparable => value.CompareTo(range.Start) < 0 - ? range.Start - : range.EndInclusive.CompareTo(value) < 0 - ? range.EndInclusive - : value; + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static int ConstrainWithin(this int value, Int32Interval range) + => value < range.Start + ? range.Start + : range.EndInclusive < value ? range.EndInclusive : value; - /// true iff is contained in ( is considered to be in the range if it's exactly equal to either bound) - public static bool Contains(this Range range, T value) where T : unmanaged, IComparable => !(value.CompareTo(range.Start) < 0 || range.EndInclusive.CompareTo(value) < 0); + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Int32Interval RangeTo(this int start, int endInclusive) + => new(start: start, endInclusive: endInclusive); - public static uint Count(this Range range) => (uint) (range.EndInclusive - range.Start + 1); - - /// beware integer overflow when contains every value - public static uint Count(this Range range) => (uint) ((long) range.EndInclusive - range.Start) + 1U; - - /// - public static ulong Count(this Range range) => (range.Contains(0L) - ? (range.Start == long.MinValue ? MIN_LONG_NEGATION_AS_ULONG : (ulong) -range.Start) + (ulong) range.EndInclusive - : (ulong) (range.EndInclusive - range.Start) - ) + 1UL; - - public static uint Count(this Range range) => (uint) (range.EndInclusive - range.Start + 1); - - public static uint Count(this Range range) => (uint) (range.EndInclusive - range.Start + 1); - - /// - public static uint Count(this Range range) => range.EndInclusive - range.Start + 1U; - - /// - public static ulong Count(this Range range) => range.EndInclusive - range.Start + 1UL; - - public static uint Count(this Range range) => (uint) (range.EndInclusive - range.Start + 1); - - public static void Deconstruct(this Range range, out T start, out T endInclusive) - where T : unmanaged, IComparable - { - start = range.Start; - endInclusive = range.EndInclusive; - } - - public static IEnumerable Enumerate(this Range range) => Enumerable.Range(range.Start, (int) range.Count()).Select(i => (byte) i); - - /// - public static IEnumerable Enumerate(this Range range, double step) - { - var d = range.Start; - while (d < range.EndInclusive) - { - yield return d; - d += step; - } - if (d.HawkFloatEquality(range.EndInclusive)) yield return d; - } - - /// beware precision errors - public static IEnumerable Enumerate(this Range range, float step) - { - var f = range.Start; - while (f < range.EndInclusive) - { - yield return f; - f += step; - } - if (f.HawkFloatEquality(range.EndInclusive)) yield return f; - } - - public static IEnumerable Enumerate(this Range range) - { - var i = range.Start; - while (i < range.EndInclusive) yield return i++; - yield return i; - } - - public static IEnumerable Enumerate(this Range range) - { - var l = range.Start; - while (l < range.EndInclusive) yield return l++; - yield return l; - } - - public static IEnumerable Enumerate(this Range range) => Enumerable.Range(range.Start, (int) range.Count()).Select(i => (sbyte) i); - - public static IEnumerable Enumerate(this Range range) => Enumerable.Range(range.Start, (int) range.Count()).Select(i => (short) i); - - public static IEnumerable Enumerate(this Range range) - { - var i = range.Start; - while (i < range.EndInclusive) yield return i++; - yield return i; - } - - public static IEnumerable Enumerate(this Range range) - { - var l = range.Start; - while (l < range.EndInclusive) yield return l++; - yield return l; - } - - public static IEnumerable Enumerate(this Range range) => Enumerable.Range(range.Start, (int) range.Count()).Select(i => (ushort) i); - - public static Range GetImmutableCopy(this Range range) where T : unmanaged, IComparable => GetMutableCopy(range); - - public static MutableRange GetMutableCopy(this Range range) where T : unmanaged, IComparable => new MutableRange(range.Start, range.EndInclusive); - - /// - public static MutableRange MutableRangeTo(this T start, T endInclusive) where T : unmanaged, IComparable => new MutableRange(start, endInclusive); - - /// - public static MutableRange MutableRangeToExclusive(this byte start, byte endExclusive) => endExclusive == byte.MinValue - ? throw ExclusiveRangeMinValExc - : new MutableRange(start, (byte) (endExclusive - 1U)); - - /// - public static MutableRange MutableRangeToExclusive(this int start, int endExclusive) => endExclusive == int.MinValue - ? throw ExclusiveRangeMinValExc - : new MutableRange(start, endExclusive - 1); - - /// - public static MutableRange MutableRangeToExclusive(this long start, long endExclusive) => endExclusive == long.MinValue - ? throw ExclusiveRangeMinValExc - : new MutableRange(start, endExclusive - 1L); - - /// - public static MutableRange MutableRangeToExclusive(this sbyte start, sbyte endExclusive) => endExclusive == sbyte.MinValue - ? throw ExclusiveRangeMinValExc - : new MutableRange(start, (sbyte) (endExclusive - 1)); - - /// - public static MutableRange MutableRangeToExclusive(this short start, short endExclusive) => endExclusive == short.MinValue - ? throw ExclusiveRangeMinValExc - : new MutableRange(start, (short) (endExclusive - 1)); - - /// - public static MutableRange MutableRangeToExclusive(this uint start, uint endExclusive) => endExclusive == uint.MinValue - ? throw ExclusiveRangeMinValExc - : new MutableRange(start, endExclusive - 1U); - - /// - public static MutableRange MutableRangeToExclusive(this ulong start, ulong endExclusive) => endExclusive == ulong.MinValue - ? throw ExclusiveRangeMinValExc - : new MutableRange(start, endExclusive - 1UL); - - /// - public static MutableRange MutableRangeToExclusive(this ushort start, ushort endExclusive) => endExclusive == ushort.MinValue - ? throw ExclusiveRangeMinValExc - : new MutableRange(start, (ushort) (endExclusive - 1U)); - - /// - public static Range RangeTo(this T start, T endInclusive) where T : unmanaged, IComparable => start.MutableRangeTo(endInclusive); - - /// - public static Range RangeToExclusive(this byte start, byte endExclusive) => MutableRangeToExclusive(start, endExclusive); + /// + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Int64Interval RangeTo(this long start, long endInclusive) + => new(start: start, endInclusive: endInclusive); /// ≤ (empty ranges where = are not permitted) /// is min value of integral type (therefore ≤ ) - public static Range RangeToExclusive(this int start, int endExclusive) => MutableRangeToExclusive(start, endExclusive); + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Int32Interval RangeToExclusive(this int start, int endExclusive) + => endExclusive == int.MinValue + ? throw ExclusiveRangeMinValExc + : new(start: start, endInclusive: endExclusive - 1); /// - public static Range RangeToExclusive(this long start, long endExclusive) => MutableRangeToExclusive(start, endExclusive); - - /// - public static Range RangeToExclusive(this sbyte start, sbyte endExclusive) => MutableRangeToExclusive(start, endExclusive); - - /// - public static Range RangeToExclusive(this short start, short endExclusive) => MutableRangeToExclusive(start, endExclusive); - - /// - public static Range RangeToExclusive(this uint start, uint endExclusive) => MutableRangeToExclusive(start, endExclusive); - - /// - public static Range RangeToExclusive(this ulong start, ulong endExclusive) => MutableRangeToExclusive(start, endExclusive); - - /// - public static Range RangeToExclusive(this ushort start, ushort endExclusive) => MutableRangeToExclusive(start, endExclusive); + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static Int64Interval RangeToExclusive(this long start, long endExclusive) + => endExclusive == long.MinValue + ? throw ExclusiveRangeMinValExc + : new(start: start, endInclusive: endExclusive - 1L); /// true iff is strictly contained in ( is considered to be OUTSIDE the range if it's exactly equal to either bound) - public static bool StrictlyBoundedBy(this T value, Range range) where T : unmanaged, IComparable => range.Start.CompareTo(value) < 0 && value.CompareTo(range.EndInclusive) < 0; + [MethodImpl(MethodImplOptions.AggressiveInlining)] + public static bool StrictlyBoundedBy(this int value, Int32Interval range) + => range.Start < value && value < range.EndInclusive; } } diff --git a/src/BizHawk.Emulation.Common/Base Implementations/Axes/AxisSpec.cs b/src/BizHawk.Emulation.Common/Base Implementations/Axes/AxisSpec.cs index 51e1b685b4..b0bfa7738d 100644 --- a/src/BizHawk.Emulation.Common/Base Implementations/Axes/AxisSpec.cs +++ b/src/BizHawk.Emulation.Common/Base Implementations/Axes/AxisSpec.cs @@ -25,9 +25,9 @@ namespace BizHawk.Emulation.Common public string? PairedAxis => Constraint?.PairedAxis; - public readonly Range Range; + public readonly Int32Interval Range; - public AxisSpec(Range range, int neutral, bool isReversed = false, AxisConstraint? constraint = null) + public AxisSpec(Int32Interval range, int neutral, bool isReversed = false, AxisConstraint? constraint = null) { Constraint = constraint; IsReversed = isReversed; diff --git a/src/BizHawk.Emulation.Common/Base Implementations/MemoryDomain.cs b/src/BizHawk.Emulation.Common/Base Implementations/MemoryDomain.cs index 6486115c72..bab9b9df9a 100644 --- a/src/BizHawk.Emulation.Common/Base Implementations/MemoryDomain.cs +++ b/src/BizHawk.Emulation.Common/Base Implementations/MemoryDomain.cs @@ -102,7 +102,7 @@ namespace BizHawk.Emulation.Common } } - public virtual void BulkPeekByte(Range addresses, byte[] values) + public virtual void BulkPeekByte(Int64Interval addresses, byte[] values) { if (addresses is null) throw new ArgumentNullException(paramName: nameof(addresses)); if (values is null) throw new ArgumentNullException(paramName: nameof(values)); @@ -121,7 +121,7 @@ namespace BizHawk.Emulation.Common } } - public virtual void BulkPeekUshort(Range addresses, bool bigEndian, ushort[] values) + public virtual void BulkPeekUshort(Int64Interval addresses, bool bigEndian, ushort[] values) { if (addresses is null) throw new ArgumentNullException(paramName: nameof(addresses)); if (values is null) throw new ArgumentNullException(paramName: nameof(values)); @@ -145,7 +145,7 @@ namespace BizHawk.Emulation.Common } } - public virtual void BulkPeekUint(Range addresses, bool bigEndian, uint[] values) + public virtual void BulkPeekUint(Int64Interval addresses, bool bigEndian, uint[] values) { if (addresses is null) throw new ArgumentNullException(paramName: nameof(addresses)); if (values is null) throw new ArgumentNullException(paramName: nameof(values)); diff --git a/src/BizHawk.Emulation.Common/Base Implementations/MemoryDomainImpls.cs b/src/BizHawk.Emulation.Common/Base Implementations/MemoryDomainImpls.cs index 2d9ef3f61b..8f0c685003 100644 --- a/src/BizHawk.Emulation.Common/Base Implementations/MemoryDomainImpls.cs +++ b/src/BizHawk.Emulation.Common/Base Implementations/MemoryDomainImpls.cs @@ -11,9 +11,11 @@ namespace BizHawk.Emulation.Common private Action _poke; // TODO: use an array of Ranges - private Action, byte[]> _bulkPeekByte { get; set; } - private Action, bool, ushort[]> _bulkPeekUshort { get; set; } - private Action, bool, uint[]> _bulkPeekUint { get; set; } + private Action _bulkPeekByte { get; set; } + + private Action _bulkPeekUshort { get; set; } + + private Action _bulkPeekUint { get; set; } public Func Peek { get; set; } @@ -37,7 +39,7 @@ namespace BizHawk.Emulation.Common _poke?.Invoke(addr, val); } - public override void BulkPeekByte(Range addresses, byte[] values) + public override void BulkPeekByte(Int64Interval addresses, byte[] values) { if (_bulkPeekByte != null) { @@ -49,7 +51,7 @@ namespace BizHawk.Emulation.Common } } - public override void BulkPeekUshort(Range addresses, bool bigEndian, ushort[] values) + public override void BulkPeekUshort(Int64Interval addresses, bool bigEndian, ushort[] values) { if (_bulkPeekUshort != null) { @@ -61,7 +63,7 @@ namespace BizHawk.Emulation.Common } } - public override void BulkPeekUint(Range addresses, bool bigEndian, uint[] values) + public override void BulkPeekUint(Int64Interval addresses, bool bigEndian, uint[] values) { if (_bulkPeekUint != null) { @@ -80,9 +82,9 @@ namespace BizHawk.Emulation.Common Func peek, Action poke, int wordSize, - Action, byte[]> bulkPeekByte = null, - Action, bool, ushort[]> bulkPeekUshort = null, - Action, bool, uint[]> bulkPeekUint = null) + Action bulkPeekByte = null, + Action bulkPeekUshort = null, + Action bulkPeekUint = null) { Name = name; EndianType = endian; @@ -210,7 +212,7 @@ namespace BizHawk.Emulation.Common } } - public override void BulkPeekByte(Range addresses, byte[] values) + public override void BulkPeekByte(Int64Interval addresses, byte[] values) { var start = (ulong)addresses.Start; var count = addresses.Count(); diff --git a/src/BizHawk.Emulation.Common/Extensions.cs b/src/BizHawk.Emulation.Common/Extensions.cs index 07742c0db8..7cafb1b1ca 100644 --- a/src/BizHawk.Emulation.Common/Extensions.cs +++ b/src/BizHawk.Emulation.Common/Extensions.cs @@ -444,7 +444,13 @@ namespace BizHawk.Emulation.Common /// /// pass only for one axis in a pair, by convention the X axis /// identical reference to ; the object is mutated - public static ControllerDefinition AddAxis(this ControllerDefinition def, string name, Range range, int neutral, bool isReversed = false, AxisConstraint constraint = null) + public static ControllerDefinition AddAxis( + this ControllerDefinition def, + string name, + Int32Interval range, + int neutral, + bool isReversed = false, + AxisConstraint constraint = null) { def.Axes.Add(name, new AxisSpec(range, neutral, isReversed, constraint)); return def; @@ -456,7 +462,15 @@ namespace BizHawk.Emulation.Common /// /// format string e.g. "P1 Left {0}" (will be used to interpolate "X" and "Y") /// identical reference to ; the object is mutated - public static ControllerDefinition AddXYPair(this ControllerDefinition def, string nameFormat, AxisPairOrientation pDir, Range rangeX, int neutralX, Range rangeY, int neutralY, AxisConstraint constraint = null) + public static ControllerDefinition AddXYPair( + this ControllerDefinition def, + string nameFormat, + AxisPairOrientation pDir, + Int32Interval rangeX, + int neutralX, + Int32Interval rangeY, + int neutralY, + AxisConstraint constraint = null) { var yAxisName = string.Format(nameFormat, "Y"); var finalConstraint = constraint ?? new NoOpAxisConstraint(yAxisName); @@ -470,8 +484,14 @@ namespace BizHawk.Emulation.Common /// /// format string e.g. "P1 Left {0}" (will be used to interpolate "X" and "Y") /// identical reference to ; the object is mutated - public static ControllerDefinition AddXYPair(this ControllerDefinition def, string nameFormat, AxisPairOrientation pDir, Range rangeBoth, int neutralBoth, AxisConstraint constraint = null) - => def.AddXYPair(nameFormat, pDir, rangeBoth, neutralBoth, rangeBoth, neutralBoth, constraint); + public static ControllerDefinition AddXYPair( + this ControllerDefinition def, + string nameFormat, + AxisPairOrientation pDir, + Int32Interval rangeBoth, + int neutralBoth, + AxisConstraint constraint = null) + => def.AddXYPair(nameFormat, pDir, rangeBoth, neutralBoth, rangeBoth, neutralBoth, constraint); /// /// Adds an X/Y/Z triple of axes to the receiver , and returns it. @@ -479,12 +499,13 @@ namespace BizHawk.Emulation.Common /// /// format string e.g. "P1 Tilt {0}" (will be used to interpolate "X", "Y", and "Z") /// identical reference to ; the object is mutated - public static ControllerDefinition AddXYZTriple(this ControllerDefinition def, string nameFormat, Range rangeAll, int neutralAll) + public static ControllerDefinition AddXYZTriple(this ControllerDefinition def, string nameFormat, Int32Interval rangeAll, int neutralAll) => def.AddAxis(string.Format(nameFormat, "X"), rangeAll, neutralAll) .AddAxis(string.Format(nameFormat, "Y"), rangeAll, neutralAll) .AddAxis(string.Format(nameFormat, "Z"), rangeAll, neutralAll); - public static AxisSpec With(this in AxisSpec spec, Range range, int neutral) => new AxisSpec(range, neutral, spec.IsReversed, spec.Constraint); + public static AxisSpec With(this in AxisSpec spec, Int32Interval range, int neutral) + => new(range, neutral, spec.IsReversed, spec.Constraint); public static string SystemIDToDisplayName(string sysID) => SystemIDDisplayNames.TryGetValue(sysID, out var dispName) ? dispName : string.Empty; diff --git a/src/BizHawk.Emulation.Cores/Waterbox/WaterboxMemoryDomain.cs b/src/BizHawk.Emulation.Cores/Waterbox/WaterboxMemoryDomain.cs index 393fad0548..346a21ef14 100644 --- a/src/BizHawk.Emulation.Cores/Waterbox/WaterboxMemoryDomain.cs +++ b/src/BizHawk.Emulation.Cores/Waterbox/WaterboxMemoryDomain.cs @@ -99,7 +99,7 @@ namespace BizHawk.Emulation.Cores.Waterbox } } - public override void BulkPeekByte(Range addresses, byte[] values) + public override void BulkPeekByte(Int64Interval addresses, byte[] values) { if (_addressMangler != 0) { @@ -189,7 +189,7 @@ namespace BizHawk.Emulation.Cores.Waterbox } } - public override void BulkPeekByte(Range addresses, byte[] values) + public override void BulkPeekByte(Int64Interval addresses, byte[] values) { if (_addressMangler != 0) {