The antik Reference Manual

This is the antik Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 19:25:57 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 antik

A library of numerical mathematics.

Author

Liam M. Healy

License

GPL v3

Dependencies
Source

antik.asd.

Child Components

2.2 physical-dimension

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

Author

Liam M. Healy

License

GPL v3

Dependencies
  • foreign-array (system).
  • fare-utils (system).
  • trivial-utf-8 (system).
Source

physical-dimension.asd.

Child Components

2.3 foreign-array

A library providing access to foreign (i.e., C) arrays.

Author

Liam M. Healy

License

GPL v3

Dependencies
  • antik-base (system).
  • cffi (system).
  • trivial-garbage (system).
  • static-vectors (system).
Source

foreign-array.asd.

Child Component

foreign-array (module).


2.4 antik-base

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

Author

Liam M. Healy

License

GPL v3

Dependencies
  • iterate (system).
  • alexandria (system).
  • metabang-bind (system).
  • named-readtables (system).
  • cl-ppcre (system).
  • split-sequence (system).
  • lisp-unit (system).
Source

antik-base.asd.

Child Components

3 Modules

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


3.1 antik/mathematics

Source

antik.asd.

Parent Component

antik (system).

Child Components

3.2 antik/optimize

Dependency

mathematics (module).

Source

antik.asd.

Parent Component

antik (system).

Child Components

3.3 antik/linear-algebra

Dependency

optimize (module).

Source

antik.asd.

Parent Component

antik (system).

Child Components

3.4 antik/sample

Dependency

linear-algebra (module).

Source

antik.asd.

Parent Component

antik (system).

Child Component

low-discrepancy-sequence.lisp (file).


3.5 physical-dimension/init

Source

physical-dimension.asd.

Parent Component

physical-dimension (system).

Child Component

pd-shadow-symbols.lisp (file).


3.6 physical-dimension/physical-quantities

Dependency

init (module).

Source

physical-dimension.asd.

Parent Component

physical-dimension (system).

Child Components

3.7 physical-dimension/cartesian

Dependency

physical-quantities (module).

Source

physical-dimension.asd.

Parent Component

physical-dimension (system).

Child Components

3.8 physical-dimension/date-time

Dependency

cartesian (module).

Source

physical-dimension.asd.

Parent Component

physical-dimension (system).

Child Components

3.9 physical-dimension/tests

Dependency

date-time (module).

Source

physical-dimension.asd.

Parent Component

physical-dimension (system).

Child Components

3.10 foreign-array/foreign-array

Source

foreign-array.asd.

Parent Component

foreign-array (system).

Child Components

3.11 foreign-array/foreign-array/tests

Source

foreign-array.asd.

Parent Component

foreign-array (module).

Child Components

3.12 antik-base/init

Source

antik-base.asd.

Parent Component

antik-base (system).

Child Components

3.13 antik-base/input-output

Dependency

init (module).

Source

antik-base.asd.

Parent Component

antik-base (system).

Child Components

3.14 antik-base/date-time

Dependency

input-output (module).

Source

antik-base.asd.

Parent Component

antik-base (system).

Child Components

3.15 antik-base/grid

Dependency

date-time (module).

Source

antik-base.asd.

Parent Component

antik-base (system).

Child Components

3.16 antik-base/grid/affi

Source

antik-base.asd.

Parent Component

grid (module).

Child Components

3.17 antik-base/grid/tests

Source

antik-base.asd.

Parent Component

grid (module).

Child Components

3.18 antik-base/tests

Dependency

grid (module).

Source

antik-base.asd.

Parent Component

antik-base (system).

Child Component

numbers.lisp (file).


4 Files

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


4.1 Lisp


4.1.1 antik/antik.asd

Source

antik.asd.

Parent Component

antik (system).

ASDF Systems

antik.


4.1.2 physical-dimension/physical-dimension.asd

Source

physical-dimension.asd.

Parent Component

physical-dimension (system).

ASDF Systems

physical-dimension.


4.1.3 foreign-array/foreign-array.asd

Source

foreign-array.asd.

Parent Component

foreign-array (system).

ASDF Systems

foreign-array.


4.1.4 antik-base/antik-base.asd

Source

antik-base.asd.

Parent Component

antik-base (system).

ASDF Systems

antik-base.


4.1.5 antik/mathematics/integers.lisp

Source

antik.asd.

Parent Component

mathematics (module).

Public Interface

prime-factors (function).


4.1.6 antik/mathematics/trigonometry.lisp

Dependency

integers.lisp (file).

Source

antik.asd.

Parent Component

mathematics (module).

Public Interface

4.1.7 antik/optimize/one-dim.lisp

Source

antik.asd.

Parent Component

optimize (module).

Public Interface
Internals

*maximum-iterations* (special variable).


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

Source

antik.asd.

Parent Component

optimize (module).

Public Interface

root-1d (method).


4.1.9 antik/optimize/least-squares.lisp

Source

antik.asd.

Parent Component

optimize (module).

Public Interface

linear-least-squares-1d (function).


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

Source

antik.asd.

Parent Component

linear-algebra (module).

Public Interface
Internals
  • *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

Source

antik.asd.

Parent Component

linear-algebra (module).


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

Source

antik.asd.

Parent Component

sample (module).

Public Interface
Internals

4.1.13 physical-dimension/init/pd-shadow-symbols.lisp

Source

physical-dimension.asd.

Parent Component

init (module).


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

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).


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

Dependency

format-output.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).

Public Interface
Internals

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

Dependency

units.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).

Public Interface
Internals

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

Dependency

scalar.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).

Internals

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

Dependency

funcall.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).

Public Interface
Internals

*degree-symbol* (special variable).


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

Dependency

unit-definitions.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).


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

Dependency

degree-symbol.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).


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

Dependency

sysunit-definitions.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).

Public Interface
Internals

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

Dependency

physical-quantities.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).

Public Interface
Internals

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

Dependency

undimension.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).

Public Interface
Internals

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

Dependency

arithmetic.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).

Public Interface
Internals

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

Dependency

angle.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).

Public Interface

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

Dependency

angle-component.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).

Public Interface
Internals

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

Dependency

state.lisp (file).

Source

physical-dimension.asd.

Parent Component

physical-quantities (module).

Public Interface
Internals

4.1.28 physical-dimension/cartesian/cartesian.lisp

Source

physical-dimension.asd.

Parent Component

cartesian (module).

Public Interface

4.1.29 physical-dimension/cartesian/polar.lisp

Dependency

cartesian.lisp (file).

Source

physical-dimension.asd.

Parent Component

cartesian (module).

Public Interface

4.1.30 physical-dimension/cartesian/rotation.lisp

Dependency

polar.lisp (file).

Source

physical-dimension.asd.

Parent Component

cartesian (module).

Public Interface
Internals

4.1.31 physical-dimension/date-time/formats.lisp

Source

physical-dimension.asd.

Parent Component

date-time (module).

Public Interface
Internals

4.1.32 physical-dimension/date-time/time-interval.lisp

Dependency

formats.lisp (file).

Source

physical-dimension.asd.

Parent Component

date-time (module).

Public Interface
Internals

time-interval-format (function).


4.1.33 physical-dimension/date-time/relative-time.lisp

Dependency

time-interval.lisp (file).

Source

physical-dimension.asd.

Parent Component

date-time (module).

Public Interface

4.1.34 physical-dimension/date-time/linear-timepoint.lisp

Dependency

relative-time.lisp (file).

Source

physical-dimension.asd.

Parent Component

date-time (module).

Internals

4.1.35 physical-dimension/date-time/dtmath.lisp

Dependency

linear-timepoint.lisp (file).

Source

physical-dimension.asd.

Parent Component

date-time (module).

Public Interface
Internals

4.1.36 physical-dimension/date-time/ut1.lisp

Dependency

dtmath.lisp (file).

Source

physical-dimension.asd.

Parent Component

date-time (module).

Public Interface

*real-ut1-utc* (special variable).

Internals

4.1.37 physical-dimension/date-time/time-interval-tests.lisp

Dependency

ut1.lisp (file).

Source

physical-dimension.asd.

Parent Component

date-time (module).

Internals

piti (macro).


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

Source

physical-dimension.asd.

Parent Component

tests (module).

Public Interface
Internals

check-pq (function).


4.1.39 physical-dimension/tests/physical-quantities-grid.lisp

Dependency

physical-quantities.lisp (file).

Source

physical-dimension.asd.

Parent Component

tests (module).


4.1.40 physical-dimension/tests/format-grid.lisp

Dependency

physical-quantities-grid.lisp (file).

Source

physical-dimension.asd.

Parent Component

tests (module).

Internals

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

Source

foreign-array.asd.

Parent Component

foreign-array (module).

Public Interface
Internals

4.1.42 foreign-array/foreign-array/complex-types.lisp

Dependency

types.lisp (file).

Source

foreign-array.asd.

Parent Component

foreign-array (module).

Public Interface
Internals

4.1.43 foreign-array/foreign-array/element-types.lisp

Dependencies
Source

foreign-array.asd.

Parent Component

foreign-array (module).

Public Interface

4.1.44 foreign-array/foreign-array/symbol-type.lisp

Source

foreign-array.asd.

Parent Component

foreign-array (module).

Public Interface

4.1.45 foreign-array/foreign-array/number-conversion.lisp

Dependencies
Source

foreign-array.asd.

Parent Component

foreign-array (module).

Public Interface

dcref (macro).


4.1.46 foreign-array/foreign-array/subclass.lisp

Dependency

element-types.lisp (file).

Source

foreign-array.asd.

Parent Component

foreign-array (module).

Public Interface

data-class-name (function).

Internals

4.1.47 foreign-array/foreign-array/foreign-array.lisp

Dependencies
Source

foreign-array.asd.

Parent Component

foreign-array (module).

Public Interface
Internals

4.1.49 foreign-array/foreign-array/methods.lisp

Dependencies
Source

foreign-array.asd.

Parent Component

foreign-array (module).

Public Interface
Internals

4.1.50 foreign-array/foreign-array/format-output.lisp

Source

foreign-array.asd.

Parent Component

foreign-array (module).

Public Interface

4.1.51 foreign-array/foreign-array/tests/aref.lisp

Source

foreign-array.asd.

Parent Component

tests (module).

Internals

make-grid-set-get (macro).


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

Source

