This file contains function prototypes and constant definitions for METIS. More...

#include <inttypes.h>

Include dependency graph for include/metis.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	iabs abs

#define	IDX_MAX INT32_MAX

#define	IDX_MIN INT32_MIN

#define	IDXTYPEWIDTH 32

#define	METIS_API(type) type

#define	METIS_NOPTIONS 40

#define	METIS_VER_MAJOR 5

#define	METIS_VER_MINOR 1

#define	METIS_VER_SUBMINOR 0

#define	PRIDX PRId32

#define	PRREAL "f"

#define	rabs fabsf

#define	REAL_EPSILON FLT_EPSILON

#define	REAL_MAX FLT_MAX

#define	REAL_MIN FLT_MIN

#define	REALEQ(x, y) ((rabs((x)-(y)) <= FLT_EPSILON))

#define	REALTYPEWIDTH 32

#define	SCIDX SCNd32

#define	SCREAL "f"

#define	strtoidx strtol

#define	strtoreal strtof

Typedefs
typedef int32_t	idx_t

typedef float	real_t

Enumerations
enum	mctype_et { METIS_CTYPE_RM, METIS_CTYPE_SHEM }

enum	mdbglvl_et { METIS_DBG_INFO = 1, METIS_DBG_TIME = 2, METIS_DBG_COARSEN = 4, METIS_DBG_REFINE = 8, METIS_DBG_IPART = 16, METIS_DBG_MOVEINFO = 32, METIS_DBG_SEPINFO = 64, METIS_DBG_CONNINFO = 128, METIS_DBG_CONTIGINFO = 256, METIS_DBG_MEMORY = 2048 }

enum	mgtype_et { METIS_GTYPE_DUAL, METIS_GTYPE_NODAL }

enum	miptype_et { METIS_IPTYPE_GROW, METIS_IPTYPE_RANDOM, METIS_IPTYPE_EDGE, METIS_IPTYPE_NODE, METIS_IPTYPE_METISRB }

enum	mobjtype_et { METIS_OBJTYPE_CUT, METIS_OBJTYPE_VOL, METIS_OBJTYPE_NODE }

enum	moptions_et { METIS_OPTION_PTYPE, METIS_OPTION_OBJTYPE, METIS_OPTION_CTYPE, METIS_OPTION_IPTYPE, METIS_OPTION_RTYPE, METIS_OPTION_DBGLVL, METIS_OPTION_NITER, METIS_OPTION_NCUTS, METIS_OPTION_SEED, METIS_OPTION_NO2HOP, METIS_OPTION_MINCONN, METIS_OPTION_CONTIG, METIS_OPTION_COMPRESS, METIS_OPTION_CCORDER, METIS_OPTION_PFACTOR, METIS_OPTION_NSEPS, METIS_OPTION_UFACTOR, METIS_OPTION_NUMBERING, METIS_OPTION_HELP, METIS_OPTION_TPWGTS, METIS_OPTION_NCOMMON, METIS_OPTION_NOOUTPUT, METIS_OPTION_BALANCE, METIS_OPTION_GTYPE, METIS_OPTION_UBVEC }

enum	moptype_et { METIS_OP_PMETIS, METIS_OP_KMETIS, METIS_OP_OMETIS }

enum	mptype_et { METIS_PTYPE_RB, METIS_PTYPE_KWAY }

enum	mrtype_et { METIS_RTYPE_FM, METIS_RTYPE_GREEDY, METIS_RTYPE_SEP2SIDED, METIS_RTYPE_SEP1SIDED }

enum	rstatus_et { METIS_OK = 1, METIS_ERROR_INPUT = -2, METIS_ERROR_MEMORY = -3, METIS_ERROR = -4 }

