Struct uncertain::ConvergenceError [−][src]
Information about a failed call to expect.
This struct allows introspection of a failed attempt to calculate
the expected value of an Uncertain.
Implementations
impl<F: Float> ConvergenceError<F>[src]
pub fn non_converged_value(&self) -> F[src]
The expected value estimate obtained.
This value is less precise than desired and should be used with caution.
pub fn two_sigma_error(&self) -> F[src]
The two sigma confidence interval around the computed value.
Details
Mathematically, this is an estimate for the
standard deviation of the expected value, i.e.
2 * sqrt(var(E(x))).
This value is calculated under the assumption
that samples from the original Uncertain
are identically and independently distributed.
pub fn desired_precision(&self) -> F[src]
The precision which was originally mandated by the
call to Uncertain::expect.
Trait Implementations
impl<F: Clone> Clone for ConvergenceError<F> where
F: Float, [src]
F: Float,
fn clone(&self) -> ConvergenceError<F>[src]
pub fn clone_from(&mut self, source: &Self)1.0.0[src]
impl<F: Debug> Debug for ConvergenceError<F> where
F: Float, [src]
F: Float,
impl<F: Float + Display> Display for ConvergenceError<F>[src]
impl<F: Float + Debug + Display> Error for ConvergenceError<F>[src]
Auto Trait Implementations
impl<F> RefUnwindSafe for ConvergenceError<F> where
F: RefUnwindSafe,
F: RefUnwindSafe,
impl<F> Send for ConvergenceError<F> where
F: Send,
F: Send,
impl<F> Sync for ConvergenceError<F> where
F: Sync,
F: Sync,
impl<F> Unpin for ConvergenceError<F> where
F: Unpin,
F: Unpin,
impl<F> UnwindSafe for ConvergenceError<F> where
F: UnwindSafe,
F: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T[src]
pub fn clone_into(&self, target: &mut T)[src]
impl<T> ToString for T where
T: Display + ?Sized, [src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,