linesweeper

Struct Segments

Source 
pub struct Segments<F: Float> { /* private fields */ }
Expand description

An arena of line segments.

Segments are indexed by SegIdx and can be retrieved by indexing (i.e. with square brackets).

Implementations§

Source§

impl<F: Float> Segments<F>

Source

pub fn len(&self) -> usize

The number of line segments in this arena.

Source

pub fn indices(&self) -> impl Iterator<Item = SegIdx>

Iterate over all indices that can be used to index into this arena.

Source

pub fn segments(&self) -> impl Iterator<Item = &Segment<F>>

Iterate over all segments in this arena.

Source

pub fn oriented_start(&self, idx: SegIdx) -> &Point<F>

Returns the starting point of the segment at idx, relative to the segment’s original orientation.

The start and end points of the segment itself are stored in sweep-line order (i.e. start has the smaller y coordinate), regardless of the original orientation of the segment. Use this method to retrieve the segment’s original start point.

Source

pub fn oriented_end(&self, idx: SegIdx) -> &Point<F>

Returns the ending point of the segment at idx, relative to the segment’s original orientation.

The start and end points of the segment itself are stored in sweep-line order (i.e. start has the smaller y coordinate), regardless of the original orientation of the segment. Use this method to retrieve the segment’s original end point.

Source

pub fn contour_next(&self, idx: SegIdx) -> Option<SegIdx>

Returns the index of the segment following idx.

If idx is part of a non-closed polyline and it is the last segment, this returns None. If idx is part of a closed polyline, this will always return Some, and you might need to be careful to avoid looping infinitely.

Source

pub fn contour_prev(&self, idx: SegIdx) -> Option<SegIdx>

Returns the index of the segment preceding idx.

If idx is part of a non-closed polyline and it is the first segment, this returns None. If idx is part of a closed polyline, this will always return Some, and you might need to be careful to avoid looping infinitely.

Source

pub fn positively_oriented(&self, idx: SegIdx) -> bool

Does the sweep-line orientation of idx agree with its original orientation?

Source

pub fn add_points<P: Into<Point<F>>>(&mut self, ps: impl IntoIterator<Item = P>)

Add a (non-closed) polyline to this arena.

Source

pub fn add_cycle<P: Into<Point<F>>>(&mut self, ps: impl IntoIterator<Item = P>)

Add a closed polyline to this arena.

Source

pub fn from_closed_cycle<P: Into<Point<F>>>( ps: impl IntoIterator<Item = P>, ) -> Self

Construct a segment arena from a single closed polyline.

Trait Implementations§

Source§

impl<F: Clone + Float> Clone for Segments<F>

Source§

fn clone(&self) -> Segments<F>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F: Debug + Float> Debug for Segments<F>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<F: Float> Default for Segments<F>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<F: Float> Index<SegIdx> for Segments<F>

Source§

type Output = Segment<F>

The returned type after indexing.
Source§

fn index(&self, index: SegIdx) -> &Self::Output

Performs the indexing (container[index]) operation. Read more

Auto Trait Implementations§

§

impl<F> Freeze for Segments<F>

§

impl<F> RefUnwindSafe for Segments<F>
where F: RefUnwindSafe,

§

impl<F> Send for Segments<F>
where F: Send,

§

impl<F> Sync for Segments<F>
where F: Sync,

§

impl<F> Unpin for Segments<F>
where F: Unpin,

§

impl<F> UnwindSafe for Segments<F>
where F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T, U> ExactFrom<T> for U
where U: TryFrom<T>,

Source§

fn exact_from(value: T) -> U

Source§

impl<T, U> ExactInto<U> for T
where U: ExactFrom<T>,

Source§

fn exact_into(self) -> U

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> OverflowingInto<U> for T
where U: OverflowingFrom<T>,

Source§

fn overflowing_into(self) -> (U, bool)

Source§

impl<T, U> RoundingInto<U> for T
where U: RoundingFrom<T>,

Source§

fn rounding_into(self, rm: RoundingMode) -> (U, Ordering)

Source§

impl<T, U> SaturatingInto<U> for T
where U: SaturatingFrom<T>,

Source§

fn saturating_into(self) -> U

Source§

impl<T> ToDebugString for T
where T: Debug,

Source§

fn to_debug_string(&self) -> String

Returns the String produced by Ts Debug implementation.

§Examples
use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, U> WrappingInto<U> for T
where U: WrappingFrom<T>,

Source§

fn wrapping_into(self) -> U