File: MatIsTranspose.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (50 lines) | stat: -rw-r--r-- 3,311 bytes parent folder | download
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
<!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/MatIsTranspose.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatIsTranspose</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/MatIsTranspose.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatIsTranspose"><H1>MatIsTranspose</H1></A>
Test whether a matrix is another one's transpose, or its own, in which case it tests symmetry. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatIsTranspose.html#MatIsTranspose">MatIsTranspose</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> A,<A HREF="../Mat/Mat.html#Mat">Mat</A> B,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> tol,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A>  *flg)
</PRE>
Collective on <A HREF="../Mat/Mat.html#Mat">Mat</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>A </B></TD><TD>- the matrix to test
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>B </B></TD><TD>- the matrix to test against, this can equal the first parameter
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<DT><B>flg </B> -the result
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Only available for SeqAIJ/MPIAIJ matrices. The sequential algorithm
has a running time of the order of the number of nonzeros; the parallel
test involves parallel copies of the block-offdiagonal parts of the matrix.
<P>

<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Mat/MatTranspose.html#MatTranspose">MatTranspose</A>(), <A HREF="../Mat/MatIsSymmetric.html#MatIsSymmetric">MatIsSymmetric</A>(), <A HREF="../Mat/MatIsHermitian.html#MatIsHermitian">MatIsHermitian</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/interface/matrix.c.html#MatIsTranspose">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/aij/mpi/mpiaij.c.html#MatIsTranspose_MPIAIJ">MatIsTranspose_MPIAIJ in src/mat/impls/aij/mpi/mpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aij.c.html#MatIsTranspose_SeqAIJ">MatIsTranspose_SeqAIJ in src/mat/impls/aij/seq/aij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baij.c.html#MatIsTranspose_SeqBAIJ">MatIsTranspose_SeqBAIJ in src/mat/impls/baij/seq/baij.c</A><BR>
<A HREF="../../../src/mat/impls/sell/mpi/mpisell.c.html#MatIsTranspose_MPISELL">MatIsTranspose_MPISELL in src/mat/impls/sell/mpi/mpisell.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>