analyzematrix Code
Command line tool for reporting details on a given matrix
Status: Beta
Brought to you by:
jlenthe
Menu
▾
▴
Tree [076713] master / History
Jason Lenthe
Read Me
-----------------------------------------------------------------------
Copyright (c) 2012 Jason Lenthe <lenthe@comcast.net>
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
-----------------------------------------------------------------------
------------
Introduction
------------
analyzematrix is a command line tool for learning detailed information about a
matrix including its inverse, determinant, eigenvalues, eigenvectors, and
singular value decomposition.
The homepage for this software is http://sourceforge.net/projects/analyzematrix.
If you use analyzematrix, be sure to post any praise, constructive criticism, or
requests for new features on the sourceforge discussion page.
------------
Dependencies
------------
analyzematrix is written in C++98 and requires a compiler that supports that
version of the language (any semi-recent version of g++ or clang++ is adequate).
analyzematrix uses the following libraries which must be installed before
it can be compiled:
* BLAS
* LAPACK
* boost regex
analyzematrix also requires the getopt_long() function to be present.
analyzematrix does not contain any Fortran code, however, a Fortran compiler
is required to be installed by the configure script so that is can properly
assess compatibility between C++ and Fortran.
------------
Development
------------
analyzematrix uses the GNU build system (autoconf and automake) so building is
done by running the configure script from your build directory and "make".
More information about the various make targets supported can be found in the
INSTALL file.
The default make target builds a unit test driver (based on Google Test and
Google Mock) called unittestdriver. The unittestdriver does not install with
the install target.
The source code for the analyzematrix.1 man page is in docbook xml under the
doc directory. The shell script make_man_page.sh is the command I use to
regenerate the man page from the XML source using xsltproc and referencing
the docbook xsl transform from /usr/local (because I develop on FreeBSD).
The Makefile for analyzematrix supports generation of design documention
with doxygen. The target is simply "doxygen" and will build html doxygen
output. If your system has the Graphviz package installed (and the "dot"
command specifically) call graphs and class hierarchy graphs will be included.