foreign-array.asd.

Parent Component

tests (module).

Public Interface

norm-equal (method).


4.1.53 foreign-array/foreign-array/tests/compose.lisp

Source

foreign-array.asd.

Parent Component

tests (module).


4.1.54 antik-base/init/package.lisp

Source

antik-base.asd.

Parent Component

init (module).

Packages
Public Interface
Internals

4.1.55 antik-base/init/utility.lisp

Dependency

package.lisp (file).

Source

antik-base.asd.

Parent Component

init (module).

Public Interface
Internals

4.1.56 antik-base/init/conditions.lisp

Dependency

utility.lisp (file).

Source

antik-base.asd.

Parent Component

init (module).

Public Interface
Internals

4.1.57 antik-base/init/object.lisp

Dependency

conditions.lisp (file).

Source

antik-base.asd.

Parent Component

init (module).

Public Interface

4.1.58 antik-base/init/iterate.lisp

Dependency

object.lisp (file).

Source

antik-base.asd.

Parent Component

init (module).


4.1.59 antik-base/init/intermediate.lisp

Dependency

iterate.lisp (file).

Source

antik-base.asd.

Parent Component

init (module).

Public Interface
Internals

4.1.60 antik-base/init/generic.lisp

Dependency

intermediate.lisp (file).

Source

antik-base.asd.

Parent Component

init (module).

Public Interface
  • * (function).
  • + (function).
  • - (function).
  • / (function).
  • < (function).
  • <= (function).
  • = (function).
  • > (function).
  • >= (function).
  • abs (generic function).
  • acos (generic function).
  • asin (generic function).
  • atan (generic function).
  • coerce (generic function).
  • cos (generic function).
  • cosh (generic function).
  • decf (macro).
  • exp (generic function).
  • expt (generic function).
  • floor (generic function).
  • incf (macro).
  • log (generic function).
  • max (function).
  • min (function).
  • minusp (generic function).
  • plusp (generic function).
  • round (generic function).
  • signum (generic function).
  • sin (generic function).
  • sinh (generic function).
  • sqrt (function).
  • tan (generic function).
  • tanh (generic function).
  • zerop (generic function).
Internals

4.1.61 antik-base/input-output/readtable.lisp

Source

antik-base.asd.

Parent Component

input-output (module).

Public Interface

4.1.62 antik-base/input-output/parameters.lisp

Dependency

readtable.lisp (file).

Source

antik-base.asd.

Parent Component

input-output (module).

Public Interface
Internals

4.1.63 antik-base/input-output/format-output.lisp

Dependency

parameters.lisp (file).

Source

antik-base.asd.

Parent Component

input-output (module).

Public Interface
Internals

4.1.64 antik-base/input-output/float.lisp

Dependency

format-output.lisp (file).

Source

antik-base.asd.

Parent Component

input-output (module).

Public Interface
Internals

4.1.65 antik-base/input-output/matlab.lisp

Dependency

float.lisp (file).

Source

antik-base.asd.

Parent Component

input-output (module).

Public Interface

format-matlab-list (function).


4.1.66 antik-base/input-output/org-mode.lisp

Dependency

matlab.lisp (file).

Source

antik-base.asd.

Parent Component

input-output (module).

Public Interface

4.1.67 antik-base/input-output/write.lisp

Dependency

org-mode.lisp (file).

Source

antik-base.asd.

Parent Component

input-output (module).

Public Interface

write-data (function).


4.1.68 antik-base/input-output/read.lisp

Dependency

write.lisp (file).

Source

antik-base.asd.

Parent Component

input-output (module).

Public Interface
Internals

4.1.69 antik-base/date-time/format-output.lisp

Source

antik-base.asd.

Parent Component

date-time (module).


4.1.70 antik-base/date-time/iso8601.lisp

Dependency

format-output.lisp (file).

Source

antik-base.asd.

Parent Component

date-time (module).

Internals

4.1.71 antik-base/date-time/dtspec.lisp

Dependency

iso8601.lisp (file).

Source

antik-base.asd.

Parent Component

date-time (module).

Public Interface
Internals

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

Dependency

dtspec.lisp (file).

Source

antik-base.asd.

Parent Component

date-time (module).

Public Interface
Internals

4.1.73 antik-base/date-time/read-time.lisp

Dependency

timepoint.lisp (file).

Source

antik-base.asd.

Parent Component

date-time (module).

Public Interface
Internals

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

Dependency

read-time.lisp (file).

Source

antik-base.asd.

Parent Component

date-time (module).

Public Interface

convert-time-scale (function).

Internals

4.1.75 antik-base/grid/util.lisp

Source

antik-base.asd.

Parent Component

grid (module).

Public Interface
Internals

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

Source

antik-base.asd.

Parent Component

affi (module).

Packages

affi.


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

Dependency

package.lisp (file).

Source

antik-base.asd.

Parent Component

affi (module).

Internals

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

Dependency

utility.lisp (file).

Source

antik-base.asd.

Parent Component

affi (module).

Public Interface
Internals

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

Dependency

affi.lisp (file).

Source

antik-base.asd.

Parent Component

affi (module).

Public Interface
Internals

4.1.80 antik-base/grid/functions.lisp

Dependencies
Source

antik-base.asd.

Parent Component

grid (module).

Public Interface
Internals

4.1.81 antik-base/grid/specification.lisp

Dependencies
Source

antik-base.asd.

Parent Component

grid (module).

Public Interface

spec-scalar-p (function).

Internals

4.1.82 antik-base/grid/array.lisp

Dependencies
Source

antik-base.asd.

Parent Component

grid (module).

Public Interface
Internals

4.1.83 antik-base/grid/map.lisp

Dependencies
Source

antik-base.asd.

Parent Component

grid (module).

Public Interface
Internals

4.1.84 antik-base/grid/compose.lisp

Dependencies
Source

antik-base.asd.

Parent Component

grid (module).

Public Interface

4.1.85 antik-base/grid/slice.lisp

Dependency

affi (module).

Source

antik-base.asd.

Parent Component

grid (module).

Public Interface

slice (function).

Internals

4.1.86 antik-base/grid/matrix.lisp

Source

antik-base.asd.

Parent Component

grid (module).

Public Interface

4.1.87 antik-base/grid/norm-vector-product.lisp

Dependencies
Source

antik-base.asd.

Parent Component

grid (module).

Public Interface

4.1.88 antik-base/grid/copy.lisp

Source

antik-base.asd.

Parent Component

grid (module).

Public Interface
Internals

copy-grid (function).


4.1.89 antik-base/grid/iterate.lisp

Dependency

compose.lisp (file).

Source

antik-base.asd.

Parent Component

grid (module).


4.1.90 antik-base/grid/mathematics.lisp

Dependency

map.lisp (file).

Source

antik-base.asd.

Parent Component

grid (module).

Public Interface
Internals
  • *i (method).
  • *i (method).
  • +i (method).
  • +i (method).
  • -i (method).
  • -i (method).
  • /i (method).
  • /i (method).

4.1.91 antik-base/grid/index-functions.lisp

Source

antik-base.asd.

Parent Component

grid (module).

Public Interface

4.1.92 antik-base/grid/indexed.lisp

Dependency

specification.lisp (file).

Source

antik-base.asd.

Parent Component

grid (module).

Public Interface

read-indexed-data (function).


4.1.93 antik-base/grid/format-output.lisp

Source

antik-base.asd.

Parent Component

grid (module).

Public Interface
  • nf (method).
  • nf (method).
Internals

4.1.94 antik-base/grid/parameters.lisp

Source

antik-base.asd.

Parent Component

grid (module).

Public Interface

make-parameters-from-table (function).


4.1.95 antik-base/grid/tests/augment.lisp

Source

antik-base.asd.

Parent Component

tests (module).

Internals

4.1.96 antik-base/grid/tests/sequence.lisp

Source

antik-base.asd.

Parent Component

tests (module).


4.1.97 antik-base/grid/tests/compose.lisp

Source

antik-base.asd.

Parent Component

tests (module).


4.1.98 antik-base/grid/tests/map.lisp

Source

antik-base.asd.

Parent Component

tests (module).


4.1.99 antik-base/grid/tests/slice.lisp

Source

antik-base.asd.

Parent Component

tests (module).


4.1.100 antik-base/grid/tests/norm-vector-product.lisp

Source

antik-base.asd.

Parent Component

tests (module).


4.1.101 antik-base/tests/numbers.lisp

Source

antik-base.asd.

Parent Component

tests (module).


5 Packages

Packages are listed by definition order.


5.1 antik

Source

package.lisp.

Use List
  • common-lisp.
  • iterate.
Used By List

antik-user.

Public Interface
Internals

5.2 grid

Source

package.lisp.

Use List

common-lisp.

Used By List

antik-user.

Public Interface
Internals

5.3 affi

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Constants

Constant: +days-per-month+
Package

antik.

Source

dtspec.lisp.

Constant: +foreign-pointer-class+

The class in which foreign pointers fall.

Package

grid.

Source

types.lisp.

Constant: +foreign-pointer-type+

The type of foreign pointers.

Package

grid.

Source

types.lisp.

Constant: +hours-per-day+
Package

antik.

Source

dtspec.lisp.

Constant: +minutes-per-hour+
Package

antik.

Source

dtspec.lisp.

Constant: +months-per-year+
Package

antik.

Source

dtspec.lisp.

Constant: +seconds-per-day+
Package

antik.

Source

dtspec.lisp.

Constant: +seconds-per-hour+
Package

antik.

Source

dtspec.lisp.

Constant: +seconds-per-minute+
Package

antik.

Source

dtspec.lisp.

Constant: +seconds-per-month+
Package

antik.

Source

dtspec.lisp.

Constant: +seconds-per-year+
Package

antik.

Source

dtspec.lisp.

Constant: 2pi
Package

antik.

Source

unit-definitions.lisp.


6.1.2 Special variables

Special Variable: *array-element-types*

All the array element types supported.

Package

grid.

Source

element-types.lisp.

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

All the array element types supported except for complex types.

Package

grid.

Source

element-types.lisp.

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

NF options for LaTeX output generated from parameters.

Package

antik.

Source

org-mode.lisp.

Special Variable: *complex-types*

All the supported complex array element types.

Package

grid.

Source

element-types.lisp.

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

grid.

Source

types.lisp.

