Matrix.i

   1 %module Matrix
   2
   3 %include "typemaps.i"
   4 %include "gsl_typemaps.i"
   5
   6 %apply int *OUTPUT { size_t *imin, size_t *imax, size_t *jmin, size_t *jmax };
   7 //%apply gsl_vector *OUTPUT { gsl_vector *V };
   8 %apply double *OUTPUT { double * min_out, double * max_out };
   9
  10 FILE * fopen(char *, char *);
  11 int fclose(FILE *);
  12
  13 %{
  14     #include "gsl/gsl_matrix.h"
  15     #include "gsl/gsl_complex.h"
  16     #include "gsl/gsl_vector_double.h"
  17     #include "gsl/gsl_matrix_double.h"
  18     #include "gsl/gsl_matrix_int.h"
  19     #include "gsl/gsl_matrix_complex_double.h"
  20     #include "gsl/gsl_matrix_char.h"
  21 %}
  22
  23 %include "gsl/gsl_matrix.h"
  24 %include "gsl/gsl_complex.h"
  25 %include "gsl/gsl_vector_double.h"
  26 %include "gsl/gsl_matrix_double.h"
  27 %include "gsl/gsl_matrix_int.h"
  28 %include "gsl/gsl_matrix_complex_double.h"
  29 %include "gsl/gsl_matrix_char.h"
  30
  31
  32 %perlcode %{
  33
  34 no warnings 'redefine';
  35 use Carp qw/croak/;
  36 use Math::GSL qw/:all/;
  37 use Math::GSL::Errno qw/:all/;
  38
  39 @EXPORT_OK = qw/fopen fclose
  40         gsl_matrix_alloc gsl_matrix_calloc gsl_matrix_alloc_from_block
  41         gsl_matrix_alloc_from_matrix gsl_vector_alloc_row_from_matrix
  42         gsl_vector_alloc_col_from_matrix gsl_matrix_free gsl_matrix_submatrix
  43         gsl_matrix_row gsl_matrix_column gsl_matrix_diagonal
  44         gsl_matrix_subdiagonal gsl_matrix_superdiagonal gsl_matrix_subrow
  45         gsl_matrix_subcolumn gsl_matrix_view_array
  46         gsl_matrix_view_array_with_tda gsl_matrix_view_vector
  47         gsl_matrix_view_vector_with_tda gsl_matrix_const_submatrix
  48         gsl_matrix_const_row gsl_matrix_const_column gsl_matrix_const_diagonal
  49         gsl_matrix_const_subdiagonal gsl_matrix_const_superdiagonal
  50         gsl_matrix_const_subrow gsl_matrix_const_subcolumn
  51         gsl_matrix_const_view_array gsl_matrix_const_view_array_with_tda
  52         gsl_matrix_const_view_vector gsl_matrix_const_view_vector_with_tda
  53         gsl_matrix_get gsl_matrix_set gsl_matrix_ptr gsl_matrix_const_ptr
  54         gsl_matrix_set_zero gsl_matrix_set_identity gsl_matrix_set_all
  55         gsl_matrix_fread gsl_matrix_fwrite gsl_matrix_fscanf gsl_matrix_fprintf
  56         gsl_matrix_memcpy gsl_matrix_swap gsl_matrix_swap_rows
  57         gsl_matrix_swap_columns gsl_matrix_swap_rowcol gsl_matrix_transpose
  58         gsl_matrix_transpose_memcpy gsl_matrix_max gsl_matrix_min
  59         gsl_matrix_minmax gsl_matrix_max_index gsl_matrix_min_index
  60         gsl_matrix_minmax_index gsl_matrix_isnull gsl_matrix_ispos
  61         gsl_matrix_isneg gsl_matrix_isnonneg gsl_matrix_add gsl_matrix_sub
  62         gsl_matrix_mul_elements gsl_matrix_div_elements gsl_matrix_scale
  63         gsl_matrix_add_constant gsl_matrix_add_diagonal
  64         gsl_matrix_char_alloc gsl_matrix_char_calloc  gsl_matrix_char_alloc_from_block
  65         gsl_matrix_char_alloc_from_matrix gsl_vector_char_alloc_row_from_matrix gsl_vector_char_alloc_col_from_matrix
  66         gsl_matrix_char_free gsl_matrix_char_submatrix
  67         gsl_matrix_char_row  gsl_matrix_char_column
  68         gsl_matrix_char_diagonal gsl_matrix_char_subdiagonal gsl_matrix_char_superdiagonal
  69         gsl_matrix_char_subrow gsl_matrix_char_subcolumn gsl_matrix_char_view_array
  70         gsl_matrix_char_view_array_with_tda gsl_matrix_char_view_vector gsl_matrix_char_view_vector_with_tda
  71         gsl_matrix_char_const_submatrix gsl_matrix_char_const_row gsl_matrix_char_const_column
  72         gsl_matrix_char_const_diagonal gsl_matrix_char_const_subdiagonal gsl_matrix_char_const_superdiagonal
  73         gsl_matrix_char_const_subrow gsl_matrix_char_const_subcolumn gsl_matrix_char_const_view_array
  74         gsl_matrix_char_const_view_array_with_tda gsl_matrix_char_const_view_vector gsl_matrix_char_const_view_vector_with_tda
  75         gsl_matrix_char_get gsl_matrix_char_set gsl_matrix_char_ptr gsl_matrix_char_const_ptr
  76         gsl_matrix_char_set_zero gsl_matrix_char_set_identity
  77         gsl_matrix_char_set_all  gsl_matrix_char_fread
  78         gsl_matrix_char_fwrite gsl_matrix_char_fscanf gsl_matrix_char_fprintf
  79         gsl_matrix_char_memcpy gsl_matrix_char_swap
  80         gsl_matrix_char_swap_rows gsl_matrix_char_swap_columns
  81         gsl_matrix_char_swap_rowcol gsl_matrix_char_transpose gsl_matrix_char_transpose_memcpy
  82         gsl_matrix_char_max gsl_matrix_char_min
  83         gsl_matrix_char_minmax  gsl_matrix_char_max_index
  84         gsl_matrix_char_min_index gsl_matrix_char_minmax_index
  85         gsl_matrix_char_isnull gsl_matrix_char_ispos gsl_matrix_char_isneg
  86         gsl_matrix_char_isnonneg  gsl_matrix_char_add
  87         gsl_matrix_char_sub gsl_matrix_char_mul_elements gsl_matrix_char_div_elements
  88         gsl_matrix_char_scale gsl_matrix_char_add_constant gsl_matrix_char_add_diagonal
  89         gsl_matrix_int_alloc gsl_matrix_int_calloc gsl_matrix_int_alloc_from_block
  90         gsl_matrix_int_alloc_from_matrix gsl_vector_int_alloc_row_from_matrix gsl_vector_int_alloc_col_from_matrix
  91         gsl_matrix_int_free gsl_matrix_int_submatrix gsl_matrix_int_row
  92         gsl_matrix_int_column gsl_matrix_int_diagonal gsl_matrix_int_subdiagonal
  93         gsl_matrix_int_superdiagonal gsl_matrix_int_subrow gsl_matrix_int_subcolumn gsl_matrix_int_view_array
  94         gsl_matrix_int_view_array_with_tda gsl_matrix_int_view_vector gsl_matrix_int_view_vector_with_tda
  95         gsl_matrix_int_const_submatrix gsl_matrix_int_const_row gsl_matrix_int_const_column
  96         gsl_matrix_int_const_diagonal gsl_matrix_int_const_subdiagonal gsl_matrix_int_const_superdiagonal
  97         gsl_matrix_int_const_subrow gsl_matrix_int_const_subcolumn gsl_matrix_int_const_view_array
  98         gsl_matrix_int_const_view_array_with_tda gsl_matrix_int_const_view_vector gsl_matrix_int_const_view_vector_with_tda
  99         gsl_matrix_int_get gsl_matrix_int_set
 100         gsl_matrix_int_ptr gsl_matrix_int_const_ptr
 101         gsl_matrix_int_set_zero gsl_matrix_int_set_identity gsl_matrix_int_set_all
 102         gsl_matrix_int_fread gsl_matrix_int_fwrite
 103         gsl_matrix_int_fscanf gsl_matrix_int_fprintf
 104         gsl_matrix_int_memcpy gsl_matrix_int_swap
 105         gsl_matrix_int_swap_rows gsl_matrix_int_swap_columns gsl_matrix_int_swap_rowcol
 106         gsl_matrix_int_transpose gsl_matrix_int_transpose_memcpy
 107         gsl_matrix_int_max gsl_matrix_int_min gsl_matrix_int_minmax
 108         gsl_matrix_int_max_index gsl_matrix_int_min_index
 109         gsl_matrix_int_minmax_index  gsl_matrix_int_isnull
 110         gsl_matrix_int_ispos gsl_matrix_int_isneg gsl_matrix_int_isnonneg
 111         gsl_matrix_int_add gsl_matrix_int_sub
 112         gsl_matrix_int_mul_elements gsl_matrix_int_div_elements gsl_matrix_int_scale
 113         gsl_matrix_int_add_constant gsl_matrix_int_add_diagonal
 114         gsl_matrix_get_row gsl_matrix_get_col gsl_matrix_set_row gsl_matrix_set_col
 115         gsl_matrix_complex_alloc gsl_matrix_complex_calloc gsl_matrix_complex_alloc_from_block
 116         gsl_matrix_complex_alloc_from_matrix gsl_vector_complex_alloc_row_from_matrix gsl_vector_complex_alloc_col_from_matrix
 117         gsl_matrix_complex_free gsl_matrix_complex_submatrix gsl_matrix_complex_row
 118         gsl_matrix_complex_column gsl_matrix_complex_diagonal gsl_matrix_complex_subdiagonal
 119         gsl_matrix_complex_superdiagonal gsl_matrix_complex_subrow gsl_matrix_complex_subcolumn
 120         gsl_matrix_complex_view_array gsl_matrix_complex_view_array_with_tda gsl_matrix_complex_view_vector
 121         gsl_matrix_complex_view_vector_with_tda gsl_matrix_complex_const_submatrix gsl_matrix_complex_const_row
 122         gsl_matrix_complex_const_column gsl_matrix_complex_const_diagonal gsl_matrix_complex_const_subdiagonal
 123         gsl_matrix_complex_const_superdiagonal gsl_matrix_complex_const_subrow gsl_matrix_complex_const_subcolumn
 124         gsl_matrix_complex_const_view_array gsl_matrix_complex_const_view_array_with_tda gsl_matrix_complex_const_view_vector
 125         gsl_matrix_complex_const_view_vector_with_tda gsl_matrix_complex_get gsl_matrix_complex_set
 126         gsl_matrix_complex_ptr gsl_matrix_complex_const_ptr gsl_matrix_complex_set_zero
 127         gsl_matrix_complex_set_identity gsl_matrix_complex_set_all gsl_matrix_complex_fread
 128         gsl_matrix_complex_fwrite gsl_matrix_complex_fscanf gsl_matrix_complex_fprintf
 129         gsl_matrix_complex_memcpy gsl_matrix_complex_swap gsl_matrix_complex_swap_rows
 130         gsl_matrix_complex_swap_columns gsl_matrix_complex_swap_rowcol gsl_matrix_complex_transpose
 131         gsl_matrix_complex_transpose_memcpy gsl_matrix_complex_isnull gsl_matrix_complex_ispos
 132         gsl_matrix_complex_isneg gsl_matrix_complex_add gsl_matrix_complex_sub
 133         gsl_matrix_complex_mul_elements gsl_matrix_complex_div_elements gsl_matrix_complex_scale
 134         gsl_matrix_complex_add_constant gsl_matrix_complex_add_diagonal gsl_matrix_complex_get_row
 135         gsl_matrix_complex_get_col gsl_matrix_complex_set_row gsl_matrix_complex_set_col /;
 136
 137
 138
 139 %EXPORT_TAGS = ( all => [ @EXPORT_OK ],
 140                  char => [ qw/
 141                     gsl_matrix_char_alloc
 142                     gsl_matrix_char_calloc
 143                     gsl_matrix_char_alloc_from_block
 144                     gsl_matrix_char_alloc_from_matrix
 145                     gsl_vector_char_alloc_row_from_matrix
 146                     gsl_vector_char_alloc_col_from_matrix
 147                     gsl_matrix_char_free
 148                     gsl_matrix_char_submatrix
 149                     gsl_matrix_char_row
 150                     gsl_matrix_char_column
 151                     gsl_matrix_char_diagonal
 152                     gsl_matrix_char_subdiagonal
 153                     gsl_matrix_char_superdiagonal
 154                     gsl_matrix_char_subrow
 155                     gsl_matrix_char_subcolumn
 156                     gsl_matrix_char_view_array
 157                     gsl_matrix_char_view_array_with_tda
 158                     gsl_matrix_char_view_vector
 159                     gsl_matrix_char_view_vector_with_tda
 160                     gsl_matrix_char_const_submatrix
 161                     gsl_matrix_char_const_row
 162                     gsl_matrix_char_const_column
 163                     gsl_matrix_char_const_diagonal
 164                     gsl_matrix_char_const_subdiagonal
 165                     gsl_matrix_char_const_superdiagonal
 166                     gsl_matrix_char_const_subrow
 167                     gsl_matrix_char_const_subcolumn
 168                     gsl_matrix_char_const_view_array
 169                     gsl_matrix_char_const_view_array_with_tda
 170                     gsl_matrix_char_const_view_vector
 171                     gsl_matrix_char_const_view_vector_with_tda
 172                     gsl_matrix_char_get
 173                     gsl_matrix_char_set
 174                     gsl_matrix_char_ptr
 175                     gsl_matrix_char_const_ptr
 176                     gsl_matrix_char_set_zero
 177                     gsl_matrix_char_set_identity
 178                     gsl_matrix_char_set_all
 179                     gsl_matrix_char_fread
 180                     gsl_matrix_char_fwrite
 181                     gsl_matrix_char_fscanf
 182                     gsl_matrix_char_fprintf
 183                     gsl_matrix_char_memcpy
 184                     gsl_matrix_char_swap
 185                     gsl_matrix_char_swap_rows
 186                     gsl_matrix_char_swap_columns
 187                     gsl_matrix_char_swap_rowcol
 188                     gsl_matrix_char_transpose
 189                     gsl_matrix_char_transpose_memcpy
 190                     gsl_matrix_char_max
 191                     gsl_matrix_char_min
 192                     gsl_matrix_char_minmax
 193                     gsl_matrix_char_max_index
 194                     gsl_matrix_char_min_index
 195                     gsl_matrix_char_minmax_index
 196                     gsl_matrix_char_isnull
 197                     gsl_matrix_char_ispos
 198                     gsl_matrix_char_isneg
 199                     gsl_matrix_char_isnonneg
 200                     gsl_matrix_char_add
 201                     gsl_matrix_char_sub
 202                     gsl_matrix_char_mul_elements
 203                     gsl_matrix_char_div_elements
 204                     gsl_matrix_char_scale
 205                     gsl_matrix_char_add_constant
 206                     gsl_matrix_char_add_diagonal
 207                      /],
 208
 209                  double => [ qw/
 210                     gsl_matrix_alloc
 211                     gsl_matrix_calloc
 212                     gsl_matrix_alloc_from_block
 213                     gsl_matrix_alloc_from_matrix
 214                     gsl_vector_alloc_row_from_matrix
 215                     gsl_vector_alloc_col_from_matrix
 216                     gsl_matrix_free
 217                     gsl_matrix_submatrix
 218                     gsl_matrix_row
 219                     gsl_matrix_column
 220                     gsl_matrix_diagonal
 221                     gsl_matrix_subdiagonal
 222                     gsl_matrix_superdiagonal
 223                     gsl_matrix_subrow
 224                     gsl_matrix_subcolumn
 225                     gsl_matrix_view_array
 226                     gsl_matrix_view_array_with_tda
 227                     gsl_matrix_view_vector
 228                     gsl_matrix_view_vector_with_tda
 229                     gsl_matrix_const_submatrix
 230                     gsl_matrix_const_row
 231                     gsl_matrix_const_column
 232                     gsl_matrix_const_diagonal
 233                     gsl_matrix_const_subdiagonal
 234                     gsl_matrix_const_superdiagonal
 235                     gsl_matrix_const_subrow
 236                     gsl_matrix_const_subcolumn
 237                     gsl_matrix_const_view_array
 238                     gsl_matrix_const_view_array_with_tda
 239                     gsl_matrix_const_view_vector
 240                     gsl_matrix_const_view_vector_with_tda
 241                     gsl_matrix_get
 242                     gsl_matrix_set
 243                     gsl_matrix_ptr
 244                     gsl_matrix_const_ptr
 245                     gsl_matrix_set_zero
 246                     gsl_matrix_set_identity
 247                     gsl_matrix_set_all
 248                     gsl_matrix_fread
 249                     gsl_matrix_fwrite
 250                     gsl_matrix_fscanf
 251                     gsl_matrix_fprintf
 252                     gsl_matrix_memcpy
 253                     gsl_matrix_swap
 254                     gsl_matrix_swap_rows
 255                     gsl_matrix_swap_columns
 256                     gsl_matrix_swap_rowcol
 257                     gsl_matrix_transpose
 258                     gsl_matrix_transpose_memcpy
 259                     gsl_matrix_max
 260                     gsl_matrix_minmax
 261                     gsl_matrix_max_index
 262                     gsl_matrix_min_index
 263                     gsl_matrix_minmax_index
 264                     gsl_matrix_isnull
 265                     gsl_matrix_ispos
 266                     gsl_matrix_isneg
 267                     gsl_matrix_isnonneg
 268                     gsl_matrix_add
 269                     gsl_matrix_mul_elements
 270                     gsl_matrix_div_elements
 271                     gsl_matrix_scale
 272                     gsl_matrix_add_constant
 273                     gsl_matrix_add_diagonal
 274                     /],
 275 int => [ qw/
 276                  gsl_matrix_int_alloc
 277                  gsl_matrix_int_alloc_from_matrix
 278                  gsl_matrix_int_free
 279                  gsl_matrix_int_column
 280                  gsl_matrix_int_superdiagonal
 281                  gsl_matrix_int_view_array_with_tda
 282                  gsl_matrix_int_const_submatrix
 283                  gsl_matrix_int_const_diagonal
 284                  gsl_matrix_int_const_subrow
 285                  gsl_matrix_int_const_view_array_with_tda
 286                  gsl_matrix_int_get
 287                  gsl_matrix_int_ptr
 288                  gsl_matrix_int_set_zero
 289                  gsl_matrix_int_fread
 290                  gsl_matrix_int_fscanf
 291                  gsl_matrix_int_memcpy
 292                  gsl_matrix_int_swap_rows
 293                  gsl_matrix_int_transpose
 294                  gsl_matrix_int_max
 295                  gsl_matrix_int_max_index
 296                  gsl_matrix_int_minmax_index
 297                  gsl_matrix_int_ispos
 298                  gsl_matrix_int_add
 299                  gsl_matrix_int_mul_elements
 300                  gsl_matrix_int_add_constant
 301                  /],
 302   complex => [ qw/
 303                  gsl_matrix_complex_alloc
 304                  gsl_matrix_complex_calloc
 305                  gsl_matrix_complex_alloc_from_block
 306                  gsl_matrix_complex_alloc_from_matrix
 307                  gsl_vector_complex_alloc_row_from_matrix
 308                  gsl_vector_complex_alloc_col_from_matrix
 309                  gsl_matrix_complex_free
 310                  gsl_matrix_complex_submatrix
 311                  gsl_matrix_complex_row
 312                  gsl_matrix_complex_column
 313                  gsl_matrix_complex_diagonal
 314                  gsl_matrix_complex_subdiagonal
 315                  gsl_matrix_complex_superdiagonal
 316                  gsl_matrix_complex_subrow
 317                  gsl_matrix_complex_subcolumn
 318                  gsl_matrix_complex_view_array
 319                  gsl_matrix_complex_view_array_with_tda
 320                  gsl_matrix_complex_view_vector
 321                  gsl_matrix_complex_view_vector_with_tda
 322                  gsl_matrix_complex_const_submatrix
 323                  gsl_matrix_complex_const_row
 324                  gsl_matrix_complex_const_column
 325                  gsl_matrix_complex_const_diagonal
 326                  gsl_matrix_complex_const_subdiagonal
 327                  gsl_matrix_complex_const_superdiagonal
 328                  gsl_matrix_complex_const_subrow
 329                  gsl_matrix_complex_const_subcolumn
 330                  gsl_matrix_complex_const_view_array
 331                  gsl_matrix_complex_const_view_array_with_tda
 332                  gsl_matrix_complex_const_view_vector
 333                  gsl_matrix_complex_const_view_vector_with_tda
 334                  gsl_matrix_complex_get
 335                  gsl_matrix_complex_set
 336                  gsl_matrix_complex_ptr
 337                  gsl_matrix_complex_const_ptr
 338                  gsl_matrix_complex_set_zero gsl_matrix_complex_set_identity
 339                  gsl_matrix_complex_set_all
 340                  gsl_matrix_complex_fread
 341                  gsl_matrix_complex_fwrite
 342                  gsl_matrix_complex_fscanf
 343                  gsl_matrix_complex_fprintf
 344                  gsl_matrix_complex_memcpygsl_matrix_complex_swap
 345                  gsl_matrix_complex_swap_rows
 346                  gsl_matrix_complex_swap_columns
 347                  gsl_matrix_complex_swap_rowcol
 348                  gsl_matrix_complex_transpose
 349                  gsl_matrix_complex_transpose_memcpy
 350                  gsl_matrix_complex_isnull
 351                  gsl_matrix_complex_ispos
 352                  gsl_matrix_complex_isneg
 353                  gsl_matrix_complex_add
 354                  gsl_matrix_complex_sub
 355                  gsl_matrix_complex_mul_elements
 356                  gsl_matrix_complex_div_elements
 357                  gsl_matrix_complex_scale
 358                  gsl_matrix_complex_add_constant
 359                  gsl_matrix_complex_add_diagonal
 360                  gsl_matrix_complex_get_row
 361                  gsl_matrix_complex_get_col
 362                  gsl_matrix_complex_set_row
 363                  gsl_matrix_complex_set_col
 364                  /]);
 365
 366 =head1 NAME
 367
 368 Math::GSL::Matrix - Mathematical functions concerning Matrices
 369
 370 =head1 SYNOPSIS
 371
 372     use Math::GSL::Matrix qw/:all/;
 373     my $matrix1 = Math::GSL::Matrix->new(5,5);  # OO interface
 374     my $matrix2 = gsl_matrix_alloc(5,5);        # standard interface
 375
 376
 377 =head1 Objected Oriented Interface to GSL Math::GSL::Matrix
 378
 379     my $matrix = Math::GSL::Matrix->new(10,10);
 380     printf "My matrix is %d x %d\n", $matrix->rows, $matrix->cols;
 381 =cut
 382
 383 sub new
 384 {
 385     my ($class, $rows, $cols) = @_;
 386     my $this = {};
 387     my $matrix;
 388     if ( defined $rows       && defined $cols &&
 389         $rows > 0            && $cols > 0     &&
 390         (int $rows == $rows) && (int $cols == $cols)){
 391
 392         $matrix  = gsl_matrix_alloc($rows,$cols);
 393     } else {
 394         croak( __PACKAGE__.'::new($x,$y) - $x and $y must be positive integers');
 395     }
 396     gsl_matrix_set_zero($matrix);
 397     $this->{_matrix} = $matrix;
 398     ($this->{_rows}, $this->{_cols}) = ($rows,$cols);
 399     bless $this, $class;
 400 }
 401 =head2 raw()
 402
 403 Get the underlying GSL matrix object created by SWIG, useful for using gsl_matrix_* functions which do not have an OO counterpart.
 404
 405     my $matrix     = Math::GSL::Matrix->new(3,3);
 406     my $gsl_matrix = $matrix->raw;
 407     my $stuff      = gsl_matrix_get($gsl_matrix, 1, 2);
 408
 409 =cut
 410 sub raw  { (shift)->{_matrix} }
 411 =head2 rows()
 412
 413 Returns the number of rows in the matrix.
 414
 415     my $rows = $matrix->rows;
 416 =cut
 417
 418 sub rows { (shift)->{_rows}   }
 419
 420 =head2 cols()
 421
 422 Returns the number of columns in the matrix.
 423
 424     my $cols = $matrix->cols;
 425 =cut
 426
 427 sub cols { (shift)->{_cols}   }
 428
 429 =head2  as_list()
 430
 431 Get the contents of a Math::GSL::Matrix object as a Perl list.
 432
 433     my $matrix = Math::GSL::Matrix->new(3,3);
 434     ...
 435     my @matrix = $matrix->as_list;
 436 =cut
 437
 438
 439 sub as_list
 440 {
 441     my $self = shift;
 442     my ($r,$c) = ($self->rows,$self->cols);
 443     return
 444         map {
 445             gsl_matrix_get($self->raw, _index_to_row_col($_,$r,$c))
 446         } (0 .. $self->rows*$self->cols-1 );
 447 }
 448
 449 # hackish
 450 sub _index_to_row_col($$$)
 451 {
 452     my ($k,$rows,$cols) = @_;
 453     return ( ($rows == 1 ) ? 0 : int($k/$rows), $k % $cols );
 454 }
 455
 456 sub row
 457 {
 458     my ($self, $row) = @_;
 459     croak (__PACKAGE__.'::$matrix->row($row) - invalid $row value')
 460         unless (($row < $self->rows-1) and $row > 0);
 461
 462     my $rowvec = gsl_vector_alloc($self->cols);
 463     my $rowmat = Math::GSL::Matrix->new(1,$self->cols);
 464
 465     my $status = gsl_matrix_get_row($rowvec, $self->raw, $row-1);
 466     croak (__PACKAGE__.'::gsl_matrix_get_row - ' . gsl_strerror($status) )
 467         unless ( $status == $GSL_SUCCESS );
 468
 469     $status = gsl_matrix_set_row($rowmat->raw, 0, $rowvec);
 470
 471     croak (__PACKAGE__.'::gsl_matrix_set_row - ' . gsl_strerror($status) )
 472         unless ( $status == $GSL_SUCCESS );
 473
 474     return $rowmat;
 475 }
 476
 477 sub col
 478 {
 479     my ($self, $col) = @_;
 480     croak (__PACKAGE__."::\$matrix->col(\$col) - $col not a valid column")
 481         unless ($col < $self->cols and $col > 0);
 482
 483     my $colvec = Math::GSL::Vector->new($self->cols);
 484     my $colmat = Math::GSL::Matrix->new($self->rows, 1);
 485
 486     my $status = gsl_matrix_get_col($colvec->raw, $self->raw, $col-1);
 487     $status    = gsl_matrix_set_col($colmat->raw, 0, $colvec->raw);
 488     return $colmat;
 489 }
 490
 491 =head1 DESCRIPTION
 492
 493 Here is a list of all the functions included in this module :
 494
 495 =over 1
 496
 497 =item C<gsl_matrix_alloc($i, $j)> - Return a gsl_matrix of $i rows and $j columns
 498
 499 =item C<gsl_matrix_calloc($i, $j)> - Return a gsl_matrix of $i rows and $j columns and initialize all of the elements of the matrix to zero
 500
 501 =item C<gsl_matrix_alloc_from_block> -
 502
 503 =item C<gsl_matrix_free> -
 504
 505 =item C<gsl_matrix_alloc_from_matrix > -
 506
 507 =item C<gsl_vector_alloc_row_from_matrix> -
 508
 509 =item C<gsl_vector_alloc_col_from_matrix > -
 510
 511 =item C<gsl_matrix_submatrix($m, $k1, $k2, $n1, $n2)> - Return a matrix view of the matrix $m. The upper-left element of the submatrix is the element ($k1,$k2) of the original matrix. The submatrix has $n1 rows and $n2 columns.
 512
 513 =item C<gsl_matrix_row($m , $i)> - Return a vector view of the $i-th row of the matrix $m
 514
 515 =item C<gsl_matrix_column($m, $j)> - Return a vector view of the $j-th column of the matrix $m
 516
 517 =item C<gsl_matrix_diagonal($m)> - Return a vector view of the diagonal of the vector. The matrix doesn't have to be square.
 518
 519 =item C<gsl_matrix_subdiagonal($m, $k)> - Return a vector view of the $k-th subdiagonal of the matrix $m. The diagonal of the matrix corresponds to k=0.
 520
 521 =item C<gsl_matrix_superdiagonal($m, $k)> - Return a vector view of the $k-th superdiagonal of the matrix $m. The matrix doesn't have to be square.
 522
 523 =item C<gsl_matrix_subrow($m, $i, $offset, $n)> - Return a vector view of the $i-th row of the matrix $m beginning at offset elements and containing n elements.
 524
 525 =item C<gsl_matrix_subcolumn($m, $j, $offset, $n)> - Return a vector view of the $j-th column of the matrix $m beginning at offset elements and containing n elements.
 526
 527 =item C<gsl_matrix_view_array> -
 528
 529 =item C<gsl_matrix_view_array_with_tda > -
 530
 531 =item C<gsl_matrix_view_vector> -
 532
 533 =item C<gsl_matrix_view_vector_with_tda> -
 534
 535 =item C<gsl_matrix_const_submatrix> -
 536
 537 =item C<gsl_matrix_get($m, $i, $j)> - Return the (i,j)-th element of the matrix $m
 538
 539 =item C<gsl_matrix_set($m, $i, $j, $x)> - Set the value of the (i,j)-th element of the matrix $m to $x
 540
 541 =item C<gsl_matrix_ptr> -
 542
 543 =item C<gsl_matrix_const_ptr> -
 544
 545 =item C<gsl_matrix_set_zero($m)> - Set all the elements of the matrix $m to zero
 546
 547 =item C<gsl_matrix_set_identity($m)> - Set the elements of the matrix $m to the corresponding elements of the identity matrix
 548
 549 =item C<gsl_matrix_set_all($m, $x)> - Set all the elements of the matrix $m to the value $x
 550
 551 =item C<gsl_matrix_fread($fh, $m)> - Read a file which has been written with gsl_matrix_fwrite from the stream $fh opened with the fopen function and stores the data inside the matrix $m
 552
 553 =item C<gsl_matrix_fwrite($fh, $m)> - Write the elements of the matrix $m in binary format to a stream $fh opened with the fopen function
 554
 555 =item C<gsl_matrix_fscanf($fh, $m)> - Read a file which has been written with gsl_matrix_fprintf from the stream $fh opened with the fopen function and stores the data inside the matrix $m
 556
 557 =item C<gsl_matrix_fprintf($fh, $m, $format)> - Write the elements of the matrix $m in the format $format (for example "%f" is the format for double) to a stream $fh opened with the fopen function
 558
 559 =item C<gsl_matrix_memcpy($dest, $src)> - Copy the elements of the matrix $src to the matrix $dest. The two matrices must have the same size.
 560
 561 =item C<gsl_matrix_swap($m1, $m2)> - Exchange the elements of the matrices $m1 and $m2 by copying. The two matrices must have the same size.
 562
 563 =item C<gsl_matrix_swap_rows($m, $i, $j)> - Exchange the $i-th and $j-th row of the matrix $m. The function returns 0 if the operation suceeded, 1 otherwise.
 564
 565 =item C<gsl_matrix_swap_columns($m, $i, $j)> - Exchange the $i-th and $j-th column of the matrix $m. The function returns 0 if the operation suceeded, 1 otherwise.
 566
 567 =item C<gsl_matrix_swap_rowcol($m, $i, $j)> - Exchange the $i-th row and the $j-th column of the matrix $m. The matrix must be square. The function returns 0 if the operation suceeded, 1 otherwise.
 568
 569 =item C<gsl_matrix_transpose($m)> - This function replaces the matrix m by its transpose by copying the elements of the matrix in-place. The matrix must be square for this operation to be possible.
 570
 571 =item C<gsl_matrix_transpose_memcpy($dest, $src)> - Make the matrix $dest the transpose of the matrix $src. This function works for all matrices provided that the dimensions of the matrix dest match the transposed dimensions of the matrix src.
 572
 573 =item C<gsl_matrix_max($m)> - Return the maximum value in the matrix $m
 574
 575 =item C<gsl_matrix_min($m)> - Return the minimum value in the matrix $m
 576
 577 =item C<gsl_matrix_minmax($m)> - Return two values, the first is the minimum value of the Matrix $m and the second is the maximum of the same the same matrix.
 578
 579 =item C<gsl_matrix_max_index($m)> - Return two values, the first is the the i indice of the maximum value of the matrix $m and the second is the j indice of the same value.
 580
 581 =item C<gsl_matrix_min_index($m)> - Return two values, the first is the the i indice of the minimum value of the matrix $m and the second is the j indice of the same value.
 582
 583 =item C<gsl_matrix_minmax_index($m)> - Return four values, the first is the i indice of the minimum of the matrix $m, the second is the j indice of the same value, the third is the i indice of the maximum of the matrix $m and the fourth is the j indice of the same value
 584
 585 =item C<gsl_matrix_isnull($m)> - Return 1 if all the elements of the matrix $m are zero, 0 otherwise
 586
 587 =item C<gsl_matrix_ispos($m)> - Return 1 if all the elements of the matrix $m are strictly positve, 0 otherwise
 588
 589 =item C<gsl_matrix_isneg($m)> - Return 1 if all the elements of the matrix $m are strictly negative, 0 otherwise
 590
 591 =item C<gsl_matrix_isnonneg($m)> - Return 1 if all the elements of the matrix $m are non-negatuive, 0 otherwise
 592
 593 =item C<gsl_matrix_add($a, $b)> - Add the elements of matrix $b to the elements of matrix $a
 594
 595 =item C<gsl_matrix_sub($a, $b)> - Subtract the elements of matrix $b from the elements of matrix $a
 596
 597 =item C<gsl_matrix_mul_elements($a, $b)> - Multiplie the elements of matrix $a by the elements of matrix $b
 598
 599 =item C<gsl_matrix_div_elements($a, $b)> - Divide the elements of matrix $a by the elements of matrix $b
 600
 601 =item C<gsl_matrix_scale($a, $x)> - Multiplie the elements of matrix $a by the constant factor $x
 602
 603 =item C<gsl_matrix_add_constant($a, $x)> - Add the constant value $x to the elements of the matrix $a
 604
 605 =item C<gsl_matrix_add_diagonal($a, $x)> - Add the constant value $x to the elements of the diagonal of the matrix $a
 606
 607 =item C<gsl_matrix_get_row($v, $m, $i)> - Copy the elements of the $i-th row of the matrix $m into the vector $v. The lenght of the vector must be of the same as the lenght of the row. The function returns 0 if it succeded, 1 otherwise.
 608
 609 =item C<gsl_matrix_get_col($v, $m, $i)> - Copy the elements of the $j-th column of the matrix $m into the vector $v. The lenght of the vector must be of the same as the lenght of the column. The function returns 0 if it succeded, 1 otherwise.
 610
 611 =item C<gsl_matrix_set_row($m, $i, $v)> - Copy the elements of vector $v into the $i-th row of the matrix $m The lenght of the vector must be of the same as the lenght of the row. The function returns 0 if it succeded, 1 otherwise.
 612
 613 =item C<gsl_matrix_set_col($m, $j, $v)> - Copy the elements of vector $v into the $j-th row of the matrix $m The lenght of the vector must be of the same as the lenght of the column. The function returns 0 if it succeded, 1 otherwise.
 614
 615 =back
 616
 617 The following functions are specific to matrices containing complex numbers :
 618
 619 =over 1
 620
 621 =item C<gsl_matrix_complex_alloc >
 622
 623 =item C<gsl_matrix_complex_calloc >
 624
 625 =item C<gsl_matrix_complex_alloc_from_block >
 626
 627 =item C<gsl_matrix_complex_alloc_from_matrix >
 628
 629 =item C<gsl_vector_complex_alloc_row_from_matrix >
 630
 631 =item C<gsl_vector_complex_alloc_col_from_matrix >
 632
 633 =item C<gsl_matrix_complex_free >
 634
 635 =item C<gsl_matrix_complex_submatrix >
 636
 637 =item C<gsl_matrix_complex_row >
 638
 639 =item C<gsl_matrix_complex_column >
 640
 641 =item C<gsl_matrix_complex_diagonal >
 642
 643 =item C<gsl_matrix_complex_subdiagonal >
 644
 645 =item C<gsl_matrix_complex_superdiagonal >
 646
 647 =item C<gsl_matrix_complex_subrow >
 648
 649 =item C<gsl_matrix_complex_subcolumn >
 650
 651 =item C<gsl_matrix_complex_view_array >
 652
 653 =item C<gsl_matrix_complex_view_array_with_tda >
 654
 655 =item C<gsl_matrix_complex_view_vector >
 656
 657 =item C<gsl_matrix_complex_view_vector_with_tda >
 658
 659 =item C<gsl_matrix_complex_const_submatrix >
 660
 661 =item C<gsl_matrix_complex_const_row >
 662
 663 =item C<gsl_matrix_complex_const_column >
 664
 665 =item C<gsl_matrix_complex_const_diagonal >
 666
 667 =item C<gsl_matrix_complex_const_subdiagonal >
 668
 669 =item C<gsl_matrix_complex_const_superdiagonal >
 670
 671 =item C<gsl_matrix_complex_const_subrow >
 672
 673 =item C<gsl_matrix_complex_const_subcolumn >
 674
 675 =item C<gsl_matrix_complex_const_view_array >
 676
 677 =item C<gsl_matrix_complex_const_view_array_with_tda >
 678
 679 =item C<gsl_matrix_complex_const_view_vector >
 680
 681 =item C<gsl_matrix_complex_const_view_vector_with_tda >
 682
 683 =item C<gsl_matrix_complex_get>
 684
 685 =item C<gsl_matrix_complex_set>
 686
 687 =item C<gsl_matrix_complex_ptr>
 688
 689 =item C<gsl_matrix_complex_const_ptr>
 690
 691 =item C<gsl_matrix_complex_set_zero >
 692
 693 =item C<gsl_matrix_complex_set_identity >
 694
 695 =item C<gsl_matrix_complex_set_all >
 696
 697 =item C<gsl_matrix_complex_fread >
 698
 699 =item C<gsl_matrix_complex_fwrite >
 700
 701 =item C<gsl_matrix_complex_fscanf >
 702
 703 =item C<gsl_matrix_complex_fprintf >
 704
 705 =item C<gsl_matrix_complex_memcpy>
 706
 707 =item C<gsl_matrix_complex_swap>
 708
 709 =item C<gsl_matrix_complex_swap_rows>
 710
 711 =item C<gsl_matrix_complex_swap_columns>
 712
 713 =item C<gsl_matrix_complex_swap_rowcol>
 714
 715 =item C<gsl_matrix_complex_transpose >
 716
 717 =item C<gsl_matrix_complex_transpose_memcpy >
 718
 719 =item C<gsl_matrix_complex_isnull >
 720
 721 =item C<gsl_matrix_complex_ispos >
 722
 723 =item C<gsl_matrix_complex_isneg >
 724
 725 =item C<gsl_matrix_complex_add >
 726
 727 =item C<gsl_matrix_complex_sub >
 728
 729 =item C<gsl_matrix_complex_mul_elements >
 730
 731 =item C<gsl_matrix_complex_div_elements >
 732
 733 =item C<gsl_matrix_complex_scale >
 734
 735 =item C<gsl_matrix_complex_add_constant >
 736
 737 =item C<gsl_matrix_complex_add_diagonal >
 738
 739 =item C<gsl_matrix_complex_get_row>
 740
 741 =item C<gsl_matrix_complex_get_col>
 742
 743 =item C<gsl_matrix_complex_set_row>
 744
 745 =item C<gsl_matrix_complex_set_col>
 746
 747 =back
 748
 749
 750 The following functions are the same as the previous enonced ones except that they work with other data types than double.
 751
 752 =over 1
 753
 754 =item gsl_matrix_const_row gsl_matrix_const_column gsl_matrix_const_diagonal
 755
 756 =item gsl_matrix_const_subdiagonal gsl_matrix_const_superdiagonal
 757
 758 =item gsl_matrix_const_subrow gsl_matrix_const_subcolumn
 759
 760 =item gsl_matrix_const_view_array gsl_matrix_const_view_array_with_tda
 761
 762 =item gsl_matrix_const_view_vector gsl_matrix_const_view_vector_with_tda gsl_matrix_char_alloc gsl_matrix_char_calloc  gsl_matrix_char_alloc_from_block
 763
 764 =item gsl_matrix_char_alloc_from_matrix gsl_vector_char_alloc_row_from_matrix gsl_vector_char_alloc_col_from_matrix
 765
 766 =item gsl_matrix_char_free gsl_matrix_char_submatrix gsl_matrix_char_row  gsl_matrix_char_column
 767
 768 =item gsl_matrix_char_diagonal gsl_matrix_char_subdiagonal gsl_matrix_char_superdiagonal
 769
 770 =item gsl_matrix_char_subrow gsl_matrix_char_subcolumn gsl_matrix_char_view_array
 771
 772 =item gsl_matrix_char_view_array_with_tda gsl_matrix_char_view_vector gsl_matrix_char_view_vector_with_tda
 773
 774 =item gsl_matrix_char_const_submatrix gsl_matrix_char_const_row gsl_matrix_char_const_column
 775
 776 =item gsl_matrix_char_const_diagonal gsl_matrix_char_const_subdiagonal gsl_matrix_char_const_superdiagonal
 777
 778 =item gsl_matrix_char_const_subrow gsl_matrix_char_const_subcolumn gsl_matrix_char_const_view_array
 779
 780 =item gsl_matrix_char_const_view_array_with_tda gsl_matrix_char_const_view_vector gsl_matrix_char_const_view_vector_with_tda
 781
 782 =item gsl_matrix_char_get gsl_matrix_char_set gsl_matrix_char_ptr gsl_matrix_char_const_ptr
 783
 784 =item gsl_matrix_char_set_zero gsl_matrix_char_set_identity
 785
 786 =item gsl_matrix_char_set_all  gsl_matrix_char_fread
 787
 788 =item gsl_matrix_char_fwrite gsl_matrix_char_fscanf gsl_matrix_char_fprintf
 789
 790 =item gsl_matrix_char_memcpy gsl_matrix_char_swap
 791
 792 =item gsl_matrix_char_swap_rows gsl_matrix_char_swap_columns
 793
 794 =item gsl_matrix_char_swap_rowcol gsl_matrix_char_transpose gsl_matrix_char_transpose_memcpy
 795
 796 =item gsl_matrix_char_max gsl_matrix_char_min
 797
 798 =item gsl_matrix_char_minmax  gsl_matrix_char_max_index
 799
 800 =item gsl_matrix_char_min_index gsl_matrix_char_minmax_index
 801
 802 =item gsl_matrix_char_isnull gsl_matrix_char_ispos gsl_matrix_char_isneg
 803
 804 =item gsl_matrix_char_isnonneg  gsl_matrix_char_add
 805
 806 =item gsl_matrix_char_sub gsl_matrix_char_mul_elements gsl_matrix_char_div_elements
 807
 808 =item gsl_matrix_char_scale gsl_matrix_char_add_constant gsl_matrix_char_add_diagonal
 809
 810 =item gsl_matrix_int_alloc gsl_matrix_int_calloc gsl_matrix_int_alloc_from_block
 811
 812 =item gsl_matrix_int_alloc_from_matrix gsl_vector_int_alloc_row_from_matrix gsl_vector_int_alloc_col_from_matrix
 813
 814 =item gsl_matrix_int_free gsl_matrix_int_submatrix gsl_matrix_int_row
 815
 816 =item gsl_matrix_int_column gsl_matrix_int_diagonal gsl_matrix_int_subdiagonal gsl_matrix_int_superdiagonal gsl_matrix_int_subrow gsl_matrix_int_subcolumn gsl_matrix_int_view_array gsl_matrix_int_view_array_with_tda gsl_matrix_int_view_vector gsl_matrix_int_view_vector_with_tda
 817
 818 =item gsl_matrix_int_const_submatrix gsl_matrix_int_const_row gsl_matrix_int_const_column
 819
 820
 821 =item gsl_matrix_int_const_diagonal gsl_matrix_int_const_subdiagonal gsl_matrix_int_const_superdiagonal
 822
 823 =item gsl_matrix_int_const_subrow gsl_matrix_int_const_subcolumn gsl_matrix_int_const_view_array
 824
 825 =item gsl_matrix_int_const_view_array_with_tda gsl_matrix_int_const_view_vector gsl_matrix_int_const_view_vector_with_tda
 826
 827 =item gsl_matrix_int_get gsl_matrix_int_set
 828
 829 =item gsl_matrix_int_ptr gsl_matrix_int_const_ptr
 830
 831 =item gsl_matrix_int_set_zero gsl_matrix_int_set_identity gsl_matrix_int_set_all
 832
 833 =item gsl_matrix_int_fread gsl_matrix_int_fwrite
 834
 835 =item gsl_matrix_int_fscanf gsl_matrix_int_fprintf
 836
 837 =item gsl_matrix_int_memcpy gsl_matrix_int_swap
 838
 839 =item gsl_matrix_int_swap_rows gsl_matrix_int_swap_columns gsl_matrix_int_swap_rowcol
 840
 841 =item gsl_matrix_int_transpose gsl_matrix_int_transpose_memcpy
 842
 843 =item gsl_matrix_int_max gsl_matrix_int_min gsl_matrix_int_minmax
 844
 845 =item gsl_matrix_int_max_index gsl_matrix_int_min_index
 846
 847 =item gsl_matrix_int_minmax_index  gsl_matrix_int_isnull
 848
 849 =item gsl_matrix_int_ispos gsl_matrix_int_isneg gsl_matrix_int_isnonneg
 850
 851 =item gsl_matrix_int_add gsl_matrix_int_sub
 852
 853 =item gsl_matrix_int_mul_elements gsl_matrix_int_div_elements gsl_matrix_int_scale
 854
 855 =item gsl_matrix_int_add_constant gsl_matrix_int_add_diagonal
 856
 857 =back
 858
 859 You have to add the functions you want to use inside the qw /put_funtion_here /.
 860 You can also write use Math::GSL::Matrix qw/:all/ to use all avaible functions of the module.
 861 Other tags are also avaible, here is a complete list of all tags for this module :
 862
 863 =over 1
 864
 865 =item C<all>
 866
 867 =item C<int>
 868
 869 =item C<double>
 870
 871 =item C<char>
 872
 873 =item C<complex>
 874
 875 =back
 876
 877 For more informations on the functions, we refer you to the GSL offcial documentation: http://www.gnu.org/software/gsl/manual/html_node/
 878 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/name_of_the_function_you_want
 879
 880 =head1 EXAMPLES
 881
 882  Most of the examples from this section are perl versions of the examples there : http://www.gnu.org/software/gsl/manual/html_node/Example-programs-for-matrices.html
 883
 884  The program below shows how to allocate, initialize and read from a matrix using the functions gsl_matrix_alloc, gsl_matrix_set and gsl_matrix_get.
 885
 886  use Math::GSL::Matrix qw/:all/;
 887  $m = gsl_matrix_alloc (10,3);
 888  for($i = 0; $i< 10; $i++){
 889     for($j = 0; $j<3; $j++){
 890         gsl_matrix_set($m, $i, $j, 0.23 + 100*$i + $j);
 891     }
 892  }
 893
 894  for($i = 0; $i< 100; $i++){ # OUT OF RANGE ERROR
 895      for($j=0; $j<3; $j++){
 896         print "m($i, $j) = " . gsl_matrix_get ($m, $i, $j) . "\n";
 897     }
 898  }
 899  gsl_matrix_free ($m);
 900
 901
 902  use Math::GSL::Matrix qw/:all/;
 903
 904  $m = gsl_matrix_alloc (100, 100);
 905  $a = gsl_matrix_alloc (100, 100);
 906
 907  for($i = 0; $i < 100; $i++){
 908      for($j = 0; $j < 100; $j++){
 909          gsl_matrix_set ($m, $i, $j, 0.23 + $i + $j);
 910      }
 911  }
 912
 913  The next program shows how to write a matrix to a file.
 914
 915  $out = fopen("test.dat", "wb");
 916  gsl_matrix_fwrite ($out, $m);
 917  fclose ($out);
 918
 919  $in = fopen("test.dat", "rb");
 920  gsl_matrix_fread ($in, $a);
 921  fclose($in);
 922
 923  $k=0;
 924  for($i = 0; $i < 100; $i++){
 925      for($j = 0; $j < 100; $j++){
 926          $mij = gsl_matrix_get ($m, $i, $j);
 927          $aij = gsl_matrix_get ($a, $i, $j);
 928          if ($mij != $aij){ $k++ };
 929      }
 930  }
 931
 932  gsl_matrix_free($m);
 933  gsl_matrix_free($a);
 934
 935  print "differences = $k (should be zero)\n";
 936
 937 =head1 AUTHOR
 938
 939 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 940
 941 =head1 COPYRIGHT AND LICENSE
 942
 943 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 944
 945 This program is free software; you can redistribute it and/or modify it
 946 under the same terms as Perl itself.
 947
 948 =cut
 949
 950 %}