source: git/src/matrix.c

/* matrix.c
 * Matrix building and solving routines
 * Copyright (C) 1993-2003,2010,2013 Olly Betts
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

/*#define SOR 1*/

#if 0
# define DEBUG_INVALID 1
#endif

#include <config.h>

#include "debug.h"
#include "cavern.h"
#include "filename.h"
#include "message.h"
#include "netbits.h"
#include "matrix.h"
#include "out.h"

#undef PRINT_MATRICES
#define PRINT_MATRICES 0

#undef DEBUG_MATRIX_BUILD
#define DEBUG_MATRIX_BUILD 0

#undef DEBUG_MATRIX
#define DEBUG_MATRIX 0

#if PRINT_MATRICES
static void print_matrix(real *M, real *B, long n);
#endif

static void choleski(real *M, real *B, long n);

#ifdef SOR
static void sor(real *M, real *B, long n);
#endif

/* for M(row, col) col must be <= row, so Y <= X */
# define M(X, Y) ((real *)M)[((((OSSIZE_T)(X)) * ((X) + 1)) >> 1) + (Y)]
              /* +(Y>X?0*printf("row<col (line %d)\n",__LINE__):0) */
/*#define M_(X, Y) ((real *)M)[((((OSSIZE_T)(Y)) * ((Y) + 1)) >> 1) + (X)]*/

static int find_stn_in_tab(node *stn);
static int add_stn_to_tab(node *stn);
static void build_matrix(node *list);

static long n_stn_tab;

static pos **stn_tab;

extern void
solve_matrix(node *list)
{
   node *stn;
   long n = 0;
   FOR_EACH_STN(stn, list) {
      if (!fixed(stn)) n++;
   }
   if (n == 0) return;

   /* we just need n to be a reasonable estimate >= the number
    * of stations left after reduction. If memory is
    * plentiful, we can be crass.
    */
   stn_tab = osmalloc((OSSIZE_T)(n * ossizeof(pos*)));
   n_stn_tab = 0;

   FOR_EACH_STN(stn, list) {
      if (!fixed(stn)) add_stn_to_tab(stn);
   }

   if (n_stn_tab < n) {
      /* release unused entries in stn_tab */
      stn_tab = osrealloc(stn_tab, n_stn_tab * ossizeof(pos*));
   }

   build_matrix(list);
#if DEBUG_MATRIX
   FOR_EACH_STN(stn, list) {
      printf("(%8.2f, %8.2f, %8.2f ) ", POS(stn, 0), POS(stn, 1), POS(stn, 2));
      print_prefix(stn->name);
      putnl();
   }
#endif

   osfree(stn_tab);
}

#ifdef NO_COVARIANCES
# define FACTOR 1
#else
# define FACTOR 3
#endif

