Struct biodivine_sketchbook::sketchbook::observations::_observation::Observation

source ·

pub struct Observation {
    id: ObservationId,
    name: String,
    annotation: String,
    values: Vec<VarValue>,
}

Expand description

A single named observation, i.e., an ordered vector of binarized values.

Fields§

§id: ObservationId§name: String§annotation: String§values: Vec<VarValue>

Implementations§

source §

impl Observation

Creating observations.

source

pub fn new(values: Vec<VarValue>, id: &str) -> Result<Self, String>

Create Observation object from a vector of values, and string ID (which must be a valid identifier).

Name is initialized same as ID, and annotation is empty. For full initializer with name and annotation, check Self::new_annotated.

source

pub fn new_annotated( values: Vec<VarValue>, id: &str, name: &str, annot: &str, ) -> Result<Self, String>

Create Observation object from a vector with values, string ID (which must be a valid identifier), string name, and annotation.

source

pub fn new_full_ones(n: usize, id: &str) -> Result<Self, String>

Create Observation encoding a vector of n ones. Name is initialized same as ID, and annotation is empty.

source

pub fn new_full_zeros(n: usize, id: &str) -> Result<Self, String>

Create Observation encoding a vector of n zeros. Name is initialized same as ID, and annotation is empty.

source

pub fn new_full_unspecified(n: usize, id: &str) -> Result<Self, String>

Create Observation encoding a vector of n unspecified values. Name is initialized same as ID, and annotation is empty.

source

pub fn try_from_str(observation_str: &str, id: &str) -> Result<Self, String>

Create Observation object from string encoding of its (ordered) values. Values are encoded using characters 1, 0, or *.

Name is initialized same as ID, and annotation is empty. For full initializer with name and annotation, check Self::try_from_str_annotated.

source

pub fn try_from_str_annotated( observation_str: &str, id: &str, name: &str, annot: &str, ) -> Result<Self, String>

Create Observation object from string encoding of its (ordered) values. Values are encoded using characters 1, 0, or *.

source §

impl Observation

Editing observations.

source

pub fn set_name(&mut self, name: &str) -> Result<(), String>

Set name.

source

pub fn set_annotation(&mut self, annotation: &str)

Set annotation string.

source

pub fn set_value(&mut self, index: usize, value: VarValue) -> Result<(), String>

Set the value at given idx.

source

pub fn set_value_by_str( &mut self, index: usize, value: &str, ) -> Result<(), String>

Set the value (one of the “0”/“1”/“*”) at given idx.

source

pub fn set_all_values(&mut self, values: Vec<VarValue>) -> Result<(), String>

Set all the values in this observation. The new vector of values must have the same number of values as the original observation (“arity” does not change).

source

pub fn set_all_values_by_str(&mut self, values: &str) -> Result<(), String>

Set all the values in this observation via its string encoding (string of “0”/“1”/“*”). The new vector of values must have the same number of values as the original observation (“arity” does not change).

source