/usr/lib/perl5/PDL/GSL/MROOT.pm is in pdl 1:2.007-2build1.
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 | #
# GENERATED WITH PDL::PP! Don't modify!
#
package PDL::GSL::MROOT;
@EXPORT_OK = qw( gslmroot_fsolver PDL::PP fsolver_meat );
%EXPORT_TAGS = (Func=>[@EXPORT_OK]);
use PDL::Core;
use PDL::Exporter;
use DynaLoader;
@ISA = ( 'PDL::Exporter','DynaLoader' );
push @PDL::Core::PP, __PACKAGE__;
bootstrap PDL::GSL::MROOT ;
=head1 NAME
PDL::GSL::MROOT - PDL interface to multidimensional root-finding routines in GSL
=head1 DESCRIPTION
This is an interface to the multidimensional root-finding package present in the
GNU Scientific Library.
At the moment there is a single function B<gslmroot_fsolver> which provides an interface
to the algorithms in the GSL library that do not use derivatives.
=head1 SYNOPSIS
use PDL;
use PDL::GSL::MROOT;
my $init = pdl (-10.00, -5.0);
my $epsabs = 1e-7;
$res = gslmroot_fsolver($init, \&rosenbrock,
{Method => 0, EpsAbs => $epsabs});
sub rosenbrock{
my ($x) = @_;
my $a = 1;
my $b = 10;
my $y = zeroes($x);
my $y0 = $y->slice(0);
$y0 .= $a * (1 - $x->slice(0));
my $y1 = $y->slice(1);
$y1 .= $b * ($x->slice(1) - $x->slice(0)**2);
return $y;
}
=head1 FUNCTIONS
=head2 gslmroot_fsolver -- Multidimensional root finder without using derivatives
This function provides an interface to the multidimensional root finding algorithms
in the GSL library. It takes a minimum of two argumennts: a piddle $init with an
initial guess for the roots of the system and a reference to a function. The latter
function must return a piddle whose i-th element is the i-th equation evaluated at
the vector x (a piddle which is the sole input to this function). See the example in
the Synopsis above for an illustration. The function returns a piddle with the roots
for the system of equations.
Two optional arguments can be specified as shown below. One is B<Method>, which can
take the values 0,1,2,3. They correspond to the 'hybrids', 'hybrid', 'dnewton' and
'broyden' algorithms respectively (see GSL documentation for details). The other
optional argument is B<Epsabs>, which sets the absolute accuracy to which the roots
of the system of equations are required. The default value for Method is 0 ('hybrids'
algorithm) and the default for Epsabs is 1e-3.
=for usage
Usage:
$res = gslmroot_fsolver($init, $function_ref,
[{Method => $method, Epsabs => $epsabs}]);
=for ref
=head1 SEE ALSO
L<PDL>
The GSL documentation is online at
http://www.gnu.org/software/gsl/manual/
=head1 AUTHOR
This file copyright (C) 2006 Andres Jordan <ajordan@eso.org>
and Simon Casassus <simon@das.uchile.cl>
All rights reserved. There is no warranty. You are allowed to redistribute this
software/documentation under certain conditions. For details, see the file
COPYING in the PDL distribution. If this file is separated from the
PDL distribution, the copyright notice should be included in the file.
=cut
=head1 FUNCTIONS
=cut
sub gslmroot_fsolver{
my ($x, $f_vect) = @_;
my $opt;
if (ref($_[$#_]) eq 'HASH'){ $opt = pop @_; }
else{ $opt = {Method => 0, EpsAbs => 1e-3}; }
if( (ref($x) ne 'PDL')){
barf("Have to pass piddle as first argument to fsolver\n");
}
my $res = $x->copy;
fsolver_meat($res, $$opt{'EpsAbs'}, $$opt{'Method'}, $f_vect);
return $res;
}
=head2 fsolver_meat
=for sig
Signature: (double xfree(n); double epsabs(); int method(); SV* funcion1)
=for ref
info not available
=for bad
fsolver_meat does not process bad values.
It will set the bad-value flag of all output piddles if the flag is set for any of the input piddles.
=cut
*fsolver_meat = \&PDL::GSLMROOT::fsolver_meat;
;
# Exit with OK status
1;
|