Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The cl-opsresearch Reference Manual

This is the cl-opsresearch Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:32:49 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The cl-opsresearch Reference Manual, Up: The cl-opsresearch Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The cl-opsresearch Reference Manual [Contents][Index]

2 Systems

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

cl-opsresearch

Previous: Systems, Up: Systems [Contents][Index]

2.1 `cl-opsresearch`

Common Lisp library for Operations Research.

Author

Donald Anderson <dranderson@OpsResearch.com>

License

GPL3

Dependency

cffi (system).

Source

cl-opsresearch.asd.

Child Components

package.lisp (file).
cl-opsresearch.lisp (file).
lisp (module).

Next: Files, Previous: Systems, Up: The cl-opsresearch Reference Manual [Contents][Index]

3 Modules

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

cl-opsresearch/lisp

Previous: Modules, Up: Modules [Contents][Index]

3.1 `cl-opsresearch/lisp`

Dependency

cl-opsresearch.lisp (file).

Source

cl-opsresearch.asd.

Parent Component

cl-opsresearch (system).

Child Components

foreign.lisp (file).
problem.lisp (file).
milp.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-opsresearch Reference Manual [Contents][Index]

4 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

4.1 Lisp

cl-opsresearch/cl-opsresearch.asd
cl-opsresearch/package.lisp
cl-opsresearch/cl-opsresearch.lisp
cl-opsresearch/lisp/foreign.lisp
cl-opsresearch/lisp/problem.lisp
cl-opsresearch/lisp/milp.lisp

Next: cl-opsresearch/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-opsresearch/cl-opsresearch.asd`

Source: cl-opsresearch.asd.
Parent Component: cl-opsresearch (system).
ASDF Systems: cl-opsresearch.

Next: cl-opsresearch/cl-opsresearch.lisp, Previous: cl-opsresearch/cl-opsresearch.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-opsresearch/package.lisp`

Source

cl-opsresearch.asd.

Parent Component

cl-opsresearch (system).

Packages

cl-opsresearch.
or-milp.
or-cffi.

Next: cl-opsresearch/lisp/foreign.lisp, Previous: cl-opsresearch/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-opsresearch/cl-opsresearch.lisp`

Dependency: package.lisp (file).
Source: cl-opsresearch.asd.
Parent Component: cl-opsresearch (system).

Next: cl-opsresearch/lisp/problem.lisp, Previous: cl-opsresearch/cl-opsresearch.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-opsresearch/lisp/foreign.lisp`

Source: cl-opsresearch.asd.
Parent Component: lisp (module).
Public Interface: with-foreign-alloc (macro).

Next: cl-opsresearch/lisp/milp.lisp, Previous: cl-opsresearch/lisp/foreign.lisp, Up: Lisp [Contents][Index]

4.1.5 `cl-opsresearch/lisp/problem.lisp`

Dependency

foreign.lisp (file).

Source

cl-opsresearch.asd.

Parent Component

lisp (module).

Public Interface

name-of (generic function).
problem (class).
release (generic function).

Previous: cl-opsresearch/lisp/problem.lisp, Up: Lisp [Contents][Index]

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

read-cplex-lp (generic function).
read-mps (generic function).
write-cplex-lp (generic function).
write-mps (generic function).

Next: Definitions, Previous: Files, Up: The cl-opsresearch Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-opsresearch
or-milp
or-cffi

Next: or-milp, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-opsresearch`

Source

package.lisp.

Use List

common-lisp.

Public Interface

name-of (generic function).
problem (class).
release (generic function).

Next: or-cffi, Previous: cl-opsresearch, Up: Packages [Contents][Index]

5.2 `or-milp`

Source

package.lisp.

Use List

common-lisp.

Public Interface

problem (class).

Internals

read-cplex-lp (generic function).
read-mps (generic function).
write-cplex-lp (generic function).
write-mps (generic function).

Previous: or-milp, Up: Packages [Contents][Index]

5.3 `or-cffi`

Source: package.lisp.
Use List: common-lisp.
Public Interface: with-foreign-alloc (macro).

Next: Indexes, Previous: Packages, Up: The cl-opsresearch Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

6.1 Public Interface

Macros
Generic functions
Classes

Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Macros

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

Package: or-cffi.
Source: foreign.lisp.

Next: Classes, Previous: Macros, Up: Public Interface [Contents][Index]

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.

Previous: Generic functions, Up: Public Interface [Contents][Index]

6.1.3 Classes

Class: problem ¶

Package: cl-opsresearch.
Source: problem.lisp.
Direct subclasses: problem.

Class: problem ¶

Package: or-milp.
Source: milp.lisp.
Direct superclasses: problem.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Generic functions

Previous: Internals, Up: Internals [Contents][Index]

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.

Previous: Definitions, Up: The cl-opsresearch Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	G M N R W

	Index Entry		Section

G
	`Generic Function, name-of`:		Public generic functions
	`Generic Function, read-cplex-lp`:		Private generic functions
	`Generic Function, read-mps`:		Private generic functions
	`Generic Function, release`:		Public generic functions
	`Generic Function, write-cplex-lp`:		Private generic functions
	`Generic Function, write-mps`:		Private generic functions

M
	`Macro, with-foreign-alloc`:		Public macros

N
	`name-of`:		Public generic functions

R
	`read-cplex-lp`:		Private generic functions
	`read-mps`:		Private generic functions
	`release`:		Public generic functions

W
	`with-foreign-alloc`:		Public macros
	`write-cplex-lp`:		Private generic functions
	`write-mps`:		Private generic functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F L M O P S

	Index Entry		Section

C
	`cl-opsresearch`:		The cl-opsresearch system
	`cl-opsresearch`:		The cl-opsresearch package
	`cl-opsresearch.asd`:		The cl-opsresearch/cl-opsresearch․asd file
	`cl-opsresearch.lisp`:		The cl-opsresearch/cl-opsresearch․lisp file
	`Class, problem`:		Public classes
	`Class, problem`:		Public classes

F
	`File, cl-opsresearch.asd`:		The cl-opsresearch/cl-opsresearch․asd file
	`File, cl-opsresearch.lisp`:		The cl-opsresearch/cl-opsresearch․lisp file
	`File, foreign.lisp`:		The cl-opsresearch/lisp/foreign․lisp file
	`File, milp.lisp`:		The cl-opsresearch/lisp/milp․lisp file
	`File, package.lisp`:		The cl-opsresearch/package․lisp file
	`File, problem.lisp`:		The cl-opsresearch/lisp/problem․lisp file
	`foreign.lisp`:		The cl-opsresearch/lisp/foreign․lisp file

L
	`lisp`:		The cl-opsresearch/lisp module

M
	`milp.lisp`:		The cl-opsresearch/lisp/milp․lisp file
	`Module, lisp`:		The cl-opsresearch/lisp module

O
	`or-cffi`:		The or-cffi package
	`or-milp`:		The or-milp package

P
	`Package, cl-opsresearch`:		The cl-opsresearch package
	`Package, or-cffi`:		The or-cffi package
	`Package, or-milp`:		The or-milp package
	`package.lisp`:		The cl-opsresearch/package․lisp file
	`problem`:		Public classes
	`problem`:		Public classes
	`problem.lisp`:		The cl-opsresearch/lisp/problem․lisp file

S
	`System, cl-opsresearch`:		The cl-opsresearch system