pod/Matrix.pod

   1 %perlcode %{
   2
   3 use strict;
   4 use warnings;
   5 use Carp qw/croak/;
   6 use Scalar::Util 'blessed';
   7
   8 use Math::GSL qw/:all/;
   9 use Math::GSL::Errno    qw/:all/;
  10 use Math::GSL::Eigen    qw/:all/;
  11 use Math::GSL::Vector   qw/:all/;
  12 use Math::GSL::Complex  qw/:all/;
  13 use Math::GSL::Test  qw/is_similar/;
  14 use Math::GSL::BLAS  qw/gsl_blas_dgemm/;
  15 use Math::GSL::CBLAS qw/$CblasNoTrans/;
  16 use Math::GSL::Permutation;
  17 use Math::GSL::Linalg qw/
  18     gsl_linalg_LU_decomp
  19     gsl_linalg_LU_det
  20     gsl_linalg_LU_lndet
  21     gsl_linalg_LU_invert
  22 /;
  23
  24 # should only include needed methods
  25 use Math::GSL::MatrixComplex qw/:all/;
  26 use Math::GSL::VectorComplex qw/:all/;
  27 use Data::Dumper;
  28
  29 use overload
  30     '*'      => \&_multiplication,
  31     '+'      => \&_addition,
  32     '-'      => \&_subtract,
  33     '=='     => \&_equal,
  34     '!='     => \&_not_equal,
  35     fallback => 1;
  36
  37 our @EXPORT_OK = qw/
  38         gsl_matrix_alloc gsl_matrix_calloc gsl_matrix_alloc_from_block
  39         gsl_matrix_alloc_from_matrix gsl_vector_alloc_row_from_matrix
  40         gsl_vector_alloc_col_from_matrix gsl_matrix_free gsl_matrix_submatrix
  41         gsl_matrix_row gsl_matrix_column gsl_matrix_diagonal
  42         gsl_matrix_subdiagonal gsl_matrix_superdiagonal gsl_matrix_subrow
  43         gsl_matrix_subcolumn gsl_matrix_view_array
  44         gsl_matrix_view_array_with_tda gsl_matrix_view_vector
  45         gsl_matrix_view_vector_with_tda gsl_matrix_const_submatrix
  46         gsl_matrix_const_row gsl_matrix_const_column gsl_matrix_const_diagonal
  47         gsl_matrix_const_subdiagonal gsl_matrix_const_superdiagonal
  48         gsl_matrix_const_subrow gsl_matrix_const_subcolumn
  49         gsl_matrix_const_view_array gsl_matrix_const_view_array_with_tda
  50         gsl_matrix_const_view_vector gsl_matrix_const_view_vector_with_tda
  51         gsl_matrix_get gsl_matrix_set gsl_matrix_ptr gsl_matrix_const_ptr
  52         gsl_matrix_set_zero gsl_matrix_set_identity gsl_matrix_set_all
  53         gsl_matrix_fread gsl_matrix_fwrite gsl_matrix_fscanf gsl_matrix_fprintf
  54         gsl_matrix_memcpy gsl_matrix_swap gsl_matrix_swap_rows
  55         gsl_matrix_swap_columns gsl_matrix_swap_rowcol gsl_matrix_transpose
  56         gsl_matrix_transpose_memcpy gsl_matrix_max gsl_matrix_min
  57         gsl_matrix_minmax gsl_matrix_max_index gsl_matrix_min_index
  58         gsl_matrix_minmax_index gsl_matrix_isnull gsl_matrix_ispos
  59         gsl_matrix_isneg gsl_matrix_isnonneg gsl_matrix_add gsl_matrix_sub
  60         gsl_matrix_mul_elements gsl_matrix_div_elements gsl_matrix_scale
  61         gsl_matrix_add_constant gsl_matrix_add_diagonal
  62         gsl_matrix_char_alloc gsl_matrix_char_calloc  gsl_matrix_char_alloc_from_block
  63         gsl_matrix_char_alloc_from_matrix gsl_vector_char_alloc_row_from_matrix gsl_vector_char_alloc_col_from_matrix
  64         gsl_matrix_char_free gsl_matrix_char_submatrix
  65         gsl_matrix_char_row  gsl_matrix_char_column
  66         gsl_matrix_char_diagonal gsl_matrix_char_subdiagonal gsl_matrix_char_superdiagonal
  67         gsl_matrix_char_subrow gsl_matrix_char_subcolumn gsl_matrix_char_view_array
  68         gsl_matrix_char_view_array_with_tda gsl_matrix_char_view_vector gsl_matrix_char_view_vector_with_tda
  69         gsl_matrix_char_const_submatrix gsl_matrix_char_const_row gsl_matrix_char_const_column
  70         gsl_matrix_char_const_diagonal gsl_matrix_char_const_subdiagonal gsl_matrix_char_const_superdiagonal
  71         gsl_matrix_char_const_subrow gsl_matrix_char_const_subcolumn gsl_matrix_char_const_view_array
  72         gsl_matrix_char_const_view_array_with_tda gsl_matrix_char_const_view_vector gsl_matrix_char_const_view_vector_with_tda
  73         gsl_matrix_char_get gsl_matrix_char_set gsl_matrix_char_ptr gsl_matrix_char_const_ptr
  74         gsl_matrix_char_set_zero gsl_matrix_char_set_identity
  75         gsl_matrix_char_set_all  gsl_matrix_char_fread
  76         gsl_matrix_char_fwrite gsl_matrix_char_fscanf gsl_matrix_char_fprintf
  77         gsl_matrix_char_memcpy gsl_matrix_char_swap
  78         gsl_matrix_char_swap_rows gsl_matrix_char_swap_columns
  79         gsl_matrix_char_swap_rowcol gsl_matrix_char_transpose gsl_matrix_char_transpose_memcpy
  80         gsl_matrix_char_max gsl_matrix_char_min
  81         gsl_matrix_char_minmax  gsl_matrix_char_max_index
  82         gsl_matrix_char_min_index gsl_matrix_char_minmax_index
  83         gsl_matrix_char_isnull gsl_matrix_char_ispos gsl_matrix_char_isneg
  84         gsl_matrix_char_isnonneg  gsl_matrix_char_add
  85         gsl_matrix_char_sub gsl_matrix_char_mul_elements gsl_matrix_char_div_elements
  86         gsl_matrix_char_scale gsl_matrix_char_add_constant gsl_matrix_char_add_diagonal
  87         gsl_matrix_int_alloc gsl_matrix_int_calloc gsl_matrix_int_alloc_from_block
  88         gsl_matrix_int_alloc_from_matrix gsl_vector_int_alloc_row_from_matrix gsl_vector_int_alloc_col_from_matrix
  89         gsl_matrix_int_free gsl_matrix_int_submatrix gsl_matrix_int_row
  90         gsl_matrix_int_column gsl_matrix_int_diagonal gsl_matrix_int_subdiagonal
  91         gsl_matrix_int_superdiagonal gsl_matrix_int_subrow gsl_matrix_int_subcolumn gsl_matrix_int_view_array
  92         gsl_matrix_int_view_array_with_tda gsl_matrix_int_view_vector gsl_matrix_int_view_vector_with_tda
  93         gsl_matrix_int_const_submatrix gsl_matrix_int_const_row gsl_matrix_int_const_column
  94         gsl_matrix_int_const_diagonal gsl_matrix_int_const_subdiagonal gsl_matrix_int_const_superdiagonal
  95         gsl_matrix_int_const_subrow gsl_matrix_int_const_subcolumn gsl_matrix_int_const_view_array
  96         gsl_matrix_int_const_view_array_with_tda gsl_matrix_int_const_view_vector gsl_matrix_int_const_view_vector_with_tda
  97         gsl_matrix_int_get gsl_matrix_int_set
  98         gsl_matrix_int_ptr gsl_matrix_int_const_ptr
  99         gsl_matrix_int_set_zero gsl_matrix_int_set_identity gsl_matrix_int_set_all
 100         gsl_matrix_int_fread gsl_matrix_int_fwrite
 101         gsl_matrix_int_fscanf gsl_matrix_int_fprintf
 102         gsl_matrix_int_memcpy gsl_matrix_int_swap
 103         gsl_matrix_int_swap_rows gsl_matrix_int_swap_columns gsl_matrix_int_swap_rowcol
 104         gsl_matrix_int_transpose gsl_matrix_int_transpose_memcpy
 105         gsl_matrix_int_max gsl_matrix_int_min gsl_matrix_int_minmax
 106         gsl_matrix_int_max_index gsl_matrix_int_min_index
 107         gsl_matrix_int_minmax_index  gsl_matrix_int_isnull
 108         gsl_matrix_int_ispos gsl_matrix_int_isneg gsl_matrix_int_isnonneg
 109         gsl_matrix_int_add gsl_matrix_int_sub
 110         gsl_matrix_int_mul_elements gsl_matrix_int_div_elements gsl_matrix_int_scale
 111         gsl_matrix_int_add_constant gsl_matrix_int_add_diagonal
 112         gsl_matrix_get_row gsl_matrix_get_col gsl_matrix_set_row gsl_matrix_set_col
 113         /;
 114
 115 our %EXPORT_TAGS = ( all => [ @EXPORT_OK ],
 116                  char => [ qw/
 117                     gsl_matrix_char_alloc
 118                     gsl_matrix_char_calloc
 119                     gsl_matrix_char_alloc_from_block
 120                     gsl_matrix_char_alloc_from_matrix
 121                     gsl_vector_char_alloc_row_from_matrix
 122                     gsl_vector_char_alloc_col_from_matrix
 123                     gsl_matrix_char_free
 124                     gsl_matrix_char_submatrix
 125                     gsl_matrix_char_row
 126                     gsl_matrix_char_column
 127                     gsl_matrix_char_diagonal
 128                     gsl_matrix_char_subdiagonal
 129                     gsl_matrix_char_superdiagonal
 130                     gsl_matrix_char_subrow
 131                     gsl_matrix_char_subcolumn
 132                     gsl_matrix_char_view_array
 133                     gsl_matrix_char_view_array_with_tda
 134                     gsl_matrix_char_view_vector
 135                     gsl_matrix_char_view_vector_with_tda
 136                     gsl_matrix_char_const_submatrix
 137                     gsl_matrix_char_const_row
 138                     gsl_matrix_char_const_column
 139                     gsl_matrix_char_const_diagonal
 140                     gsl_matrix_char_const_subdiagonal
 141                     gsl_matrix_char_const_superdiagonal
 142                     gsl_matrix_char_const_subrow
 143                     gsl_matrix_char_const_subcolumn
 144                     gsl_matrix_char_const_view_array
 145                     gsl_matrix_char_const_view_array_with_tda
 146                     gsl_matrix_char_const_view_vector
 147                     gsl_matrix_char_const_view_vector_with_tda
 148                     gsl_matrix_char_get
 149                     gsl_matrix_char_set
 150                     gsl_matrix_char_ptr
 151                     gsl_matrix_char_const_ptr
 152                     gsl_matrix_char_set_zero
 153                     gsl_matrix_char_set_identity
 154                     gsl_matrix_char_set_all
 155                     gsl_matrix_char_fread
 156                     gsl_matrix_char_fwrite
 157                     gsl_matrix_char_fscanf
 158                     gsl_matrix_char_fprintf
 159                     gsl_matrix_char_memcpy
 160                     gsl_matrix_char_swap
 161                     gsl_matrix_char_swap_rows
 162                     gsl_matrix_char_swap_columns
 163                     gsl_matrix_char_swap_rowcol
 164                     gsl_matrix_char_transpose
 165                     gsl_matrix_char_transpose_memcpy
 166                     gsl_matrix_char_max
 167                     gsl_matrix_char_min
 168                     gsl_matrix_char_minmax
 169                     gsl_matrix_char_max_index
 170                     gsl_matrix_char_min_index
 171                     gsl_matrix_char_minmax_index
 172                     gsl_matrix_char_isnull
 173                     gsl_matrix_char_ispos
 174                     gsl_matrix_char_isneg
 175                     gsl_matrix_char_isnonneg
 176                     gsl_matrix_char_add
 177                     gsl_matrix_char_sub
 178                     gsl_matrix_char_mul_elements
 179                     gsl_matrix_char_div_elements
 180                     gsl_matrix_char_scale
 181                     gsl_matrix_char_add_constant
 182                     gsl_matrix_char_add_diagonal
 183                      /],
 184
 185                  double => [ qw/
 186                     gsl_matrix_alloc
 187                     gsl_matrix_calloc
 188                     gsl_matrix_alloc_from_block
 189                     gsl_matrix_alloc_from_matrix
 190                     gsl_vector_alloc_row_from_matrix
 191                     gsl_vector_alloc_col_from_matrix
 192                     gsl_matrix_free
 193                     gsl_matrix_submatrix
 194                     gsl_matrix_row
 195                     gsl_matrix_column
 196                     gsl_matrix_diagonal
 197                     gsl_matrix_subdiagonal
 198                     gsl_matrix_superdiagonal
 199                     gsl_matrix_subrow
 200                     gsl_matrix_subcolumn
 201                     gsl_matrix_view_array
 202                     gsl_matrix_view_array_with_tda
 203                     gsl_matrix_view_vector
 204                     gsl_matrix_view_vector_with_tda
 205                     gsl_matrix_const_submatrix
 206                     gsl_matrix_const_row
 207                     gsl_matrix_const_column
 208                     gsl_matrix_const_diagonal
 209                     gsl_matrix_const_subdiagonal
 210                     gsl_matrix_const_superdiagonal
 211                     gsl_matrix_const_subrow
 212                     gsl_matrix_const_subcolumn
 213                     gsl_matrix_const_view_array
 214                     gsl_matrix_const_view_array_with_tda
 215                     gsl_matrix_const_view_vector
 216                     gsl_matrix_const_view_vector_with_tda
 217                     gsl_matrix_get
 218                     gsl_matrix_set
 219                     gsl_matrix_ptr
 220                     gsl_matrix_const_ptr
 221                     gsl_matrix_set_zero
 222                     gsl_matrix_set_identity
 223                     gsl_matrix_set_all
 224                     gsl_matrix_fread
 225                     gsl_matrix_fwrite
 226                     gsl_matrix_fscanf
 227                     gsl_matrix_fprintf
 228                     gsl_matrix_memcpy
 229                     gsl_matrix_swap
 230                     gsl_matrix_swap_rows
 231                     gsl_matrix_swap_columns
 232                     gsl_matrix_swap_rowcol
 233                     gsl_matrix_transpose
 234                     gsl_matrix_transpose_memcpy
 235                     gsl_matrix_max
 236                     gsl_matrix_minmax
 237                     gsl_matrix_max_index
 238                     gsl_matrix_min_index
 239                     gsl_matrix_minmax_index
 240                     gsl_matrix_isnull
 241                     gsl_matrix_ispos
 242                     gsl_matrix_isneg
 243                     gsl_matrix_isnonneg
 244                     gsl_matrix_add
 245                     gsl_matrix_mul_elements
 246                     gsl_matrix_div_elements
 247                     gsl_matrix_scale
 248                     gsl_matrix_add_constant
 249                     gsl_matrix_add_diagonal
 250                     /],
 251 int => [ qw/
 252                  gsl_matrix_int_alloc
 253                  gsl_matrix_int_alloc_from_matrix
 254                  gsl_matrix_int_free
 255                  gsl_matrix_int_column
 256                  gsl_matrix_int_superdiagonal
 257                  gsl_matrix_int_view_array_with_tda
 258                  gsl_matrix_int_const_submatrix
 259                  gsl_matrix_int_const_diagonal
 260                  gsl_matrix_int_const_subrow
 261                  gsl_matrix_int_const_view_array_with_tda
 262                  gsl_matrix_int_get
 263                  gsl_matrix_int_ptr
 264                  gsl_matrix_int_set_zero
 265                  gsl_matrix_int_fread
 266                  gsl_matrix_int_fscanf
 267                  gsl_matrix_int_memcpy
 268                  gsl_matrix_int_swap_rows
 269                  gsl_matrix_int_transpose
 270                  gsl_matrix_int_max
 271                  gsl_matrix_int_max_index
 272                  gsl_matrix_int_minmax_index
 273                  gsl_matrix_int_ispos
 274                  gsl_matrix_int_add
 275                  gsl_matrix_int_mul_elements
 276                  gsl_matrix_int_add_constant
 277                  /],
 278 );
 279
 280
 281 =head1 NAME
 282
 283 Math::GSL::Matrix - Mathematical functions concerning Matrices
 284
 285 =head1 SYNOPSIS
 286
 287     use Math::GSL::Matrix qw/:all/;
 288     my $matrix1 = Math::GSL::Matrix->new(5,5);  # OO interface
 289     my $matrix2 = $matrix1 + 4;                 # You can add or substract values or matrices to OO matrices
 290     my $matrix3 = $matrix1 - 4;
 291     my $matrix4 = $matrix2 + $matrix1;
 292     my $matrix5 = $matrix2 . $matrix1;          # This is a scalar product, it simply multiply each element
 293                                                 # with the element of $matrix1 that have the same position
 294                                                 # See Math::GSL::BLAS if you want scalar product
 295
 296     my $matrix6 = $matrix2 . 8;                 # Multiply every elements of $matrix2 by 8
 297     my $matrix7 = $matrix2 * $matrix1;          # scalar product of two matrices
 298     if($matrix1 == $matrix4) ...
 299     if($matrix1 != $matrix3) ...
 300     my $matrix8 = gsl_matrix_alloc(5,5);        # standard interface
 301
 302
 303 =head1 Objected Oriented Interface to GSL Math::GSL::Matrix
 304
 305 =head2 Math::GSL::Matrix->new()
 306
 307 Creates a new Matrix of the given size.
 308
 309     my $matrix = Math::GSL::Matrix->new(10,10);
 310 =cut
 311
 312 sub new
 313 {
 314     my ($class, $rows, $cols) = @_;
 315     my $this = {};
 316     my $matrix;
 317     if ( defined $rows       && defined $cols &&
 318         $rows > 0            && $cols > 0     &&
 319         (int $rows == $rows) && (int $cols == $cols)){
 320
 321         $matrix  = gsl_matrix_alloc($rows,$cols);
 322     } else {
 323         croak( __PACKAGE__.'::new($x,$y) - $x and $y must be positive integers');
 324     }
 325     gsl_matrix_set_zero($matrix);
 326     $this->{_matrix} = $matrix;
 327     ($this->{_rows}, $this->{_cols}) = ($rows,$cols);
 328     bless $this, $class;
 329 }
 330 =head2 raw()
 331
 332 Get the underlying GSL matrix object created by SWIG, useful for using gsl_matrix_* functions which do not have an OO counterpart.
 333
 334     my $matrix     = Math::GSL::Matrix->new(3,3);
 335     my $gsl_matrix = $matrix->raw;
 336     my $stuff      = gsl_matrix_get($gsl_matrix, 1, 2);
 337
 338 =cut
 339 sub raw  { (shift)->{_matrix} }
 340
 341 =head2 identity()
 342
 343 Set a matrix to the identity matrix, i.e. one on the diagonal and zero elsewhere.
 344
 345     my $I = $matrix->identity;
 346
 347 =cut
 348
 349 sub identity
 350 {
 351     my $self=shift;
 352     gsl_matrix_set_identity($self->raw);
 353     return $self;
 354 }
 355
 356 =head2 zero()
 357
 358 Set a matrix to the zero matrix.
 359
 360     $matrix->zero;
 361
 362 =cut
 363
 364 sub zero # brrr!
 365 {
 366     my $self=shift;
 367     gsl_matrix_set_zero($self->raw);
 368     return $self;
 369 }
 370
 371 =head2 copy()
 372
 373 Returns a copy of the matrix, which has the same size and values but resides at a different location in memory.
 374
 375     my $matrix = Math::GSL::Matrix->new(5,5);
 376     my $copy   = $matrix->copy;
 377
 378 =cut
 379
 380 sub copy {
 381     my $self = shift;
 382     my $copy = Math::GSL::Matrix->new( $self->rows, $self->cols );
 383     if ( gsl_matrix_memcpy($copy->raw, $self->raw) != $GSL_SUCCESS ) {
 384         croak "Math::GSL - error copying memory, aborting";
 385     }
 386     return $copy;
 387 }
 388
 389
 390 =head2 rows()
 391
 392 Returns the number of rows in the matrix.
 393
 394     my $rows = $matrix->rows;
 395 =cut
 396
 397 sub rows { (shift)->{_rows}   }
 398
 399 =head2 cols()
 400
 401 Returns the number of columns in the matrix.
 402
 403     my $cols = $matrix->cols;
 404 =cut
 405
 406 sub cols { (shift)->{_cols}   }
 407
 408 =head2  as_list()
 409
 410 Get the contents of a Math::GSL::Matrix object as a Perl list.
 411
 412     my $matrix = Math::GSL::Matrix->new(3,3);
 413     ...
 414     my @matrix = $matrix->as_list;
 415 =cut
 416
 417
 418 =head2 is_square()
 419
 420 Returns true if a matrix is square, i.e. it has the same number of rows as columns, false otherwise.
 421
 422 =cut
 423
 424 sub is_square($)
 425 {
 426     my $self = shift;
 427     return ($self->rows == $self->cols) ? 1 : 0 ;
 428 }
 429
 430 =head2 det()
 431
 432 Returns the determinant of a matrix (computed by LU decomposition) or dies if called on a non-square matrix.
 433
 434     my $det = $matrix->det();
 435
 436 =cut
 437
 438 sub det($)
 439 {
 440     my $self = shift;
 441     croak(__PACKAGE__."- determinant only exists for square matrices") unless $self->is_square;
 442
 443     my $p  = Math::GSL::Permutation->new( $self->rows );
 444     my $LU = $self->copy;
 445
 446     my ($result, $s) = gsl_linalg_LU_decomp($LU->raw, $p->raw);
 447     return gsl_linalg_LU_det($LU->raw, $s );
 448 }
 449
 450 =head2 lndet()
 451
 452 Returns the natural log of the absolute value of the determinant of a matrix (computed by LU decomposition) or dies if called on a non-square matrix.
 453
 454     my $lndet = $matrix->lndet();
 455
 456 =cut
 457
 458 sub lndet($)
 459 {
 460     my $self = shift;
 461     croak(__PACKAGE__."- log determinant only exists for square matrices") unless $self->is_square;
 462
 463     my $p  = Math::GSL::Permutation->new( $self->rows );
 464     my $LU = $self->copy;
 465
 466     gsl_linalg_LU_decomp($LU->raw, $p->raw);
 467     return gsl_linalg_LU_lndet($LU->raw);
 468 }
 469
 470 =head2 inverse()
 471
 472 Returns the inverse of a matrix or dies when called on a non-square matrix.
 473
 474     my $inverse = $matrix->inverse;
 475
 476 =cut
 477
 478 sub inverse($)
 479 {
 480     my $self = shift;
 481     croak(__PACKAGE__."- inverse only exists for square matrices") unless $self->is_square;
 482
 483     my $p  = Math::GSL::Permutation->new( $self->rows );
 484     my $LU = $self->copy;
 485     my $inverse = $self->copy;
 486
 487     # should check return status
 488     gsl_linalg_LU_decomp($LU->raw, $p->raw);
 489     gsl_linalg_LU_invert($LU->raw, $p->raw,$inverse->raw);
 490
 491     return $inverse;
 492
 493 }
 494
 495 =head2 eigenvalues()
 496
 497 =cut
 498
 499
 500 sub eigenvalues($)
 501 {
 502     my $self=shift;
 503     my ($r,$c) = ($self->rows,$self->cols);
 504     croak "Math::GSL::Matrix : \$matrix->eigenvalues - \$matrix must be square" unless ($r == $c);
 505     my $evec   = gsl_matrix_complex_alloc($r,$c);
 506     my $eigen  = gsl_eigen_nonsymmv_alloc($r);
 507     my $vector = gsl_vector_complex_alloc($r);
 508
 509     gsl_eigen_nonsymmv($self->raw, $vector, $evec, $eigen);
 510
 511     my $x = gsl_vector_complex_real($vector); # vector of real components
 512     my $y = gsl_vector_complex_imag($vector); # vector of imaginary components
 513
 514     return map {
 515                 _as_complex( gsl_vector_get($x->{vector}, $_) ,
 516                              gsl_vector_get($y->{vector}, $_) )
 517                 } (0 .. $r-1);
 518
 519 }
 520
 521 sub eigenpair($)
 522 {
 523     my $self=shift;
 524     my ($r,$c) = ($self->rows,$self->cols);
 525     croak "Math::GSL::Matrix : \$matrix->eigenvalues - \$matrix must be square" unless ($r == $c);
 526     my $evec   = Math::GSL::MatrixComplex->new($r,$c);
 527     my $eigen  = gsl_eigen_nonsymmv_alloc($r);
 528     my $vector = Math::GSL::VectorComplex->new($r);
 529
 530     gsl_eigen_nonsymmv($self->raw, $vector->raw, $evec->raw, $eigen);
 531
 532     my $eigenvectors = [ map { $evec->col($_)->as_vector } (0 .. $r-1) ];
 533
 534     my $x = gsl_vector_complex_real($vector->raw); # vector of real components
 535     my $y = gsl_vector_complex_imag($vector->raw); # vector of imaginary components
 536     my $eigenvalues = [
 537                             map {
 538                                 _as_complex( gsl_vector_get($x->{vector}, $_) ,
 539                                             gsl_vector_get($y->{vector}, $_) )
 540                              } (0 .. $r-1)
 541                       ];
 542     return ($eigenvalues, $eigenvectors);
 543 }
 544
 545 sub _as_complex {
 546     my ($w,$v) = @_;
 547     my ($x,$y) = ($w,$v);
 548     if( ref $w eq 'Math::GSL::Complex') {
 549         ($x,$y) = (gsl_real($w),gsl_imag($w));
 550     }
 551     my $z      = Math::Complex->make( $x, $y);
 552 }
 553
 554 =head2 as_vector()
 555
 556 Returns a 1xN or Nx1 matrix as a Math::GSL::Vector object. Dies if called on a matrix that is not a single row or column. Useful for turning the output of C<col()> or C<row()> into a vector, like so:
 557
 558     my $vector1 = $matrix->col(0)->as_vector;
 559     my $vector2 = $matrix->row(1)->as_vector;
 560
 561 =cut
 562
 563 sub as_vector($)
 564 {
 565     my ($self) = @_;
 566     croak(__PACKAGE__.'::as_vector() - must be a single row or column matrix') unless ($self->cols == 1 or $self->rows == 1);
 567
 568     # TODO: there is a faster way to do this
 569     return Math::GSL::Vector->new([ $self->as_list ] );
 570
 571 }
 572
 573 =head2 as_list()
 574
 575 Returns a matrix as a flattened Perl list.
 576
 577     my @values = $matrix->as_list;
 578
 579 =cut
 580
 581
 582 sub as_list($)
 583 {
 584     my $self = shift;
 585     my @matrix;
 586     for my $row ( 0 .. $self->rows-1) {
 587        push @matrix, map { gsl_matrix_get($self->raw, $row, $_) } (0 .. $self->cols-1 );
 588     }
 589     return @matrix;
 590 }
 591
 592 =head2 row()
 593
 594 Returns a row matrix of the row you enter.
 595
 596     my $matrix = Math::GSL::Matrix->new(3,3);
 597     ...
 598     my $matrix_row = $matrix->row(0);
 599
 600 =cut
 601
 602 sub row
 603 {
 604     my ($self, $row) = @_;
 605     croak (__PACKAGE__.'::$matrix->row($row) - invalid $row value')
 606         unless (($row < $self->rows) and $row >= 0);
 607
 608    my $rowmat = Math::GSL::Matrix->new(1,$self->cols);
 609
 610    for my $n (0 .. $self->cols-1) {
 611         gsl_matrix_set( $rowmat->raw, 0, $n,
 612             gsl_matrix_get($self->raw, $row, $n)
 613         );
 614    }
 615
 616     return $rowmat;
 617 }
 618
 619 =head2 col()
 620
 621 Returns a col matrix of the column you enter.
 622
 623     my $matrix = Math::GSL::Matrix->new(3,3);
 624     ...
 625     my $matrix_col = $matrix->col(0);
 626
 627 =cut
 628
 629 sub col
 630 {
 631     my ($self, $col) = @_;
 632     croak (__PACKAGE__."::\$matrix->col(\$col) - $col not a valid column")
 633         unless ($col < $self->cols and $col >= 0);
 634
 635     my $colmat = Math::GSL::Matrix->new($self->rows, 1);
 636
 637    map { gsl_matrix_set($colmat->raw, $_, 0,
 638            gsl_matrix_get($self->raw, $_, $col),
 639            )
 640        } (0 .. $self->rows-1);
 641
 642    return $colmat;
 643 }
 644
 645 =head2 set_row()
 646
 647 Sets a the values of a row with the elements of an array.
 648
 649     my $matrix = Math::GSL::Matrix->new(3,3);
 650     $matrix->set_row(0, [8, 6, 2]);
 651
 652 You can also set multiple rows at once with chained calls:
 653     my $matrix = Math::GSL::Matrix->new(3,3);
 654     $matrix->set_row(0, [8, 6, 2])
 655            ->set_row(1, [2, 4, 1]);
 656     ...
 657
 658 =cut
 659
 660 sub set_row {
 661     my ($self, $row, $values) = @_;
 662     my $length = $#$values;
 663     die __PACKAGE__.'::new($x, $values) - $values must be a nonempty array reference' if $length == -1;
 664     die __PACKAGE__.'::set_row($x, $values) - $x must be a valid row number'
 665         if ($row < 0 || $row >= $self->rows);
 666     die __PACKAGE__.'::set_row($x, $values) - $values must contains the same number of elements as there is columns in the matrix'
 667         if($length != $self->cols-1);
 668     map { gsl_matrix_set($self->raw, $row, $_, $values->[$_]) } (0..$length);
 669     return $self;
 670 }
 671
 672 =head2 set_col()
 673
 674 Sets a the values of a column with the elements of an array.
 675
 676     my $matrix = Math::GSL::Matrix->new(3,3);
 677     $matrix->set_col(0, [8, 6, 2]);
 678
 679 You can also set multiple columns at once with chained calls:
 680     my $matrix = Math::GSL::Matrix->new(3,3);
 681     $matrix->set_col(0, [8, 6, 2])
 682            ->set_col(1, [2, 4, 1]);
 683     ...
 684
 685 =cut
 686
 687 sub set_col {
 688     my ($self, $col, $values) = @_;
 689     my $length = $#$values;
 690
 691     die __PACKAGE__.'::new($x, $values) - $values must be a nonempty array reference' if $length == -1;
 692     die __PACKAGE__.'::set_row($x, $values) - $x must be a valid column number'
 693         if ($col < 0 || $col >= $self->cols);
 694     die __PACKAGE__.'::set_row($x, $values) - $values must contains the same number of elements as there is rowss in the matrix'
 695         if($length != $self->rows-1);
 696
 697     map { gsl_matrix_set($self->raw, $_, $col, $values->[$_]) } (0..$length);
 698     return $self;
 699 }
 700
 701 sub _addition {
 702     my ($left, $right) = @_;
 703
 704     my $lcopy = $left->copy;
 705
 706     if ( blessed $right && $right->isa('Math::GSL::Matrix') && blessed $left && $left->isa('Math::GSL::Matrix') ) {
 707         if ( $left->cols == $right->cols && $left->rows == $right->rows ) {
 708             gsl_matrix_add($lcopy->raw, $right->raw);
 709         } else {
 710             croak "Math::GSL - addition of matrices must be called with two objects matrices and must have the same number of columns and rows";
 711         }
 712     } else {
 713         gsl_matrix_add_constant($lcopy->raw, $right);
 714     }
 715     return $lcopy;
 716 }
 717
 718 sub _subtract {
 719     my ($left, $right) = @_;
 720
 721     my $lcopy = $left->copy;
 722
 723     if ( blessed $right && $right->isa('Math::GSL::Matrix') && blessed $left && $left->isa('Math::GSL::Matrix') ) {
 724         if ( $left->cols == $right->cols && $left->rows == $right->rows ) {
 725             gsl_matrix_sub($lcopy->raw, $right->raw);
 726         } else {
 727             croak "Math::GSL - subtraction of matrices must be called with two objects matrices and must have the same number of columns and rows";
 728         }
 729     } else {
 730         gsl_matrix_add_constant($lcopy->raw, $right*-1);
 731     }
 732     return $lcopy;
 733 }
 734
 735 sub _multiplication {
 736     my ($left,$right) = @_;
 737     my $lcopy = $left->copy;
 738
 739     if ( blessed $right && $right->isa('Math::GSL::Matrix') ) {
 740         if ( $left->cols == $right->cols && $left->rows == $right->rows ) {
 741             return _dot_product($left,$right);
 742             #gsl_matrix_mul_elements($lcopy->raw, $right->raw);
 743         } else {
 744             croak "Math::GSL::Matrix - multiplication of elements of matrices must be called with two objects matrices and must have the same number of columns and rows";
 745         }
 746     } else {
 747         gsl_matrix_scale($lcopy->raw, $right);
 748     }
 749     return $lcopy;
 750 }
 751
 752 sub _equal {
 753     my ($left, $right) = @_;
 754
 755     return is_similar( [ $left->as_list ], [ $right->as_list ] );
 756 }
 757
 758 sub _not_equal {
 759     my ($left, $right) = @_;
 760     return !is_similar( [ $left->as_list ], [ $right->as_list ] );
 761 }
 762
 763 sub _dot_product {
 764     my ($left,$right) = @_;
 765
 766     croak "Math::GSL::Matrix - incompatible matrices in multiplication"
 767         unless ( blessed $right && $right->isa('Math::GSL::Matrix') and $left->rows == $right->cols );
 768     my $C = Math::GSL::Matrix->new($left->rows, $right->cols);
 769     gsl_blas_dgemm($CblasNoTrans, $CblasNoTrans, 1, $left->raw, $right->raw, 1, $C->raw);
 770     return $C;
 771 }
 772
 773 =head1 DESCRIPTION
 774
 775 Here is a list of all the functions included in this module :
 776
 777 =over 1
 778
 779 =item C<gsl_matrix_alloc($i, $j)> - Return a gsl_matrix of $i rows and $j columns
 780
 781 =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
 782
 783 =item C<gsl_matrix_alloc_from_block> -
 784
 785 =item C<gsl_matrix_free> -
 786
 787 =item C<gsl_matrix_alloc_from_matrix > -
 788
 789 =item C<gsl_vector_alloc_row_from_matrix> -
 790
 791 =item C<gsl_vector_alloc_col_from_matrix > -
 792
 793 =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.
 794
 795 =item C<gsl_matrix_row($m , $i)> - Return a vector view of the $i-th row of the matrix $m
 796
 797 =item C<gsl_matrix_column($m, $j)> - Return a vector view of the $j-th column of the matrix $m
 798
 799 =item C<gsl_matrix_diagonal($m)> - Return a vector view of the diagonal of the vector. The matrix doesn't have to be square.
 800
 801 =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.
 802
 803 =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.
 804
 805 =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.
 806
 807 =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.
 808
 809 =item C<gsl_matrix_view_array($base, $n1, $n2)> - This function returns a matrix view of the array reference $base. The matrix has $n1 rows and $n2 columns. The physical number of columns in memory is also given by $n2. Mathematically, the (i,j)-th element of the new matrix is given by, m'(i,j) = $base->[i*$n2 + j] where the index i runs from 0 to $n1-1 and the index j runs from 0 to $n2-1. The new matrix is only a view of the array reference $base. When the view goes out of scope the original array reference $base will continue to exist. The original memory can only be deallocated by freeing the original array. Of course, the original array should not be deallocated while the view is still in use.
 810
 811 =item C<gsl_matrix_view_array_with_tda($base, $n1, $n2, $tda)> - This function returns a matrix view of the array reference $base with a physical number of columns $tda which may differ from the corresponding dimension of the matrix. The matrix has $n1 rows and $n2 columns, and the physical number of columns in memory is given by $tda. Mathematically, the (i,j)-th element of the new matrix is given by, m'(i,j) = $base->[i*$tda + j] where the index i runs from 0 to $n1-1 and the index j runs from 0 to $n2-1. The new matrix is only a view of the array reference $base. When the view goes out of scope the original array reference $base will continue to exist. The original memory can only be deallocated by freeing the original array. Of course, the original array should not be deallocated while the view is still in use.
 812
 813 =item C<gsl_matrix_view_vector> -
 814
 815 =item C<gsl_matrix_view_vector_with_tda> -
 816
 817 =item C<gsl_matrix_const_submatrix> -
 818
 819 =item C<gsl_matrix_get($m, $i, $j)> - Return the (i,j)-th element of the matrix $m
 820
 821 =item C<gsl_matrix_set($m, $i, $j, $x)> - Set the value of the (i,j)-th element of the matrix $m to $x
 822
 823 =item C<gsl_matrix_ptr> -
 824
 825 =item C<gsl_matrix_const_ptr> -
 826
 827 =item C<gsl_matrix_set_zero($m)> - Set all the elements of the matrix $m to zero
 828
 829 =item C<gsl_matrix_set_identity($m)> - Set the elements of the matrix $m to the corresponding elements of the identity matrix
 830
 831 =item C<gsl_matrix_set_all($m, $x)> - Set all the elements of the matrix $m to the value $x
 832
 833 =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 gsl_fopen function from the Math::GSL module and stores the data inside the matrix $m
 834
 835 =item C<gsl_matrix_fwrite($fh, $m)> - Write the elements of the matrix $m in binary format to a stream $fh opened with the gsl_fopen function from the Math::GSL module
 836
 837 =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 gsl_fopenfunction from the Math::GSL module and stores the data inside the matrix $m
 838
 839 =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 gsl_fopen function from the Math::GSL module
 840
 841 =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.
 842
 843 =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.
 844
 845 =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.
 846
 847 =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.
 848
 849 =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.
 850
 851 =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.
 852
 853 =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.
 854
 855 =item C<gsl_matrix_max($m)> - Return the maximum value in the matrix $m
 856
 857 =item C<gsl_matrix_min($m)> - Return the minimum value in the matrix $m
 858
 859 =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.
 860
 861 =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.
 862
 863 =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.
 864
 865 =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
 866
 867 =item C<gsl_matrix_isnull($m)> - Return 1 if all the elements of the matrix $m are zero, 0 otherwise
 868
 869 =item C<gsl_matrix_ispos($m)> - Return 1 if all the elements of the matrix $m are strictly positve, 0 otherwise
 870
 871 =item C<gsl_matrix_isneg($m)> - Return 1 if all the elements of the matrix $m are strictly negative, 0 otherwise
 872
 873 =item C<gsl_matrix_isnonneg($m)> - Return 1 if all the elements of the matrix $m are non-negatuive, 0 otherwise
 874
 875 =item C<gsl_matrix_add($a, $b)> - Add the elements of matrix $b to the elements of matrix $a
 876
 877 =item C<gsl_matrix_sub($a, $b)> - Subtract the elements of matrix $b from the elements of matrix $a
 878
 879 =item C<gsl_matrix_mul_elements($a, $b)> - Multiplie the elements of matrix $a by the elements of matrix $b
 880
 881 =item C<gsl_matrix_div_elements($a, $b)> - Divide the elements of matrix $a by the elements of matrix $b
 882
 883 =item C<gsl_matrix_scale($a, $x)> - Multiplie the elements of matrix $a by the constant factor $x
 884
 885 =item C<gsl_matrix_add_constant($a, $x)> - Add the constant value $x to the elements of the matrix $a
 886
 887 =item C<gsl_matrix_add_diagonal($a, $x)> - Add the constant value $x to the elements of the diagonal of the matrix $a
 888
 889 =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.
 890
 891 =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.
 892
 893 =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.
 894
 895 =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.
 896
 897 =back
 898
 899 These are related to constant views of a matrix.
 900
 901 =over 1
 902
 903
 904 =item C<gsl_matrix_const_row>
 905
 906 =item C<gsl_matrix_const_colum>
 907
 908 =item C<gsl_matrix_const_diagonal>
 909
 910 =item C<gsl_matrix_const_subdiagonal>
 911
 912 =item C<gsl_matrix_const_superdiagonal>
 913
 914 =item C<gsl_matrix_const_subrow>
 915
 916 =item C<gsl_matrix_const_subcolumn>
 917
 918 =item C<gsl_matrix_const_view_array>
 919
 920 =item C<gsl_matrix_const_view_array_with_tda>
 921
 922 =back
 923
 924
 925 The following functions are similar to those above but work with C<char>'s and C<int>'s. We are not quite
 926 sure if anyone wants these. Please speak up if you do and/or submit some patches to this documentation, please!
 927
 928 =over 1
 929
 930
 931 =item gsl_matrix_const_view_vector
 932
 933 =item gsl_matrix_const_view_vector_with_tda
 934
 935 =item gsl_matrix_char_alloc
 936
 937 =item gsl_matrix_char_calloc
 938
 939 =item gsl_matrix_char_alloc_from_block
 940
 941 =item gsl_matrix_char_alloc_from_matrix
 942
 943 =item gsl_vector_char_alloc_row_from_matrix
 944
 945 =item gsl_vector_char_alloc_col_from_matrix
 946
 947 =item gsl_matrix_char_free
 948
 949 =item gsl_matrix_char_submatrix
 950
 951 =item gsl_matrix_char_row
 952
 953 =item gsl_matrix_char_column
 954
 955 =item gsl_matrix_char_diagonal
 956
 957 =item gsl_matrix_char_subdiagonal
 958
 959 =item gsl_matrix_char_superdiagonal
 960
 961 =item gsl_matrix_char_subrow
 962
 963 =item gsl_matrix_char_subcolumn
 964
 965 =item gsl_matrix_char_view_array
 966
 967 =item gsl_matrix_char_view_array_with_tda
 968
 969 =item gsl_matrix_char_view_vector
 970
 971 =item gsl_matrix_char_view_vector_with_tda
 972
 973 =item gsl_matrix_char_const_submatrix
 974
 975 =item gsl_matrix_char_const_row
 976
 977 =item gsl_matrix_char_const_column
 978
 979 =item gsl_matrix_char_const_diagonal
 980
 981 =item gsl_matrix_char_const_subdiagonal
 982
 983 =item gsl_matrix_char_const_superdiagonal
 984
 985 =item gsl_matrix_char_const_subrow
 986
 987 =item gsl_matrix_char_const_subcolumn
 988
 989 =item gsl_matrix_char_const_view_array
 990
 991 =item gsl_matrix_char_const_view_array_with_tda
 992
 993 =item gsl_matrix_char_const_view_vector
 994
 995 =item gsl_matrix_char_const_view_vector_with_tda
 996
 997 =item gsl_matrix_char_get
 998
 999 =item gsl_matrix_char_set
1000
1001 =item gsl_matrix_char_ptr
1002
1003 =item gsl_matrix_char_const_ptr
1004
1005 =item gsl_matrix_char_set_zero
1006
1007 =item gsl_matrix_char_set_identity
1008
1009 =item gsl_matrix_char_set_all
1010
1011 =item gsl_matrix_char_fread
1012
1013 =item gsl_matrix_char_fwrite
1014
1015 =item gsl_matrix_char_fscanf
1016
1017 =item gsl_matrix_char_fprintf
1018
1019 =item gsl_matrix_char_memcpy
1020
1021 =item gsl_matrix_char_swap
1022
1023 =item gsl_matrix_char_swap_rows
1024
1025 =item gsl_matrix_char_swap_columns
1026
1027 =item gsl_matrix_char_swap_rowcol
1028
1029 =item gsl_matrix_char_transpose
1030
1031 =item gsl_matrix_char_transpose_memcpy
1032
1033 =item gsl_matrix_char_max
1034
1035 =item gsl_matrix_char_min
1036
1037 =item gsl_matrix_char_minmax
1038
1039 =item gsl_matrix_char_max_index
1040
1041 =item gsl_matrix_char_min_index
1042
1043 =item gsl_matrix_char_minmax_index
1044
1045 =item gsl_matrix_char_isnull
1046
1047 =item gsl_matrix_char_ispos
1048
1049 =item gsl_matrix_char_isneg
1050
1051 =item gsl_matrix_char_isnonneg
1052
1053 =item gsl_matrix_char_add
1054
1055 =item gsl_matrix_char_sub
1056
1057 =item gsl_matrix_char_mul_elements
1058
1059 =item gsl_matrix_char_div_elements
1060
1061 =item gsl_matrix_char_scale
1062
1063 =item gsl_matrix_char_add_constant
1064
1065 =item gsl_matrix_char_add_diagonal
1066
1067 =item gsl_matrix_int_alloc
1068
1069 =item gsl_matrix_int_calloc
1070
1071 =item gsl_matrix_int_alloc_from_block
1072
1073 =item gsl_matrix_int_alloc_from_matrix
1074
1075 =item gsl_vector_int_alloc_row_from_matrix
1076
1077 =item gsl_vector_int_alloc_col_from_matrix
1078
1079 =item gsl_matrix_int_free
1080
1081 =item gsl_matrix_int_submatrix
1082
1083 =item gsl_matrix_int_row
1084
1085 =item gsl_matrix_int_column
1086
1087 =item gsl_matrix_int_diagonal
1088
1089 =item gsl_matrix_int_subdiagonal
1090
1091 =item gsl_matrix_int_superdiagonal
1092
1093 =item gsl_matrix_int_subrow
1094
1095 =item gsl_matrix_int_subcolumn
1096
1097 =item gsl_matrix_int_view_array
1098
1099 =item gsl_matrix_int_view_array_with_tda
1100
1101 =item gsl_matrix_int_view_vector
1102
1103 =item gsl_matrix_int_view_vector_with_tda
1104
1105 =item gsl_matrix_int_const_submatrix
1106
1107 =item gsl_matrix_int_const_row
1108
1109 =item gsl_matrix_int_const_column
1110
1111 =item gsl_matrix_int_ptr
1112
1113 =item gsl_matrix_int_const_ptr
1114
1115 =item gsl_matrix_int_set_zero
1116
1117 =item gsl_matrix_int_set_identity
1118
1119 =item gsl_matrix_int_set_all
1120
1121 =item gsl_matrix_int_fread
1122
1123 =item gsl_matrix_int_fwrite
1124
1125 =item gsl_matrix_int_fscanf
1126
1127 =item gsl_matrix_int_fprintf
1128
1129 =item gsl_matrix_int_memcpy
1130
1131 =item gsl_matrix_int_swap
1132
1133 =item gsl_matrix_int_swap_rows
1134
1135 =item gsl_matrix_int_swap_columns
1136
1137 =item gsl_matrix_int_swap_rowcol
1138
1139 =item gsl_matrix_int_transpose
1140
1141 =item gsl_matrix_int_transpose_memcpy
1142
1143 =item gsl_matrix_int_max
1144
1145 =item gsl_matrix_int_min
1146
1147 =item gsl_matrix_int_minmax
1148
1149 =item gsl_matrix_int_max_index
1150
1151 =item gsl_matrix_int_min_index
1152
1153 =item gsl_matrix_int_minmax_index
1154
1155 =item gsl_matrix_int_isnull
1156
1157 =item gsl_matrix_int_ispos
1158
1159 =item gsl_matrix_int_isneg
1160
1161 =item gsl_matrix_int_isnonneg
1162
1163 =item gsl_matrix_int_add
1164
1165 =item gsl_matrix_int_sub
1166
1167 =item gsl_matrix_int_mul_elements
1168
1169 =item gsl_matrix_int_div_elements
1170
1171 =item gsl_matrix_int_scale
1172
1173 =item gsl_matrix_int_add_constant
1174
1175 =item gsl_matrix_int_add_diagonal
1176
1177 =back
1178
1179 You have to add the functions you want to use inside the qw /put_funtion_here /.
1180 You can also write use Math::GSL::Matrix qw/:all/ to use all avaible functions of the module.
1181 Other tags are also avaible, here is a complete list of all tags for this module :
1182
1183 =over 1
1184
1185 =item C<all>
1186
1187 =item C<int>
1188
1189 =item C<double>
1190
1191 =item C<char>
1192
1193 =item C<complex>
1194
1195 =back
1196
1197 For more informations on the functions, we refer you to the GSL offcial documentation
1198 L<http://www.gnu.org/software/gsl/manual/html_node/>
1199
1200 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/name_of_the_function_you_want
1201
1202 =head1 EXAMPLES
1203
1204  Most of the examples from this section are perl versions of the examples at L<http://www.gnu.org/software/gsl/manual/html_node/Example-programs-for-matrices.html>
1205
1206  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.
1207
1208  use Math::GSL::Matrix qw/:all/;
1209  my $m = gsl_matrix_alloc (10,3);
1210  for my $i (0..9){
1211     for my $j (0..2){
1212         gsl_matrix_set($m, $i, $j, 0.23 + 100*$i + $j);
1213     }
1214  }
1215
1216  for my $i (0..99){ # OUT OF RANGE ERROR
1217      for my $j (0..2){
1218         print "m($i, $j) = " . gsl_matrix_get ($m, $i, $j) . "\n";
1219     }
1220  }
1221  gsl_matrix_free ($m);
1222
1223
1224  use Math::GSL::Matrix qw/:all/;
1225
1226  my $m = gsl_matrix_alloc (100, 100);
1227  my $a = gsl_matrix_alloc (100, 100);
1228
1229  for my $i (0..99){
1230      for my $j (0..99){
1231          gsl_matrix_set ($m, $i, $j, 0.23 + $i + $j);
1232      }
1233  }
1234
1235  The next program shows how to write a matrix to a file.
1236
1237  my $out = gsl_fopen("test.dat", "wb");
1238  gsl_matrix_fwrite ($out, $m);
1239  gsl_fclose ($out);
1240
1241  my $in = gsl_fopen("test.dat", "rb");
1242  gsl_matrix_fread ($in, $a);
1243  gsl_fclose($in);
1244
1245  my $k=0;
1246  for my $i (0..99){
1247      for my $j (0..99){
1248          $mij = gsl_matrix_get ($m, $i, $j);
1249          $aij = gsl_matrix_get ($a, $i, $j);
1250          $k++ if ($mij != $aij);
1251      }
1252  }
1253
1254  gsl_matrix_free($m);
1255  gsl_matrix_free($a);
1256
1257  print "differences = $k (should be zero)\n";
1258
1259 =head1 AUTHORS
1260
1261 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
1262
1263 =head1 COPYRIGHT AND LICENSE
1264
1265 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
1266
1267 This program is free software; you can redistribute it and/or modify it
1268 under the same terms as Perl itself.
1269
1270 =cut
1271
1272 %}
1273