static void
build_matrix(node *list)
{
   real *M;
   real *B;
   int dim;

   if (n_stn_tab == 0) {
      if (!fQuiet)
         puts(msg(/*Network solved by reduction - no simultaneous equations to solve.*/74));
      return;
   }
   /* (OSSIZE_T) cast may be needed if n_stn_tab>=181 */
   M = osmalloc((OSSIZE_T)((((OSSIZE_T)n_stn_tab * FACTOR * (n_stn_tab * FACTOR + 1)) >> 1)) * ossizeof(real));
   B = osmalloc((OSSIZE_T)(n_stn_tab * FACTOR * ossizeof(real)));

   if (!fQuiet) {
      if (n_stn_tab == 1)
         out_current_action(msg(/*Solving one equation*/78));
      else
         out_current_action1(msg(/*Solving %d simultaneous equations*/75), n_stn_tab);
   }

#ifdef NO_COVARIANCES
   dim = 2;
#else
   dim = 0; /* fudge next loop for now */
#endif
   for ( ; dim >= 0; dim--) {
      node *stn;
      int row;

      /* Initialise M and B to zero - zeroing "linearly" will minimise
       * paging when the matrix is large */
      {
         int end = n_stn_tab * FACTOR;
         for (row = 0; row < end; row++) B[row] = (real)0.0;
         end = ((OSSIZE_T)n_stn_tab * FACTOR * (n_stn_tab * FACTOR + 1)) >> 1;
         for (row = 0; row < end; row++) M[row] = (real)0.0;
      }

      /* Construct matrix - Go thru' stn list & add all forward legs between
       * two unfixed stations to M (so each leg goes on exactly once).
       *
       * All legs between two fixed stations can be ignored here.
       *
       * All legs between a fixed and an unfixed station are then considered
       * from the unfixed end (if we consider them from the fixed end we'd
       * need to somehow detect when we're at a fixed point cut line and work
       * out which side we're dealing with at this time. */
      FOR_EACH_STN(stn, list) {
#ifdef NO_COVARIANCES
         real e;
#else
         svar e;
         delta a;
#endif
         int f, t;
         int dirn;
#if DEBUG_MATRIX_BUILD
         print_prefix(stn->name);
         printf(" used: %d colour %ld\n",
                (!!stn->leg[2]) << 2 | (!!stn -> leg[1]) << 1 | (!!stn->leg[0]),
                stn->colour);

         for (dirn = 0; dirn <= 2 && stn->leg[dirn]; dirn++) {
#ifdef NO_COVARIANCES
            printf("Leg %d, vx=%f, reverse=%d, to ", dirn,
                   stn->leg[dirn]->v[0], stn->leg[dirn]->l.reverse);
#else
            printf("Leg %d, vx=%f, reverse=%d, to ", dirn,
                   stn->leg[dirn]->v[0][0], stn->leg[dirn]->l.reverse);
#endif
            print_prefix(stn->leg[dirn]->l.to->name);
            putnl();
         }
         putnl();
#endif /* DEBUG_MATRIX_BUILD */

         if (!fixed(stn)) {
            f = find_stn_in_tab(stn);
            for (dirn = 0; dirn <= 2 && stn->leg[dirn]; dirn++) {
               linkfor *leg = stn->leg[dirn];
               node *to = leg->l.to;
               if (fixed(to)) {
                  bool fRev = !data_here(leg);
                  if (fRev) leg = reverse_leg(leg);
                  /* Ignore equated nodes */
#ifdef NO_COVARIANCES
                  e = leg->v[dim];
                  if (e != (real)0.0) {
                     e = ((real)1.0) / e;
                     M(f,f) += e;
                     B[f] += e * POS(to, dim);
                     if (fRev) {
                        B[f] += leg->d[dim];
                     } else {
                        B[f] -= leg->d[dim];
                     }
                  }
#else
                  if (invert_svar(&e, &leg->v)) {
                     delta b;
                     int i;
                     if (fRev) {
                        adddd(&a, &POSD(to), &leg->d);
                     } else {
                        subdd(&a, &POSD(to), &leg->d);
                     }
                     mulsd(&b, &e, &a);
                     for (i = 0; i < 3; i++) {
                        M(f * FACTOR + i, f * FACTOR + i) += e[i];
                        B[f * FACTOR + i] += b[i];
                     }
                     M(f * FACTOR + 1, f * FACTOR) += e[3];
                     M(f * FACTOR + 2, f * FACTOR) += e[4];
                     M(f * FACTOR + 2, f * FACTOR + 1) += e[5];
                  }
#endif
               } else if (data_here(leg)) {
                  /* forward leg, unfixed -> unfixed */
                  t = find_stn_in_tab(to);
#if DEBUG_MATRIX
                  printf("Leg %d to %d, var %f, delta %f\n", f, t, e,
                         leg->d[dim]);
#endif
                  /* Ignore equated nodes & lollipops */
#ifdef NO_COVARIANCES
                  e = leg->v[dim];
                  if (t != f && e != (real)0.0) {
                     real a;
                     e = ((real)1.0) / e;
                     M(f,f) += e;
                     M(t,t) += e;
                     if (f < t) M(t,f) -= e; else M(f,t) -= e;
                     a = e * leg->d[dim];
                     B[f] -= a;
                     B[t] += a;
                  }
#else
                  if (t != f && invert_svar(&e, &leg->v)) {
                     int i;
                     mulsd(&a, &e, &leg->d);
                     for (i = 0; i < 3; i++) {
                        M(f * FACTOR + i, f * FACTOR + i) += e[i];
                        M(t * FACTOR + i, t * FACTOR + i) += e[i];
                        if (f < t)
                           M(t * FACTOR + i, f * FACTOR + i) -= e[i];
                        else
                           M(f * FACTOR + i, t * FACTOR + i) -= e[i];
                        B[f * FACTOR + i] -= a[i];
                        B[t * FACTOR + i] += a[i];
                     }
                     M(f * FACTOR + 1, f * FACTOR) += e[3];
                     M(t * FACTOR + 1, t * FACTOR) += e[3];
                     M(f * FACTOR + 2, f * FACTOR) += e[4];
                     M(t * FACTOR + 2, t * FACTOR) += e[4];
                     M(f * FACTOR + 2, f * FACTOR + 1) += e[5];
                     M(t * FACTOR + 2, t * FACTOR + 1) += e[5];
                     if (f < t) {
                        M(t * FACTOR + 1, f * FACTOR) -= e[3];
                        M(t * FACTOR, f * FACTOR + 1) -= e[3];
                        M(t * FACTOR + 2, f * FACTOR) -= e[4];
                        M(t * FACTOR, f * FACTOR + 2) -= e[4];
                        M(t * FACTOR + 2, f * FACTOR + 1) -= e[5];
                        M(t * FACTOR + 1, f * FACTOR + 2) -= e[5];
                     } else {
                        M(f * FACTOR + 1, t * FACTOR) -= e[3];
                        M(f * FACTOR, t * FACTOR + 1) -= e[3];
                        M(f * FACTOR + 2, t * FACTOR) -= e[4];
                        M(f * FACTOR, t * FACTOR + 2) -= e[4];
                        M(f * FACTOR + 2, t * FACTOR + 1) -= e[5];
                        M(f * FACTOR + 1, t * FACTOR + 2) -= e[5];
                     }
                  }
#endif
               }
            }
         }
      }

#if PRINT_MATRICES
      print_matrix(M, B, n_stn_tab * FACTOR); /* 'ave a look! */
#endif

#ifdef SOR
      /* defined in network.c, may be altered by -z<letters> on command line */
      if (optimize & BITA('i'))
         sor(M, B, n_stn_tab * FACTOR);
      else
#endif
         choleski(M, B, n_stn_tab * FACTOR);

      {
         int m;
         for (m = (int)(n_stn_tab - 1); m >= 0; m--) {
#ifdef NO_COVARIANCES
            stn_tab[m]->p[dim] = B[m];
            if (dim == 0) {
               SVX_ASSERT2(pos_fixed(stn_tab[m]),
                       "setting station coordinates didn't mark pos as fixed");
            }
#else
            int i;
            for (i = 0; i < 3; i++) {
               stn_tab[m]->p[i] = B[m * FACTOR + i];
            }
            SVX_ASSERT2(pos_fixed(stn_tab[m]),
                    "setting station coordinates didn't mark pos as fixed");
#endif
         }
#if EXPLICIT_FIXED_FLAG
         for (m = n_stn_tab - 1; m >= 0; m--) fixpos(stn_tab[m]);
#endif
      }
   }
   osfree(B);
   osfree(M);
}

