Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages | Examples

Printing


Functions

bool vallst_closeChangingSettingFile (VallstInstance *vi)
bool vallst_closeOutTheoryFile (VallstInstance *vi)
FILE * vallst_getChangingSettingFile (VallstInstance *vi)
char * vallst_getChangingSettingFileName (VallstInstance *vi)
bool vallst_getCompleteModel (VallstInstance *vi)
FILE * vallst_getOutTheoryFile (VallstInstance *vi)
char * vallst_getOutTheoryFileName (VallstInstance *vi)
bool vallst_getPrintChangingSetting (VallstInstance *vi)
bool vallst_getPrintOutTheory (VallstInstance *vi)
FILE * vallst_getResultFile (VallstInstance *vi)
char * vallst_getResultFileName (VallstInstance *vi)
VallstVerbosityVector vallst_getVerbosityVector (VallstInstance *vi)
void vallst_hashStateCheck (FILE *f, VallstInstance *vi, bool forcePrint)
bool vallst_printAllGgcditTours (FILE *f, VallstInstance *vi)
bool vallst_printChangingSetting (VallstInstance *vi)
void vallst_printChangingSettingToFile (VallstInstance *vi, FILE *file)
void vallst_printEstimatedPrologues (FILE *f, VallstInstance *vi, VallstLiteralN pNrOfVars)
bool vallst_printGgcditTour (FILE *f, VallstInstance *vi, VallstFormulaName a)
void vallst_printHashInfo (FILE *f, VallstInstance *vi)
void vallst_printModel (FILE *file, VallstInstance *vi)
void vallst_printNrOfUncheckedVars (FILE *f, VallstInstance *vi)
void vallst_printNrOfVarsSet (FILE *f, VallstInstance *vi)
void vallst_printPrologues (FILE *f, VallstInstance *vi)
void vallst_printSettings (FILE *f, VallstInstance *vi, char sep)
bool vallst_printTheory (VallstInstance *vi, VallstFormulaNames *optMax)
void vallst_printTheoryToFile (VallstInstance *vi, FILE *file, VallstFormulaNames *optMax)
void vallst_printTimePassed (FILE *f, VallstInstance *vi)
void vallst_printVallstResult (FILE *f, VallstResult result)
void vallst_setChangingSettingFile (VallstInstance *vi, FILE *f)
void vallst_setChangingSettingFileName (VallstInstance *vi, char *fileName)
void vallst_setCompleteModel (VallstInstance *vi, bool b)
void vallst_setOutTheoryFile (VallstInstance *vi, FILE *f)
void vallst_setOutTheoryFileName (VallstInstance *vi, char *fileName)
void vallst_setPrintChangingSetting (VallstInstance *vi, bool b)
void vallst_setPrintOutTheory (VallstInstance *vi, bool b)
void vallst_setResultFile (VallstInstance *vi, FILE *f)
void vallst_setResultFileName (VallstInstance *vi, char *fileName)
void vallst_setVerbosityLevel (VallstInstance *vi, unsigned int vl)
void vallst_setVerbosityVector (VallstInstance *vi, VallstVerbosityVector vv)

Function Documentation

bool vallst_closeChangingSettingFile VallstInstance vi  ) 
 

Closes the changing-setting file, if it isn't stdout. Will however *not* reset the changing-setting file *name*. Returns true iff fclose returned an error (EOF). Also sets the changing-setting file to NULL.

Examples:
vallst.c.

bool vallst_closeOutTheoryFile VallstInstance vi  ) 
 

Closes the out-theory file, if it isn't stdout. Will however *not* reset the out-theory file *name*. Returns true iff fclose returned an error (EOF). Also sets the out-theory file to NULL.

Examples:
vallst.c.

FILE* vallst_getChangingSettingFile VallstInstance vi  ) 
 

Returns the changing-setting file.

If the changing setting is printed it goes to this file. See vallst_printChangingSetting().

char* vallst_getChangingSettingFileName VallstInstance vi  ) 
 

Returns the changing-setting file name.

bool vallst_getCompleteModel VallstInstance vi  ) 
 

Returns the complete-model flag determining if partial models will be printed as non-partial. See vallst_printModel().

FILE* vallst_getOutTheoryFile VallstInstance vi  ) 
 

Returns the out-theory file.

If the theory is printed it goes to this file. See vallst_printTheory().

char* vallst_getOutTheoryFileName VallstInstance vi  ) 
 

