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