pod/Matrix.pod

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