xref: /freebsd/lib/libc/gen/modf.3 (revision dc36d6f9bb1753f3808552f3afd30eda9a7b206a)
158f0484fSRodney W. Grimes.\" Copyright (c) 1991, 1993
258f0484fSRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
358f0484fSRodney W. Grimes.\"
458f0484fSRodney W. Grimes.\" This code is derived from software contributed to Berkeley by
558f0484fSRodney W. Grimes.\" the American National Standards Committee X3, on Information
658f0484fSRodney W. Grimes.\" Processing Systems.
758f0484fSRodney W. Grimes.\"
858f0484fSRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
958f0484fSRodney W. Grimes.\" modification, are permitted provided that the following conditions
1058f0484fSRodney W. Grimes.\" are met:
1158f0484fSRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
1258f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
1358f0484fSRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
1458f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
1558f0484fSRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
16*fbbd9655SWarner Losh.\" 3. Neither the name of the University nor the names of its contributors
1758f0484fSRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
1858f0484fSRodney W. Grimes.\"    without specific prior written permission.
1958f0484fSRodney W. Grimes.\"
2058f0484fSRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2158f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2258f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2358f0484fSRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2458f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2558f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2658f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2758f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2858f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2958f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3058f0484fSRodney W. Grimes.\" SUCH DAMAGE.
3158f0484fSRodney W. Grimes.\"
32838200ffSDavid Schultz.Dd March 29, 2008
3358f0484fSRodney W. Grimes.Dt MODF 3
3458f0484fSRodney W. Grimes.Os
3558f0484fSRodney W. Grimes.Sh NAME
36838200ffSDavid Schultz.Nm modf ,
37838200ffSDavid Schultz.Nm modff ,
38838200ffSDavid Schultz.Nm modfl
3958f0484fSRodney W. Grimes.Nd extract signed integral and fractional values from floating-point number
4025bb73e0SAlexey Zelkin.Sh LIBRARY
41838200ffSDavid Schultz.Lb libm
4258f0484fSRodney W. Grimes.Sh SYNOPSIS
4332eef9aeSRuslan Ermilov.In math.h
4458f0484fSRodney W. Grimes.Ft double
4558f0484fSRodney W. Grimes.Fn modf "double value" "double *iptr"
46838200ffSDavid Schultz.Ft float
47838200ffSDavid Schultz.Fn modff "float value" "float *iptr"
48838200ffSDavid Schultz.Ft long double
49838200ffSDavid Schultz.Fn modfl "long double value" "long double *iptr"
5058f0484fSRodney W. Grimes.Sh DESCRIPTION
5158f0484fSRodney W. GrimesThe
52838200ffSDavid Schultz.Fn modf ,
53838200ffSDavid Schultz.Fn modff ,
54838200ffSDavid Schultzand
55838200ffSDavid Schultz.Fn modfl
56838200ffSDavid Schultzfunctions break the argument
5758f0484fSRodney W. Grimes.Fa value
5858f0484fSRodney W. Grimesinto integral and fractional parts, each of which has the
5958f0484fSRodney W. Grimessame sign as the argument.
6058f0484fSRodney W. GrimesIt stores the integral part as a
61838200ffSDavid Schultzfloating point number
6258f0484fSRodney W. Grimesin the object pointed to by
6358f0484fSRodney W. Grimes.Fa iptr .
6458f0484fSRodney W. Grimes.Sh RETURN VALUES
65838200ffSDavid SchultzThese functions return the signed fractional part of
6658f0484fSRodney W. Grimes.Fa value .
6758f0484fSRodney W. Grimes.Sh SEE ALSO
6858f0484fSRodney W. Grimes.Xr frexp 3 ,
6958f0484fSRodney W. Grimes.Xr ldexp 3 ,
7058f0484fSRodney W. Grimes.Xr math 3
7158f0484fSRodney W. Grimes.Sh STANDARDS
7258f0484fSRodney W. GrimesThe
73838200ffSDavid Schultz.Fn modf ,
74838200ffSDavid Schultz.Fn modff ,
75838200ffSDavid Schultzand
76838200ffSDavid Schultz.Fn modfl
77838200ffSDavid Schultzfunctions conform to
78838200ffSDavid Schultz.St -isoC-99 .
79