nl_cholmod.c 5.53 KB
Newer Older
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
/*
 *  Copyright (c) 2004-2010, Bruno Levy
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation
 *  and/or other materials provided with the distribution.
 *  * Neither the name of the ALICE Project-Team nor the names of its
 *  contributors may be used to endorse or promote products derived from this
 *  software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 *  If you modify this software, you should include a notice giving the
 *  name of the person performing the modification, the date of modification,
 *  and the reason for such modification.
 *
 *  Contact: Bruno Levy
 *
 *     levy@loria.fr
 *
 *     ALICE Project
 *     LORIA, INRIA Lorraine,
 *     Campus Scientifique, BP 239
 *     54506 VANDOEUVRE LES NANCY CEDEX
 *     FRANCE
 *
 */

#include <NL/nl_cholmod.h>
#include <NL/nl_context.h>

/************************************************************************/
/* CHOLMOD wrapper */

#ifdef NL_USE_CHOLMOD

/* CHOLMOD includes */
#include <cholmod.h>



typedef struct {
	cholmod_common c ;
60 61
	cholmod_factor* cL ; // factor
	cholmod_dense* cb ;  // right-hand side
62 63 64 65 66 67 68
} cholmod_context ;



NLboolean nlFactorize_CHOLMOD() {

	/* OpenNL Context */
69 70 71
	NLSparseMatrix* M   = &(nlCurrentContext->M) ;
	NLuint          n   = nlCurrentContext->n ;
	NLuint          nnz = nlSparseMatrixNNZ(M) ; /* Number of Non-Zero coeffs */
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

	cholmod_context* context = (cholmod_context*)(nlCurrentContext->direct_solver_context) ;
	if(context == NULL) {
		nlCurrentContext->direct_solver_context = malloc(sizeof(cholmod_context)) ;
		context = (cholmod_context*)(nlCurrentContext->direct_solver_context) ;
	}

	/* CHOLMOD variables */
	cholmod_sparse* cA = NULL ;

	/* Temporary variables */
	NLRowColumn* Ci = NULL ;
	NLuint       i,j,count ;

	/* Sanity checks */
	nl_assert(M->storage & NL_MATRIX_STORE_COLUMNS) ;
	nl_assert(M->m == M->n) ;

90 91
	cholmod_start(&(context->c)) ;

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
	/*
	 * Step 1: convert matrix M into CHOLMOD compressed column representation
	 * ----------------------------------------------------------------------
	 */

	cA = cholmod_allocate_sparse(n, n, nnz, NL_FALSE, NL_TRUE, -1, CHOLMOD_REAL, &(context->c)) ;
	int* colptr = (int*)(cA->p) ;
	int* rowind = (int*)(cA->i) ;
	double* a = (double*)(cA->x) ;

	count = 0 ;
	for(i = 0; i < n; i++) {
		Ci = &(M->column[i]);
		colptr[i] = count ;
		for(j = 0; j < Ci->size; j++) {
			a[count]      = Ci->coeff[j].value ;
			rowind[count] = Ci->coeff[j].index ;
			count++ ;
		}
	}
	colptr[n] = nnz ;

	// pre-allocate CHOLMOD right-hand side vector
	context->cb = cholmod_allocate_dense(n, 1, n, CHOLMOD_REAL, &(context->c)) ;

	/*
	 * Step 2: factorize matrix
	 * ------------------------
	 */

	context->cL = cholmod_analyze(cA, &(context->c)) ;
	cholmod_factorize(cA, context->cL, &(context->c)) ;

	/*
	 * Step 3: cleanup
	 * ---------------
	 */

	cholmod_free_sparse(&cA, &(context->c)) ;

	return NL_TRUE ;
}

NLboolean nlSolve_CHOLMOD() {

	/* OpenNL Context */
	NLdouble* b = nlCurrentContext->b ;
	NLdouble* x = nlCurrentContext->x ;
140
	NLuint    n = nlCurrentContext->n ;
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156

	cholmod_context* context = (cholmod_context*)(nlCurrentContext->direct_solver_context) ;
	nl_assert(context != NULL) ;

	/* CHOLMOD variables */
	cholmod_dense* cx = NULL ;

	/* Temporary variables */
	NLuint i ;

	/*
	 * Step 1: convert right-hand side into CHOLMOD representation
	 * -----------------------------------------------------------
	 */

	double* cbx = (double*)(context->cb->x) ;
157
	for(i = 0; i < n; i++)
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
		cbx[i] = b[i] ;

	/*
	 * Step 2: solve
	 * -------------
	 */

	cx = cholmod_solve(CHOLMOD_A, context->cL, context->cb, &(context->c)) ;

	/*
	 * Step 3: get the solution
	 * ------------------------
	 */

	double* cxx = (double*)(cx->x) ;
	for(i = 0; i < n; i++)
		x[i] = cxx[i] ;

	/*
	 * Step 4: cleanup
	 * ---------------
	 */

	cholmod_free_dense(&cx, &(context->c)) ;

	return NL_TRUE ;
}

void nlClear_CHOLMOD() {

	cholmod_context* context = (cholmod_context*)(nlCurrentContext->direct_solver_context) ;
	if(context != NULL) {
		/* free CHOLMOD structures */
		cholmod_free_factor(&(context->cL), &(context->c)) ;
		cholmod_free_dense(&(context->cb), &(context->c)) ;
		cholmod_finish(&(context->c)) ;
	}
}

#else

NLboolean nlFactorize_CHOLMOD() {
	nl_assert_not_reached ;
	return NL_FALSE ;
}

NLboolean nlSolve_CHOLMOD() {
	nl_assert_not_reached ;
	return NL_FALSE ;
}

209 210 211 212 213
NLboolean nlClear_CHOLMOD() {
	nl_assert_not_reached ;
	return NL_FALSE ;
}

214
#endif