original/man3/modf.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified 2002-07-27 by Walter Harms
  31 .\"     (walter.harms@informatik.uni-oldenburg.de)
  32 .\"
  33 .TH MODF 3  2013-06-21 ""  "Linux Programmer's Manual"
  34 .SH NAME
  35 modf, modff, modfl \- extract signed integral and fractional values from
  36 floating-point number
  37 .SH SYNOPSIS
  38 .nf
  39 .B #include <math.h>
  40 .sp
  41 .BI "double modf(double " x ", double *" iptr );
  42 .br
  43 .BI "float modff(float " x ", float *" iptr );
  44 .br
  45 .BI "long double modfl(long double " x ", long double *" iptr );
  46 .fi
  47 .sp
  48 Link with \fI\-lm\fP.
  49 .sp
  50 .in -4n
  51 Feature Test Macro Requirements for glibc (see
  52 .BR feature_test_macros (7)):
  53 .in
  54 .sp
  55 .ad l
  56 .BR modf (),
  57 .BR modfl ():
  58 .RS 4
  59 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  60 _POSIX_C_SOURCE\ >=\ 200112L;
  61 .br
  62 or
  63 .I cc\ -std=c99
  64 .RE
  65 .ad
  66 .SH DESCRIPTION
  67 The
  68 .BR modf ()
  69 function breaks the argument
  70 .I x
  71 into an integral
  72 part and a fractional part, each of which has the same sign as
  73 .IR x .
  74 The integral part is stored in the location pointed to by
  75 .IR iptr .
  76 .SH RETURN VALUE
  77 The
  78 .BR modf ()
  79 function returns the fractional part of
  80 .IR x .
  81
  82 If
  83 .I x
  84 is a NaN, a NaN is returned, and
  85 .IR *iptr
  86 is set to a NaN.
  87
  88 If
  89 .I x
  90 is positive infinity (negative infinity), +0 (\-0) is returned, and
  91 .IR *iptr
  92 is set to positive infinity (negative infinity).
  93 .SH ERRORS
  94 No errors occur.
  95 .SH ATTRIBUTES
  96 .SS Multithreading (see pthreads(7))
  97 The
  98 .BR modf (),
  99 .BR modff (),
 100 and
 101 .BR modfl ()
 102 functions are thread-safe.
 103 .SH CONFORMING TO
 104 C99, POSIX.1-2001.
 105 The variant returning
 106 .I double
 107 also conforms to
 108 SVr4, 4.3BSD, C89.
 109 .SH SEE ALSO
 110 .BR frexp (3),
 111 .BR ldexp (3)
 112 .SH COLOPHON
 113 This page is part of release 3.67 of the Linux
 114 .I man-pages
 115 project.
 116 A description of the project,
 117 information about reporting bugs,
 118 and the latest version of this page,
 119 can be found at
 120 \%http://www.kernel.org/doc/man\-pages/.