Struct compact_genome::implementation::bit_vec_sequence_store::BitVectorSequenceStore

pub struct BitVectorSequenceStore<AlphabetType: Alphabet> { /* private fields */ }

A bitvector based sequence store.

Implementations

impl<AlphabetType: Alphabet> BitVectorSequenceStore<AlphabetType>

pub fn new() -> Self

Creates a new instance.

pub fn size_in_memory(&self) -> usize

Returns the number of bytes consumed by the characters stored in this sequence store.

Trait Implementations

impl<AlphabetType: Clone + Alphabet> Clone for BitVectorSequenceStore<AlphabetType>

fn clone(&self) -> BitVectorSequenceStore<AlphabetType>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<AlphabetType: Debug + Alphabet> Debug for BitVectorSequenceStore<AlphabetType>

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

Formats the value using the given formatter.

impl<AlphabetType: Default + Alphabet> Default for BitVectorSequenceStore<AlphabetType>

fn default() -> BitVectorSequenceStore<AlphabetType>

Returns the “default value” for a type.

impl<AlphabetType: Alphabet + 'static> InverseMappingSequenceStore<AlphabetType> for BitVectorSequenceStore<AlphabetType>

fn map_sequence_ref_to_handle( &self, sequence_ref: &Self::SequenceRef, ) -> Self::Handle

Returns a handle that refers the given sequence reference.

impl<AlphabetType: PartialEq + Alphabet> PartialEq for BitVectorSequenceStore<AlphabetType>

fn eq(&self, other: &BitVectorSequenceStore<AlphabetType>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<AlphabetType: Alphabet + 'static> SequenceStore<AlphabetType> for BitVectorSequenceStore<AlphabetType>

type Handle = BitVectorSequenceStoreHandle<AlphabetType>

A handle to a sequence in this store. Can be used to retrieve the respective sequence.

type SequenceRef = BitVectorSubGenome<AlphabetType>

A reference to a sequence stored in this store. This trait only uses &SequenceRef, so SequenceRef should be the base type and not a reference type itself.

fn add<Sequence: GenomeSequence<AlphabetType, Subsequence> + ?Sized, Subsequence: GenomeSequence<AlphabetType, Subsequence> + ?Sized>( &mut self, s: &Sequence, ) -> Self::Handle

Adds a sequence to this store and returns a handle for later retrieval. Handles do not borrow the sequence store, so they can exist while the store is modified.

fn add_from_iter( &mut self, iter: impl IntoIterator<Item = <AlphabetType as Alphabet>::CharacterType>, ) -> Self::Handle

Adds a sequence to this store and returns a handle for later retrieval. Handles do not borrow the sequence store, so they can exist while the store is modified.

fn add_from_iter_u8<IteratorType: IntoIterator<Item = u8>>( &mut self, iter: IteratorType, ) -> Result<Self::Handle, AlphabetError>

Adds a sequence to this store and returns a handle for later retrieval. Handles do not borrow the sequence store, so they can exist while the store is modified.

fn get(&self, handle: &Self::Handle) -> &Self::SequenceRef

Returns a reference to a sequence in this store, given the handle. The reference borrows the sequence store, so it cannot be mutated while references exist. On the other hand, handles do not borrow, so they can exist while the store is modified.

fn add_from_slice_u8( &mut self, slice: &[u8], ) -> Result<Self::Handle, AlphabetError>

Adds a sequence to this store and returns a handle for later retrieval. Handles do not borrow the sequence store, so they can exist while the store is modified.

impl<AlphabetType: Eq + Alphabet> Eq for BitVectorSequenceStore<AlphabetType>

impl<AlphabetType: Alphabet> StructuralPartialEq for BitVectorSequenceStore<AlphabetType>