IndexSet Methods TIBCO Spotfire 7.6 API Reference

The IndexSet type exposes the following members.

Methods
  Name Description
Public method AddIndex
Adds the index to the set. If the index is already in the set, nothing is changed.
Public method AddIndexes(IEnumerableInt32)
Adds the specified indexes to the set.
Public method AddIndexes(Int32, Int32)
Adds a range of indexes to the set.
Public method And(IndexSet)
Performs a logical AND between this and that IndexSet.

Note: the method changes the internal state of this IndexSet
Public method Static member And(IndexSet, IndexSet)
Returns a new IndexSet that is a logical AND between two IndexSet.
Public method AsReadOnly
Returns this if read-only, otherwise a read-only clone.
Public method Assign(IndexSet)
Copies the content of the specified IndexSet into this one.
Public method Assign(Int32, UInt32)
Assigns the indexes from the specified array of indexes encoded as bits. The length of the bits array must be
Copy
(capacity + 31)/32
. Bits outside of capacity in the last array element are ignored.
Public method AssignComplement
Copies the complement of the specified IndexSet into this one. In other words, this IndexSet will contain the indexes NOT in that IndexSet.
Public method AsWritable
Returns a clone if this is read-only, otherwise this.
Public method Clear
Removes all indexes from the set.
Public method Clone
Creates a writable copy of this IndexSet.
Public method Contains
Determines whether this IndexSet contains all indexes of that IndexSet.
Public method CopyTo
Copies the indexes in the set to the array starting at the offset.
Public method DeleteIndexPositions
Deletes a range of index positions. Existing indexes from
Copy
startIndex+count
and above are moved down.
Public method Equals(Object)
Tests that object is an IndexSet and is equal to this one.
(Overrides ObjectEquals(Object).)
Public method Equals(IndexSet)
Tests if this IndexSet and that IndexSet have the same Capacity and contain exactly the same indexes.
Public method Fill
Adds all indexes (as defined by Capacity) to the set.
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetBits
Fills the specified array with the indexes encoded as bits. The length of the bits array must be
Copy
(Capacity + 31)/32
.
Public method GetEnumerator
Returns an enumerator for the IndexSet.
Public method GetHashCode
Returns a hash code for the current state of the IndexSet.
(Overrides ObjectGetHashCode.)
Public method GetNextIndex
Gets the index after the specified one.
Public method GetPreviousIndex
Gets the index before the specified one.
Public method GetSubsetCount
Gets the number of indexes in a subset defined by the startIndex and endIndex arguments.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method HasIndex
Returns a bool indicating if the index is a member of the set.
Public method InsertIndexPositions
Makes room for more indexes. Existing indexes from startIndex and above are moved up.
Public method Intersects
Determines whether this and that IndexSet have any indexes in common.
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Not
Inverts the set. Any index that was included in the set will be excluded and vice versa.

Note: the method changes the internal state of this IndexSet
Public method Static member Not(IndexSet)
Returns a new IndexSet that is the complement of the specified source set. Any index that is included in the source set will be excluded and vice versa.
Public method NthSmallestIndex
Gets the Nth smallest index. Caution: This method is slow (linear time), so you must ensure that your algorithm (or the one using your algorithm) never calls this method many times, which could result in quadratic time.
Public method Or(IndexSet)
Performs a logical OR between this and that IndexSet.

Note: the method changes the internal state of this IndexSet
Public method Static member Or(IndexSet, IndexSet)
Returns a new IndexSet that is a logical OR between two IndexSet.
Public method RemoveIndex
Removes the index from the set. If the index is not in the set, nothing is changed.
Public method RemoveIndexes(IEnumerableInt32)
Removes the specified indexes from the set.
Public method RemoveIndexes(Int32, Int32)
Removes a range of indexes from the set.
Public method SetReadOnly
Sets this IndexSet to read-only.
Public method Subtract(IndexSet)
Subtracts that IndexSet from this one. In other words, the indexes in that IndexSet are removed from this.

Note: the method changes the internal state of this IndexSet
Public method Static member Subtract(IndexSet, IndexSet)
Returns a new IndexSet that is a subtraction between two IndexSet. In other words, the new IndexSet is a copy of set1 without the indexes in set2.
Public method ToString
Returns a string representation of the IndexSet. Each index position is represented by a 0 or 1, where 1 indicates that the index is in the set.
(Overrides ObjectToString.)
Public method Xor(IndexSet)
Performs a logical XOR between this and that IndexSet.

Note: the method changes the internal state of this IndexSet
Public method Static member Xor(IndexSet, IndexSet)
Returns a new IndexSet that is a logical XOR between two IndexSet.
Top
Explicit Interface Implementations
  Name Description
Explicit interface implementation Private method IEnumerableGetEnumerator
IEnumerable.GetEnumerator implementation.
Top
See Also

Reference

IndexSet Class
Spotfire.Dxp.Data Namespace