keplerian_sim

Struct Matrix3x2

Source
pub struct Matrix3x2<T> {
    pub e11: T,
    pub e12: T,
    pub e21: T,
    pub e22: T,
    pub e31: T,
    pub e32: T,
}
Expand description

A struct representing a 3x2 matrix.

This struct is used to store the transformation matrix for transforming a 2D vector into a 3D vector.

Namely, it is used in the tilt_flat_position method to tilt a 2D position into 3D, using the orbital parameters.

Each element is named eXY, where X is the row and Y is the column.

§Example

use keplerian_sim::Matrix3x2;
 
let matrix: Matrix3x2<f64> = Matrix3x2 {
   e11: 1.0, e12: 0.0,
   e21: 0.0, e22: 1.0,
   e31: 0.0, e32: 0.0,
};
 
let vec = (1.0, 2.0);
 
let result = matrix.dot_vec(vec);
 
assert_eq!(result, (1.0, 2.0, 0.0));

Fields§

§e11: T§e12: T§e21: T§e22: T§e31: T§e32: T

Implementations§

Source§

impl<T: Copy> Matrix3x2<T>

Source

pub fn filled_with(element: T) -> Matrix3x2<T>

Create a new Matrix3x2 instance where each element is initialized with the same value.

§Example
use keplerian_sim::Matrix3x2;
 
let matrix = Matrix3x2::filled_with(0.0);
 
assert_eq!(matrix, Matrix3x2 {
   e11: 0.0, e12: 0.0,
   e21: 0.0, e22: 0.0,
   e31: 0.0, e32: 0.0,
});
Source§

impl<T> Matrix3x2<T>
where T: Copy + Mul<Output = T> + Add<Output = T>,

Source

pub fn dot_vec(&self, vec: (T, T)) -> (T, T, T)

Computes a dot product between this matrix and a 2D vector.

§Example
use keplerian_sim::Matrix3x2;
 
let matrix: Matrix3x2<f64> = Matrix3x2 {
    e11: 1.0, e12: 0.0,
    e21: 0.0, e22: 1.0,
    e31: 1.0, e32: 1.0,
};
 
let vec = (1.0, 2.0);
 
let result = matrix.dot_vec(vec);
 
assert_eq!(result, (1.0, 2.0, 3.0));

Trait Implementations§

Source§

impl<T: Clone> Clone for Matrix3x2<T>

Source§

fn clone(&self) -> Matrix3x2<T>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Matrix3x2<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: PartialEq> PartialEq for Matrix3x2<T>

Source§

fn eq(&self, other: &Matrix3x2<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<T: Copy> Copy for Matrix3x2<T>

Source§

impl<T: Eq> Eq for Matrix3x2<T>

Source§

impl<T> StructuralPartialEq for Matrix3x2<T>

Auto Trait Implementations§

§

impl<T> Freeze for Matrix3x2<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Matrix3x2<T>
where T: RefUnwindSafe,

§

impl<T> Send for Matrix3x2<T>
where T: Send,

§

impl<T> Sync for Matrix3x2<T>
where T: Sync,

§

impl<T> Unpin for Matrix3x2<T>
where T: Unpin,

§

impl<T> UnwindSafe for Matrix3x2<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.