blob: 332be0b24fba916673420dd25a1bc15a27a39776 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
<holder>The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.</holder>
<!-- ================================ SYNOPSIS -->
<refnamediv id="remquo">
Floating point remainder and quotient function.
<refsynopsisdiv xmlns:xlink=""><title></title>
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
The <function>remquo</function> function computes the value <varname>r</varname> such
that <varname>r</varname> = <varname>x</varname> - <varname>n</varname>*<varname>y</varname>, where <varname>n</varname> is the integer nearest the
exact value of <varname>x</varname>/<varname>y</varname>. If there are two integers closest
to <varname>x</varname>/<varname>y</varname>, <varname>n</varname> shall be the even one. If <varname>r</varname> is zero, it is
given the same sign as <varname>x</varname>. This is the same value
that is returned by the <citerefentry><refentrytitle>remainder</refentrytitle></citerefentry> function.</para>
<para><function>remquo</function> also calculates the lower seven bits of the
integral quotient <varname>x</varname>/<varname>y</varname>, and gives that value the same
sign as <varname>x</varname>/<varname>y</varname>. It stores this signed value in the object
pointed to by <varname>quo</varname>.
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
The vector versions of the math functions operate component-wise. The description is per-component.
The built-in math functions are not affected by the prevailing rounding mode in the calling
environment, and always return the same value as they would if called with the round to nearest
even rounding mode.
This built-in math function takes scalar or vector arguments. The generic type name <type>gentype</type> is used to indicate that the function can take <type>float</type>, <type>float2</type>, <type>float4</type>, <type>float8</type>, or <type>float16</type> as the type for the arguments. For any specific
use of these function, the actual type has to be the same for all arguments and the return type.
If extended with <citerefentry><refentrytitle>cl_khr_fp64</refentrytitle></citerefentry>, generic type name <type>gentype</type> may indicate <type>double</type> and <type>double{2|4|8|16}</type> as arguments and return values. If extended with <citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>, generic type name <type>gentype</type> may indicate <type>half</type> and <type>half{2|4|8|16}</type> as arguments and return values.
<!-- ================================ EXAMPLE -->
<refsect2 id="example1">
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
Example goes here - it will be set in "code" type with white space preserved.
<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
<refsect1 id="specification"><title>Specification</title>
<imagedata fileref="pdficon_small1.gif" format="gif" />
<olink uri="mathFunctions">OpenCL Specification</olink>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<citerefentry href="mathFunctions"><refentrytitle>Math Functions</refentrytitle></citerefentry>
<!-- ============================== COPYRIGHT -->
<!-- Content included from -->
<refsect3 id="Copyright"><title></title>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
<para />