5#ifndef GKO_PUBLIC_CORE_BASE_EXCEPTION_HPP_
6#define GKO_PUBLIC_CORE_BASE_EXCEPTION_HPP_
13#include <ginkgo/core/base/types.hpp>
58class Error :
public std::exception {
67 Error(
const std::string& file,
int line,
const std::string&
what)
68 : what_(file +
":" + std::to_string(line) +
": " +
what)
75 virtual const char*
what() const noexcept
override {
return what_.c_str(); }
78 const std::string what_;
96 :
Error(file, line, func +
" is not implemented")
115 NotCompiled(
const std::string& file,
int line,
const std::string& func,
116 const std::string& module)
118 "feature " + func +
" is part of the " + module +
119 " module, which is not compiled on this system")
139 NotSupported(
const std::string& file,
int line,
const std::string& func,
140 const std::string& obj_type)
142 "Operation " + func +
" does not support parameters of type " +
160 MpiError(
const std::string& file,
int line,
const std::string& func,
162 :
Error(file, line, func +
": " + get_error(error_code))
166 static std::string get_error(
int64 error_code);
183 CudaError(
const std::string& file,
int line,
const std::string& func,
185 :
Error(file, line, func +
": " + get_error(error_code))
189 static std::string get_error(
int64 error_code);
206 CublasError(
const std::string& file,
int line,
const std::string& func,
208 :
Error(file, line, func +
": " + get_error(error_code))
212 static std::string get_error(
int64 error_code);
229 CurandError(
const std::string& file,
int line,
const std::string& func,
231 :
Error(file, line, func +
": " + get_error(error_code))
235 static std::string get_error(
int64 error_code);
254 :
Error(file, line, func +
": " + get_error(error_code))
258 static std::string get_error(
int64 error_code);
275 CufftError(
const std::string& file,
int line,
const std::string& func,
277 :
Error(file, line, func +
": " + get_error(error_code))
281 static std::string get_error(
int64 error_code);
298 HipError(
const std::string& file,
int line,
const std::string& func,
300 :
Error(file, line, func +
": " + get_error(error_code))
304 static std::string get_error(
int64 error_code);
321 HipblasError(
const std::string& file,
int line,
const std::string& func,
323 :
Error(file, line, func +
": " + get_error(error_code))
327 static std::string get_error(
int64 error_code);
344 HiprandError(
const std::string& file,
int line,
const std::string& func,
346 :
Error(file, line, func +
": " + get_error(error_code))
350 static std::string get_error(
int64 error_code);
370 :
Error(file, line, func +
": " + get_error(error_code))
374 static std::string get_error(
int64 error_code);
391 HipfftError(
const std::string& file,
int line,
const std::string& func,
393 :
Error(file, line, func +
": " + get_error(error_code))
397 static std::string get_error(
int64 error_code);
414 MetisError(
const std::string& file,
int line,
const std::string& func,
415 const std::string& error)
416 :
Error(file, line, func +
": " + error)
442 const std::string& func,
const std::string& first_name,
444 const std::string& second_name,
size_type second_rows,
445 size_type second_cols,
const std::string& clarification)
447 func +
": attempting to combine operators " + first_name +
448 " [" + std::to_string(first_rows) +
" x " +
449 std::to_string(first_cols) +
"] and " + second_name +
" [" +
450 std::to_string(second_rows) +
" x " +
451 std::to_string(second_cols) +
"]: " + clarification)
473 BadDimension(
const std::string& file,
int line,
const std::string& func,
474 const std::string& op_name,
size_type op_num_rows,
475 size_type op_num_cols,
const std::string& clarification)
477 func +
": Object " + op_name +
" has dimensions [" +
478 std::to_string(op_num_rows) +
" x " +
479 std::to_string(op_num_cols) +
"]: " + clarification)
490template <
typename IndexType>
500 const int block_size,
const IndexType size)
502 "block size = " + std::to_string(block_size) +
503 ", size = " + std::to_string(size))
525 const std::string& clarification)
527 func +
": Value mismatch : " + std::to_string(val1) +
" and " +
528 std::to_string(val2) +
" : " + clarification)
547 const std::string& device,
size_type bytes)
549 device +
": failed to allocate memory block of " +
550 std::to_string(bytes) +
"B")
572 "trying to access index " + std::to_string(index) +
573 " in a memory block of " + std::to_string(bound) +
591 const std::string& index_type)
592 :
Error(file, line,
"Overflowing " + index_type)
610 StreamError(
const std::string& file,
int line,
const std::string& func,
611 const std::string& message)
612 :
Error(file, line, func +
": " + message)
631 :
Error(file, line, func +
": unable to find an eligible kernel")
652 const std::string& msg)
653 :
Error(file, line, msg)
670 const std::string& func,
const std::string& clarification)
672 func +
": Invalid state encountered : " + clarification)
AllocationError is thrown if a memory allocation fails.
Definition exception.hpp:536
AllocationError(const std::string &file, int line, const std::string &device, size_type bytes)
Initializes an allocation error.
Definition exception.hpp:546
BadDimension is thrown if an operation is being applied to a LinOp with bad dimensions.
Definition exception.hpp:460
BadDimension(const std::string &file, int line, const std::string &func, const std::string &op_name, size_type op_num_rows, size_type op_num_cols, const std::string &clarification)
Initializes a bad dimension error.
Definition exception.hpp:473
Error that denotes issues between block sizes and matrix dimensions.
Definition exception.hpp:491
BlockSizeError(const std::string &file, const int line, const int block_size, const IndexType size)
Definition exception.hpp:499
CublasError is thrown when a cuBLAS routine throws a non-zero error code.
Definition exception.hpp:196
CublasError(const std::string &file, int line, const std::string &func, int64 error_code)
Initializes a cuBLAS error.
Definition exception.hpp:206
CudaError is thrown when a CUDA routine throws a non-zero error code.
Definition exception.hpp:173
CudaError(const std::string &file, int line, const std::string &func, int64 error_code)
Initializes a CUDA error.
Definition exception.hpp:183
CufftError is thrown when a cuFFT routine throws a non-zero error code.
Definition exception.hpp:265
CufftError(const std::string &file, int line, const std::string &func, int64 error_code)
Initializes a cuFFT error.
Definition exception.hpp:275
CurandError is thrown when a cuRAND routine throws a non-zero error code.
Definition exception.hpp:219
CurandError(const std::string &file, int line, const std::string &func, int64 error_code)
Initializes a cuRAND error.
Definition exception.hpp:229
CusparseError is thrown when a cuSPARSE routine throws a non-zero error code.
Definition exception.hpp:242
CusparseError(const std::string &file, int line, const std::string &func, int64 error_code)
Initializes a cuSPARSE error.
Definition exception.hpp:252
DimensionMismatch is thrown if an operation is being applied to LinOps of incompatible size.
Definition exception.hpp:425
DimensionMismatch(const std::string &file, int line, const std::string &func, const std::string &first_name, size_type first_rows, size_type first_cols, const std::string &second_name, size_type second_rows, size_type second_cols, const std::string &clarification)
Initializes a dimension mismatch error.
Definition exception.hpp:441
The Error class is used to report exceptional behaviour in library functions.
Definition exception.hpp:58
Error(const std::string &file, int line, const std::string &what)
Initializes an error.
Definition exception.hpp:67
virtual const char * what() const noexcept override
Returns a human-readable string with a more detailed description of the error.
Definition exception.hpp:75
HipError is thrown when a HIP routine throws a non-zero error code.
Definition exception.hpp:288
HipError(const std::string &file, int line, const std::string &func, int64 error_code)
Initializes a HIP error.
Definition exception.hpp:298
HipblasError is thrown when a hipBLAS routine throws a non-zero error code.
Definition exception.hpp:311
HipblasError(const std::string &file, int line, const std::string &func, int64 error_code)
Initializes a hipBLAS error.
Definition exception.hpp:321
HipfftError is thrown when a hipFFT routine throws a non-zero error code.
Definition exception.hpp:381
HipfftError(const std::string &file, int line, const std::string &func, int64 error_code)
Initializes a hipFFT error.
Definition exception.hpp:391
HiprandError is thrown when a hipRAND routine throws a non-zero error code.
Definition exception.hpp:334
HiprandError(const std::string &file, int line, const std::string &func, int64 error_code)
Initializes a hipRAND error.
Definition exception.hpp:344
HipsparseError is thrown when a hipSPARSE routine throws a non-zero error code.
Definition exception.hpp:358
HipsparseError(const std::string &file, int line, const std::string &func, int64 error_code)
Initializes a hipSPARSE error.
Definition exception.hpp:368
Exception thrown if an object is in an invalid state.
Definition exception.hpp:659
InvalidStateError(const std::string &file, int line, const std::string &func, const std::string &clarification)
Initializes an invalid state error.
Definition exception.hpp:669
KernelNotFound is thrown if Ginkgo cannot find a kernel which satisfies the criteria imposed by the i...
Definition exception.hpp:621
KernelNotFound(const std::string &file, int line, const std::string &func)
Initializes a KernelNotFound error.
Definition exception.hpp:630
MetisError is thrown when METIS routine throws an error code.
Definition exception.hpp:404
MetisError(const std::string &file, int line, const std::string &func, const std::string &error)
Initializes a METIS error.
Definition exception.hpp:414
MpiError is thrown when a MPI routine throws a non-zero error code.
Definition exception.hpp:151
MpiError(const std::string &file, int line, const std::string &func, int64 error_code)
Initializes a MPI error.
Definition exception.hpp:160
NotCompiled is thrown when attempting to call an operation which is a part of a module that was not c...
Definition exception.hpp:105
NotCompiled(const std::string &file, int line, const std::string &func, const std::string &module)
Initializes a NotCompiled error.
Definition exception.hpp:115
NotImplemented is thrown in case an operation has not yet been implemented (but will be implemented i...
Definition exception.hpp:86
NotImplemented(const std::string &file, int line, const std::string &func)
Initializes a NotImplemented error.
Definition exception.hpp:95
NotSupported is thrown in case it is not possible to perform the requested operation on the given obj...
Definition exception.hpp:128
NotSupported(const std::string &file, int line, const std::string &func, const std::string &obj_type)
Initializes a NotSupported error.
Definition exception.hpp:139
OutOfBoundsError is thrown if a memory access is detected to be out-of-bounds.
Definition exception.hpp:559
OutOfBoundsError(const std::string &file, int line, size_type index, size_type bound)
Initializes an OutOfBoundsError.
Definition exception.hpp:569
OverflowError is thrown when an index calculation for storage requirements overflows.
Definition exception.hpp:583
OverflowError(const std::string &file, const int line, const std::string &index_type)
Definition exception.hpp:590
StreamError is thrown if accessing a stream failed.
Definition exception.hpp:600
StreamError(const std::string &file, int line, const std::string &func, const std::string &message)
Initializes a file access error.
Definition exception.hpp:610
Exception throws if a matrix does not have a property required by a numerical method.
Definition exception.hpp:642
UnsupportedMatrixProperty(const std::string &file, const int line, const std::string &msg)
Initializes the UnsupportedMatrixProperty error.
Definition exception.hpp:651
ValueMismatch is thrown if two values are not equal.
Definition exception.hpp:511
ValueMismatch(const std::string &file, int line, const std::string &func, size_type val1, size_type val2, const std::string &clarification)
Initializes a value mismatch error.
Definition exception.hpp:523
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::int64_t int64
64-bit signed integral type.
Definition types.hpp:109
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:86