Skip to content
Browse files

migrated docs content to README.org

  • Loading branch information...
1 parent d6648c7 commit 081049ee336d5c38899d46309ef30e7355491eff @blindglobe committed
Showing with 22 additions and 26 deletions.
  1. +22 −0 README.org
  2. +0 −26 doc/README
View
22 README.org
@@ -58,6 +58,28 @@ These dependencies need to be better worked out.
*** Others (AJR?)
**** xarray (generic array-like accessors)
+* Documentation
+
+ Need to autogenerate approach for documenting what we can do with
+ this. Until then, simple reference:
+
+#+begin_src common-lisp
+(make-matrix) instantiates any supported matrix type:
+ = lisp/foriegn
+ = single/double/complex-single/complex-double/integer
+
+(mref mat x y) get/set
+
+(bind2 mat1 mat2 :by [:row|:column] )
+
+(diagonal mat)
+
+(m* mat1 mat2) => selection of the correct ZYYmm type (gemm for general mat mult)
+(m+ mat1 mat2)
+(m- mat1 mat3)
+(axpy a mat1 mat2) => (scalar * matrix) + matrix
+#+end_src
+
* Usage
** Demo (broken things)
#+begin_src common-lisp
View
26 doc/README
@@ -1,26 +0,0 @@
- -*- mode: text -*-
-
-Need to autogenerate approach for documenting what we can do with
-this. See also demo.lisp and TODO.lisp for examples and current
-challenges.
-
-
-Simple reference:
-
-
-(make-matrix) instantiates any supported matrix type:
- = lisp/foriegn
- = single/double/complex-single/complex-double/integer
-
-(mref mat x y) get/set
-
-(bind2 mat1 mat2 :by [:row|:column] )
-
-(diagonal mat)
-
-(m* mat1 mat2) => selection of the correct ZYYmm type (gemm for general mat mult)
-(m+ mat1 mat2)
-(m- mat1 mat3)
-(axpy a mat1 mat2) => (scalar * matrix) + matrix
-
-

0 comments on commit 081049e

Please sign in to comment.
Something went wrong with that request. Please try again.