distance

Vector distance.

float distance ( gentype p0,
  gentype p1)

double distance (gentype p0, gentype p1) // if double extension enabled
half distance (gentype p0, gentype p1) // if half extension enabled

Description

Returns the distance between p0 and p1. This is calculated as length(p0 - p1).

Notes

Built-in geometric functions operate component-wise and the description is per-component. The generic type name gentype indicates that the function can take float, float2, or float4 as the type for the arguments.

The built-in geometric functions are implemented using the round to nearest even rounding mode.

The geometric functions can be implemented using contractions such as mad or fma.

If extended with cl_khr_fp64, generic type name gentype may indicate double and double{2|4|8|16} as arguments and return values. If extended with cl_khr_fp16, generic type name gentype may indicate half and half{2|4|8|16} as arguments and return values.

Specification

OpenCL Specification

Also see

Geometric Functions

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.