From 1004f2db79aecbd818fba9749f95a5870618f559 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Sun, 7 Jan 2018 16:48:10 -0500 Subject: [PATCH 01/69] Use boost::is_signed instead of boost::is_unsigned. Not sure why the original didn't work after the upgrade to boost, but this fixes it. --- include/ndarray/converter/PyConverter.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/ndarray/converter/PyConverter.h b/include/ndarray/converter/PyConverter.h index 0b544c9a..dc1e8fd5 100644 --- a/include/ndarray/converter/PyConverter.h +++ b/include/ndarray/converter/PyConverter.h @@ -129,7 +129,7 @@ struct PyIntConverterBase : public PyConverterBase { */ template < typename T, - bool isUnsigned=boost::is_unsigned::value, + bool isUnsigned=!boost::is_signed::value, int cmpToLong=(sizeof(T) < sizeof(long)) ? -1 : ((sizeof(T)==sizeof(long)) ? 0 : 1) > struct PyIntConverter; From d054da2adf421bc96b0a97141dda6bba9cd7121f Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Sun, 7 Jan 2018 16:51:25 -0500 Subject: [PATCH 02/69] Look for pybind11's own cmake config. --- cmake/FindPybind11.cmake | 43 ---------------------------------------- tests/CMakeLists.txt | 12 ++--------- 2 files changed, 2 insertions(+), 53 deletions(-) delete mode 100644 cmake/FindPybind11.cmake diff --git a/cmake/FindPybind11.cmake b/cmake/FindPybind11.cmake deleted file mode 100644 index f2c8216b..00000000 --- a/cmake/FindPybind11.cmake +++ /dev/null @@ -1,43 +0,0 @@ -#.rst: -# FindPybind11 -# -------- -# -# Find the Pybind11 includes. -# -# Result Variables -# ^^^^^^^^^^^^^^^^ -# -# This module will set the following variables in your project:: -# -# PYBIND11_FOUND - True if Pybind11 found on the local system -# PYBIND11_INCLUDE_DIR - Location of Pybind11 header files. -# -# Hints -# ^^^^^ -# -# Set ``PYBIND11_DIR`` to a directory that contains a Pybind11 installation. -# -# This script expects to find headers at ``$PYBIND11_DIR/include``. -# - -# Include these modules to handle the QUIETLY and REQUIRED arguments. -include(FindPackageHandleStandardArgs) - -#============================================================================= -# If the user has provided ``PYBIND11_DIR``, use it! Choose items found -# at this location over system locations. -if( EXISTS "$ENV{PYBIND11_DIR}" ) - file( TO_CMAKE_PATH "$ENV{PYBIND11_DIR}" PYBIND11_DIR ) - set( PYBIND11_DIR "${PYBIND11_DIR}" CACHE PATH "Prefix for Pybind11 installation." ) -endif() - -#============================================================================= -# Set PYBIND11_INCLUDE_DIRS. -# Try to find pybind11 at $PYBIND11_DIR (if provided) or in standard -# system locations. -find_path(PYBIND11_INCLUDE_DIR - NAMES pybind11/pybind11.h - HINTS ${PYBIND11_DIR}/include - ) - -find_package_handle_standard_args(Pybind11 DEFAULT_MSG PYBIND11_INCLUDE_DIR) diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 6d04ceda..a55c705b 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -84,19 +84,11 @@ endif(NDARRAY_SWIG) ###Pybind11 dependency tests (also depend on Eigen) if(NDARRAY_PYBIND11) if(NDARRAY_EIGEN) - find_package(Pybind11 REQUIRED) + find_package(pybind11 REQUIRED) include_directories(${PYBIND11_INCLUDE_DIR}) - add_library(pybind11_test_mod.so MODULE pybind11_test_mod.cc) - set_target_properties(pybind11_test_mod.so PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}") - set_target_properties(pybind11_test_mod.so PROPERTIES SUFFIX "${PYTHON_MODULE_EXTENSION}") - - if (APPLE) - target_link_libraries(pybind11_test_mod.so PRIVATE "-undefined dynamic_lookup") - else () - target_link_libraries(pybind11_test_mod.so "-shared") - endif() + pybind11_add_module(pybind11_test_mod pybind11_test_mod.cc) configure_file(pybind11_test.py pybind11_test.py COPYONLY) add_test(NAME pybind11_test From 93c684ecb96fb9529bac78e59ab27359797694d1 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Sun, 7 Jan 2018 13:14:52 -0500 Subject: [PATCH 03/69] Switch travis to use conda(-forge), include pybind11 --- .travis.yml | 51 ++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 38 insertions(+), 13 deletions(-) diff --git a/.travis.yml b/.travis.yml index b765a956..6773550c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,23 +1,48 @@ -sudo: required -dist: trusty -language: cpp - +language: python +python: + # We don't actually use the Travis Python, but this keeps it organized. + - "2.7" + - "3.5" + - "3.6" before_install: - - export PATH=$(echo $PATH | tr ':' "\n" | sed '/\/opt\/python/d' | tr "\n" ":" | sed "s|::|:|g") - - sudo apt-get -qq update - - sudo apt-get install -y libboost-dev libboost-test-dev libboost-python-dev python-numpy python3-numpy libpython3-dev swig doxygen fftw3-dev libeigen3-dev libpython3-dev - - sudo ln -s /usr/lib/x86_64-linux-gnu/libboost_python-py34.so /usr/lib/x86_64-linux-gnu/libboost_python3.so + # C++14 + - sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test + - sudo apt-get update -qq + - sudo apt-get install -qq g++-6 + - sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-6 90 +install: + # We do this conditionally because it saves us some downloading if the + # version is the same. + - if [[ "$TRAVIS_PYTHON_VERSION" == "2.7" ]]; then + wget https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh -O miniconda.sh; + else + wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh; + fi + - bash miniconda.sh -b -p $HOME/miniconda + - export PATH="$HOME/miniconda/bin:$PATH" + - hash -r + - conda config --set always_yes yes --set changeps1 no + - conda config --prepend channels conda-forge + - conda update -q conda + # Useful for debugging any issues with conda + - conda info -a + - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION boost fftw numpy pybind11 swig doxygen + - source activate test-environment + - echo "eigen 3.2.*" > $CONDA_PREFIX/conda-meta/pinned + - conda install eigen + - export BOOST_DIR=$CONDA_PREFIX + - export EIGEN_DIR=$CONDA_PREFIX + - export FFTW_DIR=$CONDA_PREFIX + - export CMAKE_PREFIX_PATH=$CONDA_PREFIX + # Conda's boost is built with the old libc++ ABI, so we have to build with that too. + - export CXXFLAGS="-D_GLIBCXX_USE_CXX11_ABI=0" script: - mkdir build - cd build - - cmake -DPYTHON_EXECUTABLE=$PYTHON .. && make && make test ARGS="-V" + - cmake -DNDARRAY_PYBIND11=ON .. && make && make test ARGS="-V" - make doc -env: - - PYTHON=/usr/bin/python - - PYTHON=/usr/bin/python3 - deploy: provider: pages skip_cleanup: true From a0e697a124e405355536ad876e1baf83264d5667 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Sun, 7 Jan 2018 16:52:08 -0500 Subject: [PATCH 04/69] Add build directories to .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 5c2f1faf..dd53657c 100644 --- a/.gitignore +++ b/.gitignore @@ -28,3 +28,4 @@ include/ndarray/operators.h include/ndarray/bp/auto/*.h include/ndarray/eigen/bp/auto/*.h tests/.*.succeeded +build* From 434496445357b9f2ca7a68312584009f8495a17b Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Sun, 7 Jan 2018 20:32:43 -0500 Subject: [PATCH 05/69] Move manager-to-Python to a non-NumPy header. --- include/ndarray/converter/PyManager.h | 38 +++++++++++++++++++++++++++ include/ndarray/converter/numpy.h | 17 ++---------- 2 files changed, 40 insertions(+), 15 deletions(-) create mode 100644 include/ndarray/converter/PyManager.h diff --git a/include/ndarray/converter/PyManager.h b/include/ndarray/converter/PyManager.h new file mode 100644 index 00000000..cc8b9249 --- /dev/null +++ b/include/ndarray/converter/PyManager.h @@ -0,0 +1,38 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2018, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ +#ifndef NDARRAY_CONVERTER_PyManager_h_INCLUDED +#define NDARRAY_CONVERTER_PyManager_h_INCLUDED + +#include "Python.h" +#include "ndarray/Manager.h" + +namespace ndarray { +namespace detail { + +inline void destroyCapsule(PyObject * p) { + void * m = PyCapsule_GetPointer(p, "ndarray.Manager"); + Manager::Ptr * b = reinterpret_cast(m); + delete b; +} + +} // namespace ndarray::detail + +inline PyObject* makePyManager(Manager::Ptr const & m) { + return PyCapsule_New( + new Manager::Ptr(m), + "ndarray.Manager", + detail::destroyCapsule + ); +} + +} // namespace ndarray + +#endif // !NDARRAY_CONVERTER_PyManager_h_INCLUDED diff --git a/include/ndarray/converter/numpy.h b/include/ndarray/converter/numpy.h index 9b887819..aa3dfffd 100644 --- a/include/ndarray/converter/numpy.h +++ b/include/ndarray/converter/numpy.h @@ -23,6 +23,7 @@ #include "Python.h" #include "ndarray.h" #include "ndarray/converter/PyConverter.h" +#include "ndarray/converter/PyManager.h" namespace ndarray { namespace detail { @@ -117,16 +118,6 @@ template <> struct NumpyTraits > { /// \endcond -/** - * @internal @ingroup ndarrayPythonInternalGroup - * @brief A destructor for a Python CObject that owns a shared_ptr. - */ -inline void destroyCapsule(PyObject * p) { - void * m = PyCapsule_GetPointer(p, "ndarray.Manager"); - ndarray::Manager::Ptr * b = reinterpret_cast(m); - delete b; -} - } // namespace ndarray::detail /** @@ -291,11 +282,7 @@ struct PyConverter< Array > : public detail::PyConverterBase< Array(array.get()), owner); } From 00bd6327e40c40d4108e67b9c561a4061f6be2e0 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Sun, 7 Jan 2018 12:45:03 -0500 Subject: [PATCH 06/69] Implement pybind11 Array typecaster without PyConverter. --- include/ndarray/pybind11.h | 363 ++++++++++++++++++++++++++----------- tests/pybind11_test_mod.cc | 8 - 2 files changed, 258 insertions(+), 113 deletions(-) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index 28c43026..a7f711f5 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -42,13 +42,131 @@ */ #include "pybind11.h" +#include "pybind11/numpy.h" -#include "Python.h" #include "ndarray.h" -#include "ndarray/converter/numpy.h" -#include "ndarray/converter/ufunctors.h" -#include "ndarray/converter/Vector.h" -#include "ndarray/converter/eigen.h" +#include "ndarray/eigen.h" +#include "ndarray/converter/PyManager.h" + +namespace ndarray { + +#if PYBIND11_VERSION_MAJOR == 2 && PYBIND11_VERSION_MINOR <= 1 +using pybind11_np_size_t = size_t; +#else +using pybind11_np_size_t = ssize_t; +#endif + +template +struct Pybind11Helper { + using Element = typename ndarray::Array::Element; + using Wrapper = pybind11::array_t::type, 0>; // 0: no ensurecopy + static constexpr bool isConst = std::is_const::value; + + Pybind11Helper() : isNone(false), wrapper() {} + + bool init(pybind11::handle src) { + isNone = src.is_none(); + if (isNone) { + return true; + } + try { + wrapper = pybind11::reinterpret_borrow(src); + } catch (pybind11::error_already_set & err) { + return false; + } + return true; + } + + bool check() const { + if (isNone) { + return true; + } + if (!wrapper) { + return false; + } + if (wrapper.ndim() != N) { + return false; + } + if (!isConst && !wrapper.writeable()) { + return false; + } + pybind11_np_size_t const * shape = wrapper.shape(); + pybind11_np_size_t const * strides = wrapper.strides(); + pybind11_np_size_t const itemsize = wrapper.itemsize(); + if (C > 0) { + ssize_t requiredStride = itemsize; + for (int i = 0; i < C; ++i) { + if (strides[N-i-1] != requiredStride) { + return false; + } + requiredStride *= shape[N-i-1]; + } + } else if (C < 0) { + ssize_t requiredStride = itemsize; + for (int i = 0; i < -C; ++i) { + if (strides[i] != requiredStride) { + return false; + } + requiredStride *= shape[i]; + } + } + return true; + } + + ndarray::Array convert() const { + if (isNone) { + return ndarray::Array(); + } + Vector nShape; + Vector nStrides; + pybind11_np_size_t const * pShape = wrapper.shape(); + pybind11_np_size_t const * pStrides = wrapper.strides(); + pybind11_np_size_t const itemsize = wrapper.itemsize(); + for (int i = 0; i < N; ++i) { + if (pStrides[i] % itemsize != 0) { + PyErr_SetString( + PyExc_TypeError, + "Cannot convert array to C++: strides must be an integer multiple of the element size" + ); + throw pybind11::error_already_set(); + } + nShape[i] = pShape[i]; + nStrides[i] = pStrides[i]/itemsize; + } + return ndarray::Array( + ndarray::external(const_cast(wrapper.data()), + nShape, nStrides, pybind11::object(wrapper)) + ); + } + + static pybind11::handle toPython(ndarray::Array const & src) { + Vector nShape = src.getShape(); + Vector nStrides = src.getStrides(); + std::vector pShape(N); + std::vector pStrides(N); + pybind11_np_size_t const itemsize = sizeof(Element); + for (int i = 0; i < N; ++i) { + pShape[i] = nShape[i]; + pStrides[i] = nStrides[i]*itemsize; + } + pybind11::object base; + if (src.getManager()) { + base = pybind11::reinterpret_steal(ndarray::makePyManager(src.getManager())); + } + Wrapper result(pShape, pStrides, src.getData(), base); + if (std::is_const::value) { + result.attr("flags")["WRITEABLE"] = false; + } + return result.release(); + } + + bool isNone; + Wrapper wrapper; +}; + + + +} // namespace ndarray NAMESPACE_BEGIN(pybind11) NAMESPACE_BEGIN(detail) @@ -57,188 +175,223 @@ NAMESPACE_BEGIN(detail) */ template class type_caster< ndarray::Array > { + using Helper = ndarray::Pybind11Helper; public: + bool load(handle src, bool) { - _none = src.is_none(); - if (_none) return true; - _src.reset(src.ptr()); // equivalent to add_ref=true, keep alive for stage 2 - if (!ndarray::PyConverter< ndarray::Array >::fromPythonStage1(_src)) { - PyErr_Clear(); - return false; - } - return true; - } - static handle cast(const ndarray::Array &src, return_value_policy /* policy */, handle /* parent */) { - return ndarray::PyConverter< ndarray::Array >::toPython(src); + return _helper.init(src) && _helper.check(); } + void set_value() { - if (!ndarray::PyConverter< ndarray::Array >::fromPythonStage2(_src, _value)) { - throw error_already_set(); - } + _value = _helper.convert(); } -/* This part is normally created by the PYBIND11_TYPE_CASTER macro, which - * can't be used here due to the partial specialization - */ -protected: - ndarray::PyPtr _src; - ndarray::Array _value; - bool _none = false; -public: + + static handle cast(const ndarray::Array &src, return_value_policy /* policy */, handle /* parent */) { + return Helper::toPython(src); + } + static PYBIND11_DESCR name() { return type_descr(_>()); } + static handle cast(const ndarray::Array *src, return_value_policy policy, handle parent) { return cast(*src, policy, parent); } - operator ndarray::Array * () { - if (_none) { + + operator ndarray::Array * () { + if (_helper.isNone) { return nullptr; } else { set_value(); return &_value; } } + operator ndarray::Array & () { set_value(); return _value; } + template using cast_op_type = pybind11::detail::cast_op_type<_T>; + +private: + ndarray::Array _value; + Helper _helper; }; /* @brief A pybind11 type_caster for ndarray::EigenView */ template class type_caster< ndarray::EigenView > { + using Helper = ndarray::Pybind11Helper; public: + bool load(handle src, bool) { - _none = src.is_none(); - if (_none) return true; - _src.reset(src.ptr()); // equivalent to add_ref=true, keep alive for stage 2 - if (!ndarray::PyConverter< ndarray::EigenView >::fromPythonStage1(_src)) { - PyErr_Clear(); + if (!_helper.init(src)) { return false; } - return true; - } - static handle cast(const ndarray::EigenView &src, return_value_policy /* policy */, handle /* parent */) { - return ndarray::PyConverter< ndarray::EigenView >::toPython(src); + if (_helper.isNone) { + return true; + } + if ((Rows == 1 || Cols == 1) && N == 2) { + int shape[2] = { -1, -1 }; + if (Rows == 1) { + shape[0] = 1; + } else { + shape[1] = 1; + } + try { + _helper.wrapper = _helper.wrapper.attr("reshape")(shape[0], shape[1]); + } catch (error_already_set &) { + return false; + } + } else if (N == 1) { + _helper.wrapper = _helper.wrapper.squeeze(); + } + // check whether the shape is correct if it's static + if (N == 2) { + if (Rows != Eigen::Dynamic && _helper.wrapper.shape(0) != Rows) { + return false; + } + if (Cols != Eigen::Dynamic && _helper.wrapper.shape(1) != Cols) { + return false; + } + } else { + ndarray::pybind11_np_size_t requiredSize = Rows * Cols; + if (requiredSize != Eigen::Dynamic && _helper.wrapper.size() != requiredSize) { + return false; + } + } + return _helper.check(); } + void set_value() { - if (!ndarray::PyConverter< ndarray::EigenView >::fromPythonStage2(_src, _value)) { - throw error_already_set(); - } + _value.reset(_helper.convert()); } -/* This part is normally created by the PYBIND11_TYPE_CASTER macro, which - * can't be used here due to the partial specialization - */ -protected: - ndarray::PyPtr _src; - ndarray::EigenView _value; - bool _none = false; -public: + + bool isNone() const { return _helper.isNone; } + + static handle cast(const ndarray::EigenView &src, return_value_policy /* policy */, handle /* parent */) { + using Wrapper = typename Helper::Wrapper; + Wrapper wrapper = reinterpret_steal(Helper::toPython(src.shallow())); + return wrapper.squeeze().release(); + } + static PYBIND11_DESCR name() { return type_descr(_>()); } + static handle cast(const ndarray::EigenView *src, return_value_policy policy, handle parent) { return cast(*src, policy, parent); } + operator ndarray::EigenView * () { - if (_none) { + if (isNone()) { return nullptr; } else { set_value(); return &_value; } } - operator ndarray::EigenView & () { set_value(); return _value; } + + operator ndarray::EigenView & () { + set_value(); + return _value; + } + template using cast_op_type = pybind11::detail::cast_op_type<_T>; + +private: + ndarray::EigenView _value; + Helper _helper; }; -/* @brief A pybind11 type_caster for Eigen::Array - */ + template class type_caster< Eigen::Array > { + using OutputView = typename ndarray::SelectEigenView< Eigen::Array >::Type; + using InputView = typename ndarray::SelectEigenView< Eigen::Array const, false>::Type; public: - bool load(handle src, bool) { - _none = src.is_none(); - if (_none) return true; - _src.reset(src.ptr()); // equivalent to add_ref=true, keep alive for stage 2 - if (!ndarray::PyConverter< Eigen::Array >::fromPythonStage1(_src)) { - PyErr_Clear(); - return false; - } - return true; - } - static handle cast(const Eigen::Array &src, return_value_policy /* policy */, handle /* parent */) { - return ndarray::PyConverter< Eigen::Array >::toPython(src); + + bool load(handle src, bool convert) { + return _nested.load(src, convert); } + void set_value() { - if (!ndarray::PyConverter< Eigen::Array >::fromPythonStage2(_src, _value)) { - throw error_already_set(); - } + InputView & v = _nested; + _value = v; } -/* This part is normally created by the PYBIND11_TYPE_CASTER macro, which - * can't be used here due to the partial specialization - */ -protected: - ndarray::PyPtr _src; - Eigen::Array _value; - bool _none = false; -public: + + static handle cast(const Eigen::Array &src, return_value_policy policy, handle parent) { + OutputView v = ndarray::copy(src); + return type_caster< OutputView >::cast(v, policy, parent); + } + static PYBIND11_DESCR name() { return type_descr(_>()); } + static handle cast(const Eigen::Array *src, return_value_policy policy, handle parent) { return cast(*src, policy, parent); } + operator Eigen::Array * () { - if (_none) { + if (_nested.isNone()) { return nullptr; } else { set_value(); return &_value; } } - operator Eigen::Array & () { set_value(); return _value; } + + operator Eigen::Array & () { + set_value(); + return _value; + } + template using cast_op_type = pybind11::detail::cast_op_type<_T>; + +private: + Eigen::Array _value; + type_caster< InputView > _nested; }; -/* @brief A pybind11 type_caster for Eigen::Matrix - */ + template class type_caster< Eigen::Matrix > { + using OutputView = typename ndarray::SelectEigenView< Eigen::Matrix >::Type; + using InputView = typename ndarray::SelectEigenView< Eigen::Matrix const, false>::Type; public: - bool load(handle src, bool) { - _none = src.is_none(); - if (_none) return true; - _src.reset(src.ptr()); // equivalent to add_ref=true, keep alive for stage 2 - if (!ndarray::PyConverter< Eigen::Matrix >::fromPythonStage1(_src)) { - PyErr_Clear(); - return false; - } - return true; - } - static handle cast(const Eigen::Matrix &src, return_value_policy /* policy */, handle /* parent */) { - return ndarray::PyConverter< Eigen::Matrix >::toPython(src); + + bool load(handle src, bool convert) { + return _nested.load(src, convert); } + void set_value() { - if (!ndarray::PyConverter< Eigen::Matrix >::fromPythonStage2(_src, _value)) { - throw error_already_set(); - } + InputView & v = _nested; + _value = v; } -/* This part is normally created by the PYBIND11_TYPE_CASTER macro, which - * can't be used here due to the partial specialization - */ -protected: - ndarray::PyPtr _src; - Eigen::Matrix _value; - bool _none = false; -public: + + static handle cast(const Eigen::Matrix &src, return_value_policy policy, handle parent) { + OutputView v = ndarray::copy(src); + return type_caster< OutputView >::cast(v, policy, parent); + } + static PYBIND11_DESCR name() { return type_descr(_>()); } + static handle cast(const Eigen::Matrix *src, return_value_policy policy, handle parent) { return cast(*src, policy, parent); } + operator Eigen::Matrix * () { - if (_none) { + if (_nested.isNone()) { return nullptr; } else { set_value(); return &_value; } } - operator Eigen::Matrix & () { set_value(); return _value; } + + operator Eigen::Matrix & () { + set_value(); return _value; + } + template using cast_op_type = pybind11::detail::cast_op_type<_T>; + +private: + Eigen::Matrix _value; + type_caster< InputView > _nested; }; NAMESPACE_END(detail) diff --git a/tests/pybind11_test_mod.cc b/tests/pybind11_test_mod.cc index 1e008ed4..0bd08a34 100644 --- a/tests/pybind11_test_mod.cc +++ b/tests/pybind11_test_mod.cc @@ -1,9 +1,6 @@ -#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION #include "pybind11/pybind11.h" -#include "numpy/arrayobject.h" #include "ndarray/pybind11.h" -#include "ndarray/converter.h" namespace py = pybind11; using namespace py::literals; @@ -134,11 +131,6 @@ bool acceptFullySpecifiedMatrix(Eigen::Matrix const & a, PYBIND11_PLUGIN(pybind11_test_mod) { pybind11::module mod("pybind11_test_mod", "Tests for the ndarray library"); - if (_import_array() < 0) { - PyErr_SetString(PyExc_ImportError, "numpy.core.multiarray failed to import"); - return nullptr; - } - py::class_ cls(mod, "MatrixOwner"); cls.def(py::init<>()); From 0a438dd181eb2956213a8ddcc9f466a976b2ee3c Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 12 Jan 2018 21:13:12 -0500 Subject: [PATCH 07/69] Protect against non-native byte orders. --- include/ndarray/pybind11.h | 4 ++++ tests/pybind11_test.py | 7 +++++++ 2 files changed, 11 insertions(+) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index a7f711f5..039c0d45 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -117,6 +117,10 @@ struct Pybind11Helper { if (isNone) { return ndarray::Array(); } + if (!pybind11::reinterpret_borrow(wrapper.dtype().attr("isnative"))) { + PyErr_SetString(PyExc_TypeError, "Only arrays with native byteorder can be converted to C++."); + throw pybind11::error_already_set(); + } Vector nShape; Vector nStrides; pybind11_np_size_t const * pShape = wrapper.shape(); diff --git a/tests/pybind11_test.py b/tests/pybind11_test.py index 911f19e1..e660d921 100755 --- a/tests/pybind11_test.py +++ b/tests/pybind11_test.py @@ -95,5 +95,12 @@ def testFullySpecifiedMatrix(self): b = numpy.array([ 0., 0.]) self.assert_(pybind11_test_mod.acceptFullySpecifiedMatrix(a, b)) + def testNonNativeByteOrder(self): + d1 = numpy.dtype("f8") + nonnative = d2 if d1 == numpy.dtype(float) else d1 + a = numpy.zeros(5, dtype=nonnative) + self.assertRaises(TypeError, pybind11_test_mod.acceptArray10, a) + if __name__ == "__main__": unittest.main() From 437a22f9a76a205fee86b9973594112311ac5256 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 12 Feb 2018 18:21:10 -0500 Subject: [PATCH 08/69] Fix signed-unsigned comparison warnings in new pybind11 wrappers. --- include/ndarray/pybind11.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index 039c0d45..fe0017a5 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -94,7 +94,7 @@ struct Pybind11Helper { pybind11_np_size_t const * strides = wrapper.strides(); pybind11_np_size_t const itemsize = wrapper.itemsize(); if (C > 0) { - ssize_t requiredStride = itemsize; + pybind11_np_size_t requiredStride = itemsize; for (int i = 0; i < C; ++i) { if (strides[N-i-1] != requiredStride) { return false; @@ -102,7 +102,7 @@ struct Pybind11Helper { requiredStride *= shape[N-i-1]; } } else if (C < 0) { - ssize_t requiredStride = itemsize; + pybind11_np_size_t requiredStride = itemsize; for (int i = 0; i < -C; ++i) { if (strides[i] != requiredStride) { return false; From f693e0084b275e7a448166f24193c2ddb7bedb0e Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 12 Feb 2018 18:21:10 -0500 Subject: [PATCH 09/69] Fix more signed-unsigned comparison warnings. --- include/ndarray/pybind11.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index fe0017a5..654c1a1a 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -249,15 +249,15 @@ class type_caster< ndarray::EigenView > { } // check whether the shape is correct if it's static if (N == 2) { - if (Rows != Eigen::Dynamic && _helper.wrapper.shape(0) != Rows) { + if (Rows != Eigen::Dynamic && _helper.wrapper.shape(0) != static_cast(Rows)) { return false; } - if (Cols != Eigen::Dynamic && _helper.wrapper.shape(1) != Cols) { + if (Cols != Eigen::Dynamic && _helper.wrapper.shape(1) != static_cast(Cols)) { return false; } } else { - ndarray::pybind11_np_size_t requiredSize = Rows * Cols; - if (requiredSize != Eigen::Dynamic && _helper.wrapper.size() != requiredSize) { + auto requiredSize = Rows * Cols; + if (requiredSize != Eigen::Dynamic && _helper.wrapper.size() != static_cast(requiredSize)) { return false; } } From 37e5d9e9d181a400d31ea1e5938173ad42c2b3c0 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Sun, 25 Feb 2018 21:48:14 -0500 Subject: [PATCH 10/69] Ensure ndim is checked before shape. --- include/ndarray/pybind11.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index 654c1a1a..8c669ac4 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -247,6 +247,9 @@ class type_caster< ndarray::EigenView > { } else if (N == 1) { _helper.wrapper = _helper.wrapper.squeeze(); } + if (!_helper.check()) { + return false; + } // check whether the shape is correct if it's static if (N == 2) { if (Rows != Eigen::Dynamic && _helper.wrapper.shape(0) != static_cast(Rows)) { @@ -261,7 +264,7 @@ class type_caster< ndarray::EigenView > { return false; } } - return _helper.check(); + return true; } void set_value() { From d67ca3568b1f9cf69e4a411b66ce3c249b2a0b7a Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 2 Mar 2018 20:08:04 -0500 Subject: [PATCH 11/69] Actually check that Python arg is an array of the right type. --- include/ndarray/pybind11.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index 8c669ac4..a6e4dc7f 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -69,6 +69,9 @@ struct Pybind11Helper { if (isNone) { return true; } + if (!Wrapper::check_(src)) { + return false; + } try { wrapper = pybind11::reinterpret_borrow(src); } catch (pybind11::error_already_set & err) { From 1918f5a5b48a462edb3693671b86cf85a0fa2f73 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Sat, 3 Mar 2018 13:13:01 -0500 Subject: [PATCH 12/69] Update travis doc directory for deploy. --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 6773550c..3ce0b955 100644 --- a/.travis.yml +++ b/.travis.yml @@ -49,4 +49,4 @@ deploy: github_token: $GITHUB_TOKEN # Set in travis-ci.org dashboard on: branch: master - local_dir: html + local_dir: build/html From 9ac0380729655dca22f8ec2482542cef913c6c44 Mon Sep 17 00:00:00 2001 From: Russell Owen Date: Fri, 15 Jun 2018 16:08:05 -0700 Subject: [PATCH 13/69] Fix overly broad entry in .gitignore --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index dd53657c..66961134 100644 --- a/.gitignore +++ b/.gitignore @@ -28,4 +28,4 @@ include/ndarray/operators.h include/ndarray/bp/auto/*.h include/ndarray/eigen/bp/auto/*.h tests/.*.succeeded -build* +build/ From d4a64866aab40bf295ed2712f165bfce153c40e6 Mon Sep 17 00:00:00 2001 From: Russell Owen Date: Thu, 14 Jun 2018 14:28:17 -0700 Subject: [PATCH 14/69] Modernize pybind11_test.py --- tests/pybind11_test.py | 51 ++++++++++++++++++++++-------------------- 1 file changed, 27 insertions(+), 24 deletions(-) diff --git a/tests/pybind11_test.py b/tests/pybind11_test.py index e660d921..a439973b 100755 --- a/tests/pybind11_test.py +++ b/tests/pybind11_test.py @@ -9,54 +9,56 @@ # https://github.com/ndarray/ndarray # import numpy -import pybind11_test_mod import unittest +import pybind11_test_mod + + class TestNumpyPybind11(unittest.TestCase): def testMatrixXd(self): m1 = pybind11_test_mod.returnMatrixXd() - m2 = numpy.matrix(numpy.arange(15, dtype=float).reshape(3,5).transpose()) - self.assert_((m1 == m2).all()) - self.assert_(pybind11_test_mod.acceptMatrixXd(m2)) + m2 = numpy.matrix(numpy.arange(15, dtype=float).reshape(3, 5).transpose()) + self.assertTrue((m1 == m2).all()) + self.assertTrue(pybind11_test_mod.acceptMatrixXd(m2)) def testMatrix2d(self): m1 = pybind11_test_mod.returnMatrix2d() m2 = numpy.matrix([[0.0, 2.0], [1.0, 3.0]]) - self.assert_((m1 == m2).all()) - self.assert_(pybind11_test_mod.acceptMatrix2d(m2)) + self.assertTrue((m1 == m2).all()) + self.assertTrue(pybind11_test_mod.acceptMatrix2d(m2)) def testArray1(self): a1 = pybind11_test_mod.returnArray1() a2 = numpy.arange(6, dtype=float) - self.assert_((a1 == a2).all()) - self.assert_(pybind11_test_mod.acceptArray1(a2)) + self.assertTrue((a1 == a2).all()) + self.assertTrue(pybind11_test_mod.acceptArray1(a2)) a3 = pybind11_test_mod.returnConstArray1() - self.assert_((a1 == a3).all()) - self.assert_(a3.flags["WRITEABLE"] == False) + self.assertTrue((a1 == a3).all()) + self.assertFalse(a3.flags["WRITEABLE"]) def testArray3(self): a1 = pybind11_test_mod.returnArray3() - a2 = numpy.arange(4*3*2, dtype=float).reshape(4,3,2) - self.assert_((a1 == a2).all()) - self.assert_(pybind11_test_mod.acceptArray3(a2)) + a2 = numpy.arange(4*3*2, dtype=float).reshape(4, 3, 2) + self.assertTrue((a1 == a2).all()) + self.assertTrue(pybind11_test_mod.acceptArray3(a2)) a3 = pybind11_test_mod.returnConstArray3() - self.assert_((a1 == a3).all()) - self.assert_(a3.flags["WRITEABLE"] == False) + self.assertTrue((a1 == a3).all()) + self.assertFalse(a3.flags["WRITEABLE"]) def testClass(self): a = pybind11_test_mod.MatrixOwner() m1 = a.member m2 = a.getMember() - self.assert_((m1 == 0).all()) - self.assert_((m2 == 0).all()) - self.assertEqual(m1.shape, (2,2)) - self.assertEqual(m2.shape, (2,2)) + self.assertTrue((m1 == 0).all()) + self.assertTrue((m2 == 0).all()) + self.assertEqual(m1.shape, (2, 2)) + self.assertEqual(m2.shape, (2, 2)) def testOverloads(self): self.assertEqual(pybind11_test_mod.acceptOverload(1), 0) - self.assertEqual(pybind11_test_mod.acceptOverload(numpy.zeros((2,2), dtype=float)), 2) - self.assertEqual(pybind11_test_mod.acceptOverload(numpy.zeros((3,3), dtype=float)), 3) + self.assertEqual(pybind11_test_mod.acceptOverload(numpy.zeros((2, 2), dtype=float)), 2) + self.assertEqual(pybind11_test_mod.acceptOverload(numpy.zeros((3, 3), dtype=float)), 3) def testStrideHandling(self): # in NumPy 1.8+ 1- and 0-sized arrays can have arbitrary strides; we should @@ -91,9 +93,9 @@ def testNone(self): def testFullySpecifiedMatrix(self): # Failure on this specific case was not caught by other unit tests - a = numpy.array([[ 1., 0.], [ 0., 1.]]) - b = numpy.array([ 0., 0.]) - self.assert_(pybind11_test_mod.acceptFullySpecifiedMatrix(a, b)) + a = numpy.array([[1., 0.], [0., 1.]]) + b = numpy.array([0., 0.]) + self.assertTrue(pybind11_test_mod.acceptFullySpecifiedMatrix(a, b)) def testNonNativeByteOrder(self): d1 = numpy.dtype(" Date: Wed, 13 Jun 2018 14:39:38 -0700 Subject: [PATCH 15/69] Make sure m4 is run in a safe order ArrayBaseN.h.m4 must be processed before at least one of the other m4 headers. --- include/CMakeLists.txt | 42 ++++++++++++++++++++++++++++++------------ 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/include/CMakeLists.txt b/include/CMakeLists.txt index 3c952272..9a1b3fa5 100644 --- a/include/CMakeLists.txt +++ b/include/CMakeLists.txt @@ -1,18 +1,26 @@ # preprocess files with m4 if needed -set(FILES - "ndarray/ArrayRef.h" - "ndarray/ArrayBaseN.h" - "ndarray/operators.h" - "ndarray/Vector.h" - "ndarray/fft/FFTWTraits.h" - ) +set(FILES1 + "ndarray/ArrayBaseN.h" + ) -set(PREPROCESS_FILES "") -foreach(FILENAME ${FILES}) - list(APPEND PREPROCESS_FILES "${CMAKE_CURRENT_SOURCE_DIR}/${FILENAME}") +set(FILES2 + "ndarray/ArrayRef.h" + "ndarray/operators.h" + "ndarray/Vector.h" + "ndarray/fft/FFTWTraits.h" + ) + +set(PREPROCESS_FILES1 "") +foreach(FILENAME ${FILES1}) + list(APPEND PREPROCESS_FILES1 "${CMAKE_CURRENT_SOURCE_DIR}/${FILENAME}") +endforeach(FILENAME) + +set(PREPROCESS_FILES2 "") +foreach(FILENAME ${FILES2}) + list(APPEND PREPROCESS_FILES2 "${CMAKE_CURRENT_SOURCE_DIR}/${FILENAME}") endforeach(FILENAME) -foreach(FILENAME ${PREPROCESS_FILES}) +foreach(FILENAME ${PREPROCESS_FILES1}) add_custom_command ( OUTPUT ${FILENAME} DEPENDS ${FILENAME}.m4 @@ -20,4 +28,14 @@ foreach(FILENAME ${PREPROCESS_FILES}) ) endforeach(FILENAME) -add_custom_target(preprocess_includes ALL DEPENDS ${PREPROCESS_FILES}) \ No newline at end of file +foreach(FILENAME ${PREPROCESS_FILES2}) + add_custom_command ( + OUTPUT ${FILENAME} + DEPENDS ${FILENAME}.m4 + COMMAND m4 ${FILENAME}.m4 > ${FILENAME} + ) +endforeach(FILENAME) + +add_custom_target(preprocess_includes1 ALL DEPENDS ${PREPROCESS_FILES1}) +add_custom_target(preprocess_includes2 ALL DEPENDS ${PREPROCESS_FILES2}) +add_dependencies(preprocess_includes2 preprocess_includes1) From 1c769166ad14f771e76ccdee6cce97912e7716a6 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 8 Jun 2018 17:55:58 -0400 Subject: [PATCH 16/69] Add new asEigen* free functions returning Eigen::Map. These should now be used instead of Array.asEigen(). --- include/ndarray/eigen.h | 212 ++++++++++++++++++++++++++++++++++++++++ tests/ndarray-eigen.cc | 99 ++++++++++++++++++- 2 files changed, 309 insertions(+), 2 deletions(-) diff --git a/include/ndarray/eigen.h b/include/ndarray/eigen.h index 27987705..30e0b644 100644 --- a/include/ndarray/eigen.h +++ b/include/ndarray/eigen.h @@ -428,6 +428,218 @@ ArrayBase::asEigen() const { ArrayBase::RMC::value>(this->getSelf()); } + +namespace detail { + +template +struct SelectEigenPlainBase; + +template +struct SelectEigenPlainBase { + typedef typename boost::remove_const::type Scalar; + typedef Eigen::Matrix< + Scalar, Eigen::Dynamic, N == 1 ? 1 : Eigen::Dynamic, + Eigen::AutoAlign|(C >= 0 && N > 1 ? Eigen::RowMajor : Eigen::ColMajor) + > Type; +}; + +template +struct SelectEigenPlainBase { + typedef typename boost::remove_const::type Scalar; + typedef Eigen::Array< + Scalar, Eigen::Dynamic, N == 1 ? 1 : Eigen::Dynamic, + Eigen::AutoAlign|(C >= 0 && N > 1 ? Eigen::RowMajor : Eigen::ColMajor) + > Type; +}; + +template ::value> +struct SelectEigenPlain; + +template +struct SelectEigenPlain { + typedef typename SelectEigenPlainBase::Type const Type; +}; + +template +struct SelectEigenPlain { + typedef typename SelectEigenPlainBase::Type Type; +}; + + +template +struct SelectEigenMap; // unspecialized template parameters means not supported. + +// 1-d, not contiguous +template +struct SelectEigenMap { + + typedef Eigen::Map< + typename SelectEigenPlain::Type, + Eigen::Unaligned, + Eigen::InnerStride<> + > Type; + + static Type apply(ndarray::Array const & array) { + return Type(array.getData(), array.template getSize<0>(), + Eigen::InnerStride<>(array.template getStride<0>())); + } + +}; + +// 1-d, row-major contiguous +template +struct SelectEigenMap { + + typedef Eigen::Map< + typename SelectEigenPlain::Type, + Eigen::Unaligned + > Type; + + static Type apply(ndarray::Array const & array) { + return Type(array.getData(), array.template getSize<0>()); + } + +}; + +// 1-d, column-major contiguous +template +struct SelectEigenMap { + + typedef Eigen::Map< + typename SelectEigenPlain::Type, + Eigen::Unaligned + > Type; + + static Type apply(ndarray::Array const & array) { + return Type(array.getData(), array.template getSize<0>()); + } + +}; + +// 2-d, not contiguous +template +struct SelectEigenMap { + + typedef Eigen::Map< + typename SelectEigenPlain::Type, + Eigen::Unaligned, + Eigen::Stride + > Type; + + static Type apply(ndarray::Array const & array) { + return Type(array.getData(), array.template getSize<0>(), array.template getSize<1>(), + Eigen::Stride( + array.template getStride<0>(), array.template getStride<1>() + )); + } + +}; + +// 2-d, row-major, contiguous within a row +template +struct SelectEigenMap { + + typedef Eigen::Map< + typename SelectEigenPlain::Type, + Eigen::Unaligned, + Eigen::OuterStride<> + > Type; + + static Type apply(ndarray::Array const & array) { + return Type(array.getData(), array.template getSize<0>(), array.template getSize<1>(), + Eigen::OuterStride<>(array.template getStride<0>())); + } + +}; + +// 2-d, row-major, fully contiguous +template +struct SelectEigenMap { + + typedef Eigen::Map< + typename SelectEigenPlain::Type, + Eigen::Unaligned + > Type; + + static Type apply(ndarray::Array const & array) { + return Type(array.getData(), array.template getSize<0>(), array.template getSize<1>()); + } + +}; + +// 2-d, column-major, contiguous within a column +template +struct SelectEigenMap { + + typedef Eigen::Map< + typename SelectEigenPlain::Type, + Eigen::Unaligned, + Eigen::OuterStride<> + > Type; + + static Type apply(ndarray::Array const & array) { + return Type(array.getData(), array.template getSize<0>(), array.template getSize<1>(), + Eigen::OuterStride<>(array.template getStride<1>())); + } + +}; + +// 2-d, column-major, fully contiguous +template +struct SelectEigenMap { + + typedef Eigen::Map< + typename SelectEigenPlain::Type, + Eigen::Unaligned + > Type; + + static Type apply(ndarray::Array const & array) { + return Type(array.getData(), array.template getSize<0>(), array.template getSize<1>()); + } + +}; + +} // namespace detail + + +template +typename detail::SelectEigenMap::Type +asEigen(Array const & a) { + return detail::SelectEigenMap::apply(a); +} + +template +typename detail::SelectEigenMap::Type +asEigen(ArrayRef const & a) { + return detail::SelectEigenMap::apply(a); +} + + +template +typename detail::SelectEigenMap::Type +asEigenArray(Array const & a) { + return asEigen(a); +} + +template +typename detail::SelectEigenMap::Type +asEigenArray(ArrayRef const & a) { + return asEigen(a); +} + +template +typename detail::SelectEigenMap::Type +asEigenMatrix(Array const & a) { + return asEigen(a); +} + +template +typename detail::SelectEigenMap::Type +asEigenMatrix(ArrayRef const & a) { + return asEigen(a); +} + + } // namespace ndarray #endif // !NDARRAY_eigen_h_INCLUDED diff --git a/tests/ndarray-eigen.cc b/tests/ndarray-eigen.cc index ef910e7d..cc1528f6 100644 --- a/tests/ndarray-eigen.cc +++ b/tests/ndarray-eigen.cc @@ -23,7 +23,7 @@ void testElements2(T const & a, U const & b) { BOOST_CHECK( a.template getStride<1>() == b.colStride() ); for (int i = 0; i < b.rows(); ++i) { for (int j = 0; j < b.cols(); ++j) { - BOOST_CHECK(&a[i][j] == &b(i,j)); + BOOST_CHECK(&a[i][j] == &b.coeffRef(i,j)); } } } @@ -33,10 +33,98 @@ void testElements1(T const & a, U const & b) { BOOST_CHECK( a.template getSize<0>() == b.size() ); BOOST_CHECK( a.template getStride<0>() == b.innerStride() ); for (int i = 0; i < b.size(); ++i) { - BOOST_CHECK(&a[i] == &b[i]); + BOOST_CHECK(&a[i] == &b.coeffRef(i)); } } +template +ndarray::Array makeMutable(ndarray::Array const & a) { + return a; +} + +template +ndarray::ArrayRef makeMutable(ndarray::ArrayRef const & a) { + return a; +} + +template +ndarray::Array makeMutable(ndarray::Array const & a) { + return ndarray::const_array_cast(a); +} + +template +ndarray::ArrayRef makeMutable(ndarray::ArrayRef const & a) { + return ndarray::const_array_cast(a.shallow()).deep(); +} + +template +void testAsEigen1(A const & a) { + typedef typename boost::remove_const::type T; + ndarray::asEigen(makeMutable(a)).setRandom(); + int const n = asEigenMatrix(a).size(); + testElements1(a, ndarray::asEigen(a)); + Eigen::Matrix m1(n, 6); + m1.setRandom(n, 6); + Eigen::Matrix m2(6, 1); + m2.setRandom(6, 1); + asEigenMatrix(makeMutable(a)) = m1 * m2; + Eigen::Matrix m3 = m1 * m2; + for (int i = 0; i < n; ++i) { + BOOST_CHECK(a[i] == m3(i)); + } + Eigen::Array m4(n, 1); + m4.setRandom(); + Eigen::Array m5 = m4 * asEigenArray(a); + Eigen::Array m6 = m4 * m3.array(); + BOOST_CHECK((m5 == m6).all()); +} + +template +void testAsEigen2(A const & a) { + typedef typename boost::remove_const::type T; + ndarray::asEigen(makeMutable(a)).setRandom(); + int const m = asEigenMatrix(a).rows(); + int const n = asEigenMatrix(a).cols(); + testElements2(a, ndarray::asEigen(a)); + Eigen::Matrix m1(m, 6); + m1.setRandom(m, 6); + Eigen::Matrix m2(6, n); + m2.setRandom(6, n); + asEigenMatrix(makeMutable(a)) = m1 * m2; + Eigen::Matrix m3 = m1 * m2; + for (int i = 0; i < m; ++i) { + for (int j = 0; j < n; ++j) { + BOOST_CHECK(a[i][j] == m3(i, j)); + } + } + Eigen::Array m4(m, n); + m4.setRandom(); + Eigen::Array m5 = m4 * asEigenArray(a); + Eigen::Array m6 = m4 * m3.array(); + BOOST_CHECK((m5 == m6).all()); +} + +template +void invokeAsEigenTests() { + ndarray::Array a22(ndarray::allocate(5, 4)); + testAsEigen2<5, 4, XprKind>(a22); + + ndarray::Array a21(a22[ndarray::view()(0, 3)]); + testAsEigen2<5, 3, XprKind>(a21); + testAsEigen2<3, 5, XprKind>(a21.transpose()); + + ndarray::Array a20(a22[ndarray::view()(0, 4, 2)]); + testAsEigen2<5, 2, XprKind>(a20); + testAsEigen2<2, 5, XprKind>(a20.transpose()); + + ndarray::Array a11(ndarray::allocate(4)); + testAsEigen1<4, XprKind>(a11); + testAsEigen1<4, XprKind>(a11.transpose()); + ndarray::Array a10(a11[ndarray::view(0, 4, 2)]); + testAsEigen1<2, XprKind>(a10); + testAsEigen1<2, XprKind>(a10.transpose()); +} + template void testEigenView(ndarray::EigenView b) { ndarray::Array a(b.shallow()); @@ -158,6 +246,13 @@ void invokeEigenViewTests() { testEigenView(a10.transpose().asEigen()); } +BOOST_AUTO_TEST_CASE(AsEigen) { + invokeAsEigenTests(); + invokeAsEigenTests(); + invokeAsEigenTests(); + invokeAsEigenTests(); +} + BOOST_AUTO_TEST_CASE(EigenView) { invokeEigenViewTests(); invokeEigenViewTests(); From deeece7b561ea55ccd64b6253b10891dda348aa5 Mon Sep 17 00:00:00 2001 From: Russell Owen Date: Wed, 13 Jun 2018 14:39:02 -0700 Subject: [PATCH 17/69] Move EigenView to its own header file --- .gitignore | 1 + include/ndarray/EigenView.h | 435 ++++++++++++++++++++++++++++++ include/ndarray/buildOptions.h.in | 5 + include/ndarray/eigen.h | 406 +--------------------------- 4 files changed, 443 insertions(+), 404 deletions(-) create mode 100644 include/ndarray/EigenView.h create mode 100644 include/ndarray/buildOptions.h.in diff --git a/.gitignore b/.gitignore index 66961134..64a6a583 100644 --- a/.gitignore +++ b/.gitignore @@ -19,6 +19,7 @@ tests/ndarray tests/ndarray-eigen tests/ndarray-fft tests/swig_test_mod.py +include/ndarray/buildOptions.h include/ndarray/Array.h include/ndarray/ArrayBaseN.h include/ndarray/ArrayRef.h diff --git a/include/ndarray/EigenView.h b/include/ndarray/EigenView.h new file mode 100644 index 00000000..103d7a5e --- /dev/null +++ b/include/ndarray/EigenView.h @@ -0,0 +1,435 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2012, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ +#ifndef NDARRAY_EigenView_h_INCLUDED +#define NDARRAY_EigenView_h_INCLUDED +#ifdef ENABLE_EIGENVIEW + +/** + * @file ndarray/EigenView.h + * @brief ndarray::EigenView presents a reference-counted Eigen view into an ndarray::Array. + * + * \note This file is not included by the main "ndarray.h" header file. + */ + +#if defined __GNUC__ && __GNUC__>=6 + #pragma GCC diagnostic ignored "-Wignored-attributes" + #pragma GCC diagnostic ignored "-Wdeprecated-declarations" +#endif + +#include "Eigen/Core" +#include "ndarray.h" +#include "ndarray/eigen_fwd.h" + +namespace ndarray { +namespace detail { + +template +struct EigenStrideTraits<1,0,Rows,1> { + enum { + InnerStride = Eigen::Dynamic, + OuterStride = Eigen::Dynamic, + IsVector = 1, + Flags = Eigen::LinearAccessBit, + Options = Eigen::ColMajor | Eigen::AutoAlign + }; + static int getInnerStride(Core<1> const & core) { return core.getStride(); } + static int getOuterStride(Core<1> const & core) { return core.getSize() * core.getStride(); } + static int getRowStride(Core<1> const & core) { return core.getStride(); } + static int getColStride(Core<1> const & core) { return core.getSize() * core.getStride(); } + static int getRows(Core<1> const & core) { return core.getSize(); } + static int getCols(Core<1> const & core) { return 1; } +}; + +template +struct EigenStrideTraits<1,0,1,Cols> { + enum { + InnerStride = Eigen::Dynamic, + OuterStride = Eigen::Dynamic, + IsVector = 1, + Flags = Eigen::LinearAccessBit | Eigen::RowMajorBit, + Options = Eigen::RowMajor | Eigen::AutoAlign + }; + static int getInnerStride(Core<1> const & core) { return core.getStride(); } + static int getOuterStride(Core<1> const & core) { return core.getSize() * core.getStride(); } + static int getRowStride(Core<1> const & core) { return core.getSize() * core.getStride(); } + static int getColStride(Core<1> const & core) { return core.getStride(); } + static int getRows(Core<1> const & core) { return 1; } + static int getCols(Core<1> const & core) { return core.getSize(); } +}; + +template +struct EigenStrideTraits<1,C,1,1> { + enum { + InnerStride = Eigen::Dynamic, + OuterStride = Eigen::Dynamic, + IsVector = 1, + Flags = Eigen::LinearAccessBit, + Options = Eigen::ColMajor | Eigen::AutoAlign + }; + static int getInnerStride(Core<1> const & core) { return core.getStride(); } + static int getOuterStride(Core<1> const & core) { return core.getStride(); } + static int getRowStride(Core<1> const & core) { return core.getStride(); } + static int getColStride(Core<1> const & core) { return core.getStride(); } + static int getRows(Core<1> const & core) { return 1; } + static int getCols(Core<1> const & core) { return 1; } +}; + +template +struct EigenStrideTraits<1,C,Rows,1> { + enum { + InnerStride = 1, + OuterStride = Eigen::Dynamic, + IsVector = 1, + Flags = Eigen::LinearAccessBit | Eigen::PacketAccessBit, + Options = Eigen::ColMajor | Eigen::AutoAlign + }; + static int getInnerStride(Core<1> const & core) { return 1; } + static int getOuterStride(Core<1> const & core) { return core.getSize(); } + static int getRowStride(Core<1> const & core) { return 1; } + static int getColStride(Core<1> const & core) { return core.getSize(); } + static int getRows(Core<1> const & core) { return core.getSize(); } + static int getCols(Core<1> const & core) { return 1;} +}; + +template +struct EigenStrideTraits<1,C,1,Cols> { + enum { + InnerStride = 1, + OuterStride = Eigen::Dynamic, + IsVector = 1, + Flags = Eigen::LinearAccessBit | Eigen::RowMajorBit | Eigen::PacketAccessBit, + Options = Eigen::RowMajor | Eigen::AutoAlign + }; + static int getInnerStride(Core<1> const & core) { return 1; } + static int getOuterStride(Core<1> const & core) { return core.getSize(); } + static int getRowStride(Core<1> const & core) { return core.getSize(); } + static int getColStride(Core<1> const & core) { return 1; } + static int getRows(Core<1> const & core) { return 1; } + static int getCols(Core<1> const & core) { return core.getSize(); } +}; + +template +struct EigenStrideTraits<2,0,Rows,Cols> { + enum { + InnerStride = Eigen::Dynamic, + OuterStride = Eigen::Dynamic, + IsVector = 0, + Flags = 0, + Options = Eigen::ColMajor | Eigen::AutoAlign + }; + static int getInnerStride(Core<2> const & core) { return core.getStride(); } + static int getOuterStride(Core<1> const & core) { return core.getStride(); } + static int getRowStride(Core<2> const & core) { return core.getStride(); } + static int getColStride(Core<1> const & core) { return core.getStride(); } + static int getRows(Core<2> const & core) { return core.getSize(); } + static int getCols(Core<1> const & core) { return core.getSize(); } +}; + +template +struct EigenStrideTraits<2,1,Rows,Cols> { + enum { + InnerStride = 1, + OuterStride = Eigen::Dynamic, + IsVector = 0, + Flags = Eigen::RowMajorBit | Eigen::PacketAccessBit, + Options = Eigen::RowMajor | Eigen::AutoAlign + }; + static int getInnerStride(Core<1> const & core) { return 1; } + static int getOuterStride(Core<2> const & core) { return core.getStride(); } + static int getRowStride(Core<2> const & core) { return core.getStride(); } + static int getColStride(Core<1> const & core) { return 1; } + static int getRows(Core<2> const & core) { return core.getSize(); } + static int getCols(Core<1> const & core) { return core.getSize(); } +}; + +template +struct EigenStrideTraits<2,2,Rows,Cols> : public EigenStrideTraits<2,1,Rows,Cols> {}; + +template +struct EigenStrideTraits<2,-1,Rows,Cols> { + enum { + InnerStride = 1, + OuterStride = Eigen::Dynamic, + IsVector = 0, + Flags = Eigen::PacketAccessBit, + Options = Eigen::ColMajor | Eigen::AutoAlign + }; + static int getInnerStride(Core<2> const & core) { return 1; } + static int getOuterStride(Core<1> const & core) { return core.getStride(); } + static int getRowStride(Core<2> const & core) { return 1; } + static int getColStride(Core<1> const & core) { return core.getStride(); } + static int getRows(Core<2> const & core) { return core.getSize(); } + static int getCols(Core<1> const & core) { return core.getSize(); } +}; + +template +struct EigenStrideTraits<2,-2,Rows,Cols> : public EigenStrideTraits<2,-1,Rows,Cols> {}; + +} // namespace detail +} // namespace ndarray + + +namespace Eigen { +namespace internal { + +template +struct traits< ndarray::EigenView > { + typedef DenseIndex Index; + typedef Dense StorageKind; + typedef XprKind_ XprKind; + typedef typename boost::remove_const::type Scalar; + enum { + RowsAtCompileTime = Rows, + ColsAtCompileTime = Cols, + MaxRowsAtCompileTime = Rows, + MaxColsAtCompileTime = Cols, + InnerStrideAtCompileTime = ndarray::detail::EigenStrideTraits::InnerStride, + OuterStrideAtCompileTime = ndarray::detail::EigenStrideTraits::OuterStride, + IsVectorAtCompileTime = ndarray::detail::EigenStrideTraits::IsVector, + Flags = ndarray::detail::EigenStrideTraits::Flags + | Eigen::NestByRefBit | Eigen::DirectAccessBit + | (boost::is_const::value ? 0 : Eigen::LvalueBit), + CoeffReadCost = NumTraits::ReadCost + }; +}; + +} // namespace internal +} // namespace Eigen + +namespace ndarray { + +/** + * @brief Eigen3 view into an ndarray::Array. + * + * EigenView provides an Eigen DenseBase-derived object based on an ndarray::Array internally. + * Any one or two dimensional Array can be viewed as an Eigen object. + * + * Assignment to an EigenView is deep, and uses the Eigen assignment operators, but construction + * from an ndarray::Array or ArrayRef is shallow with reference counting. Block and transpose + * operations use the standard Eigen Block and Transpose classes, and do not do reference counting + * (in fact, they hold a plain C++ reference to the EigenView, so they should be considered extremely + * temporary). + * + * @todo Add reference-counted share and transpose operations that return EigenViews. + * + * @ingroup EigenGroup + */ +template +class EigenView + : public Eigen::internal::dense_xpr_base< EigenView >::type +{ + typedef detail::EigenStrideTraits ST; + typedef detail::ArrayAccess< Array > Access; + + void checkDimensions() { + NDARRAY_ASSERT( Rows_ == Eigen::Dynamic || Rows_ == rows() ); + NDARRAY_ASSERT( Cols_ == Eigen::Dynamic || Cols_ == cols() ); + } + +public: + + typedef typename Eigen::internal::dense_xpr_base< EigenView >::type Base; + + EIGEN_DENSE_PUBLIC_INTERFACE(EigenView) + + enum { Options = ST::Options }; + + typedef typename boost::mpl::if_< + boost::is_same, + Eigen::Matrix, + Eigen::Array + >::type PlainEigenType; + + typedef T * PointerType; + + EigenView() : _array() {} + + EigenView(EigenView const & other) : _array(other._array) {} + + explicit EigenView(Array const & array) : _array(array) { checkDimensions(); } + + EigenView & operator=(EigenView const & other) { + // Weird behavior to please SWIG: if we're default-constructed, and it's an exact match, + // do shallow assignment; otherwise all assignment is deep. + if (_array.getData() == 0) { + _array = other._array; + } else { + Base::operator=(other); + } + return *this; + } + + template + EigenView & operator=(Eigen::DenseBase const & other) { + return Base::operator=(other); + } + + template + EigenView & operator=(Eigen::EigenBase const & other) { + return Base::operator=(other); + } + + template + EigenView & operator=(Eigen::ReturnByValue const & other) { + return Base::operator=(other); + } + + inline Index innerStride() const { return ST::getInnerStride(*Access::getCore(_array)); } + inline Index outerStride() const { return ST::getOuterStride(*Access::getCore(_array)); } + + inline Index rowStride() const { return ST::getRowStride(*Access::getCore(_array)); } + inline Index colStride() const { return ST::getColStride(*Access::getCore(_array)); } + + inline Index rows() const { return ST::getRows(*Access::getCore(_array)); } + inline Index cols() const { return ST::getCols(*Access::getCore(_array)); } + + inline T* data() const { return _array.getData(); } + + inline T* data() { return _array.getData(); } + + inline T& coeff(Index row, Index col) const { + return _array.getData()[row * rowStride() + col * colStride()]; + } + + inline T& coeff(Index index) const { + return _array.getData()[index * innerStride()]; + } + + inline T& coeffRef(Index row, Index col) const { + return _array.getData()[row * rowStride() + col * colStride()]; + } + + inline T& coeffRef(Index row, Index col) { + return _array.getData()[row * rowStride() + col * colStride()]; + } + + inline T& coeffRef(Index index) const { + return _array.getData()[index * innerStride()]; + } + + inline T& coeffRef(Index index) { + return _array.getData()[index * innerStride()]; + } + + template + inline PacketScalar packet(Index row, Index col) const { + return Eigen::internal::ploadt( + _array.getData() + (col * colStride() + row * rowStride()) + ); + } + + template + inline PacketScalar packet(Index index) const { + BOOST_STATIC_ASSERT( N == 1 ); + return Eigen::internal::ploadt( + _array.getData() + index * innerStride() + ); + } + + template + inline void writePacket(Index row, Index col, const PacketScalar& x) { + BOOST_STATIC_ASSERT( !boost::is_const::value ); + Eigen::internal::pstoret( + _array.getData() + (col * colStride() + row * rowStride()), x + ); + } + + template + inline void writePacket(Index index, const PacketScalar& x) { + BOOST_STATIC_ASSERT( !boost::is_const::value ); + BOOST_STATIC_ASSERT( N == 1 ); + Eigen::internal::pstoret( + _array.getData() + index * innerStride(), x + ); + } + + Array const & shallow() const { return _array; } + ArrayRef deep() const { return _array.deep(); } + + void reset(Array const & array = Array()) { _array = array; checkDimensions(); } + void reset(ArrayRef const & array) { reset(array.shallow()); } + + void swap(EigenView & other) { _array.swap(other._array); } + + using Base::swap; + +private: + Array _array; +}; + +/// @brief A metafunction that computes the EigenView instantiation that most closely matches an Eigen type. +template +struct SelectEigenView { + typedef Eigen::internal::traits Traits; + typedef typename Traits::Scalar Scalar; + typedef typename boost::mpl::if_< boost::is_const, Scalar const, Scalar >::type Element; + typedef typename Traits::XprKind XprKind; + enum { + N = 2, + C = ((contiguous) ? ((Traits::Flags & Eigen::RowMajorBit) ? 2 : -2) : 0), + Rows = Traits::RowsAtCompileTime, + Cols = Traits::ColsAtCompileTime + }; + typedef Array Shallow; + typedef ArrayRef Deep; + typedef EigenView Type; +}; + +/// @brief Copy an arbitrary Eigen expression into a new EigenView. +template +inline typename SelectEigenView::Type copy(Eigen::EigenBase const & other) { + typename SelectEigenView::Type result( + typename SelectEigenView::Shallow(allocate(other.rows(), other.cols())) + ); + result = other.derived(); + return result; +} + +template +template +inline EigenView::Element, ArrayBase::ND::value, + ArrayBase::RMC::value, XprKind, Rows, Cols + > +ArrayBase::asEigen() const { + return EigenView::Element, ArrayBase::ND::value, + ArrayBase::RMC::value, XprKind, Rows, Cols>(this->getSelf()); +} + +template +template +inline EigenView::Element, ArrayBase::ND::value, + ArrayBase::RMC::value, XprKind> +ArrayBase::asEigen() const { + return EigenView::Element, ArrayBase::ND::value, + ArrayBase::RMC::value, XprKind>(this->getSelf()); +} + +template +template +inline EigenView::Element, ArrayBase::ND::value, + ArrayBase::RMC::value, Eigen::MatrixXpr, Rows, Cols> +ArrayBase::asEigen() const { + return EigenView::Element, ArrayBase::ND::value, + ArrayBase::RMC::value, Eigen::MatrixXpr, Rows, Cols>(this->getSelf()); +} + +template +inline EigenView::Element, ArrayBase::ND::value, + ArrayBase::RMC::value, Eigen::MatrixXpr> +ArrayBase::asEigen() const { + return EigenView::Element, ArrayBase::ND::value, + ArrayBase::RMC::value>(this->getSelf()); +} + +} // namespace ndarray + +#endif // ENABLE_EIGENVIEW_XX +#endif // !NDARRAY_EigenView_h_INCLUDED diff --git a/include/ndarray/buildOptions.h.in b/include/ndarray/buildOptions.h.in new file mode 100644 index 00000000..38ccd2be --- /dev/null +++ b/include/ndarray/buildOptions.h.in @@ -0,0 +1,5 @@ +// Build options that need to be remembered +// so they can be used when other packages build against ndarray + +#cmakedefine NDARRAY_EIGENVIEW +#cmakedefine NDARRAY_STDPYBIND11EIGEN diff --git a/include/ndarray/eigen.h b/include/ndarray/eigen.h index 30e0b644..c2fcf545 100644 --- a/include/ndarray/eigen.h +++ b/include/ndarray/eigen.h @@ -13,7 +13,7 @@ /** * @file ndarray/eigen.h - * @brief Eigen matrix objects that present a view into an ndarray::Array. + * @brief Functions that return an Eigen Map non-reference-counted view into an ndarray::Array. * * \note This file is not included by the main "ndarray.h" header file. */ @@ -26,411 +26,11 @@ #include "Eigen/Core" #include "ndarray.h" #include "ndarray/eigen_fwd.h" +#include "ndarray/EigenView.h" namespace ndarray { namespace detail { -template -struct EigenStrideTraits<1,0,Rows,1> { - enum { - InnerStride = Eigen::Dynamic, - OuterStride = Eigen::Dynamic, - IsVector = 1, - Flags = Eigen::LinearAccessBit, - Options = Eigen::ColMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return core.getStride(); } - static int getOuterStride(Core<1> const & core) { return core.getSize() * core.getStride(); } - static int getRowStride(Core<1> const & core) { return core.getStride(); } - static int getColStride(Core<1> const & core) { return core.getSize() * core.getStride(); } - static int getRows(Core<1> const & core) { return core.getSize(); } - static int getCols(Core<1> const & core) { return 1; } -}; - -template -struct EigenStrideTraits<1,0,1,Cols> { - enum { - InnerStride = Eigen::Dynamic, - OuterStride = Eigen::Dynamic, - IsVector = 1, - Flags = Eigen::LinearAccessBit | Eigen::RowMajorBit, - Options = Eigen::RowMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return core.getStride(); } - static int getOuterStride(Core<1> const & core) { return core.getSize() * core.getStride(); } - static int getRowStride(Core<1> const & core) { return core.getSize() * core.getStride(); } - static int getColStride(Core<1> const & core) { return core.getStride(); } - static int getRows(Core<1> const & core) { return 1; } - static int getCols(Core<1> const & core) { return core.getSize(); } -}; - -template -struct EigenStrideTraits<1,C,1,1> { - enum { - InnerStride = Eigen::Dynamic, - OuterStride = Eigen::Dynamic, - IsVector = 1, - Flags = Eigen::LinearAccessBit, - Options = Eigen::ColMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return core.getStride(); } - static int getOuterStride(Core<1> const & core) { return core.getStride(); } - static int getRowStride(Core<1> const & core) { return core.getStride(); } - static int getColStride(Core<1> const & core) { return core.getStride(); } - static int getRows(Core<1> const & core) { return 1; } - static int getCols(Core<1> const & core) { return 1; } -}; - -template -struct EigenStrideTraits<1,C,Rows,1> { - enum { - InnerStride = 1, - OuterStride = Eigen::Dynamic, - IsVector = 1, - Flags = Eigen::LinearAccessBit | Eigen::PacketAccessBit, - Options = Eigen::ColMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return 1; } - static int getOuterStride(Core<1> const & core) { return core.getSize(); } - static int getRowStride(Core<1> const & core) { return 1; } - static int getColStride(Core<1> const & core) { return core.getSize(); } - static int getRows(Core<1> const & core) { return core.getSize(); } - static int getCols(Core<1> const & core) { return 1;} -}; - -template -struct EigenStrideTraits<1,C,1,Cols> { - enum { - InnerStride = 1, - OuterStride = Eigen::Dynamic, - IsVector = 1, - Flags = Eigen::LinearAccessBit | Eigen::RowMajorBit | Eigen::PacketAccessBit, - Options = Eigen::RowMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return 1; } - static int getOuterStride(Core<1> const & core) { return core.getSize(); } - static int getRowStride(Core<1> const & core) { return core.getSize(); } - static int getColStride(Core<1> const & core) { return 1; } - static int getRows(Core<1> const & core) { return 1; } - static int getCols(Core<1> const & core) { return core.getSize(); } -}; - -template -struct EigenStrideTraits<2,0,Rows,Cols> { - enum { - InnerStride = Eigen::Dynamic, - OuterStride = Eigen::Dynamic, - IsVector = 0, - Flags = 0, - Options = Eigen::ColMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<2> const & core) { return core.getStride(); } - static int getOuterStride(Core<1> const & core) { return core.getStride(); } - static int getRowStride(Core<2> const & core) { return core.getStride(); } - static int getColStride(Core<1> const & core) { return core.getStride(); } - static int getRows(Core<2> const & core) { return core.getSize(); } - static int getCols(Core<1> const & core) { return core.getSize(); } -}; - -template -struct EigenStrideTraits<2,1,Rows,Cols> { - enum { - InnerStride = 1, - OuterStride = Eigen::Dynamic, - IsVector = 0, - Flags = Eigen::RowMajorBit | Eigen::PacketAccessBit, - Options = Eigen::RowMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return 1; } - static int getOuterStride(Core<2> const & core) { return core.getStride(); } - static int getRowStride(Core<2> const & core) { return core.getStride(); } - static int getColStride(Core<1> const & core) { return 1; } - static int getRows(Core<2> const & core) { return core.getSize(); } - static int getCols(Core<1> const & core) { return core.getSize(); } -}; - -template -struct EigenStrideTraits<2,2,Rows,Cols> : public EigenStrideTraits<2,1,Rows,Cols> {}; - -template -struct EigenStrideTraits<2,-1,Rows,Cols> { - enum { - InnerStride = 1, - OuterStride = Eigen::Dynamic, - IsVector = 0, - Flags = Eigen::PacketAccessBit, - Options = Eigen::ColMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<2> const & core) { return 1; } - static int getOuterStride(Core<1> const & core) { return core.getStride(); } - static int getRowStride(Core<2> const & core) { return 1; } - static int getColStride(Core<1> const & core) { return core.getStride(); } - static int getRows(Core<2> const & core) { return core.getSize(); } - static int getCols(Core<1> const & core) { return core.getSize(); } -}; - -template -struct EigenStrideTraits<2,-2,Rows,Cols> : public EigenStrideTraits<2,-1,Rows,Cols> {}; - -} // namespace detail -} // namespace ndarray - - -namespace Eigen { -namespace internal { - -template -struct traits< ndarray::EigenView > { - typedef DenseIndex Index; - typedef Dense StorageKind; - typedef XprKind_ XprKind; - typedef typename boost::remove_const::type Scalar; - enum { - RowsAtCompileTime = Rows, - ColsAtCompileTime = Cols, - MaxRowsAtCompileTime = Rows, - MaxColsAtCompileTime = Cols, - InnerStrideAtCompileTime = ndarray::detail::EigenStrideTraits::InnerStride, - OuterStrideAtCompileTime = ndarray::detail::EigenStrideTraits::OuterStride, - IsVectorAtCompileTime = ndarray::detail::EigenStrideTraits::IsVector, - Flags = ndarray::detail::EigenStrideTraits::Flags - | Eigen::NestByRefBit | Eigen::DirectAccessBit - | (boost::is_const::value ? 0 : Eigen::LvalueBit), - CoeffReadCost = NumTraits::ReadCost - }; -}; - -} // namespace internal -} // namespace Eigen - -namespace ndarray { - -/** - * @brief Eigen3 view into an ndarray::Array. - * - * EigenView provides an Eigen DenseBase-derived object based on an ndarray::Array internally. - * Any one or two dimensional Array can be viewed as an Eigen object. - * - * Assignment to an EigenView is deep, and uses the Eigen assignment operators, but construction - * from an ndarray::Array or ArrayRef is shallow with reference counting. Block and transpose - * operations use the standard Eigen Block and Transpose classes, and do not do reference counting - * (in fact, they hold a plain C++ reference to the EigenView, so they should be considered extremely - * temporary). - * - * @todo Add reference-counted share and transpose operations that return EigenViews. - * - * @ingroup EigenGroup - */ -template -class EigenView - : public Eigen::internal::dense_xpr_base< EigenView >::type -{ - typedef detail::EigenStrideTraits ST; - typedef detail::ArrayAccess< Array > Access; - - void checkDimensions() { - NDARRAY_ASSERT( Rows_ == Eigen::Dynamic || Rows_ == rows() ); - NDARRAY_ASSERT( Cols_ == Eigen::Dynamic || Cols_ == cols() ); - } - -public: - - typedef typename Eigen::internal::dense_xpr_base< EigenView >::type Base; - - EIGEN_DENSE_PUBLIC_INTERFACE(EigenView) - - enum { Options = ST::Options }; - - typedef typename boost::mpl::if_< - boost::is_same, - Eigen::Matrix, - Eigen::Array - >::type PlainEigenType; - - typedef T * PointerType; - - EigenView() : _array() {} - - EigenView(EigenView const & other) : _array(other._array) {} - - explicit EigenView(Array const & array) : _array(array) { checkDimensions(); } - - EigenView & operator=(EigenView const & other) { - // Weird behavior to please SWIG: if we're default-constructed, and it's an exact match, - // do shallow assignment; otherwise all assignment is deep. - if (_array.getData() == 0) { - _array = other._array; - } else { - Base::operator=(other); - } - return *this; - } - - template - EigenView & operator=(Eigen::DenseBase const & other) { - return Base::operator=(other); - } - - template - EigenView & operator=(Eigen::EigenBase const & other) { - return Base::operator=(other); - } - - template - EigenView & operator=(Eigen::ReturnByValue const & other) { - return Base::operator=(other); - } - - inline Index innerStride() const { return ST::getInnerStride(*Access::getCore(_array)); } - inline Index outerStride() const { return ST::getOuterStride(*Access::getCore(_array)); } - - inline Index rowStride() const { return ST::getRowStride(*Access::getCore(_array)); } - inline Index colStride() const { return ST::getColStride(*Access::getCore(_array)); } - - inline Index rows() const { return ST::getRows(*Access::getCore(_array)); } - inline Index cols() const { return ST::getCols(*Access::getCore(_array)); } - - inline T* data() const { return _array.getData(); } - - inline T* data() { return _array.getData(); } - - inline T& coeff(Index row, Index col) const { - return _array.getData()[row * rowStride() + col * colStride()]; - } - - inline T& coeff(Index index) const { - return _array.getData()[index * innerStride()]; - } - - inline T& coeffRef(Index row, Index col) const { - return _array.getData()[row * rowStride() + col * colStride()]; - } - - inline T& coeffRef(Index row, Index col) { - return _array.getData()[row * rowStride() + col * colStride()]; - } - - inline T& coeffRef(Index index) const { - return _array.getData()[index * innerStride()]; - } - - inline T& coeffRef(Index index) { - return _array.getData()[index * innerStride()]; - } - - template - inline PacketScalar packet(Index row, Index col) const { - return Eigen::internal::ploadt( - _array.getData() + (col * colStride() + row * rowStride()) - ); - } - - template - inline PacketScalar packet(Index index) const { - BOOST_STATIC_ASSERT( N == 1 ); - return Eigen::internal::ploadt( - _array.getData() + index * innerStride() - ); - } - - template - inline void writePacket(Index row, Index col, const PacketScalar& x) { - BOOST_STATIC_ASSERT( !boost::is_const::value ); - Eigen::internal::pstoret( - _array.getData() + (col * colStride() + row * rowStride()), x - ); - } - - template - inline void writePacket(Index index, const PacketScalar& x) { - BOOST_STATIC_ASSERT( !boost::is_const::value ); - BOOST_STATIC_ASSERT( N == 1 ); - Eigen::internal::pstoret( - _array.getData() + index * innerStride(), x - ); - } - - Array const & shallow() const { return _array; } - ArrayRef deep() const { return _array.deep(); } - - void reset(Array const & array = Array()) { _array = array; checkDimensions(); } - void reset(ArrayRef const & array) { reset(array.shallow()); } - - void swap(EigenView & other) { _array.swap(other._array); } - - using Base::swap; - -private: - Array _array; -}; - -/// @brief A metafunction that computes the EigenView instantiation that most closely matches an Eigen type. -template -struct SelectEigenView { - typedef Eigen::internal::traits Traits; - typedef typename Traits::Scalar Scalar; - typedef typename boost::mpl::if_< boost::is_const, Scalar const, Scalar >::type Element; - typedef typename Traits::XprKind XprKind; - enum { - N = 2, - C = ((contiguous) ? ((Traits::Flags & Eigen::RowMajorBit) ? 2 : -2) : 0), - Rows = Traits::RowsAtCompileTime, - Cols = Traits::ColsAtCompileTime - }; - typedef Array Shallow; - typedef ArrayRef Deep; - typedef EigenView Type; -}; - -/// @brief Copy an arbitrary Eigen expression into a new EigenView. -template -inline typename SelectEigenView::Type copy(Eigen::EigenBase const & other) { - typename SelectEigenView::Type result( - typename SelectEigenView::Shallow(allocate(other.rows(), other.cols())) - ); - result = other.derived(); - return result; -} - -template -template -inline EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, XprKind, Rows, Cols - > -ArrayBase::asEigen() const { - return EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, XprKind, Rows, Cols>(this->getSelf()); -} - -template -template -inline EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, XprKind> -ArrayBase::asEigen() const { - return EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, XprKind>(this->getSelf()); -} - -template -template -inline EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, Eigen::MatrixXpr, Rows, Cols> -ArrayBase::asEigen() const { - return EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, Eigen::MatrixXpr, Rows, Cols>(this->getSelf()); -} - -template -inline EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, Eigen::MatrixXpr> -ArrayBase::asEigen() const { - return EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value>(this->getSelf()); -} - - -namespace detail { - template struct SelectEigenPlainBase; @@ -465,7 +65,6 @@ struct SelectEigenPlain { typedef typename SelectEigenPlainBase::Type Type; }; - template struct SelectEigenMap; // unspecialized template parameters means not supported. @@ -639,7 +238,6 @@ asEigenMatrix(ArrayRef const & a) { return asEigen(a); } - } // namespace ndarray #endif // !NDARRAY_eigen_h_INCLUDED From 5e9bf9203f117d9fb9ca939ebfb6c6319a74facc Mon Sep 17 00:00:00 2001 From: Russell Owen Date: Wed, 13 Jun 2018 15:10:51 -0700 Subject: [PATCH 18/69] Tweak ndarray-eigen.cc Keep EigenView tests together so they can be disabled with a single #ifdef. Rewrite SVD test case to use Eigen::Map instead of ndarray::EigenView --- tests/ndarray-eigen.cc | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/tests/ndarray-eigen.cc b/tests/ndarray-eigen.cc index cc1528f6..fabeb5a2 100644 --- a/tests/ndarray-eigen.cc +++ b/tests/ndarray-eigen.cc @@ -125,6 +125,13 @@ void invokeAsEigenTests() { testAsEigen1<2, XprKind>(a10.transpose()); } +BOOST_AUTO_TEST_CASE(AsEigen) { + invokeAsEigenTests(); + invokeAsEigenTests(); + invokeAsEigenTests(); + invokeAsEigenTests(); +} + template void testEigenView(ndarray::EigenView b) { ndarray::Array a(b.shallow()); @@ -246,13 +253,6 @@ void invokeEigenViewTests() { testEigenView(a10.transpose().asEigen()); } -BOOST_AUTO_TEST_CASE(AsEigen) { - invokeAsEigenTests(); - invokeAsEigenTests(); - invokeAsEigenTests(); - invokeAsEigenTests(); -} - BOOST_AUTO_TEST_CASE(EigenView) { invokeEigenViewTests(); invokeEigenViewTests(); @@ -270,12 +270,13 @@ void testSVD(Matrix const & a, Vector const & b, Vector & x) { } BOOST_AUTO_TEST_CASE(SVD) { - typedef ndarray::EigenView Matrix; - typedef ndarray::EigenView Vector; - Matrix a(ndarray::allocate(8,5)); - Vector b(ndarray::allocate(8)); - Vector x(ndarray::allocate(5)); + auto aArray = ndarray::Array(ndarray::allocate(8,5)); + auto bArray = ndarray::Array(ndarray::allocate(8)); + auto xArray = ndarray::Array(ndarray::allocate(5)); + auto a = ndarray::asEigenMatrix(aArray); + auto b = ndarray::asEigenMatrix(bArray); + auto x = ndarray::asEigenMatrix(xArray); a.setRandom(); b.setRandom(); - testSVD< Eigen::JacobiSVD >(a, b, x); + testSVD>(a, b, x); } From 981ffc125f34ea9c0dfc2645f4995c7caad7eef2 Mon Sep 17 00:00:00 2001 From: Russell Owen Date: Wed, 13 Jun 2018 15:14:46 -0700 Subject: [PATCH 19/69] Support disabling EigenView with Cmake using the new flag NDARRAY_EIGENVIEW, which is OFF by default. Also support enabling the standard pybind11 Eigen wrapper using new flag NDARRAY_STDPYBIND11EIGEN, which is OFF by default; this option is primarily intended for use with packages that used EigenView in pybind11 wrappers, to reduce the changes required. --- CMakeLists.txt | 6 +++++ include/CMakeLists.txt | 13 +++++++---- include/ndarray/ArrayBase.h | 10 ++++++++ include/ndarray/EigenView.h | 6 +++-- include/ndarray/converter/eigen.h | 4 ++++ include/ndarray/eigen/bp/Array.h | 4 ++++ include/ndarray/eigen/bp/EigenView.h | 4 ++++ include/ndarray/eigen/bp/Matrix.h | 4 ++++ include/ndarray/eigen/bp/auto/EigenView.h.m4 | 4 ++++ include/ndarray/eigen_fwd.h | 6 +++++ include/ndarray/pybind11.h | 10 ++++++++ tests/eigen_bp_test_mod.cc | 14 ++++++++++++ tests/ndarray-eigen.cc | 5 ++++ tests/pybind11_test.py | 24 +++++++++++++------- tests/pybind11_test_mod.cc | 17 ++++++++++++++ 15 files changed, 116 insertions(+), 15 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 59eba0bc..e127550d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -17,6 +17,8 @@ project(ndarray) option(NDARRAY_SWIG "Enable .i file installation and swig tests?" ON) option(NDARRAY_TEST "Enable tests?" ON) option(NDARRAY_EIGEN "Enable Eigen tests?" ON) +option(NDARRAY_EIGENVIEW "Enable ndarray::EigenView (requires Eigen < 3.3)?" OFF) +option(NDARRAY_STDPYBIND11EIGEN "Enable standard pybind11 Eigen wrappers (requires Eigen > 3.2.5)?" OFF) option(NDARRAY_FFTW "Enable FFTW tests?" ON) option(NDARRAY_PYBIND11 "Enable Pybind11 tests?" OFF) @@ -41,6 +43,10 @@ if(DOXYGEN_FOUND) ) endif(DOXYGEN_FOUND) +if(NDARRAY_EIGENVIEW AND NDARRAY_STDPYBIND11EIGEN) + message(FATAL_ERROR "NDARRAY_EIGENVIEW and NDARRAY_STDPYBIND11EIGEN cannot both be enabled") +endif() + if(NDARRAY_TEST) enable_testing() add_subdirectory(tests) diff --git a/include/CMakeLists.txt b/include/CMakeLists.txt index 9a1b3fa5..c86cc992 100644 --- a/include/CMakeLists.txt +++ b/include/CMakeLists.txt @@ -21,11 +21,11 @@ foreach(FILENAME ${FILES2}) endforeach(FILENAME) foreach(FILENAME ${PREPROCESS_FILES1}) - add_custom_command ( - OUTPUT ${FILENAME} - DEPENDS ${FILENAME}.m4 - COMMAND m4 ${FILENAME}.m4 > ${FILENAME} - ) + add_custom_command ( + OUTPUT ${FILENAME} + DEPENDS ${FILENAME}.m4 "ndarray/buildOptions.h.in" + COMMAND m4 ${FILENAME}.m4 > ${FILENAME} + ) endforeach(FILENAME) foreach(FILENAME ${PREPROCESS_FILES2}) @@ -36,6 +36,9 @@ foreach(FILENAME ${PREPROCESS_FILES2}) ) endforeach(FILENAME) +# record certain build options +configure_file(ndarray/buildOptions.h.in "${CMAKE_CURRENT_SOURCE_DIR}/ndarray/buildOptions.h") + add_custom_target(preprocess_includes1 ALL DEPENDS ${PREPROCESS_FILES1}) add_custom_target(preprocess_includes2 ALL DEPENDS ${PREPROCESS_FILES2}) add_dependencies(preprocess_includes2 preprocess_includes1) diff --git a/include/ndarray/ArrayBase.h b/include/ndarray/ArrayBase.h index 3af4be5d..ede9b80b 100644 --- a/include/ndarray/ArrayBase.h +++ b/include/ndarray/ArrayBase.h @@ -28,8 +28,14 @@ #include "ndarray/detail/ArrayAccess.h" #include "ndarray/detail/ViewBuilder.h" #include "ndarray/ArrayTraits.h" +#include "ndarray/buildOptions.h" + +#ifdef NDARRAY_EIGENVIEW + #include "ndarray/eigen_fwd.h" +#endif // NDARRAY_EIGENVIEW + namespace ndarray { /** @@ -191,6 +197,8 @@ class ArrayBase : public ExpressionBase { /// @brief Return an ArrayRef view to this. Deep const deep() const { return Deep(this->getSelf()); } +#ifdef NDARRAY_EIGENVIEW + //@{ /** * @name Eigen3 Interface @@ -213,6 +221,8 @@ class ArrayBase : public ExpressionBase { EigenView asEigen() const; //@} +#endif // NDARRAY_EIGENVIEW + /// @brief A template metafunction class to determine the result of a view indexing operation. template struct ResultOf { diff --git a/include/ndarray/EigenView.h b/include/ndarray/EigenView.h index 103d7a5e..55453863 100644 --- a/include/ndarray/EigenView.h +++ b/include/ndarray/EigenView.h @@ -10,7 +10,6 @@ */ #ifndef NDARRAY_EigenView_h_INCLUDED #define NDARRAY_EigenView_h_INCLUDED -#ifdef ENABLE_EIGENVIEW /** * @file ndarray/EigenView.h @@ -27,6 +26,9 @@ #include "Eigen/Core" #include "ndarray.h" #include "ndarray/eigen_fwd.h" +#include "ndarray/buildOptions.h" + +#ifdef NDARRAY_EIGENVIEW namespace ndarray { namespace detail { @@ -431,5 +433,5 @@ ArrayBase::asEigen() const { } // namespace ndarray -#endif // ENABLE_EIGENVIEW_XX +#endif // NDARRAY_EIGENVIEW #endif // !NDARRAY_EigenView_h_INCLUDED diff --git a/include/ndarray/converter/eigen.h b/include/ndarray/converter/eigen.h index 9f56fb5e..96d89987 100644 --- a/include/ndarray/converter/eigen.h +++ b/include/ndarray/converter/eigen.h @@ -16,10 +16,13 @@ * @brief Python C-API conversions for Eigen matrices. */ +#include "ndarray/buildOptions.h" #include "ndarray/eigen.h" #include "ndarray/converter.h" #include "ndarray/converter/eigen.h" +#ifdef NDARRAY_EIGENVIEW + namespace ndarray { /** @@ -146,4 +149,5 @@ struct PyConverter< Eigen::Array > } // namespace ndarray +#endif // NDARRAY_EIGENVIEW #endif // !NDARRAY_CONVERTER_eigen_h_INCLUDED diff --git a/include/ndarray/eigen/bp/Array.h b/include/ndarray/eigen/bp/Array.h index 41644121..a6233366 100644 --- a/include/ndarray/eigen/bp/Array.h +++ b/include/ndarray/eigen/bp/Array.h @@ -12,6 +12,9 @@ #define NDARRAY_EIGEN_BP_Array_h_INCLUDED #include "ndarray/eigen/bp/EigenView.h" +#include "buildOptions.h" + +#ifdef NDARRAY_EIGENVIEW namespace ndarray { @@ -52,4 +55,5 @@ class FromBoostPython< Eigen::Array > } // namespace ndarray +#endif // NDARRAY_EIGENVIEW #endif // !NDARRAY_EIGEN_BP_Matrix_h_INCLUDED diff --git a/include/ndarray/eigen/bp/EigenView.h b/include/ndarray/eigen/bp/EigenView.h index ae6c84d4..fa2bdbf0 100644 --- a/include/ndarray/eigen/bp/EigenView.h +++ b/include/ndarray/eigen/bp/EigenView.h @@ -14,6 +14,9 @@ #include "boost/numpy.hpp" #include "ndarray/bp/Array.h" #include "ndarray/eigen.h" +#include "ndarray/buildOptions.h" + +#ifdef NDARRAY_EIGENVIEW namespace ndarray { @@ -77,4 +80,5 @@ class FromBoostPython< EigenView > { } // namespace ndarray +#endif // NDARRAY_EIGENVIEW #endif // !NDARRAY_EIGEN_BP_EigenView_h_INCLUDED diff --git a/include/ndarray/eigen/bp/Matrix.h b/include/ndarray/eigen/bp/Matrix.h index 73163ce6..895115b0 100644 --- a/include/ndarray/eigen/bp/Matrix.h +++ b/include/ndarray/eigen/bp/Matrix.h @@ -12,6 +12,9 @@ #define NDARRAY_EIGEN_BP_Matrix_h_INCLUDED #include "ndarray/eigen/bp/EigenView.h" +#include "ndarray/buildOptions.h" + +#ifdef NDARRAY_EIGENVIEW namespace ndarray { @@ -52,4 +55,5 @@ class FromBoostPython< Eigen::Matrix > } // namespace ndarray +#endif // NDARRAY_EIGENVIEW #endif // !NDARRAY_EIGEN_BP_Matrix_h_INCLUDED diff --git a/include/ndarray/eigen/bp/auto/EigenView.h.m4 b/include/ndarray/eigen/bp/auto/EigenView.h.m4 index f2087930..994a4502 100644 --- a/include/ndarray/eigen/bp/auto/EigenView.h.m4 +++ b/include/ndarray/eigen/bp/auto/EigenView.h.m4 @@ -16,8 +16,12 @@ changecom(`###')dnl #include "boost/numpy.hpp" #include "ndarray/eigen/bp/EigenView.h" +#include "ndarray/buildOptions.h" + +#ifdef NDARRAY_EIGENVIEW BP_AUTO_CONVERTERS(`typename T, int N, int C, typename XprKind_, int Rows_, int Cols_', `ndarray::EigenView')dnl +#endif // NDARRAY_EIGENVIEW #endif // !NDARRAY_EIGEN_BP_AUTO_EigenView_h_INCLUDED diff --git a/include/ndarray/eigen_fwd.h b/include/ndarray/eigen_fwd.h index c07cd8d3..76831b93 100644 --- a/include/ndarray/eigen_fwd.h +++ b/include/ndarray/eigen_fwd.h @@ -11,6 +11,8 @@ #ifndef NDARRAY_eigen_fwd_h_INCLUDED #define NDARRAY_eigen_fwd_h_INCLUDED +#include "ndarray/buildOptions.h" + /** * @file ndarray/eigen_fwd.h * @brief Forward declarations for ndarray/eigen interface. @@ -34,6 +36,8 @@ template struct EigenStrideTraits; } // namespace detail +#ifdef NDARRAY_EIGENVIEW + template < typename T, int N, int C, typename XprKind_=Eigen::MatrixXpr, @@ -42,6 +46,8 @@ template < > class EigenView; +#endif // NDARRAY_EIGENVIEW + } // namespace ndarray #endif // !NDARRAY_eigen_fwd_h_INCLUDED diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index a6e4dc7f..0f1fea73 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -44,9 +44,15 @@ #include "pybind11.h" #include "pybind11/numpy.h" +#include "ndarray/buildOptions.h" +#ifdef NDARRAY_STDPYBIND11EIGEN +#include "pybind11/eigen.h" +#endif // NDARRAY_STDPYBIND11EIGEN + #include "ndarray.h" #include "ndarray/eigen.h" #include "ndarray/converter/PyManager.h" +#include "ndarray/buildOptions.h" namespace ndarray { @@ -221,6 +227,8 @@ class type_caster< ndarray::Array > { Helper _helper; }; +#ifdef NDARRAY_EIGENVIEW + /* @brief A pybind11 type_caster for ndarray::EigenView */ template @@ -404,6 +412,8 @@ class type_caster< Eigen::Matrix > { type_caster< InputView > _nested; }; +#endif // NDARRAY_EIGENVIEW + NAMESPACE_END(detail) NAMESPACE_END(pybind11) diff --git a/tests/eigen_bp_test_mod.cc b/tests/eigen_bp_test_mod.cc index 5c1ba008..7ae6224c 100644 --- a/tests/eigen_bp_test_mod.cc +++ b/tests/eigen_bp_test_mod.cc @@ -8,6 +8,7 @@ * of the source distribution, or alternately available at: * https://github.com/ndarray/ndarray */ +#include "ndarray/buildOptions.h" #include "ndarray/eigen/bp/auto.h" namespace bp = boost::python; @@ -35,6 +36,8 @@ void fillMatrix(M & m) { m(1,2) = 6; } +#ifdef NDARRAY_EIGENVIEW + template M returnEigenView() { static typename boost::remove_const::type>::type m( @@ -44,6 +47,8 @@ M returnEigenView() { return m; } +#endif NDARRAY_EIGENVIEW + template M returnMatrix() { static typename boost::remove_const::type>::type m(2,3); @@ -102,6 +107,8 @@ class MatrixOwner { static const int X = Eigen::Dynamic; +#ifdef NDARRAY_EIGENVIEW + template void wrapEigenView(std::string const & name) { bp::def(("accept" + name + "_2p2").c_str(), @@ -126,8 +133,13 @@ void wrapEigenView(std::string const & name) { returnEigenView >); } +#endif // NDARRAY_EIGENVIEW + BOOST_PYTHON_MODULE(eigen_bp_test_mod) { bn::initialize(); + +#ifdef NDARRAY_EIGENVIEW + wrapEigenView("EigenView_M23d"); wrapEigenView("EigenView_MX3d"); wrapEigenView("EigenView_M2Xd"); @@ -146,6 +158,8 @@ BOOST_PYTHON_MODULE(eigen_bp_test_mod) { wrapEigenView("EigenView_A2Xi"); wrapEigenView("EigenView_AXXi"); +#endif // NDARRAY_EIGENVIEW + bp::def("acceptMatrix_23d_cref", acceptMatrix< Eigen::Matrix const & >); bp::def("acceptMatrix_X3d_cref", acceptMatrix< Eigen::Matrix const & >); bp::def("acceptMatrix_2Xd_cref", acceptMatrix< Eigen::Matrix const & >); diff --git a/tests/ndarray-eigen.cc b/tests/ndarray-eigen.cc index fabeb5a2..475c7a63 100644 --- a/tests/ndarray-eigen.cc +++ b/tests/ndarray-eigen.cc @@ -9,6 +9,7 @@ * https://github.com/ndarray/ndarray */ #include "ndarray/eigen.h" +#include "ndarray/buildOptions.h" #include "Eigen/SVD" #define BOOST_TEST_DYN_LINK @@ -132,6 +133,8 @@ BOOST_AUTO_TEST_CASE(AsEigen) { invokeAsEigenTests(); } +#ifdef NDARRAY_EIGENVIEW + template void testEigenView(ndarray::EigenView b) { ndarray::Array a(b.shallow()); @@ -262,6 +265,8 @@ BOOST_AUTO_TEST_CASE(EigenView) { BOOST_CHECK( (v.array() == m.array()).all() ); } +#endif // NDARRAY_EIGENVIEW + template void testSVD(Matrix const & a, Vector const & b, Vector & x) { SVD svd(a, Eigen::ComputeThinU | Eigen::ComputeThinV); diff --git a/tests/pybind11_test.py b/tests/pybind11_test.py index a439973b..b3f1e263 100755 --- a/tests/pybind11_test.py +++ b/tests/pybind11_test.py @@ -13,15 +13,19 @@ import pybind11_test_mod +HasEigenView = hasattr(pybind11_test_mod, "returnMatrixXd") + class TestNumpyPybind11(unittest.TestCase): + @unittest.skipIf(not HasEigenView, "No EigenView") def testMatrixXd(self): m1 = pybind11_test_mod.returnMatrixXd() m2 = numpy.matrix(numpy.arange(15, dtype=float).reshape(3, 5).transpose()) self.assertTrue((m1 == m2).all()) self.assertTrue(pybind11_test_mod.acceptMatrixXd(m2)) + @unittest.skipIf(not HasEigenView, "No EigenView") def testMatrix2d(self): m1 = pybind11_test_mod.returnMatrix2d() m2 = numpy.matrix([[0.0, 2.0], [1.0, 3.0]]) @@ -46,6 +50,7 @@ def testArray3(self): self.assertTrue((a1 == a3).all()) self.assertFalse(a3.flags["WRITEABLE"]) + @unittest.skipIf(not HasEigenView, "No EigenView") def testClass(self): a = pybind11_test_mod.MatrixOwner() m1 = a.member @@ -55,6 +60,7 @@ def testClass(self): self.assertEqual(m1.shape, (2, 2)) self.assertEqual(m2.shape, (2, 2)) + @unittest.skipIf(not HasEigenView, "No EigenView") def testOverloads(self): self.assertEqual(pybind11_test_mod.acceptOverload(1), 0) self.assertEqual(pybind11_test_mod.acceptOverload(numpy.zeros((2, 2), dtype=float)), 2) @@ -81,16 +87,18 @@ def testNone(self): self.assertEqual(pybind11_test_mod.acceptNoneArray(None), 1) self.assertEqual(pybind11_test_mod.acceptNoneArray(), 1) - m1 = pybind11_test_mod.returnMatrixXd() - self.assertEqual(pybind11_test_mod.acceptNoneMatrixXd(m1), 2) - self.assertEqual(pybind11_test_mod.acceptNoneMatrixXd(None), 3) - self.assertEqual(pybind11_test_mod.acceptNoneMatrixXd(), 3) + if HasEigenView: + m1 = pybind11_test_mod.returnMatrixXd() + self.assertEqual(pybind11_test_mod.acceptNoneMatrixXd(m1), 2) + self.assertEqual(pybind11_test_mod.acceptNoneMatrixXd(None), 3) + self.assertEqual(pybind11_test_mod.acceptNoneMatrixXd(), 3) - m2 = pybind11_test_mod.returnMatrix2d() - self.assertEqual(pybind11_test_mod.acceptNoneMatrix2d(m2), 4) - self.assertEqual(pybind11_test_mod.acceptNoneMatrix2d(None), 5) - self.assertEqual(pybind11_test_mod.acceptNoneMatrix2d(), 5) + m2 = pybind11_test_mod.returnMatrix2d() + self.assertEqual(pybind11_test_mod.acceptNoneMatrix2d(m2), 4) + self.assertEqual(pybind11_test_mod.acceptNoneMatrix2d(None), 5) + self.assertEqual(pybind11_test_mod.acceptNoneMatrix2d(), 5) + @unittest.skipIf(not HasEigenView, "No EigenView") def testFullySpecifiedMatrix(self): # Failure on this specific case was not caught by other unit tests a = numpy.array([[1., 0.], [0., 1.]]) diff --git a/tests/pybind11_test_mod.cc b/tests/pybind11_test_mod.cc index 0bd08a34..9489f24e 100644 --- a/tests/pybind11_test_mod.cc +++ b/tests/pybind11_test_mod.cc @@ -1,10 +1,12 @@ #include "pybind11/pybind11.h" #include "ndarray/pybind11.h" +#include "ndarray/buildOptions.h" namespace py = pybind11; using namespace py::literals; +#ifdef NDARRAY_EIGENVIEW Eigen::MatrixXd returnMatrixXd() { Eigen::MatrixXd r(5, 3); for (int n = 0; n < r.size(); ++n) { @@ -20,6 +22,7 @@ Eigen::Matrix2d returnMatrix2d() { } return r; } +#endif // NDARRAY_EIGENVIEW ndarray::Array returnArray1() { ndarray::Array r(ndarray::allocate(ndarray::makeVector(6))); @@ -46,6 +49,7 @@ ndarray::Array returnConstArray3() { return returnArray3(); } +#ifdef NDARRAY_EIGENVIEW bool acceptMatrixXd(Eigen::MatrixXd const & m1) { Eigen::MatrixXd m2 = returnMatrixXd(); return m1 == m2; @@ -55,6 +59,7 @@ bool acceptMatrix2d(Eigen::Matrix2d const & m1) { Eigen::Matrix2d m2 = returnMatrix2d(); return m1 == m2; } +#endif // NDARRAY_EIGENVIEW bool acceptArray1(ndarray::Array const & a1) { ndarray::Array a2 = returnArray1(); @@ -81,6 +86,7 @@ bool acceptArray3(ndarray::Array const & a1) { #endif } +#ifdef NDARRAY_EIGENVIEW int acceptOverload(int n) { return 0; } @@ -92,6 +98,7 @@ int acceptOverload(Eigen::Matrix3d const & m) { int acceptOverload(Eigen::Matrix2d const & m) { return 2; } +#endif // NDARRAY_EIGENVIEW int acceptNoneArray(ndarray::Array const * array = nullptr) { if (array) { @@ -101,6 +108,7 @@ int acceptNoneArray(ndarray::Array const * array = nullptr) { } } +#ifdef NDARRAY_EIGENVIEW int acceptNoneMatrixXd(Eigen::MatrixXd const * matrix = nullptr) { if (matrix) { return 2; @@ -127,10 +135,12 @@ struct MatrixOwner { bool acceptFullySpecifiedMatrix(Eigen::Matrix const & a, Eigen::Matrix const & b) { return true; }; +#endif // NDARRAY_EIGENVIEW PYBIND11_PLUGIN(pybind11_test_mod) { pybind11::module mod("pybind11_test_mod", "Tests for the ndarray library"); +#ifdef NDARRAY_EIGENVIEW py::class_ cls(mod, "MatrixOwner"); cls.def(py::init<>()); @@ -140,22 +150,29 @@ PYBIND11_PLUGIN(pybind11_test_mod) { cls.def("getMember", &MatrixOwner::getMember); mod.def("returnMatrixXd", returnMatrixXd); mod.def("returnMatrix2d", returnMatrix2d); +#endif // NDARRAY_EIGENVIEW mod.def("returnArray1", returnArray1); mod.def("returnConstArray1", returnConstArray1); mod.def("returnArray3", returnArray3); mod.def("returnConstArray3", returnConstArray3); +#ifdef NDARRAY_EIGENVIEW mod.def("acceptMatrixXd", acceptMatrixXd); mod.def("acceptMatrix2d", acceptMatrix2d); +#endif // NDARRAY_EIGENVIEW mod.def("acceptArray1", acceptArray1); mod.def("acceptArray10", acceptArray10); mod.def("acceptArray3", acceptArray3); +#ifdef NDARRAY_EIGENVIEW mod.def("acceptOverload", (int (*)(int)) acceptOverload); mod.def("acceptOverload", (int (*)(Eigen::Matrix2d const &)) acceptOverload); mod.def("acceptOverload", (int (*)(Eigen::Matrix3d const &)) acceptOverload); +#endif // NDARRAY_EIGENVIEW mod.def("acceptNoneArray", acceptNoneArray, "array"_a = nullptr); +#ifdef NDARRAY_EIGENVIEW mod.def("acceptNoneMatrixXd", acceptNoneMatrixXd, "matrix"_a = nullptr); mod.def("acceptNoneMatrix2d", acceptNoneMatrix2d, "matrix"_a = nullptr); mod.def("acceptFullySpecifiedMatrix", acceptFullySpecifiedMatrix); +#endif // NDARRAY_EIGENVIEW return mod.ptr(); } \ No newline at end of file From a44982b4fa0336d02559231265be450f560f9168 Mon Sep 17 00:00:00 2001 From: Russell Owen Date: Thu, 14 Jun 2018 15:08:14 -0700 Subject: [PATCH 20/69] Remove SWIG support --- CMakeLists.txt | 6 - SConstruct | 5 - include/ndarray.i | 43 -- include/ndarray/converter.h | 50 --- include/ndarray/converter/PyConverter.h | 499 ------------------------ include/ndarray/converter/PyManager.h | 38 -- include/ndarray/converter/Vector.h | 105 ----- include/ndarray/converter/eigen.h | 153 -------- include/ndarray/converter/numpy.h | 298 -------------- include/ndarray/converter/ufunctors.h | 129 ------ include/ndarray/pybind11.h | 19 +- include/ndarray/swig.h | 38 -- tests/CMakeLists.txt | 26 +- tests/SConscript | 8 - tests/swig_test.py | 78 ---- tests/swig_test_mod.i | 141 ------- 16 files changed, 19 insertions(+), 1617 deletions(-) delete mode 100644 include/ndarray.i delete mode 100644 include/ndarray/converter.h delete mode 100644 include/ndarray/converter/PyConverter.h delete mode 100644 include/ndarray/converter/PyManager.h delete mode 100644 include/ndarray/converter/Vector.h delete mode 100644 include/ndarray/converter/eigen.h delete mode 100644 include/ndarray/converter/numpy.h delete mode 100644 include/ndarray/converter/ufunctors.h delete mode 100644 include/ndarray/swig.h delete mode 100755 tests/swig_test.py delete mode 100644 tests/swig_test_mod.i diff --git a/CMakeLists.txt b/CMakeLists.txt index e127550d..fd4d423c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -14,7 +14,6 @@ project(ndarray) # The test phase may rely on external libraries, which are enabled via the # options below. Library resolution is deferred to tests/CMakeLists.txt and # only executed if NDARRAY_TEST is enabled. -option(NDARRAY_SWIG "Enable .i file installation and swig tests?" ON) option(NDARRAY_TEST "Enable tests?" ON) option(NDARRAY_EIGEN "Enable Eigen tests?" ON) option(NDARRAY_EIGENVIEW "Enable ndarray::EigenView (requires Eigen < 3.3)?" OFF) @@ -55,8 +54,3 @@ endif(NDARRAY_TEST) # installation install(DIRECTORY include/ DESTINATION include/ FILES_MATCHING PATTERN "*.h") - -if(NDARRAY_SWIG) - install(DIRECTORY include/ DESTINATION include/ - FILES_MATCHING PATTERN "*.i") -endif(NDARRAY_SWIG) diff --git a/SConstruct b/SConstruct index ed240b4e..0b80e5c5 100644 --- a/SConstruct +++ b/SConstruct @@ -61,16 +61,11 @@ pyEnv = env.Clone() if building: config = pyEnv.Configure(custom_tests=checks) havePython = config.CheckPython() and config.CheckNumPy() - haveSwig = havePython and config.CheckSwig() - if haveSwig: - pyEnv.AppendUnique(SWIGPATH = ["#include"]) config.CheckBoostPP() pyEnv = config.Finish() else: havePython = False - haveSwig = False pyEnv.havePython = havePython -pyEnv.haveSwig = haveSwig bpEnv = pyEnv.Clone() if building: diff --git a/include/ndarray.i b/include/ndarray.i deleted file mode 100644 index 0f1d39a8..00000000 --- a/include/ndarray.i +++ /dev/null @@ -1,43 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -%{ -#include "ndarray.h" -#include "ndarray/swig.h" -#include "ndarray/converter/eigen.h" -#include -%} - -#pragma SWIG nowarn=467 - -%define %declareNumPyConverters(TYPE...) -%typemap(out) TYPE { - $result = ndarray::PyConverter< TYPE >::toPython($1); -} -%typemap(out) TYPE const &, TYPE &, TYPE const *, TYPE * { - $result = ndarray::PyConverter< TYPE >::toPython(*$1); -} -%typemap(typecheck) TYPE, TYPE const *, TYPE const & { - ndarray::PyPtr tmp($input,true); - $1 = ndarray::PyConverter< TYPE >::fromPythonStage1(tmp); - if (!($1)) PyErr_Clear(); -} -%typemap(in) TYPE const & (TYPE val) { - ndarray::PyPtr tmp($input,true); - if (!ndarray::PyConverter< TYPE >::fromPythonStage1(tmp)) return NULL; - if (!ndarray::PyConverter< TYPE >::fromPythonStage2(tmp, val)) return NULL; - $1 = &val; -} -%typemap(in) TYPE { - ndarray::PyPtr tmp($input,true); - if (!ndarray::PyConverter< TYPE >::fromPythonStage1(tmp)) return NULL; - if (!ndarray::PyConverter< TYPE >::fromPythonStage2(tmp, $1)) return NULL; -} -%enddef diff --git a/include/ndarray/converter.h b/include/ndarray/converter.h deleted file mode 100644 index d5aa2825..00000000 --- a/include/ndarray/converter.h +++ /dev/null @@ -1,50 +0,0 @@ -/* - * LSST Data Management System - * Copyright 2008, 2009, 2010 LSST Corporation. - * - * This product includes software developed by the - * LSST Project (http://www.lsst.org/). - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * 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 LSST License Statement and - * the GNU General Public License along with this program. If not, - * see . - */ - -#ifndef NDARRAY_converter_h_INCLUDED -#define NDARRAY_converter_h_INCLUDED - -/** - * @file ndarray/converter.h - * @brief Public header file for SWIG-based Python support. - * - * \warning Both the Numpy C-API headers "arrayobject.h" and - * "ufuncobject.h" must be included before ndarray/python.hpp - * or any of the files in ndarray/python. - * - * \note This file is not included by the main "ndarray.h" header file. - */ - -/** \defgroup ndarrayPythonGroup Python Support - * - * The ndarray Python support module provides conversion - * functions between ndarray objects, notably Array and - * Vector, and Python Numpy objects. - */ - -#include "Python.h" -#include "ndarray.h" -#include "ndarray/converter/numpy.h" -#include "ndarray/converter/ufunctors.h" -#include "ndarray/converter/Vector.h" - -#endif // !NDARRAY_converter_h_INCLUDED diff --git a/include/ndarray/converter/PyConverter.h b/include/ndarray/converter/PyConverter.h deleted file mode 100644 index dc1e8fd5..00000000 --- a/include/ndarray/converter/PyConverter.h +++ /dev/null @@ -1,499 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_CONVERTER_PyConverter_h_INCLUDED -#define NDARRAY_CONVERTER_PyConverter_h_INCLUDED - -/** - * @file ndarray/converter/PyConverter.h - * @brief Python C-API conversions for standard numeric types. - */ -#include - -#include -#include - -#ifndef DOXYGEN -//namespace boost { -inline void intrusive_ptr_add_ref(PyObject * obj) { Py_INCREF(obj); } -inline void intrusive_ptr_release(PyObject * obj) { Py_DECREF(obj); } -//} -#endif - -namespace ndarray { - -/** - * @brief A reference-counting smart pointer for PyObject. - */ -typedef boost::intrusive_ptr PyPtr; - -template struct PyConverter; - -namespace detail { - -/** - * @internal @ingroup ndarrayPythonInternalGroup - * @brief Non-specialized base class for PyConverter. - */ -template -struct PyConverterBase { - - /** - * @brief Check if a Python object might be convertible to T. - * - * \return true if the conversion may be successful, and - * false if it definitely is not. Will not raise a Python - * exception. - * - * This is mostly useful for wrapper generators like CONVERTER or - * Boost.Python, which could use matches() to check if an - * Python arguments match a particular signature for an - * overloaded C++ function. - * - * \sa PyConverter::fromPythonStage1() - */ - static bool matches( - PyObject * arg // input Python object (borrowed) - ) { - PyPtr p(arg,true); - if (!PyConverter::fromPythonStage1(p)) { - PyErr_Clear(); - return false; - } - return true; - } - - /** - * @brief Convert a Python object to a C++ object. - * - * fromPython() is appropriate for use with the PyArg_ParseX - * Python C-API functions as a "O&" converter function. - * - * \return true if the conversion was successful, and false - * otherwise (with a Python exception set). - * - * \sa PyConverter::fromPythonStage1() - * \sa PyConverter::fromPythonStage2() - **/ - static int fromPython( - PyObject * arg, // input Python object (borrowed) - T * output // pointer to an existing C++ - ) { - PyPtr p(arg,true); - if (!PyConverter::fromPythonStage1(p)) return false; - return PyConverter::fromPythonStage2(arg,*output); - } - -}; - -/** - * @internal @ingroup ndarrayPythonInternalGroup - * - * Intermediate base class for PyConverter implementations for non-bool integer types, - * providing a common stage 1 test. - */ -template -struct PyIntConverterBase : public PyConverterBase { - - static bool fromPythonStage1(PyPtr & input) { - if ( -#if PY_MAJOR_VERSION <= 2 - !PyInt_Check(input.get()) && -#endif - !PyLong_Check(input.get()) - ) { - PyPtr s(PyObject_Repr(input.get())); - if (!s) return false; - char * cs = PyBytes_AsString(s.get()); - if (!cs) return false; - PyErr_Format(PyExc_TypeError, "'%s' is not a valid C++ integer value.", cs); - } - return true; - } - -}; - -/** - * @internal @ingroup ndarrayPythonInternalGroup - * - * Implementation of PyConverter for non-bool integer types, specialized on - * whether the type is unsigned and whether it is smaller than, equal to, or - * greater than long (which is the maximum for Python's 'int') in size. - */ -template < - typename T, - bool isUnsigned=!boost::is_signed::value, - int cmpToLong=(sizeof(T) < sizeof(long)) ? -1 : ((sizeof(T)==sizeof(long)) ? 0 : 1) - > -struct PyIntConverter; - -/** - * @internal @ingroup ndarrayPythonInternalGroup - * - * Specialized implementation of PyConverter for signed integers smaller than long in size. - */ -template -struct PyIntConverter : public PyIntConverterBase { - - static bool fromPythonStage2(PyPtr const & input, T & output) { - NDARRAY_ASSERT(input); - output = PyLong_AsLong(input.get()); - if (PyErr_Occurred()) return false; // could get OverflowError here. - return true; - } - - static PyObject * toPython(T input) { - return PyLong_FromLong(input); - } - - static PyTypeObject const * getPyType() { return &PyLong_Type; } - -}; - -/** - * @internal @ingroup ndarrayPythonInternalGroup - * - * Specialized implementation of PyConverter for unsigned integers smaller than long in size. - */ -template -struct PyIntConverter : public PyIntConverterBase { - - static bool fromPythonStage2(PyPtr const & input, T & output) { - NDARRAY_ASSERT(input); - output = PyLong_AsLong(input.get()); - if (PyErr_Occurred()) return false; // could get OverflowError here. - return true; - } - - static PyObject * toPython(T input) { - return PyLong_FromLong(input); - } - - static PyTypeObject const * getPyType() { return &PyLong_Type; } - -}; - -/** - * @internal @ingroup ndarrayPythonInternalGroup - * - * Specialized implementation of PyConverter for signed integers equal to long in size. - */ -template -struct PyIntConverter : public PyIntConverterBase { - - static bool fromPythonStage2(PyPtr const & input, T & output) { - NDARRAY_ASSERT(input); - output = PyLong_AsLong(input.get()); - if (PyErr_Occurred()) return false; // could get OverflowError here. - return true; - } - - static PyObject * toPython(T input) { - return PyLong_FromLong(input); - } - - static PyTypeObject const * getPyType() { return &PyLong_Type; } - -}; - -/** - * @internal @ingroup ndarrayPythonInternalGroup - * - * Specialized implementation of PyConverter for unsigned integers equal to long in size. - */ -template -struct PyIntConverter : public PyIntConverterBase { - - static bool fromPythonStage2(PyPtr const & input, T & output) { - NDARRAY_ASSERT(input); - output = PyLong_AsUnsignedLong(input.get()); - if (PyErr_Occurred()) return false; // could get OverflowError here. - return true; - } - - static PyObject * toPython(T input) { - return PyLong_FromUnsignedLong(input); - } - - static PyTypeObject const * getPyType() { return &PyLong_Type; } - -}; - -/** - * @internal @ingroup ndarrayPythonInternalGroup - * - * Specialized implementation of PyConverter for signed integers greater than long in size. - */ -template -struct PyIntConverter : public PyIntConverterBase { - - static bool fromPythonStage2(PyPtr const & input, T & output) { - NDARRAY_ASSERT(input); - output = PyLong_AsLongLong(input.get()); - if (PyErr_Occurred()) return false; // could get OverflowError here. - return true; - } - - static PyObject * toPython(T input) { - return PyLong_FromLongLong(input); - } - - static PyTypeObject const * getPyType() { return &PyLong_Type; } - -}; - -/** - * @internal @ingroup ndarrayPythonInternalGroup - * - * Specialized implementation of PyConverter for unsigned integers greater than long in size. - */ -template -struct PyIntConverter : public PyIntConverterBase { - - static bool fromPythonStage2(PyPtr const & input, T & output) { - NDARRAY_ASSERT(input); -#ifndef _MSC_VER - output = static_cast(PyLong_AsUnsignedLongLong(input.get())); -#else - // Christoph Lassner reports that the above segfaults on Windows; until we have a better idea - // what triggers that, it's safer just to use PyLong_AsLongLong and just not support the full - // range of unsigned long long values. - PY_LONG_LONG tmp = PyLong_AsLongLong(input.get()); - if (tmp < 0) { - PyErr_SetString(PyExc_OverflowError, "Negative integer in conversion to unsigned"); - } else { - output = static_cast(tmp); - } -#endif - if (PyErr_Occurred()) return false; // could get OverflowError here. - return true; - } - - static PyObject * toPython(T input) { - return PyLong_FromUnsignedLongLong(input); - } - - static PyTypeObject const * getPyType() { return &PyLong_Type; } - -}; - -} // namespace ndarray::detail - -/** - * @ingroup ndarrayPythonGroup - * @brief A class providing Python conversion functions for T. - * - * Undocumented specializations exist for bool, (unsigned) short, (unsigned) int, (unsigned) long, - * (unsigned long long), float, double, std::complex, std::complex, and std::string. - */ -template -struct PyConverter : public detail::PyConverterBase { - - /** - * @brief Convert a C++ object to a new Python object. - * - * \return A new Python object, or NULL on failure (with - * a Python exception set). - */ - static PyObject * toPython( - T const & input ///< Input C++ object. - ); - - /** - * @brief Return the Python TypeObject that corresponds to - * the object the toPython() function returns. - */ - static PyTypeObject const * getPyType(); - - /** - * @brief Check if a Python object is convertible to T - * and optionally begin the conversion by replacing the - * input with an intermediate. - * - * \return true if a conversion may be possible, and - * false if it is not (with a Python exception set). - */ - static bool fromPythonStage1( - PyPtr & p /**< On input, a Python object to be converted. - * On output, a Python object to be passed to - * fromPythonStage2(). - */ - ); - - /** - * @brief Complete a Python to C++ conversion begun - * with fromPythonStage1(). - * - * \return true if the conversion was successful, - * and false otherwise (with a Python exception set). - */ - static bool fromPythonStage2( - PyPtr const & p, ///< A Python object processed by fromPythonStage1(). - T & output ///< The output C++ object. - ); - -}; - -/// \cond SPECIALIZATIONS - -template <> -struct PyConverter : public detail::PyConverterBase { - - static bool fromPythonStage1(PyPtr & input) { - if (!PyBool_Check(input.get())) { - PyPtr s(PyObject_Repr(input.get())); - if (!s) return false; - char * cs = PyBytes_AsString(s.get()); - if (!cs) return false; - PyErr_Format(PyExc_TypeError,"'%s' is not a valid C++ bool value.",cs); - } - return true; - } - - static bool fromPythonStage2(PyPtr const & input, bool & output) { - NDARRAY_ASSERT(input); - output = (input.get() == Py_True); - return true; - } - - static PyObject * toPython(bool input) { - if (input) Py_RETURN_TRUE; - Py_RETURN_FALSE; - } - - static PyTypeObject const * getPyType() { return &PyBool_Type; } -}; - -template <> struct PyConverter : public detail::PyIntConverter {}; -template <> struct PyConverter : public detail::PyIntConverter {}; -template <> struct PyConverter : public detail::PyIntConverter {}; -template <> struct PyConverter : public detail::PyIntConverter {}; -template <> struct PyConverter : public detail::PyIntConverter {}; -template <> struct PyConverter : public detail::PyIntConverter {}; -template <> struct PyConverter : public detail::PyIntConverter {}; -template <> struct PyConverter : public detail::PyIntConverter {}; - -template <> -struct PyConverter : public detail::PyConverterBase { - - static bool fromPythonStage1(PyPtr & input) { - if (!PyFloat_Check(input.get())) { - PyPtr s(PyObject_Repr(input.get())); - if (!s) return false; - char * cs = PyBytes_AsString(s.get()); - if (!cs) return false; - PyErr_Format(PyExc_TypeError,"'%s' is not a valid C++ float value.",cs); - } - return true; - } - - static bool fromPythonStage2(PyPtr const & input, float & output) { - NDARRAY_ASSERT(input); - output = PyFloat_AsDouble(input.get()); - return true; - } - - static PyObject * toPython(float input) { - return PyFloat_FromDouble(input); - } - - static PyTypeObject const * getPyType() { return &PyFloat_Type; } -}; - -template <> -struct PyConverter : public detail::PyConverterBase { - - static bool fromPythonStage1(PyPtr & input) { - if (!PyFloat_Check(input.get())) { - PyPtr s(PyObject_Repr(input.get())); - if (!s) return false; - char * cs = PyBytes_AsString(s.get()); - if (!cs) return false; - PyErr_Format(PyExc_TypeError,"'%s' is not a valid C++ double value.",cs); - } - return true; - } - - static bool fromPythonStage2(PyPtr const & input, double & output) { - NDARRAY_ASSERT(input); - output = PyFloat_AsDouble(input.get()); - return true; - } - - static PyObject * toPython(double input) { - return PyFloat_FromDouble(input); - } - - static PyTypeObject const * getPyType() { return &PyFloat_Type; } -}; - -template -struct PyConverter< std::complex > : public detail::PyConverterBase< std::complex > { - - static bool fromPythonStage1(PyPtr & input) { - if (!PyComplex_Check(input.get())) { - PyPtr s(PyObject_Repr(input.get())); - if (!s) return false; - char * cs = PyBytes_AsString(s.get()); - if (!cs) return false; - PyErr_Format(PyExc_TypeError,"'%s' is not a valid C++ complex value.",cs); - } - return true; - } - - static bool fromPythonStage2(PyPtr const & input, std::complex & output) { - NDARRAY_ASSERT(input); - output.real() = PyComplex_RealAsDouble(input.get()); - output.imag() = PyComplex_ImagAsDouble(input.get()); - return true; - } - - static PyObject * toPython(std::complex const & input) { - return PyComplex_FromDoubles(input.real(),input.imag()); - } - - static PyTypeObject const * getPyType() { return &PyComplex_Type; } -}; - -template <> -struct PyConverter< std::string > : public detail::PyConverterBase { - - static bool fromPythonStage1(PyPtr & input) { - if (!PyBytes_Check(input.get())) { - PyPtr s(PyObject_Repr(input.get())); - if (!s) return false; - char * cs = PyBytes_AsString(s.get()); - if (!cs) return false; - PyErr_Format(PyExc_TypeError,"'%s' is not a valid C++ string value.",cs); - } - return true; - } - - static bool fromPythonStage2(PyPtr const & input, std::string & output) { - NDARRAY_ASSERT(input); - char * buf = 0; - Py_ssize_t size = 0; - if (PyBytes_AsStringAndSize(input.get(),&buf,&size) == -1) return false; - output = std::string(buf,size); - return true; - } - - static PyObject * toPython(std::string const & input) { - return PyBytes_FromStringAndSize(input.data(),input.size()); - } - - static PyTypeObject const * getPyType() { return &PyBytes_Type; } -}; - -/// \endcond - -} // namespace ndarray - -#endif // !NDARRAY_CONVERTER_PyConverter_h_INCLUDED diff --git a/include/ndarray/converter/PyManager.h b/include/ndarray/converter/PyManager.h deleted file mode 100644 index cc8b9249..00000000 --- a/include/ndarray/converter/PyManager.h +++ /dev/null @@ -1,38 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2018, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_CONVERTER_PyManager_h_INCLUDED -#define NDARRAY_CONVERTER_PyManager_h_INCLUDED - -#include "Python.h" -#include "ndarray/Manager.h" - -namespace ndarray { -namespace detail { - -inline void destroyCapsule(PyObject * p) { - void * m = PyCapsule_GetPointer(p, "ndarray.Manager"); - Manager::Ptr * b = reinterpret_cast(m); - delete b; -} - -} // namespace ndarray::detail - -inline PyObject* makePyManager(Manager::Ptr const & m) { - return PyCapsule_New( - new Manager::Ptr(m), - "ndarray.Manager", - detail::destroyCapsule - ); -} - -} // namespace ndarray - -#endif // !NDARRAY_CONVERTER_PyManager_h_INCLUDED diff --git a/include/ndarray/converter/Vector.h b/include/ndarray/converter/Vector.h deleted file mode 100644 index 4ae8eadf..00000000 --- a/include/ndarray/converter/Vector.h +++ /dev/null @@ -1,105 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_CONVERTER_Vector_h_INCLUDED -#define NDARRAY_CONVERTER_Vector_h_INCLUDED - -/** - * @file ndarray/converter/Vector.h - * @brief Python C-API conversions for Vector. -*/ - -#include "ndarray/converter/PyConverter.h" - -namespace ndarray { - -/** - * @ingroup ndarrayndarrayPythonGroup - * @brief A traits class providing Python conversion functions for Vector. - */ -template -struct PyConverter< Vector > : public detail::PyConverterBase< Vector > { - - /** - * @brief Convert a Vector to a new Python object. - * - * \return A new Python object, or NULL on failure (with - * a Python exception set). - */ - static PyObject * toPython( - Vector const & input ///< Input C++ object. - ) { - PyObject * r = PyTuple_New(N); - for (int i=0; i::toPython(input[i])); - } - return r; - } - - /** - * @brief Return the Python TypeObject that corresponds to - * the object the toPython() function returns. - */ - static PyTypeObject const * getPyType() { return &PyTuple_Type; } - - /** - * @brief Check if a Python object is convertible to T - * and optionally begin the conversion by replacing the - * input with an intermediate. - * - * \return true if a conversion may be possible, and - * false if it is not (with a Python exception set). - */ - static bool fromPythonStage1( - PyPtr & p /**< On input, a Python object to be converted. - * On output, a Python object to be passed to - * fromPythonStage2(). - */ - ) { - if (!PySequence_Check(p.get())) { - PyErr_Format(PyExc_TypeError,"Expected a Python sequence of length %i.",N); - return false; - } - if (PySequence_Size(p.get()) != N) { - PyErr_Format(PyExc_ValueError,"Incorrect sequence length for Vector", N); - return false; - } - return true; - } - - /** - * @brief Complete a Python to C++ conversion begun - * with fromPythonStage1(). - * - * \return true if the conversion was successful, - * and false otherwise (with a Python exception set). - */ - static bool fromPythonStage2( - PyPtr const & p, ///< A Python object processed by fromPythonStage1(). - Vector & output ///< The output C++ object. - ) { - NDARRAY_ASSERT(p); - NDARRAY_ASSERT(PySequence_Check(p.get())); - Vector tmp; - for (int n=0; n::fromPythonStage1(item)) return false; - if (!PyConverter::fromPythonStage2(item,tmp[n])) return false; - } - output = tmp; - return true; - } - -}; - -} // namespace ndarray - -#endif // !NDARRAY_CONVERTER_Vector_h_INCLUDED diff --git a/include/ndarray/converter/eigen.h b/include/ndarray/converter/eigen.h deleted file mode 100644 index 96d89987..00000000 --- a/include/ndarray/converter/eigen.h +++ /dev/null @@ -1,153 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_CONVERTER_eigen_h_INCLUDED -#define NDARRAY_CONVERTER_eigen_h_INCLUDED - -/** - * @file ndarray/converter/eigen.h - * @brief Python C-API conversions for Eigen matrices. - */ - -#include "ndarray/buildOptions.h" -#include "ndarray/eigen.h" -#include "ndarray/converter.h" -#include "ndarray/converter/eigen.h" - -#ifdef NDARRAY_EIGENVIEW - -namespace ndarray { - -/** - * @ingroup ndarrayPythonGroup - * @brief Specialization of PyConverter for EigenView. - */ -template -struct PyConverter< EigenView > { - - static bool fromPythonStage1(PyPtr & p) { - // add or remove dimensions with size one so we have the right number of dimensions - if (PyArray_Check(p.get())) { - if ((Rows_ == 1 || Cols_ == 1) && N == 2) { - npy_intp shape[2] = { -1, -1 }; - if (Rows_ == 1) { - shape[0] = 1; - } else { - shape[1] = 1; - } - PyArray_Dims dims = { shape, 2 }; - PyPtr r(PyArray_Newshape(reinterpret_cast(p.get()), &dims, NPY_ANYORDER)); - if (!r) return false; - p.swap(r); - } else if (N == 1) { - PyPtr r(PyArray_Squeeze(reinterpret_cast(p.get()))); - if (!r) return false; - p.swap(r); - } - } // else let the Array converter raise the exception - if (!PyConverter< Array >::fromPythonStage1(p)) return false; - // check whether the size is correct if it's static - auto array = reinterpret_cast(p.get()); - if (N == 2) { - if (Rows_ != Eigen::Dynamic && PyArray_DIM(array, 0) != Rows_) { - PyErr_SetString(PyExc_ValueError, "incorrect number of rows for matrix"); - return false; - } - if (Cols_ != Eigen::Dynamic && PyArray_DIM(array, 1) != Cols_) { - PyErr_SetString(PyExc_ValueError, "incorrect number of columns for matrix"); - return false; - } - } else { - int requiredSize = Rows_ * Cols_; - if (requiredSize != Eigen::Dynamic && PyArray_SIZE(array) != requiredSize) { - PyErr_SetString(PyExc_ValueError, "incorrect number of elements for vector"); - return false; - } - } - return true; - } - - static bool fromPythonStage2( - PyPtr const & input, - EigenView & output - ) { - Array array; - if (!PyConverter< Array >::fromPythonStage2(input, array)) return false; - output.reset(array); - return true; - } - - static PyObject * toPython(EigenView const & m, PyObject * owner=NULL) { - PyPtr r(PyConverter< Array >::toPython(m.shallow(), owner)); - if (!r) return NULL; - PyPtr p(PyArray_Squeeze(reinterpret_cast(r.get()))); - Py_XINCREF(p.get()); - return p.get(); - } - -}; - -namespace detail { - -/** - * @internal @ingroup ndarrayPythonInternalGroup - * @brief Implementations for PyConverter for Eigen objects. - */ -template -class EigenPyConverter : public detail::PyConverterBase { - typedef typename SelectEigenView::Type OutputView; - typedef typename SelectEigenView::Type InputView; -public: - - static PyObject * toPython(Matrix const & input, PyObject * owner = NULL) { - return PyConverter::toPython(ndarray::copy(input), owner); - } - - static PyTypeObject const * getPyType() { - return &PyArray_Type; - } - - static bool fromPythonStage1(PyPtr & p) { - return PyConverter::fromPythonStage1(p); - } - - static bool fromPythonStage2(PyPtr const & p, Matrix & output) { - InputView v; - if (!PyConverter::fromPythonStage2(p, v)) return false; - output = v; - return true; - } - -}; - -} // namespace detail - -/** - * @ingroup ndarrayPythonGroup - * @brief Specialization of PyConverter for Eigen::Matrix. - */ -template -struct PyConverter< Eigen::Matrix > - : public detail::EigenPyConverter< Eigen::Matrix > -{}; - -/** - * @ingroup ndarrayPythonGroup - * @brief Specialization of PyConverter for Eigen::Array. - */ -template -struct PyConverter< Eigen::Array > - : public detail::EigenPyConverter< Eigen::Array > -{}; - -} // namespace ndarray - -#endif // NDARRAY_EIGENVIEW -#endif // !NDARRAY_CONVERTER_eigen_h_INCLUDED diff --git a/include/ndarray/converter/numpy.h b/include/ndarray/converter/numpy.h deleted file mode 100644 index aa3dfffd..00000000 --- a/include/ndarray/converter/numpy.h +++ /dev/null @@ -1,298 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_CONVERTER_numpy_h_INCLUDED -#define NDARRAY_CONVERTER_numpy_h_INCLUDED - -#ifndef NPY_NO_DEPRECATED_API -#pragma message ( "ndarray is compatible with the NumPy 1.7 API, define NPY_NO_DEPRECATED_API to suppress API version warnings" ) -#endif - -/** - * @file ndarray/converter/numpy.h - * @brief Python C-API conversions between ndarray and numpy. - */ - -#include "Python.h" -#include "ndarray.h" -#include "ndarray/converter/PyConverter.h" -#include "ndarray/converter/PyManager.h" - -namespace ndarray { -namespace detail { - -/** - * @internal @ingroup ndarrayPythonInternalGroup - * @brief Traits class that specifies Numpy typecodes for numeric types. - */ -template struct NumpyTraits { - static int getCode(); -}; - -/// \cond SPECIALIZATIONS - -template <> struct NumpyTraits { - static int getCode() { - if (sizeof(bool)==sizeof(npy_bool)) return NPY_BOOL; - if (sizeof(bool)==1) return NPY_UBYTE; - if (sizeof(bool)==2 && sizeof(short)==2) return NPY_USHORT; - if (sizeof(bool)==4 && sizeof(int)==4) return NPY_UINT; - assert(false); - return 0; - } -}; - -template <> struct NumpyTraits { static int getCode() { return NPY_UBYTE; } }; -template <> struct NumpyTraits { static int getCode() { return NPY_BYTE; } }; -template <> struct NumpyTraits { static int getCode() { return NPY_USHORT; } }; -template <> struct NumpyTraits { static int getCode() { return NPY_SHORT; } }; -// NPY_INT is on Windows a virtual flag that is never actually used. It must be -// checked against the platform dtype. -// see http://mail.scipy.org/pipermail/numpy-discussion/2010-June/051057.html. -template <> struct NumpyTraits { - static int getCode() { -#ifdef _MSC_VER - switch(sizeof(int)) { - case 1: return NPY_UBYTE; - case 2: return NPY_USHORT; - case 4: return NPY_ULONG; - case 8: return NPY_ULONGLONG; - // no datatype here... - default: throw std::exception(); - } -#else - return NPY_UINT; -#endif - } -}; -template <> struct NumpyTraits { - static int getCode() { -#ifdef _MSC_VER - switch(sizeof(int)) { - case 1: return NPY_BYTE; - case 2: return NPY_SHORT; - case 4: return NPY_LONG; - case 8: return NPY_LONGLONG; - // no datatype here... - default: throw std::exception(); - } -#else - return NPY_INT; -#endif - } -}; -template <> struct NumpyTraits { static int getCode() { return NPY_ULONG; } }; -template <> struct NumpyTraits { static int getCode() { return NPY_LONG; } }; -template <> struct NumpyTraits { static int getCode() { return NPY_ULONGLONG; } }; -template <> struct NumpyTraits { static int getCode() { return NPY_LONGLONG; } }; -template <> struct NumpyTraits { static int getCode() { return NPY_FLOAT; } }; -template <> struct NumpyTraits { static int getCode() { return NPY_DOUBLE; } }; -#if (npy_double != npy_longdouble) - template <> struct NumpyTraits { static int getCode() { return NPY_LONGDOUBLE; } }; -#endif -template <> struct NumpyTraits { static int getCode() { return NPY_CFLOAT; } }; -template <> struct NumpyTraits { static int getCode() { return NPY_CDOUBLE; } }; -template <> struct NumpyTraits { static int getCode() { return NPY_CLONGDOUBLE; } }; - -template <> struct NumpyTraits > { - static int getCode() { assert(sizeof(std::complex)==sizeof(npy_cfloat)); return NPY_CFLOAT; } -}; - -template <> struct NumpyTraits > { - static int getCode() { assert(sizeof(std::complex)==sizeof(npy_cdouble)); return NPY_CDOUBLE; } -}; - -template <> struct NumpyTraits > { - static int getCode() { - assert(sizeof(std::complex)==sizeof(npy_clongdouble)); - return NPY_CLONGDOUBLE; - } -}; - -/// \endcond - -} // namespace ndarray::detail - -/** - * @ingroup ndarrayPythonGroup - * @brief A traits class providing Python conversion functions for Array. - * - * This specialization, for Array, adds addititional optional arguments - * to the toPython() conversion member function. - */ -template -struct PyConverter< Array > : public detail::PyConverterBase< Array > { - typedef typename Array::Element Element; - typedef typename boost::remove_const::type NonConst; - - /** - * @brief Check if a Python object is convertible to T - * and optionally begin the conversion by replacing the - * input with an intermediate. - * - * \return true if a conversion may be possible, and - * false if it is not (with a Python exception set). - */ - static bool fromPythonStage1( - PyPtr & p /**< On input, a Python object to be converted. - * On output, a Python object to be passed to - * fromPythonStage2(). - */ - ) { - if (!PyArray_Check(p.get())) { - PyErr_SetString(PyExc_TypeError, "numpy.ndarray argument required"); - return false; - } - auto array = reinterpret_cast(p.get()); - int actualType = PyArray_TYPE(array); - int requiredType = detail::NumpyTraits::getCode(); - if (actualType != requiredType) { - PyErr_SetString(PyExc_ValueError, ("numpy.ndarray argument has incorrect data type")); - return false; - } - if (PyArray_NDIM(array) != N) { - PyErr_SetString(PyExc_ValueError, "numpy.ndarray argument has incorrect number of dimensions"); - return false; - } - bool writeable = !boost::is_const::value; - if (writeable && !(PyArray_FLAGS(array) & NPY_ARRAY_WRITEABLE)) { - PyErr_SetString(PyExc_TypeError, "numpy.ndarray argument must be writeable"); - return false; - } - if (C > 0) { - Offset requiredStride = sizeof(Element); - for (int i = 0; i < C; ++i) { - Offset actualStride = PyArray_STRIDE(array, N-i-1); - if (actualStride != requiredStride) { - PyErr_SetString( - PyExc_ValueError, - "numpy.ndarray does not have enough row-major contiguous dimensions" - ); - return false; - } - requiredStride *= PyArray_DIM(array, N-i-1); - } - } else if (C < 0) { - int requiredStride = sizeof(Element); - for (int i = 0; i < -C; ++i) { - Offset actualStride = PyArray_STRIDE(array, i); - if (actualStride != requiredStride) { - PyErr_SetString( - PyExc_ValueError, - "numpy.ndarray does not have enough column-major contiguous dimensions" - ); - return false; - } - requiredStride *= PyArray_DIM(array, i); - } - } - return true; - } - - /** - * @brief Complete a Python to C++ conversion begun with fromPythonStage1(). - * - * The copy will be shallow if possible and deep if necessary to meet the data type - * and contiguousness requirements. If a non-const array is required, the copy will - * always be shallow; if this is not possible, ValueError will be raised. - * - * The output Array's shared_ptr owner attribute will own a reference to the numpy - * array that ultimately owns the data (either the original or the copy). - * - * \return true on success, false on failure (with a Python exception set). - */ - static bool fromPythonStage2( - PyPtr const & input, ///< Result of fromPythonStage1(). - Array & output ///< Reference to existing output C++ object. - ) { - auto array = reinterpret_cast(input.get()); - if (!(PyArray_FLAGS(array) & NPY_ARRAY_ALIGNED)) { - PyErr_SetString(PyExc_TypeError, "unaligned arrays cannot be converted to C++"); - return false; - } - Offset itemsize = sizeof(Element); - for (int i = 0; i < N; ++i) { - if ((PyArray_DIM(array, i) > 1) && (PyArray_STRIDE(array, i) % itemsize != 0)) { - PyErr_SetString( - PyExc_TypeError, - "Cannot convert array to C++: strides must be an integer multiple of the element size" - ); - return false; - } - } - Vector shape; - Vector strides; - std::copy(PyArray_DIMS(array), PyArray_DIMS(array) + N, shape.begin()); - std::copy(PyArray_STRIDES(array), PyArray_STRIDES(array) + N , strides.begin()); - for (int i = 0; i < N; ++i) strides[i] /= sizeof(Element); - output = external( - reinterpret_cast(PyArray_DATA(array)), - shape, strides, input - ); - return true; - } - - /** - * @brief Create a numpy.ndarray from an ndarray::Array. - * - * The Array will be shallow-copied with reference counting if either - * m.getManager() is not empty or the optional owner argument is supplied; - * otherwise a deep copy will be made. - * - * \return a new Python object, or NULL on failure (with - * a Python exception set). - */ - static PyObject* toPython( - Array const & m, ///< The input Array object. - PyObject* owner=NULL /**< A Python object that owns the memory in the Array. - * If NULL, one will be constructed from m.getManager(). */ - ) { - int flags = NPY_ARRAY_ALIGNED; - if (C==N) flags |= NPY_ARRAY_C_CONTIGUOUS; - bool writeable = !boost::is_const::value; - if (writeable) flags |= NPY_ARRAY_WRITEABLE; - npy_intp outShape[N]; - npy_intp outStrides[N]; - Vector inShape = m.getShape(); - Vector inStrides = m.getStrides(); - std::copy(inShape.begin(), inShape.end(), outShape); - for (int i = 0; i < N; ++i) outStrides[i] = inStrides[i] * sizeof(Element); - PyPtr array( - PyArray_New( - &PyArray_Type, N, outShape, detail::NumpyTraits::getCode(), - outStrides, const_cast(m.getData()), sizeof(Element), flags, NULL - ), - false - ); - if (!array) return NULL; - if (!m.getManager() && owner == NULL) { - flags = NPY_ARRAY_CARRAY_RO | NPY_ARRAY_ENSURECOPY | NPY_ARRAY_C_CONTIGUOUS; - if (writeable) flags |= NPY_ARRAY_WRITEABLE; - PyPtr r = PyArray_FROM_OF(array.get(),flags); - if (!r) return NULL; - array.swap(r); - } else { - if (owner != NULL) { - Py_INCREF(owner); - } else { - owner = makePyManager(m.getManager()); - } - PyArray_SetBaseObject(reinterpret_cast(array.get()), owner); - } - Py_INCREF(array.get()); - return PyArray_Return(reinterpret_cast(array.get())); - } - - static PyTypeObject const * getPyType() { return &PyArray_Type; } -}; - -} // namespace ndarray - -#endif // !NDARRAY_CONVERTER_numpy_h_INCLUDED diff --git a/include/ndarray/converter/ufunctors.h b/include/ndarray/converter/ufunctors.h deleted file mode 100644 index c65b0e53..00000000 --- a/include/ndarray/converter/ufunctors.h +++ /dev/null @@ -1,129 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_CONVERTER_ufunctors_h_INCLUDED -#define NDARRAY_CONVERTER_ufunctors_h_INCLUDED - -/** - * \file ndarray/converter/ufunctors.h - * @brief Python wrappers to create numpy ufunc objects from C++ function objects. - */ - -#include "ndarray/converter/numpy.h" - -namespace ndarray { - -template -struct PyUnaryUFunctor { - - static PyObject* _call_(TUnaryFunctor const& self, PyObject* input, PyObject* output) { - PyArrayObject* input_array = PyArray_FROM_OTF(input,detail::NumpyTraits::getCode(), - NPY_ARRAY_ALIGNED); - if (input_array == NULL) return NULL; - PyArrayObject* output_array; - if (output == NULL || output == Py_None) { - output_array = PyArray_SimpleNew(PyArray_NDIM(input_array), - PyArray_DIMS(input_array), - detail::NumpyTraits::getCode()); - } else { - output_array = PyArray_FROM_OTF(output,detail::NumpyTraits::getCode(), - NPY_ARRAY_ALIGNED | NPY_ARRAY_WRITEABLE | NPY_ARRAY_UPDATEIFCOPY); - } - if (output_array == NULL) { - Py_DECREF(input_array); - return NULL; - } - PyObject* iter = PyArray_MultiIterNew(2,input_array,output_array); - if (iter == NULL) { - Py_DECREF(input_array); - Py_DECREF(output_array); - return NULL; - } - int size = ((PyArrayMultiIterObject*)(iter))->size; - while (size--) { - TArgument* arg = (TArgument*)PyArray_MultiIter_DATA(iter,0); - TResult* res = (TResult*)PyArray_MultiIter_DATA(iter,1); - *res = self(*arg); - PyArray_MultiIter_NEXT(iter); - } - Py_DECREF(input_array); - Py_DECREF(iter); - return PyArray_Return(reinterpret_cast(output_array)); - } - -}; - - -template -struct PyBinaryUFunctor { - - static PyObject* _call_(TBinaryFunctor const& self, PyObject* input1, PyObject* input2, - PyObject* output) { - PyObject* input1_array = PyArray_FROM_OTF(input1,detail::NumpyTraits::getCode(), - NPY_ARRAY_ALIGNED); - PyObject* input2_array = PyArray_FROM_OTF(input2,detail::NumpyTraits::getCode(), - NPY_ARRAY_ALIGNED); - if (input1_array == NULL || input2_array == NULL) { - Py_XDECREF(input1_array); - Py_XDECREF(input2_array); - return NULL; - } - PyObject* output_array; - if (output == NULL || output == Py_None) { - PyObject* tmp = PyArray_MultiIterNew(2,input1_array,input2_array); - if (tmp == NULL) { - Py_XDECREF(input1_array); - Py_XDECREF(input2_array); - return NULL; - } - PyArrayMultiIterObject* tmp_iter = (PyArrayMultiIterObject*)tmp; - output_array = PyArray_SimpleNew(tmp_iter->nd,tmp_iter->dimensions, - detail::NumpyTraits::getCode()); - Py_DECREF(tmp); - } else { - output_array = PyArray_FROM_OTF(output,detail::NumpyTraits::getCode(), - NPY_ARRAY_ALIGNED | NPY_ARRAY_WRITEABLE | NPY_ARRAY_UPDATEIFCOPY); - } - if (output_array == NULL) { - Py_DECREF(input1_array); - Py_DECREF(input2_array); - return NULL; - } - PyObject* iter = PyArray_MultiIterNew(3,input1_array,input2_array,output_array); - if (iter == NULL) { - Py_DECREF(input1_array); - Py_DECREF(input2_array); - Py_DECREF(output_array); - return NULL; - } - int size = ((PyArrayMultiIterObject*)(iter))->size; - while (size--) { - TArgument1* arg1 = (TArgument1*)PyArray_MultiIter_DATA(iter,0); - TArgument2* arg2 = (TArgument2*)PyArray_MultiIter_DATA(iter,1); - TResult* res = (TResult*)PyArray_MultiIter_DATA(iter,2); - *res = self(*arg1,*arg2); - PyArray_MultiIter_NEXT(iter); - } - Py_DECREF(input1_array); - Py_DECREF(input2_array); - Py_DECREF(iter); - return PyArray_Return(reinterpret_cast(output_array)); - } - -}; - -} // namespace ndarray - -#endif // !NDARRAY_CONVERTER_ufunctors_h_INCLUDED diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index 0f1fea73..a8f356fb 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -51,11 +51,28 @@ #include "ndarray.h" #include "ndarray/eigen.h" -#include "ndarray/converter/PyManager.h" #include "ndarray/buildOptions.h" namespace ndarray { +namespace detail { + +inline void destroyCapsule(PyObject * p) { + void * m = PyCapsule_GetPointer(p, "ndarray.Manager"); + Manager::Ptr * b = reinterpret_cast(m); + delete b; +} + +} // namespace ndarray::detail + +inline PyObject* makePyManager(Manager::Ptr const & m) { + return PyCapsule_New( + new Manager::Ptr(m), + "ndarray.Manager", + detail::destroyCapsule + ); +} + #if PYBIND11_VERSION_MAJOR == 2 && PYBIND11_VERSION_MINOR <= 1 using pybind11_np_size_t = size_t; #else diff --git a/include/ndarray/swig.h b/include/ndarray/swig.h deleted file mode 100644 index 9f452e43..00000000 --- a/include/ndarray/swig.h +++ /dev/null @@ -1,38 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_swig_h_INCLUDED -#define NDARRAY_swig_h_INCLUDED - -/** - * @file ndarray/swig.h - * @brief Public header file for SWIG-based Python support. - * - * \warning Both the Numpy C-API headers "arrayobject.h" and - * "ufuncobject.h" must be included before ndarray/python.hpp - * or any of the files in ndarray/python. - * - * \note This file is not included by the main "ndarray.h" header file. - */ - -/** \defgroup ndarrayPythonGroup Python Support - * - * The ndarray Python support module provides conversion - * functions between ndarray objects, notably Array and - * Vector, and Python Numpy objects. - */ - -#include "Python.h" -#include "ndarray.h" -#include "ndarray/converter/numpy.h" -#include "ndarray/converter/ufunctors.h" -#include "ndarray/converter/Vector.h" - -#endif // !NDARRAY_swig_h_INCLUDED diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index a55c705b..5d3b67e5 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -46,7 +46,7 @@ if(NDARRAY_FFTW) endif(NDARRAY_FFTW) ### Python resolution -if(NDARRAY_SWIG OR NDARRAY_PYBIND11) +if(NDARRAY_PYBIND11) find_package(PythonInterp REQUIRED) find_package(PythonLibs REQUIRED) find_package(NumPy REQUIRED) @@ -57,30 +57,6 @@ if(NDARRAY_SWIG OR NDARRAY_PYBIND11) ) ENDIF() -###SWIG dependency tests (also depend on Eigen) -if(NDARRAY_SWIG) - if (NDARRAY_EIGEN) - find_package(SWIG REQUIRED) - include(${SWIG_USE_FILE}) - - set_property(SOURCE swig_test_mod.i PROPERTY CPLUSPLUS ON) - swig_add_module(swig_test_mod python swig_test_mod.i) - - if (APPLE) - swig_link_libraries(swig_test_mod "-undefined dynamic_lookup") - else () - swig_link_libraries(swig_test_mod "-shared") - endif() - - configure_file(swig_test.py swig_test.py COPYONLY) - add_test(NAME swig_test - COMMAND ${PYTHON_EXECUTABLE} - ${CMAKE_CURRENT_BINARY_DIR}/swig_test.py) - else(NDARRAY_EIGEN) - message(STATUS "Skipping Swig tests as they depend on Eigen") - endif(NDARRAY_EIGEN) -endif(NDARRAY_SWIG) - ###Pybind11 dependency tests (also depend on Eigen) if(NDARRAY_PYBIND11) if(NDARRAY_EIGEN) diff --git a/tests/SConscript b/tests/SConscript index 7955aa99..5e2371a7 100644 --- a/tests/SConscript +++ b/tests/SConscript @@ -55,14 +55,6 @@ if pyEnv.havePython: mod, Move(os.path.join(Dir('.').srcnode().abspath, "python_test_mod.pyd"), mod[0])) PythonUnitTest(pyEnv, "python_test.py", mod) - if pyEnv.haveSwig and pyEnv.haveEigen: - mod = pyEnv.LoadableModule("_swig_test_mod", ["swig_test_mod.i"], SHLIBPREFIX="") - if os.name == 'nt': - # Move the module to have the correct name. - mod = env.Command(os.path.join(Dir('.').srcnode().abspath, "_swig_test_mod.pyd"), - mod, - Move(os.path.join(Dir('.').srcnode().abspath, "_swig_test_mod.pyd"), mod[0])) - PythonUnitTest(pyEnv, "swig_test.py", mod) if bpEnv.haveBoostPython: libs = bpEnv.get("LIBS", []) + ["boost_numpy"] diff --git a/tests/swig_test.py b/tests/swig_test.py deleted file mode 100755 index 5929bbb3..00000000 --- a/tests/swig_test.py +++ /dev/null @@ -1,78 +0,0 @@ -# -*- python -*- -# -# Copyright (c) 2010-2012, Jim Bosch -# All rights reserved. -# -# ndarray is distributed under a simple BSD-like license; -# see the LICENSE file that should be present in the root -# of the source distribution, or alternately available at: -# https://github.com/ndarray/ndarray -# -import numpy -import swig_test_mod -import unittest - -class TestNumpySwig(unittest.TestCase): - - def testMatrixXd(self): - m1 = swig_test_mod.returnMatrixXd() - m2 = numpy.matrix(numpy.arange(15, dtype=float).reshape(3,5).transpose()) - self.assert_((m1 == m2).all()) - self.assert_(swig_test_mod.acceptMatrixXd(m2)) - - def testMatrix2d(self): - m1 = swig_test_mod.returnMatrix2d() - m2 = numpy.matrix([[0.0, 2.0], [1.0, 3.0]]) - self.assert_((m1 == m2).all()) - self.assert_(swig_test_mod.acceptMatrix2d(m2)) - - def testArray1(self): - a1 = swig_test_mod.returnArray1() - a2 = numpy.arange(6, dtype=float) - self.assert_((a1 == a2).all()) - self.assert_(swig_test_mod.acceptArray1(a2)) - a3 = swig_test_mod.returnConstArray1() - self.assert_((a1 == a3).all()) - self.assert_(a3.flags["WRITEABLE"] == False) - - def testArray3(self): - a1 = swig_test_mod.returnArray3() - a2 = numpy.arange(4*3*2, dtype=float).reshape(4,3,2) - self.assert_((a1 == a2).all()) - self.assert_(swig_test_mod.acceptArray3(a2)) - a3 = swig_test_mod.returnConstArray3() - self.assert_((a1 == a3).all()) - self.assert_(a3.flags["WRITEABLE"] == False) - - def testClass(self): - a = swig_test_mod.MatrixOwner() - m1 = a.member - m2 = a.getMember() - self.assert_((m1 == 0).all()) - self.assert_((m2 == 0).all()) - self.assertEqual(m1.shape, (2,2)) - self.assertEqual(m2.shape, (2,2)) - - def testOverloads(self): - self.assertEqual(swig_test_mod.acceptOverload(1), 0) - self.assertEqual(swig_test_mod.acceptOverload(numpy.zeros((2,2), dtype=float)), 2) - self.assertEqual(swig_test_mod.acceptOverload(numpy.zeros((3,3), dtype=float)), 3) - - def testStrideHandling(self): - # in NumPy 1.8+ 1- and 0-sized arrays can have arbitrary strides; we should - # be able to handle those - array = numpy.zeros(1, dtype=float) - # just test that these don't throw - swig_test_mod.acceptArray10(array) - swig_test_mod.acceptArray10(array) - array = numpy.zeros(0, dtype=float) - swig_test_mod.acceptArray10(array) - swig_test_mod.acceptArray10(array) - # test that we gracefully fail when the strides are no multiples of the itemsize - dtype = numpy.dtype([("f1", numpy.float64), ("f2", numpy.int16)]) - table = numpy.zeros(3, dtype=dtype) - self.assertRaises(TypeError, swig_test_mod.acceptArray10, table['f1']) - - -if __name__ == "__main__": - unittest.main() diff --git a/tests/swig_test_mod.i b/tests/swig_test_mod.i deleted file mode 100644 index 10854470..00000000 --- a/tests/swig_test_mod.i +++ /dev/null @@ -1,141 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -%module swig_test_mod -%{ -#define PY_ARRAY_UNIQUE_SYMBOL LSST_SWIG_TEST_NUMPY_ARRAY_API -#include "numpy/arrayobject.h" -#include "ndarray/swig.h" -#include "ndarray/converter/eigen.h" -#ifdef __GNUC__ -#pragma GCC diagnostic ignored "-Wuninitialized" -#endif -%} -%init %{ - import_array(); -%} - -%include "ndarray.i" - -%declareNumPyConverters(Eigen::MatrixXd); -%declareNumPyConverters(Eigen::Matrix2d); -%declareNumPyConverters(Eigen::Matrix3d); -%declareNumPyConverters(Eigen::Matrix); -%declareNumPyConverters(ndarray::Array); -%declareNumPyConverters(ndarray::Array); -%declareNumPyConverters(ndarray::Array); -%declareNumPyConverters(ndarray::Array); -%declareNumPyConverters(ndarray::Array); - -%inline %{ - -Eigen::MatrixXd returnMatrixXd() { - Eigen::MatrixXd r(5, 3); - for (int n = 0; n < r.size(); ++n) { - r.data()[n] = n; - } - return r; -} - -Eigen::Matrix2d returnMatrix2d() { - Eigen::Matrix2d r; - for (int n = 0; n < r.size(); ++n) { - r.data()[n] = n; - } - return r; -} - -ndarray::Array returnArray1() { - ndarray::Array r(ndarray::allocate(ndarray::makeVector(6))); - for (int n = 0; n < r.getSize<0>(); ++n) { - r[n] = n; - } - return r; -} - -ndarray::Array returnConstArray1() { - return returnArray1(); -} - -ndarray::Array returnArray3() { - ndarray::Array r(ndarray::allocate(ndarray::makeVector(4,3,2))); - ndarray::Array f = ndarray::flatten<1>(r); - for (ndarray::Size n = 0; n < f.getSize<0>(); ++n) { - f[n] = n; - } - return r; -} - -ndarray::Array returnConstArray3() { - return returnArray3(); -} - -bool acceptMatrixXd(Eigen::MatrixXd const & m1) { - Eigen::MatrixXd m2 = returnMatrixXd(); - return m1 == m2; -} - -bool acceptMatrix2d(Eigen::Matrix2d const & m1) { - Eigen::Matrix2d m2 = returnMatrix2d(); - return m1 == m2; -} - -bool acceptArray1(ndarray::Array const & a1) { - ndarray::Array a2 = returnArray1(); -#ifndef GCC_45 - return ndarray::all(ndarray::equal(a1, a2)); -#else - return std::equal(a1.begin(), a1.end(), a2.begin()); -#endif -} - -void acceptArray10(ndarray::Array const & a1) {} - -bool acceptArray3(ndarray::Array const & a1) { - ndarray::Array a2 = returnArray3(); -#ifndef GCC_45 - return ndarray::all(ndarray::equal(a1, a2)); -#else - for (ndarray::Size i = 0; i < a1.getSize<0>(); ++i) { - for (ndarray::Size j = 0; j < a1.getSize<1>(); ++j) { - if (!std::equal(a1[i][j].begin(), a1[i][j].end(), a2[i][j].begin())) return false; - } - } - return true; -#endif -} - -int acceptOverload(int n) { - return 0; -} - -int acceptOverload(Eigen::Matrix3d const & m) { - return 3; -} - -int acceptOverload(Eigen::Matrix2d const & m) { - return 2; -} - -struct MatrixOwner { - - typedef Eigen::Matrix MemberMatrix; - - MemberMatrix member; - - MemberMatrix const & getMember() const { return member; } - MemberMatrix & getMember() { return member; } - - explicit MatrixOwner() : member(MemberMatrix::Zero()) {} - -}; - - -%} From f46c0f0ff876ceab5aaa3286e5f6e86902e72feb Mon Sep 17 00:00:00 2001 From: Russell Owen Date: Fri, 15 Jun 2018 13:09:44 -0700 Subject: [PATCH 21/69] Fix pybind11_test.py pybind11_test.py is broken under pybind11 2.1.x: the test module is built without an extension and thus cannot be loaded. Jim Bosch diagnosed and fixed the problem by forcing a .so extension. --- tests/CMakeLists.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 5d3b67e5..bf71d5c5 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -64,6 +64,12 @@ if(NDARRAY_PYBIND11) include_directories(${PYBIND11_INCLUDE_DIR}) + # Either pybind11 2.1.x doesn't set the module extension appropriately, + # or ndarray is inadvertently squashing it. In any case, the problem + # goes away with pybind11 2.2.x, and in the meantime this fixes it. + # It probably wouldn't work on Windows, but we don't care about that. + set(PYTHON_MODULE_EXTENSION ".so") + pybind11_add_module(pybind11_test_mod pybind11_test_mod.cc) configure_file(pybind11_test.py pybind11_test.py COPYONLY) From e9dede8b3944c2913fd4945c07a748faaa7599fc Mon Sep 17 00:00:00 2001 From: Russell Owen Date: Fri, 15 Jun 2018 14:59:51 -0700 Subject: [PATCH 22/69] Update documentation --- README.md | 42 +++++++++++++++++++++++++---------------- include/ndarray/eigen.h | 29 +++++++++++++++++++++++++++- 2 files changed, 54 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index fcb9987d..0d6ba2e4 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,31 @@ ndarray.github.io/ndarray](http://ndarray.github.io/ndarray/). Building from Git ----------------- +CMake is the supported way to build ndarray. + +To build with cmake, do: + + mkdir build + cd build + cmake .. + make + make test + +Inclusion and testing of optional dependencies is controlled by NDARRAY_* cmake +options. Dependency resolution can be controlled by the PYBIND11_DIR, +EIGEN_DIR, and FFTW_DIR environment variables. For example, to build with an +alternate Eigen3 install location and disable FFTW testing replace `cmake ..` +with `EIGEN_DIR=/opt/local cmake -DNDARRY_FFTW=OFF ..`. + +ndarray::EigenView is not compatible with Eigen >= 3.3, +nor is it compatible with pybind11's default Eigen wrappers. +To build without ndarray::EigenView use cmake option `-DNDARRAY_EIGENVIEW=OFF` + +However, the cmake build does not support Boost.NumPy library +and Boost.Python wrappers, which are deprecated in favor of pybind11. +If you are keen to use Boost.Python you can try the older +scons build files, as follows + ndarray includes the Boost.NumPy library using git's "submodules" feature. When you clone the ndarray repository with git, you'll get an empty Boost.NumPy directory. Even if you don't plan to use @@ -27,23 +52,8 @@ From there, you'll be able to build ndarray and (optionally) Boost.NumPy together just by running "scons" from the root of the ndarray clone. -A partial cmake build has also recently been added, and we expect it to -eventually replace SCons as the recommended approach, but it does not yet -support building against Boost.NumPy to provide bindings for Boost.Python. - -To build with cmake, do: +Version 1.4.2 of ndarray is the last version to support SWIG. - mkdir build - cd build - cmake .. - make - make test - -Inclusion and testing of optional dependencies is controlled by NDARRAY_* cmake -options. Dependency resolution can be controlled by the PYBIND11_DIR, -EIGEN_DIR, and FFTW_DIR environment variables. For example, to build with an -alternate Eigen3 install location and disable FFTW testing replace `cmake ..` -with `EIGEN_DIR=/opt/local cmake -DNDARRY_FFTW=OFF ..`. Building from Compressed Source ------------------------------- diff --git a/include/ndarray/eigen.h b/include/ndarray/eigen.h index c2fcf545..afd6ec30 100644 --- a/include/ndarray/eigen.h +++ b/include/ndarray/eigen.h @@ -201,6 +201,33 @@ struct SelectEigenMap { } // namespace detail +//@{ +/** + * Use asEigenArray(array) or asEigen(array) + * to obtain an Eigen::Array-like view of an ndarray array. + * Use asEigenMatrix(array) or asEigen(array) + * to obtain an Eigen::Matrix-like view of an ndarray array. + * The returned view is an Eigen::Map whose memory is owned by the ndarray array. + * + * Be careful when calling these functions on a temporary ndarray array, + * as you must keep the temporary alive until you are done with the returned Eigen::Map. + * For example the following will have undefined behavior: + * + * auto eigenMap = asEigenMatrix(makeNdArray(...)); + * // at this point the temporary ndarray array is gone and eigenMap is broken + * processMatrix(eigenMap); + * + * This version is safe: + * + * processMatrix(asEigenMatrix(makeNdArray(...))); + * + * This version is also safe and allows you to do additional processing of the Eigen map: + * + * auto arr = makeNdArray(...); + * auto eigenMap = asEigenMatrix(arr); + * processMatrix(eigenMap); + * // ... do more with eigenMap + */ template typename detail::SelectEigenMap::Type asEigen(Array const & a) { @@ -213,7 +240,6 @@ asEigen(ArrayRef const & a) { return detail::SelectEigenMap::apply(a); } - template typename detail::SelectEigenMap::Type asEigenArray(Array const & a) { @@ -237,6 +263,7 @@ typename detail::SelectEigenMap::Type asEigenMatrix(ArrayRef const & a) { return asEigen(a); } +//@} } // namespace ndarray From 77969f16ff5125a550982a3e5c9ce09edf7740fa Mon Sep 17 00:00:00 2001 From: Russell Owen Date: Thu, 14 Jun 2018 14:31:47 -0700 Subject: [PATCH 23/69] Make Travis test two build configurations Build and run tests with -DNDARRAY_EIGENVIEW OFF and ON --- .travis.yml | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 3ce0b955..33091259 100644 --- a/.travis.yml +++ b/.travis.yml @@ -40,7 +40,16 @@ install: script: - mkdir build - cd build - - cmake -DNDARRAY_PYBIND11=ON .. && make && make test ARGS="-V" + + - cmake -DNDARRAY_PYBIND11=ON .. + - make + - make test ARGS="-V" + + - rm CMakeCache.txt + - cmake -DNDARRAY_PYBIND11=ON -DNDARRAY_EIGENVIEW=ON .. + - make + - make test ARGS="-V" + - make doc deploy: From 1ef06790784c60efca58b15b46debb455d5de7f4 Mon Sep 17 00:00:00 2001 From: Russell Owen Date: Sun, 17 Jun 2018 12:50:43 -0700 Subject: [PATCH 24/69] Add CHANGELOG.md --- CHANGELOG.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..386b2a43 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,22 @@ +# ndarray change log + +## 1.5.0 + +### New features + +`ndarray::EigenView` is not compatible with Eigen 3.3 and fixing this appears to be more work than it's worth, +so this version deprecates `ndarray::EigenView` and adds new free functions `asEigen`, `asEigenArray` +and `asEigenMatrix` which return an `eigen::Map` view of an ndarray array. Unlike `ndarray::EigenView`, +the returned eigen map does not own the memory, so you must be careful to keep the ndarray array around +until you are done with the map. + +Added build option `-DNDARRAY_EIGENVIEW` which controls whether to build ndarray::EigenView. The default is OFF. + +Added build option `-DNDARRAY_STDPYBIND11EIGEN` which, if ON, imports `pybind11/eigen.h` into `ndarray/eigen.h`. +The intent is to make it easier to port old pybind11 wrappers that used EigenView. The default is `OFF`. +`-DNDARRAY_EIGENVIEW` and `-DNDARRAY_STDPYBIND11EIGEN` cannot both be `ON`. + +### Bug fixes + +Fixed a race condition in the cmake build files: ArrayBaseN.h.m4 might not be processed before other +m4 include files that rely on it. This may fix ndarray issue 71. From d8f43a0c49157f603332d4b306305d26b3f00fb2 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Sun, 17 Jun 2018 16:34:41 -0400 Subject: [PATCH 25/69] Don't promise Boost.NumPy source in tarballs --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 0d6ba2e4..87d95936 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,4 @@ Building from Compressed Source GitHub's automatically generated tarballs and zip files don't include the Boost.NumPy submodule or the git metadata needed to run "git -submodule", so these features can't be used to download ndarray. - -When we post release downloads, however, we'll include the Boost.NumPy -source so they can be built directly. +submodule", so these features can't be used from release tarball. Please download from git if you want to use the Boost.NumPy interface. From b9d0e0d151a1c9a3451ec856f177b8a0bb09b6f0 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 18 Jun 2018 11:15:04 -0400 Subject: [PATCH 26/69] Revert "Fix pybind11_test.py" This reverts commit f46c0f0ff876ceab5aaa3286e5f6e86902e72feb. This was a somewhat unportable fix for pybind11 2.1.x that is probably only desired by LSST; we'll just make that a patch on the LSST build, and encourage everyone else to use pybind11 2.2.x. LSST will of course switch to a newer pybind11 eventually, too, but isn't quite ready yet. --- tests/CMakeLists.txt | 6 ------ 1 file changed, 6 deletions(-) diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index bf71d5c5..5d3b67e5 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -64,12 +64,6 @@ if(NDARRAY_PYBIND11) include_directories(${PYBIND11_INCLUDE_DIR}) - # Either pybind11 2.1.x doesn't set the module extension appropriately, - # or ndarray is inadvertently squashing it. In any case, the problem - # goes away with pybind11 2.2.x, and in the meantime this fixes it. - # It probably wouldn't work on Windows, but we don't care about that. - set(PYTHON_MODULE_EXTENSION ".so") - pybind11_add_module(pybind11_test_mod pybind11_test_mod.cc) configure_file(pybind11_test.py pybind11_test.py COPYONLY) From 2698c4b978f6a7ee850ccf152a2b8140e2adf27f Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 18 Jun 2018 11:19:36 -0400 Subject: [PATCH 27/69] Add note on pybind11 versions to README, CHANGELOG. --- CHANGELOG.md | 6 ++++++ README.md | 2 ++ 2 files changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 386b2a43..8854beb5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # ndarray change log +## 1.5.1 + +### Bug fixes + +Reverted a non-portable workaround for bad module suffixes with pybind11 2.1.x. Please just use pybind11 2.2.x instead. + ## 1.5.0 ### New features diff --git a/README.md b/README.md index 87d95936..2564652b 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,8 @@ ndarray::EigenView is not compatible with Eigen >= 3.3, nor is it compatible with pybind11's default Eigen wrappers. To build without ndarray::EigenView use cmake option `-DNDARRAY_EIGENVIEW=OFF` +ndarray's build system does not produce the correct suffixes for pybind11 outputs under pybind11 2.1.x (due to a bug in pybind11 itself). To avoid this problem, please upgrade to pybind11 2.2.x, or try the (now reverted) patch from ndarray commit f46c0f0ff876ceab5aaa3286e5f6e86902e72feb. + However, the cmake build does not support Boost.NumPy library and Boost.Python wrappers, which are deprecated in favor of pybind11. If you are keen to use Boost.Python you can try the older From 5fd5b29dd6c951bc744a738fffbd43b9f434b735 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 18 Jun 2018 11:22:20 -0400 Subject: [PATCH 28/69] Add belated note about dropping SWIG support. --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8854beb5..e350d59f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,10 @@ Added build option `-DNDARRAY_STDPYBIND11EIGEN` which, if ON, imports `pybind11/ The intent is to make it easier to port old pybind11 wrappers that used EigenView. The default is `OFF`. `-DNDARRAY_EIGENVIEW` and `-DNDARRAY_STDPYBIND11EIGEN` cannot both be `ON`. +### Deprecations and removals + +Support for SWIG has been dropped as of the 1.5.0 release. + ### Bug fixes Fixed a race condition in the cmake build files: ArrayBaseN.h.m4 might not be processed before other From c4c6e5906cfa9bd1a8e33b2b9dffe9355c16ede2 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Tue, 18 Sep 2018 12:37:30 -0400 Subject: [PATCH 29/69] Hide Pybind11Helper symbols when pybind11 hides its symbols. --- include/ndarray/pybind11.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index a8f356fb..3101eec5 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -80,7 +80,13 @@ using pybind11_np_size_t = ssize_t; #endif template -struct Pybind11Helper { +struct +#ifdef __GNUG__ +// pybind11 hides all symbols in its namespace only when this is set, +// and in that case we should hide these classes too. +__attribute__((visibility("hidden"))) +#endif +Pybind11Helper { using Element = typename ndarray::Array::Element; using Wrapper = pybind11::array_t::type, 0>; // 0: no ensurecopy static constexpr bool isConst = std::is_const::value; @@ -194,8 +200,6 @@ struct Pybind11Helper { Wrapper wrapper; }; - - } // namespace ndarray NAMESPACE_BEGIN(pybind11) From cabb941479d38779762a6437e6e0a5a154a87f32 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Thu, 18 Apr 2019 17:37:05 -0400 Subject: [PATCH 30/69] Stop using conda-forge in Travis. Regular conda channels now provide all of the packages we need, without entangling us in the old libstd++ ABI. --- .travis.yml | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/.travis.yml b/.travis.yml index 33091259..e113db36 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,11 +5,7 @@ python: - "3.5" - "3.6" before_install: - # C++14 - - sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test - - sudo apt-get update -qq - - sudo apt-get install -qq g++-6 - - sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-6 90 + - sudo apt-get install doxygen install: # We do this conditionally because it saves us some downloading if the # version is the same. @@ -22,11 +18,10 @@ install: - export PATH="$HOME/miniconda/bin:$PATH" - hash -r - conda config --set always_yes yes --set changeps1 no - - conda config --prepend channels conda-forge - conda update -q conda # Useful for debugging any issues with conda - conda info -a - - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION boost fftw numpy pybind11 swig doxygen + - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION boost fftw numpy pybind11 swig cmake gxx_linux-64 - source activate test-environment - echo "eigen 3.2.*" > $CONDA_PREFIX/conda-meta/pinned - conda install eigen @@ -34,8 +29,6 @@ install: - export EIGEN_DIR=$CONDA_PREFIX - export FFTW_DIR=$CONDA_PREFIX - export CMAKE_PREFIX_PATH=$CONDA_PREFIX - # Conda's boost is built with the old libc++ ABI, so we have to build with that too. - - export CXXFLAGS="-D_GLIBCXX_USE_CXX11_ABI=0" script: - mkdir build From a57d7283e20612176b69afea4bf153007b716e21 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Thu, 18 Apr 2019 22:39:33 -0400 Subject: [PATCH 31/69] Switch to Xenial VMs in Travis, and Python 3.7 (instead of 3.5). --- .travis.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index e113db36..91298410 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,9 +1,10 @@ +dist: xenial language: python python: # We don't actually use the Travis Python, but this keeps it organized. - "2.7" - - "3.5" - "3.6" + - "3.7" before_install: - sudo apt-get install doxygen install: From 3dbb86b949997feb96ab550cb18ac0ec19c57bda Mon Sep 17 00:00:00 2001 From: Paul Price Date: Thu, 18 Apr 2019 16:17:27 -0400 Subject: [PATCH 32/69] cmake: add test dependencies Building the tests requires first building the header files. --- tests/CMakeLists.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 5d3b67e5..1f78168c 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -16,10 +16,12 @@ include_directories( ) add_executable(ndarray ndarray.cc) +add_dependencies(ndarray preprocess_includes2) target_link_libraries(ndarray ${Boost_LIBRARIES}) add_test(test_ndarray ndarray) add_executable(views views.cc) +add_dependencies(views preprocess_includes2) target_link_libraries(views ${Boost_LIBRARIES}) add_test(test_views views) @@ -31,6 +33,7 @@ if(NDARRAY_EIGEN) include_directories( ${EIGEN3_INCLUDE_DIR} ) add_executable(ndarray-eigen ndarray-eigen.cc) + add_dependencies(ndarray-eigen preprocess_includes2) target_link_libraries(ndarray-eigen ${Boost_LIBRARIES}) add_test(test_ndarray_eigen ndarray-eigen) endif(NDARRAY_EIGEN) @@ -41,6 +44,7 @@ if(NDARRAY_FFTW) include_directories( ${FFTW_INCLUDES} ) add_executable(ndarray-fft ndarray-fft.cc) + add_dependencies(ndarray-fft preprocess_includes2) target_link_libraries(ndarray-fft ${Boost_LIBRARIES} ${FFTW_LIBRARIES}) add_test(test_ndarray-fft ndarray-fft) endif(NDARRAY_FFTW) @@ -65,6 +69,7 @@ if(NDARRAY_PYBIND11) include_directories(${PYBIND11_INCLUDE_DIR}) pybind11_add_module(pybind11_test_mod pybind11_test_mod.cc) + add_dependencies(pybind11_test_mod preprocess_includes2) configure_file(pybind11_test.py pybind11_test.py COPYONLY) add_test(NAME pybind11_test From 8e3840b2e39424e3487f3a8c4cc419761e7a3c0d Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 29 Jul 2019 11:38:28 -0400 Subject: [PATCH 33/69] Remove SCons build. --- README.md | 16 -------- SConstruct | 95 ---------------------------------------------- doc/SConscript | 3 -- include/SConscript | 39 ------------------- tests/SConscript | 85 ----------------------------------------- 5 files changed, 238 deletions(-) delete mode 100644 SConstruct delete mode 100644 doc/SConscript delete mode 100644 include/SConscript delete mode 100644 tests/SConscript diff --git a/README.md b/README.md index 2564652b..db45c8a5 100644 --- a/README.md +++ b/README.md @@ -37,22 +37,6 @@ ndarray's build system does not produce the correct suffixes for pybind11 output However, the cmake build does not support Boost.NumPy library and Boost.Python wrappers, which are deprecated in favor of pybind11. -If you are keen to use Boost.Python you can try the older -scons build files, as follows - -ndarray includes the Boost.NumPy library using git's "submodules" -feature. When you clone the ndarray repository with git, you'll get -an empty Boost.NumPy directory. Even if you don't plan to use -Boost.NumPy (which is required only if you want to build the -Boost.Python bindings for ndarray), it *is* necessary to checkout the -Boost.NumPy source (as parts of the build system is shared). So, -immediately after cloning ndarray, you'll need to run: - -git submodule update --init --recursive - -From there, you'll be able to build ndarray and (optionally) -Boost.NumPy together just by running "scons" from the root of the -ndarray clone. Version 1.4.2 of ndarray is the last version to support SWIG. diff --git a/SConstruct b/SConstruct deleted file mode 100644 index 0b80e5c5..00000000 --- a/SConstruct +++ /dev/null @@ -1,95 +0,0 @@ -# -*- python -*- -# -# Copyright (c) 2010-2012, Jim Bosch -# All rights reserved. -# -# ndarray is distributed under a simple BSD-like license; -# see the LICENSE file that should be present in the root -# of the source distribution, or alternately available at: -# https://github.com/ndarray/ndarray -# -import os -import sys -sys.path.insert(0, os.path.abspath('Boost.NumPy')) -from SConsChecks import AddLibOptions, GetLibChecks - -setupOptions, makeEnvironment, setupTargets, checks, libs = SConscript("Boost.NumPy/SConscript") -libs.extend(['swig', 'eigen', 'boost.test', 'fftw', 'boost.preprocessor']) -checks = GetLibChecks(libs) - -variables = setupOptions() - -AddOption("--with-eigen", dest="eigen_prefix", type="string", nargs=1, action="store", - metavar="DIR", default=os.environ.get("EIGEN_DIR"), - help="prefix for Eigen libraries; should have an 'include' subdirectory") -AddOption("--with-eigen-include", dest="eigen_include", type="string", nargs=1, action="store", - metavar="DIR", help="location of Eigen header files") -AddOption("--with-fftw", dest="fftw_prefix", type="string", nargs=1, action="store", - metavar="DIR", default=os.environ.get("FFTW_DIR"), - help="prefix for FFTW libraries; should have 'include' and 'lib' subdirectories") -AddOption("--with-fftw-include", dest="fftw_include", type="string", nargs=1, action="store", - metavar="DIR", help="location of FFTW header files") -AddOption("--with-fftw-lib", dest="fftw_lib", type="string", nargs=1, action="store", - metavar="DIR", help="location of FFTW library") -building = not GetOption("help") and not GetOption("clean") - -env = makeEnvironment(variables) -env.Tool('m4') -env.AppendUnique(CPPPATH=["#include"]) - -if building: - config = env.Configure(custom_tests=checks) - haveEigen = config.CheckEigen() - haveFFTW = config.CheckFFTW() - env = config.Finish() -else: - haveEigen = False - haveFFTW = False -env.haveEigen = haveEigen -env.haveFFTW = haveFFTW - -testEnv = env.Clone() -if building: - config = testEnv.Configure(custom_tests=checks) - haveBoostTest = config.CheckBoostTest() - testEnv = config.Finish() -else: - haveBoostTest = False -testEnv.haveBoostTest = haveBoostTest - -pyEnv = env.Clone() -if building: - config = pyEnv.Configure(custom_tests=checks) - havePython = config.CheckPython() and config.CheckNumPy() - config.CheckBoostPP() - pyEnv = config.Finish() -else: - havePython = False -pyEnv.havePython = havePython - -bpEnv = pyEnv.Clone() -if building: - config = bpEnv.Configure(custom_tests=checks) - haveBoostPython = config.CheckBoostPython() - bpEnv = config.Finish() -else: - haveBoostPython = False -bpEnv.haveBoostPython = haveBoostPython - -bpEnv.AppendUnique(CPPPATH=["#Boost.NumPy"]) -if haveBoostPython: - setupTargets(bpEnv, root="Boost.NumPy") -elif building: - print("Not building Boost.NumPy component.") - -headers = SConscript(os.path.join("include", "SConscript"), exports="env") - -prefix = Dir(GetOption("prefix")).abspath -install_headers = GetOption("install_headers") -if not install_headers: - install_headers = os.path.join(prefix, "include") -for header in Flatten(headers): - relative = os.path.relpath(header.abspath, Dir("#include").abspath) - env.Alias("install", env.InstallAs(os.path.join(install_headers, relative), header)) - -tests = SConscript(os.path.join("tests", "SConscript"), exports=["env", "testEnv", "pyEnv", "bpEnv"]) diff --git a/doc/SConscript b/doc/SConscript deleted file mode 100644 index 2028ebcd..00000000 --- a/doc/SConscript +++ /dev/null @@ -1,3 +0,0 @@ -# -*- python -*- -from lsst.sconsUtils import scripts -scripts.BasicSConscript.doc(inputs=["#include"]) diff --git a/include/SConscript b/include/SConscript deleted file mode 100644 index 5585249c..00000000 --- a/include/SConscript +++ /dev/null @@ -1,39 +0,0 @@ -# -*- python -*- -# -# Copyright (c) 2010-2012, Jim Bosch -# All rights reserved. -# -# ndarray is distributed under a simple BSD-like license; -# see the LICENSE file that should be present in the root -# of the source distribution, or alternately available at: -# https://github.com/ndarray/ndarray -# -Import("env") -import os - -generated = ["ndarray/ArrayRef.h", - "ndarray/ArrayBaseN.h", - "ndarray/operators.h", - "ndarray/Vector.h", - "ndarray/fft/FFTWTraits.h", - "ndarray/bp/auto/Array.h", - "ndarray/bp/auto/ArrayRef.h", - "ndarray/bp/auto/Vector.h", - "ndarray/eigen/bp/auto/EigenView.h", - "ndarray/eigen/bp/auto/Array.h", - "ndarray/eigen/bp/auto/Matrix.h", - ] -m4include = Dir("../m4").abspath -m4flags = "-I%s" % m4include -headers = [env.M4(filename, "%s.m4" % filename, M4FLAGS=[m4flags]) for filename in generated] - -for header in headers: - env.Depends(header, Glob(os.path.join(m4include, "*.m4"))) - -headers += env.Glob("*.h") -headers += env.Glob("*/*.h") -headers += env.Glob("*/*/*.h") -headers += env.Glob("*/*/*/*.h") -headers += env.Glob("*.i") - -Return("headers") diff --git a/tests/SConscript b/tests/SConscript deleted file mode 100644 index 5e2371a7..00000000 --- a/tests/SConscript +++ /dev/null @@ -1,85 +0,0 @@ -# -*- python -*- -# -# Copyright (c) 2010-2012, Jim Bosch -# All rights reserved. -# -# ndarray is distributed under a simple BSD-like license; -# see the LICENSE file that should be present in the root -# of the source distribution, or alternately available at: -# https://github.com/ndarray/ndarray -# -import os -import sys - -def RunBinaryUnitTest(target, source, env): - if not env.Execute(source[0].abspath): - env.Execute(Touch(target)) - -def BinaryUnitTest(env, source, dependencies=None): - if os.name != 'nt': - bin = env.Program(target="%s.test" % source, source=source) - else: - bin = env.Program(source) - run = env.Command(".%s.succeeded" % str(source), bin, RunBinaryUnitTest) - if dependencies: - env.Depends(run, dependencies) - env.Alias("tests", run) - return run - -def RunPythonUnitTest(target, source, env): - if not env.Execute('%s %s' % (sys.executable, source[0].abspath)): - env.Execute(Touch(target)) - -def PythonUnitTest(env, script, dependencies): - run = env.Command(".%s.succeeded" % str(script), script, RunPythonUnitTest) - env.Depends(run, dependencies) - env.Alias("tests", run) - return run - -Import("env", "testEnv", "pyEnv", "bpEnv") - -if testEnv.haveBoostTest: - BinaryUnitTest(testEnv, "ndarray.cc") - BinaryUnitTest(testEnv, "views.cc") - if testEnv.haveEigen: - BinaryUnitTest(testEnv, "ndarray-eigen.cc") - if testEnv.haveFFTW: - fftwEnv = testEnv.Clone() - BinaryUnitTest(fftwEnv, "ndarray-fft.cc") - -if pyEnv.havePython: - mod = pyEnv.LoadableModule("python_test_mod", "python_test_mod.cc", SHLIBPREFIX="") - if os.name == 'nt': - # Move the module to have the correct name. - mod = env.Command(os.path.join(Dir('.').srcnode().abspath, "python_test_mod.pyd"), - mod, - Move(os.path.join(Dir('.').srcnode().abspath, "python_test_mod.pyd"), mod[0])) - PythonUnitTest(pyEnv, "python_test.py", mod) - -if bpEnv.haveBoostPython: - libs = bpEnv.get("LIBS", []) + ["boost_numpy"] - libpath = bpEnv.get("LIBPATH", []) + [Dir("#Boost.NumPy/libs/numpy/src").abspath] - rpath = bpEnv.get("RPATH", []) + [Dir("#Boost.NumPy/libs/numpy/src").abspath] - bpEnv.Append( LINKFLAGS = ["$__RPATH"] ) # workaround for SCons bug #1644 - mod = bpEnv.LoadableModule("bp_test_mod", "bp_test_mod.cc", SHLIBPREFIX="", - LIBS=libs, LIBPATH=libpath, RPATH=rpath) - if os.name == 'nt': - # Move the module to have the correct name. - mod = env.Command(os.path.join(Dir('.').srcnode().abspath, "bp_test_mod.pyd"), - mod, - Move(os.path.join(Dir('.').srcnode().abspath, "bp_test_mod.pyd"), mod[0])) - PythonUnitTest(bpEnv, "bp_test.py", mod) - if bpEnv.haveEigen: - mod = bpEnv.LoadableModule("eigen_bp_test_mod", "eigen_bp_test_mod.cc", SHLIBPREFIX="", - LIBS=libs, LIBPATH=libpath, RPATH=rpath) - if os.name == 'nt': - # Move the module to have the correct name. - mod = env.Command(os.path.join(Dir('.').srcnode().abspath, "eigen_bp_test_mod.pyd"), - mod, - Move(os.path.join(Dir('.').srcnode().abspath, "eigen_bp_test_mod.pyd"), mod[0])) - PythonUnitTest(bpEnv, "eigen_bp_test.py", mod) - - -env.Clean("tests", Glob("*.os")) -env.Clean("tests", Glob("*.pyc")) -env.Clean("tests", Glob("*.so")) From 9559aa150c9de3aefe2671710e124981f04930ea Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 29 Jul 2019 11:48:45 -0400 Subject: [PATCH 34/69] Remove Boost.Python support. --- README.md | 24 +-- include/ndarray/bp.h | 18 -- include/ndarray/bp/Array.h | 160 ---------------- include/ndarray/bp/ArrayRef.h | 55 ------ include/ndarray/bp/Vector.h | 75 -------- include/ndarray/bp/auto.h | 18 -- include/ndarray/bp/auto/Array.h.m4 | 22 --- include/ndarray/bp/auto/ArrayRef.h.m4 | 22 --- include/ndarray/bp/auto/Vector.h.m4 | 22 --- include/ndarray/bp/eigen | 1 - include/ndarray/bp/eigen.h | 16 -- include/ndarray/bp_fwd.h | 21 -- include/ndarray/eigen/bp.h | 19 -- include/ndarray/eigen/bp/Array.h | 59 ------ include/ndarray/eigen/bp/EigenView.h | 84 -------- include/ndarray/eigen/bp/Matrix.h | 59 ------ include/ndarray/eigen/bp/ReturnInternal.h | 131 ------------- include/ndarray/eigen/bp/auto.h | 19 -- include/ndarray/eigen/bp/auto/Array.h.m4 | 23 --- include/ndarray/eigen/bp/auto/EigenView.h.m4 | 27 --- include/ndarray/eigen/bp/auto/Matrix.h.m4 | 23 --- m4/auto_bp_converters.m4 | 73 ------- tests/bp_test.py | 94 --------- tests/bp_test_mod.cc | 190 ------------------ tests/eigen_bp_test.py | 87 --------- tests/eigen_bp_test_mod.cc | 191 ------------------- 26 files changed, 8 insertions(+), 1525 deletions(-) delete mode 100644 include/ndarray/bp.h delete mode 100644 include/ndarray/bp/Array.h delete mode 100644 include/ndarray/bp/ArrayRef.h delete mode 100644 include/ndarray/bp/Vector.h delete mode 100644 include/ndarray/bp/auto.h delete mode 100644 include/ndarray/bp/auto/Array.h.m4 delete mode 100644 include/ndarray/bp/auto/ArrayRef.h.m4 delete mode 100644 include/ndarray/bp/auto/Vector.h.m4 delete mode 120000 include/ndarray/bp/eigen delete mode 100644 include/ndarray/bp/eigen.h delete mode 100644 include/ndarray/bp_fwd.h delete mode 100644 include/ndarray/eigen/bp.h delete mode 100644 include/ndarray/eigen/bp/Array.h delete mode 100644 include/ndarray/eigen/bp/EigenView.h delete mode 100644 include/ndarray/eigen/bp/Matrix.h delete mode 100644 include/ndarray/eigen/bp/ReturnInternal.h delete mode 100644 include/ndarray/eigen/bp/auto.h delete mode 100644 include/ndarray/eigen/bp/auto/Array.h.m4 delete mode 100644 include/ndarray/eigen/bp/auto/EigenView.h.m4 delete mode 100644 include/ndarray/eigen/bp/auto/Matrix.h.m4 delete mode 100644 m4/auto_bp_converters.m4 delete mode 100755 tests/bp_test.py delete mode 100644 tests/bp_test_mod.cc delete mode 100755 tests/eigen_bp_test.py delete mode 100644 tests/eigen_bp_test_mod.cc diff --git a/README.md b/README.md index db45c8a5..3db18535 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,10 @@ More information can be found in the [documentation at ndarray.github.io/ndarray](http://ndarray.github.io/ndarray/). -Building from Git ------------------ +Installation +------------ -CMake is the supported way to build ndarray. - -To build with cmake, do: +ndarray can be built and tested with CMake: mkdir build cd build @@ -33,17 +31,11 @@ ndarray::EigenView is not compatible with Eigen >= 3.3, nor is it compatible with pybind11's default Eigen wrappers. To build without ndarray::EigenView use cmake option `-DNDARRAY_EIGENVIEW=OFF` -ndarray's build system does not produce the correct suffixes for pybind11 outputs under pybind11 2.1.x (due to a bug in pybind11 itself). To avoid this problem, please upgrade to pybind11 2.2.x, or try the (now reverted) patch from ndarray commit f46c0f0ff876ceab5aaa3286e5f6e86902e72feb. - -However, the cmake build does not support Boost.NumPy library -and Boost.Python wrappers, which are deprecated in favor of pybind11. +ndarray's build system does not produce the correct suffixes for pybind11 +outputs under pybind11 2.1.x (due to a bug in pybind11 itself). To avoid this +problem, please upgrade to pybind11 2.2.x, or try the (now reverted) patch from +ndarray commit f46c0f0ff876ceab5aaa3286e5f6e86902e72feb. Version 1.4.2 of ndarray is the last version to support SWIG. - -Building from Compressed Source -------------------------------- - -GitHub's automatically generated tarballs and zip files don't include -the Boost.NumPy submodule or the git metadata needed to run "git -submodule", so these features can't be used from release tarball. Please download from git if you want to use the Boost.NumPy interface. +Version 1.5.3 of ndarray is the last verison to support Boost.Python. diff --git a/include/ndarray/bp.h b/include/ndarray/bp.h deleted file mode 100644 index 9cb9cd09..00000000 --- a/include/ndarray/bp.h +++ /dev/null @@ -1,18 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_bp_h_INCLUDED -#define NDARRAY_bp_h_INCLUDED - -#include "ndarray/bp/Array.h" -#include "ndarray/bp/ArrayRef.h" -#include "ndarray/bp/Vector.h" - -#endif // !NDARRAY_bp_h_INCLUDED diff --git a/include/ndarray/bp/Array.h b/include/ndarray/bp/Array.h deleted file mode 100644 index d8560813..00000000 --- a/include/ndarray/bp/Array.h +++ /dev/null @@ -1,160 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_BP_Array_h_INCLUDED -#define NDARRAY_BP_Array_h_INCLUDED - -#include "boost/numpy.hpp" -#include "ndarray.h" -#include "ndarray/bp_fwd.h" -#include - -namespace ndarray { -namespace detail { - -inline void destroyManagerCObject(void * p) { -#if PY_MAJOR_VERSION == 2 - Manager::Ptr * b = reinterpret_cast(p); -#else - Manager::Ptr * b = reinterpret_cast(PyCapsule_GetPointer(reinterpret_cast(p), 0)); -#endif - delete b; -} - -inline boost::python::object makePyObject(Manager::Ptr const & x) { - boost::intrusive_ptr< ExternalManager > y - = boost::dynamic_pointer_cast< ExternalManager >(x); - if (y) { - return y->getOwner(); - } -#if PY_MAJOR_VERSION == 2 - boost::python::handle<> h(::PyCObject_FromVoidPtr(new Manager::Ptr(x), &destroyManagerCObject)); -#else - boost::python::handle<> h(::PyCapsule_New(new Manager::Ptr(x), 0, (PyCapsule_Destructor)&destroyManagerCObject)); -#endif - return boost::python::object(h); -} - -} // namespace detail - -template -class ToBoostPython< Array > { -public: - - typedef boost::numpy::ndarray result_type; - - static boost::numpy::ndarray apply(Array const & array) { - boost::numpy::dtype dtype - = boost::numpy::dtype::get_builtin::type>(); - boost::python::object owner = detail::makePyObject(array.getManager()); - Py_ssize_t itemsize = dtype.get_itemsize(); - ndarray::Vector shape_elements = array.getShape(); - ndarray::Vector strides_elements = array.getStrides(); - std::vector shape_bytes(N); - std::vector strides_bytes(N); - for (int n=0; n -class FromBoostPython< Array > { -public: - - explicit FromBoostPython(boost::python::object const & input_) : input(input_) {} - - bool convertible() { - if (input.is_none()) return true; - try { - boost::numpy::ndarray array = boost::python::extract(input); - boost::numpy::dtype dtype - = boost::numpy::dtype::get_builtin::type>(); - boost::numpy::ndarray::bitflag flags = array.get_flags(); - if (dtype != array.get_dtype()) return false; - if (N != array.get_nd()) return false; - if (!boost::is_const::value && !(flags & boost::numpy::ndarray::WRITEABLE)) return false; - if (C > 0) { - Offset requiredStride = sizeof(T); - for (int i = 0; i < C; ++i) { - if ((array.shape(N-i-1) > 1) && (array.strides(N-i-1) != requiredStride)) { - return false; - } - requiredStride *= array.shape(N-i-1); - } - } else if (C < 0) { - Offset requiredStride = sizeof(T); - for (int i = 0; i < -C; ++i) { - if ((array.shape(i) > 1) && (array.strides(i) != requiredStride)) { - return false; - } - requiredStride *= array.shape(i); - } - } - } catch (boost::python::error_already_set) { - boost::python::handle_exception(); - PyErr_Clear(); - return false; - } - return true; - } - - Array operator()() { - if (input.is_none()) return Array(); - boost::numpy::ndarray array = boost::python::extract(input); - boost::numpy::dtype dtype = array.get_dtype(); - Py_ssize_t itemsize = dtype.get_itemsize(); - for (int i = 0; i < N; ++i) { - if ((array.shape(i) > 1) && (array.strides(i) % itemsize != 0)) { - PyErr_SetString( - PyExc_TypeError, - "Cannot convert array to C++: strides must be an integer multiple of the element size" - ); - boost::python::throw_error_already_set(); - } - } - boost::python::object obj_owner = array.get_base(); - if (obj_owner.is_none()) { - obj_owner = array; - } - Vector shape; - Vector strides; - for (int i=0; i 1) { - strides[i] = array.strides(i) / itemsize; - } else { - strides[i] = 1; - } - } - Array r = ndarray::external( - reinterpret_cast(array.get_data()), shape, strides, obj_owner - ); - return r; - } - - boost::python::object input; -}; - -} // namespace ndarray - -namespace boost { namespace numpy { - -template -numpy::ndarray array(::ndarray::Array const & arg) { - return ::ndarray::ToBoostPython< ::ndarray::Array >::apply(arg); -} - -}} // namespace boost::numpy - -#endif // !NDARRAY_BP_Array_h_INCLUDED diff --git a/include/ndarray/bp/ArrayRef.h b/include/ndarray/bp/ArrayRef.h deleted file mode 100644 index e7ab913f..00000000 --- a/include/ndarray/bp/ArrayRef.h +++ /dev/null @@ -1,55 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_BP_ArrayRef_h_INCLUDED -#define NDARRAY_BP_ArrayRef_h_INCLUDED - -#include "ndarray/bp/Array.h" - -namespace ndarray { - -template -class ToBoostPython< ArrayRef > { -public: - - typedef boost::numpy::ndarray result_type; - - static boost::numpy::ndarray apply(ArrayRef const & array) { - return ToBoostPython< Array >::apply(array); - } - -}; - -template -class FromBoostPython< ArrayRef > { -public: - - explicit FromBoostPython(boost::python::object const & input) : _impl(input) {} - - bool convertible() { return _impl.convertible(); } - - ArrayRef operator()() { return ArrayRef(_impl()); } - -private: - FromBoostPython< Array > _impl; -}; - -} // namespace ndarray - -namespace boost { namespace numpy { - -template -numpy::ndarray array(::ndarray::ArrayRef const & arg) { - return ::ndarray::ToBoostPython< ::ndarray::ArrayRef >::apply(arg); -} - -}} // namespace boost::numpy - -#endif // !NDARRAY_BP_ArrayRef_h_INCLUDED diff --git a/include/ndarray/bp/Vector.h b/include/ndarray/bp/Vector.h deleted file mode 100644 index bc86e278..00000000 --- a/include/ndarray/bp/Vector.h +++ /dev/null @@ -1,75 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_BP_Vector_h_INCLUDED -#define NDARRAY_BP_Vector_h_INCLUDED - -#include "boost/python.hpp" -#include "ndarray/Vector.h" -#include "ndarray/bp_fwd.h" - -namespace ndarray { - -template -class ToBoostPython< Vector > { -public: - - typedef boost::python::tuple result_type; - - static boost::python::tuple apply(Vector const & x) { - boost::python::handle<> t(PyTuple_New(N)); - for (int n=0; n -class FromBoostPython< Vector > { -public: - - explicit FromBoostPython(boost::python::object const & input_) : input(input_) {} - - bool convertible() { - try { - boost::python::tuple t(input); - if (len(t) != N) return false; - input = t; - } catch (boost::python::error_already_set) { - boost::python::handle_exception(); - PyErr_Clear(); - return false; - } - return true; - } - - Vector operator()() { - boost::python::tuple t = boost::python::extract(input); - if (len(t) != N) { - PyErr_SetString(PyExc_ValueError, "Incorrect size for ndarray::Vector."); - boost::python::throw_error_already_set(); - } - Vector r; - for (int n=0; n(t[n]); - } - return r; - } - - boost::python::object input; -}; - -} // namespace ndarray - -#endif // !NDARRAY_BP_Vector_h_INCLUDED diff --git a/include/ndarray/bp/auto.h b/include/ndarray/bp/auto.h deleted file mode 100644 index ed093547..00000000 --- a/include/ndarray/bp/auto.h +++ /dev/null @@ -1,18 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_BP_auto_h_INCLUDED -#define NDARRAY_BP_auto_h_INCLUDED - -#include "ndarray/bp/auto/Array.h" -#include "ndarray/bp/auto/ArrayRef.h" -#include "ndarray/bp/auto/Vector.h" - -#endif // !NDARRAY_BP_auto_h_INCLUDED diff --git a/include/ndarray/bp/auto/Array.h.m4 b/include/ndarray/bp/auto/Array.h.m4 deleted file mode 100644 index f27766da..00000000 --- a/include/ndarray/bp/auto/Array.h.m4 +++ /dev/null @@ -1,22 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -include(`auto_bp_converters.m4')dnl -changecom(`###')dnl -#ifndef NDARRAY_BP_AUTO_Array_h_INCLUDED -#define NDARRAY_BP_AUTO_Array_h_INCLUDED - -#include "boost/numpy.hpp" -#include "ndarray/bp/Array.h" - -BP_AUTO_CONVERTERS(`typename T, int N, int C', `ndarray::Array')dnl - -#endif // !NDARRAY_BP_AUTO_Array_h_INCLUDED diff --git a/include/ndarray/bp/auto/ArrayRef.h.m4 b/include/ndarray/bp/auto/ArrayRef.h.m4 deleted file mode 100644 index 06c7addc..00000000 --- a/include/ndarray/bp/auto/ArrayRef.h.m4 +++ /dev/null @@ -1,22 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -include(`auto_bp_converters.m4')dnl -changecom(`###')dnl -#ifndef NDARRAY_BP_AUTO_ArrayRef_h_INCLUDED -#define NDARRAY_BP_AUTO_ArrayRef_h_INCLUDED - -#include "boost/numpy.hpp" -#include "ndarray/bp/ArrayRef.h" - -BP_AUTO_CONVERTERS(`typename T, int N, int C', `ndarray::ArrayRef')dnl - -#endif // !NDARRAY_BP_AUTO_ArrayRef_h_INCLUDED diff --git a/include/ndarray/bp/auto/Vector.h.m4 b/include/ndarray/bp/auto/Vector.h.m4 deleted file mode 100644 index 72d6327e..00000000 --- a/include/ndarray/bp/auto/Vector.h.m4 +++ /dev/null @@ -1,22 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -include(`auto_bp_converters.m4')dnl -changecom(`###')dnl -#ifndef NDARRAY_BP_AUTO_Vector_h_INCLUDED -#define NDARRAY_BP_AUTO_Vector_h_INCLUDED - -#include "boost/numpy.hpp" -#include "ndarray/bp/Vector.h" - -BP_AUTO_CONVERTERS(`typename T, int N', `ndarray::Vector')dnl - -#endif // !NDARRAY_BP_AUTO_Vector_h_INCLUDED diff --git a/include/ndarray/bp/eigen b/include/ndarray/bp/eigen deleted file mode 120000 index b2c030d0..00000000 --- a/include/ndarray/bp/eigen +++ /dev/null @@ -1 +0,0 @@ -../eigen/bp \ No newline at end of file diff --git a/include/ndarray/bp/eigen.h b/include/ndarray/bp/eigen.h deleted file mode 100644 index b8527b6c..00000000 --- a/include/ndarray/bp/eigen.h +++ /dev/null @@ -1,16 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_BP_eigen_h_INCLUDED -#define NDARRAY_BP_eigen_h_INCLUDED - -#include "ndarray/eigen/bp.h" - -#endif // !NDARRAY_BP_eigen_h_INCLUDED diff --git a/include/ndarray/bp_fwd.h b/include/ndarray/bp_fwd.h deleted file mode 100644 index 557c2626..00000000 --- a/include/ndarray/bp_fwd.h +++ /dev/null @@ -1,21 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_bp_fwd_h_INCLUDED -#define NDARRAY_bp_fwd_h_INCLUDED - -namespace ndarray { - -template class ToBoostPython; -template class FromBoostPython; - -} // namespace ndarray - -#endif // !NDARRAY_bp_fwd_h_INCLUDED diff --git a/include/ndarray/eigen/bp.h b/include/ndarray/eigen/bp.h deleted file mode 100644 index ce77f8dd..00000000 --- a/include/ndarray/eigen/bp.h +++ /dev/null @@ -1,19 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_EIGEN_bp_h_INCLUDED -#define NDARRAY_EIGEN_bp_h_INCLUDED - -#include "ndarray/eigen/bp/EigenView.h" -#include "ndarray/eigen/bp/Array.h" -#include "ndarray/eigen/bp/Matrix.h" -#include "ndarray/eigen/bp/ReturnInternal.h" - -#endif // !NDARRAY_EIGEN_bp_h_INCLUDED diff --git a/include/ndarray/eigen/bp/Array.h b/include/ndarray/eigen/bp/Array.h deleted file mode 100644 index a6233366..00000000 --- a/include/ndarray/eigen/bp/Array.h +++ /dev/null @@ -1,59 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_EIGEN_BP_Array_h_INCLUDED -#define NDARRAY_EIGEN_BP_Array_h_INCLUDED - -#include "ndarray/eigen/bp/EigenView.h" -#include "buildOptions.h" - -#ifdef NDARRAY_EIGENVIEW - -namespace ndarray { - -template -class ToBoostPython< Eigen::Array > { -public: - - typedef Eigen::Array Input; - - typedef boost::numpy::ndarray result_type; - - typedef typename SelectEigenView::Type View; - - static boost::numpy::ndarray apply(Input const & input) { - return ToBoostPython< View >::apply(ndarray::copy(input)); - } - -}; - -template -class FromBoostPython< Eigen::Array > { -public: - - typedef Eigen::Array Output; - - // Use noncontiguous EigenView ('false' below) because we don't care about the input strides. - typedef typename SelectEigenView::Type View; - - explicit FromBoostPython(boost::python::object const & input) : _impl(input) {} - - bool convertible() { return _impl.convertible(); } - - Output operator()() { return Output(_impl()); } - -private: - FromBoostPython< View > _impl; -}; - -} // namespace ndarray - -#endif // NDARRAY_EIGENVIEW -#endif // !NDARRAY_EIGEN_BP_Matrix_h_INCLUDED diff --git a/include/ndarray/eigen/bp/EigenView.h b/include/ndarray/eigen/bp/EigenView.h deleted file mode 100644 index fa2bdbf0..00000000 --- a/include/ndarray/eigen/bp/EigenView.h +++ /dev/null @@ -1,84 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_EIGEN_BP_EigenView_h_INCLUDED -#define NDARRAY_EIGEN_BP_EigenView_h_INCLUDED - -#include "boost/numpy.hpp" -#include "ndarray/bp/Array.h" -#include "ndarray/eigen.h" -#include "ndarray/buildOptions.h" - -#ifdef NDARRAY_EIGENVIEW - -namespace ndarray { - -template -class ToBoostPython< EigenView > { -public: - - typedef boost::numpy::ndarray result_type; - - static boost::numpy::ndarray apply(EigenView const & input) { - boost::numpy::ndarray result = ToBoostPython< Array >::apply(input.shallow()); - if (Rows_ == 1 || Cols_ == 1) return result.squeeze(); - return result; - } - -}; - -template -class FromBoostPython< EigenView > { -public: - - BOOST_STATIC_ASSERT( N == 1 || N == 2 ); - - BOOST_STATIC_ASSERT( N != 1 || Rows_ == 1 || Cols_ == 1 ); - - explicit FromBoostPython(boost::python::object const & input) : _impl(input) {} - - bool convertible() { - try { - boost::numpy::ndarray array = boost::python::extract(_impl.input); - if (N == 2) { - if (Rows_ == 1) { - array = array.reshape(boost::python::make_tuple(1, -1)); - } else if (Cols_ == 1) { - array = array.reshape(boost::python::make_tuple(-1, 1)); - } - if (Rows_ != Eigen::Dynamic && array.shape(0) != Rows_) return false; - if (Cols_ != Eigen::Dynamic && array.shape(1) != Cols_) return false; - } else if (N == 1) { - array = array.squeeze(); - int requiredSize = Rows_ * Cols_; - if (requiredSize != Eigen::Dynamic && array.shape(0) != requiredSize) return false; - } - _impl.input = array; - if (!_impl.convertible()) return false; - } catch (boost::python::error_already_set) { - boost::python::handle_exception(); - PyErr_Clear(); - return false; - } - return true; - } - - EigenView operator()() { - return EigenView(_impl()); - } - -private: - FromBoostPython< Array > _impl; -}; - -} // namespace ndarray - -#endif // NDARRAY_EIGENVIEW -#endif // !NDARRAY_EIGEN_BP_EigenView_h_INCLUDED diff --git a/include/ndarray/eigen/bp/Matrix.h b/include/ndarray/eigen/bp/Matrix.h deleted file mode 100644 index 895115b0..00000000 --- a/include/ndarray/eigen/bp/Matrix.h +++ /dev/null @@ -1,59 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_EIGEN_BP_Matrix_h_INCLUDED -#define NDARRAY_EIGEN_BP_Matrix_h_INCLUDED - -#include "ndarray/eigen/bp/EigenView.h" -#include "ndarray/buildOptions.h" - -#ifdef NDARRAY_EIGENVIEW - -namespace ndarray { - -template -class ToBoostPython< Eigen::Matrix > { -public: - - typedef Eigen::Matrix Input; - - typedef boost::numpy::ndarray result_type; - - typedef typename SelectEigenView::Type View; - - static boost::numpy::ndarray apply(Input const & input) { - return ToBoostPython< View >::apply(ndarray::copy(input)); - } - -}; - -template -class FromBoostPython< Eigen::Matrix > { -public: - - typedef Eigen::Matrix Output; - - // Use noncontiguous EigenView ('false' below) because we don't care about the input strides. - typedef typename SelectEigenView::Type View; - - explicit FromBoostPython(boost::python::object const & input) : _impl(input) {} - - bool convertible() { return _impl.convertible(); } - - Output operator()() { return Output(_impl()); } - -private: - FromBoostPython< View > _impl; -}; - -} // namespace ndarray - -#endif // NDARRAY_EIGENVIEW -#endif // !NDARRAY_EIGEN_BP_Matrix_h_INCLUDED diff --git a/include/ndarray/eigen/bp/ReturnInternal.h b/include/ndarray/eigen/bp/ReturnInternal.h deleted file mode 100644 index 96580d56..00000000 --- a/include/ndarray/eigen/bp/ReturnInternal.h +++ /dev/null @@ -1,131 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_EIGEN_BP_ReturnInternal_h_INCLUDED -#define NDARRAY_EIGEN_BP_ReturnInternal_h_INCLUDED - -#if defined __GNUC__ && __GNUC__>=6 - #pragma GCC diagnostic ignored "-Wignored-attributes" - #pragma GCC diagnostic ignored "-Wdeprecated-declarations" -#endif - -#include "boost/numpy.hpp" -#include - -namespace ndarray { namespace detail { - -template -struct ShallowToBoostPython { - - typedef boost::numpy::ndarray result_type; - - typedef typename Input::Scalar Scalar; - - static boost::numpy::ndarray apply(Input const & input, bool writeable=true) { - boost::numpy::dtype dtype = boost::numpy::dtype::get_builtin(); - int itemsize = dtype.get_itemsize(); - std::vector shape(2); - shape[0] = input.rows(); - shape[1] = input.cols(); - std::vector strides(2, itemsize); - strides[0] *= input.rowStride(); - strides[1] *= input.colStride(); - boost::python::object none; - boost::numpy::ndarray result = (writeable) ? - boost::numpy::from_data(const_cast(input.data()), dtype, shape, strides, none) : - boost::numpy::from_data(const_cast(input.data()), dtype, shape, strides, none); - if (Input::RowsAtCompileTime == 1 || Input::ColsAtCompileTime == 1) return result.squeeze(); - return result; - } -}; - -} // namespace detail - -template -struct ReturnInternal : public Base { - - /** - * \brief A model of ResultConverter that creates a numpy.matrix view into an Eigen object. - * - * Note that the returned view does not own its own data, and doesn't (yet) own a reference - * to the object that does. For this reason, this result converter should ONLY be used by - * return_internal_matrix or with another model of CallPolicies with a postcall operations - * that installs a reference to the owning object. - */ - template - struct MakeShallowMatrix { - - inline bool convertible() const { return true; } - - inline PyObject * operator()(Input const & x) const { - try { - boost::python::object r = detail::ShallowToBoostPython< Input >::apply(x, writeable); - Py_INCREF(r.ptr()); - return r.ptr(); - } catch (boost::python::error_already_set & exc) { - boost::python::handle_exception(); - return NULL; - } - } - - inline PyTypeObject const * get_pytype() const { - return boost::python::converter::object_manager_traits< - typename detail::ShallowToBoostPython< Input >::result_type - >::get_pytype(); - } - - }; - - /// \brief Model of ResultConverterGenerator for make_shallow_matrix. - struct result_converter { - template - struct apply { - typedef typename boost::remove_reference::type dereferenced; - - typedef MakeShallowMatrix< - typename boost::remove_const::type, - boost::is_const::value - > type; - }; - }; - - template - static PyObject * postcall(ArgumentPackage const & args_, PyObject * result) { - std::size_t arity_ = boost::python::detail::arity(args_); - if (owner_arg > arity_ || owner_arg < 1) { - PyErr_SetString(PyExc_IndexError, - "ndarray::ReturnInternal: argument out of range."); - return NULL; - } - PyObject * owner_ref = boost::python::detail::get_prev::execute(args_, result); - if (owner_ref == NULL) return 0; - result = Base::postcall(args_, result); - if (result == NULL) return 0; - try { - boost::python::object owner( - reinterpret_cast(owner_ref) - ); - boost::numpy::ndarray array( - reinterpret_cast(result) - ); - array.set_base(owner); - Py_INCREF(array.ptr()); - result = array.ptr(); - } catch (boost::python::error_already_set & err) { - boost::python::handle_exception(); - return NULL; - } - return result; - } -}; - -} // namespace ndarray - -#endif // !NDARRAY_EIGEN_BP_ReturnInternal_h_INCLUDED diff --git a/include/ndarray/eigen/bp/auto.h b/include/ndarray/eigen/bp/auto.h deleted file mode 100644 index b1cefbd5..00000000 --- a/include/ndarray/eigen/bp/auto.h +++ /dev/null @@ -1,19 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_EIGEN_BP_auto_h_INCLUDED -#define NDARRAY_EIGEN_BP_auto_h_INCLUDED - -#include "ndarray/eigen/bp/auto/EigenView.h" -#include "ndarray/eigen/bp/auto/Array.h" -#include "ndarray/eigen/bp/auto/Matrix.h" -#include "ndarray/eigen/bp.h" - -#endif // !NDARRAY_EIGEN_BP_auto_h_INCLUDED diff --git a/include/ndarray/eigen/bp/auto/Array.h.m4 b/include/ndarray/eigen/bp/auto/Array.h.m4 deleted file mode 100644 index 8202b295..00000000 --- a/include/ndarray/eigen/bp/auto/Array.h.m4 +++ /dev/null @@ -1,23 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -include(`auto_bp_converters.m4')dnl -changecom(`###')dnl -#ifndef NDARRAY_EIGEN_BP_AUTO_Array_h_INCLUDED -#define NDARRAY_EIGEN_BP_AUTO_Array_h_INCLUDED - -#include "boost/numpy.hpp" -#include "ndarray/eigen/bp/Array.h" - -BP_AUTO_CONVERTERS(`typename Scalar, int Rows, int Cols, int Options, int MaxRows, int MaxCols', - `Eigen::Array')dnl - -#endif // !NDARRAY_EIGEN_BP_AUTO_Array_h_INCLUDED diff --git a/include/ndarray/eigen/bp/auto/EigenView.h.m4 b/include/ndarray/eigen/bp/auto/EigenView.h.m4 deleted file mode 100644 index 994a4502..00000000 --- a/include/ndarray/eigen/bp/auto/EigenView.h.m4 +++ /dev/null @@ -1,27 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -include(`auto_bp_converters.m4')dnl -changecom(`###')dnl -#ifndef NDARRAY_EIGEN_BP_AUTO_EigenView_h_INCLUDED -#define NDARRAY_EIGEN_BP_AUTO_EigenView_h_INCLUDED - -#include "boost/numpy.hpp" -#include "ndarray/eigen/bp/EigenView.h" -#include "ndarray/buildOptions.h" - -#ifdef NDARRAY_EIGENVIEW - -BP_AUTO_CONVERTERS(`typename T, int N, int C, typename XprKind_, int Rows_, int Cols_', - `ndarray::EigenView')dnl - -#endif // NDARRAY_EIGENVIEW -#endif // !NDARRAY_EIGEN_BP_AUTO_EigenView_h_INCLUDED diff --git a/include/ndarray/eigen/bp/auto/Matrix.h.m4 b/include/ndarray/eigen/bp/auto/Matrix.h.m4 deleted file mode 100644 index adadb29f..00000000 --- a/include/ndarray/eigen/bp/auto/Matrix.h.m4 +++ /dev/null @@ -1,23 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -include(`auto_bp_converters.m4')dnl -changecom(`###')dnl -#ifndef NDARRAY_EIGEN_BP_AUTO_Matrix_h_INCLUDED -#define NDARRAY_EIGEN_BP_AUTO_Matrix_h_INCLUDED - -#include "boost/numpy.hpp" -#include "ndarray/eigen/bp/Matrix.h" - -BP_AUTO_CONVERTERS(`typename Scalar, int Rows, int Cols, int Options, int MaxRows, int MaxCols', - `Eigen::Matrix')dnl - -#endif // !NDARRAY_EIGEN_BP_AUTO_Matrix_h_INCLUDED diff --git a/m4/auto_bp_converters.m4 b/m4/auto_bp_converters.m4 deleted file mode 100644 index d07d5709..00000000 --- a/m4/auto_bp_converters.m4 +++ /dev/null @@ -1,73 +0,0 @@ -define(`BP_AUTO_CONVERTERS', -` -namespace boost { namespace python { - -template <$1> -struct to_python_value< $2 const & > : public detail::builtin_to_python { - inline PyObject * operator()($2 const & x) const { - object result = ndarray::ToBoostPython< $2 >::apply(x); - Py_INCREF(result.ptr()); - return result.ptr(); - } - inline PyTypeObject const * get_pytype() const { - return converter::object_manager_traits< - typename ndarray::ToBoostPython< $2 >::result_type - >::get_pytype(); - } -}; - -template <$1> -struct to_python_value< $2 & > : public detail::builtin_to_python { - inline PyObject * operator()($2 & x) const { - object result = ndarray::ToBoostPython< $2 >::apply(x); - Py_INCREF(result.ptr()); - return result.ptr(); - } - inline PyTypeObject const * get_pytype() const { - return converter::object_manager_traits< - typename ndarray::ToBoostPython< $2 >::result_type - >::get_pytype(); - } -}; - -namespace converter { - -template <$1> -struct arg_to_python< $2 > : public handle<> { - inline arg_to_python($2 const & v) : - handle<>(to_python_value<$2 const &>()(v)) {} -}; - -template <$1> -struct arg_rvalue_from_python< $2 const & > { - typedef $2 result_type; - arg_rvalue_from_python(PyObject * p) : - _converter(boost::python::object(boost::python::handle<>(boost::python::borrowed(p)))) {} - bool convertible() const { return _converter.convertible(); } - result_type operator()() const { return _converter(); } -private: - mutable ndarray::FromBoostPython< $2 > _converter; -}; - -template <$1> -struct arg_rvalue_from_python< $2 > : public arg_rvalue_from_python< $2 const &> { - arg_rvalue_from_python(PyObject * p) : arg_rvalue_from_python< $2 const & >(p) {} -}; - -template <$1> -struct arg_rvalue_from_python< $2 const > : public arg_rvalue_from_python< $2 const &> { - arg_rvalue_from_python(PyObject * p) : arg_rvalue_from_python< $2 const & >(p) {} -}; - -template <$1> -struct extract_rvalue< $2 > : private noncopyable { - typedef $2 result_type; - extract_rvalue(PyObject * x) : m_converter(x) {} - bool check() const { return m_converter.convertible(); } - result_type operator()() const { return m_converter(); } -private: - arg_rvalue_from_python< result_type const & > m_converter; -}; - -}}} // namespace boost::python::converter -')dnl diff --git a/tests/bp_test.py b/tests/bp_test.py deleted file mode 100755 index 714c8f5a..00000000 --- a/tests/bp_test.py +++ /dev/null @@ -1,94 +0,0 @@ -# -*- python -*- -# -# Copyright (c) 2010-2012, Jim Bosch -# All rights reserved. -# -# ndarray is distributed under a simple BSD-like license; -# see the LICENSE file that should be present in the root -# of the source distribution, or alternately available at: -# https://github.com/ndarray/ndarray -# -import bp_test_mod -import unittest -import numpy - -class TestNdArrayWrappers(unittest.TestCase): - - def testReturnArray(self): - for suffix in ("11","10","22","21","20","33","32","31","30"): - func = getattr(bp_test_mod, "returnArray_d%s" % suffix) - cfunc = getattr(bp_test_mod, "returnArray_dc%s" % suffix) - array = func() - carray = cfunc() - self.assert_((array == numpy.arange(0, array.size).reshape(array.shape)).all()) - self.assert_((carray == numpy.arange(0, carray.size).reshape(carray.shape)).all()) - self.assert_(array.flags["WRITEABLE"]) - self.assert_(not carray.flags["WRITEABLE"]) - - def testAcceptArray(self): - for suffix in ("11","10","22","21","20","33","32","31","30"): - func = getattr(bp_test_mod, "acceptArray_d%s" % suffix) - cfunc = getattr(bp_test_mod, "acceptArray_dc%s" % suffix) - nd = int(suffix[0]) - shape = tuple(int(i) for i in numpy.random.randint(low=2,high=5,size=nd)) - array = numpy.zeros(shape, dtype=float) - array[:] = numpy.arange(0, array.size).reshape(array.shape) - self.assert_(func(array)) - self.assert_(cfunc(array)) - - def testAcceptArrayVal(self): - for suffix in ("11","10","22","21","20","33","32","31","30"): - func = getattr(bp_test_mod, "acceptArrayVal_d%s" % suffix) - cfunc = getattr(bp_test_mod, "acceptArrayVal_dc%s" % suffix) - nd = int(suffix[0]) - shape = tuple(int(i) for i in numpy.random.randint(low=2,high=5,size=nd)) - array = numpy.zeros(shape, dtype=float) - array[:] = numpy.arange(0, array.size).reshape(array.shape) - self.assert_(func(array)) - self.assert_(cfunc(array)) - - def testExtractArray(self): - for suffix in ("11","10","22","21","20","33","32","31","30"): - func = getattr(bp_test_mod, "extractArray_d%s" % suffix) - cfunc = getattr(bp_test_mod, "extractArray_dc%s" % suffix) - nd = int(suffix[0]) - shape = tuple(int(i) for i in numpy.random.randint(low=2,high=5,size=nd)) - array = numpy.zeros(shape, dtype=float) - array[:] = numpy.arange(0, array.size).reshape(array.shape) - self.assert_(func(array)) - self.assert_(cfunc(array)) - - def testReturnVector(self): - for suffix in ("2","3"): - func = getattr(bp_test_mod, "returnVector_d%s" % suffix) - vector = func() - self.assertEqual(vector, tuple(numpy.arange(len(vector), dtype=float))) - - def testAcceptVector(self): - for suffix in ("2","3"): - func = getattr(bp_test_mod, "acceptVector_d%s" % suffix) - nd = int(suffix[0]) - vector = tuple(numpy.arange(nd, dtype=float)) - self.assert_(func(vector)) - - def testStrideHandling(self): - # in NumPy 1.8+ 1- and 0-sized arrays can have arbitrary strides; we should - # be able to handle those - array = numpy.zeros(1, dtype=float) - self.assert_(bp_test_mod.acceptArray_d11(array)) - self.assert_(bp_test_mod.acceptArray_d10(array)) - array = numpy.zeros(0, dtype=float) - self.assert_(bp_test_mod.acceptArray_d11(array)) - self.assert_(bp_test_mod.acceptArray_d10(array)) - # test that we gracefully fail when the strides are not multiples of the itemsize - dtype = numpy.dtype([("f1", numpy.float64), ("f2", numpy.int16)]) - table = numpy.zeros(3, dtype=dtype) - self.assertRaises(TypeError, bp_test_mod.acceptArray_d10, table['f1']) - - def _testMemory(self): - shape = (400, 400, 10) - for n in range(1000000): - a = bp_test_mod.makeArray_d33(shape) - -if __name__=="__main__": - unittest.main() diff --git a/tests/bp_test_mod.cc b/tests/bp_test_mod.cc deleted file mode 100644 index cce9795f..00000000 --- a/tests/bp_test_mod.cc +++ /dev/null @@ -1,190 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ - -#include "ndarray/bp/auto.h" - -#include "boost/random/mersenne_twister.hpp" -#include "boost/random/uniform_int.hpp" - -static boost::mt19937 engine; -static boost::uniform_int<> random_int(2, 5); - -template -ndarray::Array makeArray(ndarray::Vector const & shape) { - ndarray::Array::type,N,N> a = ndarray::allocate(shape); - ndarray::Array::type,1,1> flat = ndarray::flatten<1>(a); - for (int n=0; n < flat.template getSize<0>(); ++n) { - flat[n] = n; - } - return a; -} - -template -ndarray::Vector makeShape() { - ndarray::Vector shape; - for (int n=0; n -ndarray::Array returnArray() { - ndarray::Array::type,N,N> a = ndarray::allocate(makeShape()); - ndarray::Array::type,1,1> flat = ndarray::flatten<1>(a); - for (int n=0; n < flat.template getSize<0>(); ++n) { - flat[n] = n; - } - return a; -} - -template -bool acceptArray(ndarray::Array const & p) { - ndarray::Array::type,N,N> a = ndarray::allocate(p.getShape()); - a.deep() = p; - ndarray::Array::type,1,1> flat = ndarray::flatten<1>(a); - for (int n=0; n < flat.template getSize<0>(); ++n) { - if (flat[n] != n) return false; - } - return true; -} - -template -bool acceptArrayVal(ndarray::Array p) { - ndarray::Array::type,N,N> a = ndarray::allocate(p.getShape()); - a.deep() = p; - ndarray::Array::type,1,1> flat = ndarray::flatten<1>(a); - for (int n=0; n < flat.template getSize<0>(); ++n) { - if (flat[n] != n) return false; - } - return true; -} - -template -bool extractArray(boost::python::object const & obj) { - ndarray::Array p = boost::python::extract< ndarray::Array >(obj); - ndarray::Array::type,N,N> a = ndarray::allocate(p.getShape()); - a.deep() = p; - ndarray::Array::type,1,1> flat = ndarray::flatten<1>(a); - for (int n=0; n < flat.template getSize<0>(); ++n) { - if (flat[n] != n) return false; - } - return true; -} - -template -ndarray::Vector returnVector() { - ndarray::Vector r; - for (int n=0; n -bool acceptVector(ndarray::Vector const & p) { - for (int n=0; n -bool extractVector(boost::python::object const & obj) { - ndarray::Vector p = boost::python::extract< ndarray::Vector >(obj); - for (int n=0; n); - boost::python::def("returnArray_d11", returnArray); - boost::python::def("returnArray_d10", returnArray); - boost::python::def("returnArray_d22", returnArray); - boost::python::def("returnArray_d21", returnArray); - boost::python::def("returnArray_d20", returnArray); - boost::python::def("returnArray_d33", returnArray); - boost::python::def("returnArray_d32", returnArray); - boost::python::def("returnArray_d31", returnArray); - boost::python::def("returnArray_d30", returnArray); - boost::python::def("returnArray_dc11", returnArray); - boost::python::def("returnArray_dc10", returnArray); - boost::python::def("returnArray_dc22", returnArray); - boost::python::def("returnArray_dc21", returnArray); - boost::python::def("returnArray_dc20", returnArray); - boost::python::def("returnArray_dc33", returnArray); - boost::python::def("returnArray_dc32", returnArray); - boost::python::def("returnArray_dc31", returnArray); - boost::python::def("returnArray_dc30", returnArray); - boost::python::def("acceptArray_d11", acceptArray); - boost::python::def("acceptArray_d10", acceptArray); - boost::python::def("acceptArray_d22", acceptArray); - boost::python::def("acceptArray_d21", acceptArray); - boost::python::def("acceptArray_d20", acceptArray); - boost::python::def("acceptArray_d33", acceptArray); - boost::python::def("acceptArray_d32", acceptArray); - boost::python::def("acceptArray_d31", acceptArray); - boost::python::def("acceptArray_d30", acceptArray); - boost::python::def("acceptArray_dc11", acceptArray); - boost::python::def("acceptArray_dc10", acceptArray); - boost::python::def("acceptArray_dc22", acceptArray); - boost::python::def("acceptArray_dc21", acceptArray); - boost::python::def("acceptArray_dc20", acceptArray); - boost::python::def("acceptArray_dc33", acceptArray); - boost::python::def("acceptArray_dc32", acceptArray); - boost::python::def("acceptArray_dc31", acceptArray); - boost::python::def("acceptArray_dc30", acceptArray); - boost::python::def("acceptArrayVal_d11", acceptArrayVal); - boost::python::def("acceptArrayVal_d10", acceptArrayVal); - boost::python::def("acceptArrayVal_d22", acceptArrayVal); - boost::python::def("acceptArrayVal_d21", acceptArrayVal); - boost::python::def("acceptArrayVal_d20", acceptArrayVal); - boost::python::def("acceptArrayVal_d33", acceptArrayVal); - boost::python::def("acceptArrayVal_d32", acceptArrayVal); - boost::python::def("acceptArrayVal_d31", acceptArrayVal); - boost::python::def("acceptArrayVal_d30", acceptArrayVal); - boost::python::def("acceptArrayVal_dc11", acceptArrayVal); - boost::python::def("acceptArrayVal_dc10", acceptArrayVal); - boost::python::def("acceptArrayVal_dc22", acceptArrayVal); - boost::python::def("acceptArrayVal_dc21", acceptArrayVal); - boost::python::def("acceptArrayVal_dc20", acceptArrayVal); - boost::python::def("acceptArrayVal_dc33", acceptArrayVal); - boost::python::def("acceptArrayVal_dc32", acceptArrayVal); - boost::python::def("acceptArrayVal_dc31", acceptArrayVal); - boost::python::def("acceptArrayVal_dc30", acceptArrayVal); - boost::python::def("extractArray_d11", extractArray); - boost::python::def("extractArray_d10", extractArray); - boost::python::def("extractArray_d22", extractArray); - boost::python::def("extractArray_d21", extractArray); - boost::python::def("extractArray_d20", extractArray); - boost::python::def("extractArray_d33", extractArray); - boost::python::def("extractArray_d32", extractArray); - boost::python::def("extractArray_d31", extractArray); - boost::python::def("extractArray_d30", extractArray); - boost::python::def("extractArray_dc11", extractArray); - boost::python::def("extractArray_dc10", extractArray); - boost::python::def("extractArray_dc22", extractArray); - boost::python::def("extractArray_dc21", extractArray); - boost::python::def("extractArray_dc20", extractArray); - boost::python::def("extractArray_dc33", extractArray); - boost::python::def("extractArray_dc32", extractArray); - boost::python::def("extractArray_dc31", extractArray); - boost::python::def("extractArray_dc30", extractArray); - boost::python::def("returnVector_d3", returnVector); - boost::python::def("returnVector_d2", returnVector); - boost::python::def("acceptVector_d3", acceptVector); - boost::python::def("acceptVector_d2", acceptVector); - boost::python::def("extractVector_d3", extractVector); - boost::python::def("extractVector_d2", extractVector); -} diff --git a/tests/eigen_bp_test.py b/tests/eigen_bp_test.py deleted file mode 100755 index 45c014cd..00000000 --- a/tests/eigen_bp_test.py +++ /dev/null @@ -1,87 +0,0 @@ -# -*- python -*- -# -# Copyright (c) 2010-2012, Jim Bosch -# All rights reserved. -# -# ndarray is distributed under a simple BSD-like license; -# see the LICENSE file that should be present in the root -# of the source distribution, or alternately available at: -# https://github.com/ndarray/ndarray -# -import eigen_bp_test_mod -import unittest -import numpy - -class TestEigenWrappers(unittest.TestCase): - - def setUp(self): - self.matrix_p_i = numpy.array([[1,2,3],[4,5,6]], dtype=numpy.int32, order="C") - self.matrix_p_d = numpy.array([[1,2,3],[4,5,6]], dtype=numpy.float64, order="C") - self.matrix_m_i = numpy.array([[1,2,3],[4,5,6]], dtype=numpy.int32, order="F") - self.matrix_m_d = numpy.array([[1,2,3],[4,5,6]], dtype=numpy.float64, order="F") - self.vector_i = numpy.array([1,2,3,4], dtype=numpy.int32) - self.vector_d = numpy.array([1,2,3,4], dtype=numpy.float64) - - def testEigenView(self): - for typechar in ("d", "i"): - for name1 in ("M23", "MX3", "M2X", "MXX", "A23", "AX3", "A2X", "AXX"): - for name2 in ("2p2", "2p1", "2p0"): - m = getattr(self, "matrix_p_%s" % typechar) - accept = getattr(eigen_bp_test_mod, "acceptEigenView_%s%s_%s" % (name1, typechar, name2)) - ret = getattr(eigen_bp_test_mod, "returnEigenView_%s%s_%s" % (name1, typechar, name2)) - self.assert_(accept(m)) - self.assert_((ret() == m).all()) - for name2 in ("2m2", "2m1", "2p0"): - m = getattr(self, "matrix_m_%s" % typechar) - accept = getattr(eigen_bp_test_mod, "acceptEigenView_%s%s_%s" % (name1, typechar, name2)) - ret = getattr(eigen_bp_test_mod, "returnEigenView_%s%s_%s" % (name1, typechar, name2)) - self.assert_(accept(m)) - self.assert_((ret() == m).all()) - - def testAcceptMatrix(self): - self.assert_(eigen_bp_test_mod.acceptMatrix_23d_cref(self.matrix_p_d)) - self.assert_(eigen_bp_test_mod.acceptMatrix_X3d_cref(self.matrix_p_d)) - self.assert_(eigen_bp_test_mod.acceptMatrix_2Xd_cref(self.matrix_p_d)) - self.assert_(eigen_bp_test_mod.acceptMatrix_XXd_cref(self.matrix_p_d)) - self.assert_(eigen_bp_test_mod.acceptMatrix_23d_cref(self.matrix_m_d)) - self.assert_(eigen_bp_test_mod.acceptMatrix_X3d_cref(self.matrix_m_d)) - self.assert_(eigen_bp_test_mod.acceptMatrix_2Xd_cref(self.matrix_m_d)) - self.assert_(eigen_bp_test_mod.acceptMatrix_XXd_cref(self.matrix_m_d)) - - def testAcceptVector(self): - self.assert_(eigen_bp_test_mod.acceptVector_41d_cref(self.vector_d)) - self.assert_(eigen_bp_test_mod.acceptVector_X1d_cref(self.vector_d)) - self.assert_(eigen_bp_test_mod.acceptVector_14d_cref(self.vector_d)) - self.assert_(eigen_bp_test_mod.acceptVector_1Xd_cref(self.vector_d)) - - def testReturnMatrix(self): - self.assert_((eigen_bp_test_mod.returnMatrix_23d() == self.matrix_p_d).all()) - self.assert_((eigen_bp_test_mod.returnMatrix_X3d() == self.matrix_p_d).all()) - self.assert_((eigen_bp_test_mod.returnMatrix_2Xd() == self.matrix_p_d).all()) - self.assert_((eigen_bp_test_mod.returnMatrix_XXd() == self.matrix_p_d).all()) - self.assert_((eigen_bp_test_mod.returnMatrix_23d_c() == self.matrix_p_d).all()) - self.assert_((eigen_bp_test_mod.returnMatrix_X3d_c() == self.matrix_p_d).all()) - self.assert_((eigen_bp_test_mod.returnMatrix_2Xd_c() == self.matrix_p_d).all()) - self.assert_((eigen_bp_test_mod.returnMatrix_XXd_c() == self.matrix_p_d).all()) - - def testReturnObject(self): - self.assert_((eigen_bp_test_mod.returnObject_23d() == self.matrix_p_d).all()) - self.assert_((eigen_bp_test_mod.returnObject_X3d() == self.matrix_p_d).all()) - self.assert_((eigen_bp_test_mod.returnObject_2Xd() == self.matrix_p_d).all()) - self.assert_((eigen_bp_test_mod.returnObject_XXd() == self.matrix_p_d).all()) - - def testMatrixOwner(self): - for suffix in ("23d", "X3d", "2Xd", "XXd"): - cls = getattr(eigen_bp_test_mod, "MatrixOwner_%s" % suffix) - obj = cls() - self.assert_(obj.getMatrix_ref().base is obj) - self.assert_(obj.getMatrix_cref().base is obj) - self.assert_((obj.getMatrix_ref() == self.matrix_p_d).all()) - self.assert_((obj.getMatrix_cref() == self.matrix_p_d).all()) - self.assert_(obj.getMatrix_ref().flags["WRITEABLE"]) - self.assert_(not obj.getMatrix_cref().flags["WRITEABLE"]) - self.assert_(not obj.getMatrix_ref().flags["OWNDATA"]) - self.assert_(not obj.getMatrix_cref().flags["OWNDATA"]) - -if __name__=="__main__": - unittest.main() diff --git a/tests/eigen_bp_test_mod.cc b/tests/eigen_bp_test_mod.cc deleted file mode 100644 index 7ae6224c..00000000 --- a/tests/eigen_bp_test_mod.cc +++ /dev/null @@ -1,191 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#include "ndarray/buildOptions.h" -#include "ndarray/eigen/bp/auto.h" - -namespace bp = boost::python; -namespace bn = boost::numpy; - -template -bool acceptMatrix(M m) { - return (m(0,0) == 1) && (m(0,1) == 2) && (m(0,2) == 3) - && (m(1,0) == 4) && (m(1,1) == 5) && (m(1,2) == 6); -} - -template -bool acceptVector(M m) { - return (m[0] == 1) && (m[1] == 2) && (m[2] == 3) && (m[3] == 4); -} - - -template -void fillMatrix(M & m) { - m(0,0) = 1; - m(0,1) = 2; - m(0,2) = 3; - m(1,0) = 4; - m(1,1) = 5; - m(1,2) = 6; -} - -#ifdef NDARRAY_EIGENVIEW - -template -M returnEigenView() { - static typename boost::remove_const::type>::type m( - ndarray::allocate(2,3) - ); - fillMatrix(m); - return m; -} - -#endif NDARRAY_EIGENVIEW - -template -M returnMatrix() { - static typename boost::remove_const::type>::type m(2,3); - fillMatrix(m); - return m; -} - -template -void fillVector(M & m) { - m[0] = 1; - m[1] = 2; - m[2] = 3; - m[3] = 4; -} - -template -M returnVector() { - static typename boost::remove_const::type>::type m(4); - fillVector(m); - return m; -} - -template -bp::object returnObject() { - static typename boost::remove_const::type>::type m(2,3); - fillMatrix(m); - bp::object o(m); - return o; -} - -template -class MatrixOwner { - M _matrix; -public: - MatrixOwner() : _matrix(2,3) { fillMatrix(_matrix); } - - M const & getMatrix_cref() const { return _matrix; } - M & getMatrix_ref() { return _matrix; } - - bool compareData(bn::matrix const & mp) const { - return _matrix.data() == reinterpret_cast(mp.get_data()); - } - - EIGEN_MAKE_ALIGNED_OPERATOR_NEW; - - static void declare(char const * name) { - bp::class_< MatrixOwner >(name) - .def("getMatrix_cref", &MatrixOwner::getMatrix_cref, - ndarray::ReturnInternal<>()) - .def("getMatrix_ref", &MatrixOwner::getMatrix_ref, - ndarray::ReturnInternal<>()) - .def("compareData", &MatrixOwner::compareData) - ; - } -}; - -static const int X = Eigen::Dynamic; - -#ifdef NDARRAY_EIGENVIEW - -template -void wrapEigenView(std::string const & name) { - bp::def(("accept" + name + "_2p2").c_str(), - acceptMatrix const &>); - bp::def(("accept" + name + "_2p1").c_str(), - acceptMatrix const &>); - bp::def(("accept" + name + "_2p0").c_str(), - acceptMatrix const &>); - bp::def(("accept" + name + "_2m1").c_str(), - acceptMatrix const &>); - bp::def(("accept" + name + "_2m2").c_str(), - acceptMatrix const &>); - bp::def(("return" + name + "_2p2").c_str(), - returnEigenView >); - bp::def(("return" + name + "_2p1").c_str(), - returnEigenView >); - bp::def(("return" + name + "_2p0").c_str(), - returnEigenView >); - bp::def(("return" + name + "_2m1").c_str(), - returnEigenView >); - bp::def(("return" + name + "_2m2").c_str(), - returnEigenView >); -} - -#endif // NDARRAY_EIGENVIEW - -BOOST_PYTHON_MODULE(eigen_bp_test_mod) { - bn::initialize(); - -#ifdef NDARRAY_EIGENVIEW - - wrapEigenView("EigenView_M23d"); - wrapEigenView("EigenView_MX3d"); - wrapEigenView("EigenView_M2Xd"); - wrapEigenView("EigenView_MXXd"); - wrapEigenView("EigenView_M23i"); - wrapEigenView("EigenView_MX3i"); - wrapEigenView("EigenView_M2Xi"); - wrapEigenView("EigenView_MXXi"); - - wrapEigenView("EigenView_A23d"); - wrapEigenView("EigenView_AX3d"); - wrapEigenView("EigenView_A2Xd"); - wrapEigenView("EigenView_AXXd"); - wrapEigenView("EigenView_A23i"); - wrapEigenView("EigenView_AX3i"); - wrapEigenView("EigenView_A2Xi"); - wrapEigenView("EigenView_AXXi"); - -#endif // NDARRAY_EIGENVIEW - - bp::def("acceptMatrix_23d_cref", acceptMatrix< Eigen::Matrix const & >); - bp::def("acceptMatrix_X3d_cref", acceptMatrix< Eigen::Matrix const & >); - bp::def("acceptMatrix_2Xd_cref", acceptMatrix< Eigen::Matrix const & >); - bp::def("acceptMatrix_XXd_cref", acceptMatrix< Eigen::Matrix const & >); - bp::def("acceptVector_41d_cref", acceptVector< Eigen::Matrix const & >); - bp::def("acceptVector_X1d_cref", acceptVector< Eigen::Matrix const & >); - bp::def("acceptVector_14d_cref", acceptVector< Eigen::Matrix const & >); - bp::def("acceptVector_1Xd_cref", acceptVector< Eigen::Matrix const & >); - bp::def("returnVector_41d", returnVector< Eigen::Matrix >); - bp::def("returnVector_14d", returnVector< Eigen::Matrix >); - bp::def("returnVector_X1d", returnVector< Eigen::Matrix >); - bp::def("returnVector_1Xd", returnVector< Eigen::Matrix >); - bp::def("returnMatrix_23d", returnMatrix< Eigen::Matrix >); - bp::def("returnMatrix_X3d", returnMatrix< Eigen::Matrix >); - bp::def("returnMatrix_2Xd", returnMatrix< Eigen::Matrix >); - bp::def("returnMatrix_XXd", returnMatrix< Eigen::Matrix >); - bp::def("returnMatrix_23d_c", returnMatrix< Eigen::Matrix const>); - bp::def("returnMatrix_X3d_c", returnMatrix< Eigen::Matrix const>); - bp::def("returnMatrix_2Xd_c", returnMatrix< Eigen::Matrix const>); - bp::def("returnMatrix_XXd_c", returnMatrix< Eigen::Matrix const>); - bp::def("returnObject_23d", returnObject< Eigen::Matrix >); - bp::def("returnObject_X3d", returnObject< Eigen::Matrix >); - bp::def("returnObject_2Xd", returnObject< Eigen::Matrix >); - bp::def("returnObject_XXd", returnObject< Eigen::Matrix >); - MatrixOwner< Eigen::Matrix >::declare("MatrixOwner_23d"); - MatrixOwner< Eigen::Matrix >::declare("MatrixOwner_X3d"); - MatrixOwner< Eigen::Matrix >::declare("MatrixOwner_2Xd"); - MatrixOwner< Eigen::Matrix >::declare("MatrixOwner_XXd"); -} From 9e5875e7784a11da0b8462481cfb0813b6b4e3fd Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 29 Jul 2019 11:41:42 -0400 Subject: [PATCH 35/69] Remove Boost.NumPy submodule. --- .gitignore | 2 -- .gitmodules | 3 --- Boost.NumPy | 1 - 3 files changed, 6 deletions(-) delete mode 100644 .gitmodules delete mode 160000 Boost.NumPy diff --git a/.gitignore b/.gitignore index 64a6a583..4d221ed2 100644 --- a/.gitignore +++ b/.gitignore @@ -26,7 +26,5 @@ include/ndarray/ArrayRef.h include/ndarray/Vector.h include/ndarray/fft/FFTWTraits.h include/ndarray/operators.h -include/ndarray/bp/auto/*.h -include/ndarray/eigen/bp/auto/*.h tests/.*.succeeded build/ diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 612e2c90..00000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "Boost.NumPy"] - path = Boost.NumPy - url = git://github.com/ndarray/Boost.NumPy.git diff --git a/Boost.NumPy b/Boost.NumPy deleted file mode 160000 index a0e849ed..00000000 --- a/Boost.NumPy +++ /dev/null @@ -1 +0,0 @@ -Subproject commit a0e849ed91fbd19e96f1eb7f69d5d89a565e5d79 From 50b0f1e582e0b85c7a822ad18b6486674740a0ae Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 29 Jul 2019 11:53:33 -0400 Subject: [PATCH 36/69] Remove old EigenView class. This class is incompatible with newer versions of Eigen and has been replaced with a different approach. --- .travis.yml | 2 +- CMakeLists.txt | 5 - README.md | 4 - include/CMakeLists.txt | 2 +- include/ndarray/ArrayBase.h | 33 --- include/ndarray/EigenView.h | 437 ------------------------------ include/ndarray/buildOptions.h.in | 1 - include/ndarray/eigen.h | 1 - include/ndarray/eigen_fwd.h | 15 +- include/ndarray/pybind11.h | 187 ------------- tests/ndarray-eigen.cc | 134 --------- tests/pybind11_test.py | 50 ---- tests/pybind11_test_mod.cc | 98 ------- 13 files changed, 3 insertions(+), 966 deletions(-) delete mode 100644 include/ndarray/EigenView.h mode change 100755 => 100644 tests/pybind11_test.py diff --git a/.travis.yml b/.travis.yml index 91298410..5a52c427 100644 --- a/.travis.yml +++ b/.travis.yml @@ -40,7 +40,7 @@ script: - make test ARGS="-V" - rm CMakeCache.txt - - cmake -DNDARRAY_PYBIND11=ON -DNDARRAY_EIGENVIEW=ON .. + - cmake -DNDARRAY_PYBIND11=ON .. - make - make test ARGS="-V" diff --git a/CMakeLists.txt b/CMakeLists.txt index fd4d423c..90f24cf5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -16,7 +16,6 @@ project(ndarray) # only executed if NDARRAY_TEST is enabled. option(NDARRAY_TEST "Enable tests?" ON) option(NDARRAY_EIGEN "Enable Eigen tests?" ON) -option(NDARRAY_EIGENVIEW "Enable ndarray::EigenView (requires Eigen < 3.3)?" OFF) option(NDARRAY_STDPYBIND11EIGEN "Enable standard pybind11 Eigen wrappers (requires Eigen > 3.2.5)?" OFF) option(NDARRAY_FFTW "Enable FFTW tests?" ON) option(NDARRAY_PYBIND11 "Enable Pybind11 tests?" OFF) @@ -42,10 +41,6 @@ if(DOXYGEN_FOUND) ) endif(DOXYGEN_FOUND) -if(NDARRAY_EIGENVIEW AND NDARRAY_STDPYBIND11EIGEN) - message(FATAL_ERROR "NDARRAY_EIGENVIEW and NDARRAY_STDPYBIND11EIGEN cannot both be enabled") -endif() - if(NDARRAY_TEST) enable_testing() add_subdirectory(tests) diff --git a/README.md b/README.md index 3db18535..5e7fe9bf 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,6 @@ EIGEN_DIR, and FFTW_DIR environment variables. For example, to build with an alternate Eigen3 install location and disable FFTW testing replace `cmake ..` with `EIGEN_DIR=/opt/local cmake -DNDARRY_FFTW=OFF ..`. -ndarray::EigenView is not compatible with Eigen >= 3.3, -nor is it compatible with pybind11's default Eigen wrappers. -To build without ndarray::EigenView use cmake option `-DNDARRAY_EIGENVIEW=OFF` - ndarray's build system does not produce the correct suffixes for pybind11 outputs under pybind11 2.1.x (due to a bug in pybind11 itself). To avoid this problem, please upgrade to pybind11 2.2.x, or try the (now reverted) patch from diff --git a/include/CMakeLists.txt b/include/CMakeLists.txt index c86cc992..1cca0f9f 100644 --- a/include/CMakeLists.txt +++ b/include/CMakeLists.txt @@ -23,7 +23,7 @@ endforeach(FILENAME) foreach(FILENAME ${PREPROCESS_FILES1}) add_custom_command ( OUTPUT ${FILENAME} - DEPENDS ${FILENAME}.m4 "ndarray/buildOptions.h.in" + DEPENDS ${FILENAME}.m4 COMMAND m4 ${FILENAME}.m4 > ${FILENAME} ) endforeach(FILENAME) diff --git a/include/ndarray/ArrayBase.h b/include/ndarray/ArrayBase.h index ede9b80b..79325028 100644 --- a/include/ndarray/ArrayBase.h +++ b/include/ndarray/ArrayBase.h @@ -28,13 +28,6 @@ #include "ndarray/detail/ArrayAccess.h" #include "ndarray/detail/ViewBuilder.h" #include "ndarray/ArrayTraits.h" -#include "ndarray/buildOptions.h" - -#ifdef NDARRAY_EIGENVIEW - -#include "ndarray/eigen_fwd.h" - -#endif // NDARRAY_EIGENVIEW namespace ndarray { @@ -196,32 +189,6 @@ class ArrayBase : public ExpressionBase { /// @brief Return an ArrayRef view to this. Deep const deep() const { return Deep(this->getSelf()); } - -#ifdef NDARRAY_EIGENVIEW - - //@{ - /** - * @name Eigen3 Interface - * - * These methods return Eigen3 views to the array. Template - * parameters optionally control the expression type (Matrix/Array) and - * the compile-time dimensions. - * - * The inline implementation is included by ndarray/eigen.h. - */ - template - EigenView asEigen() const; - - template - EigenView asEigen() const; - - template - EigenView asEigen() const; - - EigenView asEigen() const; - //@} - -#endif // NDARRAY_EIGENVIEW /// @brief A template metafunction class to determine the result of a view indexing operation. template diff --git a/include/ndarray/EigenView.h b/include/ndarray/EigenView.h deleted file mode 100644 index 55453863..00000000 --- a/include/ndarray/EigenView.h +++ /dev/null @@ -1,437 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#ifndef NDARRAY_EigenView_h_INCLUDED -#define NDARRAY_EigenView_h_INCLUDED - -/** - * @file ndarray/EigenView.h - * @brief ndarray::EigenView presents a reference-counted Eigen view into an ndarray::Array. - * - * \note This file is not included by the main "ndarray.h" header file. - */ - -#if defined __GNUC__ && __GNUC__>=6 - #pragma GCC diagnostic ignored "-Wignored-attributes" - #pragma GCC diagnostic ignored "-Wdeprecated-declarations" -#endif - -#include "Eigen/Core" -#include "ndarray.h" -#include "ndarray/eigen_fwd.h" -#include "ndarray/buildOptions.h" - -#ifdef NDARRAY_EIGENVIEW - -namespace ndarray { -namespace detail { - -template -struct EigenStrideTraits<1,0,Rows,1> { - enum { - InnerStride = Eigen::Dynamic, - OuterStride = Eigen::Dynamic, - IsVector = 1, - Flags = Eigen::LinearAccessBit, - Options = Eigen::ColMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return core.getStride(); } - static int getOuterStride(Core<1> const & core) { return core.getSize() * core.getStride(); } - static int getRowStride(Core<1> const & core) { return core.getStride(); } - static int getColStride(Core<1> const & core) { return core.getSize() * core.getStride(); } - static int getRows(Core<1> const & core) { return core.getSize(); } - static int getCols(Core<1> const & core) { return 1; } -}; - -template -struct EigenStrideTraits<1,0,1,Cols> { - enum { - InnerStride = Eigen::Dynamic, - OuterStride = Eigen::Dynamic, - IsVector = 1, - Flags = Eigen::LinearAccessBit | Eigen::RowMajorBit, - Options = Eigen::RowMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return core.getStride(); } - static int getOuterStride(Core<1> const & core) { return core.getSize() * core.getStride(); } - static int getRowStride(Core<1> const & core) { return core.getSize() * core.getStride(); } - static int getColStride(Core<1> const & core) { return core.getStride(); } - static int getRows(Core<1> const & core) { return 1; } - static int getCols(Core<1> const & core) { return core.getSize(); } -}; - -template -struct EigenStrideTraits<1,C,1,1> { - enum { - InnerStride = Eigen::Dynamic, - OuterStride = Eigen::Dynamic, - IsVector = 1, - Flags = Eigen::LinearAccessBit, - Options = Eigen::ColMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return core.getStride(); } - static int getOuterStride(Core<1> const & core) { return core.getStride(); } - static int getRowStride(Core<1> const & core) { return core.getStride(); } - static int getColStride(Core<1> const & core) { return core.getStride(); } - static int getRows(Core<1> const & core) { return 1; } - static int getCols(Core<1> const & core) { return 1; } -}; - -template -struct EigenStrideTraits<1,C,Rows,1> { - enum { - InnerStride = 1, - OuterStride = Eigen::Dynamic, - IsVector = 1, - Flags = Eigen::LinearAccessBit | Eigen::PacketAccessBit, - Options = Eigen::ColMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return 1; } - static int getOuterStride(Core<1> const & core) { return core.getSize(); } - static int getRowStride(Core<1> const & core) { return 1; } - static int getColStride(Core<1> const & core) { return core.getSize(); } - static int getRows(Core<1> const & core) { return core.getSize(); } - static int getCols(Core<1> const & core) { return 1;} -}; - -template -struct EigenStrideTraits<1,C,1,Cols> { - enum { - InnerStride = 1, - OuterStride = Eigen::Dynamic, - IsVector = 1, - Flags = Eigen::LinearAccessBit | Eigen::RowMajorBit | Eigen::PacketAccessBit, - Options = Eigen::RowMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return 1; } - static int getOuterStride(Core<1> const & core) { return core.getSize(); } - static int getRowStride(Core<1> const & core) { return core.getSize(); } - static int getColStride(Core<1> const & core) { return 1; } - static int getRows(Core<1> const & core) { return 1; } - static int getCols(Core<1> const & core) { return core.getSize(); } -}; - -template -struct EigenStrideTraits<2,0,Rows,Cols> { - enum { - InnerStride = Eigen::Dynamic, - OuterStride = Eigen::Dynamic, - IsVector = 0, - Flags = 0, - Options = Eigen::ColMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<2> const & core) { return core.getStride(); } - static int getOuterStride(Core<1> const & core) { return core.getStride(); } - static int getRowStride(Core<2> const & core) { return core.getStride(); } - static int getColStride(Core<1> const & core) { return core.getStride(); } - static int getRows(Core<2> const & core) { return core.getSize(); } - static int getCols(Core<1> const & core) { return core.getSize(); } -}; - -template -struct EigenStrideTraits<2,1,Rows,Cols> { - enum { - InnerStride = 1, - OuterStride = Eigen::Dynamic, - IsVector = 0, - Flags = Eigen::RowMajorBit | Eigen::PacketAccessBit, - Options = Eigen::RowMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<1> const & core) { return 1; } - static int getOuterStride(Core<2> const & core) { return core.getStride(); } - static int getRowStride(Core<2> const & core) { return core.getStride(); } - static int getColStride(Core<1> const & core) { return 1; } - static int getRows(Core<2> const & core) { return core.getSize(); } - static int getCols(Core<1> const & core) { return core.getSize(); } -}; - -template -struct EigenStrideTraits<2,2,Rows,Cols> : public EigenStrideTraits<2,1,Rows,Cols> {}; - -template -struct EigenStrideTraits<2,-1,Rows,Cols> { - enum { - InnerStride = 1, - OuterStride = Eigen::Dynamic, - IsVector = 0, - Flags = Eigen::PacketAccessBit, - Options = Eigen::ColMajor | Eigen::AutoAlign - }; - static int getInnerStride(Core<2> const & core) { return 1; } - static int getOuterStride(Core<1> const & core) { return core.getStride(); } - static int getRowStride(Core<2> const & core) { return 1; } - static int getColStride(Core<1> const & core) { return core.getStride(); } - static int getRows(Core<2> const & core) { return core.getSize(); } - static int getCols(Core<1> const & core) { return core.getSize(); } -}; - -template -struct EigenStrideTraits<2,-2,Rows,Cols> : public EigenStrideTraits<2,-1,Rows,Cols> {}; - -} // namespace detail -} // namespace ndarray - - -namespace Eigen { -namespace internal { - -template -struct traits< ndarray::EigenView > { - typedef DenseIndex Index; - typedef Dense StorageKind; - typedef XprKind_ XprKind; - typedef typename boost::remove_const::type Scalar; - enum { - RowsAtCompileTime = Rows, - ColsAtCompileTime = Cols, - MaxRowsAtCompileTime = Rows, - MaxColsAtCompileTime = Cols, - InnerStrideAtCompileTime = ndarray::detail::EigenStrideTraits::InnerStride, - OuterStrideAtCompileTime = ndarray::detail::EigenStrideTraits::OuterStride, - IsVectorAtCompileTime = ndarray::detail::EigenStrideTraits::IsVector, - Flags = ndarray::detail::EigenStrideTraits::Flags - | Eigen::NestByRefBit | Eigen::DirectAccessBit - | (boost::is_const::value ? 0 : Eigen::LvalueBit), - CoeffReadCost = NumTraits::ReadCost - }; -}; - -} // namespace internal -} // namespace Eigen - -namespace ndarray { - -/** - * @brief Eigen3 view into an ndarray::Array. - * - * EigenView provides an Eigen DenseBase-derived object based on an ndarray::Array internally. - * Any one or two dimensional Array can be viewed as an Eigen object. - * - * Assignment to an EigenView is deep, and uses the Eigen assignment operators, but construction - * from an ndarray::Array or ArrayRef is shallow with reference counting. Block and transpose - * operations use the standard Eigen Block and Transpose classes, and do not do reference counting - * (in fact, they hold a plain C++ reference to the EigenView, so they should be considered extremely - * temporary). - * - * @todo Add reference-counted share and transpose operations that return EigenViews. - * - * @ingroup EigenGroup - */ -template -class EigenView - : public Eigen::internal::dense_xpr_base< EigenView >::type -{ - typedef detail::EigenStrideTraits ST; - typedef detail::ArrayAccess< Array > Access; - - void checkDimensions() { - NDARRAY_ASSERT( Rows_ == Eigen::Dynamic || Rows_ == rows() ); - NDARRAY_ASSERT( Cols_ == Eigen::Dynamic || Cols_ == cols() ); - } - -public: - - typedef typename Eigen::internal::dense_xpr_base< EigenView >::type Base; - - EIGEN_DENSE_PUBLIC_INTERFACE(EigenView) - - enum { Options = ST::Options }; - - typedef typename boost::mpl::if_< - boost::is_same, - Eigen::Matrix, - Eigen::Array - >::type PlainEigenType; - - typedef T * PointerType; - - EigenView() : _array() {} - - EigenView(EigenView const & other) : _array(other._array) {} - - explicit EigenView(Array const & array) : _array(array) { checkDimensions(); } - - EigenView & operator=(EigenView const & other) { - // Weird behavior to please SWIG: if we're default-constructed, and it's an exact match, - // do shallow assignment; otherwise all assignment is deep. - if (_array.getData() == 0) { - _array = other._array; - } else { - Base::operator=(other); - } - return *this; - } - - template - EigenView & operator=(Eigen::DenseBase const & other) { - return Base::operator=(other); - } - - template - EigenView & operator=(Eigen::EigenBase const & other) { - return Base::operator=(other); - } - - template - EigenView & operator=(Eigen::ReturnByValue const & other) { - return Base::operator=(other); - } - - inline Index innerStride() const { return ST::getInnerStride(*Access::getCore(_array)); } - inline Index outerStride() const { return ST::getOuterStride(*Access::getCore(_array)); } - - inline Index rowStride() const { return ST::getRowStride(*Access::getCore(_array)); } - inline Index colStride() const { return ST::getColStride(*Access::getCore(_array)); } - - inline Index rows() const { return ST::getRows(*Access::getCore(_array)); } - inline Index cols() const { return ST::getCols(*Access::getCore(_array)); } - - inline T* data() const { return _array.getData(); } - - inline T* data() { return _array.getData(); } - - inline T& coeff(Index row, Index col) const { - return _array.getData()[row * rowStride() + col * colStride()]; - } - - inline T& coeff(Index index) const { - return _array.getData()[index * innerStride()]; - } - - inline T& coeffRef(Index row, Index col) const { - return _array.getData()[row * rowStride() + col * colStride()]; - } - - inline T& coeffRef(Index row, Index col) { - return _array.getData()[row * rowStride() + col * colStride()]; - } - - inline T& coeffRef(Index index) const { - return _array.getData()[index * innerStride()]; - } - - inline T& coeffRef(Index index) { - return _array.getData()[index * innerStride()]; - } - - template - inline PacketScalar packet(Index row, Index col) const { - return Eigen::internal::ploadt( - _array.getData() + (col * colStride() + row * rowStride()) - ); - } - - template - inline PacketScalar packet(Index index) const { - BOOST_STATIC_ASSERT( N == 1 ); - return Eigen::internal::ploadt( - _array.getData() + index * innerStride() - ); - } - - template - inline void writePacket(Index row, Index col, const PacketScalar& x) { - BOOST_STATIC_ASSERT( !boost::is_const::value ); - Eigen::internal::pstoret( - _array.getData() + (col * colStride() + row * rowStride()), x - ); - } - - template - inline void writePacket(Index index, const PacketScalar& x) { - BOOST_STATIC_ASSERT( !boost::is_const::value ); - BOOST_STATIC_ASSERT( N == 1 ); - Eigen::internal::pstoret( - _array.getData() + index * innerStride(), x - ); - } - - Array const & shallow() const { return _array; } - ArrayRef deep() const { return _array.deep(); } - - void reset(Array const & array = Array()) { _array = array; checkDimensions(); } - void reset(ArrayRef const & array) { reset(array.shallow()); } - - void swap(EigenView & other) { _array.swap(other._array); } - - using Base::swap; - -private: - Array _array; -}; - -/// @brief A metafunction that computes the EigenView instantiation that most closely matches an Eigen type. -template -struct SelectEigenView { - typedef Eigen::internal::traits Traits; - typedef typename Traits::Scalar Scalar; - typedef typename boost::mpl::if_< boost::is_const, Scalar const, Scalar >::type Element; - typedef typename Traits::XprKind XprKind; - enum { - N = 2, - C = ((contiguous) ? ((Traits::Flags & Eigen::RowMajorBit) ? 2 : -2) : 0), - Rows = Traits::RowsAtCompileTime, - Cols = Traits::ColsAtCompileTime - }; - typedef Array Shallow; - typedef ArrayRef Deep; - typedef EigenView Type; -}; - -/// @brief Copy an arbitrary Eigen expression into a new EigenView. -template -inline typename SelectEigenView::Type copy(Eigen::EigenBase const & other) { - typename SelectEigenView::Type result( - typename SelectEigenView::Shallow(allocate(other.rows(), other.cols())) - ); - result = other.derived(); - return result; -} - -template -template -inline EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, XprKind, Rows, Cols - > -ArrayBase::asEigen() const { - return EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, XprKind, Rows, Cols>(this->getSelf()); -} - -template -template -inline EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, XprKind> -ArrayBase::asEigen() const { - return EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, XprKind>(this->getSelf()); -} - -template -template -inline EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, Eigen::MatrixXpr, Rows, Cols> -ArrayBase::asEigen() const { - return EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, Eigen::MatrixXpr, Rows, Cols>(this->getSelf()); -} - -template -inline EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value, Eigen::MatrixXpr> -ArrayBase::asEigen() const { - return EigenView::Element, ArrayBase::ND::value, - ArrayBase::RMC::value>(this->getSelf()); -} - -} // namespace ndarray - -#endif // NDARRAY_EIGENVIEW -#endif // !NDARRAY_EigenView_h_INCLUDED diff --git a/include/ndarray/buildOptions.h.in b/include/ndarray/buildOptions.h.in index 38ccd2be..88feb6e9 100644 --- a/include/ndarray/buildOptions.h.in +++ b/include/ndarray/buildOptions.h.in @@ -1,5 +1,4 @@ // Build options that need to be remembered // so they can be used when other packages build against ndarray -#cmakedefine NDARRAY_EIGENVIEW #cmakedefine NDARRAY_STDPYBIND11EIGEN diff --git a/include/ndarray/eigen.h b/include/ndarray/eigen.h index afd6ec30..26ee65a2 100644 --- a/include/ndarray/eigen.h +++ b/include/ndarray/eigen.h @@ -26,7 +26,6 @@ #include "Eigen/Core" #include "ndarray.h" #include "ndarray/eigen_fwd.h" -#include "ndarray/EigenView.h" namespace ndarray { namespace detail { diff --git a/include/ndarray/eigen_fwd.h b/include/ndarray/eigen_fwd.h index 76831b93..46f49f23 100644 --- a/include/ndarray/eigen_fwd.h +++ b/include/ndarray/eigen_fwd.h @@ -18,7 +18,7 @@ * @brief Forward declarations for ndarray/eigen interface. */ -/** +/** * \defgroup ndarrayEigenGroup Eigen * Interoperability with the Eigen 3 linear algebra library. */ @@ -35,19 +35,6 @@ namespace detail { template struct EigenStrideTraits; } // namespace detail - -#ifdef NDARRAY_EIGENVIEW - -template < - typename T, int N, int C, - typename XprKind_=Eigen::MatrixXpr, - int Rows_=-1, - int Cols_=((N == 1) ? 1 : -1) - > -class EigenView; - -#endif // NDARRAY_EIGENVIEW - } // namespace ndarray #endif // !NDARRAY_eigen_fwd_h_INCLUDED diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index 3101eec5..f4c4d73f 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -248,193 +248,6 @@ class type_caster< ndarray::Array > { Helper _helper; }; -#ifdef NDARRAY_EIGENVIEW - -/* @brief A pybind11 type_caster for ndarray::EigenView - */ -template -class type_caster< ndarray::EigenView > { - using Helper = ndarray::Pybind11Helper; -public: - - bool load(handle src, bool) { - if (!_helper.init(src)) { - return false; - } - if (_helper.isNone) { - return true; - } - if ((Rows == 1 || Cols == 1) && N == 2) { - int shape[2] = { -1, -1 }; - if (Rows == 1) { - shape[0] = 1; - } else { - shape[1] = 1; - } - try { - _helper.wrapper = _helper.wrapper.attr("reshape")(shape[0], shape[1]); - } catch (error_already_set &) { - return false; - } - } else if (N == 1) { - _helper.wrapper = _helper.wrapper.squeeze(); - } - if (!_helper.check()) { - return false; - } - // check whether the shape is correct if it's static - if (N == 2) { - if (Rows != Eigen::Dynamic && _helper.wrapper.shape(0) != static_cast(Rows)) { - return false; - } - if (Cols != Eigen::Dynamic && _helper.wrapper.shape(1) != static_cast(Cols)) { - return false; - } - } else { - auto requiredSize = Rows * Cols; - if (requiredSize != Eigen::Dynamic && _helper.wrapper.size() != static_cast(requiredSize)) { - return false; - } - } - return true; - } - - void set_value() { - _value.reset(_helper.convert()); - } - - bool isNone() const { return _helper.isNone; } - - static handle cast(const ndarray::EigenView &src, return_value_policy /* policy */, handle /* parent */) { - using Wrapper = typename Helper::Wrapper; - Wrapper wrapper = reinterpret_steal(Helper::toPython(src.shallow())); - return wrapper.squeeze().release(); - } - - static PYBIND11_DESCR name() { return type_descr(_>()); } - - static handle cast(const ndarray::EigenView *src, return_value_policy policy, handle parent) { - return cast(*src, policy, parent); - } - - operator ndarray::EigenView * () { - if (isNone()) { - return nullptr; - } else { - set_value(); - return &_value; - } - } - - operator ndarray::EigenView & () { - set_value(); - return _value; - } - - template using cast_op_type = pybind11::detail::cast_op_type<_T>; - -private: - ndarray::EigenView _value; - Helper _helper; -}; - - -template -class type_caster< Eigen::Array > { - using OutputView = typename ndarray::SelectEigenView< Eigen::Array >::Type; - using InputView = typename ndarray::SelectEigenView< Eigen::Array const, false>::Type; -public: - - bool load(handle src, bool convert) { - return _nested.load(src, convert); - } - - void set_value() { - InputView & v = _nested; - _value = v; - } - - static handle cast(const Eigen::Array &src, return_value_policy policy, handle parent) { - OutputView v = ndarray::copy(src); - return type_caster< OutputView >::cast(v, policy, parent); - } - - static PYBIND11_DESCR name() { return type_descr(_>()); } - - static handle cast(const Eigen::Array *src, return_value_policy policy, handle parent) { - return cast(*src, policy, parent); - } - - operator Eigen::Array * () { - if (_nested.isNone()) { - return nullptr; - } else { - set_value(); - return &_value; - } - } - - operator Eigen::Array & () { - set_value(); - return _value; - } - - template using cast_op_type = pybind11::detail::cast_op_type<_T>; - -private: - Eigen::Array _value; - type_caster< InputView > _nested; -}; - - -template -class type_caster< Eigen::Matrix > { - using OutputView = typename ndarray::SelectEigenView< Eigen::Matrix >::Type; - using InputView = typename ndarray::SelectEigenView< Eigen::Matrix const, false>::Type; -public: - - bool load(handle src, bool convert) { - return _nested.load(src, convert); - } - - void set_value() { - InputView & v = _nested; - _value = v; - } - - static handle cast(const Eigen::Matrix &src, return_value_policy policy, handle parent) { - OutputView v = ndarray::copy(src); - return type_caster< OutputView >::cast(v, policy, parent); - } - - static PYBIND11_DESCR name() { return type_descr(_>()); } - - static handle cast(const Eigen::Matrix *src, return_value_policy policy, handle parent) { - return cast(*src, policy, parent); - } - - operator Eigen::Matrix * () { - if (_nested.isNone()) { - return nullptr; - } else { - set_value(); - return &_value; - } - } - - operator Eigen::Matrix & () { - set_value(); return _value; - } - - template using cast_op_type = pybind11::detail::cast_op_type<_T>; - -private: - Eigen::Matrix _value; - type_caster< InputView > _nested; -}; - -#endif // NDARRAY_EIGENVIEW - NAMESPACE_END(detail) NAMESPACE_END(pybind11) diff --git a/tests/ndarray-eigen.cc b/tests/ndarray-eigen.cc index 475c7a63..7fe5db57 100644 --- a/tests/ndarray-eigen.cc +++ b/tests/ndarray-eigen.cc @@ -133,140 +133,6 @@ BOOST_AUTO_TEST_CASE(AsEigen) { invokeAsEigenTests(); } -#ifdef NDARRAY_EIGENVIEW - -template -void testEigenView(ndarray::EigenView b) { - ndarray::Array a(b.shallow()); - b.setRandom(); - testElements2(a, b); - Eigen::Matrix m1(b.rows(), 6); - m1.setRandom(b.rows(), 6); - Eigen::Matrix m2(6, b.cols()); - m2.setRandom(6, b.cols()); - b.matrix() = m1 * m2; - Eigen::Matrix m3 = m1 * m2; - for (int i = 0; i < b.rows(); ++i) { - for (int j = 0; j < b.cols(); ++j) { - BOOST_CHECK(a[i][j] == m3(i,j)); - } - } - Eigen::Array m4(b.rows(), b.cols()); - m4.setRandom(); - Eigen::Array m5 = m4 * b; - Eigen::Array m6 = m4 * m3.array(); - BOOST_CHECK( (m5 == m6).all() ); -} - -template -void testEigenView(ndarray::EigenView b) { - ndarray::Array a(b.shallow()); - b.setRandom(); - testElements1(a, b); - Eigen::Matrix m1(b.rows(), 6); - m1.setRandom(b.rows(), 6); - Eigen::Matrix m2(6, b.cols()); - m2.setRandom(6, b.cols()); - b.matrix() = m1 * m2; - Eigen::Matrix m3 = m1 * m2; - for (int i = 0; i < b.rows(); ++i) { - BOOST_CHECK(a[i] == m3[i]); - } - Eigen::Array m4(b.rows(), b.cols()); - m4.setRandom(); - Eigen::Array m5 = m4 * b; - Eigen::Array m6 = m4 * m3.array(); - BOOST_CHECK( (m5 == m6).all() ); -} - -template -void testEigenView(ndarray::EigenView b) { - ndarray::Array a(b.shallow()); - b.setRandom(); - testElements2(a, b); - Eigen::Matrix m1(b.rows(), 6); - m1.setRandom(b.rows(), 6); - Eigen::Matrix m2(6, b.cols()); - m2.setRandom(6, b.cols()); - b = m1 * m2; - Eigen::Matrix m3 = m1 * m2; - for (int i = 0; i < b.rows(); ++i) { - for (int j = 0; j < b.cols(); ++j) { - BOOST_CHECK(a[i][j] == m3(i,j)); - } - } - Eigen::Array m4(b.rows(), b.cols()); - m4.setRandom(); - Eigen::Array m5 = m4 * b.array(); - Eigen::Array m6 = m4 * m3.array(); - BOOST_CHECK( (m5 == m6).all() ); -} - -template -void testEigenView(ndarray::EigenView b) { - ndarray::Array a(b.shallow()); - b.setRandom(); - testElements1(a, b); - Eigen::Matrix m1(b.rows(), 6); - m1.setRandom(b.rows(), 6); - Eigen::Matrix m2(6, b.cols()); - m2.setRandom(6, b.cols()); - b = m1 * m2; - Eigen::Matrix m3 = m1 * m2; - for (int i = 0; i < b.rows(); ++i) { - BOOST_CHECK(a[i] == m3[i]); - } - Eigen::Array m4(b.rows(), b.cols()); - m4.setRandom(); - Eigen::Array m5 = m4 * b.array(); - Eigen::Array m6 = m4 * m3.array(); - BOOST_CHECK( (m5 == m6).all() ); -} - -template -void invokeEigenViewTests() { - ndarray::Array a22(ndarray::allocate(5,4)); - testEigenView(a22.asEigen()); - testEigenView(a22.asEigen()); - testEigenView(a22.transpose().asEigen()); - testEigenView(a22.transpose().asEigen()); - ndarray::Array a21(a22[ndarray::view()(0,3)]); - testEigenView(a21.asEigen()); - testEigenView(a21.asEigen()); - testEigenView(a21.transpose().asEigen()); - testEigenView(a21.transpose().asEigen()); - ndarray::Array a20(a22[ndarray::view()(0,4,2)]); - testEigenView(a20.asEigen()); - testEigenView(a20.asEigen()); - testEigenView(a20.transpose().asEigen()); - testEigenView(a20.transpose().asEigen()); - ndarray::Array a11(ndarray::allocate(4)); - testEigenView(a11.asEigen()); - testEigenView(a11.asEigen()); - testEigenView(a11.asEigen()); - testEigenView(a11.transpose().asEigen()); - testEigenView(a11.transpose().asEigen()); - testEigenView(a11.transpose().asEigen()); - ndarray::Array a10(a11[ndarray::view(0,4,2)]); - testEigenView(a10.asEigen()); - testEigenView(a10.asEigen()); - testEigenView(a10.asEigen()); - testEigenView(a10.transpose().asEigen()); - testEigenView(a10.transpose().asEigen()); - testEigenView(a10.transpose().asEigen()); -} - -BOOST_AUTO_TEST_CASE(EigenView) { - invokeEigenViewTests(); - invokeEigenViewTests(); - - Eigen::MatrixXd m(Eigen::MatrixXd::Random(5,6)); - ndarray::SelectEigenView::Type v(ndarray::copy(m)); - BOOST_CHECK( (v.array() == m.array()).all() ); -} - -#endif // NDARRAY_EIGENVIEW - template void testSVD(Matrix const & a, Vector const & b, Vector & x) { SVD svd(a, Eigen::ComputeThinU | Eigen::ComputeThinV); diff --git a/tests/pybind11_test.py b/tests/pybind11_test.py old mode 100755 new mode 100644 index b3f1e263..1c913ed6 --- a/tests/pybind11_test.py +++ b/tests/pybind11_test.py @@ -13,25 +13,9 @@ import pybind11_test_mod -HasEigenView = hasattr(pybind11_test_mod, "returnMatrixXd") - class TestNumpyPybind11(unittest.TestCase): - @unittest.skipIf(not HasEigenView, "No EigenView") - def testMatrixXd(self): - m1 = pybind11_test_mod.returnMatrixXd() - m2 = numpy.matrix(numpy.arange(15, dtype=float).reshape(3, 5).transpose()) - self.assertTrue((m1 == m2).all()) - self.assertTrue(pybind11_test_mod.acceptMatrixXd(m2)) - - @unittest.skipIf(not HasEigenView, "No EigenView") - def testMatrix2d(self): - m1 = pybind11_test_mod.returnMatrix2d() - m2 = numpy.matrix([[0.0, 2.0], [1.0, 3.0]]) - self.assertTrue((m1 == m2).all()) - self.assertTrue(pybind11_test_mod.acceptMatrix2d(m2)) - def testArray1(self): a1 = pybind11_test_mod.returnArray1() a2 = numpy.arange(6, dtype=float) @@ -50,22 +34,6 @@ def testArray3(self): self.assertTrue((a1 == a3).all()) self.assertFalse(a3.flags["WRITEABLE"]) - @unittest.skipIf(not HasEigenView, "No EigenView") - def testClass(self): - a = pybind11_test_mod.MatrixOwner() - m1 = a.member - m2 = a.getMember() - self.assertTrue((m1 == 0).all()) - self.assertTrue((m2 == 0).all()) - self.assertEqual(m1.shape, (2, 2)) - self.assertEqual(m2.shape, (2, 2)) - - @unittest.skipIf(not HasEigenView, "No EigenView") - def testOverloads(self): - self.assertEqual(pybind11_test_mod.acceptOverload(1), 0) - self.assertEqual(pybind11_test_mod.acceptOverload(numpy.zeros((2, 2), dtype=float)), 2) - self.assertEqual(pybind11_test_mod.acceptOverload(numpy.zeros((3, 3), dtype=float)), 3) - def testStrideHandling(self): # in NumPy 1.8+ 1- and 0-sized arrays can have arbitrary strides; we should # be able to handle those @@ -87,24 +55,6 @@ def testNone(self): self.assertEqual(pybind11_test_mod.acceptNoneArray(None), 1) self.assertEqual(pybind11_test_mod.acceptNoneArray(), 1) - if HasEigenView: - m1 = pybind11_test_mod.returnMatrixXd() - self.assertEqual(pybind11_test_mod.acceptNoneMatrixXd(m1), 2) - self.assertEqual(pybind11_test_mod.acceptNoneMatrixXd(None), 3) - self.assertEqual(pybind11_test_mod.acceptNoneMatrixXd(), 3) - - m2 = pybind11_test_mod.returnMatrix2d() - self.assertEqual(pybind11_test_mod.acceptNoneMatrix2d(m2), 4) - self.assertEqual(pybind11_test_mod.acceptNoneMatrix2d(None), 5) - self.assertEqual(pybind11_test_mod.acceptNoneMatrix2d(), 5) - - @unittest.skipIf(not HasEigenView, "No EigenView") - def testFullySpecifiedMatrix(self): - # Failure on this specific case was not caught by other unit tests - a = numpy.array([[1., 0.], [0., 1.]]) - b = numpy.array([0., 0.]) - self.assertTrue(pybind11_test_mod.acceptFullySpecifiedMatrix(a, b)) - def testNonNativeByteOrder(self): d1 = numpy.dtype("f8") diff --git a/tests/pybind11_test_mod.cc b/tests/pybind11_test_mod.cc index 9489f24e..ddd7c1ab 100644 --- a/tests/pybind11_test_mod.cc +++ b/tests/pybind11_test_mod.cc @@ -6,24 +6,6 @@ namespace py = pybind11; using namespace py::literals; -#ifdef NDARRAY_EIGENVIEW -Eigen::MatrixXd returnMatrixXd() { - Eigen::MatrixXd r(5, 3); - for (int n = 0; n < r.size(); ++n) { - r.data()[n] = n; - } - return r; -} - -Eigen::Matrix2d returnMatrix2d() { - Eigen::Matrix2d r; - for (int n = 0; n < r.size(); ++n) { - r.data()[n] = n; - } - return r; -} -#endif // NDARRAY_EIGENVIEW - ndarray::Array returnArray1() { ndarray::Array r(ndarray::allocate(ndarray::makeVector(6))); for (int n = 0; n < r.getSize<0>(); ++n) { @@ -49,18 +31,6 @@ ndarray::Array returnConstArray3() { return returnArray3(); } -#ifdef NDARRAY_EIGENVIEW -bool acceptMatrixXd(Eigen::MatrixXd const & m1) { - Eigen::MatrixXd m2 = returnMatrixXd(); - return m1 == m2; -} - -bool acceptMatrix2d(Eigen::Matrix2d const & m1) { - Eigen::Matrix2d m2 = returnMatrix2d(); - return m1 == m2; -} -#endif // NDARRAY_EIGENVIEW - bool acceptArray1(ndarray::Array const & a1) { ndarray::Array a2 = returnArray1(); #ifndef GCC_45 @@ -86,20 +56,6 @@ bool acceptArray3(ndarray::Array const & a1) { #endif } -#ifdef NDARRAY_EIGENVIEW -int acceptOverload(int n) { - return 0; -} - -int acceptOverload(Eigen::Matrix3d const & m) { - return 3; -} - -int acceptOverload(Eigen::Matrix2d const & m) { - return 2; -} -#endif // NDARRAY_EIGENVIEW - int acceptNoneArray(ndarray::Array const * array = nullptr) { if (array) { return 0; @@ -108,71 +64,17 @@ int acceptNoneArray(ndarray::Array const * array = nullptr) { } } -#ifdef NDARRAY_EIGENVIEW -int acceptNoneMatrixXd(Eigen::MatrixXd const * matrix = nullptr) { - if (matrix) { - return 2; - } else { - return 3; - } -} - -int acceptNoneMatrix2d(Eigen::Matrix2d const * matrix = nullptr) { - if (matrix) { - return 4; - } else { - return 5; - } -} - -struct MatrixOwner { - typedef Eigen::Matrix MemberMatrix; - MemberMatrix member; - MemberMatrix & getMember() { return member; } - explicit MatrixOwner() : member(MemberMatrix::Zero()) {} -}; - -bool acceptFullySpecifiedMatrix(Eigen::Matrix const & a, Eigen::Matrix const & b) { - return true; -}; -#endif // NDARRAY_EIGENVIEW - PYBIND11_PLUGIN(pybind11_test_mod) { pybind11::module mod("pybind11_test_mod", "Tests for the ndarray library"); -#ifdef NDARRAY_EIGENVIEW - py::class_ cls(mod, "MatrixOwner"); - cls.def(py::init<>()); - - py::class_(cls, "MemberMatrix"); - - cls.def_readwrite("member", &MatrixOwner::member); - cls.def("getMember", &MatrixOwner::getMember); - mod.def("returnMatrixXd", returnMatrixXd); - mod.def("returnMatrix2d", returnMatrix2d); -#endif // NDARRAY_EIGENVIEW mod.def("returnArray1", returnArray1); mod.def("returnConstArray1", returnConstArray1); mod.def("returnArray3", returnArray3); mod.def("returnConstArray3", returnConstArray3); -#ifdef NDARRAY_EIGENVIEW - mod.def("acceptMatrixXd", acceptMatrixXd); - mod.def("acceptMatrix2d", acceptMatrix2d); -#endif // NDARRAY_EIGENVIEW mod.def("acceptArray1", acceptArray1); mod.def("acceptArray10", acceptArray10); mod.def("acceptArray3", acceptArray3); -#ifdef NDARRAY_EIGENVIEW - mod.def("acceptOverload", (int (*)(int)) acceptOverload); - mod.def("acceptOverload", (int (*)(Eigen::Matrix2d const &)) acceptOverload); - mod.def("acceptOverload", (int (*)(Eigen::Matrix3d const &)) acceptOverload); -#endif // NDARRAY_EIGENVIEW mod.def("acceptNoneArray", acceptNoneArray, "array"_a = nullptr); -#ifdef NDARRAY_EIGENVIEW - mod.def("acceptNoneMatrixXd", acceptNoneMatrixXd, "matrix"_a = nullptr); - mod.def("acceptNoneMatrix2d", acceptNoneMatrix2d, "matrix"_a = nullptr); - mod.def("acceptFullySpecifiedMatrix", acceptFullySpecifiedMatrix); -#endif // NDARRAY_EIGENVIEW return mod.ptr(); } \ No newline at end of file From 7f981504b5b55dea9637d51c3389afa2626c4afe Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 29 Jul 2019 12:04:17 -0400 Subject: [PATCH 37/69] Remove option to include pybind11/eigen.h. This was for partial backwards compatibility with ndarray's old Eigen interface, and is now being removed. --- .gitignore | 1 - CMakeLists.txt | 1 - include/CMakeLists.txt | 3 --- include/ndarray/buildOptions.h.in | 4 ---- include/ndarray/eigen_fwd.h | 2 -- include/ndarray/pybind11.h | 6 ------ tests/ndarray-eigen.cc | 1 - tests/pybind11_test_mod.cc | 1 - 8 files changed, 19 deletions(-) delete mode 100644 include/ndarray/buildOptions.h.in diff --git a/.gitignore b/.gitignore index 4d221ed2..dcab2795 100644 --- a/.gitignore +++ b/.gitignore @@ -19,7 +19,6 @@ tests/ndarray tests/ndarray-eigen tests/ndarray-fft tests/swig_test_mod.py -include/ndarray/buildOptions.h include/ndarray/Array.h include/ndarray/ArrayBaseN.h include/ndarray/ArrayRef.h diff --git a/CMakeLists.txt b/CMakeLists.txt index 90f24cf5..5809b3a4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -16,7 +16,6 @@ project(ndarray) # only executed if NDARRAY_TEST is enabled. option(NDARRAY_TEST "Enable tests?" ON) option(NDARRAY_EIGEN "Enable Eigen tests?" ON) -option(NDARRAY_STDPYBIND11EIGEN "Enable standard pybind11 Eigen wrappers (requires Eigen > 3.2.5)?" OFF) option(NDARRAY_FFTW "Enable FFTW tests?" ON) option(NDARRAY_PYBIND11 "Enable Pybind11 tests?" OFF) diff --git a/include/CMakeLists.txt b/include/CMakeLists.txt index 1cca0f9f..494b45b0 100644 --- a/include/CMakeLists.txt +++ b/include/CMakeLists.txt @@ -36,9 +36,6 @@ foreach(FILENAME ${PREPROCESS_FILES2}) ) endforeach(FILENAME) -# record certain build options -configure_file(ndarray/buildOptions.h.in "${CMAKE_CURRENT_SOURCE_DIR}/ndarray/buildOptions.h") - add_custom_target(preprocess_includes1 ALL DEPENDS ${PREPROCESS_FILES1}) add_custom_target(preprocess_includes2 ALL DEPENDS ${PREPROCESS_FILES2}) add_dependencies(preprocess_includes2 preprocess_includes1) diff --git a/include/ndarray/buildOptions.h.in b/include/ndarray/buildOptions.h.in deleted file mode 100644 index 88feb6e9..00000000 --- a/include/ndarray/buildOptions.h.in +++ /dev/null @@ -1,4 +0,0 @@ -// Build options that need to be remembered -// so they can be used when other packages build against ndarray - -#cmakedefine NDARRAY_STDPYBIND11EIGEN diff --git a/include/ndarray/eigen_fwd.h b/include/ndarray/eigen_fwd.h index 46f49f23..fdb362fe 100644 --- a/include/ndarray/eigen_fwd.h +++ b/include/ndarray/eigen_fwd.h @@ -11,8 +11,6 @@ #ifndef NDARRAY_eigen_fwd_h_INCLUDED #define NDARRAY_eigen_fwd_h_INCLUDED -#include "ndarray/buildOptions.h" - /** * @file ndarray/eigen_fwd.h * @brief Forward declarations for ndarray/eigen interface. diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index f4c4d73f..09eefac8 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -44,14 +44,8 @@ #include "pybind11.h" #include "pybind11/numpy.h" -#include "ndarray/buildOptions.h" -#ifdef NDARRAY_STDPYBIND11EIGEN -#include "pybind11/eigen.h" -#endif // NDARRAY_STDPYBIND11EIGEN - #include "ndarray.h" #include "ndarray/eigen.h" -#include "ndarray/buildOptions.h" namespace ndarray { diff --git a/tests/ndarray-eigen.cc b/tests/ndarray-eigen.cc index 7fe5db57..7d4785dd 100644 --- a/tests/ndarray-eigen.cc +++ b/tests/ndarray-eigen.cc @@ -9,7 +9,6 @@ * https://github.com/ndarray/ndarray */ #include "ndarray/eigen.h" -#include "ndarray/buildOptions.h" #include "Eigen/SVD" #define BOOST_TEST_DYN_LINK diff --git a/tests/pybind11_test_mod.cc b/tests/pybind11_test_mod.cc index ddd7c1ab..b1d0fb73 100644 --- a/tests/pybind11_test_mod.cc +++ b/tests/pybind11_test_mod.cc @@ -1,7 +1,6 @@ #include "pybind11/pybind11.h" #include "ndarray/pybind11.h" -#include "ndarray/buildOptions.h" namespace py = pybind11; using namespace py::literals; From fbdd6877f3463a499fbdcc208bec9af5a6eb052b Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 29 Jul 2019 12:06:00 -0400 Subject: [PATCH 38/69] Remove old tests for Swig Python bindings. --- .gitignore | 2 - tests/python_test.py | 117 --------------------------------------- tests/python_test_mod.cc | 98 -------------------------------- 3 files changed, 217 deletions(-) delete mode 100755 tests/python_test.py delete mode 100644 tests/python_test_mod.cc diff --git a/.gitignore b/.gitignore index dcab2795..0edbcde6 100644 --- a/.gitignore +++ b/.gitignore @@ -18,12 +18,10 @@ version.py tests/ndarray tests/ndarray-eigen tests/ndarray-fft -tests/swig_test_mod.py include/ndarray/Array.h include/ndarray/ArrayBaseN.h include/ndarray/ArrayRef.h include/ndarray/Vector.h include/ndarray/fft/FFTWTraits.h include/ndarray/operators.h -tests/.*.succeeded build/ diff --git a/tests/python_test.py b/tests/python_test.py deleted file mode 100755 index 2f02b05c..00000000 --- a/tests/python_test.py +++ /dev/null @@ -1,117 +0,0 @@ -# -*- python -*- -# -# Copyright (c) 2010-2012, Jim Bosch -# All rights reserved. -# -# ndarray is distributed under a simple BSD-like license; -# see the LICENSE file that should be present in the root -# of the source distribution, or alternately available at: -# https://github.com/ndarray/ndarray -# -import numpy -import python_test_mod -import unittest - -class TestNDArray(unittest.TestCase): - - def testIntArrayConversion(self): - a1 = numpy.zeros((5,3,4),dtype=numpy.int32) - a2 = a1[:,:,:2] - self.assertTrue(a1.flags["WRITEABLE"]) - self.assertTrue(a2.flags["WRITEABLE"]) - - ua1 = numpy.zeros((5,3,4),dtype=numpy.uint32) - self.assertTrue(ua1.flags["WRITEABLE"]) - - b1 = python_test_mod.passIntArray33(a1) - self.assertTrue(b1.flags["WRITEABLE"]) - self.assertEqual(a1.shape,b1.shape) - self.assertEqual(a1.strides,b1.strides) - - ub1 = python_test_mod.passUIntArray33(ua1) - self.assertTrue(ub1.flags["WRITEABLE"]) - self.assertEqual(a1.shape,ub1.shape) - self.assertEqual(a1.strides,ub1.strides) - - c1 = python_test_mod.passIntArray30(a1) - self.assertTrue(c1.flags["WRITEABLE"]) - self.assertEqual(a1.shape,c1.shape) - self.assertEqual(a1.strides,c1.strides) - - d1 = python_test_mod.passConstIntArray33(a1) - self.assertEqual(a1.shape,d1.shape) - self.assertEqual(a1.strides,d1.strides) - self.assertTrue(not d1.flags.writeable) - - self.assertRaises(ValueError, python_test_mod.passIntArray33, a2) - - c2 = python_test_mod.passIntArray30(a2) - self.assertTrue(c2.flags["WRITEABLE"]) - self.assertEqual(a2.shape,c2.shape) - self.assertEqual(a2.strides,c2.strides) - - # test to be sure a tuple of tuples does not work - self.assertRaises(TypeError, python_test_mod.passIntArray30, ((1,1,1),(2,2,2),(3,3,3))) - - # test to be sure an array of the wrong type does not work - self.assertRaises(ValueError, python_test_mod.passIntArray30, - numpy.zeros((4,3,4),dtype=numpy.float)) - - def testVectorConversion(self): - a = (3.5,6.7,1.2) - b = python_test_mod.passFloatVector3(a) - self.assertEqual(a,b) - - def testArrayConversion(self): - a1 = numpy.zeros((5,3,4),dtype=float) - a2 = a1[:,:,:2] - self.assertTrue(a1.flags["WRITEABLE"]) - self.assertTrue(a2.flags["WRITEABLE"]) - - b1 = python_test_mod.passFloatArray33(a1) - self.assertTrue(b1.flags["WRITEABLE"]) - self.assertEqual(a1.shape,b1.shape) - self.assertEqual(a1.strides,b1.strides) - - - c1 = python_test_mod.passFloatArray30(a1) - self.assertTrue(c1.flags["WRITEABLE"]) - self.assertEqual(a1.shape,c1.shape) - self.assertEqual(a1.strides,c1.strides) - - d1 = python_test_mod.passConstFloatArray33(a1) - self.assertEqual(a1.shape,d1.shape) - self.assertEqual(a1.strides,d1.strides) - self.assertTrue(not d1.flags.writeable) - - self.assertRaises(ValueError, python_test_mod.passFloatArray33, a2) - - c2 = python_test_mod.passFloatArray30(a2) - self.assertTrue(c2.flags["WRITEABLE"]) - self.assertEqual(a2.shape,c2.shape) - self.assertEqual(a2.strides,c2.strides) - - # test to be sure a tuple of tuples does not work - self.assertRaises(TypeError, python_test_mod.passFloatArray30, - ((1.0,1.0,1.0),(2.0,2.0,2.0),(3.0,3.0,3.0))) - - # test to be sure an array of the wrong type does not work - self.assertRaises(ValueError, python_test_mod.passFloatArray30, - numpy.zeros((4,3,4),dtype=numpy.int32)) - - # test to be sure a tuple of tuples does not work - self.assertRaises(TypeError, python_test_mod.passFloatArray30, - ((1.0,1.0,1.0),(2.0,2.0,2.0),(3.0,3.0,3.0))) - - # test to be sure an array of the wrong type does not work - self.assertRaises(ValueError, python_test_mod.passFloatArray30, - numpy.zeros((4,3,4),dtype=numpy.int32)) - - def testFloatArrayCreation(self): - a = python_test_mod.makeFloatArray3((3,4,5)) - - def testIntArrayCreation(self): - a = python_test_mod.makeIntArray3((3,4,5)) - -if __name__ == "__main__": - unittest.main() diff --git a/tests/python_test_mod.cc b/tests/python_test_mod.cc deleted file mode 100644 index e73bee88..00000000 --- a/tests/python_test_mod.cc +++ /dev/null @@ -1,98 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -#include "Python.h" -#include "numpy/arrayobject.h" -#include "ndarray/swig.h" -#include -#ifndef _MSC_VER -#pragma GCC diagnostic ignored "-Wuninitialized" -#endif - -/* Define macros for things that changed between Python V2.7 and V3.2 */ -#if PY_MAJOR_VERSION >= 3 -#define MOD_INIT(name) PyMODINIT_FUNC PyInit_##name(void) -#define RETURN(value) return value -#else -#define MOD_INIT(name) PyMODINIT_FUNC init##name(void) -#define RETURN(value) return -#endif - -template -static PyObject * passVector(PyObject * self, PyObject * args) { - ndarray::Vector vector; - if (!PyArg_ParseTuple(args,"O&",ndarray::PyConverter< ndarray::Vector >::fromPython,&vector)) - return NULL; - return ndarray::PyConverter< ndarray::Vector >::toPython(vector); -} - -template -static PyObject * passArray(PyObject * self, PyObject * args) { - ndarray::Array array; - if (!PyArg_ParseTuple(args,"O&",ndarray::PyConverter< ndarray::Array >::fromPython,&array)) - return NULL; - return ndarray::PyConverter< ndarray::Array >::toPython(array); -} - -template -static PyObject * makeArray(PyObject * self, PyObject * args) { - ndarray::Vector shape; - if (!PyArg_ParseTuple( - args, - "O&", - ndarray::PyConverter< ndarray::Vector >::fromPython, - &shape) - ) { - return NULL; - } - ndarray::Array array = ndarray::allocate(shape); - array.deep() = static_cast(0); - return ndarray::PyConverter< ndarray::Array >::toPython(array); -} - -static PyMethodDef methods[] = { - {"passFloatVector3",&passVector,METH_VARARGS,NULL}, - {"passFloatArray33",&passArray,METH_VARARGS,NULL}, - {"passConstFloatArray33",&passArray,METH_VARARGS,NULL}, - {"passFloatArray30",&passArray,METH_VARARGS,NULL}, - {"makeFloatArray3",&makeArray,METH_VARARGS,NULL}, - {"passIntVector3",&passVector,METH_VARARGS,NULL}, - {"passIntArray33",&passArray,METH_VARARGS,NULL}, - {"passUIntArray33",&passArray,METH_VARARGS,NULL}, - {"passConstIntArray33",&passArray,METH_VARARGS,NULL}, - {"passIntArray30",&passArray,METH_VARARGS,NULL}, - {"makeIntArray3",&makeArray,METH_VARARGS,NULL}, - {NULL} -}; - -/* Describe the properties of the module. */ -#if PY_MAJOR_VERSION >= 3 -static struct PyModuleDef testmodule = { - PyModuleDef_HEAD_INIT, - "ndarray_python_test", - "Test the ndarray python interface", - -1, - methods, - NULL, NULL, NULL, NULL -}; -#endif - -MOD_INIT(ndarray_python_test) { - import_array(); - PyObject * module = Py_InitModule("python_test_mod",methods); - if (module == NULL) return; -#if PY_MAJOR_VERSION >= 3 - PyObject * module; - module = PyModule_Create(&testmodule); -#else - Py_InitModule3("ndarray_python_test", methods, "Test ndarray python interface"); -#endif - RETURN(module); -} From 0f3d13793e33ed01df63c7548afecea12bd4601f Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 29 Jul 2019 12:24:40 -0400 Subject: [PATCH 39/69] Unpin Eigen version in travis build. And remove Swig, which hasn't needed to be there for a long time. --- .travis.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 5a52c427..8ed6668d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,10 +22,8 @@ install: - conda update -q conda # Useful for debugging any issues with conda - conda info -a - - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION boost fftw numpy pybind11 swig cmake gxx_linux-64 + - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION boost fftw numpy pybind11 cmake gxx_linux-64 eigen - source activate test-environment - - echo "eigen 3.2.*" > $CONDA_PREFIX/conda-meta/pinned - - conda install eigen - export BOOST_DIR=$CONDA_PREFIX - export EIGEN_DIR=$CONDA_PREFIX - export FFTW_DIR=$CONDA_PREFIX From 2209559482f3433624e12430cb8ac0ffc4b1292f Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 29 Jul 2019 12:49:49 -0400 Subject: [PATCH 40/69] Only deploy docs on build for latest Python. --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 8ed6668d..f55cc76a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -50,4 +50,5 @@ deploy: github_token: $GITHUB_TOKEN # Set in travis-ci.org dashboard on: branch: master + python: "3.7" local_dir: build/html From 68eba3a60c5d94a9ff1374735c95a030cbdb7d3a Mon Sep 17 00:00:00 2001 From: Pierre Kestener Date: Tue, 17 Mar 2020 14:22:01 +0100 Subject: [PATCH 41/69] fix class type_caster reported in issue 77 --- include/ndarray/pybind11.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index 09eefac8..db0f5ff9 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -218,7 +218,7 @@ class type_caster< ndarray::Array > { return Helper::toPython(src); } - static PYBIND11_DESCR name() { return type_descr(_>()); } + static constexpr auto name = type_descr(_>()); static handle cast(const ndarray::Array *src, return_value_policy policy, handle parent) { return cast(*src, policy, parent); From 6fbb36c813c077d73dcfa0b2e32317998d0a23f6 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Sat, 19 Sep 2020 16:18:50 -0400 Subject: [PATCH 42/69] Directly report python type in pybind11 type caster. It looks to me like type_descr is only supposed to be used for regular wrapped types, not custom type casters of the sort we have here. And happily we don't need to use its magic to look up the right Python type from a compete (i.e. template-instantiated) C++ type, because we know all ndarray type casters map to "numpy.ndarray" regardless of their template parameters. --- include/ndarray/pybind11.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index db0f5ff9..5af4bcb9 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -218,7 +218,7 @@ class type_caster< ndarray::Array > { return Helper::toPython(src); } - static constexpr auto name = type_descr(_>()); + static constexpr auto name = _("numpy.ndarray"); static handle cast(const ndarray::Array *src, return_value_policy policy, handle parent) { return cast(*src, policy, parent); From b6350f850fd1a74b0fb09ad07a9a557a310bb0d4 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 8 Jan 2021 12:56:00 -0500 Subject: [PATCH 43/69] Avoid use of pybind11's namespace macro for version compatibility. The names of these macros apparently changed between 2.5 and 2.6, but we don't need them anyway, and the namespaces themselves did not change. This resolves #11. --- include/ndarray/pybind11.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index 5af4bcb9..5d216dee 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -196,8 +196,8 @@ Pybind11Helper { } // namespace ndarray -NAMESPACE_BEGIN(pybind11) -NAMESPACE_BEGIN(detail) +namespace pybind11 { +namespace detail { /* @brief A pybind11 type_caster for ndarray::Array */ @@ -242,7 +242,7 @@ class type_caster< ndarray::Array > { Helper _helper; }; -NAMESPACE_END(detail) -NAMESPACE_END(pybind11) +} // namespace detail +} // namespace pybind11 #endif // !NDARRAY_pybind11_h_INCLUDED From f30938f7f507f833de8d7693b5c7fdedc9151408 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 8 Jan 2021 13:21:54 -0500 Subject: [PATCH 44/69] Switch from Travis CI to GitHub Actions. This does not include doc deploy yet. --- .github/workflows/build.yaml | 59 ++++++++++++++++++++++++++++++++++++ .travis.yml | 54 --------------------------------- README.md | 2 +- etc/conda-forge-testing.yaml | 11 +++++++ 4 files changed, 71 insertions(+), 55 deletions(-) create mode 100644 .github/workflows/build.yaml delete mode 100644 .travis.yml create mode 100644 etc/conda-forge-testing.yaml diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 00000000..81b4219e --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,59 @@ +name: build_and_test + +on: + - pull_request + +env: + # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.) + BUILD_TYPE: Release + +jobs: + build_and_test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [2.7, 3.7, 3.8, 3.9] + steps: + - uses: actions/checkout@v2 + - uses: conda-incubator/setup-miniconda@v2 + with: + auto-update-conda: true + miniconda-version: "latest" + channel-priority: strict + channels: conda-forge + python-version: ${{ matrix.python-version }} + environment-file: etc/conda-forge-testing.yaml + activate-environment: ndarray + + - name: Create Build Environment + # Some projects don't allow in-source building, so create a separate build directory + # We'll use this as our working directory for all subsequent commands + run: cmake -E make_directory ${{github.workspace}}/build + + - name: Configure CMake + # Use a bash shell so we can use the same syntax for environment variable + # access regardless of the host operating system + shell: bash -l {0} + working-directory: ${{github.workspace}}/build + # Note the current convention is to use the -S and -B options here to specify source + # and build directories, but this is only available with CMake 3.13 and higher. + # The CMake binaries on the Github Actions machines are (as of this writing) 3.12 + run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DBoost_NO_BOOST_CMAKE=ON -DNDARRAY_PYBIND11=ON -DCMAKE_PREFIX_PATH=$CONDA_PREFIX + + - name: Build + working-directory: ${{github.workspace}}/build + shell: bash -l {0} + # Execute the build. You can specify a specific target with "--target " + run: cmake --build . --config $BUILD_TYPE + + - name: Test + working-directory: ${{github.workspace}}/build + shell: bash -l {0} + # Execute tests defined by the CMake configuration. + # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail + run: ctest -C $BUILD_TYPE + + - name: Build Documentation + working-directory: ${{github.workspace}}/build + shell: bash -l {0} + run: make doc diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index f55cc76a..00000000 --- a/.travis.yml +++ /dev/null @@ -1,54 +0,0 @@ -dist: xenial -language: python -python: - # We don't actually use the Travis Python, but this keeps it organized. - - "2.7" - - "3.6" - - "3.7" -before_install: - - sudo apt-get install doxygen -install: - # We do this conditionally because it saves us some downloading if the - # version is the same. - - if [[ "$TRAVIS_PYTHON_VERSION" == "2.7" ]]; then - wget https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh -O miniconda.sh; - else - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh; - fi - - bash miniconda.sh -b -p $HOME/miniconda - - export PATH="$HOME/miniconda/bin:$PATH" - - hash -r - - conda config --set always_yes yes --set changeps1 no - - conda update -q conda - # Useful for debugging any issues with conda - - conda info -a - - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION boost fftw numpy pybind11 cmake gxx_linux-64 eigen - - source activate test-environment - - export BOOST_DIR=$CONDA_PREFIX - - export EIGEN_DIR=$CONDA_PREFIX - - export FFTW_DIR=$CONDA_PREFIX - - export CMAKE_PREFIX_PATH=$CONDA_PREFIX - -script: - - mkdir build - - cd build - - - cmake -DNDARRAY_PYBIND11=ON .. - - make - - make test ARGS="-V" - - - rm CMakeCache.txt - - cmake -DNDARRAY_PYBIND11=ON .. - - make - - make test ARGS="-V" - - - make doc - -deploy: - provider: pages - skip_cleanup: true - github_token: $GITHUB_TOKEN # Set in travis-ci.org dashboard - on: - branch: master - python: "3.7" - local_dir: build/html diff --git a/README.md b/README.md index 5e7fe9bf..b04d1a44 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ndarray: NumPy-friendly multidimensional arrays in C++ ====================================================== -[![Build Status](https://travis-ci.org/ndarray/ndarray.svg?branch=master)](https://travis-ci.org/ndarray/ndarray) +![Build Status](https://github.com/ndarray/ndarray/workflows/build_and_test/badge.svg) ndarray is a template library that provides multidimensional array objects in C++, with an interface and features designed to mimic the diff --git a/etc/conda-forge-testing.yaml b/etc/conda-forge-testing.yaml new file mode 100644 index 00000000..ce4fc26e --- /dev/null +++ b/etc/conda-forge-testing.yaml @@ -0,0 +1,11 @@ +name: ndarray +channels: + - conda-forge +dependencies: + - doxygen + - boost + - fftw + - numpy + - pybind11 + - gxx_linux-64 + - eigen From 3ae5a4dcac545100296399fbe0019894f8356a89 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 8 Jan 2021 14:32:25 -0500 Subject: [PATCH 45/69] Attempt to move doc deploy to GitHub actions. --- .github/workflows/build.yaml | 10 ++++++++++ README.md | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 81b4219e..74c04023 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -1,6 +1,7 @@ name: build_and_test on: + - push - pull_request env: @@ -57,3 +58,12 @@ jobs: working-directory: ${{github.workspace}}/build shell: bash -l {0} run: make doc + + - name: Deploy Documentation (master/py3.8 only) + uses: JamesIves/github-pages-deploy-action@3.7.1 + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.python-version == 3.8 }} + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: gh-pages # The branch the action should deploy to. + FOLDER: build/html # The folder the action should deploy. + CLEAN: true # Automatically remove deleted files from the deploy branch diff --git a/README.md b/README.md index b04d1a44..2be217b7 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ objects in C++, with an interface and features designed to mimic the Python 'numpy' package as much as possible. More information can be found in the [documentation at -ndarray.github.io/ndarray](http://ndarray.github.io/ndarray/). +ndarray.github.io/ndarray](https://ndarray.github.io/ndarray/). Installation From 1e51250b2d29f36654f287f040633e8b98ae0cbd Mon Sep 17 00:00:00 2001 From: Matthias Wittgen Date: Sat, 9 Jan 2021 17:11:54 -0500 Subject: [PATCH 46/69] don't generate source code with m4 --- .gitignore | 6 - CMakeLists.txt | 1 - include/CMakeLists.txt | 41 - include/ndarray/ArrayBaseN.h | 229 +++++ include/ndarray/ArrayBaseN.h.m4 | 87 -- include/ndarray/ArrayRef.h | 401 +++++++++ include/ndarray/ArrayRef.h.m4 | 176 ---- include/ndarray/Vector.h | 815 +++++++++++++++++ include/ndarray/Vector.h.m4 | 465 ---------- include/ndarray/fft/FFTWTraits.h | 326 +++++++ include/ndarray/fft/FFTWTraits.h.m4 | 143 --- include/ndarray/operators.h | 1261 +++++++++++++++++++++++++++ include/ndarray/operators.h.m4 | 349 -------- tests/CMakeLists.txt | 10 +- 14 files changed, 3037 insertions(+), 1273 deletions(-) delete mode 100644 include/CMakeLists.txt create mode 100644 include/ndarray/ArrayBaseN.h delete mode 100644 include/ndarray/ArrayBaseN.h.m4 create mode 100644 include/ndarray/ArrayRef.h delete mode 100644 include/ndarray/ArrayRef.h.m4 create mode 100644 include/ndarray/Vector.h delete mode 100644 include/ndarray/Vector.h.m4 create mode 100644 include/ndarray/fft/FFTWTraits.h delete mode 100644 include/ndarray/fft/FFTWTraits.h.m4 create mode 100644 include/ndarray/operators.h delete mode 100644 include/ndarray/operators.h.m4 diff --git a/.gitignore b/.gitignore index 0edbcde6..51eb3e96 100644 --- a/.gitignore +++ b/.gitignore @@ -18,10 +18,4 @@ version.py tests/ndarray tests/ndarray-eigen tests/ndarray-fft -include/ndarray/Array.h -include/ndarray/ArrayBaseN.h -include/ndarray/ArrayRef.h -include/ndarray/Vector.h -include/ndarray/fft/FFTWTraits.h -include/ndarray/operators.h build/ diff --git a/CMakeLists.txt b/CMakeLists.txt index 5809b3a4..7031c7d4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -26,7 +26,6 @@ add_definitions(-std=c++11) # module search path set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH}) -add_subdirectory(include) # add a target to generate API documentation with Doxygen find_package(Doxygen) diff --git a/include/CMakeLists.txt b/include/CMakeLists.txt deleted file mode 100644 index 494b45b0..00000000 --- a/include/CMakeLists.txt +++ /dev/null @@ -1,41 +0,0 @@ -# preprocess files with m4 if needed -set(FILES1 - "ndarray/ArrayBaseN.h" - ) - -set(FILES2 - "ndarray/ArrayRef.h" - "ndarray/operators.h" - "ndarray/Vector.h" - "ndarray/fft/FFTWTraits.h" - ) - -set(PREPROCESS_FILES1 "") -foreach(FILENAME ${FILES1}) - list(APPEND PREPROCESS_FILES1 "${CMAKE_CURRENT_SOURCE_DIR}/${FILENAME}") -endforeach(FILENAME) - -set(PREPROCESS_FILES2 "") -foreach(FILENAME ${FILES2}) - list(APPEND PREPROCESS_FILES2 "${CMAKE_CURRENT_SOURCE_DIR}/${FILENAME}") -endforeach(FILENAME) - -foreach(FILENAME ${PREPROCESS_FILES1}) - add_custom_command ( - OUTPUT ${FILENAME} - DEPENDS ${FILENAME}.m4 - COMMAND m4 ${FILENAME}.m4 > ${FILENAME} - ) -endforeach(FILENAME) - -foreach(FILENAME ${PREPROCESS_FILES2}) - add_custom_command ( - OUTPUT ${FILENAME} - DEPENDS ${FILENAME}.m4 - COMMAND m4 ${FILENAME}.m4 > ${FILENAME} - ) -endforeach(FILENAME) - -add_custom_target(preprocess_includes1 ALL DEPENDS ${PREPROCESS_FILES1}) -add_custom_target(preprocess_includes2 ALL DEPENDS ${PREPROCESS_FILES2}) -add_dependencies(preprocess_includes2 preprocess_includes1) diff --git a/include/ndarray/ArrayBaseN.h b/include/ndarray/ArrayBaseN.h new file mode 100644 index 00000000..182e5670 --- /dev/null +++ b/include/ndarray/ArrayBaseN.h @@ -0,0 +1,229 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2012, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ + +#ifndef NDARRAY_ArrayBaseN_h_INCLUDED +#define NDARRAY_ArrayBaseN_h_INCLUDED + +/** + * @file ndarray/ArrayBaseN.h + * + * @brief Definition of ArrayBaseN, a dimension-specialized CRTP base class for Array and ArrayRef. + */ + +#include "ndarray/ArrayBase.h" + +namespace ndarray { + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef. + */ +template ::ND::value> +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; +private: + template friend class Array; + template friend class ArrayRef; + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + /// @internal @brief Construct an ArrayRef from a pointer and Core. + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 1). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0) const { + return this->operator[](makeVector(n0)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 2). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0, int n1) const { + return this->operator[](makeVector(n0, n1)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 3). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0, int n1, int n2) const { + return this->operator[](makeVector(n0, n1, n2)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 4). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0, int n1, int n2, int n3) const { + return this->operator[](makeVector(n0, n1, n2, n3)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 5). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0, int n1, int n2, int n3, int n4) const { + return this->operator[](makeVector(n0, n1, n2, n3, n4)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 6). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0, int n1, int n2, int n3, int n4, int n5) const { + return this->operator[](makeVector(n0, n1, n2, n3, n4, n5)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +} // namespace ndarray + +#endif // !NDARRAY_ArrayBaseN_h_INCLUDED diff --git a/include/ndarray/ArrayBaseN.h.m4 b/include/ndarray/ArrayBaseN.h.m4 deleted file mode 100644 index 2d112954..00000000 --- a/include/ndarray/ArrayBaseN.h.m4 +++ /dev/null @@ -1,87 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -changecom(`###')dnl -define(`SPECIALIZE', -` -/** - * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for $1). - */ -template -class ArrayBaseN : public ArrayBase< Derived > { - typedef ArrayBase Super; -protected: - typedef typename Super::Core Core; - typedef typename Super::CorePtr CorePtr; -public: - typedef typename Super::Element Element; - - Element & operator()($2) const { - return this->operator[](makeVector($3)); - } - -private: - template friend class Array; - template friend class ArrayRef; - - void operator=(ArrayBaseN const & other) { - Super::operator=(other); - } - - template - ArrayBaseN(ArrayBaseN const & other) : Super(other) {} - - ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} -};')dnl -#ifndef NDARRAY_ArrayBaseN_h_INCLUDED -#define NDARRAY_ArrayBaseN_h_INCLUDED - -/** - * @file ndarray/ArrayBaseN.h - * - * @brief Definition of ArrayBaseN, a dimension-specialized CRTP base class for Array and ArrayRef. - */ - -#include "ndarray/ArrayBase.h" - -namespace ndarray { - -/** - * @brief An intermediate CRTP base class for Array and ArrayRef. - */ -template ::ND::value> -class ArrayBaseN : public ArrayBase< Derived > { - typedef ArrayBase Super; -protected: - typedef typename Super::Core Core; - typedef typename Super::CorePtr CorePtr; -public: - typedef typename Super::Element Element; -private: - template friend class Array; - template friend class ArrayRef; - void operator=(ArrayBaseN const & other) { - Super::operator=(other); - } - /// @internal @brief Construct an ArrayRef from a pointer and Core. - ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} -}; - -SPECIALIZE(1, `int n0', `n0') -SPECIALIZE(2, `int n0, int n1', `n0, n1') -SPECIALIZE(3, `int n0, int n1, int n2', `n0, n1, n2') -SPECIALIZE(4, `int n0, int n1, int n2, int n3', `n0, n1, n2, n3') -SPECIALIZE(5, `int n0, int n1, int n2, int n3, int n4', `n0, n1, n2, n3, n4') -SPECIALIZE(6, `int n0, int n1, int n2, int n3, int n4, int n5', `n0, n1, n2, n3, n4, n5') - -} // namespace ndarray - -#endif // !NDARRAY_ArrayBaseN_h_INCLUDED diff --git a/include/ndarray/ArrayRef.h b/include/ndarray/ArrayRef.h new file mode 100644 index 00000000..0fec2c0a --- /dev/null +++ b/include/ndarray/ArrayRef.h @@ -0,0 +1,401 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2012, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ +#ifndef NDARRAY_ArrayRef_h_INCLUDED +#define NDARRAY_ArrayRef_h_INCLUDED + +/** + * @file ndarray/ArrayRef.h + * + * @brief Definitions for ArrayRef. + */ + +#include "ndarray_fwd.h" +#include "ndarray/ArrayTraits.h" +#include "ndarray/ArrayBaseN.h" +#include "ndarray/detail/ArrayAccess.h" +#include "ndarray/Vector.h" +#include "ndarray/detail/Core.h" +#include "ndarray/views.h" + +namespace ndarray { + +/** + * @brief A proxy class for Array with deep assignment operators. + */ +template +class ArrayRef : public ArrayBaseN< ArrayRef > { + typedef ArrayBaseN Super; + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Iterator Iterator; + + /** + * @brief Construct an array with the given dimensions and allocated but uninitialized memory. + * + * Unspecified dimensions will have unit size, and if the number of argmuments is greater + * than the number of dimensions of the array, the extra arguments will be silently ignored. + * + * This is implemented in initialization.h. + */ + explicit ArrayRef(Size n1, Size n2=1, Size n3=1, Size n4=1, Size n5=1, Size n6=1, Size n7=1, Size n8=1); + + /** + * @brief Construct an array with the given dimensions and allocated but uninitialized memory. + * + * This is implemented in initialization.h. + */ + template + explicit ArrayRef(Vector const & shape); + + /** + * @brief Non-converting copy constructor. + */ + ArrayRef(ArrayRef const & other) : Super(other._data, other._core) {} + + /** + * @brief Converting copy constructor. + * + * Implicit conversion is allowed for non-const to const and for + * more guaranteed RMC to less guaranteed RMC (see \ref ndarrayTutorial). + */ + template + explicit ArrayRef( + Array const & other +#ifndef DOXYGEN + , typename boost::enable_if,void*>::type=0 +#endif + ) : Super(other._data, other._core) {} + + /** + * @brief Converting copy constructor. + * + * Implicit conversion is allowed for non-const to const and for + * more guaranteed RMC to less guaranteed RMC (see \ref ndarrayTutorial). + */ + template + ArrayRef( + ArrayRef const & other +#ifndef DOXYGEN + , typename boost::enable_if,void*>::type=0 +#endif + ) : Super(other._data, other._core) {} + + /** + * @name Assignment and Augmented Assignment Operators + * + * ArrayRef assignment is deep, and requires that + * the ArrayRef being assigned to has the same shape as + * the input array expression. Scalar assignment sets + * all elements of the ArrayRef to a single value. + */ + /// @{ + ArrayRef const & operator=(Array const & other) const { + NDARRAY_ASSERT(other.getShape() == this->getShape()); + std::copy(other.begin(), other.end(), this->begin()); + return *this; + } + + ArrayRef const & operator=(ArrayRef const & other) const { + NDARRAY_ASSERT(other.getShape() == this->getShape()); + std::copy(other.begin(), other.end(), this->begin()); + return *this; + } + + + /// \brief = assignment of arrays and array expressions. + template + ArrayRef const & + operator =(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + std::copy(expr.begin(),expr.end(),this->begin()); + return *this; + } + + /// \brief = assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator =(Scalar const & scalar) const { + Super::Traits::fill(this->begin(),this->end(),scalar); + return *this; + } + + /// \brief += assignment of arrays and array expressions. + template + ArrayRef const & + operator +=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) += (*j); + return *this; + } + + /// \brief += assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator +=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) += scalar; + return *this; + } + + /// \brief -= assignment of arrays and array expressions. + template + ArrayRef const & + operator -=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) -= (*j); + return *this; + } + + /// \brief -= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator -=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) -= scalar; + return *this; + } + + /// \brief *= assignment of arrays and array expressions. + template + ArrayRef const & + operator *=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) *= (*j); + return *this; + } + + /// \brief *= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator *=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) *= scalar; + return *this; + } + + /// \brief /= assignment of arrays and array expressions. + template + ArrayRef const & + operator /=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) /= (*j); + return *this; + } + + /// \brief /= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator /=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) /= scalar; + return *this; + } + + /// \brief %= assignment of arrays and array expressions. + template + ArrayRef const & + operator %=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) %= (*j); + return *this; + } + + /// \brief %= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator %=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) %= scalar; + return *this; + } + + /// \brief ^= assignment of arrays and array expressions. + template + ArrayRef const & + operator ^=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) ^= (*j); + return *this; + } + + /// \brief ^= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator ^=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) ^= scalar; + return *this; + } + + /// \brief &= assignment of arrays and array expressions. + template + ArrayRef const & + operator &=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) &= (*j); + return *this; + } + + /// \brief &= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator &=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) &= scalar; + return *this; + } + + /// \brief |= assignment of arrays and array expressions. + template + ArrayRef const & + operator |=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) |= (*j); + return *this; + } + + /// \brief |= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator |=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) |= scalar; + return *this; + } + + /// \brief <<= assignment of arrays and array expressions. + template + ArrayRef const & + operator <<=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) <<= (*j); + return *this; + } + + /// \brief <<= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator <<=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) <<= scalar; + return *this; + } + + /// \brief >>= assignment of arrays and array expressions. + template + ArrayRef const & + operator >>=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) >>= (*j); + return *this; + } + + /// \brief >>= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator >>=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) >>= scalar; + return *this; + } + ///@} + +private: + template friend class Array; + template friend class ArrayRef; + template friend struct ArrayTraits; + template friend class ArrayBase; + template friend class detail::ArrayAccess; + + /// @internal @brief Construct an ArrayRef from a pointer and Core. + ArrayRef(T * data, CorePtr const & core) : Super(data, core) {} + +}; + +} // namespace ndarray + +#endif // !NDARRAY_ArrayRef_h_INCLUDED diff --git a/include/ndarray/ArrayRef.h.m4 b/include/ndarray/ArrayRef.h.m4 deleted file mode 100644 index ee5da55b..00000000 --- a/include/ndarray/ArrayRef.h.m4 +++ /dev/null @@ -1,176 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -changecom(`###')dnl -define(`GENERAL_ASSIGN', -` - /// \brief $1 assignment of arrays and array expressions. - template - ArrayRef const & - operator $1(ExpressionBase const & expr) const { - NDARRAY_ASSERT(expr.getShape() - == this->getShape().template first::ND::value>()); - indir(`$3',$1) - return *this; - } - - /// \brief $1 assignment of scalars. - template -#ifndef DOXYGEN - typename boost::enable_if, ArrayRef const &>::type -#else - ArrayRef const & -#endif - operator $1(Scalar const & scalar) const { - indir(`$2',$1) - return *this; - }')dnl -define(`BASIC_ASSIGN_SCALAR',`Super::Traits::fill(this->begin(),this->end(),scalar);')dnl -define(`BASIC_ASSIGN_EXPR',`std::copy(expr.begin(),expr.end(),this->begin());')dnl -define(`AUGMENTED_ASSIGN_SCALAR', -`Iterator const i_end = this->end(); - for (Iterator i = this->begin(); i != i_end; ++i) (*i) $1 scalar;')dnl -define(`AUGMENTED_ASSIGN_EXPR', -`Iterator const i_end = this->end(); - typename Other::Iterator j = expr.begin(); - for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) $1 (*j);')dnl -define(`BASIC_ASSIGN',`GENERAL_ASSIGN(`=',`BASIC_ASSIGN_SCALAR',`BASIC_ASSIGN_EXPR')')dnl -define(`AUGMENTED_ASSIGN',`GENERAL_ASSIGN($1,`AUGMENTED_ASSIGN_SCALAR',`AUGMENTED_ASSIGN_EXPR')')dnl -#ifndef NDARRAY_ArrayRef_h_INCLUDED -#define NDARRAY_ArrayRef_h_INCLUDED - -/** - * @file ndarray/ArrayRef.h - * - * @brief Definitions for ArrayRef. - */ - -#include "ndarray_fwd.h" -#include "ndarray/ArrayTraits.h" -#include "ndarray/ArrayBaseN.h" -#include "ndarray/detail/ArrayAccess.h" -#include "ndarray/Vector.h" -#include "ndarray/detail/Core.h" -#include "ndarray/views.h" - -namespace ndarray { - -/** - * @brief A proxy class for Array with deep assignment operators. - */ -template -class ArrayRef : public ArrayBaseN< ArrayRef > { - typedef ArrayBaseN Super; - typedef typename Super::Core Core; - typedef typename Super::CorePtr CorePtr; -public: - typedef typename Super::Iterator Iterator; - - /** - * @brief Construct an array with the given dimensions and allocated but uninitialized memory. - * - * Unspecified dimensions will have unit size, and if the number of argmuments is greater - * than the number of dimensions of the array, the extra arguments will be silently ignored. - * - * This is implemented in initialization.h. - */ - explicit ArrayRef(Size n1, Size n2=1, Size n3=1, Size n4=1, Size n5=1, Size n6=1, Size n7=1, Size n8=1); - - /** - * @brief Construct an array with the given dimensions and allocated but uninitialized memory. - * - * This is implemented in initialization.h. - */ - template - explicit ArrayRef(Vector const & shape); - - /** - * @brief Non-converting copy constructor. - */ - ArrayRef(ArrayRef const & other) : Super(other._data, other._core) {} - - /** - * @brief Converting copy constructor. - * - * Implicit conversion is allowed for non-const to const and for - * more guaranteed RMC to less guaranteed RMC (see \ref ndarrayTutorial). - */ - template - explicit ArrayRef( - Array const & other -#ifndef DOXYGEN - , typename boost::enable_if,void*>::type=0 -#endif - ) : Super(other._data, other._core) {} - - /** - * @brief Converting copy constructor. - * - * Implicit conversion is allowed for non-const to const and for - * more guaranteed RMC to less guaranteed RMC (see \ref ndarrayTutorial). - */ - template - ArrayRef( - ArrayRef const & other -#ifndef DOXYGEN - , typename boost::enable_if,void*>::type=0 -#endif - ) : Super(other._data, other._core) {} - - /** - * @name Assignment and Augmented Assignment Operators - * - * ArrayRef assignment is deep, and requires that - * the ArrayRef being assigned to has the same shape as - * the input array expression. Scalar assignment sets - * all elements of the ArrayRef to a single value. - */ - /// @{ - ArrayRef const & operator=(Array const & other) const { - NDARRAY_ASSERT(other.getShape() == this->getShape()); - std::copy(other.begin(), other.end(), this->begin()); - return *this; - } - - ArrayRef const & operator=(ArrayRef const & other) const { - NDARRAY_ASSERT(other.getShape() == this->getShape()); - std::copy(other.begin(), other.end(), this->begin()); - return *this; - } - -BASIC_ASSIGN -AUGMENTED_ASSIGN(+=) -AUGMENTED_ASSIGN(-=) -AUGMENTED_ASSIGN(*=) -AUGMENTED_ASSIGN(/=) -AUGMENTED_ASSIGN(%=) -AUGMENTED_ASSIGN(^=) -AUGMENTED_ASSIGN(&=) -AUGMENTED_ASSIGN(|=) -AUGMENTED_ASSIGN(<<=) -AUGMENTED_ASSIGN(>>=) - ///@} - -private: - template friend class Array; - template friend class ArrayRef; - template friend struct ArrayTraits; - template friend class ArrayBase; - template friend class detail::ArrayAccess; - - /// @internal @brief Construct an ArrayRef from a pointer and Core. - ArrayRef(T * data, CorePtr const & core) : Super(data, core) {} - -}; - -} // namespace ndarray - -#endif // !NDARRAY_ArrayRef_h_INCLUDED diff --git a/include/ndarray/Vector.h b/include/ndarray/Vector.h new file mode 100644 index 00000000..f8e476c6 --- /dev/null +++ b/include/ndarray/Vector.h @@ -0,0 +1,815 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2012, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ + +#ifndef NDARRAY_Vector_h_INCLUDED +#define NDARRAY_Vector_h_INCLUDED + +/// @file ndarray/Vector.h Definition for Vector. + +#include +#include +#include +#include +#include +#include +#include + +#include + +#include "ndarray_fwd.h" +#include "ndarray/types.h" + +/// \cond MACROS +#define NDARRAY_MAKE_VECTOR_MAX 8 + +#define NDARRAY_MAKE_VECTOR_ARG_SPEC(Z,I,DATA) T v ## I +#define NDARRAY_MAKE_VECTOR_SET_SPEC(Z,I,DATA) r[I] = v ## I; + +#define NDARRAY_MAKE_VECTOR_SPEC(Z,N,DATA) \ + template \ + inline Vector makeVector( \ + BOOST_PP_ENUM(N,NDARRAY_MAKE_VECTOR_ARG_SPEC,unused) \ + ) { \ + Vector r; \ + BOOST_PP_REPEAT(N,NDARRAY_MAKE_VECTOR_SET_SPEC,unused) \ + return r; \ + } + +/// \endcond + +namespace ndarray { + +namespace detail { + +template ::value> +struct DefaultValue { + static T get() { return T(); } +}; + +template +struct DefaultValue { + static T get() { return T(0); } +}; + +} // namespace detail + +/// \addtogroup ndarrayVectorGroup +/// @{ + +/** + * @class Vector + * @brief A fixed-size 1D array class. + * + * Vector is primarily used as the data type for the shape + * (with T==Size) and strides (with T==Offset) attributes of Array. + * + * Vector is implemented almost exactly as a non-aggregate + * boost::array, but with the addition of mathematical + * operators and a few other utility functions. + */ +template < + typename T, ///< Data type. + int N ///< Number of elements. + > +struct Vector { + + typedef T Element; + typedef T Value; + typedef T & Reference; + typedef T const & ConstReference; + typedef T * Iterator; + typedef T const * ConstIterator; + + typedef Value value_type; + typedef Iterator iterator; + typedef ConstIterator const_iterator; + typedef Reference reference; + typedef ConstReference const_reference; + typedef boost::reverse_iterator reverse_iterator; + typedef boost::reverse_iterator const_reverse_iterator; + typedef T * pointer; + typedef int difference_type; + typedef int size_type; + + + typedef boost::mpl::int_ ND; + /// @brief Return the size of the Vector. + size_type size() const { return N; } + /// @brief Return the size of the Vector. + size_type max_size() const { return N; } + ///< @brief Return true if size() == 0. + bool empty() const { return N==0; } + /// @brief Return an iterator to the beginning of the Vector. + iterator begin() { return elems; } + /// @brief Return a const_iterator to the beginning of the Vector. + const_iterator begin() const { return elems; } + /// @brief Return an iterator to the end of the Vector. + iterator end() { return elems+N; } + /// @brief Return a const_iterator to the end of the Vector. + const_iterator end() const { return elems+N; } + /// @brief Return a reverse_iterator to the beginning of the reversed Vector. + reverse_iterator rbegin() { return reverse_iterator(end()); } + /// @brief Return a const_reverse_iterator to the beginning of the reversed Vector. + const_reverse_iterator rbegin() const { return const_reverse_iterator(end()); } + /// @brief Return a reverse_iterator to the end of the reversed Vector. + reverse_iterator rend() { return reverse_iterator(begin()); } + /// @brief Return a const_reverse_iterator to the end of the reversed Vector. + const_reverse_iterator rend() const { return const_reverse_iterator(begin()); } + + /// @brief Return a reference to the first element. + reference front() { return *elems; } + /// @brief Return a reference to the last element. + reference back() { return *(elems+N-1); } + /// @brief Return a const_reference to the first element. + const_reference front() const { return *elems; } + /// @brief Return a const_reference to the last element. + const_reference back() const { return *(elems+N-1); } + + /// @brief Return a reference to the element with the given index. + reference operator[](int i) { return elems[i]; } + /// @brief Return a const_reference to the element with the given index. + const_reference operator[](int i) const { return elems[i]; } + + /// @brief Create a new Vector that is a subset of this. + template + Vector getRange() const { + Vector r; + std::copy(begin() + Start, begin()+Stop, r.begin()); + return r; + } + + /// @brief Create a new Vector from the first M elements of this. + template Vector first() const { + Vector r; + std::copy(begin(), begin() + M, r.begin()); + return r; + } + + /// @brief Create a new Vector from the last M elements of this. + template Vector last() const { + Vector r; + std::copy(begin() + (N - M), begin() + N, r.begin()); + return r; + } + + /** @brief Stream output. */ + friend std::ostream& operator<<(std::ostream& os, Vector const & obj) { + os << "("; + std::copy(obj.begin(), obj.end(), std::ostream_iterator(os,",")); + return os << ")"; + } + + /** + * @brief Default constructor. + * + * Initializes the elements to zero. + */ + Vector() { this-> + #ifndef _MSC_VER + template + #endif + operator=(detail::DefaultValue::get()); } + + /// @brief Construct with copies of a scalar. + explicit Vector(T scalar) { + this->operator=(scalar); + } + + /// @brief Converting copy constructor. + template + Vector(Vector const & other) { + this-> + #ifndef _MSC_VER + template + #endif + operator=(other); + } + + /// @brief Return true if elements of other are equal to the elements of this. + bool operator==(Vector const & other) const { + return std::equal(begin(), end(), other.begin()); + } + + /// @brief Return false if any elements of other are not equal to the elements of this. + bool operator!=(Vector const & other) const { + return !(*this == other); + } + + /// @brief Return the sum of all elements. + T sum() const { + T r = 0; + for (ConstIterator i = begin(); i != end(); ++i) r += (*i); + return r; + } + + /// @brief Return the product of all elements. + T product() const { + T r = 1; + for (ConstIterator i = begin(); i != end(); ++i) r *= (*i); + return r; + } + + /// @brief Return a Vector with the elements reversed. + Vector reverse() const { + Vector r; + std::copy(begin(), end(), r.rbegin()); + return r; + } + + /// @brief Cast the vector element-wise to another type. + template + Vector cast() const { + Vector r; + for (int i = 0; i < N; ++i) { + r[i] = static_cast((*this)[i]); + } + return r; + } + + + /// @brief Augmented = assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator = (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) = (*j); + return *this; + } + /// @brief Augmented = assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator = (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) = scalar; + return *this; + } + + /// @brief Augmented += assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator += (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) += (*j); + return *this; + } + /// @brief Augmented += assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator += (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) += scalar; + return *this; + } + + /// @brief Augmented -= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator -= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) -= (*j); + return *this; + } + /// @brief Augmented -= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator -= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) -= scalar; + return *this; + } + + /// @brief Augmented *= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator *= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) *= (*j); + return *this; + } + /// @brief Augmented *= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator *= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) *= scalar; + return *this; + } + + /// @brief Augmented /= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator /= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) /= (*j); + return *this; + } + /// @brief Augmented /= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator /= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) /= scalar; + return *this; + } + + /// @brief Augmented %= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator %= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) %= (*j); + return *this; + } + /// @brief Augmented %= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator %= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) %= scalar; + return *this; + } + + /// @brief Augmented &= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator &= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) &= (*j); + return *this; + } + /// @brief Augmented &= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator &= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) &= scalar; + return *this; + } + + /// @brief Augmented ^= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator ^= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) ^= (*j); + return *this; + } + /// @brief Augmented ^= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator ^= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) ^= scalar; + return *this; + } + + /// @brief Augmented |= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator |= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) |= (*j); + return *this; + } + /// @brief Augmented |= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator |= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) |= scalar; + return *this; + } + + /// @brief Augmented <<= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator <<= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) <<= (*j); + return *this; + } + /// @brief Augmented <<= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator <<= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) <<= scalar; + return *this; + } + + /// @brief Augmented >>= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator >>= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) >>= (*j); + return *this; + } + /// @brief Augmented >>= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator >>= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) >>= scalar; + return *this; + } + + T elems[N]; +}; + +/// @brief PArtial specialization for zero-size vectors to avoid compiler errors on some platforms. +template +struct Vector { + + typedef T Element; + typedef T Value; + typedef T & Reference; + typedef T const & ConstReference; + typedef T * Iterator; + typedef T const * ConstIterator; + + typedef Value value_type; + typedef Iterator iterator; + typedef ConstIterator const_iterator; + typedef Reference reference; + typedef ConstReference const_reference; + typedef boost::reverse_iterator reverse_iterator; + typedef boost::reverse_iterator const_reverse_iterator; + typedef T * pointer; + typedef int difference_type; + typedef int size_type; + + + typedef boost::mpl::int_<0> ND; + + size_type size() const { return 0; } ///< @brief Return the size of the Vector. + size_type max_size() const { return 0; } ///< @brief Return the size of the Vector. + bool empty() const { return true; } ///< @brief Return true if size() == 0. + /// @brief Return an iterator to the beginning of the Vector. + iterator begin() { return 0; } + /// @brief Return a const_iterator to the beginning of the Vector. + const_iterator begin() const { return 0; } + /// @brief Return an iterator to the end of the Vector. + iterator end() { return 0; } + /// @brief Return a const_iterator to the end of the Vector. + const_iterator end() const { return 0; } + /// @brief Return a reverse_iterator to the beginning of the reversed Vector. + reverse_iterator rbegin() { return reverse_iterator(); } + /// @brief Return a const_reverse_iterator to the beginning of the reversed Vector. + const_reverse_iterator rbegin() const { return const_reverse_iterator(); } + /// @brief Return a reverse_iterator to the end of the reversed Vector. + reverse_iterator rend() { return reverse_iterator(); } + /// @brief Return a const_reverse_iterator to the end of the reversed Vector. + const_reverse_iterator rend() const { return const_reverse_iterator(); } + + /// @brief Return a reference to the first element. + reference front() { NDARRAY_ASSERT(false); return 0; } + /// @brief Return a reference to the last element. + reference back() { return NDARRAY_ASSERT(false); return 0; } + /// @brief Return a const_reference to the first element. + const_reference front() const { NDARRAY_ASSERT(false); return 0; } + /// @brief Return a const_reference to the last element. + const_reference back() const { NDARRAY_ASSERT(false); return 0; } + + /// @brief Return a reference to the element with the given index. + reference operator[](int i) { NDARRAY_ASSERT(false); return 0; } + /// @brief Return a const_reference to the element with the given index. + const_reference operator[](int i) const { NDARRAY_ASSERT(false); return 0; } + + /// @brief Create a new Vector that is a subset of this. + template + Vector getRange() const { + return Vector(); + } + + /// @brief Create a new Vector from the first M elements of this. + template Vector first() const { + return Vector(); + } + + /// @brief Create a new Vector from the last M elements of this. + template Vector last() const { + return Vector(); + } + + /** @brief Stream output. */ + friend std::ostream& operator<<(std::ostream& os, Vector const & obj) { + return os << "()"; + } + + /** + * @brief Default constructor. + * + * Initializes the elements to zero. + */ + Vector() {} + + /// @brief Construct with copies of a scalar. + explicit Vector(T scalar) {} + + /// @brief Converting copy constructor. + template + Vector(Vector const & other) {} + + /// @brief Return true if elements of other are equal to the elements of this. + bool operator==(Vector const & other) const { return true; } + + /// @brief Return false if any elements of other are not equal to the elements of this. + bool operator!=(Vector const & other) const { return false; } + + /// @brief Return the sum of all elements. + T sum() const { return 0; } + + /// @brief Return the product of all elements. + T product() const { return 1; } + + /// @brief Return a Vector with the elements reversed. + Vector reverse() const { return Vector(); } + + /// @brief Cast the vector element-wise to another type. + template + Vector cast() const { return Vector(); } + +}; + + +/// @brief Concatenate two Vectors into a single long Vector. +template +inline Vector concatenate(Vector const & a, Vector const & b) { + Vector r; + std::copy(a.begin(),a.end(),r.begin()); + std::copy(b.begin(),b.end(),r.begin()+N); + return r; +} + +/// @brief Return a new Vector with the given scalar appended to the original. +template +inline typename boost::enable_if,Vector >::type +concatenate(Vector const & a, U b) { + Vector r; + std::copy(a.begin(),a.end(),r.begin()); + r[N] = b; + return r; +} + +/// @brief Return a new Vector with the given scalar prepended to the original. +template +inline typename boost::enable_if,Vector >::type +concatenate(U a, Vector const & b) { + Vector r; + r[0] = a; + std::copy(b.begin(),b.end(),r.begin()+1); + return r; +} + +#ifndef DOXYGEN +BOOST_PP_REPEAT_FROM_TO(1, NDARRAY_MAKE_VECTOR_MAX, NDARRAY_MAKE_VECTOR_SPEC, unused) +#else +/** + * @brief Variadic constructor for Vector. + * + * Defined for N in [0 - NDARRAY_MAKE_VECTOR_MAX). + */ +template +Vector makeVector(T v1, T v2, ..., T vN); +#endif + +/** @brief Unary bitwise NOT for Vector. */ +template +inline Vector operator~(Vector const & vector) { + Vector r(vector); + for (typename Vector::Iterator i = r.begin(); i != r.end(); ++i) (*i) = ~(*i); + return r; +} + +/** @brief Unary negation for Vector. */ +template +inline Vector operator!(Vector const & vector) { + Vector r(vector); + for (typename Vector::Iterator i = r.begin(); i != r.end(); ++i) (*i) = !(*i); + return r; +} + + + /// @brief Operator overload for Vector + Vector. + template + Vector::Type,N> + operator +(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r += b; + } + /** @brief Operator overload for Vector + Scalar. */ + template + Vector::Type,N> + operator +(Vector const & a, U b) { + Vector::Type,N> r(a); + return r += b; + } + /** @brief Operator overload for Scalar + Vector. */ + template + Vector::Type,N> + operator +(U a, Vector const & b) { + Vector::Type,N> r(a); + return r += b; + } + + /// @brief Operator overload for Vector - Vector. + template + Vector::Type,N> + operator -(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r -= b; + } + /** @brief Operator overload for Vector - Scalar. */ + template + Vector::Type,N> + operator -(Vector const & a, U b) { + Vector::Type,N> r(a); + return r -= b; + } + /** @brief Operator overload for Scalar - Vector. */ + template + Vector::Type,N> + operator -(U a, Vector const & b) { + Vector::Type,N> r(a); + return r -= b; + } + + /// @brief Operator overload for Vector * Vector. + template + Vector::Type,N> + operator *(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r *= b; + } + /** @brief Operator overload for Vector * Scalar. */ + template + Vector::Type,N> + operator *(Vector const & a, U b) { + Vector::Type,N> r(a); + return r *= b; + } + /** @brief Operator overload for Scalar * Vector. */ + template + Vector::Type,N> + operator *(U a, Vector const & b) { + Vector::Type,N> r(a); + return r *= b; + } + + /// @brief Operator overload for Vector / Vector. + template + Vector::Type,N> + operator /(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r /= b; + } + /** @brief Operator overload for Vector / Scalar. */ + template + Vector::Type,N> + operator /(Vector const & a, U b) { + Vector::Type,N> r(a); + return r /= b; + } + /** @brief Operator overload for Scalar / Vector. */ + template + Vector::Type,N> + operator /(U a, Vector const & b) { + Vector::Type,N> r(a); + return r /= b; + } + + /// @brief Operator overload for Vector % Vector. + template + Vector::Type,N> + operator %(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r %= b; + } + /** @brief Operator overload for Vector % Scalar. */ + template + Vector::Type,N> + operator %(Vector const & a, U b) { + Vector::Type,N> r(a); + return r %= b; + } + /** @brief Operator overload for Scalar % Vector. */ + template + Vector::Type,N> + operator %(U a, Vector const & b) { + Vector::Type,N> r(a); + return r %= b; + } + + /// @brief Operator overload for Vector & Vector. + template + Vector::Type,N> + operator &(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r &= b; + } + /** @brief Operator overload for Vector & Scalar. */ + template + Vector::Type,N> + operator &(Vector const & a, U b) { + Vector::Type,N> r(a); + return r &= b; + } + /** @brief Operator overload for Scalar & Vector. */ + template + Vector::Type,N> + operator &(U a, Vector const & b) { + Vector::Type,N> r(a); + return r &= b; + } + + /// @brief Operator overload for Vector ^ Vector. + template + Vector::Type,N> + operator ^(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r ^= b; + } + /** @brief Operator overload for Vector ^ Scalar. */ + template + Vector::Type,N> + operator ^(Vector const & a, U b) { + Vector::Type,N> r(a); + return r ^= b; + } + /** @brief Operator overload for Scalar ^ Vector. */ + template + Vector::Type,N> + operator ^(U a, Vector const & b) { + Vector::Type,N> r(a); + return r ^= b; + } + + /// @brief Operator overload for Vector | Vector. + template + Vector::Type,N> + operator |(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r |= b; + } + /** @brief Operator overload for Vector | Scalar. */ + template + Vector::Type,N> + operator |(Vector const & a, U b) { + Vector::Type,N> r(a); + return r |= b; + } + /** @brief Operator overload for Scalar | Vector. */ + template + Vector::Type,N> + operator |(U a, Vector const & b) { + Vector::Type,N> r(a); + return r |= b; + } + + /// @brief Operator overload for Vector << Vector. + template + Vector::Type,N> + operator <<(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r <<= b; + } + /** @brief Operator overload for Vector << Scalar. */ + template + Vector::Type,N> + operator <<(Vector const & a, U b) { + Vector::Type,N> r(a); + return r <<= b; + } + /** @brief Operator overload for Scalar << Vector. */ + template + Vector::Type,N> + operator <<(U a, Vector const & b) { + Vector::Type,N> r(a); + return r <<= b; + } + + /// @brief Operator overload for Vector >> Vector. + template + Vector::Type,N> + operator >>(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r >>= b; + } + /** @brief Operator overload for Vector >> Scalar. */ + template + Vector::Type,N> + operator >>(Vector const & a, U b) { + Vector::Type,N> r(a); + return r >>= b; + } + /** @brief Operator overload for Scalar >> Vector. */ + template + Vector::Type,N> + operator >>(U a, Vector const & b) { + Vector::Type,N> r(a); + return r >>= b; + } + +/// @} + +} // namespace ndarray + +#endif // !NDARRAY_Vector_h_INCLUDED diff --git a/include/ndarray/Vector.h.m4 b/include/ndarray/Vector.h.m4 deleted file mode 100644 index f7201b11..00000000 --- a/include/ndarray/Vector.h.m4 +++ /dev/null @@ -1,465 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -changecom(`###')dnl -define(`VECTOR_ASSIGN', -` - /// @brief Augmented $1 assignment from another vector. - template - typename boost::enable_if,Vector&>::type - operator $1 (Vector const & other) { - typename Vector::ConstIterator j = other.begin(); - for (Iterator i = begin(); i != end(); ++i, ++j) (*i) $1 (*j); - return *this; - } - /// @brief Augmented $1 assignment from a scalar. - template - typename boost::enable_if,Vector&>::type - operator $1 (U scalar) { - for (Iterator i = begin(); i != end(); ++i) (*i) $1 scalar; - return *this; - }')dnl -define(`VECTOR_BINARY_OP', -` - /// @brief Operator overload for Vector $1 Vector. - template - Vector::Type,N> - operator $1(Vector const & a, Vector const & b) { - Vector::Type,N> r(a); - return r $1= b; - } - /** @brief Operator overload for Vector $1 Scalar. */ - template - Vector::Type,N> - operator $1(Vector const & a, U b) { - Vector::Type,N> r(a); - return r $1= b; - } - /** @brief Operator overload for Scalar $1 Vector. */ - template - Vector::Type,N> - operator $1(U a, Vector const & b) { - Vector::Type,N> r(a); - return r $1= b; - }')dnl -define(`VECTOR_TYPEDEFS', -` - typedef T Element; - typedef T Value; - typedef T & Reference; - typedef T const & ConstReference; - typedef T * Iterator; - typedef T const * ConstIterator; - - typedef Value value_type; - typedef Iterator iterator; - typedef ConstIterator const_iterator; - typedef Reference reference; - typedef ConstReference const_reference; - typedef boost::reverse_iterator reverse_iterator; - typedef boost::reverse_iterator const_reverse_iterator; - typedef T * pointer; - typedef int difference_type; - typedef int size_type; -')dnl -#ifndef NDARRAY_Vector_h_INCLUDED -#define NDARRAY_Vector_h_INCLUDED - -/// @file ndarray/Vector.h Definition for Vector. - -#include -#include -#include -#include -#include -#include -#include - -#include - -#include "ndarray_fwd.h" -#include "ndarray/types.h" - -/// \cond MACROS -#define NDARRAY_MAKE_VECTOR_MAX 8 - -#define NDARRAY_MAKE_VECTOR_ARG_SPEC(Z,I,DATA) T v ## I -#define NDARRAY_MAKE_VECTOR_SET_SPEC(Z,I,DATA) r[I] = v ## I; - -#define NDARRAY_MAKE_VECTOR_SPEC(Z,N,DATA) \ - template \ - inline Vector makeVector( \ - BOOST_PP_ENUM(N,NDARRAY_MAKE_VECTOR_ARG_SPEC,unused) \ - ) { \ - Vector r; \ - BOOST_PP_REPEAT(N,NDARRAY_MAKE_VECTOR_SET_SPEC,unused) \ - return r; \ - } - -/// \endcond - -namespace ndarray { - -namespace detail { - -template ::value> -struct DefaultValue { - static T get() { return T(); } -}; - -template -struct DefaultValue { - static T get() { return T(0); } -}; - -} // namespace detail - -/// \addtogroup ndarrayVectorGroup -/// @{ - -/** - * @class Vector - * @brief A fixed-size 1D array class. - * - * Vector is primarily used as the data type for the shape - * (with T==Size) and strides (with T==Offset) attributes of Array. - * - * Vector is implemented almost exactly as a non-aggregate - * boost::array, but with the addition of mathematical - * operators and a few other utility functions. - */ -template < - typename T, ///< Data type. - int N ///< Number of elements. - > -struct Vector { - VECTOR_TYPEDEFS - - typedef boost::mpl::int_ ND; - /// @brief Return the size of the Vector. - size_type size() const { return N; } - /// @brief Return the size of the Vector. - size_type max_size() const { return N; } - ///< @brief Return true if size() == 0. - bool empty() const { return N==0; } - /// @brief Return an iterator to the beginning of the Vector. - iterator begin() { return elems; } - /// @brief Return a const_iterator to the beginning of the Vector. - const_iterator begin() const { return elems; } - /// @brief Return an iterator to the end of the Vector. - iterator end() { return elems+N; } - /// @brief Return a const_iterator to the end of the Vector. - const_iterator end() const { return elems+N; } - /// @brief Return a reverse_iterator to the beginning of the reversed Vector. - reverse_iterator rbegin() { return reverse_iterator(end()); } - /// @brief Return a const_reverse_iterator to the beginning of the reversed Vector. - const_reverse_iterator rbegin() const { return const_reverse_iterator(end()); } - /// @brief Return a reverse_iterator to the end of the reversed Vector. - reverse_iterator rend() { return reverse_iterator(begin()); } - /// @brief Return a const_reverse_iterator to the end of the reversed Vector. - const_reverse_iterator rend() const { return const_reverse_iterator(begin()); } - - /// @brief Return a reference to the first element. - reference front() { return *elems; } - /// @brief Return a reference to the last element. - reference back() { return *(elems+N-1); } - /// @brief Return a const_reference to the first element. - const_reference front() const { return *elems; } - /// @brief Return a const_reference to the last element. - const_reference back() const { return *(elems+N-1); } - - /// @brief Return a reference to the element with the given index. - reference operator[](int i) { return elems[i]; } - /// @brief Return a const_reference to the element with the given index. - const_reference operator[](int i) const { return elems[i]; } - - /// @brief Create a new Vector that is a subset of this. - template - Vector getRange() const { - Vector r; - std::copy(begin() + Start, begin()+Stop, r.begin()); - return r; - } - - /// @brief Create a new Vector from the first M elements of this. - template Vector first() const { - Vector r; - std::copy(begin(), begin() + M, r.begin()); - return r; - } - - /// @brief Create a new Vector from the last M elements of this. - template Vector last() const { - Vector r; - std::copy(begin() + (N - M), begin() + N, r.begin()); - return r; - } - - /** @brief Stream output. */ - friend std::ostream& operator<<(std::ostream& os, Vector const & obj) { - os << "("; - std::copy(obj.begin(), obj.end(), std::ostream_iterator(os,",")); - return os << ")"; - } - - /** - * @brief Default constructor. - * - * Initializes the elements to zero. - */ - Vector() { this-> - #ifndef _MSC_VER - template - #endif - operator=(detail::DefaultValue::get()); } - - /// @brief Construct with copies of a scalar. - explicit Vector(T scalar) { - this->operator=(scalar); - } - - /// @brief Converting copy constructor. - template - Vector(Vector const & other) { - this-> - #ifndef _MSC_VER - template - #endif - operator=(other); - } - - /// @brief Return true if elements of other are equal to the elements of this. - bool operator==(Vector const & other) const { - return std::equal(begin(), end(), other.begin()); - } - - /// @brief Return false if any elements of other are not equal to the elements of this. - bool operator!=(Vector const & other) const { - return !(*this == other); - } - - /// @brief Return the sum of all elements. - T sum() const { - T r = 0; - for (ConstIterator i = begin(); i != end(); ++i) r += (*i); - return r; - } - - /// @brief Return the product of all elements. - T product() const { - T r = 1; - for (ConstIterator i = begin(); i != end(); ++i) r *= (*i); - return r; - } - - /// @brief Return a Vector with the elements reversed. - Vector reverse() const { - Vector r; - std::copy(begin(), end(), r.rbegin()); - return r; - } - - /// @brief Cast the vector element-wise to another type. - template - Vector cast() const { - Vector r; - for (int i = 0; i < N; ++i) { - r[i] = static_cast((*this)[i]); - } - return r; - } - - VECTOR_ASSIGN(=) - VECTOR_ASSIGN(+=) - VECTOR_ASSIGN(-=) - VECTOR_ASSIGN(*=) - VECTOR_ASSIGN(/=) - VECTOR_ASSIGN(%=) - VECTOR_ASSIGN(&=) - VECTOR_ASSIGN(^=) - VECTOR_ASSIGN(|=) - VECTOR_ASSIGN(<<=) - VECTOR_ASSIGN(>>=) - - T elems[N]; -}; - -/// @brief PArtial specialization for zero-size vectors to avoid compiler errors on some platforms. -template -struct Vector { - VECTOR_TYPEDEFS - - typedef boost::mpl::int_<0> ND; - - size_type size() const { return 0; } ///< @brief Return the size of the Vector. - size_type max_size() const { return 0; } ///< @brief Return the size of the Vector. - bool empty() const { return true; } ///< @brief Return true if size() == 0. - /// @brief Return an iterator to the beginning of the Vector. - iterator begin() { return 0; } - /// @brief Return a const_iterator to the beginning of the Vector. - const_iterator begin() const { return 0; } - /// @brief Return an iterator to the end of the Vector. - iterator end() { return 0; } - /// @brief Return a const_iterator to the end of the Vector. - const_iterator end() const { return 0; } - /// @brief Return a reverse_iterator to the beginning of the reversed Vector. - reverse_iterator rbegin() { return reverse_iterator(); } - /// @brief Return a const_reverse_iterator to the beginning of the reversed Vector. - const_reverse_iterator rbegin() const { return const_reverse_iterator(); } - /// @brief Return a reverse_iterator to the end of the reversed Vector. - reverse_iterator rend() { return reverse_iterator(); } - /// @brief Return a const_reverse_iterator to the end of the reversed Vector. - const_reverse_iterator rend() const { return const_reverse_iterator(); } - - /// @brief Return a reference to the first element. - reference front() { NDARRAY_ASSERT(false); return 0; } - /// @brief Return a reference to the last element. - reference back() { return NDARRAY_ASSERT(false); return 0; } - /// @brief Return a const_reference to the first element. - const_reference front() const { NDARRAY_ASSERT(false); return 0; } - /// @brief Return a const_reference to the last element. - const_reference back() const { NDARRAY_ASSERT(false); return 0; } - - /// @brief Return a reference to the element with the given index. - reference operator[](int i) { NDARRAY_ASSERT(false); return 0; } - /// @brief Return a const_reference to the element with the given index. - const_reference operator[](int i) const { NDARRAY_ASSERT(false); return 0; } - - /// @brief Create a new Vector that is a subset of this. - template - Vector getRange() const { - return Vector(); - } - - /// @brief Create a new Vector from the first M elements of this. - template Vector first() const { - return Vector(); - } - - /// @brief Create a new Vector from the last M elements of this. - template Vector last() const { - return Vector(); - } - - /** @brief Stream output. */ - friend std::ostream& operator<<(std::ostream& os, Vector const & obj) { - return os << "()"; - } - - /** - * @brief Default constructor. - * - * Initializes the elements to zero. - */ - Vector() {} - - /// @brief Construct with copies of a scalar. - explicit Vector(T scalar) {} - - /// @brief Converting copy constructor. - template - Vector(Vector const & other) {} - - /// @brief Return true if elements of other are equal to the elements of this. - bool operator==(Vector const & other) const { return true; } - - /// @brief Return false if any elements of other are not equal to the elements of this. - bool operator!=(Vector const & other) const { return false; } - - /// @brief Return the sum of all elements. - T sum() const { return 0; } - - /// @brief Return the product of all elements. - T product() const { return 1; } - - /// @brief Return a Vector with the elements reversed. - Vector reverse() const { return Vector(); } - - /// @brief Cast the vector element-wise to another type. - template - Vector cast() const { return Vector(); } - -}; - - -/// @brief Concatenate two Vectors into a single long Vector. -template -inline Vector concatenate(Vector const & a, Vector const & b) { - Vector r; - std::copy(a.begin(),a.end(),r.begin()); - std::copy(b.begin(),b.end(),r.begin()+N); - return r; -} - -/// @brief Return a new Vector with the given scalar appended to the original. -template -inline typename boost::enable_if,Vector >::type -concatenate(Vector const & a, U b) { - Vector r; - std::copy(a.begin(),a.end(),r.begin()); - r[N] = b; - return r; -} - -/// @brief Return a new Vector with the given scalar prepended to the original. -template -inline typename boost::enable_if,Vector >::type -concatenate(U a, Vector const & b) { - Vector r; - r[0] = a; - std::copy(b.begin(),b.end(),r.begin()+1); - return r; -} - -#ifndef DOXYGEN -BOOST_PP_REPEAT_FROM_TO(1, NDARRAY_MAKE_VECTOR_MAX, NDARRAY_MAKE_VECTOR_SPEC, unused) -#else -/** - * @brief Variadic constructor for Vector. - * - * Defined for N in [0 - NDARRAY_MAKE_VECTOR_MAX). - */ -template -Vector makeVector(T v1, T v2, ..., T vN); -#endif - -/** @brief Unary bitwise NOT for Vector. */ -template -inline Vector operator~(Vector const & vector) { - Vector r(vector); - for (typename Vector::Iterator i = r.begin(); i != r.end(); ++i) (*i) = ~(*i); - return r; -} - -/** @brief Unary negation for Vector. */ -template -inline Vector operator!(Vector const & vector) { - Vector r(vector); - for (typename Vector::Iterator i = r.begin(); i != r.end(); ++i) (*i) = !(*i); - return r; -} - -VECTOR_BINARY_OP(+) -VECTOR_BINARY_OP(-) -VECTOR_BINARY_OP(*) -VECTOR_BINARY_OP(/) -VECTOR_BINARY_OP(%) -VECTOR_BINARY_OP(&) -VECTOR_BINARY_OP(^) -VECTOR_BINARY_OP(|) -VECTOR_BINARY_OP(<<) -VECTOR_BINARY_OP(>>) - -/// @} - -} // namespace ndarray - -#endif // !NDARRAY_Vector_h_INCLUDED diff --git a/include/ndarray/fft/FFTWTraits.h b/include/ndarray/fft/FFTWTraits.h new file mode 100644 index 00000000..87f94cdc --- /dev/null +++ b/include/ndarray/fft/FFTWTraits.h @@ -0,0 +1,326 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2012, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ +// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. +#ifndef NDARRAY_FFT_FFTWTraits_h_INCLUDED +#define NDARRAY_FFT_FFTWTraits_h_INCLUDED + +/** + * @file ndarray/fft/FFTWTraits.h + * + * \brief Traits classes that wrap FFTW in a template-friendly interface. + */ + +#include +#include +#include "ndarray/fft/FourierTraits.h" + +namespace ndarray { +/// \cond INTERNAL +namespace detail { + +/** + * \internal \ingroup FFTInternalGroup + * \brief A traits class that maps C++ template types to FFTW types and wraps FFTW function calls. + */ +template struct FFTWTraits { BOOST_STATIC_ASSERT(sizeof(T) < 0); }; + +/// \cond SPECIALIZATIONS + + template <> struct FFTWTraits { + BOOST_STATIC_ASSERT((!boost::is_const::value)); + typedef fftwf_plan Plan; + typedef FourierTraits::ElementX ElementX; + typedef FourierTraits::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwf_plan_many_dft_r2c(rank, n, howmany, + in, inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwf_plan_many_dft_c2r(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + out, onembed, ostride, odist, + flags); + } + static inline void destroy(Plan p) { fftwf_destroy_plan(p); } + static inline void execute(Plan p) { fftwf_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftwf_malloc(sizeof(ElementX)*n) + ), + fftwf_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftwf_malloc(sizeof(ElementK)*n) + ), + fftwf_free + ); + } + }; + template <> struct FFTWTraits< std::complex > { + typedef fftwf_plan Plan; + typedef FourierTraits< std::complex >::ElementX ElementX; + typedef FourierTraits< std::complex >::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwf_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_FORWARD, flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwf_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_BACKWARD,flags); + } + static inline void destroy(Plan p) { fftwf_destroy_plan(p); } + static inline void execute(Plan p) { fftwf_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftwf_malloc(sizeof(ElementX)*n) + ), + fftwf_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftwf_malloc(sizeof(ElementK)*n) + ), + fftwf_free + ); + } + }; + + template <> struct FFTWTraits { + BOOST_STATIC_ASSERT((!boost::is_const::value)); + typedef fftw_plan Plan; + typedef FourierTraits::ElementX ElementX; + typedef FourierTraits::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftw_plan_many_dft_r2c(rank, n, howmany, + in, inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftw_plan_many_dft_c2r(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + out, onembed, ostride, odist, + flags); + } + static inline void destroy(Plan p) { fftw_destroy_plan(p); } + static inline void execute(Plan p) { fftw_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftw_malloc(sizeof(ElementX)*n) + ), + fftw_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftw_malloc(sizeof(ElementK)*n) + ), + fftw_free + ); + } + }; + template <> struct FFTWTraits< std::complex > { + typedef fftw_plan Plan; + typedef FourierTraits< std::complex >::ElementX ElementX; + typedef FourierTraits< std::complex >::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftw_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_FORWARD, flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftw_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_BACKWARD,flags); + } + static inline void destroy(Plan p) { fftw_destroy_plan(p); } + static inline void execute(Plan p) { fftw_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftw_malloc(sizeof(ElementX)*n) + ), + fftw_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftw_malloc(sizeof(ElementK)*n) + ), + fftw_free + ); + } + }; +#ifndef NDARRAY_FFT_NO_LONG_DOUBLE + + template <> struct FFTWTraits { + BOOST_STATIC_ASSERT((!boost::is_const::value)); + typedef fftwl_plan Plan; + typedef FourierTraits::ElementX ElementX; + typedef FourierTraits::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwl_plan_many_dft_r2c(rank, n, howmany, + in, inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwl_plan_many_dft_c2r(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + out, onembed, ostride, odist, + flags); + } + static inline void destroy(Plan p) { fftwl_destroy_plan(p); } + static inline void execute(Plan p) { fftwl_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftwl_malloc(sizeof(ElementX)*n) + ), + fftwl_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftwl_malloc(sizeof(ElementK)*n) + ), + fftwl_free + ); + } + }; + template <> struct FFTWTraits< std::complex > { + typedef fftwl_plan Plan; + typedef FourierTraits< std::complex >::ElementX ElementX; + typedef FourierTraits< std::complex >::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwl_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_FORWARD, flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwl_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_BACKWARD,flags); + } + static inline void destroy(Plan p) { fftwl_destroy_plan(p); } + static inline void execute(Plan p) { fftwl_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftwl_malloc(sizeof(ElementX)*n) + ), + fftwl_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftwl_malloc(sizeof(ElementK)*n) + ), + fftwl_free + ); + } + }; +#endif +/// \endcond + +} // namespace detail +/// \endcond +} // namespace ndarray + +#endif // !NDARRAY_FFT_FFTWTraits_h_INCLUDED diff --git a/include/ndarray/fft/FFTWTraits.h.m4 b/include/ndarray/fft/FFTWTraits.h.m4 deleted file mode 100644 index 5440673d..00000000 --- a/include/ndarray/fft/FFTWTraits.h.m4 +++ /dev/null @@ -1,143 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -changecom(`###')dnl -define(`FFTW_TRAITS', -` - template <> struct FFTWTraits<$1> { - BOOST_STATIC_ASSERT((!boost::is_const<$1>::value)); - typedef $2_plan Plan; - typedef FourierTraits<$1>::ElementX ElementX; - typedef FourierTraits<$1>::ElementK ElementK; - typedef boost::shared_ptr OwnerX; - typedef boost::shared_ptr OwnerK; - static inline Plan forward(int rank, const int *n, int howmany, - ElementX *in, const int *inembed, int istride, int idist, - ElementK *out, const int *onembed, int ostride, int odist, - unsigned flags) { - return $2_plan_many_dft_r2c(rank, n, howmany, - in, inembed, istride, idist, - reinterpret_cast<$2_complex*>(out), - onembed, ostride, odist, - flags); - } - static inline Plan inverse(int rank, const int *n, int howmany, - ElementK *in, const int *inembed, int istride, int idist, - ElementX *out, const int *onembed, int ostride, int odist, - unsigned flags) { - return $2_plan_many_dft_c2r(rank, n, howmany, - reinterpret_cast<$2_complex*>(in), - inembed, istride, idist, - out, onembed, ostride, odist, - flags); - } - static inline void destroy(Plan p) { $2_destroy_plan(p); } - static inline void execute(Plan p) { $2_execute(p); } - static inline OwnerX allocateX(int n) { - return OwnerX( - reinterpret_cast( - $2_malloc(sizeof(ElementX)*n) - ), - $2_free - ); - } - static inline OwnerK allocateK(int n) { - return OwnerK( - reinterpret_cast( - $2_malloc(sizeof(ElementK)*n) - ), - $2_free - ); - } - }; - template <> struct FFTWTraits< std::complex<$1> > { - typedef $2_plan Plan; - typedef FourierTraits< std::complex<$1> >::ElementX ElementX; - typedef FourierTraits< std::complex<$1> >::ElementK ElementK; - typedef boost::shared_ptr OwnerX; - typedef boost::shared_ptr OwnerK; - static inline Plan forward(int rank, const int *n, int howmany, - ElementX *in, const int *inembed, int istride, int idist, - ElementK *out, const int *onembed, int ostride, int odist, - unsigned flags) { - return $2_plan_many_dft(rank, n, howmany, - reinterpret_cast<$2_complex*>(in), - inembed, istride, idist, - reinterpret_cast<$2_complex*>(out), - onembed, ostride, odist, - FFTW_FORWARD, flags); - } - static inline Plan inverse(int rank, const int *n, int howmany, - ElementK *in, const int *inembed, int istride, int idist, - ElementX *out, const int *onembed, int ostride, int odist, - unsigned flags) { - return $2_plan_many_dft(rank, n, howmany, - reinterpret_cast<$2_complex*>(in), - inembed, istride, idist, - reinterpret_cast<$2_complex*>(out), - onembed, ostride, odist, - FFTW_BACKWARD,flags); - } - static inline void destroy(Plan p) { $2_destroy_plan(p); } - static inline void execute(Plan p) { $2_execute(p); } - static inline OwnerX allocateX(int n) { - return OwnerX( - reinterpret_cast( - $2_malloc(sizeof(ElementX)*n) - ), - $2_free - ); - } - static inline OwnerK allocateK(int n) { - return OwnerK( - reinterpret_cast( - $2_malloc(sizeof(ElementK)*n) - ), - $2_free - ); - } - }')dnl -#ifndef NDARRAY_FFT_FFTWTraits_h_INCLUDED -#define NDARRAY_FFT_FFTWTraits_h_INCLUDED - -/** - * @file ndarray/fft/FFTWTraits.h - * - * \brief Traits classes that wrap FFTW in a template-friendly interface. - */ - -#include -#include -#include "ndarray/fft/FourierTraits.h" - -namespace ndarray { -/// \cond INTERNAL -namespace detail { - -/** - * \internal \ingroup FFTInternalGroup - * \brief A traits class that maps C++ template types to FFTW types and wraps FFTW function calls. - */ -template struct FFTWTraits { BOOST_STATIC_ASSERT(sizeof(T) < 0); }; - -/// \cond SPECIALIZATIONS -FFTW_TRAITS(float,fftwf); -FFTW_TRAITS(double,fftw); -#ifndef NDARRAY_FFT_NO_LONG_DOUBLE -FFTW_TRAITS(long double, fftwl); -#endif -/// \endcond - -} // namespace detail -/// \endcond -} // namespace ndarray - -#endif // !NDARRAY_FFT_FFTWTraits_h_INCLUDED diff --git a/include/ndarray/operators.h b/include/ndarray/operators.h new file mode 100644 index 00000000..9d671444 --- /dev/null +++ b/include/ndarray/operators.h @@ -0,0 +1,1261 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2012, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ + +#ifndef NDARRAY_operators_h_INCLUDED +#define NDARRAY_operators_h_INCLUDED + +/** + * \file ndarray/operators.h \brief Arithmetic and logical operators for Array. + */ + +#include "ndarray/Array.h" +#include +#include +#include + +#include "ndarray/detail/UnaryOp.h" +#include "ndarray/detail/BinaryOp.h" +#include "ndarray/types.h" + +namespace ndarray { + +/// \cond INTERNAL +namespace detail { + +/** + * \internal @class PromotingBinaryFunction + * \brief A typedef-providing base class for binary functors with numeric type promotion. + * + * \ingroup InternalGroup + */ +template +struct PromotingBinaryFunction { + typedef A ElementA; + typedef B ElementB; + typedef A first_argument_type; + typedef B second_argument_type; + typedef typename boost::call_traits::param_type ParamA; + typedef typename boost::call_traits::param_type ParamB; + typedef typename Promote::Type result_type; +}; + +/** + * \internal @class BinaryPredicate + * \brief A typedef-providing base class for binary predicates. + * + * \ingroup InternalGroup + */ +template +struct BinaryPredicate { + typedef A ElementA; + typedef B ElementB; + typedef A first_argument_type; + typedef B second_argument_type; + typedef typename boost::call_traits::param_type ParamA; + typedef typename boost::call_traits::param_type ParamB; + typedef bool result_type; +}; + +/** + * \internal @class AdaptableFunctionTag + * \brief A CRTP base class for non-template classes that contain a templated functor. + * + * \ingroup InternalGroup + */ +template +struct AdaptableFunctionTag { + + template + struct ScalarExpr { + typedef typename Derived::template ScalarFunction< + A, typename ExpressionTraits::Element + > BinaryFunction; + typedef boost::binder1st Bound; + static Bound bind(A const & scalar) { + return Bound(BinaryFunction(),scalar); + } + }; + + template + struct ExprScalar { + typedef typename Derived::template ScalarFunction< + typename ExpressionTraits::Element, B + > BinaryFunction; + typedef boost::binder2nd Bound; + static Bound bind(B const & scalar) { + return Bound(BinaryFunction(),scalar); + } + }; + + template + struct ExprExpr { + typedef typename Derived::template ScalarFunction< + typename ExpressionTraits::Element, + typename ExpressionTraits::Element + > BinaryFunction; + }; + +}; + +/** + * \internal @class BitwiseNot + * \ingroup InternalGroup + * \brief An STL Unary Function class for bitwise NOT (unary ~). + */ +template +struct BitwiseNot { + typedef T argument_type; + typedef T result_type; + + result_type operator()(argument_type arg) const { return ~arg; } +}; + + + struct PlusTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a + b; + } + }; + }; + + struct MinusTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a - b; + } + }; + }; + + struct MultipliesTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a * b; + } + }; + }; + + struct DividesTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a / b; + } + }; + }; + + struct ModulusTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a % b; + } + }; + }; + + struct BitwiseXorTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a ^ b; + } + }; + }; + + struct BitwiseOrTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a | b; + } + }; + }; + + struct BitwiseAndTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a & b; + } + }; + }; + + struct BitwiseLeftShiftTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a << b; + } + }; + }; + + struct BitwiseRightShiftTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a >> b; + } + }; + }; + + + struct EqualToTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a == b; + } + }; + }; + + struct NotEqualToTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a != b; + } + }; + }; + + struct LessTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a < b; + } + }; + }; + + struct GreaterTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a > b; + } + }; + }; + + struct LessEqualTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a <= b; + } + }; + }; + + struct GreaterEqualTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a >= b; + } + }; + }; + + struct LogicalAnd : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a && b; + } + }; + }; + + struct LogicalOr : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a || b; + } + }; + }; + +} // namespace detail +/// \endcond + +/// \addtogroup ndarrayOpGroup +/// @{ + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::PlusTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator+(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::PlusTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::PlusTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator+(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::PlusTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::PlusTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator+(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::PlusTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::MinusTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator-(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::MinusTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::MinusTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator-(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::MinusTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::MinusTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator-(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::MinusTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::MultipliesTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator*(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::MultipliesTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::MultipliesTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator*(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::MultipliesTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::MultipliesTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator*(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::MultipliesTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::DividesTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator/(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::DividesTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::DividesTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator/(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::DividesTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::DividesTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator/(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::DividesTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::ModulusTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator%(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::ModulusTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::ModulusTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator%(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::ModulusTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::ModulusTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator%(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::ModulusTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseXorTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator^(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::BitwiseXorTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseXorTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator^(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::BitwiseXorTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::BitwiseXorTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator^(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::BitwiseXorTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseOrTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator|(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::BitwiseOrTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseOrTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator|(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::BitwiseOrTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::BitwiseOrTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator|(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::BitwiseOrTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseAndTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator&(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::BitwiseAndTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseAndTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator&(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::BitwiseAndTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::BitwiseAndTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator&(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::BitwiseAndTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseLeftShiftTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator<<(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::BitwiseLeftShiftTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseLeftShiftTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator<<(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::BitwiseLeftShiftTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::BitwiseLeftShiftTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator<<(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::BitwiseLeftShiftTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseRightShiftTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator>>(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::BitwiseRightShiftTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseRightShiftTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator>>(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::BitwiseRightShiftTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::BitwiseRightShiftTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator>>(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::BitwiseRightShiftTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::EqualToTag::template ExprScalar::Bound > + >::type +#else + +#endif + equal(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::EqualToTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::EqualToTag::template ScalarExpr::Bound > + >::type +#else + +#endif + equal(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::EqualToTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::EqualToTag::template ExprExpr::BinaryFunction + > +#else + +#endif + equal(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::EqualToTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::NotEqualToTag::template ExprScalar::Bound > + >::type +#else + +#endif + not_equal(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::NotEqualToTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::NotEqualToTag::template ScalarExpr::Bound > + >::type +#else + +#endif + not_equal(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::NotEqualToTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::NotEqualToTag::template ExprExpr::BinaryFunction + > +#else + +#endif + not_equal(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::NotEqualToTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LessTag::template ExprScalar::Bound > + >::type +#else + +#endif + less(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::LessTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LessTag::template ScalarExpr::Bound > + >::type +#else + +#endif + less(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::LessTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::LessTag::template ExprExpr::BinaryFunction + > +#else + +#endif + less(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::LessTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::GreaterTag::template ExprScalar::Bound > + >::type +#else + +#endif + greater(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::GreaterTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::GreaterTag::template ScalarExpr::Bound > + >::type +#else + +#endif + greater(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::GreaterTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::GreaterTag::template ExprExpr::BinaryFunction + > +#else + +#endif + greater(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::GreaterTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LessEqualTag::template ExprScalar::Bound > + >::type +#else + +#endif + less_equal(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::LessEqualTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LessEqualTag::template ScalarExpr::Bound > + >::type +#else + +#endif + less_equal(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::LessEqualTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::LessEqualTag::template ExprExpr::BinaryFunction + > +#else + +#endif + less_equal(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::LessEqualTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::GreaterEqualTag::template ExprScalar::Bound > + >::type +#else + +#endif + great_equal(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::GreaterEqualTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::GreaterEqualTag::template ScalarExpr::Bound > + >::type +#else + +#endif + great_equal(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::GreaterEqualTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::GreaterEqualTag::template ExprExpr::BinaryFunction + > +#else + +#endif + great_equal(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::GreaterEqualTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LogicalAnd::template ExprScalar::Bound > + >::type +#else + +#endif + logical_and(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::LogicalAnd::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LogicalAnd::template ScalarExpr::Bound > + >::type +#else + +#endif + logical_and(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::LogicalAnd::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::LogicalAnd::template ExprExpr::BinaryFunction + > +#else + +#endif + logical_and(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::LogicalAnd::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LogicalOr::template ExprScalar::Bound > + >::type +#else + +#endif + logical_or(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::LogicalOr::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LogicalOr::template ScalarExpr::Bound > + >::type +#else + +#endif + logical_or(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::LogicalOr::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::LogicalOr::template ExprExpr::BinaryFunction + > +#else + +#endif + logical_or(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::LogicalOr::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + + template +#ifndef DOXYGEN + detail::UnaryOpExpression< Operand, std::negate::Element> > +#else + +#endif + operator-(ExpressionBase const & operand) { + return vectorize(std::negate::Element>(),operand); + } + + template +#ifndef DOXYGEN + detail::UnaryOpExpression< Operand, std::logical_not::Element> > +#else + +#endif + logical_not(ExpressionBase const & operand) { + return vectorize(std::logical_not::Element>(),operand); + } + + template +#ifndef DOXYGEN + detail::UnaryOpExpression< Operand, detail::BitwiseNot::Element> > +#else + +#endif + operator~(ExpressionBase const & operand) { + return vectorize(detail::BitwiseNot::Element>(),operand); + } +/// @} + +template +inline typename boost::enable_if::IsScalar, bool>::type +any(Scalar const & scalar) { + return bool(scalar); +} + +/** + * \brief Return true if any of the elements of the given expression are true. + * + * \ingroup MainGroup + */ +template +inline bool +any(ExpressionBase const & expr) { + typename Derived::Iterator const i_end = expr.end(); + for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { + if (any(*i)) return true; + } + return false; +} + +template +inline typename boost::enable_if::IsScalar, bool>::type +all(Scalar const & scalar) { + return bool(scalar); +} + +/** + * \brief Return true if all of the elements of the given expression are true. + * + * \ingroup MainGroup + */ +template +inline bool +all(ExpressionBase const & expr) { + typename Derived::Iterator const i_end = expr.end(); + for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { + if (!all(*i)) return false; + } + return true; +} + +template +inline typename boost::enable_if< + boost::mpl::and_< + typename ExpressionTraits::IsScalar, + typename ExpressionTraits::IsScalar + >, + bool +>::type +allclose(Scalar1 const & scalar1, Scalar2 const & scalar2, double tol=1E-8) { + ApproximatelyEqual func(tol); + return func(scalar1, scalar2); +} + +template +inline typename boost::enable_if::IsScalar,bool>::type +allclose(Scalar const & scalar, ExpressionBase const & expr, double tol=1E-8) { + ApproximatelyEqual func(tol); + typename Derived::Iterator const i_end = expr.end(); + for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { + if (!allclose(scalar, *i, tol)) return false; + } + return true; +} + +template +inline typename boost::enable_if::IsScalar,bool>::type +allclose(ExpressionBase const & expr, Scalar const & scalar, double tol=1E-8) { + return allclose(scalar, expr, tol); +} + +template +inline bool +allclose(ExpressionBase const & expr1, ExpressionBase const & expr2, double tol=1E-8) { + typename Derived1::Iterator const i_end = expr1.end(); + typename Derived1::Iterator i = expr1.begin(); + typename Derived2::Iterator j = expr2.begin(); + for (; i != i_end; ++i, ++j) { + if (!allclose(*i, *j, tol)) return false; + } + return true; +} + + +template +inline typename boost::enable_if::IsScalar, Scalar>::type +sum(Scalar const & scalar) { return scalar; } + + +/** + * \brief Return the sum of all elements of the given expression. + * + * \ingroup MainGroup + */ +template +inline typename Derived::Element +sum(ExpressionBase const & expr) { + typename Derived::Iterator const i_end = expr.end(); + typename Derived::Element total = static_cast(0); + for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { + total += sum(*i); + } + return total; +} + + +} // namespace ndarray + +#endif // !NDARRAY_operators_h_INCLUDED diff --git a/include/ndarray/operators.h.m4 b/include/ndarray/operators.h.m4 deleted file mode 100644 index 0525c894..00000000 --- a/include/ndarray/operators.h.m4 +++ /dev/null @@ -1,349 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -changecom(`###')dnl -define(`FUNCTION_TAG', -` - struct $1 : public AdaptableFunctionTag<$1> { - template - struct ScalarFunction : public $2 { - typename $2::result_type operator()( - typename $2::ParamA a, - typename $2::ParamB b - ) const { - return a $3 b; - } - }; - };')dnl -define(`BINARY_OP', -` - template -#ifndef DOXYGEN - typename boost::enable_if< - typename ExpressionTraits::IsScalar, - detail::UnaryOpExpression< Operand, typename $1::template ExprScalar::Bound > - >::type -#else - -#endif - $2(ExpressionBase const & operand, Scalar const & scalar) { - return vectorize($1::template ExprScalar::bind(scalar),operand); - } - - template -#ifndef DOXYGEN - typename boost::enable_if< - typename ExpressionTraits::IsScalar, - detail::UnaryOpExpression< Operand, typename $1::template ScalarExpr::Bound > - >::type -#else - -#endif - $2(Scalar const & scalar, ExpressionBase const & operand) { - return vectorize($1::template ScalarExpr::bind(scalar),operand); - } - - template -#ifndef DOXYGEN - detail::BinaryOpExpression< - Operand1, Operand2, - typename $1::template ExprExpr::BinaryFunction - > -#else - -#endif - $2(ExpressionBase const & operand1, ExpressionBase const & operand2) { - return vectorize( - typename $1::template ExprExpr::BinaryFunction(), - operand1, - operand2 - ); - }')dnl -define(`UNARY_OP', -` - template -#ifndef DOXYGEN - detail::UnaryOpExpression< Operand, $1::Element> > -#else - -#endif - $2(ExpressionBase const & operand) { - return vectorize($1::Element>(),operand); - }')dnl -#ifndef NDARRAY_operators_h_INCLUDED -#define NDARRAY_operators_h_INCLUDED - -/** - * \file ndarray/operators.h \brief Arithmetic and logical operators for Array. - */ - -#include "ndarray/Array.h" -#include -#include -#include - -#include "ndarray/detail/UnaryOp.h" -#include "ndarray/detail/BinaryOp.h" -#include "ndarray/types.h" - -namespace ndarray { - -/// \cond INTERNAL -namespace detail { - -/** - * \internal @class PromotingBinaryFunction - * \brief A typedef-providing base class for binary functors with numeric type promotion. - * - * \ingroup InternalGroup - */ -template -struct PromotingBinaryFunction { - typedef A ElementA; - typedef B ElementB; - typedef A first_argument_type; - typedef B second_argument_type; - typedef typename boost::call_traits::param_type ParamA; - typedef typename boost::call_traits::param_type ParamB; - typedef typename Promote::Type result_type; -}; - -/** - * \internal @class BinaryPredicate - * \brief A typedef-providing base class for binary predicates. - * - * \ingroup InternalGroup - */ -template -struct BinaryPredicate { - typedef A ElementA; - typedef B ElementB; - typedef A first_argument_type; - typedef B second_argument_type; - typedef typename boost::call_traits::param_type ParamA; - typedef typename boost::call_traits::param_type ParamB; - typedef bool result_type; -}; - -/** - * \internal @class AdaptableFunctionTag - * \brief A CRTP base class for non-template classes that contain a templated functor. - * - * \ingroup InternalGroup - */ -template -struct AdaptableFunctionTag { - - template - struct ScalarExpr { - typedef typename Derived::template ScalarFunction< - A, typename ExpressionTraits::Element - > BinaryFunction; - typedef boost::binder1st Bound; - static Bound bind(A const & scalar) { - return Bound(BinaryFunction(),scalar); - } - }; - - template - struct ExprScalar { - typedef typename Derived::template ScalarFunction< - typename ExpressionTraits::Element, B - > BinaryFunction; - typedef boost::binder2nd Bound; - static Bound bind(B const & scalar) { - return Bound(BinaryFunction(),scalar); - } - }; - - template - struct ExprExpr { - typedef typename Derived::template ScalarFunction< - typename ExpressionTraits::Element, - typename ExpressionTraits::Element - > BinaryFunction; - }; - -}; - -/** - * \internal @class BitwiseNot - * \ingroup InternalGroup - * \brief An STL Unary Function class for bitwise NOT (unary ~). - */ -template -struct BitwiseNot { - typedef T argument_type; - typedef T result_type; - - result_type operator()(argument_type arg) const { return ~arg; } -}; - -FUNCTION_TAG(PlusTag,PromotingBinaryFunction,+) -FUNCTION_TAG(MinusTag,PromotingBinaryFunction,-) -FUNCTION_TAG(MultipliesTag,PromotingBinaryFunction,*) -FUNCTION_TAG(DividesTag,PromotingBinaryFunction,/) -FUNCTION_TAG(ModulusTag,PromotingBinaryFunction,%) -FUNCTION_TAG(BitwiseXorTag,PromotingBinaryFunction,^) -FUNCTION_TAG(BitwiseOrTag,PromotingBinaryFunction,|) -FUNCTION_TAG(BitwiseAndTag,PromotingBinaryFunction,&) -FUNCTION_TAG(BitwiseLeftShiftTag,PromotingBinaryFunction,<<) -FUNCTION_TAG(BitwiseRightShiftTag,PromotingBinaryFunction,>>) - -FUNCTION_TAG(EqualToTag,BinaryPredicate,==) -FUNCTION_TAG(NotEqualToTag,BinaryPredicate,!=) -FUNCTION_TAG(LessTag,BinaryPredicate,<) -FUNCTION_TAG(GreaterTag,BinaryPredicate,>) -FUNCTION_TAG(LessEqualTag,BinaryPredicate,<=) -FUNCTION_TAG(GreaterEqualTag,BinaryPredicate,>=) -FUNCTION_TAG(LogicalAnd,BinaryPredicate,&&) -FUNCTION_TAG(LogicalOr,BinaryPredicate,||) - -} // namespace detail -/// \endcond - -/// \addtogroup ndarrayOpGroup -/// @{ -BINARY_OP(detail::PlusTag,operator+) -BINARY_OP(detail::MinusTag,operator-) -BINARY_OP(detail::MultipliesTag,operator*) -BINARY_OP(detail::DividesTag,operator/) -BINARY_OP(detail::ModulusTag,operator%) -BINARY_OP(detail::BitwiseXorTag,operator^) -BINARY_OP(detail::BitwiseOrTag,operator|) -BINARY_OP(detail::BitwiseAndTag,operator&) -BINARY_OP(detail::BitwiseLeftShiftTag,operator<<) -BINARY_OP(detail::BitwiseRightShiftTag,operator>>) - -BINARY_OP(detail::EqualToTag, equal) -BINARY_OP(detail::NotEqualToTag, not_equal) -BINARY_OP(detail::LessTag, less) -BINARY_OP(detail::GreaterTag, greater) -BINARY_OP(detail::LessEqualTag, less_equal) -BINARY_OP(detail::GreaterEqualTag, great_equal) -BINARY_OP(detail::LogicalAnd, logical_and) -BINARY_OP(detail::LogicalOr, logical_or) - -UNARY_OP(std::negate,operator-) -UNARY_OP(std::logical_not, logical_not) -UNARY_OP(detail::BitwiseNot,operator~) -/// @} - -template -inline typename boost::enable_if::IsScalar, bool>::type -any(Scalar const & scalar) { - return bool(scalar); -} - -/** - * \brief Return true if any of the elements of the given expression are true. - * - * \ingroup MainGroup - */ -template -inline bool -any(ExpressionBase const & expr) { - typename Derived::Iterator const i_end = expr.end(); - for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { - if (any(*i)) return true; - } - return false; -} - -template -inline typename boost::enable_if::IsScalar, bool>::type -all(Scalar const & scalar) { - return bool(scalar); -} - -/** - * \brief Return true if all of the elements of the given expression are true. - * - * \ingroup MainGroup - */ -template -inline bool -all(ExpressionBase const & expr) { - typename Derived::Iterator const i_end = expr.end(); - for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { - if (!all(*i)) return false; - } - return true; -} - -template -inline typename boost::enable_if< - boost::mpl::and_< - typename ExpressionTraits::IsScalar, - typename ExpressionTraits::IsScalar - >, - bool ->::type -allclose(Scalar1 const & scalar1, Scalar2 const & scalar2, double tol=1E-8) { - ApproximatelyEqual func(tol); - return func(scalar1, scalar2); -} - -template -inline typename boost::enable_if::IsScalar,bool>::type -allclose(Scalar const & scalar, ExpressionBase const & expr, double tol=1E-8) { - ApproximatelyEqual func(tol); - typename Derived::Iterator const i_end = expr.end(); - for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { - if (!allclose(scalar, *i, tol)) return false; - } - return true; -} - -template -inline typename boost::enable_if::IsScalar,bool>::type -allclose(ExpressionBase const & expr, Scalar const & scalar, double tol=1E-8) { - return allclose(scalar, expr, tol); -} - -template -inline bool -allclose(ExpressionBase const & expr1, ExpressionBase const & expr2, double tol=1E-8) { - typename Derived1::Iterator const i_end = expr1.end(); - typename Derived1::Iterator i = expr1.begin(); - typename Derived2::Iterator j = expr2.begin(); - for (; i != i_end; ++i, ++j) { - if (!allclose(*i, *j, tol)) return false; - } - return true; -} - - -template -inline typename boost::enable_if::IsScalar, Scalar>::type -sum(Scalar const & scalar) { return scalar; } - - -/** - * \brief Return the sum of all elements of the given expression. - * - * \ingroup MainGroup - */ -template -inline typename Derived::Element -sum(ExpressionBase const & expr) { - typename Derived::Iterator const i_end = expr.end(); - typename Derived::Element total = static_cast(0); - for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { - total += sum(*i); - } - return total; -} - - -} // namespace ndarray - -#endif // !NDARRAY_operators_h_INCLUDED diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 1f78168c..43c383ce 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -16,12 +16,12 @@ include_directories( ) add_executable(ndarray ndarray.cc) -add_dependencies(ndarray preprocess_includes2) + target_link_libraries(ndarray ${Boost_LIBRARIES}) add_test(test_ndarray ndarray) add_executable(views views.cc) -add_dependencies(views preprocess_includes2) + target_link_libraries(views ${Boost_LIBRARIES}) add_test(test_views views) @@ -33,7 +33,7 @@ if(NDARRAY_EIGEN) include_directories( ${EIGEN3_INCLUDE_DIR} ) add_executable(ndarray-eigen ndarray-eigen.cc) - add_dependencies(ndarray-eigen preprocess_includes2) + target_link_libraries(ndarray-eigen ${Boost_LIBRARIES}) add_test(test_ndarray_eigen ndarray-eigen) endif(NDARRAY_EIGEN) @@ -44,7 +44,7 @@ if(NDARRAY_FFTW) include_directories( ${FFTW_INCLUDES} ) add_executable(ndarray-fft ndarray-fft.cc) - add_dependencies(ndarray-fft preprocess_includes2) + target_link_libraries(ndarray-fft ${Boost_LIBRARIES} ${FFTW_LIBRARIES}) add_test(test_ndarray-fft ndarray-fft) endif(NDARRAY_FFTW) @@ -69,7 +69,7 @@ if(NDARRAY_PYBIND11) include_directories(${PYBIND11_INCLUDE_DIR}) pybind11_add_module(pybind11_test_mod pybind11_test_mod.cc) - add_dependencies(pybind11_test_mod preprocess_includes2) + configure_file(pybind11_test.py pybind11_test.py COPYONLY) add_test(NAME pybind11_test From d151f9fadf75775d58bbbbb18a1450eec5c0cf35 Mon Sep 17 00:00:00 2001 From: Matthias Wittgen Date: Mon, 11 Jan 2021 15:40:36 -0500 Subject: [PATCH 47/69] use modern cmake; clean up doxygen generation fix numpy detection --- .gitignore | 20 - CMakeLists.txt | 27 +- cmake/FindEigen3.cmake | 83 -- cmake/FindFFTW.cmake | 124 -- cmake/FindNumPy.cmake | 90 -- cmake/FindPythonInterp.cmake | 165 --- cmake/FindPythonLibs.cmake | 354 ------ doc/CMakeLists.txt | 7 + doc/doxygen.conf.in | 2280 ++++++++++++++++++++++++++++++++++ doxygen.conf.in | 2280 ---------------------------------- include/CMakeLists.txt | 19 + tests/CMakeLists.txt | 46 +- 12 files changed, 2328 insertions(+), 3167 deletions(-) delete mode 100644 cmake/FindEigen3.cmake delete mode 100644 cmake/FindFFTW.cmake delete mode 100644 cmake/FindNumPy.cmake delete mode 100644 cmake/FindPythonInterp.cmake delete mode 100644 cmake/FindPythonLibs.cmake create mode 100644 doc/CMakeLists.txt delete mode 100644 doxygen.conf.in create mode 100644 include/CMakeLists.txt diff --git a/.gitignore b/.gitignore index 51eb3e96..567609b1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,21 +1 @@ -.sconsign.dblite -config.log -.sconf_temp -*.dylib -*.o -*.os -*.so -*.cfgc -*.pyc -*_wrap.cc -doc/html -doc/*.tag -doc/*.inc -doc/doxygen.conf -tests/.tests -tests/*.test -version.py -tests/ndarray -tests/ndarray-eigen -tests/ndarray-fft build/ diff --git a/CMakeLists.txt b/CMakeLists.txt index 7031c7d4..60ca1684 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,6 +1,6 @@ -cmake_minimum_required(VERSION 2.8.11) - -project(ndarray) +cmake_minimum_required(VERSION 3.1 ) +project(ndarray LANGUAGES CXX) +set (CMAKE_CXX_STANDARD 11) # Build is split into two broad passes: # (1) Generation, which performs macro-expansion and header installation. @@ -14,29 +14,17 @@ project(ndarray) # The test phase may rely on external libraries, which are enabled via the # options below. Library resolution is deferred to tests/CMakeLists.txt and # only executed if NDARRAY_TEST is enabled. + option(NDARRAY_TEST "Enable tests?" ON) option(NDARRAY_EIGEN "Enable Eigen tests?" ON) option(NDARRAY_FFTW "Enable FFTW tests?" ON) option(NDARRAY_PYBIND11 "Enable Pybind11 tests?" OFF) -# enable C++11 support -add_definitions(-std=c++11) - -# put our local cmake find scripts at the beginning of the cmake -# module search path -set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH}) - +add_subdirectory(include) -# add a target to generate API documentation with Doxygen find_package(Doxygen) if(DOXYGEN_FOUND) - configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.conf.in - ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf @ONLY) - add_custom_target(doc ${DOXYGEN_EXECUTABLE} - ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} - COMMENT "Running Doxygen" VERBATIM -) + add_subdirectory(doc) endif(DOXYGEN_FOUND) if(NDARRAY_TEST) @@ -44,6 +32,3 @@ if(NDARRAY_TEST) add_subdirectory(tests) endif(NDARRAY_TEST) -# installation -install(DIRECTORY include/ DESTINATION include/ - FILES_MATCHING PATTERN "*.h") diff --git a/cmake/FindEigen3.cmake b/cmake/FindEigen3.cmake deleted file mode 100644 index 225d1d56..00000000 --- a/cmake/FindEigen3.cmake +++ /dev/null @@ -1,83 +0,0 @@ -# - Try to find Eigen3 lib -# -# This module supports requiring a minimum version, e.g. you can do -# find_package(Eigen3 3.1.2) -# to require version 3.1.2 or newer of Eigen3. -# -# Once done this will define -# -# EIGEN3_FOUND - system has eigen lib with correct version -# EIGEN3_INCLUDE_DIR - the eigen include directory -# EIGEN3_VERSION - eigen version - -# Copyright (c) 2006, 2007 Montel Laurent, -# Copyright (c) 2008, 2009 Gael Guennebaud, -# Copyright (c) 2009 Benoit Jacob -# Redistribution and use is allowed according to the terms of the 2-clause BSD license. - -if(NOT Eigen3_FIND_VERSION) - if(NOT Eigen3_FIND_VERSION_MAJOR) - set(Eigen3_FIND_VERSION_MAJOR 2) - endif(NOT Eigen3_FIND_VERSION_MAJOR) - if(NOT Eigen3_FIND_VERSION_MINOR) - set(Eigen3_FIND_VERSION_MINOR 91) - endif(NOT Eigen3_FIND_VERSION_MINOR) - if(NOT Eigen3_FIND_VERSION_PATCH) - set(Eigen3_FIND_VERSION_PATCH 0) - endif(NOT Eigen3_FIND_VERSION_PATCH) - - set(Eigen3_FIND_VERSION "${Eigen3_FIND_VERSION_MAJOR}.${Eigen3_FIND_VERSION_MINOR}.${Eigen3_FIND_VERSION_PATCH}") -endif(NOT Eigen3_FIND_VERSION) - -macro(_eigen3_check_version) - file(READ "${EIGEN3_INCLUDE_DIR}/Eigen/src/Core/util/Macros.h" _eigen3_version_header) - - string(REGEX MATCH "define[ \t]+EIGEN_WORLD_VERSION[ \t]+([0-9]+)" _eigen3_world_version_match "${_eigen3_version_header}") - set(EIGEN3_WORLD_VERSION "${CMAKE_MATCH_1}") - string(REGEX MATCH "define[ \t]+EIGEN_MAJOR_VERSION[ \t]+([0-9]+)" _eigen3_major_version_match "${_eigen3_version_header}") - set(EIGEN3_MAJOR_VERSION "${CMAKE_MATCH_1}") - string(REGEX MATCH "define[ \t]+EIGEN_MINOR_VERSION[ \t]+([0-9]+)" _eigen3_minor_version_match "${_eigen3_version_header}") - set(EIGEN3_MINOR_VERSION "${CMAKE_MATCH_1}") - - set(EIGEN3_VERSION ${EIGEN3_WORLD_VERSION}.${EIGEN3_MAJOR_VERSION}.${EIGEN3_MINOR_VERSION}) - if(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) - set(EIGEN3_VERSION_OK FALSE) - else(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) - set(EIGEN3_VERSION_OK TRUE) - endif(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) - - if(NOT EIGEN3_VERSION_OK) - - message(STATUS "Eigen3 version ${EIGEN3_VERSION} found in ${EIGEN3_INCLUDE_DIR}, " - "but at least version ${Eigen3_FIND_VERSION} is required") - endif(NOT EIGEN3_VERSION_OK) -endmacro(_eigen3_check_version) - -if (EIGEN3_INCLUDE_DIR) - - # in cache already - _eigen3_check_version() - set(EIGEN3_FOUND ${EIGEN3_VERSION_OK}) - -else (EIGEN3_INCLUDE_DIR) - message(STATUS "Trying to find eigen in $ENV{EIGEN_DIR}") - - find_path(EIGEN3_INCLUDE_DIR NAMES signature_of_eigen3_matrix_library - PATHS - $ENV{EIGEN_DIR} - ${CMAKE_INSTALL_PREFIX}/include - ${KDE4_INCLUDE_DIR} - PATH_SUFFIXES eigen3 eigen include include/eigen3 include/eigen - ) - - if(EIGEN3_INCLUDE_DIR) - _eigen3_check_version() - endif(EIGEN3_INCLUDE_DIR) - - include(FindPackageHandleStandardArgs) - find_package_handle_standard_args(Eigen3 DEFAULT_MSG EIGEN3_INCLUDE_DIR EIGEN3_VERSION_OK) - - mark_as_advanced(EIGEN3_INCLUDE_DIR) - -endif(EIGEN3_INCLUDE_DIR) - diff --git a/cmake/FindFFTW.cmake b/cmake/FindFFTW.cmake deleted file mode 100644 index 48aed3e8..00000000 --- a/cmake/FindFFTW.cmake +++ /dev/null @@ -1,124 +0,0 @@ -# - Find the FFTW library -# -# Usage: -# find_package(FFTW [REQUIRED] [QUIET] ) -# -# It sets the following variables: -# FFTW_FOUND ... true if fftw is found on the system -# FFTW_LIBRARIES ... full path to fftw library -# FFTW_INCLUDES ... fftw include directory -# -# The following variables will be checked by the function -# FFTW_USE_STATIC_LIBS ... if true, only static libraries are found -# FFTW_ROOT ... if set, the libraries are exclusively searched -# under this path -# FFTW_LIBRARY ... fftw library to use -# FFTW_INCLUDE_DIR ... fftw include directory -# - -#If environment variable FFTWDIR is specified, it has same effect as FFTW_ROOT -if( NOT FFTW_ROOT AND ENV{FFTWDIR} ) - set( FFTW_ROOT $ENV{FFTWDIR} ) -endif() - -#Add FFTW_DIR support to mirror other dependencies -if( NOT FFTW_ROOT AND ENV{FFTW_DIR} ) - set( FFTW_ROOT $ENV{FFTW_DIR} ) -endif() - -# Check if we can use PkgConfig -find_package(PkgConfig) - -#Determine from PKG -if( PKG_CONFIG_FOUND AND NOT FFTW_ROOT ) - pkg_check_modules( PKG_FFTW QUIET "fftw3" ) -endif() - -#Check whether to search static or dynamic libs -set( CMAKE_FIND_LIBRARY_SUFFIXES_SAV ${CMAKE_FIND_LIBRARY_SUFFIXES} ) - -if( ${FFTW_USE_STATIC_LIBS} ) - set( CMAKE_FIND_LIBRARY_SUFFIXES ${CMAKE_STATIC_LIBRARY_SUFFIX} ) -else() - set( CMAKE_FIND_LIBRARY_SUFFIXES ${CMAKE_SHARED_LIBRARY_SUFFIX} ) -endif() - -if( FFTW_ROOT ) - - #find libs - find_library( - FFTW_LIB - NAMES "fftw3" - PATHS ${FFTW_ROOT} - PATH_SUFFIXES "lib" "lib64" - NO_DEFAULT_PATH - ) - - find_library( - FFTWF_LIB - NAMES "fftw3f" - PATHS ${FFTW_ROOT} - PATH_SUFFIXES "lib" "lib64" - NO_DEFAULT_PATH - ) - - find_library( - FFTWL_LIB - NAMES "fftw3l" - PATHS ${FFTW_ROOT} - PATH_SUFFIXES "lib" "lib64" - NO_DEFAULT_PATH - ) - - #find includes - find_path( - FFTW_INCLUDES - NAMES "fftw3.h" - PATHS ${FFTW_ROOT} - PATH_SUFFIXES "include" - NO_DEFAULT_PATH - ) - -else() - - find_library( - FFTW_LIB - NAMES "fftw3" - PATHS ${PKG_FFTW_LIBRARY_DIRS} ${LIB_INSTALL_DIR} - ) - - find_library( - FFTWF_LIB - NAMES "fftw3f" - PATHS ${PKG_FFTW_LIBRARY_DIRS} ${LIB_INSTALL_DIR} - ) - - - find_library( - FFTWL_LIB - NAMES "fftw3l" - PATHS ${PKG_FFTW_LIBRARY_DIRS} ${LIB_INSTALL_DIR} - ) - - find_path( - FFTW_INCLUDES - NAMES "fftw3.h" - PATHS ${PKG_FFTW_INCLUDE_DIRS} ${INCLUDE_INSTALL_DIR} - ) - -endif( FFTW_ROOT ) - -set(FFTW_LIBRARIES ${FFTW_LIB} ${FFTWF_LIB}) - -if(FFTWL_LIB) - set(FFTW_LIBRARIES ${FFTW_LIBRARIES} ${FFTWL_LIB}) -endif() - -set( CMAKE_FIND_LIBRARY_SUFFIXES ${CMAKE_FIND_LIBRARY_SUFFIXES_SAV} ) - -include(FindPackageHandleStandardArgs) -find_package_handle_standard_args(FFTW DEFAULT_MSG - FFTW_INCLUDES FFTW_LIBRARIES) - -mark_as_advanced(FFTW_INCLUDES FFTW_LIBRARIES FFTW_LIB FFTWF_LIB FFTWL_LIB) - diff --git a/cmake/FindNumPy.cmake b/cmake/FindNumPy.cmake deleted file mode 100644 index ecae7e6b..00000000 --- a/cmake/FindNumPy.cmake +++ /dev/null @@ -1,90 +0,0 @@ -# - Find the NumPy libraries -# This module finds if NumPy is installed, and sets the following variables -# indicating where it is. -# -# TODO: Update to provide the libraries and paths for linking npymath lib. -# -# NUMPY_FOUND - was NumPy found -# NUMPY_VERSION - the version of NumPy found as a string -# NUMPY_VERSION_MAJOR - the major version number of NumPy -# NUMPY_VERSION_MINOR - the minor version number of NumPy -# NUMPY_VERSION_PATCH - the patch version number of NumPy -# NUMPY_VERSION_DECIMAL - e.g. version 1.6.1 is 10601 -# NUMPY_INCLUDE_DIRS - path to the NumPy include files - -#============================================================================ -# Copyright 2012 Continuum Analytics, Inc. -# -# MIT License -# -# Permission is hereby granted, free of charge, to any person obtaining -# a copy of this software and associated documentation files -# (the "Software"), to deal in the Software without restriction, including -# without limitation the rights to use, copy, modify, merge, publish, -# distribute, sublicense, and/or sell copies of the Software, and to permit -# persons to whom the Software is furnished to do so, subject to -# the following conditions: -# -# The above copyright notice and this permission notice shall be included -# in all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR -# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -# OTHER DEALINGS IN THE SOFTWARE. -# -#============================================================================ - -# Finding NumPy involves calling the Python interpreter -if(NumPy_FIND_REQUIRED) - find_package(PythonInterp REQUIRED) -else() - find_package(PythonInterp) -endif() - -if(NOT PYTHONINTERP_FOUND) - set(NUMPY_FOUND FALSE) -endif() - -execute_process(COMMAND "${PYTHON_EXECUTABLE}" "-c" - "import numpy as n; print(n.__version__); print(n.get_include());" - RESULT_VARIABLE _NUMPY_SEARCH_SUCCESS - OUTPUT_VARIABLE _NUMPY_VALUES - ERROR_VARIABLE _NUMPY_ERROR_VALUE - OUTPUT_STRIP_TRAILING_WHITESPACE) - -if(NOT _NUMPY_SEARCH_SUCCESS MATCHES 0) - if(NumPy_FIND_REQUIRED) - message(FATAL_ERROR - "NumPy import failure:\n${_NUMPY_ERROR_VALUE}") - endif() - set(NUMPY_FOUND FALSE) -endif() - -# Convert the process output into a list -string(REGEX REPLACE ";" "\\\\;" _NUMPY_VALUES ${_NUMPY_VALUES}) -string(REGEX REPLACE "\n" ";" _NUMPY_VALUES ${_NUMPY_VALUES}) -list(GET _NUMPY_VALUES 0 NUMPY_VERSION) -list(GET _NUMPY_VALUES 1 NUMPY_INCLUDE_DIRS) - -# Make sure all directory separators are '/' -string(REGEX REPLACE "\\\\" "/" NUMPY_INCLUDE_DIRS ${NUMPY_INCLUDE_DIRS}) - -# Get the major and minor version numbers -string(REGEX REPLACE "\\." ";" _NUMPY_VERSION_LIST ${NUMPY_VERSION}) -list(GET _NUMPY_VERSION_LIST 0 NUMPY_VERSION_MAJOR) -list(GET _NUMPY_VERSION_LIST 1 NUMPY_VERSION_MINOR) -list(GET _NUMPY_VERSION_LIST 2 NUMPY_VERSION_PATCH) -string(REGEX MATCH "[0-9]*" NUMPY_VERSION_PATCH ${NUMPY_VERSION_PATCH}) -math(EXPR NUMPY_VERSION_DECIMAL - "(${NUMPY_VERSION_MAJOR} * 10000) + (${NUMPY_VERSION_MINOR} * 100) + ${NUMPY_VERSION_PATCH}") - -find_package_message(NUMPY - "Found NumPy: version \"${NUMPY_VERSION}\" ${NUMPY_INCLUDE_DIRS}" - "${NUMPY_INCLUDE_DIRS}${NUMPY_VERSION}") - -set(NUMPY_FOUND TRUE) - diff --git a/cmake/FindPythonInterp.cmake b/cmake/FindPythonInterp.cmake deleted file mode 100644 index 4117f7f5..00000000 --- a/cmake/FindPythonInterp.cmake +++ /dev/null @@ -1,165 +0,0 @@ -#.rst: -# FindPythonInterp -# ---------------- -# -# Find python interpreter -# -# This module finds if Python interpreter is installed and determines -# where the executables are. This code sets the following variables: -# -# :: -# -# PYTHONINTERP_FOUND - Was the Python executable found -# PYTHON_EXECUTABLE - path to the Python interpreter -# -# -# -# :: -# -# PYTHON_VERSION_STRING - Python version found e.g. 2.5.2 -# PYTHON_VERSION_MAJOR - Python major version found e.g. 2 -# PYTHON_VERSION_MINOR - Python minor version found e.g. 5 -# PYTHON_VERSION_PATCH - Python patch version found e.g. 2 -# -# -# -# The Python_ADDITIONAL_VERSIONS variable can be used to specify a list -# of version numbers that should be taken into account when searching -# for Python. You need to set this variable before calling -# find_package(PythonInterp). -# -# If calling both ``find_package(PythonInterp)`` and -# ``find_package(PythonLibs)``, call ``find_package(PythonInterp)`` first to -# get the currently active Python version by default with a consistent version -# of PYTHON_LIBRARIES. - -#============================================================================= -# Copyright 2005-2010 Kitware, Inc. -# Copyright 2011 Bjoern Ricks -# Copyright 2012 Rolf Eike Beer -# -# Distributed under the OSI-approved BSD License (the "License"); -# see accompanying file Copyright.txt for details. -# -# This software is distributed WITHOUT ANY WARRANTY; without even the -# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# See the License for more information. -#============================================================================= -# (To distribute this file outside of CMake, substitute the full -# License text for the above reference.) - -unset(_Python_NAMES) - -set(_PYTHON1_VERSIONS 1.6 1.5) -set(_PYTHON2_VERSIONS 2.7 2.6 2.5 2.4 2.3 2.2 2.1 2.0) -set(_PYTHON3_VERSIONS 3.6 3.5 3.4 3.3 3.2 3.1 3.0) - -if(PythonInterp_FIND_VERSION) - if(PythonInterp_FIND_VERSION_COUNT GREATER 1) - set(_PYTHON_FIND_MAJ_MIN "${PythonInterp_FIND_VERSION_MAJOR}.${PythonInterp_FIND_VERSION_MINOR}") - list(APPEND _Python_NAMES - python${_PYTHON_FIND_MAJ_MIN} - python${PythonInterp_FIND_VERSION_MAJOR}) - unset(_PYTHON_FIND_OTHER_VERSIONS) - if(NOT PythonInterp_FIND_VERSION_EXACT) - foreach(_PYTHON_V ${_PYTHON${PythonInterp_FIND_VERSION_MAJOR}_VERSIONS}) - if(NOT _PYTHON_V VERSION_LESS _PYTHON_FIND_MAJ_MIN) - list(APPEND _PYTHON_FIND_OTHER_VERSIONS ${_PYTHON_V}) - endif() - endforeach() - endif() - unset(_PYTHON_FIND_MAJ_MIN) - else() - list(APPEND _Python_NAMES python${PythonInterp_FIND_VERSION_MAJOR}) - set(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON${PythonInterp_FIND_VERSION_MAJOR}_VERSIONS}) - endif() -else() - set(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON3_VERSIONS} ${_PYTHON2_VERSIONS} ${_PYTHON1_VERSIONS}) -endif() -find_program(PYTHON_EXECUTABLE NAMES ${_Python_NAMES}) - -# Set up the versions we know about, in the order we will search. Always add -# the user supplied additional versions to the front. -set(_Python_VERSIONS ${Python_ADDITIONAL_VERSIONS}) -# If FindPythonInterp has already found the major and minor version, -# insert that version next to get consistent versions of the interpreter and -# library. -if(DEFINED PYTHONLIBS_VERSION_STRING) - string(REPLACE "." ";" _PYTHONLIBS_VERSION "${PYTHONLIBS_VERSION_STRING}") - list(GET _PYTHONLIBS_VERSION 0 _PYTHONLIBS_VERSION_MAJOR) - list(GET _PYTHONLIBS_VERSION 1 _PYTHONLIBS_VERSION_MINOR) - list(APPEND _Python_VERSIONS ${_PYTHONLIBS_VERSION_MAJOR}.${_PYTHONLIBS_VERSION_MINOR}) -endif() -# Search for the current active python version first -list(APPEND _Python_VERSIONS ";") -list(APPEND _Python_VERSIONS ${_PYTHON_FIND_OTHER_VERSIONS}) - -unset(_PYTHON_FIND_OTHER_VERSIONS) -unset(_PYTHON1_VERSIONS) -unset(_PYTHON2_VERSIONS) -unset(_PYTHON3_VERSIONS) - -# Search for newest python version if python executable isn't found -if(NOT PYTHON_EXECUTABLE) - foreach(_CURRENT_VERSION IN LISTS _Python_VERSIONS) - set(_Python_NAMES python${_CURRENT_VERSION}) - if(WIN32) - list(APPEND _Python_NAMES python) - endif() - find_program(PYTHON_EXECUTABLE - NAMES ${_Python_NAMES} - PATHS [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath] - ) - endforeach() -endif() - -# determine python version string -if(PYTHON_EXECUTABLE) - execute_process(COMMAND "${PYTHON_EXECUTABLE}" -c - "import sys; sys.stdout.write(';'.join([str(x) for x in sys.version_info[:3]]))" - OUTPUT_VARIABLE _VERSION - RESULT_VARIABLE _PYTHON_VERSION_RESULT - ERROR_QUIET) - if(NOT _PYTHON_VERSION_RESULT) - string(REPLACE ";" "." PYTHON_VERSION_STRING "${_VERSION}") - list(GET _VERSION 0 PYTHON_VERSION_MAJOR) - list(GET _VERSION 1 PYTHON_VERSION_MINOR) - list(GET _VERSION 2 PYTHON_VERSION_PATCH) - if(PYTHON_VERSION_PATCH EQUAL 0) - # it's called "Python 2.7", not "2.7.0" - string(REGEX REPLACE "\\.0$" "" PYTHON_VERSION_STRING "${PYTHON_VERSION_STRING}") - endif() - else() - # sys.version predates sys.version_info, so use that - execute_process(COMMAND "${PYTHON_EXECUTABLE}" -c "import sys; sys.stdout.write(sys.version)" - OUTPUT_VARIABLE _VERSION - RESULT_VARIABLE _PYTHON_VERSION_RESULT - ERROR_QUIET) - if(NOT _PYTHON_VERSION_RESULT) - string(REGEX REPLACE " .*" "" PYTHON_VERSION_STRING "${_VERSION}") - string(REGEX REPLACE "^([0-9]+)\\.[0-9]+.*" "\\1" PYTHON_VERSION_MAJOR "${PYTHON_VERSION_STRING}") - string(REGEX REPLACE "^[0-9]+\\.([0-9])+.*" "\\1" PYTHON_VERSION_MINOR "${PYTHON_VERSION_STRING}") - if(PYTHON_VERSION_STRING MATCHES "^[0-9]+\\.[0-9]+\\.([0-9]+)") - set(PYTHON_VERSION_PATCH "${CMAKE_MATCH_1}") - else() - set(PYTHON_VERSION_PATCH "0") - endif() - else() - # sys.version was first documented for Python 1.5, so assume - # this is older. - set(PYTHON_VERSION_STRING "1.4") - set(PYTHON_VERSION_MAJOR "1") - set(PYTHON_VERSION_MINOR "4") - set(PYTHON_VERSION_PATCH "0") - endif() - endif() - unset(_PYTHON_VERSION_RESULT) - unset(_VERSION) -endif() - -# handle the QUIETLY and REQUIRED arguments and set PYTHONINTERP_FOUND to TRUE if -# all listed variables are TRUE -include(FindPackageHandleStandardArgs) -FIND_PACKAGE_HANDLE_STANDARD_ARGS(PythonInterp REQUIRED_VARS PYTHON_EXECUTABLE VERSION_VAR PYTHON_VERSION_STRING) - -mark_as_advanced(PYTHON_EXECUTABLE) diff --git a/cmake/FindPythonLibs.cmake b/cmake/FindPythonLibs.cmake deleted file mode 100644 index 5e6e6f6b..00000000 --- a/cmake/FindPythonLibs.cmake +++ /dev/null @@ -1,354 +0,0 @@ -#.rst: -# FindPythonLibs -# -------------- -# -# Find python libraries -# -# This module finds if Python is installed and determines where the -# include files and libraries are. It also determines what the name of -# the library is. This code sets the following variables: -# -# :: -# -# PYTHONLIBS_FOUND - have the Python libs been found -# PYTHON_LIBRARIES - path to the python library -# PYTHON_INCLUDE_PATH - path to where Python.h is found (deprecated) -# PYTHON_INCLUDE_DIRS - path to where Python.h is found -# PYTHON_DEBUG_LIBRARIES - path to the debug library (deprecated) -# PYTHONLIBS_VERSION_STRING - version of the Python libs found (since CMake 2.8.8) -# -# -# -# The Python_ADDITIONAL_VERSIONS variable can be used to specify a list -# of version numbers that should be taken into account when searching -# for Python. You need to set this variable before calling -# find_package(PythonLibs). -# -# If you'd like to specify the installation of Python to use, you should -# modify the following cache variables: -# -# :: -# -# PYTHON_LIBRARY - path to the python library -# PYTHON_INCLUDE_DIR - path to where Python.h is found -# -# If calling both ``find_package(PythonInterp)`` and -# ``find_package(PythonLibs)``, call ``find_package(PythonInterp)`` first to -# get the currently active Python version by default with a consistent version -# of PYTHON_LIBRARIES. - -#============================================================================= -# Copyright 2001-2009 Kitware, Inc. -# -# Distributed under the OSI-approved BSD License (the "License"); -# see accompanying file Copyright.txt for details. -# -# This software is distributed WITHOUT ANY WARRANTY; without even the -# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# See the License for more information. -#============================================================================= -# (To distribute this file outside of CMake, substitute the full -# License text for the above reference.) - -# Use the executable's path as a hint -set(_Python_LIBRARY_PATH_HINT) -if(PYTHON_EXECUTABLE) - if(WIN32) - get_filename_component(_Python_PREFIX ${PYTHON_EXECUTABLE} PATH) - if(_Python_PREFIX) - set(_Python_LIBRARY_PATH_HINT ${_Python_PREFIX}/libs) - endif() - unset(_Python_PREFIX) - else() - get_filename_component(_Python_PREFIX ${PYTHON_EXECUTABLE} PATH) - get_filename_component(_Python_PREFIX ${_Python_PREFIX} PATH) - if(_Python_PREFIX) - set(_Python_LIBRARY_PATH_HINT ${_Python_PREFIX}/lib) - endif() - unset(_Python_PREFIX) - endif() -endif() - -include(CMakeFindFrameworks) -# Search for the python framework on Apple. -CMAKE_FIND_FRAMEWORKS(Python) - -# Save CMAKE_FIND_FRAMEWORK -if(DEFINED CMAKE_FIND_FRAMEWORK) - set(_PythonLibs_CMAKE_FIND_FRAMEWORK ${CMAKE_FIND_FRAMEWORK}) -else() - unset(_PythonLibs_CMAKE_FIND_FRAMEWORK) -endif() -# To avoid picking up the system Python.h pre-maturely. -set(CMAKE_FIND_FRAMEWORK LAST) - -set(_PYTHON1_VERSIONS 1.6 1.5) -set(_PYTHON2_VERSIONS 2.7 2.6 2.5 2.4 2.3 2.2 2.1 2.0) -set(_PYTHON3_VERSIONS 3.6 3.5 3.4 3.3 3.2 3.1 3.0) - -if(PythonLibs_FIND_VERSION) - if(PythonLibs_FIND_VERSION_COUNT GREATER 1) - set(_PYTHON_FIND_MAJ_MIN "${PythonLibs_FIND_VERSION_MAJOR}.${PythonLibs_FIND_VERSION_MINOR}") - unset(_PYTHON_FIND_OTHER_VERSIONS) - if(PythonLibs_FIND_VERSION_EXACT) - if(_PYTHON_FIND_MAJ_MIN STREQUAL PythonLibs_FIND_VERSION) - set(_PYTHON_FIND_OTHER_VERSIONS "${PythonLibs_FIND_VERSION}") - else() - set(_PYTHON_FIND_OTHER_VERSIONS "${PythonLibs_FIND_VERSION}" "${_PYTHON_FIND_MAJ_MIN}") - endif() - else() - foreach(_PYTHON_V ${_PYTHON${PythonLibs_FIND_VERSION_MAJOR}_VERSIONS}) - if(NOT _PYTHON_V VERSION_LESS _PYTHON_FIND_MAJ_MIN) - list(APPEND _PYTHON_FIND_OTHER_VERSIONS ${_PYTHON_V}) - endif() - endforeach() - endif() - unset(_PYTHON_FIND_MAJ_MIN) - else() - set(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON${PythonLibs_FIND_VERSION_MAJOR}_VERSIONS}) - endif() -else() - set(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON3_VERSIONS} ${_PYTHON2_VERSIONS} ${_PYTHON1_VERSIONS}) -endif() - -# Set up the versions we know about, in the order we will search. Always add -# the user supplied additional versions to the front. -# If FindPythonInterp has already found the major and minor version, -# insert that version between the user supplied versions and the stock -# version list. -set(_Python_VERSIONS ${Python_ADDITIONAL_VERSIONS}) -if(DEFINED PYTHON_VERSION_MAJOR AND DEFINED PYTHON_VERSION_MINOR) - list(APPEND _Python_VERSIONS ${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}) -endif() -list(APPEND _Python_VERSIONS ${_PYTHON_FIND_OTHER_VERSIONS}) - -unset(_PYTHON_FIND_OTHER_VERSIONS) -unset(_PYTHON1_VERSIONS) -unset(_PYTHON2_VERSIONS) -unset(_PYTHON3_VERSIONS) - -foreach(_CURRENT_VERSION ${_Python_VERSIONS}) - string(REPLACE "." "" _CURRENT_VERSION_NO_DOTS ${_CURRENT_VERSION}) - if(WIN32) - find_library(PYTHON_DEBUG_LIBRARY - NAMES python${_CURRENT_VERSION_NO_DOTS}_d python - HINTS ${_Python_LIBRARY_PATH_HINT} - PATHS - [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs/Debug - [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs/Debug - [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs - [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs - ) - endif() - - set(PYTHON_FRAMEWORK_LIBRARIES) - if(Python_FRAMEWORKS AND NOT PYTHON_LIBRARY) - foreach(dir ${Python_FRAMEWORKS}) - list(APPEND PYTHON_FRAMEWORK_LIBRARIES - ${dir}/Versions/${_CURRENT_VERSION}/lib) - endforeach() - endif() - find_library(PYTHON_LIBRARY - NAMES - python${_CURRENT_VERSION_NO_DOTS} - python${_CURRENT_VERSION}mu - python${_CURRENT_VERSION}m - python${_CURRENT_VERSION}u - python${_CURRENT_VERSION} - HINTS - ${_Python_LIBRARY_PATH_HINT} - PATHS - ${PYTHON_FRAMEWORK_LIBRARIES} - [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs - [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs - # Avoid finding the .dll in the PATH. We want the .lib. - NO_SYSTEM_ENVIRONMENT_PATH - ) - # Look for the static library in the Python config directory - find_library(PYTHON_LIBRARY - NAMES python${_CURRENT_VERSION_NO_DOTS} python${_CURRENT_VERSION} - # Avoid finding the .dll in the PATH. We want the .lib. - NO_SYSTEM_ENVIRONMENT_PATH - # This is where the static library is usually located - PATH_SUFFIXES python${_CURRENT_VERSION}/config - ) - - # Don't search for include dir until library location is known - if(PYTHON_LIBRARY) - - # Use the library's install prefix as a hint - set(_Python_INCLUDE_PATH_HINT) - get_filename_component(_Python_PREFIX ${PYTHON_LIBRARY} PATH) - get_filename_component(_Python_PREFIX ${_Python_PREFIX} PATH) - if(_Python_PREFIX) - set(_Python_INCLUDE_PATH_HINT ${_Python_PREFIX}/include) - endif() - unset(_Python_PREFIX) - - # Add framework directories to the search paths - set(PYTHON_FRAMEWORK_INCLUDES) - if(Python_FRAMEWORKS AND NOT PYTHON_INCLUDE_DIR) - foreach(dir ${Python_FRAMEWORKS}) - list(APPEND PYTHON_FRAMEWORK_INCLUDES - ${dir}/Versions/${_CURRENT_VERSION}/include) - endforeach() - endif() - - find_path(PYTHON_INCLUDE_DIR - NAMES Python.h - HINTS - ${_Python_INCLUDE_PATH_HINT} - PATHS - ${PYTHON_FRAMEWORK_INCLUDES} - [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/include - [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/include - PATH_SUFFIXES - python${_CURRENT_VERSION}mu - python${_CURRENT_VERSION}m - python${_CURRENT_VERSION}u - python${_CURRENT_VERSION} - ) - endif() - - # For backward compatibility, set PYTHON_INCLUDE_PATH. - set(PYTHON_INCLUDE_PATH "${PYTHON_INCLUDE_DIR}") - - if(PYTHON_INCLUDE_DIR AND EXISTS "${PYTHON_INCLUDE_DIR}/patchlevel.h") - file(STRINGS "${PYTHON_INCLUDE_DIR}/patchlevel.h" python_version_str - REGEX "^#define[ \t]+PY_VERSION[ \t]+\"[^\"]+\"") - string(REGEX REPLACE "^#define[ \t]+PY_VERSION[ \t]+\"([^\"]+)\".*" "\\1" - PYTHONLIBS_VERSION_STRING "${python_version_str}") - unset(python_version_str) - endif() - - if(PYTHON_LIBRARY AND PYTHON_INCLUDE_DIR) - break() - endif() -endforeach() - -unset(_Python_INCLUDE_PATH_HINT) -unset(_Python_LIBRARY_PATH_HINT) - -mark_as_advanced( - PYTHON_DEBUG_LIBRARY - PYTHON_LIBRARY - PYTHON_INCLUDE_DIR -) - -# We use PYTHON_INCLUDE_DIR, PYTHON_LIBRARY and PYTHON_DEBUG_LIBRARY for the -# cache entries because they are meant to specify the location of a single -# library. We now set the variables listed by the documentation for this -# module. -set(PYTHON_INCLUDE_DIRS "${PYTHON_INCLUDE_DIR}") -set(PYTHON_DEBUG_LIBRARIES "${PYTHON_DEBUG_LIBRARY}") - -# These variables have been historically named in this module different from -# what SELECT_LIBRARY_CONFIGURATIONS() expects. -set(PYTHON_LIBRARY_DEBUG "${PYTHON_DEBUG_LIBRARY}") -set(PYTHON_LIBRARY_RELEASE "${PYTHON_LIBRARY}") -include(SelectLibraryConfigurations) -SELECT_LIBRARY_CONFIGURATIONS(PYTHON) -# SELECT_LIBRARY_CONFIGURATIONS() sets ${PREFIX}_FOUND if it has a library. -# Unset this, this prefix doesn't match the module prefix, they are different -# for historical reasons. -unset(PYTHON_FOUND) - -# Restore CMAKE_FIND_FRAMEWORK -if(DEFINED _PythonLibs_CMAKE_FIND_FRAMEWORK) - set(CMAKE_FIND_FRAMEWORK ${_PythonLibs_CMAKE_FIND_FRAMEWORK}) - unset(_PythonLibs_CMAKE_FIND_FRAMEWORK) -else() - unset(CMAKE_FIND_FRAMEWORK) -endif() - -include(FindPackageHandleStandardArgs) -FIND_PACKAGE_HANDLE_STANDARD_ARGS(PythonLibs - REQUIRED_VARS PYTHON_LIBRARIES PYTHON_INCLUDE_DIRS - VERSION_VAR PYTHONLIBS_VERSION_STRING) - -# PYTHON_ADD_MODULE( src1 src2 ... srcN) is used to build modules for python. -# PYTHON_WRITE_MODULES_HEADER() writes a header file you can include -# in your sources to initialize the static python modules -function(PYTHON_ADD_MODULE _NAME ) - get_property(_TARGET_SUPPORTS_SHARED_LIBS - GLOBAL PROPERTY TARGET_SUPPORTS_SHARED_LIBS) - option(PYTHON_ENABLE_MODULE_${_NAME} "Add module ${_NAME}" TRUE) - option(PYTHON_MODULE_${_NAME}_BUILD_SHARED - "Add module ${_NAME} shared" ${_TARGET_SUPPORTS_SHARED_LIBS}) - - # Mark these options as advanced - mark_as_advanced(PYTHON_ENABLE_MODULE_${_NAME} - PYTHON_MODULE_${_NAME}_BUILD_SHARED) - - if(PYTHON_ENABLE_MODULE_${_NAME}) - if(PYTHON_MODULE_${_NAME}_BUILD_SHARED) - set(PY_MODULE_TYPE MODULE) - else() - set(PY_MODULE_TYPE STATIC) - set_property(GLOBAL APPEND PROPERTY PY_STATIC_MODULES_LIST ${_NAME}) - endif() - - set_property(GLOBAL APPEND PROPERTY PY_MODULES_LIST ${_NAME}) - add_library(${_NAME} ${PY_MODULE_TYPE} ${ARGN}) -# target_link_libraries(${_NAME} ${PYTHON_LIBRARIES}) - - if(PYTHON_MODULE_${_NAME}_BUILD_SHARED) - set_target_properties(${_NAME} PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}") - if(WIN32 AND NOT CYGWIN) - set_target_properties(${_NAME} PROPERTIES SUFFIX ".pyd") - endif() - endif() - - endif() -endfunction() - -function(PYTHON_WRITE_MODULES_HEADER _filename) - - get_property(PY_STATIC_MODULES_LIST GLOBAL PROPERTY PY_STATIC_MODULES_LIST) - - get_filename_component(_name "${_filename}" NAME) - string(REPLACE "." "_" _name "${_name}") - string(TOUPPER ${_name} _nameUpper) - set(_filename ${CMAKE_CURRENT_BINARY_DIR}/${_filename}) - - set(_filenameTmp "${_filename}.in") - file(WRITE ${_filenameTmp} "/*Created by cmake, do not edit, changes will be lost*/\n") - file(APPEND ${_filenameTmp} -"#ifndef ${_nameUpper} -#define ${_nameUpper} - -#include - -#ifdef __cplusplus -extern \"C\" { -#endif /* __cplusplus */ - -") - - foreach(_currentModule ${PY_STATIC_MODULES_LIST}) - file(APPEND ${_filenameTmp} "extern void init${PYTHON_MODULE_PREFIX}${_currentModule}(void);\n\n") - endforeach() - - file(APPEND ${_filenameTmp} -"#ifdef __cplusplus -} -#endif /* __cplusplus */ - -") - - - foreach(_currentModule ${PY_STATIC_MODULES_LIST}) - file(APPEND ${_filenameTmp} "int ${_name}_${_currentModule}(void) \n{\n static char name[]=\"${PYTHON_MODULE_PREFIX}${_currentModule}\"; return PyImport_AppendInittab(name, init${PYTHON_MODULE_PREFIX}${_currentModule});\n}\n\n") - endforeach() - - file(APPEND ${_filenameTmp} "void ${_name}_LoadAllPythonModules(void)\n{\n") - foreach(_currentModule ${PY_STATIC_MODULES_LIST}) - file(APPEND ${_filenameTmp} " ${_name}_${_currentModule}();\n") - endforeach() - file(APPEND ${_filenameTmp} "}\n\n") - file(APPEND ${_filenameTmp} "#ifndef EXCLUDE_LOAD_ALL_FUNCTION\nvoid CMakeLoadAllPythonModules(void)\n{\n ${_name}_LoadAllPythonModules();\n}\n#endif\n\n#endif\n") - -# with configure_file() cmake complains that you may not use a file created using file(WRITE) as input file for configure_file() - execute_process(COMMAND ${CMAKE_COMMAND} -E copy_if_different "${_filenameTmp}" "${_filename}" OUTPUT_QUIET ERROR_QUIET) - -endfunction() diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 00000000..5f154054 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,7 @@ +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.conf.in + ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf @ONLY) +add_custom_target(doc ${DOXYGEN_EXECUTABLE} + ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Running Doxygen" VERBATIM) + diff --git a/doc/doxygen.conf.in b/doc/doxygen.conf.in index e69de29b..ad7bedf6 100644 --- a/doc/doxygen.conf.in +++ b/doc/doxygen.conf.in @@ -0,0 +1,2280 @@ +# Doxyfile 1.8.5 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "ndarray" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "NumPy-friendly multidimensional arrays in C++" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese- +# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, +# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/include/ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.h + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /