Struct nadi_core::network::Network

#[repr(C)]
pub struct Network { /* private fields */ }

Network is a collection of Nodes, with Connection information. The connection information is saved in the nodes itself (inputs and output variables), but they are assigned from the network.

The nadi system (lit, river system), is designed for the connections between points along a river. Out of different types of river networks possible, it can only handle non-branching tributaries system, where each point can have zero to multiple inputs, but can only have one output. Overall the system should have a single output point. There can be branches in the river itself in the physical sense as long as they converse before the next point of interests. There cannot be node points that have more than one path to reach another node in the representative system.

Here is an example network file,

cannelton -> newburgh
newburgh -> evansville
evansville -> "jt-myers"
"jt-myers" -> "old-shawneetown"
"old-shawneetown" -> golconda
markland -> mcalpine
golconda -> smithland

The basic form of network file can contain a connection per line, the node names can either be identifier (alphanumeric+_) or a quoted string (similar to DOT format (graphviz package)). Network file without any connection format can be written as a node per line, but those network can only call sequential functions, and not input dependent ones.

Depending on the use cases, it can probably be applied to other systems that are similar to a river system. Or even without the connection information, the functions that are independent to each other can be run in sequential order.

Implementations

impl Network

pub fn from_file<P: AsRef<Path>>(filename: P) -> Result<Self>

pub fn nodes(&self) -> impl Iterator<Item = &Node>

pub fn nodes_rev(&self) -> impl Iterator<Item = &Node>

pub fn nodes_count(&self) -> usize

pub fn insert_node_by_name(&mut self, name: &str)

pub fn node(&self, ind: usize) -> Option<&Node>

pub fn node_by_name(&self, name: &str) -> Option<&Node>

pub fn nodes_propagation(&self, prop: &Propagation) -> Vec<Node>

pub fn calc_order(&mut self)

pub fn reorder(&mut self)

pub fn reindex(&self)

pub fn set_levels(&mut self)

sets the levels for the nodes, 0 means it’s the main branch and increasing number is for tributories level

Trait Implementations

impl Clone for Network

fn clone(&self) -> Network

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Network

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

Formats the value using the given formatter.

impl Default for Network

fn default() -> Network

Returns the “default value” for a type.

impl GetStaticEquivalent_ for Network

type StaticEquivalent = _static_Network

The 'static equivalent of Self

impl StableAbi for Network

const LAYOUT: &'static TypeLayout = _

The layout of the type provided by implementors.

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern.

const ABI_CONSTS: AbiConsts = _

const-equivalents of the associated types.