The periodic-table Reference Manual

Table of Contents

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

The periodic-table Reference Manual

This is the periodic-table Reference Manual, version 1.0, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:09:51 2018 GMT+0.


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

1 Introduction

Periodic Table in Common Lisp
Copyright 2004 Peter Scott
Released under the LLGPL (see http://opensource.franz.com/preamble.html).

This package defines a package, :elements, with an ELEMENT structure
and a number of functions to search the periodic table.

For example:

(use-package :elements)

(element-name (symbol-element "Kr")) => "Krypton"
(electronegativity-element 4.0)
=>
#S(ELEMENT
   :NAME "Fluorine"
   :ATOMIC-WEIGHT 18.9984
   :ATOMIC-NUMBER 9
   :OXIDATION-STATES "-1"
   :BOILING-POINT 85.0
   :SYMBOL "F"
   :ELECTRONEGATIVITY 3.98)

If you have any questions, please ask them on the chemboy-devel mailing list
at .

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

2 Systems

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


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

2.1 periodic-table

Author

Peter Scott

License

LLGPL

Version

1.0

Source

periodic-table.asd (file)

Components

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

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 files   [Contents][Index]

3.1.1 periodic-table.asd

Location

periodic-table.asd

Systems

periodic-table (system)

Packages

periodic-table-system


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

3.1.2 periodic-table/unittest.lisp

Parent

periodic-table (system)

Location

unittest.lisp

Packages

gigamonkeys-unittest

Exported Definitions
Internal Definitions

*test-name* (special variable)


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

3.1.3 periodic-table/elements.lisp

Dependency

unittest.lisp (file)

Parent

periodic-table (system)

Location

elements.lisp

Packages

elements

Exported Definitions
Internal Definitions

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

3.1.4 periodic-table/periodic-table.lisp

Dependency

elements.lisp (file)

Parent

periodic-table (system)

Location

periodic-table.lisp


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

4 Packages

Packages are listed by definition order.


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

4.1 periodic-table-system

Source

periodic-table.asd

Use List

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

4.2 gigamonkeys-unittest

Source

unittest.lisp (file)

Use List

common-lisp

Used By List

elements

Exported Definitions
Internal Definitions

*test-name* (special variable)


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

4.3 elements

Source

elements.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: check &body FORMS

Run each expression in ‘forms’ as a test case.

Package

gigamonkeys-unittest

Source

unittest.lisp (file)

Macro: combine-results &body FORMS

Combine the results (as booleans) of evaluating ‘forms’ in order.

Package

gigamonkeys-unittest

Source

unittest.lisp (file)

Macro: deftest NAME PARAMETERS &body BODY

Define a test function. Within a test function we can call other test functions or use ‘check’ to run individual test cases.

Package

gigamonkeys-unittest

Source

unittest.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: atomic-number-element ATOMIC-NUMBER

Get an element from its atomic number

Package

elements

Source

elements.lisp (file)

Function: atomic-weight-element ATOMIC-WEIGHT

Get an element from its approximate atomic weight

Package

elements

Source

elements.lisp (file)

Function: boiling-point-element BOILING-POINT

Get an element from its approximate boiling point

Package

elements

Source

elements.lisp (file)

Function: electronegativity-element ELECTRONEGATIVITY

Get an element from its approximate electronegativity

Package

elements

Source

elements.lisp (file)

Function: element-atomic-number INSTANCE
Function: (setf element-atomic-number) VALUE INSTANCE
Package

elements

Source

elements.lisp (file)

Function: element-atomic-weight INSTANCE
Function: (setf element-atomic-weight) VALUE INSTANCE
Package

elements

Source

elements.lisp (file)

Function: element-boiling-point INSTANCE
Function: (setf element-boiling-point) VALUE INSTANCE
Package

elements

Source

elements.lisp (file)

Function: element-electronegativity INSTANCE
Function: (setf element-electronegativity) VALUE INSTANCE
Package

elements

Source

elements.lisp (file)

Function: element-name INSTANCE
Function: (setf element-name) VALUE INSTANCE
Package

elements

Source

elements.lisp (file)

Function: element-oxidation-states INSTANCE
Function: (setf element-oxidation-states) VALUE INSTANCE
Package

elements

Source

elements.lisp (file)

