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 $line;
 443     my @part;
 444     my @total;
 445     for($line=0; $line<$self->rows; $line++){
 446        @part = map {
 447          gsl_matrix_get($self->raw, $line, $_)
 448        } (0 .. $self->cols-1 );
 449        push(@total, @part);
 450     }
 451     return @total;
 452 }
 453
 454 sub row
 455 {
 456     my ($self, $row) = @_;
 457     croak (__PACKAGE__.'::$matrix->row($row) - invalid $row value')
 458         unless (($row < $self->rows) and $row >= 0);
 459
 460     my $rowvec = Math::GSL::Vector->new($self->cols);
 461     my $rowmat = Math::GSL::Matrix->new(1,$self->cols);
 462
 463     my $status = gsl_matrix_get_row($rowvec->raw, $self->raw, $row);
 464     croak (__PACKAGE__.'::gsl_matrix_get_row - ' . gsl_strerror($status) )
 465         unless ( $status == $GSL_SUCCESS );
 466
 467     $status = gsl_matrix_set_row($rowmat->raw, 0, $rowvec->raw);
 468
 469     croak (__PACKAGE__.'::gsl_matrix_set_row - ' . gsl_strerror($status) )
 470         unless ( $status == $GSL_SUCCESS );
 471
 472     return $rowmat;
 473 }
 474
 475 sub col
 476 {
 477     my ($self, $col) = @_;
 478     croak (__PACKAGE__."::\$matrix->col(\$col) - $col not a valid column")
 479         unless ($col < $self->cols and $col >= 0);
 480
 481     my $colvec = Math::GSL::Vector->new($self->cols);
 482     my $colmat = Math::GSL::Matrix->new($self->rows, 1);
 483
 484     my $status = gsl_matrix_get_col($colvec->raw, $self->raw, $col);
 485 # return $colvec;
 486     $status    = gsl_matrix_set_col($colmat->raw, 0, $colvec->raw);
 487     return $colmat;
 488 }
 489
 490 =head1 DESCRIPTION
 491
 492 Here is a list of all the functions included in this module :
 493
 494 =over 1
 495
 496 =item C<gsl_matrix_alloc($i, $j)> - Return a gsl_matrix of $i rows and $j columns
 497
 498 =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
 499
 500 =item C<gsl_matrix_alloc_from_block> -
 501
 502 =item C<gsl_matrix_free> -
 503
 504 =item C<gsl_matrix_alloc_from_matrix > -
 505
 506 =item C<gsl_vector_alloc_row_from_matrix> -
 507
 508 =item C<gsl_vector_alloc_col_from_matrix > -
 509
 510 =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.
 511
 512 =item C<gsl_matrix_row($m , $i)> - Return a vector view of the $i-th row of the matrix $m
 513
 514 =item C<gsl_matrix_column($m, $j)> - Return a vector view of the $j-th column of the matrix $m
 515
 516 =item C<gsl_matrix_diagonal($m)> - Return a vector view of the diagonal of the vector. The matrix doesn't have to be square.
 517
 518 =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.
 519
 520 =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.
 521
 522 =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.
 523
 524 =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.
 525
 526 =item C<gsl_matrix_view_array> -
 527
 528 =item C<gsl_matrix_view_array_with_tda > -
 529
 530 =item C<gsl_matrix_view_vector> -
 531
 532 =item C<gsl_matrix_view_vector_with_tda> -
 533
 534 =item C<gsl_matrix_const_submatrix> -
 535
 536 =item C<gsl_matrix_get($m, $i, $j)> - Return the (i,j)-th element of the matrix $m
 537
 538 =item C<gsl_matrix_set($m, $i, $j, $x)> - Set the value of the (i,j)-th element of the matrix $m to $x
 539
 540 =item C<gsl_matrix_ptr> -
 541
 542 =item C<gsl_matrix_const_ptr> -
 543
 544 =item C<gsl_matrix_set_zero($m)> - Set all the elements of the matrix $m to zero
 545
 546 =item C<gsl_matrix_set_identity($m)> - Set the elements of the matrix $m to the corresponding elements of the identity matrix
 547
 548 =item C<gsl_matrix_set_all($m, $x)> - Set all the elements of the matrix $m to the value $x
 549
 550 =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
 551
 552 =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
 553
 554 =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
 555
 556 =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
 557
 558 =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.
 559
 560 =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.
 561
 562 =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.
 563
 564 =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.
 565
 566 =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.
 567
 568 =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.
 569
 570 =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.
 571
 572 =item C<gsl_matrix_max($m)> - Return the maximum value in the matrix $m
 573
 574 =item C<gsl_matrix_min($m)> - Return the minimum value in the matrix $m
 575
 576 =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.
 577
 578 =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.
 579
 580 =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.
 581
 582 =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
 583
 584 =item C<gsl_matrix_isnull($m)> - Return 1 if all the elements of the matrix $m are zero, 0 otherwise
 585
 586 =item C<gsl_matrix_ispos($m)> - Return 1 if all the elements of the matrix $m are strictly positve, 0 otherwise
 587
 588 =item C<gsl_matrix_isneg($m)> - Return 1 if all the elements of the matrix $m are strictly negative, 0 otherwise
 589
 590 =item C<gsl_matrix_isnonneg($m)> - Return 1 if all the elements of the matrix $m are non-negatuive, 0 otherwise
 591
 592 =item C<gsl_matrix_add($a, $b)> - Add the elements of matrix $b to the elements of matrix $a
 593
 594 =item C<gsl_matrix_sub($a, $b)> - Subtract the elements of matrix $b from the elements of matrix $a
 595
 596 =item C<gsl_matrix_mul_elements($a, $b)> - Multiplie the elements of matrix $a by the elements of matrix $b
 597
 598 =item C<gsl_matrix_div_elements($a, $b)> - Divide the elements of matrix $a by the elements of matrix $b
 599
 600 =item C<gsl_matrix_scale($a, $x)> - Multiplie the elements of matrix $a by the constant factor $x
 601
 602 =item C<gsl_matrix_add_constant($a, $x)> - Add the constant value $x to the elements of the matrix $a
 603
 604 =item C<gsl_matrix_add_diagonal($a, $x)> - Add the constant value $x to the elements of the diagonal of the matrix $a
 605
 606 =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.
 607
 608 =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.
 609
 610 =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.
 611
 612 =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.
 613
 614 =back
 615
 616 The following functions are specific to matrices containing complex numbers :
 617
 618 =over 1
 619
 620 =item C<gsl_matrix_complex_alloc >
 621
 622 =item C<gsl_matrix_complex_calloc >
 623
 624 =item C<gsl_matrix_complex_alloc_from_block >
 625
 626 =item C<gsl_matrix_complex_alloc_from_matrix >
 627
 628 =item C<gsl_vector_complex_alloc_row_from_matrix >
 629
 630 =item C<gsl_vector_complex_alloc_col_from_matrix >
 631
 632 =item C<gsl_matrix_complex_free >
 633
 634 =item C<gsl_matrix_complex_submatrix >
 635
 636 =item C<gsl_matrix_complex_row >
 637
 638 =item C<gsl_matrix_complex_column >
 639
 640 =item C<gsl_matrix_complex_diagonal >
 641
 642 =item C<gsl_matrix_complex_subdiagonal >
 643
 644 =item C<gsl_matrix_complex_superdiagonal >
 645
 646 =item C<gsl_matrix_complex_subrow >
 647
 648 =item C<gsl_matrix_complex_subcolumn >
 649
 650 =item C<gsl_matrix_complex_view_array >
 651
 652 =item C<gsl_matrix_complex_view_array_with_tda >
 653
 654 =item C<gsl_matrix_complex_view_vector >
 655
 656 =item C<gsl_matrix_complex_view_vector_with_tda >
 657
 658 =item C<gsl_matrix_complex_const_submatrix >
 659
 660 =item C<gsl_matrix_complex_const_row >
 661
 662 =item C<gsl_matrix_complex_const_column >
 663
 664 =item C<gsl_matrix_complex_const_diagonal >
 665
 666 =item C<gsl_matrix_complex_const_subdiagonal >
 667
 668 =item C<gsl_matrix_complex_const_superdiagonal >
 669
 670 =item C<gsl_matrix_complex_const_subrow >
 671
 672 =item C<gsl_matrix_complex_const_subcolumn >
 673
 674 =item C<gsl_matrix_complex_const_view_array >
 675
 676 =item C<gsl_matrix_complex_const_view_array_with_tda >
 677
 678 =item C<gsl_matrix_complex_const_view_vector >
 679
 680 =item C<gsl_matrix_complex_const_view_vector_with_tda >
 681
 682 =item C<gsl_matrix_complex_get>
 683
 684 =item C<gsl_matrix_complex_set>
 685
 686 =item C<gsl_matrix_complex_ptr>
 687
 688 =item C<gsl_matrix_complex_const_ptr>
 689
 690 =item C<gsl_matrix_complex_set_zero >
 691
 692 =item C<gsl_matrix_complex_set_identity >
 693
 694 =item C<gsl_matrix_complex_set_all >
 695
 696 =item C<gsl_matrix_complex_fread >
 697
 698 =item C<gsl_matrix_complex_fwrite >
 699
 700 =item C<gsl_matrix_complex_fscanf >
 701
 702 =item C<gsl_matrix_complex_fprintf >
 703
 704 =item C<gsl_matrix_complex_memcpy>
 705
 706 =item C<gsl_matrix_complex_swap>
 707
 708 =item C<gsl_matrix_complex_swap_rows>
 709
 710 =item C<gsl_matrix_complex_swap_columns>
 711
 712 =item C<gsl_matrix_complex_swap_rowcol>
 713
 714 =item C<gsl_matrix_complex_transpose >
 715
 716 =item C<gsl_matrix_complex_transpose_memcpy >
 717
 718 =item C<gsl_matrix_complex_isnull >
 719
 720 =item C<gsl_matrix_complex_ispos >
 721
 722 =item C<gsl_matrix_complex_isneg >
 723
 724 =item C<gsl_matrix_complex_add >
 725
 726 =item C<gsl_matrix_complex_sub >
 727
 728 =item C<gsl_matrix_complex_mul_elements >
 729
 730 =item C<gsl_matrix_complex_div_elements >
 731
 732 =item C<gsl_matrix_complex_scale >
 733
 734 =item C<gsl_matrix_complex_add_constant >
 735
 736 =item C<gsl_matrix_complex_add_diagonal >
 737
 738 =item C<gsl_matrix_complex_get_row>
 739
 740 =item C<gsl_matrix_complex_get_col>
 741
 742 =item C<gsl_matrix_complex_set_row>
 743
 744 =item C<gsl_matrix_complex_set_col>
 745
 746 =back
 747
 748
 749 The following functions are the same as the previous enonced ones except that they work with other data types than double.
 750
 751 =over 1
 752
 753 =item gsl_matrix_const_row gsl_matrix_const_column gsl_matrix_const_diagonal
 754
 755 =item gsl_matrix_const_subdiagonal gsl_matrix_const_superdiagonal
 756
 757 =item gsl_matrix_const_subrow gsl_matrix_const_subcolumn
 758
 759 =item gsl_matrix_const_view_array gsl_matrix_const_view_array_with_tda
 760
 761 =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
 762
 763 =item gsl_matrix_char_alloc_from_matrix gsl_vector_char_alloc_row_from_matrix gsl_vector_char_alloc_col_from_matrix
 764
 765 =item gsl_matrix_char_free gsl_matrix_char_submatrix gsl_matrix_char_row  gsl_matrix_char_column
 766
 767 =item gsl_matrix_char_diagonal gsl_matrix_char_subdiagonal gsl_matrix_char_superdiagonal
 768
 769 =item gsl_matrix_char_subrow gsl_matrix_char_subcolumn gsl_matrix_char_view_array
 770
 771 =item gsl_matrix_char_view_array_with_tda gsl_matrix_char_view_vector gsl_matrix_char_view_vector_with_tda
 772
 773 =item gsl_matrix_char_const_submatrix gsl_matrix_char_const_row gsl_matrix_char_const_column
 774
 775 =item gsl_matrix_char_const_diagonal gsl_matrix_char_const_subdiagonal gsl_matrix_char_const_superdiagonal
 776
 777 =item gsl_matrix_char_const_subrow gsl_matrix_char_const_subcolumn gsl_matrix_char_const_view_array
 778
 779 =item gsl_matrix_char_const_view_array_with_tda gsl_matrix_char_const_view_vector gsl_matrix_char_const_view_vector_with_tda
 780
 781 =item gsl_matrix_char_get gsl_matrix_char_set gsl_matrix_char_ptr gsl_matrix_char_const_ptr
 782
 783 =item gsl_matrix_char_set_zero gsl_matrix_char_set_identity
 784
 785 =item gsl_matrix_char_set_all  gsl_matrix_char_fread
 786
 787 =item gsl_matrix_char_fwrite gsl_matrix_char_fscanf gsl_matrix_char_fprintf
 788
 789 =item gsl_matrix_char_memcpy gsl_matrix_char_swap
 790
 791 =item gsl_matrix_char_swap_rows gsl_matrix_char_swap_columns
 792
 793 =item gsl_matrix_char_swap_rowcol gsl_matrix_char_transpose gsl_matrix_char_transpose_memcpy
 794
 795 =item gsl_matrix_char_max gsl_matrix_char_min
 796
 797 =item gsl_matrix_char_minmax  gsl_matrix_char_max_index
 798
 799 =item gsl_matrix_char_min_index gsl_matrix_char_minmax_index
 800
 801 =item gsl_matrix_char_isnull gsl_matrix_char_ispos gsl_matrix_char_isneg
 802
 803 =item gsl_matrix_char_isnonneg  gsl_matrix_char_add
 804
 805 =item gsl_matrix_char_sub gsl_matrix_char_mul_elements gsl_matrix_char_div_elements
 806
 807 =item gsl_matrix_char_scale gsl_matrix_char_add_constant gsl_matrix_char_add_diagonal
 808
 809 =item gsl_matrix_int_alloc gsl_matrix_int_calloc gsl_matrix_int_alloc_from_block
 810
 811 =item gsl_matrix_int_alloc_from_matrix gsl_vector_int_alloc_row_from_matrix gsl_vector_int_alloc_col_from_matrix
 812
 813 =item gsl_matrix_int_free gsl_matrix_int_submatrix gsl_matrix_int_row
 814
 815 =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
 816
 817 =item gsl_matrix_int_const_submatrix gsl_matrix_int_const_row gsl_matrix_int_const_column
 818
 819
 820 =item gsl_matrix_int_const_diagonal gsl_matrix_int_const_subdiagonal gsl_matrix_int_const_superdiagonal
 821
 822 =item gsl_matrix_int_const_subrow gsl_matrix_int_const_subcolumn gsl_matrix_int_const_view_array
 823
 824 =item gsl_matrix_int_const_view_array_with_tda gsl_matrix_int_const_view_vector gsl_matrix_int_const_view_vector_with_tda
 825
 826 =item gsl_matrix_int_get gsl_matrix_int_set
 827
 828 =item gsl_matrix_int_ptr gsl_matrix_int_const_ptr
 829
 830 =item gsl_matrix_int_set_zero gsl_matrix_int_set_identity gsl_matrix_int_set_all
 831
 832 =item gsl_matrix_int_fread gsl_matrix_int_fwrite
 833
 834 =item gsl_matrix_int_fscanf gsl_matrix_int_fprintf
 835
 836 =item gsl_matrix_int_memcpy gsl_matrix_int_swap
 837
 838 =item gsl_matrix_int_swap_rows gsl_matrix_int_swap_columns gsl_matrix_int_swap_rowcol
 839
 840 =item gsl_matrix_int_transpose gsl_matrix_int_transpose_memcpy
 841
 842 =item gsl_matrix_int_max gsl_matrix_int_min gsl_matrix_int_minmax
 843
 844 =item gsl_matrix_int_max_index gsl_matrix_int_min_index
 845
 846 =item gsl_matrix_int_minmax_index  gsl_matrix_int_isnull
 847
 848 =item gsl_matrix_int_ispos gsl_matrix_int_isneg gsl_matrix_int_isnonneg
 849
 850 =item gsl_matrix_int_add gsl_matrix_int_sub
 851
 852 =item gsl_matrix_int_mul_elements gsl_matrix_int_div_elements gsl_matrix_int_scale
 853
 854 =item gsl_matrix_int_add_constant gsl_matrix_int_add_diagonal
 855
 856 =back
 857
 858 You have to add the functions you want to use inside the qw /put_funtion_here /.
 859 You can also write use Math::GSL::Matrix qw/:all/ to use all avaible functions of the module.
 860 Other tags are also avaible, here is a complete list of all tags for this module :
 861
 862 =over 1
 863
 864 =item C<all>
 865
 866 =item C<int>
 867
 868 =item C<double>
 869
 870 =item C<char>
 871
 872 =item C<complex>
 873
 874 =back
 875
 876 For more informations on the functions, we refer you to the GSL offcial documentation: http://www.gnu.org/software/gsl/manual/html_node/
 877 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/name_of_the_function_you_want
 878
 879 =head1 EXAMPLES
 880
 881  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
 882
 883  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.
 884
 885  use Math::GSL::Matrix qw/:all/;
 886  $m = gsl_matrix_alloc (10,3);
 887  for($i = 0; $i< 10; $i++){
 888     for($j = 0; $j<3; $j++){
 889         gsl_matrix_set($m, $i, $j, 0.23 + 100*$i + $j);
 890     }
 891  }
 892
 893  for($i = 0; $i< 100; $i++){ # OUT OF RANGE ERROR
 894      for($j=0; $j<3; $j++){
 895         print "m($i, $j) = " . gsl_matrix_get ($m, $i, $j) . "\n";
 896     }
 897  }
 898  gsl_matrix_free ($m);
 899
 900
 901  use Math::GSL::Matrix qw/:all/;
 902
 903  $m = gsl_matrix_alloc (100, 100);
 904  $a = gsl_matrix_alloc (100, 100);
 905
 906  for($i = 0; $i < 100; $i++){
 907      for($j = 0; $j < 100; $j++){
 908          gsl_matrix_set ($m, $i, $j, 0.23 + $i + $j);
 909      }
 910  }
 911
 912  The next program shows how to write a matrix to a file.
 913
 914  $out = fopen("test.dat", "wb");
 915  gsl_matrix_fwrite ($out, $m);
 916  fclose ($out);
 917
 918  $in = fopen("test.dat", "rb");
 919  gsl_matrix_fread ($in, $a);
 920  fclose($in);
 921
 922  $k=0;
 923  for($i = 0; $i < 100; $i++){
 924      for($j = 0; $j < 100; $j++){
 925          $mij = gsl_matrix_get ($m, $i, $j);
 926          $aij = gsl_matrix_get ($a, $i, $j);
 927          if ($mij != $aij){ $k++ };
 928      }
 929  }
 930
 931  gsl_matrix_free($m);
 932  gsl_matrix_free($a);
 933
 934  print "differences = $k (should be zero)\n";
 935
 936 =head1 AUTHOR
 937
 938 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 939
 940 =head1 COPYRIGHT AND LICENSE
 941
 942 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 943
 944 This program is free software; you can redistribute it and/or modify it
 945 under the same terms as Perl itself.
 946
 947 =cut
 948
 949 %}