# The antik Reference Manual

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

# The antik Reference Manual

This is the antik Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 13:08:10 2018 GMT+0.

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

## 1 Introduction

Antik: a Common Lisp library for computational mathematics, science, and engineering.  It is named after the Antikythera Mechanism [http://www.antikythera-mechanism.gr/], one of the oldest known devices built and used for scientific computation.

Antik defines library functions for common mathematical operations used in science and engineering including arrays and physical (dimensioned) quantities.  It is expressly designed to facilitate the interchange of data with foreign (that is, non-lisp) libraries.  For example, GSLL, the GNU Scientific Library for Lisp, uses Antik.

There are several systems that comprise Antik and included in this repository:
- antik-base, formatting (numbers, etc.)
- grid, generalized arrays
- foreign-array, grids whose content is in foreign memory
- physical-dimension, quantities with physical properties (e.g., mass, length) and relationships
- mathematics, various definitions for applied mathematics
- date-time, manipulation and computation with dates and times

In addition, there are other systems used internally.



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

## 2 Systems

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

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

### 2.1 antik

Author

Liam M. Healy

GPL v3

Description

A library of numerical mathematics.

Dependencies
Source

antik.asd (file)

Components

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

### 2.2 physical-dimension

Author

Liam M. Healy

GPL v3

Description

A library to provide computations with physical dimension, i.e. units.

Dependencies
Source

physical-dimension.asd (file)

Components

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

### 2.3 foreign-array

Author

Liam M. Healy

GPL v3

Description

Dependencies
Source

foreign-array.asd (file)

Component

foreign-array (module)

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

### 2.4 antik-base

Author

Liam M. Healy

GPL v3

Description

Basic definitions providing a foundation for computational mathematics, science, and engineering.

Dependencies
• iterate
• alexandria
• metabang-bind
• cl-ppcre
• split-sequence
• lisp-unit
Source

antik-base.asd (file)

Components

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

## 3 Modules

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

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

### 3.1 antik/mathematics

Parent

antik (system)

Location

mathematics/

Components

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

### 3.2 antik/optimize

Dependency

mathematics (module)

Parent

antik (system)

Location

optimize/

Components

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

### 3.3 antik/linear-algebra

Dependency

optimize (module)

Parent

antik (system)

Location

linear-algebra/

Components

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

### 3.4 antik/sample

Dependency

linear-algebra (module)

Parent

antik (system)

Location

sample/

Component

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

### 3.5 physical-dimension/init

Parent

physical-dimension (system)

Location

init/

Component

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

### 3.6 physical-dimension/physical-quantities

Dependency

init (module)

Parent

physical-dimension (system)

Location

physical-quantities/

Components

### 3.7 physical-dimension/cartesian

Dependency

physical-quantities (module)

Parent

physical-dimension (system)

Location

cartesian/

Components

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

### 3.8 physical-dimension/date-time

Dependency

cartesian (module)

Parent

physical-dimension (system)

Location

date-time/

Components

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

### 3.9 physical-dimension/tests

Dependency

date-time (module)

Parent

physical-dimension (system)

Location

tests/

Components

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

### 3.10 foreign-array/foreign-array

Parent

foreign-array (system)

Location

foreign-array/

Components

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

### 3.11 foreign-array/foreign-array/tests

Parent

foreign-array (module)

Location

foreign-array/tests/

Components

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

### 3.12 antik-base/init

Parent

antik-base (system)

Location

init/

Components

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

### 3.13 antik-base/input-output

Dependency

init (module)

Parent

antik-base (system)

Location

input-output/

Components

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

### 3.14 antik-base/date-time

Dependency

input-output (module)

Parent

antik-base (system)

Location

date-time/

Components

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

### 3.15 antik-base/grid

Dependency

date-time (module)

Parent

antik-base (system)

Location

grid/

Components

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

### 3.16 antik-base/grid/affi

Parent

grid (module)

Location

grid/affi/

Components

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

### 3.17 antik-base/grid/tests

Parent

grid (module)

Location

grid/tests/

Components

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

### 3.18 antik-base/tests

Dependency

grid (module)

Parent

antik-base (system)

Location

tests/

Component

numbers.lisp (file)

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

## 4 Files

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

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

### 4.1 Lisp

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

#### 4.1.1 antik.asd

Location

antik.asd

Systems

antik (system)

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

#### 4.1.2 physical-dimension.asd

Location

physical-dimension.asd

Systems

physical-dimension (system)

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

#### 4.1.3 foreign-array.asd

Location

foreign-array.asd

Systems

foreign-array (system)

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

#### 4.1.4 antik-base.asd

Location

antik-base.asd

Systems

antik-base (system)

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

#### 4.1.5 antik/mathematics/integers.lisp

Parent

mathematics (module)

Location

mathematics/integers.lisp

Exported Definitions

prime-factors (function)

#### 4.1.6 antik/mathematics/trigonometry.lisp

Dependency

integers.lisp (file)

Parent

mathematics (module)

Location

mathematics/trigonometry.lisp

Exported Definitions

angle-law-of-cosines (function)

#### 4.1.7 antik/optimize/one-dim.lisp

Parent

optimize (module)

Location

optimize/one-dim.lisp

Exported Definitions

#### 4.1.8 antik/optimize/one-dim-pq.lisp

Parent

optimize (module)

Location

optimize/one-dim-pq.lisp

Exported Definitions

root-1d (method)

#### 4.1.9 antik/optimize/least-squares.lisp

Parent

optimize (module)

Location

optimize/least-squares.lisp

Exported Definitions

linear-least-squares-1d (function)

#### 4.1.10 antik/linear-algebra/linear-algebra.lisp

Parent

linear-algebra (module)

Location

linear-algebra/linear-algebra.lisp

Exported Definitions
Internal Definitions
• *i (method)
• *i (method)
• *i (method)
• +i (method)
• +i (method)
• +i (method)
• -i (method)
• -i (method)
• -i (method)
• /i (method)

#### 4.1.11 antik/linear-algebra/linear-algebra-tests.lisp

Parent

linear-algebra (module)

Location

linear-algebra/linear-algebra-tests.lisp

#### 4.1.12 antik/sample/low-discrepancy-sequence.lisp

Parent

sample (module)

Location

sample/low-discrepancy-sequence.lisp

Exported Definitions
Internal Definitions

Parent

init (module)

Location

#### 4.1.14 physical-dimension/physical-quantities/format-output.lisp

Parent

physical-quantities (module)

Location

physical-quantities/format-output.lisp

#### 4.1.15 physical-dimension/physical-quantities/units.lisp

Dependency

format-output.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/units.lisp

Exported Definitions
Internal Definitions

#### 4.1.16 physical-dimension/physical-quantities/scalar.lisp

Dependency

units.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/scalar.lisp

Exported Definitions
Internal Definitions

#### 4.1.17 physical-dimension/physical-quantities/funcall.lisp

Dependency

scalar.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/funcall.lisp

Internal Definitions

#### 4.1.18 physical-dimension/physical-quantities/unit-definitions.lisp

Dependency

funcall.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/unit-definitions.lisp

Exported Definitions
Internal Definitions

*degree-symbol* (special variable)

#### 4.1.19 physical-dimension/physical-quantities/degree-symbol.lisp

Dependency

unit-definitions.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/degree-symbol.lisp

#### 4.1.20 physical-dimension/physical-quantities/sysunit-definitions.lisp

Dependency

degree-symbol.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/sysunit-definitions.lisp

#### 4.1.21 physical-dimension/physical-quantities/physical-quantities.lisp

Dependency

sysunit-definitions.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/physical-quantities.lisp

Exported Definitions
Internal Definitions

#### 4.1.22 physical-dimension/physical-quantities/undimension.lisp

Dependency

physical-quantities.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/undimension.lisp

Exported Definitions
Internal Definitions

#### 4.1.23 physical-dimension/physical-quantities/arithmetic.lisp

Dependency

undimension.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/arithmetic.lisp

Exported Definitions
Internal Definitions

#### 4.1.24 physical-dimension/physical-quantities/angle.lisp

Dependency

arithmetic.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/angle.lisp

Exported Definitions
Internal Definitions

#### 4.1.25 physical-dimension/physical-quantities/angle-component.lisp

Dependency

angle.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/angle-component.lisp

Exported Definitions

#### 4.1.26 physical-dimension/physical-quantities/state.lisp

Dependency

angle-component.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/state.lisp

Exported Definitions
Internal Definitions

#### 4.1.27 physical-dimension/physical-quantities/grid.lisp

Dependency

state.lisp (file)

Parent

physical-quantities (module)

Location

physical-quantities/grid.lisp

Exported Definitions
Internal Definitions

#### 4.1.28 physical-dimension/cartesian/cartesian.lisp

Parent

cartesian (module)

Location

cartesian/cartesian.lisp

Exported Definitions

#### 4.1.29 physical-dimension/cartesian/polar.lisp

Dependency

cartesian.lisp (file)

Parent

cartesian (module)

Location

cartesian/polar.lisp

Exported Definitions

#### 4.1.30 physical-dimension/cartesian/rotation.lisp

Dependency

polar.lisp (file)

Parent

cartesian (module)

Location

cartesian/rotation.lisp

Exported Definitions
Internal Definitions

#### 4.1.31 physical-dimension/date-time/time-interval.lisp

Parent

date-time (module)

Location

date-time/time-interval.lisp

Exported Definitions
Internal Definitions

time-interval-format (function)

#### 4.1.32 physical-dimension/date-time/relative-time.lisp

Dependency

time-interval.lisp (file)

Parent

date-time (module)

Location

date-time/relative-time.lisp

Exported Definitions

#### 4.1.33 physical-dimension/date-time/linear-timepoint.lisp

Dependency

relative-time.lisp (file)

Parent

date-time (module)

Location

date-time/linear-timepoint.lisp

Internal Definitions

#### 4.1.34 physical-dimension/date-time/dtmath.lisp

Dependency

linear-timepoint.lisp (file)

Parent

date-time (module)

Location

date-time/dtmath.lisp

Exported Definitions
Internal Definitions

#### 4.1.35 physical-dimension/date-time/ut1.lisp

Dependency

dtmath.lisp (file)

Parent

date-time (module)

Location

date-time/ut1.lisp

Exported Definitions

*real-ut1-utc* (special variable)

Internal Definitions

#### 4.1.36 physical-dimension/date-time/time-interval-tests.lisp

Dependency

ut1.lisp (file)

Parent

date-time (module)

Location

date-time/time-interval-tests.lisp

Internal Definitions

piti (macro)

#### 4.1.37 physical-dimension/tests/physical-quantities.lisp

Parent

tests (module)

Location

tests/physical-quantities.lisp

Internal Definitions

check-pq (function)

#### 4.1.38 physical-dimension/tests/physical-quantities-grid.lisp

Dependency

physical-quantities.lisp (file)

Parent

tests (module)

Location

tests/physical-quantities-grid.lisp

#### 4.1.39 physical-dimension/tests/format-grid.lisp

Dependency
Parent

tests (module)

Location

tests/format-grid.lisp

Internal Definitions

#### 4.1.40 foreign-array/foreign-array/types.lisp

Parent

foreign-array (module)

Location

foreign-array/types.lisp

Exported Definitions
Internal Definitions

#### 4.1.41 foreign-array/foreign-array/complex-types.lisp

Dependency

types.lisp (file)

Parent

foreign-array (module)

Location

foreign-array/complex-types.lisp

Exported Definitions
Internal Definitions

#### 4.1.42 foreign-array/foreign-array/element-types.lisp

Dependencies
Parent

foreign-array (module)

Location

foreign-array/element-types.lisp

Exported Definitions

#### 4.1.43 foreign-array/foreign-array/symbol-type.lisp

Parent

foreign-array (module)

Location

foreign-array/symbol-type.lisp

Exported Definitions

#### 4.1.44 foreign-array/foreign-array/number-conversion.lisp

Dependencies
Parent

foreign-array (module)

Location

foreign-array/number-conversion.lisp

Exported Definitions

dcref (macro)

#### 4.1.45 foreign-array/foreign-array/subclass.lisp

Dependency

element-types.lisp (file)

Parent

foreign-array (module)

Location

foreign-array/subclass.lisp

Exported Definitions

data-class-name (function)

Internal Definitions

#### 4.1.46 foreign-array/foreign-array/foreign-array.lisp

Dependencies
Parent

foreign-array (module)

Location

foreign-array/foreign-array.lisp

Exported Definitions
Internal Definitions

#### 4.1.47 foreign-array/foreign-array/vector-matrix.lisp

Dependencies
Parent

foreign-array (module)

Location

foreign-array/vector-matrix.lisp

Exported Definitions

#### 4.1.48 foreign-array/foreign-array/methods.lisp

Dependencies
Parent

foreign-array (module)

Location

foreign-array/methods.lisp

Exported Definitions
Internal Definitions

#### 4.1.49 foreign-array/foreign-array/format-output.lisp

Parent

foreign-array (module)

Location

foreign-array/format-output.lisp

Exported Definitions

#### 4.1.50 foreign-array/foreign-array/tests/aref.lisp

Parent

tests (module)

Location

foreign-array/tests/aref.lisp

Internal Definitions

make-grid-set-get (macro)

#### 4.1.51 foreign-array/foreign-array/tests/lisp-unit-extension.lisp

Parent

tests (module)

Location

foreign-array/tests/lisp-unit-extension.lisp

#### 4.1.52 foreign-array/foreign-array/tests/compose.lisp

Parent

tests (module)

Location

foreign-array/tests/compose.lisp

#### 4.1.53 antik-base/init/package.lisp

Parent

init (module)

Location

init/package.lisp

Packages
Exported Definitions
Internal Definitions

#### 4.1.54 antik-base/init/utility.lisp

Dependency

package.lisp (file)

Parent

init (module)

Location

init/utility.lisp

Exported Definitions
Internal Definitions

#### 4.1.55 antik-base/init/conditions.lisp

Dependency

utility.lisp (file)

Parent

init (module)

Location

init/conditions.lisp

Exported Definitions
Internal Definitions

#### 4.1.56 antik-base/init/object.lisp

Dependency

conditions.lisp (file)

Parent

init (module)

Location

init/object.lisp

Exported Definitions

#### 4.1.57 antik-base/init/iterate.lisp

Dependency

object.lisp (file)

Parent

init (module)

Location

init/iterate.lisp

#### 4.1.58 antik-base/init/intermediate.lisp

Dependency

iterate.lisp (file)

Parent

init (module)

Location

init/intermediate.lisp

Exported Definitions
Internal Definitions

#### 4.1.59 antik-base/init/generic.lisp

Dependency

intermediate.lisp (file)

Parent

init (module)

Location

init/generic.lisp

Exported Definitions
Internal Definitions

Parent

input-output (module)

Location

Exported Definitions

#### 4.1.61 antik-base/input-output/parameters.lisp

Dependency

Parent

input-output (module)

Location

input-output/parameters.lisp

Exported Definitions
Internal Definitions

#### 4.1.62 antik-base/input-output/format-output.lisp

Dependency

parameters.lisp (file)

Parent

input-output (module)

Location

input-output/format-output.lisp

Exported Definitions
Internal Definitions

#### 4.1.63 antik-base/input-output/float.lisp

Dependency

format-output.lisp (file)

Parent

input-output (module)

Location

input-output/float.lisp

Exported Definitions
Internal Definitions

#### 4.1.64 antik-base/input-output/matlab.lisp

Dependency

float.lisp (file)

Parent

input-output (module)

Location

input-output/matlab.lisp

Exported Definitions

format-matlab-list (function)

#### 4.1.65 antik-base/input-output/org-mode.lisp

Dependency

matlab.lisp (file)

Parent

input-output (module)

Location

input-output/org-mode.lisp

Exported Definitions

#### 4.1.66 antik-base/input-output/write.lisp

Dependency

org-mode.lisp (file)

Parent

input-output (module)

Location

input-output/write.lisp

Exported Definitions

write-data (function)

Dependency

write.lisp (file)

Parent

input-output (module)

Location

Exported Definitions
Internal Definitions

#### 4.1.68 antik-base/date-time/format-output.lisp

Parent

date-time (module)

Location

date-time/format-output.lisp

#### 4.1.69 antik-base/date-time/iso8601.lisp

Dependency

format-output.lisp (file)

Parent

date-time (module)

Location

date-time/iso8601.lisp

Internal Definitions

#### 4.1.70 antik-base/date-time/dtspec.lisp

Dependency

iso8601.lisp (file)

Parent

date-time (module)

Location

date-time/dtspec.lisp

Exported Definitions
Internal Definitions

#### 4.1.71 antik-base/date-time/formats.lisp

Dependency

dtspec.lisp (file)

Parent

date-time (module)

Location

date-time/formats.lisp

Exported Definitions
Internal Definitions

#### 4.1.72 antik-base/date-time/timepoint.lisp

Dependency

formats.lisp (file)

Parent

date-time (module)

Location

date-time/timepoint.lisp

Exported Definitions
Internal Definitions

Dependency

timepoint.lisp (file)

Parent

date-time (module)

Location

Exported Definitions
Internal Definitions

#### 4.1.74 antik-base/date-time/convert-timescale.lisp

Dependency

Parent

date-time (module)

Location

date-time/convert-timescale.lisp

Exported Definitions

convert-time-scale (function)

Internal Definitions

#### 4.1.75 antik-base/grid/util.lisp

Parent

grid (module)

Location

grid/util.lisp

Exported Definitions
Internal Definitions

#### 4.1.76 antik-base/grid/affi/package.lisp

Parent

affi (module)

Location

grid/affi/package.lisp

Packages

#### 4.1.77 antik-base/grid/affi/utility.lisp

Dependency

package.lisp (file)

Parent

affi (module)

Location

grid/affi/utility.lisp

Internal Definitions

#### 4.1.78 antik-base/grid/affi/affi.lisp

Dependency

utility.lisp (file)

Parent

affi (module)

Location

grid/affi/affi.lisp

Exported Definitions
Internal Definitions

#### 4.1.79 antik-base/grid/affi/transformers.lisp

Dependency

affi.lisp (file)

Parent

affi (module)

Location

grid/affi/transformers.lisp

Exported Definitions
Internal Definitions

#### 4.1.80 antik-base/grid/functions.lisp

Dependencies
Parent

grid (module)

Location

grid/functions.lisp

Exported Definitions
Internal Definitions

#### 4.1.81 antik-base/grid/specification.lisp

Dependencies
Parent

grid (module)

Location

grid/specification.lisp

Exported Definitions

spec-scalar-p (function)

Internal Definitions

#### 4.1.82 antik-base/grid/array.lisp

Dependencies
Parent

grid (module)

Location

grid/array.lisp

Exported Definitions
Internal Definitions

#### 4.1.83 antik-base/grid/map.lisp

Dependencies
Parent

grid (module)

Location

grid/map.lisp

Exported Definitions
Internal Definitions

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

#### 4.1.84 antik-base/grid/compose.lisp

Dependencies
Parent

grid (module)

Location

grid/compose.lisp

Exported Definitions

#### 4.1.85 antik-base/grid/slice.lisp

Dependency

affi (module)

Parent

grid (module)

Location

grid/slice.lisp

Exported Definitions

slice (function)

Internal Definitions

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

#### 4.1.86 antik-base/grid/norm-vector-product.lisp

Dependencies
Parent

grid (module)

Location

grid/norm-vector-product.lisp

Exported Definitions

#### 4.1.87 antik-base/grid/copy.lisp

Parent

grid (module)

Location

grid/copy.lisp

Exported Definitions
Internal Definitions

copy-grid (function)

#### 4.1.88 antik-base/grid/iterate.lisp

Dependency

compose.lisp (file)

Parent

grid (module)

Location

grid/iterate.lisp

#### 4.1.89 antik-base/grid/mathematics.lisp

Dependency

map.lisp (file)

Parent

grid (module)

Location

grid/mathematics.lisp

Exported Definitions
Internal Definitions
• *i (method)
• *i (method)
• +i (method)
• +i (method)
• -i (method)
• -i (method)
• /i (method)
• /i (method)

#### 4.1.90 antik-base/grid/index-functions.lisp

Parent

grid (module)

Location

grid/index-functions.lisp

Exported Definitions

#### 4.1.91 antik-base/grid/indexed.lisp

Dependency

specification.lisp (file)

Parent

grid (module)

Location

grid/indexed.lisp

Exported Definitions

#### 4.1.92 antik-base/grid/format-output.lisp

Parent

grid (module)

Location

grid/format-output.lisp

Exported Definitions
• nf (method)
• nf (method)
Internal Definitions

#### 4.1.93 antik-base/grid/parameters.lisp

Parent

grid (module)

Location

grid/parameters.lisp

Exported Definitions

make-parameters-from-table (function)

#### 4.1.94 antik-base/grid/tests/augment.lisp

Parent

tests (module)

Location

grid/tests/augment.lisp

Internal Definitions

#### 4.1.95 antik-base/grid/tests/sequence.lisp

Parent

tests (module)

Location

grid/tests/sequence.lisp

#### 4.1.96 antik-base/grid/tests/compose.lisp

Parent

tests (module)

Location

grid/tests/compose.lisp

#### 4.1.97 antik-base/grid/tests/map.lisp

Parent

tests (module)

Location

grid/tests/map.lisp

#### 4.1.98 antik-base/grid/tests/slice.lisp

Parent

tests (module)

Location

grid/tests/slice.lisp

#### 4.1.99 antik-base/grid/tests/norm-vector-product.lisp

Parent

tests (module)

Location

grid/tests/norm-vector-product.lisp

#### 4.1.100 antik-base/tests/numbers.lisp

Parent

tests (module)

Location

tests/numbers.lisp

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

## 5 Packages

Packages are listed by definition order.

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

### 5.1 grid

Source

package.lisp (file)

Use List

common-lisp

Used By List

antik-user

Exported Definitions
Internal Definitions

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

### 5.2 antik

Source

package.lisp (file)

Use List
• iterate
• common-lisp
Used By List

antik-user

Exported Definitions
Internal Definitions

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

### 5.3 affi

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

## 6 Definitions

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

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

### 6.1 Exported definitions

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

#### 6.1.1 Constants

Constant: +days-per-month+
Package
Source

dtspec.lisp (file)

Constant: +foreign-pointer-class+

The class in which foreign pointers fall.

Package
Source

types.lisp (file)

Constant: +foreign-pointer-type+

The type of foreign pointers.

Package
Source

types.lisp (file)

Constant: +hours-per-day+
Package
Source

dtspec.lisp (file)

Constant: +minutes-per-hour+
Package
Source

dtspec.lisp (file)

Constant: +months-per-year+
Package
Source

dtspec.lisp (file)

Constant: +seconds-per-day+
Package
Source

dtspec.lisp (file)

Constant: +seconds-per-hour+
Package
Source

dtspec.lisp (file)

Constant: +seconds-per-minute+
Package
Source

dtspec.lisp (file)

Constant: +seconds-per-month+
Package
Source

dtspec.lisp (file)

Constant: +seconds-per-year+
Package
Source

dtspec.lisp (file)

Constant: 2pi
Package
Source

unit-definitions.lisp (file)

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

#### 6.1.2 Special variables

Special Variable: *array-element-types*

All the array element types supported.

Package
Source

element-types.lisp (file)

Special Variable: *array-element-types-no-complex*

All the array element types supported except for complex types.

Package
Source

element-types.lisp (file)

Special Variable: *code-block-eval-nf-options*

NF options for LaTeX output generated from parameters.

Package
Source

org-mode.lisp (file)

Special Variable: *complex-types*

All the supported complex array element types.

Package
Source

element-types.lisp (file)

Special Variable: *cstd-cl-type-mapping*

An alist of the C standard types as keywords, and the CL type The exception is complex types, which don’t have a definition in the C standard; in that case, the C type is the foreign struct definition.

Package
Source

types.lisp (file)

Package
Source

dtspec.lisp (file)

Special Variable: *default-dimensions*
Package
Source

functions.lisp (file)

Special Variable: *default-element-type*
Package
Source

types.lisp (file)

Special Variable: *default-grid-type*
Package
Source

functions.lisp (file)

Special Variable: *default-sfg*

The default state function generator.

Package
Source

state.lisp (file)

Special Variable: *double-types*

All the supported double float element types.

Package
Source

element-types.lisp (file)

Special Variable: *float-complex-types*

All the float or complex array element types supported.

Package
Source

element-types.lisp (file)

Special Variable: *float-types*

All the float array element types.

Package
Source

element-types.lisp (file)

Special Variable: *format-float-significant-figures*

The default number of significant figures in floating point number output.

Package
Source

float.lisp (file)

Special Variable: *grid-types*

A list of (disjoint) types that are accepted as grids. Not every object of the given type is necessarily a grid, however.

Package
Source

functions.lisp (file)

Special Variable: *prehistoric*
Package
Source

Special Variable: *print-contents*

Print the contents of the foreign-array.

Package
Source

foreign-array.lisp (file)

Print the contents of the foreign-array with the #m reader macro.

Package
Source

format-output.lisp (file)

Special Variable: *real-ut1-utc*

If NIL, user wants UT1 to be the same as UTC.

Package
Source

ut1.lisp (file)

Special Variable: *return-formula*

Show the formula used in computing the attribute.

Package
Source

state.lisp (file)

Special Variable: *timepoint-print-scale*

Convert timepoints to this timescale for printing. If nil, use the internal time scale (UTC).

Package
Source

timepoint.lisp (file)

Special Variable: *timepoint-print-scale-name*

When T, print the scale (UTC, TAI, etc.) with a timepoint.

Package
Source

timepoint.lisp (file)

Special Variable: *timescales*

All known time scales.

Package
Source

Use the readable print form in creation-form if available.

Package
Source

object.lisp (file)

Special Variable: *zero-is-dimensionless*

Numbers with zero magnitude are made dimensionless.

Package
Source

scalar.lisp (file)

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

#### 6.1.3 Symbol macros

Symbol Macro: @
Package
Source

package.lisp (file)

Expansion

*

Symbol Macro: half-revolution
Package
Source

unit-definitions.lisp (file)

Expansion

(antik:pqwu (antik:make-pq 1/2 (quote antik:revolution)))

Symbol Macro: now
Package
Source

timepoint.lisp (file)

Expansion

(antik:clut-to-timepoint (get-universal-time))

Package
Source

unit-definitions.lisp (file)

Expansion

Symbol Macro: revolution
Package
Source

unit-definitions.lisp (file)

Expansion

(antik:pqwu (antik:make-pq 1 (quote antik:revolution)))

Symbol Macro: texstyle
Package
Source

format-output.lisp (file)

Expansion

(and (eq (antik:nf-option :style) :tex))

Symbol Macro: today
Package
Source

timepoint.lisp (file)

Expansion

(antik:clut-to-timepoint (get-universal-time) t)

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

#### 6.1.4 Macros

Macro: accept-coerce &body BODY

A handler to accept coerced object.

Package
Source

conditions.lisp (file)

Macro: arithmetic-errors-return-nan &body BODY

Return a NaN for a variety of arithmetic errors.

Package
Source

conditions.lisp (file)

Macro: components NAME

Components of vector.

Package
Source

state.lisp (file)

Macro: constraints NAME

Constraint on acceptable values.

Package
Source

state.lisp (file)

If we are printing readably, then rely on printed form to create the new object.

Package
Source

object.lisp (file)

Macro: dcref DOUBLE &optional INDEX

Reference C double(s).

Package
Source

number-conversion.lisp (file)

Macro: decf REF &optional DELTA
Package
Source

generic.lisp (file)

Macro: def-dyadic-scalar METHOD &optional OPERATION LEFT RIGHT

Define a method of the operation that operates elementwise on a grid.

Package
Source

mathematics.lisp (file)

Defmethod the make-load-form assuming creation-form exists.

Package
Source

object.lisp (file)

Define a method of the operation that operates elementwise on a grid.

Package
Source

mathematics.lisp (file)

Macro: defattribute NAME DIMENSION &optional SYNONYMS PRINT-NAMES DESCRIPTION COMPONENTS CONSTRAINTS MAKE-FUNCTION

Define an attribute of a physical system. The name should not be the same as a physical dimension or unit name.

Package
Source

state.lisp (file)

Macro: define-parameter CATEGORY NAME &key VALUE TYPE ATTRIBUTE DOCUMENTATION SYNONYMS

Define the parameter (global special variable) with the given name. It will be defined in the package named by category (which will be created if necessary), and exported from it.

Package
Source

parameters.lisp (file)

Macro: define-physical-constant NAME VALUE &optional SYNONYMS PRINT-NAME DOCSTRING

Define the variable to be the physical dimension quantity given, and also make it a unit of measure.

Package
Source

units.lisp (file)

Macro: define-system-of-units SYSTEM-NAME UNITS &optional AUGEMENTED-SYSTEM

Define a system of units with the given name and units, possibly by augmenting the named system of units.

Package
Source

units.lisp (file)

Macro: dimension UNIT-OR-DIMENSION

The dimension as a dimel (list of exponents) from a unit name or dimension name.

Package
Source

units.lisp (file)

Macro: dimensionless-call FUNCTION ANSWER-DIMENSION &rest ARGUMENTS

Call a function that is incapable of handling physical dimension quantities. This macro will consistently remove the units from all arguments, then create the answer with the specified units.

Package
Source

undimension.lisp (file)

Macro: export-value FORM &optional NF-OPTIONS

The form value formatted for tex. Useful in embedded org-mode code block evaluation as e.g. src_lisp[:results raw]{(export-value xyz)}.

Package
Source

org-mode.lisp (file)

Macro: floating-point-association SPLICE-LIST
Package
Source

types.lisp (file)

Macro: gsetf &rest ARGS
Package
Source

methods.lisp (file)

Macro: handling-complex-number RESTART &body BODY

A handler to make the complex number.

Package
Source

conditions.lisp (file)

Macro: incf REF &optional DELTA
Package
Source

generic.lisp (file)

Macro: length &rest ARGS
Package
Source

utility.lisp (file)

Access a slot in the foreign-metadata.

Package
Source

foreign-array.lisp (file)

Macro: nf-option NAME

Get/set the nf option named.

Package
Source

format-output.lisp (file)

Macro: parameter-value CATEGORY NAME

Get or set the parameter value.

Package
Source

parameters.lisp (file)

Setf Expander

(setf parameter-value) (setf expander)

Setf Expander: (setf parameter-value) CATEGORY NAME VALUE
Package
Source

parameters.lisp (file)

parameter-value (macro)

Writer

set-parameter (macro)

Macro: pedagogical KEYWORD &body BODY
Package
Source

intermediate.lisp (file)

Macro: print-name UNIT

How a unit is printed.

Package
Source

units.lisp (file)

Macro: pythagorean-complement X

The square root sqrt(1-x^2).

Package
Source

utility.lisp (file)

Macro: pythagorean-sum &rest ARGS

Sum the squares of the arguments.

Package
Source

utility.lisp (file)

Macro: see-intermediate-value KEYWORD LABEL FORM

If keyword is in *pedagogical*, then print returned value of form, and return it; otherwise, just evaluate the form and return.

Package
Source

intermediate.lisp (file)

Macro: see-values KEYWORD SKIPPING-COMPUTE FORMAT-STRING &rest ARGS

If keyword is in *pedagogical*, then print returned value of form,
and return it; otherwise, just evaluate the form and return.
If skipping-compute is true, forms are evaluated left to right, whether or not the keyword is in *pedagogical*.
If it is false, they are only evaluated if keyword is in *pedagogical*, and the last one is returned from this form.

Package
Source

intermediate.lisp (file)

Macro: serialize-binding SYMBOL

Generate a form that when loaded will redefine the object and bind the variable to it.

Package
Source

object.lisp (file)

Macro: set-nf-options &rest NAME-VALUES

Set the numerical formatting options.

Package
Source

format-output.lisp (file)

Macro: set-parameter CATEGORY NAME VALUE

Set the parameter value, checking that the name is legitimate and the value is of the correct type.

Package
Source

parameters.lisp (file)

Setf Expander

(setf parameter-value) (setf expander)

Macro: set-parameters CATEGORY &rest NAMES-VALUES

Set the values of the parameters.

Package
Source

parameters.lisp (file)

If readtable is true, set the reader to enable the three Antik reader macros “#_“ (physical dimension quantity), “#d“ (date/time), “#m“ (grid). Set the reader to interpret float literals without an exponent marker to be the type specified. If “NIL“, leave as-is. Use this form in Lisp source files.

Package
Source

Macro: time &rest ARGS
Package
Source

utility.lisp (file)

Macro: val CATEGORY VARIABLE &optional NF-OPTIONS

The parameter value formatted for tex. Useful in embedded org-mode code block evaluation as e.g. src_lisp[:results raw]{(val P1020 B)}.

Package
Source

org-mode.lisp (file)

Macro: with-nf-options (&rest NAME-VALUES) &body BODY

Set the options for all nf calls within body to inherit.

Package
Source

format-output.lisp (file)

Macro: with-parameters (CATEGORY &rest NAME-VALUES) &body BODY

Provide local scope for parameter values, and possibly bind new values.

Package
Source

parameters.lisp (file)

Macro: with-pq PHYSICAL-QUANTITIES &body BODY

Ensure that the named physical dimension quantities are of the right dimensions, or convert them from plain numbers using the current system of units as specified by (nf-option :system-of-units).

Package
Source

physical-quantities.lisp (file)

Macro: with-si-units &body BODY

Use the SI system of units in the body.

Package
Source

units.lisp (file)

Macro: with-system-of-units (SYSTEM-OF-UNITS &rest UNITS) &body BODY

When executing the body, change the system of units by naming the units. If system-of-units is non-nil, augment that system with the specified units; if it is T, augment the current system of units.

Package
Source

units.lisp (file)

Macro: with-units &body BODY

Compute everything within the dynamic scope with physical units, when there is an outer dynamic scope with without-units. Remove units from returned value of body.

Package
Source

undimension.lisp (file)

Macro: without-units (&optional SYSTEM-OF-UNITS) &body BODY

Compute everything within the dynamic scope without physical units. Physical dimension quantities should be wrapped with #’pqwu.

Package
Source

undimension.lisp (file)

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

#### 6.1.5 Compiler macros

Compiler Macro: aref OBJECT &rest INDICES

Expand the aref form directly into a faster call if the type is known at compile time.

Package
Source

methods.lisp (file)

Compiler Macro: aref* OBJECT LINEARIZED-INDEX

Expand the aref* form directly into a faster call if the type is known at compile time.

Package
Source

methods.lisp (file)

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

#### 6.1.6 Functions

Function: * &rest ARGS

Multiplication of generalized or regular numbers with an arbitrary number of arguments.

Package
Source

generic.lisp (file)

Function: + &rest ARGS

Addition of generalized or regular numbers with an arbitrary number of arguments.

Package
Source

generic.lisp (file)

Function: - &rest ARGS

Subtraction of generalized or regular numbers.

Package
Source

generic.lisp (file)

Function: / &rest ARGS

Division of generalized or regular numbers for an arbitrary number of arguments.

Package
Source

generic.lisp (file)

Function: < &rest ARGS
Package
Source

generic.lisp (file)

Function: <= &rest ARGS
Package
Source

generic.lisp (file)

Function: = &rest ARGS
Package
Source

generic.lisp (file)

Function: > &rest ARGS
Package
Source

generic.lisp (file)

Function: >= &rest ARGS
Package
Source

generic.lisp (file)

Function: all-same LIST &key TEST POST-FUNCTION

If all elements are the same, that value and T are returned; if not, NIL and NIL are returned. The post-function is applied to the common value before returning the answer if there is one.

Package
Source

utility.lisp (file)

Function: all-types ALIST &optional RIGHT-SIDE

A list of all types defined by symbol or definition.

Package
Source

types.lisp (file)

Function: angle-as-time ANGLE &optional NORMALIZE

Convert the angle to a time (interval), where one revolution is a complete day.

Package
Source

angle.lisp (file)

Function: angle-dms DEGREES-OR-HOURS MINUTES SECONDS &optional HOURS

Read the angle as degrees (or hours), minutes and seconds.
With hours=T computes the hour angle, where a minute is 1/60 of
15 degrees instead of 1/60 of 1 degree. This option is the inverse of angle-as-time.

Package
Source

angle.lisp (file)

Solve for the angle when lengths of a triangle are known.

Package
Source

trigonometry.lisp (file)

Function: apply-to-arguments FUNCTION ARGUMENT-ORDER ARGUMENT-LIST

Apply the function to the arguments given, where the argument list is a list of (argument-name argument-value).

Package
Source
Function: attributep SYMBOL-OR-LIST &optional ERROR

This is a defined attribute, or list of attributes.

Package
Source

state.lisp (file)

Function: calculate-index AFFI SUBSCRIPTS

Calculate the index of a given vector of subscripts.

Package
Source

affi.lisp (file)

Function: cffi-cl CFFI-TYPE

The CL type from the CFFI element type.

Package
Source

types.lisp (file)

Function: check-conformability AFFI1 AFFI2 &optional CONFORMABILITY

Check that two affine indexes are conformable. There are three types of conformability: :strict requires that the two domains are exactly the same, :dropped checks if they are the same when we drop dimensions of size 1, and :size just checks the size of the two ranges.

Package
Source

affi.lisp (file)

Function: check-dimension OBJ UNITS &optional ERRORP ZEROS-HAVE-ANY-DIMENSION

T if one of these cases hold:
- obj is a pdq and units have the same dimension as obj,
- obj is zero and zeros-have-any-dimension is T,
- obj and units represent a dimensionless quantity,
- obj and units are grids of the same length, and for
each pair of corresponding elements, one of the above is true.

Package
Source

physical-quantities.lisp (file)

Function: check-dimensions DIMENSIONS &optional ERRORP

Check that dimension specification for a grid is a list of positive integers.

Package
Source

array.lisp (file)

Function: cl-cffi CL-TYPE

The CFFI element type from the CL type.

Package
Source

types.lisp (file)

Function: cl-single CL-TYPE &optional PACKAGE

The element type name as a single symbol.

Package
Source

types.lisp (file)

Function: clut-to-timepoint CLUT &optional DAY-ONLY

Compute the timepoint from the CLUT.

Package
Source

timepoint.lisp (file)

Function: codimension-one-subspace GRID POSITION INDEX &optional DESTINATION

Select a subspace with rank one less than the argument grid. The position is a non-negative number indicating which dimension is to be dropped, and index is the fixed value it should have. If destination is specified, the result will be written to that grid.

Package
Source

compose.lisp (file)

Writer

(setf codimension-one-subspace) (function)

Function: (setf codimension-one-subspace) SUBGRID GRID POSITION INDEX

Set a subspace with rank one less than the argument grid. The index is a non-negative number indicating which dimension is to be dropped, and position is the fixed value it should have.

Package
Source

compose.lisp (file)

codimension-one-subspace (function)

Function: column GRID INDEX &optional DESTINATION

The subgrid with the second index set to the specified value.

Package
Source

compose.lisp (file)

Writer

(setf column) (function)

Function: (setf column) SUBGRID GRID INDEX

Set the subgrid with the second index set to the specified value.

Package
Source

compose.lisp (file)

column (function)

Function: component-float-type ELTYPE

The type of the component of this type (complex).

Package
Source

complex-types.lisp (file)

Function: component-type ELTYPE
Package
Source

complex-types.lisp (file)

Function: concatenate-grids GRID0 GRID1 &key AXIS

Concatenate the grids along the axis specified. The new grid will have the grid type specification and element type as grid0.

Package
Source

compose.lisp (file)

Function: contents GRID

The contents of the grid as nested lists. This can be used as the :initial-contents argument in making a new grid.

Package
Source

functions.lisp (file)

Function: convert-time-scale TIMEPOINT NEW-SCALE

Convert time from one scale to another.

Package
Source

convert-timescale.lisp (file)

Function: coordinate-unit-vector I &optional LENGTH

A coordinate unit vector.

Package
Source

cartesian.lisp (file)

Function: coplanar VECT1-OR-MATRIX &optional VECT2 VECT3

The cosine of the angle between vect1 and the cross product of vect2 and vect3. This should be near zero if the vectors are coplanar.

Package
Source

cartesian.lisp (file)

Function: copy-state ORIGINAL-STATE &rest ATTRIBUTES

Make a new state with the same attributes as an existing state. The attributes specified are computed if needed.

Package
Source

state.lisp (file)

Function: copy-to OBJECT &optional TYPE ELEMENT-TYPE

Make a grid of the specified type from the object. This is different from #’copy in that it takes the default values for the destinatoin from special variables rather than the argument. This is provided only as a convenience for interactive use and should not be used in distributed software where the user may change the specials with unexpected results.

Package
Source

copy.lisp (file)

Function: cross GRID0 GRID1

The cross product of two vectors, using the first three components of each.

Package
Source

norm-vector-product.lisp (file)

Function: data-class-name CATEGORY-OR-RANK ELEMENT-TYPE &optional MAKING-CLASS

The class name from the type of element.

Package
Source

subclass.lisp (file)

Function: datime+ TP TIME

Add the time to the timepoint. If time is a number, it is assumed to represent seconds.

Package
Source

dtmath.lisp (file)

Function: datime- DATIME1 B

The difference of the datimes, or subtract a time from a datime.

Package
Source

dtmath.lisp (file)

Function: datime-j2000day DATIME

Julian Day from J2000 epoch, and seconds from the start of the day.

Package
Source

dtmath.lisp (file)

Function: datime-relation RELATION ARGS

Apply the relation to all the datime arguments and return what it returns.

Package
Source

dtspec.lisp (file)

Function: datime< &rest ARGS
Package
Source

dtspec.lisp (file)

Function: datime<= &rest ARGS
Package
Source

dtspec.lisp (file)

Function: datime= &rest ARGS
Package
Source

dtspec.lisp (file)

Function: datime> &rest ARGS
Package
Source

dtspec.lisp (file)

Function: datime>= &rest ARGS
Package
Source

dtspec.lisp (file)

Function: days+ DATIME &optional INCREMENT

Add the number of days to the given datime.

Package
Source

dtmath.lisp (file)

Function: days- DATIME1 DATIME2

Integer number of days separating the days. Differs from datime-
in that the time of day doesn’t matter, just the day on which the two datimes occur.

Package
Source

dtmath.lisp (file)

Function: define-unit UNIT DEFINITION &optional SYNONYMS PRINT-NAME DIMENSION RATIONALIZE

Define the unit. If the definition is a number then the dimension information will be extracted from dimension.

Package
Source

units.lisp (file)

Function: define-units DIMENSION UNIT-DEF-SYN-PNM

Define the units given. The second argument is a list of lists, each consisting of a unit name, its definition, and a list of synonyms.

Package
Source

units.lisp (file)

Function: determinant MATRIX

Find the determinant of the matrix.

Package
Source

linear-algebra.lisp (file)

Function: diagonal GRID &key OFFSET INDICES DESTINATION START

Select a subgrid where the two indices are equal or
differ by the offset, e.g. the diagonal affi for the matrix. The offset specifies sub- (offset<0) or super- (offset>0) diagonals.

Package
Source

compose.lisp (file)

Writer

(setf diagonal) (function)

Function: (setf diagonal) DIAGONAL GRID &key OFFSET INDICES

Set a subgrid where the two indices are equal or
differ by the offset, e.g. the diagonal affi for the matrix. The offset specifies sub- (offset<0) or super- (offset>0) diagonals. If grid is not supplied, a grid of one higher dimension than diagonal with default element 0 is used.

Package
Source

compose.lisp (file)

diagonal (function)

Function: diagonal AFFI &optional OFFSET INDICES

Select a subarray where the two indices are equal or differ by the offset, e.g. the diagonal affi for the matrix. The offset specifies sub- (offset<0) or super- (offset>0) diagonals.

Package
Source

transformers.lisp (file)

Function: dim0 OBJECT

The first dimension of the object.

Package
Source

util.lisp (file)

Function: dim1 OBJECT

The second dimension of the object.

Package
Source

util.lisp (file)

Function: distance A B &optional COMBINATION-FUNCTION

The length of the vector and the vector difference a-b.

Package
Source

cartesian.lisp (file)

Function: dms-angle ANGLE

The angle as a list degrees, minutes, seconds.

Package
Source

angle.lisp (file)

Function: drop GRID &key DESTINATION DROP

Remove singleton axes (axes with dimension 1) if the argument drop is true; otherwise return the input grid unchanged. The destination is an optional pre-existing grid in which to write the result.

Package
Source

compose.lisp (file)

Function: drop AFFI &optional WHICH

Drop the dimensions from the domain which have size 1, provided that their index is in ‘which’, or ‘which’ is t. Return new affine index. If ‘which’ is nil, no dimension is dropped.

Package
Source

transformers.lisp (file)

Function: dtspec-from-julian-day-number JULIAN-DAY-NUMBER &optional MODIFIED

Find the dtspec for the given (modified) Julian day.
Algorithm given in http://www.pauahtun.org/CalendarFAQ/cal/node3.html#SECTION003151000000000000000.

Package
Source

dtspec.lisp (file)

Function: element-size OBJECT

The size of each element as stored in C.

Package
Source

element-types.lisp (file)

Function: element-types ELEMENT-TYPES

All the element types available of a given category.

Package
Source

element-types.lisp (file)

Function: elementwise FUNCTION &optional TOGGLE-PHYSICAL-DIMENSION

Make a function on a grid as an elementwise map of a scalar function. If the result has no physical dimension but the argument does, or vice versa, toggle-physical-dimension should be T. @example
(funcall (grid:elementwise ’sqrt) #(1.0d0 2.0d0 3.0d0 4.0d0))
#(1.0 1.4142135623730951 1.7320508075688772 2.0)
@end example

Package
Source

map.lisp (file)

Function: ensure-foreign-array OBJECT &optional DIMENSIONS ELEMENT-TYPE INITIAL-ELEMENT

If object is not a foreign array, make and return a foreign array with the dimensions and element-type. If object is a foreign array, it is returned.

Package
Source

foreign-array.lisp (file)

Function: euclidean GRID &optional KIND

The norm of the grid. Kind can be :euclidean, for the euclidean, or 2-norm.

Package
Source

norm-vector-product.lisp (file)

Function: euler-angle-rotation ROT3A ROT1 ROT3B &optional PASSIVE

Compute the matrix for a 3-1-3 rotation. See Curtis (9.118).

Package
Source

rotation.lisp (file)

Function: extrude AFFI INDEX NEW-DIMENSION

Create a new AFFI that makes the grid look as if it has an additional dimension, with each element replicated along that dimension.

Package
Source

transformers.lisp (file)

Function: first-3vector VEC

Extract the first 3-vector.

Package
Source

cartesian.lisp (file)

Function: format-attribute-name NAME &optional SEPARATE-COMPONENTS INCLUDE-UNITS INCLUDE-NAME

Format the attribute name, and possibly the units.

Package
Source

state.lisp (file)

Function: format-matlab-list LIST &optional STREAM NUMBER-PER-LINE

Format a matrix row to be read by Matlab.

Package
Source

matlab.lisp (file)

Function: from-jd JD &optional MODIFIED SCALE

Find the timepoint from the Julian date.
Assumes a fixed number of seconds per day (86400).

Package
Source

formats.lisp (file)

Function: from-yyddd YY-OR-YYDDD &key DDD SCALE HOURS MINUTES SECONDS

Read datime from yyddd.ddddd or yy, ddd.ddddd format.

Package
Source

formats.lisp (file)

Function: get-canonical-name SYMBOL
Package
Source

units.lisp (file)

Function: get-coeff AFFI

Return the coefficients in an affine index (copy is made).

Package
Source

affi.lisp (file)

Function: get-const AFFI

Return the constant in an affine index.

Package
Source

affi.lisp (file)

Function: get-domain AFFI

Return the domain in an affine index (copy is made).

Package
Source

affi.lisp (file)

Function: gref GRID &rest INDICES
Function: (setf gref) VALUE GRID &rest INDICES

Obsolete; use grid:aref.

Package
Source

functions.lisp (file)

Function: gref* GRID LINEARIZED-INDEX
Function: (setf gref*) VALUE GRID LINEARIZED-INDEX

Obsolete; use grid:aref*.

Package
Source

functions.lisp (file)

Function: grid &rest ARGS

Make the simple grid with default properties and elements as specified in args.

Package
Source

functions.lisp (file)

Function: gridp OBJECT

Object is a grid; type is returned.

Package
Source

functions.lisp (file)

Function: identity-matrix DIMENSION &optional SCALAR TYPE ELEMENT-TYPE

A rank-two grid with the off-diagonals zero and the diagonal equal to scalar.

Package
Source

compose.lisp (file)

Function: invert-matrix MATRIX

Invert the matrix; return the inverse and determinant.

Package
Source

linear-algebra.lisp (file)

Function: iso8601-parse-time-interval STRING

Parse the time interval in ISO8601:2000(E) Section 5.5.4.2.1 format, representation of time-interval by duration only.

Package
Source

time-interval.lisp (file)

Function: iso8601-time-interval TIME &optional FORMAT FRACTIONAL-SECONDS-DIGITS

Represent the time interval in ISO8601:2000(E) Section 5.5.4.2.1 format, representation of time-interval by duration only.

Package
Source

time-interval.lisp (file)

Function: jd-table START-YEAR END-YEAR &optional FORMAT

Write out a J2000 day number table. Output format is org-mode table (:org), LaTeX (:tex), or comma-separated values (:csv).

Package
Source

formats.lisp (file)

Function: julian-day-number DTSPEC &optional MODIFIED FRACTIONAL-DAY

Julian day number at noon of the day, or modified Julian day at
the start of the day, independent of timescale.
Algorithm given in http://www.pauahtun.org/CalendarFAQ/cal/node3.html#SECTION003151000000000000000.

Package
Source

dtspec.lisp (file)

Function: linear-least-squares-1d OBSERVATIONS &optional TIMES

Find the one dimensional least squares (linear regression) solution of slope and intercept. Values returned: slope, intercept, and their standard errors.

Package
Source

least-squares.lisp (file)

Function: list-no-key &rest ARGS

Make a list of the values without the keywords.

Package
Source
Function: long-print-name UNIT

How the unit or attribute should be printed on the screen.

Package
Source

units.lisp (file)

Function: lookup-type SYMBOL ALIST &optional REVERSE ERROR

Lookup the symbol defined in the alist. If error is non-nil it should be a string describing the class of types, and this function will signal an error if the type wasn’t found.

Package
Source

types.lisp (file)

Function: low-discrepancy-sample COUNT MAKE-FUNCTION &rest PARAMETERS

Call the make function to generate a set of objects with the parameters sampled according to a low-discrepancy sequence. Each parameter will be either a fixed value, specified as a list of key and value, or a range from which the sample is taken, specified as a list of key, lower value, and upper value.

Package
Source
Function: make-affi-cm DIMENSIONS

Setup a _column major_ affine mapping using dimensions.

Package
Source

affi.lisp (file)

Function: make-dtspec &key TIMEPARSE DAY-ONLY TYPE

Make the dtspec arguments.

Package
Source

dtspec.lisp (file)

Function: make-foreign-array ELEMENT-TYPE &rest KEYS &key DIMENSIONS &allow-other-keys

Make a foreign array with the given element type, :dimensions, and :initial-contents, :initial-element or :data.

Package
Source

foreign-array.lisp (file)

Function: make-foreign-array-from-pointer POINTER DIMENSIONS ELEMENT-TYPE &optional FINALIZE

Given a foreign pointer to an array, make a Lisp object of class ’foreign-array that references that. This will never make a static-vector. If finalize is true, than the array memory will be freed when this object is garbage collected; otherwise it is presumed that the foreign code will handle that job.

Package
Source

foreign-array.lisp (file)

Function: make-fortran-array ELEMENT-TYPE &rest KEYS

Make an array in column-major order with the given element type, :dimensions, and :initial-contents, :initial-element or :data.

Package
Source

foreign-array.lisp (file)

Function: make-grid SPECIFICATION &rest KEYS &key INITIAL-CONTENTS INITIAL-ELEMENT &allow-other-keys

Make a grid object with no or literal values specified. The specification is of the form
((component-type dimensions...) ... element-type)
If initial-contents are specified, the dimensions may be omitted,
((component-type) ... element-type).

Package
Source

functions.lisp (file)

Function: make-grid-from-index FUNCTION &key DESTINATION DESTINATION-SPECIFICATION GRID-TYPE DIMENSIONS ELEMENT-TYPE

Make or set a grid from the index or indices. The function gets the indices as arguments, and returns a value that will become the element at that index.

Package
Source

index-functions.lisp (file)

Function: make-grid-sequential-elements &rest ARGS &key OFFSET STEP-COL STEP-ROW &allow-other-keys

Create or set values in a grid with a value based on an affine transformation of the index or indices.

Package
Source

index-functions.lisp (file)

Function: make-grid-with-diagonal DIAGONAL &key OFFSET INITIAL-ELEMENT

Make a matrix with the default element, setting the diagonal to the given diagonal.

Package
Source

compose.lisp (file)

Function: make-new-physical-state &rest ATTRIBUTES-VALUES

Make a new physical state with the given attribute values.

Package
Source

state.lisp (file)

Function: make-parameter CATEGORY NAME &key VALUE TYPE ATTRIBUTE DOCUMENTATION SYNONYMS

Define the parameter (global special variable) with the given name. It will be defined in the package named by category (which will be created if necessary), and exported from it.

Package
Source

parameters.lisp (file)

Function: make-parameters-from-table TABLE &key HEADERP CATEGORY TYPE PREFIX

From the list of lists, define the parameters. The optional header should have column names. These column names include ’category ’name ’value ’type ’description (’value and ’default mean the same thing). Any column names not specified will receive a default value. Any values in the cells that are empty will receive a default value. Any columns given with a header not on the list will be ignored. Category must already exist.

Package
Source

parameters.lisp (file)

Function: make-physical-state STATE ATTRIBUTES &rest ATTRIBUTES-VALUES

From the given attributes and values, copy the requested attributes from the existing state if they exist, then define new attribute values.

Package
Source

state.lisp (file)

Function: make-pq MAGNITUDE UNIT-EXPRESSION &optional SCALAR-DIMENSION

Make a physical dimension quantity (PDQ). Allow for the
possiblity that magnitude is already a PDQ; in this case, check
that the physical dimension is correct, and pass it on. This can
be used as a way of assigning default units to a number. Unitless dimensions (e.g., ’length) are interpeted as units in the :system-of-units. If scalar-dimension is T and
magnitude is not a scalar, the unit-expression applies to each
element of the magnitude. Otherwise it must be a grid or list of
the shape as the magnitude.

Package
Source

scalar.lisp (file)

Function: make-pq-zero UNIT-EXPRESSION
Package
Source

scalar.lisp (file)

Function: make-simple-grid &rest ARGS &key GRID-TYPE DIMENSIONS ELEMENT-TYPE INITIAL-ELEMENT INITIAL-CONTENTS

Make a simple grid by specfying the grid-type (default *default-grid-type*), dimensions (*default-dimensions*), element-type (*default-element-type*), and optionally initial-element or initial-contents.

Package
Source

functions.lisp (file)

Function: make-st SYMBOL TYPE
Package
Source

symbol-type.lisp (file)

Function: make-state-table ()
Package
Source

state.lisp (file)

Function: make-timeparse-majord &optional YEAR MONTH DAY HOUR MINUTE SECOND
Package
Source

dtspec.lisp (file)

Function: make-timeparse-minord &optional SECOND MINUTE HOUR DAY MONTH YEAR
Package
Source

dtspec.lisp (file)

Function: make-timepoint &rest ARGS &key DTSPEC TIMEPARSE SCALE DAY-ONLY

Make an object representing a point in time. Either dtspec
or timeparse should be specified, and scale should be specified.

Package
Source

timepoint.lisp (file)

Function: make-timepoint-j2000sec J2000SEC &optional DAY-ONLY

Make a timepoint from J2000sec.

Package
Source

dtmath.lisp (file)

Function: make-user-package NAME &optional NICKNAMES

Make a package in which it is convenient to use Antik and related systems. If the package already exists, the use-packages and shadowing symbols are updated.

Package
Source

package.lisp (file)

Function: make-walker AFFI &optional INITIAL-SUBSCRIPTS

Create a walker for an affine index that starts at the given subscripts (zeroes by default). Return two functions: one that returns the current index and increments the walker, the other just returns the index without any side effects.

Package
Source

affi.lisp (file)

Function: map-grid &key SOURCE SOURCE-AFFI SOURCE-DIMS DESTINATION DESTINATION-AFFI DESTINATION-SPECIFICATION INITIAL-ELEMENT ELEMENT-FUNCTION COMBINATION-FUNCTION

Make a new grid by mapping on an existing grid or on indices. :source
The source grid; if not a grid, it is taken as a
function to apply to the grid indices to make the
element of the destination; if this is supplied,
source is ignored and element-function is only applied
to the default value.
:source-affi
The affi to be used for extraction; defaults to
making an affi from source-dims, then destination-specification. :source-dims
The dimensions of the source if source not supplied;
if NIL, dimensions are taken from destination-specification. :destination
The destination grid, if not supplied, it will be made according to destination-affi and destination-specification. :destination-affi
The affi for injection, defaults to (affi destination)
if destination is supplied, then
makes an affi if destination-specification is supplied, otherwise source-affi.
:destination-specification
The specification to use for the destination to be make, defaults to the specification of source. :initial-element
The default value to set in a newly-created destination. :element-function
The function to apply to each element of the source; defaults to coercing element to the element type of the destination. :combination-function
A designator for a function of two arguments,
or nil (default). If a function, it will be funcalled on
the destination element and the transformed source element. If nil, the destination element is overwritten.

Package
Source

map.lisp (file)

Function: map-n-grids &key SOURCES DESTINATION DESTINATION-AFFI DESTINATION-SPECIFICATION INITIAL-ELEMENT ELEMENT-FUNCTIONS COMBINATION-FUNCTION COMBINE-DESTINATION

Map on multiple source grids. The arguments are:
sources:
A list of (grid-or-function affi), each one representing either a grid or function from which data will be drawn.
If it is a grid, the grid values are used. If it is a function of the appropriate number of non-negative integer arguments, values will be created by calling that function on the indices. If affi is not specified and grid-or-function is a grid, the affi will default to the AFFI of that grid.
destination:
A grid in which to put the results, or nil if one is
to be created.
destination-affi:
An AFFI for the destinattion.
destination-specification:
A specification for the destination, if destination-affi
is not given.
initial-element: Initial value to give to the destination grid. element-functions:
A list of functions or nil, one for each source. This function is applied to the source element before combination. combination-function:
A function that combines each of the source values after being passed through the element-functions. If nil,
then just take the value from the first source. combine-destination:
If true, pass as the first argument to the combination-function the prior value of the destination grid. Defaults to T if :desination is specified; otherwise nil.

Package
Source

map.lisp (file)

Function: map-state ORIGINAL-STATE ATTRIBUTES &optional FUNCTION

Make a new state by mapping a function of (value attribute-name)
on existing attributes. If function is NIL, use existing value. A function, if specified, should return the new value. If attributes is NIL, use all the defined attributes of the original state.

Package
Source

state.lisp (file)

Function: matrix-from-columns &rest COLUMNS

Make the matrix out of the equal-length vectors. If *default-grid-type* is non-nil, resultant grid will be of the specified type; otherwise, it will be the same as the first column.

Package
Source

norm-vector-product.lisp (file)

Function: max &rest ARGS
Package
Source

generic.lisp (file)

Function: maximize-1d FUNCTION X-LOWER X-UPPER &optional X-MAXIMUM ABSOLUTE-ERROR RELATIVE-ERROR METHOD

Find the maximum of the function of one variable (x) between x-lower and x-upper. The optional argument x-maximum is a guess of x for the maximum value of the function. Returns the argument and value at the maximum.

Package
Source

one-dim.lisp (file)

Function: min &rest ARGS
Package
Source

generic.lisp (file)

Function: minimize-1d FUNCTION X-LOWER X-UPPER &optional X-MINIMUM ABSOLUTE-ERROR RELATIVE-ERROR METHOD

Find the minimum of the function of one variable (x) between x-lower and x-upper. The optional argument x-minimum is a guess of x for the minimum value of the function. Returns the argument and value at the minimum.

Package
Source

one-dim.lisp (file)

Function: mkstr &rest ARGS

Make a string out of the printed representations of the arguments.

Package
Source

utility.lisp (file)

The format produced will be readable to Lisp.

Package
Source

format-output.lisp (file)

Function: nf-string OBJECT

Format output for numerical objects to a new string.

Package
Source

format-output.lisp (file)

Function: norm GRID &optional KIND

The norm of the grid. Kind can be :euclidean, for the euclidean norm.

Package
Source

norm-vector-product.lisp (file)

Function: norm-denorm-angle ANGLE FUNCTION &optional POSITIVE

Normalize an angle, process it, and denormalize it back to the original cycle count. This is useful for e.g. Kepler’s equation, where the normalized angle is needed to for the algorithm to converge properly, but the full cycles are needed for f & g functions.

Package
Source

angle.lisp (file)

Function: normalize GRID &optional THRESHOLD

Find the normalized grid, i.e., each element is divided by grid norm, and the normalization factor. If the norm is less than the non-nil threshold, then nil is returned; if it is zero and threshold is nil, a zero grid is returned.

Package
Source

norm-vector-product.lisp (file)

Function: number-class TYPE

Find the class corresponding to the numeric type.

Package
Source

types.lisp (file)

Function: object-as-nf OBJECT

Define a new object exactly as the current nf options print an existing one. This function can be used for example to define a number exactly as the rounded print format of another one.

Package
Source

format-output.lisp (file)

Function: org-table LIST-OF-LISTS &optional STREAM

Format the table.

Package
Source

org-mode.lisp (file)

Function: org-table-line LIST &optional STREAM

Format the list for a line of an org-mode table.

Package
Source

org-mode.lisp (file)

Function: parameter-help &optional CATEGORY NAME STREAM

Print all information known about the parameter. If category is nil (default), names of all categories are printed. If name is nil, all defined parameters in that category are printed.

Package
Source

parameters.lisp (file)

Function: permute AFFI PERMUTATION

Permute the subscripts of an affine index using the given list.

Package
Source

transformers.lisp (file)

Function: physical-quantity-p X
Package
Source

scalar.lisp (file)

Function: polar-to-rectangular AZIMUTH ELEVATION &optional RADIUS SIGN1

Convert polar coordinates to rectangular coordinates.
Argument sign1 should be set to -1 for accomodating topocentric azimuth, which is measured from North instead of South.

Package
Source

polar.lisp (file)

Function: pqwu PQ

If we are dynamically inside without-units, return the magnitude. If not, return the object as-is.

Package
Source

undimension.lisp (file)

Function: prime-factors N

Find the prime factors of the integer n.

Package
Source

integers.lisp (file)

If the CL-defined specials are defined appropriately, print readably and return T, otherwise, return NIL.

Package
Source

object.lisp (file)

The numerical value of the angle in radians.

Package
Source

angle.lisp (file)

Function: range AFFI

Return the smallest and the largest integer in the range of an affine index.

Package
Source

affi.lisp (file)

Function: rank AFFI

Return the rank of an affine index.

Package
Source

affi.lisp (file)

Read the data in the file into a list. If include-count is true, one column will be a serial count of the line of input data. If discard-header is not nil, discard header line(s); if a number greater than 1, discard that many lines.

Package
Source

Function: read-data-stream &key SEPARATOR INCLUDE-COUNT STREAM

Read the data from the stream and collect a list of lists of values from columns separated by whitespace. If include-count is a number, line count starting at that number will be prepended as the first field.

Package
Source

Function: read-indexed-data INPUT MAXIMUM-INDEX-PARAMETERS &rest ARGS &key INDEX-ALGORITHM DEFAULT-VALUE INITIAL-ELEMENT

Read the stream of indexed data; each line contains one record. The last column is the datum and the preceeding columns are either the indices, or inputs to index-algorithm, a function that should return the indices. The grid is sized from maximum-indices, which are index parameters if index-algorithm is non-nil. If a value read is not of the appropriate type (grid:*default-element-type*), then default-value is used instead, which should be of the appropriate type.

Package
Source

indexed.lisp (file)

Parse the datime or time interval string and create a timepoint object.

Package
Source

Function: read-timepoint STRING &optional POS-YMDHMS SCALE

Read a timepoint from a string with specification for the position in the string of each component; pos-ymdhms is a list of year, month, day, hour, minute, and second as sequence numbers for the integers in the string. Scale is the timescale (zone) as a string or symbol. If pos-ymdhms has only three components, or only a date is provided, the timepoint created will be specifed as day-only. The default reads an ISO8601 string like 1999-03-30T12:33:45.

Package
Source

Read the timepoint specified as an ISO8601 string. In contrast to #’read-timepoint, this accepts the various rearrangements permitted by ISO8601 (see documentation for #’iso8601-parse, but does not accept miscellaneous separator symbols.

Package
Source

Read dates and times in customary US format MM/DD/YYYY; times may be included as well if day-only is nil.

Package
Source

Function: read-vector-from-string STRING COUNT &optional START END

Read the count element vector from a string.

Package
Source

Package
Source

object.lisp (file)

Function: rectangular-to-polar VECTOR &optional SIGN1

Convert rectangular coordinates to polar coordinates.
Argument sign1 should be set to -1 for accomodating topocentric azimuth, which is measured from North instead of South.
Returns a list of azimuth, elevation, and radius, and the
plane distance.

Package
Source

polar.lisp (file)

Function: redimension MAGNITUDE UNIT-EXPRESSION

Apply units that were stripped off a quantity.

Package
Source

undimension.lisp (file)

Function: relative-time BASE-TIME TIME &optional ABSOLUTE

Compute a time using base-time as a reference.
Either can be a timepoint or time pdq, and the result can be chosen either way by specifying absolute T or NIL respectively. The returned value is the time specified by the second argument, but referenced to base-time.

Package
Source

relative-time.lisp (file)

Function: right-angle VECTOR

Find an arbitrary right angle to the vector.

Package
Source

cartesian.lisp (file)

Function: rotate ANGLE &optional PASSIVE

Create a rotation matrix in two dimensions.
Passive rotation if passive is true, otherwise active.

Package
Source

rotation.lisp (file)

Function: rotate-3d AXIS ANGLE &optional PASSIVE

Create a rotation matrix about the (0, 1, 2) axis in three dimensions. Passive rotation if passive is true, otherwise active.

Package
Source

rotation.lisp (file)

Function: rotate-3daa ROTATION-AXIS ANGLE &optional PASSIVE

Rotation about an arbitrary axis in 3D.
See Goldstein, Poole, Safko (4.62) or http://mathworld.wolfram.com/RotationFormula.html.

Package
Source

rotation.lisp (file)

Function: row GRID INDEX &optional DESTINATION

The subgrid with the first index set to the specified value.

Package
Source

compose.lisp (file)

Writer

(setf row) (function)

Function: (setf row) SUBGRID GRID INDEX

Set the subgrid with the first index set to the specified value.

Package
Source

compose.lisp (file)

row (function)

Function: second-3vector VEC

Extract the second 3-vector.

Package
Source

cartesian.lisp (file)

Function: seconds-per-day DATIME

Compute the number of seconds in the given day.

Package
Source

dtmath.lisp (file)

Function: set-diagonal GRID FUNCTION-OR-VALUE &optional OFFSET VALUE

Set the diagonal of the grid by calling the function on the indices. If value is non-nil, then set it to function-or-value, ignoring the indices.

Package
Source

compose.lisp (file)

If readtable is true, set the reader to enable the three Antik reader macros “#_“ (physical dimension quantity), “#d“ (date/time), “#m“ (grid). Set the reader to interpret float literals without an exponent marker to be the type specified. If “NIL“, leave as-is.

Package
Source

Function: set-showing KEYWORD &optional STATUS

Set the showing of intermediate values.

Package
Source

intermediate.lisp (file)

Function: set-state-value VALUE ATTRIBUTE STATE-TABLE

Set the value of a particular attribute for this state.

Package
Source

state.lisp (file)

Function: set-system-of-units SYSTEM-OF-UNITS &rest UNITS

Set the default system of units to the specified system.

Package
Source

units.lisp (file)

Function: short-print-name UNIT

How the unit or attribute should be printed on the screen.

Package
Source

units.lisp (file)

Function: single LST

Test list for one element.

Package
Source

utility.lisp (file)

Function: size AFFI

Return the size (ie number of integers in the range) of an affine index. Note that size is not necessarily the difference of the endpoints of the range, as the range may be non-contiguous.

Package
Source

affi.lisp (file)

Function: slice GRID INDEX-SELECTION &key DESTINATION DROP

Select slice(s) from a grid. The index-selection is a list with length equal to the rank of grid. Each element should be one of: an index, indicating the index to be selected,
:all, indicating the entire range if indices are to be selected, :rev, indicating the entire range if indices are to be selected in reverse order,
(:range start end stride), indicating a range of indices to be selected; if stride is omitted, it is presumed to be 1, (:select value ...), indicating explicit values to be selected.

Package
Source

slice.lisp (file)

Function: solve-linear MATRIX VECTOR

Solve the linear algebra equation.

Package
Source

linear-algebra.lisp (file)

Function: spec-scalar-p SPECIFICATION

Specification is for a scalar; if so, return that type.

Package
Source

specification.lisp (file)

Function: sqrt NUM

The square root :math:‘\sqrt{x}‘ of the generalized or regular number :math:‘x‘.

Package
Source

generic.lisp (file)

Function: st-actual-type DECL
Package
Source

symbol-type.lisp (file)

Function: st-pointer-generic-pointer DECL
Package
Source

symbol-type.lisp (file)

Function: st-pointerp DECL

If this st represents a pointer, return the type of the object.

Package
Source

symbol-type.lisp (file)

Function: st-symbol DECL
Package
Source

symbol-type.lisp (file)

Function: st-type DECL
Package
Source

symbol-type.lisp (file)

Function: start-of-day DATIME &optional RELATIVE-DAY DAY-ONLY

From the given datime, return the start of the given day, relative-day = 0: this day, -1: day before, +1 next day, etc.

Package
Source

dtmath.lisp (file)

Function: state-formula ATTRIBUTE-CANONICAL STATE-TABLE &optional APPLY-TO-VALUES STATE-FUNCTION-GENERATOR

Find the formula for the attribute given the known quantities in state.

Package
Source

state.lisp (file)

Function: (setf state-value) VALUE ATTRIBUTE STATE-TABLE
Package
Source

state.lisp (file)

state-value (generic function)

Function: state-value-expand ATTRIBUTE STATE-TABLE WILL-HAVE STATE-FUNCTION-GENERATOR

Create the expanded form of the function constructor call on the state so that function construction can take place at compile time instead of run time. This is faster provided the attributes that will be present are known. The state-function-generator should return the lambda form of the function.

Package
Source

state.lisp (file)

Function: stream-to-string STREAM &key TERMINATOR TERMINATE-IF

Fill a string with the contents of the stream. Stop when an EOF is encountered, or when the terminating character :terminator, which is discarded, is reached, or the function :terminate-if is satisfied on the character, which is returned to the stream. Only one of :terminator and :terminate-if should be specified.

Package
Source

utility.lisp (file)

Function: stride GRID STRIDE &key DESTINATION

Create a new grid with every stride-th element.

Package
Source

compose.lisp (file)

Function: stride AFFI STRIDE

Create a new AFFI that makes the grid look as if is been reduced by taking only every stride-th element.

Package
Source

transformers.lisp (file)

Function: subgrid GRID DIMENSIONS START &key DESTINATION DROP

Create a grid from a block of an existing grid, e.g. a row from a matrix, or a block. The dimensions give the dimensions of the subgrid, and start gives the lowest values of each index which corresponds to the subgrid element with all index values zero. If drop is true, all singleton axes are dropped.

Package
Source

compose.lisp (file)

Writer

(setf subgrid) (function)

Function: (setf subgrid) SUBGRID GRID START &optional AXES

Set the subgrid of the grid. Specify the starting indices with start, and in the case that the subgrid has lower rank than the grid, which axes; default is the first (rank subgrid) axes.

Package
Source

compose.lisp (file)

subgrid (function)

Function: subrange AFFI DIMS &optional DIM-POSITIONS START

Create an affi selecting a subrange from the given affi corresponding to the dimensions dims in the positions dim-positions.

Package
Source

transformers.lisp (file)

Function: symb &rest ARGS

Make a symbol out of the printed representations of the arguments.

Package
Source

utility.lisp (file)

Function: tait-bryan-angles DCM

Find the three angles psi, theta, phi of a 3-2-1 (Tait-Bryan) rotation for the direction cosine matrix.

Package
Source

rotation.lisp (file)

Function: tait-bryan-rotation ROT1 ROT2 ROT3 &optional PASSIVE

Compute the matrix for a 3-2-1 (yaw-pitch-roll) rotation. See Curtis (9.124). This transforms a vector in the body frame into a vector in the external frame.

Package
Source

rotation.lisp (file)

Function: tex-print-name UNIT

How the unit or attribute should be printed in TeX.

Package
Source

units.lisp (file)

Function: time-as-angle TIME-STRING

Compute the angle from the time,
the major field is hours with 24 hours = 1 revolution.

Package
Source

angle.lisp (file)

Function: time-interval-timeparse TIMEPARSE

Convert the timeparse to a time interval.

Package
Source

time-interval.lisp (file)

Function: time-limits TIME1 TIME2 &optional REFERENCE

Make sense of time1 and time2 in absolute terms. If one is absolute,
and the other relative, it is presumed to be relative to the other. If they are both relative, they are presumed to be relative to reference.

Package
Source

relative-time.lisp (file)

Function: time-precision-seconds TIME-INTERVAL &optional FLOAT-FORMAT

Approximate inaccuracy in seconds of the time interval; e.g. if 1, than the seconds digit is inaccurate.

Package
Source

time-interval.lisp (file)

Function: timeparse-day TIMEPARSE
Function: (setf timeparse-day) VALUE TIMEPARSE
Package
Source

dtspec.lisp (file)

Function: timeparse-hour TIMEPARSE
Package
Source

dtspec.lisp (file)

Function: timeparse-minute TIMEPARSE
Package
Source

dtspec.lisp (file)

Function: timeparse-month TIMEPARSE
Function: (setf timeparse-month) VALUE TIMEPARSE
Package
Source

dtspec.lisp (file)

Function: timeparse-second TIMEPARSE
Package
Source

dtspec.lisp (file)

Function: timeparse-time-interval TIME &optional FRACTIONAL-SECONDS-DIGITS

Convert the time interval to a timeparse.

Package
Source

time-interval.lisp (file)

Function: timeparse-year TIMEPARSE
Package
Source

dtspec.lisp (file)

Function: timepoint-j2000sec TP

Seconds from the J2000 epoch, 2000-01-01T12:00:00UTC.

Package
Source

dtmath.lisp (file)

Function: to-yyddd DATIME

Generate the twoline element form of datime. Note this is not year-2000 compliant!

Package
Source

formats.lisp (file)

Function: transpose GRID &key INDICES DESTINATION START

Transpose the grid, optionally putting the result in destination at the element specified by the start indices.

Package
Source

compose.lisp (file)

Function: transpose AFFI &optional INDICES

Transpose any pair of indices.

Package
Source

transformers.lisp (file)

Function: transpose-list LISTS
Package
Source

utility.lisp (file)

Function: vector-angle A B

The short angle between a and b, and the rotation vector.

Package
Source

cartesian.lisp (file)

Function: write-data LIST &optional STREAM

Write the formatted data, given as a list of lists.

Package
Source

write.lisp (file)

Function: write-dms ANGLE &optional STREAM FIRST-SEP SECOND-SEP FINAL
Package
Source

angle.lisp (file)

Function: write-us-date DATIME

Write dates and times in customary US format MM/DD/YYYY.

Package
Source

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

#### 6.1.7 Generic functions

Generic Function: abs NUM

The absolute value.

Package
Source

generic.lisp (file)

Methods
Method: abs (X physical-quantity)
Source

arithmetic.lisp (file)

Method: abs X
Source

mathematics.lisp (file)

Method: abs (NUM number)
Method: abs (SEQ sequence)
Generic Function: acos ARG

The arccosine of the generalized or regular number.

Package
Source

generic.lisp (file)

Methods
Method: acos (X physical-quantity)
Source

arithmetic.lisp (file)

Method: acos X
Source

mathematics.lisp (file)

Method: acos (ARG number)
Generic Function: aref GRID &rest INDICES

Select the element from the grid.

Package
Source

functions.lisp (file)

Writer

(setf aref) (generic function)

Methods
Method: aref (OBJECT physical-quantity) &rest INDICES
Source

grid.lisp (file)

Method: aref (HISTOGRAM histogram2d) &rest INDICES

Return the contents of the i-th, j-th bin of the 2D histogram. If either index lies outside the valid range of index for the histogram then an error (input-domain) is signalled.

Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/histogram/updating-accessing.lisp

Method: aref (HISTOGRAM histogram) &rest INDICES

Return the contents of the i-th bin of the histogram. If i lies outside the valid range of index for the histogram then an error (input-domain) is signalled.

Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/histogram/updating-accessing.lisp

Method: aref (P permutation) &rest INDICES
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/data/permutation.lisp

Method: aref (OBJECT matrix-unsigned-byte-64) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT matrix-signed-byte-64) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT matrix-unsigned-byte-32) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT matrix-signed-byte-32) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT matrix-unsigned-byte-16) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT matrix-signed-byte-16) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT matrix-unsigned-byte-8) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT matrix-signed-byte-8) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT matrix-complex-double-float) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT matrix-complex-single-float) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT matrix-double-float) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT matrix-single-float) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-unsigned-byte-64) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-signed-byte-64) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-unsigned-byte-32) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-signed-byte-32) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-unsigned-byte-16) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-signed-byte-16) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-unsigned-byte-8) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-signed-byte-8) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-complex-double-float) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-complex-single-float) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-double-float) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT vector-single-float) &rest INDICES
Source

