The periodic-table Reference Manual

This is the periodic-table Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:15:54 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 periodic-table

Author

Peter Scott

License

LLGPL

Version

1.0

Source

periodic-table.asd.

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 periodic-table/periodic-table.asd

Source

periodic-table.asd.

Parent Component

periodic-table (system).

ASDF Systems

periodic-table.

Packages

periodic-table-system.


3.1.2 periodic-table/unittest.lisp

Source

periodic-table.asd.

Parent Component

periodic-table (system).

Packages

gigamonkeys-unittest.

Public Interface
Internals

*test-name* (special variable).


3.1.3 periodic-table/elements.lisp

Dependency

unittest.lisp (file).

Source

periodic-table.asd.

Parent Component

periodic-table (system).

Packages

elements.

Public Interface
Internals

3.1.4 periodic-table/periodic-table.lisp

Dependency

elements.lisp (file).

Source

periodic-table.asd.

Parent Component

periodic-table (system).


4 Packages

Packages are listed by definition order.


4.1 periodic-table-system

Source

periodic-table.asd.

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

4.2 gigamonkeys-unittest

Source

unittest.lisp.

Use List

common-lisp.

Used By List

elements.

Public Interface
Internals

*test-name* (special variable).


4.3 elements

Source

elements.lisp.

Use List
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 Macros

Macro: check (&body forms)

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

Package

gigamonkeys-unittest.

Source

unittest.lisp.

Macro: combine-results (&body forms)

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

Package

gigamonkeys-unittest.

Source

unittest.lisp.

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.


5.1.2 Ordinary functions

Function: atomic-number-element (atomic-number)

Get an element from its atomic number

Package

elements.

Source

elements.lisp.

Function: atomic-weight-element (atomic-weight)

Get an element from its approximate atomic weight

Package

elements.

Source

elements.lisp.

Function: boiling-point-element (boiling-point)

Get an element from its approximate boiling point

Package

elements.

Source

elements.lisp.

Function: electronegativity-element (electronegativity)

Get an element from its approximate electronegativity

Package

elements.

Source

elements.lisp.

Reader: element-atomic-number (instance)
Writer: (setf element-atomic-number) (instance)
Package

elements.

Source

elements.lisp.

Target Slot

atomic-number.

Reader: element-atomic-weight (instance)
Writer: (setf element-atomic-weight) (instance)
Package

elements.

Source

elements.lisp.

Target Slot

atomic-weight.

Reader: element-boiling-point (instance)
Writer: (setf element-boiling-point) (instance)
Package

elements.

Source

elements.lisp.

Target Slot

boiling-point.

Reader: element-electronegativity (instance)
Writer: (setf element-electronegativity) (instance)
Package

elements.

Source

elements.lisp.

Target Slot

electronegativity.

Reader: element-name (instance)
Writer: (setf element-name) (instance)
Package

elements.

Source

elements.lisp.

Target Slot

name.

Reader: element-oxidation-states (instance)
Writer: (setf element-oxidation-states) (instance)
Package

elements.

Source

elements.lisp.

Target Slot

oxidation-states.

Reader: element-symbol (instance)
Writer: (setf element-symbol) (instance)
Package

elements.

Source

elements.lisp.

Target Slot

symbol.

Function: find-element-if (predicate)

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

Package

elements.

Source

elements.lisp.

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.

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.

Function: name-element (name)

Get an element from its name

Package

elements.

Source

elements.lisp.

Function: report-result (result form)

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

Package

gigamonkeys-unittest.

Source

unittest.lisp.

Function: symbol-element (symbol)

Get an element from its symbol

Package

elements.

Source

elements.lisp.

Function: test-elements ()
Package

elements.

Source

elements.lisp.

Function: test-get-element ()
Package

elements.

Source

elements.lisp.


5.1.3 Structures

Structure: element
Package

elements.

Source

elements.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: name
Type

string

Initform

""

Readers

element-name.

Writers

(setf element-name).

Slot: atomic-weight
Type

float

Initform

0.0

Readers

element-atomic-weight.

Writers

(setf element-atomic-weight).

Slot: atomic-number
Type

integer

Initform

0

Readers

element-atomic-number.

Writers

(setf element-atomic-number).

Slot: oxidation-states
Type

string

Initform

""

Readers

element-oxidation-states.

Writers

(setf element-oxidation-states).

Slot: boiling-point
Type

(or float null)

Initform

0.0

Readers

element-boiling-point.

Writers

(setf element-boiling-point).

Slot: symbol
Package

common-lisp.

Type

string

Initform

""

Readers

element-symbol.

Writers

(setf element-symbol).

Slot: electronegativity
Type

(or float null)

Initform

0.0

Readers

element-electronegativity.

Writers

(setf element-electronegativity).


5.2 Internals


5.2.1 Special variables

Special Variable: *elements-table*

Table of elements

Package

elements.

Source

elements.lisp.

Special Variable: *test-name*
Package

gigamonkeys-unittest.

Source

unittest.lisp.


5.2.2 Ordinary functions

Function: copy-element (instance)
Package

elements.

Source

elements.lisp.

Function: defelement (name atomic-weight atomic-number oxidation-states boiling-point symbol electronegativity)
Package

elements.

Source

elements.lisp.

Function: element-p (object)
Package

elements.

Source

elements.lisp.

Function: make-element (&key name atomic-weight atomic-number oxidation-states boiling-point symbol electronegativity)
Package

elements.

Source

elements.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

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

A
atomic-number-element: Public ordinary functions
atomic-weight-element: Public ordinary functions

B
boiling-point-element: Public ordinary functions

C
check: Public macros
combine-results: Public macros
copy-element: Private ordinary functions

D
defelement: Private ordinary functions
deftest: Public macros

E
electronegativity-element: Public ordinary functions
element-atomic-number: Public ordinary functions
element-atomic-weight: Public ordinary functions
element-boiling-point: Public ordinary functions
element-electronegativity: Public ordinary functions
element-name: Public ordinary functions
element-oxidation-states: Public ordinary functions
element-p: Private ordinary functions
element-symbol: Public ordinary functions

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

G
get-element: Public ordinary functions

M
Macro, check: Public macros
Macro, combine-results: Public macros
Macro, deftest: Public macros
make-element: Private ordinary functions

N
name-element: Public ordinary functions

R
report-result: Public ordinary functions

S
symbol-element: Public ordinary functions

T
test-elements: Public ordinary functions
test-get-element: Public ordinary functions