The clnuplot Reference Manual

Table of Contents

The clnuplot Reference Manual

This is the clnuplot Reference Manual, version 0.2.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:34:31 2018 GMT+0.

1 Systems

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

1.1 clnuplot

Maintainer

Gary Warren King <gwking@metabang.com>

Author

Gary Warren King <gwking@metabang.com>

License

MIT License

Description

Common Lisp interface to GNUPlot.

Version

0.2.2

Dependencies

• cl-containers
• cl-mathstats
• metabang-bind
• trivial-shell

Source

clnuplot.asd (file)

Component

dev (module)

2 Modules

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

2.1 clnuplot/dev

Parent

clnuplot (system)

Location

dev/

Components

• package.lisp (file)
• utilities.lisp (file)
• plots.lisp (file)
• roc-curves.lisp (file)
• plot-window.lisp (file)
• notes.text (file)
• examples (file)

3 Files

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

3.1 Lisp

3.1.1 clnuplot.asd

Location

clnuplot.asd

Systems

clnuplot (system)

Packages

clnuplot-system

3.1.2 clnuplot/dev/package.lisp

Parent

dev (module)

Location

dev/package.lisp

Packages

clnuplot

3.1.3 clnuplot/dev/utilities.lisp

Dependency

package.lisp (file)

Parent

dev (module)

Location

dev/utilities.lisp

Internal Definitions

• make-string-safe-for-unix (function)
• plot-kind->plot-style (function)
• plot-kind->point-kind (function)

3.1.4 clnuplot/dev/plots.lisp

Dependency

utilities.lisp (file)

Parent

dev (module)

Location

dev/plots.lisp

Exported Definitions

• *plot-default-directory* (special variable)
• *plot-default-host* (special variable)
• filename (method)
• (setf filename) (method)
• fullpath (function)
• histogram (function)
• make-plot (method)
• scatter-plot (function)
• write-plot (generic function)
• write-plot (method)
• write-plot (method)
• write-plot (method)

Internal Definitions

• *plot-data-set-settings* (special variable)
• *plot-plot-settings* (special variable)
• *plot-ps2pdf-command* (special variable)
• comment (method)
• (setf comment) (method)
• comment (method)
• (setf comment) (method)
• data (method)
• data->n-buckets (function)
• data-sets (method)
• determine-width (method)
• determine-width (method)
• filepath (method)
• (setf filepath) (method)
• format-value-for-gnuplot (method)
• format-value-for-gnuplot (method)
• format-value-for-gnuplot (method)
• format-value-for-gnuplot (method)
• format-value-for-gnuplot (method)
• gnuplot (class)
• handle-setting (method)
• handle-setting (method)
• handle-setting (method)
• host (method)
• (setf host) (method)
• labelsp (method)
• make-data-point (method)
• make-data-point (method)
• make-data-set (method)
• plot-abstract (class)
• plot-data-set (class)
• quick-plot (function)
• set-settings (function)
• settings (method)
• settings (method)
• style (method)
• (setf style) (method)
• write-data-set (method)
• write-plot-settings (method)
• write-plot-settings (method)

3.1.5 clnuplot/dev/roc-curves.lisp

Dependency

plots.lisp (file)

Parent

dev (module)

Location

dev/roc-curves.lisp

Exported Definitions

• make-roc-plot (function)
• make-roc-plot-template (function)
• roc (function)
• roc! (function)

3.1.6 clnuplot/dev/plot-window.lisp

Dependency

plots.lisp (file)

Parent

dev (module)

Location

dev/plot-window.lisp

Exported Definitions

• *gnuplot-home* (special variable)
• write-plot (method)

Internal Definitions

execute-plot (function)

3.2 Other

3.2.1 clnuplot/dev/notes.text

Parent

dev (module)

Location

dev/notes.text

3.2.2 clnuplot/dev/examples

Parent

dev (module)

Location

/home/quickref/quicklisp/dists/quicklisp/software/clnuplot-20130128-darcs/dev/examples (not found)