methods.lisp (file)

Method: aref (OBJECT foreign-array) &rest INDICES
Source

methods.lisp (file)

Method: aref (GRID array) &rest INDICES
Source

array.lisp (file)

Generic Function: (setf aref) VALUE GRID &rest INDICES

Set the element from the grid.

Package
Source

functions.lisp (file)

aref (generic function)

Methods
Method: (setf aref) VALUE (OBJECT physical-quantity) &rest INDICES
Source

grid.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-unsigned-byte-64) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-signed-byte-64) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-unsigned-byte-32) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-signed-byte-32) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-unsigned-byte-16) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-signed-byte-16) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-unsigned-byte-8) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-signed-byte-8) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-complex-double-float) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-complex-single-float) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-double-float) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT matrix-single-float) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-unsigned-byte-64) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-signed-byte-64) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-unsigned-byte-32) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-signed-byte-32) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-unsigned-byte-16) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-signed-byte-16) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-unsigned-byte-8) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-signed-byte-8) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-complex-double-float) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-complex-single-float) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-double-float) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT vector-single-float) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (OBJECT foreign-array) &rest INDICES
Source

methods.lisp (file)

Method: (setf aref) VALUE (GRID array) &rest INDICES
Source

array.lisp (file)

Generic Function: aref* GRID LINEARIZED-INDEX

