Struct MultiSampleEdge 

pub struct MultiSampleEdge { /* private fields */ }

Edge class for connecting nodes in the graph that tracks some per-sample information.

This class extends BaseEdge with the additional functionality of tracking the maximum multiplicity seen within any single sample. The workflow for using this class is:

{@code
     MultiSampleEdge e = new MultiSampleEdge(ref, 1)
     e.incMultiplicity(1)              // total is 2, per sample is 2, max per sample is 1
     e.getPruningMultiplicity()        // = 1
     e.flushSingleSampleMultiplicity() // total is 2, per sample is 0, max per sample is 2
     e.getPruningMultiplicity()        // = 2
     e.incMultiplicity(3)              // total is 5, per sample is 3, max per sample is 2
     e.getPruningMultiplicity()        // = 2
     e.flushSingleSampleMultiplicity() // total is 5, per sample is 0, max per sample is 3
     e.getPruningMultiplicity()        // = 3
}

Implementations

impl MultiSampleEdge

pub fn set( &mut self, is_ref: bool, multiplicity: usize, single_sample_capacity: usize, )

pub fn flush_single_sample_multiplicity(&mut self)

update the single sample multiplicities by adding the current single sample multiplicity to the priority queue, and reset the current single sample multiplicity to 0.

pub fn inc_multiplicity(&mut self, incr: usize)

pub fn get_pruning_multiplicity(&self) -> usize

pub fn add_reference_index(&mut self, i: usize)

pub fn get_reference_path_indexes(&self) -> &Vec<usize>

pub fn get_current_single_sample_multiplicity(&self) -> usize

Trait Implementations

impl BaseEdge for MultiSampleEdge

fn new( is_ref: bool, multiplicity: usize, single_sample_capacity: usize, ) -> MultiSampleEdge

Create a new MultiSampleEdge with weight multiplicity and, if isRef == true, indicates a path through the reference

@param isRef indicates whether this edge is a path through the reference @param multiplicity the number of observations of this edge in this sample @param singleSampleCapacity the max number of samples to track edge multiplicities

fn get_multiplicity(&self) -> usize

Get the number of observations of paths connecting two vertices @return a positive integer >= 0

fn get_dot_label(&self) -> String

Get the DOT format label for this edge, to be displayed when printing this edge to a DOT file @return a non-null string

fn inc_multiplicity(&mut self, incr: usize)

Increase the multiplicity of this edge by incr @param incr the change in this multiplicity, must be >= 0

fn get_pruning_multiplicity(&self) -> usize

A special assessor that returns the multiplicity that should be used by pruning algorithm

@return the multiplicity value that should be used for pruning

fn set_multiplicity(&mut self, value: usize)

Set the multiplicity of this edge to value @param value an integer >= 0

fn is_ref(&self) -> bool

Does this edge indicate a path through the reference graph? @return true if so

fn set_is_ref(&mut self, is_ref: bool)

Indicate that this edge follows the reference sequence, or not @param isRef true if this is a reference edge

fn add(&mut self, edge: Self)

Add edge to this edge, updating isRef and multiplicity as appropriate

isRef is simply the or of this and edge multiplicity is the sum

@param edge the edge to add @return this

fn make_o_r_edge( edges: Vec<Self>, multiplicity: usize, single_sample_capacity: usize, ) -> Self

Create a new BaseEdge with the given multiplicity. The resulting edge is a reference edge if any of the argument edges are reference.

@param edges a collection of edges to or their isRef values @param multiplicity our desired multiplicity @return a newly allocated BaseEdge

fn to_string(&self) -> String

impl Clone for MultiSampleEdge

fn clone(&self) -> MultiSampleEdge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiSampleEdge

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

Formats the value using the given formatter.

impl Hash for MultiSampleEdge

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MultiSampleEdge

fn eq(&self, other: &Self) -> 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 Eq for MultiSampleEdge