Struct pathfinder::Coordinate

pub struct Coordinate {
    pub x: i16,
    pub y: i16,
}

Fields

x: i16

y: i16

Methods

impl Coordinate

pub fn new(x: i16, y: i16) -> Self

Constructs a Coordinate struct.

Examples

Coordinate::new(10, 10);

Invocation can be done used the macro coordinate!

coordinate!(10);

These are equal.

let a = coordinate!(10);
let b = Coordinate::new(10, 10);
assert_eq!(a, b);

pub fn lt(self, lt: i16) -> bool

Returns true if either x or y is less than the input.

Examples

let c = Coordinate::new(10, 10);
assert!(c.lt(11));

pub fn abs(self) -> Coordinate

Returns the absolute coordinate equivilent.

Examples

let c = Coordinate::new(-10, 10);
assert_eq!(c.abs(), Coordinate::new(10, 10));

pub fn from_list(list: &[(i16, i16)]) -> Vec<Coordinate>

Creates a list of coordinates from a list of tuples with x and y positions.

Trait Implementations

impl Location for Coordinate

fn position(&self) -> Coordinate

Retrieves the position Coordinates.

fn eq<L: Location>(&self, other: &L) -> bool

Returns if the positions are equal or not.

fn x(&self) -> i16

Retrieves the X coordinate.

fn y(&self) -> i16

Retrieves the Y coordinate.

fn sum(&self) -> i16

Returns the sum of the x and y value.

impl Ord for Coordinate

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Clone for Coordinate

fn clone(&self) -> Coordinate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Coordinate

impl From<Coordinate> for Node

fn from(c: Coordinate) -> Self

Performs the conversion.

impl From<Coordinate> for Group

fn from(c: Coordinate) -> Self

Performs the conversion.

impl From<Node> for Coordinate

fn from(node: Node) -> Self

Performs the conversion.

impl From<Group> for Coordinate

fn from(group: Group) -> Self

Performs the conversion.

impl Default for Coordinate

fn default() -> Coordinate

Returns the "default value" for a type.

impl PartialEq<Coordinate> for Coordinate

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for Coordinate

impl PartialOrd<Coordinate> for Coordinate

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Debug for Coordinate

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

Formats the value using the given formatter.

impl Display for Coordinate

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

Formats the value using the given formatter.

impl Add<Coordinate> for Coordinate

type Output = Coordinate

The resulting type after applying the + operator.

fn add(self, other: Coordinate) -> Coordinate

Performs the + operation.

impl Sub<Coordinate> for Coordinate

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Coordinate) -> Coordinate

Performs the - operation.

impl Mul<Coordinate> for Coordinate

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl AddAssign<Coordinate> for Coordinate

fn add_assign(&mut self, other: Coordinate)

Performs the += operation.

impl SubAssign<Coordinate> for Coordinate

fn sub_assign(&mut self, other: Coordinate)

Performs the -= operation.