Direction

Struct Direction 

Source
pub(crate) struct Direction<const N: usize> {
    pub(crate) k: Jet<N>,
    pub(crate) transverse: Jet<N>,
    pub(crate) xy: [Jet<N>; 2],
}
Expand description

The direction of a wavevector (kx, ky, kz) as jets in its components: slots 0, 1 and 2 hold the derivatives with respect to kx, ky and kz (only the first N are kept).

Fields§

§k: Jet<N>

The wavenumber k = sqrt(kx^2 + ky^2 + kz^2).

§transverse: Jet<N>

The transverse norm sqrt(kx^2 + ky^2), which is k sin(theta).

§xy: [Jet<N>; 2]

The unit transverse direction (kx, ky) / transverse, which is (cos phi, sin phi); zero on the z axis.

Implementations§

Source§

impl<const N: usize> Direction<N>

Source

pub(crate) fn new(vector: [Complex; 3]) -> Result<Self>

The direction of vector; see wavenumbers for the errors.

Source

pub(crate) fn from_parts( vector: [Complex; 3], k: Complex, transverse: Complex, xy: [Complex; 2], ) -> Result<Self>

The direction from the values wavenumbers returns. On the z axis the transverse direction has no derivative, so N > 0 gives an error there.

Auto Trait Implementations§

§

impl<const N: usize> Freeze for Direction<N>

§

impl<const N: usize> RefUnwindSafe for Direction<N>

§

impl<const N: usize> Send for Direction<N>

§

impl<const N: usize> Sync for Direction<N>

§

impl<const N: usize> Unpin for Direction<N>

§

impl<const N: usize> UnwindSafe for Direction<N>

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,