Update documentation

diff --git a/doc/doxygen/headers/laoperators.h b/doc/doxygen/headers/laoperators.h
index 85b8176087d866018453bc53397401913e881f67..049035160fac336f1f024773fa163fbbb28b2569 100644 (file)
--- a/doc/doxygen/headers/laoperators.h
+++ b/doc/doxygen/headers/laoperators.h
@@ -46,8 +46,8 @@
  * applied on a vector, one can write:
  * @code
  * dealii::SparseMatrix<double> A, B, C;
+ * double k;
  * // Setup and assembly...
- * const double k = ...;
  *
  * const auto op_a = linear_operator(A);
  * const auto op_b = linear_operator(B);
@@ -65,7 +65,26 @@
  *
  * For objects of type LinearOperator, all vector space operations, i.e.,
  * addition and subtraction, scalar multiplication and composition (of
- * compatible linear operators) are implemented.
+ * compatible linear operators) are implemented:
+ * @code
+ * dealii::LinearOperator op_a, op_b;
+ * double k;
+ *
+ * // vector space addition, subtraction and scalar multiplication
+ * op_a + op_b;
+ * op_a - op_b;
+ * k * op_a;
+ * op_a * k;
+ *
+ * // in-place variants
+ * op_a += op_b;
+ * op_a -= op_b;
+ * op_a *= k;
+ *
+ * // operator composition
+ * op_a * op_b;
+ * op_a *= op_b; // If op_b is an endomorphism of the domain space of op_a
+ * @endcode
  *
  * block_operator() and block_diagonal_operator() provide further
  * encapsulation of individual linear operators into blocked linear

diff --git a/include/deal.II/lac/linear_operator.h b/include/deal.II/lac/linear_operator.h
index 0366e3520562f23293ad86218ad61887b18d6f9f..bc7bf3b04a4eb8602782b19c7090c38d63efc20a 100644 (file)
--- a/include/deal.II/lac/linear_operator.h
+++ b/include/deal.II/lac/linear_operator.h
@@ -248,8 +248,8 @@ public:
   }
 
   /**
-   * Concatenation of the LinearOperator with an endomorphism @p second_op
-   * on the @p Domain space.
+   * Composition of the LinearOperator with an endomorphism @p second_op
+   * of the @p Domain space.
    */
   LinearOperator<Range, Domain> &
   operator*=(const LinearOperator<Domain, Domain> &second_op)
@@ -276,8 +276,8 @@ public:
 /**
  * \relates LinearOperator
  *
- * Addition of two linear operators @p first_op and @p second_op given
- * by $(\text{first\_op}+\text{second\_op})x:=\text{first\_op}(x)+\text{second\_op}(x)$
+ * Addition of two linear operators @p first_op and @p second_op given by
+ * $(\text{first\_op}+\text{second\_op})x:=\text{first\_op}(x)+\text{second\_op}(x)$
  *
  * @ingroup LAOperators
  */
@@ -325,8 +325,8 @@ operator+(const LinearOperator<Range, Domain> &first_op,
 /**
  * \relates LinearOperator
  *
- * Subtraction of two linear operators @p first_op and @p second_op given
- * by $(\text{first\_op}-\text{second\_op})x:=\text{first\_op}(x)-\text{second\_op}(x)$
+ * Subtraction of two linear operators @p first_op and @p second_op given by
+ * $(\text{first\_op}-\text{second\_op})x:=\text{first\_op}(x)-\text{second\_op}(x)$
  *
  * @ingroup LAOperators
  */
@@ -343,8 +343,8 @@ operator-(const LinearOperator<Range, Domain> &first_op,
 /**
  * \relates LinearOperator
  *
- * Concatenation of two linear operators @p first_op and @p second_op given
- * by $(\text{first\_op}*\text{second\_op})x:=\text{first\_op}(\text{second\_op}(x))$
+ * Composition of two linear operators @p first_op and @p second_op given by
+ * $(\text{first\_op}*\text{second\_op})x:=\text{first\_op}(\text{second\_op}(x))$
  *
  * @ingroup LAOperators
  */

diff --git a/include/deal.II/lac/pointer_matrix.h b/include/deal.II/lac/pointer_matrix.h
index c95f3f4c7e293a46cd2db92f58afb8505afba377..e05cb07bf1bfc20cdea84ed737b073fd81a28d9b 100644 (file)
--- a/include/deal.II/lac/pointer_matrix.h
+++ b/include/deal.II/lac/pointer_matrix.h
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------
 //
-// Copyright (C) 2002 - 2014 by the deal.II authors
+// Copyright (C) 2002 - 2015 by the deal.II authors
 //
 // This file is part of the deal.II library.
 //

diff --git a/include/deal.II/lac/schur_matrix.h b/include/deal.II/lac/schur_matrix.h
index c7805956149401b4bab9c343a1f0dff8a6e76193..01201eb300b740f89c7936671d2532f63e30d8e4 100644 (file)
--- a/include/deal.II/lac/schur_matrix.h
+++ b/include/deal.II/lac/schur_matrix.h
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------
 //
-// Copyright (C) 2001 - 2014 by the deal.II authors
+// Copyright (C) 2001 - 2015 by the deal.II authors
 //
 // This file is part of the deal.II library.
 //