.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH ZFP "1" "August 2022" "zfp version 1.0.0 (August 1, 2022)" "User Commands"
.SH NAME
zfp \- compress or expand files using the zfp algorithm
.SH SYNOPSIS
.B zfp
\fI\,<options>\/\fR
.SH DESCRIPTION
zfp version 1.0.0 (August 1, 2022)
.SS "General options:"
.HP
\fB\-h\fR : read/write array and compression parameters from/to compressed header
.HP
\fB\-q\fR : quiet mode; suppress output
.HP
\fB\-s\fR : print error statistics
.SS "Input and output:"
.HP
\fB\-i\fR <path> : uncompressed binary input file ("\-" for stdin)
.HP
\fB\-o\fR <path> : decompressed binary output file ("\-" for stdout)
.HP
\fB\-z\fR <path> : compressed input (w/o \fB\-i\fR) or output file ("\-" for stdin/stdout)
.SS "Array type and dimensions (needed with -i):"
.HP
\fB\-f\fR : single precision (float type)
.HP
\fB\-d\fR : double precision (double type)
.HP
\fB\-t\fR <i32|i64|f32|f64> : integer or floating scalar type
.HP
\fB\-1\fR <nx> : dimensions for 1D array a[nx]
.HP
\fB\-2\fR <nx> <ny> : dimensions for 2D array a[ny][nx]
.HP
\fB\-3\fR <nx> <ny> <nz> : dimensions for 3D array a[nz][ny][nx]
.HP
\fB\-4\fR <nx> <ny> <nz> <nw> : dimensions for 4D array a[nw][nz][ny][nx]
.SS "Compression parameters (needed with -i):"
.HP
\fB\-R\fR : reversible (lossless) compression
.HP
\fB\-r\fR <rate> : fixed rate (# compressed bits per floating\-point value)
.HP
\fB\-p\fR <precision> : fixed precision (# uncompressed bits per value)
.HP
\fB\-a\fR <tolerance> : fixed accuracy (absolute error tolerance)
.HP
\fB\-c\fR <minbits> <maxbits> <maxprec> <minexp> : advanced usage
.IP
minbits : min # bits per 4^d values in d dimensions
maxbits : max # bits per 4^d values in d dimensions (0 for unlimited)
maxprec : max # bits of precision per value (0 for full)
minexp : min bit plane # coded (\fB\-1074\fR for all bit planes)
.SS "Execution parameters:"
.HP
\fB\-x\fR serial : serial compression (default)
.HP
\fB\-x\fR omp[=threads[,chunk_size]] : OpenMP parallel compression
.HP
\fB\-x\fR cuda : CUDA fixed rate parallel compression/decompression
.SH EXAMPLES
.HP
\-i file : read uncompressed file and compress to memory
.HP
\-z file : read compressed file and decompress to memory
.HP
\-i ifile \-z zfile : read uncompressed ifile, write compressed zfile
.HP
\-z zfile \-o ofile : read compressed zfile, write decompressed ofile
.HP
\-i ifile \-o ofile : read ifile, compress, decompress, write ofile
.HP
\-i file \-s : read uncompressed file, compress to memory, print stats
.HP
\-i \- \-o \- \-s : read stdin, compress, decompress, write stdout, print stats
.HP
\-f \-3 100 100 100 \-r 16 : 2x fixed\-rate compression of 100x100x100 floats
.HP
\-d \-1 1000000 \-r 32 : 2x fixed\-rate compression of 1M doubles
.HP
\-d \-2 1000 1000 \-p 32 : 32\-bit precision compression of 1000x1000 doubles
.HP
\-d \-1 1000000 \-a 1e\-9 : compression of 1M doubles with < 1e\-9 max error
.HP
\-d \-1 1000000 \-c 64 64 0 \-1074 : 4x fixed\-rate compression of 1M doubles
.HP
\-x omp=16,256 : parallel compression with 16 threads, 256\-block chunks
.PP
Usage: zfp <options>
General options:
.HP
\-h : read/write array and compression parameters from/to compressed header
.HP
\-q : quiet mode; suppress output
.HP
\-s : print error statistics
.SS "Input and output:"
.HP
\-i <path> : uncompressed binary input file ("\-" for stdin)
.HP
\-o <path> : decompressed binary output file ("\-" for stdout)
.HP
\-z <path> : compressed input (w/o \-i) or output file ("\-" for stdin/stdout)
.SS "Array type and dimensions (needed with -i):"
.HP
\-f : single precision (float type)
.HP
\-d : double precision (double type)
.HP
\-t <i32|i64|f32|f64> : integer or floating scalar type
.HP
\-1 <nx> : dimensions for 1D array a[nx]
.HP
\-2 <nx> <ny> : dimensions for 2D array a[ny][nx]
.HP
\-3 <nx> <ny> <nz> : dimensions for 3D array a[nz][ny][nx]
.HP
\-4 <nx> <ny> <nz> <nw> : dimensions for 4D array a[nw][nz][ny][nx]
.SS "Compression parameters (needed with -i):"
.HP
\-R : reversible (lossless) compression
.HP
\-r <rate> : fixed rate (# compressed bits per floating\-point value)
.HP
\-p <precision> : fixed precision (# uncompressed bits per value)
.HP
\-a <tolerance> : fixed accuracy (absolute error tolerance)
.HP
\-c <minbits> <maxbits> <maxprec> <minexp> : advanced usage
.IP
minbits : min # bits per 4^d values in d dimensions
maxbits : max # bits per 4^d values in d dimensions (0 for unlimited)
maxprec : max # bits of precision per value (0 for full)
minexp : min bit plane # coded (\-1074 for all bit planes)
.SS "Execution parameters:"
.HP
\-x serial : serial compression (default)
.HP
\-x omp[=threads[,chunk_size]] : OpenMP parallel compression
.HP
\-x cuda : CUDA fixed rate parallel compression/decompression
.HP
\-i file : read uncompressed file and compress to memory
.HP
\-z file : read compressed file and decompress to memory
.HP
\-i ifile \-z zfile : read uncompressed ifile, write compressed zfile
.HP
\-z zfile \-o ofile : read compressed zfile, write decompressed ofile
.HP
\-i ifile \-o ofile : read ifile, compress, decompress, write ofile
.HP
\-i file \-s : read uncompressed file, compress to memory, print stats
.HP
\-i \- \-o \- \-s : read stdin, compress, decompress, write stdout, print stats
.HP
\-f \-3 100 100 100 \-r 16 : 2x fixed\-rate compression of 100x100x100 floats
.HP
\-d \-1 1000000 \-r 32 : 2x fixed\-rate compression of 1M doubles
.HP
\-d \-2 1000 1000 \-p 32 : 32\-bit precision compression of 1000x1000 doubles
.HP
\-d \-1 1000000 \-a 1e\-9 : compression of 1M doubles with < 1e\-9 max error
.HP
\-d \-1 1000000 \-c 64 64 0 \-1074 : 4x fixed\-rate compression of 1M doubles
.HP
\-x omp=16,256 : parallel compression with 16 threads, 256\-block chunks