Struct zng_unit::DistanceKey

pub struct DistanceKey(/* private fields */);

Comparable key that represents the absolute distance between two pixel points.

Computing the actual distance only for comparison is expensive, this key avoids the conversion to float and square-root operation.

Implementations

impl DistanceKey

pub const NONE_MAX: DistanceKey = _

Value that is always greater than any distance key.

pub const NONE_MIN: DistanceKey = _

Value that is always smaller than any distance key.

pub const MAX: DistanceKey = _

Maximum distance.

pub const MIN: DistanceKey = _

Minimum distance.

pub fn from_points(a: PxPoint, b: PxPoint) -> Self

New distance key computed from two points.

pub fn from_distance(d: Px) -> Self

New distance key from already computed actual distance.

Note that computing the actual distance is slower then using from_points to compute just the distance key.

pub fn is_none(self) -> bool

If the key is the NONE_MAX or NONE_MIN.

pub fn distance(self) -> Option<Px>

Completes the distance calculation.

Trait Implementations

impl Clone for DistanceKey

fn clone(&self) -> DistanceKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for DistanceKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for DistanceKey

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DistanceKey

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for DistanceKey

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

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

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

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

impl PartialOrd for DistanceKey

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

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

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

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

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

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

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

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

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

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

impl Serialize for DistanceKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Zeroable for DistanceKey

fn zeroed() -> Self

Calls zeroed.

impl Copy for DistanceKey

impl Eq for DistanceKey

impl Pod for DistanceKey

impl StructuralPartialEq for DistanceKey