]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Doc updates to make doc++ happy with operator definitions.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 1 Jun 1999 13:04:58 +0000 (13:04 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 1 Jun 1999 13:04:58 +0000 (13:04 +0000)
git-svn-id: https://svn.dealii.org/trunk@1360 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/logstream.h
deal.II/base/include/base/tensor.h
deal.II/base/include/base/tensor_base.h

index 90e94dd4cd91175f551f5d5ec191f10584fd9f47..3eeb490e18fc3c549f7e664571f03309854b0272 100644 (file)
@@ -211,9 +211,14 @@ LogStream::push (const string& text)
 
 
 
+// sorry for the weird following declaration spanning 5 lines, but
+// doc++ gets confused if we be more compact :-(
+
 template <class T>
-inline LogStream&
-LogStream::operator << (const T& t)
+inline
+LogStream &
+LogStream::
+operator<< (const T& t)
 {
                                   // if the previous command was an
                                   // #endl#, print the topmost prefix
index ba626965225d5fb528202d5dd6776b6c6ff2515e..04e12a164d9e567850524b8f4e22f05bf6f4d777 100644 (file)
@@ -134,7 +134,7 @@ class Tensor //<rank_, dim>
                                     /**
                                      * Fill a vector with all tensor elements.
                                      *
-                                     * Thsi function unrolls all
+                                     * This function unrolls all
                                      * tensor entries into a single,
                                      * linearly numbered vector. As
                                      * usual in C++, the rightmost
@@ -180,6 +180,9 @@ class Tensor //<rank_, dim>
 
 
 /*--------------------------- Inline functions -----------------------------*/
+// in the following, declarations of operators look rather weird because they are
+// split over several lines. this is necessary, however, because otherwise doc++
+// gets really confused about this all... :-(
 
 
 template <int rank_, int dim>
@@ -205,7 +208,8 @@ Tensor<rank_,dim>::Tensor (const array_type &initializer) {
 template <int rank_, int dim>
 inline
 Tensor<rank_-1,dim> &
-Tensor<rank_,dim>::operator[] (const unsigned int i) {
+Tensor<rank_,dim>::
+operator[] (const unsigned int i) {
   Assert (i<dim, ExcInvalidIndex(i));
   
   return subtensor[i];
@@ -216,7 +220,8 @@ Tensor<rank_,dim>::operator[] (const unsigned int i) {
 template <int rank_, int dim>
 inline
 const Tensor<rank_-1,dim> &
-Tensor<rank_,dim>::operator[] (const unsigned int i) const {
+Tensor<rank_,dim>::
+operator[] (const unsigned int i) const {
   Assert (i<dim, ExcInvalidIndex(i));
   
   return subtensor[i];
@@ -226,7 +231,9 @@ Tensor<rank_,dim>::operator[] (const unsigned int i) const {
 
 template <int rank_, int dim>
 inline
-Tensor<rank_,dim> & Tensor<rank_,dim>::operator = (const Tensor<rank_,dim> &t) {
+Tensor<rank_,dim> &
+Tensor<rank_,dim>::
+operator = (const Tensor<rank_,dim> &t) {
   for (unsigned int i=0; i<dim; ++i)
     subtensor[i] = t.subtensor[i];
   return *this;
@@ -236,7 +243,9 @@ Tensor<rank_,dim> & Tensor<rank_,dim>::operator = (const Tensor<rank_,dim> &t) {
 
 template <int rank_, int dim>
 inline
-bool Tensor<rank_,dim>::operator == (const Tensor<rank_,dim> &p) const {
+bool
+Tensor<rank_,dim>::
+operator == (const Tensor<rank_,dim> &p) const {
   for (unsigned int i=0; i<dim; ++i)
     if (subtensor[i] != p.subtensor[i]) return false;
   return true;
@@ -246,7 +255,9 @@ bool Tensor<rank_,dim>::operator == (const Tensor<rank_,dim> &p) const {
 
 template <int rank_, int dim>
 inline
-bool Tensor<rank_,dim>::operator != (const Tensor<rank_,dim> &p) const {
+bool
+Tensor<rank_,dim>::
+operator != (const Tensor<rank_,dim> &p) const {
   return !((*this) == p);
 };
 
@@ -254,7 +265,9 @@ bool Tensor<rank_,dim>::operator != (const Tensor<rank_,dim> &p) const {
 
 template <int rank_, int dim>
 inline
-Tensor<rank_,dim> & Tensor<rank_,dim>::operator += (const Tensor<rank_,dim> &p) {
+Tensor<rank_,dim> &
+Tensor<rank_,dim>::
+operator += (const Tensor<rank_,dim> &p) {
   for (unsigned int i=0; i<dim; ++i)
     subtensor[i] += p.subtensor[i];
   return *this;
@@ -264,7 +277,9 @@ Tensor<rank_,dim> & Tensor<rank_,dim>::operator += (const Tensor<rank_,dim> &p)
 
 template <int rank_, int dim>
 inline
-Tensor<rank_,dim> & Tensor<rank_,dim>::operator -= (const Tensor<rank_,dim> &p) {
+Tensor<rank_,dim> &
+Tensor<rank_,dim>::
+operator -= (const Tensor<rank_,dim> &p) {
   for (unsigned int i=0; i<dim; ++i)
     subtensor[i] -= p.subtensor[i];
   return *this;
@@ -274,7 +289,9 @@ Tensor<rank_,dim> & Tensor<rank_,dim>::operator -= (const Tensor<rank_,dim> &p)
 
 template <int rank_, int dim>
 inline
-Tensor<rank_,dim> & Tensor<rank_,dim>::operator *= (const double &s) {
+Tensor<rank_,dim> &
+Tensor<rank_,dim>::
+operator *= (const double &s) {
   for (unsigned int i=0; i<dim; ++i)
     subtensor[i] *= s;
   return *this;
@@ -284,7 +301,9 @@ Tensor<rank_,dim> & Tensor<rank_,dim>::operator *= (const double &s) {
 
 template <int rank_, int dim>
 inline
-Tensor<rank_,dim> & Tensor<rank_,dim>::operator /= (const double &s) {
+Tensor<rank_,dim> &
+Tensor<rank_,dim>::
+operator /= (const double &s) {
   for (unsigned int i=0; i<dim; ++i)
     subtensor[i] /= s;
   return *this;
@@ -295,7 +314,8 @@ Tensor<rank_,dim> & Tensor<rank_,dim>::operator /= (const double &s) {
 template <int rank_, int dim>
 inline
 Tensor<rank_,dim>
-Tensor<rank_,dim>::operator + (const Tensor<rank_,dim> &t) const {
+Tensor<rank_,dim>::
+operator + (const Tensor<rank_,dim> &t) const {
   Tensor<rank_,dim> tmp(*this);
   
   for (unsigned int i=0; i<dim; ++i)
@@ -309,7 +329,8 @@ Tensor<rank_,dim>::operator + (const Tensor<rank_,dim> &t) const {
 template <int rank_, int dim>
 inline
 Tensor<rank_,dim>
-Tensor<rank_,dim>::operator - (const Tensor<rank_,dim> &t) const {
+Tensor<rank_,dim>::
+operator - (const Tensor<rank_,dim> &t) const {
   Tensor<rank_,dim> tmp(*this);
   
   for (unsigned int i=0; i<dim; ++i)
index d253ac37e72002bbe413cc42dc67de6524fa5c3b..61ca6bd0c460a19585dae44bcc85f486adc595d2 100644 (file)
@@ -219,6 +219,10 @@ ostream & operator << (ostream &out, const Tensor<1,dim> &p);
 
 
 /*------------------------------- Inline functions: Tensor ---------------------------*/
+// in the following, declarations of operators look rather weird because they are
+// split over several lines. this is necessary, however, because otherwise doc++
+// gets really confused about this all... :-(
+
 
 
 template <int dim>
@@ -253,7 +257,8 @@ Tensor<1,dim>::Tensor (const Tensor<1,dim> &p) {
 
 template <int dim>
 inline
-double Tensor<1,dim>::operator [] (const unsigned int index) const {
+double Tensor<1,dim>::
+operator [] (const unsigned int index) const {
   Assert (index<dim, ExcInvalidIndex (index));
   return values[index];
 };
@@ -262,7 +267,8 @@ double Tensor<1,dim>::operator [] (const unsigned int index) const {
 
 template <int dim>
 inline
-double & Tensor<1,dim>::operator [] (const unsigned int index) {
+double & Tensor<1,dim>::
+operator [] (const unsigned int index) {
   Assert (index<dim, ExcInvalidIndex (index));
   return values[index];
 };
@@ -271,7 +277,8 @@ double & Tensor<1,dim>::operator [] (const unsigned int index) {
 
 template <int dim>
 inline
-Tensor<1,dim> & Tensor<1,dim>::operator = (const Tensor<1,dim> &p) {
+Tensor<1,dim> & Tensor<1,dim>::
+operator = (const Tensor<1,dim> &p) {
   for (unsigned int i=0; i<dim; ++i)
     values[i] = p.values[i];
   return *this;
@@ -281,7 +288,8 @@ Tensor<1,dim> & Tensor<1,dim>::operator = (const Tensor<1,dim> &p) {
 
 template <int dim>
 inline
-bool Tensor<1,dim>::operator == (const Tensor<1,dim> &p) const {
+bool Tensor<1,dim>::
+operator == (const Tensor<1,dim> &p) const {
   for (unsigned int i=0; i<dim; ++i)
     if (values[i] != p.values[i]) return false;
   return true;
@@ -291,7 +299,8 @@ bool Tensor<1,dim>::operator == (const Tensor<1,dim> &p) const {
 
 template <int dim>
 inline
-bool Tensor<1,dim>::operator != (const Tensor<1,dim> &p) const {
+bool Tensor<1,dim>::
+operator != (const Tensor<1,dim> &p) const {
   return !((*this) == p);
 };
 
@@ -299,7 +308,8 @@ bool Tensor<1,dim>::operator != (const Tensor<1,dim> &p) const {
 
 template <int dim>
 inline
-Tensor<1,dim> & Tensor<1,dim>::operator += (const Tensor<1,dim> &p) {
+Tensor<1,dim> & Tensor<1,dim>::
+operator += (const Tensor<1,dim> &p) {
   for (unsigned int i=0; i<dim; ++i)
     values[i] += p.values[i];
   return *this;
@@ -309,7 +319,8 @@ Tensor<1,dim> & Tensor<1,dim>::operator += (const Tensor<1,dim> &p) {
 
 template <int dim>
 inline
-Tensor<1,dim> & Tensor<1,dim>::operator -= (const Tensor<1,dim> &p) {
+Tensor<1,dim> & Tensor<1,dim>::
+operator -= (const Tensor<1,dim> &p) {
   for (unsigned int i=0; i<dim; ++i)
     values[i] -= p.values[i];
   return *this;
@@ -319,7 +330,8 @@ Tensor<1,dim> & Tensor<1,dim>::operator -= (const Tensor<1,dim> &p) {
 
 template <int dim>
 inline
-Tensor<1,dim> & Tensor<1,dim>::operator *= (const double &s) {
+Tensor<1,dim> & Tensor<1,dim>::
+operator *= (const double &s) {
   for (unsigned int i=0; i<dim; ++i)
     values[i] *= s;
   return *this;
@@ -329,7 +341,8 @@ Tensor<1,dim> & Tensor<1,dim>::operator *= (const double &s) {
 
 template <int dim>
 inline
-Tensor<1,dim> & Tensor<1,dim>::operator /= (const double &s) {
+Tensor<1,dim> & Tensor<1,dim>::
+operator /= (const double &s) {
   for (unsigned int i=0; i<dim; ++i)
     values[i] /= s;
   return *this;
@@ -339,7 +352,8 @@ Tensor<1,dim> & Tensor<1,dim>::operator /= (const double &s) {
 
 template <int dim>
 inline
-double Tensor<1,dim>::operator * (const Tensor<1,dim> &p) const {
+double Tensor<1,dim>::
+operator * (const Tensor<1,dim> &p) const {
   double q=0;
   for (unsigned int i=0; i<dim; ++i)
     q += values[i] * p.values[i];
@@ -350,7 +364,8 @@ double Tensor<1,dim>::operator * (const Tensor<1,dim> &p) const {
 
 template <int dim>
 inline
-Tensor<1,dim> Tensor<1,dim>::operator + (const Tensor<1,dim> &p) const {
+Tensor<1,dim> Tensor<1,dim>::
+operator + (const Tensor<1,dim> &p) const {
   return (Tensor<1,dim>(*this) += p);
 };
 
@@ -358,7 +373,8 @@ Tensor<1,dim> Tensor<1,dim>::operator + (const Tensor<1,dim> &p) const {
 
 template <int dim>
 inline
-Tensor<1,dim> Tensor<1,dim>::operator - (const Tensor<1,dim> &p) const {
+Tensor<1,dim> Tensor<1,dim>::
+operator - (const Tensor<1,dim> &p) const {
   return (Tensor<1,dim>(*this) -= p);
 };
 

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.