The clnuplot Reference Manual

This is the clnuplot Reference Manual, version 0.2.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:47:59 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 clnuplot

Common Lisp interface to GNUPlot.

Maintainer

Gary Warren King <>

Author

Gary Warren King <>

License

MIT License

Version

0.2.2

Dependencies
  • cl-containers (system).
  • cl-mathstats (system).
  • metabang-bind (system).
  • trivial-shell (system).
Source

clnuplot.asd.

Child Component

dev (module).


2 Modules

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


2.1 clnuplot/dev

Source

clnuplot.asd.

Parent Component

clnuplot (system).

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 clnuplot/clnuplot.asd

Source

clnuplot.asd.

Parent Component

clnuplot (system).

ASDF Systems

clnuplot.

Packages

clnuplot-system.


3.1.2 clnuplot/dev/package.lisp

Source

clnuplot.asd.

Parent Component

dev (module).

Packages

clnuplot.


3.1.3 clnuplot/dev/utilities.lisp

Dependency

package.lisp (file).

Source

clnuplot.asd.

Parent Component

dev (module).

Internals

3.1.4 clnuplot/dev/plots.lisp

Dependency

utilities.lisp (file).

Source

clnuplot.asd.

Parent Component

dev (module).

Public Interface
Internals

3.1.5 clnuplot/dev/roc-curves.lisp

Dependency

plots.lisp (file).

Source

clnuplot.asd.

Parent Component

dev (module).

Public Interface

3.1.6 clnuplot/dev/plot-window.lisp

Dependency

plots.lisp (file).

Source

clnuplot.asd.

Parent Component

dev (module).

Public Interface
Internals

execute-plot (function).


3.2 Static


3.2.1 clnuplot/dev/notes.text

Source

clnuplot.asd.

Parent Component

dev (module).


3.2.2 clnuplot/dev/examples

Source

clnuplot.asd.

Parent Component

dev (module).


4 Packages

Packages are listed by definition order.


4.1 clnuplot-system

Source

clnuplot.asd.

Use List
  • asdf/interface.
  • common-lisp.

4.2 clnuplot

Source

package.lisp.

Use List
  • cl-mathstats.
  • common-lisp.
  • metabang.bind.
  • metabang.cl-containers.
  • metabang.utilities.
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: *gnuplot-home*
Package

clnuplot.

Source

plot-window.lisp.

Special Variable: *plot-default-directory*
Package

clnuplot.

Source

plots.lisp.

Special Variable: *plot-default-host*
Package

clnuplot.

Source

plots.lisp.


5.1.2 Ordinary functions

Function: fullpath (plot)
Package

clnuplot.

Source

plots.lisp.

Function: histogram (data &rest args &key x-coord y-coord key title xlabel ylabel filename legend-creator width &allow-other-keys)
Package

clnuplot.

Source

plots.lisp.

Function: make-roc-plot (data &rest args &key plot linewidth &allow-other-keys)

Data can either be a single plot or multiple plots. In the first case, it should be a list of pairs of numbers; in the second it should be a list of lists of pairs of numbers.

Package

clnuplot.

Source

roc-curves.lisp.

Function: make-roc-plot-template (&rest args &key filename title xlabel ylabel key &allow-other-keys)
Package

clnuplot.

Source

roc-curves.lisp.

Function: roc (examples count-positive count-negative f test &key weight)
Package

clnuplot.

Source

roc-curves.lisp.

Function: roc! (examples count-positive count-negative f test &key weight beta sort?)

Returns (as multiple values) a list of points for an ROC curve and a list of f-measures associated with those points. The ROC curve algorithm is from Tom Facwett’s ROC Graphs: Notes and Practical Considerations for Data Mining Researchers. See moab entry fawcett-roc-2003 for more information.

If you know that the examples are already sorted, you can use the sort? keyword to prevent this from sorting them again. The :beta keyword is passed along to the f-measure function. The :weight keyword is provided to handles aggreates of examples.

Package

clnuplot.

Source

roc-curves.lisp.

Function: scatter-plot (data &rest args &key x-coord y-coord key test title xlabel ylabel filename legend-creator &allow-other-keys)
Package

clnuplot.

Source

plots.lisp.


