Struct biodivine_lib_param_bn::Regulation

pub struct Regulation {
    pub(crate) regulator: VariableId,
    pub(crate) target: VariableId,
    pub(crate) observable: bool,
    pub(crate) monotonicity: Option<Monotonicity>,
}

Describes an interaction between two Variables in a RegulatoryGraph (or a BooleanNetwork).

Every regulation can be monotonous, and can be set as observable:

• Monotonicity is either positive or negative and signifies that the influence of the regulator on the target has to increase or decrease the target value respectively.
• If observability is set to true, the regulator must have influence on the outcome of the target update function in some context. If set to false, this is not enforced (i.e. the regulator can have an influence on the target, but it is not required).

Regulations can be represented as strings in the form "regulator_name 'relationship' target_name". The ‘relationship’ starts with -, which is followed by > for activation (positive monotonicity), | for inhibition (negative monotonicity) or ? for unspecified monotonicity. Finally, an additional ? at the end of ‘relationship’ signifies a non-observable regulation. Together, this gives the following options: ->, ->?, -|, -|?, -?, -??.

Regulations cannot be created directly, they are only borrowed from a RegulatoryGraph or a BooleanNetwork.

Fields

regulator: VariableId

target: VariableId

observable: bool

monotonicity: Option<Monotonicity>

Implementations

impl Regulation

Basic getters.

pub fn is_observable(&self) -> bool

Check if the regulation is marked as observable.

pub fn get_monotonicity(&self) -> Option<Monotonicity>

Return monotonicity of the regulation (if specified).

pub fn get_regulator(&self) -> VariableId

Get the VariableId if the regulator.

pub fn get_target(&self) -> VariableId

Get the VariableId of the target.

impl Regulation

Serialization utility methods.

pub fn try_from_string(
    regulation: &str
) -> Option<(String, Option<Monotonicity>, bool, String)>

Try to read all available information about a regulation from a given string in the standard format.

The returned data correspond to the items as they appear in the string, i.e. regulator, monotonicity, observability and target. If the string is not valid, returns None.

pub fn to_string(&self, context: &RegulatoryGraph) -> String

Convert to standard string format using variable names provided by a RegulatoryGraph.

Trait Implementations

impl Clone for Regulation

fn clone(&self) -> Regulation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Regulation

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

Formats the value using the given formatter.

impl Hash for Regulation

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Regulation> for Regulation

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

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

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

This method tests for !=.

impl Eq for Regulation

impl StructuralEq for Regulation

impl StructuralPartialEq for Regulation