Function: element-symbol INSTANCE
Function: (setf element-symbol) VALUE INSTANCE
Package

elements

Source

elements.lisp (file)

Function: find-element-if PREDICATE

A version of ‘find-if’ that searches in ‘*elements-table’

Package

elements

Source

elements.lisp (file)

Function: find-element-if-slot-near SLOT-ACCESSOR VALUE

Find the element where the value returned by calling ‘slot-accessor’ on the element produces the closest match to ‘value’

Package

elements

Source

elements.lisp (file)

Function: get-element ELEMENT &key ERROR-P

Get an element structure from either an element structure (just return it), an element name, or a symbol for an element. This is not case sensitive. Or you can search by atomic number if ‘element’ is a positive integer. Or search for an element whose symbol or name equal the symbol-name if element is a symbol. If ‘error-p’ is nil, then unmatched elements will simply return nil but if it is t, then an error will be raised.

Package

elements

Source

elements.lisp (file)

Function: name-element NAME

Get an element from its name

Package

elements

Source

elements.lisp (file)

Function: report-result RESULT FORM

Report the results of a single test case. Called by ‘check’.

Package

gigamonkeys-unittest

Source

unittest.lisp (file)

Function: symbol-element SYMBOL

Get an element from its symbol

Package

elements

Source

elements.lisp (file)

Function: test-elements ()
Package

elements

Source

elements.lisp (file)

Function: test-get-element ()
Package

elements

Source

elements.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Structures

Structure: element ()
Package

elements

Source

elements.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: name
Type

string

Initform

""

Readers

element-name (function)

Writers

(setf element-name) (function)

Slot: atomic-weight
Type

float

Initform

0.0

Readers

element-atomic-weight (function)

Writers

(setf element-atomic-weight) (function)

Slot: atomic-number
Type

integer

Initform

0

Readers

element-atomic-number (function)

Writers

(setf element-atomic-number) (function)

Slot: oxidation-states
Type

string

Initform

""

Readers

element-oxidation-states (function)

Writers

(setf element-oxidation-states) (function)

Slot: boiling-point
Type

(or float null)

Initform

0.0

Readers

element-boiling-point (function)

Writers

(setf element-boiling-point) (function)

Slot: symbol
Type

string

Initform

""

Readers

element-symbol (function)

Writers

(setf element-symbol) (function)

Slot: electronegativity
Type

(or float null)

Initform

0.0

Readers

element-electronegativity (function)

Writers

(setf element-electronegativity) (function)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *elements-table*

Table of elements

Package

elements

Source

elements.lisp (file)

Special Variable: *test-name*
Package

gigamonkeys-unittest

Source

unittest.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: copy-element INSTANCE
Package

elements

Source

elements.lisp (file)

Function: defelement NAME ATOMIC-WEIGHT ATOMIC-NUMBER OXIDATION-STATES BOILING-POINT SYMBOL ELECTRONEGATIVITY
Package

elements

Source

elements.lisp (file)

Function: element-p OBJECT
Package

elements

Source

elements.lisp (file)

Function: make-element &key (NAME NAME) (ATOMIC-WEIGHT ATOMIC-WEIGHT) (ATOMIC-NUMBER ATOMIC-NUMBER) (OXIDATION-STATES OXIDATION-STATES) (BOILING-POINT BOILING-POINT) (SYMBOL SYMBOL) (ELECTRONEGATIVITY ELECTRONEGATIVITY)
Package

elements

Source

elements.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   P  
Index Entry  Section

F
File, Lisp, periodic-table.asd: The periodic-table<dot>asd file
File, Lisp, periodic-table/elements.lisp: The periodic-table/elements<dot>lisp file
File, Lisp, periodic-table/periodic-table.lisp: The periodic-table/periodic-table<dot>lisp file
File, Lisp, periodic-table/unittest.lisp: The periodic-table/unittest<dot>lisp file

L
Lisp File, periodic-table.asd: The periodic-table<dot>asd file
Lisp File, periodic-table/elements.lisp: The periodic-table/elements<dot>lisp file
Lisp File, periodic-table/periodic-table.lisp: The periodic-table/periodic-table<dot>lisp file
Lisp File, periodic-table/unittest.lisp: The periodic-table/unittest<dot>lisp file

