interface IBagConst in Tinman.Core.Collections

Base interface for classes that represent a read-only collection of elements.

interface	IBagConst	with	<T>
		extends	IEnumerable<T>
		base of	BagConstBase
			IBag
			IMapConst
			ISortedSetConst
			IVectorConst

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.

Methods

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.

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.

First

Returns the first enumerated value.

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

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.

Exceptions:

• TinmanException:
  If the enumeration is empty.

ToArray

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

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

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.

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.

ToList

Returns the elements of this enumerable object as a list.

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