Quality

Quality

Information about the quality of the computed ball.

Kind: global class

• Quality
  • new Quality(qrInconsistency, minConvexCoefficient, maxOverlength, maxUnderlength, iterations, supportSize)
  • .getQrInconsistency() ⇒ number
  • .getMinConvexCoefficient() ⇒ number
  • .getMaxOverlength() ⇒ number
  • .getMaxUnderlength() ⇒ number
  • .getIterations() ⇒ number
  • .getSupportSize() ⇒ number
  • .toString() ⇒ string

new Quality(qrInconsistency, minConvexCoefficient, maxOverlength, maxUnderlength, iterations, supportSize)

Param	Type
qrInconsistency	number
minConvexCoefficient	number
maxOverlength	number
maxUnderlength	number
iterations	number
supportSize	number

quality.getQrInconsistency() ⇒ number

A measure for the quality of the internally used support points.

The returned number should in theory be zero (but may be non-zero due to rounding errors).

Kind: instance method of Quality

quality.getMinConvexCoefficient() ⇒ number

A measure for the minimality of the computed ball.

The returned number should in theory be non-zero and positive. Due to rounding errors, it may be negative.

Kind: instance method of Quality

quality.getMaxOverlength() ⇒ number

The maximal over-length of a point from the input set, relative to the computed miniball's radius.

For each point p from the input point set, it is computed how far it is outside the miniball ("over-length"). The returned number is the maximal such over-length, divided by the radius of the computed miniball.

Notice that getMaxOverlength() == 0 if and only if all points are contained in the miniball.

Kind: instance method of Quality
Returns: number - the maximal over-length, a number ≥ 0

quality.getMaxUnderlength() ⇒ number

The maximal under-length of a point from the input set, relative to the computed miniball's radius.

For each point p from the input point set, it is computed how far one has to walk from this point towards the boundary of the miniball ("under-length"). The returned number is the maximal such under-length, divided by the radius of the computed miniball.

Notice that in theory getMaxUnderlength() should be zero, otherwise the computed miniball is enclosing but not minimal.

Kind: instance method of Quality
Returns: number - the maximal under-length, a number ≥ 0

quality.getIterations() ⇒ number

The number of iterations that the algorithm needed to compute the miniball.

Kind: instance method of Quality
Returns: number - number of iterations

quality.getSupportSize() ⇒ number

The size of the support.

Refer to the documentation of Miniball#support() for more information on the

support.

Kind: instance method of Quality
Returns: number - size of the support

quality.toString() ⇒ string

Kind: instance method of Quality