Click or drag to resize
Helper Class
Generally useful static methods.
Inheritance Hierarchy
SystemObject
  Bio.UtilHelper

Namespace: Bio.Util
Assembly: Bio.Core (in Bio.Core.dll) Version: 2.0.0.1 (2.0.0.1)
Syntax
public static class Helper

The Helper type exposes the following members.

Methods
  NameDescription
Public methodStatic memberASCIIEncoding
Simple method to take a byte array and convert it to ASCII string.
Public methodStatic memberBigMul
Helper method for large multiplication - this function is missing from the portable profile.
Public methodStatic memberCheckCondition(Boolean)
Confirms that a condition is true. Raise an exception if it is not.
Public methodStatic memberCheckCondition(Boolean, FuncString)
Confirms that a condition is true. Raise an exception if it is not.
Public methodStatic memberCheckCondition(Boolean, String)
Confirms that a condition is true. Raise an exception if it is not.
Public methodStatic memberCheckCondition(Boolean, String, Object)
Confirms that a condition is true. Raise an exception if it is not.
Public methodStatic memberCheckConditionT(Boolean)
Confirms that a condition is true. Raise an exception of type T if it is not.
Public methodStatic memberCheckConditionT(Boolean, FuncString)
Confirms that a condition is true. Raise an exception if it is not.
Public methodStatic memberCheckConditionT(Boolean, String)
Confirms that a condition is true. Raise an exception of type T if it is not.
Public methodStatic memberCheckConditionT(Boolean, String, Object)
Confirms that a condition is true. Raise an exception if it is not.
Public methodStatic memberCopy(Array, Array, Int64)
Copies source array to destination array.
Public methodStatic memberCopy(Array, Int64, Array, Int64, Int64)
Copies source array to destination array.
Public methodStatic memberCreateDelimitedString
Creates a delimited string containing the object's string values.
Public methodStatic memberCreateTabString
Creates a tab-delimited string containing the object's string values.
Public methodStatic memberFileEndsWithZippedExtension
Determine if file ends with extension ".gz"
Public methodStatic memberGenerateAlphabetCheckFailureException
Create a useful error message when a sequence fails validation.
Public methodStatic memberGetCrossReferenceLink
Returns a string which represents specified CrossReferenceLink.
Public methodStatic memberGetGenBankAccession
Returns a string which represents specified GenBankAccession.
Public methodStatic memberGetHexString
Gets the HexString from the specified byte array.
Public methodStatic memberGetInt16
Returns 16 bit signed integer from the byte array stored as little-endian.
Public methodStatic memberGetInt32
Returns 32 bit signed integer from the byte array stored as little-endian.
Public methodStatic memberGetLittleEndianByteArray(Int16)
Gets a byte array which represents value of 16 bit singed integer in LittleEndian format.
Public methodStatic memberGetLittleEndianByteArray(Int32)
Gets a byte array which represents value of 32 bit singed integer in LittleEndian format.
Public methodStatic memberGetLittleEndianByteArray(Single)
Gets byte array which represents value of float in LittleEndian format.
Public methodStatic memberGetLittleEndianByteArray(UInt16)
Gets a byte array which represents value of 16 bit unsinged integer in LittleEndian format.
Public methodStatic memberGetLittleEndianByteArray(UInt32)
Gets a byte array which represents value of 32 bit unsigned integer in LittleEndian format.
Public methodStatic memberGetMatePairedReadType
Gets the mate paired read type. That is for F/1/X1 it provides R/2/Y1.
Public methodStatic memberGetNormalRandom(Double, Double)
Returns random numbers according to an approximate normal distribution with an average and standard deviation set by the caller.
Public methodStatic memberGetNormalRandom(Double, Double, Int32)
Returns random numbers according to an approximate normal distribution with an average and standard deviation set by the caller. This is done iteratively using the central limit theorem.
Public methodStatic memberGetPairedReadId
Concatenates the specified original sequence id, paired read type and library name to paired read id format.
Public methodStatic memberGetProjectIdentifier
Returns a string which represents specified ProjectIdentifier.
Public methodStatic memberGetReadIdExcludingOtherInfo
Returns the id exluding the otherinformation part from it.
Public methodStatic memberGetReverseComplement
Get reverse complement of sequence string. Handles only unambiguous DNA sequence strings. Note: This method is a light-weight implementation of sequence.ReverseComplement. This only works for unambiguous DNA sequences, which is characteristic of the input for de-novo.
Public methodStatic memberGetSequenceRange
Get a range of sequence.
Public methodStatic memberGetSequenceSegment
Returns a string which represents specified SequenceSegment.
Public methodStatic memberGetSingle
Returns float from the byte array.
Public methodStatic memberGetStrandTopology(String)
Returns a SequenceStrandTopology corresponds to the specified string.
Public methodStatic memberGetStrandTopology(SequenceStrandTopology)
Returns a string which represents specified SequenceStrandTopology.
Public methodStatic memberGetStrandType(String)
Returns a SequenceStrandType corresponds to the specified string.
Public methodStatic memberGetStrandType(SequenceStrandType)
Returns a string which represents specified SequenceStrandType.
Public methodStatic memberGetString
Gets string representing specified delta alignment. This method is used in comparative Utilities to write delta alignments to file.
Public methodStatic memberGetUInt16
Returns 16 bit unsigned integer from the byte array stored as little-endian.
Public methodStatic memberGetUInt32
Returns 32 bit unsigned integer from the byte array stored as little-endian.
Public methodStatic memberGetUInt64
Returns 32 bit unsigned integer from the byte array stored as little-endian.
Public methodStatic memberIsBAM
Identifies if a file extension is a valid extension for BAM formats.
Public methodStatic memberIsFasta
Identifies if a file extension is a valid extension for FASTA formats.
Public methodStatic memberIsFastQ
Identifies if a file extension is a valid extension for FastQ formats.
Public methodStatic memberIsGenBank
Identifies if a file extension is a valid extension for GenBank formats.
Public methodStatic memberIsValidPatternValue(String, String, String)
Validates specified value with the specified regular expression pattern.
Public methodStatic memberIsValidPatternValue(String, String, Regex)
Validates specified value with the specified regular expression.
Public methodStatic memberIsValidRange
Validates int value.
Public methodStatic memberIsValidRegexValue(String, String)
Validates specified value with the specified regular expression.
Public methodStatic memberIsValidRegexValue(Regex, String)
Validates specified value with the specified regular expression.
Public methodStatic memberIsZippedFasta
Identifies if a file extension is a valid extension for FASTA formats that is gzipped.
Public methodStatic memberIsZippedFastQ
Identifies if a file extension is a valid extension for a gzipped FastQ formats.
Public methodStatic memberKeysEqualTKey, TValue1, TValue2
Efficiently (log n) test if two dictionaries have the same key set.
Public methodStatic memberRemoveSequencePolyTail
Get a Sequence Poly Tail.
Public methodStatic memberSplitSequence
Split sequence for Iron poython.
Public methodStatic memberStringContainsIllegalCharacters
Determines if the string contains any characters specified in the list.
Public methodStatic memberStringHasMatch
See if test string is identical to any of the passed list of strings.
Public methodStatic memberStringMultiply
String Multiply. Build a string by concatenating copies of the input string.
Public methodStatic memberValidatePairedSequenceId
Validates the specified sequence id is in the format of paired read or not. If so then gets the original sequence id, paired read type and library name from the paired sequence id. For Example: if the sequence id is "seq1.F:10K!324;abcd;345" then this method will return true and originalSequenceId - "seq1" pairedReadType - "F" libraryName - "10K" if the sequence id is not in the format of "originalSequenceId.{F,R}:LibraryName" or "originalSequenceId.{F,R}:LibraryName!otherInfo" then this method will return false.
Public methodStatic memberWrapAroundLeftShift
Shifts the bits of an int around in a wrapped way. It is useful for creating hashcodes of collections.
Top
Fields
  NameDescription
Public fieldStatic memberAlphabetsToShowInToString
Stores the number of alphabets to show in ToString function of a class.
Public fieldStatic memberGenBankMetadataKey
Key to get GenBankMetadata object from Metadata of a sequence which is parsed from GenBankParser.
Public fieldStatic memberPairedReadDelimiter
Delimitar "!" used to seperate the PairedRead information with other info in the sequence id.
Public fieldStatic memberSAMAlignedSequenceHeaderKey
Key to get SAMAlignedSequenceHeader object from Metadata of a aligned sequence which is parsed from SAMParser.
Public fieldStatic memberSAMAlignmentHeaderKey
Key to get SAMAlignmentHeader object from Metadata of a sequence alignment which is parsed from SAMParser.
Public fieldStatic memberZippedFileExtension
The .gz extension to indicate gzipped files
Top
See Also