.\" -*- 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 "FastRaw 3pm"
.TH FastRaw 3pm 2024-05-17 "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
PDL::CCS::IO::FastRaw \- PDL::IO::FastRaw wrappers for PDL::CCS::Nd
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& use PDL;
\& use PDL::CCS::Nd;
\& use PDL::CCS::IO::FastRaw;
\&
\& $ccs = PDL::CCS::Nd\->newFromWhich($which,$nzvals);
\&
\& ccs_writefraw($ccs,$fname);     # write a pair of raw files
\& $ccs2 = ccs_readfraw($fname);   # read a pair of raw files
\&
\& $ccs3 = ccs_mapfraw($fname,{ReadOnly=>1}); # mmap a pair of files, don\*(Aqt read yet
.Ve
.SH "I/O Utilities"
.IX Header "I/O Utilities"
.SS ccs_writefraw
.IX Subsection "ccs_writefraw"
Write a pair of raw binary files using \fBPDL::IO::FastRaw::writefraw()\fR.
.PP
.Vb 2
\& ccs_writefraw($ccs,$fname)
\& ccs_writefraw($ccs,$fname,\e%opts)
.Ve
.PP
Options \f(CW%opts:\fR
.PP
.Vb 5
\& Header      => $Header,       ##\-\- default="$fname.hdr"
\& ixFile      => $ixFile,       ##\-\- default="$fname.ix"
\& ixHeader    => $ixHeader,     ##\-\- default="$ixFile.hdr"
\& nzFile      => $nzFile,       ##\-\- default="$fname.nz"
\& nzHeader    => $nzHeader,     ##\-\- default="$nzFile.hdr"
.Ve
.SS ccs_readfraw
.IX Subsection "ccs_readfraw"
Read a pair of raw binary files using \fBPDL::IO::FastRaw::readfraw()\fR.
.PP
.Vb 2
\& $ccs = ccs_readfraw($fname)
\& $ccs = ccs_readfraw($fname,\e%opts)
.Ve
.PP
Options \f(CW%opts:\fR
.PP
.Vb 6
\& Header   => $Header,      ##\-\- default="$fname.hdr"
\& ixFile   => $ixFile,      ##\-\- default="$fname.ix"
\& ixHeader => $ixHeader,    ##\-\- default="$ixFile.hdr"
\& nzFile   => $nzFile,      ##\-\- default="$fname.nz"
\& nzHeader => $nzHeader,    ##\-\- default="$nzFile.hdr"
\& sorted   => $bool,        ##\-\- is data on disk already sorted? (default=1)
.Ve
.SS ccs_mapfraw
.IX Subsection "ccs_mapfraw"
Read a pair of raw binary files using \fBPDL::IO::FastRaw::readfraw()\fR.
.PP
.Vb 2
\& $ccs = ccs_mapfraw($fname)
\& $ccs = ccs_mapfraw($fname,\e%opts)
.Ve
.PP
Global options in \f(CW%opts:\fR
.PP
.Vb 6
\& Header    => $Header,   ##\-\- default="$fname.hdr"
\& ReadOnly  => $bool,     ##\-\- read\-only mode?
\& Dims      => \e@dims,    ##\-\- logical dimensions (~ \e@pdims)
\& Datatype  => $type,     ##\-\- CCS::Nd datatype
\& Creat     => $bool,     ##\-\- create file(s)?
\& Trunc     => $bool,     ##\-\- truncate file(s)?
.Ve
.PP
CCS::Nd options in \f(CW%opts:\fR
.PP
.Vb 5
\& flags     => $flags,    ##\-\- CCS::Nd flags
\& nnz       => $nnz,      ##\-\- CCS::Nd nnz
\& pdims     => \e@pdims,   ##\-\- CCS::Nd physical dimensions
\& vdims     => \e@vdims,   ##\-\- CCS::Nd virtual dimensions
\& sorted    => $bool,     ##\-\- is data on disk sorted? (default=1)
.Ve
.PP
Component options in \f(CW%opts\fR, for ${c} in qw(ix nz):
.PP
.Vb 3
\& "${c}${opt}" => $cValue,   ##\-\- override global option ${opt}
\& "${c}File"   => $cFile,    ##\-\- default="$fname.${c}"
\& "${c}Header" => $cHeader,  ##\-\- default="$cFile.hdr"
.Ve
.SH ACKNOWLEDGEMENTS
.IX Header "ACKNOWLEDGEMENTS"
Perl by Larry Wall.
.PP
PDL by Karl Glazebrook, Tuomas J. Lukka, Christian Soeller, and others.
.SH AUTHOR
.IX Header "AUTHOR"
Bryan Jurish <moocow@cpan.org>
.SS "Copyright Policy"
.IX Subsection "Copyright Policy"
Copyright (C) 2015\-2024, 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"
perl,
PDL,
PDL::CCS::Nd,
PDL::CCS::IO::FITS,
PDL::CCS::IO::MatrixMarket,
PDL::CCS::IO::LDAC,
\&...