Package dev.frostlake.functions.scalar.vector

Class VectorL2Distance

java.lang.Object
dev.frostlake.functions.BuiltInFunction
dev.frostlake.functions.scalar.vector.VectorL2Distance
public class VectorL2Distance extends BuiltInFunction
VECTOR_L2_DISTANCE(v1, v2) — the Euclidean distance sqrt(Σ(a−b)²), as a FLOAT (float64).

Live-verified: VECTOR_L2_DISTANCE([1,2,3], [4,5,6]) is 5.196152422706632 (= √27) for VECTOR(FLOAT,3) and for VECTOR(INT,3) alike, SYSTEM$TYPEOF of the result is FLOAT[DOUBLE], a vector against itself is 0.0, and a typed NULL operand yields SQL NULL. Over float32 elements the account keeps full float64 precision in the answer: [0.1,0.2,0.3] to [0.4,0.5,0.6] is 0.5196152500135338.

  • Constructor Details

    • VectorL2Distance

      public VectorL2Distance()

  • Method Details

    • evaluate

      public Object evaluate(List<Object> args)
      Description copied from class: BuiltInFunction
      Computes the function's result over its already-evaluated argument values. A SQL NULL argument arrives as Java null, and returning null makes the SQL result NULL.
      Specified by:
      evaluate in class BuiltInFunction
      Parameters:
      args - the argument values, in call order
      Returns:
      the function's value for these arguments, or null for SQL NULL

    • getMinArgCount

      public int getMinArgCount()
      Description copied from class: BuiltInFunction
      The fewest arguments a call to this function may pass; fewer is an argument-count error.
      Specified by:
      getMinArgCount in class BuiltInFunction
      Returns:
      the minimum accepted argument count

    • getMaxArgCount

      public int getMaxArgCount()
      Description copied from class: BuiltInFunction
      The most arguments a call to this function may pass; Integer.MAX_VALUE marks a variadic function (see BuiltInFunction.isVariadic()).
      Specified by:
      getMaxArgCount in class BuiltInFunction
      Returns:
      the maximum accepted argument count