Select the element from the grid using a linearized index.

Package
Source

functions.lisp (file)

Writer

(setf aref*) (generic function)

Methods
Method: aref* (OBJECT physical-quantity) INDEX
Source

grid.lisp (file)

Method: aref* (OBJECT matrix-unsigned-byte-64) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT matrix-signed-byte-64) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT matrix-unsigned-byte-32) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT matrix-signed-byte-32) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT matrix-unsigned-byte-16) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT matrix-signed-byte-16) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT matrix-unsigned-byte-8) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT matrix-signed-byte-8) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT matrix-complex-double-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT matrix-complex-single-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT matrix-double-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT matrix-single-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-unsigned-byte-64) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-signed-byte-64) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-unsigned-byte-32) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-signed-byte-32) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-unsigned-byte-16) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-signed-byte-16) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-unsigned-byte-8) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-signed-byte-8) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-complex-double-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-complex-single-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-double-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT vector-single-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (OBJECT foreign-array) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: aref* (GRID array) LINEARIZED-INDEX
Source

array.lisp (file)

Method: aref* GRID LINEARIZED-INDEX before
Generic Function: (setf aref*) VALUE GRID LINEARIZED-INDEX

Set the element from the grid using a linearized index.

Package
Source

functions.lisp (file)

aref* (generic function)

