Merge pull request #11 from FastNFT/release-0.1

Release 0.1.1

Author: wahls

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+
+
+## [0.1.1] -- 2018-05-14
+
+### Added
+
+- Mex files now compile also with Matlab R2018a
+
+### Changed
+
+- Fixed: Several potential memory violations in fnft_nsev, poly_chirpz and nsev_testcases
+- Fixed: Some return codes in fnft_nsep had not been checked
+- Fixed: misc_merge did not work correctly for empty input vectors
+- Fixed: The continuous spectrum in mex_fnft_nsev_example.m was plotted over t, not xi
+- Fixed: A superfluous parameter kappa was given in the documentation of mex_fnft_kdvv

CMakeLists.txt

@@ -3,7 +3,7 @@ project(fnft C)
 
 set(FNFT_VERSION_MAJOR 0)
 set(FNFT_VERSION_MINOR 1)
-set(FNFT_VERSION_PATCH 0)
+set(FNFT_VERSION_PATCH 1)
 
 include(CheckIncludeFiles)
 include(CheckFunctionExists)
@@ -151,7 +151,9 @@ if (WITH_MATLAB)
 		foreach (srcfile ${MEX_SOURCES})
 			get_filename_component(mexfile ${srcfile} NAME_WE)
 			matlab_add_mex(NAME ${mexfile} SRC ${srcfile} LINK_TO fnft ${LIBM})
-			set_target_properties(${mexfile} PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/matlab")
+            set_target_properties(${mexfile} PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/matlab")
+            target_compile_options(${mexfile} PRIVATE -DMEX_DOUBLE_HANDLE)
+            # -DMEX_DOUBLE_HANDLE avoids the new complex interleaved API
 		endforeach()
 	endif()
 endif()

examples/mex_fnft_nsev_example.m

@@ -54,7 +54,7 @@
 legend('Real part', 'Imaginary part');
 
 figure;
-plot(t, real(contspec), t, imag(contspec));
+plot(xi, real(contspec), xi, imag(contspec));
 title('Continuous spectrum');
 xlabel('\xi');
 ylabel('r(\xi)');

matlab/mex_fnft_kdvv.m

@@ -1,7 +1,7 @@
 % MEX_FNFT_KDVV Fast nonlinear Fourier transform for the Korteweg-de Vries
 % equation with vanishing boundaries.
 %
-%   contspec = MEX_FNFT_KDVV(q, T, XI, kappa)
+%   contspec = MEX_FNFT_KDVV(q, T, XI)
 %
 % DESCRIPTION
 %   Provides an interface to the C routine fnft_kdvv.

matlab/mex_fnft_nsep.c

@@ -75,7 +75,7 @@ void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
     fnft_errwarn_setprintf(mexPrintf);
 
     /* Check remaining inputs, if any */
-    for (k=3; k<nrhs; i++) {
+    for (k=3; k<nrhs; k++) {
 
         /* Check if current input is a string as desired and convert it */
         if ( !mxIsChar(prhs[k]) ) {

src/fnft_nsep.c

@@ -337,6 +337,7 @@ static inline INT gridsearch(const UINT D,
         M = oversampling_factor*deg;
         ret_code = poly_roots_fftgridsearch(deg, transfer_matrix+(deg+1), &M,
             PHI, roots);
+        CHECK_RETCODE(ret_code, release_mem);
 
         // Coordinate transform (from discrete-time to continuous-time domain)
         for (i=0; i<M; i++)
@@ -476,6 +477,7 @@ static inline INT subsample_and_refine(const UINT D,
         // Refine the remaining roots
         ret_code = refine_mainspec(D, q, eps_t, K, roots,
             opts_ptr->max_evals, +2.0, kappa);
+        CHECK_RETCODE(ret_code, release_mem);
 
         // Filter the refined roots
         if (opts_ptr->filtering != fnft_nsep_filt_NONE) {
@@ -574,7 +576,8 @@ static inline INT subsample_and_refine(const UINT D,
         // Refine the roots
         ret_code = refine_auxspec(D, q, eps_t, M, roots,
             opts_ptr->max_evals, kappa);
-
+        CHECK_RETCODE(ret_code, release_mem);
+ 
         // Filter the refined roots
         if (opts_ptr->filtering != fnft_nsep_filt_NONE) {
             ret_code = misc_filter(&M, roots, NULL, opts_ptr->bounding_box);

src/fnft_nsev.c

@@ -267,6 +267,8 @@ static inline INT tf2contspec(
 
     // We reuse an unused part of the transfer matrix as buffer
     a_vals = transfer_matrix + (deg+1);
+    if (M > deg+1)
+        return E_NOT_YET_IMPLEMENTED(M >> D, "Any M<=2*D should work. It is planned to remove this restriction in the next release.");
 
     // Set step sizes
     eps_t = (T[1] - T[0])/(D - 1);
@@ -423,7 +425,7 @@ static inline INT tf2boundstates(
         case nsev_bsloc_FAST_EIGENVALUE:
 
             K = deg;
-            if (*K_ptr <= K) {
+            if (*K_ptr >= K) {
                 buffer = bound_states;
             } else {
                 // Store intermediate results in unused part of transfer matrix.

src/private/fnft__misc.c

@@ -227,7 +227,9 @@ INT misc_merge(UINT *N_ptr, COMPLEX * const vals, REAL tol)
     UINT i, j, N, N_filtered;
 
     if (N_ptr == NULL)
-        return E_INVALID_ARGUMENT(N_ptr)
+        return E_INVALID_ARGUMENT(N_ptr);
+    if (*N_ptr == 0)
+        return SUCCESS;
     if (vals == NULL)
         return E_INVALID_ARGUMENT(vals);
     if (tol < 0.0)

src/private/fnft__nsev_testcases.c

@@ -381,7 +381,7 @@ INT nsev_testcases(nsev_testcases_t tc, const UINT D,
 release_mem_4:
     free(*bound_states_ptr);
 release_mem_3:
-    free(ab_ptr);
+    free(*ab_ptr);
 release_mem_2:
     free(*contspec_ptr);
 release_mem_1:

src/private/fnft__poly_chirpz.c

@@ -56,7 +56,7 @@ INT poly_chirpz(const UINT deg, COMPLEX const * const p, \
     Y = malloc(L * sizeof(kiss_fft_cpx));
     V = malloc(L * sizeof(kiss_fft_cpx));
     buf = malloc(L * sizeof(kiss_fft_cpx));
-    if (cfg == NULL && Y == NULL && V == NULL && buf == NULL) {
+    if (cfg == NULL || Y == NULL || V == NULL || buf == NULL) {
         ret_code = E_NOMEM;
         goto release_mem;
     }