Struct ParticleID

pub struct ParticleID(/* private fields */);

Particle ID according to the Monte Carlo Particle Numbering Scheme

Implementations

impl ParticleID

pub const fn new(id: i32) -> ParticleID

Construct from the given id

pub const fn latex_symbol(&self) -> Option<&'static str>

Particle symbol in LaTeX format

pub const fn symbol(&self) -> Option<&'static str>

Particle symbol in UTF-8 format

pub const fn name(&self) -> Option<&'static str>

Name of the associated particle

pub const fn id(self) -> i32

Get the corresponding integer

Example

use particle_id::sm_elementary_particles::*;
assert_eq!(photon.id(), 22);

pub const fn anti(self) -> ParticleID

Get the corresponding anti-particle

Example

use particle_id::sm_elementary_particles::*;
assert_eq!(positron.anti(), electron);
assert_eq!(electron.anti(), positron);

pub const fn abs(self) -> ParticleID

Get the corresponding particle for an anti-particle

If not used on an anti-particle, returns the particle itself

Example

use particle_id::sm_elementary_particles::*;
assert_eq!(positron.abs(), electron);
assert_eq!(electron.abs(), electron);

pub const fn is_anti_particle(&self) -> bool

Check if this is an anti-particle

Example

use particle_id::sm_elementary_particles::*;
assert!(!electron.is_anti_particle());
assert!(positron.is_anti_particle());

pub const fn is_gauge_boson(&self) -> bool

Check if this is a gauge boson

Example

use particle_id::sm_elementary_particles::*;
assert!(photon.is_gauge_boson());
assert!(!electron.is_gauge_boson());
assert!(!Higgs.is_gauge_boson());

pub const fn is_quark(&self) -> bool

Check if this is a quark

Note that anti-quarks are not treated as quarks! Use abs() if you want to include both quarks and anti-quarks.

Example

use particle_id::sm_elementary_particles::*;
assert!(top.is_quark());
assert!(!anti_top.is_quark());
assert!(anti_top.abs().is_quark());
assert!(anti_top.anti().is_quark());

pub const fn is_anti_quark(&self) -> bool

Check if this is an anti-quark

Example

use particle_id::sm_elementary_particles::*;
assert!(!top.is_anti_quark());
assert!(anti_top.is_anti_quark());

pub const fn is_lepton(&self) -> bool

Check if this is a lepton

Note that anti-leptons are not treated as leptons! Use abs() if you want to include both leptons and anti-leptons.

Both charged leptons and neutrinos are included.

Example

use particle_id::sm_elementary_particles::*;
assert!(muon.is_lepton());
assert!(!anti_muon.is_lepton());
assert!(anti_muon.abs().is_lepton());
assert!(anti_muon.anti().is_lepton());

pub const fn is_anti_lepton(&self) -> bool

Check if this is an anti-lepton

Example

use particle_id::sm_elementary_particles::*;
assert!(!muon.is_anti_lepton());
assert!(anti_muon.is_anti_lepton());

pub const fn is_neutrino(&self) -> bool

Check if this is a neutrino

Note that anti-neutrinos are not treated as neutrinos! Use abs() if you want to include both neutrinos and anti-neutrinos.

Example

use particle_id::sm_elementary_particles::*;
assert!(muon_neutrino.is_neutrino());
assert!(!muon_anti_neutrino.is_neutrino());

pub const fn is_anti_neutrino(&self) -> bool

Check if this is an anti-neutrino

Example

use particle_id::sm_elementary_particles::*;
assert!(!muon_neutrino.is_anti_neutrino());
assert!(muon_anti_neutrino.is_anti_neutrino());

pub const fn is_charged_lepton(&self) -> bool

Check if this is a charged lepton

Note that anti-leptons are not treated as leptons! Use abs() if you want to include both leptons and anti-leptons.

Example

use particle_id::sm_elementary_particles::*;
assert!(muon.is_charged_lepton());
assert!(!electron_neutrino.is_charged_lepton());

pub const fn is_charged_anti_lepton(&self) -> bool

Check if this is a charged anti-lepton

Example

use particle_id::sm_elementary_particles::*;
assert!(!muon.is_charged_anti_lepton());
assert!(anti_muon.is_charged_anti_lepton());

Trait Implementations

impl Clone for ParticleID

fn clone(&self) -> ParticleID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParticleID

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParticleID

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ParticleID

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ParticleID

fn cmp(&self, other: &ParticleID) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ParticleID

fn eq(&self, other: &ParticleID) -> 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 PartialOrd for ParticleID

fn partial_cmp(&self, other: &ParticleID) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ParticleID

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ParticleID

impl Eq for ParticleID

impl StructuralPartialEq for ParticleID