Package com.qtsurfer.api.sdk

Enum Class SweepRanking

java.lang.Object

java.lang.Enum<SweepRanking>

com.qtsurfer.api.sdk.SweepRanking

All Implemented Interfaces:

Serializable, Comparable<SweepRanking>, Constable

public enum SweepRanking
extends Enum<SweepRanking>

How the leaderboard is ordered.

The server default is PLATEAU, so the order a sweep answers with is not the raw objective order unless you ask for it. Set it through SweepOptions.Builder.ranking(SweepRanking); leaving it unset sends no ranking parameter at all and takes whatever the platform defaults to.

What you request is not always what you get. Read ExecuteSweepResult.getRanking() to find out which ordering was actually applied: a sweep with no stored parameter grid has no neighbourhood to score against and falls back to RAW, and a walk-forward sweep is always RAW because its leaderboard is one out-of-sample row per fold rather than a grid.

This applies to the ranked view only. Alongside SweepOrder.NATURAL it is ignored — that view is always ordered by runIx.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PLATEAU	Order by plateau score: the objective of the worst run in a point's immediate neighbourhood, so a point only ranks well when the region around it does too.
RAW	Order by the objective alone, with no neighbourhood adjustment.

Method Summary

Modifier and Type	Method	Description
static SweepRanking	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SweepRanking[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
String	wire()	Internal: the value sent as the ranking query parameter.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PLATEAU

public static final SweepRanking PLATEAU

Order by plateau score: the objective of the worst run in a point's immediate neighbourhood, so a point only ranks well when the region around it does too.

This exists because the highest raw score is very often a spike that does not survive the parameters moving slightly. Rows ranked this way carry plateauScore and neighbourCount, and those two are read together — see Sweep.await().

RAW

public static final SweepRanking RAW

Order by the objective alone, with no neighbourhood adjustment.

Method Details

values

public static SweepRanking[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SweepRanking valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

wire

public String wire()

Internal: the value sent as the ranking query parameter. Exposed so the SDK's own helpers can pass it through without re-encoding.

Returns:

the wire token for this ordering