logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

feraiseexcept.3p (3415B)

    

  1. '\" et
  2. .TH FERAISEEXCEPT "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. feraiseexcept
  12. \(em raise floating-point exception
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <fenv.h>
  17. .P
  18. int feraiseexcept(int \fIexcepts\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The functionality described on this reference page is aligned with the
  22. ISO\ C standard. Any conflict between the requirements described here and the
  23. ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
  24. .P
  25. The
  26. \fIferaiseexcept\fR()
  27. function shall attempt to raise the supported floating-point exceptions
  28. represented by the
  29. .IR excepts
  30. argument. The order in which these floating-point exceptions are raised is
  31. unspecified,
  32. except that if the
  33. .IR excepts
  34. argument represents IEC 60559 valid coincident floating-point
  35. exceptions for atomic operations (namely overflow and inexact,
  36. or underflow and inexact), then overflow or underflow shall be
  37. raised before inexact.
  38. Whether the
  39. \fIferaiseexcept\fR()
  40. function additionally raises the inexact floating-point exception
  41. whenever it raises the overflow or underflow floating-point exception
  42. is implementation-defined.
  43. .SH "RETURN VALUE"
  44. If the argument is zero or if all the specified exceptions were
  45. successfully raised,
  46. \fIferaiseexcept\fR()
  47. shall return zero. Otherwise, it shall return a non-zero value.
  48. .SH ERRORS
  49. No errors are defined.
  50. .LP
  51. .IR "The following sections are informative."
  52. .SH EXAMPLES
  53. None.
  54. .SH "APPLICATION USAGE"
  55. The effect is intended to be similar to that of floating-point
  56. exceptions raised by arithmetic operations. Hence, enabled traps for
  57. floating-point exceptions raised by this function are taken.
  58. .SH RATIONALE
  59. Raising overflow or underflow is allowed to also raise inexact because
  60. on some architectures the only practical way to raise an exception is
  61. to execute an instruction that has the exception as a side-effect. The
  62. function is not restricted to accept only valid coincident expressions
  63. for atomic operations, so the function can be used to raise exceptions
  64. accrued over several operations.
  65. .SH "FUTURE DIRECTIONS"
  66. None.
  67. .SH "SEE ALSO"
  68. .IR "\fIfeclearexcept\fR\^(\|)",
  69. .IR "\fIfegetexceptflag\fR\^(\|)",
  70. .IR "\fIfetestexcept\fR\^(\|)"
  71. .P
  72. The Base Definitions volume of POSIX.1\(hy2017,
  73. .IR "\fB<fenv.h>\fP"
  74. .\"
  75. .SH COPYRIGHT
  76. Portions of this text are reprinted and reproduced in electronic form
  77. from IEEE Std 1003.1-2017, Standard for Information Technology
  78. -- Portable Operating System Interface (POSIX), The Open Group Base
  79. Specifications Issue 7, 2018 Edition,
  80. Copyright (C) 2018 by the Institute of
  81. Electrical and Electronics Engineers, Inc and The Open Group.
  82. In the event of any discrepancy between this version and the original IEEE and
  83. The Open Group Standard, the original IEEE and The Open Group Standard
  84. is the referee document. The original Standard can be obtained online at
  85. http://www.opengroup.org/unix/online.html .
  86. .PP
  87. Any typographical or formatting errors that appear
  88. in this page are most likely
  89. to have been introduced during the conversion of the source files to
  90. man page format. To report such errors, see
  91. https://www.kernel.org/doc/man-pages/reporting_bugs.html .