From: bangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Sun, 24 Mar 2013 16:38:07 +0000 (+0000)
Subject: Augment documentation.
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4fe6d2aada99c71b5382fa683e3f8498d85e0dc2;p=dealii-svn.git

Augment documentation.


git-svn-id: https://svn.dealii.org/trunk@29015 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/include/deal.II/base/index_set.h b/deal.II/include/deal.II/base/index_set.h
index 0b2baecf3e..c0cf5a1ddd 100644
--- a/deal.II/include/deal.II/base/index_set.h
+++ b/deal.II/include/deal.II/base/index_set.h
@@ -1,7 +1,7 @@
 //---------------------------------------------------------------------------
 //    $Id$
 //
-//    Copyright (C) 2009, 2010, 2011, 2012 by the deal.II authors
+//    Copyright (C) 2009, 2010, 2011, 2012, 2013 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -244,6 +244,16 @@ public:
    * index set with the interval, shifted
    * to the range <tt>[0,
    * end-begin)</tt>.
+   *
+   * In other words, the result of this operation is the
+   * intersection of the set represented by the current object
+   * and the interval <tt>[begin, end)</tt>, as seen
+   * <i>within the interval <tt>[begin, end)</tt></i> by
+   * shifting the result of the intersection operation to
+   * the left by <tt>begin</tt>. This corresponds to the notion
+   * of a <i>view</i>: The interval <tt>[begin, end)</tt> is
+   * a <i>window</i> through which we see the set represented
+   * by the current object.
    */
   IndexSet get_view (const unsigned int begin,
                      const unsigned int end) const;
@@ -1047,4 +1057,3 @@ IndexSet::serialize (Archive &ar, const unsigned int)
 DEAL_II_NAMESPACE_CLOSE
 
 #endif
-