lib/libc/stdlib/imaxdiv.3

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