Returns the out-theory file name.

bool vallst_getPrintChangingSetting VallstInstance vi  ) 
 

Returns the print-changing-setting flag.

If the flag is true, the changing setting will be printed at time-out and at interupt. See vallst_printChangingSetting().

Examples:
vallst.c.

bool vallst_getPrintOutTheory VallstInstance vi  ) 
 

Returns the print-out-theory flag.

If the flag is true, the theory will be printed at time-out and at interupt.

Examples:
vallst.c.

FILE* vallst_getResultFile VallstInstance vi  ) 
 

Returns the result file, to which any model is printed.

Examples:
vallst.c.

char* vallst_getResultFileName VallstInstance vi  ) 
 

Returns the result file name.

VallstVerbosityVector vallst_getVerbosityVector VallstInstance vi  ) 
 

Returns the verbosity vector. See masks for the verbosity vector and VallstVerbosityVector for what each bit means.

Examples:
vallst.c.

void vallst_hashStateCheck FILE *  f,
VallstInstance vi,
bool  forcePrint
 

Prints detailed info about a the hash-table, if the VallstVerbosity_hashDetails flag is set.

If NDEBUG is defined, things will be printed only if forcePrint is true (and the VallstVerbosity_hashDetails flag is set).

Examples:
vallst.c.

bool vallst_printAllGgcditTours FILE *  f,
VallstInstance vi
 

Prints all ggcdit tours. See vallst_printGgcditTour().

Examples:
vallst.c.

bool vallst_printChangingSetting VallstInstance vi  ) 
 

Prints changing settings.

Will print a subset of the settings that typically change during a search. Something like this is what will be printed, on a single line without a newline character ending the line: " --tight-meta-meta-prune-start=5 --tight-meta-meta-prune-end=7 --tight-meta-prune-start=9 --tight-keep-cc-threshold=18 --meta-meta-prune-start=8 --meta-meta-prune-end=12 --meta-prune-start=30 --keep-conflict-clause-length-threshold=47 "

The file printed to will be changing-setting-file-name. If changing-setting-file-name is NULL, the file used will be changing-setting-file. Any previous contents of the file will be discarded if changing-setting-file-name isn't NULL. See vallst_setChangingSettingFile() and vallst_setChangingSettingFileName().

If changing-setting-file-name isn't NULL, that file will be assigned to changing-setting-file. If the file couldn't be opened, true is returned. Otherwise false is returned.

False is returned iff the destination file couldn't be opened.

Examples:
vallst.c.

void vallst_printChangingSettingToFile VallstInstance vi,
FILE *  file
 

Prints the changing setting to file.

void vallst_printEstimatedPrologues FILE *  f,
VallstInstance vi,
VallstLiteralN  pNrOfVars
 

Prints estimated prologue values.

See vallst.c for an example.

Examples:
vallst.c.

bool vallst_printGgcditTour FILE *  f,
VallstInstance vi,
VallstFormulaName  a
 

Prints the current tour corresponding to the formula 'a', where 'a' should be of type VallstFormulaType_ggcdiTour. For example, if the current state corresponds to the tour 0->3->1->2->0, "0 3 1 2 0" will be printed.

Takes linear time in the number of nodes in the graph.

Returns true iff something went wrong, like e.g. if 'a' isn't of the ggcdit type or it's detected that the literals representing the graph don't correspond to a tour.

Note that there is no guarantee that the current state does in fact constitute a tour and no exhaustive check of that fact will be done. The edge state is just printed as it is without any double checks. If you have a model, and everything else is as it should be, then what's printed will be a tour. But if something is askew there is no guarantee that what's printed is correct or a tour and there is no guarantee that the function returns true if there is something wrong.

void vallst_printHashInfo FILE *  f,
VallstInstance vi
 

Prints some, easily obtainable, info about the hash-table.

Examples:
vallst.c.

void vallst_printModel FILE *  file,
VallstInstance vi
 

Prints the current value of the variables to 'file'. The notation used will be DIMACS so that e.g. if the negated variable 7 is true it will be printed as -3. Only true literals are printed.

If 'file' is NULL, the default output result file will be used except when that also is NULL in which case stdout is used.

Open variables, who is not in an equ-class with more than one member, will be printed (as true) if the complete-model flag is true. See vallst_setCompleteModel().

Members of an open equivalence class with more than one member will be printed as having a truth value.

