The cl-opsresearch Reference Manual

Table of Contents

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

The cl-opsresearch Reference Manual

This is the cl-opsresearch Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:27:52 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-opsresearch

A Lisp system for distributed processing using native machine learning and analytics packages:

Tested with SBCL and ABCL.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 cl-opsresearch

Author

Donald Anderson <dranderson@OpsResearch.com>

License

GPL3

Description

Common Lisp library for Operations Research.

Dependency

cffi

Source

cl-opsresearch.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


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

3.1 cl-opsresearch/lisp

Dependency

cl-opsresearch.lisp (file)

Parent

cl-opsresearch (system)

Location

lisp/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


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

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-opsresearch.asd

Location

cl-opsresearch.asd

Systems

cl-opsresearch (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 cl-opsresearch/package.lisp

Parent

cl-opsresearch (system)

Location

package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 cl-opsresearch/cl-opsresearch.lisp

Dependency

package.lisp (file)

Parent

cl-opsresearch (system)

Location

cl-opsresearch.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 cl-opsresearch/lisp/foreign.lisp

Parent

lisp (module)

Location

lisp/foreign.lisp

Exported Definitions

with-foreign-alloc (macro)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 cl-opsresearch/lisp/problem.lisp

Dependency

foreign.lisp (file)

Parent

lisp (module)

Location

lisp/problem.lisp

Exported Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.6 cl-opsresearch/lisp/milp.lisp

Dependency

problem.lisp (file)

Parent

lisp (module)

Location

lisp/milp.lisp

Exported Definitions

problem (class)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 or-milp

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

problem (class)

Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.2 or-cffi

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

with-foreign-alloc (macro)


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

5.3 cl-opsresearch

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Macros

Macro: with-foreign-alloc (VAR TYPE &rest REST) &body BODY
Package

or-cffi

Source

foreign.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Generic functions

Generic Function: name-of PROBLEM
Package

cl-opsresearch

Source

problem.lisp (file)

Generic Function: release PROBLEM
Package

cl-opsresearch

Source

problem.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Classes

Class: problem ()
Package

or-milp

Source

milp.lisp (file)

Direct superclasses

problem (class)

Class: problem ()
Package

cl-opsresearch

Source

problem.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

problem (class)


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

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Generic functions

Generic Function: read-cplex-lp PROBLEM PATH
Package

or-milp

Source

milp.lisp (file)

Generic Function: read-mps PROBLEM PATH &key FORMAT
Package

or-milp

Source

milp.lisp (file)

Generic Function: write-cplex-lp PROBLEM PATH
Package

or-milp

Source

milp.lisp (file)

Generic Function: write-mps PROBLEM PATH &key FORMAT
Package

or-milp

Source

milp.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-opsresearch.asd: The cl-opsresearch<dot>asd file
cl-opsresearch/cl-opsresearch.lisp: The cl-opsresearch/cl-opsresearch<dot>lisp file
cl-opsresearch/lisp: The cl-opsresearch/lisp module
cl-opsresearch/lisp/foreign.lisp: The cl-opsresearch/lisp/foreign<dot>lisp file
cl-opsresearch/lisp/milp.lisp: The cl-opsresearch/lisp/milp<dot>lisp file
cl-opsresearch/lisp/problem.lisp: The cl-opsresearch/lisp/problem<dot>lisp file
cl-opsresearch/package.lisp: The cl-opsresearch/package<dot>lisp file

F
File, Lisp, cl-opsresearch.asd: The cl-opsresearch<dot>asd file
File, Lisp, cl-opsresearch/cl-opsresearch.lisp: The cl-opsresearch/cl-opsresearch<dot>lisp file
File, Lisp, cl-opsresearch/lisp/foreign.lisp: The cl-opsresearch/lisp/foreign<dot>lisp file
File, Lisp, cl-opsresearch/lisp/milp.lisp: The cl-opsresearch/lisp/milp<dot>lisp file
File, Lisp, cl-opsresearch/lisp/problem.lisp: The cl-opsresearch/lisp/problem<dot>lisp file
File, Lisp, cl-opsresearch/package.lisp: The cl-opsresearch/package<dot>lisp file

L
Lisp File, cl-opsresearch.asd: The cl-opsresearch<dot>asd file
Lisp File, cl-opsresearch/cl-opsresearch.lisp: The cl-opsresearch/cl-opsresearch<dot>lisp file
Lisp File, cl-opsresearch/lisp/foreign.lisp: The cl-opsresearch/lisp/foreign<dot>lisp file
Lisp File, cl-opsresearch/lisp/milp.lisp: The cl-opsresearch/lisp/milp<dot>lisp file
Lisp File, cl-opsresearch/lisp/problem.lisp: The cl-opsresearch/lisp/problem<dot>lisp file
Lisp File, cl-opsresearch/package.lisp: The cl-opsresearch/package<dot>lisp file

M
Module, cl-opsresearch/lisp: The cl-opsresearch/lisp module

Jump to:   C   F   L   M  

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

A.2 Functions

Jump to:   G   M   N   R   W  
Index Entry  Section

G
Generic Function, name-of: Exported generic functions
Generic Function, read-cplex-lp: Internal generic functions
Generic Function, read-mps: Internal generic functions
Generic Function, release: Exported generic functions
Generic Function, write-cplex-lp: Internal generic functions
Generic Function, write-mps: Internal generic functions

M
Macro, with-foreign-alloc: Exported macros

N
name-of: Exported generic functions

R
read-cplex-lp: Internal generic functions
read-mps: Internal generic functions
release: Exported generic functions

W
with-foreign-alloc: Exported macros
write-cplex-lp: Internal generic functions
write-mps: Internal generic functions

Jump to:   G   M   N   R   W  

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

A.3 Variables


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

A.4 Data types

Jump to:   C   O   P   S  
Index Entry  Section

C
cl-opsresearch: The cl-opsresearch system
cl-opsresearch: The cl-opsresearch package
Class, problem: Exported classes
Class, problem: Exported classes

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
problem: Exported classes
problem: Exported classes

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

Jump to:   C   O   P   S