From 4cc4f8d5e07a4aa85ac52ce3205574e37ffdf780 Mon Sep 17 00:00:00 2001 From: Charlotte Pabst Date: Mon, 25 Mar 2024 02:25:43 +0100 Subject: generational references & documentation --- src/mevvlfs.rs | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'src/mevvlfs.rs') diff --git a/src/mevvlfs.rs b/src/mevvlfs.rs index 318a91b..92a11f1 100644 --- a/src/mevvlfs.rs +++ b/src/mevvlfs.rs @@ -2,6 +2,9 @@ use crate::*; // Make Edge-Vertex-Vertex-Loop-Face-Shell +/// Operator corresponding to MEVVLS in SNUMOD. +/// +/// See [`Dcel::mevvlfs`] for details. pub struct Mevvlfs<'brand, 'arena, V> { pub body: ptr!(Body), pub data: [V; 2], @@ -59,6 +62,9 @@ impl<'brand, 'arena, V> Operator<'brand, 'arena, V> for Mevvlfs<'brand, 'arena, } } +/// Operator corresponding to KEVVLS in SNUMOD. +/// +/// See [`Dcel::kevvlfs`] for details. pub struct Kevvlfs<'brand, 'arena, V> { pub edge: own!(Edge), pub vertices: [own!(Vertex); 2], @@ -67,6 +73,7 @@ pub struct Kevvlfs<'brand, 'arena, V> { pub shell: own!(Shell), } +/// Precondition Error for [`Kevvlfs`]. #[derive(Debug, Error)] pub enum KevvlfsError { #[error("edge vertices do not equal vertices")] -- cgit v1.2.3