Scroll to navigation

REMQUO(3clc) OpenCL Manual REMQUO(3clc)

NAME

remquo - Floating point remainder and quotient function.

floatn remquo(floatn x, floatn y, __global intn *quo);

floatn remquo(floatn x, floatn y, __local intn *quo);

floatn remquo(floatn x, floatn y, __private intn *quo);

float remquo(float x, float y, __global int *quo);

float remquo(float x, float y, __local int *quo);

float remquo(float x, float y, __private int *quo);

doublen remquo(doublen x, doublen y, __global intn *quo);

doublen remquo(doublen x, doublen y, __local intn *quo);

doublen remquo(doublen x, doublen y, __private intn *quo);

double remquo(double x, double y, __global int *quo);

double remquo(double x, double y, __local int *quo);

double remquo(double x, double y, __private int *quo);

halfn remquo(halfn x, halfn y, __global intn *quo);

halfn remquo(halfn x, halfn y, __local intn *quo);

halfn remquo(halfn x, halfn y, __private intn *quo);

half remquo(half x, half y, __global int *quo);

half remquo(half x, half y, __local int *quo);

half remquo(half x, half y, __private int *quo);

DESCRIPTION

The remquo function computes the value r such that r = x - n*y, where k is the integer nearest the exact value of x/y. If there are two integers closest to x/y, k shall be the even one. If r is zero, it is given the same sign as x. This is the same value that is returned by the remainder(3clc) function.

remquo also calculates the lower seven bits of the integral quotient x/y, and gives that value the same sign as x/y. It stores this signed value in the object pointed to by quo.

NOTES

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.

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.

The generic type name gentype is used to indicate that the function can take float, float2, float3, float4, float8, float16, double, double2, double3, double4, double8, or double16 as the type for the arguments.

If extended with cl_khr_fp16(3clc), generic type name gentype may indicate half and half{2|3|4|8|16} as arguments and return values.

The generic type name gentypef is used to indicate that the function can take float, float2, float3, float4, float8, or float16 as the type for the arguments.

The generic type name gentyped is used to indicate that the function can take double, double2, double3, double4, double8, or double16 as the type for the arguments.

SPECIFICATION

OpenCL Specification[1]

SEE ALSO

mathFunctions(3clc)

AUTHORS

The Khronos Group

COPYRIGHT

Copyright © 2007-2011 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.

NOTES

1.
OpenCL Specification
page 244, section 6.12.2 - Math Functions
01/14/2021 The Khronos Group