Methods
Method: (setf aref*) VALUE (OBJECT physical-quantity) INDEX
Source

grid.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-unsigned-byte-64) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-signed-byte-64) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-unsigned-byte-32) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-signed-byte-32) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-unsigned-byte-16) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-signed-byte-16) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-unsigned-byte-8) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-signed-byte-8) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-complex-double-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-complex-single-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-double-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT matrix-single-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-unsigned-byte-64) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-signed-byte-64) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-unsigned-byte-32) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-signed-byte-32) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-unsigned-byte-16) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-signed-byte-16) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-unsigned-byte-8) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-signed-byte-8) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-complex-double-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-complex-single-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-double-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT vector-single-float) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (OBJECT foreign-array) LINEARIZED-INDEX
Source

methods.lisp (file)

Method: (setf aref*) VALUE (GRID array) LINEARIZED-INDEX
Source

array.lisp (file)

Method: (setf aref*) VALUE GRID LINEARIZED-INDEX before
Generic Function: asin ARG

The arcsine of the generalized or regular number.

Package
Source

generic.lisp (file)

Methods
Method: asin (X physical-quantity)
Source

arithmetic.lisp (file)

Method: asin X
Source

mathematics.lisp (file)

Method: asin (ARG number)
Generic Function: atan NUM &optional DEN DEFAULT ZERO-ENOUGH

