Enum d4::Dictionary

pub enum Dictionary {
    SimpleRange {
        low: i32,
        high: i32,
    },
    Dictionary {
        _v2i_map: Box<HashMap<i32, u32>>,
        i2v_map: Box<Vec<i32>>,
    },
}

The dictionary (a.k.a encoding table)

Variants

SimpleRange

The dictionary for a consequtive range

Fields of SimpleRange

low: i32high: i32

Dictionary

The dctionary described as a key-value map

Fields of Dictionary

_v2i_map: Box<HashMap<i32, u32>>i2v_map: Box<Vec<i32>>

Implementations

impl Dictionary

pub fn pretty_print(&self) -> Result<String>

Pretty print the dictionary in JSON format

pub fn from_sample_bam<P: AsRef<Path>, F: Fn(&str, usize) -> bool>(
    path: P,
    filter: F,
    reference: Option<&str>,
    min_mq: u8
) -> Result<Self, Box<dyn Error>>

Run the random sampling algorithm on an alignment file, determining the optimal dictionary configuration

pub fn from_dict_list(mapping: Vec<i32>) -> Result<Self>

Create a dictioanry from the mapping vector

pub fn new_dictionary_from_file<R: Read>(file: R) -> Result<Self>

Create a dictionary from a dictionay specification file. The dictionary has 2^K lines, the N-th lines contains the actual value that code N-1 encodes.

pub fn new_simple_range_dict(left: i32, right: i32) -> Result<Self>

Create a new simple range dictionary

Trait Implementations

impl Clone for Dictionary

fn clone(&self) -> Dictionary

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for Dictionary

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Dictionary

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

Serialize this value into the given Serde serializer.