Struct libradicl::BarcodeLookupMap

pub struct BarcodeLookupMap {
    pub barcodes: Vec<u64>,
    // some fields omitted
}

Fields

barcodes: Vec<u64>

Implementations

impl BarcodeLookupMap

pub fn new(kv: Vec<u64>, bclen: u32) -> BarcodeLookupMap

pub fn barcode_for_idx(&self, idx: usize) -> u64

pub fn find_exact(&self, query: u64) -> Option<usize>

pub fn find_neighbors(
    &self,
    query: u64,
    try_exact: bool
) -> (Option<usize>, usize)

The find function searches for the barcode query in the BarcodeLookupMap. It returns a tuple (Option<usize>, usize) where the first element is either Some(usize) or None. If Some(usize) is returned, this is the index of a matching/neighboring barcode if None is returned, then no match was found. The second element is either 0, 1 or 2. If 0, no match was found; if 1 a unique match was found, if 2 then 2 or more equally good matches were found.

The parameter try_exact controls whether a an exact search is performed or not. If this parameter is true, an exact search is performed before a neighbor search. Otherwise, the exact search is skipped.

Trait Implementations

impl Debug for BarcodeLookupMap

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BarcodeLookupMap

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

Deserialize this value from the given Serde deserializer.

impl Serialize for BarcodeLookupMap

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

Serialize this value into the given Serde serializer.