calculateDistance

0th

Percentile

Internal: Matrix difference

Calculates the average of the differences between all possible pairs of (symmetric) matrices in a list using a given distance measure.

Keywords
internal
Usage
calculateDistance(
  .matrices = NULL, 
  .distance = args_default()$.distance
  )
Arguments
.matrices

A list of at least two matrices.

.distance

Character string. A distance measure. One of: "geodesic" or "squared_euclidian". Defaults to "geodesic".

Details

.matrices must be a list of at least two matrices. If more than two matrices are supplied the arithmetic mean of the differences between all possible pairs of (symmetric) matrices in a list is computed. Mathematically this is n chose 2. Hence, supplying a large number of matrices will become computationally challenging.

Currently two distance measures are supported:

geodesic

(Default) The geodesic distance.

squared_euclidian

The squared Euclidian distance

Value

A numeric vector of length one containing the (arithmetic) mean of the differences between all possible pairs of matrices supplied via .matrices.

Aliases
  • calculateDistance
Documentation reproduced from package cSEM, version 0.1.0, License: GPL-3

Community examples

Looks like there are no examples yet.