Special Variable: *datime-readable*

Whether to print datimes readably.

Package

antik.

Source

dtspec.lisp.

Special Variable: *default-dimensions*
Package

grid.

Source

functions.lisp.

Special Variable: *default-element-type*
Package

grid.

Source

types.lisp.

Special Variable: *default-grid-type*
Package

grid.

Source

functions.lisp.

Special Variable: *default-sfg*

The default state function generator.

Package

antik.

Source

state.lisp.

Special Variable: *default-specific-exponent-marker*
Package

antik.

Source

float.lisp.

Special Variable: *double-types*

All the supported double float element types.

Package

grid.

Source

element-types.lisp.

Special Variable: *float-complex-types*

All the float or complex array element types supported.

Package

grid.

Source

element-types.lisp.

Special Variable: *float-types*

All the float array element types.

Package

grid.

Source

element-types.lisp.

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

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

Package

antik.

Source

float.lisp.

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

grid.

Source

functions.lisp.

Special Variable: *prehistoric*
Package

antik.

Source

read-time.lisp.

Special Variable: *print-contents*

Print the contents of the foreign-array.

Package

grid.

Source

foreign-array.lisp.

Special Variable: *print-foreign-array-readably*

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

Package

grid.

Source

format-output.lisp.

Special Variable: *real-ut1-utc*

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

Package

antik.

Source

ut1.lisp.

Special Variable: *return-formula*

Show the formula used in computing the attribute.

Package

antik.

Source

state.lisp.

Special Variable: *timepoint-print-scale*

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

Package

antik.

Source

timepoint.lisp.

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

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

Package

antik.

Source

timepoint.lisp.

Special Variable: *timescales*

All known time scales.

Package

antik.

Source

read-time.lisp.

Special Variable: *use-readable-print-form*

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

Package

antik.

Source

object.lisp.

Special Variable: *zero-is-dimensionless*

Numbers with zero magnitude are made dimensionless.

Package

antik.

Source

scalar.lisp.


6.1.3 Symbol macros

Symbol Macro: @
Package

antik.

Source

package.lisp.

Symbol Macro: half-revolution
Package

antik.

Source

unit-definitions.lisp.

Symbol Macro: now
Package

antik.

Source

timepoint.lisp.

Symbol Macro: radian
Package

antik.

Source

unit-definitions.lisp.

Symbol Macro: revolution
Package

antik.

Source

unit-definitions.lisp.

Symbol Macro: texstyle
Package

antik.

Source

format-output.lisp.

Symbol Macro: today
Package

antik.

Source

timepoint.lisp.


6.1.4 Macros

Macro: accept-coerce (&body body)

A handler to accept coerced object.

Package

antik.

Source

conditions.lisp.

Macro: arithmetic-errors-return-nan (&body body)

Return a NaN for a variety of arithmetic errors.

Package

antik.

Source

conditions.lisp.

Macro: components (name)

Components of vector.

Package

antik.

Source

state.lisp.

Macro: constraints (name)

Constraint on acceptable values.

Package

antik.

Source

state.lisp.

Macro: creation-form-readably (object non-readably)

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

Package

antik.

Source

object.lisp.

Macro: dcref (double &optional index)

Reference C double(s).

Package

grid.

Source

number-conversion.lisp.

Macro: decf (ref &optional delta)
Package

antik.

Source

generic.lisp.

Macro: def-dyadic-scalar (method &optional operation left right)

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

Package

antik.

Source

mathematics.lisp.

Macro: def-make-load-form (object-type)

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

Package

antik.

Source

object.lisp.

Macro: def-monadic (operation)

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

Package

antik.

Source

mathematics.lisp.

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

antik.

Source

state.lisp.

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

antik.

Source

parameters.lisp.

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

antik.

Source

units.lisp.

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

antik.

Source

units.lisp.

Macro: dimension (unit-or-dimension)

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

Package

antik.

Source

units.lisp.

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

antik.

Source

undimension.lisp.

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

antik.

Source

org-mode.lisp.

Macro: floating-point-association (splice-list)
Package

grid.

Source

types.lisp.

Macro: gsetf (&rest args)
Package

grid.

Source

methods.lisp.

Macro: handling-complex-number (restart &body body)

A handler to make the complex number.

Package

antik.

Source

conditions.lisp.

Macro: incf (ref &optional delta)
Package

antik.

Source

generic.lisp.

Macro: length (&rest args)
Package

antik.

Source

utility.lisp.

Macro: metadata-slot (object name)

Access a slot in the foreign-metadata.

Package

grid.

Source

foreign-array.lisp.

Macro: nf-option (name)

Get/set the nf option named.

Package

antik.

Source

format-output.lisp.

Macro: parameter-value (category name)

Get or set the parameter value.

Package

antik.

Source

parameters.lisp.

Setf expander for this macro

(setf parameter-value).

Macro: pedagogical (keyword &body body)
Package

antik.

Source

intermediate.lisp.

Macro: print-name (unit)

How a unit is printed.

Package

antik.

Source

units.lisp.

Macro: pythagorean-complement (x)

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

Package

antik.

Source

utility.lisp.

Macro: pythagorean-sum (&rest args)

Sum the squares of the arguments.

Package

antik.

Source

utility.lisp.

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

antik.

Source

intermediate.lisp.

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

antik.

Source

intermediate.lisp.

Macro: serialize-binding (symbol)

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

Package

antik.

Source

object.lisp.

Macro: set-nf-options (&rest name-values)

Set the numerical formatting options.

Package

antik.

Source

format-output.lisp.

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

antik.

Source

parameters.lisp.

Setf expanders to this macro

(setf parameter-value).

Macro: set-parameters (category &rest names-values)

Set the values of the parameters.

Package

antik.

Source

parameters.lisp.

Macro: set-reader-in-file (&optional readtable default-float)

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

antik.

Source

readtable.lisp.

Macro: time (&rest args)
Package

antik.

Source

utility.lisp.

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

antik.

Source

org-mode.lisp.

Macro: with-new-units ((&rest units) &body body)

Augment the current system of units with the named units.

Package

antik.

Source

units.lisp.

Macro: with-nf-options ((&rest name-values) &body body)

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

Package

antik.

Source

format-output.lisp.

Macro: with-parameters ((category &rest name-values) &body body)

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

Package

antik.

Source

parameters.lisp.

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

antik.

Source

physical-quantities.lisp.

Macro: with-si-units (&body body)

Use the SI system of units in the body.

Package

antik.

Source

units.lisp.

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

antik.

Source

units.lisp.

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

antik.

Source

undimension.lisp.

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

antik.

Source

undimension.lisp.


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

grid.

Source

methods.lisp.

Compiler Macro: (setf aref) (object &rest indices)
Package

grid.

Source

methods.lisp.

Compiler Macro: aref* (object linearized-index)

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

Package

grid.

Source

methods.lisp.

Compiler Macro: (setf aref*) (object linearized-index)
Package

grid.

Source

methods.lisp.


6.1.6 Setf expanders

Setf Expander: (setf parameter-value) (&rest args)
Package

antik.

Source

parameters.lisp.

Reader

parameter-value (macro).

Writer

set-parameter (macro).


6.1.7 Ordinary functions

Function: * (&rest args)

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

Package

antik.

Source

generic.lisp.

Function: + (&rest args)

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

Package

antik.

Source

generic.lisp.

Function: - (&rest args)

Subtraction of generalized or regular numbers.

Package

antik.

Source

generic.lisp.

Function: / (&rest args)

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

Package

antik.

Source

generic.lisp.

Function: < (&rest args)
Package

antik.

Source

generic.lisp.

Function: <= (&rest args)
Package

antik.

Source

generic.lisp.

Function: = (&rest args)
Package

antik.

Source

generic.lisp.

Function: > (&rest args)
Package

antik.

Source

generic.lisp.

Function: >= (&rest args)
Package

antik.

Source

generic.lisp.

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

antik.

Source

utility.lisp.

Function: all-types (alist &optional right-side)

A list of all types defined by symbol or definition.

Package

grid.

Source

types.lisp.

Function: angle-as-time (angle &optional normalize)

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

Package

antik.

Source

angle.lisp.

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

antik.

Source

angle.lisp.

Function: angle-greater-than (angle greater-than)

Find an equivalent angle that is greater than the greater-than angle.

Package

antik.

Source

angle-component.lisp.

Function: angle-law-of-cosines (length-opp length-adj1 length-adj2)

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

Package

antik.

Source

trigonometry.lisp.

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

antik.

Source

low-discrepancy-sequence.lisp.

Function: attributep (symbol-or-list &optional error)

This is a defined attribute, or list of attributes.

Package

antik.

Source

state.lisp.

Function: calculate-index (affi subscripts)

Calculate the index of a given vector of subscripts.

Package

affi.

Source

affi.lisp.

Function: cffi-cl (cffi-type)

The CL type from the CFFI element type.

Package

grid.

Source

types.lisp.

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

affi.

Source

affi.lisp.

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

antik.

Source

physical-quantities.lisp.

Function: check-dimensions (dimensions &optional errorp)

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

Package

grid.

Source

array.lisp.

Function: cl-cffi (cl-type)

The CFFI element type from the CL type.

Package

grid.

Source

types.lisp.

Function: cl-single (cl-type &optional package)

The element type name as a single symbol.

Package

grid.

Source

types.lisp.

Function: clut-to-timepoint (clut &optional day-only)

Compute the timepoint from the CLUT.

Package

antik.

Source

timepoint.lisp.

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

grid.

Source

compose.lisp.

