xref: /freebsd/lib/libc/gen/modf.3 (revision fb3ef04d2028110f06d68b09009f1f2ca0f4128e)
1.\" Copyright (c) 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)modf.3	8.1 (Berkeley) 6/4/93
33.\"
34.Dd March 29, 2008
35.Dt MODF 3
36.Os
37.Sh NAME
38.Nm modf ,
39.Nm modff ,
40.Nm modfl
41.Nd extract signed integral and fractional values from floating-point number
42.Sh LIBRARY
43.Lb libm
44.Sh SYNOPSIS
45.In math.h
46.Ft double
47.Fn modf "double value" "double *iptr"
48.Ft float
49.Fn modff "float value" "float *iptr"
50.Ft long double
51.Fn modfl "long double value" "long double *iptr"
52.Sh DESCRIPTION
53The
54.Fn modf ,
55.Fn modff ,
56and
57.Fn modfl
58functions break the argument
59.Fa value
60into integral and fractional parts, each of which has the
61same sign as the argument.
62It stores the integral part as a
63floating point number
64in the object pointed to by
65.Fa iptr .
66.Sh RETURN VALUES
67These functions return the signed fractional part of
68.Fa value .
69.Sh SEE ALSO
70.Xr frexp 3 ,
71.Xr ldexp 3 ,
72.Xr math 3
73.Sh STANDARDS
74The
75.Fn modf ,
76.Fn modff ,
77and
78.Fn modfl
79functions conform to
80.St -isoC-99 .
81