Struct HistogramAccumulatorState 

pub struct HistogramAccumulatorState {

    pub kind: HistogramSnapshotKind,
    pub title: String,
    pub type_description: String,
    pub phase: ObservablePhase,
    pub value_transform: ObservableValueTransform,
    pub supports_misbinning_mitigation: bool,
    pub x_min: f64,
    pub x_max: f64,
    pub sample_count: usize,
    pub log_x_axis: bool,
    pub log_y_axis: bool,
    pub discrete_min_bin_id: Option<isize>,
    pub discrete_ordering: Option<DiscreteBinOrdering>,
    pub bin_labels: Vec<Option<String>>,
    pub bins: Vec<ObservableBinAccumulator>,
    pub underflow_bin: ObservableBinAccumulator,
    pub overflow_bin: ObservableBinAccumulator,
    pub statistics: ObservableHistogramStatistics,
    /* private fields */
}

Fields

kind: HistogramSnapshotKind

Determines whether bins represent continuous ranges or discrete identifiers.

title: String

Human-readable histogram title used by snapshots and exported output.

type_description: String

HwU TYPE@ description retained in generated snapshots.

phase: ObservablePhase

Real or imaginary component of the complex event weight accumulated in this histogram.

value_transform: ObservableValueTransform

Transformation applied to observable coordinates before continuous binning.

supports_misbinning_mitigation: bool

Whether the observable supports paired fills that mitigate boundary misbinning.

x_min: f64

Lower continuous bound, or the smallest discrete bin identifier as an f64.

x_max: f64

Upper continuous bound, or one past the largest discrete bin identifier as an f64.

sample_count: usize

Number of committed statistically independent Monte Carlo samples.

log_x_axis: bool

Whether compatible renderers should display the horizontal axis logarithmically.

log_y_axis: bool

Whether compatible renderers should display the vertical axis logarithmically.

discrete_min_bin_id: Option<isize>

Smallest discrete bin identifier, or None for a continuous histogram.

discrete_ordering: Option<DiscreteBinOrdering>

Display ordering for discrete bins, or None for a continuous histogram.

bin_labels: Vec<Option<String>>

Optional labels indexed by bin offset, primarily used by discrete histograms.

bins: Vec<ObservableBinAccumulator>

Per-bin raw-stat accumulators in continuous or ascending discrete-bin order.

underflow_bin: ObservableBinAccumulator

Raw-stat accumulator for entries below the configured histogram range.

overflow_bin: ObservableBinAccumulator

Raw-stat accumulator for entries above the configured histogram range.

statistics: ObservableHistogramStatistics

Histogram-wide entry, non-finite-value, and mitigation counters.

Implementations

impl HistogramAccumulatorState

pub fn continuous( title: String, type_description: String, phase: ObservablePhase, value_transform: ObservableValueTransform, x_min: f64, x_max: f64, log_x_axis: bool, log_y_axis: bool, n_bins: usize, ) -> Self

pub fn discrete( title: String, type_description: String, phase: ObservablePhase, min_bin_id: isize, max_bin_id: isize, ordering: DiscreteBinOrdering, log_y_axis: bool, bin_labels: Vec<Option<String>>, ) -> Result<Self>

pub fn snapshot(&self) -> HistogramSnapshot

pub fn merge_in_place( &mut self, other: &mut HistogramAccumulatorState, ) -> Result<()>

pub fn merged_with(&self, other: &HistogramAccumulatorState) -> Result<Self>

pub fn update_results(&mut self)

pub fn fill_continuous_sample(&mut self, entries: &[(f64, f64)]) -> Result<()>

pub fn fill_discrete_sample(&mut self, entries: &[(isize, f64)]) -> Result<()>

pub fn rebin(&self, contiguous_bins: usize) -> Result<Self>

pub fn rescale(&mut self, factor: f64)

pub fn rescaled(&self, factor: f64) -> Self

pub fn change_bin_ordering( &mut self, ordering: DiscreteBinOrdering, ) -> Result<()>

pub fn changed_bin_ordering( &self, ordering: DiscreteBinOrdering, ) -> Result<Self>

Trait Implementations

impl Clone for HistogramAccumulatorState

fn clone(&self) -> HistogramAccumulatorState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HistogramAccumulatorState

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

Formats the value using the given formatter.

impl Default for HistogramAccumulatorState

fn default() -> HistogramAccumulatorState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HistogramAccumulatorState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HistogramAccumulatorState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.