aboutsummaryrefslogtreecommitdiff
path: root/src/mve.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/mve.rs')
-rw-r--r--src/mve.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/mve.rs b/src/mve.rs
index 19785d9..6fc326c 100644
--- a/src/mve.rs
+++ b/src/mve.rs
@@ -2,6 +2,9 @@ use crate::*;
// Make Vertex-Edge
+/// Operator corresponding to MVE in SNUMOD.
+///
+/// See [`Dcel::mve`] for details.
pub struct Mve<'brand, 'arena, V> {
pub edge: ptr!(Edge),
pub data: V,
@@ -87,6 +90,9 @@ impl<'brand, 'arena, V> Operator<'brand, 'arena, V> for Mve<'brand, 'arena, V> {
}
}
+/// Operator corresponding to KVE in SNUMOD.
+///
+/// See [`Dcel::kve`] for details.
pub struct Kve<'brand, 'arena, V> {
pub edge: own!(Edge),
pub vertex: own!(Vertex),
@@ -98,6 +104,7 @@ impl<'brand, 'arena, V> Kve<'brand, 'arena, V> {
}
}
+/// Precondition Error for [`Kve`].
#[derive(Debug, Error)]
pub enum KveError {
#[error("vertex is not part of edge")]