Skip to content

Commit 93faa01

Browse files
committed
doc
1 parent f4c9aee commit 93faa01

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

+stdlib/h5save.m

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@
99
% * A: data to write
1010
% * opts.size: variable shape -- helps write scalar or vectors especially
1111
% * opts.type: class of variable e.g. int32, float32
12+
%
13+
% The shape of the dataset can be controlled by specifying the "size" argument.
14+
% This is particularly useful when writing HDF5 files to be used in other programming languages where dimensional shapes are important.
15+
% Matlab may collapse singleton dimensions otherwise.
16+
% h5save(filename, dataset_name, dataset, size=[3,1])
17+
%
18+
% Likewise, the type of the dataset may be explicitly specified with the "type" argument.
19+
% h5save(filename, dataset_name, dataset, type="int32")
1220

1321
function h5save(filename, varname, A, opts)
1422
arguments

0 commit comments

Comments
 (0)