Module math.vector
ballerina/math.vector Ballerina library
Package overview
This package provides functions for doing vector operations including calculating the L1 and L2 norm, dot product, cosine similarity, Euclidean distance, and Manhattan distance.
Report issues
To report bugs, request new features, start new discussions, view project boards, etc., go to the Ballerina standard library parent repository.
Useful links
- Chat live with us via our Discord server.
- Post all technical questions on Stack Overflow with the #ballerina tag.
Functions
cosineSimilarity
Calculates the cosine similarity between two float vectors.
float[] v1 = [1.0, 2.0, 3.0]; float[] v2 = [4.0, 5.0, 6.0]; cosineSimilarity(v1, v2) ⇒ 0.9746318461970762
Return Type
- float - the cosine similarity between the given two vectors
dotProduct
Calculates the dot product of two float vectors.
float[] v1 = [1.0, 2.0, 3.0]; float[] v2 = [4.0, 5.0, 6.0]; dotProduct(v1, v2) ⇒ 32.0
Return Type
- float - the dot product of the given two vectors
euclideanDistance
Calculates the Euclidean distance between two float vectors.
float[] v1 = [1.0, 2.0, 3.0]; float[] v2 = [4.0, 5.0, 6.0]; euclideanDistance(v1, v2) ⇒ 5.196152422706632
Return Type
- float - the Euclidean distance between the given two vectors
manhattanDistance
Calculates the Manhattan distance between two float vectors.
float[] v1 = [1.0, 2.0, 3.0]; float[] v2 = [4.0, 5.0, 6.0]; manhattanDistance(v1, v2) ⇒ 9.0
Return Type
- float - the Manhattan distance between the given two vectors
vectorNorm
Calculates the L1 and L2 norm of a float vector.
float[] v = [1.0, 2.0, 3.0]; vectorNorm(v, vector:L2) ⇒ 3.7416573867739413 vectorNorm(v, vector:L1) ⇒ 6.0
Parameters
- v float[] - float vector to operate on
- norm NormType - norm type to calculate out of [L1, L2]
Return Type
- float - the L1 or L2 norm of the given float vector
Enums
math.vector: NormType
An enum containing the supported norm types. L1 - L1 norm which is the sum of the absolute values of the vector elements L2 - L2 norm which is the square root of the sum of the squared vector elements.