pub struct BinningWithWidth<T>{ /* private fields */ }
Expand description

Generic binning meant for any integer type

Implementations§

source§

impl BinningWithWidth<u8>

source

pub fn new_inclusive( start: u8, end_inclusive: u8, bin_width: u8 ) -> Result<Self, <u8 as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> u8

Get left border, inclusive

source

pub const fn right(&self) -> u8

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (u8, 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::BinningU8;
let binning = BinningU8::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<u8>>( &self, val: V ) -> Option<<u8 as HasUnsignedVersion>::Unsigned>

source§

impl BinningWithWidth<i8>

source

pub fn new_inclusive( start: i8, end_inclusive: i8, bin_width: i8 ) -> Result<Self, <i8 as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> i8

Get left border, inclusive

source

pub const fn right(&self) -> i8

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (i8, 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::BinningI8;
let binning = BinningI8::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<i8>>( &self, val: V ) -> Option<<i8 as HasUnsignedVersion>::Unsigned>

source§

impl BinningWithWidth<u16>

source

pub fn new_inclusive( start: u16, end_inclusive: u16, bin_width: u16 ) -> Result<Self, <u16 as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> u16

Get left border, inclusive

source

pub const fn right(&self) -> u16

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (u16, 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::BinningU16;
let binning = BinningU16::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<u16>>( &self, val: V ) -> Option<<u16 as HasUnsignedVersion>::Unsigned>

source§

impl BinningWithWidth<i16>

source

pub fn new_inclusive( start: i16, end_inclusive: i16, bin_width: i16 ) -> Result<Self, <i16 as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> i16

Get left border, inclusive

source

pub const fn right(&self) -> i16

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (i16, 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::BinningI16;
let binning = BinningI16::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<i16>>( &self, val: V ) -> Option<<i16 as HasUnsignedVersion>::Unsigned>

source§

impl BinningWithWidth<u32>

source

pub fn new_inclusive( start: u32, end_inclusive: u32, bin_width: u32 ) -> Result<Self, <u32 as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> u32

Get left border, inclusive

source

pub const fn right(&self) -> u32

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (u32, 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::BinningU32;
let binning = BinningU32::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<u32>>( &self, val: V ) -> Option<<u32 as HasUnsignedVersion>::Unsigned>

source§

impl BinningWithWidth<i32>

source

pub fn new_inclusive( start: i32, end_inclusive: i32, bin_width: i32 ) -> Result<Self, <i32 as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> i32

Get left border, inclusive

source

pub const fn right(&self) -> i32

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (i32, 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::BinningI32;
let binning = BinningI32::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<i32>>( &self, val: V ) -> Option<<i32 as HasUnsignedVersion>::Unsigned>

source§

impl BinningWithWidth<u64>

source

pub fn new_inclusive( start: u64, end_inclusive: u64, bin_width: u64 ) -> Result<Self, <u64 as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> u64

Get left border, inclusive

source

pub const fn right(&self) -> u64

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (u64, 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::BinningU64;
let binning = BinningU64::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<u64>>( &self, val: V ) -> Option<<u64 as HasUnsignedVersion>::Unsigned>

source§

impl BinningWithWidth<i64>

source

pub fn new_inclusive( start: i64, end_inclusive: i64, bin_width: i64 ) -> Result<Self, <i64 as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> i64

Get left border, inclusive

source

pub const fn right(&self) -> i64

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (i64, 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::BinningI64;
let binning = BinningI64::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<i64>>( &self, val: V ) -> Option<<i64 as HasUnsignedVersion>::Unsigned>

source§

impl BinningWithWidth<u128>

source

pub fn new_inclusive( start: u128, end_inclusive: u128, bin_width: u128 ) -> Result<Self, <u128 as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> u128

Get left border, inclusive

source

pub const fn right(&self) -> u128

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (u128, 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::BinningU128;
let binning = BinningU128::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<u128>>( &self, val: V ) -> Option<<u128 as HasUnsignedVersion>::Unsigned>

source§

impl BinningWithWidth<i128>

source

pub fn new_inclusive( start: i128, end_inclusive: i128, bin_width: i128 ) -> Result<Self, <i128 as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> i128

Get left border, inclusive

source

pub const fn right(&self) -> i128

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (i128, 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::BinningI128;
let binning = BinningI128::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<i128>>( &self, val: V ) -> Option<<i128 as HasUnsignedVersion>::Unsigned>

source§

impl BinningWithWidth<usize>

source

pub fn new_inclusive( start: usize, end_inclusive: usize, bin_width: usize ) -> Result<Self, <usize as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> usize

Get left border, inclusive

source

pub const fn right(&self) -> usize

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (usize, 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::BinningUSIZE;
let binning = BinningUSIZE::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<usize>>( &self, val: V ) -> Option<<usize as HasUnsignedVersion>::Unsigned>

source§

impl BinningWithWidth<isize>

source

pub fn new_inclusive( start: isize, end_inclusive: isize, bin_width: isize ) -> Result<Self, <isize as HasUnsignedVersion>::Unsigned>

Create a new Binning
  • both borders are inclusive
  • each bin has width 1
Panics
  • if start is smaller than end_inclusive
  • if bin_width <= 0
source

pub const fn left(&self) -> isize

Get left border, inclusive

source

pub const fn right(&self) -> isize

Get right border, inclusive

source

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

source

pub fn multi_valued_bin_iter(&self) -> impl Iterator<Item = (isize, 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::BinningISIZE;
let binning = BinningISIZE::new_inclusive(2,7,2).unwrap();
let vec: Vec<_> = binning.multi_valued_bin_iter().collect();
assert_eq!(&vec, &[(2, 3), (4, 5), (6, 7)]);
source

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

source

pub fn get_bin_index_native<V: Borrow<isize>>( &self, val: V ) -> Option<<isize as HasUnsignedVersion>::Unsigned>

Trait Implementations§

source§

impl<T> Clone for BinningWithWidth<T>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T> Debug for BinningWithWidth<T>

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl<T> PartialEq for BinningWithWidth<T>

source§

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

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

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.
source§

impl<T> Serialize for BinningWithWidth<T>

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl<T> Eq for BinningWithWidth<T>

source§

impl<T> StructuralEq for BinningWithWidth<T>

source§

impl<T> StructuralPartialEq for BinningWithWidth<T>

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for BinningWithWidth<T>
where T: RefUnwindSafe,

§

impl<T> Send for BinningWithWidth<T>
where T: Send,

§

impl<T> Sync for BinningWithWidth<T>
where T: Sync,

§

impl<T> Unpin for BinningWithWidth<T>
where T: Unpin,

§

impl<T> UnwindSafe for BinningWithWidth<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<S, T> Cast<T> for S
where T: Conv<S>,

§

fn cast(self) -> T

Cast from Self to T Read more
§

fn try_cast(self) -> Result<T, Error>

Try converting from Self to T Read more
§

impl<S, T> CastApprox<T> for S
where T: ConvApprox<S>,

§

fn try_cast_approx(self) -> Result<T, Error>

Try approximate conversion from Self to T Read more
§

fn cast_approx(self) -> T

Cast approximately from Self to T Read more
§

impl<S, T> CastFloat<T> for S
where T: ConvFloat<S>,

§

fn cast_trunc(self) -> T

Cast to integer, truncating Read more
§

fn cast_nearest(self) -> T

Cast to the nearest integer Read more
§

fn cast_floor(self) -> T

Cast the floor to an integer Read more
§

fn cast_ceil(self) -> T

Cast the ceiling to an integer Read more
§

fn try_cast_trunc(self) -> Result<T, Error>

Try converting to integer with truncation Read more
§

fn try_cast_nearest(self) -> Result<T, Error>

Try converting to the nearest integer Read more
§

fn try_cast_floor(self) -> Result<T, Error>

Try converting the floor to an integer Read more
§

fn try_cast_ceil(self) -> Result<T, Error>

Try convert the ceiling to an integer Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,