Regina 7.3 Calculation Engine
Public Member Functions | List of all members
regina::SnapPeaMemoryFull Class Reference

An exception that is thrown when the SnapPea kernel finds that all available memory has been exhausted. More...

#include <snappea/snappeatriangulation.h>

Inheritance diagram for regina::SnapPeaMemoryFull:

Public Member Functions

 SnapPeaMemoryFull () noexcept=default
 Creates a new exception. More...
 
 SnapPeaMemoryFull (const SnapPeaMemoryFull &) noexcept=default
 Creates a new copy of the given exception. More...
 
SnapPeaMemoryFulloperator= (const SnapPeaMemoryFull &) noexcept=default
 Sets this to be a copy of the given exception. More...
 
const char * what () const noexcept override
 Returns a human-readable description of the error that occurred. More...
 

Detailed Description

An exception that is thrown when the SnapPea kernel finds that all available memory has been exhausted.

This is one of two types of exception that can be thrown from deep within the SnapPea kernel. SnapPeaFatalError is used for informative messages (the description includes a function and filename), whereas SnapPeaMemoryFull is used for out-of-memory errors (which use a stock description so they can be created without allocating further resources).

Details of the error can be accessed through the member function what().

Constructor & Destructor Documentation

◆ SnapPeaMemoryFull() [1/2]

regina::SnapPeaMemoryFull::SnapPeaMemoryFull ( )
defaultnoexcept

Creates a new exception.

◆ SnapPeaMemoryFull() [2/2]

regina::SnapPeaMemoryFull::SnapPeaMemoryFull ( const SnapPeaMemoryFull )
defaultnoexcept

Creates a new copy of the given exception.

Member Function Documentation

◆ operator=()

SnapPeaMemoryFull & regina::SnapPeaMemoryFull::operator= ( const SnapPeaMemoryFull )
defaultnoexcept

Sets this to be a copy of the given exception.

Returns
a reference to this exception.

◆ what()

const char * regina::SnapPeaMemoryFull::what ( ) const
inlineoverridenoexcept

Returns a human-readable description of the error that occurred.

Returns
a description of the error.

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

Copyright © 1999-2023, The Regina development team
This software is released under the GNU General Public License, with some additional permissions; see the source code for details.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@maths.uq.edu.au).