From 83c56fc09a517b036d9a4d89910ea3cbed1e16e2 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Sun, 13 Aug 2023 14:23:30 +0000 Subject: [PATCH] build based on 544a071 --- dev/index.html | 2 +- dev/search/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dev/index.html b/dev/index.html index 90c20a5..42951df 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · VectorizedKmers.jl
Edit on GitHub

VectorizedKmers

Documentation for VectorizedKmers.

VectorizedKmers.AbstractKmerCount — Type
AbstractKmerCount{A, K, T <: Real, V <: AbstractVector{T}}

Abstract type for K-mer counts. A is the alphabet size, K is the K-mer size, and T is the element type of the underlying counts field, which in turn has type V{T}.

source
VectorizedKmers.AbstractKmerCountVector — Type
AbstractKmerCountVector{A, K, T <: Real, M <: AbstractMatrix{T}} <: AbstractVector{KmerCount{A, K, T}}

A container for K-mer counts, where K-mer counts are stored together as rows or columns in a matrix. A is the alphabet size, K is the K-mer size, T is the element type of the counts, and M is the type of the matrix in which the K-mer counts are stored.

source
VectorizedKmers.KmerCount — Type
KmerCount{A, K, T, V} <: AbstractKmerCount{A, K, T, V}

A concrete type for K-mer counts with vector type Base.Vector{T}.

source
VectorizedKmers.count_kmers! — Method
count_kmers!(kmer_count, kmers; reset=true)

Mutate the counts vector in kmer_count by adding the counts of each kmer in kmers. The K-mers in kmers must be represented as integers between 0 and length(kmer_count) - 1.

If reset is true, the counts vector will be zero-ed before counting.

This is not a very efficient method, since it takes an entire vector. It is mainly used for testing. Ideally the K-mers would be procedurally calculated in constant memory.

source
+Home · VectorizedKmers.jl
Edit on GitHub

VectorizedKmers

Documentation for VectorizedKmers.

VectorizedKmers.AbstractKmerCount — Type
AbstractKmerCount{A, K, T <: Real, V <: AbstractVector{T}}

Abstract type for K-mer counts. A is the alphabet size, K is the K-mer size, and T is the element type of the underlying counts field, which in turn has type V{T}.

source
VectorizedKmers.AbstractKmerCountVector — Type
AbstractKmerCountVector{A, K, T <: Real, M <: AbstractMatrix{T}} <: AbstractVector{KmerCount{A, K, T}}

A container for K-mer counts, where K-mer counts are stored together as rows or columns in a matrix. A is the alphabet size, K is the K-mer size, T is the element type of the counts, and M is the type of the matrix in which the K-mer counts are stored.

source
VectorizedKmers.KmerCount — Type
KmerCount{A, K, T, V} <: AbstractKmerCount{A, K, T, V}

A concrete type for K-mer counts with vector type Base.Vector{T}.

source
VectorizedKmers.count_kmers! — Method
count_kmers!(kmer_count, kmers; reset=true)

Mutate the counts vector in kmer_count by adding the counts of each kmer in kmers. The K-mers in kmers must be represented as integers between 0 and length(kmer_count) - 1.

If reset is true, the counts vector will be zero-ed before counting.

This is not a very efficient method, since it takes an entire vector. It is mainly used for testing. Ideally the K-mers would be procedurally calculated in constant memory.

source
diff --git a/dev/search/index.html b/dev/search/index.html index b057879..eeec863 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · VectorizedKmers.jl

Loading search...

    +Search · VectorizedKmers.jl

    Loading search...