The cl-opsresearch Reference Manual

This is the cl-opsresearch Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:30:52 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-opsresearch

Common Lisp library for Operations Research.

Author

Donald Anderson <>

License

GPL3

Dependency

cffi (system).

Source

cl-opsresearch.asd.

Child Components

3 Modules

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


3.1 cl-opsresearch/lisp

Dependency

cl-opsresearch.lisp (file).

Source

cl-opsresearch.asd.

Parent Component

cl-opsresearch (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-opsresearch/cl-opsresearch.asd

Source

cl-opsresearch.asd.

Parent Component

cl-opsresearch (system).

ASDF Systems

cl-opsresearch.


4.1.2 cl-opsresearch/package.lisp

Source

cl-opsresearch.asd.

Parent Component

cl-opsresearch (system).

Packages

4.1.3 cl-opsresearch/cl-opsresearch.lisp

Dependency

package.lisp (file).

Source

cl-opsresearch.asd.

Parent Component

cl-opsresearch (system).


4.1.4 cl-opsresearch/lisp/foreign.lisp

Source

cl-opsresearch.asd.

Parent Component

lisp (module).

Public Interface

with-foreign-alloc (macro).


4.1.5 cl-opsresearch/lisp/problem.lisp

Dependency

foreign.lisp (file).

Source

cl-opsresearch.asd.

Parent Component

lisp (module).

Public Interface

4.1.6 cl-opsresearch/lisp/milp.lisp

Dependency

problem.lisp (file).

Source

cl-opsresearch.asd.

Parent Component

lisp (module).

Public Interface

problem (class).

Internals

5 Packages

Packages are listed by definition order.


5.1 or-cffi

Source

package.lisp.

Use List

common-lisp.

Public Interface

with-foreign-alloc (macro).


5.2 or-milp

Source

package.lisp.

Use List

common-lisp.

Public Interface

problem (class).

Internals

5.3 cl-opsresearch

Source

package.lisp.

Use List

common-lisp.

Public Interface

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: with-foreign-alloc ((var type &rest rest) &body body)
Package

or-cffi.

Source

foreign.lisp.


6.1.2 Generic functions

Generic Function: name-of (problem)
Package

cl-opsresearch.

Source

problem.lisp.

Generic Function: release (problem)
Package

cl-opsresearch.

Source

problem.lisp.


6.1.3 Classes

Class: problem
Package

or-milp.

Source

milp.lisp.

Direct superclasses

problem.

Class: problem
Package

cl-opsresearch.

Source

problem.lisp.

Direct subclasses

problem.


6.2 Internals


6.2.1 Generic functions

Generic Function: read-cplex-lp (problem path)
Package

or-milp.

Source

milp.lisp.

Generic Function: read-mps (problem path &key format)
Package

or-milp.

Source

milp.lisp.

Generic Function: write-cplex-lp (problem path)
Package

or-milp.

Source

milp.lisp.

Generic Function: write-mps (problem path &key format)
Package

or-milp.

Source

milp.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables