Struct pineappl::bin::BinLimits

pub struct BinLimits(_);

Structure representing bin limits.

Implementations

impl BinLimits

#[must_use]pub fn new(limits: Vec<f64>) -> Self

Constructor for BinLimits.

#[must_use]pub fn bins(&self) -> usize

Returns the number of bins.

#[must_use]pub fn index(&self, value: f64) -> Option<usize>

Returns the bin index for observable value. If the value over- or underflows, the return value is None.

#[must_use]pub fn left(&self) -> f64

Returns the left-most bin limit

#[must_use]pub fn limits(&self) -> Vec<f64>

Returns the limits in a Vec.

Examples

use pineappl::bin::BinLimits;

// example with equally sized bins
let equal_bins = BinLimits::new(vec![0.25, 0.5, 0.75, 1.0]);
assert_eq!(equal_bins.limits(), vec![0.25, 0.5, 0.75, 1.0]);

// example with unequally sized bins
let unequal_bins = BinLimits::new(vec![0.125, 0.25, 1.0, 1.5]);
assert_eq!(unequal_bins.limits(), vec![0.125, 0.25, 1.0, 1.5]);

#[must_use]pub fn bin_sizes(&self) -> Vec<f64>

Returns the size for each bin.

Examples

use pineappl::bin::BinLimits;

// example with equally sized bins
let equal_bins = BinLimits::new(vec![0.25, 0.5, 0.75, 1.0]);
assert_eq!(equal_bins.bin_sizes(), vec![0.25, 0.25, 0.25]);

// example with unequally sized bins
let unequal_bins = BinLimits::new(vec![0.125, 0.25, 1.0, 1.5]);
assert_eq!(unequal_bins.bin_sizes(), vec![0.125, 0.75, 0.5]);

pub fn merge(&mut self, other: &Self) -> Result<(), MergeBinError>

Merge the limits of other into self on the right-hand-side. If both limits are non-consecutive, an error is returned.

Errors

If the right-most limit of self is different from the left-most limit of other, the bins are non-consecutive and an error is returned.

#[must_use]pub fn right(&self) -> f64

Returns the right-most bin limit

Trait Implementations

impl<'de> Deserialize<'de> for BinLimits

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<BinLimits> for BinLimits

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for BinLimits

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 BinLimits