Mercurial > hg > octave-nkf
view scripts/miscellaneous/bunzip2.m @ 19595:9e5b64b3c1fe
Fix up documentation for new disable_[range,diagonal_matrix,permutation_matrix] fcns.
* NEWS: Announce new functions disable_range, disable_diagonal_matrix,
disable_permutation_matrix.
* diagperm.txi: Add example showing space savings from using
disable_diagonal_matrix.
* ov.cc(Fdisable_range): Correct docstring which had cut-and-paste error
documenting disable_permutation_matrix instead. Add seealso links to
other disable_xxx functions.
* ov.cc(Fdisable_diagonal_matrix, Fdisable_permutation_matrix): Add seealso
links to other disable_xxx functions.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 13 Dec 2014 18:41:03 -0800 |
parents | a4e993343e93 |
children | 4197fc428c7d |
line wrap: on
line source
## Copyright (C) 2006-2013 Bill Denney ## ## This file is part of Octave. ## ## Octave 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. ## ## Octave 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 Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {@var{filelist} =} bunzip2 (@var{bzfile}) ## @deftypefnx {Function File} {@var{filelist} =} bunzip2 (@var{bzfile}, @var{dir}) ## Unpack the bzip2 archive @var{bzfile}. ## ## If @var{dir} is specified the files are unpacked in this directory rather ## than the one where @var{bzfile} is located. ## ## The optional output @var{filelist} is a list of the uncompressed files. ## @seealso{bzip2, unpack, gunzip, unzip, untar} ## @end deftypefn ## Author: Bill Denney <denney@seas.upenn.edu> function filelist = bunzip2 (bzfile, dir = []) if (nargin < 1 || nargin > 2) print_usage (); endif if (isempty (dir)) dir = fileparts (bzfile); endif if (nargout > 0) filelist = unpack (bzfile, dir, "bunzip2"); else unpack (bzfile, dir, "bunzip2"); endif endfunction ## Tests for this m-file are located in bzip2.m ## Remove from test statistics %!assert (1)