seriation (version 1.1-1)

get_order: Extracting Order Information from a Permutation Object

Description

Method to get the order information from an object of class ser_permutation or ser_permutation_vector. Order information can be extracted as an integer permutation vector, a vector containing the object ranks or a permutation matrix.

Usage

get_order(x, ...)
## S3 method for class 'ser_permutation_vector':
get_order(x, \ldots)
## S3 method for class 'ser_permutation':
get_order(x, dim = 1, \ldots)
get_permutation_matrix(x, ...)

Arguments

x

an object of class ser_permutation or ser_permutation_vector.

dim

order information for which dimension should be returned?

...

further arguments are ignorred for get_order. For get_permutation_matrix the additional arguments are passed on to get_order (e.g., as dim).

Value

• Returns an integer vector.

Details

get_order returns the seriation as an integer vector containing the rank/position of each object of the $n$ objects in the permuted order (i.e., position of 1st object, 2nd object, ... $n$th object). get_permutation_matrix returns a $n \times n$ permutation matrix.

See Also

ser_permutation_vector, ser_permutation

Examples

## permutation_vector
o <- ser_permutation_vector(sample(10))
o

get_order(o)
get_permutation_matrix(o)

## permutation
o2 <- ser_permutation(o, sample(5))
o2

get_order(o2, dim = 2)
get_permutation_matrix(o2, dim = 2)