SIMPLE SOLUTIONS

CLAMP(3CLC) - Linux man page online | Library functions

Clamp x to range given by min, max.

Chapter
01/03/2018
CLAMP(3clc) OpenCL Manual CLAMP(3clc)

NAME

clamp - Clamp x to range given by min, max gentype clamp(gentype x, gentype minval, gentype maxval); gentypef clamp(gentypef x, float minval, float maxval); gentyped clamp(gentyped x, double minval, double maxval); gentype clamp (gentype x, gentype minval, gentype maxval) // if half extension enabled gentype clamp (gentype x, half minval, half maxval) // if half extension enabled

DESCRIPTION

Returns min(fmax(x, minval), maxval). Results are undefined if minval > maxval.

NOTES

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. 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 built-in common functions are implemented using the round to nearest even rounding mode. 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.

SPECIFICATION

OpenCL Specification[1]

SEE ALSO

commonFunctions(3clc)

AUTHORS

The Khronos Group
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 260, section 6.12.4 - Common Functions
The Khronos Group 01/03/2018 CLAMP(3clc)
This manual Reference Other manuals
clamp(3clc) referred by commonFunctions(3clc) | integerClamp(3clc)
refer to cl_khr_fp16(3clc) | commonFunctions(3clc)
Download raw manual
Main page OpenCL Manual (+322) The Khronos Group (+322) № 3 (+68044)
Go top