Package dev.frostlake.functions.scalar.vector

Class VectorCosineSimilarity

java.lang.Object
dev.frostlake.functions.BuiltInFunction
dev.frostlake.functions.scalar.vector.VectorCosineSimilarity
public class VectorCosineSimilarity extends BuiltInFunction
VECTOR_COSINE_SIMILARITY(v1, v2) — the cosine of the angle between two vectors, Σ(a·b) / (|a|·|b|), as a FLOAT (float64).

Live-verified: over [1,2,3] and itself it is 1.0, against [4,5,6] it is 0.9746318461970762 (SYSTEM$TYPEOF → FLOAT[DOUBLE]), the same value for the VECTOR(INT,3) pair, and against the ZERO vector it is NaN (the division by a zero magnitude is not special-cased). The float32 ELEMENTS still feed float64 arithmetic: over [0.1,0.2,0.3] and [0.4,0.5,0.6] the account returns 0.9746318467275483, not the exact-decimal 0.9746318461970762.

  • Constructor Details

    • VectorCosineSimilarity

      public VectorCosineSimilarity()

  • 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