diff --git a/README b/README index 157a6b9..54e5901 100644 --- a/README +++ b/README @@ -2,6 +2,8 @@ parrot-linear-algebra A linear algebra library package for Parrot +PROJECT GOALS + The initial goals of this package are to receive and make independent the bindings for CBLAS and CLAPACK that were originally developed for the Matrixy compiler project @@ -9,24 +11,17 @@ compiler project OLD: http://code.google.com/p/matrixy NEW: http://github.com/Whiteknight/matrixy -Development on this projece will proceed in several phases, and has multiple -goals, which may be attacked in concert: - -1) Create proper bindings for CBLAS and CLAPACK library routines, including - translational wrappers to convert Parrot data types into matrices used - by these libraries -2) Create a proper build system that can find and link to the CBLAS and - CLAPACK libraries. Possibly even download and build them from source -3) Create a 2-D numerical matrix PMC type that can be used to provide - low-level access to library routines with minimal conversion -4) Creation of any additonal bindings or wrappers that may be useful to - high-level language projects - STATUS Currently, this package is in an extreme state of disrepair because it is being separated from the Matrixy project. Nothing works, nothing builds, and this is expected. +DEPENDENCIES + + +BUILDING + + CREDITS Original versions were developed as part of the Matrixy project by Blairuk. diff --git a/ROADMAP.pod b/ROADMAP.pod new file mode 100644 index 0000000..186b8b2 --- /dev/null +++ b/ROADMAP.pod @@ -0,0 +1,30 @@ +=head1 ROADMAP + +=head2 General Plans + +=over 4 + +=item* Create a basic, dense, 2D Matrix PMC type that contains bindings for +CBLAS routines. + +This includes basic VTABLEs (add, subtract, multiply, divide, etc). Add METHODs +for other interesting routines. Find a good way to do multi-level indices. + +=item* Create proper PIR bindings for CBLAS and CLAPACK library routines. + +This includes translational wrappers to convert Parrot data types into matrices +used by these libraries + +=item* Create a proper build system. + +Should be able to detect and link to multiple implementations of BLAS, including +CBLAS, GSL, ATLAS, etc. Should be able to link to CLAPACK, and maybe other +implementations of LAPACK as well. Maybe should be able to download and build +those libraries from source. + +=item* Creation of any additonal bindings or wrappers that may be useful to +high-level language projects + +=back + +=cut