net.viktorc.detroid.framework.tuning

Annotation Type Parameter

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface Parameter

An annotation for denoting fields to be considered as engine parameters possibly eligible for tuning.

Author:

Viktor

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
byte	binaryLengthLimit The number of bits to include in the binary output for the annotated field counting from the least significant bit.
ParameterType	type The type of the parameter e.g.

Element Detail

type

public abstract ParameterType type

The type of the parameter e.g. static evaluation parameter or engine or search control parameter. As in most engines the great majority of parameters, especially those wished to be tuned, are static evaluation parameters, so is the default value for this attribute.

Returns:

The type of the parameter.

Default:

net.viktorc.detroid.framework.tuning.ParameterType.STATIC_EVALUATION

binaryLengthLimit

public abstract byte binaryLengthLimit

The number of bits to include in the binary output for the annotated field counting from the least significant bit. If it is less than zero or higher than the maximum number of bits in an unsigned primitive or the maximum number of bits minus one in a signed primitive, no binary length limit shall be imposed. If it is zero, the field shall be ignored during tuning. It's default value is -1 which means the binary length limit shall be ignored by default.

Returns:

The number of bits to include in the binary output for the annotated field.

Default:

-1