Struct sampling::histogram::FastSingleIntBinning

pub struct FastSingleIntBinning<T> { /* private fields */ }

Generic binning meant for any integer type

Implementations

impl FastSingleIntBinning<u8>

pub const fn new_inclusive(start: u8, end_inclusive: u8) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> u8

Get left border, inclusive

pub const fn right(&self) -> u8

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<u8>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = u8>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningU8;
let binning = FastBinningU8::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <u8 as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

impl FastSingleIntBinning<i8>

pub const fn new_inclusive(start: i8, end_inclusive: i8) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> i8

Get left border, inclusive

pub const fn right(&self) -> i8

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<i8>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = i8>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningI8;
let binning = FastBinningI8::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <i8 as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

impl FastSingleIntBinning<u16>

pub const fn new_inclusive(start: u16, end_inclusive: u16) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> u16

Get left border, inclusive

pub const fn right(&self) -> u16

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<u16>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = u16>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningU16;
let binning = FastBinningU16::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <u16 as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

impl FastSingleIntBinning<i16>

pub const fn new_inclusive(start: i16, end_inclusive: i16) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> i16

Get left border, inclusive

pub const fn right(&self) -> i16

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<i16>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = i16>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningI16;
let binning = FastBinningI16::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <i16 as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

impl FastSingleIntBinning<u32>

pub const fn new_inclusive(start: u32, end_inclusive: u32) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> u32

Get left border, inclusive

pub const fn right(&self) -> u32

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<u32>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = u32>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningU32;
let binning = FastBinningU32::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <u32 as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

impl FastSingleIntBinning<i32>

pub const fn new_inclusive(start: i32, end_inclusive: i32) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> i32

Get left border, inclusive

pub const fn right(&self) -> i32

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<i32>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = i32>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningI32;
let binning = FastBinningI32::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <i32 as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

impl FastSingleIntBinning<u64>

pub const fn new_inclusive(start: u64, end_inclusive: u64) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> u64

Get left border, inclusive

pub const fn right(&self) -> u64

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<u64>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = u64>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningU64;
let binning = FastBinningU64::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <u64 as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

impl FastSingleIntBinning<i64>

pub const fn new_inclusive(start: i64, end_inclusive: i64) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> i64

Get left border, inclusive

pub const fn right(&self) -> i64

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<i64>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = i64>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningI64;
let binning = FastBinningI64::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <i64 as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

impl FastSingleIntBinning<u128>

pub const fn new_inclusive(start: u128, end_inclusive: u128) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> u128

Get left border, inclusive

pub const fn right(&self) -> u128

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<u128>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = u128>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningU128;
let binning = FastBinningU128::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <u128 as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

impl FastSingleIntBinning<i128>

pub const fn new_inclusive(start: i128, end_inclusive: i128) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> i128

Get left border, inclusive

pub const fn right(&self) -> i128

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<i128>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = i128>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningI128;
let binning = FastBinningI128::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <i128 as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

impl FastSingleIntBinning<usize>

pub const fn new_inclusive(start: usize, end_inclusive: usize) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> usize

Get left border, inclusive

pub const fn right(&self) -> usize

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<usize>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = usize>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningUSIZE;
let binning = FastBinningUSIZE::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <usize as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

impl FastSingleIntBinning<isize>

pub const fn new_inclusive(start: isize, end_inclusive: isize) -> Self

Create a new Binning

• both borders are inclusive
• each bin has width 1

Panics

• if start is smaller than end_inclusive TODO Think about if this should actually panic or return None

pub const fn left(&self) -> isize

Get left border, inclusive

pub const fn right(&self) -> isize

Get right border, inclusive

pub const fn range_inclusive(&self) -> RangeInclusive<isize>

Returns the range covered by the bins as a RangeInclusive<T>

pub fn single_valued_bin_iter(&self) -> impl Iterator<Item = isize>

Iterator over all the bins

Since the bins have width 1, a bin can be defined by its corresponding value which we can iterate over.

Example

use sampling::histogram::FastBinningISIZE;
let binning = FastBinningISIZE::new_inclusive(2,5);
let vec: Vec<_> = binning.single_valued_bin_iter().collect();
assert_eq!(&vec, &[2, 3, 4, 5]);

pub fn bins_m1(&self) -> <isize as HasUnsignedVersion>::Unsigned

The amount of bins -1

• minus 1 because if the bins are going over the entire range of the type, then I cannot represent the number of bins as this type

Example

If we look at an u8 and the range from 0 to 255, then this is 256 bins, which cannot be represented as u8. To combat this, I return bins - 1. This works, because we always have at least 1 bin

Trait Implementations

impl<T: Clone> Clone for FastSingleIntBinning<T>

fn clone(&self) -> FastSingleIntBinning<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for FastSingleIntBinning<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for FastSingleIntBinning<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Ord> Ord for FastSingleIntBinning<T>

fn cmp(&self, other: &FastSingleIntBinning<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for FastSingleIntBinning<T>

fn eq(&self, other: &FastSingleIntBinning<T>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for FastSingleIntBinning<T>

fn partial_cmp(&self, other: &FastSingleIntBinning<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for FastSingleIntBinning<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy> Copy for FastSingleIntBinning<T>

impl<T: Eq> Eq for FastSingleIntBinning<T>

impl<T> StructuralEq for FastSingleIntBinning<T>

impl<T> StructuralPartialEq for FastSingleIntBinning<T>