File: DSSort.html

package info (click to toggle)
slepc 3.23.1%2Bdfsg1-1exp2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 48,276 kB
  • sloc: ansic: 103,363; python: 6,078; f90: 3,286; cpp: 1,528; makefile: 772; sh: 311
file content (61 lines) | stat: -rw-r--r-- 4,226 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
51
52
53
54
55
56
57
58
59
60
61
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current//Users/jroman/tmp/slepc-3.23.1/docs/manualpages/DS/DSSort.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>DSSort</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>slepc-3.23.1 2025-05-01</b></div>
   <div id="bugreport" align=right><a href="mailto:slepc-maint@upv.es?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: slepc-3.23.1 v3.23.1 /Users/jroman/tmp/slepc-3.23.1/docs/manualpages/DS/DSSort.html "><small>Report Typos and Errors</small></a></div>
<H1>DSSort</H1>
Sorts the result of <A HREF="../DS/DSSolve.html#DSSolve">DSSolve</A>() according to a given sorting criterion. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcds.h" 
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DS/DSSort.html#DSSort">DSSort</A>(<A HREF="../DS/DS.html#DS">DS</A> ds,<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> eigr[],<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> eigi[],<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> rr[],<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> ri[],<A HREF="https://petsc.org/release/manualpages/Sys/PetscInt.html#PetscInt">PetscInt</A> *k)
</PRE>
Logically Collective
<P>
<H3><FONT COLOR="#883300">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ds   </B></TD><TD>&nbsp;- the direct solver context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>rr   </B></TD><TD>&nbsp;- (optional) array containing auxiliary values (real part)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ri   </B></TD><TD>&nbsp;- (optional) array containing auxiliary values (imaginary part)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Input/Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>eigr </B></TD><TD>&nbsp;- array containing the computed eigenvalues (real part)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>eigi </B></TD><TD>&nbsp;- array containing the computed eigenvalues (imaginary part)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>k    </B></TD><TD>&nbsp;- (optional) number of elements in the leading group
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
This routine sorts the arrays provided in eigr and eigi, and also
sorts the dense system stored inside ds (assumed to be in condensed form).
The sorting criterion is specified with <A HREF="../DS/DSSetSlepcSC.html#DSSetSlepcSC">DSSetSlepcSC</A>().
<P>
If arrays rr and ri are provided, then a (partial) reordering based on these
values rather than on the eigenvalues is performed. In symmetric problems
a total order is obtained (parameter k is ignored), but otherwise the result
is sorted only partially. In this latter case, it is only guaranteed that
all the first k elements satisfy the comparison with any of the last n-k
elements. The output value of parameter k is the final number of elements in
the first set.
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../DS/DSSolve.html#DSSolve">DSSolve</A>(), <A HREF="../DS/DSSetSlepcSC.html#DSSetSlepcSC">DSSetSlepcSC</A>(), <A HREF="../DS/DSSortWithPermutation.html#DSSortWithPermutation">DSSortWithPermutation</A>()
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/sys/classes/ds/interface/dsops.c.html#DSSort">src/sys/classes/ds/interface/dsops.c</A>
<BR><BR><A HREF="./index.html">Index of all DS routines</A>
<BR><A HREF="../../../docs/manual.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>