abstract class Guess

Base class for guesses made by TypeGuesserInterface implementation.

Each instance contains a confidence value about the correctness of the guess. Thus an instance with confidence HIGH_CONFIDENCE is more likely to be correct than an instance with confidence LOW_CONFIDENCE.

Constants

VERY_HIGH_CONFIDENCE

Marks an instance with a value that is extremely likely to be correct.

HIGH_CONFIDENCE

Marks an instance with a value that is very likely to be correct.

MEDIUM_CONFIDENCE

Marks an instance with a value that is likely to be correct.

LOW_CONFIDENCE

Marks an instance with a value that may be correct.

Methods

static Guess|null
getBestGuess(array $guesses)

Returns the guess most likely to be correct from a list of guesses.

__construct(int $confidence)

No description

int
getConfidence()

Returns the confidence that the guessed value is correct.

Details

at line 67
static Guess|null getBestGuess(array $guesses)

Returns the guess most likely to be correct from a list of guesses.

If there are multiple guesses with the same, highest confidence, the returned guess is any of them.

Parameters

array $guesses An array of guesses

Return Value

Guess|null

at line 87
__construct(int $confidence)

Parameters

int $confidence The confidence

Exceptions

InvalidArgumentException if the given value of confidence is unknown

at line 103
int getConfidence()

Returns the confidence that the guessed value is correct.

Return Value

int One of the constants VERY_HIGH_CONFIDENCE, HIGH_CONFIDENCE, MEDIUM_CONFIDENCE and LOW_CONFIDENCE