Points (Lucene 10.5.0 benchmark API)
Description: declaration: package: org.apache.lucene.benchmark.byTask.stats, class: Points

Package org.apache.lucene.benchmark.byTask.stats

# Class Points

java.lang.Object
org.apache.lucene.benchmark.byTask.stats.Points

public class Points extends Object
Test run data points collected as the test proceeds.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `Points(Config config)`
  Create a Points statistics object.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `clearData()`
  Clear all data, prepare for more tests.
  `TaskStats`
  `getCurrentStats()`
  `void`
  `markTaskEnd(TaskStats stats, int count)`
  mark the end of a task
  `TaskStats`
  `markTaskStart(PerfTask task, int round)`
  Mark that a task is starting.
  `List<TaskStats>`
  `taskStats()`
  Return the current task stats.

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### Points

    public Points(Config config)
    Create a Points statistics object.

- ## Method Details

  - ### taskStats

    public List<TaskStats> taskStats()
    Return the current task stats. the actual task stats are returned, so caller should not modify this task stats.
    Returns:
      current `TaskStats`.

  - ### markTaskStart

    public TaskStats markTaskStart(PerfTask task, int round)
    Mark that a task is starting. Create a task stats for it and store it as a point.
    Parameters:
      `task` - the starting task.
    Returns:
      the new task stats created for the starting task.

  - ### getCurrentStats

    public TaskStats getCurrentStats()

  - ### markTaskEnd

    public void markTaskEnd(TaskStats stats, int count)
    mark the end of a task

  - ### clearData

    public void clearData()
    Clear all data, prepare for more tests.