Packages

trait Reducer extends AnyRef

A method for combining identical k-mers (which may have associated extra data)

Linear Supertypes
AnyRef, Any
Known Subclasses
CountReducer, CountersSubtractReducer, KmerSubtractReducer, LeftReducer, MaxReducer, MinReducer, RightReducer, SumReducer
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Reducer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def params: ReduceParams
  2. abstract def reduceEqualKmers(table: KmerTable, into: Int, from: Int): Unit

    Apply a binary operation op(into, from) on the tags of the k-mers at these positions, writing the result in the tags of "into", writing the zero value into the tags of "from".

    Apply a binary operation op(into, from) on the tags of the k-mers at these positions, writing the result in the tags of "into", writing the zero value into the tags of "from". This method will only be called on equal k-mers.

    table

    The table containing k-mers

    into

    Target k-mer index in the table (k-mer A in op(A,B))

    from

    Source k-mer index in the table (k-mer B in op(A,B))

  3. abstract val tagOffset: Int

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hasNonZeroTag(tags: Array[Tag]): Boolean
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def k: Int
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. def orientation: Orientation

    Orientation filter for k-mers

  17. def preprocessFirst(bucket: ReducibleBucket): ReducibleBucket

    Preprocess bucket A prior to op(A,B)

  18. def preprocessSecond(bucket: ReducibleBucket): ReducibleBucket

    Preprocess bucket B prior to op(A,B)

  19. def reduceKmers(table: KmerTable): KmerTable

    Reduce tags of a single KmerTable by combining equal k-mers.

    Reduce tags of a single KmerTable by combining equal k-mers. Requires that the table was sorted at construction time. Mutates the table.

    table

    the KmerTable

  20. def shouldKeep(table: KmerTable, kmer: Int): Boolean

    Whether to keep the k-mer (together with tag data) after reduction.

    Whether to keep the k-mer (together with tag data) after reduction.

    table

    The table containing k-mers

    kmer

    Index of k-mer to be tested

  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. val zeroValue: Tag

    A special value that is used to indicate non-existent/redundant k-mers.

    A special value that is used to indicate non-existent/redundant k-mers. Should also have the property that op(A, zero) == op(zero, A) for all A

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped