Skip to content

Commit

Permalink
starting "api-guide" document to help characterize the current api su…
Browse files Browse the repository at this point in the history
…rface, will also be later used to write further documentation / tutorials
  • Loading branch information
cartazio committed Jun 16, 2014
1 parent e21553f commit e5f7a5c
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion api-guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
# A map of the Numerical-Core APIs

Your first time looking at the source code for numerical-core can be
an overwhelming one! Theres a
an overwhelming one! Theres a lot going on!

Before you get lost, the current set of live modules in the code base
that have any useful information are:

* Numerical.Array.Layout
* Numerical.Array.Layout.Base
* Numerical.Array.Layout.Dense
* Numerical.Array.Layout.Sparse
* Numerical.Array.Layout.Dense.Builder
* Numerical.Array
* Numerical.World
* Control.NumericalApplicative.Backwards
* Numerical.Array.Shape
* Numerical.Array.Storage
* Numerical.Nat
* Numerical.Array.Mutable
* Numerical.Array.Pure
* Numerical.Array.Locality
* Numerical.Array.Address
* Numerical.Internal.Data.Vector.Pair

For those who just wish to


0 comments on commit e5f7a5c

Please sign in to comment.