user_params.c

This toolbox contains Matlab code for several graph and mesh partitioning methods, including geometr

/* This software was developed by Bruce Hendrickson and Robert Leland   *
 * at Sandia National Laboratories under US Department of Energy        *
 * contract DE-AC04-76DP00789 and is copyrighted by Sandia Corporation. */

/* Modified by John Gilbert 25 Aug 1995 for Matlab mex-file interface   */
/* Modified by Tim Davis, July 6, 1998, for Matlab 5.1 interface, and */
/* a more picky compiler (cc) that complains about duplicate global */
/* declarations. */

#include "params.h"

#define  TRUE  1
#define  FALSE 0


/* Input and ouput control parameters */

int       CHECK_INPUT = TRUE;	 /* Check input for consistency? (TRUE/FALSE) */
int       ECHO = 0;		 /* Print input/param options? to file? (-2..2) */
int       OUTPUT_METRICS = 0;	 /* Controls displaying of results (-2..2) */
int       OUTPUT_TIME = 0;	 /* At what level to display timings (0..2) */
int       OUTPUT_ASSIGN = FALSE; /* Write assignments to file? (TRUE/FALSE) */
int       OUT_ASSIGN_INV = FALSE;/* If so, use inverse form? (TRUE/FALSE) */
int       IN_ASSIGN_INV = FALSE; /* Input file in inverse form? (TRUE/FALSE) */
int       PROMPT = FALSE;	 /* Prompt for input? (TRUE/FALSE) */
int       PRINT_HEADERS = FALSE; /* Print pretty output headers (TRUE/FALSE) */


/* Eigenvector calculation parameters */

int       LANCZOS_TYPE = 3;	/* type of Lanczos to use */
				/* 1 => full orthog, 2 => full inverse operator */
				/* 3 =>  selective orthogonalization */
double    EIGEN_TOLERANCE = 1e-3;	/* Numerical eigen-tolerance */
double    SRESTOL = -1.;		/* Rel resid tol on T evec; autoset if <= 0 */
int       LANCZOS_SO_INTERVAL = 10;	/* Itns. between SO orthog checks; set >= 2 */
int       LANCZOS_MAXITNS = -1;		/* Max Lanczos its; autoset if <= 0 */
double    BISECTION_SAFETY = 10;	/* Divides Lanczos bisection tol */
int       LANCZOS_CONVERGENCE_MODE = 0;	/* Lanczos convergence test type: */
					/* 0=> residual,  1=> partition */
int       RQI_CONVERGENCE_MODE = 1;	/* RQI convergence test type: */
					/* 0=> residual,  1=> partition */
int       LANCZOS_SO_PRECISION = 2;	/* 2 => double Lanczos, 1 => float */
int       WARNING_EVECS = 2;	/* Warnings in eigenvector generation (0..3) */
double    WARNING_ORTHTOL = 2;	/* Warning if Ares and bjitol have this ratio */
double    WARNING_MISTOL = 100;	/* Warning if Ares and bjitol have this ratio */
int       LANCZOS_TIME = FALSE;	/* Detailed Lanczos times? (TRUE/FALSE) */
int       TIME_KERNELS = FALSE;	/* Time numerical kernels? (TRUE/FALSE) */


/* Other parameters for spectral methods */

int       MAKE_CONNECTED = TRUE;/* Connect graph if using spectral method? */
int       PERTURB = TRUE;	/* Randomly perturb matrix in spectral method? */
int       NPERTURB = 2;		/* If so, how many edges to modify? */
double    PERTURB_MAX = 3.0e-3;	/* Largest value for perturbation */
int       MAPPING_TYPE = 1;	/* How to map from eigenvectors to partition */
				/* 0 => cut at origin, 1 => min-cost assign */
int       COARSE_NLEVEL_RQI = 2;/* # levels between RQI calls in uncoarsening */
int       OPT3D_NTRIES = 5;	/* # local opts to look for global min in opt3d */


/* Kernighan--Lin/Fiduccia--Mattheyses parameters */

int       KL_METRIC = 2;	/* KL interset cost: 1=>cuts, 2=>hops */
int       KL_RANDOM = TRUE;	/* Use randomness in Kernighan-Lin? (TRUE/FALSE)*/
int       KL_BAD_MOVES = 20;	/* Number of unhelpful moves in a row allowed */
int       KL_NTRIES_BAD = 1;	/* # unhelpful passes before quitting KL */
int       KL_UNDO_LIST = TRUE;	/* Only resort changed vtxs? (TRUE/FALSE) */
double    KL_IMBALANCE = 0.0;	/* Fractional imbalance allowed by KL */


/* Coarsening parameters */

