Package com.qtsurfer.api.sdk

Enum Class SweepSampler

java.lang.Object

java.lang.Enum<SweepSampler>

com.qtsurfer.api.sdk.SweepSampler

All Implemented Interfaces:

Serializable, Comparable<SweepSampler>, Constable

public enum SweepSampler
extends Enum<SweepSampler>

How the parameter grid is turned into the list of vectors that actually run.

GRID is the platform default and runs the full cross product. RANDOM and LHS draw a bounded number of vectors instead, so both need SweepRequest.Builder.samples(int); samples is ignored by GRID.

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
GRID	Every combination of every axis value.
LHS	Latin hypercube draws, which spread the sample more evenly than uniform random.
RANDOM	Uniformly random draws from the grid, capped at samples.

Method Summary

Modifier and Type	Method	Description
static SweepSampler	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SweepSampler[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
com.qtsurfer.api.client.model.SweepSpecRequest.SamplerEnum	wire()	Internal: the underlying api-client enum.

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

GRID

public static final SweepSampler GRID

Every combination of every axis value. Cost is the product of the axis sizes.

RANDOM

public static final SweepSampler RANDOM

Uniformly random draws from the grid, capped at samples.

LHS

public static final SweepSampler LHS

Latin hypercube draws, which spread the sample more evenly than uniform random.

Method Details

values

public static SweepSampler[] 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 SweepSampler 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 com.qtsurfer.api.client.model.SweepSpecRequest.SamplerEnum wire()

Internal: the underlying api-client enum. Exposed so the SDK's own helpers can pass it through without re-encoding.

Returns:

the api-client sampler constant