NAME¶
modf - Decompose a floating-point number.
gentype modf(gentype x,
__global gentype *iptr);
gentype modf(gentype x,
__local gentype *iptr);
gentype modf(gentype x,
__private gentype *iptr);
DESCRIPTION¶
Decompose a floating-point number. The
modf function breaks the argument
x into integral and fractional parts, each of which has the same sign
as the argument. It stores the integral part in the object pointed to by
iptr.
NOTES¶
modf behaves as though implemented by:
gentype modf ( gentype value, gentype *iptr )
{
*iptr = trunc(3clc)( value );
return copysign(3clc)( isinf(3clc)( value ) ? 0.0 : value - *iptr, value );
}
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
