gko::Error Class Reference

#include <ginkgo/core/base/exception.hpp>

Inheritance diagram for gko::Error:

Public Member Functions
	Error (const std::string &file, int line, const std::string &what)
virtual const char *	what () const noexcept override

Detailed Description

The Error class is used to report exceptional behaviour in library functions. Ginkgo uses C++ exception mechanism to this end, and the Error class represents a base class for all types of errors. The exact list of errors which could occur during the execution of a certain library routine is provided in the documentation of that routine, along with a short description of the situation when that error can occur. During runtime, these errors can be detected by using standard C++ try-catch blocks, and a human-readable error description can be obtained by calling the Error::what() method.

As an example, trying to compute a matrix-vector product with arguments of incompatible size will result in a DimensionMismatch error, which is demonstrated in the following program.

#include <ginkgo.h>
#include <iostream>
 
using namespace gko;
 
int main()
{
    auto omp = create<OmpExecutor>();
    auto A = randn_fill<matrix::Csr<float>>(5, 5, 0f, 1f, omp);
    auto x = fill<matrix::Dense<float>>(6, 1, 1f, omp);
    try {
        auto y = apply(A, x);
    } catch(Error e) {
        // an error occurred, write the message to screen and exit
        std::cout << e.what() << std::endl;
        return -1;
    }
    return 0;
}

Constructor & Destructor Documentation

Error()

gko::Error::Error ( const std::string &  file, int  line, const std::string &  what  )

inline

Initializes an error.

Parameters

file	The name of the offending source file
line	The source code line number where the error occurred
what	The error message

Member Function Documentation

what()

virtual const char * gko::Error::what ( ) const

inlineoverridevirtualnoexcept

Returns a human-readable string with a more detailed description of the error.

---

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

• ginkgo/core/base/exception.hpp