Mercurial > octave
changeset 33096:55c8c338aaeb stable
doc: update save and load docstring options for hdf5 formats (bug #42530)
* libinterp/corefcn/load-save.cc (save): Clarify in docstring that octave
does not yet implement -v7.3 saving. Adjust -hdf5 option description line
wrapping.
* libinterp/corefcn/load-save.cc (load): Update docstirng entry for -v7.3 to
clarify that reading of this format is possible. Update -hdf5 option
description to clarify that it can also often work for files saved as v7.3.
author | Nicholas R. Jankowski <jankowski.nicholas@gmail.com> |
---|---|
date | Tue, 27 Feb 2024 16:40:49 -0500 |
parents | dbf49a4f50da |
children | db71211ac17b 71bbf3d89efe |
files | libinterp/corefcn/load-save.cc |
diffstat | 1 files changed, 17 insertions(+), 12 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/load-save.cc Fri Feb 16 18:01:09 2024 +0100 +++ b/libinterp/corefcn/load-save.cc Tue Feb 27 16:40:49 2024 -0500 @@ -1642,12 +1642,13 @@ Force Octave to assume the file is in Octave's binary format. @item -hdf5 -Force Octave to assume the file is in @sc{hdf5} format. -(@sc{hdf5} is a free, portable binary format developed by the National -Center for Supercomputing Applications at the University of Illinois.) -Note that Octave can only read @sc{hdf5} files that were created by itself with -@code{save}. This format is only available if Octave was built with a link to -the @sc{hdf5} libraries. +Force Octave to assume the file is in @sc{hdf5} format. (@sc{hdf5} is a free, +portable binary format developed by the National Center for Supercomputing +Applications at the University of Illinois.) Note that Octave can only +read @sc{hdf5} files that were created by itself with @code{save} or with +@sc{matlab}'s @code{-v7.3} option (which saves in @sc{hdf5} format). This +format is only available if Octave was built with a link to the @sc{hdf5} +libraries. @item -import This option is accepted for backward compatibility but is ignored. @@ -1660,7 +1661,10 @@ @item -v7.3 @itemx -V7.3 @itemx -7.3 -Octave does @strong{not} yet implement @sc{matlab}'s v7.3 binary data format. +Force Octave to assume the file is in @sc{matlab}'s v7.3 binary data format. +As the v7.3 format is an HDF5 based format, those files often can also be +opened with the @qcode{"-hdf5"} option. Note that Octave @strong{can not} +currently save in this format. @item -v7 @itemx -V7 @@ -1754,10 +1758,10 @@ be represented in single precision. @item -hdf5 -Save the data in @sc{hdf5} format. -(HDF5 is a free, portable, binary format developed by the National Center for -Supercomputing Applications at the University of Illinois.) This format is only -available if Octave was built with a link to the @sc{hdf5} libraries. +Save the data in @sc{hdf5} format. (HDF5 is a free, portable, binary format +developed by the National Center for Supercomputing Applications at the +University of Illinois.) This format is only available if Octave was built +with a link to the @sc{hdf5} libraries. @item -float-hdf5 Save the data in @sc{hdf5} format but using only single precision. Use this @@ -1770,7 +1774,8 @@ @item -v7.3 @itemx -V7.3 @itemx -7.3 -Octave does @strong{not} yet implement @sc{matlab}'s v7.3 binary data format. +Octave does @strong{not} yet implement saving in @sc{matlab}'s v7.3 binary +data format. @item -v7 @itemx -V7