Functions
	METIS_API (int) METIS_PartGraphRecursive(idx_t *nvtxs

Variables
idx_t idx_t idx_t *	adjncy

idx_t idx_t idx_t idx_t idx_t idx_t *	adjwgt

idx_t idx_t idx_t idx_t idx_t idx_t idx_t real_t real_t idx_t idx_t *	edgecut

idx_t idx_t idx_t *	eind

idx_t idx_t idx_t idx_t idx_t idx_t real_t idx_t idx_t idx_t *	epart

idx_t idx_t *	eptr

idx_t idx_t idx_t idx_t idx_t *	hmarker

idx_t idx_t idx_t idx_t idx_t idx_t *	iperm

idx_t idx_t idx_t idx_t *	ncommon

idx_t *	ncon

idx_t *	nn

idx_t idx_t idx_t idx_t idx_t idx_t real_t idx_t idx_t idx_t idx_t *	npart

idx_t idx_t idx_t idx_t idx_t idx_t idx_t *	nparts

idx_t idx_t idx_t idx_t	npes

idx_t idx_t idx_t idx_t idx_t *	numflag

idx_t idx_t idx_t idx_t idx_t idx_t real_t idx_t idx_t *	objval

idx_t idx_t idx_t idx_t idx_t idx_t idx_t real_t real_t idx_t *	options

idx_t idx_t idx_t idx_t idx_t idx_t idx_t real_t real_t idx_t idx_t idx_t *	part

idx_t idx_t idx_t idx_t idx_t *	perm

idx_t idx_t idx_t idx_t idx_t idx_t idx_t **	r_adjncy

idx_t idx_t idx_t idx_t idx_t idx_t **	r_xadj

idx_t idx_t idx_t idx_t idx_t *	sepsize

idx_t idx_t idx_t idx_t idx_t idx_t idx_t idx_t *	sizes

idx_t idx_t idx_t idx_t idx_t idx_t idx_t real_t *	tpwgts

idx_t idx_t idx_t idx_t idx_t real_t	ubfactor

idx_t idx_t idx_t idx_t idx_t idx_t idx_t real_t real_t *	ubvec

idx_t idx_t idx_t idx_t idx_t *	vsize

idx_t idx_t idx_t idx_t *	vwgt

idx_t idx_t idx_t idx_t *	where

idx_t idx_t *	xadj

Detailed Description

This file contains function prototypes and constant definitions for METIS.

Author: George

Date: Started 8/9/02

Version

$Id$

Definition in file include/metis.h.

Macro Definition Documentation

◆ iabs

#define iabs abs

Definition at line 110 of file include/metis.h.

◆ IDX_MAX

#define IDX_MAX INT32_MAX

Definition at line 103 of file include/metis.h.

◆ IDX_MIN

#define IDX_MIN INT32_MIN

Definition at line 104 of file include/metis.h.

◆ IDXTYPEWIDTH

#define IDXTYPEWIDTH 32

Definition at line 33 of file include/metis.h.

◆ METIS_API

#define METIS_API ( type ) type

Definition at line 188 of file include/metis.h.

◆ METIS_NOPTIONS

#define METIS_NOPTIONS 40

Definition at line 175 of file include/metis.h.

◆ METIS_VER_MAJOR

#define METIS_VER_MAJOR 5

Definition at line 170 of file include/metis.h.

◆ METIS_VER_MINOR

#define METIS_VER_MINOR 1

Definition at line 171 of file include/metis.h.

◆ METIS_VER_SUBMINOR

#define METIS_VER_SUBMINOR 0

Definition at line 172 of file include/metis.h.

◆ PRIDX

#define PRIDX PRId32

Definition at line 107 of file include/metis.h.

◆ PRREAL

#define PRREAL "f"

Definition at line 135 of file include/metis.h.

◆ rabs

#define rabs fabsf

Definition at line 140 of file include/metis.h.

◆ REAL_EPSILON

#define REAL_EPSILON FLT_EPSILON

Definition at line 138 of file include/metis.h.

◆ REAL_MAX

#define REAL_MAX FLT_MAX

Definition at line 136 of file include/metis.h.

◆ REAL_MIN

#define REAL_MIN FLT_MIN

Definition at line 137 of file include/metis.h.

◆ REALEQ

#define REALEQ	(	x,
		y
	)	((rabs((x)-(y)) <= FLT_EPSILON))

Definition at line 141 of file include/metis.h.

◆ REALTYPEWIDTH

#define REALTYPEWIDTH 32

Definition at line 43 of file include/metis.h.

◆ SCIDX

#define SCIDX SCNd32

Definition at line 106 of file include/metis.h.

◆ SCREAL

#define SCREAL "f"

Definition at line 134 of file include/metis.h.

◆ strtoidx

#define strtoidx strtol

