mspass::utility::dmatrix_index_error Class Reference

special convenience class for matrix indexing errors. More...

#include <dmatrix.h>

Inheritance diagram for mspass::utility::dmatrix_index_error:

Public Member Functions
	dmatrix_index_error (const size_t nrmax, const size_t ncmax, const size_t ir, const size_t ic)
Public Member Functions inherited from mspass::utility::MsPASSError
	MsPASSError ()
	MsPASSError (const std::string mess, const char *howbad)
	Construct from a std::string with badness defined by keywords in a string.
	MsPASSError (const std::string mess, const ErrorSeverity s=ErrorSeverity::Invalid)
	MsPASSError (const char *mess, const ErrorSeverity s)
void	log_error ()
void	log_error (std::ostream &ofs)
const char *	what () const noexcept
ErrorSeverity	severity () const

Additional Inherited Members
Protected Attributes inherited from mspass::utility::MsPASSError
std::string	message
ErrorSeverity	badness

Detailed Description

special convenience class for matrix indexing errors.

Thrown by a dmatrix if a requested index is outside the bounds of the matrix dimension.

\author Gary L. Pavlis

Constructor & Destructor Documentation

dmatrix_index_error()

mspass::utility::dmatrix_index_error::dmatrix_index_error ( const size_t  nrmax, const size_t  ncmax, const size_t  ir, const size_t  ic  )

inline

Basic constructor for this error object.

Parameters

nrmax	number of rows in matrix
ncmax	number of columns in matrix
ir	row index requested
ic	column index requested

                                       {
    row = ir;
    column = ic;
    nrr = nrmax;
    ncc = ncmax;
    std::ostringstream oss;
    oss << "dmatrix object:  indexing error" << std::endl
        << "Matrix index (" << row << "," << column
        << ")is outside range = " << nrr << "," << ncc << std::endl;
    message = oss.str();
    badness = ErrorSeverity::Invalid;
  };

References mspass::utility::MsPASSError::badness, and mspass::utility::MsPASSError::message.

~dmatrix_index_error()

mspass::utility::dmatrix_index_error::~dmatrix_index_error ( ) throw ( )

inline

{};

---

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

• /home/runner/work/mspass/mspass/cxx/include/mspass/utility/dmatrix.h