The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

 / 
PDL-CCS-1.24.1
River stage one • 1 direct dependent • 3 total dependents
/ PDL::CCS::IO::FastRaw

NAME

PDL::CCS::IO::FastRaw - PDL::IO::FastRaw wrappers for PDL::CCS::Nd

SYNOPSIS


            

              
              
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't read yet

I/O Utilities

ccs_writefraw

Write a pair of raw binary files using PDL::IO::FastRaw::writefraw().


            

              
              
ccs_writefraw($ccs,$fname)
ccs_writefraw($ccs,$fname,\%opts)

Options %opts:


            

              
              
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"

ccs_readfraw

Read a pair of raw binary files using PDL::IO::FastRaw::readfraw().


            

              
              
$ccs = ccs_readfraw($fname)
$ccs = ccs_readfraw($fname,\%opts)

Options %opts:


            

              
              
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)

ccs_mapfraw

Read a pair of raw binary files using PDL::IO::FastRaw::readfraw().


            

              
              
$ccs = ccs_mapfraw($fname)
$ccs = ccs_mapfraw($fname,\%opts)

Global options in %opts:


            

              
              
Header    => $Header,   ##-- default="$fname.hdr"
ReadOnly  => $bool,     ##-- read-only mode?
Dims      => \@dims,    ##-- logical dimensions (~ \@pdims)
Datatype  => $type,     ##-- CCS::Nd datatype
Creat     => $bool,     ##-- create file(s)?
Trunc     => $bool,     ##-- truncate file(s)?

CCS::Nd options in %opts:


            

              
              
flags     => $flags,    ##-- CCS::Nd flags
nnz       => $nnz,      ##-- CCS::Nd nnz
pdims     => \@pdims,   ##-- CCS::Nd physical dimensions
vdims     => \@vdims,   ##-- CCS::Nd virtual dimensions
sorted    => $bool,     ##-- is data on disk sorted? (default=1)

Component options in %opts, for ${c} in qw(ix nz):


            

              
              
"${c}${opt}" => $cValue,   ##-- override global option ${opt}
"${c}File"   => $cFile,    ##-- default="$fname.${c}"
"${c}Header" => $cHeader,  ##-- default="$cFile.hdr"

ACKNOWLEDGEMENTS

Perl by Larry Wall.

PDL by Karl Glazebrook, Tuomas J. Lukka, Christian Soeller, and others.

AUTHOR

Bryan Jurish <moocow@cpan.org>

Copyright (C) 2015-2024, Bryan Jurish. All rights reserved.

This package is free software, and entirely without warranty. You may redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

perl, PDL, PDL::CCS::Nd, PDL::CCS::IO::FITS, PDL::CCS::IO::MatrixMarket, PDL::CCS::IO::LDAC, ...