'\" t
.\"     Title: remquo
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 06/18/2014
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "REMQUO" "3clc" "06/18/2014" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
remquo \- Floating point remainder and quotient function\&.
.SH ""
.HP \w'floatn\ remquo('u
.BI "floatn remquo(floatn\ " "x" ", floatn\ " "y" ", __global\ intn\ *" "quo" ");"
.HP \w'floatn\ remquo('u
.BI "floatn remquo(floatn\ " "x" ", floatn\ " "y" ", __local\ intn\ *" "quo" ");"
.HP \w'floatn\ remquo('u
.BI "floatn remquo(floatn\ " "x" ", floatn\ " "y" ", __private\ intn\ *" "quo" ");"
.HP \w'float\ remquo('u
.BI "float remquo(float\ " "x" ", float\ " "y" ", __global\ int\ *" "quo" ");"
.HP \w'float\ remquo('u
.BI "float remquo(float\ " "x" ", float\ " "y" ", __local\ int\ *" "quo" ");"
.HP \w'float\ remquo('u
.BI "float remquo(float\ " "x" ", float\ " "y" ", __private\ int\ *" "quo" ");"
.HP \w'doublen\ remquo('u
.BI "doublen remquo(doublen\ " "x" ", doublen\ " "y" ", __global\ intn\ *" "quo" ");"
.HP \w'doublen\ remquo('u
.BI "doublen remquo(doublen\ " "x" ", doublen\ " "y" ", __local\ intn\ *" "quo" ");"
.HP \w'doublen\ remquo('u
.BI "doublen remquo(doublen\ " "x" ", doublen\ " "y" ", __private\ intn\ *" "quo" ");"
.HP \w'double\ remquo('u
.BI "double remquo(double\ " "x" ", double\ " "y" ", __global\ int\ *" "quo" ");"
.HP \w'double\ remquo('u
.BI "double remquo(double\ " "x" ", double\ " "y" ", __local\ int\ *" "quo" ");"
.HP \w'double\ remquo('u
.BI "double remquo(double\ " "x" ", double\ " "y" ", __private\ int\ *" "quo" ");"
.HP \w'halfn\ remquo('u
.BI "halfn remquo(halfn\ " "x" ", halfn\ " "y" ", __global\ intn\ *" "quo" ");"
.HP \w'halfn\ remquo('u
.BI "halfn remquo(halfn\ " "x" ", halfn\ " "y" ", __local\ intn\ *" "quo" ");"
.HP \w'halfn\ remquo('u
.BI "halfn remquo(halfn\ " "x" ", halfn\ " "y" ", __private\ intn\ *" "quo" ");"
.HP \w'half\ remquo('u
.BI "half remquo(half\ " "x" ", half\ " "y" ", __global\ int\ *" "quo" ");"
.HP \w'half\ remquo('u
.BI "half remquo(half\ " "x" ", half\ " "y" ", __local\ int\ *" "quo" ");"
.HP \w'half\ remquo('u
.BI "half remquo(half\ " "x" ", half\ " "y" ", __private\ int\ *" "quo" ");"
.SH "DESCRIPTION"
.PP
The
\fBremquo\fR
function computes the value
\fIr\fR
such that
\fIr\fR
=
\fIx\fR
\-
\fIn\fR*\fIy\fR, where
\fIk\fR
is the integer nearest the exact value of
\fIx\fR/\fIy\fR\&. If there are two integers closest to
\fIx\fR/\fIy\fR,
\fIk\fR
shall be the even one\&. If
\fIr\fR
is zero, it is given the same sign as
\fIx\fR\&. This is the same value that is returned by the
\fBremainder\fR(3clc)
function\&.
.PP
\fBremquo\fR
also calculates the lower seven bits of the integral quotient
\fIx\fR/\fIy\fR, and gives that value the same sign as
\fIx\fR/\fIy\fR\&. It stores this signed value in the object pointed to by
\fIquo\fR\&.
.SH "NOTES"
.PP
The vector versions of the math functions operate component\-wise\&. The description is per\-component\&.
.PP
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\&.
.PP
The built\-in math functions take scalar or vector arguments\&. For any specific use of these function, the actual type has to be the same for all arguments and the return type unless otherwise specified\&.
.PP
The generic type name
\fBgentype\fR
is used to indicate that the function can take
\fBfloat\fR,
\fBfloat2\fR,
\fBfloat3\fR,
\fBfloat4\fR,
\fBfloat8\fR,
\fBfloat16\fR,
\fBdouble\fR,
\fBdouble2\fR,
\fBdouble3\fR,
\fBdouble4\fR,
\fBdouble8\fR, or
\fBdouble16\fR
as the type for the arguments\&.
.PP
If extended with
\fBcl_khr_fp16\fR(3clc), generic type name
\fBgentype\fR
may indicate
\fBhalf\fR
and
\fBhalf{2|3|4|8|16}\fR
as arguments and return values\&.
.PP
The generic type name
\fBgentypef\fR
is used to indicate that the function can take
\fBfloat\fR,
\fBfloat2\fR,
\fBfloat3\fR,
\fBfloat4\fR,
\fBfloat8\fR, or
\fBfloat16\fR
as the type for the arguments\&.
.PP
The generic type name
\fBgentyped\fR
is used to indicate that the function can take
\fBdouble\fR,
\fBdouble2\fR,
\fBdouble3\fR,
\fBdouble4\fR,
\fBdouble8\fR, or
\fBdouble16\fR
as the type for the arguments\&.
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBmathFunctions\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
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.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 244, section 6.12.2 - Math Functions
.RE