Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## de.jstacs.data.sequences
Class SparseSequence

    java.lang.Object
      de.jstacs.data.Sequence
          de.jstacs.data.sequences.DiscreteSequence
              de.jstacs.data.sequences.SparseSequence

All Implemented Interfaces:
  Comparable<Sequence>

    public final class SparseSequence

extends DiscreteSequence

This class is an implementation for sequences on one alphabet with length 4. This implementation can be used, for instance, for DNA sequences.
The symbols are encoded in the bits of the primitive type `long`, which allows to save 32 symbols in one `long`. On the one hand an instance of this class is more memory efficient than any other `DiscreteSequence`, e.g. `ByteSequence`. But on the other hand this class will be a little bit slower when accessing single positions.

Author:
  Jens Keilwagen

Nested Class Summary

Nested classes/interfaces inherited from class de.jstacs.data.Sequence
`Sequence.CompositeSequence, Sequence.SubSequence`

Field Summary

Fields inherited from class de.jstacs.data.Sequence
`alphabetCon, annotation, rc`

Constructor Summary
`SparseSequence(AlphabetContainer alphCon, String seq)` Creates a new `SparseSequence` from a `String` representation.
`SparseSequence(AlphabetContainer alphCon, SymbolExtractor se)` Creates a new `SparseSequence` from a `SymbolExtractor`.

Method Summary
`SparseSequence` | `complement(int start, int end)` This method returns a new instance of `Sequence.CompositeSequence` containing a part of the complementary current `Sequence.CompositeSequence`.
`int` | `discreteVal(int pos)` Returns the discrete value at position `pos` of the `Sequence.CompositeSequence`.
`protected Sequence` | `flatCloneWithoutAnnotation()` Works in analogy to `Object.clone()`, but does not clone the annotation.
`int` | `getLength()` Returns the length of the `Sequence.CompositeSequence`.
`static Sample` | `getSample(AlphabetContainer con, AbstractStringExtractor se)` This method allows to create a `Sample` containing `SparseSequence`s.
`SparseSequence` | `reverse(int start, int end)` This method returns a new instance of `Sequence.CompositeSequence` containing a part of the reverse current `Sequence.CompositeSequence`.
`SparseSequence` | `reverseComplement(int start, int end)` This method returns a new instance of `Sequence.CompositeSequence` containing a reverse part of the complementary current `Sequence.CompositeSequence`.

Methods inherited from class de.jstacs.data.sequences.DiscreteSequence
`continuousVal`

Methods inherited from class de.jstacs.data.Sequence
`annotate, compareTo, complement, create, create, create, equals, getAlphabetContainer, getAnnotation, getCompositeSequence, getCompositeSequence, getHammingDistance, getNumberOfSequenceAnnotationsByType, getSequenceAnnotationByType, getSubSequence, getSubSequence, getSubSequence, getSubSequence, hashCode, reverse, reverseComplement, toDiscrete, toString, toString, toString, toString`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

### SparseSequence

    public SparseSequence(AlphabetContainer alphCon,
                          String seq)
                   throws WrongSequenceTypeException,
                          WrongAlphabetException

  Creates a new `SparseSequence` from a `String` representation.

  Parameters:
    `alphCon` - the `AlphabetContainer`
    `seq` - the sequence as `String`
  Throws:
    `WrongSequenceTypeException` - if the `AlphabetContainer` is not simple or the internal `Alphabet` has more than 4 symbols
    `WrongAlphabetException` - if the `AlphabetContainer` is not discrete
  See Also:
    `SparseSequence(AlphabetContainer, SymbolExtractor)`

### SparseSequence

    public SparseSequence(AlphabetContainer alphCon,
                          SymbolExtractor se)
                   throws WrongSequenceTypeException,
                          WrongAlphabetException

  Creates a new `SparseSequence` from a `SymbolExtractor`.

  Parameters:
    `alphCon` - the `AlphabetContainer`
    `se` - the `SymbolExtractor`
  Throws:
    `WrongSequenceTypeException` - if the `AlphabetContainer` is not simple or the internal `Alphabet` has more than 4 symbols
    `WrongAlphabetException` - if the `AlphabetContainer` is not discrete
  See Also:
    `SparseSequence(AlphabetContainer, int, SequenceAnnotation[])`

Method Detail

