Struct hilbert16::Curve

pub struct Curve { /* fields omitted */ }

A psuedo-Hilbert curve.

This type is optimized for O(1) queries of arbitrary points or distances without pre-calculating the curve.

Implementations

impl Curve

#[must_use]pub fn new(order: u8) -> Option<Self>

Generate an iteration of the Hilbert curve with the given order.

The largest supported order is 15, which corresponds a square of 32768 by 32768 units.

Examples

use hilbert16::Curve;

assert!(matches!(Curve::new(15), Some(_)));
assert_eq!(Curve::new(16), None);

#[must_use]pub const fn order(self) -> u8

The Hilbert curve's order.

Examples

use hilbert16::Curve;

let curve = Curve::new(2).unwrap();
assert_eq!(curve.order(), 2);

#[must_use]pub const fn side_len(self) -> u16

The side length of the Hilbert curve's enclosing square.

Examples

use hilbert16::Curve;

let curve = Curve::new(2).unwrap();
assert_eq!(curve.side_len(), 4);

#[must_use]pub const fn num_pnts(self) -> u32

The number of points contained in the Hilbert curve.

Examples

use hilbert16::Curve;

let curve = Curve::new(2).unwrap();
assert_eq!(curve.num_pnts(), 16);

#[must_use]pub fn point_at(self, d: u32) -> Option<Point>

Get the point corresponding to the given distance.

Examples

use hilbert16::{Curve, Point};

let curve = Curve::new(1).unwrap();
let p = curve.point_at(2).unwrap();
assert_eq!(p, Point { x: 1, y: 1 });

pub fn dist_at<P>(self, p: P) -> Option<u32> where
    P: Into<Point>, 

Get the distance corresponding to the given point.

Examples

use hilbert16::Curve;

let curve = Curve::new(1).unwrap();
let dist = curve.dist_at((1u16, 1u16)).unwrap();
assert_eq!(dist, 2);

#[must_use]pub fn wrapping_point_at(self, d: u32) -> Point

Get the point corresponding to the given distance, wrapping back to (0, 0).

Examples

use hilbert16::{Curve, Point};

let curve = Curve::new(1).unwrap();
let pnt = curve.wrapping_point_at(6);
assert_eq!(pnt, Point { x: 1, y: 1 });

pub fn wrapping_dist_at<P>(self, p: P) -> u32 where
    P: Into<Point>, 

Get the distance corresponding to the given point, wrapping back to 0.

Examples

use hilbert16::Curve;

let curve = Curve::new(1).unwrap();
let dist = curve.wrapping_dist_at((3u16, 1u16));
assert_eq!(dist, 2);

Trait Implementations

impl Clone for Curve

pub fn clone(&self) -> Curve

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Curve

impl Debug for Curve

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

Formats the value using the given formatter.

impl Default for Curve

pub fn default() -> Self

Returns the "default value" for a type.

impl Eq for Curve

impl Ord for Curve

pub fn cmp(&self, other: &Curve) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Curve> for Curve

pub fn eq(&self, other: &Curve) -> bool

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

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

This method tests for !=.

impl PartialOrd<Curve> for Curve

pub fn partial_cmp(&self, other: &Curve) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Curve) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Curve) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Curve) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Curve) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Curve

impl StructuralPartialEq for Curve