Skip to main content

NaiveSum

Struct NaiveSum 

Source
pub struct NaiveSum<T>(/* private fields */);
Expand description

Naive (plain +=) accumulator.

This strategy keeps a single running sum and updates it with standard floating-point addition. It has minimal overhead and is usually the fastest option, but it may lose small addends when values have very different magnitudes.

In norm routines this is used by the default APIs such as crate::algorithms::vector_norms::vector_norm_l1, crate::algorithms::vector_norms::vector_norm_l2, and crate::algorithms::vector_norms::vector_norm_l2_sq.

§Example

use num_valid::algorithms::accumulators::*;

let mut naive = NaiveSum::<f64>::new();
naive.push(1.0);
naive.push(2.0);
naive.push(3.0);
assert_eq!(naive.result(), 6.0);

Trait Implementations§

Source§

impl<T: FpScalar> Accumulator for NaiveSum<T>

Source§

type Input = T

The type of values pushed into the accumulator.
Source§

type Output = T

The type of the final result produced by result.
Source§

fn new() -> Self

Creates a new, empty accumulator (the identity for combine).
Source§

fn push(&mut self, r: T)

Adds a single value to the accumulator.
Source§

fn result(self) -> T

Consumes the accumulator and returns the final result.
Source§

fn combine(&mut self, other: Self)

Merges other into self. Read more
Source§

fn new_sequential<I>(values: I) -> Self
where I: IntoIterator<Item = Self::Input>,

Creates a new accumulator by sequentially adding all values from values. Read more
Source§

fn new_parallel<I>(values: I) -> Self
where Self: Send, I: IntoParallelIterator<Item = Self::Input>,

Builds an accumulator by processing a parallel iterator. Read more
Source§

impl<T: FpScalar> SumAccumulator for NaiveSum<T>

Source§

fn rescale_by(&mut self, r: &T)

Multiply the entire accumulated sum by r.

Auto Trait Implementations§

§

impl<T> Freeze for NaiveSum<T>
where T: Freeze,

§

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

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for NaiveSum<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for NaiveSum<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> Az for T

Source§

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

Casts the value.
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
Source§

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

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

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

Casts the value.
Source§

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

Source§

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

Casts the value.
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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> OverflowingAs for T

Source§

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

Casts the value.
Source§

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

Source§

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

Casts the value.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> SaturatingAs for T

Source§

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

Casts the value.
Source§

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

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
Source§

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

Source§

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>,

Source§

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

impl<T> UnwrappedAs for T

Source§

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

Casts the value.
Source§

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

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

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

Casts the value.
Source§

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

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.