source: Roms_tools/mexcdf/mexnc/tests/test_put_get_var_double.m @ 1

function test_put_get_var_double ( ncfile )
% TEST_GET_PUT_VAR_DOUBLE
%
% Tests expected to succeed.
% Test 001:  write to a singleton value, read them back using [put/get]_var_double
% Test 002:  write to a singleton value, read them back using [put/get]_var1_double
% Test 003:  write to an entire value, read them back using [put/get]_var_double
% Test 004:  write to an single value, read them back using [put/get]_var1_double
% Test 005:  write to an single value, read them back using [put/get]_vara_double
% Test 006:  write to an single value, read them back using [put/get]_vars_double
% Test 007:  write to an single value, read them back using [put/get]_varm_double
%
%     [PUT,GET]_VAR_DOUBLE: Write a 6x4 array of monotonically increasing values, read them back.
%     [PUT,GET]_VAR1_DOUBLE:  write and read 255 to disk
%     [PUT,GET]_VARA_DOUBLE:  write and read a 3x3 chunk
%     [PUT,GET]_VARS_DOUBLE:  write and read the 6x4 array, subset by factor of 2, stride of 2
%     [PUT,GET]_VARM_DOUBLE:  normally we want to transpose the data before writing with
%                             mexnc.  However, this is makes for a good test of the VARM_XXX
%                             routine, as that routine can actually handle the transpose for us.
%                             So this test writes the same array of data as [put,get]_var_xxx,
%                             but we don't bother to transpose the array.  Yes, these routines
%                             really are that hard to wrap one's head around.
%

if ( nargin == 0 )
        ncfile = 'foo.nc';
end

create_test_ncfile ( ncfile );

test_001 ( ncfile );
test_002 ( ncfile );
test_003 ( ncfile );
test_004 ( ncfile );
test_005 ( ncfile );
test_006 ( ncfile );
test_007 ( ncfile );



function test_003 ( ncfile )

