1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
|
/* ========================================================================== */
/* === colamdtest mexFunction =============================================== */
/* ========================================================================== */
/* COLAMD Version 2.4.
This MATLAB mexFunction is for testing only. It is not meant for
production use. See colamdmex.c instead.
Usage:
[ P, stats ] = colamdtest (A, knobs) ;
See colamd.m for a description. knobs is required.
knobs (1) dense row control
knobs (2) dense column control
knobs (3) spumoni
knobs (4) for testing only. Controls the workspace used by
colamd.
knobs (5) for testing only. Controls how the input matrix is
jumbled prior to calling colamd, to test its error
handling capability.
Authors:
The authors of the code itself are Stefan I. Larimore and Timothy A.
Davis (davis at cise.ufl.edu), University of Florida. The algorithm was
developed in collaboration with John Gilbert, Xerox PARC, and Esmond
Ng, Oak Ridge National Laboratory.
Acknowledgements:
This work was supported by the National Science Foundation, under
grants DMS-9504974 and DMS-9803599.
Notice:
Copyright (c) 1998-2005, Timothy A. Davis, All Rights Reserved.
See http://www.cise.ufl.edu/research/sparse/colamd (the colamd.c
file) for the License.
Availability:
The colamd/symamd library is available at
http://www.cise.ufl.edu/research/sparse/colamd/
This is the
http://www.cise.ufl.edu/research/sparse/colamd/colamdtestmex.c
file. It requires the colamd.c and colamd.h files.
*/
/* ========================================================================== */
/* === Include files ======================================================== */
/* ========================================================================== */
#include "colamd.h"
#include "mex.h"
#include "matrix.h"
#include <stdlib.h>
#include <string.h>
static void dump_matrix
(
int A [ ],
int p [ ],
int n_row,
int n_col,
int Alen,
int limit
) ;
/* ========================================================================== */
/* === colamd mexFunction =================================================== */
/* ========================================================================== */
void mexFunction
(
/* === Parameters ======================================================= */
int nlhs, /* number of left-hand sides */
mxArray *plhs [], /* left-hand side matrices */
int nrhs, /* number of right--hand sides */
const mxArray *prhs [] /* right-hand side matrices */
)
{
/* === Local variables ================================================== */
int *A ; /* colamd's copy of the matrix, and workspace */
int *p ; /* colamd's copy of the column pointers */
int Alen ; /* size of A */
int n_col ; /* number of columns of A */
int n_row ; /* number of rows of A */
int nnz ; /* number of entries in A */
int full ; /* TRUE if input matrix full, FALSE if sparse */
double knobs [COLAMD_KNOBS] ; /* colamd user-controllable parameters */
double *out_perm ; /* output permutation vector */
double *out_stats ; /* output stats vector */
double *in_knobs ; /* input knobs vector */
int i ; /* loop counter */
mxArray *Ainput ; /* input matrix handle */
int spumoni ; /* verbosity variable */
int stats2 [COLAMD_STATS] ; /* stats for colamd */
int *cp, *cp_end, result, col, length ;
int *stats ;
stats = stats2 ;
colamd_printf = mexPrintf ; /* COLAMD printf routine */
/* === Check inputs ===================================================== */
if (nrhs < 1 || nrhs > 2 || nlhs < 0 || nlhs > 2)
{
mexErrMsgTxt (
"colamd: incorrect number of input and/or output arguments") ;
}
if (nrhs != 2)
{
mexErrMsgTxt ("colamdtest: knobs are required") ;
}
/* for testing we require all 5 knobs */
if (mxGetNumberOfElements (prhs [1]) != 5)
{
mexErrMsgTxt ("colamd: must have all 5 knobs for testing") ;
}
/* === Get knobs ======================================================== */
colamd_set_defaults (knobs) ;
spumoni = 0 ;
/* check for user-passed knobs */
if (nrhs == 2)
{
in_knobs = mxGetPr (prhs [1]) ;
i = mxGetNumberOfElements (prhs [1]) ;
if (i > 0) knobs [COLAMD_DENSE_ROW] = in_knobs [0] ;
if (i > 1) knobs [COLAMD_DENSE_COL] = in_knobs [1] ;
if (i > 2) spumoni = (int) in_knobs [2] ;
}
/* print knob settings if spumoni is set */
if (spumoni)
{
mexPrintf ("\ncolamd version %d.%d, %s:\n",
COLAMD_MAIN_VERSION, COLAMD_SUB_VERSION, COLAMD_DATE) ;
if (knobs [COLAMD_DENSE_ROW] >= 0)
{
mexPrintf ("knobs(1): %g, rows with > max(16,%g*sqrt(size(A,2)))"
" entries removed\n", in_knobs [0], knobs [COLAMD_DENSE_ROW]) ;
}
else
{
mexPrintf ("knobs(1): %g, only completely dense rows removed\n",
in_knobs [0]) ;
}
if (knobs [COLAMD_DENSE_COL] >= 0)
{
mexPrintf ("knobs(2): %g, cols with > max(16,%g*sqrt(min(size(A)))"
" entries removed\n", in_knobs [1], knobs [COLAMD_DENSE_COL]) ;
}
else
{
mexPrintf ("knobs(2): %g, only completely dense columns removed\n",
in_knobs [1]) ;
}
mexPrintf ("knobs(3): %g, statistics and knobs printed\n",
in_knobs [2]) ;
}
/* === If A is full, convert to a sparse matrix ========================= */
Ainput = (mxArray *) prhs [0] ;
if (mxGetNumberOfDimensions (Ainput) != 2)
{
mexErrMsgTxt ("colamd: input matrix must be 2-dimensional") ;
}
full = !mxIsSparse (Ainput) ;
if (full)
{
mexCallMATLAB (1, &Ainput, 1, (mxArray **) prhs, "sparse") ;
}
/* === Allocate workspace for colamd ==================================== */
/* get size of matrix */
n_row = mxGetM (Ainput) ;
n_col = mxGetN (Ainput) ;
/* get column pointer vector so we can find nnz */
p = (int *) mxCalloc (n_col+1, sizeof (int)) ;
(void) memcpy (p, mxGetJc (Ainput), (n_col+1)*sizeof (int)) ;
nnz = p [n_col] ;
Alen = colamd_recommended (nnz, n_row, n_col) ;
/* === Modify size of Alen if testing ======================================= */
/*
knobs [3] amount of workspace given to colamd.
< 0 : TIGHT memory
> 0 : MIN + knob [3] - 1
== 0 : RECOMMENDED memory
*/
/* Here only for testing */
#ifdef MIN
#undef MIN
#endif
#define MIN(a,b) (((a) < (b)) ? (a) : (b))
#define COLAMD_MIN_MEMORY(nnz,n_row,n_col) \
(2 * (nnz) + COLAMD_C (n_col) + COLAMD_R (n_row))
/* get knob [3], if negative */
if (in_knobs [3] < 0)
{
Alen = COLAMD_MIN_MEMORY (nnz, n_row, n_col) + n_col ;
}
else if (in_knobs [3] > 0)
{
Alen = COLAMD_MIN_MEMORY (nnz, n_row, n_col) + in_knobs [3] - 1 ;
}
/* otherwise, we use the recommended amount set above */
/* === Copy input matrix into workspace ================================= */
A = (int *) mxCalloc (Alen, sizeof (int)) ;
(void) memcpy (A, mxGetIr (Ainput), nnz*sizeof (int)) ;
if (full)
{
mxDestroyArray (Ainput) ;
}
/* === Jumble matrix ======================================================== */
/*
knobs [4] FOR TESTING ONLY: Specifies how to jumble matrix
0 : No jumbling
1 : Make n_row less than zero
2 : Make first pointer non-zero
3 : Make column pointers not non-decreasing
4 : Make a column pointer greater or equal to Alen
5 : Make row indices not strictly increasing
6 : Make a row index greater or equal to n_row
7 : Set A = NULL
8 : Set p = NULL
9 : Repeat row index
10: make row indices not sorted
11: jumble columns massively (note this changes
the pattern of the matrix A.)
12: Set stats = NULL
13: Make n_col less than zero
*/
/* jumble appropriately */
switch ((int) in_knobs [4])
{
case 0 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: no errors expected\n") ;
}
result = 1 ; /* no errors */
break ;
case 1 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: nrow out of range\n") ;
}
result = 0 ; /* nrow out of range */
n_row = -1 ;
break ;
case 2 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: p [0] nonzero\n") ;
}
result = 0 ; /* p [0] must be zero */
p [0] = 1 ;
break ;
case 3 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: negative length last column\n") ;
}
result = (n_col == 0) ; /* p must be monotonically inc. */
p [n_col] = p [0] ;
break ;
case 4 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: Alen too small\n") ;
}
result = 0 ; /* out of memory */
p [n_col] = Alen ;
break ;
case 5 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: row index out of range (-1)\n") ;
}
if (nnz > 0) /* row index out of range */
{
result = 0 ;
A [nnz-1] = -1 ;
}
else
{
if (spumoni > 0)
{
mexPrintf ("Note: no row indices to put out of range\n") ;
}
result = 1 ;
}
break ;
case 6 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: row index out of range (n_row)\n") ;
}
if (nnz > 0) /* row index out of range */
{
if (spumoni > 0)
{
mexPrintf ("Changing A[nnz-1] from %d to %d\n",
A [nnz-1], n_row) ;
}
result = 0 ;
A [nnz-1] = n_row ;
}
else
{
if (spumoni > 0)
{
mexPrintf ("Note: no row indices to put out of range\n") ;
}
result = 1 ;
}
break ;
case 7 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: A not present\n") ;
}
result = 0 ; /* A not present */
A = (int *) NULL ;
break ;
case 8 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: p not present\n") ;
}
result = 0 ; /* p not present */
p = (int *) NULL ;
break ;
case 9 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: duplicate row index\n") ;
}
result = 1 ; /* duplicate row index */
for (col = 0 ; col < n_col ; col++)
{
length = p [col+1] - p [col] ;
if (length > 1)
{
A [p [col]] = A [p [col] + 1] ;
if (spumoni > 0)
{
mexPrintf ("Made duplicate row %d in col %d\n",
A [p [col] + 1], col) ;
}
break ;
}
}
if (spumoni > 1)
{
dump_matrix (A, p, n_row, n_col, Alen, col+2) ;
}
break ;
case 10 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: unsorted column\n") ;
}
result = 1 ; /* jumbled columns */
for (col = 0 ; col < n_col ; col++)
{
length = p [col+1] - p [col] ;
if (length > 1)
{
i = A[p [col]] ;
A [p [col]] = A[p [col] + 1] ;
A [p [col] + 1] = i ;
if (spumoni > 0)
{
mexPrintf ("Unsorted column %d \n", col) ;
}
break ;
}
}
if (spumoni > 1)
{
dump_matrix (A, p, n_row, n_col, Alen, col+2) ;
}
break ;
case 11 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: massive jumbling\n") ;
}
result = 1 ; /* massive jumbling, but no errors */
srand (1) ;
for (i = 0 ; i < n_col ; i++)
{
cp = &A [p [i]] ;
cp_end = &A [p [i+1]] ;
while (cp < cp_end)
{
*cp++ = rand() % n_row ;
}
}
if (spumoni > 1)
{
dump_matrix (A, p, n_row, n_col, Alen, n_col) ;
}
break ;
case 12 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: stats not present\n") ;
}
result = 0 ; /* stats not present */
stats = (int *) NULL ;
break ;
case 13 :
if (spumoni > 0)
{
mexPrintf ("colamdtest: ncol out of range\n") ;
}
result = 0 ; /* ncol out of range */
n_col = -1 ;
break ;
}
/* === Order the columns (destroys A) =================================== */
if (!colamd (n_row, n_col, Alen, A, p, knobs, stats))
{
/* return p = -1 if colamd failed */
plhs [0] = mxCreateDoubleMatrix (1, 1, mxREAL) ;
out_perm = mxGetPr (plhs [0]) ;
out_perm [0] = -1 ;
mxFree (p) ;
mxFree (A) ;
if (spumoni > 0 || result)
{
colamd_report (stats) ;
}
if (result)
{
mexErrMsgTxt ("colamd should have returned TRUE\n") ;
}
return ;
/* mexErrMsgTxt ("colamd error!") ; */
}
if (!result)
{
colamd_report (stats) ;
mexErrMsgTxt ("colamd should have returned FALSE\n") ;
}
mxFree (A) ;
/* === Return the permutation vector ==================================== */
plhs [0] = mxCreateDoubleMatrix (1, n_col, mxREAL) ;
out_perm = mxGetPr (plhs [0]) ;
for (i = 0 ; i < n_col ; i++)
{
/* colamd is 0-based, but MATLAB expects this to be 1-based */
out_perm [i] = p [i] + 1 ;
}
mxFree (p) ;
/* === Return the stats vector ========================================== */
/* print stats if spumoni > 0 */
if (spumoni > 0)
{
colamd_report (stats) ;
}
if (nlhs == 2)
{
plhs [1] = mxCreateDoubleMatrix (1, COLAMD_STATS, mxREAL) ;
out_stats = mxGetPr (plhs [1]) ;
for (i = 0 ; i < COLAMD_STATS ; i++)
{
out_stats [i] = stats [i] ;
}
/* fix stats (5) and (6), for 1-based information on jumbled matrix. */
/* note that this correction doesn't occur if symamd returns FALSE */
out_stats [COLAMD_INFO1] ++ ;
out_stats [COLAMD_INFO2] ++ ;
}
}
static void dump_matrix
(
int A [ ],
int p [ ],
int n_row,
int n_col,
int Alen,
int limit
)
{
int col, k, row ;
mexPrintf ("dump matrix: nrow %d ncol %d Alen %d\n", n_row, n_col, Alen) ;
for (col = 0 ; col < MIN (n_col, limit) ; col++)
{
mexPrintf ("column %d, p[col] %d, p [col+1] %d, length %d\n",
col, p [col], p [col+1], p [col+1] - p [col]) ;
for (k = p [col] ; k < p [col+1] ; k++)
{
row = A [k] ;
mexPrintf (" %d", row) ;
}
mexPrintf ("\n") ;
}
}
|