MyNixOS website logo
Description

Test, Check, Verify, Investigate the Monotonic Properties of Vectors.

Functions to test/check/verify/investigate the ordering of vectors. The 'is_[strictly_]*' family of functions test vectors for 'sorted', 'monotonic', 'increasing', 'decreasing' order; 'is_constant' and 'is_incremental' test for the degree of ordering. `ordering` provides a numeric indication of ordering -2 (strictly decreasing) to 2 (strictly increasing).

ordering

Test/Check/Verify/Investigate the Ordering of Vectors

ordering provides several functions for testing/checking/verify/investigating the ordering of vectors (numeric or otherwise).

The packages has the following tests:

is_[strictly_]*

Where * can be one of:

  • monotonic -or- sorted whether the values are (strictly) ordered
  • increasing whether the values are in (strictly) increasing ordered
  • decreasing whehter the values are in (strictly) decreasing ordered

In addition:

  • is_constant whether all values are equal
  • is_incremental whether x is incremental, ordered and equally spaced
  • monotoniciy reports the degree of monotonicty.

install

Install using the standard methods

install.packages('ordering')
 
# -OR-
 
devtools::install_github( "decisionpatterns/ordering")

Usage

The usage of the packages is probably best demonstrated by a few examples:

x <- 1:5

is_sorted(x)              # TRUE
is_strictly_sorted(x)     # TRUE

is_increasing(x)          # TRUE    
is_strictly_increasing(x) # TRUE

is_decreasing(x)          # FALSE
is_strictly_decreasing(x) # FALSE

is_sorted(x)              # TRUE
is_strictly_sorted(x)     # TRUE 

is_constant(x)            # FALSE
is_incremental()          # TRUE

monotonicity(x)           # 2 - strictly increasing
Metadata

Version

0.7.0

License

Unknown

Platforms (75)

    Darwin
    FreeBSD
    Genode
    GHCJS
    Linux
    MMIXware
    NetBSD
    none
    OpenBSD
    Redox
    Solaris
    WASI
    Windows
Show all
  • aarch64-darwin
  • aarch64-genode
  • aarch64-linux
  • aarch64-netbsd
  • aarch64-none
  • aarch64_be-none
  • arm-none
  • armv5tel-linux
  • armv6l-linux
  • armv6l-netbsd
  • armv6l-none
  • armv7a-darwin
  • armv7a-linux
  • armv7a-netbsd
  • armv7l-linux
  • armv7l-netbsd
  • avr-none
  • i686-cygwin
  • i686-darwin
  • i686-freebsd
  • i686-genode
  • i686-linux
  • i686-netbsd
  • i686-none
  • i686-openbsd
  • i686-windows
  • javascript-ghcjs
  • loongarch64-linux
  • m68k-linux
  • m68k-netbsd
  • m68k-none
  • microblaze-linux
  • microblaze-none
  • microblazeel-linux
  • microblazeel-none
  • mips-linux
  • mips-none
  • mips64-linux
  • mips64-none
  • mips64el-linux
  • mipsel-linux
  • mipsel-netbsd
  • mmix-mmixware
  • msp430-none
  • or1k-none
  • powerpc-netbsd
  • powerpc-none
  • powerpc64-linux
  • powerpc64le-linux
  • powerpcle-none
  • riscv32-linux
  • riscv32-netbsd
  • riscv32-none
  • riscv64-linux
  • riscv64-netbsd
  • riscv64-none
  • rx-none
  • s390-linux
  • s390-none
  • s390x-linux
  • s390x-none
  • vc4-none
  • wasm32-wasi
  • wasm64-wasi
  • x86_64-cygwin
  • x86_64-darwin
  • x86_64-freebsd
  • x86_64-genode
  • x86_64-linux
  • x86_64-netbsd
  • x86_64-none
  • x86_64-openbsd
  • x86_64-redox
  • x86_64-solaris
  • x86_64-windows