pub struct FactorGraphModel {
pub variables: Vec<VizVariableNode>,
pub factors: Vec<VizFactorNode>,
}Expand description
A lightweight factor graph representation for visualization.
This is intentionally decoupled from FactorGraph so that callers
can build ad-hoc models (e.g. from external data) and still use the
rendering / statistics helpers.
Fields§
§variables: Vec<VizVariableNode>Variable nodes.
factors: Vec<VizFactorNode>Factor nodes.
Implementations§
Source§impl FactorGraphModel
impl FactorGraphModel
Sourcepub fn from_factor_graph(fg: &FactorGraph) -> Self
pub fn from_factor_graph(fg: &FactorGraph) -> Self
Build a FactorGraphModel from an existing FactorGraph.
Variable ordering is arbitrary (HashMap iteration order).
Sourcepub fn add_variable(
&mut self,
name: impl Into<String>,
domain_size: usize,
) -> usize
pub fn add_variable( &mut self, name: impl Into<String>, domain_size: usize, ) -> usize
Add a variable node. Returns the index of the newly added variable.
Sourcepub fn add_factor(
&mut self,
name: impl Into<String>,
variable_indices: Vec<usize>,
)
pub fn add_factor( &mut self, name: impl Into<String>, variable_indices: Vec<usize>, )
Add a factor node connecting the given variable indices.
Sourcepub fn variable_count(&self) -> usize
pub fn variable_count(&self) -> usize
Number of variable nodes.
Sourcepub fn factor_count(&self) -> usize
pub fn factor_count(&self) -> usize
Number of factor nodes.
Sourcepub fn edge_count(&self) -> usize
pub fn edge_count(&self) -> usize
Total number of edges (factor-variable connections).
Trait Implementations§
Source§impl Clone for FactorGraphModel
impl Clone for FactorGraphModel
Source§fn clone(&self) -> FactorGraphModel
fn clone(&self) -> FactorGraphModel
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for FactorGraphModel
impl Debug for FactorGraphModel
Source§impl Default for FactorGraphModel
impl Default for FactorGraphModel
Source§fn default() -> FactorGraphModel
fn default() -> FactorGraphModel
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for FactorGraphModel
impl RefUnwindSafe for FactorGraphModel
impl Send for FactorGraphModel
impl Sync for FactorGraphModel
impl Unpin for FactorGraphModel
impl UnsafeUnpin for FactorGraphModel
impl UnwindSafe for FactorGraphModel
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.