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
|
<!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/MatGetRowIJ.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatGetRowIJ</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/MatGetRowIJ.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatGetRowIJ"><H1>MatGetRowIJ</H1></A>
Returns the compressed row storage i and j indices for sequential matrices.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatGetRowIJ.html#MatGetRowIJ">MatGetRowIJ</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> shift,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> symmetric,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> inodecompressed,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *n,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *ia[],const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *ja[],<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> *done)
</PRE>
Collective on <A HREF="../Mat/Mat.html#Mat">Mat</A>
<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>shift </B></TD><TD>- 0 or 1 indicating we want the indices starting at 0 or 1
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>symmetric </B></TD><TD>- <A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> or <A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A> indicating the matrix data structure should be symmetrized
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>inodecompressed </B></TD><TD>- <A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> or <A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A> indicating if the nonzero structure of the
inodes or the nonzero elements is wanted. For BAIJ matrices the compressed version is
always used.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n </B></TD><TD>- number of rows in the (possibly compressed) matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ia </B></TD><TD>- the row pointers [of length n+1]
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ja </B></TD><TD>- the column indices
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>done </B></TD><TD>- indicates if the routine actually worked and returned appropriate ia[] and ja[] arrays; callers
are responsible for handling the case when done == <A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A> and ia and ja are not set
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
You CANNOT change any of the ia[] or ja[] values.
<P>
Use <A HREF="../Mat/MatRestoreRowIJ.html#MatRestoreRowIJ">MatRestoreRowIJ</A>() when you are finished accessing the ia[] and ja[] values.
<P>
<H3><FONT COLOR="#CC3333">Fortran Notes</FONT></H3>
In Fortran use
<pre>
</pre>
<pre>
<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> ia(1), ja(1)
</pre>
<pre>
<A HREF="../Sys/PetscOffset.html#PetscOffset">PetscOffset</A> iia, jja
</pre>
<pre>
call <A HREF="../Mat/MatGetRowIJ.html#MatGetRowIJ">MatGetRowIJ</A>(mat,shift,symmetric,inodecompressed,n,ia,iia,ja,jja,done,ierr)
</pre>
<pre>
! Access the ith and jth entries via ia(iia + i) and ja(jja + j)
</pre>
<P>
or
<pre>
</pre>
<pre>
<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A>, pointer :: ia(:),ja(:)
</pre>
<pre>
call MatGetRowIJF90(mat,shift,symmetric,inodecompressed,n,ia,ja,done,ierr)
</pre>
<pre>
! Access the ith and jth entries via ia(i) and ja(j)
</pre>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatGetColumnIJ.html#MatGetColumnIJ">MatGetColumnIJ</A>(), <A HREF="../Mat/MatRestoreRowIJ.html#MatRestoreRowIJ">MatRestoreRowIJ</A>(), <A HREF="../Mat/MatSeqAIJGetArray.html#MatSeqAIJGetArray">MatSeqAIJGetArray</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/interface/matrix.c.html#MatGetRowIJ">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/adj/mpi/mpiadj.c.html#MatGetRowIJ_MPIAdj">MatGetRowIJ_MPIAdj in src/mat/impls/adj/mpi/mpiadj.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aij.c.html#MatGetRowIJ_SeqAIJ">MatGetRowIJ_SeqAIJ in src/mat/impls/aij/seq/aij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/inode.c.html#MatGetRowIJ_SeqAIJ_Inode_Symmetric">MatGetRowIJ_SeqAIJ_Inode_Symmetric in src/mat/impls/aij/seq/inode.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/inode.c.html#MatGetRowIJ_SeqAIJ_Inode_Nonsymmetric">MatGetRowIJ_SeqAIJ_Inode_Nonsymmetric in src/mat/impls/aij/seq/inode.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/inode.c.html#MatGetRowIJ_SeqAIJ_Inode">MatGetRowIJ_SeqAIJ_Inode in src/mat/impls/aij/seq/inode.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baij.c.html#MatGetRowIJ_SeqBAIJ">MatGetRowIJ_SeqBAIJ in src/mat/impls/baij/seq/baij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/sbaij.c.html#MatGetRowIJ_SeqSBAIJ">MatGetRowIJ_SeqSBAIJ in src/mat/impls/sbaij/seq/sbaij.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>
|
