isOrdered

0th

Percentile

Check If A Vector Is Ordered

Performs check to determine if a vector is strictly increasing, strictly decreasing, not decreasing, or not increasing.

Keywords
misc
Usage
isOrdered(x, increasing = TRUE, strictly = TRUE)
Arguments
x

a numeric vector

increasing

test for increasing/decreasing values

strictly

are duplicates OK

Details

Designed for internal use with xts, this provides highly optimized tests for ordering.

Value

Logical

See Also

is.unsorted

Aliases
  • isOrdered
Examples
# NOT RUN {
# strictly increasing
isOrdered(1:10, increasing=TRUE)
isOrdered(1:10, increasing=FALSE)
isOrdered(c(1,1:10), increasing=TRUE)
isOrdered(c(1,1:10), increasing=TRUE, strictly=FALSE)

# decreasing
isOrdered(10:1, increasing=TRUE)
isOrdered(10:1, increasing=FALSE)

# }
Documentation reproduced from package xts, version 0.12-0, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.