setparam

Sylvain Saucier

void Guess.setparam(uint8 maxdepth, uint8 minresult, uint8 maxresult)

Function used to reset the search parameters to different values. Used in constructor. This function does not invalidate the dictionary.

maxdepth

Maximum depth to search for possible match, the higher the depth the less probable the expected result will be found.
Recommended setting: 5 [1 to 8]

minresult

The library will search for possible match until the number or results are equal or larger then minresult or the depth is equal to maxdepth.
Recommended minimum setting: 25 [1 to 255]
Recommended maximum setting: 100 [1 to 255]

maxresult

The library will return no more than _maxresult when queried.
Recommended minimum setting: 25 [1 to 255]
Recommended maximum setting: 100 [1 to 255]

Notes

In larger dictionaries (5000+ words) the large quantity of possible match introduce noise that need to be filtered out. To do so, the _minresult should be set to a minimum of 50 and _maxdepth should be set to a minimum of 4.