std::out_of_range - cppreference.com (original) (raw)

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

• 1 Member functions
• 2 std::out_of_range::out_of_range
  • 2.1 Parameters
  • 2.2 Exceptions
  • 2.3 Notes
• 3 std::out_of_range::operator=
  • 3.1 Parameters
  • 3.2 Return value
  • 3.3 Notes
• 4 Inherited from std::logic_error
• 5 Inherited from std::exception
  • 5.1 Member functions
  • 5.2 Notes
  • 5.3 Defect reports
  • 5.4 See also

[edit] Member functions

| | constructs a new out_of_range object with the given message (public member function) | | ----------------------------------------------------------------------------------------- | | | replaces the out_of_range object (public member function) |

std::out_of_range::out_of_range

1. Constructs the exception object with what_arg as explanatory string. After construction, std::strcmp(what(), what_arg.c_str()) == 0.

2. Constructs the exception object with what_arg as explanatory string. After construction, std::strcmp(what(), what_arg) == 0.

3. Copy constructor. If *this and other both have dynamic type std::out_of_range then std::strcmp(what(), other.what()) == 0. No exception can be thrown from the copy constructor.

Parameters

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) (constexpr since C++26) | | ---------------------------------------------------------- | | ---------------------------------------------- |

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

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

| | destroys the exception object (virtual public member function of std::exception) [edit] | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | returns an explanatory string (virtual public member function of std::exception) [edit] |

[edit] 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.

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

[edit] See also