Struct Interval

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

1D interval

Implementations

impl<I> Interval<I>

where I: Integer,

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

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!

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!

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

pub fn min(&self) -> I

pub fn max(&self) -> I

pub fn width(&self) -> I

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

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);

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));

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

Trait Implementations

impl<I> Clone for Interval<I>

where I: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I> Debug for Interval<I>

where I: Debug,

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

Formats the value using the given formatter.

impl<I> PartialEq for Interval<I>

where I: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<I> Eq for Interval<I>

where I: Eq,

impl<I> StructuralPartialEq for Interval<I>