Merge pull request #49 from FastNFT/release-0.3

Merge the final changes from release 0.3 back into development

Author: wahls

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.3.0] -- 2020-03-06
+
+### Added
+
+- The routine fnft_nsep for the NFT of the periodic nonlinear Schroedinger equation can now visualize spines (see the new points_per_spine option)
+- The subsampling and refinement processes in fnft_nsep can now be better controlled using the new Dsub and max_evals options
+- The Matlab routine mex_fnft_nsep has been updated accordingly
+
+### Fixed
+
+- The Matlab interface now builds also with the most recent versions of Matlab
+- The refinement of the auxiliary spectrum in fnft_nsep was refining the complex conjugate of mu_k instead of mu_k
+
+### Changed
+
+- The refinement of the main spectrum in fnft_nsep has been improved
+- The polynomial rootfinder in fnft__poly_roots_fasteigen now always uses the QR algorithm
+
 ## [0.2.2] -- 2018-12-13
 
 ### Added

CMakeLists.txt

@@ -20,9 +20,9 @@ cmake_minimum_required(VERSION 3.5)
 project(fnft C)
 
 set(FNFT_VERSION_MAJOR 0)
-set(FNFT_VERSION_MINOR 2)
-set(FNFT_VERSION_PATCH 2)
-set(FNFT_VERSION_SUFFIX "-dev") # should not be longer than FNFT_SUFFIX_MAXLEN
+set(FNFT_VERSION_MINOR 3)
+set(FNFT_VERSION_PATCH 0)
+set(FNFT_VERSION_SUFFIX "") # should not be longer than FNFT_SUFFIX_MAXLEN
 set(FNFT_VERSION ${FNFT_VERSION_MAJOR}.${FNFT_VERSION_MINOR}.${FNFT_VERSION_PATCH}${FNFT_VERSION_SUFFIX})
 
 include(CheckIncludeFiles)

Doxyfile

@@ -29,8 +29,11 @@ If the MATLAB interface has been built, try the following in MATLAB
 
 ## Documentation
 
-The C interface is separated in a public ('fnft_' prefix) and a private part ('fnft__' prefix). To get started with the public part, read the documentation in the public header files in the 'include' folder. It is also possible to build a html version of the documentation. To build it, run doxygen in the main folder of the library. It can then be found in the
-doc folder. Simply open the file '~/FNFT/doc/html/index.html' in your web browser.
+The documentation of the C interface is available online at
+
+    [https://fastnft.github.io/FNFT/](https://fastnft.github.io/FNFT/)
+
+The C interface is separated into a public part ('fnft_' prefix) and a private part ('fnft__' prefix). The public part corresponds to the header files directly inside the 'include' folder. The header files in the subdirectories of the 'include' folder are considered private. To build the documentation yourself, run doxygen in the main folder of the library. It can then be found in the doc folder. Simply open the file '~/FNFT/doc/html/index.html' in your web browser.
 
 The MATLAB interface is documented in the usual way. Run the commands
 

Getting-Started.md

@@ -28,10 +28,18 @@
 /**
  * \mainpage FNFT: Fast nonlinear Fourier transforms
  *
- * The library is separated into a public ("fnft_" prefix) and a private part
- * ("fnft__" prefix). \n\n
- * To get started, read the modules \ref fnft and \ref fnft_inverse, and try
- * the examples in the examples directory.
+ * This is the documention for the C interface of the library FNFT.
+ *
+ * You can download FNFT at https://github.com/FastNFT/FNFT/
+ *
+ * Please read the file README.md first if you are new to FNFT.
+ *
+ * The C interface is separated into a public part ("fnft_" prefix) and a private
+ * part ("fnft__" prefix).
+ *
+ * To get start with the public part of the C interface, study the modules
+ * \ref fnft and \ref fnft_inverse, and try the examples in the examples
+ * directory.
  */
 
 /* Define groups for Doxygen documentation */

include/fnft.h

@@ -35,7 +35,7 @@
  * @ingroup data_types
  *  fnft_nsep_opts_loc_SUBSAMPLE_AND_REFINE: Similar approach as for
  *  fnft_nsev_opts_dsloc_SUBSAMPLE_AND_REFINE (see
- *  \link fnft_nsev_opts_t::bound_state_localization\endlink.)\n\n
+ *  \link fnft_nsev_opts_t::bound_state_localization \endlink.)\n\n
  *  fnft_nsep_opts_loc_GRIDSEARCH: Uses a grid search to localize roots. Can
  *  only find main and auxiliary spectrum points on the real axis. In the
  *  defocusing case, the main spectrum is always real.\n\n
