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/TaoLineSearch/TaoLineSearchSetFromOptions.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoLineSearchSetFromOptions</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/TaoLineSearch/TaoLineSearchSetFromOptions.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoLineSearchSetFromOptions"><H1>TaoLineSearchSetFromOptions</H1></A>
Sets various TaoLineSearch parameters from user options.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctaolinesearch.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../TaoLineSearch/TaoLineSearchSetFromOptions.html#TaoLineSearchSetFromOptions">TaoLineSearchSetFromOptions</A>(TaoLineSearch ls)
</PRE>
Collective on TaoLineSearch
<P>
<H3><FONT COLOR="#CC3333">Input Paremeter</FONT></H3>
<DT><B>ls </B> -the TaoLineSearch context
<br>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_type <type> </B></TD><TD>- The algorithm that TAO uses (more-thuente, gpcg, unit)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_ftol <tol> </B></TD><TD>- tolerance for sufficient decrease
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_gtol <tol> </B></TD><TD>- tolerance for curvature condition
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_rtol <tol> </B></TD><TD>- relative tolerance for acceptable step
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_stepmin <step> </B></TD><TD>- minimum steplength allowed
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_stepmax <step> </B></TD><TD>- maximum steplength allowed
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_max_funcs <n> </B></TD><TD>- maximum number of function evaluations allowed
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_ls_view </B></TD><TD>- display line-search results to standard output
</TD></TR></TABLE>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/tao/linesearch/interface/taolinesearch.c.html#TaoLineSearchSetFromOptions">src/tao/linesearch/interface/taolinesearch.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/tao/linesearch/impls/armijo/armijo.c.html#TaoLineSearchSetFromOptions_Armijo">TaoLineSearchSetFromOptions_Armijo in src/tao/linesearch/impls/armijo/armijo.c</A><BR>
<A HREF="../../../src/tao/linesearch/impls/morethuente/morethuente.c.html#TaoLineSearchSetFromOptions_MT">TaoLineSearchSetFromOptions_MT in src/tao/linesearch/impls/morethuente/morethuente.c</A><BR>
<A HREF="../../../src/tao/linesearch/impls/owarmijo/owarmijo.c.html#TaoLineSearchSetFromOptions_OWArmijo">TaoLineSearchSetFromOptions_OWArmijo in src/tao/linesearch/impls/owarmijo/owarmijo.c</A><BR>
<A HREF="../../../src/tao/linesearch/impls/unit/unit.c.html#TaoLineSearchSetFromOptions_Unit">TaoLineSearchSetFromOptions_Unit in src/tao/linesearch/impls/unit/unit.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>
|
