racket/collects/math/scribblings/math.scrbl
Neil Toronto 769e8b47ec Added `array->list-array'
Cleaned up expected value code a little

Refactored running statistics objects (hid private fields, added
`update-statistics*')

Documented expected value functions and running statistics

Removed `bfpsi0' from bigfloat tests (DrDr's libmpfr doesn't have it)

Commented out custodian shutdown callback that frees MPFR's cache
(something's broken)
2012-12-06 22:52:22 -07:00

46 lines
1.7 KiB
Racket

#lang scribble/manual
@(require "utils.rkt")
@title[#:tag "top"]{Math Library}
@(author-neil)
@(author-jens-axel)
@defmodule[math]
The @racketmodname[math] library provides functions and data structures useful
for working with numbers and collections of numbers. These include
@itemlist[
@item{Additional constants and elementary functions}
@item{Special functions}
@item{Bigfloats, or arbitrary-precision floating-point numbers}
@item{Number-theoretic functions}
@item{Functional arrays for storing and operating on large rectangular data sets}
@item{Probability distributions}
@item{Statistical functions (currently being documented)}
@item{Linear algebra functions (currently under review)}
]
With this library, we hope to support a wide variety of applied mathematics in
Racket, including simulation, statistical inference, signal processing, and
combinatorics. If you find it lacking for your variety of mathematics,
please contact us or post to one of the
@hyperlink["http://racket-lang.org/community.html"]{mailing lists}
to make suggestions or submit patches.
@bold{This is a Typed Racket library.} It is most efficient to use it in Typed
Racket, so that contracts are checked statically. However, almost all of it can
be used in untyped Racket. Exceptions and performance warnings are in @bold{bold text}.
@local-table-of-contents[]
@include-section["math-base.scrbl"]
@include-section["math-flonum.scrbl"]
@include-section["math-special-functions.scrbl"]
@include-section["math-number-theory.scrbl"]
@include-section["math-bigfloat.scrbl"]
@include-section["math-array.scrbl"]
@include-section["math-statistics.scrbl"]
@include-section["math-distributions.scrbl"]
@include-section["math-utils.scrbl"]