Struct bigsi_rs::Bigsi

pub struct Bigsi {
    pub bigsi: Vec<BitVec>,
    pub num_hashes: u64,
    pub accessions: u64,
}

BIGSI-like data structure

Fields

bigsi: Vec<BitVec>

num_hashes: u64

accessions: u64

Methods

impl Bigsi

pub fn new(m: usize, n: u64, eta: u64) -> Bigsi

Create a new index of size m, n aceesions and eta hashes.

pub fn default() -> Bigsi

Create a new index with default parameters (size: 100, 2 hashes, 10 accessions).

pub fn insert(&mut self, accession: u64, value: &str)

Insert new value for an accession.

pub fn slim(&mut self)

Shrink uninformative elements in index.

pub fn get(&self, value: &str) -> Vec<usize>

Given a value, return a vector with accessions containing the query value

pub fn get_bv(&self, value: &str) -> BitVec

Given a value, return hits as bit vector

pub fn merge(&mut self, other_bigsi: &Bigsi)

concatenate two indices

pub fn save(&self, file_name: &str)

Save index to file

pub fn read(&mut self, path: &str)

Read index from file

Trait Implementations

impl Debug for Bigsi

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Bigsi

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Bigsi> for Bigsi

fn eq(&self, other: &Bigsi) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Bigsi) -> bool

This method tests for !=.

impl Serialize for Bigsi

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Bigsi