/usr/share/gtk-doc/html/libgwyddion/libgwyddion-GwyNLFitter.html is in libgwyddion20-doc 2.26-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GwyNLFitter</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="prev" href="libgwyddion-Math-Fallback.html" title="Math Fallback">
<link rel="next" href="GwyNLFitPreset.html" title="GwyNLFitPreset">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgwyddion-Math-Fallback.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gwyddion Library Reference Manual</th>
<td><a accesskey="n" href="GwyNLFitPreset.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgwyddion-GwyNLFitter.synopsis" class="shortcut">Top</a>
|
<a href="#libgwyddion-GwyNLFitter.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwyddion-GwyNLFitter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyddion-GwyNLFitter.top_of_page"></a>GwyNLFitter</span></h2>
<p>GwyNLFitter — Marquardt-Levenberg nonlinear least square fitter</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyddion-GwyNLFitter.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwyddion/gwyddion.h>
<span class="returnvalue">void</span> (<a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitDerFunc" title="GwyNLFitDerFunc ()">*GwyNLFitDerFunc</a>) (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_param</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *param</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *fixed_param</code></em>,
<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitFunc" title="GwyNLFitFunc ()"><span class="type">GwyNLFitFunc</span></a> fmarq</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *deriv</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *dres</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> (<a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitFunc" title="GwyNLFitFunc ()">*GwyNLFitFunc</a>) (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_param</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *param</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *fres</code></em>);
struct <a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter">GwyNLFitter</a>;
<span class="returnvalue">void</span> <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-derive" title="gwy_math_nlfit_derive ()">gwy_math_nlfit_derive</a> (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_param</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *param</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *fixed_param</code></em>,
<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitFunc" title="GwyNLFitFunc ()"><span class="type">GwyNLFitFunc</span></a> ff</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *deriv</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *dres</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-fit" title="gwy_math_nlfit_fit ()">gwy_math_nlfit_fit</a> (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_dat</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *x</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *y</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_param</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *param</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-fit-full" title="gwy_math_nlfit_fit_full ()">gwy_math_nlfit_fit_full</a> (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_dat</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *x</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *y</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *weight</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_param</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *param</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *fixed_param</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *link_map</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-free" title="gwy_math_nlfit_free ()">gwy_math_nlfit_free</a> (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-get-correlations" title="gwy_math_nlfit_get_correlations ()">gwy_math_nlfit_get_correlations</a> (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> par1</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> par2</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-get-dispersion" title="gwy_math_nlfit_get_dispersion ()">gwy_math_nlfit_get_dispersion</a> (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-get-max-iterations" title="gwy_math_nlfit_get_max_iterations ()">gwy_math_nlfit_get_max_iterations</a> (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-get-sigma" title="gwy_math_nlfit_get_sigma ()">gwy_math_nlfit_get_sigma</a> (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> par</code></em>);
<a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="returnvalue">GwyNLFitter</span></a> * <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-new" title="gwy_math_nlfit_new ()">gwy_math_nlfit_new</a> (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitFunc" title="GwyNLFitFunc ()"><span class="type">GwyNLFitFunc</span></a> ff</code></em>,
<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitDerFunc" title="GwyNLFitDerFunc ()"><span class="type">GwyNLFitDerFunc</span></a> df</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-set-max-iterations" title="gwy_math_nlfit_set_max_iterations ()">gwy_math_nlfit_set_max_iterations</a> (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> maxiter</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-succeeded" title="gwy_math_nlfit_succeeded ()">gwy_math_nlfit_succeeded</a> (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyddion-GwyNLFitter.description"></a><h2>Description</h2>
<p>
A new Marquardt-Levenberg nonlinear least square fitter can be created with
<a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-new" title="gwy_math_nlfit_new ()"><code class="function">gwy_math_nlfit_new()</code></a>, specifying the function to fit (as <a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitFunc" title="GwyNLFitFunc ()"><span class="type">GwyNLFitFunc</span></a>) and
its derivative (as <a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitDerFunc" title="GwyNLFitDerFunc ()"><span class="type">GwyNLFitDerFunc</span></a>). For functions for whose analytic
derivative is not available or very impractical, <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-derive" title="gwy_math_nlfit_derive ()"><code class="function">gwy_math_nlfit_derive()</code></a>
(computing the derivative numerically) can be used instead.
</p>
<p>
A fitter can be then repeatedly used on different data either in
<a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-fit" title="gwy_math_nlfit_fit ()"><code class="function">gwy_math_nlfit_fit()</code></a>, or <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-fit-full" title="gwy_math_nlfit_fit_full ()"><code class="function">gwy_math_nlfit_fit_full()</code></a> when there are some
fixed or linked parameters. Arbitrary additional (non-fitting) parameters
can be passed to the fited function in <em class="parameter"><code>user_data</code></em>.
</p>
<p>
After a successfull fit additional fit information can be obtained with
<a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-get-dispersion" title="gwy_math_nlfit_get_dispersion ()"><code class="function">gwy_math_nlfit_get_dispersion()</code></a>, <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-get-correlations" title="gwy_math_nlfit_get_correlations ()"><code class="function">gwy_math_nlfit_get_correlations()</code></a>,
<a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-get-sigma" title="gwy_math_nlfit_get_sigma ()"><code class="function">gwy_math_nlfit_get_sigma()</code></a>. Note these functions may be used only after a
successfull fit. When a fitter is no longer needed, it should be freed with
<a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-free" title="gwy_math_nlfit_free ()"><code class="function">gwy_math_nlfit_free()</code></a>.
</p>
<p>
Several common functions are also available as fitting presets that can be
fitted with <a class="link" href="GwyNLFitPreset.html#gwy-nlfit-preset-fit" title="gwy_nlfit_preset_fit ()"><code class="function">gwy_nlfit_preset_fit()</code></a>. See <a class="link" href="GwyNLFitPreset.html" title="GwyNLFitPreset"><span class="type">GwyNLFitPreset</span></a> for details.
</p>
</div>
<div class="refsect1">
<a name="libgwyddion-GwyNLFitter.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyNLFitDerFunc"></a><h3>GwyNLFitDerFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GwyNLFitDerFunc) (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_param</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *param</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *fixed_param</code></em>,
<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitFunc" title="GwyNLFitFunc ()"><span class="type">GwyNLFitFunc</span></a> fmarq</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *deriv</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *dres</code></em>);</pre>
<p>
Fitting function partial derivative type.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>x-data as passed to <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-fit" title="gwy_math_nlfit_fit ()"><code class="function">gwy_math_nlfit_fit()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_param</code></em> :</span></p></td>
<td>The number of parameters (size of <em class="parameter"><code>param</code></em>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
<td>Parameters.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fixed_param</code></em> :</span></p></td>
<td>Which parameters should be treated as fixed (corresponding
entries are set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fmarq</code></em> :</span></p></td>
<td>The fitting function.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data as passed to <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-fit" title="gwy_math_nlfit_fit ()"><code class="function">gwy_math_nlfit_fit()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>deriv</code></em> :</span></p></td>
<td>Array where the <em class="parameter"><code>n_param</code></em> partial derivatives by each parameter are
to be stored.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dres</code></em> :</span></p></td>
<td>Set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if succeeds, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyNLFitFunc"></a><h3>GwyNLFitFunc ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> (*GwyNLFitFunc) (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_param</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *param</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *fres</code></em>);</pre>
<p>
Fitting function type.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>The value to compute the function at.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_param</code></em> :</span></p></td>
<td>The number of parameters (size of <em class="parameter"><code>param</code></em>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
<td>Parameters.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data as passed to <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-fit" title="gwy_math_nlfit_fit ()"><code class="function">gwy_math_nlfit_fit()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fres</code></em> :</span></p></td>
<td>Set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if succeeds, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value at <em class="parameter"><code>x</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GwyNLFitter"></a><h3>struct GwyNLFitter</h3>
<pre class="programlisting">struct GwyNLFitter {
GwyNLFitFunc fmarq; /* fitting function */
GwyNLFitDerFunc dmarq; /* fitting function derivations */
gint maxiter; /* max number of iterations */
gboolean eval; /* success? */
gdouble *covar; /* covariance matrix */
gdouble dispersion; /* dispersion */
gdouble mfi; /* fitting parameters --
fi, snizeni, zvyseni lambda, minimalni lambda */
gdouble mdec;
gdouble minc;
gdouble mtol;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-nlfit-derive"></a><h3>gwy_math_nlfit_derive ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_math_nlfit_derive (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_param</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *param</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *fixed_param</code></em>,
<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitFunc" title="GwyNLFitFunc ()"><span class="type">GwyNLFitFunc</span></a> ff</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *deriv</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *dres</code></em>);</pre>
<p>
Numerically computes the partial derivative of a fitting function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>The value to compute the derivative at.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_param</code></em> :</span></p></td>
<td>The nuber of parameters.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
<td>Array of parameters (of size <em class="parameter"><code>n_param</code></em>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fixed_param</code></em> :</span></p></td>
<td>Which parameters should be treated as fixed (corresponding
entries are set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ff</code></em> :</span></p></td>
<td>The fitted function.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data as passed to <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-fit" title="gwy_math_nlfit_fit ()"><code class="function">gwy_math_nlfit_fit()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>deriv</code></em> :</span></p></td>
<td>Array where the put the result to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dres</code></em> :</span></p></td>
<td>Set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if succeeds, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-nlfit-fit"></a><h3>gwy_math_nlfit_fit ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_math_nlfit_fit (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_dat</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *x</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *y</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_param</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *param</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Performs a nonlinear fit of <em class="parameter"><code>nlfit</code></em> function on (<em class="parameter"><code>x</code></em>,<em class="parameter"><code>y</code></em>) data.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nlfit</code></em> :</span></p></td>
<td>A Marquardt-Levenberg nonlinear fitter.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_dat</code></em> :</span></p></td>
<td>The number of data points in <em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Array of independent variable values.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>Array of dependent variable values.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_param</code></em> :</span></p></td>
<td>The nuber of parameters.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
<td>Array of parameters (of size <em class="parameter"><code>n_param</code></em>). Note the parameters must
be initialized to reasonably near values.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>Any pointer that will be passed to the function and derivative
as <em class="parameter"><code>user_data</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The final residual sum, a negative number in the case of failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-nlfit-fit-full"></a><h3>gwy_math_nlfit_fit_full ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_math_nlfit_fit_full (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_dat</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *x</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *y</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *weight</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_param</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *param</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *fixed_param</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *link_map</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Performs a nonlinear fit of <em class="parameter"><code>nlfit</code></em> function on (<em class="parameter"><code>x</code></em>,<em class="parameter"><code>y</code></em>) data, allowing
some fixed parameters.
</p>
<p>
Initial values of linked (dependent) parameters are overwritten by master
values, their <em class="parameter"><code>fixed_param</code></em> property is ignored and master's property
controls whether all are fixed or all variable.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nlfit</code></em> :</span></p></td>
<td>A Marquardt-Levenberg nonlinear fitter.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_dat</code></em> :</span></p></td>
<td>The number of data points in <em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>, <em class="parameter"><code>weight</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Array of independent variable values.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>Array of dependent variable values.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>weight</code></em> :</span></p></td>
<td>Array of weights associated to each data point. Can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,
weight of 1 is then used for all data.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_param</code></em> :</span></p></td>
<td>The nuber of parameters.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
<td>Array of parameters (of size <em class="parameter"><code>n_param</code></em>). Note the parameters must
be initialized to reasonably near values.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fixed_param</code></em> :</span></p></td>
<td>Which parameters should be treated as fixed (set corresponding
element to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for them). May be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if all parameters
are variable.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>link_map</code></em> :</span></p></td>
<td>Map of linked parameters. One of linked parameters is master,
Values in this array are indices of corresponding master
parameter for each parameter (for independent parameters set
<em class="parameter"><code>link_map</code></em>[i] == i). May be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if all parameter are
independent.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>Any pointer that will be passed to the function and derivative</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The final residual sum, a negative number in the case of failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-nlfit-free"></a><h3>gwy_math_nlfit_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_math_nlfit_free (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>);</pre>
<p>
Completely frees a Marquardt-Levenberg nonlinear fitter.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>nlfit</code></em> :</span></p></td>
<td>A Marquardt-Levenberg nonlinear fitter.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-nlfit-get-correlations"></a><h3>gwy_math_nlfit_get_correlations ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_math_nlfit_get_correlations (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> par1</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> par2</code></em>);</pre>
<p>
Returns the correlation coefficient between <em class="parameter"><code>par1</code></em>-th and <em class="parameter"><code>par2</code></em>-th parameter.
</p>
<p>
This function can be used only after a successful fit.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nlfit</code></em> :</span></p></td>
<td>A Marquardt-Levenberg nonlinear fitter.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>par1</code></em> :</span></p></td>
<td>First parameter index.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>par2</code></em> :</span></p></td>
<td>Second parameter index.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The correlation coefficient.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-nlfit-get-dispersion"></a><h3>gwy_math_nlfit_get_dispersion ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_math_nlfit_get_dispersion (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>);</pre>
<p>
Returns the residual sum divided by the number of degrees of freedom.
</p>
<p>
This function can be used only after a successful fit.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nlfit</code></em> :</span></p></td>
<td>A Marquardt-Levenberg nonlinear fitter.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The dispersion.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-nlfit-get-max-iterations"></a><h3>gwy_math_nlfit_get_max_iterations ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gwy_math_nlfit_get_max_iterations (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>);</pre>
<p>
Returns the maximum number of iterations of nonlinear fitter <em class="parameter"><code>nlfit</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nlfit</code></em> :</span></p></td>
<td>A Marquardt-Levenberg nonlinear fitter.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The maximum number of iterations.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-nlfit-get-sigma"></a><h3>gwy_math_nlfit_get_sigma ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a> gwy_math_nlfit_get_sigma (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> par</code></em>);</pre>
<p>
Returns the standard deviation of parameter number <em class="parameter"><code>par</code></em>.
</p>
<p>
This function makes sense only after a successful fit.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nlfit</code></em> :</span></p></td>
<td>A Marquardt-Levenberg nonlinear fitter.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>par</code></em> :</span></p></td>
<td>Parameter index.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The SD of <em class="parameter"><code>par</code></em>-th parameter.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-nlfit-new"></a><h3>gwy_math_nlfit_new ()</h3>
<pre class="programlisting"><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="returnvalue">GwyNLFitter</span></a> * gwy_math_nlfit_new (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitFunc" title="GwyNLFitFunc ()"><span class="type">GwyNLFitFunc</span></a> ff</code></em>,
<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitDerFunc" title="GwyNLFitDerFunc ()"><span class="type">GwyNLFitDerFunc</span></a> df</code></em>);</pre>
<p>
Creates a new Marquardt-Levenberg nonlinear fitter for function <em class="parameter"><code>ff</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ff</code></em> :</span></p></td>
<td>The fitted function.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>df</code></em> :</span></p></td>
<td>The derivative of fitted function. You can use <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-derive" title="gwy_math_nlfit_derive ()"><code class="function">gwy_math_nlfit_derive()</code></a>
computing the derivative numerically, when you don't know the
derivative explicitely.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created fitter.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-nlfit-set-max-iterations"></a><h3>gwy_math_nlfit_set_max_iterations ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_math_nlfit_set_max_iterations (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> maxiter</code></em>);</pre>
<p>
Sets the maximum number of iterations for nonlinear fitter <em class="parameter"><code>nlfit</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nlfit</code></em> :</span></p></td>
<td>A Marquardt-Levenberg nonlinear fitter.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>maxiter</code></em> :</span></p></td>
<td>The maximum number of iterations.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-nlfit-succeeded"></a><h3>gwy_math_nlfit_succeeded ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_math_nlfit_succeeded (<em class="parameter"><code><a class="link" href="libgwyddion-GwyNLFitter.html#GwyNLFitter" title="struct GwyNLFitter"><span class="type">GwyNLFitter</span></a> *nlfit</code></em>);</pre>
<p>
Obtains the status of the last fitting.
</p>
<p>
Fitting failure can be (and usually should be) also determined by checking
for negative return value of <a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-fit" title="gwy_math_nlfit_fit ()"><code class="function">gwy_math_nlfit_fit()</code></a> or
<a class="link" href="libgwyddion-GwyNLFitter.html#gwy-math-nlfit-fit-full" title="gwy_math_nlfit_fit_full ()"><code class="function">gwy_math_nlfit_fit_full()</code></a>. This function allows to test it later.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nlfit</code></em> :</span></p></td>
<td>A Marquardt-Levenberg nonlinear fitter.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the last fitting suceeded, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it failed.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7</p>
</div>
</div>
<div class="refsect1">
<a name="libgwyddion-GwyNLFitter.see-also"></a><h2>See Also</h2>
<a class="link" href="GwyNLFitPreset.html" title="GwyNLFitPreset"><span class="type">GwyNLFitPreset</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|