static int
find_stn_in_tab(node *stn)
{
   int i = 0;
   pos *p = stn->name->pos;
   while (stn_tab[i] != p)
      if (++i == n_stn_tab) {
#if DEBUG_INVALID
         fputs("Station ", stderr);
         fprint_prefix(stderr, stn->name);
         fputs(" not in table\n\n", stderr);
#endif
#if 0
         print_prefix(stn->name);
         printf(" used: %d colour %d\n",
                (!!stn->leg[2])<<2 | (!!stn->leg[1])<<1 | (!!stn->leg[0]),
                stn->colour);
#endif
         fatalerror(/*Bug in program detected! Please report this to the authors*/11);
      }
   return i;
}

static int
add_stn_to_tab(node *stn)
{
   int i;
   pos *p = stn->name->pos;
   for (i = 0; i < n_stn_tab; i++) {
      if (stn_tab[i] == p) return i;
   }
   stn_tab[n_stn_tab++] = p;
   return i;
}

/* Solve MX=B for X by Choleski factorisation - modified Choleski actually
 * since we factor into LDL' while Choleski is just LL'
 */
/* Note M must be symmetric positive definite */
/* routine is entitled to scribble on M and B if it wishes */
static void
choleski(real *M, real *B, long n)
{
   int i, j, k;

   for (j = 1; j < n; j++) {
      real V;
      for (i = 0; i < j; i++) {
         V = (real)0.0;
         for (k = 0; k < i; k++) V += M(i,k) * M(j,k) * M(k,k);
         M(j,i) = (M(j,i) - V) / M(i,i);
      }
      V = (real)0.0;
      for (k = 0; k < j; k++) V += M(j,k) * M(j,k) * M(k,k);
      M(j,j) -= V; /* may be best to add M() last for numerical reasons too */
   }

   /* Multiply x by L inverse */
   for (i = 0; i < n - 1; i++) {
      for (j = i + 1; j < n; j++) {
         B[j] -= M(j,i) * B[i];
      }
   }

   /* Multiply x by D inverse */
   for (i = 0; i < n; i++) {
      B[i] /= M(i,i);
   }

   /* Multiply x by (L transpose) inverse */
   for (i = (int)(n - 1); i > 0; i--) {
      for (j = i - 1; j >= 0; j--) {
         B[j] -= M(i,j) * B[i];
      }
   }

   /* printf("\n%ld/%ld\n\n",flops,flopsTot); */
}

