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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/TaoLineSearch/TaoLineSearchMonitor.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoLineSearchMonitor</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/TaoLineSearch/TaoLineSearchMonitor.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoLineSearchMonitor"><H1>TaoLineSearchMonitor</H1></A>
Monitor the line search steps. This routine will otuput the iteration number, step length, and function value before calling the implementation specific monitor.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctaolinesearch.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../TaoLineSearch/TaoLineSearchMonitor.html#TaoLineSearchMonitor">TaoLineSearchMonitor</A>(TaoLineSearch ls, <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> step)
</PRE>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ls </B></TD><TD>- the TaoLineSearch context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>its </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 objective function value
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>step </B></TD><TD>- the step length
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Key</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_monitor </B></TD><TD>- Use the default monitor, which prints statistics to standard output
</TD></TR></TABLE>
<P>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/tao/linesearch/interface/taolinesearch.c.html#TaoLineSearchMonitor">src/tao/linesearch/interface/taolinesearch.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/tao/linesearch/impls/morethuente/morethuente.c.html#TaoLineSearchMonitor_MT">TaoLineSearchMonitor_MT in src/tao/linesearch/impls/morethuente/morethuente.c</A><BR>
<BR><A HREF="./index.html">Index of all TaoLineSearch 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>
|
