burn::tensor

Struct Tolerance

pub struct Tolerance<F> { /* private fields */ }
Expand description

The tolerance used to compare to floating point numbers.

Generally, two numbers x and y are approximately equal if

|x - y| < max(R * (|x + y|), A)

where R is the relative tolerance and A is the absolute tolerance.

The most common way to initialize this struct is to use Tolerance::<F>::default(). In that case, the relative and absolute tolerances are computed using an heuristic based on the EPSILON and MIN_POSITIVE values of the given floating point type F.

Another common initialization is Tolerance::<F>::rel_abs(1e-4, 1e-5).set_half_precision_relative(1e-2). This will use a sane default to manage values too close to 0.0 and use different relative tolerances depending on the floating point precision.

Implementations§

§

impl<F> Tolerance<F>
where F: Float,

pub fn rel_abs<FF>(relative: FF, absolute: FF) -> Tolerance<F>
where FF: ToPrimitive,

When comparing two numbers, this uses both the relative and absolute differences.

That is, x and y are approximately equal if

|x - y| < max(R * (|x + y|), A)

where R is the relative tolerance and A is the absolute tolerance.

pub fn relative<FF>(tolerance: FF) -> Tolerance<F>
where FF: ToPrimitive,

When comparing two numbers, this uses only the relative difference.

That is, x and y are approximately equal if

|x - y| < R * (|x + y|)

where R is the relative tolerance.

pub fn absolute<FF>(tolerance: FF) -> Tolerance<F>
where FF: ToPrimitive,

When comparing two numbers, this uses only the absolute difference.

That is, x and y are approximately equal if

|x - y| < A

where A is the absolute tolerance.

pub fn set_relative<FF>(self, tolerance: FF) -> Tolerance<F>
where FF: ToPrimitive,

Change the relative tolerance to the given one.

pub fn set_half_precision_relative<FF>(self, tolerance: FF) -> Tolerance<F>
where FF: ToPrimitive,

Change the relative tolerance to the given one only if F is half precision.

pub fn set_single_precision_relative<FF>(self, tolerance: FF) -> Tolerance<F>
where FF: ToPrimitive,

Change the relative tolerance to the given one only if F is single precision.

pub fn set_double_precision_relative<FF>(self, tolerance: FF) -> Tolerance<F>
where FF: ToPrimitive,

Change the relative tolerance to the given one only if F is double precision.

pub fn set_absolute<FF>(self, tolerance: FF) -> Tolerance<F>
where FF: ToPrimitive,

Change the absolute tolerance to the given one.

pub fn set_half_precision_absolute<FF>(self, tolerance: FF) -> Tolerance<F>
where FF: ToPrimitive,

Change the absolute tolerance to the given one only if F is half precision.

pub fn set_single_precision_absolute<FF>(self, tolerance: FF) -> Tolerance<F>
where FF: ToPrimitive,

Change the absolute tolerance to the given one only if F is single precision.

pub fn set_double_precision_absolute<FF>(self, tolerance: FF) -> Tolerance<F>
where FF: ToPrimitive,

Change the absolute tolerance to the given one only if F is double precision.

pub fn approx_eq(&self, x: F, y: F) -> bool

Checks if x and y are approximately equal given the tolerance.

Trait Implementations§

§

impl<F> Clone for Tolerance<F>
where F: Clone,

§

fn clone(&self) -> Tolerance<F>

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<F> Debug for Tolerance<F>
where F: Debug,

§

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

Formats the value using the given formatter. Read more
§

impl<F> Default for Tolerance<F>
where F: Float,

§

fn default() -> Tolerance<F>

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

impl<F> Copy for Tolerance<F>
where F: Copy,

Auto Trait Implementations§

§

impl<F> Freeze for Tolerance<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for Tolerance<F>
where F: RefUnwindSafe,

§

impl<F> Send for Tolerance<F>
where F: Send,

§

impl<F> Sync for Tolerance<F>
where F: Sync,

§

impl<F> Unpin for Tolerance<F>
where F: Unpin,

§

impl<F> UnwindSafe for Tolerance<F>
where F: UnwindSafe,

Blanket Implementations§

§

impl<T> Adaptor<()> for T

§

fn adapt(&self)

Adapt the type to be passed to a metric.
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> 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<T> CloneToUninit for T
where T: Clone,

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

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

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

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

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> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T

§

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

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