Enum lace::Given

pub enum Given<Ix: ColumnIndex> {
    Conditions(Vec<(Ix, Datum)>),
    Nothing,
}

Describes a the conditions (or not) on a conditional distribution

Variants

Conditions(Vec<(Ix, Datum)>)

The conditions in (column_id, value) tuples. The tuple (11, Datum::Continuous(2.3)) indicates that we wish to condition on the value of column 11 being 2.3.

Nothing

The absence of conditioning observations

Implementations

impl<Ix: ColumnIndex> Given<Ix>

pub fn is_nothing(&self) -> bool

Determine whether there are no conditions

Example

let nothing_given = Given::<usize>::Nothing;

assert!(nothing_given.is_nothing());

let something_given = Given::Conditions(
    vec![(1, Datum::Categorical(1_u8.into()))]
);

assert!(!something_given.is_nothing());

pub fn is_conditions(&self) -> bool

Determine whether there are conditions

Example

let nothing_given = Given::<usize>::Nothing;

assert!(!nothing_given.is_conditions());

let something_given = Given::Conditions(
    vec![(1, Datum::Categorical(1_u8.into()))]
);

assert!(something_given.is_conditions());

pub fn canonical(self, codebook: &Codebook) -> Result<Given<usize>, IndexError>

Attempt to convert all indices in the condition into integers.

Notes

Will return IndexError if any of the names do not exists or indices are out of bounds.

Trait Implementations

impl<Ix: Clone + ColumnIndex> Clone for Given<Ix>

fn clone(&self) -> Given<Ix>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Ix: Debug + ColumnIndex> Debug for Given<Ix>

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

Formats the value using the given formatter.

impl<Ix: ColumnIndex> Default for Given<Ix>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, Ix> Deserialize<'de> for Given<Ix>

where Ix: Deserialize<'de> + ColumnIndex,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Ix: Hash + ColumnIndex> Hash for Given<Ix>

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<Ix: PartialEq + ColumnIndex> PartialEq for Given<Ix>

fn eq(&self, other: &Given<Ix>) -> bool

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

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.

impl<Ix: PartialOrd + ColumnIndex> PartialOrd for Given<Ix>

fn partial_cmp(&self, other: &Given<Ix>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Ix> Serialize for Given<Ix>

where Ix: Serialize + ColumnIndex,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Ix: ColumnIndex + Hash + Eq> TryInto<Given<Ix>> for Option<Vec<(Ix, Datum)>>

type Error = IntoGivenError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Given<Ix>, Self::Error>

Performs the conversion.

impl<Ix: ColumnIndex + Hash + Eq> TryInto<Given<Ix>> for Vec<(Ix, Datum)>

type Error = IntoGivenError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Given<Ix>, Self::Error>

Performs the conversion.

impl<Ix: ColumnIndex> StructuralPartialEq for Given<Ix>