ES|QL change point

docs/changelog/119458.yaml

@@ -0,0 +1,5 @@
+pr: 119458
+summary: ES|QL change point
+area: Machine Learning
+type: feature
+issues: []

x-pack/plugin/esql/compute/ann/src/main/java/org/elasticsearch/compute/ann/Aggregator.java

@@ -63,4 +63,8 @@
      */
     Class<? extends Exception>[] warnExceptions() default {};
 
+    /**
+     * If {@code true} then the @timestamp LongVector will be appended to the input blocks of the aggregation function.
+     */
+    boolean includeTimestamps() default false;
 }

x-pack/plugin/esql/compute/build.gradle

@@ -669,6 +669,28 @@ tasks.named('stringTemplates').configure {
     it.outputFile = "org/elasticsearch/compute/aggregation/TopIpAggregator.java"
   }
 
+  File changePointAggregatorInputFile = new File("${projectDir}/src/main/java/org/elasticsearch/compute/aggregation/X-ChangePointAggregator.java.st")
+  template {
+    it.properties = intProperties
+    it.inputFile = changePointAggregatorInputFile
+    it.outputFile = "org/elasticsearch/compute/aggregation/ChangePointIntAggregator.java"
+  }
+  template {
+    it.properties = longProperties
+    it.inputFile = changePointAggregatorInputFile
+    it.outputFile = "org/elasticsearch/compute/aggregation/ChangePointLongAggregator.java"
+  }
+  template {
+    it.properties = floatProperties
+    it.inputFile = changePointAggregatorInputFile
+    it.outputFile = "org/elasticsearch/compute/aggregation/ChangePointFloatAggregator.java"
+  }
+  template {
+    it.properties = doubleProperties
+    it.inputFile = changePointAggregatorInputFile
+    it.outputFile = "org/elasticsearch/compute/aggregation/ChangePointDoubleAggregator.java"
+  }
+
   File multivalueDedupeInputFile = file("src/main/java/org/elasticsearch/compute/operator/mvdedupe/X-MultivalueDedupe.java.st")
   template {
     it.properties = intProperties

x-pack/plugin/esql/compute/gen/src/main/java/org/elasticsearch/compute/gen/AggregatorImplementer.java

@@ -87,12 +87,14 @@ public class AggregatorImplementer {
     private final boolean valuesIsBytesRef;
     private final List<IntermediateStateDesc> intermediateState;
     private final List<Parameter> createParameters;
+    private final boolean includeTimestampVector;
 
     public AggregatorImplementer(
         Elements elements,
         TypeElement declarationType,
         IntermediateState[] interStateAnno,
-        List<TypeMirror> warnExceptions
+        List<TypeMirror> warnExceptions,
+        boolean includeTimestampVector
     ) {
         this.declarationType = declarationType;
         this.warnExceptions = warnExceptions;
@@ -128,6 +130,7 @@ public AggregatorImplementer(
         );
         this.valuesIsBytesRef = BYTES_REF.equals(TypeName.get(combine.getParameters().get(combine.getParameters().size() - 1).asType()));
         intermediateState = Arrays.stream(interStateAnno).map(IntermediateStateDesc::newIntermediateStateDesc).toList();
+        this.includeTimestampVector = includeTimestampVector;
     }
 
     ClassName implementation() {
@@ -359,34 +362,44 @@ private MethodSpec addRawInput() {
             builder.addStatement("return");
         }
         builder.endControlFlow();
+        builder.addStatement("$T block = page.getBlock(channels.get(0))", valueBlockType(init, combine));
+        builder.addStatement("$T vector = block.asVector()", valueVectorType(init, combine));
+        if (includeTimestampVector) {
+            builder.addStatement("$T timestampsBlock = page.getBlock(channels.get(1))", LONG_BLOCK);
+            builder.addStatement("$T timestampsVector = timestampsBlock.asVector()", LONG_VECTOR);
+            builder.beginControlFlow("if (timestampsVector == null) ");
+            builder.addStatement("throw new IllegalStateException($S)", "expected @timestamp vector; but got a block");
+            builder.endControlFlow();
+        }
+
         builder.beginControlFlow("if (mask.allTrue())");
+        String extra = includeTimestampVector ? ", timestampsVector" : "";
         {
             builder.addComment("No masking");
-            builder.addStatement("$T block = page.getBlock(channels.get(0))", valueBlockType(init, combine));
-            builder.addStatement("$T vector = block.asVector()", valueVectorType(init, combine));
             builder.beginControlFlow("if (vector != null)");
-            builder.addStatement("addRawVector(vector)");
+            builder.addStatement("addRawVector(vector$L)", extra);
             builder.nextControlFlow("else");
-            builder.addStatement("addRawBlock(block)");
+            builder.addStatement("addRawBlock(block$L)", extra);
             builder.endControlFlow();
             builder.addStatement("return");
         }
-        builder.endControlFlow();
-
+        builder.nextControlFlow("else");
         builder.addComment("Some positions masked away, others kept");
-        builder.addStatement("$T block = page.getBlock(channels.get(0))", valueBlockType(init, combine));
-        builder.addStatement("$T vector = block.asVector()", valueVectorType(init, combine));
         builder.beginControlFlow("if (vector != null)");
-        builder.addStatement("addRawVector(vector, mask)");
+        builder.addStatement("addRawVector(vector$L, mask)", extra);
         builder.nextControlFlow("else");
-        builder.addStatement("addRawBlock(block, mask)");
+        builder.addStatement("addRawBlock(block$L, mask)", extra);
+        builder.endControlFlow();
         builder.endControlFlow();
         return builder.build();
     }
 
     private MethodSpec addRawVector(boolean masked) {
         MethodSpec.Builder builder = MethodSpec.methodBuilder("addRawVector");
         builder.addModifiers(Modifier.PRIVATE).addParameter(valueVectorType(init, combine), "vector");
+        if (includeTimestampVector) {
+            builder.addParameter(LONG_VECTOR, "timestamps");
+        }
         if (masked) {
             builder.addParameter(BOOLEAN_VECTOR, "mask");
         }
@@ -416,6 +429,9 @@ private MethodSpec addRawVector(boolean masked) {
     private MethodSpec addRawBlock(boolean masked) {
         MethodSpec.Builder builder = MethodSpec.methodBuilder("addRawBlock");
         builder.addModifiers(Modifier.PRIVATE).addParameter(valueBlockType(init, combine), "block");
+        if (includeTimestampVector) {
+            builder.addParameter(LONG_VECTOR, "timestamps");
+        }
         if (masked) {
             builder.addParameter(BOOLEAN_VECTOR, "mask");
         }
@@ -455,6 +471,8 @@ private void combineRawInput(MethodSpec.Builder builder, String blockVariable) {
         }
         if (valuesIsBytesRef) {
             combineRawInputForBytesRef(builder, blockVariable);
+        } else if (includeTimestampVector) {
+            combineRawInputWithTimestamp(builder, blockVariable);
         } else if (returnType.isPrimitive()) {
             combineRawInputForPrimitive(returnType, builder, blockVariable);
         } else if (returnType == TypeName.VOID) {
@@ -492,6 +510,12 @@ private void combineRawInputForVoid(MethodSpec.Builder builder, String blockVari
         );
     }
 
+    private void combineRawInputWithTimestamp(MethodSpec.Builder builder, String blockVariable) {
+        TypeName valueType = TypeName.get(combine.getParameters().get(combine.getParameters().size() - 1).asType());
+        String blockType = valueType.toString().substring(0, 1).toUpperCase(Locale.ROOT) + valueType.toString().substring(1);
+        builder.addStatement("$T.combine(state, timestamps.getLong(i), $L.get$L(i))", declarationType, blockVariable, blockType);
+    }
+
     private void combineRawInputForBytesRef(MethodSpec.Builder builder, String blockVariable) {
         // scratch is a BytesRef var that must have been defined before the iteration starts
         builder.addStatement("$T.combine(state, $L.getBytesRef(i, scratch))", declarationType, blockVariable);

x-pack/plugin/esql/compute/gen/src/main/java/org/elasticsearch/compute/gen/AggregatorProcessor.java

@@ -87,7 +87,14 @@ public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnv
             );
             if (aggClass.getAnnotation(Aggregator.class) != null) {
                 IntermediateState[] intermediateState = aggClass.getAnnotation(Aggregator.class).value();
-                implementer = new AggregatorImplementer(env.getElementUtils(), aggClass, intermediateState, warnExceptionsTypes);
+                boolean includeTimestamps = aggClass.getAnnotation(Aggregator.class).includeTimestamps();
+                implementer = new AggregatorImplementer(
+                    env.getElementUtils(),
+                    aggClass,
+                    intermediateState,
+                    warnExceptionsTypes,
+                    includeTimestamps
+                );
                 write(aggClass, "aggregator", implementer.sourceFile(), env);
             }
             GroupingAggregatorImplementer groupingAggregatorImplementer = null;