VECTOR_ ELEMENTS_ SUM
On this page
The VECTOR_
function sums all elements of a vector.
Syntax
VECTOR_ELEMENTS_SUM(vector_expression)
Arguments
-
vector_
: An expression that evaluates to a vector.expression Vectors can be stored in SingleStore using the native VECTOR
type (Vector Type) or theBLOB
type (BLOB Types).SingleStore recommends using the VECTOR
type when possible.
Return Type
The return type is a 64-bit signed integer when the vector element type is an integer type, a 64-bit floating-point number when the vector element type is a floating point type, or NULL
.
Remarks
-
If the input is
NULL
,NULL
will be returned.
Using VECTOR_ ELEMENTS_ SUM with the VECTOR Data Type
The examples below show two uses of VECTOR_
with different types of VECTOR
arguments.
Example 1 - Vector with F32 Element Type
First create a table of vectors of length 4 using the VECTOR
data type and insert data into that table.
CREATE TABLE vectors (id int, vec VECTOR(4) not null);INSERT INTO vectors VALUES (1, '[0.45, 0.55, 0.495, 0.5]');INSERT INTO vectors VALUES (2, '[0.1, 0.8, 0.2, 0.555]');INSERT INTO vectors VALUES (3, '[-0.5, -0.03, -0.1, 0.86]');INSERT INTO vectors VALUES (4, '[0.5, 0.3, 0.807, 0.1]');
Note
The default element type for Vector Type is 32-bit floating point (F32
).
The following SQL sums the elements of those vectors.
Click the Playground icon to the right of the SQL listing to try this query.
SELECT id, VECTOR_ELEMENTS_SUM(vec)FROM vectorsORDER BY id;
+------+--------------------------+
| id | VECTOR_ELEMENTS_SUM(vec) |
+------+--------------------------+
| 1 | 1.9950000047683716 |
| 2 | 1.6550000235438347 |
| 3 | 0.23000001348555088 |
| 4 | 1.706999994814396 |
+------+--------------------------+
Example 2 - Vector with I16 Element Type
This example shows how to use VECTOR_
with a VECTOR
with an elementType of 16-bit integer (I16
).
CREATE TABLE vectors_i16(id INT, vec VECTOR(3, I16));INSERT INTO vectors_i16 VALUES(1, '[1, 2, 3]');INSERT INTO vectors_i16 VALUES(2, '[4, 5, 6]');INSERT INTO vectors_i16 VALUES(3, '[1, 4, 8]');
The following SQL sums the elements of those vectors.
SELECT id, VECTOR_ELEMENTS_SUM(vec)FROM vectors_i16ORDER BY id;
+------+--------------------------+
| id | VECTOR_ELEMENTS_SUM(vec) |
+------+--------------------------+
| 1 | 6 |
| 2 | 15 |
| 3 | 13 |
+------+--------------------------+
Using VECTOR_ ELEMENTS_ SUM with Vectors as BLOBs
The following examples and descriptions show the use of VECTOR_
with an arguments that is a vector stored as a BLOB
.
Example 1 - BLOB Argument
Create a table with a column of type BLOB
to store the vectors.vec
and type BLOB
, will store the vectors.BLOB
s, hence the column of type BLOB
named vec
.
Then use the JSON_
built-in function to easily insert properly formatted vectors.
The following query sums the vectors in the vectors in the vectors_
table.
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]'));
SELECT id, VECTOR_ELEMENTS_SUM(vec)FROM vectors_bORDER BY id;
+------+--------------------------+
| id | VECTOR_ELEMENTS_SUM(vec) |
+------+--------------------------+
| 1 | 1.6550000235438347 |
| 2 | 1.9950000047683716 |
+------+--------------------------+
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 of the suffix.
Note
The functions with suffixes do not work with the VECTOR
type.
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 sums the elements of the vectors in the vectors_
.
SELECT id, VECTOR_ELEMENTS_SUM_I16(vec)FROM vectors_b_iORDER BY id;
+------+------------------------------+
| id | VECTOR_ELEMENTS_SUM_I16(vec) |
+------+------------------------------+
| 1 | 11 |
| 2 | 36 |
+------+------------------------------+
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_
.BLOB
s.BLOB
containing packed numbers in little-endian byte order.BLOB
s can be of any length; however, the input blob length must be divisible by the size of the packed vector elements (1, 2, 4 , or 8 bytes, depending on the vector element).
Related Topics
Last modified: May 30, 2024