The eazy-gnuplot Reference Manual

This is the eazy-gnuplot Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:09:10 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 eazy-gnuplot

An intuitive CL interface to gnuplot.

Author

Masataro Asai

Contact

License

LLGPL

Version

0.2.0

Dependencies
  • iterate (system).
  • trivia (system).
  • alexandria (system).
  • uiop (system).
Source

eazy-gnuplot.asd.

Child Component

src (module).


3 Modules

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


3.1 eazy-gnuplot/src

Source

eazy-gnuplot.asd.

Parent Component

eazy-gnuplot (system).

Child Component

package.lisp (file).


4 Files

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


4.1 Lisp


4.1.1 eazy-gnuplot/eazy-gnuplot.asd

Source

eazy-gnuplot.asd.

Parent Component

eazy-gnuplot (system).

ASDF Systems

eazy-gnuplot.

Packages

eazy-gnuplot-asd.


4.1.2 eazy-gnuplot/src/package.lisp

Source

eazy-gnuplot.asd.

Parent Component

src (module).

Packages

eazy-gnuplot.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 eazy-gnuplot-asd

Source

eazy-gnuplot.asd.

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

5.2 eazy-gnuplot

Source

package.lisp.

Use List
  • alexandria.
  • common-lisp.
  • iterate.
  • trivia.level2.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *gnuplot-home*

gnuplot command available in the system.

Package

eazy-gnuplot.

Source

package.lisp.


6.1.2 Macros

Macro: with-plots ((stream &key debug external-format persist) &body body)

with-plots
stream - print commands to this stream.

Keywords
:debug boolean - prints debugging information.
:external-format encoding - the external format need for output, default is :default. :persist boolean - allows windows from GUI terminals to remain open; default is nil (not to persist).
Body
Place your plot code here.

Package

eazy-gnuplot.

Source

package.lisp.


6.1.3 Ordinary functions

Function: datafile-plot (pathspec &rest args &key using &allow-other-keys)
Package

eazy-gnuplot.

Source

package.lisp.

Function: datafile-splot (pathspec &rest args &key using &allow-other-keys)
Package

eazy-gnuplot.

Source

package.lisp.

Function: fit (expression data &rest args &key using via unitweights yerror xyerror zerror errors &allow-other-keys)

EXPRESSION is a string representing gnuplot fitting target expressions e.g. f(x), ax**2+bx+c. DATA is either a function producing data, a string
representing a gnuplot expression, or a pathanme for input data.

Package

eazy-gnuplot.

Source

package.lisp.

Function: func-plot (expression &rest args &key using &allow-other-keys)
Package

eazy-gnuplot.

Source

package.lisp.

Function: func-splot (expression &rest args &key using &allow-other-keys)
Package

eazy-gnuplot.

Source

package.lisp.

Function: gp (&rest args)

Render single line gnuplot commands
For example:
Command:
(gp :set :param)
(gp :set :style :line 1 :lc :rgb ’("’#999999’") :lt 1 ’("#border")) Generates:
set param
set style line 1 lc rgb "’#999999’" lt 1 "#border"

- Return:
NIL

Package

eazy-gnuplot.

Source

package.lisp.

Function: gp-quote (value)

Map a value to the corresponding gnuplot string

Package

eazy-gnuplot.

Source

package.lisp.

Function: gp-setup (&rest args &key terminal output multiplot &allow-other-keys)

Special command for setting up gnuplot. This is almost the same as GP command, however it serves some special purposes such as terminal detection from the output, multiplot etc.

Package

eazy-gnuplot.

Source

package.lisp.

Function: plot (data &rest args &key using &allow-other-keys)

DATA is either a function producing data, a string representing gnuplot functions, or a pathanme for input data.

Package

eazy-gnuplot.

Source

package.lisp.

Function: row (&rest args)

Write a row

Package

eazy-gnuplot.

Source

package.lisp.

Function: splot (data &rest args &key using &allow-other-keys)

DATA is either a function producing data, a string representing gnuplot functions, or a pathanme for input data.

Package

eazy-gnuplot.

Source

package.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: *data-stream*

a stream dedicated for printing the inline data fed to the plot command. not meant to be exposed to the users.

Package

eazy-gnuplot.

Source

package.lisp.

Special Variable: *keyword-separator-alist*

an alist from a keyword to the corresponding separator string.

Package

eazy-gnuplot.

Source

package.lisp.

Special Variable: *plot-command-stream*

a stream dedicated for printing the plot command, and its non-data arguments, like plot style, linewidth, linetype. not meant to be exposed to the users.

Package

eazy-gnuplot.

Source

package.lisp.

Special Variable: *plot-type*
Package

eazy-gnuplot.

Source

package.lisp.

Special Variable: *plot-type-multiplot*
Package

eazy-gnuplot.

Source

package.lisp.

Special Variable: *user-stream*

a stream which is bounded by with-plots, and which the user can write some additional gnuplot commands into.

Package

eazy-gnuplot.

Source

package.lisp.


6.2.2 Ordinary functions

Function: %gp (args)
Package

eazy-gnuplot.

Source

package.lisp.

Function: %plot (data &rest args &key type &allow-other-keys)
Package

eazy-gnuplot.

Source

package.lisp.

Function: call-with-plots (external-format persist debug body)
Package

eazy-gnuplot.

Source

package.lisp.

Function: data-filename (data)
Package

eazy-gnuplot.

Source

package.lisp.

Function: gp-quote-for (keyword value)
Package

eazy-gnuplot.

Source

package.lisp.

Function: map-plist (args fn)
Package

eazy-gnuplot.

Source

package.lisp.

Function: wrap-range-result (keyword result)
Package

eazy-gnuplot.

Source

package.lisp.


6.2.3 Conditions

Condition: new-plot
Package

eazy-gnuplot.

Source

package.lisp.

Direct superclasses

condition.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
C   D   F   G   M   P   R   S   W  
Index Entry  Section

%
%gp: Private ordinary functions
%plot: Private ordinary functions

C
call-with-plots: Private ordinary functions

D
data-filename: Private ordinary functions
datafile-plot: Public ordinary functions
datafile-splot: Public ordinary functions

F
fit: Public ordinary functions
func-plot: Public ordinary functions
func-splot: Public ordinary functions
Function, %gp: Private ordinary functions
Function, %plot: Private ordinary functions
Function, call-with-plots: Private ordinary functions
Function, data-filename: Private ordinary functions
Function, datafile-plot: Public ordinary functions
Function, datafile-splot: Public ordinary functions
Function, fit: Public ordinary functions
Function, func-plot: Public ordinary functions
Function, func-splot: Public ordinary functions
Function, gp: Public ordinary functions
Function, gp-quote: Public ordinary functions
Function, gp-quote-for: Private ordinary functions
Function, gp-setup: Public ordinary functions
Function, map-plist: Private ordinary functions
Function, plot: Public ordinary functions
Function, row: Public ordinary functions
Function, splot: Public ordinary functions
Function, wrap-range-result: Private ordinary functions

G
gp: Public ordinary functions
gp-quote: Public ordinary functions
gp-quote-for: Private ordinary functions
gp-setup: Public ordinary functions

M
Macro, with-plots: Public macros
map-plist: Private ordinary functions

P
plot: Public ordinary functions

R
row: Public ordinary functions

S
splot: Public ordinary functions

W
with-plots: Public macros
wrap-range-result: Private ordinary functions