Struct birli::Jones

pub struct Jones<F>(_)
 where
    F: Float + Num;

Implementations

impl<F> Jones<F> where
    F: Float, 

pub fn identity() -> Jones<F>

Return an identity matrix. All imaginary parts are zero.

pub fn nan() -> Jones<F>

Return a matrix with all real parts set to NaN and all imaginary parts set to zero. Jones::any_nan() will return true for this Jones matrix.

pub fn h(self) -> Jones<F>

From an input Jones matrix, get a copy that has been Hermitian conjugated (J^H).

pub fn mul_hermitian(self, b: Jones<F>) -> Jones<F>

Multiply by a Jones matrix which gets Hermitian conjugated (J^H).

pub fn inv(self) -> Jones<F>

Get the inverse of the Jones matrix (J^I).

Ideally, J^I . J = I. However it’s possible that J is singular, in which case the contents of J^I are all NaN.

pub fn norm_sqr(self) -> [F; 4]

Call Complex::norm_sqr() on each element of a Jones matrix.

pub fn axb(a: Jones<F>, b: Jones<F>) -> Jones<F>

pub fn axbh(a: Jones<F>, b: Jones<F>) -> Jones<F>

impl<F> Jones<F> where
    F: Float + FloatCore, 

pub fn any_nan(self) -> bool

Are any elements of this Jones NaN?

impl<F> Jones<F> where
    F: Float + NumAssign, 

pub fn plus_axb(c: &mut Jones<F>, a: Jones<F>, b: Jones<F>)

pub fn plus_ahxb(c: &mut Jones<F>, a: Jones<F>, b: Jones<F>)

Methods from Deref<Target = [Complex<F>; 4]>

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N]

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

Borrows each element and returns an array of references with the same size as self.

Example

#![feature(array_methods)]

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

#![feature(array_methods)]

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn each_mut(&mut self) -> [&mut T; N]

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

Borrows each element mutably and returns an array of mutable references with the same size as self.

Example

#![feature(array_methods)]

let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

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

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])

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

Divides one mutable array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_array_mut::<2>();
assert_eq!(left, &mut [1, 0][..]);
assert_eq!(right, &mut [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

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

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])

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

