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
|
<!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/ISComplement.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>ISComplement</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/IS/ISComplement.html "><small>Report Typos and Errors</small></a></div>
<A NAME="ISComplement"><H1>ISComplement</H1></A>
Given an index set (<A HREF="../IS/IS.html#IS">IS</A>) generates the complement index set. That is all all indices that are NOT in the given set.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscis.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../IS/ISComplement.html#ISComplement">ISComplement</A>(<A HREF="../IS/IS.html#IS">IS</A> is,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nmin,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nmax,<A HREF="../IS/IS.html#IS">IS</A> *isout)
</PRE>
Collective on <A HREF="../IS/IS.html#IS">IS</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>is </B></TD><TD>- the index set
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nmin </B></TD><TD>- the first index desired in the local part of the complement
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nmax </B></TD><TD>- the largest index desired in the local part of the complement (note that all indices in is must be greater or equal to nmin and less than nmax)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>isout </B> -the complement
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The communicator for this new <A HREF="../IS/IS.html#IS">IS</A> is the same as for the input <A HREF="../IS/IS.html#IS">IS</A>
<P>
For a parallel <A HREF="../IS/IS.html#IS">IS</A>, this will generate the local part of the complement on each process
<P>
To generate the entire complement (on each process) of a parallel <A HREF="../IS/IS.html#IS">IS</A>, first call <A HREF="../IS/ISAllGather.html#ISAllGather">ISAllGather</A>() and then
call this routine.
<P>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../IS/ISCreateGeneral.html#ISCreateGeneral">ISCreateGeneral</A>(), <A HREF="../IS/ISCreateStride.html#ISCreateStride">ISCreateStride</A>(), <A HREF="../IS/ISCreateBlock.html#ISCreateBlock">ISCreateBlock</A>(), <A HREF="../IS/ISAllGather.html#ISAllGather">ISAllGather</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/vec/is/is/utils/iscoloring.c.html#ISComplement">src/vec/is/is/utils/iscoloring.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/vec/vec/utils/tagger/examples/tutorials/ex1.c.html">src/vec/vec/utils/tagger/examples/tutorials/ex1.c.html</A><BR>
<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>
|
