.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Math::GSL::SparseMatrix 3pm"
.TH Math::GSL::SparseMatrix 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Math::GSL::SparseMatrix \- Sparse Matrices
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\&    use Math::GSL::SparseMatrix qw/:all/;
\&    use Math::GSL::Matrix qw/gsl_matrix_alloc/;
\&    my $sparse = gsl_spmatrix_alloc(100,100);
\&    my $status = gsl_spmatrix_set($sparse,50,50,42.42);
\&    my $value  = gsl_spmatrix_get($sparse,50,50);
\&
\&    # multiply every element by 5
\&    $status = gsl_spmatrix_scale($sparse, 5);
\&
\&    # get the number of non\-zero elements
\&    my $nnz = gsl_spmatrix_nnz($sparse);
\&
\&    # fine min and max values, other than zero elements
\&    ($status, $min, $max) = gsl_spmatrix_minmax($sparse);
\&
\&    # set all elements to zero
\&    $status = gsl_spmatrix_set_zero($sparse);
\&
\&    my $dense  = gsl_matrix_alloc(100,100);
\&    # convert a sparse matrix to a dense matrix
\&    $status = gsl_spmatrix_sp2d($dense, $sparse);
\&
\&    # convert a dense matrix to a sparse matrix
\&    $status = gsl_spmatrix_d2sp($sparse, $dense);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
NOTE: This module requires GSL 2.0 or higher.
.PP
For more information on the functions, we refer you to the GSL official
documentation: <http://www.gnu.org/software/gsl/manual/html_node/>
.SH AUTHORS
.IX Header "AUTHORS"
Jonathan "Duke" Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2008\-2023 Jonathan "Duke" Leto and Thierry Moisan
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.