Struct kas::geom::Vec2

#[repr(C)]pub struct Vec2(pub f32, pub f32);

2D vector

Usually used as either a coordinate or a difference of coordinates, but may have some other uses.

Vectors are partially ordered and support component-wise comparison via methods like lhs.lt(rhs). The PartialOrd trait is not implemented since it implements lhs ≤ rhs as lhs < rhs || lhs == rhs which is wrong for vectors (consider for lhs = (0, 1), rhs = (1, 0)).

Implementations

impl Vec2

pub const ZERO: Vec2

Zero

pub const INFINITY: Vec2

Positive infinity

pub const fn splat(value: f32) -> Self

Constructs a new instance with each element initialized to value.

pub fn min_comp(self) -> f32

Take the minimum component

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

Return the minimum, componentwise

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

Return the maximum, componentwise

pub fn abs(self) -> Self

Take the absolute value of each component

pub fn ceil(self) -> Self

Take the ceiling of each component

pub fn sign(self) -> Self

For each component, return ±1 with the same sign as self.

pub fn lt(self, rhs: Self) -> bool

True when for all components, lhs < rhs

pub fn le(self, rhs: Self) -> bool

True when for all components, lhs ≤ rhs

pub fn ge(self, rhs: Self) -> bool

True when for all components, lhs ≥ rhs

pub fn gt(self, rhs: Self) -> bool

True when for all components, lhs > rhs

pub fn complex_mul(self, rhs: Self) -> Self

Multiply two vectors as if they are complex numbers

pub fn complex_div(self, rhs: Self) -> Self

Divide by a second vector as if they are complex numbers

pub fn complex_inv(self) -> Self

Take the complex reciprocal

pub fn sum(self) -> f32

Return the sum of the terms

pub fn sum_square(self) -> f32

Return the sum of the square of the terms

Trait Implementations

impl Add<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the + operator.

pub fn add(self, rhs: Vec2) -> Self::Output

Performs the + operation.

impl Add<f32> for Vec2

type Output = Vec2

The resulting type after applying the + operator.

pub fn add(self, rhs: f32) -> Self::Output

Performs the + operation.

impl Clone for Vec2

pub fn clone(&self) -> Vec2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Vec2

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Default for Vec2

pub fn default() -> Vec2

Returns the "default value" for a type.

impl Div<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

pub fn div(self, rhs: Vec2) -> Self::Output

Performs the / operation.

impl Div<f32> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

pub fn div(self, rhs: f32) -> Self::Output

Performs the / operation.

impl From<(f32, f32)> for Vec2

pub fn from(arg: (f32, f32)) -> Self

Performs the conversion.

impl From<Coord> for Vec2

pub fn from(arg: Coord) -> Self

Performs the conversion.

impl From<Size> for Vec2

pub fn from(arg: Size) -> Self

Performs the conversion.

impl From<Vec2> for (f32, f32)

pub fn from(v: Vec2) -> Self

Performs the conversion.

impl From<Vec2> for Coord

pub fn from(arg: Vec2) -> Self

Performs the conversion.

impl From<Vec2> for Size

pub fn from(arg: Vec2) -> Self

Performs the conversion.

impl From<Vec2> for Vec2

pub fn from(size: Vec2) -> Self

Performs the conversion.

impl From<Vec2> for Vec2

pub fn from(size: Vec2) -> Vec2

Performs the conversion.

impl Mul<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

pub fn mul(self, rhs: Vec2) -> Self::Output

Performs the * operation.

impl Mul<f32> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

pub fn mul(self, rhs: f32) -> Self::Output

Performs the * operation.

impl Neg for Vec2

type Output = Vec2

The resulting type after applying the - operator.

pub fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<Vec2> for Vec2

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

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

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

This method tests for !=.

impl StructuralPartialEq for Vec2

impl Sub<Vec2> for Vec2

type Output = Vec2

The resulting type after applying the - operator.

pub fn sub(self, rhs: Vec2) -> Self::Output

Performs the - operation.

impl Sub<f32> for Vec2

type Output = Vec2

The resulting type after applying the - operator.

pub fn sub(self, rhs: f32) -> Self::Output

Performs the - operation.