Function: (setf codimension-one-subspace) (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

grid.

Source

compose.lisp.

Function: column (grid index &optional destination)

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

Package

grid.

Source

matrix.lisp.

Function: (setf column) (grid index)

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

Package

grid.

Source

matrix.lisp.

Function: columns (grid)

A list of all the columns.

Package

grid.

Source

matrix.lisp.

Function: component-float-type (eltype)

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

Package

grid.

Source

complex-types.lisp.

Function: component-type (eltype)
Package

grid.

Source

complex-types.lisp.

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

grid.

Source

compose.lisp.

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

grid.

Source

functions.lisp.

Function: convert-time-scale (timepoint new-scale)

Convert time from one scale to another.

Package

antik.

Source

convert-timescale.lisp.

Function: coordinate-unit-vector (i &optional length)

A coordinate unit vector.

Package

antik.

Source

cartesian.lisp.

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

antik.

Source

cartesian.lisp.

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

antik.

Source

state.lisp.

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

grid.

Source

copy.lisp.

Function: cross (grid0 grid1)

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

Package

grid.

Source

norm-vector-product.lisp.

Function: data-class-name (category-or-rank element-type &optional making-class)

The class name from the type of element.

Package

grid.

Source

subclass.lisp.

Function: datime+ (tp time)

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

Package

antik.

Source

dtmath.lisp.

Function: datime- (datime1 b)

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

Package

antik.

Source

dtmath.lisp.

Function: datime-j2000day (datime)

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

Package

antik.

Source

dtmath.lisp.

Function: datime-relation (relation args)

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

Package

antik.

Source

dtspec.lisp.

Function: datime< (&rest args)
Package

antik.

Source

dtspec.lisp.

Function: datime<= (&rest args)
Package

antik.

Source

dtspec.lisp.

Function: datime= (&rest args)
Package

antik.

Source

dtspec.lisp.

Function: datime> (&rest args)
Package

antik.

Source

dtspec.lisp.

Function: datime>= (&rest args)
Package

antik.

Source

dtspec.lisp.

Function: days+ (datime &optional increment)

Add the number of days to the given datime.

Package

antik.

Source

dtmath.lisp.

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

antik.

Source

dtmath.lisp.

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

antik.

Source

units.lisp.

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

antik.

Source

units.lisp.

Function: determinant (matrix)

Find the determinant of the matrix.

Package

antik.

Source

linear-algebra.lisp.

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

grid.

Source

compose.lisp.

Function: (setf 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

grid.

Source

compose.lisp.

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

affi.

Source

transformers.lisp.

Function: dim0 (object)

The first dimension of the object.

Package

grid.

Source

util.lisp.

Function: dim1 (object)

The second dimension of the object.

Package

grid.

Source

util.lisp.

Function: distance (a b &optional combination-function)

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

Package

antik.

Source

cartesian.lisp.

Function: dms-angle (angle)

The angle as a list degrees, minutes, seconds.

Package

antik.

Source

angle.lisp.

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

grid.

Source

compose.lisp.

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

affi.

Source

transformers.lisp.

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

antik.

Source

dtspec.lisp.

Function: element-size (object)

The size of each element as stored in C.

Package

grid.

Source

element-types.lisp.

Function: element-types (element-types)

All the element types available of a given category.

Package

grid.

Source

element-types.lisp.

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

grid.

Source

map.lisp.

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

grid.

Source

foreign-array.lisp.

Function: euclidean (grid)

The Euclidean, or 2-norm of the grid.

Package

grid.

Source

norm-vector-product.lisp.

Function: euler-angle-rotation (rot3a rot1 rot3b &optional passive)

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

Package

antik.

Source

rotation.lisp.

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

affi.

Source

transformers.lisp.

Function: first-3vector (vec)

Extract the first 3-vector.

Package

antik.

Source

cartesian.lisp.

Function: format-attribute-name (name &optional separate-components include-units include-name)

Format the attribute name, and possibly the units.

Package

antik.

Source

state.lisp.

Function: format-matlab-list (list &optional stream number-per-line)

Format a matrix row to be read by Matlab.

Package

antik.

Source

matlab.lisp.

Function: from-jd (jd &optional modified scale)

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

Package

antik.

Source

formats.lisp.

Function: from-yyddd (yy-or-yyddd &key ddd scale hours minutes seconds)

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

Package

antik.

Source

formats.lisp.

Function: get-canonical-name (symbol)
Package

antik.

Source

units.lisp.

Function: get-coeff (affi)

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

Package

affi.

Source

affi.lisp.

Function: get-const (affi)

Return the constant in an affine index.

Package

affi.

Source

affi.lisp.

Function: get-domain (affi)

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

Package

affi.

Source

affi.lisp.

Function: gref (grid &rest indices)

Obsolete; use grid:aref.

Package

grid.

Source

functions.lisp.

Function: (setf gref) (grid &rest indices)

Obsolete; use grid:aref.

Package

grid.

Source

functions.lisp.

Function: gref* (grid linearized-index)

Obsolete; use grid:aref*.

Package

grid.

Source

functions.lisp.

Function: (setf gref*) (grid linearized-index)

Obsolete; use grid:aref*.

Package

grid.

Source

functions.lisp.

Function: grid (&rest args)

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

Package

grid.

Source

functions.lisp.

Function: gridp (object)

Object is a grid; type is returned.

Package

grid.

Source

functions.lisp.

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

grid.

Source

compose.lisp.

Function: invert-matrix (matrix)

Invert the matrix; return the inverse and determinant.

Package

antik.

Source

linear-algebra.lisp.

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

antik.

Source

time-interval.lisp.

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

antik.

Source

time-interval.lisp.

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

antik.

Source

formats.lisp.

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

antik.

Source

dtspec.lisp.

Function: length-law-of-cosines (angle length-adj1 length-adj2)

Solve for the opposite length when angle and adjacent lengths of a triangle are known.

Package

antik.

Source

trigonometry.lisp.

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

antik.

Source

least-squares.lisp.

Function: list-no-key (&rest args)

Make a list of the values without the keywords.

Package

antik.

Source

low-discrepancy-sequence.lisp.

Function: long-print-name (unit)

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

Package

antik.

Source

units.lisp.

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

grid.

Source

types.lisp.

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

antik.

Source

low-discrepancy-sequence.lisp.

Function: make-affi-cm (dimensions)

Setup a _column major_ affine mapping using dimensions.

Package

affi.

Source

affi.lisp.

Function: make-dtspec (&key timeparse day-only type)

Make the dtspec arguments.

Package

antik.

Source

dtspec.lisp.

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

grid.

Source

foreign-array.lisp.

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

grid.

Source

foreign-array.lisp.

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

grid.

Source

foreign-array.lisp.

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

grid.

Source

functions.lisp.

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

grid.

Source

index-functions.lisp.

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

grid.

Source

index-functions.lisp.

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

grid.

Source

compose.lisp.

Function: make-new-physical-state (&rest attributes-values)

Make a new physical state with the given attribute values.

Package

antik.

Source

state.lisp.

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

antik.

Source

parameters.lisp.

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

antik.

Source

parameters.lisp.

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

antik.

Source

state.lisp.

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

antik.

Source

scalar.lisp.

Function: make-pq-zero (unit-expression)
Package

antik.

Source

scalar.lisp.

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

grid.

Source

functions.lisp.

Function: make-st (symbol type)
Package

grid.

Source

symbol-type.lisp.

Function: make-state-table ()
Package

antik.

Source

state.lisp.

Function: make-timeparse-majord (&optional year month day hour minute second)
Package

antik.

Source

dtspec.lisp.

Function: make-timeparse-minord (&optional second minute hour day month year)
Package

antik.

Source

dtspec.lisp.

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

antik.

Source

timepoint.lisp.

Function: make-timepoint-j2000sec (j2000sec &optional day-only)

Make a timepoint from J2000sec.

Package

antik.

Source

dtmath.lisp.

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

antik.

Source

package.lisp.

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

affi.

Source

affi.lisp.

Function: map-columns (function matrix)

Apply a function that returns a column for each of the columns of the matrix

Package

grid.

Source

matrix.lisp.

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

grid.

Source

map.lisp.

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

grid.

Source

map.lisp.

Function: map-rows (function matrix)

Apply a function that returns a row for each of the rows of the matrix

Package

grid.

Source

matrix.lisp.

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

antik.

Source

state.lisp.

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

grid.

Source

matrix.lisp.

Function: matrix-from-rows (&rest rows)

Make a matrix from the specified rows

Package

grid.

Source

matrix.lisp.

Function: max (&rest args)
Package

antik.

Source

generic.lisp.

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

antik.

Source

one-dim.lisp.

Function: min (&rest args)
Package

antik.

Source

generic.lisp.

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

antik.

Source

one-dim.lisp.

Function: mkstr (&rest args)

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

Package

antik.

Source

utility.lisp.

Function: nf-readably ()

The format produced will be readable to Lisp.

Package

antik.

Source

format-output.lisp.

Function: nf-string (object)

Format output for numerical objects to a new string.

Package

antik.

Source

format-output.lisp.

Function: norm (grid &optional kind)

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

Package

grid.

Source

norm-vector-product.lisp.

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 for the algorithm to
converge properly, but the full cycles are needed for f & g functions.

Package

antik.

Source

angle.lisp.

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

grid.

Source

norm-vector-product.lisp.

Function: number-class (type)

Find the class corresponding to the numeric type.

Package

grid.

Source

types.lisp.

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

antik.

Source

format-output.lisp.

Function: org-table (list-of-lists &optional stream)

Format the table.

Package

antik.

Source

org-mode.lisp.

Function: org-table-line (list &optional stream)

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

Package

antik.

Source

org-mode.lisp.

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

antik.

Source

parameters.lisp.

Function: permute (affi permutation)

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

Package

affi.

Source

transformers.lisp.

Function: physical-quantity-p (x)
Package

antik.

Source

scalar.lisp.

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

antik.

Source

polar.lisp.

Function: pqwu (pq)

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

Package

antik.

Source

undimension.lisp.

Function: prime-factors (n)

Find the prime factors of the integer n.

Package

antik.

Source

integers.lisp.

Function: print-readably (object &optional stream)

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

Package

antik.

Source

object.lisp.

Function: radian (angle)

The numerical value of the angle in radians.

Package

antik.

Source

angle.lisp.

Function: range (affi)

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

Package

affi.

Source

affi.lisp.

Function: rank (affi)

Return the rank of an affine index.

Package

affi.

Source

affi.lisp.

Function: read-data-file (filename &key separator include-count discard-header)

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

grid.

Source

read.lisp.

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

grid.

Source

read.lisp.

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

grid.

Source

indexed.lisp.

Function: read-time (string)

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

Package

antik.

Source

read-time.lisp.

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

antik.

Source

read-time.lisp.

Function: read-timepoint-iso8601 (string &optional scale)

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

antik.

Source

read-time.lisp.

Function: read-us-date (string &optional day-only)

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

Package

antik.

Source

read-time.lisp.

Function: read-vector-from-string (string count &optional start end)

Read the count element vector from a string.

Package

grid.

Source

read.lisp.

Function: readably ()
Package

antik.

Source

object.lisp.

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

antik.

Source

polar.lisp.

Function: redimension (magnitude unit-expression)

Apply units that were stripped off a quantity.

Package

antik.

Source

undimension.lisp.

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

antik.

Source

relative-time.lisp.

Function: right-angle (vector)

Find an arbitrary right angle to the vector.

Package

antik.

Source

cartesian.lisp.

Function: root-mean-square (grid)

The root mean square of the vector.

Package

grid.

Source

norm-vector-product.lisp.

Function: rotate (angle &optional passive)

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

Package

antik.

Source

rotation.lisp.

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

antik.

Source

rotation.lisp.

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

antik.

Source

rotation.lisp.

Function: row (grid index &optional destination)

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

Package

grid.

Source

matrix.lisp.

Function: (setf row) (grid index)

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

Package

grid.

Source

matrix.lisp.

Function: rows (grid)

A list of all the rows.

Package

grid.

Source

matrix.lisp.

Function: second-3vector (vec)

Extract the second 3-vector.

Package

antik.

Source

cartesian.lisp.

Function: seconds-per-day (datime)

Compute the number of seconds in the given day.

Package

antik.

Source

dtmath.lisp.

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

grid.

Source

compose.lisp.

Function: set-reader (&optional readtable default-float)

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

antik.

Source

readtable.lisp.

Function: set-showing (keyword &optional status)

Set the showing of intermediate values.

Package

antik.

Source

intermediate.lisp.

Function: set-state-value (value attribute state-table)

Set the value of a particular attribute for this state.

Package

antik.

Source

state.lisp.

Function: set-system-of-units (system-of-units &rest units)

Set the default system of units to the specified system.

Package

antik.

Source

units.lisp.

Function: short-print-name (unit)

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

Package

antik.

Source

units.lisp.

Function: single (lst)

Test list for one element.

Package

antik.

Source

utility.lisp.

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

affi.

Source

affi.lisp.

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

grid.

Source

slice.lisp.

Function: solve-linear (matrix vector)

Solve the linear algebra equation.

Package

antik.

Source

linear-algebra.lisp.

Function: spec-scalar-p (specification)

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

Package

grid.

Source

specification.lisp.

Function: sqrt (num)

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

Package

antik.

Source

generic.lisp.

Function: st-actual-type (decl)
Package

grid.

Source

symbol-type.lisp.

Function: st-pointer-generic-pointer (decl)
Package

grid.

Source

symbol-type.lisp.

Function: st-pointerp (decl)

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

Package

grid.

Source

symbol-type.lisp.

Function: st-symbol (decl)
Package

grid.

Source

symbol-type.lisp.

Function: st-type (decl)
Package

grid.

Source

symbol-type.lisp.

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

antik.

Source

dtmath.lisp.

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

antik.

Source

state.lisp.

Function: (setf state-value) (attribute state-table)
Package

antik.

Source

state.lisp.

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

antik.

Source

state.lisp.

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

antik.

Source

utility.lisp.

Function: stride (grid stride &key destination)

Create a new grid with every stride-th element.

Package

grid.

Source

compose.lisp.

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

affi.

Source

transformers.lisp.

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

grid.

Source

compose.lisp.

Function: (setf 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

grid.

Source

compose.lisp.

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

affi.

Source

transformers.lisp.

Function: symb (&rest args)

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

Package

antik.

Source

utility.lisp.

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

antik.

Source

rotation.lisp.

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

antik.

Source

rotation.lisp.

Function: tex-print-name (unit)

How the unit or attribute should be printed in TeX.

Package

antik.

Source

units.lisp.

Function: time-as-angle (time-string)

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

Package

antik.

Source

angle.lisp.

Function: time-interval-timeparse (timeparse)

Convert the timeparse to a time interval.

Package

antik.

Source

time-interval.lisp.

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

antik.

Source

relative-time.lisp.

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

antik.

Source

time-interval.lisp.

Function: timeparse-day (timeparse)
Package

antik.

Source

dtspec.lisp.

Function: (setf timeparse-day) (timeparse)
Package

antik.

Source

dtspec.lisp.

Function: timeparse-hour (timeparse)
Package

antik.

Source

dtspec.lisp.

Function: timeparse-minute (timeparse)
Package

antik.

Source

dtspec.lisp.

Function: timeparse-month (timeparse)
Package

antik.

Source

dtspec.lisp.

Function: (setf timeparse-month) (timeparse)
Package

antik.

Source

dtspec.lisp.

Function: timeparse-second (timeparse)
Package

antik.

Source

dtspec.lisp.

Function: timeparse-time-interval (time &optional fractional-seconds-digits)

Convert the time interval to a timeparse.

Package

antik.

Source

time-interval.lisp.

Function: timeparse-year (timeparse)
Package

antik.

Source

dtspec.lisp.

Function: timepoint-j2000sec (tp)

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

Package

antik.

Source

dtmath.lisp.

Function: to-yyddd (datime)

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

Package

antik.

Source

formats.lisp.

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

grid.

Source

compose.lisp.

Function: transpose (affi &optional indices)

Transpose any pair of indices.

Package

affi.

Source

transformers.lisp.

Function: transpose-list (lists)
Package

antik.

Source

utility.lisp.

Function: vector-angle (a b)

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

Package

antik.

Source

cartesian.lisp.

Function: write-data (list &optional stream)

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

Package

antik.

Source

write.lisp.

Function: write-dms (angle &optional stream first-sep second-sep final)
Package

antik.

Source

angle.lisp.

Function: write-us-date (datime)

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

Package

antik.

Source

read-time.lisp.


6.1.8 Generic functions

Generic Function: abs (num)

The absolute value.

Package

antik.

Source

generic.lisp.

Methods
Method: abs ((x physical-quantity))
Source

arithmetic.lisp.

Method: abs (x)
Source

mathematics.lisp.

Method: abs ((num number))
Method: abs ((seq sequence))
Generic Function: acos (arg)

The arccosine of the generalized or regular number.

Package

antik.

Source

generic.lisp.

Methods
Method: acos ((x physical-quantity))
Source

arithmetic.lisp.

Method: acos (x)
Source

mathematics.lisp.

Method: acos ((arg number))
Generic Function: aref (grid &rest indices)

Select the element from the grid.

Package

grid.

Source

functions.lisp.

Methods
Method: aref ((object physical-quantity) &rest indices)
Source

grid.lisp.

Method: aref ((object matrix-unsigned-byte-64) &rest indices)
Source

methods.lisp.

Method: aref ((object matrix-signed-byte-64) &rest indices)
Source

methods.lisp.

Method: aref ((object matrix-unsigned-byte-32) &rest indices)
Source

methods.lisp.

Method: aref ((object matrix-signed-byte-32) &rest indices)
Source

methods.lisp.

Method: aref ((object matrix-unsigned-byte-16) &rest indices)
Source

methods.lisp.

Method: aref ((object matrix-signed-byte-16) &rest indices)
Source

methods.lisp.

Method: aref ((object matrix-unsigned-byte-8) &rest indices)
Source

methods.lisp.

Method: aref ((object matrix-signed-byte-8) &rest indices)
Source

methods.lisp.

Method: aref ((object matrix-complex-double-float) &rest indices)
Source

methods.lisp.

Method: aref ((object matrix-complex-single-float) &rest indices)
Source

methods.lisp.

Method: aref ((object matrix-double-float) &rest indices)
Source

methods.lisp.

Method: aref ((object matrix-single-float) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-unsigned-byte-64) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-signed-byte-64) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-unsigned-byte-32) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-signed-byte-32) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-unsigned-byte-16) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-signed-byte-16) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-unsigned-byte-8) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-signed-byte-8) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-complex-double-float) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-complex-single-float) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-double-float) &rest indices)
Source

