MatSetPreallocationCOO#

set preallocation for matrices using a coordinate format of the entries with global indices

Synopsis#

#include "petscmat.h"  
PetscErrorCode MatSetPreallocationCOO(Mat A, PetscCount ncoo, PetscInt coo_i[], PetscInt coo_j[])

Collective

Input Parameters#

A - matrix being preallocated
ncoo - number of entries
coo_i - row indices
coo_j - column indices

Notes#

The indices coo_i and coo_j may be modified within this function. The caller should not rely on them having any specific value after this function returns. The arrays can be freed or reused immediately after this function returns.

Entries can be repeated, see MatSetValuesCOO(). Entries with negative row or column indices are allowed but will be ignored. The corresponding entries in MatSetValuesCOO() will be ignored too. Remote entries are allowed and will be properly added or inserted to the matrix, unless the matrix option MAT_IGNORE_OFF_PROC_ENTRIES is set, in which case remote entries are ignored, or MAT_NO_OFF_PROC_ENTRIES is set, in which case an error will be generated.

If you just want to create a sequential AIJ matrix (MATSEQAIJ), and your matrix entries in COO format are unique, you can also use MatCreateSeqAIJFromTriple(). But that is not recommended for iterative applications.