interface IBag in Tinman.Core.Collections

Base interface for classes that represent a collection of elements.

interface	IBag	with	<T>
		extends	IBagConst<T>
			ICollector<T>
		base of	BagBase
			ISortedSet
			IVector

Remarks

Subclasses are free to implement set semantics, i.e. equal elements are stored only once.

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.

---

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.

Clear

Removes all elements from this collection.

method

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.

GetEnumerator

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

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.

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.

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.

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