From df3fe5462306f78f75f3bb8e91c59c570fc203e6 Mon Sep 17 00:00:00 2001
From: Norihiro Watanabe <norihiro.watanabe@ufz.de>
Date: Fri, 7 Dec 2012 11:18:04 +0100
Subject: [PATCH] use nullptr and add documentation
---
.../ISystemOfLinearEquations.h | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/MathLib/LinAlg/SystemOfLinearEquations/ISystemOfLinearEquations.h b/MathLib/LinAlg/SystemOfLinearEquations/ISystemOfLinearEquations.h
index eaf0cf36521..710f3536ef0 100644
--- a/MathLib/LinAlg/SystemOfLinearEquations/ISystemOfLinearEquations.h
+++ b/MathLib/LinAlg/SystemOfLinearEquations/ISystemOfLinearEquations.h
@@ -37,11 +37,14 @@ public:
/**
* Constructor
*
- * \param dimension system dimension
- * \param sparsity sparse pattern
+ * @param dimension
+ * A dimension of the linear system, i.e. the number of linear equations.
+ * @param sparsity
+ * A pointer to a row-major sparse pattern. The sparse pattern can be
+ * used in linear systems based on sparse matrices.
*/
ISystemOfLinearEquations(std::size_t /*dimension*/,
- RowMajorSparsity* /*sparsity*/ = NULL) {};
+ RowMajorSparsity* /*sparsity*/ = nullptr) {};
///
virtual ~ISystemOfLinearEquations()
@@ -146,8 +149,10 @@ public:
* @param vec_row_pos
* A vector of global row index. The number of entries of vec_row_pos
* have to be identical to the number of rows of the sub vector.
- * @param sub_vector Pointer to a sub-vector
- * @param fac Scaling parameter
+ * @param sub_vector
+ * Pointer to a sub-vector. Its length must be the same as the length of vec_row_pos.
+ * @param fac
+ * Scaling parameter. Default value is 1.
*/
inline virtual void addSubRHS(const std::vector<std::size_t> &vec_row_pos,
const double* sub_vector, double fac = 1.0);
--
GitLab