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
62
|
<!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/TaoLineSearchSetObjectiveAndGradientRoutine.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoLineSearchSetObjectiveAndGradientRoutine</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/TaoLineSearch/TaoLineSearchSetObjectiveAndGradientRoutine.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoLineSearchSetObjectiveAndGradientRoutine"><H1>TaoLineSearchSetObjectiveAndGradientRoutine</H1></A>
Sets the objective/gradient evaluation routine for the line search
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctaolinesearch.h"
PetscErrorCode TaoLineSearchSetObjectiveAndGradientRoutine(TaoLineSearch ls, PetscErrorCode(*func)(TaoLineSearch ls, Vec x, PetscReal *, Vec g, void*), void *ctx)
</PRE>
Logically Collective on TaoLineSearch
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</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>func </B></TD><TD>- the objective and gradient evaluation routine
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- the (optional) user-defined context for private data
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling sequence of func</FONT></H3>
<pre>
func (TaoLinesearch ls, <A HREF="../Vec/Vec.html#Vec">Vec</A> x, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *f, <A HREF="../Vec/Vec.html#Vec">Vec</A> g, void *ctx);
</pre>
<P>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>x </B></TD><TD>- input vector
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>f </B></TD><TD>- function value
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>g </B></TD><TD>- gradient vector
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx (optional) user</B></TD><TD>- defined context
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
Use this routine only if you want the line search objective and gradient
evaluation routines to be different from the <A HREF="../Tao/Tao.html#Tao">Tao</A>'s objective
and gradient evaluation routines.
<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
Some algorithms (lcl, gpcg) set their own objective routine for the
line search, application programmers should be wary of overriding the
default objective routine.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../TaoLineSearch/TaoLineSearchCreate.html#TaoLineSearchCreate">TaoLineSearchCreate</A>(), <A HREF="../TaoLineSearch/TaoLineSearchSetObjectiveRoutine.html#TaoLineSearchSetObjectiveRoutine">TaoLineSearchSetObjectiveRoutine</A>(), <A HREF="../TaoLineSearch/TaoLineSearchSetGradientRoutine.html#TaoLineSearchSetGradientRoutine">TaoLineSearchSetGradientRoutine</A>(), <A HREF="../TaoLineSearch/TaoLineSearchUseTaoRoutines.html#TaoLineSearchUseTaoRoutines">TaoLineSearchUseTaoRoutines</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>beginner
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/tao/linesearch/interface/taolinesearch.c.html#TaoLineSearchSetObjectiveAndGradientRoutine">src/tao/linesearch/interface/taolinesearch.c</A>
<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>
|
