Struct biodivine_lib_param_bn::VariableId

source · [−]

pub struct VariableId(pub(crate) usize);

Expand description

A type-safe index of a Variable inside a RegulatoryGraph (or a BooleanNetwork).

If needed, it can be converted into usize for serialisation and safely read again by providing the original RegulatoryGraph as context to the VariableId::try_from_usize.

Warning: Do not mix type-safe indices between different networks/graphs!

Tuple Fields

0: usize

Implementations

impl VariableId

pub fn try_from_usize(
context: &RegulatoryGraph,
value: usize
) -> Option<VariableId>

Try to construct a VariableId from the given usize value. The id must be valid inside the context of the specified RegulatoryGraph, otherwise None is returned.

Trait Implementations

impl Clone for VariableId

fn clone(&self) -> VariableId

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

impl Debug for VariableId

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

Formats the value using the given formatter. Read more

impl Display for VariableId

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

Formats the value using the given formatter. Read more

impl From<VariableId> for usize

fn from(value: VariableId) -> Self

Performs the conversion.

impl Hash for VariableId

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

impl Index<VariableId> for BooleanNetwork

Allow indexing BooleanNetwork using VariableId objects.

type Output = Variable

The returned type after indexing.

fn index(&self, index: VariableId) -> &Self::Output

Performs the indexing (container[index]) operation. Read more

impl Index<VariableId> for RegulatoryGraph

Allow indexing RegulatoryGraph using VariableId objects.

type Output = Variable

The returned type after indexing.

fn index(&self, index: VariableId) -> &Self::Output

Performs the indexing (container[index]) operation. Read more

impl Ord for VariableId

fn cmp(&self, other: &VariableId) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

impl PartialEq<VariableId> for VariableId

fn eq(&self, other: &VariableId) -> bool

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

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

This method tests for !=.

impl PartialOrd<VariableId> for VariableId

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

impl Copy for VariableId

impl Eq for VariableId

impl StructuralEq for VariableId

impl StructuralPartialEq for VariableId

Auto Trait Implementations

impl RefUnwindSafe for VariableId

impl Send for VariableId

impl Sync for VariableId

impl Unpin for VariableId

impl UnwindSafe for VariableId

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V