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