The cl-maxsat Reference Manual

This is the cl-maxsat Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:13:56 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-maxsat

Common Lisp API to MAX-SAT Solvers

Author

Masataro Asai

Contact

License

LGPL

Version

0.1

Dependencies
  • cl-sat (system).
  • trivia (system).
  • alexandria (system).
  • iterate (system).
Source

cl-maxsat.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-maxsat/src

Source

cl-maxsat.asd.

Parent Component

cl-maxsat (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 cl-maxsat/cl-maxsat.asd

Source

cl-maxsat.asd.

Parent Component

cl-maxsat (system).

ASDF Systems

cl-maxsat.


4.1.2 cl-maxsat/src/0-package.lisp

Source

cl-maxsat.asd.

Parent Component

src (module).

Packages

cl-maxsat.


4.1.3 cl-maxsat/src/2-class.lisp

Source

cl-maxsat.asd.

Parent Component

src (module).

Public Interface

4.1.4 cl-maxsat/src/3-dimacs.lisp

Source

cl-maxsat.asd.

Parent Component

src (module).

Public Interface

4.1.5 cl-maxsat/src/4-competition.lisp

Source

cl-maxsat.asd.

Parent Component

src (module).

Public Interface

print-object (method).

Internals

5 Packages

Packages are listed by definition order.


5.1 cl-maxsat

Source

0-package.lisp.

Use List
  • alexandria.
  • cl-sat.
  • common-lisp.
  • iterate.
  • trivia.level2.
Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Ordinary functions

Function: parse-wdimacs-output (file instance)
Package

cl-maxsat.

Source

3-dimacs.lisp.

Function: print-wcnf (instance &optional stream *verbosity*)
Package

cl-maxsat.

Source

3-dimacs.lisp.


6.1.2 Generic functions

Generic Reader: soft-clauses (object)
Package

cl-maxsat.

Methods
Reader Method: soft-clauses ((maxsat-instance maxsat-instance))

automatically generated reader method

Source

2-class.lisp.

Target Slot

soft-clauses.


6.1.3 Standalone methods

Method: initialize-instance ((i maxsat-instance) &rest args &key converter soft-clauses &allow-other-keys)
Source

2-class.lisp.

Method: print-object ((c competition-setup-error) s)
Source

4-competition.lisp.

Method: solve ((*instance* maxsat-instance) solver &rest args &key debug &allow-other-keys)
Package

cl-sat.

Source

2-class.lisp.

Method: variables ((instance maxsat-instance))
Package

cl-sat.

Source

2-class.lisp.


6.1.4 Classes

Class: maxsat-instance
Package

cl-maxsat.

Source

2-class.lisp.

Direct superclasses

sat-instance.

Direct methods
Direct slots
Slot: soft-clauses
Initargs

:soft-clauses

Readers

soft-clauses.

Writers

This slot is read-only.


6.2 Internals


6.2.1 Special variables

Special Variable: *base-url*
Package

cl-maxsat.

Source

4-competition.lisp.


6.2.2 Ordinary functions

Function: cmd (command &rest format-args)

returns a status code, signal errors for non-0 return code

Package

cl-maxsat.

Source

4-competition.lisp.

Function: cmd* (command &rest format-args)

returns a status code, ignores error status

Package

cl-maxsat.

Source

4-competition.lisp.

Function: cmd*/s (command &rest format-args)

returns a string, ignores error status.
This is only for the ’light’ routines as the process may not be terminated properly.

Package

cl-maxsat.

Source

4-competition.lisp.

Function: cmd/s (command &rest format-args)

returns a string, signal errors for non-0 return code.
This is only for the ’light’ routines as the process may not be terminated properly.

Package

cl-maxsat.

Source

4-competition.lisp.

Function: detect-cplex ()
Package

cl-maxsat.

Source

4-competition.lisp.

Function: download-and-extract (year track name)
Package

cl-maxsat.

Source

4-competition.lisp.

Function: rel (directory)
Package

cl-maxsat.

Source

4-competition.lisp.


6.2.3 Generic functions

Generic Function: download-and-run-solver (year track name input dir result)

Returns function

Package

cl-maxsat.

Source

4-competition.lisp.

Methods
Method: download-and-run-solver ((year (eql 2017)) (track (eql :incomplete)) (name (eql :maxhs-inc)) input dir result)
Method: download-and-run-solver ((year (eql 2017)) (track (eql :incomplete)) (name (eql :lmhs-inc)) input dir result)
Method: download-and-run-solver ((year (eql 2017)) (track (eql :incomplete)) (name (eql :open-wbo-lsu)) input dir result)
Method: download-and-run-solver ((year (eql 2017)) (track (eql :complete)) (name (eql :qmaxsatuc)) input dir result)
Method: download-and-run-solver ((year (eql 2017)) (track (eql :complete)) (name (eql :qmaxsat)) input dir result)
Method: download-and-run-solver ((year (eql 2017)) (track (eql :complete)) (name (eql :maxino)) input dir result)
Method: download-and-run-solver ((year (eql 2017)) (track (eql :complete)) (name (eql :open-wbo)) input dir result)
Method: download-and-run-solver ((year (eql 2017)) (track (eql :complete)) (name (eql :maxhs)) input dir result)
Method: download-and-run-solver ((year (eql 2017)) (track (eql :complete)) (name (eql :lmhs)) input dir result)

6.2.4 Conditions

Condition: build-error
Package

cl-maxsat.

Source

4-competition.lisp.

Direct superclasses

competition-setup-error.

Condition: chmod-error
Package

cl-maxsat.

Source

4-competition.lisp.

Direct superclasses

competition-setup-error.

Condition: competition-setup-error
Package

cl-maxsat.

Source

4-competition.lisp.

Direct superclasses

error.

Direct subclasses
Direct methods

print-object.

Direct slots
Slot: year
Initargs

:year

Slot: track
Initargs

:track

Slot: name
Initargs

:name

Condition: download-error
Package

cl-maxsat.

Source

4-competition.lisp.

Direct superclasses

competition-setup-error.

Condition: no-cplex-error
Package

cl-maxsat.

Source

4-competition.lisp.

Direct superclasses

error.

Condition: unzip-error
Package

cl-maxsat.

Source

4-competition.lisp.

Direct superclasses

competition-setup-error.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   D   F   G   I   M   P   R   S   V  
Index Entry  Section

C
cmd: Private ordinary functions
cmd*: Private ordinary functions
cmd*/s: Private ordinary functions
cmd/s: Private ordinary functions

D
detect-cplex: Private ordinary functions
download-and-extract: Private ordinary functions
download-and-run-solver: Private generic functions
download-and-run-solver: Private generic functions
download-and-run-solver: Private generic functions
download-and-run-solver: Private generic functions
download-and-run-solver: Private generic functions
download-and-run-solver: Private generic functions
download-and-run-solver: Private generic functions
download-and-run-solver: Private generic functions
download-and-run-solver: Private generic functions
download-and-run-solver: Private generic functions

F
Function, cmd: Private ordinary functions
Function, cmd*: Private ordinary functions
Function, cmd*/s: Private ordinary functions
Function, cmd/s: Private ordinary functions
Function, detect-cplex: Private ordinary functions
Function, download-and-extract: Private ordinary functions
Function, parse-wdimacs-output: Public ordinary functions
Function, print-wcnf: Public ordinary functions
Function, rel: Private ordinary functions

G
Generic Function, download-and-run-solver: Private generic functions
Generic Function, soft-clauses: Public generic functions

I
initialize-instance: Public standalone methods

M
Method, download-and-run-solver: Private generic functions
Method, download-and-run-solver: Private generic functions
Method, download-and-run-solver: Private generic functions
Method, download-and-run-solver: Private generic functions
Method, download-and-run-solver: Private generic functions
Method, download-and-run-solver: Private generic functions
Method, download-and-run-solver: Private generic functions
Method, download-and-run-solver: Private generic functions
Method, download-and-run-solver: Private generic functions
Method, initialize-instance: Public standalone methods
Method, print-object: Public standalone methods
Method, soft-clauses: Public generic functions
Method, solve: Public standalone methods
Method, variables: Public standalone methods

P
parse-wdimacs-output: Public ordinary functions
print-object: Public standalone methods
print-wcnf: Public ordinary functions

R
rel: Private ordinary functions

S
soft-clauses: Public generic functions
soft-clauses: Public generic functions
solve: Public standalone methods

V
variables: Public standalone methods


A.4 Data types

Jump to:   0   2   3   4  
B   C   D   F   M   N   P   S   U  
Index Entry  Section

0
0-package.lisp: The cl-maxsat/src/0-package․lisp file

2
2-class.lisp: The cl-maxsat/src/2-class․lisp file

3
3-dimacs.lisp: The cl-maxsat/src/3-dimacs․lisp file

4
4-competition.lisp: The cl-maxsat/src/4-competition․lisp file

B
build-error: Private conditions

C
chmod-error: Private conditions
cl-maxsat: The cl-maxsat system
cl-maxsat: The cl-maxsat package
cl-maxsat.asd: The cl-maxsat/cl-maxsat․asd file
Class, maxsat-instance: Public classes
competition-setup-error: Private conditions
Condition, build-error: Private conditions
Condition, chmod-error: Private conditions
Condition, competition-setup-error: Private conditions
Condition, download-error: Private conditions
Condition, no-cplex-error: Private conditions
Condition, unzip-error: Private conditions

D
download-error: Private conditions

F
File, 0-package.lisp: The cl-maxsat/src/0-package․lisp file
File, 2-class.lisp: The cl-maxsat/src/2-class․lisp file
File, 3-dimacs.lisp: The cl-maxsat/src/3-dimacs․lisp file
File, 4-competition.lisp: The cl-maxsat/src/4-competition․lisp file
File, cl-maxsat.asd: The cl-maxsat/cl-maxsat․asd file

M
maxsat-instance: Public classes
Module, src: The cl-maxsat/src module

N
no-cplex-error: Private conditions

P
Package, cl-maxsat: The cl-maxsat package

S
src: The cl-maxsat/src module
System, cl-maxsat: The cl-maxsat system

U
unzip-error: Private conditions