Crate numpress_rs

Crate numpress_rs 

Source
Expand description

Numpress utility.

A pure rust implementation of ms-numpress, a fast, minimally lossy compression algorithm for mass spectrometry data.

§Additional Information

The API makes extensive use of unsafe Rust features, and therefore cannot guarantee low-level memory safety. Use at your own risk.

Modules§

low_level

Structs§

Error
Custom error for Numpress compression.

Enums§

ErrorKind
Type of error encountered during compression or decompression.

Constants§

DEFAULT_SCALING
Default scaling factor for compression.

Traits§

AsFloat64

Functions§

decode_linear
The decoder for Numpress linear encoding compression, e.g. encode_linear
decode_pic
The decoder for Numpress positive integer encoding compression, e.g. encode_pic
decode_slof
The decoder for Numpress short logged float encoding compression, e.g. encode_slof
encode_linear
High-level compressor for Numpress linear encoding.
encode_pic
High-level compressor for Numpress positive integer encoding.
encode_slof
High-level compressor for Numpress short logged float encoding.
numpress_compress
High-level compressor for Numpress.
numpress_decompress
High-level decompressor for Numpress.
optimal_scaling
Calculate the optimal, most-compressed scaling factor for linear encoding compression.
optimal_slof_fixed_point
Calculate the optimal, most-compressed scaling factor for short logged float (Slof) encoding compression.

Type Aliases§

Result
Specialized result for Numpress operations.