[−][src]Function suitesparse_camd_sys::camd_order

pub unsafe extern "C" fn camd_order(
    n: SuiteSparseInt, 
    ap: *const SuiteSparseInt, 
    ai: *const SuiteSparseInt, 
    p: *mut SuiteSparseInt, 
    control: *mut c_double, 
    info: *mut c_double, 
    constraint: *mut SuiteSparseInt
) -> SuiteSparseInt

Find a permutation matrix P, represented by the permutation indices p, which reduces the fill-in of the symmetric sparse matrix A (represented by its index pointer ap and indices pointer ai) in Cholesky factorization (ie, the number of nonzeros of the Cholesky factorization of P A P^T is less than for the Cholesky factorization of A).

If A is not symmetric, the ordering will be computed for A + A^T

Safety and constraints

  • n is the number of rows and columns of the matrix A and should be positive
  • ap must be an array of length n + 1.
  • ai must be an array of length ap[n]. The performance is better if ai[ap[i]..ap[i+1]] is always sorted and without duplicates.
  • p must be an array of length n. Its contents can be uninitialized.
  • control must be an array of size CAMD_CONTROL.
  • info must be an array of size CAMD_INFO.
  • constraint must be either the null pointer, or an array of size n.