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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Tao/TaoGetSolutionStatus.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoGetSolutionStatus</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/Tao/TaoGetSolutionStatus.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoGetSolutionStatus"><H1>TaoGetSolutionStatus</H1></A>
Get the current iterate, objective value, residual, infeasibility, and termination
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctao.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Tao/TaoGetSolutionStatus.html#TaoGetSolutionStatus">TaoGetSolutionStatus</A>(<A HREF="../Tao/Tao.html#Tao">Tao</A> tao, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *its, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *f, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *gnorm, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *cnorm, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *xdiff, <A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TaoConvergedReason</A> *reason)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<DT><B>tao </B> -the <A HREF="../Tao/Tao.html#Tao">Tao</A> context
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>iterate </B></TD><TD>- the current iterate number (>=0)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>f </B></TD><TD>- the current function value
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>gnorm </B></TD><TD>- the square of the gradient norm, duality gap, or other measure indicating distance from optimality.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>cnorm </B></TD><TD>- the infeasibility of the current solution with regard to the constraints.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>xdiff </B></TD><TD>- the step length or trust region radius of the most recent iterate.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>reason </B></TD><TD>- The termination reason, which can equal <A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_CONTINUE_ITERATING</A>
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
TAO returns the values set by the solvers in the routine <A HREF="../Tao/TaoMonitor.html#TaoMonitor">TaoMonitor</A>().
<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
If any of the output arguments are set to NULL, no corresponding value will be returned.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Tao/TaoMonitor.html#TaoMonitor">TaoMonitor</A>(), <A HREF="../Tao/TaoGetConvergedReason.html#TaoGetConvergedReason">TaoGetConvergedReason</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/tao/interface/taosolver.c.html#TaoGetSolutionStatus">src/tao/interface/taosolver.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/eptorsion2f.F.html">src/tao/unconstrained/examples/tutorials/eptorsion2f.F.html</A><BR>
<A HREF="../../../src/tao/bound/examples/tutorials/jbearing2.c.html">src/tao/bound/examples/tutorials/jbearing2.c.html</A><BR>
<BR><A HREF="./index.html">Index of all Tao 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>
|
