Update docs
author |
Steve Losh <steve@stevelosh.com> |
date |
Tue, 23 Aug 2016 01:13:16 +0000 |
parents |
eb328be4e513 |
children |
e7bd00f6516f |
(defpackage #:losh.internal
(:use #:cl))
(in-package #:losh.internal)
(defun reexport (source-package &optional (target-package '#:losh))
(do-external-symbols (s (find-package source-package))
(import s (find-package target-package))
(export s (find-package target-package))))
(defmacro defsubpackage (name &rest args)
`(progn
(defpackage ,name ,@args)
(reexport ',name)))
(defpackage #:losh
(:use
#:cl
#:iterate
#:losh.quickutils)
(:documentation
"This package exports all of the symbols in the other packages.
If you just want to get everything you can `:use` this one and be done with
it. Otherwise you can `:use` only the ones you need.
"))
(defsubpackage #:losh.math
(:documentation "Utilities related to math and numbers.")
(:export
#:tau
#:square
#:dividesp
#:norm
#:lerp
#:precise-lerp
#:map-range
#:clamp))
(defsubpackage #:losh.random
(:documentation "Utilities related to randomness.")
(:export
#:randomp
#:random-elt
#:random-range
#:random-range-exclusive
#:random-around
#:random-gaussian
#:random-gaussian-integer
#:d))
(defsubpackage #:losh.functions
(:documentation "Utilities for working with higher-order functions.")
(:export
#:juxt
#:nullary))
(defsubpackage #:losh.control-flow
(:documentation "Utilities for managing control flow.")
(:export
#:recursively
#:recur
#:when-found
#:if-found
#:gathering
#:gather))
(defsubpackage #:losh.mutation
(:documentation "Utilities for mutating places in-place.")
(:export
#:zapf
#:%
#:mulf
#:divf
#:modf
#:remainderf
#:clampf
#:negatef
#:notf
#:callf))
(defsubpackage #:losh.lists
(:documentation "Utilities related to lists.")
(:export
#:take))
(defsubpackage #:losh.arrays
(:documentation "Utilities related to arrays.")
(:export
#:do-array
#:fill-multidimensional-array
#:fill-multidimensional-array-t
#:fill-multidimensional-array-fixnum
#:fill-multidimensional-array-single-float))
(defsubpackage #:losh.queues
(:documentation "A simple queue implementation.")
(:export
#:queue
#:make-queue
#:queue-contents
#:queue-size
#:queue-empty-p
#:enqueue
#:dequeue
#:queue-append))
(defsubpackage #:losh.iterate
(:use #:iterate) ; need this for iterate's `for` symbol fuckery
(:documentation "Custom `iterate` drivers and clauses.")
(:export
#:pairs-of-list
#:averaging
#:into
#:timing
#:since-start-into
#:per-iteration-into
#:real-time
#:run-time
#:in-lists
#:in-sequences
#:in-whatever
#:in-array
#:across-flat-array
#:index-of-flat-array
#:cycling
#:for-nested
#:within-radius
#:skip-origin))
(defsubpackage #:losh.distributions
(:documentation "Utilities for calculating statistical... things.")
(:export
#:prefix-sums
#:frequencies))
(defsubpackage #:losh.hash-sets
(:documentation "A simple hash set implementation.")
(:export
#:hash-set
#:make-set
#:set-contains-p
#:set-empty-p
#:set-add
#:set-add-all
#:set-remove
#:set-remove-all
#:set-clear
#:set-random
#:set-pop))
(defsubpackage #:losh.debugging
(:documentation "Utilities for figuring out what the hell is going on.")
(:export
#:pr
#:bits
#:dis))
(defsubpackage #:losh.weightlists
(:documentation
"A simple data structure for choosing random items with weighted probabilities.")
(:export
#:weightlist
#:weightlist-weights
#:weightlist-items
#:make-weightlist
#:weightlist-random))
(defsubpackage #:losh.eldritch-horrors
(:documentation "Abandon all hope, ye who enter here.")
(:export
#:dlambda
#:define-with-macro))
;;;; Remember to add it to the docs!