The cl-cerf Reference Manual

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

The cl-cerf Reference Manual

This is the cl-cerf Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:33:12 2022 GMT+0.

Table of Contents


1 Introduction

This library is a front-end to the libcerf project
(https://sourceforge.net/projects/libcerf/), which is published under
the MIT license.

This Common Lisp wrapper is public domain.

cl-cerf comes in two layers:

* The CFFI library in the cl-cerf-cffi package
* The Lisp wrapper in the cl-cerf package.

The Lisp wrapper uses generic functions to provide either real or
complex arguments and return values depending on the function.

Note that the w-* functions were renamed to the hopefully more
identifiable name #'faddeeva-w, which encompasses all of the
functionality of that group of functions.

Note that when a complex argument is supplied as input, generally the
result will be a complex number, but for some functions a real input
will lead to only a real output.

Examples:

(cl-cerf:faddeeva-w 1)
==> #C(0.36787944117144233d0 0.6071577058413937d0)

(cl-cerf:faddeeva-w #c(0 1))
==> #C(0.427583576155807d0 0.0d0)

(cl-cerf:erf #c(1 2))
==> #C(-0.5366435657785664d0 -5.0491437034470374d0)

(cl-cerf:erf 1)
==> 0.8427007929497149d0


2 Systems

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


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

2.1 cl-cerf

Lisp wrapper to libcerf

Author

Gary Hollis

License

Public Domain

Dependencies
  • cffi (system).
  • cffi-libffi (system).
Source

cl-cerf.asd.

Child Components

3 Files

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


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

3.1 Lisp


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

3.1.1 cl-cerf/cl-cerf.asd

Source

cl-cerf.asd.

Parent Component

cl-cerf (system).

ASDF Systems

cl-cerf.


3.1.2 cl-cerf/package.lisp

Source

cl-cerf.asd.

Parent Component

cl-cerf (system).

Packages

3.1.3 cl-cerf/cl-cerf-cffi.lisp

Dependency

package.lisp (file).

Source

cl-cerf.asd.

Parent Component

cl-cerf (system).

Public Interface
Internals

c-complex-tclass (class).


3.1.4 cl-cerf/cl-cerf.lisp

Dependency

cl-cerf-cffi.lisp (file).

Source

cl-cerf.asd.

Parent Component

cl-cerf (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 cl-cerf-cffi

Source

package.lisp.

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

c-complex-tclass (class).


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

4.2 cl-cerf

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.


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

5.1 Public Interface


5.1.1 Ordinary functions

Function: cdawson (z)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: cerf (z)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: cerf-experimental-imw (x y)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: cerf-experimental-rew (x y)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: cerfc (z)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: cerfcx (z)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: cerfi (z)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: dawson (x)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: erfcx (x)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: erfi (x)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: im-w-of-x (x)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: im-w-of-z (z)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: re-w-of-z (z)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: voigt (x sigma gamma)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: voigt (x sigma gamma)
Package

cl-cerf.

Source

cl-cerf.lisp.

Function: voigt-hwhm (sigma gamma)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

Function: voigt-hwhm (sigma gamma)
Package

cl-cerf.

Source

cl-cerf.lisp.

Function: w-of-z (z)
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.


5.1.2 Generic functions

Generic Function: dawson (z)

Dawson’s integral

Package

cl-cerf.

Source

cl-cerf.lisp.

Methods
Method: dawson ((z complex))
Method: dawson ((x real))
Generic Function: erf (z)

Error function of complex arguments

Package

cl-cerf.

Source

cl-cerf.lisp.

Methods
Method: erf ((z complex))
Method: erf ((x real))
Generic Function: erfc (z)

Complementary error function of complex arguments

Package

cl-cerf.

Source

cl-cerf.lisp.

Methods
Method: erfc ((z complex))
Method: erfc ((x real))
Generic Function: erfcx (z)

Underflow-compensated error function of complex arguments

Package

cl-cerf.

Source

cl-cerf.lisp.

Methods
Method: erfcx ((z complex))
Method: erfcx ((x real))
Generic Function: erfi (z)

Imaginary error function of complex arguments

Package

cl-cerf.

Source

cl-cerf.lisp.

Methods
Method: erfi ((z complex))
Method: erfi ((x real))
Generic Function: faddeeva-w (z)

Faddeeva’s w(z) scaled complex error function

Package

cl-cerf.

Source

cl-cerf.lisp.

Methods
Method: faddeeva-w ((z complex))
Method: faddeeva-w ((x real))

5.2 Internals


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

5.2.1 Ordinary functions

Function: complex->plist (z)
Package

cl-cerf.

Source

cl-cerf.lisp.

Function: plist->complex (plist)
Package

cl-cerf.

Source

cl-cerf.lisp.


5.2.2 Classes

Class: c-complex-tclass
Package

cl-cerf-cffi.

Source

cl-cerf-cffi.lisp.

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

Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   C   D   E   F   G   I   M   P   R   V   W  
Index Entry  Section

C
cdawson: Public ordinary functions
cerf: Public ordinary functions
cerf-experimental-imw: Public ordinary functions
cerf-experimental-rew: Public ordinary functions
cerfc: Public ordinary functions
cerfcx: Public ordinary functions
cerfi: Public ordinary functions
complex->plist: Private ordinary functions

D
dawson: Public ordinary functions
dawson: Public generic functions
dawson: Public generic functions
dawson: Public generic functions

E
erf: Public generic functions
erf: Public generic functions
erf: Public generic functions
erfc: Public generic functions
erfc: Public generic functions
erfc: Public generic functions
erfcx: Public ordinary functions
erfcx: Public generic functions
erfcx: Public generic functions
erfcx: Public generic functions
erfi: Public ordinary functions
erfi: Public generic functions
erfi: Public generic functions
erfi: Public generic functions

F
faddeeva-w: Public generic functions
faddeeva-w: Public generic functions
faddeeva-w: Public generic functions
Function, cdawson: Public ordinary functions
Function, cerf: Public ordinary functions
Function, cerf-experimental-imw: Public ordinary functions
Function, cerf-experimental-rew: Public ordinary functions
Function, cerfc: Public ordinary functions
Function, cerfcx: Public ordinary functions
Function, cerfi: Public ordinary functions
Function, complex->plist: Private ordinary functions
Function, dawson: Public ordinary functions
Function, erfcx: Public ordinary functions
Function, erfi: Public ordinary functions
Function, im-w-of-x: Public ordinary functions
Function, im-w-of-z: Public ordinary functions
Function, plist->complex: Private ordinary functions
Function, re-w-of-z: Public ordinary functions
Function, voigt: Public ordinary functions
Function, voigt: Public ordinary functions
Function, voigt-hwhm: Public ordinary functions
Function, voigt-hwhm: Public ordinary functions
Function, w-of-z: Public ordinary functions

G
Generic Function, dawson: Public generic functions
Generic Function, erf: Public generic functions
Generic Function, erfc: Public generic functions
Generic Function, erfcx: Public generic functions
Generic Function, erfi: Public generic functions
Generic Function, faddeeva-w: Public generic functions

I
im-w-of-x: Public ordinary functions
im-w-of-z: Public ordinary functions

M
Method, dawson: Public generic functions
Method, dawson: Public generic functions
Method, erf: Public generic functions
Method, erf: Public generic functions
Method, erfc: Public generic functions
Method, erfc: Public generic functions
Method, erfcx: Public generic functions
Method, erfcx: Public generic functions
Method, erfi: Public generic functions
Method, erfi: Public generic functions
Method, faddeeva-w: Public generic functions
Method, faddeeva-w: Public generic functions

P
plist->complex: Private ordinary functions

R
re-w-of-z: Public ordinary functions

V
voigt: Public ordinary functions
voigt: Public ordinary functions
voigt-hwhm: Public ordinary functions
voigt-hwhm: Public ordinary functions

W
w-of-z: Public ordinary functions

Jump to:   C   D   E   F   G   I   M   P   R   V   W  

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

A.3 Variables