File: DHT.pm.2.2.1

package info (click to toggle)
libmath-gsl-perl 0.45-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 192,156 kB
  • sloc: ansic: 895,524; perl: 24,682; makefile: 12
file content (222 lines) | stat: -rw-r--r-- 6,874 bytes parent folder | download | duplicates (13)
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
# This file was automatically generated by SWIG (https://www.swig.org).
# Version 4.2.0
#
# Do not make changes to this file unless you know what you are doing - modify
# the SWIG interface file instead.

package Math::GSL::DHT;
use base qw(Exporter);
use base qw(DynaLoader);
package Math::GSL::DHTc;
bootstrap Math::GSL::DHT;
package Math::GSL::DHT;
@EXPORT = qw();

# ---------- BASE METHODS -------------

package Math::GSL::DHT;

sub TIEHASH {
    my ($classname,$obj) = @_;
    return bless $obj, $classname;
}

sub CLEAR { }

sub FIRSTKEY { }

sub NEXTKEY { }

sub FETCH {
    my ($self,$field) = @_;
    my $member_func = "swig_${field}_get";
    $self->$member_func();
}

sub STORE {
    my ($self,$field,$newval) = @_;
    my $member_func = "swig_${field}_set";
    $self->$member_func($newval);
}

sub this {
    my $ptr = shift;
    return tied(%$ptr);
}


# ------- FUNCTION WRAPPERS --------

package Math::GSL::DHT;

*gsl_error = *Math::GSL::DHTc::gsl_error;
*gsl_stream_printf = *Math::GSL::DHTc::gsl_stream_printf;
*gsl_strerror = *Math::GSL::DHTc::gsl_strerror;
*gsl_set_error_handler = *Math::GSL::DHTc::gsl_set_error_handler;
*gsl_set_error_handler_off = *Math::GSL::DHTc::gsl_set_error_handler_off;
*gsl_set_stream_handler = *Math::GSL::DHTc::gsl_set_stream_handler;
*gsl_set_stream = *Math::GSL::DHTc::gsl_set_stream;
*gsl_dht_alloc = *Math::GSL::DHTc::gsl_dht_alloc;
*gsl_dht_new = *Math::GSL::DHTc::gsl_dht_new;
*gsl_dht_init = *Math::GSL::DHTc::gsl_dht_init;
*gsl_dht_x_sample = *Math::GSL::DHTc::gsl_dht_x_sample;
*gsl_dht_k_sample = *Math::GSL::DHTc::gsl_dht_k_sample;
*gsl_dht_free = *Math::GSL::DHTc::gsl_dht_free;
*gsl_dht_apply = *Math::GSL::DHTc::gsl_dht_apply;

############# Class : Math::GSL::DHT::gsl_dht_struct ##############

package Math::GSL::DHT::gsl_dht_struct;
use vars qw(@ISA %OWNER %ITERATORS %BLESSEDMEMBERS);
@ISA = qw( Math::GSL::DHT );
%OWNER = ();
%ITERATORS = ();
*swig_size_get = *Math::GSL::DHTc::gsl_dht_struct_size_get;
*swig_size_set = *Math::GSL::DHTc::gsl_dht_struct_size_set;
*swig_nu_get = *Math::GSL::DHTc::gsl_dht_struct_nu_get;
*swig_nu_set = *Math::GSL::DHTc::gsl_dht_struct_nu_set;
*swig_xmax_get = *Math::GSL::DHTc::gsl_dht_struct_xmax_get;
*swig_xmax_set = *Math::GSL::DHTc::gsl_dht_struct_xmax_set;
*swig_kmax_get = *Math::GSL::DHTc::gsl_dht_struct_kmax_get;
*swig_kmax_set = *Math::GSL::DHTc::gsl_dht_struct_kmax_set;
*swig_j_get = *Math::GSL::DHTc::gsl_dht_struct_j_get;
*swig_j_set = *Math::GSL::DHTc::gsl_dht_struct_j_set;
*swig_Jjj_get = *Math::GSL::DHTc::gsl_dht_struct_Jjj_get;
*swig_Jjj_set = *Math::GSL::DHTc::gsl_dht_struct_Jjj_set;
*swig_J2_get = *Math::GSL::DHTc::gsl_dht_struct_J2_get;
*swig_J2_set = *Math::GSL::DHTc::gsl_dht_struct_J2_set;
sub new {
    my $pkg = shift;
    my $self = Math::GSL::DHTc::new_gsl_dht_struct(@_);
    bless $self, $pkg if defined($self);
}

sub DESTROY {
    return unless $_[0]->isa('HASH');
    my $self = tied(%{$_[0]});
    return unless defined $self;
    delete $ITERATORS{$self};
    if (exists $OWNER{$self}) {
        Math::GSL::DHTc::delete_gsl_dht_struct($self);
        delete $OWNER{$self};
    }
}

sub DISOWN {
    my $self = shift;
    my $ptr = tied(%$self);
    delete $OWNER{$ptr};
}

sub ACQUIRE {
    my $self = shift;
    my $ptr = tied(%$self);
    $OWNER{$ptr} = 1;
}


# ------- VARIABLE STUBS --------

package Math::GSL::DHT;

