File: SVDGetIterationNumber.html

package info (click to toggle)
slepc 3.4.2.dfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 15,584 kB
  • ctags: 66,037
  • sloc: ansic: 51,275; makefile: 2,762; python: 1,577; fortran: 785; f90: 186; sh: 9
file content (44 lines) | stat: -rw-r--r-- 2,037 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc/slepc.css" type="text/css">
<TITLE>SVDGetIterationNumber</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">

<H1>SVDGetIterationNumber</H1>
Gets the current iteration number. If the call to <A HREF="../SVD/SVDSolve.html#SVDSolve">SVDSolve</A>() is complete, then it returns the number of iterations carried out by the solution method. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcsvd.h" 
PetscErrorCode SVDGetIterationNumber(SVD svd,PetscInt *its)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#883300">Input Parameter</FONT></H3>
<DT><B>svd </B> - the singular value solver context
<br>
<P>
<H3><FONT COLOR="#883300">Output Parameter</FONT></H3>
<DT><B>its </B> - number of iterations
<br>
<P>

<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
During the i-th iteration this call returns i-1. If <A HREF="../SVD/SVDSolve.html#SVDSolve">SVDSolve</A>() is
complete, then parameter "its" contains either the iteration number at
which convergence was successfully reached, or failure was detected.
Call <A HREF="../SVD/SVDGetConvergedReason.html#SVDGetConvergedReason">SVDGetConvergedReason</A>() to determine if the solver converged or
failed and why.
<P>
<P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/svd/interface/svdsolve.c.html#SVDGetIterationNumber">src/svd/interface/svdsolve.c</A>
<BR><A HREF="./index.html">Index of all SVD 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>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/svd/examples/tutorials/ex14.c.html">src/svd/examples/tutorials/ex14.c.html</A><BR>
<A HREF="../../../src/svd/examples/tutorials/ex15.c.html">src/svd/examples/tutorials/ex15.c.html</A><BR>
<A HREF="../../../src/svd/examples/tutorials/ex15f.F.html">src/svd/examples/tutorials/ex15f.F.html</A><BR>
</BODY></HTML>