xref: /freebsd/lib/libc/stdlib/imaxdiv.3 (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
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.Dd November 14, 2001
26.Dt IMAXDIV 3
27.Os
28.Sh NAME
29.Nm imaxdiv
30.Nd returns quotient and remainder
31.Sh LIBRARY
32.Lb libc
33.Sh SYNOPSIS
34.In inttypes.h
35.Ft imaxdiv_t
36.Fn imaxdiv "intmax_t numer" "intmax_t denom"
37.Sh DESCRIPTION
38The
39.Fn imaxdiv
40function computes the value of
41.Fa numer
42divided by
43.Fa denom
44and returns the stored result in the form of the
45.Vt imaxdiv_t
46type.
47.Pp
48The
49.Vt imaxdiv_t
50type is defined as:
51.Bd -literal -offset indent
52typedef struct {
53	intmax_t quot; /* Quotient. */
54	intmax_t rem;  /* Remainder. */
55} imaxdiv_t;
56.Ed
57.Sh SEE ALSO
58.Xr div 3 ,
59.Xr ldiv 3 ,
60.Xr lldiv 3 ,
61.Xr math 3
62.Sh STANDARDS
63The
64.Fn imaxdiv
65function conforms to
66.St -isoC-99 .
67.Sh HISTORY
68The
69.Fn imaxdiv
70function first appeared in
71.Fx 5.0 .
72