### discreteVal

    public int discreteVal(int pos)

  Description copied from class: `Sequence`
  Returns the discrete value at position `pos` of the `Sequence.CompositeSequence`.

  Specified by:
    `discreteVal` in class `Sequence`
  Parameters:
    `pos` - the position of the `Sequence.CompositeSequence`
  Returns:
    the discrete value at position `pos` of the `Sequence.CompositeSequence`

### getLength

    public int getLength()

  Description copied from class: `Sequence`
  Returns the length of the `Sequence.CompositeSequence`.

  Specified by:
    `getLength` in class `Sequence`
  Returns:
    the length of the `Sequence.CompositeSequence`

### complement

    public SparseSequence complement(int start,
                                     int end)
                              throws OperationNotSupportedException

  Description copied from class: `Sequence`
  This method returns a new instance of `Sequence.CompositeSequence` containing a part of the complementary current `Sequence.CompositeSequence`.
  So invoking this method, for instance, on the sequence "TAATA" with an `AlphabetContainer` on `DNAAlphabet` returns "ATTAT".

  Overrides:
    `complement` in class `Sequence`
  Parameters:
    `start` - the start position (inclusive) in the original `Sequence.CompositeSequence`
    `end` - the end position (exclusive) in the original `Sequence.CompositeSequence`
  Returns:
    the complementary `Sequence.CompositeSequence` of the part
  Throws:
    `OperationNotSupportedException` - if the current `Sequence.CompositeSequence` is not based on a `ComplementableDiscreteAlphabet`
  See Also:
    `ComplementableDiscreteAlphabet`

### reverse

    public SparseSequence reverse(int start,
                                  int end)
                           throws OperationNotSupportedException

  Description copied from class: `Sequence`
  This method returns a new instance of `Sequence.CompositeSequence` containing a part of the reverse current `Sequence.CompositeSequence`.

  Overrides:
    `reverse` in class `Sequence`
  Parameters:
    `start` - the start position (inclusive) in the original `Sequence.CompositeSequence`
    `end` - the end position (exclusive) in the original `Sequence.CompositeSequence`
  Returns:
    the reverse `Sequence.CompositeSequence` of the part
  Throws:
    `OperationNotSupportedException` - if the current `Sequence.CompositeSequence` is based on an `AlphabetContainer` that is not simple

### reverseComplement

    public SparseSequence reverseComplement(int start,
                                            int end)
                                     throws OperationNotSupportedException

  Description copied from class: `Sequence`
  This method returns a new instance of `Sequence.CompositeSequence` containing a reverse part of the complementary current `Sequence.CompositeSequence`. For more details see the methods `Sequence.reverse()` and `Sequence.complement()`.

  Overrides:
    `reverseComplement` in class `Sequence`
  Parameters:
    `start` - the start position (inclusive) in the original `Sequence.CompositeSequence`
    `end` - the end position (exclusive) in the original `Sequence.CompositeSequence`
  Returns:
    the reverse complementary `Sequence.CompositeSequence` of the part
  Throws:
    `OperationNotSupportedException` - if the current `Sequence.CompositeSequence` is not discrete and simple ((not based on a `ComplementableDiscreteAlphabet`)
  See Also:
    `Sequence.reverse()`, `Sequence.complement()`, `ComplementableDiscreteAlphabet`

### flatCloneWithoutAnnotation

    protected Sequence flatCloneWithoutAnnotation()

  Description copied from class: `Sequence`
  Works in analogy to `Object.clone()`, but does not clone the annotation. This method is used in `Sequence.annotate(boolean, SequenceAnnotation...)`.

  Specified by:
    `flatCloneWithoutAnnotation` in class `Sequence`
  Returns:
    the cloned `Sequence.CompositeSequence` without annotation

### getSample

    public static final Sample getSample(AlphabetContainer con,
                                         AbstractStringExtractor se)
                                  throws WrongSequenceTypeException,
                                         WrongAlphabetException,
                                         EmptySampleException

  This method allows to create a `Sample` containing `SparseSequence`s.

  Parameters:
    `con` - the `AlphabetContainer` for the `Sample` and `Sequence`s
    `se` - the `AbstractStringExtractor` that handles the `Sample` as `String`
  Returns:
    a `Sample` containing `SparseSequence`s
  Throws:
    `WrongSequenceTypeException` - if the `AlphabetContainer` is not simple or the internal `Alphabet` has more than 4 symbols
    `WrongAlphabetException` - if the `AlphabetContainer` is not discrete
    `EmptySampleException` - if a `Sample` with 0 (zero) `Sequence` should be created

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD