20.01.2013 Views

Kombilo Documentation Release 0.7.4 Ulrich Goertz - Bitbucket

Kombilo Documentation Release 0.7.4 Ulrich Goertz - Bitbucket

Kombilo Documentation Release 0.7.4 Ulrich Goertz - Bitbucket

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

filename<br />

sgf (the full SFG source).<br />

<strong>Kombilo</strong> <strong>Documentation</strong>, <strong>Release</strong> <strong>0.7.4</strong><br />

gameinfoSearchNC(query)<br />

Returns the number of games matching the given query (see gameinfoSearch() for the format of the<br />

query) without changing the list of current games.<br />

loadDBs(progBar=None, showwarning=None)<br />

Load the database files for all databases that were added to the gamelist.<br />

parseReferencesFile(datafile, options=None)<br />

Parse a file with references to commentaries in the literature. See the file src/data/references for<br />

the file format.<br />

The method builds up self.gamelist.references, a dictionary which for each Dyer signature has<br />

a list of all references for the corresponding game.<br />

patternSearch(CSP, SO=None, CL=’ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz123456789’,<br />

FL={}, progBar=None)<br />

Start a pattern search on the current game list.<br />

•CSP must be an instance of Pattern - it is the pattern that is searched for.<br />

•You can specify search options as SO - this must be an instance of lk.SearchOptions (see below).<br />

•CL, FL, progBar are used with the <strong>Kombilo</strong> GUI.<br />

Search options. Create an instance of lk.SearchOptions by<br />

so = lk.SearchOptions<br />

You can then set particular options on so, e.g.:<br />

so.fixedColor = 1<br />

so.searchInVariations = false<br />

Available options:<br />

•fixedColor, values: 0 = also search for pattern with colors reversed; 1 = fix colors as given in pattern;<br />

default value is 0<br />

•nextMove, values: 0 either player moves next, 1 = next move must be black, 2 = next move must be<br />

white; default value is 0<br />

•moveLimit, positive integer; pattern must occur at this move in the game or earlier; default value is<br />

10000<br />

•trustHashFull, boolean, values: true = do not use ALGO_MOVELIST to confirm a hit given by<br />

ALGO_HASH_FULL, false = use ALGO_MOVELIST to confirm it; default value is false<br />

•searchInVariations, boolean; default value is true<br />

•algos, an integer which specifies which algorithms should be used; in practice, use one of the following:<br />

lk.ALGO_FINALPOS | lk.ALGO_MOVELIST<br />

lk.ALGO_FINALPOS | lk.ALGO_MOVELIST | lk.ALGO_HASH_FULL<br />

lk.ALGO_FINALPOS | lk.ALGO_MOVELIST | lk.ALGO_HASH_FULL | lk.ALGO_HASH_CORNER<br />

The default is to use all available algorithms.<br />

patternSearchDetails(exportMode=’ascii’, showAllCont=False)<br />

Returns a string with information on the most recent pattern search.<br />

signatureSearch(sig)<br />

Do a signature search for the Dyer signature sig.<br />

4.3. API 43

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!