/usr/include/suitesparse/cholmod_partition.h is in libsuitesparse-dev 1:5.1.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /* ========================================================================== */
/* === Include/cholmod_partition.h ========================================== */
/* ========================================================================== */
/* -----------------------------------------------------------------------------
* CHOLMOD/Include/cholmod_partition.h.
* Copyright (C) 2005-2013, Univ. of Florida. Author: Timothy A. Davis
* -------------------------------------------------------------------------- */
/* CHOLMOD Partition module.
*
* Graph partitioning and graph-partition-based orderings. Includes an
* interface to CCOLAMD and CSYMAMD, constrained minimum degree ordering
* methods which order a matrix following constraints determined via nested
* dissection.
*
* These functions require METIS:
* cholmod_nested_dissection CHOLMOD nested dissection ordering
* cholmod_metis METIS nested dissection ordering (METIS_NodeND)
* cholmod_bisect graph partitioner (currently based on METIS)
* cholmod_metis_bisector direct interface to METIS_ComputeVertexSeparator
*
* Requires the Core and Cholesky modules, and three packages: METIS, CAMD,
* and CCOLAMD. Optionally used by the Cholesky module.
*
* Note that METIS does not have a version that uses SuiteSparse_long integers.
* If you try to use cholmod_nested_dissection, cholmod_metis, cholmod_bisect,
* or cholmod_metis_bisector on a matrix that is too large, an error code will
* be returned. METIS does have an "idxtype", which could be redefined as
* SuiteSparse_long, if you wish to edit METIS or use compile-time flags to
* redefine idxtype.
*/
#ifndef CHOLMOD_PARTITION_H
#define CHOLMOD_PARTITION_H
#include "cholmod_core.h"
#include "cholmod_camd.h"
/* -------------------------------------------------------------------------- */
/* cholmod_nested_dissection */
/* -------------------------------------------------------------------------- */
/* Order A, AA', or A(:,f)*A(:,f)' using CHOLMOD's nested dissection method
* (METIS's node bisector applied recursively to compute the separator tree
* and constraint sets, followed by CCOLAMD using the constraints). Usually
* finds better orderings than METIS_NodeND, but takes longer.
*/
SuiteSparse_long cholmod_nested_dissection /* returns # of components */
(
/* ---- input ---- */
cholmod_sparse *A, /* matrix to order */
int *fset, /* subset of 0:(A->ncol)-1 */
size_t fsize, /* size of fset */
/* ---- output --- */
int *Perm, /* size A->nrow, output permutation */
int *CParent, /* size A->nrow. On output, CParent [c] is the parent
* of component c, or EMPTY if c is a root, and where
* c is in the range 0 to # of components minus 1 */
int *Cmember, /* size A->nrow. Cmember [j] = c if node j of A is
* in component c */
/* --------------- */
cholmod_common *Common
) ;
SuiteSparse_long cholmod_l_nested_dissection (cholmod_sparse *,
SuiteSparse_long *, size_t, SuiteSparse_long *, SuiteSparse_long *,
SuiteSparse_long *, cholmod_common *) ;
/* -------------------------------------------------------------------------- */
/* cholmod_metis */
/* -------------------------------------------------------------------------- */
/* Order A, AA', or A(:,f)*A(:,f)' using METIS_NodeND. */
int cholmod_metis
(
/* ---- input ---- */
cholmod_sparse *A, /* matrix to order */
int *fset, /* subset of 0:(A->ncol)-1 */
size_t fsize, /* size of fset */
int postorder, /* if TRUE, follow with etree or coletree postorder */
/* ---- output --- */
int *Perm, /* size A->nrow, output permutation */
/* --------------- */
cholmod_common *Common
) ;
int cholmod_l_metis (cholmod_sparse *, SuiteSparse_long *, size_t, int,
SuiteSparse_long *, cholmod_common *) ;
/* -------------------------------------------------------------------------- */
/* cholmod_bisect */
/* -------------------------------------------------------------------------- */
/* Finds a node bisector of A, A*A', A(:,f)*A(:,f)'. */
SuiteSparse_long cholmod_bisect /* returns # of nodes in separator */
(
/* ---- input ---- */
cholmod_sparse *A, /* matrix to bisect */
int *fset, /* subset of 0:(A->ncol)-1 */
size_t fsize, /* size of fset */
int compress, /* if TRUE, compress the graph first */
/* ---- output --- */
int *Partition, /* size A->nrow. Node i is in the left graph if
* Partition [i] = 0, the right graph if 1, and in the
* separator if 2. */
/* --------------- */
cholmod_common *Common
) ;
SuiteSparse_long cholmod_l_bisect (cholmod_sparse *, SuiteSparse_long *,
size_t, int, SuiteSparse_long *, cholmod_common *) ;
/* -------------------------------------------------------------------------- */
/* cholmod_metis_bisector */
/* -------------------------------------------------------------------------- */
/* Find a set of nodes that bisects the graph of A or AA' (direct interface
* to METIS_ComputeVertexSeperator). */
SuiteSparse_long cholmod_metis_bisector /* returns separator size */
(
/* ---- input ---- */
cholmod_sparse *A, /* matrix to bisect */
int *Anw, /* size A->nrow, node weights, can be NULL, */
/* which means the graph is unweighted. */
int *Aew, /* size nz, edge weights (silently ignored). */
/* This option was available with METIS 4, but not */
/* in METIS 5. This argument is now unused, but */
/* it remains for backward compatibilty, so as not */
/* to change the API for cholmod_metis_bisector. */
/* ---- output --- */
int *Partition, /* size A->nrow */
/* --------------- */
cholmod_common *Common
) ;
SuiteSparse_long cholmod_l_metis_bisector (cholmod_sparse *,
SuiteSparse_long *, SuiteSparse_long *, SuiteSparse_long *,
cholmod_common *) ;
/* -------------------------------------------------------------------------- */
/* cholmod_collapse_septree */
/* -------------------------------------------------------------------------- */
/* Collapse nodes in a separator tree. */
SuiteSparse_long cholmod_collapse_septree
(
/* ---- input ---- */
size_t n, /* # of nodes in the graph */
size_t ncomponents, /* # of nodes in the separator tree (must be <= n) */
double nd_oksep, /* collapse if #sep >= nd_oksep * #nodes in subtree */
size_t nd_small, /* collapse if #nodes in subtree < nd_small */
/* ---- in/out --- */
int *CParent, /* size ncomponents; from cholmod_nested_dissection */
int *Cmember, /* size n; from cholmod_nested_dissection */
/* --------------- */
cholmod_common *Common
) ;
SuiteSparse_long cholmod_l_collapse_septree (size_t, size_t, double, size_t,
SuiteSparse_long *, SuiteSparse_long *, cholmod_common *) ;
#endif
|