.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Math::GSL::Min 3pm"
.TH Math::GSL::Min 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Math::GSL::Min \- 1\-D Minimization
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use Math::GSL::Min qw/:all/;
\& use Math::GSL::Const qw/$M_PI/;
\&
\& my $m = gsl_min_fminimizer_alloc($gsl_min_fminimizer_goldensection);
\&
\& gsl_min_fminimizer_set_with_values($m,
\& sub { cos($_[0]) },
\& 3, cos(3),
\& 0, cos(0),
\& 2*$M_PI, cos(2*$M_PI)
\& );
\& my $status = gsl_min_fminimizer_iterate($m);
\&
\& my $x_min = gsl_min_fminimizer_x_minimum($m);
\& my $x_lower = gsl_min_fminimizer_x_lower($m);
\& my $x_upper = gsl_min_fminimizer_x_upper($m);
\&
\& my $f_min = gsl_min_fminimizer_f_minimum($m);
\& my $f_lower = gsl_min_fminimizer_f_lower($m);
\& my $f_upper = gsl_min_fminimizer_f_upper($m);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Here is a list of all the functions in this module :
.IP \(bu 4
\&\f(CWgsl_min_fminimizer_alloc($type)\fR
.IP \(bu 4
\&\f(CW\*(C`gsl_min_fminimizer_free\*(C'\fR
.Sp
Don't call this function explicitly. It will be called automatically in DESTROY for fminimizer.
.IP \(bu 4
\&\f(CW\*(C`gsl_min_fminimizer_set \*(C'\fR
.Sp
Don't apply this function twice to the same fminimizer. It will cause a memory leak. Instead of this you should create new fminimizer.
.IP \(bu 4
\&\f(CW\*(C`gsl_min_fminimizer_set_with_values\*(C'\fR
.Sp
Don't apply this function twice to the same fminimizer. It will cause a memory leak. Instead of this you should create new fminimizer.
.IP \(bu 4
\&\f(CWgsl_min_fminimizer_iterate($m)\fR
.IP \(bu 4
\&\f(CW\*(C`gsl_min_fminimizer_name \*(C'\fR
.IP \(bu 4
\&\f(CWgsl_min_fminimizer_x_minimum($m)\fR
.IP \(bu 4
\&\f(CWgsl_min_fminimizer_x_lower($m) \fR
.IP \(bu 4
\&\f(CWgsl_min_fminimizer_x_upper($m) \fR
.IP \(bu 4
\&\f(CWgsl_min_fminimizer_f_minimum($m)\fR
.IP \(bu 4
\&\f(CWgsl_min_fminimizer_f_lower($m) \fR
.IP \(bu 4
\&\f(CWgsl_min_fminimizer_f_upper($m) \fR
.IP \(bu 4
\&\f(CWgsl_min_fminimizer_minimum($m) \fR
.IP \(bu 4
\&\f(CWgsl_min_test_interval($m) \fR
.IP \(bu 4
\&\f(CWgsl_min_find_bracket($m) \fR
.PP
This module also includes the following constants :
.IP \(bu 4
\&\f(CW$gsl_min_fminimizer_brent\fR
.IP \(bu 4
\&\f(CW$gsl_min_fminimizer_goldensection\fR
.PP
For more information on the functions, we refer you to the GSL official
documentation:
.SH AUTHORS
.IX Header "AUTHORS"
Jonathan "Duke" Leto and Thierry Moisan
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2008\-2023 Jonathan "Duke" Leto and Thierry Moisan
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.