File: Initializing-the-Solver.html

package info (click to toggle)
gsl-ref-html 1.16-1
links: PTS
area: non-free
in suites: jessie, jessie-kfreebsd, stretch
size: 5,816 kB
ctags: 4,130
sloc: makefile: 35
file content (150 lines) | stat: -rw-r--r-- 7,829 bytes
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The GSL Team.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections and no cover texts.  A copy of the license is
included in the section entitled "GNU Free Documentation License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library &ndash; Reference Manual: Initializing the Solver</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Initializing the Solver">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Initializing the Solver">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="One-dimensional-Root_002dFinding.html#One-dimensional-Root_002dFinding" rel="up" title="One dimensional Root-Finding">
<link href="Providing-the-function-to-solve.html#Providing-the-function-to-solve" rel="next" title="Providing the function to solve">
<link href="Root-Finding-Caveats.html#Root-Finding-Caveats" rel="previous" title="Root Finding Caveats">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Initializing-the-Solver"></a>
<div class="header">
<p>
Next: <a href="Providing-the-function-to-solve.html#Providing-the-function-to-solve" accesskey="n" rel="next">Providing the function to solve</a>, Previous: <a href="Root-Finding-Caveats.html#Root-Finding-Caveats" accesskey="p" rel="previous">Root Finding Caveats</a>, Up: <a href="One-dimensional-Root_002dFinding.html#One-dimensional-Root_002dFinding" accesskey="u" rel="up">One dimensional Root-Finding</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Initializing-the-Solver-1"></a>
<h3 class="section">33.3 Initializing the Solver</h3>

<dl>
<dt><a name="index-gsl_005froot_005ffsolver_005falloc"></a>Function: <em>gsl_root_fsolver *</em> <strong>gsl_root_fsolver_alloc</strong> <em>(const gsl_root_fsolver_type * <var>T</var>)</em></dt>
<dd><a name="index-gsl_005froot_005ffsolver"></a>
<a name="index-gsl_005froot_005ffsolver_005ftype"></a>
<p>This function returns a pointer to a newly allocated instance of a
solver of type <var>T</var>.  For example, the following code creates an
instance of a bisection solver,
</p>
<div class="example">
<pre class="example">const gsl_root_fsolver_type * T 
  = gsl_root_fsolver_bisection;
gsl_root_fsolver * s 
  = gsl_root_fsolver_alloc (T);
</pre></div>

<p>If there is insufficient memory to create the solver then the function
returns a null pointer and the error handler is invoked with an error
code of <code>GSL_ENOMEM</code>.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005froot_005ffdfsolver_005falloc"></a>Function: <em>gsl_root_fdfsolver *</em> <strong>gsl_root_fdfsolver_alloc</strong> <em>(const gsl_root_fdfsolver_type * <var>T</var>)</em></dt>
<dd><a name="index-gsl_005froot_005ffdfsolver"></a>
<a name="index-gsl_005froot_005ffdfsolver_005ftype"></a>
<p>This function returns a pointer to a newly allocated instance of a
derivative-based solver of type <var>T</var>.  For example, the following
code creates an instance of a Newton-Raphson solver,
</p>
<div class="example">
<pre class="example">const gsl_root_fdfsolver_type * T 
  = gsl_root_fdfsolver_newton;
gsl_root_fdfsolver * s 
  = gsl_root_fdfsolver_alloc (T);
</pre></div>

<p>If there is insufficient memory to create the solver then the function
returns a null pointer and the error handler is invoked with an error
code of <code>GSL_ENOMEM</code>.
</p></dd></dl>


<dl>
<dt><a name="index-gsl_005froot_005ffsolver_005fset"></a>Function: <em>int</em> <strong>gsl_root_fsolver_set</strong> <em>(gsl_root_fsolver * <var>s</var>, gsl_function * <var>f</var>, double <var>x_lower</var>, double <var>x_upper</var>)</em></dt>
<dd><p>This function initializes, or reinitializes, an existing solver <var>s</var>
to use the function <var>f</var> and the initial search interval
[<var>x_lower</var>, <var>x_upper</var>].
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005froot_005ffdfsolver_005fset"></a>Function: <em>int</em> <strong>gsl_root_fdfsolver_set</strong> <em>(gsl_root_fdfsolver * <var>s</var>, gsl_function_fdf * <var>fdf</var>, double <var>root</var>)</em></dt>
<dd><p>This function initializes, or reinitializes, an existing solver <var>s</var>
to use the function and derivative <var>fdf</var> and the initial guess
<var>root</var>.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005froot_005ffsolver_005ffree"></a>Function: <em>void</em> <strong>gsl_root_fsolver_free</strong> <em>(gsl_root_fsolver * <var>s</var>)</em></dt>
<dt><a name="index-gsl_005froot_005ffdfsolver_005ffree"></a>Function: <em>void</em> <strong>gsl_root_fdfsolver_free</strong> <em>(gsl_root_fdfsolver * <var>s</var>)</em></dt>
<dd><p>These functions free all the memory associated with the solver <var>s</var>.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005froot_005ffsolver_005fname"></a>Function: <em>const char *</em> <strong>gsl_root_fsolver_name</strong> <em>(const gsl_root_fsolver * <var>s</var>)</em></dt>
<dt><a name="index-gsl_005froot_005ffdfsolver_005fname"></a>Function: <em>const char *</em> <strong>gsl_root_fdfsolver_name</strong> <em>(const gsl_root_fdfsolver * <var>s</var>)</em></dt>
<dd><p>These functions return a pointer to the name of the solver.  For example,
</p>
<div class="example">
<pre class="example">printf (&quot;s is a '%s' solver\n&quot;,
        gsl_root_fsolver_name (s));
</pre></div>

<p>would print something like <code>s is a 'bisection' solver</code>.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="Providing-the-function-to-solve.html#Providing-the-function-to-solve" accesskey="n" rel="next">Providing the function to solve</a>, Previous: <a href="Root-Finding-Caveats.html#Root-Finding-Caveats" accesskey="p" rel="previous">Root Finding Caveats</a>, Up: <a href="One-dimensional-Root_002dFinding.html#One-dimensional-Root_002dFinding" accesskey="u" rel="up">One dimensional Root-Finding</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>