Rate This Document
Findability
Accuracy
Completeness
Readability

krl_L2sqr

Interface Definition

int krl_L2sqr(const float* x, const float* __restrict y, const size_t d, float* dis, size_t dis_size);

Function

Performs one-to-one Euclidean distance computation on vectors represented in float precision.

Parameters

Parameter

Data Type

Description

Value Range

x

const float*

Query vector for distance computation.

The vector has a dimension of d.

y

const float*

Base vector for distance computation.

The vector has a dimension of d.

d

const size_t

Vector dimension.

[1, 65535]

dis

float*

Stores the distance computation result.

The size is specified by dis_size. The memory needs to be allocated in advance.

dis_size

size_t

Specifies the size of the distance result array.

The value is 1.

Return Values

Data Type

Description

int

0 is returned on successful execution. In case of failure, an error code is returned to indicate the specific issue:

  • -1: invalid pointer
  • -2: memory allocation failure
  • -3: invalid input parameter
  • -4: double free
  • -5: insecure memory operation
  • -6: I/O failure