Index
- NAME
- SYNOPSIS
- Objected Oriented Interface to GSL Math::GSL::MatrixComplex
- new()
- cols()
- as_vector()
- as_list()
- row()
- col()
- set_row()
- set_col()
- is_square()
- det()
- zero()
- identity()
- inverse()
- is_hermitian()
- lndet()
-
gsl_matrix_complex_allocgsl_matrix_complex_callocgsl_matrix_complex_alloc_from_blockgsl_matrix_complex_alloc_from_matrixgsl_vector_complex_alloc_row_from_matrixgsl_vector_complex_alloc_col_from_matrixgsl_matrix_complex_freegsl_matrix_complex_submatrixgsl_matrix_complex_rowgsl_matrix_complex_columngsl_matrix_complex_diagonalgsl_matrix_complex_subdiagonalgsl_matrix_complex_superdiagonalgsl_matrix_complex_subrowgsl_matrix_complex_subcolumngsl_matrix_complex_view_arraygsl_matrix_complex_view_array_with_tdagsl_matrix_complex_view_vectorgsl_matrix_complex_view_vector_with_tdagsl_matrix_complex_const_submatrixgsl_matrix_complex_const_rowgsl_matrix_complex_const_columngsl_matrix_complex_const_diagonalgsl_matrix_complex_const_subdiagonalgsl_matrix_complex_const_superdiagonalgsl_matrix_complex_const_subrowgsl_matrix_complex_const_subcolumngsl_matrix_complex_const_view_arraygsl_matrix_complex_const_view_array_with_tdagsl_matrix_complex_const_view_vectorgsl_matrix_complex_const_view_vector_with_tdagsl_matrix_complex_getgsl_matrix_complex_setgsl_matrix_complex_ptrgsl_matrix_complex_const_ptrgsl_matrix_complex_set_zerogsl_matrix_complex_set_identitygsl_matrix_complex_set_allgsl_matrix_complex_freadgsl_matrix_complex_fwritegsl_matrix_complex_fscanfgsl_matrix_complex_fprintfgsl_matrix_complex_memcpygsl_matrix_complex_swapgsl_matrix_complex_swap_rowsgsl_matrix_complex_swap_columnsgsl_matrix_complex_swap_rowcolgsl_matrix_complex_transposegsl_matrix_complex_transpose_memcpygsl_matrix_complex_isnullgsl_matrix_complex_isposgsl_matrix_complex_isneggsl_matrix_complex_addgsl_matrix_complex_subgsl_matrix_complex_mul_elementsgsl_matrix_complex_div_elementsgsl_matrix_complex_scalegsl_matrix_complex_add_constantgsl_matrix_complex_add_diagonalgsl_matrix_complex_get_rowgsl_matrix_complex_get_colgsl_matrix_complex_set_rowgsl_matrix_complex_set_col
- AUTHORS
- COPYRIGHT AND LICENSE
NAME
Math::GSL::MatrixComplex - Complex Matrices
SYNOPSIS
use Math::GSL::MatrixComplex qw/:all/;
my $matrix1 = Math::GSL::MatrixComplex->new(5,5); # OO interface
my $matrix3 = $matrix1 + $matrix1;
my $matrix4 = $matrix1 - $matrix1;
if($matrix1 == $matrix4) ...
if($matrix1 != $matrix3) ...
my $matrix2 = gsl_matrix_complex_alloc(5,5); # standard interface
Objected Oriented Interface to GSL Math::GSL::MatrixComplex
new()
Creates a new MatrixComplex object of the given size.
my $matrix = Math::GSL::MatrixComplex->new(10,10); =cut
sub new { my ($class, $rows, $cols) = @_; my $this = {}; my $matrix; if ( defined $rows && defined $cols && $rows > 0 && $cols > 0 && (int $rows == $rows) && (int $cols == $cols)){
$matrix = gsl_matrix_complex_alloc($rows,$cols);
} else {
croak( __PACKAGE__.'::new($x,$y) - $x and $y must be positive integers');
}
gsl_matrix_complex_set_zero($matrix);
$this->{_matrix} = $matrix;
($this->{_rows}, $this->{_cols}) = ($rows,$cols);
bless $this, $class;
}
=head2 raw()
Get the underlying GSL matrix object created by SWIG, useful for using gsl_matrix_* functions which do not have an OO counterpart.
my $matrix = Math::GSL::MatrixComplex->new(3,3);
my $gsl_matrix = $matrix->raw;
my $stuff = gsl_matrix_complex_get($gsl_matrix, 1, 2);
cols()
Returns the number of columns in the matrix.
my $cols = $matrix->cols; =cut
sub cols { (shift)->{_cols} }
as_vector()
Returns a 1xN or Nx1 matrix as a Math::GSL::VectorComplex object. Dies if called on a matrix that is not a single row or column. Useful for turning the output of col() or row() into a vector, like so:
my $vector1 = $matrix->col(0)->as_vector;
my $vector2 = $matrix->row(1)->as_vector;
as_list()
Get the contents of a Math::GSL::Matrix object as a Perl list.
my $matrix = Math::GSL::MatrixComplex->new(3,3);
...
my @matrix = $matrix->as_list;
=cut
sub as_list($) { my $self = shift; my @matrix; for my $row ( 0 .. $self->rows-1) { push @matrix, map { gsl_matrix_complex_get($self->raw, $row, $_) } (0 .. $self->cols-1 ); } return map { Math::Complex->make( gsl_real($_), gsl_imag($_)) } @matrix; }
row()
Returns a row matrix of the row you enter.
my $matrix = Math::GSL::MatrixComplex->new(3,3);
...
my $matrix_row = $matrix->row(0);
col()
Returns a col matrix of the column you enter.
my $matrix = Math::GSL::MatrixComplex->new(3,3);
...
my $matrix_col = $matrix->col(0);
set_row()
Sets a the values of a row with the elements of an array.
my $matrix = Math::GSL::MatrixComplex->new(3,3);
$matrix->set_row(0, [8, 6, 2]);
You can also set multiple rows at once with chained calls: my $matrix = Math::GSL::MatrixComplex->new(3,3); $matrix->set_row(0, [8, 6, 2]) ->set_row(1, [2, 4, 1]); ...
set_col()
Sets a the values of a column with the elements of an array.
my $matrix = Math::GSL::MatrixComplex->new(3,3);
$matrix->set_col(0, [8, 6, 2]);
You can also set multiple columns at once with chained calls: my $matrix = Math::GSL::MatrixComplex->new(3,3); $matrix->set_col(0, [8, 6, 2]) ->set_col(1, [2, 4, 1]); ...
is_square()
Returns true if a matrix is square, i.e. it has the same number of rows as columns, false otherwise.
det()
Returns the determinant of a matrix (computed by LU decomposition) or dies if called on a non-square matrix.
my $det = $matrix->det();
zero()
Set a matrix to the zero matrix.
$matrix->zero;
identity()
Set a matrix to the identity matrix, i.e. one on the diagonal and zero elsewhere.
my $I = $matrix->identity;
inverse()
Returns the inverse of a matrix or dies when called on a non-square matrix.
my $inverse = $matrix->inverse;
is_hermitian()
Returns true if the matrix is hermitian, false otherwise
my $test = $matrix->is_hermitian;
lndet()
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.
my $lndet = $matrix->lndet();
gsl_matrix_complex_allocgsl_matrix_complex_callocgsl_matrix_complex_alloc_from_blockgsl_matrix_complex_alloc_from_matrixgsl_vector_complex_alloc_row_from_matrixgsl_vector_complex_alloc_col_from_matrixgsl_matrix_complex_freegsl_matrix_complex_submatrixgsl_matrix_complex_rowgsl_matrix_complex_columngsl_matrix_complex_diagonalgsl_matrix_complex_subdiagonalgsl_matrix_complex_superdiagonalgsl_matrix_complex_subrowgsl_matrix_complex_subcolumngsl_matrix_complex_view_arraygsl_matrix_complex_view_array_with_tdagsl_matrix_complex_view_vectorgsl_matrix_complex_view_vector_with_tdagsl_matrix_complex_const_submatrixgsl_matrix_complex_const_rowgsl_matrix_complex_const_columngsl_matrix_complex_const_diagonalgsl_matrix_complex_const_subdiagonalgsl_matrix_complex_const_superdiagonalgsl_matrix_complex_const_subrowgsl_matrix_complex_const_subcolumngsl_matrix_complex_const_view_arraygsl_matrix_complex_const_view_array_with_tdagsl_matrix_complex_const_view_vectorgsl_matrix_complex_const_view_vector_with_tdagsl_matrix_complex_getgsl_matrix_complex_setgsl_matrix_complex_ptrgsl_matrix_complex_const_ptrgsl_matrix_complex_set_zerogsl_matrix_complex_set_identitygsl_matrix_complex_set_allgsl_matrix_complex_freadgsl_matrix_complex_fwritegsl_matrix_complex_fscanfgsl_matrix_complex_fprintfgsl_matrix_complex_memcpygsl_matrix_complex_swapgsl_matrix_complex_swap_rowsgsl_matrix_complex_swap_columnsgsl_matrix_complex_swap_rowcolgsl_matrix_complex_transposegsl_matrix_complex_transpose_memcpygsl_matrix_complex_isnullgsl_matrix_complex_isposgsl_matrix_complex_isneggsl_matrix_complex_addgsl_matrix_complex_subgsl_matrix_complex_mul_elementsgsl_matrix_complex_div_elementsgsl_matrix_complex_scalegsl_matrix_complex_add_constantgsl_matrix_complex_add_diagonalgsl_matrix_complex_get_rowgsl_matrix_complex_get_colgsl_matrix_complex_set_rowgsl_matrix_complex_set_col
For more informations on the functions, we refer you to the GSL offcial documentation http://www.gnu.org/software/gsl/manual/html_node/
AUTHORS
Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
COPYRIGHT AND LICENSE
Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.