methods.lisp.

Method: aref ((object vector-single-float) &rest indices)
Source

methods.lisp.

Method: aref ((object foreign-array) &rest indices)
Source

methods.lisp.

Method: aref ((grid array) &rest indices)
Source

array.lisp.

Generic Function: (setf aref) (grid &rest indices)

Set the element from the grid.

Package

grid.

Source

functions.lisp.

Methods
Method: (setf aref) ((object physical-quantity) &rest indices)
Source

grid.lisp.

Method: (setf aref) ((object matrix-unsigned-byte-64) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object matrix-signed-byte-64) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object matrix-unsigned-byte-32) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object matrix-signed-byte-32) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object matrix-unsigned-byte-16) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object matrix-signed-byte-16) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object matrix-unsigned-byte-8) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object matrix-signed-byte-8) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object matrix-complex-double-float) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object matrix-complex-single-float) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object matrix-double-float) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object matrix-single-float) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-unsigned-byte-64) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-signed-byte-64) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-unsigned-byte-32) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-signed-byte-32) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-unsigned-byte-16) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-signed-byte-16) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-unsigned-byte-8) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-signed-byte-8) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-complex-double-float) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-complex-single-float) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-double-float) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object vector-single-float) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((object foreign-array) &rest indices)
Source

methods.lisp.

Method: (setf aref) ((grid array) &rest indices)
Source

array.lisp.

Generic Function: aref* (grid linearized-index)

Select the element from the grid using a linearized index.

Package

grid.

Source

functions.lisp.

Methods
Method: aref* ((object physical-quantity) index)
Source

grid.lisp.

Method: aref* ((object matrix-unsigned-byte-64) linearized-index)
Source

methods.lisp.

Method: aref* ((object matrix-signed-byte-64) linearized-index)
Source

methods.lisp.

Method: aref* ((object matrix-unsigned-byte-32) linearized-index)
Source

methods.lisp.

Method: aref* ((object matrix-signed-byte-32) linearized-index)
Source

methods.lisp.

Method: aref* ((object matrix-unsigned-byte-16) linearized-index)
Source

methods.lisp.

Method: aref* ((object matrix-signed-byte-16) linearized-index)
Source

methods.lisp.

Method: aref* ((object matrix-unsigned-byte-8) linearized-index)
Source

methods.lisp.

Method: aref* ((object matrix-signed-byte-8) linearized-index)
Source

methods.lisp.

Method: aref* ((object matrix-complex-double-float) linearized-index)
Source

methods.lisp.

Method: aref* ((object matrix-complex-single-float) linearized-index)
Source

methods.lisp.

