equivalent: Test two numeric vectors for equivalence

In tractor.base: Read, Manipulate and Visualise Magnetic Resonance Images

Test two numeric vectors for equivalence

Description

This function is a wrapper for isTRUE(all.equal(x,y,...{})), but with the additional capability of doing sign-insensitive comparison.

Usage

equivalent(x, y, signMatters = TRUE, ...)

Arguments

x	The first numeric vector.
y	The second numeric vector.
signMatters	Logical value: if FALSE then equivalence in absolute value is sufficient.
...	Additional arguments to all.equal, notably tolerance.

Value

TRUE if all elements of x match all elements of y to within tolerance, ignoring signs if required. FALSE otherwise.

Author(s)

Jon Clayden

References

Please cite the following reference when using TractoR in your work:

J.D. Clayden, S. Muñoz Maniega, A.J. Storkey, M.D. King, M.E. Bastin & C.A. Clark (2011). TractoR: Magnetic resonance imaging and tractography with R. Journal of Statistical Software 44(8):1-18. https://www.jstatsoft.org/v44/i08/.

See Also

all.equal

Examples

equivalent(c(-1,1), c(1,1))  # FALSE
equivalent(c(-1,1), c(1,1), signMatters=FALSE)  # TRUE
equivalent(1:2, 2:3, tolerance=2)  # TRUE

tractor.base documentation built on Aug. 24, 2022, 5:06 p.m.