Enhanced C#
Language of your choice: library documentation

Documentation moved to ecsharp.net

GitHub doesn't support HTTP redirects, so you'll be redirected in 3 seconds.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Public fields | Properties | Public Member Functions | List of all members
Loyc.Collections.NegListSlice< T > Struct Template Reference

Adapter: a random-access range for a slice of an INegListSource{T}. More...


Source file:
Inheritance diagram for Loyc.Collections.NegListSlice< T >:
Loyc.Collections.IRange< out T > Loyc.ICloneable< out T > Loyc.Collections.IIsEmpty Loyc.Collections.INegListSource< T > Loyc.Collections.IBRange< out T > Loyc.Collections.IListSource< out T > Loyc.ICloneable< out T > Loyc.Collections.IFRange< out T > Loyc.ICloneable< out T > Loyc.ICloneable< out T > Loyc.Collections.IIsEmpty

Remarks

Adapter: a random-access range for a slice of an INegListSource{T}.

Template Parameters
TItem type in the list

Although this slices a neg-list, the slice itself is an ordinary zero-indexed IListSource{T}. It implements INegListSource{T} for completeness, but its Min is 0.

Public fields

INegListSource< T > _list
 
int _start
 
int _count
 

Properties

int Count [get]
 
bool IsEmpty [get]
 
Front [get]
 
Back [get]
 
this[int index] [get]
 
this[int index, T defaultValue] [get]
 
int INegListSource< T >. Min [get]
 
int INegListSource< T >. Max [get]
 
- Properties inherited from Loyc.Collections.IBRange< out T >
Back [get]
 Returns the value of the last item in the range. More...
 
- Properties inherited from Loyc.Collections.IFRange< out T >
Front [get]
 Returns the first value in the range, without popping it. More...
 
- Properties inherited from Loyc.Collections.IIsEmpty
bool IsEmpty [get]
 
- 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...
 
this[int index] [get]
 Gets the item at the specified index. More...
 

Public Member Functions

 NegListSlice (INegListSource< T > list, int start, int count)
 Initializes a slice. More...
 
PopFront (out bool empty)
 Removes the first item from the range and returns it. More...
 
PopBack (out bool empty)
 Removes the last item from the range and returns it. More...
 
IFRange< T > ICloneable
< IFRange< T > >. 
Clone ()
 
IBRange< T > ICloneable
< IBRange< T > >. 
Clone ()
 
IRange< T > ICloneable< IRange
< T > >. 
Clone ()
 
NegListSlice< T > Clone ()
 
IEnumerator< T > IEnumerable< T >. GetEnumerator ()
 
System.Collections.IEnumerator
System.Collections.IEnumerable. 
GetEnumerator ()
 
RangeEnumerator< NegListSlice
< T >, T > 
GetEnumerator ()
 
TryGet (int index, out bool fail)
 Gets the item at the specified index, and does not throw an exception on failure. More...
 
IRange< T > IListSource< T >. Slice (int start, int count)
 Returns a sub-range of this list. More...
 
IRange< T > INegListSource< T >. Slice (int start, int count)
 Returns a sub-range of this list. More...
 
NegListSlice< T > Slice (int start, int count)
 Returns a sub-range of this list. More...
 

Constructor & Destructor Documentation

Loyc.Collections.NegListSlice< T >.NegListSlice ( INegListSource< T >  list,
int  start,
int  count 
)
inline

Initializes a slice.

Exceptions
ArgumentExceptionThe start index was below zero.

The (start, count) range is allowed to be invalid, as long as 'start' is Min or above and 'count' is zero or above.

  • If 'start' is above the original Count, the Count of the new slice is set to zero.
  • if (start + count) is above the original Count, the Count of the new slice is reduced to list.Count - start.

References Loyc.Collections.INegListSource< T >.Min.

Member Function Documentation

T Loyc.Collections.NegListSlice< T >.PopBack ( out bool  fail)
inline

Removes the last item from the range and returns it.

Parameters
failReceives the current value of IsEmpty.
Returns
The first item of the range, or default(T) if IsEmpty.

The remarks of IFRange{T}.PopFront apply to this method.

Implements Loyc.Collections.IBRange< out T >.

T Loyc.Collections.NegListSlice< T >.PopFront ( out bool  fail)
inline

Removes the first item from the range and returns it.

Parameters
failReceives the current value of IIsEmpty.IsEmpty.
Returns
The first item of the range, or default(T) if IsEmpty.

This method is a little unweildy in plain C#, but in EC# it will be a bit more convenient to use via extension methods like PopFirst(ref this Range range, T defaultValue) and PopFirst(ref this Range range), which are illegal in plain C#.

I wanted to give this method the signature "bool PopFirst(out T first)" but the generic parameter "T" is covariant, i.e. it is marked "out T" which, ironically, is not compatible with "out T" parameters, only with return values.

Implements Loyc.Collections.IFRange< out T >.

IRange<T> IListSource<T>. Loyc.Collections.NegListSlice< T >.Slice ( int  start,
int  count 
)
inline
IRange<T> INegListSource<T>. Loyc.Collections.NegListSlice< T >.Slice ( int  start,
int  count 
)
inline
NegListSlice<T> Loyc.Collections.NegListSlice< T >.Slice ( int  start,
int  count 
)
inline

Returns a sub-range of this list.

Implements Loyc.Collections.INegListSource< T >.

T Loyc.Collections.NegListSlice< T >.TryGet ( int  index,
out bool  fail 
)
inline

Gets the item at the specified index, and does not throw an exception on failure.

Parameters
indexAn index in the range Min to Max.
failA 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);

Implements Loyc.Collections.INegListSource< T >.