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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Mat/MatRestoreRow.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatRestoreRow</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.10.3 2018-12-18</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.10.3 v3.10.3 docs/manualpages/Mat/MatRestoreRow.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatRestoreRow"><H1>MatRestoreRow</H1></A>
Frees any temporary space allocated by <A HREF="../Mat/MatGetRow.html#MatGetRow">MatGetRow</A>().
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatRestoreRow.html#MatRestoreRow">MatRestoreRow</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> row,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *ncols,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *cols[],const <A HREF="../Sys/PetscScalar.html#PetscScalar">PetscScalar</A> *vals[])
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mat </B></TD><TD>- the matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>row </B></TD><TD>- the row to get
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ncols, cols </B></TD><TD>- the number of nonzeros and their columns
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>vals </B></TD><TD>- if nonzero the column values
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This routine should be called after you have finished examining the entries.
<P>
This routine zeros out ncols, cols, and vals. This is to prevent accidental
us of the array after it has been restored. If you pass NULL, it will
not zero the pointers. Use of cols or vals after <A HREF="../Mat/MatRestoreRow.html#MatRestoreRow">MatRestoreRow</A> is invalid.
<P>
<H3><FONT COLOR="#CC3333">Fortran Notes</FONT></H3>
The calling sequence from Fortran is
<PRE>
<A HREF="../Mat/MatRestoreRow.html#MatRestoreRow">MatRestoreRow</A>(matrix,row,ncols,cols,values,ierr)
<A HREF="../Mat/Mat.html#Mat">Mat</A> matrix (input)
integer row (input)
integer ncols (output)
integer cols(maxcols) (output)
double precision (or double complex) values(maxcols) output
</PRE>
Where maxcols >= maximum nonzeros in any row of the matrix.
<P>
In Fortran <A HREF="../Mat/MatRestoreRow.html#MatRestoreRow">MatRestoreRow</A>() MUST be called after <A HREF="../Mat/MatGetRow.html#MatGetRow">MatGetRow</A>()
before another call to <A HREF="../Mat/MatGetRow.html#MatGetRow">MatGetRow</A>() can be made.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatGetRow.html#MatGetRow">MatGetRow</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/interface/matrix.c.html#MatRestoreRow">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/mat/examples/tutorials/ex12.c.html">src/mat/examples/tutorials/ex12.c.html</A><BR>
<A HREF="../../../src/mat/examples/tutorials/ex16.c.html">src/mat/examples/tutorials/ex16.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/adj/mpi/mpiadj.c.html#MatRestoreRow_MPIAdj">MatRestoreRow_MPIAdj in src/mat/impls/adj/mpi/mpiadj.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mpiaij.c.html#MatRestoreRow_MPIAIJ">MatRestoreRow_MPIAIJ in src/mat/impls/aij/mpi/mpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aij.c.html#MatRestoreRow_SeqAIJ">MatRestoreRow_SeqAIJ in src/mat/impls/aij/seq/aij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/mpibaij.c.html#MatRestoreRow_MPIBAIJ">MatRestoreRow_MPIBAIJ in src/mat/impls/baij/mpi/mpibaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baij.c.html#MatRestoreRow_SeqBAIJ">MatRestoreRow_SeqBAIJ in src/mat/impls/baij/seq/baij.c</A><BR>
<A HREF="../../../src/mat/impls/dense/mpi/mpidense.c.html#MatRestoreRow_MPIDense">MatRestoreRow_MPIDense in src/mat/impls/dense/mpi/mpidense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/dense.c.html#MatRestoreRow_SeqDense">MatRestoreRow_SeqDense in src/mat/impls/dense/seq/dense.c</A><BR>
<A HREF="../../../src/mat/impls/hypre/mhypre.c.html#MatRestoreRow_HYPRE">MatRestoreRow_HYPRE in src/mat/impls/hypre/mhypre.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/mpi/mpisbaij.c.html#MatRestoreRow_MPISBAIJ">MatRestoreRow_MPISBAIJ in src/mat/impls/sbaij/mpi/mpisbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/sbaij.c.html#MatRestoreRow_SeqSBAIJ">MatRestoreRow_SeqSBAIJ in src/mat/impls/sbaij/seq/sbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sell/seq/sell.c.html#MatRestoreRow_SeqSELL">MatRestoreRow_SeqSELL in src/mat/impls/sell/seq/sell.c</A><BR>
<BR><A HREF="./index.html">Index of all Mat routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
