KmerBigSet

class KmerBigSet(val kmerSize: Int = 21, val bothStrands: Boolean = true, val stepSize: Int = 1, val keepMinOnly: Boolean = false) : AbstractKmerSet

A set of kmers capable of storing up to 134217728 * (2^31 − 1) unique kmers. Includes a count value for each kmer, up to 128. Recommended use is for dense tables where most possible kmers of length kmerSize are present or where the number of unique kmers exceeds MAX_VALUE of Int.

Constructors

Link copied to clipboard
constructor(kmerSize: Int = 21, bothStrands: Boolean = true, stepSize: Int = 1, keepMinOnly: Boolean = false)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard

Generates kmers from a nucleotide sequence and adds those kmers to this set.

Link copied to clipboard
fun addSet(kmers: AbstractSparseKmerSet, useCounts: Boolean = true)

Adds all kmers from kmers to this set. If kmers is a KmerMultiSet and useCounts is true, the count of each kmer in kmers will be added. If kmers is a KmerSet or useCounts is false, one count of each kmer in kmers will be added. kmers must have the same initialization parameters as this set: kmerSize, bothStrands, and keepMinOnly

Link copied to clipboard

Returns the number of ambiguous kmers in the set.

Link copied to clipboard
open override fun contains(kmer: Kmer): Boolean

Returns true if kmer appears at least once in the set.

Link copied to clipboard
open override fun getCountOf(kmer: Kmer): Int

Returns the number of times kmer appears in the set.

Link copied to clipboard
open override fun isEmpty(): Boolean

Returns true if no kmer appears at least once in the set.

Link copied to clipboard

Returns the total length of sequence(s) used to generate this set.

Link copied to clipboard
open override fun setSize(): Long

Returns the number of unique kmers in this set that have a count of at least one.

Link copied to clipboard
open override fun toString(): String

Summarizes set parameters and size in string format.