Struct lattice_qcd_rs::field::Su3Adjoint

pub struct Su3Adjoint { /* private fields */ }

Adjoint representation of SU(3), it is su(3) (i.e. the lie algebra). See su3::GENERATORS to view the order of generators. Note that the generators are normalize such that Tr[T^a T^b] = \delta^{ab} / 2

Implementations

impl Su3Adjoint

pub const fn new(data: Vector8<Real>) -> Self

create a new Su3Adjoint representation where M = M^a T^a, where T are generators given in su3::GENERATORS.

Example

use lattice_qcd_rs::field::Su3Adjoint;
use nalgebra::SVector;

let su3 = Su3Adjoint::new(SVector::<f64, 8>::from_element(1_f64));

pub fn new_from_array(data: [Real; 8]) -> Self

create a new Su3Adjoint representation where M = M^a T^a, where T are generators given in su3::GENERATORS.

Example

let su3 = Su3Adjoint::new_from_array([0_f64; 8]);

pub const fn data(&self) -> &Vector8<Real>

get the data inside the Su3Adjoint.

pub const fn as_vector(&self) -> &Vector8<Real>

Get the su3 adjoint as a Vector8.

Example

let max = adj.as_vector().max();
let norm = adj.as_ref().norm();

pub fn as_vector_mut(&mut self) -> &mut Vector8<Real>

Get the su3 adjoint as mut ref to a Vector8.

Example

let mut adj = Su3Adjoint::default(); // filled with 0.
adj.as_vector_mut().apply(|el| *el += 1_f64);
assert_eq!(adj.as_vector(), &Vector8::from_element(1_f64));

adj.as_mut().set_magnitude(1_f64);

let mut v = Vector8::from_element(1_f64);
v.set_magnitude(1_f64);

assert_eq!(adj.as_vector(), &v);

pub fn to_matrix(self) -> Matrix3<Complex<Real>>

Returns the su(3) (Lie algebra) matrix.

Example

let su3 = Su3Adjoint::new_from_array([1_f64, 0_f64, 0_f64, 0_f64, 0_f64, 0_f64, 0_f64, 0_f64]);
assert_eq!(su3.to_matrix(), *lattice_qcd_rs::su3::GENERATORS[0]);

pub fn to_su3(self) -> Matrix3<Complex<Real>>

Return the SU(3) matrix associated with this generator. Note that the function consume self.

Example

let su3 = Su3Adjoint::new_from_array([1_f64, 0_f64, 0_f64, 0_f64, 0_f64, 0_f64, 0_f64, 0_f64]);
assert_eq!(su3.to_su3().determinant(), nalgebra::Complex::from(1_f64));

pub fn exp(self) -> Matrix3<Complex<Real>>

Return exp( T^a v^a) where v is self. Note that the function consume self.

pub fn random<Rng>(rng: &mut Rng, d: &impl Distribution<Real>) -> Selfwhere Rng: Rng + ?Sized,

Create a new random SU3 adjoint.

Example

use lattice_qcd_rs::field::Su3Adjoint;

let mut rng = rand::thread_rng();
let distribution = rand::distributions::Uniform::from(-1_f64..1_f64);
let su3 = Su3Adjoint::random(&mut rng, &distribution);

pub fn trace_squared(&self) -> Real

Returns the trace squared Tr(X^2).

It is more accurate and faster than computing

(m.to_matrix() * m.to_matrix()).trace().real();

pub fn t(&self) -> Real

Return the t coeff t = - 1/2 * Tr(X^2). If you are looking for the trace square use Self::trace_squared instead.

It is used for su3::su3_exp_i.

Example

let su3 = Su3Adjoint::from([1_f64; 8]);
let m = su3.to_matrix();
assert_eq!(
    nalgebra::Complex::new(su3.t(), 0_f64),
    -nalgebra::Complex::from(0.5_f64) * (m * m).trace()
);

pub fn d(&self) -> Complex<Real>

Return the t coeff d = i * det(X). Used for su3::su3_exp_i.

Example

let su3 = Su3Adjoint::from([1_f64; 8]);
let m = su3.to_matrix();
assert_eq!(
    su3.d(),
    nalgebra::Complex::new(0_f64, 1_f64) * m.determinant()
);

pub fn len(&self) -> usize

Return the number of data. This number is 8

assert_eq!(su3.len(), 8);

pub const fn len_const() -> usize

Return the number of data. This number is 8

let su3 = Su3Adjoint::new(nalgebra::SVector::<f64, 8>::zeros());
assert_eq!(Su3Adjoint::len_const(), su3.len());

