Difference between revisions of "cpp/error/out of range"
m (Updated langlinks) |
([exception]/2) |
||
| Line 1: | Line 1: | ||
{{cpp/title | out_of_range}} | {{cpp/title | out_of_range}} | ||
| − | {{cpp/error | + | {{cpp/error/navbar}} |
{{ddcl | header=stdexcept | | {{ddcl | header=stdexcept | | ||
class out_of_range; | class out_of_range; | ||
| Line 12: | Line 12: | ||
===Member functions=== | ===Member functions=== | ||
| − | {{ | + | {{cpp/error/exception/member of derived with message|out_of_range}} |
| − | + | ||
| − | + | ||
| − | {{ | + | {{inherited | [[cpp/error/logic_error|{{small|std::}}logic_error]] | }} |
{{cpp/error/exception/inherit}} | {{cpp/error/exception/inherit}} | ||
Revision as of 09:05, 22 April 2020
| Defined in header <stdexcept>
|
||
| class out_of_range; |
||
Defines a type of object to be thrown as exception. It reports errors that are consequence of attempt to access elements out of defined range.
It may be thrown by the member functions of std::bitset and std::basic_string, by std::stoi and std::stod families of functions, and by the bounds-checked member access functions (e.g. std::vector::at and std::map::at).
Inheritance diagram
Contents |
Member functions
| (constructor) |
constructs a new out_of_range object with the given message (public member function) |
| operator= |
replaces the out_of_range object (public member function) |
std::out_of_range::out_of_range
| out_of_range( const std::string& what_arg ); |
(1) | |
| out_of_range( const char* what_arg ); |
(2) | |
| out_of_range( const out_of_range& other ); |
(3) | (noexcept since C++11) |
std::out_of_range then std::strcmp(what(), other.what()) == 0. No exception can be thrown from the copy constructor.Parameters
| what_arg | - | explanatory string |
| other | - | another exception object to copy |
Exceptions
Notes
Because copying std::out_of_range is not permitted to throw exceptions, this message is typically stored internally as a separately-allocated reference-counted string. This is also why there is no constructor taking std::string&&: it would have to copy the content anyway.
Before the resolution of LWG issue 254, the non-copy constructor can only accept std::string. It makes dynamic allocation mandatory in order to construct a std::string object.
After the resolution of LWG issue 471, a derived standard exception class must have a publicly accessible copy constructor. It can be implicitly defined as long as the explanatory strings obtained by what() are the same for the original object and the copied object.
std::out_of_range::operator=
| out_of_range& operator=( const out_of_range& other ); |
(noexcept since C++11) | |
Assigns the contents with those of other. If *this and other both have dynamic type std::out_of_range then std::strcmp(what(), other.what()) == 0 after assignment. No exception can be thrown from the copy assignment operator.
Parameters
| other | - | another exception object to assign with |
Return value
*this
Notes
After the resolution of LWG issue 471, a derived standard exception class must have a publicly accessible copy assignment operator. It can be implicitly defined as long as the explanatory strings obtained by what() are the same for the original object and the copied object.
Inherited from std::logic_error
Inherited from std::exception
Member functions
| [virtual] |
destroys the exception object (virtual public member function of std::exception)
|
| [virtual] |
returns an explanatory string (virtual public member function of std::exception)
|
Notes
The standard error condition std::errc::result_out_of_range typically indicates the condition where the result, rather than the input, is out of range, and is more closely related to std::range_error and ERANGE.
See also
| accesses the specified character with bounds checking (public member function of std::basic_string<CharT,Traits,Allocator>)
|
