Relational Built-In Functions

Click an item in the table below for details about that function.

isequal

Compare of x == y.

isnotequal

Compare of x != y.

isgreater

Compare of x > y.

isgreaterequal

Compare of x >= y.

isless

Compare of x < y.

islessequal

Compare of x <= y.

islessgreater

Compare of (x < y) || (x > y).

isfinite

Test for finite value.

isinf

Test for +ve or -ve infinity.

isnan

Test for a NaN.

isnormal

Test for a normal value.

isordered

Test if arguments are ordered.

isunordered

Test if arguments are unordered.

signbit

Test for sign bit.

any

1 if MSB in any component of x is set; else 0.

all

1 if MSB in all components of x is set; else 0.

bitselect

Each bit of result is corresponding bit of a if corresponding bit of c is 0.

select

For each component of a vector type, result[i] = if MSB of c[i] is set ? b[i] : a[i] For scalar type, result = c ? b : a.

Description

The relational and equality operators (<, <=, >, >=, !=, ==) can be used with scalar and vector built-in types and produce a scalar or vector signed integer result respectively.

The built-in relational functions can be used with built-in scalar or vector types as arguments and return a scalar vector integer result. The argment type gentype can be char, charn, uchar, ucharn, short, shortn, ushort, ushortn, int, intn, uint, uintn, long, longn, ulong, ulongn, float, and floatn. The argument type igentype refers to signed integer vector types i.e. char, charn, short, shortn, int, intn, long, and longn. The argument type ugentype refers to unsigned integer vector types i.e. uchar, ucharn, ushort, ushortn, uint, uintn, ulong, and ulongn.

The built-in relational functions are extended with cl_khr_fp64 to include appropriate versions of functions that take double, and double{2|4|8|16} as arguments and return values. They are also extended with with cl_khr_fp16 to include appropriate versions of functions that take half, and half{2|4|8|16} as arguments and return values.

Specification

OpenCL Specification

Copyright © 2007-2009 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.