clamp(3clc)

clamp3clc

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

Overview

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]

Notes

1.

OpenCL Specification

page 260, section 6.12.4 - Common Functions

Releases

5 releases since Debian 8 (Jessie); the text changed 3 times.

  1. 8–9
  2. 10
  3. 11
  4. 13

Authors

The Khronos Group

From opencl-1.2-man-doc 1.0~svn33624-5.1 in Debian 13 (Trixie). Parsed by carta from the page's man source.