Struct C2Params

pub struct C2Params { /* private fields */ }

C2Params are a wrapper struct for a set of CompactParams and CompressedParams.

Example

To create your own parameters, use the constructor function

if let Some(cp1) = new_compact_params(2.0, 15, 9) {
    if let Some(cp2) = new_compressed_params(1.4, 31) {
        let cp = new_c2_params(cp1, cp2);
        // do something
    } else { }
} else { }

Implementations

impl C2Params

pub fn compact_ps(&self) -> &CompactParams

returns a reference to the underlying CompactParameters

pub fn compressed_ps(&self) -> &CompressedParams

returns a reference to the underlying CompressedParameters

Trait Implementations

impl Clone for C2Params

fn clone(&self) -> C2Params

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for C2Params

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

Formats the value using the given formatter.

impl Histogram<C2Params, usize, usize> for C2Histogram

fn labels(&self, params: &C2Params) -> Option<Box<dyn Iterator<Item = usize>>>

If possible, creates and returns an iterator for the labels for which the histogram has frequencies stored.

fn frequency(&self, label: usize, params: &C2Params) -> Option<usize>

If possible, returns the frequency of a particular label. The behavior need only be defined if the label is in the set of values returned from labels.

fn total(&self) -> usize

the total number of data-points in the histogram

impl HistogramParams for C2Params