interface IVector in Tinman.Core.Collections

Base interface for classes that represent a list of elements.

interface	IVector	with	<T>
		extends	IBag<T>
			IVectorConst<T>
		base of	VectorBase

Attributes

Count

The number of elements in this collection.

property	Count { get }
type	int32
value	[>=0]	The number of elements.
inherited	IBagConst.Count

Methods

Add

Adds the given element to this collection.

method	Add (T element)
type	bool
params	element		The element to add.
returns			true if the collection has changed, false if not.
inherited	ICollector.Add

Remarks:

Implementing methods shall return false iff the element has already been collected, i.e. it is contained in the collection. If in doubt, return true.

AddAll

Adds the given elements to this collection.

method	AddAll (IEnumerable<T> elements)
type	bool
params	elements	[not-null]	The elements to add.
returns			true if the collection has changed, false if not.
inherited	IBag.AddAll

---

Adds the given elements to this collection.

method	AddAll (T[] elements, int32 first = 0, int32 count = -1)
type	bool
params	elements	[not-null]	The elements to add.
	first	[>=0]	Index of first element to add.
	count	[>=-1]	Number of elements to add. If -1 all elements from first to the last element are added.
returns			true if the collection has changed, false if not.
inherited	IBag.AddAll

Clear

Removes all elements from this collection.

method	Clear ()
inherited	IBag.Clear

Contains

Returns if this collection contains the given element.

[Pure]
method	Contains (T element)
type	bool
params	element		The element.
returns			true if element is contained in this collection, false if not.
inherited	IBagConst.Contains

ContainsAll

Returns if this collection contains all given elements.

method	ContainsAll (IEnumerable<T> elements)
type	bool
params	elements	[not-null]	The elements.
returns			true if all elements are contained in this collection, false if not.
inherited	IBagConst.ContainsAll

First

Returns the first enumerated value.

[Pure]
method	First ()
type	T
returns			The first enumerated value.
inherited	IBagConst.First

Exceptions:

• TinmanException:
  If the enumeration is empty.

GetAt

Returns the element at the given list index.

[Pure]
method	GetAt (int32 index)
type	T
params	index	[0..Count-1]	The list index.
returns			The element.
inherited	IVectorConst.GetAt

GetEnumerator

method	GetEnumerator ()
type	IEnumerator<T>
inherited	IEnumerable.GetEnumerator

IndexOf

Returns the list index of the given element.

[Pure]
method	IndexOf (T element)
type	int32
params	element		The element.
returns			The list index or -1 if the element is not contained in the list.
inherited	IVectorConst.IndexOf

InsertAt

Inserts the given element into the list.

method	InsertAt (int32 index, T element)
params	index	[0..Count]	List index where to insert the element.
	element		The element to insert.

Last

Returns the last enumerated value.

[Pure]
method	Last ()
type	T
returns			The last enumerated value.
inherited	IBagConst.Last

Exceptions:

• TinmanException:
  If the enumeration is empty.

Remove

Removes the given element from this collection.

method	Remove (T element)
type	bool
params	element		The element to remove.
returns			true if the collection has changed, false if not.
inherited	IBag.Remove

RemoveAll

Removes the given elements from this collection.

method	RemoveAll (IEnumerable<T> elements)
type	bool
params	elements	[not-null]	The elements to remove.
returns			true if the collection has changed, false if not.
inherited	IBag.RemoveAll

RemoveAt

Removes the element at the given list index.

method	RemoveAt (int32 index)
type	T
params	index	[0..Count-1]	The list index.
returns			The removed element.

RemoveRange

Removes a range of elements.

method	RemoveRange (int32 index, int32 count)
params	index	[0..Count]	List index of first element to remove.
	count	[0..Count-index]	Number of subsequent elements to remove.

RemoveWhere

Removes all elements from this collection for which the given predicate evaluates to true.

method	RemoveWhere (PredicateDelegate<T> predicate)
type	bool
params	predicate	[not-null]	The predicate to use.
returns			true if the collection has changed, false if not.
inherited	IBag.RemoveWhere

SetAt

Sets the element at the given list index.

method	SetAt (int32 index, T element)
type	T
params	index	[0..Count-1]	The list index of the element to set.
	element		The new element.
returns			The previous element.

ToArray

Returns the elements of this enumerable object as a fresh array.

[Pure]
method	ToArray ()
type	T[]
returns		[not-null]	The array of elements.
inherited	IBagConst.ToArray

ToArrayCopy

Returns the elements of this collection as an array.

method	ToArrayCopy (T[] array, int32 offset = 0)
type	T[]
params	array	[not-null]	The output array.
	offset	[>=0]	Offset into array. Defaults to 0.
returns		[not-null]	The filled array.
inherited	IBagConst.ToArrayCopy

Remarks:

The elements in this collection will be copied into the given array, starting at the array index specified by offset.

ToArrayList

Returns the elements of this enumerable object as a list.

[Pure]
method	ToArrayList ()
type	IArrayVector<T>
returns		[not-null]	The list of elements.
inherited	IBagConst.ToArrayList

ToList

Returns the elements of this enumerable object as a list.

[Pure]
method	ToList ()
type	IVectorConst<T>
returns		[not-null]	The list of elements.
inherited	IBagConst.ToList