Ecfun (version 0.3-2)

sign: Sign function with zero option

Description

sign returns a vector with the signs of the corresponding elements of x, being 1, zero, or -1 if the number is positive, zero or negative, respectively.

This generalizes the sign function in the base package to allow something other than 0 as the the "sign" of 0.

Usage

sign(x, zero=0L)

Value

an integer vector of the same length as x assuming values 1, zero and -1, as discussed above.

Arguments

x

a numeric vector for which signs are desired

zero

an integer value to be assigned for x==0.

See Also

sign

Examples

##
## 1.  default
##
sx <- sign((-2):2)

# check 
stopifnot(
all.equal(sx, base::sign((-2):2))
)

##
## 2.  with zero = 1
##
s1 <- sign((-2):2, 1)

# check 
stopifnot(
all.equal(s1, rep(c(-1, 1), c(2,3)))
)