Divides one mutable array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.rsplit_array_mut::<4>();
assert_eq!(left, &mut [1, 0]);
assert_eq!(right, &mut [3, 0, 5, 6][..]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

Trait Implementations

impl<F> Add<Jones<F>> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the + operator.

pub fn add(self, rhs: Jones<F>) -> Jones<F>

Performs the + operation.

impl<'_, F> AddAssign<&'_ Jones<F>> for Jones<F> where
    F: Float + NumAssign, 

pub fn add_assign(&mut self, rhs: &Jones<F>)

Performs the += operation.

impl<F> AddAssign<Jones<F>> for Jones<F> where
    F: Float + NumAssign, 

pub fn add_assign(&mut self, rhs: Jones<F>)

Performs the += operation.

impl<F> Clone for Jones<F> where
    F: Clone + Float + Num, 

pub fn clone(&self) -> Jones<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Jones<f32>

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

Formats the value using the given formatter.

impl Debug for Jones<f64>

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

Formats the value using the given formatter.

impl<F> Default for Jones<F> where
    F: Default + Float + Num, 

pub fn default() -> Jones<F>

Returns the “default value” for a type.

impl<F> Deref for Jones<F> where
    F: Float, 

type Target = [Complex<F>; 4]

The resulting type after dereferencing.

pub fn deref(&self) -> &<Jones<F> as Deref>::Target

Dereferences the value.

impl<F> DerefMut for Jones<F> where
    F: Float, 

pub fn deref_mut(&mut self) -> &mut <Jones<F> as Deref>::Target

Mutably dereferences the value.

impl Display for Jones<f32>

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

Formats the value using the given formatter.

impl Display for Jones<f64>

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

Formats the value using the given formatter.

impl<'_, F> Div<&'_ Jones<F>> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the / operator.

pub fn div(self, rhs: &Jones<F>) -> Jones<F>

Performs the / operation.

impl<F> Div<Complex<F>> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the / operator.

pub fn div(self, rhs: Complex<F>) -> Jones<F>

Performs the / operation.

impl<F> Div<F> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the / operator.

pub fn div(self, rhs: F) -> Jones<F>

Performs the / operation.

impl<F> Div<Jones<F>> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the / operator.

pub fn div(self, rhs: Jones<F>) -> Jones<F>

Performs the / operation.

impl<'_, F> DivAssign<&'_ Jones<F>> for Jones<F> where
    F: Float + NumAssign, 

pub fn div_assign(&mut self, rhs: &Jones<F>)

Performs the /= operation.

impl<F> DivAssign<Complex<F>> for Jones<F> where
    F: Float + NumAssign, 

pub fn div_assign(&mut self, rhs: Complex<F>)

Performs the /= operation.

impl<F> DivAssign<F> for Jones<F> where
    F: Float + NumAssign, 

pub fn div_assign(&mut self, rhs: F)

Performs the /= operation.

impl<F> DivAssign<Jones<F>> for Jones<F> where
    F: Float + NumAssign, 

pub fn div_assign(&mut self, rhs: Jones<F>)

Performs the /= operation.

impl<'_> From<&'_ Jones<f32>> for Jones<f64>

pub fn from(j_c32: &Jones<f32>) -> Jones<f64>

Performs the conversion.

impl<'_> From<&'_ Jones<f64>> for Jones<f32>

pub fn from(j_c64: &Jones<f64>) -> Jones<f32>

Performs the conversion.

impl<F> From<[Complex<F>; 4]> for Jones<F> where
    F: Float, 

pub fn from(arr: [Complex<F>; 4]) -> Jones<F>

Performs the conversion.

impl From<Jones<f32>> for Jones<f64>

pub fn from(j_c32: Jones<f32>) -> Jones<f64>

Performs the conversion.

impl From<Jones<f64>> for Jones<f32>

pub fn from(j_c64: Jones<f64>) -> Jones<f32>

Performs the conversion.

impl<'_, F> Mul<&'_ Jones<F>> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the * operator.

pub fn mul(self, rhs: &Jones<F>) -> Jones<F>

Performs the * operation.

impl<F> Mul<Complex<F>> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the * operator.

pub fn mul(self, rhs: Complex<F>) -> Jones<F>

Performs the * operation.

impl<F> Mul<F> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the * operator.

pub fn mul(self, rhs: F) -> Jones<F>

Performs the * operation.

impl<F> Mul<Jones<F>> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the * operator.

pub fn mul(self, rhs: Jones<F>) -> Jones<F>

Performs the * operation.

impl<'_, F> MulAssign<&'_ Jones<F>> for Jones<F> where
    F: Float + NumAssign, 

pub fn mul_assign(&mut self, rhs: &Jones<F>)

Performs the *= operation.

impl<F> MulAssign<Complex<F>> for Jones<F> where
    F: Float + NumAssign, 

pub fn mul_assign(&mut self, rhs: Complex<F>)

Performs the *= operation.

impl<F> MulAssign<F> for Jones<F> where
    F: Float + NumAssign, 

pub fn mul_assign(&mut self, rhs: F)

Performs the *= operation.

impl<F> MulAssign<Jones<F>> for Jones<F> where
    F: Float + NumAssign, 

pub fn mul_assign(&mut self, rhs: Jones<F>)

Performs the *= operation.

impl<F> PartialEq<Jones<F>> for Jones<F> where
    F: PartialEq<F> + Float + Num, 

pub fn eq(&self, other: &Jones<F>) -> bool

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

pub fn ne(&self, other: &Jones<F>) -> bool

This method tests for !=.

impl<'_, F> Sub<&'_ Jones<F>> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the - operator.

pub fn sub(self, rhs: &Jones<F>) -> Jones<F>

Performs the - operation.

impl<'_, F> Sub<&'_ mut Jones<F>> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the - operator.

pub fn sub(self, rhs: &mut Jones<F>) -> Jones<F>

Performs the - operation.

impl<F> Sub<Jones<F>> for Jones<F> where
    F: Float, 

type Output = Jones<F>

The resulting type after applying the - operator.

pub fn sub(self, rhs: Jones<F>) -> Jones<F>

Performs the - operation.

impl<'_, F> SubAssign<&'_ Jones<F>> for Jones<F> where
    F: Float + NumAssign, 

pub fn sub_assign(&mut self, rhs: &Jones<F>)

Performs the -= operation.

impl<F> SubAssign<Jones<F>> for Jones<F> where
    F: Float + NumAssign, 

pub fn sub_assign(&mut self, rhs: Jones<F>)

Performs the -= operation.

impl<F> Zero for Jones<F> where
    F: Float, 

pub fn zero() -> Jones<F>

Returns the additive identity element of Self, 0.

pub fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<F> Copy for Jones<F> where
    F: Copy + Float + Num, 

impl<F> StructuralPartialEq for Jones<F> where
    F: Float + Num,