The arctangent of the generalized or regular number. If absolute value of the arguments are below zero-enough, default is returned.

Package
Source

generic.lisp (file)

Methods
Method: atan (NUM number) &optional DEN DEFAULT ZERO-ENOUGH around
Source

arithmetic.lisp (file)

Method: atan (NUM physical-quantity) &optional DEN DEFAULT ZERO-ENOUGH
Source

arithmetic.lisp (file)

Method: atan NUM &optional DEN DEFAULT ZERO-ENOUGH
Source

mathematics.lisp (file)

Method: atan (NUM number) &optional DEN DEFAULT ZERO-ENOUGH
Generic Function: cl-array OBJECT
Package
Methods
Method: cl-array (FOREIGN-ARRAY foreign-array)

Source

foreign-array.lisp (file)

Generic Function: coerce NUMBER LIKE

Make number into an object similar to like, or
if like is a number type, into that type.

Package
Source

generic.lisp (file)

Methods
Method: coerce (NUM number) (PQ physical-quantity)
Source

arithmetic.lisp (file)

Method: coerce X LIKE
Method: coerce (NUMBER number) (LIKE number)
Method: coerce (NUMBER symbol) (LIKE number)
Method: coerce NUMBER (LIKE symbol)
Method: coerce (NUMBER sequence) LIKE
Method: coerce OBJECT (LIKE null)
Generic Function: copy OBJECT &key SPECIFICATION GRID-TYPE DIMENSIONS ELEMENT-TYPE DESTINATION &allow-other-keys

