Vector.i

   1 %module "Math::GSL::Vector"
   2
   3 %include "typemaps.i"
   4
   5 %apply int *OUTPUT { size_t *imin, size_t *imax };
   6
   7 %apply double *OUTPUT { double * min_out, double * max_out };
   8
   9 %typemap(in) double *v {
  10     AV *tempav;
  11     I32 len;
  12     int i;
  13     SV **tv;
  14     if (!SvROK($input))
  15         croak("Math::GSL : $input is not a reference!");
  16     if (SvTYPE(SvRV($input)) != SVt_PVAV)
  17         croak("Math::GSL : $input is not an array ref!");
  18
  19     tempav = (AV*)SvRV($input);
  20     len = av_len(tempav);
  21     $1 = (double *) malloc((len+1)*sizeof(double));
  22     for (i = 0; i <= len; i++) {
  23         tv = av_fetch(tempav, i, 0);
  24         $1[i] = (double) SvNV(*tv);
  25     }
  26 }
  27
  28 FILE * fopen(char *, char *);
  29 int fclose(FILE *);
  30
  31 %{
  32     #include "gsl/gsl_nan.h"
  33     #include "gsl/gsl_vector.h"
  34     #include "gsl/gsl_vector_char.h"
  35     #include "gsl/gsl_vector_complex.h"
  36     #include "gsl/gsl_vector_complex_double.h"
  37     #include "gsl/gsl_vector_double.h"
  38     #include "gsl/gsl_vector_float.h"
  39     #include "gsl/gsl_vector_int.h"
  40 %}
  41
  42 %include "gsl/gsl_nan.h"
  43 %include "gsl/gsl_vector.h"
  44 %include "gsl/gsl_vector_char.h"
  45 %include "gsl/gsl_vector_complex.h"
  46 %include "gsl/gsl_vector_complex_double.h"
  47 %include "gsl/gsl_vector_double.h"
  48 %include "gsl/gsl_vector_int.h"
  49
  50
  51
  52 %perlcode %{
  53 use Scalar::Util 'blessed';
  54 use Carp qw/croak/;
  55 use overload
  56     '*'      => \&_multiplication,
  57     fallback => 1,
  58 ;
  59
  60 @EXPORT_OK  = qw/fopen fclose
  61                  gsl_vector_alloc gsl_vector_calloc gsl_vector_alloc_from_block gsl_vector_alloc_from_vector
  62                  gsl_vector_free gsl_vector_view_array gsl_vector_view_array_with_stride
  63                  gsl_vector_const_view_array_with_stride gsl_vector_subvector gsl_vector_subvector_wi gsl_vector_subvector_with_stride
  64                  gsl_vector_const_subvec gsl_vector_const_subvec gsl_vector_get gsl_vector_set
  65                  gsl_vector_ptr gsl_vector_const_ptr gsl_vector_set_zero gsl_vector_set_all
  66                  gsl_vector_set_basis gsl_vector_fread gsl_vector_fwrite gsl_vector_fscanf
  67                  gsl_vector_fprintf gsl_vector_memcpy gsl_vector_reverse gsl_vector_swap
  68                  gsl_vector_swap_elements gsl_vector_max gsl_vector_min gsl_vector_minmax
  69                  gsl_vector_max_index gsl_vector_min_index gsl_vector_minmax_index
  70                  gsl_vector_add gsl_vector_sub gsl_vector_mul gsl_vector_div
  71                  gsl_vector_scale gsl_vector_add_constant gsl_vector_isnull
  72                  gsl_vector_ispos gsl_vector_isneg gsl_vector_isnonneg
  73                  gsl_vector_float_alloc gsl_vector_float_calloc gsl_vector_float_alloc_from_block
  74                  gsl_vector_float_alloc_from_vector gsl_vector_float_free gsl_vector_float_view_array
  75                  gsl_vector_float_view_array_with_stride gsl_vector_float_const_view_array gsl_vector_float_const_view_array_with_stride
  76                  gsl_vector_float_subvector gsl_vector_float_subvector_with_stride gsl_vector_float_const_subvector
  77                  gsl_vector_float_const_subvector_with_stride gsl_vector_float_get gsl_vector_float_set gsl_vector_float_ptr
  78                  gsl_vector_float_const_ptr gsl_vector_float_set_zero gsl_vector_float_set_all gsl_vector_float_set_basis
  79                  gsl_vector_float_fread gsl_vector_float_fwrite gsl_vector_float_fscanf gsl_vector_float_fprintf
  80                  gsl_vector_float_memcpy gsl_vector_float_reverse gsl_vector_float_swap gsl_vector_float_swap_elements
  81                  gsl_vector_float_max gsl_vector_float_min gsl_vector_float_minmax gsl_vector_float_max_index gsl_vector_float_min_index
  82                  gsl_vector_float_minmax_index gsl_vector_float_add gsl_vector_float_sub gsl_vector_float_mul gsl_vector_float_div gsl_vector_float_scale
  83                  gsl_vector_float_add_constant gsl_vector_float_isnull gsl_vector_float_ispos gsl_vector_float_isneg gsl_vector_float_isnonneg
  84                  gsl_vector_complex_alloc gsl_vector_complex_calloc gsl_vector_complex_alloc_from_block gsl_vector_complex_alloc_from_vector
  85                  gsl_vector_complex_free gsl_vector_complex_view_array gsl_vector_complex_view_array_with_stride gsl_vector_complex_const_view_array
  86                  gsl_vector_complex_const_view_array_with_stride gsl_vector_complex_subvector gsl_vector_complex_subvector_with_stride
  87                  gsl_vector_complex_const_subvector gsl_vector_complex_const_subvector_with_stride gsl_vector_complex_real gsl_vector_complex_imag
  88                  gsl_vector_complex_const_real gsl_vector_complex_const_imag gsl_vector_complex_get gsl_vector_complex_set
  89                  gsl_vector_complex_ptr gsl_vector_complex_const_ptr gsl_vector_complex_set_zero gsl_vector_complex_set_all
  90                  gsl_vector_complex_set_basis gsl_vector_complex_fread gsl_vector_complex_fwrite gsl_vector_complex_fscanf
  91                  gsl_vector_complex_fprintf gsl_vector_complex_memcpy gsl_vector_complex_reverse gsl_vector_complex_swap
  92                  gsl_vector_complex_swap_elements gsl_vector_complex_isnull gsl_vector_complex_ispos gsl_vector_complex_isneg
  93 /;
  94 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  95
  96 =head1 NAME
  97
  98 Math::GSL::Vector - Functions concerning vectors
  99
 100 =head1 SYNOPSIS
 101
 102     use Math::GSL::Vector qw/:all/;
 103     my $vec1 = Math::GSL::Vector->new([1, 7, 94, 15 ]);
 104     my $vec2 = $vec1 * 5;
 105     my $vec3 = Math::GSL::Vector>new(10);   # 10 element zero vector
 106
 107     # set the element at index 1 to 9
 108     # and the element at index 3 to 8
 109     $vec3->set([ 1, 3 ], [ 9, 8 ]);
 110
 111     my @vec = $vec2->as_list;               # return elements as Perl list
 112
 113     my $dot_product = $vec1 * $vec2;
 114     my $length      = $vec2->length;
 115     my $first       = $vec1->get(0);
 116
 117
 118 =cut
 119
 120 sub new {
 121     my ($class, $values) = @_;
 122     my $length  = $#$values;
 123     my $this = {};
 124     my $vector;
 125     if ( ref $values eq 'ARRAY' ){
 126         die __PACKAGE__.'::new($x) - $x must be a nonempty array reference' if $length == -1;
 127         $vector  = gsl_vector_alloc($length+1);
 128         map { gsl_vector_set($vector, $_, $values->[$_] ) }  (0 .. $length);
 129         $this->{_length} = $length+1;
 130     } elsif ( (int($values) == $values) && ($values > 0)) {
 131         $vector  = gsl_vector_alloc($values);
 132         gsl_vector_set_zero($vector);
 133         $this->{_length} = $values;
 134     } else {
 135         die __PACKAGE__.'::new($x) - $x must be an int or array reference';
 136     }
 137     $this->{_vector} = $vector;
 138     bless $this, $class;
 139 }
 140
 141 sub raw { (shift)->{_vector} }
 142
 143 sub min {
 144     my $self=shift;
 145     return gsl_vector_min($self->raw);
 146 }
 147
 148 sub max {
 149     my $self=shift;
 150     return gsl_vector_max($self->raw);
 151 }
 152 sub length { my $self=shift; $self->{_length} }
 153
 154 sub as_list {
 155     my $self=shift;
 156     $self->get( [ 0 .. $self->length - 1  ] );
 157 }
 158 sub get {
 159     my ($self, $indices) = @_;
 160     return  map {  gsl_vector_get($self->{_vector}, $_ ) } @$indices ;
 161 }
 162
 163 sub set {
 164     my ($self, $indices, $values) = @_;
 165     die (__PACKAGE__.'::set($indices, $values) - $indices and $values must be array references of the same length')
 166         unless ( ref $indices eq 'ARRAY' && ref $values eq 'ARRAY' &&  $#$indices == $#$values );
 167     eval {
 168         map {  gsl_vector_set($self->{_vector}, $indices->[$_], $values->[$_] ) } (0..$#$indices);
 169     };
 170     return;
 171 }
 172
 173 sub _multiplication {
 174     my ($left,$right) = @_;
 175     if ( blessed $right && $right->isa('Math::GSL::Vector') ) {
 176         return $left->dot_product($right);
 177     } else {
 178         gsl_vector_scale($left->raw, $right);
 179     }
 180     return $left;
 181 }
 182
 183 sub dot_product {
 184     my ($left,$right) = @_;
 185     my $sum=0;
 186     if ( blessed $right && $right->isa('Math::GSL::Vector') &&
 187          blessed $left  && $left->isa('Math::GSL::Vector') &&
 188          $left->length == $right->length ) {
 189          my @l = $left->as_list;
 190          my @r = $right->as_list;
 191          map { $sum += $l[$_] * $r[$_] } (0..$#l);
 192         return $sum;
 193     } else {
 194         croak "dot_product() must be called with two vectors";
 195     }
 196 }
 197
 198 =head1 DESCRIPTION
 199
 200 Here is a list of all the functions included in this module :
 201
 202 =over 1
 203
 204 =item C<gsl_vector_alloc($x)> - create a vector of size $x
 205
 206 =item C<gsl_vector_calloc($x)> - create a vector of size $x and initializes all the elements of the vector to zero
 207
 208 =item C<gsl_vector_alloc_from_block>
 209
 210 =item C<gsl_vector_alloc_from_vector>
 211
 212 =item C<gsl_vector_free($v)> - free a previously allocated vector $v
 213
 214 =item C<gsl_vector_view_array>
 215
 216 =item C<gsl_vector_view_array_with_stride>
 217
 218 =item C<gsl_vector_const_view_array_with_stride>
 219
 220 =item C<gsl_vector_subvector($v, $offset, $n)> - return a vector_view type which contains a subvector of $v, with a size of $size, starting from the $offset position
 221
 222 =item C<gsl_vector_subvector_with_stride($v, $offset, $stride, $size)> - return a vector_view type which contains a subvector of $v, with a size of $size, starting from the $offset position and with a $stride step between each element of $v
 223
 224 =item C<gsl_vector_const_subvector>
 225
 226 =item C<gsl_vector_get($v, $i)> - return the $i-th element of a vector $v
 227
 228 =item C<gsl_vector_set($v, $i, $x)> - return the vector $v with his $i-th element set to $x
 229
 230 =item C<gsl_vector_ptr>
 231
 232 =item C<gsl_vector_const_ptr>
 233
 234 =item C<gsl_vector_set_zero($v)> - set all the elements of $v to 0
 235
 236 =item C<gsl_vector_set_all($v, $x)> - set all the elements of $v to $x
 237
 238 =item C<gsl_vector_set_basis($v, $i)> - set all the elements of $v to 0 except for the $i-th element which is set to 1 and return 0 if the operation succeded, 1 otherwise.
 239
 240 =item C<gsl_vector_fread($file, $v)> - This function reads into the vector $v from the open stream $file opened with fopen in binary format. The vector $v must be preallocated with the correct length since the function uses the size of $v to determine how many bytes to read. The return value is 0 for success and 1 if there was a problem reading from the file.
 241
 242 =item C<gsl_vector_fwrite($file, $v)> - This function writes the elements of the vector $v to the stream $file opened with fopen in binary format. The return value is 0 for success and 1 if there was a problem writing to the file. Since the data is written in the native binary format it may not be portable between different architectures.
 243
 244 =item C<gsl_vector_fscanf($file, $v)> This function reads formatted data from the stream $file opened with fopen into the vector $v. The vector $v must be preallocated with the correct length since the function uses the size of $v to determine how many numbers to read. The function returns 0 for success and 1 if there was a problem reading from the file.
 245
 246 =item C<gsl_vector_fprintf($file, $v, $format)> -This function writes the elements of the vector $v line-by-line to the stream $file opened with fopen using the format specifier format, which should be one of the "%g", "%e" or "%f" formats for floating point numbers and "%d" for integers. The function returns 0 for success and 1 if there was a problem writing to the file.
 247
 248 =item C<gsl_vector_memcpy($dest, $src)> - This function copies the elements of the vector $src into the vector $dest and return 0 if the opertaion succeded, 1 otherwise. The two vectors must have the same length.
 249
 250 =item C<gsl_vector_reverse($v)> - reverse the order of the elements of the vector $v and return 0 if the opertaion succeded, 1 otherwise
 251
 252 =item C<gsl_vector_swap($v, $v2)> - swap the values of the vectors $v and $v2 and return 0 if the opertaion succeded, 1 otherwise
 253
 254 =item C<gsl_vector_swap_elements($v, $i, $j)> - permute the elements at position $i and $j in the vector $v and return 0 if the operation succeded, 1 otherwise.
 255
 256 =item C<gsl_vector_max($v)> - return the maximum value in the vector $v
 257
 258 =item C<gsl_vector_min($v)> - return the minimum value in the vector $v
 259
 260 =item C<gsl_vector_minmax($v)> - return two values, the first is the minimum value in the vector $v and the second is the maximum value.
 261
 262 =item C<gsl_vector_max_index($v)> - return the position of the maximum value in the vector $v
 263
 264 =item C<gsl_vector_min_index($v)> - return the position of the minimum value in the vector $v
 265
 266 =item C<gsl_vector_minmax_index> -  return two values, the first is the position of the minimum value in the vector $v and the second is the position of the maximum value.
 267
 268 =item C<gsl_vector_add($v, $v2)> - add the elements of $v2 to the elements of $v, the two vectors must have the same lenght and return 0 if the operation succeded, 1 otherwise.
 269
 270 =item C<gsl_vector_sub($v, $v2)> - substract the elements of $v2 from the elements of $v, the two vectors must have the same lenght and return 0 if the operation succeded, 1 otherwise.
 271
 272 =item C<gsl_vector_mul($v, $v2)> - multiply the elements of $v by the elements of $v2, the two vectors must have the same lenght and return 0 if the operation succeded, 1 otherwise.
 273
 274 =item C<gsl_vector_div($v, $v2)> - divides the elements of $v by the elements of $v2, the two vectors must have the same lenght and return 0 if the operation succeded, 1 otherwise.
 275
 276 =item C<gsl_vector_scale($v, $x)> - multiplty the elements of the vector $v by a constant $x and return 0 if the operation succeded, 1 otherwise.
 277
 278 =item C<gsl_vector_add_constant($v, $x)> - add a constant $x to the elements of the vector $v and return 0 if the operation succeded, 1 otherwise.
 279
 280 =item C<gsl_vector_isnull($v)> - verify if all the elements of the vector $v are null, return 0 if it's the case, 1 otherwise.
 281
 282 =item C<gsl_vector_ispos($v)> - verify if all the elements of the vector $v are positive, return 0 if it's the case, 1 otherwise.
 283
 284 =item C<gsl_vector_isneg($v)> - verify if all the elements of the vector $v are negative, return 0 if it's the case, 1 otherwise.
 285
 286 =item C<gsl_vector_isnonneg($v)> - verify if all the elements the vector $v are not negative, return 0 if it's the case, 1 otherwise.
 287
 288 =back
 289
 290 You have to add the functions you want to use inside the qw /put_funtion_here / with spaces between each function. You can also write use Math::GSL::Complex qw/:all/ to use all avaible functions of the module.
 291
 292
 293 Precision on the vector_view type : every modification you'll make on a vector_view will also modify the original vector.
 294 For example, the following code will zero the even elements of the vector $v of length $size, while leaving the odd elements untouched :
 295
 296 =over 1
 297
 298 =item C<$v_even= gsl_vector_subvector_with_stride ($v, 0, 2, $size/2);>
 299
 300 =item C<gsl_vector_set_zero ($v_even-E<gt>{vector});>
 301
 302 =back
 303
 304 For more informations on the functions, we refer you to the GSL offcial documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
 305 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
 306
 307 =head1 EXAMPLES
 308
 309  use Math::GSL::Vector qw/:all/;
 310  print "We'll create this vector : [0,1,4,9,16] \n";
 311  my $vector = Math::GSL::Vector->new([0,1,4,9,16]);
 312  my ($min, $max) = gsl_vector_minmax_index($vector->raw);
 313  print "We then check the index value of the maximum and minimum values of the vector. \n";
 314  print "The index of the maximum should be 4 and we received $max \n";
 315  print "The index of the minimum should be 0 and we received $min \n";
 316  print "We'll then swap the first and the third elements of the vector \n";
 317  gsl_vector_swap_elements($vector->raw, 0, 3);
 318  my @got = $vector->as_list;
 319  print "The vector should now be like this : [9,1,4,0,16] \n";
 320  print "and we received : [";
 321  for (my $element=0; $element<4; $element++) {
 322  print "$got[$element],"; }
 323  print "$got[4]] \n";
 324
 325 =head1 AUTHOR
 326
 327 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 328
 329 =head1 COPYRIGHT AND LICENSE
 330
 331 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 332
 333 This program is free software; you can redistribute it and/or modify it
 334 under the same terms as Perl itself.
 335
 336 =cut
 337 %}