Struct RuleSet 

pub struct RuleSet { /* private fields */ }

A collection of selection rules for testing whether a two-body decay channel is allowed.

Each rule enables one conservation or symmetry check. Each enabled rule is associated with a RulePolicy which dictates how permissively it should be applied to the given particles.

Notes

The default angular policy doesn’t actually enforce any rules, as angular momentum conservation and coupling rules are handled by other methods.

All constructors assume a permissive enforcement policy, i.e. if a property is unknown for one or more particles involved, that check is skipped.

Implementations

impl RuleSet

pub fn angular() -> Self

Construct a rule set with no non-angular selection rules enabled.

This is useful when only the angular-momentum coupling constraints should be applied: $S \in |j_a - j_b|, \ldots, j_a + j_b$ and $J \in |L - S|, \ldots, L + S$.

pub fn strong() -> Self

Construct a rule set appropriate for ordinary strong two-body decays.

This enables parity, isospin, isospin projection, electric charge, flavor quantum numbers, baryon number, and identical-particle exchange symmetry.

Charge-conjugation parity and G-parity are left disabled because they are only meaningful for certain channels and should be enabled explicitly when applicable.

pub fn electromagnetic() -> Self

Construct a rule set appropriate for electromagnetic two-body decays.

This enables parity, electric charge, flavor quantum numbers, baryon number, isospin-projection conservation, and identical-particle exchange symmetry.

Total isospin is not enabled because electromagnetic interactions break isospin symmetry.

pub fn weak() -> Self

Construct a rule set appropriate for weak two-body decays.

This enables electric charge, baryon number, individual lepton-family numbers, total lepton number, and identical-particle exchange symmetry.

Parity, isospin, strangeness, charm, bottomness, and topness are not enabled because weak interactions can violate or change them.

pub fn enforce_mut(&mut self, rule: RuleKind) -> &mut Self

Enable a rule in place using permissive missing-input handling.

pub fn enforce_strict_mut(&mut self, rule: RuleKind) -> &mut Self

Enable a rule in place and reject candidates with missing inputs.

pub fn set_policy_mut( &mut self, rule: RuleKind, policy: RulePolicy, ) -> &mut Self

Assign an explicit policy to a rule in place.

pub fn ignore_mut( &mut self, rule: RuleKind, reason: impl Into<String>, ) -> &mut Self

Ignore a rule in place and record the supplied reason.

pub fn ignore_without_reason_mut(&mut self, rule: RuleKind) -> &mut Self

Ignore a rule in place without recording a reason.

pub fn diagnose_only_mut( &mut self, rule: RuleKind, reason: impl Into<String>, ) -> &mut Self

Make a rule diagnostic-only in place and record the supplied reason.

pub fn diagnose_only_without_reason_mut(&mut self, rule: RuleKind) -> &mut Self

Make a rule diagnostic-only in place without recording a reason.

pub fn disable_mut(&mut self, rule: RuleKind) -> &mut Self

Remove a rule from this set in place.

pub fn with_unknown_policy_mut( &mut self, rule: RuleKind, unknown: UnknownPolicy, ) -> &mut Self

Change a rule’s missing-input policy in place.

The rule is enabled with RulePolicy::enforce if it was not already configured.

pub fn enforce(self, rule: RuleKind) -> Self

Return a copy with a permissively enforced rule.

pub fn enforce_strict(self, rule: RuleKind) -> Self

Return a copy with a strictly enforced rule.

pub fn set_policy(self, rule: RuleKind, policy: RulePolicy) -> Self

Return a copy with an explicit policy assigned to a rule.

pub fn ignore(self, rule: RuleKind, reason: impl Into<String>) -> Self

Return a copy which ignores a rule for the supplied reason.

pub fn ignore_without_reason(self, rule: RuleKind) -> Self

Return a copy which ignores a rule without recording a reason.

pub fn diagnose_only(self, rule: RuleKind, reason: impl Into<String>) -> Self

Return a copy which evaluates a rule only for diagnostics.

pub fn diagnose_only_without_reason(self, rule: RuleKind) -> Self

Return a copy which evaluates a rule only for diagnostics, without a reason.

pub fn disable(self, rule: RuleKind) -> Self

Return a copy with a rule removed.

pub fn with_unknown_policy(self, rule: RuleKind, unknown: UnknownPolicy) -> Self

Return a copy with the selected missing-input policy.

pub fn policy(&self, rule: RuleKind) -> Option<&RulePolicy>

Retrieve the configured policy for a rule.

pub fn enabled_rules(&self) -> impl Iterator<Item = RuleKind> + '_

Iterate over the configured rules in stable RuleKind order.

pub fn check( &self, parent: &ParticleProperties, daughters: (&ParticleProperties, &ParticleProperties), l: L, s: S, ) -> bool

Return whether a two-body partial-wave candidate satisfies this rule set.

pub fn evaluate( &self, parent: &ParticleProperties, daughters: (&ParticleProperties, &ParticleProperties), l: L, s: S, ) -> RuleReport

Evaluate every configured rule and return a detailed report.

Trait Implementations

impl Clone for RuleSet

fn clone(&self) -> RuleSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleSet

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

Formats the value using the given formatter.

impl Default for RuleSet

fn default() -> RuleSet

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RuleSet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RuleSet

impl Hash for RuleSet

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

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 PartialEq for RuleSet

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RuleSet

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RuleSet