Struct Vector2 

pub struct Vector2 {
    pub x: f64,
    pub y: f64,
}

A 2D column vector.

Fields

x: f64

The first component.

y: f64

The second component.

Implementations

impl Vector2

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

Creates a vector from two components.

Examples found in repository

examples/basic_usage.rs (line 4)

fn main() -> Result<(), use_linear::LinearError> {
    let vector = Vector2::new(3.0, 4.0);
    let basis = Matrix2::new(2.0, 1.0, 5.0, 3.0);
    let rhs = Vector2::new(1.0, 2.0);

    assert!((dot(vector, Vector2::new(-2.0, 1.0)) + 2.0).abs() < 1.0e-12);
    assert!((vector.magnitude() - 5.0).abs() < 1.0e-12);
    assert_eq!(
        basis.mul_vector(Vector2::new(1.0, -1.0)),
        Vector2::new(1.0, 2.0)
    );
    assert_eq!(basis * Matrix2::identity(), basis);
    assert_eq!(solve_2x2(basis, rhs)?, Vector2::new(1.0, -1.0));

    Ok(())
}

pub const fn magnitude_squared(self) -> f64

Returns the squared Euclidean norm.

pub fn magnitude(self) -> f64

Returns the Euclidean norm.

Examples found in repository

examples/basic_usage.rs (line 9)

fn main() -> Result<(), use_linear::LinearError> {
    let vector = Vector2::new(3.0, 4.0);
    let basis = Matrix2::new(2.0, 1.0, 5.0, 3.0);
    let rhs = Vector2::new(1.0, 2.0);

    assert!((dot(vector, Vector2::new(-2.0, 1.0)) + 2.0).abs() < 1.0e-12);
    assert!((vector.magnitude() - 5.0).abs() < 1.0e-12);
    assert_eq!(
        basis.mul_vector(Vector2::new(1.0, -1.0)),
        Vector2::new(1.0, 2.0)
    );
    assert_eq!(basis * Matrix2::identity(), basis);
    assert_eq!(solve_2x2(basis, rhs)?, Vector2::new(1.0, -1.0));

    Ok(())
}

pub const fn dot(self, other: Self) -> f64

Returns the dot product with other.

Trait Implementations

impl Add for Vector2

type Output = Vector2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Vector2

fn clone(&self) -> Vector2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vector2

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

Formats the value using the given formatter.

impl Default for Vector2

fn default() -> Vector2

Returns the “default value” for a type.

impl Mul<Vector2> for Matrix2

type Output = Vector2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Vector2

type Output = Vector2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Vector2

type Output = Vector2

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Vector2

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Sub for Vector2

type Output = Vector2

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Vector2

impl StructuralPartialEq for Vector2