Skip to main content

Tol

Struct Tol 

Source
pub struct Tol {
    pub ct: f64,
    pub by_smaller: bool,
}
Expand description

How close two floats have to be to count as equal.

Both languages compare reals with a relative tolerance: J’s 9!:18 comparison tolerance, APL’s ⎕CT. Two values are equal when they differ by less than the tolerance scaled by one of their magnitudes — the smaller one in J, the larger one in APL. Both references answer strictly: a difference exactly at the threshold is not equal. Integers, characters and boxes are unaffected, and an exact bit-for-bit equality (the infinities included) is equality whatever the tolerance is.

Fields§

§ct: f64

Relative tolerance; zero compares exactly.

§by_smaller: bool

Scale by the smaller magnitude (J) rather than the larger (APL).

Implementations§

Source§

impl Tol

Source

pub const EXACT: Tol

No tolerance at all — J’s u!.0.

Source

pub const J: Tol

J’s default comparison tolerance, 2^-44.

Source

pub const APL: Tol

GNU APL’s default ⎕CT.

Source

pub fn eq(self, a: f64, b: f64) -> bool

Tolerant equality.

Source

pub fn is_j(self) -> bool

Whose rule this is. A scalar verb is handed the tolerance and nothing else about the dialect, and two rules below need to know which one they are under: J reads a magnitude below the tolerance as zero, and J’s equality is total across the box boundary where APL’s reaches inside the box instead.

Source

pub fn is_zero(self, y: f64) -> bool

Whether the tolerance reads this magnitude as zero.

J’s signum does: * 1e_15 is 0 and * 6e_14 is 1, the threshold being the tolerance itself. APL’s × is exact there. With !.0 the tolerance is zero, so the rule falls away with it.

Source

pub fn lt(self, a: f64, b: f64) -> bool

Tolerant <: less, and not tolerantly equal.

Source

pub fn le(self, a: f64, b: f64) -> bool

Tolerant <=: less, or tolerantly equal.

Source

pub fn eq_cx(self, a: Cx, b: Cx) -> bool

Tolerant equality on complex values: the magnitude of the difference against the same scale the real comparison uses. J answers 3j4 = 3.0000000000001j4 with 1, which is this rule on magnitudes.

Source

pub fn floor(self, y: f64) -> f64

<. y: the largest integer not above y, with a value just under an integer counting as that integer.

Source

pub fn ceil(self, y: f64) -> f64

>. y: the ceiling, with a value just over an integer counting as that integer.

Trait Implementations§

Source§

impl Clone for Tol

Source§

fn clone(&self) -> Tol

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Tol

Source§

impl Debug for Tol

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Tol

Source§

fn eq(&self, other: &Tol) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Tol

Auto Trait Implementations§

§

impl Freeze for Tol

§

impl RefUnwindSafe for Tol

§

impl Send for Tol

§

impl Sync for Tol

§

impl Unpin for Tol

§

impl UnsafeUnpin for Tol

§

impl UnwindSafe for Tol

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> 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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
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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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

Source§

impl<T> WasmNotSendSync for T

Source§

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