From dad2728463a16c4854af923369419280aae0e177 Mon Sep 17 00:00:00 2001
From: Max Kahnt <max.kahnt@fu-berlin.de>
Date: Tue, 26 Jul 2016 13:40:39 +0200
Subject: [PATCH] Add docu.
---
dune/matrix-vector/triangularsolve.hh | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/dune/matrix-vector/triangularsolve.hh b/dune/matrix-vector/triangularsolve.hh
index baa2c52..61cffac 100644
--- a/dune/matrix-vector/triangularsolve.hh
+++ b/dune/matrix-vector/triangularsolve.hh
@@ -3,6 +3,11 @@
namespace Dune {
namespace MatrixVector {
+
+ /**
+ * \brief Solves L*x=b where L is a lower triangular matrix.
+ * \param transpose Set true if L is passed as an upper triangular matrix.
+ */
template <class Matrix, class Vector, class BitVector>
static void lowerTriangularSolve(Matrix const& L, Vector b, Vector& x,
BitVector const* ignore,
@@ -40,6 +45,10 @@ namespace MatrixVector {
}
}
+ /**
+ * \brief Solves U*x=b where U is an upper triangular matrix.
+ * \param transpose Set true if U is passed as a lower triangular matrix.
+ */
template <class Matrix, class Vector, class BitVector>
static void upperTriangularSolve(Matrix const& U, Vector b, Vector& x,
BitVector const* ignore,
--
GitLab