Provided by: opencl-1.2-man-doc_1.0~svn22836-1.1_all
NAME
Math_Built-In_Functions - The table below describes the list of built-in math functions. These functions can take scalar or vector arguments. Click an item in the table for details about that function. ┌─────────────┬────────────────┬─────────────┬─────────────────┐ │ acos(3clc) │ acos(3clc) │ acos(3clc) │ asin(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ asin(3clc) │ asin(3clc) │ atan(3clc) │ atan(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ atan(3clc) │ atan(3clc) │ atan(3clc) │ cbrt(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ ceil(3clc) │ copysign(3clc) │ cos(3clc) │ cos(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ cos(3clc) │ erf(3clc) │ erf(3clc) │ exp(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ exp(3clc) │ exp(3clc) │ exp(3clc) │ fabs(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ fdim(3clc) │ floor(3clc) │ fma(3clc) │ fmax(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ fmin(3clc) │ fmod(3clc) │ fract(3clc) │ frexp(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │hypot(3clc) │ ilogb(3clc) │ ldexp(3clc) │ lgamma(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │lgamma(3clc) │ log(3clc) │ log(3clc) │ log(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ log(3clc) │ log(3clc) │ mad(3clc) │ mag(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ mag(3clc) │ modf(3clc) │ nan(3clc) │ nextafter(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ pow(3clc) │ pow(3clc) │ pow(3clc) │ remainder(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │remquo(3clc) │ rint(3clc) │ rootn(3clc) │ round(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ sqrt(3clc) │ sin(3clc) │ sin(3clc) │ sin(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ sin(3clc) │ sqrt(3clc) │ tan(3clc) │ tan(3clc) │ ├─────────────┼────────────────┼─────────────┼─────────────────┤ │ tan(3clc) │ tgamma(3clc) │ trunc(3clc) │ │ └─────────────┴────────────────┴─────────────┴─────────────────┘ The table below describes the list of built-in math functions that are defined with the half_ or native_ prefix ┌───────────┬──────────────┬────────────┬───────────┐ │cos(3clc) │ divide(3clc) │ exp(3clc) │ exp(3clc) │ ├───────────┼──────────────┼────────────┼───────────┤ │exp(3clc) │ log(3clc) │ log(3clc) │ log(3clc) │ ├───────────┼──────────────┼────────────┼───────────┤ │pow(3clc) │ recip(3clc) │ sqrt(3clc) │ sin(3clc) │ ├───────────┼──────────────┼────────────┼───────────┤ │sqrt(3clc) │ tan(3clc) │ │ │ └───────────┴──────────────┴────────────┴───────────┘
DESCRIPTION
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. The math functions that are defined with the half_ prefix are implemented with a minimum of 10-bits of accuracy i.e. an ULP value <= 8192 ulp. The math functions that are defined with the native_ prefix may map to one or more native device instructions and will typically have better performance compared to the corresponding functions (without the native_ prefix) described. The accuracy (and in some cases the input range(s)) of these functions is implementation-defined.
SPECIFICATION
OpenCL Specification[1]
SEE ALSO
mathConstants(3clc), FP_CONTRACT(3clc), macroLimits(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