1<a name='___top' class='dummyTopAnchor' ></a>
  2
  3<h1><a class='u' href='#___top' title='click to go to top of document'
  4name="Matrixy"
  5>Matrixy</a></h1>
  6
  7<h2><a class='u' href='#___top' title='click to go to top of document'
  8name="INTRODUCTION"
  9>INTRODUCTION</a></h2>
 10
 11<p>This is a port of the MATLAB/Octave programming language to Parrot.
 12See the ROADMAP file for more information on the status of this project,
 13and what else needs to be done.</p>
 14
 15<h2><a class='u' href='#___top' title='click to go to top of document'
 16name="ABOUT"
 17>ABOUT</a></h2>
 18
 19<p>Primary goals are:</p>
 20
 21<blockquote>
 22<p>=item* Create a working compiler that understands the majority of the MATLAB/Octave programming language.</p>
 23</blockquote>
 24
 25<h2><a class='u' href='#___top' title='click to go to top of document'
 26name="IMPLEMENTATION"
 27>IMPLEMENTATION</a></h2>
 28
 29<p>This project is broken into three primary components:</p>
 30
 31<blockquote>
 32<p>=item* The first is the parser,
 33located in the <code>src/parser/</code> directory.
 34The parser proper is composed of three source files,
 35<em>grammar.pg</em> which is a Perl6Grammar file,
 36and <em>actions.pm</em> which is the associated actions file written in NQP,
 37and <em>grammar-oper.pm</em> which is the operator precidence parser.
 38In addition,
 39several helper functions used by the parser are located in <code>src/internals</code>.</p>
 40
 41<p>=item* The second component is the library of builtin functions in the <code>src/builtins/</code> directory.
 42These functions are,
 43currently,
 44written primarily in PIR.
 45Function names prefixed with an underscore are &#34;private&#34; functions for use with the parser.
 46Other functions should have names which are the same as names for regular MATLAB or Octave functions,
 47since they will be available to the HLL.
 48These are also separated into different namespaces depending on visibility and utility.</p>
 49
 50<p>=item* A number of library functions are written in M,
 51or mostly M with some inline PIR code in <code>toolbox/</code>.</p>
 52</blockquote>
 53
 54<h2><a class='u' href='#___top' title='click to go to top of document'
 55name="DEPENDENCIES"
 56>DEPENDENCIES</a></h2>
 57
 58<p>Matrixy depends on these dependencies:</p>
 59
 60<h3><a class='u' href='#___top' title='click to go to top of document'
 61name="Parrot"
 62>Parrot</a></h3>
 63
 64<p>To get a proper version of Parrot to build Matrixy,
 65you will need to check out and build Parrot from source:</p>
 66
 67<pre>    svn co http://svn.parrot.org/parrot/trunk parrot
 68    cd parrot
 69    perl Configure.pl
 70    make &#38;&#38; make test &#38;&#38; make install-dev</pre>
 71
 72<h3><a class='u' href='#___top' title='click to go to top of document'
 73name="Parrot-Linear-Algebra"
 74>Parrot-Linear-Algebra</a></h3>
 75
 76<p>The linear algebra package for Parrot is available separately and provides functionality required by Matrixy. This includes matrix data types and matrix manipulation libraries</p>
 77
 78<h2><a class='u' href='#___top' title='click to go to top of document'
 79name="BUILDING"
 80>BUILDING</a></h2>
 81
 82<p>Once all dependencies are in place, you can build Matrixy using this sequence of commands:</p>
 83
 84<pre>    perl Configure.pl
 85    nmake test</pre>
 86
 87<h2><a class='u' href='#___top' title='click to go to top of document'
 88name="TODO"
 89>TODO</a></h2>
 90
 91<pre>    * Parser
 92    * Standard Builtins
 93    * Test against Octave Test Suite.</pre>
 94
 95<h2><a class='u' href='#___top' title='click to go to top of document'
 96name="BUGS"
 97>BUGS</a></h2>
 98
 99<p>Lots!</p>
100
101<h2><a class='u' href='#___top' title='click to go to top of document'
102name="CONTACT"
103>CONTACT</a></h2>
104
105<p>If you need to contact the Matrixy team, go to the project home page at:</p>
106
107<p>www.github.com\Whiteknight\matrixy</p>
108