From 87fa26a952241116620a8c7c13f7c29e690a7a7b Mon Sep 17 00:00:00 2001
From: Thomas Fischer <thomas.fischer@ufz.de>
Date: Fri, 11 Nov 2011 11:33:50 +0100
Subject: [PATCH] added documentation to method getValue()
---
MathLib/LinAlg/Sparse/CRSMatrix.h | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/MathLib/LinAlg/Sparse/CRSMatrix.h b/MathLib/LinAlg/Sparse/CRSMatrix.h
index 65e503ddc2f..beeb3a4407c 100644
--- a/MathLib/LinAlg/Sparse/CRSMatrix.h
+++ b/MathLib/LinAlg/Sparse/CRSMatrix.h
@@ -125,6 +125,13 @@ public:
return 1;
}
+ /**
+ * This is an access operator to a non-zero matrix entry. If the value of
+ * a non-existing matrix entry is requested it will be 0.0 returned.
+ * @param row the row number
+ * @param col the column number
+ * @return The corresponding matrix entry or 0.0.
+ */
double getValue(IDX_TYPE row, IDX_TYPE col)
{
assert(0 <= row && row < MatrixBase::_n_rows);
--
GitLab