Struct Interval

Source
pub struct Interval<I> { /* private fields */ }
Expand description

1D interval

Implementations§

Source§

impl<I> Interval<I>
where I: Integer,

Source

pub fn with_minmax(min: I, max: I) -> Interval<I>
where I: Debug,

Construct a new AABB with given min and max points.

Debug panic if points are not min/max:

let b = Interval::with_minmax (1, 0);  // panic!

Identical points are allowed:

let b = Interval::with_minmax (0, 0);  // ok
Source

pub fn from_points(a: I, b: I) -> Interval<I>

Construct a new AABB using the two given points to determine min/max.

Identical points are allowed:

let b = Interval::from_points (0, 0);  // ok!
Source

pub fn containing(points: &[I]) -> Interval<I>
where I: Debug,

Construct the minimum AABB containing the given set of points.

Identical points are allowed:

let b = Interval::containing (&[0, 0]);  // ok!

A single point is allowed:

let b = Interval::containing (&[0]);  // ok!

Debug panic if no points are given:

let b = Interval::<i32>::containing (&[]);  // panic!
Source

pub fn union(a: &Interval<I>, b: &Interval<I>) -> Interval<I>
where I: Debug,

Create a new AABB that is the union of the two input AABBs

Source

pub fn min(&self) -> I

Source

pub fn max(&self) -> I

Source

pub fn width(&self) -> I

Source

pub fn contains(&self, point: I) -> bool

Source

pub fn clamp(&self, point: I) -> I

Clamp a given point to the AABB interval.

let b = Interval::from_points (-1, 1);
assert_eq!(b.clamp (-2), -1);
assert_eq!(b.clamp ( 2),  1);
assert_eq!(b.clamp ( 0),  0);
Source

pub fn rand_point<R>(&self, rng: &mut R) -> I
where I: SampleUniform, R: Rng,

Generate a random point contained in the AABB

use rand_xorshift;
use rand::SeedableRng;
// random sequence will be the same each time this is run
let mut rng = rand_xorshift::XorShiftRng::seed_from_u64 (0);
let aabb = Interval::<i32>::with_minmax (-10, 10);
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (point));
let point = aabb.rand_point (&mut rng);
assert!(aabb.contains (point));
Source

pub fn intersects(&self, other: &Interval<I>) -> bool

Trait Implementations§

Source§

impl<I> Clone for Interval<I>
where I: Clone,

Source§

fn clone(&self) -> Interval<I>

Returns a duplicate 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<I> Debug for Interval<I>
where I: Debug,

Source§

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

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

impl<'de, I> Deserialize<'de> for Interval<I>
where I: Deserialize<'de>,

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Interval<I>, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<I> PartialEq for Interval<I>
where I: PartialEq,

Source§

fn eq(&self, other: &Interval<I>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<I> Serialize for Interval<I>
where I: Serialize,

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<I> Eq for Interval<I>
where I: Eq,

Source§

impl<I> StructuralPartialEq for Interval<I>

Auto Trait Implementations§

§

impl<I> Freeze for Interval<I>
where I: Freeze,

§

impl<I> RefUnwindSafe for Interval<I>
where I: RefUnwindSafe,

§

impl<I> Send for Interval<I>
where I: Send,

§

impl<I> Sync for Interval<I>
where I: Sync,

§

impl<I> Unpin for Interval<I>
where I: Unpin,

§

impl<I> UnwindSafe for Interval<I>
where I: 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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
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> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> MaybeSerDes for T