Struct Edge 

pub struct Edge<'id, N, ET>(/* private fields */);

Edge type, see oxidd_core::Edge

Internally, this is represented as a u32 index.

Implementations

impl<N: NodeBase, ET: Tag> Edge<'_, N, ET>

pub fn raw(&self) -> u32

Get the raw representation of the edge (also called “edge value”)

pub unsafe fn from_terminal_id(id: u32) -> Self

Get an edge from a terminal ID

Safety

id must be a terminal ID, i.e., id < TERMINALS, and the caller must update the reference count for the terminal accordingly.

Trait Implementations

impl<N, ET> Drop for Edge<'_, N, ET>

fn drop(&mut self)

Executes the destructor for this type.

impl<'id, ET: Tag, const ARITY: usize> DropWith<Edge<'id, NodeWithLevel<'id, ET, ARITY>, ET>> for NodeWithLevel<'id, ET, ARITY>

fn drop_with(self, drop_edge: impl Fn(Edge<'id, Self, ET>))

Drop self

fn drop_with_manager<M>(self, manager: &M)

where M: Manager<Edge = E>,

Drop self

impl<N: NodeBase, ET: Tag> Edge for Edge<'_, N, ET>

type Tag = ET

Edge tag

fn borrowed(&self) -> Borrowed<'_, Self>

Turn a reference into a borrowed handle

fn with_tag(&self, tag: Self::Tag) -> Borrowed<'_, Self>

Get a version of this Edge with the given tag

fn with_tag_owned(self, tag: Self::Tag) -> Self

Get a version of this Edge with the given tag

fn tag(&self) -> Self::Tag

Get the Tag of this Edge

fn node_id(&self) -> NodeID

Returns some unique identifier for the node, e.g. for I/O purposes

impl<'id, N, ET> Hash for Edge<'id, N, ET>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'id, ET: Tag, const ARITY: usize> InnerNode<Edge<'id, NodeWithLevel<'id, ET, ARITY>, ET>> for NodeWithLevel<'id, ET, ARITY>

const ARITY: usize = ARITY

The node’s arity (upper bound)

type ChildrenIter<'a> = BorrowedEdgeIter<'a, Edge<'id, NodeWithLevel<'id, ET, ARITY>, ET>, Iter<'a, Edge<'id, NodeWithLevel<'id, ET, ARITY>, ET>>> where Self: 'a

Iterator over children of an inner node

fn new( level: LevelNo, children: impl IntoIterator<Item = Edge<'id, Self, ET>>, ) -> Self

Create a new node

fn check_level(&self, check: impl FnOnce(LevelNo) -> bool) -> bool

Returns the result of check applied to the node’s level in case this node type stores levels, otherwise returns true.

fn assert_level_matches(&self, level: LevelNo)

Panics if the node types stores a level and the node’s level is not level

fn children(&self) -> Self::ChildrenIter<'_>

Get the children of this node as an iterator

fn child(&self, n: usize) -> Borrowed<'_, Edge<'id, Self, ET>>

Get the n-th child of this node

unsafe fn set_child( &self, n: usize, child: Edge<'id, Self, ET>, ) -> Edge<'id, Self, ET>

Set the n-th child of this node

fn ref_count(&self) -> usize

Get the node’s reference count

impl<'a, 'id, N, ET, TM, R, MD, const TERMINALS: usize> LevelView<Edge<'id, N, ET>, N> for LevelView<'a, 'id, N, ET, TM, R, MD, TERMINALS>

where N: NodeBase + InnerNode<Edge<'id, N, ET>>, ET: Tag, TM: TerminalManager<'id, N, ET, TERMINALS>, MD: DropWith<Edge<'id, N, ET>>,

type Iterator<'b> = LevelViewIter<'b, 'id, N, ET> where Self: 'b, Edge<'id, N, ET>: 'b

Iterator over Edges pointing to nodes at this level

type Taken = TakenLevelView<'a, 'id, N, ET, TM, R, MD, TERMINALS>

Taken level view, see LevelView::take()

fn len(&self) -> usize

Get the number of nodes on this level

fn level_no(&self) -> LevelNo

Get the level number of this level

fn reserve(&mut self, additional: usize)

Reserve space for additional nodes on this level

fn get(&self, node: &N) -> Option<&Edge<'id, N, ET>>

Get the edge corresponding to the given node (if present)

fn insert(&mut self, edge: Edge<'id, N, ET>) -> bool

Insert the given edge into the unique table at this level, assuming that the referenced node is already stored in the associated manager.

fn get_or_insert(&mut self, node: N) -> AllocResult<Edge<'id, N, ET>>

Get the edge corresponding to level and node if present, or insert it.

fn gc(&mut self)

Perform garbage collection on this level

fn remove(&mut self, node: &N) -> bool

Remove node from (this level of) the manager

unsafe fn swap(&mut self, other: &mut Self)

Move all nodes from this level to the other level and vice versa.

fn iter(&self) -> Self::Iterator<'_>

Iterate over all the edges at this level

fn take(&mut self) -> Self::Taken

Clear this level, returning a level view containing all the previous edges.

fn is_empty(&self) -> bool

Returns true iff this level contains nodes

impl<'id, N, ET, TM, R, MD, const TERMINALS: usize> LevelView<Edge<'id, N, ET>, N> for TakenLevelView<'_, 'id, N, ET, TM, R, MD, TERMINALS>

where N: NodeBase + InnerNode<Edge<'id, N, ET>>, ET: Tag, TM: TerminalManager<'id, N, ET, TERMINALS>, MD: DropWith<Edge<'id, N, ET>>,

type Iterator<'b> = LevelViewIter<'b, 'id, N, ET> where Self: 'b, Edge<'id, N, ET>: 'b

Iterator over Edges pointing to nodes at this level

type Taken = TakenLevelView<'_, 'id, N, ET, TM, R, MD, TERMINALS>

Taken level view, see LevelView::take()

fn len(&self) -> usize

Get the number of nodes on this level

fn level_no(&self) -> LevelNo

Get the level number of this level

fn reserve(&mut self, additional: usize)

Reserve space for additional nodes on this level

fn get(&self, node: &N) -> Option<&Edge<'id, N, ET>>

Get the edge corresponding to the given node (if present)

fn insert(&mut self, edge: Edge<'id, N, ET>) -> bool

Insert the given edge into the unique table at this level, assuming that the referenced node is already stored in the associated manager.

fn get_or_insert(&mut self, node: N) -> AllocResult<Edge<'id, N, ET>>

Get the edge corresponding to level and node if present, or insert it.

fn gc(&mut self)

Perform garbage collection on this level

fn remove(&mut self, node: &N) -> bool

Remove node from (this level of) the manager

unsafe fn swap(&mut self, other: &mut Self)

Move all nodes from this level to the other level and vice versa.

fn iter(&self) -> Self::Iterator<'_>

Iterate over all the edges at this level

fn take(&mut self) -> Self::Taken

Clear this level, returning a level view containing all the previous edges.

fn is_empty(&self) -> bool

Returns true iff this level contains nodes

impl<'id, N: NodeBase, ET: Tag> NodeSet<Edge<'id, N, ET>> for NodeSet

fn len(&self) -> usize

Get the number of nodes in the set

fn insert(&mut self, edge: &Edge<'id, N, ET>) -> bool

Add a node (the node to which edge points) to the set

fn contains(&self, edge: &Edge<'id, N, ET>) -> bool

Return true if the set contains the given node

fn remove(&mut self, edge: &Edge<'id, N, ET>) -> bool

Remove a node from the set

fn is_empty(&self) -> bool

Returns true iff there are no nodes in the set

impl<'id, N, ET> Ord for Edge<'id, N, ET>

fn cmp(&self, __other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'id, N, ET> PartialEq for Edge<'id, N, ET>

fn eq(&self, __other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'id, N, ET> PartialOrd for Edge<'id, N, ET>

fn partial_cmp(&self, __other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'id, N, ET> Eq for Edge<'id, N, ET>