Struct AssignmentBuilder 

pub struct AssignmentBuilder<X>
where
    X: Eq + Ord + Hash,
{ /* private fields */ }

Intermediate structure for building assignments

• In particular, this structrure will handle mass discounting
• There is no constructor for AssignmentBuilder: methods init_assignment or init_assignment_with_capacity of trait Lattice are used
• X : type of lattice element encoding

Implementations

impl<X> AssignmentBuilder<X>

where X: Clone + Eq + Ord + Hash,

pub unsafe fn unsafe_push( &mut self, element: X, weight: f64slx, ) -> Result<bool, String>

Unsafe push weighted element within assignment; weights smaller than ASSIGNMENT_EPSILON are discarded (result in Ok(false))

• method is unsafe since there is no consistency check that the encoded element comes from the lattice of the builder
• element: X : encoded element
• weight: f64slx : weight of the element
• Output:
  • true if weighted element is inserted
  • false if the weighted element is discarded
  • error if the weight is non finite or negative

pub fn push( &mut self, safe_element: SafeElement<X>, weight: f64slx, ) -> Result<bool, String>

Push weighted element within assignment; weights smaller than ASSIGNMENT_EPSILON are discarded (result in Ok(false))

• safe_element: SafeElement<X> : element with safe encoding
• weight: f64slx : weight of the element
• Output:
  • true if weighted element is inserted
  • false if the weighted element is discarded
  • error if the weight is non finite or negative

pub fn remove( &mut self, safe_element: &SafeElement<X>, ) -> Result<Option<(SafeElement<X>, f64slx)>, String>

Remove element from assignment

• safe_element: &SafeElement<X> : reference to lement to be removed
• Output:
  • Some safe element Some(se) if element was found
  • None if element was not found
  • error in case of lattice hash mismatch

pub fn prune<F>(&mut self, pruner: F)

where F: Fn(X, X) -> X,

Prune the assignment in order to reduce its size within acceptable range

• pruner: F : prunning function
  • two weighted encoded elements (x,wx) and (y,wy) to be prunned will be replaced by (pruner(x,y),wx + wy)
• F : type of pruner
• Output: nothing

pub fn scale(&mut self, scaler: f64slx) -> Result<(), String>

Scale the assignment weights

• scaler: f64slx : scale multiplier
• Output: nothing or error

pub fn neg_shift(&mut self, neg_shift: f64slx) -> Result<(), String>

Shift the assignment negatively

• Weighted element (x,w) is replaced by (x,w - neg_shift)
• neg_shift: f64slx : negative shift
• Output: nothing or error

pub fn cumul_weight(&self) -> Result<f64slx, String>

Compute the cumulative weight of the assignment

• Output: the cumulative weight or an error if some weights are non finite or negative

pub fn normalize(&mut self) -> Result<(), String>

Normalize the assignment

• Output: nothing or error

pub fn map<F>(self, f: F) -> Result<Self, String>

where F: FnMut(f64slx) -> f64slx,

Map the assignment with a closure

• f: F : a closure
• F : type of the closure
• Output: mapped assignment or an error if some mapped weights are non finite or negative

pub fn self_map<F>(&mut self, f: F) -> Result<(), String>

where F: FnMut(f64slx) -> f64slx,

Self-map the assignment with a closure

• f: F : a closure
• F : type of the closure
• Output: nothing or an error if some mapped weights are non finite or negative

Trait Implementations

impl<X> Add<()> for AssignmentBuilder<X>

where X: Eq + Ord + Hash + Clone,

type Output = Assignment<X>

The resulting type after applying the + operator.

fn add(self, _: ()) -> Self::Output

Performs the + operation.

impl<X, T> Add<(SafeElement<X>, T)> for AssignmentBuilder<X>

where X: Eq + Ord + Hash + Clone, T: Into<f64slx>,

type Output = AssignmentBuilder<X>

The resulting type after applying the + operator.

fn add(self, (x, w): (SafeElement<X>, T)) -> Self::Output

Performs the + operation.

impl<X> Clone for AssignmentBuilder<X>

where X: Eq + Ord + Hash + Clone,

fn clone(&self) -> AssignmentBuilder<X>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<X> From<AssignmentBuilder<X>> for Assignment<X>

where X: Eq + Ord + Hash,

fn from(value: AssignmentBuilder<X>) -> Self

Converts to this type from the input type.

impl<X> HashedTypeDef for AssignmentBuilder<X>

where X: Eq + Ord + Hash + HashedTypeDef, (): HashedTypeDef,

const TYPE_HASH_NATIVE: u128 = 47_772_005_739_513_253_640_004_655_473_980_371_520u128

native hash computation

const TYPE_HASH_LE: u128 = _

hash encoded to little endianess

const TYPE_HASH_BE: u128 = _

hash encoded to big endianess

const UUID: Uuid = _

hash encoded to Uuid