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
|
<!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/TaoLineSearchComputeObjectiveAndGTS.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoLineSearchComputeObjectiveAndGTS</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/TaoLineSearchComputeObjectiveAndGTS.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoLineSearchComputeObjectiveAndGTS"><H1>TaoLineSearchComputeObjectiveAndGTS</H1></A>
Computes the objective function value and inner product of gradient and step direction at a given point
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctaolinesearch.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../TaoLineSearch/TaoLineSearchComputeObjectiveAndGTS.html#TaoLineSearchComputeObjectiveAndGTS">TaoLineSearchComputeObjectiveAndGTS</A>(TaoLineSearch ls, <A HREF="../Vec/Vec.html#Vec">Vec</A> x, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *f, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *gts)
</PRE>
Collective on <A HREF="../Tao/Tao.html#Tao">Tao</A>
<P>
<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>x </B></TD><TD>- input vector
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>f </B></TD><TD>- Objective value at X
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>gts </B></TD><TD>- inner product of gradient and step direction at X
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<A HREF="../TaoLineSearch/TaoLineSearchComputeObjectiveAndGTS.html#TaoLineSearchComputeObjectiveAndGTS">TaoLineSearchComputeObjectiveAndGTS</A>() is typically used within line searches
so most users would not generally call this routine themselves.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../TaoLineSearch/TaoLineSearchComputeGradient.html#TaoLineSearchComputeGradient">TaoLineSearchComputeGradient</A>(), <A HREF="../TaoLineSearch/TaoLineSearchComputeObjectiveAndGradient.html#TaoLineSearchComputeObjectiveAndGradient">TaoLineSearchComputeObjectiveAndGradient</A>(), <A HREF="../TaoLineSearch/TaoLineSearchSetObjectiveRoutine.html#TaoLineSearchSetObjectiveRoutine">TaoLineSearchSetObjectiveRoutine</A>()
<BR><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#TaoLineSearchComputeObjectiveAndGTS">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>
|
