Struct nblast::BinLookup

pub struct BinLookup<T: PartialOrd + Clone + Debug> {
    pub bin_boundaries: Vec<T>,
    pub snap: (bool, bool),
    pub n_bins: usize,
}

Fields§

§bin_boundaries: Vec<T>§snap: (bool, bool)§n_bins: usize

Implementations§

impl<T: PartialOrd + Copy + Debug> BinLookup<T>

pub fn new( bin_boundaries: Vec<T>, snap: (bool, bool) ) -> Result<Self, BinLookupBuildError>

bin_boundaries must be sorted ascending and have length > 2. snap is a tuple of whether to clamp values beyond the left and the right bin boundary respectively.

pub fn to_idx(&self, val: &T) -> Result<usize, OutOfBin>

If snap = (true, true), result will always be Ok

impl BinLookup<Precision>

pub fn new_linear( min: Precision, max: Precision, n_bins: usize, snap: (bool, bool) ) -> Result<Self, BinLookupBuildError>

Create a BinLookup whose boundaries are linearly spaced between min and max. snap is as used in BinLookup::new.

pub fn new_exp( base: Precision, min_exp: Precision, max_exp: Precision, n_bins: usize, snap: (bool, bool) ) -> Result<Self, BinLookupBuildError>

Create a BinLookup whose boundaries are logarithmically spaced between base^min_exp (which should be small) and base^max_exp. snap is as in BinLookup::new.

pub fn new_quantiles( sorted_data: &[Precision], quantiles: &[Precision], snap: (bool, bool) ) -> Result<BinLookup<Precision>, BinLookupBuildError>

Create a BinLookup whose boundaries are the quantiles of some data, which must be sorted in ascending order (this is checked). quantiles must be within [0, 1] and sorted ascending (also checked). snap is as in BinLookup::new.

pub fn new_n_quantiles( data: &[Precision], n_bins: usize, snap: (bool, bool) ) -> Result<BinLookup<Precision>, BinLookupBuildError>

Create a BinLookup whose boundaries are the quantiles of some (sorted ascending) data, evenly spaced within [0, 1]. snap is as in BinLookup::new.

Trait Implementations§

impl<T: Clone + PartialOrd + Clone + Debug> Clone for BinLookup<T>

fn clone(&self) -> BinLookup<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

impl<T: Debug + PartialOrd + Clone + Debug> Debug for BinLookup<T>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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

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

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

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

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

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

fn lossy_into(self) -> Dst

Performs the conversion.

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.

impl<T> UnwrappedAs for T

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> WrappingAs for T

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.