xref: /freebsd/lib/libc/stdlib/imaxdiv.3 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1.\" Copyright (c) 2001 Mike Barcroft <mike@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd November 14, 2001
28.Dt IMAXDIV 3
29.Os
30.Sh NAME
31.Nm imaxdiv
32.Nd returns quotient and remainder
33.Sh LIBRARY
34.Lb libc
35.Sh SYNOPSIS
36.In inttypes.h
37.Ft imaxdiv_t
38.Fn imaxdiv "intmax_t numer" "intmax_t denom"
39.Sh DESCRIPTION
40The
41.Fn imaxdiv
42function computes the value of
43.Fa numer
44divided by
45.Fa denom
46and returns the stored result in the form of the
47.Vt imaxdiv_t
48type.
49.Pp
50The
51.Vt imaxdiv_t
52type is defined as:
53.Bd -literal -offset indent
54typedef struct {
55	intmax_t quot; /* Quotient. */
56	intmax_t rem;  /* Remainder. */
57} imaxdiv_t;
58.Ed
59.Sh SEE ALSO
60.Xr div 3 ,
61.Xr ldiv 3 ,
62.Xr lldiv 3 ,
63.Xr math 3
64.Sh STANDARDS
65The
66.Fn imaxdiv
67function conforms to
68.St -isoC-99 .
69.Sh HISTORY
70The
71.Fn imaxdiv
72function first appeared in
73.Fx 5.0 .
74