5.1.3 Generic functions

Generic Reader: filename (object)
Package

clnuplot.

Methods
Reader Method: filename ((gnuplot gnuplot))

automatically generated reader method

Source

plots.lisp.

Target Slot

filename.

Generic Writer: (setf filename) (object)
Package

clnuplot.

Methods
Writer Method: (setf filename) ((gnuplot gnuplot))

automatically generated writer method

Source

plots.lisp.

Target Slot

filename.

Generic Function: make-plot (plot-kind data &rest args &key name comment filename plot &allow-other-keys)
Package

clnuplot.

Methods
Method: make-plot ((plot-kind symbol) data &rest args &key name comment filename plot &allow-other-keys)
Source

plots.lisp.

Generic Function: write-plot (plot style)
Package

clnuplot.

Source

plots.lisp.

Methods
Method: write-plot ((plot gnuplot) (style (eql :pdf)))
Source

plot-window.lisp.

Method: write-plot ((plot gnuplot) (style (eql :postscript)))
Method: write-plot ((plot gnuplot) (style (eql :gnuplot)))
Method: write-plot :around (plot style)

5.2 Internals


5.2.1 Special variables

Special Variable: *plot-data-set-settings*
Package

clnuplot.

Source

plots.lisp.

Special Variable: *plot-plot-settings*
Package

clnuplot.

Source

plots.lisp.

Special Variable: *plot-ps2pdf-command*
Package

clnuplot.

Source

plots.lisp.


5.2.2 Ordinary functions

Function: data->n-buckets (data bucket-count key &key bucket-center)
Package

clnuplot.

Source

plots.lisp.

Function: execute-plot (plot)
Package

clnuplot.

Source

plot-window.lisp.

Function: make-string-safe-for-unix (string)
Package

clnuplot.

Source

utilities.lisp.

Function: plot-kind->plot-style (plot-kind)
Package

clnuplot.

Source

utilities.lisp.

Function: plot-kind->point-kind (plot-kind)
Package

clnuplot.

Source

utilities.lisp.

Function: quick-plot (data &rest args &key plot-kind x-coord y-coord key test title xlabel ylabel filename legend-creator &allow-other-keys)
Package

clnuplot.

Source

plots.lisp.

Function: set-settings (possibile-settings object settings)
Package

clnuplot.

Source

plots.lisp.


5.2.3 Generic functions

Generic Reader: comment (object)
Package

clnuplot.

Methods
Reader Method: comment ((plot-data-set plot-data-set))

automatically generated reader method

Source

plots.lisp.

Target Slot

comment.

Reader Method: comment ((plot-abstract plot-abstract))

automatically generated reader method

Source

plots.lisp.

Target Slot

comment.

Generic Writer: (setf comment) (object)
Package

clnuplot.

Methods
Writer Method: (setf comment) ((plot-data-set plot-data-set))

automatically generated writer method

Source

plots.lisp.

Target Slot

comment.

Writer Method: (setf comment) ((plot-abstract plot-abstract))

automatically generated writer method

Source

plots.lisp.

Target Slot

comment.

Generic Reader: data (object)
Package

clnuplot.

Methods
Reader Method: data ((plot-data-set plot-data-set))

automatically generated reader method

Source

plots.lisp.

Target Slot

data.

Generic Reader: data-sets (object)
Package

clnuplot.

Methods
Reader Method: data-sets ((plot-abstract plot-abstract))

automatically generated reader method

Source

plots.lisp.

Target Slot

data-sets.

Generic Function: determine-width (width)
Package

clnuplot.

Methods
Method: determine-width ((width function))
Source

plots.lisp.

Method: determine-width ((width number))
Source

plots.lisp.

Generic Reader: filepath (object)
Package

clnuplot.

Methods
Reader Method: filepath ((gnuplot gnuplot))

automatically generated reader method

Source

plots.lisp.

Target Slot

filepath.

Generic Writer: (setf filepath) (object)
Package

clnuplot.

Methods
Writer Method: (setf filepath) ((gnuplot gnuplot))

automatically generated writer method

Source

plots.lisp.

Target Slot

filepath.

Generic Function: format-value-for-gnuplot (name value)
Package

