Struct BinningAxis 

pub struct BinningAxis { /* private fields */ }

A finite, strictly increasing one-dimensional bin axis.

Implementations

impl BinningAxis

pub fn new( edges: impl IntoIterator<Item = f64>, ) -> Result<BinningAxis, LadduPhysicsError>

Validate and construct an axis from explicit edges.

Errors

Returns an error unless at least two finite, strictly increasing edges are supplied.

pub fn uniform( count: usize, min: f64, max: f64, ) -> Result<BinningAxis, LadduPhysicsError>

Construct uniformly spaced bins over finite increasing bounds.

Errors

Returns an error for zero bins or non-finite/non-increasing bounds.

pub fn edges(&self) -> &[f64]

Validated edge values.

pub fn bin_count(&self) -> usize

Number of bins along the axis.

pub fn index(&self, value: f64, final_upper: FinalUpperEdge) -> Option<usize>

Assign a value using half-open internal bins and an explicit final-edge policy.

Trait Implementations

impl Clone for BinningAxis

fn clone(&self) -> BinningAxis

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinningAxis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BinningAxis

fn deserialize<D>( deserializer: D, ) -> Result<BinningAxis, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BinningAxis

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BinningAxis

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 StructuralPartialEq for BinningAxis