The linear-programming-glpk Reference Manual

This is the linear-programming-glpk Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:45:46 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 linear-programming-glpk

A backend for linear-programming using GLPK

Author

Nei Lindquist <>

Contact

Source Control

(GIT https://github.com/neil-lindquist/linear-programming-gplk.git)

Bug Tracker

https://github.com/neil-lindquist/linear-programming-gplk/issues

License

GPL 3.0

Version

1.0.0

Dependencies
  • cffi (system).
  • linear-programming (system).
Source

linear-programming-glpk.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 linear-programming-glpk/linear-programming-glpk.asd

Source

linear-programming-glpk.asd.

Parent Component

linear-programming-glpk (system).

ASDF Systems

linear-programming-glpk.


3.1.2 linear-programming-glpk/package.lisp

Source

linear-programming-glpk.asd.

Parent Component

linear-programming-glpk (system).

Packages

linear-programming-glpk.


3.1.3 linear-programming-glpk/ffi.lisp

Dependency

package.lisp (file).

Source

linear-programming-glpk.asd.

Parent Component

linear-programming-glpk (system).

Internals

3.1.4 linear-programming-glpk/high-level.lisp

Dependency

ffi.lisp (file).

Source

linear-programming-glpk.asd.

Parent Component

linear-programming-glpk (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 linear-programming-glpk

Source

package.lisp.

Use List
  • cffi.
  • common-lisp.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: glpk-solver
Package

linear-programming-glpk.

Source

high-level.lisp.


5.1.2 Ordinary functions

Function: glpk-solver (problem &key solver-method fp-tolerance enable-presolver pricing method ratio-test ordering-algorithm branching-technique backtracking-technique preprocessing-technique cut-methods message-level &allow-other-keys)

Solves the given linear problem using the GLPK library

Package

linear-programming-glpk.

Source

high-level.lisp.


5.1.3 Standalone methods

Method: solution-objective-value ((solution glpk-solution))
Package

linear-programming/solver.

Source

high-level.lisp.

Method: solution-problem ((solution glpk-solution))
Package

linear-programming/solver.

Source

high-level.lisp.

Method: solution-reduced-cost ((solution glpk-solution) variable)
Package

linear-programming/solver.

Source

high-level.lisp.

Method: solution-variable ((solution glpk-solution) variable)
Package

linear-programming/solver.

Source

high-level.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: %add-cols (problem new-columns)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %add-rows (problem new-rows)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %adv-basis (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %check-dep (m n ne rows cols)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %cpx-basis (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %create-index (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %create-prob ()
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %del-cols (problem number-of-columns columns)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %del-rows (problem number-of-rows rows)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %delete-index (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %delete-prob (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %exact (problem params)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %find-col (problem name)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %find-row (problem name)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-col-dual (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-col-kind (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-col-lb (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-col-name (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-col-prim (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-col-stat (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-col-type (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-col-ub (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-dual-stat (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-mat-col (problem index indices values)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-mat-row (problem index indices values)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-num-bin (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-num-cols (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-num-int (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-num-nz (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-num-rows (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-obj-coef (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-obj-dir (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-obj-name (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-obj-val (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-prim-stat (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-prob-name (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-row-dual (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-row-lb (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-row-name (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-row-prim (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-row-stat (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-row-type (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-row-ub (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %get-status (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %init-iocp (parameters)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %init-iptcp (parameters)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %init-smcp (paramters)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %interior (problem parameters)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %intopt (problem parameters)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %ipt-col-dual (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %ipt-col-prim (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %ipt-obj-val (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %ipt-row-dual (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %ipt-row-prim (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %ipt-status (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %load-matrix (problem number-of-entries rows cols vals)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %mip-col-val (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %mip-obj-val (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %mip-row-val (problem index)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %mip-status (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %scale-prob (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-col-bnds (problem index type lower-bound upper-bound)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-col-kind (problem index kind)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-col-name (problem index name)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-col-stat (problem index status)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-mat-col (problem column-index length row-indices values)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-mat-row (problem row-index length column-indices values)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-obj-coef (problem index coefficient)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-obj-dir (problem direction)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-obj-name (problem name)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-prob-name (problem name)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-row-bnds (problem index type lower-bound upper-bound)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-row-name (problem index name)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %set-row-stat (problem index status)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %simplex (problem params)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %sort-matrix (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %std-basis (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: %unscale-prob (problem)
Package

linear-programming-glpk.

Source

ffi.lisp.

Function: as-glpk-float (num)

Converts a number to a type that CFFI can convert to a C double

Package

linear-programming-glpk.

Source

high-level.lisp.

Function: copy-glpk-solution (instance)
Package

linear-programming-glpk.

Source

high-level.lisp.

Function: glpk-float-type ()
Package

linear-programming-glpk.

Source

high-level.lisp.

Reader: glpk-solution-objective-value (instance)
Writer: (setf glpk-solution-objective-value) (instance)
Package

linear-programming-glpk.

Source

high-level.lisp.

Target Slot

objective-value.

Function: glpk-solution-p (object)
Package

linear-programming-glpk.

Source

high-level.lisp.

Reader: glpk-solution-problem (instance)
Writer: (setf glpk-solution-problem) (instance)
Package

linear-programming-glpk.

Source

high-level.lisp.

Target Slot

problem.

Reader: glpk-solution-solver-mode (instance)
Writer: (setf glpk-solution-solver-mode) (instance)
Package

linear-programming-glpk.

Source

high-level.lisp.

Target Slot

solver-mode.

Reader: glpk-solution-var-index (instance)
Writer: (setf glpk-solution-var-index) (instance)
Package

linear-programming-glpk.

Source

high-level.lisp.

Target Slot

var-index.

Reader: glpk-solution-var-reduced-costs (instance)
Writer: (setf glpk-solution-var-reduced-costs) (instance)
Package

linear-programming-glpk.

Source

high-level.lisp.

Target Slot

var-reduced-costs.

Reader: glpk-solution-var-values (instance)
Writer: (setf glpk-solution-var-values) (instance)
Package

linear-programming-glpk.

Source

high-level.lisp.

Target Slot

var-values.

Function: make-glpk-solution (&key problem solver-mode objective-value var-values var-reduced-costs var-index)
Package

linear-programming-glpk.

Source

high-level.lisp.


5.2.2 Structures

Structure: glpk-solution
Package

linear-programming-glpk.

Source

high-level.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: problem
Readers

glpk-solution-problem.

Writers

(setf glpk-solution-problem).

Slot: solver-mode
Readers

glpk-solution-solver-mode.

Writers

(setf glpk-solution-solver-mode).

Slot: objective-value
Readers

glpk-solution-objective-value.

Writers

(setf glpk-solution-objective-value).

Slot: var-values
Readers

glpk-solution-var-values.

Writers

(setf glpk-solution-var-values).

Slot: var-reduced-costs
Readers

glpk-solution-var-reduced-costs.

Writers

(setf glpk-solution-var-reduced-costs).

Slot: var-index
Readers

glpk-solution-var-index.

Writers

(setf glpk-solution-var-index).


5.2.3 Classes

Class: integer-control-parameters-tclass
Package

linear-programming-glpk.

Source

ffi.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: interior-point-control-parameters-tclass
Package

linear-programming-glpk.

Source

ffi.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: simplex-control-parameters-tclass
Package

linear-programming-glpk.

Source

ffi.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   C   F   G   M   S  
Index Entry  Section

%
%add-cols: Private ordinary functions
%add-rows: Private ordinary functions
%adv-basis: Private ordinary functions
%check-dep: Private ordinary functions
%cpx-basis: Private ordinary functions
%create-index: Private ordinary functions
%create-prob: Private ordinary functions
%del-cols: Private ordinary functions
%del-rows: Private ordinary functions
%delete-index: Private ordinary functions
%delete-prob: Private ordinary functions
%exact: Private ordinary functions
%find-col: Private ordinary functions
%find-row: Private ordinary functions
%get-col-dual: Private ordinary functions
%get-col-kind: Private ordinary functions
%get-col-lb: Private ordinary functions
%get-col-name: Private ordinary functions
%get-col-prim: Private ordinary functions
%get-col-stat: Private ordinary functions
%get-col-type: Private ordinary functions
%get-col-ub: Private ordinary functions
%get-dual-stat: Private ordinary functions
%get-mat-col: Private ordinary functions
%get-mat-row: Private ordinary functions
%get-num-bin: Private ordinary functions
%get-num-cols: Private ordinary functions
%get-num-int: Private ordinary functions
%get-num-nz: Private ordinary functions
%get-num-rows: Private ordinary functions
%get-obj-coef: Private ordinary functions
%get-obj-dir: Private ordinary functions
%get-obj-name: Private ordinary functions
%get-obj-val: Private ordinary functions
%get-prim-stat: Private ordinary functions
%get-prob-name: Private ordinary functions
%get-row-dual: Private ordinary functions
%get-row-lb: Private ordinary functions
%get-row-name: Private ordinary functions
%get-row-prim: Private ordinary functions
%get-row-stat: Private ordinary functions
%get-row-type: Private ordinary functions
%get-row-ub: Private ordinary functions
%get-status: Private ordinary functions
%init-iocp: Private ordinary functions
%init-iptcp: Private ordinary functions
%init-smcp: Private ordinary functions
%interior: Private ordinary functions
%intopt: Private ordinary functions
%ipt-col-dual: Private ordinary functions
%ipt-col-prim: Private ordinary functions
%ipt-obj-val: Private ordinary functions
%ipt-row-dual: Private ordinary functions
%ipt-row-prim: Private ordinary functions
%ipt-status: Private ordinary functions
%load-matrix: Private ordinary functions
%mip-col-val: Private ordinary functions
%mip-obj-val: Private ordinary functions
%mip-row-val: Private ordinary functions
%mip-status: Private ordinary functions
%scale-prob: Private ordinary functions
%set-col-bnds: Private ordinary functions
%set-col-kind: Private ordinary functions
%set-col-name: Private ordinary functions
%set-col-stat: Private ordinary functions
%set-mat-col: Private ordinary functions
%set-mat-row: Private ordinary functions
%set-obj-coef: Private ordinary functions
%set-obj-dir: Private ordinary functions
%set-obj-name: Private ordinary functions
%set-prob-name: Private ordinary functions
%set-row-bnds: Private ordinary functions
%set-row-name: Private ordinary functions
%set-row-stat: Private ordinary functions
%simplex: Private ordinary functions
%sort-matrix: Private ordinary functions
%std-basis: Private ordinary functions
%unscale-prob: Private ordinary functions

(
(setf glpk-solution-objective-value): Private ordinary functions
(setf glpk-solution-problem): Private ordinary functions
(setf glpk-solution-solver-mode): Private ordinary functions
(setf glpk-solution-var-index): Private ordinary functions
(setf glpk-solution-var-reduced-costs): Private ordinary functions
(setf glpk-solution-var-values): Private ordinary functions

A
as-glpk-float: Private ordinary functions

C
copy-glpk-solution: Private ordinary functions

F
Function, %add-cols: Private ordinary functions
Function, %add-rows: Private ordinary functions
Function, %adv-basis: Private ordinary functions
Function, %check-dep: Private ordinary functions
Function, %cpx-basis: Private ordinary functions
Function, %create-index: Private ordinary functions
Function, %create-prob: Private ordinary functions
Function, %del-cols: Private ordinary functions
Function, %del-rows: Private ordinary functions
Function, %delete-index: Private ordinary functions
Function, %delete-prob: Private ordinary functions
Function, %exact: Private ordinary functions
Function, %find-col: Private ordinary functions
Function, %find-row: Private ordinary functions
Function, %get-col-dual: Private ordinary functions
Function, %get-col-kind: Private ordinary functions
Function, %get-col-lb: Private ordinary functions
Function, %get-col-name: Private ordinary functions
Function, %get-col-prim: Private ordinary functions
Function, %get-col-stat: Private ordinary functions
Function, %get-col-type: Private ordinary functions
Function, %get-col-ub: Private ordinary functions
Function, %get-dual-stat: Private ordinary functions
Function, %get-mat-col: Private ordinary functions
Function, %get-mat-row: Private ordinary functions
Function, %get-num-bin: Private ordinary functions
Function, %get-num-cols: Private ordinary functions
Function, %get-num-int: Private ordinary functions
Function, %get-num-nz: Private ordinary functions
Function, %get-num-rows: Private ordinary functions
Function, %get-obj-coef: Private ordinary functions
Function, %get-obj-dir: Private ordinary functions
Function, %get-obj-name: Private ordinary functions
Function, %get-obj-val: Private ordinary functions
Function, %get-prim-stat: Private ordinary functions
Function, %get-prob-name: Private ordinary functions
Function, %get-row-dual: Private ordinary functions
Function, %get-row-lb: Private ordinary functions
Function, %get-row-name: Private ordinary functions
Function, %get-row-prim: Private ordinary functions
Function, %get-row-stat: Private ordinary functions
Function, %get-row-type: Private ordinary functions
Function, %get-row-ub: Private ordinary functions
Function, %get-status: Private ordinary functions
Function, %init-iocp: Private ordinary functions
Function, %init-iptcp: Private ordinary functions
Function, %init-smcp: Private ordinary functions
Function, %interior: Private ordinary functions
Function, %intopt: Private ordinary functions
Function, %ipt-col-dual: Private ordinary functions
Function, %ipt-col-prim: Private ordinary functions
Function, %ipt-obj-val: Private ordinary functions
Function, %ipt-row-dual: Private ordinary functions
Function, %ipt-row-prim: Private ordinary functions
Function, %ipt-status: Private ordinary functions
Function, %load-matrix: Private ordinary functions
Function, %mip-col-val: Private ordinary functions
Function, %mip-obj-val: Private ordinary functions
Function, %mip-row-val: Private ordinary functions
Function, %mip-status: Private ordinary functions
Function, %scale-prob: Private ordinary functions
Function, %set-col-bnds: Private ordinary functions
Function, %set-col-kind: Private ordinary functions
Function, %set-col-name: Private ordinary functions
Function, %set-col-stat: Private ordinary functions
Function, %set-mat-col: Private ordinary functions
Function, %set-mat-row: Private ordinary functions
Function, %set-obj-coef: Private ordinary functions
Function, %set-obj-dir: Private ordinary functions
Function, %set-obj-name: Private ordinary functions
Function, %set-prob-name: Private ordinary functions
Function, %set-row-bnds: Private ordinary functions
Function, %set-row-name: Private ordinary functions
Function, %set-row-stat: Private ordinary functions
Function, %simplex: Private ordinary functions
Function, %sort-matrix: Private ordinary functions
Function, %std-basis: Private ordinary functions
Function, %unscale-prob: Private ordinary functions
Function, (setf glpk-solution-objective-value): Private ordinary functions
Function, (setf glpk-solution-problem): Private ordinary functions
Function, (setf glpk-solution-solver-mode): Private ordinary functions
Function, (setf glpk-solution-var-index): Private ordinary functions
Function, (setf glpk-solution-var-reduced-costs): Private ordinary functions
Function, (setf glpk-solution-var-values): Private ordinary functions
Function, as-glpk-float: Private ordinary functions
Function, copy-glpk-solution: Private ordinary functions
Function, glpk-float-type: Private ordinary functions
Function, glpk-solution-objective-value: Private ordinary functions
Function, glpk-solution-p: Private ordinary functions
Function, glpk-solution-problem: Private ordinary functions
Function, glpk-solution-solver-mode: Private ordinary functions
Function, glpk-solution-var-index: Private ordinary functions
Function, glpk-solution-var-reduced-costs: Private ordinary functions
Function, glpk-solution-var-values: Private ordinary functions
Function, glpk-solver: Public ordinary functions
Function, make-glpk-solution: Private ordinary functions

G
glpk-float-type: Private ordinary functions
glpk-solution-objective-value: Private ordinary functions
glpk-solution-p: Private ordinary functions
glpk-solution-problem: Private ordinary functions
glpk-solution-solver-mode: Private ordinary functions
glpk-solution-var-index: Private ordinary functions
glpk-solution-var-reduced-costs: Private ordinary functions
glpk-solution-var-values: Private ordinary functions
glpk-solver: Public ordinary functions

M
make-glpk-solution: Private ordinary functions
Method, solution-objective-value: Public standalone methods
Method, solution-problem: Public standalone methods
Method, solution-reduced-cost: Public standalone methods
Method, solution-variable: Public standalone methods

S
solution-objective-value: Public standalone methods
solution-problem: Public standalone methods
solution-reduced-cost: Public standalone methods
solution-variable: Public standalone methods