@@ -123,6 +123,11 @@ typedef enum {
  *   is used during localization. See \link fnft_nsep_loc_t \endlink.
  *   When set to zero (default), the algorithm will choose Dsub automatically
  *   such that the complexity of finding initial guesses is O(D log^2 D).
+ *
+ * @var fnft_nsep_opts_t::tol
+ *   Tolerance used to stop the refinement of main and auxiliary spectrum.
+ *   Should be positive or -1. In latter case, the algorithm chooses the
+ *   tolerance.
  */
 typedef struct {
     fnft_nsep_loc_t localization;

include/fnft_nsep.h

@@ -1,6 +1,6 @@
 /*
-* This file is part of FNFT.  
-*                                                                  
+* This file is part of FNFT.
+*
 * FNFT is free software; you can redistribute it and/or
 * modify it under the terms of the version 2 of the GNU General
 * Public License as published by the Free Software Foundation.
@@ -9,7 +9,7 @@
 * 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 this program. If not, see <http://www.gnu.org/licenses/>.
 *
@@ -92,8 +92,8 @@
  * equation,&quot;</a> J. Comput. Phys. 102(2), 1992.
  * It is supported by \link fnft__nse_scatter.h \endlink.
  *
- * Used in \link fnft__akns_fscatter\endlink and
- * \link fnft__akns_scatter.h\endlink.
+ * Used in \link fnft__akns_fscatter.h \endlink and
+ * \link fnft__akns_scatter.h \endlink.
  *
  * @ingroup data_types
  */

include/private/fnft__akns_discretization_t.h

@@ -1,6 +1,6 @@
 /*
-* This file is part of FNFT.  
-*                                                                  
+* This file is part of FNFT.
+*
 * FNFT is free software; you can redistribute it and/or
 * modify it under the terms of the version 2 of the GNU General
 * Public License as published by the Free Software Foundation.
@@ -9,7 +9,7 @@
 * 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 this program. If not, see <http://www.gnu.org/licenses/>.
 *
@@ -57,7 +57,7 @@ INT main()
     // Repeat tests without real spectrum
     opts.bounding_box[2] = 0.1;
     D = 1024;
-    error_bounds[0] = 4.4e-5;
+    error_bounds[0] = 4.5e-5;
     error_bounds[1] = 4.4e-5;
     error_bounds[2] = 0.0;
     ret_code = nsep_testcases_test_fnft(tc, D, error_bounds, &opts);

test/fnft_nsep/fnft_nsep_test_plane_wave_focusing_2split2A.c

@@ -1,6 +1,6 @@
 /*
-* This file is part of FNFT.  
-*                                                                  
+* This file is part of FNFT.
+*
 * FNFT is free software; you can redistribute it and/or
 * modify it under the terms of the version 2 of the GNU General
 * Public License as published by the Free Software Foundation.
@@ -9,7 +9,7 @@
 * 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 this program. If not, see <http://www.gnu.org/licenses/>.
 *
@@ -57,7 +57,7 @@ INT main()
     // Repeat tests without real spectrum
     opts.bounding_box[2] = 0.1;
     D = 1024;
-    error_bounds[0] = 4.4e-5;
+    error_bounds[0] = 4.5e-5;
     error_bounds[1] = 4.4e-5;
     error_bounds[2] = 0.0;
     ret_code = nsep_testcases_test_fnft(tc, D, error_bounds, &opts);