//// //#pragma warning disable //#nullable enable annotations // //// Licensed to the .NET Foundation under one or more agreements. //// The .NET Foundation licenses this file to you under the MIT license. // //namespace System //{ // /// Represent a type can be used to index a collection either from the start or the end. // /// // /// Index is used by the C# compiler to support the new index syntax // /// // /// int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ; // /// int lastElement = someArray[^1]; // lastElement = 5 // /// // /// // [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage] // public readonly struct Index : global::System.IEquatable // { // private readonly int _value; // // /// Construct an Index using a value and indicating if the index is from the start or from the end. // /// The index value. it has to be zero or positive number. // /// Indicating if the index is from the start or from the end. // /// // /// If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element. // /// // [global::System.Runtime.CompilerServices.MethodImpl(global::System.Runtime.CompilerServices.MethodImplOptions.AggressiveInlining)] // public Index(int value, bool fromEnd = false) // { // if (value < 0) // { // global::System.Index.ThrowHelper.ThrowValueArgumentOutOfRange_NeedNonNegNumException(); // } // // if (fromEnd) // _value = ~value; // else // _value = value; // } // // // The following private constructors mainly created for perf reason to avoid the checks // private Index(int value) // { // _value = value; // } // // /// Create an Index pointing at first element. // public static global::System.Index Start => new global::System.Index(0); // // /// Create an Index pointing at beyond last element. // public static global::System.Index End => new global::System.Index(~0); // // /// Create an Index from the start at the position indicated by the value. // /// The index value from the start. // [global::System.Runtime.CompilerServices.MethodImpl(global::System.Runtime.CompilerServices.MethodImplOptions.AggressiveInlining)] // public static global::System.Index FromStart(int value) // { // if (value < 0) // { // global::System.Index.ThrowHelper.ThrowValueArgumentOutOfRange_NeedNonNegNumException(); // } // // return new global::System.Index(value); // } // // /// Create an Index from the end at the position indicated by the value. // /// The index value from the end. // [global::System.Runtime.CompilerServices.MethodImpl(global::System.Runtime.CompilerServices.MethodImplOptions.AggressiveInlining)] // public static global::System.Index FromEnd(int value) // { // if (value < 0) // { // global::System.Index.ThrowHelper.ThrowValueArgumentOutOfRange_NeedNonNegNumException(); // } // // return new global::System.Index(~value); // } // // /// Returns the index value. // public int Value // { // get // { // if (_value < 0) // return ~_value; // else // return _value; // } // } // // /// Indicates whether the index is from the start or the end. // public bool IsFromEnd => _value < 0; // // /// Calculate the offset from the start using the giving collection length. // /// The length of the collection that the Index will be used with. length has to be a positive value // /// // /// For performance reason, we don't validate the input length parameter and the returned offset value against negative values. // /// we don't validate either the returned offset is greater than the input length. // /// It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and // /// then used to index a collection will get out of range exception which will be same affect as the validation. // /// // [global::System.Runtime.CompilerServices.MethodImpl(global::System.Runtime.CompilerServices.MethodImplOptions.AggressiveInlining)] // public int GetOffset(int length) // { // int offset = _value; // if (IsFromEnd) // { // // offset = length - (~value) // // offset = length + (~(~value) + 1) // // offset = length + value + 1 // // offset += length + 1; // } // return offset; // } // // /// Indicates whether the current Index object is equal to another object of the same type. // /// An object to compare with this object // public override bool Equals([global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)] object? value) => value is global::System.Index && _value == ((global::System.Index)value)._value; // // /// Indicates whether the current Index object is equal to another Index object. // /// An object to compare with this object // public bool Equals(global::System.Index other) => _value == other._value; // // /// Returns the hash code for this instance. // public override int GetHashCode() => _value; // // /// Converts integer number to an Index. // public static implicit operator global::System.Index(int value) => FromStart(value); // // /// Converts the value of the current Index object to its equivalent string representation. // public override string ToString() // { // if (IsFromEnd) // return ToStringFromEnd(); // // return ((uint)Value).ToString(); // } // // private string ToStringFromEnd() // { // return '^' + Value.ToString(); // } // // private static class ThrowHelper // { // [global::System.Diagnostics.CodeAnalysis.DoesNotReturn] // public static void ThrowValueArgumentOutOfRange_NeedNonNegNumException() // { // throw new global::System.ArgumentOutOfRangeException("value", "Non-negative number required."); // } // } // } //}