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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://slepc.upv.es/documentation/current/docs/manualpages/FN/FNSetScale.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>FNSetScale</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>slepc-3.7.3 2016-09-29</b></div>
<div id="bugreport" align=right><a href="mailto:slepc-maint@upv.es?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: slepc-3.7.3 v3.7.3 docs/manualpages/FN/FNSetScale.html "><small>Report Typos and Errors</small></a></div>
<H1>FNSetScale</H1>
Sets the scaling parameters that define the matematical function.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcfn.h"
PetscErrorCode FNSetScale(FN fn,PetscScalar alpha,PetscScalar beta)
</PRE>
Logically Collective on <A HREF="../FN/FN.html#FN">FN</A>
<P>
<H3><FONT COLOR="#883300">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fn </B></TD><TD> - the math function context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>alpha </B></TD><TD> - inner scaling (argument)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>beta </B></TD><TD> - outer scaling (result)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
Given a function f(x) specified by the <A HREF="../FN/FN.html#FN">FN</A> type, the scaling parameters can
be used to realize the function beta*f(alpha*x). So when these values are given,
the procedure for function evaluation will first multiply the argument by alpha,
then evaluate the function itself, and finally scale the result by beta.
Likewise, these values are also considered when evaluating the derivative.
<P>
If you want to provide only one of the two scaling factors, set the other
one to 1.0.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../FN/FNGetScale.html#FNGetScale">FNGetScale</A>(), <A HREF="../FN/FNEvaluateFunction.html#FNEvaluateFunction">FNEvaluateFunction</A>()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/sys/classes/fn/interface/fnbasic.c.html#FNSetScale">src/sys/classes/fn/interface/fnbasic.c</A>
<BR><A HREF="./index.html">Index of all FN 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>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/nep/examples/tutorials/ex22.c.html">src/nep/examples/tutorials/ex22.c.html</A><BR>
<A HREF="../../../src/nep/examples/nlevp/gun.c.html">src/nep/examples/nlevp/gun.c.html</A><BR>
<A HREF="../../../src/mfn/examples/tutorials/ex23.c.html">src/mfn/examples/tutorials/ex23.c.html</A><BR>
</BODY></HTML>
|