clnuplot.

Methods
Method: format-value-for-gnuplot (name (value list))
Source

plots.lisp.

Method: format-value-for-gnuplot (name (value number))
Source

plots.lisp.

Method: format-value-for-gnuplot (name (value integer))
Source

plots.lisp.

Method: format-value-for-gnuplot (name (value symbol))
Source

plots.lisp.

Method: format-value-for-gnuplot (name (value string))
Source

plots.lisp.

Generic Function: handle-setting (kind name data value)
Package

clnuplot.

Methods
Method: handle-setting ((kind (eql :range)) name data value)
Source

plots.lisp.

Method: handle-setting ((kind (eql :translate)) name data value)
Source

plots.lisp.

Method: handle-setting ((kind (eql nil)) name data value)
Source

plots.lisp.

Generic Reader: host (object)
Package

clnuplot.

Methods
Reader Method: host ((gnuplot gnuplot))

automatically generated reader method

Source

plots.lisp.

Target Slot

host.

Generic Writer: (setf host) (object)
Package

clnuplot.

Methods
Writer Method: (setf host) ((gnuplot gnuplot))

automatically generated writer method

Source

plots.lisp.

Target Slot

host.

Generic Function: labelsp (plot)
Package

clnuplot.

Methods
Method: labelsp (plot)
Source

plots.lisp.

Generic Function: make-data-point (point-kind datum &key x-coord y-coord width label offset &allow-other-keys)
Package

clnuplot.

Methods
Method: make-data-point ((point-kind (eql :point)) datum &key x-coord y-coord &allow-other-keys)
Source

plots.lisp.

Method: make-data-point ((point-kind (eql :box)) datum &key x-coord y-coord width label offset &allow-other-keys)
Source

plots.lisp.

Generic Function: make-data-set (plot-kind data &rest args &key comment filter &allow-other-keys)
Package

clnuplot.

Methods
Method: make-data-set (plot-kind data &rest args &key comment filter &allow-other-keys)
Source

plots.lisp.

Generic Reader: settings (object)
Package

clnuplot.

Methods
Reader Method: settings ((plot-data-set plot-data-set))

automatically generated reader method

Source

plots.lisp.

Target Slot

settings.

Reader Method: settings ((plot-abstract plot-abstract))

automatically generated reader method

Source

plots.lisp.

Target Slot

settings.

Generic Reader: style (object)
Package

clnuplot.

Methods
Reader Method: style ((plot-data-set plot-data-set))

automatically generated reader method

Source

plots.lisp.

Target Slot

style.

Generic Writer: (setf style) (object)
Package

clnuplot.

Methods
Writer Method: (setf style) ((plot-data-set plot-data-set))

automatically generated writer method

Source

plots.lisp.

Target Slot

style.

Generic Function: write-data-set (data-set out)
Package

clnuplot.

Methods
Method: write-data-set ((data-set plot-data-set) out)
Source

plots.lisp.

Generic Function: write-plot-settings (plot out)
Package

clnuplot.

Methods
Method: write-plot-settings ((plot plot-data-set) out)
Source

plots.lisp.

Method: write-plot-settings ((plot gnuplot) out)
Source

plots.lisp.


5.2.4 Classes

Class: gnuplot
Package

clnuplot.

Source

plots.lisp.

Direct superclasses

plot-abstract.

Direct methods
Direct Default Initargs
InitargValue
:host*plot-default-host*
:directory*plot-default-directory*
Direct slots
Slot: filename
Initform

"plot"

Initargs

:filename

Readers

filename.

Writers

(setf filename).

Slot: host
Initargs

:host

Readers

host.

Writers

(setf host).

Slot: filepath
Initargs

:filepath, :directory

Readers

filepath.

Writers

(setf filepath).

Class: plot-abstract
Package

clnuplot.

Source

plots.lisp.

Direct subclasses

gnuplot.

Direct methods
Direct slots
Slot: settings
Initform

(metabang.cl-containers:make-container (quote metabang.cl-containers:simple-associative-container))

Readers

settings.

Writers

This slot is read-only.

Slot: data-sets
Initform

(metabang.cl-containers:make-container (quote metabang.cl-containers:stable-associative-container))

Readers

