man3/remquo.3

   1 '\" t
   2 .\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
   3 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   4 .\"     <mtk.manpages@gmail.com>
   5 .\"
   6 .\" SPDX-License-Identifier: GPL-1.0-or-later
   7 .\"
   8 .\" based on glibc infopages
   9 .\" polished, aeb
  10 .\"
  11 .TH remquo 3 (date) "Linux man-pages (unreleased)"
  12 .SH NAME
  13 remquo, remquof, remquol \- remainder and part of quotient
  14 .SH LIBRARY
  15 Math library
  16 .RI ( libm ", " \-lm )
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <math.h>
  20 .P
  21 .BI "double remquo(double " x ", double " y ", int *" quo );
  22 .BI "float remquof(float " x ", float " y ", int *" quo );
  23 .BI "long double remquol(long double " x ", long double " y ", int *" quo );
  24 .fi
  25 .P
  26 .RS -4
  27 Feature Test Macro Requirements for glibc (see
  28 .BR feature_test_macros (7)):
  29 .RE
  30 .P
  31 .BR remquo (),
  32 .BR remquof (),
  33 .BR remquol ():
  34 .nf
  35     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  36 .fi
  37 .SH DESCRIPTION
  38 These functions compute the remainder and part of the quotient
  39 upon division of
  40 .I x
  41 by
  42 .IR y .
  43 A few bits of the quotient are stored via the
  44 .I quo
  45 pointer.
  46 The remainder is returned as the function result.
  47 .P
  48 The value of the remainder is the same as that computed by the
  49 .BR remainder (3)
  50 function.
  51 .P
  52 The value stored via the
  53 .I quo
  54 pointer has the sign of
  55 .I x\~/\~y
  56 and agrees with the quotient in at least the low order 3 bits.
  57 .P
  58 For example, \fIremquo(29.0,\ 3.0)\fP returns \-1.0 and might store 2.
  59 Note that the actual quotient might not fit in an integer.
  60 .\" A possible application of this function might be the computation
  61 .\" of sin(x). Compute remquo(x, pi/2, &quo) or so.
  62 .\"
  63 .\" glibc, UnixWare: return 3 bits
  64 .\" MacOS 10: return 7 bits
  65 .SH RETURN VALUE
  66 On success, these functions return the same value as
  67 the analogous functions described in
  68 .BR remainder (3).
  69 .P
  70 If
  71 .I x
  72 or
  73 .I y
  74 is a NaN, a NaN is returned.
  75 .P
  76 If
  77 .I x
  78 is an infinity,
  79 and
  80 .I y
  81 is not a NaN,
  82 a domain error occurs, and
  83 a NaN is returned.
  84 .P
  85 If
  86 .I y
  87 is zero,
  88 and
  89 .I x
  90 is not a NaN,
  91 a domain error occurs, and
  92 a NaN is returned.
  93 .SH ERRORS
  94 See
  95 .BR math_error (7)
  96 for information on how to determine whether an error has occurred
  97 when calling these functions.
  98 .P
  99 The following errors can occur:
 100 .TP
 101 Domain error: \fIx\fP is an infinity or \fIy\fP is 0, \
 102 and the other argument is not a NaN
 103 .\" .I errno
 104 .\" is set to
 105 .\" .BR EDOM .
 106 An invalid floating-point exception
 107 .RB ( FE_INVALID )
 108 is raised.
 109 .P
 110 These functions do not set
 111 .IR errno .
 112 .\" FIXME . Is it intentional that these functions do not set errno?
 113 .\" Bug raised: https://www.sourceware.org/bugzilla/show_bug.cgi?id=6802
 114 .SH ATTRIBUTES
 115 For an explanation of the terms used in this section, see
 116 .BR attributes (7).
 117 .TS
 118 allbox;
 119 lbx lb lb
 120 l l l.
 121 Interface       Attribute       Value
 122 T{
 123 .na
 124 .nh
 125 .BR remquo (),
 126 .BR remquof (),
 127 .BR remquol ()
 128 T}      Thread safety   MT-Safe
 129 .TE
 130 .SH STANDARDS
 131 C11, POSIX.1-2008.
 132 .SH HISTORY
 133 glibc 2.1.
 134 C99, POSIX.1-2001.
 135 .SH SEE ALSO
 136 .BR fmod (3),
 137 .BR logb (3),
 138 .BR remainder (3)