In the C++ standard library,<cassert>

<cassert>it is a header file in the C++ standard library that provides assertion functionality to check whether a condition is true at runtime. If the condition is false, the program terminates execution and outputs an error message. Assertions are mainly used during the debugging phase to ensure the logical correctness of the program.

An assertion is a debugging tool used to check the running state of a program during development. If an assertion fails, the program terminates immediately, which helps developers quickly locate the problem.

Syntax

cassertinassertThe basic syntax of the macro is as follows:

#include <cassert>

assert(expression);

whereexpressionIt is a Boolean expression; if the result of the expression istrue, then the program continues execution; if the result isfalse, the program will terminate and output an error message.

Example

Below is an example of usingcasserta simple example:

Example

#include <iostream>
#include <cassert>

int main() {
    int a = 5;
    int b = 3;

    // Check whether a is greater than b
    assert(a > b);

    // If a is not greater than b, the program will terminate here and output an error message
    std::cout << "a is greater than b" << std::endl;

    return 0;
}

Output result

When the above program is run, sinceaIndeed greaterb, so the program will execute normally and output:

a is greater than b

If we modifyathe value is 2, making it not greater thanb, the program will output an error message and terminate:

Assertion failed: a > b, file main.cpp, line 8.

Advanced usage of assertions

assertThe macro can also accept an additional expression to output a custom error message:

Example

#include <iostream>
#include <cassert>

int main() {
    int x = 10;
    int y = 0;

    // Use custom error message
    assert(y != 0 && "Division by zero error");

    int result = x / y; // This line of code will not execute because the assertion has failed

    return 0;
}

When the above program is run, sinceyis 0, the assertion will fail and output:

Division by zero error
Assertion failed: y != 0 && "Division by zero error", file main.cpp, line 8.

Notes

  • In release versions of programs, assertions are usually disabled to avoid the program terminating unexpectedly at runtime. This can be done by definingNDEBUGImplemented with a macro:

     
#define NDEBUG
#include <cassert>

  • Assertions should only be used to check logical errors in the program, not to handle runtime errors. Runtime errors should be handled through exception handling or other mechanisms.

  • The assertion expression should be simple, avoiding complex logic or calculations to reduce performance overhead.

by usingcassertinassertmacro, developers can quickly discover and fix logic errors during the development process, improving the stability and reliability of the program.

other extensions