Vector.i

   1 %module 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 "/usr/local/include/gsl/gsl_nan.h"
  33     #include "/usr/local/include/gsl/gsl_vector.h"
  34     #include "/usr/local/include/gsl/gsl_vector_char.h"
  35     #include "/usr/local/include/gsl/gsl_vector_complex.h"
  36     #include "/usr/local/include/gsl/gsl_vector_complex_double.h"
  37     #include "/usr/local/include/gsl/gsl_vector_double.h"
  38     #include "/usr/local/include/gsl/gsl_vector_float.h"
  39     #include "/usr/local/include/gsl/gsl_vector_int.h"
  40 %}
  41
  42 %include "/usr/local/include/gsl/gsl_nan.h"
  43 %include "/usr/local/include/gsl/gsl_vector.h"
  44 %include "/usr/local/include/gsl/gsl_vector_char.h"
  45 %include "/usr/local/include/gsl/gsl_vector_complex.h"
  46 %include "/usr/local/include/gsl/gsl_vector_complex_double.h"
  47 %include "/usr/local/include/gsl/gsl_vector_double.h"
  48 %include "/usr/local/include/gsl/gsl_vector_int.h"
  49
  50
  51
  52 %perlcode %{
  53
  54
  55 @EXPORT_OK  = qw/fopen fclose
  56                  gsl_vector_alloc gsl_vector_calloc gsl_vector_alloc_from_b gsl_vector_alloc_from_v
  57                  gsl_vector_free gsl_vector_view_array gsl_vector_view_array_w
  58                  gsl_vector_const_view_a gsl_vector_subvector gsl_vector_subvector_wi gsl_vector_subvector_with_stride
  59                  gsl_vector_const_subvec gsl_vector_const_subvec gsl_vector_get gsl_vector_set
  60                  gsl_vector_ptr gsl_vector_const_ptr gsl_vector_set_zero gsl_vector_set_all
  61                  gsl_vector_set_basis gsl_vector_fread gsl_vector_fwrite gsl_vector_fscanf
  62                  gsl_vector_fprintf gsl_vector_memcpy gsl_vector_reverse gsl_vector_swap
  63                  gsl_vector_swap_elements gsl_vector_max gsl_vector_min gsl_vector_minmax
  64                  gsl_vector_max_index gsl_vector_min_index gsl_vector_minmax_index
  65                  gsl_vector_add gsl_vector_sub gsl_vector_mul gsl_vector_div
  66                  gsl_vector_scale gsl_vector_add_constant gsl_vector_isnull
  67                  gsl_vector_ispos gsl_vector_isneg gsl_vector_isnonneg
  68                  /;
  69 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  70
  71 sub new {
  72     my ($class, $values) = @_;
  73     my $length  = $#$values;
  74     my $this = {};
  75     my $vector;
  76     if ( ref $values eq 'ARRAY' ){
  77         die __PACKAGE__.'::new($x) - $x must a nonempty array reference' if $length == -1;
  78         $vector  = gsl_vector_alloc($length+1);
  79         map { gsl_vector_set($vector, $_, $values->[$_] ) }  (0 .. $length);
  80         $this->{_length} = $length+1;
  81     } elsif ( (int($values) == $values) && ($values > 0)) {
  82         $vector  = gsl_vector_alloc($values);
  83         $this->{_length} = $values;
  84     } else {
  85         die __PACKAGE__.'::new($x) - $x must be an int or array reference';
  86     }
  87     $this->{_vector} = $vector;
  88     bless $this, $class;
  89 }
  90
  91 sub length { my $self=shift; $self->{_length} }
  92
  93 sub get_all {
  94     my $self=shift;
  95     $self->get( [ 0 .. $self->length - 1  ] );
  96 }
  97 sub get {
  98     my ($self, $indices) = @_;
  99     return  map {  gsl_vector_get($self->{_vector}, $_ ) } @$indices ;
 100 }
 101
 102 sub set {
 103     my ($self, $indices, $values) = @_;
 104     die (__PACKAGE__.'::set($indices, $values) - $indices and $values must be array references of the same length')
 105         unless ( ref $indices eq 'ARRAY' && ref $values eq 'ARRAY' &&  $#$indices == $#$values );
 106     eval {
 107         map {  gsl_vector_set($self->{_vector}, $indices->[$_], $values->[$_] ) } (0..$#$indices);
 108     };
 109     return;
 110 }
 111
 112 __END__
 113
 114 =head1 NAME
 115
 116 Math::GSL::Vector - Functions concerning vectors
 117
 118 =head1 SYPNOPSIS
 119
 120     use Math::GSL::Vector qw/:all/;
 121
 122 =head1 DESCRIPTION
 123
 124 Here is a list of all the functions included in this module :
 125
 126     gsl_vector_alloc($x) - create a vector of size $x
 127
 128     gsl_vector_calloc($x) - create a vector of size $x and initializes all the elements of the vector to zero
 129
 130     gsl_vector_alloc_from_b
 131
 132     gsl_vector_alloc_from_v
 133
 134     gsl_vector_free($v) - free a previously allocated vector $v
 135
 136     gsl_vector_view_array
 137
 138     gsl_vector_view_array_w
 139
 140     gsl_vector_const_view_a
 141
 142     gsl_vector_subvector - return a vector_view type which contains a subvector of $v, with a size of $size, starting from the $offset position
 143
 144     gsl_vector_subvector_wi
 145
 146     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
 147
 148     gsl_vector_const_subvec
 149
 150     gsl_vector_get($v, $i) - return the $i-th element of a vector $v
 151
 152     gsl_vector_set($v, $i, $x) - return the vector $v with his $i-th element set to $x
 153
 154     gsl_vector_ptr
 155
 156     gsl_vector_const_ptr
 157
 158     gsl_vector_set_zero($v) - set all the elements of $v to 0
 159
 160     gsl_vector_set_all($v, $x) - set all the elements of $v to $x
 161
 162     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.
 163
 164     gsl_vector_fread($file, $v)
 165
 166     gsl_vector_fwrite
 167
 168     gsl_vector_fscanf
 169
 170     gsl_vector_fprintf
 171
 172     gsl_vector_memcpy
 173
 174     gsl_vector_reverse($v) - reverse the order of the elements of the vector $v and return 0 if the opertaion succeded, 1 otherwise
 175
 176     gsl_vector_swap($v, $v2) - swap the values of the vectors $v and $v2 and return 0 if the opertaion succeded, 1 otherwise
 177
 178     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.
 179
 180     gsl_vector_max($v) - return the maximum value in the vector $v
 181
 182     gsl_vector_min($v) - return the minimum value in the vector $v
 183
 184     gsl_vector_minmax
 185
 186     gsl_vector_max_index($v) - return the position of the maximum value in the vector $v
 187
 188     gsl_vector_min_index - return the position of the minimum value in the vector $v
 189
 190     gsl_vector_minmax_index
 191
 192     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.
 193
 194     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.
 195
 196     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.
 197
 198     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.
 199
 200     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.
 201
 202     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.
 203
 204     gsl_vector_isnull($v) - verify if all the elements of the vector $v are null, return 0 if it's the case, 1 otherwise.
 205
 206     gsl_vector_ispos($v) - verify if all the elements of the vector $v are positive, return 0 if it's the case, 1 otherwise.
 207
 208     gsl_vector_isneg($v) - verify if all the elements of the vector $v are negative, return 0 if it's the case, 1 otherwise.
 209
 210     gsl_vector_isnonneg($v) - verify if all the elements the vector $v are not negative, return 0 if it's the case, 1 otherwise.
 211
 212
 213 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.
 214
 215
 216 Precision on the vector_view type : every modification you'll make on a vector_view will also modify the original vector.
 217 For example, the following code will zero the even elements of the vector v of length n, while leaving the odd elements untouched :
 218
 219 $v_even= gsl_vector_subvector_with_stride ($v, 0, 2, $size/2);
 220 gsl_vector_set_zero ($v_even->{vector});
 221
 222
 223 For more informations on the functions, we refer you to the GSL offcial documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
 224 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
 225
 226 =head1 EXAMPLES
 227
 228
 229 =head1 AUTHOR
 230
 231 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 232
 233 =head1 COPYRIGHT AND LICENSE
 234
 235 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 236
 237 This program is free software; you can redistribute it and/or modify it
 238 under the same terms as Perl itself.
 239
 240 =cut
 241 %}