Struct DivergenceMetadata 

pub struct DivergenceMetadata {
    pub model: &'static str,
    pub width_kind: &'static str,
    pub width_rad: f64,
    pub width_deg: f64,
    pub incidence: &'static str,
    pub max_attempts: u32,
    pub stream_word: &'static str,
}

Run metadata of a beam divergence (Bca::divergence_metadata): the distribution, its width and the incidence policy, so a result states the spread it was run with.

Fields

model: &'static str

"gaussian" or "uniform-cone".

width_kind: &'static str

Which angle width_rad is: "sigma_per_plane" (Gaussian standard deviation of each of two orthogonal plane angles) or "cone_half_angle" (uniform in solid angle).

width_rad: f64

The width, radians.

width_deg: f64

The width, degrees (the unit the input uses).

incidence: &'static str

Incidence policy: "inward-conditioned", i.e. the distribution conditioned on directions into the target by rejection sampling.

max_attempts: u32

Rejection-sampling attempt bound per primary.

stream_word: &'static str

Word position of the random-stream segment the draws come from.

Implementations

impl DivergenceMetadata

pub fn new(divergence: &Divergence) -> Option<Self>

Metadata of divergence; None for Divergence::None.

Trait Implementations

impl Clone for DivergenceMetadata

fn clone(&self) -> DivergenceMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DivergenceMetadata

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

Formats the value using the given formatter.

impl PartialEq for DivergenceMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DivergenceMetadata

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 DivergenceMetadata