[ncid, status] = mexnc ( 'open', ncfile, nc_write_mode );
if ( status ~= 0 )
        msg = sprintf ( '%s:  %s\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end


[y_dimid,status] = mexnc ( 'inq_dimid', ncid, 'y' );
if status, error ( mexnc ( 'strerror', status ) ), end

[len_y,status] = mexnc ( 'inq_dimlen', ncid, y_dimid );
if status, error ( mexnc ( 'strerror', status ) ), end

[x_dimid,status] = mexnc ( 'inq_dimid', ncid, 'x' );
if status, error ( mexnc ( 'strerror', status ) ), end

[len_x,status] = mexnc ( 'inq_dimlen', ncid, x_dimid );
if status, error ( mexnc ( 'strerror', status ) ), end


[varid, status] = mexnc('INQ_VARID', ncid, 'z_double');
if ( status ~= 0 )
        msg = sprintf ( '%s:  INQ_VARID failed\n', mfilename );
        error ( msg );
end

[varname,xtype,ndims,dimids,natts,status] = mexnc('INQ_VAR',ncid,varid);
for j = 1:ndims
        dimlen(j) = mexnc('INQ_DIMLEN',ncid,dimids(j));
end




input_data = [1:1:prod(dimlen)];
input_data = reshape ( input_data, dimlen(1), dimlen(2) );

status = mexnc ( 'PUT_VAR_DOUBLE', ncid, varid, input_data' );
if ( status ~= 0 )
        ncerr_msg = mexnc ( 'strerror', status );
        msg = sprintf ( '%s:  PUT_VAR_DOUBLE failed, (%s)\n', mfilename, ncerr_msg );
        error ( msg );
end


[output_data, status] = mexnc ( 'GET_VAR_DOUBLE', ncid, varid );
if ( status ~= 0 )
        msg = sprintf ( '%s:  GET_VAR_DOUBLE failed, msg ''%s''\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end


d = max(abs(output_data-input_data'))';
if (any(d))
        msg = sprintf ( '%s:  values written by PUT_VAR_DOUBLE do not match what was retrieved by GET_VAR_DOUBLE\n', mfilename  );
        error ( msg );
end

fprintf ( 1, 'PUT_VAR_DOUBLE succeeded\n' );
fprintf ( 1, 'GET_VAR_DOUBLE succeeded\n' );

status = mexnc ( 'close', ncid );
if ( status ~= 0 )
        error ( 'CLOSE failed' );
end

return






function test_004 ( ncfile )


[ncid, status] = mexnc ( 'open', ncfile, nc_write_mode );
if ( status ~= 0 )
        msg = sprintf ( '%s:  %s\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end


[y_dimid,status] = mexnc ( 'inq_dimid', ncid, 'y' );
if status, error ( mexnc ( 'strerror', status ) ), end

[len_y,status] = mexnc ( 'inq_dimlen', ncid, y_dimid );
if status, error ( mexnc ( 'strerror', status ) ), end

[x_dimid,status] = mexnc ( 'inq_dimid', ncid, 'x' );
if status, error ( mexnc ( 'strerror', status ) ), end

[len_x,status] = mexnc ( 'inq_dimlen', ncid, x_dimid );
if status, error ( mexnc ( 'strerror', status ) ), end


[varid, status] = mexnc('INQ_VARID', ncid, 'z_double');
if ( status ~= 0 )
        msg = sprintf ( '%s:  INQ_VARID failed\n', mfilename );
        error ( msg );
end


%
% Test PUT/GET_VAR1
input_data = 255;
status = mexnc ( 'PUT_VAR1_DOUBLE', ncid, varid, [2 2], input_data );
if ( status < 0 )
        msg = sprintf ( '%s:  PUT_VAR1_DOUBLE failed\n', mfilename );
        error ( msg );
end


status = mexnc ( 'SYNC', ncid );
if ( status < 0 )
        msg = sprintf ( '%s:  SYNC failed, msg ''%s''\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end


[output_data, status] = mexnc ( 'GET_VAR1_DOUBLE', ncid, varid, [2 2] );
if ( status < 0 )
        msg = sprintf ( '%s:  GET_VAR1_DOUBLE failed, msg ''%s''\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end

d = max(abs(double(output_data)-double(input_data)));
if (d > 0)
        msg = sprintf ( '%s:  values written by PUT_VAR1_DOUBLE do not match what was retrieved by GET_VAR_DOUBLE\n', mfilename  );
        error ( msg );
end

status = mexnc ( 'close', ncid );
if ( status ~= 0 )
        error ( 'CLOSE failed' );
end

fprintf ( 1, 'PUT_VAR1_DOUBLE succeeded\n' );
fprintf ( 1, 'GET_VAR1_DOUBLE succeeded\n' );
return










function test_005 ( ncfile )

[ncid, status] = mexnc ( 'open', ncfile, nc_write_mode );
if ( status ~= 0 )
        msg = sprintf ( '%s:  %s\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end


[y_dimid,status] = mexnc ( 'inq_dimid', ncid, 'y' );
if status, error ( mexnc ( 'strerror', status ) ), end

[len_y,status] = mexnc ( 'inq_dimlen', ncid, y_dimid );
if status, error ( mexnc ( 'strerror', status ) ), end

[x_dimid,status] = mexnc ( 'inq_dimid', ncid, 'x' );
if status, error ( mexnc ( 'strerror', status ) ), end

[len_x,status] = mexnc ( 'inq_dimlen', ncid, x_dimid );
if status, error ( mexnc ( 'strerror', status ) ), end


[varid, status] = mexnc('INQ_VARID', ncid, 'z_double');
if ( status ~= 0 )
        msg = sprintf ( '%s:  INQ_VARID failed\n', mfilename );
        error ( msg );
end

[varname,xtype,ndims,dimids,natts,status] = mexnc('INQ_VAR',ncid,varid);
for j = 1:ndims
        dimlen(j) = mexnc('INQ_DIMLEN',ncid,dimids(j));
end




input_data = [1:1:prod(dimlen)];
input_data = reshape ( input_data, dimlen(1), dimlen(2) );

input_data = input_data(2:4,1:3);
input_data = input_data';
start = [1 0]; count = [3 3];


status = mexnc ( 'PUT_VARA_DOUBLE', ncid, varid, start, count, input_data );
if ( status < 0 )
        msg = sprintf ( '%s:  PUT_VARA_DOUBLE failed\n', mfilename );
        error ( msg );
end


status = mexnc ( 'SYNC', ncid );
if ( status < 0 )
        msg = sprintf ( '%s:  SYNC failed, msg ''%s''\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end


[output_data, status] = mexnc ('GET_VARA_DOUBLE',ncid,varid,start,count);
if ( status < 0 )
        msg = sprintf ( '%s:  GET_VARA_DOUBLE failed, msg ''%s''\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end

d = max(abs(output_data-input_data))';
if (any(d))
        msg = sprintf ( '%s:  values written by PUT_VARA_DOUBLE do not match what was retrieved by GET_VARA_DOUBLE\n', mfilename  );
        error ( msg );
end

status = mexnc ( 'close', ncid );
if ( status ~= 0 )
        error ( 'CLOSE failed' );
end

fprintf ( 1, 'PUT_VARA_DOUBLE succeeded\n' );
fprintf ( 1, 'GET_VARA_DOUBLE succeeded\n' );

return









function test_006 ( ncfile )

[ncid, status] = mexnc ( 'open', ncfile, nc_write_mode );
if ( status ~= 0 )
        msg = sprintf ( '%s:  %s\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end

[varid, status] = mexnc('INQ_VARID', ncid, 'z_double');
if ( status ~= 0 )
        msg = sprintf ( '%s:  INQ_VARID failed\n', mfilename );
        error ( msg );
end

[varname,xtype,ndims,dimids,natts,status] = mexnc('INQ_VAR',ncid,varid);
for j = 1:ndims
        dimlen(j) = mexnc('INQ_DIMLEN',ncid,dimids(j));
end




input_data = [1:1:prod(dimlen)];
input_data = reshape ( input_data, dimlen(1), dimlen(2) );
input_data = input_data(1:2:end,1:2:end);
[r,c] = size(input_data);

status = mexnc ( 'PUT_VARS_DOUBLE', ncid, varid, [0 0], [r c], [2 2], input_data' );
if ( status < 0 )
        msg = sprintf ( '%s:  PUT_VARS_DOUBLE failed\n', mfilename );
        error ( msg );
end


status = mexnc ( 'SYNC', ncid );
if ( status < 0 )
        msg = sprintf ( '%s:  SYNC failed, msg ''%s''\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end


[output_data, status] = mexnc ( 'GET_VARS_DOUBLE', ncid, varid, [0 0], [r c], [2 2] );
if ( status < 0 )
        msg = sprintf ( '%s:  GET_VARS_DOUBLE failed, msg ''%s''\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end


d = max(abs(output_data-input_data'))';
if (any(d))
        msg = sprintf ( '%s:  values written by PUT_VARS_DOUBLE do not match what was retrieved by GET_VARS_DOUBLE\n', mfilename  );
        error ( msg );
end

fprintf ( 1, 'PUT_VARS_DOUBLE succeeded\n' );
fprintf ( 1, 'GET_VARS_DOUBLE succeeded\n' );

status = mexnc ( 'close', ncid );
if ( status ~= 0 )
        error ( 'CLOSE failed' );
end

return









function test_007 ( ncfile )

if mexnc_use_tmw
        warning('GET_VARM and PUT_VARM operations are not supported in the netCDF package');
        return
end

[ncid, status] = mexnc ( 'open', ncfile, nc_write_mode );
if ( status ~= 0 )
        msg = sprintf ( '%s:  %s\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end


[y_dimid,status] = mexnc ( 'inq_dimid', ncid, 'y' );
if status, error ( mexnc ( 'strerror', status ) ), end

[len_y,status] = mexnc ( 'inq_dimlen', ncid, y_dimid );
if status, error ( mexnc ( 'strerror', status ) ), end

[x_dimid,status] = mexnc ( 'inq_dimid', ncid, 'x' );
if status, error ( mexnc ( 'strerror', status ) ), end

[len_x,status] = mexnc ( 'inq_dimlen', ncid, x_dimid );
if status, error ( mexnc ( 'strerror', status ) ), end


[varid, status] = mexnc('INQ_VARID', ncid, 'z_double');
if ( status ~= 0 )
        msg = sprintf ( '%s:  INQ_VARID failed\n', mfilename );
        error ( msg );
end



%
% Test PUT/GET_VARM
input_data = [1:1:len_y*len_x];
input_data = reshape ( input_data, len_y, len_x );

start_coord = [0 0];
count_coord = [6 4];
stride_coord = [1 1];

%
% This is the tricky part.  When the matrix arrives in the mex file, it
% arrives essentially transposed, as a 4x6 array, monotonically increasing
% across the columns instead of rows.  But in the netcdf file, we want the
% dataset to increase monotonically by rows.  This is an inter-element
% distance of 1 for the rows.  So the first column should consist of 
% [1 2 3 4 5 6], and the 2nd row starts at 7.  That inter-element distance
% is then 6.  In the imap vector, you start with the slowest varying FILE
% dimension and proceed out to the most rapidly varying.  This means imap
% should be 6 and then 1.
%
%     NetCDF dimension         inter-element distance
%     most rapidly varying     6
%     most slowly varying      1
%
imap_coord = [1 6];

%
% Write without transposing first.
status = mexnc ( 'put_varm_double', ncid, varid, start_coord, count_coord, stride_coord, imap_coord, input_data );
if ( status ~= 0 )
        ncerr_msg = mexnc ( 'strerror', status );
        msg = sprintf ( '%s:  ''put_varm_double'' failed on var rh, file %s, error message '' %s ''\n', mfilename, ncfile, ncerr_msg );
        error ( msg );
end

status = mexnc ( 'sync', ncid );
if ( status ~= 0 )
        ncerr_msg = mexnc ( 'strerror', status );
        msg = sprintf ( '%s:  ''sync'' failed on file %s, error message '' %s ''\n', mfilename, ncfile, ncerr_msg );
        error ( msg );
end


%
% Now read it back.
%
% This is the tricky part.  When the matrix arrives from the mexfile,
% one has to remember that it arrives transposed.  So what we want is
% to choose imap so that it yields the transpose of what we really want.
% Then we get the transpose of a transpose, which would be the data arranged
% in rows and columns in matlab exactly as it is in the netcdf file.
%
% The NetCDF file has the data stored as
% 
%    |  1  7 13 19 |
%    |  2  8 14 20 |
%    |  3  9 15 21 |
%    |  4 10 16 22 |
%    |  5 11 17 23 |
%    |  6 12 18 24 |
%
% The transpose of what we want would be
%
%    |  1  2  3  4  5  6 |
%    |  7  8  9 10 11 12 |
%    | 13 14 15 16 17 18 |
%    | 19 20 21 22 23 24 |
%
% Start with the end of imap, which is the most rapidly varying NetCDF
% dimension.  That's the column.  In the internal array (that's the 2nd
% array above), how far between elements?  In the NetCDF file file, 1 and 7
% are next to each other across the row, but in the internal array (which
% is still inside the mex file and therefore in C, so row major order)
% they have a distance of 6.  The first element of imap corresponds to
% the slowest varying NetCDF dimension, the rows.  In the internal array,
% how far between row elements?  In the NetCDF file, 1 and 2 are next to
% each other across rows, but in the internal array, they have a distance
% of 1 across columns.  So imap is the same as above, [1 6].
[output_data,status] = mexnc ( 'get_varm_double', ncid, varid, start_coord, count_coord, stride_coord, imap_coord );
if ( status ~= 0 )
        ncerr_msg = mexnc ( 'strerror', status );
        msg = sprintf ( '%s:  ''get_varm_double'' failed on var rh, file %s, error message '' %s ''\n', mfilename, ncfile, ncerr_msg );
        error ( msg );
end

d = max(abs(output_data-input_data))';
if (any(d))
        msg = sprintf ( '%s:  values written by PUT_VARM_DOUBLE do not match what was retrieved by GET_VARM_DOUBLE\n', mfilename  );
        error ( msg );
end



fprintf ( 1, 'PUT_VARM_DOUBLE succeeded\n' );
fprintf ( 1, 'GET_VARM_DOUBLE succeeded\n' );



%
% CLOSE
status = mexnc ( 'close', ncid );
if ( status ~= 0 )
        error ( 'CLOSE failed' );
end


return






function test_001 ( ncfile )

[ncid, status] = mexnc ( 'open', ncfile, nc_write_mode );
if ( status ~= 0 )
        msg = sprintf ( '%s:  %s\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end

fprintf ( 1, 'a\n' );

%
% Test 1: singleton
[varid, status] = mexnc('INQ_VARID', ncid, 'double_singleton');
if ( status ~= 0 )
        msg = sprintf ( '%s:  INQ_VARID failed\n', mfilename );
        error ( msg );
end

fprintf ( 1, 'b\n' );

input_data = 3.14;
status = mexnc ( 'PUT_VAR_DOUBLE', ncid, varid, input_data );
if status
        error ( mexnc('strerror',status) );
end

fprintf ( 1, 'c\n' );

[output_data, status] = mexnc ( 'GET_VAR_DOUBLE', ncid, varid );
if status
        error ( mexnc('strerror',status) );
end

fprintf ( 1, 'd\n' );

d = max(abs(output_data-input_data))';
if (any(d))
        msg = sprintf ( '%s:  values written by PUT_VAR_DOUBLE do not match what was retrieved by GET_VAR_DOUBLE\n', mfilename  );
        error ( msg );
end

fprintf ( 1, 'GET_VAR_DOUBLE succeeded on a singleton\n' );
fprintf ( 1, 'PUT_VAR_DOUBLE succeeded on a singleton\n' );

status = mexnc ( 'close', ncid );
if status, error ( mexnc('strerror',status) ), end

return






function test_002 ( ncfile )

[ncid, status] = mexnc ( 'open', ncfile, nc_write_mode );
if ( status ~= 0 )
        msg = sprintf ( '%s:  %s\n', mfilename, mexnc ( 'strerror', status ) );
        error ( msg );
end


%
% Test 1: singleton
[varid, status] = mexnc('INQ_VARID', ncid, 'double_singleton');
if ( status ~= 0 )
        msg = sprintf ( '%s:  INQ_VARID failed\n', mfilename );
        error ( msg );
end

input_data = 3.14;
status = mexnc ( 'PUT_VAR1_DOUBLE', ncid, varid, 0, input_data );
if status
        error ( mexnc('strerror',status) );
end

[output_data, status] = mexnc ( 'GET_VAR1_DOUBLE', ncid, varid, 0 );
if status
        error ( mexnc('strerror',status) );
end

d = max(abs(output_data-input_data))';
if (any(d))
        msg = sprintf ( '%s:  values written by PUT_VAR1_DOUBLE do not match what was retrieved by GET_VAR1_DOUBLE\n', mfilename  );
        error ( msg );
end


fprintf ( 1, 'GET_VAR1_DOUBLE succeeded on a singleton\n' );
fprintf ( 1, 'PUT_VAR1_DOUBLE succeeded on a singleton\n' );

status = mexnc ( 'close', ncid );
if status, error ( mexnc('strerror',status) ), end

return