Definition at line 109 of file include/metis.h.

◆ strtoreal

#define strtoreal strtof

Definition at line 146 of file include/metis.h.

Typedef Documentation

◆ idx_t

typedef int32_t idx_t

Definition at line 101 of file include/metis.h.

◆ real_t

typedef float real_t

Definition at line 132 of file include/metis.h.

Enumeration Type Documentation

◆ mctype_et

enum mctype_et

Coarsening Schemes

Enumerator
METIS_CTYPE_RM
METIS_CTYPE_SHEM

Definition at line 314 of file include/metis.h.

◆ mdbglvl_et

enum mdbglvl_et

Debug Levels

Enumerator
METIS_DBG_INFO	Shows various diagnostic messages
METIS_DBG_TIME	Perform timing analysis
METIS_DBG_COARSEN	Show the coarsening progress
METIS_DBG_REFINE	Show the refinement progress
METIS_DBG_IPART	Show info on initial partitioning
METIS_DBG_MOVEINFO	Show info on vertex moves during refinement
METIS_DBG_SEPINFO	Show info on vertex moves during sep refinement
METIS_DBG_CONNINFO	Show info on minimization of subdomain connectivity
METIS_DBG_CONTIGINFO	Show info on elimination of connected components
METIS_DBG_MEMORY	Show info related to wspace allocation

Definition at line 339 of file include/metis.h.

◆ mgtype_et

enum mgtype_et

Graph types for meshes

Enumerator
METIS_GTYPE_DUAL
METIS_GTYPE_NODAL

Definition at line 308 of file include/metis.h.

◆ miptype_et

enum miptype_et

Initial partitioning schemes

Enumerator
METIS_IPTYPE_GROW
METIS_IPTYPE_RANDOM
METIS_IPTYPE_EDGE
METIS_IPTYPE_NODE
METIS_IPTYPE_METISRB

Definition at line 320 of file include/metis.h.

◆ mobjtype_et

enum mobjtype_et

Enumerator
METIS_OBJTYPE_CUT
METIS_OBJTYPE_VOL
METIS_OBJTYPE_NODE

Definition at line 354 of file include/metis.h.

◆ moptions_et

enum moptions_et

Options codes (i.e., options[])

Enumerator
METIS_OPTION_PTYPE
METIS_OPTION_OBJTYPE
METIS_OPTION_CTYPE
METIS_OPTION_IPTYPE
METIS_OPTION_RTYPE
METIS_OPTION_DBGLVL
METIS_OPTION_NITER
METIS_OPTION_NCUTS
METIS_OPTION_SEED
METIS_OPTION_NO2HOP
METIS_OPTION_MINCONN
METIS_OPTION_CONTIG
METIS_OPTION_COMPRESS
METIS_OPTION_CCORDER
METIS_OPTION_PFACTOR
METIS_OPTION_NSEPS
METIS_OPTION_UFACTOR
METIS_OPTION_NUMBERING
METIS_OPTION_HELP
METIS_OPTION_TPWGTS
METIS_OPTION_NCOMMON
METIS_OPTION_NOOUTPUT
METIS_OPTION_BALANCE
METIS_OPTION_GTYPE
METIS_OPTION_UBVEC

Definition at line 270 of file include/metis.h.

◆ moptype_et

enum moptype_et

Operation type codes

Enumerator
METIS_OP_PMETIS
METIS_OP_KMETIS
METIS_OP_OMETIS

Definition at line 262 of file include/metis.h.

◆ mptype_et

enum mptype_et

Partitioning Schemes

Enumerator
METIS_PTYPE_RB
METIS_PTYPE_KWAY

Definition at line 302 of file include/metis.h.

◆ mrtype_et

enum mrtype_et

Refinement schemes

Enumerator
METIS_RTYPE_FM
METIS_RTYPE_GREEDY
METIS_RTYPE_SEP2SIDED
METIS_RTYPE_SEP1SIDED

Definition at line 330 of file include/metis.h.

◆ rstatus_et

enum rstatus_et

Return codes

Enumerator
METIS_OK	Returned normally
METIS_ERROR_INPUT	Returned due to erroneous inputs and/or options
METIS_ERROR_MEMORY	Returned due to insufficient memory
METIS_ERROR	Some other errors