Method: aref* ((object matrix-double-float) linearized-index)
Source

methods.lisp.

Method: aref* ((object matrix-single-float) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-unsigned-byte-64) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-signed-byte-64) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-unsigned-byte-32) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-signed-byte-32) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-unsigned-byte-16) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-signed-byte-16) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-unsigned-byte-8) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-signed-byte-8) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-complex-double-float) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-complex-single-float) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-double-float) linearized-index)
Source

methods.lisp.

Method: aref* ((object vector-single-float) linearized-index)
Source

methods.lisp.

Method: aref* ((object foreign-array) linearized-index)
Source

methods.lisp.

Method: aref* ((grid array) linearized-index)
Source

array.lisp.

Method: aref* :before (grid linearized-index)
Generic Function: (setf aref*) (grid linearized-index)

Set the element from the grid using a linearized index.

Package

grid.

Source

functions.lisp.

Methods
Method: (setf aref*) ((object physical-quantity) index)
Source

grid.lisp.

Method: (setf aref*) ((object matrix-unsigned-byte-64) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object matrix-signed-byte-64) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object matrix-unsigned-byte-32) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object matrix-signed-byte-32) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object matrix-unsigned-byte-16) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object matrix-signed-byte-16) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object matrix-unsigned-byte-8) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object matrix-signed-byte-8) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object matrix-complex-double-float) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object matrix-complex-single-float) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object matrix-double-float) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object matrix-single-float) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-unsigned-byte-64) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-signed-byte-64) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-unsigned-byte-32) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-signed-byte-32) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-unsigned-byte-16) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-signed-byte-16) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-unsigned-byte-8) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-signed-byte-8) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-complex-double-float) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-complex-single-float) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-double-float) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object vector-single-float) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((object foreign-array) linearized-index)
Source

methods.lisp.

Method: (setf aref*) ((grid array) linearized-index)
Source

array.lisp.

Method: (setf aref*) :before (grid linearized-index)
Generic Function: asin (arg)

The arcsine of the generalized or regular number.

Package

antik.

Source

generic.lisp.

Methods
Method: asin ((x physical-quantity))
Source

arithmetic.lisp.

Method: asin (x)
Source

mathematics.lisp.

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

antik.

Source

generic.lisp.

Methods
Method: atan :around ((num number) &optional den default zero-enough)
Source

arithmetic.lisp.

Method: atan ((num physical-quantity) &optional den default zero-enough)
Source

arithmetic.lisp.

Method: atan (num &optional den default zero-enough)
Source

mathematics.lisp.

Method: atan ((num number) &optional den default zero-enough)
Generic Reader: cl-array (object)
Package

grid.

Methods
Reader Method: cl-array ((foreign-array foreign-array))

automatically generated reader method

Source

foreign-array.lisp.

Target Slot

cl-array.

Generic Function: coerce (number like)

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

Package

antik.

Source

generic.lisp.

Methods
Method: coerce ((num number) (pq physical-quantity))
Source

arithmetic.lisp.

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

grid.

Source

copy.lisp.

Methods
Method: copy ((object foreign-array) &rest args &key specification grid-type dimensions element-type destination)
Source

methods.lisp.

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

antik.

Source

generic.lisp.

Methods
Method: cos ((x physical-quantity))
Source

arithmetic.lisp.

Method: cos (x)
Source

mathematics.lisp.

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

antik.

Source

generic.lisp.

Methods
Method: cosh ((x physical-quantity))
Source

arithmetic.lisp.

Method: cosh (x)
Source

mathematics.lisp.

Method: cosh ((num rational))
Method: cosh ((num number))
Method: cosh ((x sequence))
Generic Function: creation-form (object)

A form that creates the object.

Package

antik.

Source

object.lisp.

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

physical-quantities.lisp.

Method: creation-form ((tp timepoint))
Source

timepoint.lisp.

Method: creation-form ((dt dtspec))
Source

dtspec.lisp.

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 Reader: day-only (object)
Package

antik.

Methods
Reader Method: day-only ((dtspec dtspec))

automatically generated reader method

Source

dtspec.lisp.

Target Slot

day-only.

Generic Function: defined-attributes (state)

List the attributes defined for this state.

Package

antik.

Source

state.lisp.

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

grid.

Source

functions.lisp.

Methods
Method: dimensions ((object physical-quantity))
Source

grid.lisp.

Reader Method: dimensions ((foreign-array foreign-array))

automatically generated reader method

Source

foreign-array.lisp.

Target Slot

dimensions.

Method: dimensions ((grid array))
Source

array.lisp.

Method: dimensions ((object list))
Generic Function: element-type (grid)

The element type of the grid.

Package

grid.

Source

functions.lisp.

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

grid.lisp.

Reader Method: element-type ((foreign-array foreign-array))

automatically generated reader method

Source

foreign-array.lisp.

Target Slot

element-type.

Method: element-type ((grid array))
Source

array.lisp.

Method: element-type ((grid list))
Generic Function: exp (num)

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

Package

antik.

Source

generic.lisp.

Methods
Method: exp (x)
Source

mathematics.lisp.

Method: exp ((num rational))
Method: exp ((num number))
Method: exp ((x sequence))
Generic Function: expt (num exponent)

Raise the number to the exponent.

Package

antik.

Source

generic.lisp.

Methods
Method: expt ((a matrix) (b integer))
Source

linear-algebra.lisp.

Method: expt ((x physical-quantity) expon)
Source

arithmetic.lisp.

Method: expt (a (b number))
Source

mathematics.lisp.

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

antik.

Source

arithmetic.lisp.

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

antik.

Source

generic.lisp.

Methods
Method: floor ((x physical-quantity) &optional y)
Source

arithmetic.lisp.

Method: floor ((number number) &optional divisor)
Generic Reader: foreign-pointer (object)
Package

grid.

Methods
Reader Method: foreign-pointer ((foreign-array foreign-array))

automatically generated reader method

Source

foreign-array.lisp.

Target Slot

foreign-pointer.

Generic Function: inner (grid0 grid1)

The inner product of two grids.

Package

grid.

Source

norm-vector-product.lisp.

Methods
Method: inner (grid0 grid1)
Generic Reader: iso8601 (object)
Package

antik.

Methods
Reader Method: iso8601 ((dtspec dtspec))

automatically generated reader method

Source

dtspec.lisp.

Target Slot

iso8601.

Generic Function: log (num &optional base)

The natural logarithm of the generalized or regular number.

Package

antik.

Source

generic.lisp.

Methods
Method: log (a &optional base)
Source

mathematics.lisp.

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

affi.

Source

affi.lisp.

Methods
Method: make-affi ((dimensions sequence) &optional offset)

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

Generic Function: minusp (a)

Negative

Package

antik.

Source

generic.lisp.

Methods
Method: minusp ((x physical-quantity))
Source

arithmetic.lisp.

Method: minusp ((a number))
Method: minusp (a)
Generic Function: nf (object &optional stream)

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

Package

antik.

Source

format-output.lisp.

Methods
Method: nf ((pq physical-quantity) &optional stream)
Source

physical-quantities.lisp.

Method: nf ((object foreign-array) &optional stream)
Source

format-output.lisp.

Method: nf ((object sequence) &optional stream)
Source

format-output.lisp.

Method: nf ((object array) &optional stream)
Source

format-output.lisp.

Method: nf ((object timepoint) &optional stream)
Source

timepoint.lisp.

Method: nf ((object dtspec) &optional stream)
Source

dtspec.lisp.

Method: nf ((object float) &optional stream)

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

Source

float.lisp.

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

antik.

Source

angle-component.lisp.

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

grid.

Source

norm-vector-product.lisp.

Methods
Method: outer (grid0 grid1)
Generic Function: plusp (a)

Positive.

Package

antik.

Source

generic.lisp.

Methods
Method: plusp ((x physical-quantity))
Source

arithmetic.lisp.

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

antik.

Source

physical-quantities.lisp.

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

grid.

Source

functions.lisp.

Methods
Method: rank ((object physical-quantity))
Source

grid.lisp.

Method: rank ((object foreign-array))
Source

methods.lisp.

Method: rank ((grid array))
Source

array.lisp.

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

antik.

Source

one-dim.lisp.

Methods
Method: root-1d (function (initial physical-quantity) derivative &optional absolute-error relative-error method)
Source

one-dim-pq.lisp.

Method: root-1d (function initial derivative &optional absolute-error relative-error method)
Method: root-1d (function lower (upper number) &optional absolute-error relative-error method)
Generic Function: round (number &optional divisor)

Nearest multiple of divisor to number.

Package

antik.

Source

generic.lisp.

Methods
Method: round ((number number) &optional divisor)
Generic Function: show-state (state)

Show the physical state attributes.

Package

antik.

Source

state.lisp.

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

Signum(a).

Package

antik.

Source

generic.lisp.

Methods
Method: signum ((a number))
Method: signum (a)
Generic Function: sin (num)

The sine of the generalized or regular number.

Package

antik.

Source

generic.lisp.

Methods
Method: sin ((x physical-quantity))
Source

arithmetic.lisp.

Method: sin (x)
Source

mathematics.lisp.

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

antik.

Source

generic.lisp.

Methods
Method: sinh ((x physical-quantity))
Source

arithmetic.lisp.

Method: sinh (x)
Source

mathematics.lisp.

Method: sinh ((num rational))
Method: sinh ((num number))
Method: sinh ((x sequence))
Generic Function: specification (grid)

The grid specification.

Package

grid.

Source

functions.lisp.

Methods
Method: specification ((object physical-quantity))
Source

grid.lisp.

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

antik.

Source

state.lisp.

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

antik.

Source

generic.lisp.

Methods
Method: tan ((x physical-quantity))
Source

arithmetic.lisp.

Method: tan (x)
Source

mathematics.lisp.

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

antik.

Source

generic.lisp.

Methods
Method: tanh ((x physical-quantity))
Source

arithmetic.lisp.

Method: tanh (x)
Source

mathematics.lisp.

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

affi.

Source

affi.lisp.

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 Reader: timeparse (object)
Package

antik.

Methods
Reader Method: timeparse ((dtspec dtspec))

automatically generated reader method

Source

dtspec.lisp.

Target Slot

timeparse.

Generic Function: total-size (grid)
Package

grid.

Source

functions.lisp.

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

grid.lisp.

