From a61ab7c70bd4ce6212542ebb623a246a9c3a0079 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Mon, 28 Mar 2005 16:59:00 +0000 Subject: [PATCH] Reindent comments. git-svn-id: https://svn.dealii.org/trunk@10244 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/point.h | 98 ++++++++++++++++-------------- deal.II/base/include/base/tensor.h | 34 ++++++----- 2 files changed, 73 insertions(+), 59 deletions(-) diff --git a/deal.II/base/include/base/point.h b/deal.II/base/include/base/point.h index 3e8bf6b8d3..d41822d044 100644 --- a/deal.II/base/include/base/point.h +++ b/deal.II/base/include/base/point.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 by the deal authors +// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 by the deal authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -21,24 +21,25 @@ /** - * The Point class provides for a point or vector in a space with arbitrary - * dimension dim. + * The Point class provides for a point or vector in a space with + * arbitrary dimension dim. * - * It is the preferred object to be passed to functions which - * operate on points in spaces of a priori unknown dimension: rather than - * using functions like double f(double x) and double f(double x, double y), + * It is the preferred object to be passed to functions which operate on + * points in spaces of a priori unknown dimension: rather than using functions + * like double f(double x) and double f(double x, double y), * you use double f(Point &p). * - * Point also serves as a starting point for the implementation of the - * geometrical primitives like Polyhedron, Triangle, etc. + * Point also serves as a starting point for the implementation of + * the geometrical primitives like Polyhedron, Triangle, + * etc. * - * Points can also be thought of as vectors, i.e. points in a vector space - * without an obvious meaning. For instance, it may be suitable to let the - * gradient of a function be a point vector: - * Point gradient_of_f (const Point &x). Points have all + * Points can also be thought of as vectors, i.e. points in a vector + * space without an obvious meaning. For instance, it may be suitable to let + * the gradient of a function be a point vector: Point + * gradient_of_f (const Point &x). Points have all * functionality for this, e.g. scalar products, addition etc. However, you - * should also consider using the simpler Tensor<1,dim> class, which seems - * more suited to gradients. + * should also consider using the simpler Tensor<1,dim> class, which + * seems more suited to gradients. * * @author Wolfgang Bangerth, 1997 */ @@ -67,37 +68,41 @@ class Point : public Tensor<1,dim> Point (const Tensor<1,dim> &); /** - * Constructor for one dimensional points. This - * function is only implemented for dim==1 - * since the usage is considered unsafe - * for points with dim!=1. + * Constructor for one dimensional + * points. This function is only + * implemented for dim==1 since + * the usage is considered unsafe for + * points with dim!=1. */ explicit Point (const double x); /** - * Constructor for two dimensional points. This - * function is only implemented for dim==2 - * since the usage is considered unsafe - * for points with dim!=2. + * Constructor for two dimensional + * points. This function is only + * implemented for dim==2 since + * the usage is considered unsafe for + * points with dim!=2. */ Point (const double x, const double y); /** - * Constructor for three dimensional points. This - * function is only implemented for dim==3 - * since the usage is considered unsafe - * for points with dim!=3. + * Constructor for three dimensional + * points. This function is only + * implemented for dim==3 since + * the usage is considered unsafe for + * points with dim!=3. */ Point (const double x, const double y, const double z); /** - * Read access to the indexth coordinate. + * Read access to the indexth + * coordinate. */ double operator () (const unsigned int index) const; /** - * Read and write access to the indexth - * coordinate. + * Read and write access to the + * indexth coordinate. */ double & operator () (const unsigned int index); @@ -107,16 +112,18 @@ class Point : public Tensor<1,dim> */ /** - * Add two point vectors. If possible, use - * operator += instead since this does not - * need to copy a point at least once. + * Add two point vectors. If possible, + * use operator += instead + * since this does not need to copy a + * point at least once. */ Point operator + (const Tensor<1,dim>&) const; /** - * Subtract two point vectors. If possible, use - * operator += instead since this does not - * need to copy a point at least once. + * Subtract two point vectors. If + * possible, use operator += + * instead since this does not need to + * copy a point at least once. */ Point operator - (const Tensor<1,dim>&) const; @@ -126,9 +133,10 @@ class Point : public Tensor<1,dim> Point operator - () const; /** - * Multiply by a factor. If possible, use - * operator *= instead since this does not - * need to copy a point at least once. + * Multiply by a factor. If possible, + * use operator *= instead + * since this does not need to copy a + * point at least once. * * There is a commutative complement to this * function also @@ -136,21 +144,23 @@ class Point : public Tensor<1,dim> Point operator * (const double) const; /** - * Returns the scalar product of two vectors. + * Returns the scalar product of two + * vectors. */ double operator * (const Tensor<1,dim> &) const; /** * Divide by a factor. If possible, use - * operator /= instead since this does not - * need to copy a point at least once. + * operator /= instead since + * this does not need to copy a point at + * least once. */ Point operator / (const double) const; /** - * Returns the scalar product of this point - * vector with itself, i.e. the square, or - * the square of the norm. + * Returns the scalar product of this + * point vector with itself, i.e. the + * square, or the square of the norm. */ double square () const; diff --git a/deal.II/base/include/base/tensor.h b/deal.II/base/include/base/tensor.h index 8317d89ceb..dec4268eb8 100644 --- a/deal.II/base/include/base/tensor.h +++ b/deal.II/base/include/base/tensor.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 by the deal authors +// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 by the deal authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -114,43 +114,47 @@ class Tensor bool operator != (const Tensor &) const; /** - * Add another vector, i.e. move this tensor by - * the given offset. + * Add another tensor. */ Tensor & operator += (const Tensor &); /** - * Subtract another vector. + * Subtract another tensor. */ Tensor & operator -= (const Tensor &); /** - * Scale the tensor by factor, i.e. multiply - * all coordinates by factor. + * Scale the tensor by factor, + * i.e. multiply all components by + * factor. */ Tensor & operator *= (const double &factor); /** - * Scale the vector by 1/factor. + * Scale the vector by + * 1/factor. */ Tensor & operator /= (const double &factor); /** - * Add two tensors. If possible, use - * operator += instead since this does not - * need to copy a point at least once. + * Add two tensors. If possible, you + * should use operator += + * instead since this does not need the + * creation of a temporary. */ Tensor operator + (const Tensor &) const; /** - * Subtract two tensors. If possible, use - * operator += instead since this does not - * need to copy a point at least once. + * Subtract two tensors. If possible, + * you should use operator -= + * instead since this does not need the + * creation of a temporary. */ Tensor operator - (const Tensor &) const; /** - * Invert all entries of a tensor. + * Unary minus operator. Negate all + * entries of a tensor. */ Tensor operator - () const; @@ -224,7 +228,7 @@ class Tensor // also, it would be sufficient to make // the function unroll_loops a friend, // but that seems to be impossible as well. - template friend class Tensor; + template friend class Tensor; }; -- 2.39.5