Examples:
vallst.c.

void vallst_printNrOfUncheckedVars FILE *  f,
VallstInstance vi
 

Prints the number of unchecked variables.

void vallst_printNrOfVarsSet FILE *  f,
VallstInstance vi
 

Prints the number of variables that have been given a truth-value.

Examples:
vallst.c.

void vallst_printPrologues FILE *  f,
VallstInstance vi
 

Prints hindsighted prologue values.

See vallst.c for an example.

Examples:
vallst.c.

void vallst_printSettings FILE *  f,
VallstInstance vi,
char  sep
 

Prints option settings. sep is used as a separator between options and can e.g. be ' ' (space) or '\n' (newline).

Examples:
vallst.c.

bool vallst_printTheory VallstInstance vi,
VallstFormulaNames optMax
 

Prints the current theory.

The file printed to will be out-theory-file-name. If out-theory-file-name is NULL, the file used will be out-theory-file. Any previous contents of the file will be discarded if out-theory-file-name isn't NULL. See vallst_setOutTheoryFile() and vallst_setOutTheoryFileName().

If out-theory-file-name isn't NULL, that file will be assigned to out-theory-file. If the file couldn't be opened, true is returned. Otherwise false is returned.

"max" will be augmented to the prints of constraint formulas of type <, <* and <\/ in optMax. This doesn't affect other types of formulas. If optMax is NULL, no "max" will be printed. (Note that a "max" for <\/ might not make much sense.)

Examples:
vallst.c.

void vallst_printTheoryToFile VallstInstance vi,
FILE *  file,
VallstFormulaNames optMax
 

Prints the current theory to file.

"max" will be augmented to the prints of constraint formulas of type <, <* and <\/ in optMax. This doesn't affect other types of formulas. If optMax is NULL, no "max" will be printed. (Note that a "max" for <\/ might not make much sense.)

void vallst_printTimePassed FILE *  f,
VallstInstance vi
 

Prints the cpu time used.

Examples:
vallst.c.

void vallst_printVallstResult FILE *  f,
VallstResult  result
 

Prints to f a short string corresponding to a VallstResult.

Examples:
vallst.c.

void vallst_setChangingSettingFile VallstInstance vi,
FILE *  f
 

Sets the changing-setting file. See vallst_printChangingSetting().

void vallst_setChangingSettingFileName VallstInstance vi,
char *  fileName
 

Sets the changing-setting file name. See vallst_printChangingSetting(). The string will *not* be copied and the pointer (fileName) will be saved.

void vallst_setCompleteModel VallstInstance vi,
bool  b
 

Sets the complete-model flag determining if partial models will be printed as non-partial. See vallst_printModel().

void vallst_setOutTheoryFile VallstInstance vi,
FILE *  f
 

Sets the out-theory file. See vallst_printTheory().

void vallst_setOutTheoryFileName VallstInstance vi,
char *  fileName
 

Sets the out-theory file name. See vallst_printTheory(). The string will *not* be copied and the pointer (fileName) will be saved.

void vallst_setPrintChangingSetting VallstInstance vi,
bool  b
 

Sets the print-changing-setting flag.

If the flag is true, the changing setting will be printed at time-out and at interupt.

void vallst_setPrintOutTheory VallstInstance vi,
bool  b
 

Sets the print-out-theory flag.

If the flag is true, the theory will be printed at time-out and at interupt.

void vallst_setResultFile VallstInstance vi,
FILE *  f
 

Sets the result file, to which any model is printed.

void vallst_setResultFileName VallstInstance vi,
char *  fileName
 

Sets the result file name. The string will *not* be copied and the pointer (fileName) will be saved.

void vallst_setVerbosityLevel VallstInstance vi,
unsigned int  vl
 

Sets the verbosity level. 0 is quiet; only some error messages are printed. 99 is maximally verbose. What this function does is to set the verbosity vector to something seemingly appropriate. If you want to fine-tune, use vallst_setVerbosityVector().

void vallst_setVerbosityVector VallstInstance vi,
VallstVerbosityVector  vv
 

Sets the verbosity vector to vv. 0 is quiet; only some error messages is printed. See masks for the verbosity vector and VallstVerbosityVector for what each bit means.


Copyright (C) 2004-2005 Daniel Vallstrom. See the various vallst files for license notices.

Generated on Mon Jul 18 11:34:15 2005 for Vallst by doxygen 1.4.3.