ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/group/trunk/OOPSE-4/src/math/SquareMatrix.hpp
(Generate patch)

Comparing trunk/OOPSE-4/src/math/SquareMatrix.hpp (file contents):
Revision 1616 by tim, Wed Oct 20 18:07:08 2004 UTC vs.
Revision 1930 by gezelter, Wed Jan 12 22:41:40 2005 UTC

# Line 1 | Line 1
1 < /*
2 < * Copyright (C) 2000-2004  Object Oriented Parallel Simulation Engine (OOPSE) project
3 < *
4 < * Contact: oopse@oopse.org
5 < *
6 < * This program is free software; you can redistribute it and/or
7 < * modify it under the terms of the GNU Lesser General Public License
8 < * as published by the Free Software Foundation; either version 2.1
9 < * of the License, or (at your option) any later version.
10 < * All we ask is that proper credit is given for our work, which includes
11 < * - but is not limited to - adding the above copyright notice to the beginning
12 < * of your source code files, and to any copyright notice that you may distribute
13 < * with programs based on this work.
14 < *
15 < * This program is distributed in the hope that it will be useful,
16 < * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 < * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 < * GNU Lesser General Public License for more details.
19 < *
20 < * You should have received a copy of the GNU Lesser General Public License
21 < * along with this program; if not, write to the Free Software
22 < * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
1 > /*
2 > * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3   *
4 + * The University of Notre Dame grants you ("Licensee") a
5 + * non-exclusive, royalty free, license to use, modify and
6 + * redistribute this software in source and binary code form, provided
7 + * that the following conditions are met:
8 + *
9 + * 1. Acknowledgement of the program authors must be made in any
10 + *    publication of scientific results based in part on use of the
11 + *    program.  An acceptable form of acknowledgement is citation of
12 + *    the article in which the program was described (Matthew
13 + *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14 + *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15 + *    Parallel Simulation Engine for Molecular Dynamics,"
16 + *    J. Comput. Chem. 26, pp. 252-271 (2005))
17 + *
18 + * 2. Redistributions of source code must retain the above copyright
19 + *    notice, this list of conditions and the following disclaimer.
20 + *
21 + * 3. Redistributions in binary form must reproduce the above copyright
22 + *    notice, this list of conditions and the following disclaimer in the
23 + *    documentation and/or other materials provided with the
24 + *    distribution.
25 + *
26 + * This software is provided "AS IS," without a warranty of any
27 + * kind. All express or implied conditions, representations and
28 + * warranties, including any implied warranty of merchantability,
29 + * fitness for a particular purpose or non-infringement, are hereby
30 + * excluded.  The University of Notre Dame and its licensors shall not
31 + * be liable for any damages suffered by licensee as a result of
32 + * using, modifying or distributing the software or its
33 + * derivatives. In no event will the University of Notre Dame or its
34 + * licensors be liable for any lost revenue, profit or data, or for
35 + * direct, indirect, special, consequential, incidental or punitive
36 + * damages, however caused and regardless of the theory of liability,
37 + * arising out of the use of or inability to use software, even if the
38 + * University of Notre Dame has been advised of the possibility of
39 + * such damages.
40   */
41 <
41 >
42   /**
43   * @file SquareMatrix.hpp
44   * @author Teng Lin
# Line 45 | Line 61 | namespace oopse {
61      template<typename Real, int Dim>
62      class SquareMatrix : public RectMatrix<Real, Dim, Dim> {
63          public:
64 +            typedef Real ElemType;
65 +            typedef Real* ElemPoinerType;
66  
67 <        /** default constructor */
68 <        SquareMatrix() {
69 <            for (unsigned int i = 0; i < Dim; i++)
70 <                for (unsigned int j = 0; j < Dim; j++)
71 <                    data_[i][j] = 0.0;
72 <         }
67 >            /** default constructor */
68 >            SquareMatrix() {
69 >                for (unsigned int i = 0; i < Dim; i++)
70 >                    for (unsigned int j = 0; j < Dim; j++)
71 >                        data_[i][j] = 0.0;
72 >             }
73  
74 <        /** copy constructor */
75 <        SquareMatrix(const RectMatrix<Real, Dim, Dim>& m)  : RectMatrix<Real, Dim, Dim>(m) {
76 <        }
59 <        
60 <        /** copy assignment operator */
61 <        SquareMatrix<Real, Dim>& operator =(const RectMatrix<Real, Dim, Dim>& m) {
62 <            RectMatrix<Real, Dim, Dim>::operator=(m);
63 <            return *this;
64 <        }
65 <                              
66 <        /** Retunrs  an identity matrix*/
74 >            /** Constructs and initializes every element of this matrix to a scalar */
75 >            SquareMatrix(Real s) : RectMatrix<Real, Dim, Dim>(s){
76 >            }
77  
78 <       static SquareMatrix<Real, Dim> identity() {
79 <            SquareMatrix<Real, Dim> m;
78 >            /** Constructs and initializes from an array */
79 >            SquareMatrix(Real* array) : RectMatrix<Real, Dim, Dim>(array){
80 >            }
81 >
82 >
83 >            /** copy constructor */
84 >            SquareMatrix(const RectMatrix<Real, Dim, Dim>& m) : RectMatrix<Real, Dim, Dim>(m) {
85 >            }
86              
87 <            for (unsigned int i = 0; i < Dim; i++)
88 <                for (unsigned int j = 0; j < Dim; j++)
89 <                    if (i == j)
90 <                        m(i, j) = 1.0;
91 <                    else
92 <                        m(i, j) = 0.0;
87 >            /** copy assignment operator */
88 >            SquareMatrix<Real, Dim>& operator =(const RectMatrix<Real, Dim, Dim>& m) {
89 >                RectMatrix<Real, Dim, Dim>::operator=(m);
90 >                return *this;
91 >            }
92 >                                  
93 >            /** Retunrs  an identity matrix*/
94  
95 <            return m;
96 <        }
95 >           static SquareMatrix<Real, Dim> identity() {
96 >                SquareMatrix<Real, Dim> m;
97 >                
98 >                for (unsigned int i = 0; i < Dim; i++)
99 >                    for (unsigned int j = 0; j < Dim; j++)
100 >                        if (i == j)
101 >                            m(i, j) = 1.0;
102 >                        else
103 >                            m(i, j) = 0.0;
104  
105 <        /**
106 <         * Retunrs  the inversion of this matrix.
83 <         * @todo need implementation
84 <         */
85 <         SquareMatrix<Real, Dim>  inverse() {
86 <             SquareMatrix<Real, Dim> result;
105 >                return m;
106 >            }
107  
108 <             return result;
109 <        }        
108 >            /**
109 >             * Retunrs  the inversion of this matrix.
110 >             * @todo need implementation
111 >             */
112 >             SquareMatrix<Real, Dim>  inverse() {
113 >                 SquareMatrix<Real, Dim> result;
114  
115 <        /**
116 <         * Returns the determinant of this matrix.
93 <         * @todo need implementation
94 <         */
95 <        Real determinant() const {
96 <            Real det;
97 <            return det;
98 <        }
115 >                 return result;
116 >            }        
117  
118 <        /** Returns the trace of this matrix. */
119 <        Real trace() const {
120 <           Real tmp = 0;
121 <          
122 <            for (unsigned int i = 0; i < Dim ; i++)
123 <                tmp += data_[i][i];
118 >            /**
119 >             * Returns the determinant of this matrix.
120 >             * @todo need implementation
121 >             */
122 >            Real determinant() const {
123 >                Real det;
124 >                return det;
125 >            }
126  
127 <            return tmp;
128 <        }
127 >            /** Returns the trace of this matrix. */
128 >            Real trace() const {
129 >               Real tmp = 0;
130 >              
131 >                for (unsigned int i = 0; i < Dim ; i++)
132 >                    tmp += data_[i][i];
133  
134 <        /** Tests if this matrix is symmetrix. */            
135 <        bool isSymmetric() const {
112 <            for (unsigned int i = 0; i < Dim - 1; i++)
113 <                for (unsigned int j = i; j < Dim; j++)
114 <                    if (fabs(data_[i][j] - data_[j][i]) > oopse::epsilon)
115 <                        return false;
116 <                    
117 <            return true;
118 <        }
134 >                return tmp;
135 >            }
136  
137 <        /** Tests if this matrix is orthogonal. */            
138 <        bool isOrthogonal() {
139 <            SquareMatrix<Real, Dim> tmp;
137 >            /** Tests if this matrix is symmetrix. */            
138 >            bool isSymmetric() const {
139 >                for (unsigned int i = 0; i < Dim - 1; i++)
140 >                    for (unsigned int j = i; j < Dim; j++)
141 >                        if (fabs(data_[i][j] - data_[j][i]) > oopse::epsilon)
142 >                            return false;
143 >                        
144 >                return true;
145 >            }
146  
147 <            tmp = *this * transpose();
147 >            /** Tests if this matrix is orthogonal. */            
148 >            bool isOrthogonal() {
149 >                SquareMatrix<Real, Dim> tmp;
150  
151 <            return tmp.isDiagonal();
127 <        }
151 >                tmp = *this * transpose();
152  
153 <        /** Tests if this matrix is diagonal. */
154 <        bool isDiagonal() const {
131 <            for (unsigned int i = 0; i < Dim ; i++)
132 <                for (unsigned int j = 0; j < Dim; j++)
133 <                    if (i !=j && fabs(data_[i][j]) > oopse::epsilon)
134 <                        return false;
135 <                    
136 <            return true;
137 <        }
153 >                return tmp.isDiagonal();
154 >            }
155  
156 <        /** Tests if this matrix is the unit matrix. */
157 <        bool isUnitMatrix() const {
158 <            if (!isDiagonal())
159 <                return false;
160 <            
161 <            for (unsigned int i = 0; i < Dim ; i++)
162 <                if (fabs(data_[i][i] - 1) > oopse::epsilon)
156 >            /** Tests if this matrix is diagonal. */
157 >            bool isDiagonal() const {
158 >                for (unsigned int i = 0; i < Dim ; i++)
159 >                    for (unsigned int j = 0; j < Dim; j++)
160 >                        if (i !=j && fabs(data_[i][j]) > oopse::epsilon)
161 >                            return false;
162 >                        
163 >                return true;
164 >            }
165 >
166 >            /** Tests if this matrix is the unit matrix. */
167 >            bool isUnitMatrix() const {
168 >                if (!isDiagonal())
169                      return false;
170                  
171 <            return true;
172 <        }        
171 >                for (unsigned int i = 0; i < Dim ; i++)
172 >                    if (fabs(data_[i][i] - 1) > oopse::epsilon)
173 >                        return false;
174 >                    
175 >                return true;
176 >            }        
177  
178 <        /** @todo need implementation */
179 <        void diagonalize() {
180 <            //jacobi(m, eigenValues, ortMat);
181 <        }
178 >            /** @todo need implementation */
179 >            void diagonalize() {
180 >                //jacobi(m, eigenValues, ortMat);
181 >            }
182  
183 <        /**
184 <         * Jacobi iteration routines for computing eigenvalues/eigenvectors of
185 <         * real symmetric matrix
186 <         *
187 <         * @return true if success, otherwise return false
188 <         * @param a symmetric matrix whose eigenvectors are to be computed. On return, the matrix is
189 <         *     overwritten
190 <         * @param w will contain the eigenvalues of the matrix On return of this function
191 <         * @param v the columns of this matrix will contain the eigenvectors. The eigenvectors are
192 <         *    normalized and mutually orthogonal.
193 <         */
194 <      
195 <        static int jacobi(SquareMatrix<Real, Dim>& a, Vector<Real, Dim>& d,
196 <                              SquareMatrix<Real, Dim>& v);
183 >            /**
184 >             * Jacobi iteration routines for computing eigenvalues/eigenvectors of
185 >             * real symmetric matrix
186 >             *
187 >             * @return true if success, otherwise return false
188 >             * @param a symmetric matrix whose eigenvectors are to be computed. On return, the matrix is
189 >             *     overwritten
190 >             * @param w will contain the eigenvalues of the matrix On return of this function
191 >             * @param v the columns of this matrix will contain the eigenvectors. The eigenvectors are
192 >             *    normalized and mutually orthogonal.
193 >             */
194 >          
195 >            static int jacobi(SquareMatrix<Real, Dim>& a, Vector<Real, Dim>& d,
196 >                                  SquareMatrix<Real, Dim>& v);
197      };//end SquareMatrix
198  
199  
# Line 197 | Line 224 | namespace oopse {
224      // normalized.
225      template<typename Real, int Dim>
226      int SquareMatrix<Real, Dim>::jacobi(SquareMatrix<Real, Dim>& a, Vector<Real, Dim>& w,
227 <                                  SquareMatrix<Real, Dim>& v) {
228 <      const int n = Dim;  
229 <      int i, j, k, iq, ip, numPos;
230 <      Real tresh, theta, tau, t, sm, s, h, g, c, tmp;
231 <      Real bspace[4], zspace[4];
232 <      Real *b = bspace;
233 <      Real *z = zspace;
234 <
235 <      // only allocate memory if the matrix is large
236 <      if (n > 4)
237 <        {
238 <        b = new Real[n];
212 <        z = new Real[n];
227 >                                        SquareMatrix<Real, Dim>& v) {
228 >        const int n = Dim;  
229 >        int i, j, k, iq, ip, numPos;
230 >        Real tresh, theta, tau, t, sm, s, h, g, c, tmp;
231 >        Real bspace[4], zspace[4];
232 >        Real *b = bspace;
233 >        Real *z = zspace;
234 >
235 >        // only allocate memory if the matrix is large
236 >        if (n > 4) {
237 >            b = new Real[n];
238 >            z = new Real[n];
239          }
240  
241 <      // initialize
242 <      for (ip=0; ip<n; ip++)
243 <        {
244 <        for (iq=0; iq<n; iq++)
245 <          {
246 <          v(ip, iq) = 0.0;
221 <          }
222 <        v(ip, ip) = 1.0;
241 >        // initialize
242 >        for (ip=0; ip<n; ip++) {
243 >            for (iq=0; iq<n; iq++) {
244 >                v(ip, iq) = 0.0;
245 >            }
246 >            v(ip, ip) = 1.0;
247          }
248 <      for (ip=0; ip<n; ip++)
249 <        {
250 <        b[ip] = w[ip] = a(ip, ip);
227 <        z[ip] = 0.0;
248 >        for (ip=0; ip<n; ip++) {
249 >            b[ip] = w[ip] = a(ip, ip);
250 >            z[ip] = 0.0;
251          }
252  
253 <      // begin rotation sequence
254 <      for (i=0; i<VTK_MAX_ROTATIONS; i++)
255 <        {
256 <        sm = 0.0;
257 <        for (ip=0; ip<n-1; ip++)
258 <          {
259 <          for (iq=ip+1; iq<n; iq++)
237 <            {
238 <            sm += fabs(a(ip, iq));
253 >        // begin rotation sequence
254 >        for (i=0; i<VTK_MAX_ROTATIONS; i++) {
255 >            sm = 0.0;
256 >            for (ip=0; ip<n-1; ip++) {
257 >                for (iq=ip+1; iq<n; iq++) {
258 >                    sm += fabs(a(ip, iq));
259 >                }
260              }
261 <          }
262 <        if (sm == 0.0)
263 <          {
243 <          break;
244 <          }
261 >            if (sm == 0.0) {
262 >                break;
263 >            }
264  
265 <        if (i < 3)                                // first 3 sweeps
266 <          {
267 <          tresh = 0.2*sm/(n*n);
268 <          }
269 <        else
251 <          {
252 <          tresh = 0.0;
253 <          }
265 >            if (i < 3) {                                // first 3 sweeps
266 >                tresh = 0.2*sm/(n*n);
267 >            } else {
268 >                tresh = 0.0;
269 >            }
270  
271 <        for (ip=0; ip<n-1; ip++)
272 <          {
273 <          for (iq=ip+1; iq<n; iq++)
258 <            {
259 <            g = 100.0*fabs(a(ip, iq));
271 >            for (ip=0; ip<n-1; ip++) {
272 >                for (iq=ip+1; iq<n; iq++) {
273 >                    g = 100.0*fabs(a(ip, iq));
274  
275 <            // after 4 sweeps
276 <            if (i > 3 && (fabs(w[ip])+g) == fabs(w[ip])
277 <            && (fabs(w[iq])+g) == fabs(w[iq]))
278 <              {
279 <              a(ip, iq) = 0.0;
280 <              }
281 <            else if (fabs(a(ip, iq)) > tresh)
282 <              {
283 <              h = w[iq] - w[ip];
284 <              if ( (fabs(h)+g) == fabs(h))
285 <                {
286 <                t = (a(ip, iq)) / h;
287 <                }
288 <              else
289 <                {
290 <                theta = 0.5*h / (a(ip, iq));
291 <                t = 1.0 / (fabs(theta)+sqrt(1.0+theta*theta));
292 <                if (theta < 0.0)
293 <                  {
294 <                  t = -t;
295 <                  }
296 <                }
297 <              c = 1.0 / sqrt(1+t*t);
298 <              s = t*c;
285 <              tau = s/(1.0+c);
286 <              h = t*a(ip, iq);
287 <              z[ip] -= h;
288 <              z[iq] += h;
289 <              w[ip] -= h;
290 <              w[iq] += h;
291 <              a(ip, iq)=0.0;
275 >                    // after 4 sweeps
276 >                    if (i > 3 && (fabs(w[ip])+g) == fabs(w[ip])
277 >                        && (fabs(w[iq])+g) == fabs(w[iq])) {
278 >                        a(ip, iq) = 0.0;
279 >                    } else if (fabs(a(ip, iq)) > tresh) {
280 >                        h = w[iq] - w[ip];
281 >                        if ( (fabs(h)+g) == fabs(h)) {
282 >                            t = (a(ip, iq)) / h;
283 >                        } else {
284 >                            theta = 0.5*h / (a(ip, iq));
285 >                            t = 1.0 / (fabs(theta)+sqrt(1.0+theta*theta));
286 >                            if (theta < 0.0) {
287 >                                t = -t;
288 >                            }
289 >                        }
290 >                        c = 1.0 / sqrt(1+t*t);
291 >                        s = t*c;
292 >                        tau = s/(1.0+c);
293 >                        h = t*a(ip, iq);
294 >                        z[ip] -= h;
295 >                        z[iq] += h;
296 >                        w[ip] -= h;
297 >                        w[iq] += h;
298 >                        a(ip, iq)=0.0;
299  
300 <              // ip already shifted left by 1 unit
301 <              for (j = 0;j <= ip-1;j++)
302 <                {
303 <                VTK_ROTATE(a,j,ip,j,iq);
300 >                        // ip already shifted left by 1 unit
301 >                        for (j = 0;j <= ip-1;j++) {
302 >                            VTK_ROTATE(a,j,ip,j,iq);
303 >                        }
304 >                        // ip and iq already shifted left by 1 unit
305 >                        for (j = ip+1;j <= iq-1;j++) {
306 >                            VTK_ROTATE(a,ip,j,j,iq);
307 >                        }
308 >                        // iq already shifted left by 1 unit
309 >                        for (j=iq+1; j<n; j++) {
310 >                            VTK_ROTATE(a,ip,j,iq,j);
311 >                        }
312 >                        for (j=0; j<n; j++) {
313 >                            VTK_ROTATE(v,j,ip,j,iq);
314 >                        }
315 >                    }
316                  }
298 –              // ip and iq already shifted left by 1 unit
299 –              for (j = ip+1;j <= iq-1;j++)
300 –                {
301 –                VTK_ROTATE(a,ip,j,j,iq);
302 –                }
303 –              // iq already shifted left by 1 unit
304 –              for (j=iq+1; j<n; j++)
305 –                {
306 –                VTK_ROTATE(a,ip,j,iq,j);
307 –                }
308 –              for (j=0; j<n; j++)
309 –                {
310 –                VTK_ROTATE(v,j,ip,j,iq);
311 –                }
312 –              }
317              }
314 –          }
318  
319 <        for (ip=0; ip<n; ip++)
320 <          {
321 <          b[ip] += z[ip];
322 <          w[ip] = b[ip];
323 <          z[ip] = 0.0;
321 <          }
319 >            for (ip=0; ip<n; ip++) {
320 >                b[ip] += z[ip];
321 >                w[ip] = b[ip];
322 >                z[ip] = 0.0;
323 >            }
324          }
325  
326 <      //// this is NEVER called
327 <      if ( i >= VTK_MAX_ROTATIONS )
328 <        {
329 <           std::cout << "vtkMath::Jacobi: Error extracting eigenfunctions" << std::endl;
328 <           return 0;
326 >        //// this is NEVER called
327 >        if ( i >= VTK_MAX_ROTATIONS ) {
328 >            std::cout << "vtkMath::Jacobi: Error extracting eigenfunctions" << std::endl;
329 >            return 0;
330          }
331  
332 <      // sort eigenfunctions                 these changes do not affect accuracy
333 <      for (j=0; j<n-1; j++)                  // boundary incorrect
334 <        {
334 <        k = j;
335 <        tmp = w[k];
336 <        for (i=j+1; i<n; i++)                // boundary incorrect, shifted already
337 <          {
338 <          if (w[i] >= tmp)                   // why exchage if same?
339 <            {
340 <            k = i;
332 >        // sort eigenfunctions                 these changes do not affect accuracy
333 >        for (j=0; j<n-1; j++) {                  // boundary incorrect
334 >            k = j;
335              tmp = w[k];
336 +            for (i=j+1; i<n; i++) {                // boundary incorrect, shifted already
337 +                if (w[i] >= tmp) {                   // why exchage if same?
338 +                    k = i;
339 +                    tmp = w[k];
340 +                }
341              }
342 <          }
343 <        if (k != j)
344 <          {
345 <          w[k] = w[j];
346 <          w[j] = tmp;
347 <          for (i=0; i<n; i++)
348 <            {
349 <            tmp = v(i, j);
351 <            v(i, j) = v(i, k);
352 <            v(i, k) = tmp;
342 >            if (k != j) {
343 >                w[k] = w[j];
344 >                w[j] = tmp;
345 >                for (i=0; i<n; i++) {
346 >                    tmp = v(i, j);
347 >                    v(i, j) = v(i, k);
348 >                    v(i, k) = tmp;
349 >                }
350              }
354 –          }
351          }
352 <      // insure eigenvector consistency (i.e., Jacobi can compute vectors that
353 <      // are negative of one another (.707,.707,0) and (-.707,-.707,0). This can
354 <      // reek havoc in hyperstreamline/other stuff. We will select the most
355 <      // positive eigenvector.
356 <      int ceil_half_n = (n >> 1) + (n & 1);
357 <      for (j=0; j<n; j++)
358 <        {
359 <        for (numPos=0, i=0; i<n; i++)
360 <          {
361 <          if ( v(i, j) >= 0.0 )
366 <            {
367 <            numPos++;
352 >        // insure eigenvector consistency (i.e., Jacobi can compute vectors that
353 >        // are negative of one another (.707,.707,0) and (-.707,-.707,0). This can
354 >        // reek havoc in hyperstreamline/other stuff. We will select the most
355 >        // positive eigenvector.
356 >        int ceil_half_n = (n >> 1) + (n & 1);
357 >        for (j=0; j<n; j++) {
358 >            for (numPos=0, i=0; i<n; i++) {
359 >                if ( v(i, j) >= 0.0 ) {
360 >                    numPos++;
361 >                }
362              }
363 <          }
364 <    //    if ( numPos < ceil(double(n)/double(2.0)) )
365 <        if ( numPos < ceil_half_n)
366 <          {
367 <          for(i=0; i<n; i++)
374 <            {
375 <            v(i, j) *= -1.0;
363 >            //    if ( numPos < ceil(double(n)/double(2.0)) )
364 >            if ( numPos < ceil_half_n) {
365 >                for (i=0; i<n; i++) {
366 >                    v(i, j) *= -1.0;
367 >                }
368              }
377 –          }
369          }
370  
371 <      if (n > 4)
372 <        {
373 <        delete [] b;
383 <        delete [] z;
371 >        if (n > 4) {
372 >            delete [] b;
373 >            delete [] z;
374          }
375 <      return 1;
375 >        return 1;
376      }
377  
378  

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines