pub struct Rings { /* private fields */ }Expand description
Owned primitive-ring set.
let (xyz, edge) = seams::diamond8();
let mut system = seams::System::new()?;
system.set_ortho(&xyz, edge, edge, edge)?;
let rings = system.rings(&seams::RingOptions::default())?;
assert!(rings.size() > 0);
assert!(!rings.vertices(0)?.is_empty());Implementations§
Source§impl Rings
impl Rings
Sourcepub fn size(&self) -> i32
pub fn size(&self) -> i32
Number of primitive rings.
let (xyz, edge) = seams::diamond8();
let mut system = seams::System::new()?;
system.set_ortho(&xyz, edge, edge, edge)?;
let rings = system.rings(&seams::RingOptions::default())?;
assert_eq!(rings.iter().count(), rings.size() as usize);Sourcepub fn vertices(&self, index: i32) -> Result<Vec<i32>, Error>
pub fn vertices(&self, index: i32) -> Result<Vec<i32>, Error>
Atom indices of one ring.
let (xyz, edge) = seams::diamond8();
let mut system = seams::System::new()?;
system.set_ortho(&xyz, edge, edge, edge)?;
let rings = system.rings(&seams::RingOptions::default())?;
assert!(!rings.vertices(0)?.is_empty());Sourcepub fn histogram(&self, up_to: i32) -> Result<Vec<i32>, Error>
pub fn histogram(&self, up_to: i32) -> Result<Vec<i32>, Error>
Histogram of ring size. counts[k] is the number of rings of size k.
let (xyz, edge) = seams::diamond8();
let mut system = seams::System::new()?;
system.set_ortho(&xyz, edge, edge, edge)?;
let rings = system.rings(&seams::RingOptions::default())?;
let hist = rings.histogram(6)?;
assert_eq!(hist.len(), 7);Sourcepub fn fraction(&self, ring_size: i32) -> Result<f64, Error>
pub fn fraction(&self, ring_size: i32) -> Result<f64, Error>
Fraction of atoms that sit on a ring of one size. Zero counts every ring.
let (xyz, edge) = seams::diamond8();
let mut system = seams::System::new()?;
system.set_ortho(&xyz, edge, edge, edge)?;
let rings = system.rings(&seams::RingOptions::default())?;
assert!(rings.fraction(6)?.is_finite());Sourcepub fn iter(&self) -> RingIter<'_> ⓘ
pub fn iter(&self) -> RingIter<'_> ⓘ
Walk the rings. Each item is the vertex list of one ring.
let (xyz, edge) = seams::diamond8();
let mut system = seams::System::new()?;
system.set_ortho(&xyz, edge, edge, edge)?;
let rings = system.rings(&seams::RingOptions::default())?;
assert!(rings.iter().all(|ring| ring.is_ok()));Trait Implementations§
Auto Trait Implementations§
impl !Sync for Rings
impl Freeze for Rings
impl RefUnwindSafe for Rings
impl Unpin for Rings
impl UnsafeUnpin for Rings
impl UnwindSafe for Rings
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more