#ifdef SOR
/* factor to use for SOR (must have 1 <= SOR_factor < 2) */
#define SOR_factor 1.93 /* 1.95 */

/* Solve MX=B for X by SOR of Gauss-Siedel */
/* routine is entitled to scribble on M and B if it wishes */
static void
sor(real *M, real *B, long n)
{
   real t, x, delta, threshold, t2;
   int row, col;
   real *X;
   long it = 0;

   X = osmalloc(n * ossizeof(real));

   threshold = 0.00001;

   printf("reciprocating diagonal\n"); /* TRANSLATE */

   /* munge diagonal so we can multiply rather than divide */
   for (row = n - 1; row >= 0; row--) {
      M(row,row) = 1 / M(row,row);
      X[row] = 0;
   }

   printf("starting iteration\n"); /* TRANSLATE */

   do {
      /*printf("*");*/
      it++;
      t = 0.0;
      for (row = 0; row < n; row++) {
         x = B[row];
         for (col = 0; col < row; col++) x -= M(row,col) * X[col];
         for (col++; col < n; col++) x -= M(col,row) * X[col];
         x *= M(row,row);
         delta = (x - X[row]) * SOR_factor;
         X[row] += delta;
         t2 = fabs(delta);
         if (t2 > t) t = t2;
      }
      printf("% 6d: %8.6f\n", it, t);
   } while (t >= threshold && it < 100000);

   if (t >= threshold) {
      fprintf(stderr, "*not* converged after %ld iterations\n", it);
      BUG("iteration stinks");
   }

   printf("%ld iterations\n", it); /* TRANSLATE */

#if 0
   putnl();
   for (row = n - 1; row >= 0; row--) {
      t = 0.0;
      for (col = 0; col < row; col++) t += M(row, col) * X[col];
      t += X[row] / M(row, row);
      for (col = row + 1; col < n; col++)
         t += M(col, row) * X[col];
      printf("[ %f %f ]\n", t, B[row]);
   }
#endif

   for (row = n - 1; row >= 0; row--) B[row] = X[row];

   osfree(X);
   printf("\ndone\n"); /* TRANSLATE */
}
#endif

#if PRINT_MATRICES
static void
print_matrix(real *M, real *B, long n)
{
   long row, col;
   printf("Matrix, M and vector, B:\n");
   for (row = 0; row < n; row++) {
      for (col = 0; col <= row; col++) printf("%6.2f\t", M(row, col));
      for (; col <= n; col++) printf(" \t");
      printf("\t%6.2f\n", B[row]);
   }
   putnl();
   return;
}
#endif