HMath.Error¶
Module index · Numerical conventions
Description
Errors shared by the checked linear algebra APIs. Shapes and indices are
(rows, columns) pairs. Generic matrix/vector arithmetic follows its numeric
type; the LU APIs additionally check finite inputs and arithmetic results.
On this page¶
| API | Purpose |
|---|---|
| MathError | A failed input contract or LU numerical check. |
| NegativeDimensions | A requested shape contains a negative dimension. |
| ElementCountOverflow | A shape's element count exceeds maxBound :: Int. |
| ElementCountMismatch | Expected element count, then actual element count. |
| ShapeMismatch | Left and right shapes differ for an elementwise operation. |
| InnerDimensionMismatch | Left column count and right row count differ for multiplication. |
| IndexOutOfBounds | Matrix shape, then the invalid zero-based index. |
| SliceOutOfBounds | Matrix shape, slice start, and slice extent. |
| VectorLengthMismatch | Left and right finite-list lengths differ. |
| NonSquareMatrix | A factorization requires equal row and column counts. |
| InvalidTolerance | A relative pivot tolerance is negative, NaN, or infinite. |
| SingularMatrix | An exactly zero pivot, at the given zero-based elimination step. |
| NearSingularMatrix | A nonzero pivot is at or below the relative tolerance threshold. |
| NonFiniteMatrixEntry | The first NaN or infinite matrix entry, in row-major order. |
| NonFiniteVectorEntry | The first NaN or infinite vector entry, by zero-based index. |
| NonFiniteResult | LU arithmetic produced a NaN or infinity, including overflow. |
| RightHandSideMismatch | Expected right-hand-side row count, then actual row count. |
| DomainError | An operation's mathematical input domain was violated. |
| InvalidArgument | A configuration, shape, or index argument is invalid. |
| NonConvergence | Algorithm name and exhausted iteration or evaluation budget. |
| RankDeficient | Estimated numerical rank is insufficient for the requested solve. |
| NotPositiveDefinite | A Cholesky pivot is not strictly positive, at a zero-based index. |
Documentation
MathError
A failed input contract or LU numerical check.
Constructors
| NegativeDimensions (Int, Int) | A requested shape contains a negative dimension. |
| ElementCountOverflow (Int, Int) | A shape's element count exceeds |
| ElementCountMismatch Int Int | Expected element count, then actual element count. |
| ShapeMismatch (Int, Int) (Int, Int) | Left and right shapes differ for an elementwise operation. |
| InnerDimensionMismatch Int Int | Left column count and right row count differ for multiplication. |
| IndexOutOfBounds (Int, Int) (Int, Int) | Matrix shape, then the invalid zero-based index. |
| SliceOutOfBounds (Int, Int) (Int, Int) (Int, Int) | Matrix shape, slice start, and slice extent. |
| VectorLengthMismatch Int Int | Left and right finite-list lengths differ. |
| NonSquareMatrix (Int, Int) | A factorization requires equal row and column counts. |
| InvalidTolerance | A relative pivot tolerance is negative, NaN, or infinite. |
| SingularMatrix Int | An exactly zero pivot, at the given zero-based elimination step. |
| NearSingularMatrix Int | A nonzero pivot is at or below the relative tolerance threshold. |
| NonFiniteMatrixEntry (Int, Int) | The first NaN or infinite matrix entry, in row-major order. |
| NonFiniteVectorEntry Int | The first NaN or infinite vector entry, by zero-based index. |
| NonFiniteResult | LU arithmetic produced a NaN or infinity, including overflow. |
| RightHandSideMismatch Int Int | Expected right-hand-side row count, then actual row count. |
| DomainError String | An operation's mathematical input domain was violated. |
| InvalidArgument String | A configuration, shape, or index argument is invalid. |
| NonConvergence String Int | Algorithm name and exhausted iteration or evaluation budget. |
| RankDeficient Int | Estimated numerical rank is insufficient for the requested solve. |
| NotPositiveDefinite Int | A Cholesky pivot is not strictly positive, at a zero-based index. |