]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Augment documentation.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 8 Oct 2004 18:46:01 +0000 (18:46 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 8 Oct 2004 18:46:01 +0000 (18:46 +0000)
git-svn-id: https://svn.dealii.org/trunk@9704 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/point.h

index dba7de6ded6182152d8e061d7d35c803461ba9cc..3e8bf6b8d32595cca9381c55a01a35f1a1a4f6a0 100644 (file)
@@ -155,8 +155,11 @@ class Point : public Tensor<1,dim>
     double              square () const;
     
                                     /**
-                                     * Returns the distance of <tt>this</tt> 
-                                     * point to the point <tt>p</tt>.
+                                     * Returns the Euclidian distance of
+                                     * <tt>this</tt> point to the point
+                                     * <tt>p</tt>, i.e. the <tt>l_2</tt> norm
+                                     * of the difference between the vectors
+                                     * representing the two points.
                                      */
     double distance (const Point<dim> &p) const;
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.