|
15
|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
|
2 <!--NewPage-->
|
|
|
3 <HTML>
|
|
|
4 <HEAD>
|
|
|
5 <!-- Generated by javadoc (build 1.6.0_17) on Sat Mar 27 22:46:07 EDT 2010 -->
|
|
|
6 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
|
7 <TITLE>
|
|
|
8 DifferentiableMultivariateRealFunction (Commons Math 2.1 API)
|
|
|
9 </TITLE>
|
|
|
10
|
|
|
11 <META NAME="date" CONTENT="2010-03-27">
|
|
|
12
|
|
|
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
|
|
14
|
|
|
15 <SCRIPT type="text/javascript">
|
|
|
16 function windowTitle()
|
|
|
17 {
|
|
|
18 if (location.href.indexOf('is-external=true') == -1) {
|
|
|
19 parent.document.title="DifferentiableMultivariateRealFunction (Commons Math 2.1 API)";
|
|
|
20 }
|
|
|
21 }
|
|
|
22 </SCRIPT>
|
|
|
23 <NOSCRIPT>
|
|
|
24 </NOSCRIPT>
|
|
|
25
|
|
|
26 </HEAD>
|
|
|
27
|
|
|
28 <BODY BGCOLOR="white" onload="windowTitle();">
|
|
|
29 <HR>
|
|
|
30
|
|
|
31
|
|
|
32 <!-- ========= START OF TOP NAVBAR ======= -->
|
|
|
33 <A NAME="navbar_top"><!-- --></A>
|
|
|
34 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
|
35 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
36 <TR>
|
|
|
37 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
38 <A NAME="navbar_top_firstrow"><!-- --></A>
|
|
|
39 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
40 <TR ALIGN="center" VALIGN="top">
|
|
|
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DifferentiableMultivariateRealFunction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
49 </TR>
|
|
|
50 </TABLE>
|
|
|
51 </TD>
|
|
|
52 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
53 </EM>
|
|
|
54 </TD>
|
|
|
55 </TR>
|
|
|
56
|
|
|
57 <TR>
|
|
|
58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
59 <A HREF="../../../../../org/apache/commons/math/analysis/ComposableFunction.html" title="class in org.apache.commons.math.analysis"><B>PREV CLASS</B></A>
|
|
|
60 <A HREF="../../../../../org/apache/commons/math/analysis/DifferentiableMultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis"><B>NEXT CLASS</B></A></FONT></TD>
|
|
|
61 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
62 <A HREF="../../../../../index.html?org/apache/commons/math/analysis/DifferentiableMultivariateRealFunction.html" target="_top"><B>FRAMES</B></A>
|
|
|
63 <A HREF="DifferentiableMultivariateRealFunction.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
64 <SCRIPT type="text/javascript">
|
|
|
65 <!--
|
|
|
66 if(window==top) {
|
|
|
67 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
68 }
|
|
|
69 //-->
|
|
|
70 </SCRIPT>
|
|
|
71 <NOSCRIPT>
|
|
|
72 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
73 </NOSCRIPT>
|
|
|
74
|
|
|
75
|
|
|
76 </FONT></TD>
|
|
|
77 </TR>
|
|
|
78 <TR>
|
|
|
79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
80 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
81 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
82 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
83 </TR>
|
|
|
84 </TABLE>
|
|
|
85 <A NAME="skip-navbar_top"></A>
|
|
|
86 <!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
87
|
|
|
88 <HR>
|
|
|
89 <!-- ======== START OF CLASS DATA ======== -->
|
|
|
90 <H2>
|
|
|
91 <FONT SIZE="-1">
|
|
|
92 org.apache.commons.math.analysis</FONT>
|
|
|
93 <BR>
|
|
|
94 Interface DifferentiableMultivariateRealFunction</H2>
|
|
|
95 <DL>
|
|
|
96 <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateRealFunction</A></DD>
|
|
|
97 </DL>
|
|
|
98 <HR>
|
|
|
99 <DL>
|
|
|
100 <DT><PRE>public interface <A HREF="../../../../../src-html/org/apache/commons/math/analysis/DifferentiableMultivariateRealFunction.html#line.26"><B>DifferentiableMultivariateRealFunction</B></A><DT>extends <A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateRealFunction</A></DL>
|
|
|
101 </PRE>
|
|
|
102
|
|
|
103 <P>
|
|
|
104 Extension of <A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis"><CODE>MultivariateRealFunction</CODE></A> representing a differentiable
|
|
|
105 multivariate real function.
|
|
|
106 <P>
|
|
|
107
|
|
|
108 <P>
|
|
|
109 <DL>
|
|
|
110 <DT><B>Since:</B></DT>
|
|
|
111 <DD>2.0</DD>
|
|
|
112 <DT><B>Version:</B></DT>
|
|
|
113 <DD>$Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $</DD>
|
|
|
114 </DL>
|
|
|
115 <HR>
|
|
|
116
|
|
|
117 <P>
|
|
|
118
|
|
|
119 <!-- ========== METHOD SUMMARY =========== -->
|
|
|
120
|
|
|
121 <A NAME="method_summary"><!-- --></A>
|
|
|
122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
124 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
125 <B>Method Summary</B></FONT></TH>
|
|
|
126 </TR>
|
|
|
127 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
129 <CODE> <A HREF="../../../../../org/apache/commons/math/analysis/MultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateVectorialFunction</A></CODE></FONT></TD>
|
|
|
130 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/analysis/DifferentiableMultivariateRealFunction.html#gradient()">gradient</A></B>()</CODE>
|
|
|
131
|
|
|
132 <BR>
|
|
|
133 Returns the gradient function.</TD>
|
|
|
134 </TR>
|
|
|
135 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
137 <CODE> <A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateRealFunction</A></CODE></FONT></TD>
|
|
|
138 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/analysis/DifferentiableMultivariateRealFunction.html#partialDerivative(int)">partialDerivative</A></B>(int k)</CODE>
|
|
|
139
|
|
|
140 <BR>
|
|
|
141 Returns the partial derivative of the function with respect to a point coordinate.</TD>
|
|
|
142 </TR>
|
|
|
143 </TABLE>
|
|
|
144 <A NAME="methods_inherited_from_class_org.apache.commons.math.analysis.MultivariateRealFunction"><!-- --></A>
|
|
|
145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
146 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
|
147 <TH ALIGN="left"><B>Methods inherited from interface org.apache.commons.math.analysis.<A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateRealFunction</A></B></TH>
|
|
|
148 </TR>
|
|
|
149 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
150 <TD><CODE><A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html#value(double[])">value</A></CODE></TD>
|
|
|
151 </TR>
|
|
|
152 </TABLE>
|
|
|
153
|
|
|
154 <P>
|
|
|
155
|
|
|
156 <!-- ============ METHOD DETAIL ========== -->
|
|
|
157
|
|
|
158 <A NAME="method_detail"><!-- --></A>
|
|
|
159 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
160 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
161 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
162 <B>Method Detail</B></FONT></TH>
|
|
|
163 </TR>
|
|
|
164 </TABLE>
|
|
|
165
|
|
|
166 <A NAME="partialDerivative(int)"><!-- --></A><H3>
|
|
|
167 partialDerivative</H3>
|
|
|
168 <PRE>
|
|
|
169 <A HREF="../../../../../org/apache/commons/math/analysis/MultivariateRealFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateRealFunction</A> <A HREF="../../../../../src-html/org/apache/commons/math/analysis/DifferentiableMultivariateRealFunction.html#line.40"><B>partialDerivative</B></A>(int k)</PRE>
|
|
|
170 <DL>
|
|
|
171 <DD>Returns the partial derivative of the function with respect to a point coordinate.
|
|
|
172 <p>
|
|
|
173 The partial derivative is defined with respect to point coordinate
|
|
|
174 x<sub>k</sub>. If the partial derivatives with respect to all coordinates are
|
|
|
175 needed, it may be more efficient to use the <A HREF="../../../../../org/apache/commons/math/analysis/DifferentiableMultivariateRealFunction.html#gradient()"><CODE>gradient()</CODE></A> method which will
|
|
|
176 compute them all at once.
|
|
|
177 </p>
|
|
|
178 <P>
|
|
|
179 <DD><DL>
|
|
|
180 </DL>
|
|
|
181 </DD>
|
|
|
182 <DD><DL>
|
|
|
183 <DT><B>Parameters:</B><DD><CODE>k</CODE> - index of the coordinate with respect to which the partial
|
|
|
184 derivative is computed
|
|
|
185 <DT><B>Returns:</B><DD>the partial derivative function with respect to k<sup>th</sup> point coordinate</DL>
|
|
|
186 </DD>
|
|
|
187 </DL>
|
|
|
188 <HR>
|
|
|
189
|
|
|
190 <A NAME="gradient()"><!-- --></A><H3>
|
|
|
191 gradient</H3>
|
|
|
192 <PRE>
|
|
|
193 <A HREF="../../../../../org/apache/commons/math/analysis/MultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis">MultivariateVectorialFunction</A> <A HREF="../../../../../src-html/org/apache/commons/math/analysis/DifferentiableMultivariateRealFunction.html#line.49"><B>gradient</B></A>()</PRE>
|
|
|
194 <DL>
|
|
|
195 <DD>Returns the gradient function.
|
|
|
196 <p>If only one partial derivative with respect to a specific coordinate is
|
|
|
197 needed, it may be more efficient to use the <A HREF="../../../../../org/apache/commons/math/analysis/DifferentiableMultivariateRealFunction.html#partialDerivative(int)"><CODE>partialDerivative(int)</CODE></A> method
|
|
|
198 which will compute only the specified component.</p>
|
|
|
199 <P>
|
|
|
200 <DD><DL>
|
|
|
201 </DL>
|
|
|
202 </DD>
|
|
|
203 <DD><DL>
|
|
|
204
|
|
|
205 <DT><B>Returns:</B><DD>the gradient function</DL>
|
|
|
206 </DD>
|
|
|
207 </DL>
|
|
|
208 <!-- ========= END OF CLASS DATA ========= -->
|
|
|
209 <HR>
|
|
|
210
|
|
|
211
|
|
|
212 <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
|
213 <A NAME="navbar_bottom"><!-- --></A>
|
|
|
214 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
|
215 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
216 <TR>
|
|
|
217 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
218 <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
|
219 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
220 <TR ALIGN="center" VALIGN="top">
|
|
|
221 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
222 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
223 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
224 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DifferentiableMultivariateRealFunction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
225 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
226 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
227 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
228 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
229 </TR>
|
|
|
230 </TABLE>
|
|
|
231 </TD>
|
|
|
232 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
233 </EM>
|
|
|
234 </TD>
|
|
|
235 </TR>
|
|
|
236
|
|
|
237 <TR>
|
|
|
238 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
239 <A HREF="../../../../../org/apache/commons/math/analysis/ComposableFunction.html" title="class in org.apache.commons.math.analysis"><B>PREV CLASS</B></A>
|
|
|
240 <A HREF="../../../../../org/apache/commons/math/analysis/DifferentiableMultivariateVectorialFunction.html" title="interface in org.apache.commons.math.analysis"><B>NEXT CLASS</B></A></FONT></TD>
|
|
|
241 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
242 <A HREF="../../../../../index.html?org/apache/commons/math/analysis/DifferentiableMultivariateRealFunction.html" target="_top"><B>FRAMES</B></A>
|
|
|
243 <A HREF="DifferentiableMultivariateRealFunction.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
244 <SCRIPT type="text/javascript">
|
|
|
245 <!--
|
|
|
246 if(window==top) {
|
|
|
247 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
248 }
|
|
|
249 //-->
|
|
|
250 </SCRIPT>
|
|
|
251 <NOSCRIPT>
|
|
|
252 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
253 </NOSCRIPT>
|
|
|
254
|
|
|
255
|
|
|
256 </FONT></TD>
|
|
|
257 </TR>
|
|
|
258 <TR>
|
|
|
259 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
260 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
261 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
262 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
263 </TR>
|
|
|
264 </TABLE>
|
|
|
265 <A NAME="skip-navbar_bottom"></A>
|
|
|
266 <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
267
|
|
|
268 <HR>
|
|
|
269 Copyright © 2003-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
|
|
|
270 </BODY>
|
|
|
271 </HTML>
|