Copy contents into existing or new object.

Package
Source

copy.lisp (file)

Methods
Method: copy (SOURCE histogram2d) &key DESTINATION &allow-other-keys
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/histogram/histogram.lisp

Method: copy (SOURCE histogram) &key DESTINATION &allow-other-keys
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/histogram/histogram.lisp

Method: copy (SOURCE quasi-random-number-generator) &key DESTINATION &allow-other-keys
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/random/quasi.lisp

Method: copy (SOURCE random-number-generator) &key DESTINATION &allow-other-keys
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/random/generators.lisp

Method: copy (SOURCE combination) &key GRID-TYPE DESTINATION &allow-other-keys
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/data/combination.lisp

Method: copy (SOURCE permutation) &key GRID-TYPE DESTINATION &allow-other-keys
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/data/permutation.lisp

Method: copy (OBJECT foreign-array) &rest ARGS &key SPECIFICATION GRID-TYPE DIMENSIONS ELEMENT-TYPE DESTINATION
Source

methods.lisp (file)

Method: copy (OBJECT array) &rest ARGS &key SPECIFICATION GRID-TYPE DIMENSIONS ELEMENT-TYPE DESTINATION
Generic Function: cos NUM

The cosine of the generalized or regular number.

Package
Source

generic.lisp (file)

