usr/src/man/man3m/modf.3m

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
  46 .\"
  47 .TH MODF 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  48 .SH NAME
  49 modf, modff, modfl \- decompose floating-point number
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  54 #include <math.h>
  55
  56 \fBdouble\fR \fBmodf\fR(\fBdouble\fR \fIx\fR, \fBdouble *\fR\fIiptr\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBfloat\fR \fBmodff\fR(\fBfloat\fR \fIx\fR, \fBfloat *\fR\fIiptr\fR);
  62 .fi
  63
  64 .LP
  65 .nf
  66 \fBlong double\fR \fBmodfl\fR(\fBlong double\fR \fIx\fR, \fBlong double *\fR\fIiptr\fR);
  67 .fi
  68
  69 .SH DESCRIPTION
  70 .sp
  71 .LP
  72 These functions break the argument \fIx\fR into integral and fractional parts,
  73 each of which has the same sign as the argument. It stores the integral part as
  74 a \fBdouble\fR for the \fBmodf()\fR function, a float for the \fBmodff()\fR
  75 function, or a long double for the\fBmodfl()\fR function in the object pointed
  76 to by \fIiptr\fR.
  77 .SH RETURN VALUES
  78 .sp
  79 .LP
  80 Upon successful completion, these functions return the signed fractional part
  81 of \fIx\fR.
  82 .sp
  83 .LP
  84 If \fIx\fR is NaN, a NaN is returned and *\fIiptr\fR is set to NaN.
  85 .sp
  86 .LP
  87 If \fIx\fR is \(+-Inf, \(+-0 is returned and *\fIiptr\fR is set to \(+-Inf.
  88 .SH ERRORS
  89 .sp
  90 .LP
  91 No errors are defined.
  92 .SH USAGE
  93 .sp
  94 .LP
  95 These functions compute the function result and *\fIiptr\fR such that:
  96 .sp
  97 .in +2
  98 .nf
  99 a = modf(x, &iptr) ;
 100 x == a+*iptr ;
 101 .fi
 102 .in -2
 103
 104 .SH ATTRIBUTES
 105 .sp
 106 .LP
 107 See \fBattributes\fR(5) for descriptions of the following attributes:
 108 .sp
 109
 110 .sp
 111 .TS
 112 tab(    ) box;
 113 cw(2.75i) |cw(2.75i)
 114 lw(2.75i) |lw(2.75i)
 115 .
 116 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 117 _
 118 Interface Stability     Standard
 119 _
 120 MT-Level        MT-Safe
 121 .TE
 122
 123 .SH SEE ALSO
 124 .sp
 125 .LP
 126 \fBfrexp\fR(3M), \fBisnan\fR(3M), \fBldexp\fR(3M), \fBattributes\fR(5),
 127 \fBstandards\fR(5)