granicus.if.org Git - imagemagick/blob - MagickCore/matrix.c

   1 /*
   2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   3 %                                                                             %
   4 %                                                                             %
   5 %                                                                             %
   6 %                  M   M   AAA   TTTTT  RRRR   IIIII  X   X                   %
   7 %                  MM MM  A   A    T    R   R    I     X X                    %
   8 %                  M M M  AAAAA    T    RRRR     I      X                     %
   9 %                  M   M  A   A    T    R R      I     X X                    %
  10 %                  M   M  A   A    T    R  R   IIIII  X   X                   %
  11 %                                                                             %
  12 %                                                                             %
  13 %                         MagickCore Matrix Methods                           %
  14 %                                                                             %
  15 %                            Software Design                                  %
  16 %                              John Cristy                                    %
  17 %                              August 2007                                    %
  18 %                                                                             %
  19 %                                                                             %
  20 %  Copyright 1999-2011 ImageMagick Studio LLC, a non-profit organization      %
  21 %  dedicated to making software imaging solutions freely available.           %
  22 %                                                                             %
  23 %  You may not use this file except in compliance with the License.  You may  %
  24 %  obtain a copy of the License at                                            %
  25 %                                                                             %
  26 %    http://www.imagemagick.org/script/license.php                            %
  27 %                                                                             %
  28 %  Unless required by applicable law or agreed to in writing, software        %
  29 %  distributed under the License is distributed on an "AS IS" BASIS,          %
  30 %  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   %
  31 %  See the License for the specific language governing permissions and        %
  32 %  limitations under the License.                                             %
  33 %                                                                             %
  34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  35 %
  36 %
  37 */
  38 \f
  39 /*
  40   Include declarations.
  41 */
  42 #include "MagickCore/studio.h"
  43 #include "MagickCore/matrix.h"
  44 #include "MagickCore/matrix-private.h"
  45 #include "MagickCore/memory_.h"
  46 #include "MagickCore/utility.h"
  47 \f
  48 /*
  49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  50 %                                                                             %
  51 %                                                                             %
  52 %                                                                             %
  53 %   A c q u i r e M a g i c k M a t r i x                                     %
  54 %                                                                             %
  55 %                                                                             %
  56 %                                                                             %
  57 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  58 %
  59 %  AcquireMagickMatrix() allocates and returns a matrix in the form of an
  60 %  array of pointers to an array of doubles, with all values pre-set to zero.
  61 %
  62 %  This used to generate the two dimensional matrix, and vectors required
  63 %  for the GaussJordanElimination() method below, solving some system of
  64 %  simultanious equations.
  65 %
  66 %  The format of the AcquireMagickMatrix method is:
  67 %
  68 %      double **AcquireMagickMatrix(const size_t number_rows,
  69 %        const size_t size)
  70 %
  71 %  A description of each parameter follows:
  72 %
  73 %    o number_rows: the number pointers for the array of pointers
  74 %      (first dimension).
  75 %
  76 %    o size: the size of the array of doubles each pointer points to
  77 %      (second dimension).
  78 %
  79 */
  80 MagickExport double **AcquireMagickMatrix(const size_t number_rows,
  81   const size_t size)
  82 {
  83   double
  84     **matrix;
  85
  86   register ssize_t
  87     i,
  88     j;
  89
  90   matrix=(double **) AcquireQuantumMemory(number_rows,sizeof(*matrix));
  91   if (matrix == (double **) NULL)
  92     return((double **) NULL);
  93   for (i=0; i < (ssize_t) number_rows; i++)
  94   {
  95     matrix[i]=(double *) AcquireQuantumMemory(size,sizeof(*matrix[i]));
  96     if (matrix[i] == (double *) NULL)
  97     {
  98       for (j=0; j < i; j++)
  99         matrix[j]=(double *) RelinquishMagickMemory(matrix[j]);
 100       matrix=(double **) RelinquishMagickMemory(matrix);
 101       return((double **) NULL);
 102     }
 103     for (j=0; j < (ssize_t) size; j++)
 104       matrix[i][j]=0.0;
 105   }
 106   return(matrix);
 107 }
 108 \f
 109 /*
 110 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 111 %                                                                             %
 112 %                                                                             %
 113 %                                                                             %
 114 %   G a u s s J o r d a n E l i m i n a t i o n                               %
 115 %                                                                             %
 116 %                                                                             %
 117 %                                                                             %
 118 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 119 %
 120 %  GaussJordanElimination() returns a matrix in reduced row echelon form,
 121 %  while simultaneously reducing and thus solving the augumented results
 122 %  matrix.
 123 %
 124 %  See also  http://en.wikipedia.org/wiki/Gauss-Jordan_elimination
 125 %
 126 %  The format of the GaussJordanElimination method is:
 127 %
 128 %      MagickBooleanType GaussJordanElimination(double **matrix,
 129 %        double **vectors,const size_t rank,const size_t number_vectors)
 130 %
 131 %  A description of each parameter follows:
 132 %
 133 %    o matrix: the matrix to be reduced, as an 'array of row pointers'.
 134 %
 135 %    o vectors: the additional matrix argumenting the matrix for row reduction.
 136 %             Producing an 'array of column vectors'.
 137 %
 138 %    o rank:  The size of the matrix (both rows and columns).
 139 %             Also represents the number terms that need to be solved.
 140 %
 141 %    o number_vectors: Number of vectors columns, argumenting the above matrix.
 142 %             Usally 1, but can be more for more complex equation solving.
 143 %
 144 %  Note that the 'matrix' is given as a 'array of row pointers' of rank size.
 145 %  That is values can be assigned as   matrix[row][column]   where 'row' is
 146 %  typically the equation, and 'column' is the term of the equation.
 147 %  That is the matrix is in the form of a 'row first array'.
 148 %
 149 %  However 'vectors' is a 'array of column pointers' which can have any number
 150 %  of columns, with each column array the same 'rank' size as 'matrix'.
 151 %
 152 %  This allows for simpler handling of the results, especially is only one
 153 %  column 'vector' is all that is required to produce the desired solution.
 154 %
 155 %  For example, the 'vectors' can consist of a pointer to a simple array of
 156 %  doubles.  when only one set of simultanious equations is to be solved from
 157 %  the given set of coefficient weighted terms.
 158 %
 159 %     double **matrix = AcquireMagickMatrix(8UL,8UL);
 160 %     double coefficents[8];
 161 %     ...
 162 %     GaussJordanElimination(matrix, &coefficents, 8UL, 1UL);
 163 %
 164 %  However by specifing more 'columns' (as an 'array of vector columns',
 165 %  you can use this function to solve a set of 'separable' equations.
 166 %
 167 %  For example a distortion function where    u = U(x,y)   v = V(x,y)
 168 %  And the functions U() and V() have separate coefficents, but are being
 169 %  generated from a common x,y->u,v  data set.
 170 %
 171 %  Another example is generation of a color gradient from a set of colors
 172 %  at specific coordients, such as a list    x,y -> r,g,b,a
 173 %  (Reference to be added - Anthony)
 174 %
 175 %  You can also use the 'vectors' to generate an inverse of the given 'matrix'
 176 %  though as a 'column first array' rather than a 'row first array'. For
 177 %  details see http://en.wikipedia.org/wiki/Gauss-Jordan_elimination.
 178 %
 179 */
 180 MagickPrivate MagickBooleanType GaussJordanElimination(double **matrix,
 181   double **vectors,const size_t rank,const size_t number_vectors)
 182 {
 183 #define GaussJordanSwap(x,y) \
 184 { \
 185   if ((x) != (y)) \
 186     { \
 187       (x)+=(y); \
 188       (y)=(x)-(y); \
 189       (x)=(x)-(y); \
 190     } \
 191 }
 192
 193   double
 194     max,
 195     scale;
 196
 197   register ssize_t
 198     i,
 199     j,
 200     k;
 201
 202   ssize_t
 203     column,
 204     *columns,
 205     *pivots,
 206     row,
 207     *rows;
 208
 209   columns=(ssize_t *) AcquireQuantumMemory(rank,sizeof(*columns));
 210   rows=(ssize_t *) AcquireQuantumMemory(rank,sizeof(*rows));
 211   pivots=(ssize_t *) AcquireQuantumMemory(rank,sizeof(*pivots));
 212   if ((rows == (ssize_t *) NULL) || (columns == (ssize_t *) NULL) ||
 213       (pivots == (ssize_t *) NULL))
 214     {
 215       if (pivots != (ssize_t *) NULL)
 216         pivots=(ssize_t *) RelinquishMagickMemory(pivots);
 217       if (columns != (ssize_t *) NULL)
 218         columns=(ssize_t *) RelinquishMagickMemory(columns);
 219       if (rows != (ssize_t *) NULL)
 220         rows=(ssize_t *) RelinquishMagickMemory(rows);
 221       return(MagickFalse);
 222     }
 223   (void) ResetMagickMemory(columns,0,rank*sizeof(*columns));
 224   (void) ResetMagickMemory(rows,0,rank*sizeof(*rows));
 225   (void) ResetMagickMemory(pivots,0,rank*sizeof(*pivots));
 226   column=0;
 227   row=0;
 228   for (i=0; i < (ssize_t) rank; i++)
 229   {
 230     max=0.0;
 231     for (j=0; j < (ssize_t) rank; j++)
 232       if (pivots[j] != 1)
 233         {
 234           for (k=0; k < (ssize_t) rank; k++)
 235             if (pivots[k] != 0)
 236               {
 237                 if (pivots[k] > 1)
 238                   return(MagickFalse);
 239               }
 240             else
 241               if (fabs(matrix[j][k]) >= max)
 242                 {
 243                   max=fabs(matrix[j][k]);
 244                   row=j;
 245                   column=k;
 246                 }
 247         }
 248     pivots[column]++;
 249     if (row != column)
 250       {
 251         for (k=0; k < (ssize_t) rank; k++)
 252           GaussJordanSwap(matrix[row][k],matrix[column][k]);
 253         for (k=0; k < (ssize_t) number_vectors; k++)
 254           GaussJordanSwap(vectors[k][row],vectors[k][column]);
 255       }
 256     rows[i]=row;
 257     columns[i]=column;
 258     if (matrix[column][column] == 0.0)
 259       return(MagickFalse);  /* sigularity */
 260     scale=1.0/matrix[column][column];
 261     matrix[column][column]=1.0;
 262     for (j=0; j < (ssize_t) rank; j++)
 263       matrix[column][j]*=scale;
 264     for (j=0; j < (ssize_t) number_vectors; j++)
 265       vectors[j][column]*=scale;
 266     for (j=0; j < (ssize_t) rank; j++)
 267       if (j != column)
 268         {
 269           scale=matrix[j][column];
 270           matrix[j][column]=0.0;
 271           for (k=0; k < (ssize_t) rank; k++)
 272             matrix[j][k]-=scale*matrix[column][k];
 273           for (k=0; k < (ssize_t) number_vectors; k++)
 274             vectors[k][j]-=scale*vectors[k][column];
 275         }
 276   }
 277   for (j=(ssize_t) rank-1; j >= 0; j--)
 278     if (columns[j] != rows[j])
 279       for (i=0; i < (ssize_t) rank; i++)
 280         GaussJordanSwap(matrix[i][rows[j]],matrix[i][columns[j]]);
 281   pivots=(ssize_t *) RelinquishMagickMemory(pivots);
 282   rows=(ssize_t *) RelinquishMagickMemory(rows);
 283   columns=(ssize_t *) RelinquishMagickMemory(columns);
 284   return(MagickTrue);
 285 }
 286 \f
 287 /*
 288 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 289 %                                                                             %
 290 %                                                                             %
 291 %                                                                             %
 292 %   L e a s t S q u a r e s A d d T e r m s                                   %
 293 %                                                                             %
 294 %                                                                             %
 295 %                                                                             %
 296 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 297 %
 298 %  LeastSquaresAddTerms() adds one set of terms and associate results to the
 299 %  given matrix and vectors for solving using least-squares function fitting.
 300 %
 301 %  The format of the AcquireMagickMatrix method is:
 302 %
 303 %      void LeastSquaresAddTerms(double **matrix,double **vectors,
 304 %        const double *terms,const double *results,const size_t rank,
 305 %        const size_t number_vectors);
 306 %
 307 %  A description of each parameter follows:
 308 %
 309 %    o matrix: the square matrix to add given terms/results to.
 310 %
 311 %    o vectors: the result vectors to add terms/results to.
 312 %
 313 %    o terms: the pre-calculated terms (without the unknown coefficent
 314 %      weights) that forms the equation being added.
 315 %
 316 %    o results: the result(s) that should be generated from the given terms
 317 %      weighted by the yet-to-be-solved coefficents.
 318 %
 319 %    o rank: the rank or size of the dimentions of the square matrix.
 320 %      Also the length of vectors, and number of terms being added.
 321 %
 322 %    o number_vectors: Number of result vectors, and number or results being
 323 %      added.  Also represents the number of separable systems of equations
 324 %      that is being solved.
 325 %
 326 %  Example of use...
 327 %
 328 %     2 dimensional Affine Equations (which are separable)
 329 %         c0*x + c2*y + c4*1 => u
 330 %         c1*x + c3*y + c5*1 => v
 331 %
 332 %     double **matrix = AcquireMagickMatrix(3UL,3UL);
 333 %     double **vectors = AcquireMagickMatrix(2UL,3UL);
 334 %     double terms[3], results[2];
 335 %     ...
 336 %     for each given x,y -> u,v
 337 %        terms[0] = x;
 338 %        terms[1] = y;
 339 %        terms[2] = 1;
 340 %        results[0] = u;
 341 %        results[1] = v;
 342 %        LeastSquaresAddTerms(matrix,vectors,terms,results,3UL,2UL);
 343 %     ...
 344 %     if ( GaussJordanElimination(matrix,vectors,3UL,2UL) ) {
 345 %       c0 = vectors[0][0];
 346 %       c2 = vectors[0][1];
 347 %       c4 = vectors[0][2];
 348 %       c1 = vectors[1][0];
 349 %       c3 = vectors[1][1];
 350 %       c5 = vectors[1][2];
 351 %     }
 352 %     else
 353 %       printf("Matrix unsolvable\n);
 354 %     RelinquishMagickMatrix(matrix,3UL);
 355 %     RelinquishMagickMatrix(vectors,2UL);
 356 %
 357 */
 358 MagickPrivate void LeastSquaresAddTerms(double **matrix,double **vectors,
 359   const double *terms,const double *results,const size_t rank,
 360   const size_t number_vectors)
 361 {
 362   register ssize_t
 363     i,
 364     j;
 365
 366   for (j=0; j < (ssize_t) rank; j++)
 367   {
 368     for (i=0; i < (ssize_t) rank; i++)
 369       matrix[i][j]+=terms[i]*terms[j];
 370     for (i=0; i < (ssize_t) number_vectors; i++)
 371       vectors[i][j]+=results[i]*terms[j];
 372   }
 373 }
 374 \f
 375 /*
 376 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 377 %                                                                             %
 378 %                                                                             %
 379 %                                                                             %
 380 %   R e l i n q u i s h M a g i c k M a t r i x                               %
 381 %                                                                             %
 382 %                                                                             %
 383 %                                                                             %
 384 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 385 %
 386 %  RelinquishMagickMatrix() frees the previously acquired matrix (array of
 387 %  pointers to arrays of doubles).
 388 %
 389 %  The format of the RelinquishMagickMatrix method is:
 390 %
 391 %      double **RelinquishMagickMatrix(double **matrix,
 392 %        const size_t number_rows)
 393 %
 394 %  A description of each parameter follows:
 395 %
 396 %    o matrix: the matrix to relinquish
 397 %
 398 %    o number_rows: the first dimension of the acquired matrix (number of
 399 %      pointers)
 400 %
 401 */
 402 MagickExport double **RelinquishMagickMatrix(double **matrix,
 403   const size_t number_rows)
 404 {
 405   register ssize_t
 406     i;
 407
 408   if (matrix == (double **) NULL )
 409     return(matrix);
 410   for (i=0; i < (ssize_t) number_rows; i++)
 411      matrix[i]=(double *) RelinquishMagickMemory(matrix[i]);
 412   matrix=(double **) RelinquishMagickMemory(matrix);
 413   return(matrix);
 414 }