pub fn iter( &self ) -> impl Iterator<Item = &Real> + ExactSizeIterator + FusedIterator

Get an iterator over the elements.

Example

let sum_abs = adj.iter().map(|el| el.abs()).sum::<f64>();

pub fn iter_mut( &mut self ) -> impl Iterator<Item = &mut Real> + ExactSizeIterator + FusedIterator

Get an iterator over the mutable ref of elements.

Example

adj.iter_mut().for_each(|el| *el = *el / 2_f64);

pub fn data_mut(&mut self) -> &mut Vector8<Real>

Get a mutable reference over the data.

Trait Implementations

impl Add<&Su3Adjoint> for &Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Su3Adjoint> for Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Su3Adjoint> for &Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Su3Adjoint> for Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Su3Adjoint> for Su3Adjoint

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AsMut<Matrix<f64, Const<8>, Const<1>, ArrayStorage<f64, 8, 1>>> for Su3Adjoint

fn as_mut(&mut self) -> &mut Vector8<f64>

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Matrix<f64, Const<8>, Const<1>, ArrayStorage<f64, 8, 1>>> for Su3Adjoint

fn as_ref(&self) -> &Vector8<f64>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Su3Adjoint

fn clone(&self) -> Su3Adjoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Su3Adjoint

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

Formats the value using the given formatter.

impl Default for Su3Adjoint

Return the representation for the zero matrix.

fn default() -> Self

Return the representation for the zero matrix.

Example

assert_eq!(
    Su3Adjoint::default(),
    Su3Adjoint::new_from_array([0_f64; 8])
);

impl<'de> Deserialize<'de> for Su3Adjoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Su3Adjoint

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

Formats the value using the given formatter.

impl Div<&f64> for &Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the / operator.

fn div(self, rhs: &Real) -> Self::Output

Performs the / operation.

impl Div<&f64> for Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the / operator.

fn div(self, rhs: &Real) -> Self::Output

Performs the / operation.

impl Div<f64> for &Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<&f64> for Su3Adjoint

fn div_assign(&mut self, rhs: &f64)

Performs the /= operation.

impl DivAssign<f64> for Su3Adjoint

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl From<&Su3Adjoint> for Vector8<Real>

fn from(v: &Su3Adjoint) -> Self

Converts to this type from the input type.

impl From<[f64; 8]> for Su3Adjoint

fn from(v: [Real; 8]) -> Self

Converts to this type from the input type.

impl From<Matrix<f64, Const<8>, Const<1>, ArrayStorage<f64, 8, 1>>> for Su3Adjoint

fn from(v: Vector8<Real>) -> Self

Converts to this type from the input type.

impl From<Su3Adjoint> for Vector8<Real>

fn from(v: Su3Adjoint) -> Self

Converts to this type from the input type.

impl Index<usize> for Su3Adjoint

fn index(&self, pos: usize) -> &Self::Output

Get the element at position pos.

Panic

Panics if the position is out of bound (greater or equal to 8).

let su3 = Su3Adjoint::new_from_array([0_f64; 8]);
let _ = su3[8];

type Output = f64

The returned type after indexing.

impl IndexMut<usize> for Su3Adjoint

fn index_mut(&mut self, pos: usize) -> &mut Self::Output

Get the element at position pos.

Panic

Panics if the position is out of bound (greater or equal to 8).

let mut su3 = Su3Adjoint::new_from_array([0_f64; 8]);
su3[8] += 1_f64;

impl<'a> IntoIterator for &'a Su3Adjoint

type IntoIter = <&'a Matrix<f64, Const<8>, Const<1>, ArrayStorage<f64, 8, 1>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

type Item = &'a f64

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Su3Adjoint

type IntoIter = <&'a mut Matrix<f64, Const<8>, Const<1>, ArrayStorage<f64, 8, 1>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

type Item = &'a mut f64

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Mul<&Su3Adjoint> for &Real

type Output = Su3Adjoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Su3Adjoint> for Real

type Output = Su3Adjoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&f64> for &Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&f64> for Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Su3Adjoint> for &Real

type Output = Su3Adjoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Su3Adjoint> for Real

type Output = Su3Adjoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for &Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for Su3Adjoint

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl Neg for &Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<Su3Adjoint> for Su3Adjoint

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

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

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

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

impl Serialize for Su3Adjoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<&Su3Adjoint> for &Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Su3Adjoint> for Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Su3Adjoint> for &Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Su3Adjoint> for Su3Adjoint

type Output = Su3Adjoint

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Su3Adjoint> for Su3Adjoint

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Su3Adjoint

impl StructuralPartialEq for Su3Adjoint