Scroll to navigation

DISTANCE(3clc) OpenCL Manual DISTANCE(3clc)

NAME

distance - Vector distance.

float distance(floatn p0, floatn p1);

double distance(doublen p0, doublen p1);

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

DESCRIPTION

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

NOTES

Built-in geometric functions operate component-wise. The description is per-component. floatn is float, float2, float3, or float4 and doublen is double, double2, double3, or double4. 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(3clc) or fma(3clc).

If extended with cl_khr_fp16(3clc), generic type name gentype may indicate half and half{2|3|4} as arguments.

SPECIFICATION

OpenCL Specification[1]

SEE ALSO

geometricFunctions(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 262, section 6.12.5 - Geometric Functions
06/18/2014 The Khronos Group