Methods
Method: cos (X physical-quantity)
Source

arithmetic.lisp (file)

Method: cos X
Source

mathematics.lisp (file)

Method: cos (NUM rational)
Method: cos (NUM number)
Method: cos (X sequence)
Generic Function: cosh NUM

The hyperbolic cosine of the generalized or regular number.

Package
Source

generic.lisp (file)

Methods
Method: cosh (X physical-quantity)
Source

arithmetic.lisp (file)

Method: cosh X
Source

mathematics.lisp (file)

Method: cosh (NUM rational)
Method: cosh (NUM number)
Method: cosh (X sequence)
Generic Function: creation-form OBJECT

A form that creates the object.

Package
Source

object.lisp (file)

Methods
Method: creation-form (PQ physical-quantity)
Source

physical-quantities.lisp (file)

Method: creation-form (TP timepoint)
Source

timepoint.lisp (file)

Method: creation-form (DT dtspec)
Source

dtspec.lisp (file)

Method: creation-form OBJECT
Method: creation-form (OBJECT symbol)
Method: creation-form (OBJECT number)
Method: creation-form (OBJECT string)
Method: creation-form (OBJECT vector)
Method: creation-form (OBJECT list)
Method: creation-form (OBJECT hash-table)
Generic Function: day-only OBJECT
Package
Methods
Method: day-only (DTSPEC dtspec)

Source

dtspec.lisp (file)

Generic Function: defined-attributes STATE

List the attributes defined for this state.

Package
Source

state.lisp (file)

Methods
Method: defined-attributes (STATE hash-table)
Method: defined-attributes (STATE null)
Generic Function: dimensions GRID

A list representing the dimensions of the generalized array.

Package
Source

functions.lisp (file)

Methods
Method: dimensions (OBJECT physical-quantity)
Source

grid.lisp (file)

Method: dimensions (HISTOGRAM histogram2d)
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/histogram/updating-accessing.lisp

Method: dimensions (HISTOGRAM histogram)

The number of bins in the histogram.

Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/histogram/updating-accessing.lisp

Method: dimensions (P permutation)
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/data/permutation.lisp

Method: dimensions (CALLBACK-INCLUDED callback-included)

Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/init/callback-included.lisp

Method: dimensions (FOREIGN-ARRAY foreign-array)

Source

foreign-array.lisp (file)

Method: dimensions (GRID array)
Source

array.lisp (file)

Method: dimensions (OBJECT list)
Generic Function: element-type GRID

The element type of the grid.

Package
Source

functions.lisp (file)

Methods
Method: element-type (OBJECT physical-quantity)
Source

grid.lisp (file)

Method: element-type (FOREIGN-ARRAY foreign-array)

Source

foreign-array.lisp (file)

Method: element-type (GRID array)
Source

array.lisp (file)

Method: element-type (GRID list)
Generic Function: exp NUM

The natural exponent e^num of the generalized or regular number.

Package
Source

generic.lisp (file)

Methods
Method: exp X
Source

mathematics.lisp (file)

Method: exp (NUM rational)
Method: exp (NUM number)
Method: exp (X sequence)
Generic Function: expt NUM EXPONENT

Raise the number to the exponent.

Package
Source

generic.lisp (file)

Methods
Method: expt (A matrix) (B integer)
Source

linear-algebra.lisp (file)

Method: expt (X physical-quantity) EXPON
Source

arithmetic.lisp (file)

Method: expt A (B number)
Source

mathematics.lisp (file)

Method: expt (NUM number) (EXPONENT number)
Generic Function: flatten-angle OBJECT

Remove the angular dimension; the number is not changed
and therefore the angles are radians. This function is necessary as proper dimensional arithmetic ignores angles as a dimension.

Package
Source

arithmetic.lisp (file)

Methods
Method: flatten-angle (OBJECT physical-quantity)
Method: flatten-angle (OBJECT sequence)
Method: flatten-angle OBJECT
Generic Function: floor NUMBER &optional DIVISOR

Greatest multiple of divisor less than number.

Package
Source

generic.lisp (file)

Methods
Method: floor (X physical-quantity) &optional Y
Source

arithmetic.lisp (file)

Method: floor (NUMBER number) &optional DIVISOR
Generic Function: foreign-pointer OBJECT
Package
Methods
Method: foreign-pointer (FOREIGN-ARRAY foreign-array)

Source

foreign-array.lisp (file)

Generic Function: inner GRID0 GRID1

The inner product of two grids.

Package
Source

norm-vector-product.lisp (file)

Methods
Method: inner (VEC1 vector-complex-double-float) (VEC2 vector-complex-double-float)
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/linear-algebra/blas1.lisp

Method: inner (VEC1 vector-complex-single-float) (VEC2 vector-complex-single-float)
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/linear-algebra/blas1.lisp

Method: inner (VEC1 vector-double-float) (VEC2 vector-double-float)
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/linear-algebra/blas1.lisp

Method: inner (VEC1 vector-single-float) (VEC2 vector-single-float)
Source

/home/quickbuilder/quicklisp/dists/quicklisp/software/gsll-quicklisp-dd2e7673-git/linear-algebra/blas1.lisp

