vctrs (version 0.1.0)

vec_proxy_compare: Comparison proxy

Description

Returns a proxy object (i.e. an atomic vector or data frame of atomic vectors). For vctrs, this determins the behaviour of order() and sort() (via xtfrm()); <, >, >= and <= (via vec_compare()); and min(), max(), median(), and quantile().

Usage

vec_proxy_compare(x)

Arguments

x

A vector x.

Value

A 1d atomic vector or a data frame.

Details

The default method assumes that all classes built on top of atomic vectors or records are orderable. If your class is not, you will need to provide a vec_proxy_compare() method that throws an error. Note that the default vec_proxy_equal() method calls vec_proxy_compare() so if your object is equal-able but not comparable, you'll need to provide methods for both generics.