VECTOR_
On this page
The VECTOR_ function adds the two vector arguments and returns a vector which is the result of that addition.
Syntax
VECTOR_ADD(vector_expression, vector_expression)
Arguments
-
vector_: An expression that evaluates to a vector.expression Vectors can be stored in SingleStore using the BLOBtype (BLOB Types).
Return Type
If both arguments are BLOBs, then the return type will be by default a BLOB that contains a vector encoded as 32-bit floating point numbers (F32).BLOB that contains a vector encoded using the type of the suffix.
See Using Suffixes for Other Element Types with BLOBs for information on using suffixes with vectors encoded as BLOBs.
Remarks
-
The default format for vector element storage and processing is a 32-bit floating-point number (
F32).When the inputs are BLOBs, the function assumes the inputs are vectors encoded as 32-bit floating-point numbers. -
When a suffix is used, the function will interpret the inputs as vectors encoded as specified by the suffix.
See Using Suffixes for Other Element Types with BLOBs for more information.
Using VECTOR_
The following examples and descriptions show the use of VECTOR_ with arguments that are both vectors stored as BLOBs.
Example 1 - BLOB Arguments
Create a table with a column of type BLOB to store the vectors.vec and type BLOB, will store the vectors.BLOBs, hence the column of type BLOB named vec.
CREATE TABLE vectors_b (id int, vec BLOB not null);INSERT INTO vectors_b VALUES (1, JSON_ARRAY_PACK('[0.1, 0.8, 0.2, 0.555]'));INSERT INTO vectors_b VALUES (2, JSON_ARRAY_PACK('[0.45, 0.55, 0.495, 0.5]'));
The following query adds the vector '[0. to the vectors in the vectors_ table and uses JSON_ to see the results in JSON format.
SET @qv = JSON_ARRAY_PACK('[0.1,0.1,0.1,0.1]');SELECT id, JSON_ARRAY_UNPACK(VECTOR_ADD(vec, @qv)) AS vector_addFROM vectors_bORDER BY id;
+------+---------------------------------------------------+
| id | vector_add |
+------+---------------------------------------------------+
| 1 | [0.200000003,0.900000036,0.300000012,0.655000031] |
| 2 | [0.550000012,0.650000036,0.595000029,0.600000024] |
+------+---------------------------------------------------+JSON_ was used here to output the vectors in readable format because VECTOR_ returns a BLOB when its inputs are BLOBs.
The following query adds the vector '[0. to the vectors in the vectors_ table and uses HEX to view the results in hexadecimal format.
SET @qv = JSON_ARRAY_PACK('[0.1,0.1,0.1,0.1]');SELECT id, HEX(VECTOR_ADD(vec, @qv)) AS vector_addFROM vectors_bORDER BY id;
+------+----------------------------------+
| id | vector_add |
+------+----------------------------------+
| 1 | CDCC4C3E6766663F9A99993E15AE273F |
| 2 | CDCC0C3F6766263FEC51183F9A99193F |
+------+----------------------------------+Using Suffixes for Other Element Types with BLOBs
The default element type for vector storage and processing is 32-bit floating point (F32).
You can specify the datatype of the vector elements to be used in the operation by adding a suffix to the function._.
When using a suffix, the return type will be the type specified by the suffix.
The following table lists the suffixes and their data type.
|
Suffix |
Data Type |
|---|---|
|
|
8-bit signed integer |
|
|
16-bit signed integer |
|
|
32-bit signed integer |
|
|
64-bit signed integer |
|
|
32-bit floating-point number (IEEE standard format) |
|
|
64-bit floating-point number (IEEE standard format) |
Example 2 - BLOBs with 16-bit Integers
Below is an example of using JSON_ and VECTOR_ with 16-bit signed integers.
First create a table of vectors stored as 16-bit integers._ suffix on JSON_.
CREATE TABLE vectors_b_i (id int, vec BLOB not null);INSERT INTO vectors_b_i VALUES (1, JSON_ARRAY_PACK_I16('[1, 3, 2, 5]'));INSERT INTO vectors_b_i VALUES(2, JSON_ARRAY_PACK_I16('[23, 4, 1, 8]'));
The following query adds the vector '[2,2,2,2]' to the vectors in the vectors_.
SET @qv = JSON_ARRAY_PACK_I16('[2, 2, 2, 2]');SELECT JSON_ARRAY_UNPACK_I16(VECTOR_ADD_I16(@qv, vec)) AS vector_addFROM vectors_b_i;
+--------------+
| vector_add |
+--------------+
| [3,5,4,7] |
| [25,6,3,10] |
+--------------+The result is an array of 16-bit integers as indicated by the _ suffix.
Note
Be sure that the suffixes you use to pack the vector data match the suffixes you use to unpack the data and the suffixes you use on functions to process that data.
Formatting Binary Vector Data for BLOBs
When using the BLOB type for vector operations, vector data can be formatted using JSON_.BLOBs.BLOB containing packed numbers in little-endian byte order.BLOBs can be of any length; however, the input blob length must be divisible by the size of the packed vector elements .
Related Topics
Last modified: May 30, 2024