4 Packages

Packages are listed by definition order.

4.1 clnuplot-system

Source

clnuplot.asd

Use List

• common-lisp
• asdf/interface

4.2 clnuplot

Source

package.lisp (file)

Use List

• metabang.cl-containers
• cl-mathstats
• metabang.bind
• metabang.utilities
• common-lisp

Exported Definitions

• *gnuplot-home* (special variable)
• *plot-default-directory* (special variable)
• *plot-default-host* (special variable)
• filename (generic function)
• filename (method)
• (setf filename) (method)
• (setf filename) (generic function)
• fullpath (function)
• histogram (function)
• make-plot (generic function)
• make-plot (method)
• make-roc-plot (function)
• make-roc-plot-template (function)
• roc (function)
• roc! (function)
• scatter-plot (function)
• write-plot (generic function)
• write-plot (method)
• write-plot (method)
• write-plot (method)
• write-plot (method)

Internal Definitions

• *plot-data-set-settings* (special variable)
• *plot-plot-settings* (special variable)
• *plot-ps2pdf-command* (special variable)
• comment (generic function)
• comment (method)
• (setf comment) (method)
• comment (method)
• (setf comment) (method)
• (setf comment) (generic function)
• data (generic function)
• data (method)
• data->n-buckets (function)
• data-sets (generic function)
• data-sets (method)
• determine-width (generic function)
• determine-width (method)
• determine-width (method)
• execute-plot (function)
• filepath (generic function)
• filepath (method)
• (setf filepath) (method)
• (setf filepath) (generic function)
• format-value-for-gnuplot (generic function)
• format-value-for-gnuplot (method)
• format-value-for-gnuplot (method)
• format-value-for-gnuplot (method)
• format-value-for-gnuplot (method)
• format-value-for-gnuplot (method)
• gnuplot (class)
• handle-setting (generic function)
• handle-setting (method)
• handle-setting (method)
• handle-setting (method)
• host (generic function)
• host (method)
• (setf host) (method)
• (setf host) (generic function)
• labelsp (generic function)
• labelsp (method)
• make-data-point (generic function)
• make-data-point (method)
• make-data-point (method)
• make-data-set (generic function)
• make-data-set (method)
• make-string-safe-for-unix (function)
• plot-abstract (class)
• plot-data-set (class)
• plot-kind->plot-style (function)
• plot-kind->point-kind (function)
• quick-plot (function)
• set-settings (function)
• settings (generic function)
• settings (method)
• settings (method)
• style (generic function)
• style (method)
• (setf style) (method)
• (setf style) (generic function)
• write-data-set (generic function)
• write-data-set (method)
• write-plot-settings (generic function)
• write-plot-settings (method)
• write-plot-settings (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *gnuplot-home*

Package

clnuplot

Source

plot-window.lisp (file)

Special Variable: *plot-default-directory*

Package

clnuplot

Source

plots.lisp (file)

Special Variable: *plot-default-host*

Package

clnuplot

Source

plots.lisp (file)

5.1.2 Functions

Function: fullpath PLOT

Package

clnuplot

Source

plots.lisp (file)

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 (file)

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 (file)

Function: make-roc-plot-template &rest ARGS &key FILENAME TITLE XLABEL YLABEL KEY &allow-other-keys

Package

clnuplot

Source

roc-curves.lisp (file)

Function: roc EXAMPLES COUNT-POSITIVE COUNT-NEGATIVE F TEST &key WEIGHT

Package

clnuplot

Source

roc-curves.lisp (file)

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 (file)

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 (file)

5.1.3 Generic functions

Generic Function: filename OBJECT

Generic Function: (setf filename) NEW-VALUE OBJECT

Package

clnuplot

Methods

Method: filename (GNUPLOT gnuplot)

automatically generated reader method

Source

plots.lisp (file)

Method: (setf filename) NEW-VALUE (GNUPLOT gnuplot)

automatically generated writer method

Source

plots.lisp (file)

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 (file)

Generic Function: write-plot PLOT STYLE

Package

clnuplot

Source

plots.lisp (file)

Methods

Method: write-plot (PLOT gnuplot) (STYLE (eql pdf))

Source

plot-window.lisp (file)

Method: write-plot (PLOT gnuplot) (STYLE (eql postscript))

Method: write-plot (PLOT gnuplot) (STYLE (eql gnuplot))

Method: write-plot PLOT STYLE around

5.2 Internal definitions

5.2.1 Special variables

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

Package

clnuplot

Source

plots.lisp (file)

Special Variable: *plot-plot-settings*

Package

clnuplot

Source

plots.lisp (file)

Special Variable: *plot-ps2pdf-command*

Package

clnuplot

Source

plots.lisp (file)

5.2.2 Functions

Function: data->n-buckets DATA BUCKET-COUNT KEY &key BUCKET-CENTER

Package

clnuplot

Source

plots.lisp (file)

Function: execute-plot PLOT

Package

clnuplot

Source

plot-window.lisp (file)

Function: make-string-safe-for-unix STRING

Package

clnuplot

Source

utilities.lisp (file)

Function: plot-kind->plot-style PLOT-KIND

Package

clnuplot

Source

utilities.lisp (file)

Function: plot-kind->point-kind PLOT-KIND

Package

clnuplot

Source

utilities.lisp (file)

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 (file)

Function: set-settings POSSIBILE-SETTINGS OBJECT SETTINGS

Package

clnuplot

Source

plots.lisp (file)

5.2.3 Generic functions

Generic Function: comment OBJECT

Generic Function: (setf comment) NEW-VALUE OBJECT

Package

clnuplot

Methods

Method: comment (PLOT-DATA-SET plot-data-set)

automatically generated reader method

Source

plots.lisp (file)

Method: (setf comment) NEW-VALUE (PLOT-DATA-SET plot-data-set)

automatically generated writer method

Source

plots.lisp (file)

Method: comment (PLOT-ABSTRACT plot-abstract)

automatically generated reader method

Source

plots.lisp (file)

Method: (setf comment) NEW-VALUE (PLOT-ABSTRACT plot-abstract)

automatically generated writer method

Source

plots.lisp (file)

Generic Function: data OBJECT

Package

clnuplot

Methods

Method: data (PLOT-DATA-SET plot-data-set)

automatically generated reader method

Source

plots.lisp (file)

Generic Function: data-sets OBJECT

Package

clnuplot

Methods

Method: data-sets (PLOT-ABSTRACT plot-abstract)

automatically generated reader method

Source

plots.lisp (file)

Generic Function: determine-width WIDTH

Package

clnuplot

Methods

Method: determine-width (WIDTH function)

Source

plots.lisp (file)

Method: determine-width (WIDTH number)

Source

plots.lisp (file)

Generic Function: filepath OBJECT

Generic Function: (setf filepath) NEW-VALUE OBJECT

Package

clnuplot

Methods

Method: filepath (GNUPLOT gnuplot)

automatically generated reader method

Source

plots.lisp (file)

Method: (setf filepath) NEW-VALUE (GNUPLOT gnuplot)

automatically generated writer method

Source

plots.lisp (file)

Generic Function: format-value-for-gnuplot NAME VALUE

Package

clnuplot

Methods

Method: format-value-for-gnuplot NAME (VALUE list)

Source

plots.lisp (file)

Method: format-value-for-gnuplot NAME (VALUE number)

Source

plots.lisp (file)

Method: format-value-for-gnuplot NAME (VALUE integer)

Source

plots.lisp (file)

Method: format-value-for-gnuplot NAME (VALUE symbol)

Source

plots.lisp (file)

Method: format-value-for-gnuplot NAME (VALUE string)

Source

plots.lisp (file)

Generic Function: handle-setting KIND NAME DATA VALUE

Package

clnuplot

Methods

Method: handle-setting (KIND (eql range)) NAME DATA VALUE

Source

plots.lisp (file)

Method: handle-setting (KIND (eql translate)) NAME DATA VALUE

Source

plots.lisp (file)

Method: handle-setting (KIND (eql nil)) NAME DATA VALUE

Source

plots.lisp (file)

Generic Function: host OBJECT

Generic Function: (setf host) NEW-VALUE OBJECT

Package

clnuplot

Methods

Method: host (GNUPLOT gnuplot)

automatically generated reader method

Source

plots.lisp (file)

Method: (setf host) NEW-VALUE (GNUPLOT gnuplot)

automatically generated writer method

Source

plots.lisp (file)

Generic Function: labelsp PLOT

Package

clnuplot

Methods

Method: labelsp PLOT

Source

plots.lisp (file)

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 (file)

Method: make-data-point (POINT-KIND (eql box)) DATUM &key X-COORD Y-COORD WIDTH LABEL OFFSET &allow-other-keys

Source

plots.lisp (file)

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 (file)

Generic Function: settings OBJECT

Package

clnuplot

Methods

Method: settings (PLOT-DATA-SET plot-data-set)

automatically generated reader method

Source

plots.lisp (file)

Method: settings (PLOT-ABSTRACT plot-abstract)

automatically generated reader method

Source

plots.lisp (file)

Generic Function: style OBJECT

Generic Function: (setf style) NEW-VALUE OBJECT

Package

clnuplot

Methods

Method: style (PLOT-DATA-SET plot-data-set)

automatically generated reader method

Source

plots.lisp (file)

Method: (setf style) NEW-VALUE (PLOT-DATA-SET plot-data-set)

automatically generated writer method

Source

plots.lisp (file)

Generic Function: write-data-set DATA-SET OUT

Package

clnuplot

Methods

Method: write-data-set (DATA-SET plot-data-set) OUT

Source

plots.lisp (file)

Generic Function: write-plot-settings PLOT OUT

Package

clnuplot

Methods

Method: write-plot-settings (PLOT plot-data-set) OUT

Source

plots.lisp (file)

Method: write-plot-settings (PLOT gnuplot) OUT

Source

plots.lisp (file)

5.2.4 Classes

Class: gnuplot ()

Package

clnuplot

Source

plots.lisp (file)

Direct superclasses

plot-abstract (class)

Direct methods

• write-plot (method)
• write-plot-settings (method)
• write-plot (method)
• write-plot (method)
• filepath (method)
• filepath (method)
• host (method)
• host (method)
• filename (method)
• filename (method)

Direct slots

Slot: filename

Initargs

:filename

Initform

"plot"

Readers

filename (generic function)

Writers

(setf filename) (generic function)

Slot: host

Initargs

:host

Readers

host (generic function)

Writers

(setf host) (generic function)

Slot: filepath

Initargs

:filepath, :directory

Readers

filepath (generic function)

Writers

(setf filepath) (generic function)

Direct Default Initargs

Initarg	Value
:host	clnuplot:*plot-default-host*
:directory	clnuplot:*plot-default-directory*

Class: plot-abstract ()

Package

clnuplot

Source

plots.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

gnuplot (class)

Direct methods

• comment (method)
• comment (method)
• data-sets (method)
• settings (method)

Direct slots

Slot: settings

Initform

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

Readers

settings (generic function)

Slot: data-sets

Initform

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

Readers

data-sets (generic function)

Slot: comment

Initargs

:comment

Readers

comment (generic function)

Writers

(setf comment) (generic function)

Class: plot-data-set ()

Package

clnuplot

Source

plots.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• write-data-set (method)
• write-plot-settings (method)
• data (method)
• style (method)
• style (method)
• comment (method)
• comment (method)
• settings (method)

Direct slots

Slot: settings

Initform

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

Readers

settings (generic function)

Slot: comment

Initargs

:comment

Readers

comment (generic function)

Writers

(setf comment) (generic function)

Slot: style

Initargs

:style

Readers

style (generic function)

Writers

(setf style) (generic function)

Slot: data

Initform

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

Readers

data (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types