SparseSequence Class |
Namespace: Bio
The SparseSequence type exposes the following members.
Name | Description | |
---|---|---|
SparseSequence(IAlphabet) |
Creates a SparseSequence with no sequence data.
Count property of SparseSequence instance created by using this constructor will be set to zero.
For working with sequences that never have sequence data, but are
only used for metadata storage (like keeping an ID or various features
but no direct sequence data) consider using the VirtualSequence
class instead.
| |
SparseSequence(ISequence) |
Creates a sparse sequence based on the new passed sequence.
| |
SparseSequence(IAlphabet, Int32) |
Creates a SparseSequence with no sequence data.
Count property of SparseSequence instance created by using this constructor will be
set a value specified by size parameter.
For working with sequences that never have sequence data, but are
only used for metadata storage (like keeping an ID or various features
but no direct sequence data) consider using the VirtualSequence
class instead.
| |
SparseSequence(IAlphabet, Int32, Byte) |
Creates a sparse sequence based on the specified parameters.
The item parameter must contain an alphabet as specified in the alphabet parameter,
else an exception will occur.
The index parameter value must be a non negative value.
Count property of an instance created by this constructor will be set to value of index + 1.
| |
SparseSequence(IAlphabet, Int32, IEnumerableByte) |
Creates a sparse sequence based on the specified parameters.
The sequenceItems parameter must contain sequence items known by the specified alphabet,
else an exception will occur.
The index parameter value must be a non negative.
|
Name | Description | |
---|---|---|
Alphabet |
The alphabet to which string representations of the sequence should
conform.
| |
Count |
The number of sequence items contained in the Sequence.
| |
ID |
An identification provided to distinguish the sequence to others
being worked with.
| |
Item |
Allows the sequence to function like an array, gets
the sequence item at the specified index. Note that the
index value starts its count at 0.
| |
Metadata |
Many sequence representations when saved to file also contain
information about that sequence. Unfortunately there is no standard
around what that data may be from format to format. This property
allows a place to put structured metadata that can be accessed by
a particular key.
For example, if species information is stored in a particular Species
class, you could add it to the dictionary by:
mySequence.Metadata["SpeciesInfo"] = mySpeciesInfo;
To fetch the data you would use:
Species mySpeciesInfo = mySequence.Metadata["SpeciesInfo"];
Particular formats may create their own data model class for information
unique to their format as well. Such as:
GenBankMetadata genBankData = new GenBankMetadata();
// ... add population code
mySequence.MetaData["GenBank"] = genBankData;
| |
Statistics |
Keeps track of the number of occurrences of each symbol within a sequence.
|
Name | Description | |
---|---|---|
CopyTo |
Copies all items from the sequence to a pre allocated array.
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetComplementedSequence |
Return a sequence representing the complement of this sequence.
| |
GetEnumerator |
Gets an enumerator to the bytes present in this sequence.
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetKnownSequenceItems |
Returns known sequence items with their position as ReadOnlyCollection of IndexedSequenceItem.
| |
GetReverseComplementedSequence |
Return a sequence representing the reverse complement of this sequence.
| |
GetReversedSequence |
Return a sequence representing this sequence with the orientation reversed.
| |
GetSubSequence |
Return a new sequence representing a range (subsequence) of this sequence.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IndexOfNonGap |
Gets the index of first non gap character.
| |
IndexOfNonGap(Int64) |
Returns the position of the first item from startPos that does not
have a Gap character.
| |
LastIndexOfNonGap |
Gets the index of last non gap character.
| |
LastIndexOfNonGap(Int64) |
Gets the index of last non gap character within the specified end position.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Name | Description | |
---|---|---|
AppendByte(Byte) | Overloaded.
Yield an Enumeration of the list with the item appended to the end
(Defined by IEnumerableExtensions.) | |
AppendByte(IEnumerableByte) | Overloaded.
Yield a concatenation of the two Enumerable lists
(Defined by IEnumerableExtensions.) | |
ConvertToString |
Converts the sequence to a string.
(Defined by SequenceExtensions.) | |
ElementAtByte |
Returns the element at a specified index in a sequence.
(Defined by IEnumerableExtensions.) | |
ForEachByte(ActionByte) | Overloaded.
Calls an action on each element of a sequence. The action takes one argument: an element. It has no return value.
(Defined by IEnumerableExtensions.) | |
ForEachByte(ActionByte, Int32) | Overloaded.
Calls an action on each element of a sequence. The action takes two arguments: an element and the index of the element.
It has no return value.
(Defined by IEnumerableExtensions.) | |
IsMarkedAsReverseComplement |
This checks for a sequence marker to determine if the given ISequence was generated from
a reverse complement.
(Defined by SequenceExtensions.) | |
MarkAsReverseComplement |
This adds a key to the Metadata to indicate this is a reversed sequence
(Defined by SequenceExtensions.) | |
ShuffleByte |
Shuffles the elements of a sequence.
(Defined by IEnumerableExtensions.) | |
StringJoin | Overloaded.
Creates a string from a sequence of elements. No delimiter is used.
(Defined by IEnumerableExtensions.) | |
StringJoin(String) | Overloaded.
Creates a delimited string from a sequence of elements.
(Defined by IEnumerableExtensions.) | |
StringJoin(String, Int32, String) | Overloaded.
Creates a delimited string from a sequence of elements. At most maxLength elements will be used and "..." shows that more elements were in the list.
(Defined by IEnumerableExtensions.) | |
SubSequenceByte |
Take the items from a sequence starting with item # start (index 0) and contining for count items.
(Defined by IEnumerableExtensions.) | |
ToHashSetByte | Overloaded.
Creates a HashSet from a sequence. If the sequence is already a HashSet, a new HashSet is still created.
(Defined by IEnumerableExtensions.) | |
ToHashSetByte(IEqualityComparerByte) | Overloaded.
Creates a HashSet from a sequence. If the sequence is already a HashSet, a new HashSet is still created.
(Defined by IEnumerableExtensions.) | |
ToQueueByte |
Creates a Queue from a sequence. If the sequence is already a Queue, a new Queue is still created.
(Defined by IEnumerableExtensions.) |