File: ISSortPermutation.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (47 lines) | stat: -rw-r--r-- 2,873 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/IS/ISSortPermutation.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>ISSortPermutation</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.14.5 2021-03-03</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.14.5 v3.14.5 docs/manualpages/IS/ISSortPermutation.html "><small>Report Typos and Errors</small></a></div>
<A NAME="ISSortPermutation"><H1>ISSortPermutation</H1></A>
calculate the permutation of the indices into a nondecreasing order. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscis.h"  
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../IS/ISSortPermutation.html#ISSortPermutation">ISSortPermutation</A>(<A HREF="../IS/IS.html#IS">IS</A> f,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> always,<A HREF="../IS/IS.html#IS">IS</A> *h)
</PRE>
Not collective.
<P>
<H3><FONT COLOR="#CC3333">Input arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>f      </B></TD><TD>- <A HREF="../IS/IS.html#IS">IS</A> to sort
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>always </B></TD><TD>- build the permutation even when f's indices are nondecreasing.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output argument</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>h    </B></TD><TD>- permutation or NULL, if f is nondecreasing and always == <A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A>.
</TD></TR></TABLE>
<P>
<P>
Note: Indices in f are unchanged. f[h[i]] is the i-th smallest f index.
If always == <A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A>, an extra check is peformed to see whether
the f indices are nondecreasing. h is built on <A HREF="../Sys/PETSC_COMM_SELF.html#PETSC_COMM_SELF">PETSC_COMM_SELF</A>, since
the permutation has a local meaning only.
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../IS/ISLocalToGlobalMapping.html#ISLocalToGlobalMapping">ISLocalToGlobalMapping</A>, <A HREF="../IS/ISSort.html#ISSort">ISSort</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/vec/is/is/utils/isdiff.c.html#ISSortPermutation">src/vec/is/is/utils/isdiff.c</A>
<BR><A HREF="./index.html">Index of all IS 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>