Reader Method: total-size ((foreign-array foreign-array))

automatically generated reader method

Source

foreign-array.lisp.

Target Slot

total-size.

Method: total-size (grid)
Generic Function: zerop (a)

Zero.

Package

antik.

Source

generic.lisp.

Methods
Method: zerop ((x physical-quantity))
Source

arithmetic.lisp.

Method: zerop ((grid foreign-array))
Source

methods.lisp.

Method: zerop ((grid array))
Source

functions.lisp.

Method: zerop ((a number))
Method: zerop ((x sequence))
Method: zerop (a)

6.1.9 Standalone methods

Method: initialize-instance :after ((object foreign-array) &key dimensions element-type foreign-pointer finalizer linearization initial-element initial-contents)
Source

foreign-array.lisp.

Method: initialize-instance :after ((affi affi) &key)
Source

affi.lisp.

Method: make-load-form ((object physical-quantity) &optional env)
Source

physical-quantities.lisp.

Method: make-load-form ((object timepoint) &optional env)
Source

timepoint.lisp.

Method: make-load-form ((object foreign-array) &optional env)
Source

foreign-array.lisp.

Method: norm-equal ((data1 foreign-array) (data2 foreign-array) &optional epsilon measure)
Package

lisp-unit.

Source

lisp-unit-extension.lisp.

Method: numerical-equal ((result1 number) (result2 physical-quantity) &rest keys &key test)
Package

lisp-unit.

Source

physical-quantities.lisp.

Method: numerical-equal ((result1 physical-quantity) (result2 number) &rest keys &key test)
Package

lisp-unit.

Source

physical-quantities.lisp.

Method: numerical-equal ((result1 physical-quantity) (result2 physical-quantity) &rest keys &key test)
Package

lisp-unit.

Source

physical-quantities.lisp.

Method: print-object ((pq physical-quantity) stream)

Print the physical-quantity using nf.

Source

physical-quantities.lisp.

Method: print-object ((object dtspec) stream)
Source

dtspec.lisp.

Method: print-object ((object timepoint) stream)
Source

timepoint.lisp.

Method: print-object :around ((object foreign-array) stream)
Source

format-output.lisp.

Method: print-object ((object foreign-array) stream)
Source

foreign-array.lisp.

Method: print-object ((obj affi) stream)
Source

affi.lisp.

Method: translate-from-foreign (p (type complex-float-type))
Package

cffi.

Source

complex-types.lisp.

Method: translate-from-foreign (p (type complex-double-type))
Package

cffi.

Source

complex-types.lisp.

Method: translate-into-foreign-memory ((value complex) (type complex-float-type) p)
Package

cffi.

Source

complex-types.lisp.

Method: translate-into-foreign-memory ((value complex) (type complex-double-type) p)
Package

cffi.

Source

complex-types.lisp.


6.1.10 Conditions

Condition: array-mismatch

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

Package

grid.

Source

copy.lisp.

Direct superclasses

error.

Condition: coerce-nil

Signalled when coercing something to nil.

Package

antik.

Source

conditions.lisp.

Direct superclasses

arithmetic-error.

Direct methods

coerce-object.

Direct slots
Slot: object
Initargs

:object

Readers

coerce-object.

Writers

This slot is read-only.

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

antik.

Source

conditions.lisp.

Direct superclasses

arithmetic-error.

Direct methods
Direct slots
Slot: object
Initargs

:object

Readers

coerce-object.

Writers

This slot is read-only.

Slot: to
Initargs

:to

Readers

coerce-to.

Writers

This slot is read-only.

Condition: making-complex-number

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

Package

antik.

Source

conditions.lisp.

Direct superclasses

arithmetic-error.

Direct methods
Direct slots
Slot: operation
Initargs

:operation

Readers

mcn-operation.

Writers

This slot is read-only.

Slot: number
Package

common-lisp.

Initargs

:number

Readers

mcn-number.

Writers

This slot is read-only.


6.1.11 Classes

Class: affi
Package

affi.

Source

affi.lisp.

Direct methods
Direct slots
Slot: const
Initargs

:const

Slot: coeff
Initargs

:coeff

Slot: domain
Initargs

:domain

Readers

domain.

Writers

This slot is read-only.

Class: dtspec

Specification of date and time, without an assigned scale.

Package

antik.

Source

dtspec.lisp.

Direct subclasses

timepoint.

Direct methods
Direct slots
Slot: iso8601
Initargs

:iso8601

Readers

iso8601.

Writers

This slot is read-only.

Slot: timeparse
Initargs

:timeparse

Readers

timeparse.

Writers

This slot is read-only.

Slot: day-only
Initargs

:day-only

Readers

day-only.

Writers

This slot is read-only.

Class: foreign-array

Arrays that can be referenced by foreign functions.

Package

grid.

Source

foreign-array.lisp.

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

:foreign-pointer

Readers

foreign-pointer.

Writers

This slot is read-only.

Slot: dimensions
Initargs

:dimensions

Readers

dimensions.

Writers

This slot is read-only.

Slot: total-size
Readers

total-size.

Writers

This slot is read-only.

Slot: element-type
Initform

grid:*default-element-type*

Initargs

:element-type

Readers

element-type.

Writers

This slot is read-only.

Slot: affi
Readers

affi.

Writers

This slot is read-only.

Slot: cl-array
Readers

cl-array.

Writers

This slot is read-only.

Slot: foreign-metadata
Initargs

:foreign-metadata

Readers

foreign-metadata.

Writers

This slot is read-only.

Class: matrix

Foreign matrices.

Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

foreign-array.

Direct subclasses
Direct methods

expt.

Class: matrix-complex-double-float
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

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

:class

Initform

(quote (complex double-float))

Class: matrix-complex-single-float
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

Direct methods
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • (setf column).
  • column.
  • conjugate-rank-1-update.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • hermitian-rank-1-update.
  • hermitian-rank-1-update.
  • hermitian-rank-2-update.
  • hermitian-rank-2-update.
  • inverse-matrix-product.
  • inverse-matrix-product.
  • matrix-product.
  • matrix-product.
  • matrix-product-hermitian.
  • matrix-product-hermitian.
  • matrix-product-symmetric.
  • matrix-product-triangular.
  • matrix-product-triangular.
  • matrix-transpose.
  • matrix-transpose*.
  • mminusp.
  • mplusp.
  • mzerop.
  • non-negative-p.
  • rank-1-update.
  • (setf row).
  • row.
  • set-all.
  • set-identity.
  • set-zero.
  • swap.
  • swap-columns.
  • swap-row-column.
  • swap-rows.
  • symmetric-rank-1-update.
  • symmetric-rank-2-update.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (complex single-float))

Class: matrix-double-float
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

Direct methods
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • cholesky-decomposition.
  • cholesky-solve.
  • (setf column).
  • column.
  • eigenvalues.
  • eigenvalues-eigenvectors.
  • eigenvalues-eigenvectors-gensymm.
  • eigenvalues-gensymm.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • inverse-matrix-product.
  • inverse-matrix-product.
  • lu-decomposition.
  • lu-determinant.
  • lu-invert.
  • lu-log-determinant.
  • lu-refine.
  • lu-sgndet.
  • lu-solve.
  • matrix-product.
  • matrix-product.
  • matrix-product-symmetric.
  • matrix-product-symmetric.
  • matrix-product-triangular.
  • matrix-product-triangular.
  • matrix-transpose.
  • matrix-transpose*.
  • max-index.
  • mean.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • rank-1-update.
  • (setf row).
  • row.
  • set-all.
  • set-identity.
  • set-zero.
  • sort-eigenvalues-eigenvectors.
  • sort-largest.
  • sort-smallest.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-columns.
  • swap-row-column.
  • swap-rows.
  • symmetric-rank-1-update.
  • symmetric-rank-1-update.
  • symmetric-rank-2-update.
  • symmetric-rank-2-update.
  • tridiagonal-decomposition.
  • tridiagonal-unpack.
  • tridiagonal-unpack-t.
  • variance.
  • variance-with-fixed-mean.
  • weighted-mean.
  • weighted-standard-deviation.
  • weighted-standard-deviation-with-fixed-mean.
  • weighted-variance.
  • weighted-variance-with-fixed-mean.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote double-float)

Class: matrix-signed-byte-16
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

Direct methods
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • (setf column).
  • column.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • matrix-transpose.
  • matrix-transpose*.
  • max-index.
  • mean.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • (setf row).
  • row.
  • set-all.
  • set-identity.
  • set-zero.
  • sort-largest.
  • sort-smallest.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-columns.
  • swap-row-column.
  • swap-rows.
  • variance.
  • variance-with-fixed-mean.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (signed-byte 16))

Class: matrix-signed-byte-32
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

Direct methods
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • (setf column).
  • column.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • matrix-transpose.
  • matrix-transpose*.
  • max-index.
  • mean.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • (setf row).
  • row.
  • set-all.
  • set-identity.
  • set-zero.
  • sort-largest.
  • sort-smallest.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-columns.
  • swap-row-column.
  • swap-rows.
  • variance.
  • variance-with-fixed-mean.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (signed-byte 32))

Class: matrix-signed-byte-64
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

Direct methods
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • (setf column).
  • column.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • matrix-transpose.
  • matrix-transpose*.
  • max-index.
  • mean.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • (setf row).
  • row.
  • set-all.
  • set-identity.
  • set-zero.
  • sort-largest.
  • sort-smallest.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-columns.
  • swap-row-column.
  • swap-rows.
  • variance.
  • variance-with-fixed-mean.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (signed-byte 64))

Class: matrix-signed-byte-8
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

Direct methods
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • (setf column).
  • column.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • matrix-transpose.
  • matrix-transpose*.
  • max-index.
  • mean.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • (setf row).
  • row.
  • set-all.
  • set-identity.
  • set-zero.
  • sort-largest.
  • sort-smallest.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-columns.
  • swap-row-column.
  • swap-rows.
  • variance.
  • variance-with-fixed-mean.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (signed-byte 8))

Class: matrix-single-float
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

