summaryrefslogtreecommitdiffstats
path: root/src/math/matrix.php
diff options
context:
space:
mode:
authorKore Nordmann <github@kore-nordmann.de>2008-08-20 08:46:31 +0000
committerKore Nordmann <github@kore-nordmann.de>2008-08-20 08:46:31 +0000
commit59e15d56899406f7cff4fd3eae3a370410e0c898 (patch)
tree82a07694271a329c1d34c2b4072f0a18e2bec8b6 /src/math/matrix.php
parent0f7144b17ea88e3c5553ca8bb40901947e947de6 (diff)
downloadzetacomponents-graph-59e15d56899406f7cff4fd3eae3a370410e0c898.zip
zetacomponents-graph-59e15d56899406f7cff4fd3eae3a370410e0c898.tar.gz
- Started with better class level documentation.
Diffstat (limited to 'src/math/matrix.php')
-rw-r--r--src/math/matrix.php9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/math/matrix.php b/src/math/matrix.php
index 0cfbed3..26da354 100644
--- a/src/math/matrix.php
+++ b/src/math/matrix.php
@@ -10,6 +10,15 @@
*/
/**
* Provides a genereic matrix class with basic math operations
+ *
+ * The matrix class is used for internal matrix calculations, and it should not
+ * be required to be used by end users. It offers the common arithmetics
+ * operations, and a __toString mechanism for debugging.
+ *
+ * Beside this it implements more complex matrix algorithms to solve non linear
+ * equatations using the Gauss-Newton algorithm and LR decomposition using the
+ * Cholesky-Crout algorithm. These algorithms are required by the average
+ * polynom calculation in the ezcGraphDataSetAveragePolynom class.
*
* @version //autogentag//
* @package Graph
OpenPOWER on IntegriCloud