Skip to content

Commit

Permalink
update changelog to add lzma support
Browse files Browse the repository at this point in the history
  • Loading branch information
fangq committed Jun 3, 2019
1 parent 73e5a98 commit 14a84a5
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 40 deletions.
11 changes: 10 additions & 1 deletion AUTHORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,19 @@ Address: Dept. of Bioengineering
URL: http://fanglab.org
Email: <q.fang at neu.edu>

ZMAT Website : http://iso2mesh.sf.net/jsonlab
ZMAT Website : https://github.com/fangq/zmat



The base64_{encode,decode} functions in the zmat.cpp functions were copied from
http://web.mit.edu/freebsd/head/contrib/wpa/src/utils/base64.c
http://web.mit.edu/freebsd/head/contrib/wpa/src/utils/base64.h
written by Jouni Malinen <j@w1.fi> licensed under the BSD license


The optional LZMA/LZIP compression support is provided by
the easylzma library written by Lloyd Hilaiel, which was
built on Igor Pavlov's LZMA library (both previous works
were released under the public domain)

https://github.com/lloyd/easylzma
6 changes: 6 additions & 0 deletions ChangeLog.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
= Change Log =

== ZMAT 0.8.0 (Mox-the-fox), FangQ <q.fang (a) neu.edu> ==

2019-05-07 [27a8583] make lzma optional in compilation, use static library
2019-05-06 [3d8de61] support lzma compression via easylzma, close #1


== ZMAT 0.5.0 (Zac-the-rat), FangQ <q.fang (a) neu.edu> ==

2019-05-04 [ ] tag and release v0.5.0
Expand Down
25 changes: 0 additions & 25 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,28 +1,3 @@
===============================================================================
= ZMAT - a portable compression/decompression toobox for MATLAB/Octave =
===============================================================================

Copyright (c) 2019 Qianqian Fang <q.fang at neu.edu>

The base64_{encode,decode} functions in the zmat.cpp functions are copyrighted by
Copyright (c) 2005-2011, Jouni Malinen <j@w1.fi>

-------------------------------------------------------------------------------

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

------------------------------------------------------------------------

GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Expand Down
25 changes: 13 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

* Copyright (C) 2019 Qianqian Fang <q.fang at neu.edu>
* License: GNU General Public License version 3 (GPL v3), see License*.txt
* Version: 0.5 (Zac-the-rat)
* Version: 0.8 (Mox-the-fox)
* Binaries: http://github.com/fangq/zmat_mex
* URL: http://github.com/fangq/zmat

Expand All @@ -19,9 +19,9 @@ Table of Contents
Introduction
============

ZMat is a portable mex function to enable zlib/gzip based data
compression/decompression and base64 encoding/decoding support in
MATLAB and GNU Octave. It is fast and portable, can compress a
ZMat is a portable mex function to enable zlib/gzip/lzma/lzip based
data compression/decompression and base64 encoding/decoding support
in MATLAB and GNU Octave. It is fast and portable, can compress a
large array within a fraction of a second.

ZMat accepts 3 types of inputs: char-based strings, uint8 arrays
Expand Down Expand Up @@ -104,8 +104,8 @@ zmat.m
input:
input: a string, int8 or uint8 array
iscompress: (optional) if iscompress is 1, zmat compresses the input,
if 0, it decompresses the input. Default value is 1.
iscompress: (optional) if iscompress is 1, zmat compresses/encodes the input,
if 0, it decompresses/decodes the input. Default value is 1.
method: (optional) compression method, currently, zmat supports the below methods
'zlib': zlib/zip based data compression (default)
'gzip': gzip formatted data compression
Expand All @@ -122,13 +122,14 @@ zmat.m
example:
[ss, info]=zmat(uint8(eye(5))) % compress an 5x5 identity matrix
orig=zmat(ss,0) % decompress the compressed matrix
orig=reshape(orig, info.size) % restore the original size using info output
ss=char(zmat('zmat test',1,'base64')) % encode a string using base64
orig=char(zmat(ss,0,'base64')) % decode the base64 string
[ss, info]=zmat(uint8(eye(5)))
orig=zmat(ss,0)
orig=reshape(orig, info.size)
ss=char(zmat('zmat test',1,'base64'))
orig=char(zmat(ss,0,'base64'))
-- this function is part of the zmat toolbox (http://github.com/fangq/zmat)
-- this function is part of the ZMAT toolbox (http://github.com/fangq/zmat)
---------
examples
Expand Down
4 changes: 2 additions & 2 deletions zmat.m
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
%
% input:
% input: a string, int8 or uint8 array
% iscompress: (optional) if iscompress is 1, zmat compresses the input,
% if 0, it decompresses the input. Default value is 1.
% iscompress: (optional) if iscompress is 1, zmat compresses/encodes the input,
% if 0, it decompresses/decodes the input. Default value is 1.
% method: (optional) compression method, currently, zmat supports the below methods
% 'zlib': zlib/zip based data compression (default)
% 'gzip': gzip formatted data compression
Expand Down

0 comments on commit 14a84a5

Please sign in to comment.