Permalink
Browse files

Updated readme

  • Loading branch information...
1 parent 9c6e34d commit d2a0a389fb488610445922811cad386bd6ac5144 nisbus committed Feb 23, 2013
Showing with 46 additions and 1 deletion.
  1. +46 −1 README.md
View
@@ -1,4 +1,49 @@
mathex
======
-Extra math function for Erlang
+Extra math functions for Erlang
+
+This library contains the following functions:
+
+## Return a single value
+
+* average
+* sum
+* stdev_sample
+* stdev_population
+* skew
+* kurtosis
+* variance
+* covariance
+
+## Return a list of values
+
+* moving_average
+* correlation
+* correlation_matrix
+
+Most of these are well documented elsewhere except maybe the
+correlation_matrix.
+The correlation matrix will take in a list of numeric lists
+and correlate each list in the collection with all the other lists
+of the collection.
+The result will look like this:
+
+```erlang
+[{integer(),integer(),float()},
+ {integer(),integer(),float()},
+ {integer(),integer(),float()},
+ {integer(),integer(),float()}]
+```
+
+Where the first int is the index of a list in the collection and the
+second integer the index of the list it's being correlated to.
+The float is the correlation of the two.
+It will give you all possible combinations and their correlation.
+
+
+#To Do
+Add a sort function to return the correlation_matrix sorted desc/asc.
+Add more functions.
+Add unit tests.
+Add more documentation.

0 comments on commit d2a0a38

Please sign in to comment.