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
|
<html lang="en">
<head>
<title>Initializing the Multidimensional Solver - GNU Scientific Library -- Reference Manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Scientific Library -- Reference Manual">
<meta name="generator" content="makeinfo 4.8">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Multidimensional-Root_002dFinding.html" title="Multidimensional Root-Finding">
<link rel="prev" href="Overview-of-Multidimensional-Root-Finding.html" title="Overview of Multidimensional Root Finding">
<link rel="next" href="Providing-the-multidimensional-system-of-equations-to-solve.html" title="Providing the multidimensional system of equations to solve">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 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.2 or
any later version published by the Free Software Foundation; with the
Invariant Sections being ``GNU General Public License'' and ``Free Software
Needs Free Documentation'', the Front-Cover text being ``A GNU Manual'',
and with the Back-Cover Text being (a) (see below). A copy of the
license is included in the section entitled ``GNU Free Documentation
License''.
(a) The Back-Cover Text is: ``You have freedom to copy and modify this
GNU Manual, like GNU software.''-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Initializing-the-Multidimensional-Solver"></a>
Next: <a rel="next" accesskey="n" href="Providing-the-multidimensional-system-of-equations-to-solve.html">Providing the multidimensional system of equations to solve</a>,
Previous: <a rel="previous" accesskey="p" href="Overview-of-Multidimensional-Root-Finding.html">Overview of Multidimensional Root Finding</a>,
Up: <a rel="up" accesskey="u" href="Multidimensional-Root_002dFinding.html">Multidimensional Root-Finding</a>
<hr>
</div>
<h3 class="section">34.2 Initializing the Solver</h3>
<p>The following functions initialize a multidimensional solver, either
with or without derivatives. The solver itself depends only on the
dimension of the problem and the algorithm and can be reused for
different problems.
<div class="defun">
— Function: gsl_multiroot_fsolver * <b>gsl_multiroot_fsolver_alloc</b> (<var>const gsl_multiroot_fsolver_type * T, size_t n</var>)<var><a name="index-gsl_005fmultiroot_005ffsolver_005falloc-2281"></a></var><br>
<blockquote><p>This function returns a pointer to a newly allocated instance of a
solver of type <var>T</var> for a system of <var>n</var> dimensions.
For example, the following code creates an instance of a hybrid solver,
to solve a 3-dimensional system of equations.
<pre class="example"> const gsl_multiroot_fsolver_type * T
= gsl_multiroot_fsolver_hybrid;
gsl_multiroot_fsolver * s
= gsl_multiroot_fsolver_alloc (T, 3);
</pre>
<p class="noindent">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></blockquote></div>
<div class="defun">
— Function: gsl_multiroot_fdfsolver * <b>gsl_multiroot_fdfsolver_alloc</b> (<var>const gsl_multiroot_fdfsolver_type * T, size_t n</var>)<var><a name="index-gsl_005fmultiroot_005ffdfsolver_005falloc-2282"></a></var><br>
<blockquote><p>This function returns a pointer to a newly allocated instance of a
derivative solver of type <var>T</var> for a system of <var>n</var> dimensions.
For example, the following code creates an instance of a Newton-Raphson solver,
for a 2-dimensional system of equations.
<pre class="example"> const gsl_multiroot_fdfsolver_type * T
= gsl_multiroot_fdfsolver_newton;
gsl_multiroot_fdfsolver * s =
gsl_multiroot_fdfsolver_alloc (T, 2);
</pre>
<p class="noindent">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></blockquote></div>
<div class="defun">
— Function: int <b>gsl_multiroot_fsolver_set</b> (<var>gsl_multiroot_fsolver * s, gsl_multiroot_function * f, gsl_vector * x</var>)<var><a name="index-gsl_005fmultiroot_005ffsolver_005fset-2283"></a></var><br>
<blockquote><p>This function sets, or resets, an existing solver <var>s</var> to use the
function <var>f</var> and the initial guess <var>x</var>.
</p></blockquote></div>
<div class="defun">
— Function: int <b>gsl_multiroot_fdfsolver_set</b> (<var>gsl_multiroot_fdfsolver * s, gsl_multiroot_function_fdf * fdf, gsl_vector * x</var>)<var><a name="index-gsl_005fmultiroot_005ffdfsolver_005fset-2284"></a></var><br>
<blockquote><p>This function sets, or resets, an existing solver <var>s</var> to use the
function and derivative <var>fdf</var> and the initial guess <var>x</var>.
</p></blockquote></div>
<div class="defun">
— Function: void <b>gsl_multiroot_fsolver_free</b> (<var>gsl_multiroot_fsolver * s</var>)<var><a name="index-gsl_005fmultiroot_005ffsolver_005ffree-2285"></a></var><br>
— Function: void <b>gsl_multiroot_fdfsolver_free</b> (<var>gsl_multiroot_fdfsolver * s</var>)<var><a name="index-gsl_005fmultiroot_005ffdfsolver_005ffree-2286"></a></var><br>
<blockquote><p>These functions free all the memory associated with the solver <var>s</var>.
</p></blockquote></div>
<div class="defun">
— Function: const char * <b>gsl_multiroot_fsolver_name</b> (<var>const gsl_multiroot_fsolver * s</var>)<var><a name="index-gsl_005fmultiroot_005ffsolver_005fname-2287"></a></var><br>
— Function: const char * <b>gsl_multiroot_fdfsolver_name</b> (<var>const gsl_multiroot_fdfsolver * s</var>)<var><a name="index-gsl_005fmultiroot_005ffdfsolver_005fname-2288"></a></var><br>
<blockquote><p>These functions return a pointer to the name of the solver. For example,
<pre class="example"> printf ("s is a '%s' solver\n",
gsl_multiroot_fdfsolver_name (s));
</pre>
<p class="noindent">would print something like <code>s is a 'newton' solver</code>.
</p></blockquote></div>
<hr>The GNU Scientific Library - a free numerical library licensed under the GNU GPL<br>Back to the <a href="/software/gsl/">GNU Scientific Library Homepage</a></body></html>
|
