IndexedItem(T) Class

IndexedItemT Class

IndexedItem holds an item and its index. Index is a zero based position of item. This class is used in Sparse Sequence to get the known sequence items with their positions. This class implements IComparable interface and all comparisons are based on index and not on item.

Inheritance Hierarchy

SystemObject
BioIndexedItemT

Namespace: Bio
Assembly: Bio.Core (in Bio.Core.dll) Version: 2.0.0.1 (2.0.0.1)

Syntax

C++

Copy

public class IndexedItem<T> : IComparable<IndexedItem<T>>, 
	IComparable

Public Class IndexedItem(Of T)
	Implements IComparable(Of IndexedItem(Of T)), IComparable

generic<typename T>
public ref class IndexedItem : IComparable<IndexedItem<T>^>, 
	IComparable

type IndexedItem<'T> =  
    class
        interface IComparable<IndexedItem<'T>>
        interface IComparable
    end

Type Parameters

T: The type of item in IndexedItem.

The IndexedItemT type exposes the following members.

Constructors

	Name	Description
	IndexedItemT	Creates a new IndexedItem from the specified index and item.

Top

Properties

	Name	Description
	Index	Gets or sets the index. Specifies the zero based position of the item.
	Item	Gets or sets the item.

Top

Methods

	Name	Description
	CompareTo(Object)	Compares Index property of this instance with the Index property of specified IndexedItem and returns an indication of their relative values. Parameter obj must be of IndexedItem, else an ArgumentException will occur.
	CompareTo(IndexedItemT)	Compares Index property of this instance with the Index property of specified IndexedItem and returns an indication of their relative values.
	Equals(Object)	Returns a value indicating whether this instance is equal to a specified IndexedItem. Note that this method compares both index and item. If both Index and Item of this instance and obj are equal then it returns true else returns false. (Overrides ObjectEquals(Object).)
	Equals(IndexedItemT)	Returns a value indicating whether this instance is equal to a specified IndexedItem. Note that this method compares both Index and Item. If both Index and Item of this instance and other are equal then it returns true, else returns false.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns a hash code for this instance. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Operators

	Name	Description
	Equality	Compares the index of leftHandSideObject and rightHandSideObject, if index of leftHandSideObject is equal to the index of rightHandSideObject then returns true else returns false. Note that this method will compare only index and will not compare Item property.
	GreaterThan	Compares the index of leftHandSideObject and rightHandSideObject, if index of leftHandSideObject is greater than the index of rightHandSideObject then returns true else returns false. Note that this method will compare only index and will not compare Item property.
	GreaterThanOrEqual	Compares the index of leftHandSideObject and rightHandSideObject, if index of leftHandSideObject is greater than or equal to the index of rightHandSideObject then returns true else returns false. Note that this method will compare only index and will not compare Item property.
	Inequality	Compares the index of leftHandSideObject and rightHandSideObject, if index of leftHandSideObject is not equal to the index of rightHandSideObject then returns true else returns false. Note that this method will compare only index and will not compare Item property.
	LessThan	Compares the index of leftHandSideObject and rightHandSideObject, if index of leftHandSideObject is less than the index of rightHandSideObject then returns true, else returns false. Note that this method will compare only index and will not compare Item property.
	LessThanOrEqual	Compares the index of leftHandSideObject and rightHandSideObject, if index of leftHandSideObject is less than or equal to the index of rightHandSideObject then returns true else returns false. Note that this method will compare only index and will not compare Item property.

Top

Reference

Bio Namespace