.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "CCS 3pm"
.TH CCS 3pm "2018-11-02" "perl v5.28.0" "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"
PDL::CCS \- Sparse N\-dimensional PDLs with compressed column storage
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use PDL;
\& use PDL::CCS;
\&
\& ## ... stuff happens ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1PDL::CCS\s0 is now just a wrapper package which pulls in a number of
submodules.  See the documentation of the respective modules for details.
.SS "Modules"
.IX Subsection "Modules"
.IP "PDL::CCS::Nd" 4
.IX Item "PDL::CCS::Nd"
Perl class for representing large sparse N\-dimensional numeric structures
using sorted index vector-vectors and a flat vector of non-missing values.
Supports a subset of the perl-side \s-1PDL API.\s0
.IP "PDL::CCS::Compat" 4
.IX Item "PDL::CCS::Compat"
Backwards-compatibility module for Harwell-Boeing compressed row\- or column-storage.
.IP "PDL::CCS::Functions" 4
.IX Item "PDL::CCS::Functions"
Some useful generic pure-perl functions for dealing directly with
\&\s-1CCS\-, CRS\-,\s0 and index-encoded PDLs.
.IP "PDL::CCS::Utils" 4
.IX Item "PDL::CCS::Utils"
Low-level generic \s-1PDL::PP\s0 utilities for Harwell-Boeing encoding and decoding
\&\*(L"pointers\*(R" along arbitrary dimensions of a sparse \s-1PDL\s0 given an index list.
.IP "PDL::CCS::Ops" 4
.IX Item "PDL::CCS::Ops"
Low-level generic \s-1PDL::PP\s0 utilities for blockwise alignment of pairs
of sparse index-encoded PDLs, useful for implementing binary operations.
.IP "PDL::CCS::Ufunc" 4
.IX Item "PDL::CCS::Ufunc"
Various low-level ufunc (accumulator) utilities for index-encoded PDLs.
.IP "PDL::CCS::MatrixOps" 4
.IX Item "PDL::CCS::MatrixOps"
Low-level generic \s-1PDL::PP\s0 utilities for matrix operations
on index-encoded PDLs.
.IP "PDL::CCS::IO::FastRaw" 4
.IX Item "PDL::CCS::IO::FastRaw"
PDL::IO::FastRaw wrappers for PDL::CCS::Nd objects.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Perl by Larry Wall.
.PP
\&\s-1PDL\s0 by Karl Glazebrook, Tuomas J. Lukka, Christian Soeller, and others.
.PP
Original inspiration and algorithms from the \s-1SVDLIBC C\s0 library by Douglas Rohde;
which is itself based on \s-1SVDPACKC\s0
by Michael Berry, Theresa Do, Gavin O'Brien, Vijay Krishna and Sowmini Varadhan.
.SH "KNOWN BUGS"
.IX Header "KNOWN BUGS"
.IP "\(bu" 4
PDL::CCS::Nd supports only a subset of the \s-1PDL API\s0
(i.e. is not really a \s-1PDL\s0).
.IP "\(bu" 4
Binary operations via alignment only work correctly when
missing values are annihilators.
.IP "\(bu" 4
Misleading module name: PDL::CCS::Nd objects actually use a native \s-1COO\s0 (full coordinate list)
format rather than \s-1CRS\s0 (compressed row storage) or \s-1CCS\s0 (compressed column storage);
see <https://en.wikipedia.org/wiki/Sparse_matrix#Coordinate_list_(\s-1COO\s0)> for a discussion.
.SH "AUTHOR"
.IX Header "AUTHOR"
Bryan Jurish <moocow@cpan.org>
.SS "Copyright Policy"
.IX Subsection "Copyright Policy"
Copyright (C) 2005\-2018 by Bryan Jurish. All rights reserved.
.PP
This package is free software, and entirely without warranty.
You may redistribute it and/or modify it under the same terms
as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1),
\&\s-1\fBPDL\s0\fR\|(3perl),
\&\fBPDL::CCS::Nd\fR\|(3perl),
\&\s-1\fBPDL::SVDLIBC\s0\fR\|(3perl),
<https://en.wikipedia.org/wiki/Sparse_matrix>.