Method: inner GRID0 GRID1
Generic Function: iso8601 OBJECT
Package
Methods
Method: iso8601 (DTSPEC dtspec)

Source

dtspec.lisp (file)

Generic Function: log NUM &optional BASE

The natural logarithm of the generalized or regular number.

Package
Source

generic.lisp (file)

Methods
Method: log A &optional BASE
Source

mathematics.lisp (file)

Method: log (NUM number) &optional BASE
Method: log (X sequence) &optional BASE
Generic Function: make-affi OBJECT &optional OFFSET

Create an affine mapping conforming to the given object.

Package
Source

affi.lisp (file)

Methods
Method: make-affi (DIMENSIONS sequence) &optional OFFSET

Setup a row-major affine mapping with the given dimensions.

Generic Function: minusp A

Negative

Package
Source

generic.lisp (file)

Methods
Method: minusp (X physical-quantity)
Source

arithmetic.lisp (file)

Method: minusp (A number)
Method: minusp A
Generic Function: nf OBJECT &optional STREAM

Format output for numerical objects. Default stream is *standard-output*.

Package
Source

format-output.lisp (file)

Methods
Method: nf (PQ physical-quantity) &optional STREAM
Source

physical-quantities.lisp (file)

Method: nf (OBJECT foreign-array) &optional STREAM
Source

format-output.lisp (file)

Method: nf (OBJECT sequence) &optional STREAM
Source

format-output.lisp (file)

Method: nf (OBJECT array) &optional STREAM
Source

format-output.lisp (file)

Method: nf (OBJECT timepoint) &optional STREAM
Source

timepoint.lisp (file)

Method: nf (OBJECT dtspec) &optional STREAM
Source

dtspec.lisp (file)

Method: nf (OBJECT float) &optional STREAM

Returns two values: the string and prints-as-zero.

Source

float.lisp (file)

Method: nf (NUMBER ratio) &optional STREAM
Method: nf (OBJECT integer) &optional STREAM
Method: nf (OBJECT null) &optional STREAM
Method: nf OBJECT &optional STREAM
Generic Function: normalize-angle ANGLE &optional POSITIVE

Normalizes the angle to (in radians) -pi to pi
or 0 to 2pi (positive = t).
Two values are returned: the normalized angle, and the number of full revolutions that should be added to the normalized angle to recreate the original angle.

Package
Source

angle-component.lisp (file)

Methods
Method: normalize-angle (SEQ sequence) &optional POSITIVE
Method: normalize-angle (ANGLE physical-quantity) &optional POSITIVE
Method: normalize-angle (ANGLE number) &optional POSITIVE
Generic Function: outer GRID0 GRID1

The outer product of two grids.

Package
Source

norm-vector-product.lisp (file)

Methods
Method: outer GRID0 GRID1
Generic Function: plusp A

Positive.

Package
Source

generic.lisp (file)

Methods
Method: plusp (X physical-quantity)
Source

arithmetic.lisp (file)

Method: plusp (A number)
Method: plusp A
Generic Function: pqval PQ

Get the numerical value and the units of the physical dimension quantity. Returns the magnitude, the units, and whether units are the same for each element of a sequence or grid.

Package
Source

physical-quantities.lisp (file)

Methods
Method: pqval (PQ sequence)
Method: pqval (PQ physical-quantity)
Method: pqval PQ
Generic Function: rank GRID

The rank (number of dimensions) of the generalized array.

Package
Source

functions.lisp (file)

Methods
Method: rank (OBJECT physical-quantity)
Source

grid.lisp (file)

Method: rank (OBJECT foreign-array)
Source

methods.lisp (file)

Method: rank (GRID array)
Source

array.lisp (file)

Generic Function: root-1d FUNCTION INITIAL DERIVATIVE &optional ABSOLUTE-ERROR RELATIVE-ERROR METHOD

Find the root of a real function of a real variable. Returns the argument value of the root and the computed value of the function at that value. The argument and return values may be physical quantities. If derivative is nil, the function should return value and derivative as multiple values.

Package
Source

one-dim.lisp (file)

Methods
Method: root-1d FUNCTION (INITIAL physical-quantity) DERIVATIVE &optional ABSOLUTE-ERROR RELATIVE-ERROR METHOD
Source

one-dim-pq.lisp (file)

Method: root-1d FUNCTION INITIAL DERIVATIVE &optional ABSOLUTE-ERROR RELATIVE-ERROR METHOD
Generic Function: round NUMBER &optional DIVISOR

Nearest multiple of divisor to number.

Package
Source

generic.lisp (file)

Methods
Method: round (NUMBER number) &optional DIVISOR
Generic Function: show-state STATE

Show the physical state attributes.

Package
Source

state.lisp (file)

Methods
Method: show-state (STATE hash-table)
Generic Function: signum A

Signum(a).

Package
Source

generic.lisp (file)

Methods
Method: signum (A number)
Method: signum A
Generic Function: sin NUM

The sine of the generalized or regular number.

Package
Source

generic.lisp (file)

Methods
Method: sin (X physical-quantity)
Source

arithmetic.lisp (file)

Method: sin X
Source

mathematics.lisp (file)

Method: sin (NUM rational)
Method: sin (NUM number)
Method: sin (X sequence)
Generic Function: sinh NUM

The hyperbolic sine of the generalized or regular number.

Package
Source

generic.lisp (file)

Methods
Method: sinh (X physical-quantity)
Source

arithmetic.lisp (file)

Method: sinh X
Source

mathematics.lisp (file)

Method: sinh (NUM rational)
Method: sinh (NUM number)
Method: sinh (X sequence)
Generic Function: specification GRID

The grid specification.

Package
Source

functions.lisp (file)

Methods
Method: specification (OBJECT physical-quantity)
Source

grid.lisp (file)

Method: specification GRID
Generic Function: state-value ATTRIBUTE STATE &optional STATE-FUNCTION-GENERATOR

Get the value of the attribute from the state table.
If it is not present, compute it if possible with state-function-generator. If state-function-generator is nil, do not compute.

Package
Source

state.lisp (file)

Writer

(setf state-value) (function)

Methods
Method: state-value ATTRIBUTE (STATE-TABLE hash-table) &optional STATE-FUNCTION-GENERATOR
Method: state-value ATTRIBUTE (STATE null) &optional STATE-FUNCTION-GENERATOR
Generic Function: tan NUM

The tangent of the generalized or regular number.

Package
Source

generic.lisp (file)

Methods
Method: tan (X physical-quantity)
Source

arithmetic.lisp (file)

Method: tan X
Source

mathematics.lisp (file)

Method: tan (NUM rational)
Method: tan (NUM number)
Method: tan (X sequence)
Generic Function: tanh NUM

The hyperbolic tangent of the generalized or regular number.

Package
Source

generic.lisp (file)

Methods
Method: tanh (X physical-quantity)
Source

arithmetic.lisp (file)

Method: tanh X
Source

mathematics.lisp (file)

Method: tanh (NUM rational)
Method: tanh (NUM number)
Method: tanh (X sequence)
Generic Function: test-walker OBJECT

Output the indices generated by a walker. For testing purposes.

Package
Source

affi.lisp (file)

Methods
Method: test-walker (AFFI affi)

Make and then test a walker.

Method: test-walker (WALKER function)

Output the indices generated by a walker. For testing purposes.

Generic Function: timeparse OBJECT
Package
Methods
Method: timeparse (DTSPEC dtspec)

Source

dtspec.lisp (file)

Generic Function: total-size GRID
Package
Source

functions.lisp (file)

Methods
Method: total-size (OBJECT physical-quantity)
Source

grid.lisp (file)

Method: total-size (FOREIGN-ARRAY foreign-array)

Source

foreign-array.lisp (file)

Method: total-size GRID
Generic Function: zerop A

Zero.

Package
Source

generic.lisp (file)

Methods
Method: zerop (X physical-quantity)
Source

arithmetic.lisp (file)

Method: zerop (GRID foreign-array)
Source

methods.lisp (file)

Method: zerop (GRID array)
Source

functions.lisp (file)

Method: zerop (A number)
Method: zerop (X sequence)
Method: zerop A

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

#### 6.1.8 Conditions

Condition: array-mismatch ()

An error indicating that the two arrays do not have the same dimensions.

Package
Source

copy.lisp (file)

Direct superclasses

error (condition)

Condition: coerce-nil ()

Signalled when coercing something to nil.

Package
Source

conditions.lisp (file)

Direct superclasses

arithmetic-error (condition)

Direct methods

coerce-object (method)

Direct slots
Slot: object
Initargs

:object

coerce-object (generic function)

Condition: coerce-undefined ()

Signalled when making a generalized number in which a higher type
(like taylor-number) is a component of a lower type (like physical-quantity).

Package
Source

conditions.lisp (file)

Direct superclasses

arithmetic-error (condition)

Direct methods
Direct slots
Slot: object
Initargs

:object

coerce-object (generic function)

Slot: to
Initargs

:to

coerce-to (generic function)

Condition: making-complex-number ()

Signalled when a mathematical calculation would result in a complex number.

Package
Source

conditions.lisp (file)

Direct superclasses

arithmetic-error (condition)

Direct methods
Direct slots
Slot: operation
Initargs

:operation

mcn-operation (generic function)

Slot: number
Initargs

:number

mcn-number (generic function)

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

#### 6.1.9 Classes

Class: affi ()
Package
Source

affi.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
• test-walker (method)
• print-object (method)
• initialize-instance (method)
• domain (method)
Direct slots
Slot: const
Initargs

:const

Slot: coeff
Initargs

:coeff

Slot: domain
Initargs

:domain

domain (generic function)

Class: dtspec ()

Specification of date and time, without an assigned scale.

Package
Source

dtspec.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

timepoint (class)

Direct methods
Direct slots
Slot: iso8601
Initargs

:iso8601

iso8601 (generic function)

Slot: timeparse
Initargs

:timeparse

timeparse (generic function)

Slot: day-only
Initargs

:day-only

day-only (generic function)

Class: foreign-array ()

Arrays that can be referenced by foreign functions.

Package
Source

foreign-array.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: foreign-pointer
Initargs

:foreign-pointer

foreign-pointer (generic function)

Slot: dimensions
Initargs

:dimensions

dimensions (generic function)

Slot: total-size

total-size (generic function)

Slot: element-type
Initargs

:element-type

Initform

grid:*default-element-type*

element-type (generic function)

Slot: affi

affi (generic function)

Slot: cl-array

cl-array (generic function)

Initargs

Class: matrix ()

Foreign matrices.

Package
Source

vector-matrix.lisp (file)

Direct superclasses

foreign-array (class)

Direct subclasses
Direct methods

expt (method)

Class: matrix-complex-double-float ()
Package
Source

vector-matrix.lisp (file)

Direct superclasses

matrix (class)

Direct methods
• eigenvalues-eigenvectors-gensymm (method)
• eigenvalues-gensymm (method)
• sort-eigenvalues-eigenvectors (method)
• eigenvalues-eigenvectors (method)
• eigenvalues (method)
• tridiagonal-unpack-t (method)
• tridiagonal-unpack (method)
• tridiagonal-decomposition (method)
• cholesky-solve (method)
• cholesky-decomposition (method)
• lu-sgndet (method)
• lu-log-determinant (method)
• lu-determinant (method)
• lu-invert (method)
• lu-refine (method)
• lu-solve (method)
• lu-decomposition (method)
• hermitian-rank-2-update (method)
• symmetric-rank-2-update (method)
• hermitian-rank-1-update (method)
• symmetric-rank-1-update (method)
• inverse-matrix-product (method)
• matrix-product-triangular (method)
• matrix-product-hermitian (method)
• matrix-product-symmetric (method)
• matrix-product (method)
• hermitian-rank-2-update (method)
• hermitian-rank-1-update (method)
• conjugate-rank-1-update (method)
• rank-1-update (method)
• matrix-product-hermitian (method)
• inverse-matrix-product (method)
• matrix-product-triangular (method)
• matrix-product (method)
• non-negative-p (method)
• mminusp (method)
• mplusp (method)
• mzerop (method)
• elt* (method)
• elt- (method)
• elt+ (method)
• elt+ (method)
• swap (method)
• set-zero (method)
• set-all (method)
• alloc-from-block (method)
• matrix-transpose (method)
• matrix-transpose* (method)
• swap-row-column (method)
• swap-columns (method)
• swap-rows (method)
• column (method)
• column (method)
• row (method)
• row (method)
• set-identity (method)
• aref* (method)
• aref (method)
• aref* (method)
• aref (method)
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (complex double-float))

Class: matrix-complex-single-float ()
Package
Source

vector-matrix.lisp (file)

Direct superclasses

matrix (class)

Direct methods
• hermitian-rank-2-update (method)
• symmetric-rank-2-update (method)
• hermitian-rank-1-update (method)
• symmetric-rank-1-update (method)
• inverse-matrix-product (method)
• matrix-product-triangular (method)
• matrix-product-hermitian (method)
• matrix-product-symmetric (method)
• matrix-product (method) <