Struct kahan::KahanSum

pub struct KahanSum<T: Float> { /* fields omitted */ }

Methods

impl<T: Float> KahanSum<T>

Represents an ongoing Kahan summation. New terms can be added to the sum by simple addition.

Examples

let mut kahan_sum = KahanSum::new();
kahan_sum += 10000.0f32;
kahan_sum += 3.14159f32;
assert_eq!(10003.142f32, kahan_sum.sum());
assert_eq!(0.000011444092f32, kahan_sum.err());

pub fn new() -> Self

Creates a new KahanSum with sum and err initialized to 0

pub fn new_with_value(initial: T) -> Self

Creates a new KahanSum with starting sum set to initial, but err initalized to 0

pub fn sum(&self) -> T

Returns the current running sum

pub fn err(&self) -> T

Returns the current error value

Trait Implementations

impl<T: Float> Default for KahanSum<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Clone + Float> Clone for KahanSum<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Float> Debug for KahanSum<T>

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

Formats the value using the given formatter.

impl<T: Float> Add<T> for KahanSum<T>

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<'_, T: Float> Add<&'_ KahanSum<T>> for KahanSum<T>

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: &KahanSum<T>) -> Self::Output

Performs the + operation.

impl<T: Float> Add<KahanSum<T>> for KahanSum<T>

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: KahanSum<T>) -> Self::Output

Performs the + operation.

impl<T: Float> AddAssign<T> for KahanSum<T>

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<'_, T: Float> AddAssign<&'_ KahanSum<T>> for KahanSum<T>

fn add_assign(&mut self, rhs: &KahanSum<T>)

Performs the += operation.

impl<T: Float> AddAssign<KahanSum<T>> for KahanSum<T>

fn add_assign(&mut self, rhs: KahanSum<T>)

Performs the += operation.