Ginkgo  Generated from pipelines/2837190956 branch based on develop. Ginkgo version 2.0.0
A numerical linear algebra library targeting many-core architectures
Public Member Functions | List of all members
gko::InvalidData Class Reference

InvalidData is thrown in case an object in Ginkgo contains invalid data, either because the data was user-provided, or because of a bug. More...

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

Inheritance diagram for gko::InvalidData:
[legend]
Collaboration diagram for gko::InvalidData:
[legend]

Public Member Functions

 InvalidData (const std::string &file, int line, const std::type_info &type, const std::string &invariant)
 Initializes an InvalidData error. More...
 
- Public Member Functions inherited from gko::Error
 Error (const std::string &file, int line, const std::string &what)
 Initializes an error. More...
 

Detailed Description

InvalidData is thrown in case an object in Ginkgo contains invalid data, either because the data was user-provided, or because of a bug.

Invalid data is described by the invariant it violated.

Constructor & Destructor Documentation

◆ InvalidData()

gko::InvalidData::InvalidData ( const std::string &  file,
int  line,
const std::type_info &  type,
const std::string &  invariant 
)
inline

Initializes an InvalidData error.

Parameters
fileThe name of the source file containing the check
lineThe source code line number where the check failed
typeThe object type on which the requested operation failed.
invariantThe invariant that was violated by the invalid data.

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