Add std::complex support (#23)

* Tweak build script

* Simplify bool conversion

* Add complex number support to std::vector

Author: sethrj

doc/modules/vector.rst

@@ -9,8 +9,8 @@ Vector
 ******
 
 Vectors are resizeable arrays of elements. The ``flc_vector`` module
-instantiates vectors of ``integer(4)``,  ``integer(8)``,  ``real(8)``, and
-``type(String)``.
+instantiates vectors of ``integer(4)``,  ``integer(8)``,  ``real(8)``,
+``complex(8)``, and ``type(String)``.
 
 Common functionality
 ====================
@@ -94,11 +94,13 @@ Numeric vectors
 ===============
 
 As with the algorithms and other methods, the ``flc_vector`` module includes
-three numeric instantiations. They each have distinct derived types:
+three scalar numeric instantiations, but it also includes an instantiation for
+complex numbers. Each instantiation has a distinct derived type:
 
  - ``VectorInt4``: each element is ``integer(4)``
  - ``VectorInt8``: each element is ``integer(8)``
  - ``VectorReal8``: each element is ``real(8)``
+ - ``VectorComplex8``: each element is ``complex(8)``
 
 Construct from an array
 -----------------------

include/flc_vector.i

@@ -1,21 +1,22 @@
 /*!
  * \file flc_vector.i
  *
- * Copyright (c) 2019 Oak Ridge National Laboratory, UT-Battelle, LLC.
+ * Copyright (c) 2019-2020 Oak Ridge National Laboratory, UT-Battelle, LLC.
  * Distributed under an MIT open source license: see LICENSE for details.
  */
 
 %module "flc_vector"
 %include "import_flc.i"
 %flc_add_header
 
+%include <complex.i>
 %include <std_vector.i>
 
 /* -------------------------------------------------------------------------
  * Macro definitions
  * ------------------------------------------------------------------------- */
 
-%define %flc_std_vector_extend_pod(CTYPE)
+%define %flc_std_vector_extend_pod(CTYPE, IMTYPE)
 %extend {
   %apply (const SWIGTYPE *DATA, ::size_t SIZE)
     { (const CTYPE* DATA, size_type SIZE) };
@@ -31,7 +32,7 @@
   }
 
   // Get a mutable view to ourself
-  %fortran_array_pointer(CTYPE, vector<CTYPE>& view);
+  %fortran_array_pointer(IMTYPE, vector<CTYPE>& view);
 
   %typemap(out, noblock=1) vector<CTYPE>& view {
     $result.data = ($1->empty() ? NULL : &(*$1->begin()));
@@ -63,7 +64,7 @@ namespace std {
 
     %swig_std_vector(T, const T&)
     %swig_std_vector_extend_ref(T)
-    %flc_std_vector_extend_pod(T)
+    %flc_std_vector_extend_pod(T, T)
   };
 }
 
@@ -72,6 +73,31 @@ namespace std {
 
 %enddef
 
+
+/* ------------------------------------------------------------------------- */
+/*! \def %flc_template_std_vector_complex
+ *
+ * Inject member functions and typemaps for std::complex instantiations.
+ *
+ * This definition is considered part of the \em public API so that downstream
+ * apps that generate FLC-based bindings can instantiate their own POD vectors.
+ */
+%define %flc_template_std_vector_complex(NAME, T)
+
+namespace std {
+  template<> class vector<std::complex<T> > {
+
+    %swig_std_vector(std::complex<T>, const std::complex<T>&)
+    %swig_std_vector_extend_ref(std::complex<T>)
+    %flc_std_vector_extend_pod(std::complex<T>, SwigComplex_ ## T)
+  };
+}
+
+// Instantiate the template
+%template(NAME) std::vector<std::complex<T> >;
+
+%enddef
+
 /* -------------------------------------------------------------------------
  * Numeric vectors
  * ------------------------------------------------------------------------- */
@@ -80,6 +106,8 @@ namespace std {
 %flc_template_std_vector_pod(VectorInt8,  int64_t)
 %flc_template_std_vector_pod(VectorReal8, double)
 
+%flc_template_std_vector_complex(VectorComplex8, double)
+
 /* -------------------------------------------------------------------------
  * String vectors
  * ------------------------------------------------------------------------- */

scripts/cmake_vostok renamed to scripts/build/vostok.sh

@@ -1,5 +1,5 @@
 #!/bin/sh -ex
-SOURCE=$(cd $(dirname "${BASH_SOURCE[0]}")/.. && pwd)
+SOURCE=$(cd $(dirname "${BASH_SOURCE[0]}")/../.. && pwd)
 BUILD=${SOURCE}/build
 PREFIX=${SOURCE}/install
 
@@ -12,11 +12,13 @@ ${CMAKE} --version
 ${CMAKE} \
   -G Ninja \
   -D FLIBCPP_DEV=ON \
-  -D SWIG_EXECUTABLE="/rnsdhpc/code/build/swig-debug/swig"  \
-  -D SWIG_DIR="/rnsdhpc/code/src/swig/Lib" \
+  -D SWIG_EXECUTABLE="/rnsdhpc/code/_build/swig-debug/swig"  \
+  -D SWIG_DIR="/rnsdhpc/code/swig/Lib" \
   -D BUILD_SHARED_LIBS=ON \
   -D CMAKE_Fortran_FLAGS="-Wall -Wextra -Wimplicit-procedure -Wimplicit-interface -Wno-compare-reals" \
-  -D CMAKE_CXX_FLAGS="-Wall -Wextra" \
+  -D CMAKE_CXX_FLAGS="-Wall -Wextra -pedantic" \
   -D CMAKE_INSTALL_PREFIX="${PREFIX}" \
   ${SOURCE}
-ninja
+ninja -v
+ctest --output-on-failure
+ninja install

src/flc_algorithm.f90

@@ -780,12 +780,7 @@ subroutine SWIGTM_fout_bool(imout, fout)
   use, intrinsic :: ISO_C_BINDING
   integer(kind=C_INT), intent(in) :: imout
   logical, intent(out) :: fout
-  ! TODO: fout = (imout /= 0) ???
-  if (imout /= 0) then
-    fout = .true.
-  else
-    fout = .false.
-  end if
+  fout = (imout /= 0)
 end subroutine
 
 function swigf_is_sorted__SWIG_1(data) &

src/flc_map.f90

@@ -416,12 +416,7 @@ subroutine SWIGTM_fout_bool(imout, fout)
   use, intrinsic :: ISO_C_BINDING
   integer(kind=C_INT), intent(in) :: imout
   logical, intent(out) :: fout
-  ! TODO: fout = (imout /= 0) ???
-  if (imout /= 0) then
-    fout = .true.
-  else
-    fout = .false.
-  end if
+  fout = (imout /= 0)
 end subroutine
 
 function swigf_MapIntInt_empty(self) &

src/flc_set.f90

@@ -383,12 +383,7 @@ subroutine SWIGTM_fout_bool(imout, fout)
   use, intrinsic :: ISO_C_BINDING
   integer(kind=C_INT), intent(in) :: imout
   logical, intent(out) :: fout
-  ! TODO: fout = (imout /= 0) ???
-  if (imout /= 0) then
-    fout = .true.
-  else
-    fout = .false.
-  end if
+  fout = (imout /= 0)
 end subroutine
 
 function swigf_SetInt_empty(self) &

src/flc_string.f90

@@ -443,12 +443,7 @@ subroutine SWIGTM_fout_bool(imout, fout)
   use, intrinsic :: ISO_C_BINDING
   integer(kind=C_INT), intent(in) :: imout
   logical, intent(out) :: fout
-  ! TODO: fout = (imout /= 0) ???
-  if (imout /= 0) then
-    fout = .true.
-  else
-    fout = .false.
-  end if
+  fout = (imout /= 0)
 end subroutine
 
 function swigf_string_empty(self) &