Struct lowdim::BBox

pub struct BBox<S: Integer, V: Vector<S>> { /* fields omitted */ }

A bounding box.

An axis-aligned non-empty volume of the same dimension as the space.

Implementations

impl<S, V> BBox<S, V> where
    S: Integer,
    V: Vector<S>, 

pub fn new(origin: Point<S, V>, size: V) -> BBox<S, V>

Constructs a bounding box from origin and size.

All coordinates of size must be positive to make the box non-empty.

pub fn from_point(p: Point<S, V>) -> BBox<S, V>

Constructs a bounding box which contains a single point.

Example

let p = p2d(2, 3);
assert_eq!(bb2d(2..3, 3..4), BBox2d::from_point(p));

pub fn from_points(p0: Point<S, V>, p1: Point<S, V>) -> BBox<S, V>

Constructs the smallest bounding box containing two points.

Example

let p0 = p2d(2, 3);
let p1 = p2d(-1, 4);
assert_eq!(bb2d(-1..3, 3..5), BBox2d::from_points(p0, p1));

pub fn min(&self) -> Point<S, V>

The minimal point in the bounding box.

pub fn max(&self) -> Point<S, V>

The maximal point in the bounding box.

pub fn center(&self) -> Point<S, V>

The center point in the bounding box.

This is only the true center of the bounding box if the bounding box has odd dimensions. Otherwise the coordinates of the center are rounded according to the rules for integer division, i.e. towards zero.

pub fn lub(&self, other: &BBox<S, V>) -> BBox<S, V>

The least upper bound of two bounding boxes w.r.t. inclusion.

That is, the smallest bounding box encompassing the points in the two boxes.

Example

let bb0 = bb2d(-2..3, -1..2);
let bb1 = bb2d(-5..4, 2..5);
assert_eq!(bb2d(-5..4, -1..5), bb0.lub(&bb1));

pub fn extend_to(&self, p: Point<S, V>) -> BBox<S, V>

Returns the smallest bounding box encompassing this box and a given point.

Example

let bb = bb2d(-2..3, -1..2);
let p = p2d(3, 4);
assert_eq!(bb2d(-2..4, -1..5), bb.extend_to(p));

impl<S> BBox<S, Vec2d<S>> where
    S: Integer, 

pub fn from_bounds(x_start: S, x_end: S, y_start: S, y_end: S) -> BBox2d<S>

Constructs a bounding box from bounds.

As always, lower bounds are inclusive, upper bounds exclusive.

pub fn x_start(&self) -> S

Returns the lower bound in the x-coordinate (inclusive).

pub fn x_end(&self) -> S

Returns the upper bound in the x-coordinate (exclusive).

pub fn x_min(&self) -> S

Returns the lower bound in the x-coordinate (inclusive).

pub fn x_max(&self) -> S

Returns the upper bound in the x-coordinate (inclusive).

pub fn x0(&self) -> S

👎 Deprecated:

Use x_start or x_min instead.

Returns the lower bound in the x-coordinate (inclusive).

pub fn x1(&self) -> S

👎 Deprecated:

Use x_end instead, or consider using x_max.

Returns the upper bound in the x-coordinate (exclusive).

pub fn y_start(&self) -> S

Returns the lower bound in the y-coordinate (inclusive).

pub fn y_end(&self) -> S

Returns the upper bound in the y-coordinate (exclusive).

pub fn y_min(&self) -> S

Returns the lower bound in the y-coordinate (inclusive).

pub fn y_max(&self) -> S

Returns the upper bound in the y-coordinate (inclusive).

pub fn y0(&self) -> S

👎 Deprecated:

Use y_start or y_min instead.

Returns the lower bound in the y-coordinate (inclusive).

pub fn y1(&self) -> S

👎 Deprecated:

Use y_end instead, or consider using y_max.

Returns the upper bound in the y-coordinate (exclusive).

pub fn x_len(&self) -> usize where
    usize: TryFrom<S>, 

Returns the width of the bounding box.

pub fn y_len(&self) -> usize where
    usize: TryFrom<S>, 

Returns the height of the bounding box.

pub fn area(&self) -> usize where
    usize: TryFrom<S>, 

Returns the area of the bounding box.

pub fn contains(&self, p: &Point2d<S>) -> bool

Returns true if the point is inside the bounding box.

pub fn x_range(&self) -> Range<S>

The range of the x coordinate

pub fn y_range(&self) -> Range<S>

The range of the y coordinate

pub fn iter(&self) -> Iter<'_, S> where
    usize: TryFrom<S>, 

Returns an iterator over the points in the bounding box.

Points are returned by row.

pub fn seq_index(&self, p: Point2d<S>) -> usize where
    usize: TryFrom<S>, 

Returns the sequential index for a given point.

Points are counted by row.

Trait Implementations

impl<S: Clone + Integer, V: Clone + Vector<S>> Clone for BBox<S, V>

fn clone(&self) -> BBox<S, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Integer, V: Debug + Vector<S>> Debug for BBox<S, V>

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

Formats the value using the given formatter.

impl<S: Hash + Integer, V: Hash + Vector<S>> Hash for BBox<S, V>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<S: PartialEq + Integer, V: PartialEq + Vector<S>> PartialEq<BBox<S, V>> for BBox<S, V>

fn eq(&self, other: &BBox<S, V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BBox<S, V>) -> bool

This method tests for !=.

impl<S: Copy + Integer, V: Copy + Vector<S>> Copy for BBox<S, V>

impl<S: Eq + Integer, V: Eq + Vector<S>> Eq for BBox<S, V>

impl<S: Integer, V: Vector<S>> StructuralEq for BBox<S, V>

impl<S: Integer, V: Vector<S>> StructuralPartialEq for BBox<S, V>