Loyc.Collections.NegList< T > Struct Template Reference

Adapter: provides a view of an IList{T} in which the Count is the same, but the minimum index is not necessarily zero. Returned from LCExt.NegView{T}(IList{T},int). More...

---

Source file:

• /Core/Loyc.Essentials/Collections/Adapters/NegList.cs

Inheritance diagram for Loyc.Collections.NegList< T >:

Remarks

Adapter: provides a view of an IList{T} in which the Count is the same, but the minimum index is not necessarily zero. Returned from LCExt.NegView{T}(IList{T},int).

This wrapper is a structure in order to offer high performance in certain scenarios.

Public static fields
static readonly NegList< T >	Empty = new NegList<T>(EmptyList<T>.Value, 0)

Properties
IList< T >	OriginalList [get]
	Gets the list that was passed to the constructor of this instance. More...
int	Offset [get, set]
	Returns the offset added to indexes in the original list, which equals -Min. More...
int	Count [get]
	Returns the total number of items in the list (same as OriginalList.Count). More...
int	Min [get]
	Returns the minimum valid index. More...
int	Max [get]
	Returns the maximum valid index, which is Min + OriginalList.Count - 1. More...
T	this[int index] [get, set]
	Gets the value of the list at the specified index. In terms of the original list, this is OriginalList[index + Offset] More...
Properties inherited from Loyc.Collections.INegArray< T >
new T	this[int index] [get, set]
	Gets or sets an element of the array-like collection. More...
Properties inherited from Loyc.Collections.INegListSource< T >
int	Min [get]
	Returns the minimum valid index in the collection. More...
int	Max [get]
	Returns the maximum valid index in the collection. More...
T	this[int index] [get]
	Gets the item at the specified index. More...

Public Member Functions
	NegList (IList< T > list, int zeroOffset)
	Initializes a NegListSource wrapper. More...
T	TryGet (int index, out bool fail)
	Gets the item at the specified index, and does not throw an exception on failure. Parameters index An index in the range Min to Max. fail A flag that is set on failure. To improve performance slightly, this flag is not cleared on success. Returns The element at the specified index, or default(T) if the index is not valid. In my original design, the caller could provide a value to return on failure, but this would not allow T to be marked as "out" in C# 4. For the same reason, we cannot have a ref/out T parameter. Instead, the following extension methods are provided: bool TryGet(int index, ref T value); T TryGet(int, T defaultValue);
bool	TrySet (int index, T value)
IRange< T >	Slice (int start, int count=int.MaxValue)
	Returns a sub-range of this list. More...
IEnumerator< T >	GetEnumerator ()
System.Collections.IEnumerator System.Collections.IEnumerable.	GetEnumerator ()
bool	Equals (NegList< T > rhs)
override bool	Equals (object obj)
override int	GetHashCode ()
override string	ToString ()
	Returns ToString() of the wrapped list. More...

Static Public Member Functions
static bool	operator== (NegList< T > a, NegList< T > b)
static bool	operator!= (NegList< T > a, NegList< T > b)

Constructor & Destructor Documentation

Loyc.Collections.NegList< T >.NegList ( IList< T >  list, int  zeroOffset  )

inline

Initializes a NegListSource wrapper.

Parameters

list	A list to wrap (must not be null).
zeroOffset	An index into the original list. this[0] will refer to that index.

The zeroOffset can be any integer, but if it is not in the range 0 to list.Count-1, this[0] will not be valid.

Member Function Documentation

IRange<T> Loyc.Collections.NegList< T >.Slice ( int  start, int  count = int.MaxValue  )

inline

Returns a sub-range of this list.

Implements Loyc.Collections.INegListSource< T >.

override string Loyc.Collections.NegList< T >.ToString ( )

inline

Returns ToString() of the wrapped list.

Property Documentation

int Loyc.Collections.NegList< T >.Count

get

Returns the total number of items in the list (same as OriginalList.Count).

int Loyc.Collections.NegList< T >.Max

get

Returns the maximum valid index, which is Min + OriginalList.Count - 1.

int Loyc.Collections.NegList< T >.Min

get

Returns the minimum valid index.

int Loyc.Collections.NegList< T >.Offset

getset

Returns the offset added to indexes in the original list, which equals -Min.

The 0th item in this list the same as OriginalList[Offset].

WARNING: this is a value type. Calling the setter may have unexpected consequences for people unfamiliar with the .NET type system, because it is easy to make copies accidentally, and changing the Offset in a copy does not change the Offset in the original.

IList<T> Loyc.Collections.NegList< T >.OriginalList

get

Gets the list that was passed to the constructor of this instance.

T Loyc.Collections.NegList< T >.this[int index]

getset

Gets the value of the list at the specified index. In terms of the original list, this is OriginalList[index + Offset]

Parameters

index

An index in the range Min to Max.

Exceptions

ArgumentOutOfRangeException

The index provided is not valid in this list.