Struct sprs::linalg::etree::Parents

pub struct Parents<S>where
    S: Deref<Target = [Parent]>,{ /* private fields */ }

Store an etree as the parent information of each node. This reflects the fact that etrees can in fact have multiple roots.

Implementations

impl<S: Deref<Target = [Parent]>> Parents<S>

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

Get the parent of a node. Returns None if the node is a root.

Panics

• if node is out of bounds

pub fn is_root(&self, node: usize) -> bool

Test whether a node is a root.

Panics

• if node is out of bounds

pub fn nb_nodes(&self) -> usize

The number of nodes in this tree.

pub fn view(&self) -> ParentsView<'_>

Get a view of this object

impl<S: DerefMut<Target = [Parent]>> Parents<S>

pub fn set_parent(&mut self, node: usize, parent: usize)

Set the parent of a node.

Panics

• if node is out of bounds
• if parent is out of bounds

pub fn set_root(&mut self, node: usize)

Set a node as a root.

Panics

• if node is out of bounds

pub fn uproot(&mut self, node: usize, parent: usize)

Give a parent to a root of the tree. No-op if the node was not a parent.

Panics

if either node or parent is out of bounds

pub fn view_mut(&mut self) -> ParentsViewMut<'_>

impl Parents<Vec<Option<usize>, Global>>

pub fn new(nb_nodes: usize) -> Self

Create a new tree with all nodes set as root

Trait Implementations

impl<S> Clone for Parents<S>where S: Deref<Target = [Parent]> + Clone,

fn clone(&self) -> Parents<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Parents<S>where S: Deref<Target = [Parent]> + Debug,

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

Formats the value using the given formatter.