IsCloseArgs

rstsr_core::prelude_dev

Struct IsCloseArgs

pub struct IsCloseArgs<TE>where
    TE: 'static,{
    pub rtol: TE,
    pub atol: TE,
    pub equal_nan: bool,
}

Expand description

Arguments for isclose function.

For type f64, you can also use the From trait implementations to create IsCloseArgs<f64> from simpler types:

f64: specifies rtol;
(f64, f64): specifies rtol and atol;
(f64, f64, bool): specifies rtol, atol, and equal_nan;
None: uses default values.

§See also

[isclose]

Fields§

§rtol: TE

Relative tolerance. For type f64, the default is 1.0e-5.

§atol: TE

Absolute tolerance. For type f64, the default is 1.0e-8.

§equal_nan: bool

Whether to consider NaNs as equal. For type f64, the default is false.

Trait Implementations§

impl<TE> Clone for IsCloseArgs<TE>
where TE: Clone + 'static,

fn clone(&self) -> IsCloseArgs<TE>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<TE> Debug for IsCloseArgs<TE>
where TE: Debug + 'static,

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

Formats the value using the given formatter. Read more

impl Default for IsCloseArgs<f64>

fn default() -> IsCloseArgs<f64>

Returns the “default value” for a type. Read more

impl From<(f64,)> for IsCloseArgs<f64>

fn from(v: (f64,)) -> IsCloseArgs<f64>

Converts to this type from the input type.

impl From<(f64, f64)> for IsCloseArgs<f64>

fn from(v: (f64, f64)) -> IsCloseArgs<f64>

Converts to this type from the input type.

impl From<(f64, f64, bool)> for IsCloseArgs<f64>

fn from(v: (f64, f64, bool)) -> IsCloseArgs<f64>

Converts to this type from the input type.

impl From<Option<f64>> for IsCloseArgs<f64>

fn from(rtol: Option<f64>) -> IsCloseArgs<f64>

Converts to this type from the input type.

impl From<f64> for IsCloseArgs<f64>

fn from(rtol: f64) -> IsCloseArgs<f64>

Converts to this type from the input type.

impl<TE> PartialEq for IsCloseArgs<TE>
where TE: PartialEq + 'static,

fn eq(&self, other: &IsCloseArgs<TE>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<TE> Eq for IsCloseArgs<TE>
where TE: Eq + 'static,

impl<TE> StructuralPartialEq for IsCloseArgs<TE>
where TE: 'static,

Auto Trait Implementations§

impl<TE> Freeze for IsCloseArgs<TE>
where TE: Freeze,

impl<TE> RefUnwindSafe for IsCloseArgs<TE>
where TE: RefUnwindSafe,

impl<TE> Send for IsCloseArgs<TE>
where TE: Send,

impl<TE> Sync for IsCloseArgs<TE>
where TE: Sync,

impl<TE> Unpin for IsCloseArgs<TE>
where TE: Unpin,

impl<TE> UnwindSafe for IsCloseArgs<TE>
where TE: 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> 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<T> ByRef<T> for T

fn by_ref(&self) -> &T

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DTypeCastAPI<T> for T

fn into_cast(self) -> T

impl<T> DTypePromoteAPI<T> for T

const SAME_TYPE: bool = true

const CAN_CAST_SELF: bool = true

const CAN_CAST_OTHER: bool = true

type Res = T

fn promote_self(self) -> <T as DTypePromoteAPI<T>>::Res

fn promote_other(val: T) -> <T as DTypePromoteAPI<T>>::Res

fn promote_pair(self, val: T) -> (Self::Res, Self::Res)
where Self: Sized,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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<T> IntoEither for T

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

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

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> 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> ValWriteAPI<T> for T

fn write(&mut self, val: T) -> &mut T