Direct methods
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • (setf column).
  • column.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • inverse-matrix-product.
  • inverse-matrix-product.
  • matrix-product.
  • matrix-product.
  • matrix-product-symmetric.
  • matrix-product-symmetric.
  • matrix-product-triangular.
  • matrix-product-triangular.
  • matrix-transpose.
  • matrix-transpose*.
  • max-index.
  • mean.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • rank-1-update.
  • (setf row).
  • row.
  • set-all.
  • set-identity.
  • set-zero.
  • sort-largest.
  • sort-smallest.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-columns.
  • swap-row-column.
  • swap-rows.
  • symmetric-rank-1-update.
  • symmetric-rank-1-update.
  • symmetric-rank-2-update.
  • symmetric-rank-2-update.
  • variance.
  • variance-with-fixed-mean.
  • weighted-mean.
  • weighted-standard-deviation.
  • weighted-standard-deviation-with-fixed-mean.
  • weighted-variance.
  • weighted-variance-with-fixed-mean.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote single-float)

Class: matrix-unsigned-byte-16
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

Direct methods
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • (setf column).
  • column.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • matrix-transpose.
  • matrix-transpose*.
  • max-index.
  • mean.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • (setf row).
  • row.
  • set-all.
  • set-identity.
  • set-zero.
  • sort-largest.
  • sort-smallest.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-columns.
  • swap-row-column.
  • swap-rows.
  • variance.
  • variance-with-fixed-mean.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (unsigned-byte 16))

Class: matrix-unsigned-byte-32
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

Direct methods
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • (setf column).
  • column.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • matrix-transpose.
  • matrix-transpose*.
  • max-index.
  • mean.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • (setf row).
  • row.
  • set-all.
  • set-identity.
  • set-zero.
  • sort-largest.
  • sort-smallest.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-columns.
  • swap-row-column.
  • swap-rows.
  • variance.
  • variance-with-fixed-mean.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (unsigned-byte 32))

Class: matrix-unsigned-byte-64
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

Direct methods
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • (setf column).
  • column.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • matrix-transpose.
  • matrix-transpose*.
  • max-index.
  • mean.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • (setf row).
  • row.
  • set-all.
  • set-identity.
  • set-zero.
  • sort-largest.
  • sort-smallest.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-columns.
  • swap-row-column.
  • swap-rows.
  • variance.
  • variance-with-fixed-mean.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (unsigned-byte 64))

Class: matrix-unsigned-byte-8
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

matrix.

Direct methods
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • (setf column).
  • column.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • matrix-transpose.
  • matrix-transpose*.
  • max-index.
  • mean.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • (setf row).
  • row.
  • set-all.
  • set-identity.
  • set-zero.
  • sort-largest.
  • sort-smallest.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-columns.
  • swap-row-column.
  • swap-rows.
  • variance.
  • variance-with-fixed-mean.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (unsigned-byte 8))

Class: mvector

Foreign vectors.

Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

foreign-array.

Direct subclasses
Class: physical-quantity

A quantity with a dimension and possibly a unit, e.g. length or meter.

Package

antik.

Source

scalar.lisp.

Direct methods
Direct slots
Slot: magnitude
Initargs

:magnitude

Readers

pq-magnitude.

Writers

This slot is read-only.

Slot: dimension
Type

(or (satisfies antik::dimelp) array)

Initargs

:dimension

Readers

pq-dimension.

Writers

This slot is read-only.

Slot: scalar-dimension
Initargs

:scalar-dimension

Readers

scalar-dimension.

Writers

This slot is read-only.

Class: timepoint

Specification of a point in time, including a scale.

Package

antik.

Source

timepoint.lisp.

Direct superclasses

dtspec.

Direct methods
Direct slots
Slot: scale
Initargs

:scale

Readers

scale.

Writers

This slot is read-only.

Class: vector-complex-double-float
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

mvector.

Direct methods
  • absolute-sum.
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • axpy.
  • backward-discrete-fourier-transform.
  • backward-fourier-transform-dif-radix2.
  • backward-fourier-transform-nonradix2.
  • backward-fourier-transform-radix2.
  • blas-copy.
  • blas-swap.
  • cdot.
  • cholesky-solve.
  • (setf column).
  • conjugate-rank-1-update.
  • discrete-fourier-transform.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • euclidean-norm.
  • evaluate.
  • forward-discrete-fourier-transform.
  • forward-fourier-transform-dif-radix2.
  • forward-fourier-transform-nonradix2.
  • forward-fourier-transform-radix2.
  • fourier-transform-dif-radix2.
  • fourier-transform-radix2.
  • hermitian-rank-1-update.
  • hermitian-rank-2-update.
  • index-max.
  • inner.
  • inverse-discrete-fourier-transform.
  • inverse-fourier-transform-dif-radix2.
  • inverse-fourier-transform-nonradix2.
  • inverse-fourier-transform-radix2.
  • inverse-matrix-product.
  • lu-refine.
  • lu-solve.
  • matrix-product.
  • matrix-product-hermitian.
  • matrix-product-triangular.
  • mminusp.
  • mplusp.
  • mzerop.
  • non-negative-p.
  • permute.
  • permute-inverse.
  • rank-1-update.
  • (setf row).
  • scale.
  • scale.
  • set-all.
  • set-basis.
  • set-zero.
  • sort-eigenvalues-eigenvectors.
  • swap.
  • swap-elements.
  • vector-reverse.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (complex double-float))

Class: vector-complex-single-float
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

mvector.

Direct methods
  • absolute-sum.
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • axpy.
  • backward-discrete-fourier-transform.
  • backward-fourier-transform-dif-radix2.
  • backward-fourier-transform-nonradix2.
  • backward-fourier-transform-radix2.
  • blas-copy.
  • blas-swap.
  • cdot.
  • (setf column).
  • conjugate-rank-1-update.
  • discrete-fourier-transform.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • euclidean-norm.
  • forward-discrete-fourier-transform.
  • forward-fourier-transform-dif-radix2.
  • forward-fourier-transform-nonradix2.
  • forward-fourier-transform-radix2.
  • fourier-transform-dif-radix2.
  • fourier-transform-radix2.
  • hermitian-rank-1-update.
  • hermitian-rank-2-update.
  • index-max.
  • inner.
  • inverse-discrete-fourier-transform.
  • inverse-fourier-transform-dif-radix2.
  • inverse-fourier-transform-nonradix2.
  • inverse-fourier-transform-radix2.
  • inverse-matrix-product.
  • matrix-product.
  • matrix-product-hermitian.
  • matrix-product-triangular.
  • mminusp.
  • mplusp.
  • mzerop.
  • non-negative-p.
  • permute.
  • permute-inverse.
  • rank-1-update.
  • (setf row).
  • scale.
  • scale.
  • set-all.
  • set-basis.
  • set-zero.
  • swap.
  • swap-elements.
  • vector-reverse.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (complex single-float))

Class: vector-double-float
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

mvector.

Direct methods
  • absolute-deviation.
  • absolute-sum.
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • autocorrelation.
  • axpy.
  • backward-fourier-transform-halfcomplex-nonradix2.
  • backward-fourier-transform-halfcomplex-radix2.
  • blas-copy.
  • blas-swap.
  • cholesky-solve.
  • (setf column).
  • correlation.
  • covariance.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • euclidean-norm.
  • evaluate.
  • evaluate.
  • fft-half-complex-radix2-unpack.
  • fft-half-complex-unpack.
  • fft-real-unpack.
  • forward-fourier-transform-halfcomplex-nonradix2.
  • forward-fourier-transform-halfcomplex-radix2.
  • forward-fourier-transform-nonradix2.
  • forward-fourier-transform-radix2.
  • givens-rotation.
  • givens-rotation-m.
  • index-max.
  • inner.
  • inverse-fourier-transform-halfcomplex-nonradix2.
  • inverse-fourier-transform-halfcomplex-radix2.
  • inverse-matrix-product.
  • kurtosis.
  • lu-refine.
  • lu-solve.
  • matrix-product.
  • matrix-product-symmetric.
  • matrix-product-triangular.
  • max-index.
  • mean.
  • median.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • modified-givens-rotation.
  • modified-givens-rotation-m.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • permute.
  • permute-inverse.
  • quantile.
  • rank-1-update.
  • (setf row).
  • scale.
  • set-all.
  • set-basis.
  • set-zero.
  • skewness.
  • sort-eigenvalues-eigenvectors.
  • sort-index.
  • sort-largest.
  • sort-largest-index.
  • sort-smallest.
  • sort-smallest-index.
  • sort-vector.
  • sort-vector-index.
  • sort-vector-largest.
  • sort-vector-largest-index.
  • sort-vector-smallest.
  • sort-vector-smallest-index.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-elements.
  • symmetric-rank-1-update.
  • symmetric-rank-2-update.
  • variance.
  • variance-with-fixed-mean.
  • vector-reverse.
  • weighted-absolute-deviation.
  • weighted-kurtosis.
  • weighted-mean.
  • weighted-skewness.
  • weighted-standard-deviation.
  • weighted-standard-deviation-with-fixed-mean.
  • weighted-variance.
  • weighted-variance-with-fixed-mean.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote double-float)

Class: vector-signed-byte-16
Package

grid.

Source

vector-matrix.lisp.

Direct superclasses

mvector.

Direct methods
  • absolute-deviation.
  • alloc-from-block.
  • (setf aref).
  • aref.
  • (setf aref*).
  • aref*.
  • autocorrelation.
  • (setf column).
  • correlation.
  • covariance.
  • elt*.
  • elt*.
  • elt+.
  • elt+.
  • elt-.
  • elt/.
  • kurtosis.
  • max-index.
  • mean.
  • median.
  • min-index.
  • minmax.
  • minmax-index.
  • mmax.
  • mmin.
  • mminusp.
  • mplusp.
  • msort.
  • mzerop.
  • non-negative-p.
  • permute.
  • permute-inverse.
  • quantile.
  • (setf row).
  • set-all.
  • set-basis.
  • set-zero.
  • skewness.
  • sort-index.
  • sort-largest.
  • sort-largest-index.
  • sort-smallest.
  • sort-smallest-index.
  • sort-vector.
  • sort-vector-index.
  • sort-vector-largest.
  • sort-vector-largest-index.
  • sort-vector-smallest.
  • sort-vector-smallest-index.
  • standard-deviation.
  • standard-deviation-with-fixed-mean.
  • swap.
  • swap-elements.
  • variance.
  • variance-with-fixed-mean.
  • vector-reverse.
Direct slots
Slot: element-type
Allocation

:class

Initform

(quote (signed-byte 16))

Class: vector-signed-byte-32