P
periodic-table.asd: The periodic-table<dot>asd file
periodic-table/elements.lisp: The periodic-table/elements<dot>lisp file
periodic-table/periodic-table.lisp: The periodic-table/periodic-table<dot>lisp file
periodic-table/unittest.lisp: The periodic-table/unittest<dot>lisp file

Jump to:   F   L   P  

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

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   M   N   R   S   T  
Index Entry  Section

(
(setf element-atomic-number): Exported functions
(setf element-atomic-weight): Exported functions
(setf element-boiling-point): Exported functions
(setf element-electronegativity): Exported functions
(setf element-name): Exported functions
(setf element-oxidation-states): Exported functions
(setf element-symbol): Exported functions

A
atomic-number-element: Exported functions
atomic-weight-element: Exported functions

B
boiling-point-element: Exported functions

C
check: Exported macros
combine-results: Exported macros
copy-element: Internal functions

D
defelement: Internal functions
deftest: Exported macros

E
electronegativity-element: Exported functions
element-atomic-number: Exported functions
element-atomic-weight: Exported functions
element-boiling-point: Exported functions
element-electronegativity: Exported functions
element-name: Exported functions
element-oxidation-states: Exported functions
element-p: Internal functions
element-symbol: Exported functions

F
find-element-if: Exported functions
find-element-if-slot-near: Exported functions
Function, (setf element-atomic-number): Exported functions
Function, (setf element-atomic-weight): Exported functions
Function, (setf element-boiling-point): Exported functions
Function, (setf element-electronegativity): Exported functions
Function, (setf element-name): Exported functions
Function, (setf element-oxidation-states): Exported functions
Function, (setf element-symbol): Exported functions
Function, atomic-number-element: Exported functions
Function, atomic-weight-element: Exported functions
Function, boiling-point-element: Exported functions
Function, copy-element: Internal functions
Function, defelement: Internal functions
Function, electronegativity-element: Exported functions
Function, element-atomic-number: Exported functions
Function, element-atomic-weight: Exported functions
Function, element-boiling-point: Exported functions
Function, element-electronegativity: Exported functions
Function, element-name: Exported functions
Function, element-oxidation-states: Exported functions
Function, element-p: Internal functions
Function, element-symbol: Exported functions
Function, find-element-if: Exported functions
Function, find-element-if-slot-near: Exported functions
Function, get-element: Exported functions
Function, make-element: Internal functions
Function, name-element: Exported functions
Function, report-result: Exported functions
Function, symbol-element: Exported functions
Function, test-elements: Exported functions
Function, test-get-element: Exported functions

G
get-element: Exported functions

M
Macro, check: Exported macros
Macro, combine-results: Exported macros
Macro, deftest: Exported macros
make-element: Internal functions

N
name-element: Exported functions

R
report-result: Exported functions

S
symbol-element: Exported functions

T
test-elements: Exported functions
test-get-element: Exported functions

Jump to:   (  
A   B   C   D   E   F   G   M   N   R   S   T  

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

A.3 Variables

Jump to:   *  
A   B   E   N   O   S  
Index Entry  Section

*
*elements-table*: Internal special variables
*test-name*: Internal special variables

A
atomic-number: Exported structures
atomic-weight: Exported structures

B
boiling-point: Exported structures

E
electronegativity: Exported structures

N
name: Exported structures

O
oxidation-states: Exported structures

S
Slot, atomic-number: Exported structures
Slot, atomic-weight: Exported structures
Slot, boiling-point: Exported structures
Slot, electronegativity: Exported structures
Slot, name: Exported structures
Slot, oxidation-states: Exported structures
Slot, symbol: Exported structures
Special Variable, *elements-table*: Internal special variables
Special Variable, *test-name*: Internal special variables
symbol: Exported structures

Jump to:   *  
A   B   E   N   O   S  

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

A.4 Data types

Jump to:   E   G   P   S  
Index Entry  Section

E
element: Exported structures
elements: The elements package

G
gigamonkeys-unittest: The gigamonkeys-unittest package

P
Package, elements: The elements package
Package, gigamonkeys-unittest: The gigamonkeys-unittest package
Package, periodic-table-system: The periodic-table-system package
periodic-table: The periodic-table system
periodic-table-system: The periodic-table-system package

S
Structure, element: Exported structures
System, periodic-table: The periodic-table system

Jump to:   E   G   P   S