NumericAL
A header-only C++20 lexer built on REAL
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
numerical::not_positive_definite_error Class Reference

Thrown when a Cholesky factorisation finds the matrix not positive-definite. More...

#include <factorizations.hpp>

Inheritance diagram for numerical::not_positive_definite_error:
[legend]
Collaboration diagram for numerical::not_positive_definite_error:
[legend]

Public Member Functions

 not_positive_definite_error (const std::string &message, std::size_t order=0)
 Builds the error.
 
std::size_t order () const noexcept
 The order of the first leading minor found not positive definite (LAPACK's info), 0 where unknown.
 
- Public Member Functions inherited from numerical::detail::tagged< std::runtime_error >
const char * what () const noexcept override
 The message.
 
- Public Member Functions inherited from numerical::error
virtual ~error ()=default
 

Private Attributes

std::size_t order_
 The order of the failing leading minor, or 0.
 

Additional Inherited Members

- Protected Member Functions inherited from numerical::error
 error ()=default
 
 error (const error &)=default
 
 error (error &&)=default
 
error & operator= (const error &)=default
 
error & operator= (error &&)=default
 

Detailed Description

Thrown when a Cholesky factorisation finds the matrix not positive-definite.

Definition at line 2574 of file factorizations.hpp.

Constructor & Destructor Documentation

◆ not_positive_definite_error()

numerical::not_positive_definite_error::not_positive_definite_error ( const std::string &  message,
std::size_t  order = 0 
)
inlineexplicit

Builds the error.

Parameters
[in]messageHuman-readable cause.
[in]orderAs order gives it.

Definition at line 2579 of file factorizations.hpp.

Member Function Documentation

◆ order()

std::size_t numerical::not_positive_definite_error::order ( ) const
inlinenoexcept

The order of the first leading minor found not positive definite (LAPACK's info), 0 where unknown.

Definition at line 2585 of file factorizations.hpp.

Member Data Documentation

◆ order_

std::size_t numerical::not_positive_definite_error::order_
private

The order of the failing leading minor, or 0.

Definition at line 2592 of file factorizations.hpp.


The documentation for this class was generated from the following file: