InvalidDistanceMatrixException
extends InvalidArgumentException
in package
Class InvalidDistanceMatrixException
Tags
Table of Contents
Methods
- asymmetricEntry() : InvalidDistanceMatrixException
- Builds the exception raised when D[i][j] and D[j][i] disagree, which breaks the symmetry a distance matrix requires.
- duplicateLabel() : InvalidDistanceMatrixException
- Builds the exception raised when the same label is given twice, which would make it impossible to tell the corresponding taxa apart in the resulting tree.
- emptyLabel() : InvalidDistanceMatrixException
- Builds the exception raised when a label is empty or not a string.
- mismatchedDimensions() : InvalidDistanceMatrixException
- Builds the exception raised when the distance matrix is not exactly N x N for N labels.
- negativeDistance() : InvalidDistanceMatrixException
- Builds the exception raised when an off-diagonal distance is negative, which is not a valid input measurement regardless of the tree it might imply.
- nonFiniteDistance() : InvalidDistanceMatrixException
- Builds the exception raised when a distance is infinite or not a number : the tree built from it would carry branch lengths no Newick string can hold.
- nonNumericDistance() : InvalidDistanceMatrixException
- Builds the exception raised when a distance is not a number at all (a null, an empty string, "n/a") : cast to a float it would read as 0, and two distinct taxa would be taken for identical.
- nonZeroDiagonal() : InvalidDistanceMatrixException
- Builds the exception raised when a taxon's distance to itself is not exactly zero.
- noTaxa() : InvalidDistanceMatrixException
- Builds the exception raised when no taxon at all is given.
Methods
asymmetricEntry()
Builds the exception raised when D[i][j] and D[j][i] disagree, which breaks the symmetry a distance matrix requires.
public
static asymmetricEntry(int $iRow, int $iColumn, float $fForward, float $fBackward) : InvalidDistanceMatrixException
Parameters
- $iRow : int
- $iColumn : int
- $fForward : float
- $fBackward : float
Return values
InvalidDistanceMatrixExceptionduplicateLabel()
Builds the exception raised when the same label is given twice, which would make it impossible to tell the corresponding taxa apart in the resulting tree.
public
static duplicateLabel(string $sLabel) : InvalidDistanceMatrixException
Parameters
- $sLabel : string
Return values
InvalidDistanceMatrixExceptionemptyLabel()
Builds the exception raised when a label is empty or not a string.
public
static emptyLabel(int $iPosition) : InvalidDistanceMatrixException
Parameters
- $iPosition : int
Return values
InvalidDistanceMatrixExceptionmismatchedDimensions()
Builds the exception raised when the distance matrix is not exactly N x N for N labels.
public
static mismatchedDimensions(int $iExpected, int $iActual) : InvalidDistanceMatrixException
Parameters
- $iExpected : int
- $iActual : int
Return values
InvalidDistanceMatrixExceptionnegativeDistance()
Builds the exception raised when an off-diagonal distance is negative, which is not a valid input measurement regardless of the tree it might imply.
public
static negativeDistance(int $iRow, int $iColumn, float $fValue) : InvalidDistanceMatrixException
Parameters
- $iRow : int
- $iColumn : int
- $fValue : float
Return values
InvalidDistanceMatrixExceptionnonFiniteDistance()
Builds the exception raised when a distance is infinite or not a number : the tree built from it would carry branch lengths no Newick string can hold.
public
static nonFiniteDistance(int $iRow, int $iColumn, float $fValue) : InvalidDistanceMatrixException
Parameters
- $iRow : int
- $iColumn : int
- $fValue : float
Return values
InvalidDistanceMatrixExceptionnonNumericDistance()
Builds the exception raised when a distance is not a number at all (a null, an empty string, "n/a") : cast to a float it would read as 0, and two distinct taxa would be taken for identical.
public
static nonNumericDistance(int $iRow, int $iColumn, mixed $mValue) : InvalidDistanceMatrixException
Parameters
- $iRow : int
- $iColumn : int
- $mValue : mixed
Return values
InvalidDistanceMatrixExceptionnonZeroDiagonal()
Builds the exception raised when a taxon's distance to itself is not exactly zero.
public
static nonZeroDiagonal(int $iIndex, float $fValue) : InvalidDistanceMatrixException
Parameters
- $iIndex : int
- $fValue : float
Return values
InvalidDistanceMatrixExceptionnoTaxa()
Builds the exception raised when no taxon at all is given.
public
static noTaxa() : InvalidDistanceMatrixException