Provided by: opencl-1.2-man-doc_1.0~svn33624-5_all
NAME
sin,_sincos,_sinh,_sinpi,_half_sin,_native_sin - Sine functions. gentype sin(gentype ); gentype sincos(gentype x, __global gentype *cosval); gentype sincos(gentype x, __local gentype *cosval); gentype sincos(gentype x, __private gentype *cosval); gentype sinh(gentype ); gentype sinpi(gentype x); gentype half_sin(gentype x); gentype native_sin(gentype x);
DESCRIPTION
sin computes the sine. sincos computes sine and cosine of x. The computed sine is the return value and computed cosine is returned in cosval. sinh computes the hyperbolic sine. sinpi computes sin (pi * x). half_sin computes sine. x must be in the range -216... +216. native_sin computes sine over an implementation-defined range. The maximum error is implementation-defined.
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. Functions with the half_ prefix are implemented with a minimum of 10-bits of accuracy i.e. an ULP value ≤ 8192 ulp. Functions 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). The accuracy (and in some cases the input range(s)) of these functions is implementation-defined.
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