xref: /netbsd-src/lib/libm/man/modf.3 (revision d2174aa7ea58a63db7dcee0f51375f5a52c3d507)
1.\"	$NetBSD: modf.3,v 1.3 2017/02/01 15:57:47 abhinav 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.\"     @(#)modf.3	8.1 (Berkeley) 6/4/93
35.\"
36.Dd March 7, 2016
37.Dt MODF 3
38.Os
39.Sh NAME
40.Nm modf ,
41.Nm modff ,
42.Nm modfl
43.Nd extract signed integral and fractional values from floating-point number
44.Sh LIBRARY
45.Lb libm
46.Sh SYNOPSIS
47.In math.h
48.Ft double
49.Fn modf "double value" "double *iptr"
50.Ft float
51.Fn modff "float value" "float *iptr"
52.Ft long double
53.Fn modfl "long double value" "long double *iptr"
54.Sh DESCRIPTION
55The
56.Fn modf
57function breaks the argument
58.Fa value
59into integral and fractional parts, each of which has the
60same sign as the argument.
61It stores the integral part as a
62.Em double
63in the object pointed to by
64.Fa iptr .
65.Sh RETURN VALUES
66The
67.Fn modf
68function returns 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
77function conforms to
78.St -ansiC .
79