feraiseexcept man page

Prolog

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

feraiseexcept — raise floating-point exception

Synopsis

#include <fenv.h>

int feraiseexcept(int excepts);

Description

The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of POSIX.1‐2008 defers to the ISO C standard.

The feraiseexcept() function shall attempt to raise the supported floating-point exceptions represented by the argument excepts. The order in which these floating-point exceptions are raised is unspecified. Whether the feraiseexcept() function additionally raises the inexact floating-point exception whenever it raises the overflow or underflow floating-point exception is implementation-defined.

Return Value

If the argument is zero or if all the specified exceptions were successfully raised, feraiseexcept() shall return zero. Otherwise, it shall return a non-zero value.

Errors

No errors are defined.

The following sections are informative.

Application Usage

The effect is intended to be similar to that of floating-point exceptions raised by arithmetic operations. Hence, enabled traps for floating-point exceptions raised by this function are taken.

Rationale

Raising overflow or underflow is allowed to also raise inexact because on some architectures the only practical way to raise an exception is to execute an instruction that has the exception as a side-effect. The function is not restricted to accept only valid coincident expressions for atomic operations, so the function can be used to raise exceptions accrued over several operations.

See Also

feclearexcept(), fegetexceptflag(), fetestexcept()

The Base Definitions volume of POSIX.1‐2008, <fenv.h>

Info

2013 IEEE/The Open Group POSIX Programmer's Manual