R: Check If A Vector Is Ordered

isOrdered {xts} | R Documentation

## Check If A Vector Is Ordered

### Description

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

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

### Author(s)

Jeffrey A. Ryan

### See Also

`is.unsorted`

### Examples

    # 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)

[Package xts version 0.12.1 Index]