double    COARSEN_RATIO_MIN = .7;  /* Min vtx reduction each coarsen stage */
int       COARSE_NLEVEL_KL = 2;	   /* # levels between KL calls in uncoarsening */
int       MATCH_TYPE = 1;	   /* Type of contraction matching (1..4) */
int       HEAVY_MATCH = FALSE;	   /* Encourage heavy match edges? (TRUE/FALSE) */
int       COARSE_KL_BOTTOM = TRUE; /* Force KL at lowest level (TRUE/FALSE) */
int       COARSEN_VWGTS = TRUE;	   /* Sum vtx weights in coarsening? (TRUE/FALSE) */
int       COARSEN_EWGTS = TRUE;	   /* Sum edge weights in coarsening? (TRUE/FALSE) */
int       KL_ONLY_BNDY = TRUE;	   /* Start moving vtxs on boundary? (TRUE/FALSE) */


/* Parameters for post-processing options */

int       REFINE_PARTITION = FALSE;	/* Postprocess to improve cuts? */
int       INTERNAL_VERTICES = FALSE;	/* ... to up internal vtxs? (TRUE/FALSE) */
int       REFINE_MAP = FALSE;		/* ... to reduce hops? (TRUE/FALSE) */


/* Architecture and simulator parameters */

int       ARCHITECTURE = 0;	/* 0=> hypercube, d=> d-dimensional mesh (0..3)*/

/* Modified by Tim Davis:  remove duplicate definitions */
#ifdef DUPLICATE_DEFINITIONS_REMOVED
int       SIMULATOR = 0;	/* Run simulator? In what mode? */
int       SIMULATION_ITNS = 1;	/* # iterations simulator is to imitate. */
int       PERCENTAGE_OUTPUT = FALSE;	/* Output in percent? (TRUE/FALSE) */
double    CUT_COST = 0.0;	/* Communication cost of a cut-edge. */
double    HOP_COST = 0.0;	/* Communication cost of a hop. */
double    BDY_COST = 0.0;	/* Cost associated with boundary vertices.  */
double    BDY_HOP_COST = 0.0;	/* Cost associated with boundary hops. */
double    STARTUP_COST = 0.0;	/* Communication cost of a message startup. */
	/* Note: nCUBE2 startup: 112e-6, per byte: 4.6e-6, buffering 5.6e-6 */
	/* Intel Paragon startup: 70e-6, per byte: 5.3e-8 */
#endif

/* Miscellaneous parameters */

int       TERM_PROP = FALSE;	/* Invoke terminal propagation? (TRUE/FALSE) */
double    CUT_TO_HOP_COST = 1;	/* ..if so, relative importance of cuts/hops */
int       SEQUENCE = FALSE;	/* Only do spectral ordering? (TRUE/FALSE) */
char      SEQ_FILENAME[NAME_LENGTH] = "Sequence.out";	/* If so, file name */
long      RANDOM_SEED = 7654321L;	/* Seed for random number generator */
int       NSQRTS = 1000;	/* # square roots to precompute if coarsening */
int       MAKE_VWGTS = FALSE;	/* Make vtx weights degrees+1? (TRUE/FALSE) */
int       FREE_GRAPH = FALSE;	/* Free input graph data? (TRUE/FALSE) */
char     *PARAMS_FILENAME = "User_Params";	/* File of parameter changes */


/* Parameters that control debugging output */

int       DEBUG_EVECS = 0;	/* Debug flag for eigenvector generation (0..5) */
int       DEBUG_KL = 0;		/* Debug flag for Kernighan-Lin (0..3) */
int       DEBUG_INERTIAL = 0;	/* Debug flag for inertial method (0..1) */
int       DEBUG_CONNECTED = 0;	/* Debug flag for connected components (0..1) */
int       DEBUG_PERTURB = 0;	/* Debug flag for matrix perturbation (0..1) */
int       DEBUG_ASSIGN = 0;	/* Debug flag for assignment to sets (0..1) */
int       DEBUG_OPTIMIZE = 0;	/* Debug flag for optimization/rotation (0..2) */
int       DEBUG_BPMATCH = 0;	/* Debug flag for bipartite matching code (0..2) */
int       DEBUG_COARSEN = 0;	/* Debug flag for coarsening/uncoarsening (0..1) */
int       DEBUG_MEMORY = 0;	/* Debug flag for smalloc/sfree (0..3) */
int       DEBUG_INPUT = 0;	/* Debug flag for having read input files (0..1) */
int       DEBUG_PARAMS = 1;	/* Debug flag for reading parameter file (0..2) */
int       DEBUG_INTERNAL = 0;	/* Debug flag for internal vertices (0..2) */
int       DEBUG_REFINE_PART = 0;/* Debug flag for refine partition (0..1) */
int       DEBUG_REFINE_MAP = 0;	/* Debug flag for refining mapping (0..1) */
int       DEBUG_SIMULATOR = 0;	/* Debug flag for comm simulator (0..2) */
int       DEBUG_TRACE = 0;	/* Trace main execution path (0..2) */
int       DEBUG_MACH_PARAMS = 0;/* Print computed machine params? (0..1) */