pub struct EstimatedUnionCardinalities<F> { /* private fields */ }
Expand description

A struct for more readable code.

Implementations§

source§

impl<F: MaxMin + One + Add<F, Output = F> + Sub<F, Output = F> + Div<F, Output = F> + Copy> EstimatedUnionCardinalities<F>

source

pub fn get_left_cardinality(&self) -> F

Returns the estimated cardinality of the left set.

Examples
use hyperloglog_rs::EstimatedUnionCardinalities;

let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));

let left_cardinality = estimated_union_cardinalities.get_left_cardinality();

assert_eq!(left_cardinality, 2.0);
source

pub fn get_right_cardinality(&self) -> F

Returns the estimated cardinality of the right set.

Examples
use hyperloglog_rs::EstimatedUnionCardinalities;

let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));

let right_cardinality = estimated_union_cardinalities.get_right_cardinality();

assert_eq!(right_cardinality, 3.0);
source

pub fn get_union_cardinality(&self) -> F

Returns the estimated cardinality of the union of the two sets.

Examples
use hyperloglog_rs::EstimatedUnionCardinalities;

let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));

let union_cardinality = estimated_union_cardinalities.get_union_cardinality();

assert_eq!(union_cardinality, 4.0);
source

pub fn get_intersection_cardinality(&self) -> F

Returns the estimated cardinality of the intersection of the two sets.

Examples
use hyperloglog_rs::EstimatedUnionCardinalities;

let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));

let intersection_cardinality = estimated_union_cardinalities.get_intersection_cardinality();

assert_eq!(intersection_cardinality, 1.0);
source

pub fn get_left_difference_cardinality(&self) -> F

Returns the estimated cardinality of the left set minus the right set.

Examples
use hyperloglog_rs::EstimatedUnionCardinalities;

let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));

let left_minus_right_cardinality = estimated_union_cardinalities.get_left_difference_cardinality();

assert_eq!(left_minus_right_cardinality, 1.0);
source

pub fn get_right_difference_cardinality(&self) -> F

Returns the estimated cardinality of the right set minus the left set.

Examples
use hyperloglog_rs::EstimatedUnionCardinalities;

let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));

let right_minus_left_cardinality = estimated_union_cardinalities.get_right_difference_cardinality();

assert_eq!(right_minus_left_cardinality, 2.0);
source

pub fn get_symmetric_difference_cardinality(&self) -> F

Returns the estimated cardinality of the symmetric difference of the two sets.

Examples
use hyperloglog_rs::EstimatedUnionCardinalities;

let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));

let symmetric_difference_cardinality = estimated_union_cardinalities.get_symmetric_difference_cardinality();

assert_eq!(symmetric_difference_cardinality, 3.0);
source

pub fn get_jaccard_index(&self) -> F

Returns the estimated Jaccard index of the two sets.

Examples
use hyperloglog_rs::EstimatedUnionCardinalities;

let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));

let jaccard_index = estimated_union_cardinalities.get_jaccard_index();

assert_eq!(jaccard_index, 1.0 / 4.0, "Example 1: Expected 1.0 / 4.0, got {}", jaccard_index);

Trait Implementations§

source§

impl<F: Clone> Clone for EstimatedUnionCardinalities<F>

source§

fn clone(&self) -> EstimatedUnionCardinalities<F>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<F: Debug> Debug for EstimatedUnionCardinalities<F>

source§

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

Formats the value using the given formatter. Read more
source§

impl<F: Default> Default for EstimatedUnionCardinalities<F>

source§

fn default() -> EstimatedUnionCardinalities<F>

Returns the “default value” for a type. Read more
source§

impl<'de, F> Deserialize<'de> for EstimatedUnionCardinalities<F>
where F: Deserialize<'de>,

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl<F> From<(F, F, F)> for EstimatedUnionCardinalities<F>

source§

fn from(value: (F, F, F)) -> Self

Converts to this type from the input type.
source§

impl<F: PartialEq> PartialEq for EstimatedUnionCardinalities<F>

source§

fn eq(&self, other: &EstimatedUnionCardinalities<F>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<F> Serialize for EstimatedUnionCardinalities<F>
where F: Serialize,

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl<F: Copy> Copy for EstimatedUnionCardinalities<F>

source§

impl<F> StructuralPartialEq for EstimatedUnionCardinalities<F>

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,