sourmash 0.22.0

tools for comparing biological sequences with k-mer sketches
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! # Compute, compare and search signatures for nucleotide (DNA/RNA) and protein sequences.
//!
//! sourmash is a command-line tool and Python library for computing
//! [MinHash sketches][0] from DNA sequences, comparing them to each other,
//! and plotting the results.
//! This allows you to estimate sequence similarity between even very
//! large data sets quickly and accurately.
//!
//! [0]: https://en.wikipedia.org/wiki/MinHash
//!
//! sourmash can be used to quickly search large databases of genomes
//! for matches to query genomes and metagenomes.
//!
//! sourmash also includes k-mer based taxonomic exploration and
//! classification routines for genome and metagenome analysis. These
//! routines can use the NCBI taxonomy but do not depend on it in any way.
//! Documentation and further examples for each module can be found in the module descriptions below.

// TODO: remove this line and update all the appropriate type names for 1.0
#![allow(clippy::upper_case_acronyms)]

pub mod errors;
pub use errors::SourmashError as Error;
pub type Result<T> = std::result::Result<T, Error>;

pub mod prelude;

// All the cbindgen:ignore comments below are for avoiding parsing errors when
// running cbindgen (mostly because tuples are not supported).
// None of these influence the generated C header, because only items defined
// in the `ffi` module are actually exported.
// Note: these tuple errors tend to show up in `Builder` structs, which are
// generated by typed-builder.

/// cbindgen:ignore
pub mod cmd;

pub mod ani_utils;
pub mod collection;
pub mod encodings;
/// cbindgen:ignore
pub mod index;
pub mod manifest;
/// cbindgen:ignore
pub mod selection;
/// cbindgen:ignore
pub mod signature;
/// cbindgen:ignore
pub mod sketch;
/// cbindgen:ignore
pub mod storage;

use cfg_if::cfg_if;
use murmurhash3::murmurhash3_x64_128;

cfg_if! {
    if #[cfg(all(target_arch = "wasm32", target_os = "unknown"))] {
        // Explicitly keeping emscripten and wasi out of this
        /// cbindgen:ignore
        pub mod wasm;
    } else {
        pub mod ffi;
    }
}

type HashIntoType = u64;
pub type ScaledType = u32;

pub fn _hash_murmur(kmer: &[u8], seed: u64) -> u64 {
    murmurhash3_x64_128(kmer, seed).0
}