*GSL_VERSION = *Math::GSL::DHTc::GSL_VERSION;
*GSL_MAJOR_VERSION = *Math::GSL::DHTc::GSL_MAJOR_VERSION;
*GSL_MINOR_VERSION = *Math::GSL::DHTc::GSL_MINOR_VERSION;
*GSL_POSZERO = *Math::GSL::DHTc::GSL_POSZERO;
*GSL_NEGZERO = *Math::GSL::DHTc::GSL_NEGZERO;
*GSL_SUCCESS = *Math::GSL::DHTc::GSL_SUCCESS;
*GSL_FAILURE = *Math::GSL::DHTc::GSL_FAILURE;
*GSL_CONTINUE = *Math::GSL::DHTc::GSL_CONTINUE;
*GSL_EDOM = *Math::GSL::DHTc::GSL_EDOM;
*GSL_ERANGE = *Math::GSL::DHTc::GSL_ERANGE;
*GSL_EFAULT = *Math::GSL::DHTc::GSL_EFAULT;
*GSL_EINVAL = *Math::GSL::DHTc::GSL_EINVAL;
*GSL_EFAILED = *Math::GSL::DHTc::GSL_EFAILED;
*GSL_EFACTOR = *Math::GSL::DHTc::GSL_EFACTOR;
*GSL_ESANITY = *Math::GSL::DHTc::GSL_ESANITY;
*GSL_ENOMEM = *Math::GSL::DHTc::GSL_ENOMEM;
*GSL_EBADFUNC = *Math::GSL::DHTc::GSL_EBADFUNC;
*GSL_ERUNAWAY = *Math::GSL::DHTc::GSL_ERUNAWAY;
*GSL_EMAXITER = *Math::GSL::DHTc::GSL_EMAXITER;
*GSL_EZERODIV = *Math::GSL::DHTc::GSL_EZERODIV;
*GSL_EBADTOL = *Math::GSL::DHTc::GSL_EBADTOL;
*GSL_ETOL = *Math::GSL::DHTc::GSL_ETOL;
*GSL_EUNDRFLW = *Math::GSL::DHTc::GSL_EUNDRFLW;
*GSL_EOVRFLW = *Math::GSL::DHTc::GSL_EOVRFLW;
*GSL_ELOSS = *Math::GSL::DHTc::GSL_ELOSS;
*GSL_EROUND = *Math::GSL::DHTc::GSL_EROUND;
*GSL_EBADLEN = *Math::GSL::DHTc::GSL_EBADLEN;
*GSL_ENOTSQR = *Math::GSL::DHTc::GSL_ENOTSQR;
*GSL_ESING = *Math::GSL::DHTc::GSL_ESING;
*GSL_EDIVERGE = *Math::GSL::DHTc::GSL_EDIVERGE;
*GSL_EUNSUP = *Math::GSL::DHTc::GSL_EUNSUP;
*GSL_EUNIMPL = *Math::GSL::DHTc::GSL_EUNIMPL;
*GSL_ECACHE = *Math::GSL::DHTc::GSL_ECACHE;
*GSL_ETABLE = *Math::GSL::DHTc::GSL_ETABLE;
*GSL_ENOPROG = *Math::GSL::DHTc::GSL_ENOPROG;
*GSL_ENOPROGJ = *Math::GSL::DHTc::GSL_ENOPROGJ;
*GSL_ETOLF = *Math::GSL::DHTc::GSL_ETOLF;
*GSL_ETOLX = *Math::GSL::DHTc::GSL_ETOLX;
*GSL_ETOLG = *Math::GSL::DHTc::GSL_ETOLG;
*GSL_EOF = *Math::GSL::DHTc::GSL_EOF;

@EXPORT_OK = qw/
               gsl_dht_alloc
               gsl_dht_new
               gsl_dht_init
               gsl_dht_x_sample
               gsl_dht_k_sample
               gsl_dht_free
               gsl_dht_apply
             /;
%EXPORT_TAGS = ( all => [ @EXPORT_OK ] );

=encoding utf8

__END__

=head1 NAME

Math::GSL::DHT - Discrete Hankel Transforms

=head1 SYNOPSIS

    use Math::GSL::DHT qw/:all/;

=head1 DESCRIPTION

Here is a list of all the functions included in this module :

=over

=item C<gsl_dht_alloc($size)> - This function allocates a Discrete Hankel transform object of size $size.

=item C<gsl_dht_new($size, $nu, $xmax)> -  This function allocates a Discrete Hankel transform object of size $size and initializes it for the given values of $nu and $xmax.

=item C<gsl_dht_init($t, $nu, $xmax)> - This function initializes the transform $t for the given values of $nu and $xmax.

=item C<gsl_dht_x_sample($t, $n)> - This function returns the value of the $n-th sample point in the unit interval, (j_{\nu,n+1}/j_{\nu,M}) X. These are the points where the function f(t) is assumed to be sampled.

=item C<gsl_dht_k_sample($t, $n)> - This function returns the value of the $n-th sample point in "k-space", j_{\nu,n+1}/X.

=item C<gsl_dht_free($t)> - This function frees the transform $t.

=item C<gsl_dht_apply>

=back

=head1 EXAMPLES

=head1 AUTHORS

Jonathan "Duke" Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2008-2024 Jonathan "Duke" Leto and Thierry Moisan

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut
1;