racket/collects/math/scribblings/math.scrbl
Neil Toronto f2dc2027f6 Initial math library commit. The history for these changes is preserved
in the original GitHub fork:

  https://github.com/ntoronto/racket

Some things about this are known to be broken (most egregious is that the
array tests DO NOT RUN because of a problem in typed/rackunit), about half
has no coverage in the tests, and half has no documentation. Fixes and
docs are coming. This is committed now to allow others to find errors and
inconsistency in the things that appear to be working, and to give the
author a (rather incomplete) sense of closure.
2012-11-16 11:39:51 -07:00

42 lines
1.5 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{@racket[Bigfloat]s, or arbitrary-precision floating-point numbers}
@item{Probability distributions}
@item{Statistical functions}
@item{Number-theoretic functions}
@item{@racket[Array]s for storing and transforming large rectangular data sets}
@item{Linear algebra functions}
]
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"]