Fix some apparent typos and misindentations.

[ginac.git] / ginac / matrix.h

diff --git a/ginac/matrix.h b/ginac/matrix.h
index fc6a80bf4e6b3127eb701809792d948fdb694525..759e825ab4ca06c7dedf446a25d325b00e32402e 100644 (file)
--- a/ginac/matrix.h
+++ b/ginac/matrix.h
@@ -3,7 +3,7 @@
  *  Interface to symbolic matrices */
 
 /*
- *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2015 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -17,19 +17,20 @@
  *
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#ifndef __GINAC_MATRIX_H__
-#define __GINAC_MATRIX_H__
+#ifndef GINAC_MATRIX_H
+#define GINAC_MATRIX_H
 
-#include <vector>
-#include <string>
 #include "basic.h"
 #include "ex.h"
+#include "archive.h"
 
-namespace GiNaC {
+#include <string>
+#include <vector>
 
+namespace GiNaC {
 
 /** Helper template to allow initialization of matrices via an overloaded
  *  comma operator (idea stolen from Blitz++). */
@@ -100,7 +101,7 @@ public:
        matrix(unsigned r, unsigned c, const exvector & m2);
        matrix(unsigned r, unsigned c, const lst & l);
 
-       // First step of initialization of matrix with a comma-separated seqeuence
+       // First step of initialization of matrix with a comma-separated sequence
        // of expressions. Subsequent steps are handled by matrix_init<>::operator,().
        matrix_init<ex, exvector::iterator> operator=(const ex & x)
        {
@@ -120,7 +121,14 @@ public:
        ex add_indexed(const ex & self, const ex & other) const;
        ex scalar_mul_indexed(const ex & self, const numeric & other) const;
        bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
-
+       ex conjugate() const;
+       ex real_part() const;
+       ex imag_part() const;
+
+       /** Save (a.k.a. serialize) object into archive. */
+       void archive(archive_node& n) const;
+       /** Read (a.k.a. deserialize) object from archive. */
+       void read_archive(const archive_node& n, lst& syms);
 protected:
        bool match_same_type(const basic & other) const;
        unsigned return_type() const { return return_types::noncommutative; };
@@ -147,6 +155,8 @@ public:
        matrix inverse() const;
        matrix solve(const matrix & vars, const matrix & rhs,
                     unsigned algo = solve_algo::automatic) const;
+       unsigned rank() const;
+       bool is_zero_matrix() const;
 protected:
        ex determinant_minor() const;
        int gauss_elimination(const bool det = false);
@@ -165,6 +175,7 @@ protected:
        unsigned col;             ///< number of columns
        exvector m;               ///< representation (cols indexed first)
 };
+GINAC_DECLARE_UNARCHIVER(matrix); 
 
 
 // wrapper functions around member functions
@@ -202,13 +213,10 @@ inline ex charpoly(const matrix & m, const ex & lambda)
 inline matrix inverse(const matrix & m)
 { return m.inverse(); }
 
-// utility functions
+inline unsigned rank(const matrix & m)
+{ return m.rank(); }
 
-/** Specialization of is_exactly_a<matrix>(obj) for matrix objects. */
-template<> inline bool is_exactly_a<matrix>(const basic & obj)
-{
-       return obj.tinfo()==TINFO_matrix;
-}
+// utility functions
 
 /** Convert list of lists to matrix. */
 extern ex lst_to_matrix(const lst & l);
@@ -228,6 +236,13 @@ inline ex unit_matrix(unsigned x)
  *  The base name for LaTeX output is specified separately. */
 extern ex symbolic_matrix(unsigned r, unsigned c, const std::string & base_name, const std::string & tex_base_name);
 
+/** Return the reduced matrix that is formed by deleting the rth row and cth
+ *  column of matrix m. The determinant of the result is the Minor r, c. */
+extern ex reduced_matrix(const matrix& m, unsigned r, unsigned c);
+
+/** Return the nr times nc submatrix starting at position r, c of matrix m. */
+extern ex sub_matrix(const matrix&m, unsigned r, unsigned nr, unsigned c, unsigned nc);
+
 /** Create an r times c matrix of newly generated symbols consisting of the
  *  given base name plus the numeric row/column position of each element. */
 inline ex symbolic_matrix(unsigned r, unsigned c, const std::string & base_name)
@@ -235,4 +250,4 @@ inline ex symbolic_matrix(unsigned r, unsigned c, const std::string & base_name)
 
 } // namespace GiNaC
 
-#endif // ndef __GINAC_MATRIX_H__
+#endif // ndef GINAC_MATRIX_H