share/man/man3m/fex_merge_flags.3m

   1 '\" te
   2 .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH FEX_MERGE_FLAGS 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
   7 .SH NAME
   8 fex_merge_flags \- manage the floating point environment
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 c99 [ \fIflag\fR... ] \fIfile\fR... -lm [ \fIlibrary\fR... ]
  13 #include <fenv.h>
  14
  15 \fBvoid\fR \fBfex_merge_flags\fR(\fBconst fenv_t *\fR\fIenvp\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBfex_merge_flags()\fR function copies into the current environment those
  22 exception flags that are set in the environment represented by the object
  23 pointed to by \fIenvp\fR.  The argument \fIenvp\fR must point to an object set
  24 by a call to \fBfeholdexcept\fR(3M) or \fBfegetenv\fR(3M) or equal to the macro
  25 \fBFE_DFL_ENV\fR.  The \fBfex_merge_flags()\fR function does not raise any
  26 exceptions, but only sets its flags.
  27 .SH RETURN VALUES
  28 .sp
  29 .LP
  30 The \fBfex_merge_flags\fR function does not return a value.
  31 .SH ATTRIBUTES
  32 .sp
  33 .LP
  34 See \fBattributes\fR(5) for descriptions of the following attributes:
  35 .sp
  36
  37 .sp
  38 .TS
  39 tab(    ) box;
  40 lw(2.75i) lw(2.75i)
  41 lw(2.75i) lw(2.75i)
  42 .
  43 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  44 Availability    SUNWlibms, SUNWlmsx
  45 Interface Stability     Stable
  46 MT-Level        MT-Safe
  47 .TE
  48
  49 .SH SEE ALSO
  50 .sp
  51 .LP
  52 \fBfeclearexcept\fR(3M), \fBfegetenv\fR(3M), \fBfesetround\fR(3M),
  53 \fBfesetprec\fR(3M), \fBfex_set_handling\fR(3M), \fBfex_set_log\fR(3M),
  54 \fBattributes\fR(5)
  55 .sp
  56 .LP
  57 \fINumerical Computation Guide\fR
  58 .SH NOTES
  59 .sp
  60 .LP
  61 In a multithreaded program, the \fBfex_merge_flags()\fR function affects the
  62 floating point environment only for the calling thread.
  63 .sp
  64 .LP
  65 The \fBfex_merge_flags()\fR function automatically installs and deinstalls
  66 \fBSIGFPE\fR handlers and sets and clears the trap enable mode bits in the
  67 floating point status register as needed.  If a program uses these functions
  68 and attempts to install a \fBSIGFPE\fR handler or control the trap enable mode
  69 bits independently, the resulting behavior is not defined.