This is the numericals Reference Manual, version 2023.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Mar 15 07:09:23 2023 GMT+0.
numericals/numericals.asdnumericals/package.lispnumericals/utils.lispnumericals/primitives.lispnumericals/broadcast.lispnumericals/transpose.lispnumericals/aref.lispnumericals/ptr-iterate-but-inner.lispnumericals/lparallel.lispnumericals/test.lispnumericals/translations.lispnumericals/copy-coerce.lispnumericals/one-arg-fn-float.lispnumericals/one-arg-fn-all.lispnumericals/one-arg-reduce-fn.lispnumericals/two-arg-fn-float.lispnumericals/two-arg-fn-comparison.lispnumericals/two-arg-fn-non-comparison.lispnumericals/in-place-operators.lispnumericals/n-arg-fn.lispnumericals/n-arg-fn-compiler-macros.lispnumericals/n-arg-fn-tests.lispnumericals/blas.lispThe main system appears first, followed by any subsystem dependency.
numericalsA high performance numerical computing library for Common Lisp (focus: basic math operations)
MIT
2023.2.0
numericals.common (system).
polymorphic-functions (system).
cl-form-types (system).
compiler-macro-notes (system).
ctype (system).
bmas (system).
magicl/ext-blas (system).
extensible-compound-types-cl (system)., for feature :extensible-compound-types
fiveam (system).
alexandria (system).
iterate (system).
cffi (system).
lparallel (system).
policy-cond (system).
specialized-function (system).
swank (system).
trivial-coerce (system).
trivial-types (system).
trivial-package-local-nicknames (system).
introspect-environment (system).
package.lisp (file).
utils.lisp (file).
primitives.lisp (file).
broadcast.lisp (file).
transpose.lisp (file).
aref.lisp (file).
ptr-iterate-but-inner.lisp (file).
lparallel.lisp (file).
test.lisp (file).
translations.lisp (file).
copy-coerce.lisp (file).
one-arg-fn-float.lisp (file).
one-arg-fn-all.lisp (file).
one-arg-reduce-fn.lisp (file).
two-arg-fn-float.lisp (file).
two-arg-fn-comparison.lisp (file).
two-arg-fn-non-comparison.lisp (file).
in-place-operators.lisp (file).
n-arg-fn.lisp (file).
n-arg-fn-compiler-macros.lisp (file).
n-arg-fn-tests.lisp (file).
blas.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
numericals/numericals.asdnumericals/package.lispnumericals/utils.lispnumericals/primitives.lispnumericals/broadcast.lispnumericals/transpose.lispnumericals/aref.lispnumericals/ptr-iterate-but-inner.lispnumericals/lparallel.lispnumericals/test.lispnumericals/translations.lispnumericals/copy-coerce.lispnumericals/one-arg-fn-float.lispnumericals/one-arg-fn-all.lispnumericals/one-arg-reduce-fn.lispnumericals/two-arg-fn-float.lispnumericals/two-arg-fn-comparison.lispnumericals/two-arg-fn-non-comparison.lispnumericals/in-place-operators.lispnumericals/n-arg-fn.lispnumericals/n-arg-fn-compiler-macros.lispnumericals/n-arg-fn-tests.lispnumericals/blas.lispnumericals/package.lispnumericals (system).
type-parameter-p (function).
numericals/utils.lisppackage.lisp (file).
numericals (system).
*broadcast-automatically* (special variable).
*default-float-format* (special variable).
array= (function).
array-layout (function).
array-storage (function).
array-stride (function).
array-type-element-type (function).
blas-trans (function).
ccall (macro).
cl-array-offset (function).
dimensions (function).
element-type (function).
int-index (type).
lm (macro).
max-type (function).
narray-dimensions (function).
runtime-array-allocation (condition).
size (type).
the-int-index (macro).
the-size (macro).
with-foreign-object (macro).
with-foreign-objects (macro).
with-pointers-to-vectors-data (macro).
numericals/primitives.lisputils.lisp (file).
numericals (system).
*array-element-type* (special variable).
*array-element-type-alist* (special variable).
*array-layout* (special variable).
do-arrays (macro).
empty (compiler macro).
empty (function).
empty-like (function).
full (function).
full-like (function).
macro-map-array (macro).
numericals-array-element-type (type).
ones (compiler macro).
ones (function).
ones-like (function).
rand (function).
rand-like (function).
reshape (function).
shape (function).
zeros (compiler macro).
zeros (function).
zeros-like (function).
default-element-type (symbol macro).
defun-c (macro).
ensure-appropriate-array (function).
ensure-row-major-layout (macro).
package-local-element-type (symbol macro).
split-at-keywords (function).
uint32 (type).
numericals/broadcast.lispprimitives.lisp (file).
utils.lisp (file).
numericals (system).
broadcast-array (function).
%broadcast-compatible-p (function).
broadcast-compatible-p (function).
condition-array-likes (reader method).
condition-dimensions (reader method).
do-with-broadcasting (macro).
incompatible-broadcast-dimensions (condition).
strides-for-broadcast (function).
numericals/transpose.lisppackage.lisp (file).
numericals (system).
transpose (function).
numericals/aref.lispprimitives.lisp (file).
utils.lisp (file).
numericals (system).
aref* (function).
aref-applicable-p (function).
fixnump (function).
int32 (type).
normalize-index (function).
strides (function).
numericals/ptr-iterate-but-inner.lisppackage.lisp (file).
numericals (system).
ptr-iterate-but-inner (macro).
numericals/lparallel.lisppackage.lisp (file).
numericals (system).
*inline-with-multithreading* (special variable).
*multithreaded-threshold* (special variable).
with-thresholded-multithreading (macro).
with-thresholded-multithreading/cl (macro).
numericals/test.lispprimitives.lisp (file).
broadcast.lisp (file).
aref.lisp (file).
numericals (system).
define-numericals-one-arg-test (macro).
define-numericals-one-arg-test/integers (macro).
define-numericals-two-arg-test (macro).
define-numericals-two-arg-test/integers (macro).
numericals/translations.lisppackage.lisp (file).
numericals (system).
*translation-table* (special variable).
+fixnum-shift-pointer+ (special variable).
c-name (compiler macro).
c-name (function).
c-size (compiler macro).
c-size (function).
c-type (compiler macro).
c-type (function).
cl-name (compiler macro).
cl-name (function).
double-float-c-name (compiler macro).
double-float-c-name (function).
fixnum-c-name (compiler macro).
fixnum-c-name (function).
fixnum-dot (function).
fixnum-hmax (function).
fixnum-hmin (function).
fixnum-mul (function).
fixnum-sum (function).
int16-c-name (compiler macro).
int16-c-name (function).
int32-c-name (compiler macro).
int32-c-name (function).
int64-c-name (compiler macro).
int64-c-name (function).
int8-c-name (compiler macro).
int8-c-name (function).
single-float-c-name (compiler macro).
single-float-c-name (function).
uint16-c-name (compiler macro).
uint16-c-name (function).
uint32-c-name (compiler macro).
uint32-c-name (function).
uint64-c-name (compiler macro).
uint64-c-name (function).
uint8-c-name (compiler macro).
uint8-c-name (function).
numericals/copy-coerce.lispprimitives.lisp (file).
ptr-iterate-but-inner.lisp (file).
lparallel.lisp (file).
numericals (system).
test-copy (function).
numericals/one-arg-fn-float.lispcopy-coerce.lisp (file).
test.lisp (file).
translations.lisp (file).
numericals (system).
+one-arg-fn-float-doc+ (constant).
numericals/one-arg-fn-all.lispcopy-coerce.lisp (file).
test.lisp (file).
translations.lisp (file).
numericals (system).
+one-arg-fn-all-doc+ (constant).
numericals/one-arg-reduce-fn.lisptranslations.lisp (file).
primitives.lisp (file).
numericals (system).
numericals/two-arg-fn-float.lispcopy-coerce.lisp (file).
test.lisp (file).
translations.lisp (file).
numericals (system).
numericals/two-arg-fn-comparison.lispcopy-coerce.lisp (file).
test.lisp (file).
translations.lisp (file).
numericals (system).
two-arg-/= (function).
two-arg-< (function).
two-arg-<= (function).
two-arg-= (function).
two-arg-> (function).
two-arg->= (function).
numericals/two-arg-fn-non-comparison.lispcopy-coerce.lisp (file).
test.lisp (file).
translations.lisp (file).
numericals (system).
numericals/in-place-operators.lispone-arg-fn-float.lisp (file).
two-arg-fn-float.lisp (file).
two-arg-fn-comparison.lisp (file).
two-arg-fn-non-comparison.lisp (file).
numericals (system).
numericals/n-arg-fn.lisptwo-arg-fn-comparison.lisp (file).
two-arg-fn-non-comparison.lisp (file).
numericals (system).
define-splice-list-fn (macro).
normalize-arguments/bitwise (function).
normalize-arguments/cmp (function).
normalize-arguments/dmas (function).
numericals/n-arg-fn-compiler-macros.lispn-arg-fn.lisp (file).
numericals (system).
arg-is-not-array (condition).
arg-out-type-mismatch (condition).
array-type-is-unoptimized (condition).
bad-position-for-out (condition).
condition-arg (reader method).
condition-arg (reader method).
condition-arg-type (reader method).
condition-arg-type (reader method).
condition-args (reader method).
condition-args (reader method).
condition-out (reader method).
condition-out-type (reader method).
condition-type (reader method).
out-unknown-at-compile-time (condition).
numericals/n-arg-fn-tests.lispn-arg-fn-compiler-macros.lisp (file).
numericals (system).
numericals/blas.lispprimitives.lisp (file).
ptr-iterate-but-inner.lisp (file).
numericals (system).
Packages are listed by definition order.
numericals* (compiler macro).
* (function).
*array-element-type* (special variable).
*array-element-type-alist* (special variable).
*array-layout* (special variable).
*broadcast-automatically* (special variable).
*default-float-format* (special variable).
*inline-with-multithreading* (special variable).
*multithreaded-threshold* (special variable).
+ (compiler macro).
+ (function).
+optimized-types+ (constant).
- (compiler macro).
- (function).
/ (compiler macro).
/ (function).
/= (function).
< (function).
<= (function).
= (function).
> (function).
>= (function).
abs (compiler macro).
abs! (compiler macro).
acos (compiler macro).
acos! (compiler macro).
acosh (compiler macro).
acosh! (compiler macro).
add (compiler macro).
add (function).
add! (compiler macro).
aref* (function).
array= (compiler macro).
array= (function).
asarray (compiler macro).
asin (compiler macro).
asin! (compiler macro).
asinh (compiler macro).
asinh! (compiler macro).
astype (compiler macro).
atan (compiler macro).
atanh (compiler macro).
atanh! (compiler macro).
broadcast-array (function).
copy (compiler macro).
cos (compiler macro).
cos! (compiler macro).
cosh (compiler macro).
cosh! (compiler macro).
divide (compiler macro).
divide (function).
divide! (compiler macro).
do-arrays (macro).
empty (compiler macro).
empty (function).
empty-like (function).
exp (compiler macro).
exp! (compiler macro).
expt (compiler macro).
expt! (compiler macro).
fceiling (compiler macro).
fceiling (function).
fceiling! (compiler macro).
ffloor (compiler macro).
ffloor (function).
ffloor! (compiler macro).
fround (compiler macro).
fround (function).
fround! (compiler macro).
ftruncate (compiler macro).
ftruncate (function).
ftruncate! (compiler macro).
full (function).
full-like (function).
logand (function).
logior (function).
logxor (function).
macro-map-array (macro).
maximum (compiler macro).
minimum (compiler macro).
multiply (compiler macro).
multiply (function).
multiply! (compiler macro).
numericals-array-element-type (type).
ones (compiler macro).
ones (function).
ones-like (function).
rand (function).
rand-like (function).
reshape (function).
shape (function).
sin (compiler macro).
sin! (compiler macro).
sinh (compiler macro).
sinh! (compiler macro).
subtract (compiler macro).
subtract (function).
subtract! (compiler macro).
sum (compiler macro).
tan (compiler macro).
tan! (compiler macro).
tanh (compiler macro).
tanh! (compiler macro).
transpose (function).
two-arg-/= (compiler macro).
two-arg-/= (function).
two-arg-< (compiler macro).
two-arg-< (function).
two-arg-<= (compiler macro).
two-arg-<= (function).
two-arg-= (compiler macro).
two-arg-= (function).
two-arg-> (compiler macro).
two-arg-> (function).
two-arg->= (compiler macro).
two-arg->= (function).
two-arg-matmul (compiler macro).
vdot (compiler macro).
zeros (compiler macro).
zeros (function).
zeros-like (function).
atan2 (compiler macro).
numericals.implalexandria.
common-lisp.
introspect-environment.
iterate.
polymorphic-functions.
%broadcast-compatible-p (function).
*translation-table* (special variable).
+fixnum-shift-pointer+ (special variable).
+one-arg-fn-all-doc+ (constant).
+one-arg-fn-float-doc+ (constant).
aref-applicable-p (function).
arg-is-not-array (condition).
arg-out-type-mismatch (condition).
array-layout (function).
array-storage (function).
array-stride (function).
array-type-element-type (function).
array-type-is-unoptimized (condition).
bad-position-for-out (condition).
blas-trans (function).
broadcast-compatible-p (function).
c-name (compiler macro).
c-name (function).
c-size (compiler macro).
c-size (function).
c-type (compiler macro).
c-type (function).
ccall (macro).
cl-array-offset (function).
cl-name (compiler macro).
cl-name (function).
condition-arg (generic reader).
condition-arg-type (generic reader).
condition-args (generic reader).
condition-array-likes (generic reader).
condition-dimensions (generic reader).
condition-out (generic reader).
condition-out-type (generic reader).
condition-type (generic reader).
default-element-type (symbol macro).
define-numericals-one-arg-test (macro).
define-numericals-one-arg-test/integers (macro).
define-numericals-two-arg-test (macro).
define-numericals-two-arg-test/integers (macro).
define-splice-list-fn (macro).
defun-c (macro).
dimensions (function).
do-with-broadcasting (macro).
double-float-c-name (compiler macro).
double-float-c-name (function).
element-type (function).
ensure-appropriate-array (function).
ensure-row-major-layout (macro).
fixnum-c-name (compiler macro).
fixnum-c-name (function).
fixnum-dot (function).
fixnum-hmax (function).
fixnum-hmin (function).
fixnum-mul (function).
fixnum-sum (function).
fixnump (function).
incompatible-broadcast-dimensions (condition).
int-index (type).
int16-c-name (compiler macro).
int16-c-name (function).
int32 (type).
int32-c-name (compiler macro).
int32-c-name (function).
int64-c-name (compiler macro).
int64-c-name (function).
int8-c-name (compiler macro).
int8-c-name (function).
lm (macro).
max-type (function).
narray-dimensions (function).
normalize-arguments/bitwise (function).
normalize-arguments/cmp (function).
normalize-arguments/dmas (function).
normalize-index (function).
one-arg-fn/all (compiler macro).
one-arg-fn/float (compiler macro).
one-arg-reduce-fn (compiler macro).
out-unknown-at-compile-time (condition).
package-local-element-type (symbol macro).
ptr-iterate-but-inner (macro).
runtime-array-allocation (condition).
single-float-c-name (compiler macro).
single-float-c-name (function).
size (type).
split-at-keywords (function).
strides (function).
strides-for-broadcast (function).
test-copy (function).
the-int-index (macro).
the-size (macro).
two-arg-fn/comparison (compiler macro).
two-arg-fn/float (compiler macro).
two-arg-fn/non-comparison (compiler macro).
type-parameter-p (function).
uint16-c-name (compiler macro).
uint16-c-name (function).
uint32 (type).
uint32-c-name (compiler macro).
uint32-c-name (function).
uint64-c-name (compiler macro).
uint64-c-name (function).
uint8-c-name (compiler macro).
uint8-c-name (function).
with-foreign-object (macro).
with-foreign-objects (macro).
with-pointers-to-vectors-data (macro).
with-thresholded-multithreading (macro).
with-thresholded-multithreading/cl (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
If BOUND, this is the default value of the ELEMENT-TYPE or TYPE argument.
Overrides *ARRAY-ELEMENT-TYPE-ALIST*.
Is overriden by explicitly passing an ELEMENT-TYPE or TYPE argument.
An ALIST mapping package to the default element-type used in that package.
(Inspired from SWANK:*READTABLE-ALIST*)
Overrides none.
Is overriden by *ARRAY-ELEMENT-TYPE* when bound, or by explicitly passing an
ELEMENT-TYPE or TYPE argument.
Dummy variable provided so that code written for NUMERICALS may be easily upgradeable to DENSE-NUMERICALS
If non-NIL, operations automatically perform broadcasting as necessary. If NIL, broadcasting is expected to be performed by the user. Such strictness can be helpful to locate bugs.
Used for converting non-float arrays to float arrays for floating-point operations like trigonometric functions.
Inlining is usually necessary for smaller arrays; for such arrays multithreading becomes unnecessary. If this parameter is non-NIL, code using multithreading would be emitted; otherwise, the code would be skipped.
Each element of BINDINGS is of the form (VAR ARRAY-EXPR &OPTIONAL ELEMENT-TYPE)
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
LAMBDA-LIST: (ARRAY-LIKES &KEY OUT)
LAMBDA-LIST: (ARRAY-LIKES &KEY OUT)
LAMBDA-LIST: (ARRAY-LIKES &KEY OUT)
LAMBDA-LIST: (ARRAY-LIKES &KEY OUT)
LAMBDA-LIST: (ARRAY-LIKES &KEY OUT)
LAMBDA-LIST: (ARRAY-LIKES &KEY OUT)
ARGS: (array &rest subscripts &key out) See tests for examples.
ARGS: (&rest array-dimensions &key (type default-element-type))
Examples:
(empty 2 3)
(empty ’(5 5))
(empty 3 3 :type ’fixnum)
Lambda List: (shape &key value (type default-element-type))
ARGS: (&rest array-dimensions &key (type default-element-type))
Examples:
(ones 2 3)
(ones ’(5 5))
(ones 3 3 :type ’fixnum)
Lambda List: (shape &key (type default-element-type) (min 0) (max 1))
ARGS: (&rest array-dimensions &key (type default-element-type))
Examples:
(zeros 2 3)
(zeros ’(5 5))
(zeros 3 3 :type ’fixnum)
Calls CFFI:FOREIGN-FUNCALL on NAME with appropriate type declarations on args.
Each bindings is of the form (ELT-VAR ARRAY-EXPR &OPTIONAL ELT-TYPE).
Each bindings is of the form (PTR-VAR ELT-SIZE INNER-STRIDE-VAR ARRAY-EXPR).
A wrapper around CFFI:WITH-FOREIGN-OBJECT with an additional VALUE option.
A wrapper around CFFI:WITH-FOREIGN-OBJECTS with an additional VALUE option.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
pf-compiler-macro.
Returns two values:
The first value is a generalized boolean indicating whether the two dimensions are broadcast compatible.
The second value is the dimensions of the array resulting from the broadcast.
Returns two values:
The first value is a generalized boolean indicating whether the dimensions can be broadcasted.
The second value is the dimension of the array resulting from the broadcast.
Consequences of ARRAY-LIKE having elements of different dimensions is undefined.
Consequences of ARRAY-LIKE having elements of different element-type is undefined.
Example: (1 2 3 :a 2 :b 3) => ((1 2 3) :a 2 :b 3)
arg-is-not-array)) ¶arg.
arg-out-type-mismatch)) ¶arg.
arg-is-not-array)) ¶arg-out-type-mismatch)) ¶bad-position-for-out)) ¶args.
out-unknown-at-compile-time)) ¶args.
incompatible-broadcast-dimensions)) ¶incompatible-broadcast-dimensions)) ¶arg-out-type-mismatch)) ¶out.
arg-out-type-mismatch)) ¶array-type-is-unoptimized)) ¶type.
optimization-failure-note.
:arg
This slot is read-only.
:arg-type
This slot is read-only.
:out
This slot is read-only.
:out-type
This slot is read-only.
optimization-failure-note.
common-lisp.
:type
This slot is read-only.
optimization-failure-note.
:args
This slot is read-only.
optimization-failure-note.
:args
This slot is read-only.
suboptimal-polymorph-note.
| Jump to: | %
*
+
-
/
<
=
>
A B C D E F G I L M N O P R S T U V W Z |
|---|
| Jump to: | %
*
+
-
/
<
=
>
A B C D E F G I L M N O P R S T U V W Z |
|---|
| Jump to: | *
+
A C D O P S T |
|---|
| Jump to: | *
+
A C D O P S T |
|---|
| Jump to: | A B C F I L N O P R S T U |
|---|
| Jump to: | A B C F I L N O P R S T U |
|---|