xref: /freebsd/lib/libc/gen/modf.3 (revision ef36b3f75658d201edb495068db5e1be49593de5)
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.\" $FreeBSD$
34.\"
35.Dd March 29, 2008
36.Dt MODF 3
37.Os
38.Sh NAME
39.Nm modf ,
40.Nm modff ,
41.Nm modfl
42.Nd extract signed integral and fractional values from floating-point number
43.Sh LIBRARY
44.Lb libm
45.Sh SYNOPSIS
46.In math.h
47.Ft double
48.Fn modf "double value" "double *iptr"
49.Ft float
50.Fn modff "float value" "float *iptr"
51.Ft long double
52.Fn modfl "long double value" "long double *iptr"
53.Sh DESCRIPTION
54The
55.Fn modf ,
56.Fn modff ,
57and
58.Fn modfl
59functions break the argument
60.Fa value
61into integral and fractional parts, each of which has the
62same sign as the argument.
63It stores the integral part as a
64floating point number
65in the object pointed to by
66.Fa iptr .
67.Sh RETURN VALUES
68These functions return the signed fractional part of
69.Fa value .
70.Sh SEE ALSO
71.Xr frexp 3 ,
72.Xr ldexp 3 ,
73.Xr math 3
74.Sh STANDARDS
75The
76.Fn modf ,
77.Fn modff ,
78and
79.Fn modfl
80functions conform to
81.St -isoC-99 .
82