Struct JointHistogram 

pub struct JointHistogram { /* private fields */ }

An N-dimensional empirical weighted histogram stored in row-major order.

The last axis varies fastest. Bins are half-open on both ordinary and final upper edges, matching crate::histogram::Histogram flow semantics.

Implementations

impl JointHistogram

pub fn empty(axes: Vec<Vec<f64>>) -> Result<JointHistogram, LadduPhysicsError>

Construct an empty joint histogram from ordered axis edges.

Errors

Returns an error for no axes, malformed axis edges, shape overflow, or an accumulator allocation that cannot be satisfied.

pub fn axes(&self) -> &[Vec<f64>]

Ordered axis-edge metadata.

pub fn shape(&self) -> &[usize]

Bin count along each ordered axis.

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

Row-major flattened weighted sums.

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

Row-major flattened squared-weight sums.

pub fn errors(&self) -> Vec<f64>

Row-major flattened empirical standard errors.

pub fn reported_errors(&self) -> Option<Vec<f64>>

Return errors only when the stored constituents define an honest uncertainty.

pub fn uncertainty_status(&self) -> HistogramUncertaintyStatus

Return whether covariance information is sufficient to report errors.

pub fn diagnostics(&self) -> &JointHistogramDiagnostics

Aggregate invalid-event diagnostics.

pub fn fill_weighted( &mut self, coordinates: &[f64], weight: f64, ) -> Result<(), LadduPhysicsError>

Fill one ordered coordinate using an empirical event weight.

Errors

Returns an error when the coordinate rank differs from the histogram rank or a finite weight’s square cannot be represented.

pub fn merge(&mut self, other: &JointHistogram) -> Result<(), LadduPhysicsError>

Merge a histogram filled from a disjoint event partition atomically.

Errors

Returns an error for incompatible geometry, count overflow, or a nonfinite merged accumulator. A failure leaves self unchanged.

pub fn add( &self, other: &JointHistogram, ) -> Result<JointHistogram, LadduPhysicsError>

Add a compatible histogram without assuming the inputs are independent.

Errors

Returns an error for incompatible geometry or non-finite output.

pub fn add_independent( &self, other: &JointHistogram, ) -> Result<JointHistogram, LadduPhysicsError>

Add a compatible histogram with an explicit caller assertion of independence.

Errors

Returns an error for incompatible geometry or non-finite output.

pub fn subtract( &self, other: &JointHistogram, ) -> Result<JointHistogram, LadduPhysicsError>

Subtract a compatible histogram without assuming the inputs are independent.

Errors

Returns an error for incompatible geometry or non-finite output.

pub fn subtract_independent( &self, other: &JointHistogram, ) -> Result<JointHistogram, LadduPhysicsError>

Subtract a compatible histogram with an explicit caller assertion of independence.

Errors

Returns an error for incompatible geometry or non-finite output.

pub fn scaled(&self, factor: f64) -> Result<JointHistogram, LadduPhysicsError>

Scale central values, diagnostic weights, and uncertainty constituents.

Errors

Returns an error when the factor or scaled output is non-finite.

Trait Implementations

impl Clone for JointHistogram

fn clone(&self) -> JointHistogram

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JointHistogram

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JointHistogram

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for JointHistogram

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for JointHistogram

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 JointHistogram