data-sets.

Writers

This slot is read-only.

Slot: comment
Initargs

:comment

Readers

comment.

Writers

(setf comment).

Class: plot-data-set
Package

clnuplot.

Source

plots.lisp.

Direct methods
Direct slots
Slot: settings
Initform

(metabang.cl-containers:make-container (quote metabang.cl-containers:simple-associative-container))

Readers

settings.

Writers

This slot is read-only.

Slot: comment
Initargs

:comment

Readers

comment.

Writers

(setf comment).

Slot: style
Initargs

:style

Readers

style.

Writers

(setf style).

Slot: data
Initform

(metabang.cl-containers:make-container (quote metabang.cl-containers:flexible-vector-container))

Readers

data.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   D   E   F   G   H   L   M   P   Q   R   S   W  
Index Entry  Section

(
(setf comment): Private generic functions
(setf comment): Private generic functions
(setf comment): Private generic functions
(setf filename): Public generic functions
(setf filename): Public generic functions
(setf filepath): Private generic functions
(setf filepath): Private generic functions
(setf host): Private generic functions
(setf host): Private generic functions
(setf style): Private generic functions
(setf style): Private generic functions

C
comment: Private generic functions
comment: Private generic functions
comment: Private generic functions

D
data: Private generic functions
data: Private generic functions
data->n-buckets: Private ordinary functions
data-sets: Private generic functions
data-sets: Private generic functions
determine-width: Private generic functions
determine-width: Private generic functions
determine-width: Private generic functions

E
execute-plot: Private ordinary functions

F
filename: Public generic functions
filename: Public generic functions
filepath: Private generic functions
filepath: Private generic functions
format-value-for-gnuplot: Private generic functions
format-value-for-gnuplot: Private generic functions
format-value-for-gnuplot: Private generic functions
format-value-for-gnuplot: Private generic functions
format-value-for-gnuplot: Private generic functions
format-value-for-gnuplot: Private generic functions
fullpath: Public ordinary functions
Function, data->n-buckets: Private ordinary functions
Function, execute-plot: Private ordinary functions
Function, fullpath: Public ordinary functions
Function, histogram: Public ordinary functions
Function, make-roc-plot: Public ordinary functions
Function, make-roc-plot-template: Public ordinary functions
Function, make-string-safe-for-unix: Private ordinary functions
Function, plot-kind->plot-style: Private ordinary functions
Function, plot-kind->point-kind: Private ordinary functions
Function, quick-plot: Private ordinary functions
Function, roc: Public ordinary functions
Function, roc!: Public ordinary functions
Function, scatter-plot: Public ordinary functions
Function, set-settings: Private ordinary functions

G
Generic Function, (setf comment): Private generic functions
Generic Function, (setf filename): Public generic functions
Generic Function, (setf filepath): Private generic functions
Generic Function, (setf host): Private generic functions
Generic Function, (setf style): Private generic functions
Generic Function, comment: Private generic functions
Generic Function, data: Private generic functions
Generic Function, data-sets: Private generic functions
Generic Function, determine-width: Private generic functions
Generic Function, filename: Public generic functions
Generic Function, filepath: Private generic functions
Generic Function, format-value-for-gnuplot: Private generic functions
Generic Function, handle-setting: Private generic functions
Generic Function, host: Private generic functions
Generic Function, labelsp: Private generic functions
Generic Function, make-data-point: Private generic functions
Generic Function, make-data-set: Private generic functions
Generic Function, make-plot: Public generic functions
Generic Function, settings: Private generic functions
Generic Function, style: Private generic functions
Generic Function, write-data-set: Private generic functions
Generic Function, write-plot: Public generic functions
Generic Function, write-plot-settings: Private generic functions

H
handle-setting: Private generic functions
handle-setting: Private generic functions
handle-setting: Private generic functions
handle-setting: Private generic functions
histogram: Public ordinary functions
host: Private generic functions
host: Private generic functions

L
labelsp: Private generic functions
labelsp: Private generic functions

M
make-data-point: Private generic functions
make-data-point: Private generic functions
make-data-point: Private generic functions
make-data-set: Private generic functions
make-data-set: Private generic functions
make-plot: Public generic functions
make-plot: Public generic functions
make-roc-plot: Public ordinary functions
make-roc-plot-template: Public ordinary functions
make-string-safe-for-unix: Private ordinary functions
Method, (setf comment): Private generic functions
Method, (setf comment): Private generic functions
Method, (setf filename): Public generic functions
Method, (setf filepath): Private generic functions
Method, (setf host): Private generic functions
Method, (setf style): Private generic functions
Method, comment: Private generic functions
Method, comment: Private generic functions
Method, data: Private generic functions
Method, data-sets: Private generic functions
Method, determine-width: Private generic functions
Method, determine-width: Private generic functions
Method, filename: Public generic functions
Method, filepath: Private generic functions
Method, format-value-for-gnuplot: Private generic functions
Method, format-value-for-gnuplot: Private generic functions
Method, format-value-for-gnuplot: Private generic functions
Method, format-value-for-gnuplot: Private generic functions
Method, format-value-for-gnuplot: Private generic functions
Method, handle-setting: Private generic functions
Method, handle-setting: Private generic functions
Method, handle-setting: Private generic functions
Method, host: Private generic functions
Method, labelsp: Private generic functions
Method, make-data-point: Private generic functions
Method, make-data-point: Private generic functions
Method, make-data-set: Private generic functions
Method, make-plot: Public generic functions
Method, settings: Private generic functions
Method, settings: Private generic functions
Method, style: Private generic functions
Method, write-data-set: Private generic functions
Method, write-plot: Public generic functions
Method, write-plot: Public generic functions
Method, write-plot: Public generic functions
Method, write-plot: Public generic functions
Method, write-plot-settings: Private generic functions
Method, write-plot-settings: Private generic functions

P
plot-kind->plot-style: Private ordinary functions
plot-kind->point-kind: Private ordinary functions

Q
quick-plot: Private ordinary functions

R
roc: Public ordinary functions
roc!: Public ordinary functions

S
scatter-plot: Public ordinary functions
set-settings: Private ordinary functions
settings: Private generic functions
settings: Private generic functions
settings: Private generic functions
style: Private generic functions
style: Private generic functions

W
write-data-set: Private generic functions
write-data-set: Private generic functions
write-plot: Public generic functions
write-plot: Public generic functions
write-plot: Public generic functions
write-plot: Public generic functions
write-plot: Public generic functions
write-plot-settings: Private generic functions
write-plot-settings: Private generic functions
write-plot-settings: Private generic functions


A.4 Data types

Jump to:   C   D   E   F   G   M   N   P   R   S   U  
Index Entry  Section

C
Class, gnuplot: Private classes
Class, plot-abstract: Private classes
Class, plot-data-set: Private classes
clnuplot: The clnuplot system
clnuplot: The clnuplot package
clnuplot-system: The clnuplot-system package
clnuplot.asd: The clnuplot/clnuplot․asd file

D
dev: The clnuplot/dev module

E
examples: The clnuplot/dev/examples file

F
File, clnuplot.asd: The clnuplot/clnuplot․asd file
File, examples: The clnuplot/dev/examples file
File, notes.text: The clnuplot/dev/notes․text file
File, package.lisp: The clnuplot/dev/package․lisp file
File, plot-window.lisp: The clnuplot/dev/plot-window․lisp file
File, plots.lisp: The clnuplot/dev/plots․lisp file
File, roc-curves.lisp: The clnuplot/dev/roc-curves․lisp file
File, utilities.lisp: The clnuplot/dev/utilities․lisp file

G
gnuplot: Private classes

M
Module, dev: The clnuplot/dev module

N
notes.text: The clnuplot/dev/notes․text file

P
Package, clnuplot: The clnuplot package
Package, clnuplot-system: The clnuplot-system package
package.lisp: The clnuplot/dev/package․lisp file
plot-abstract: Private classes
plot-data-set: Private classes
plot-window.lisp: The clnuplot/dev/plot-window․lisp file
plots.lisp: The clnuplot/dev/plots․lisp file

R
roc-curves.lisp: The clnuplot/dev/roc-curves․lisp file

S
System, clnuplot: The clnuplot system

U
utilities.lisp: The clnuplot/dev/utilities․lisp file