is_JP_ready: Check whether a set of vectors obeys the constraints...

In flatness: Indices and Tests for Assessing the Flatness of (Rank) Histograms

Description

This function checks whether a set of vectors has the following two properties:

• the set is orthonormal

• each vector has components summing to zero (that is, it is a deviation)

Usage

is_JP_ready(x, verbose = TRUE, tol = 1e-04)

Arguments

x	an rkhist or matrix object containing the vectors to check (by row).
verbose	a logical. Should the result of the check be displayed?
tol	a positive numeric. The accepted tolerance for the constraints.

Value

A list with entries

isOK

TRUE if the set obeys the constraints, FALSE otherwise

tol

the tolerance allowed on the constraints

crossprod

the cross product of the vectors

sums

the sum of the components of each vector

x

the checked vectors

flatness documentation built on June 29, 2021, 9:08 a.m.