From c01214e0c21cb4eee0526698633b5a202afb9e5b Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Tue, 10 Apr 2012 13:28:30 -0400 Subject: [PATCH 001/102] support flatten for ArrayRef as well as Array --- include/ndarray/casts.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/include/ndarray/casts.h b/include/ndarray/casts.h index 7707e659..2c2333ec 100644 --- a/include/ndarray/casts.h +++ b/include/ndarray/casts.h @@ -147,6 +147,18 @@ flatten(Array const & input) { return Access::construct(input.getData(), Core::create(newShape, newStrides, input.getManager())); } +/** + * @brief Create a view into an array with trailing contiguous dimensions merged. + * + * The first template parameter sets the dimension of the output array and must + * be specified directly. Only row-major contiguous dimensions can be flattened. + */ +template +inline typename boost::enable_if_c< ((C+Nf-N)>=1), ArrayRef >::type +flatten(ArrayRef const & input) { + return flatten(input.shallow()); +} + /// @} } // namespace ndarray From 525f887865c715b444f55655ed3883f1705692f3 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Tue, 10 Apr 2012 14:38:05 -0400 Subject: [PATCH 002/102] modify doxygen @mainpage to work with crosslinked doxygen builds --- include/ndarray.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/ndarray.h b/include/ndarray.h index 7cbb141d..a1432286 100644 --- a/include/ndarray.h +++ b/include/ndarray.h @@ -29,7 +29,7 @@ namespace ndarray { /** - * @mainpage Multidimensional Arrays in C++ + * @mainpage ndarray; Multidimensional Arrays in C++ * * %ndarray is a template library that provides multidimensional array objects in C++, with * an interface and features designed to mimic the Python 'numpy' package as much as possible. From 2012ddc698ccf6de6ed2e650a898a2d0dfae91e5 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 20 Apr 2012 13:08:22 -0400 Subject: [PATCH 003/102] consistently use class rather than struct for Formatter to address clang warnings --- include/ndarray/formatting.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/include/ndarray/formatting.h b/include/ndarray/formatting.h index 593675b4..52f4bc58 100644 --- a/include/ndarray/formatting.h +++ b/include/ndarray/formatting.h @@ -23,7 +23,7 @@ namespace ndarray { namespace detail { -template struct Formatter; +template class Formatter; } // namespace detail /** @@ -81,7 +81,8 @@ namespace detail { * @brief Recursive metafunction used in stream output. */ template -struct Formatter { +class Formatter { +public: static void apply( FormatOptions const & options, std::ostream & os, @@ -108,7 +109,8 @@ struct Formatter { * @brief Recursive metafunction used in stream output (1d specialization). */ template -struct Formatter { +class Formatter { +public: static void apply( FormatOptions const & options, std::ostream & os, From 69fe908e855612965aaee39d2921a461da27d253 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Tue, 21 Aug 2012 18:42:41 -0400 Subject: [PATCH 004/102] be more explicit with assignment operators in EigenView to avoid (valid? buggy?) clang errors --- include/ndarray/eigen.h | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/include/ndarray/eigen.h b/include/ndarray/eigen.h index 099a2de6..689576a8 100644 --- a/include/ndarray/eigen.h +++ b/include/ndarray/eigen.h @@ -261,7 +261,20 @@ class EigenView return *this; } - using Base::operator=; + 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)); } From a565369504d52be7cefec59acff9967a8a6feca1 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 7 Dec 2012 22:17:23 -0500 Subject: [PATCH 005/102] allow Vector to handle non-numeric types by not always setting to zero --- include/ndarray/Vector.h.m4 | 17 ++++++++++++++++- tests/ndarray.cc | 6 ++++++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/include/ndarray/Vector.h.m4 b/include/ndarray/Vector.h.m4 index b1a8310e..f7201b11 100644 --- a/include/ndarray/Vector.h.m4 +++ b/include/ndarray/Vector.h.m4 @@ -75,6 +75,7 @@ define(`VECTOR_TYPEDEFS', /// @file ndarray/Vector.h Definition for Vector. +#include #include #include #include @@ -107,6 +108,20 @@ define(`VECTOR_TYPEDEFS', 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 /// @{ @@ -204,7 +219,7 @@ struct Vector { #ifndef _MSC_VER template #endif - operator=(0); } + operator=(detail::DefaultValue::get()); } /// @brief Construct with copies of a scalar. explicit Vector(T scalar) { diff --git a/tests/ndarray.cc b/tests/ndarray.cc index 7d3da461..6f2b4b37 100644 --- a/tests/ndarray.cc +++ b/tests/ndarray.cc @@ -44,6 +44,12 @@ BOOST_AUTO_TEST_CASE(vectors) { BOOST_CHECK_EQUAL(a, f); e = a.last<0>(); + + // make sure we can default-construct whether or not T is a number + ndarray::Vector,2> g; + BOOST_CHECK_EQUAL(g, ndarray::makeVector(boost::shared_ptr(), boost::shared_ptr())); + ndarray::Vector h; + BOOST_CHECK_EQUAL(h, ndarray::makeVector(0, 0, 0)); } BOOST_AUTO_TEST_CASE(cores) { From e6b0fbe247172057c34f200617e7386bde5d18f6 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Thu, 25 Apr 2013 11:19:21 -0400 Subject: [PATCH 006/102] Make ArrayAccess class instead of a struct to fix clang warnings. --- include/ndarray/detail/ArrayAccess.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/include/ndarray/detail/ArrayAccess.h b/include/ndarray/detail/ArrayAccess.h index a227c36b..f62d32f6 100644 --- a/include/ndarray/detail/ArrayAccess.h +++ b/include/ndarray/detail/ArrayAccess.h @@ -23,7 +23,8 @@ namespace ndarray { namespace detail { template -struct ArrayAccess { +class ArrayAccess { +public: typedef typename ExpressionTraits< Array_ >::Element Element; typedef typename ExpressionTraits< Array_ >::Core Core; typedef typename ExpressionTraits< Array_ >::CorePtr CorePtr; From e845c9dc7ee884c9e7f4cf2fd7386d2a2b62c66f Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Tue, 19 Nov 2013 11:56:59 -0500 Subject: [PATCH 007/102] Don't invoke std::fill on NestedIterator; it's not an STL ForwardIterator This should address build failures on Mac OSX 10.9 (#3054) --- include/ndarray/ArrayRef.h.m4 | 2 +- include/ndarray/ArrayTraits.h | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/include/ndarray/ArrayRef.h.m4 b/include/ndarray/ArrayRef.h.m4 index 968a1660..59708d9b 100644 --- a/include/ndarray/ArrayRef.h.m4 +++ b/include/ndarray/ArrayRef.h.m4 @@ -33,7 +33,7 @@ define(`GENERAL_ASSIGN', indir(`$2',$1) return *this; }')dnl -define(`BASIC_ASSIGN_SCALAR',`std::fill(this->begin(),this->end(),scalar);')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(); diff --git a/include/ndarray/ArrayTraits.h b/include/ndarray/ArrayTraits.h index 089c000a..1c4c3e2e 100644 --- a/include/ndarray/ArrayTraits.h +++ b/include/ndarray/ArrayTraits.h @@ -57,6 +57,16 @@ struct ArrayTraits { static Iterator makeIterator(Element * data, CorePtr const & core, Offset stride) { return Iterator(Reference(data, core), stride); } + static void fill(Iterator iter, Iterator const & end, Element value) { + // We can't use std::fill here because NestedIterator is not formally an STL ForwardIterator; + // it has random access traversal, but it does not dereference to an addressable type (see + // http://www.boost.org/doc/libs/1_55_0/libs/iterator/doc/new-iter-concepts.html#motivation) + // Most C++ standard libraries have a fill implementation that will accept NestedIterator + // anyway, but Clang's libc++ is more strictly compliant and does not. + for (; iter != end; ++iter) { + *iter = value; + } + } }; template @@ -76,6 +86,9 @@ struct ArrayTraits { static Iterator makeIterator(Element * data, CorePtr const & core, Offset stride) { return Iterator(data, stride); } + static void fill(Iterator iter, Iterator const & end, Element value) { + std::fill(iter, end, value); + } }; template @@ -95,6 +108,9 @@ struct ArrayTraits { static Iterator makeIterator(Element * data, CorePtr const & core, Offset stride) { return data; } + static void fill(Iterator iter, Iterator const & end, Element value) { + std::fill(iter, end, value); + } }; template @@ -114,6 +130,9 @@ struct ArrayTraits { static Iterator makeIterator(Element * data, CorePtr const & core, Offset stride) { return data; } + static void fill(Iterator iter, Iterator const & end, Element value) { + std::fill(iter, end, value); + } }; template From bfc8c145433a8e93c8e6d5565ddfc52ee0e1e360 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Tue, 19 Nov 2013 13:11:14 -0500 Subject: [PATCH 008/102] Add explicit enable_if #includes to files that use enable_if --- include/ndarray/casts.h | 1 + include/ndarray/operators.h.m4 | 1 + include/ndarray/vectorize.h | 1 + 3 files changed, 3 insertions(+) diff --git a/include/ndarray/casts.h b/include/ndarray/casts.h index 2c2333ec..d5d1e56e 100644 --- a/include/ndarray/casts.h +++ b/include/ndarray/casts.h @@ -22,6 +22,7 @@ #include #include #include +#include #include namespace ndarray { diff --git a/include/ndarray/operators.h.m4 b/include/ndarray/operators.h.m4 index 40eb76c7..0525c894 100644 --- a/include/ndarray/operators.h.m4 +++ b/include/ndarray/operators.h.m4 @@ -88,6 +88,7 @@ define(`UNARY_OP', #include "ndarray/Array.h" #include #include +#include #include "ndarray/detail/UnaryOp.h" #include "ndarray/detail/BinaryOp.h" diff --git a/include/ndarray/vectorize.h b/include/ndarray/vectorize.h index 39ca3821..d8bd309e 100644 --- a/include/ndarray/vectorize.h +++ b/include/ndarray/vectorize.h @@ -19,6 +19,7 @@ #include "ndarray/detail/UnaryOp.h" #include +#include namespace ndarray { namespace result_of { From 7f8c99d3d4b6b77540da9616be4c9a955c413fb8 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 24 Jan 2014 15:15:08 -0500 Subject: [PATCH 009/102] Fix clang warnings about class/struct mismatches (#3081) --- include/ndarray/Array.h | 2 +- include/ndarray/ArrayBase.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/include/ndarray/Array.h b/include/ndarray/Array.h index dd1fe82d..78de27d8 100644 --- a/include/ndarray/Array.h +++ b/include/ndarray/Array.h @@ -174,7 +174,7 @@ class Array : public ArrayBaseN< Array > { template friend class ArrayRef; template friend struct ArrayTraits; template friend class ArrayBase; - template friend struct detail::ArrayAccess; + template friend class detail::ArrayAccess; /// @internal @brief Construct an Array from a pointer and Core. Array(T * data, CorePtr const & core) : Super(data, core) {} diff --git a/include/ndarray/ArrayBase.h b/include/ndarray/ArrayBase.h index 6604349d..3af4be5d 100644 --- a/include/ndarray/ArrayBase.h +++ b/include/ndarray/ArrayBase.h @@ -236,7 +236,7 @@ class ArrayBase : public ExpressionBase { template friend struct ArrayTraits; template friend class detail::NestedIterator; template friend class ArrayBase; - template friend struct detail::ArrayAccess; + template friend class detail::ArrayAccess; Element * _data; CorePtr _core; From e48197423ca69b30447fcedeac1c1ad4eb41c0b4 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Wed, 21 Jan 2015 18:23:57 -0500 Subject: [PATCH 010/102] Remove unused local typedef to address gcc warnings --- include/ndarray/initialization.h | 1 - 1 file changed, 1 deletion(-) diff --git a/include/ndarray/initialization.h b/include/ndarray/initialization.h index 3a375287..c9c2bcc9 100644 --- a/include/ndarray/initialization.h +++ b/include/ndarray/initialization.h @@ -69,7 +69,6 @@ class ExternalInitializer : public Initializer< N, ExternalInitializer Access; typedef typename Access::Core Core; - typedef typename Access::Element Element; Manager::Ptr manager; if (!boost::is_same::value) { manager = makeManager(_owner); From e89c88fd5ba9c17ce643314d589140847ce7e272 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Wed, 6 Apr 2016 10:00:57 -0700 Subject: [PATCH 011/102] Add missing include --- include/ndarray_fwd.h | 1 + 1 file changed, 1 insertion(+) diff --git a/include/ndarray_fwd.h b/include/ndarray_fwd.h index 2bed1f4a..0b1b531b 100644 --- a/include/ndarray_fwd.h +++ b/include/ndarray_fwd.h @@ -30,6 +30,7 @@ #include #include #include +#include #include #ifdef __GNUC__ From bdd4635e615d0ea558657471a77d9300d17e9b1a Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 27 Jun 2016 11:42:42 -0400 Subject: [PATCH 012/102] Add casts to work around Vector inferrence failure --- include/ndarray/initialization.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/include/ndarray/initialization.h b/include/ndarray/initialization.h index c9c2bcc9..56945f19 100644 --- a/include/ndarray/initialization.h +++ b/include/ndarray/initialization.h @@ -181,8 +181,8 @@ inline detail::ExternalInitializer external( ) { return detail::ExternalInitializer( data, - Vector(shape), - Vector(strides), + Vector(shape.template cast()), + Vector(strides.template cast()), owner ); } @@ -235,8 +235,8 @@ inline detail::ExternalInitializer external( ) { return detail::ExternalInitializer( data, - Vector(shape), - computeStrides(shape, order), + Vector(shape.template cast()), + computeStrides(shape.template cast(), order), owner ); } @@ -261,8 +261,8 @@ inline detail::ExternalInitializer external( ) { return detail::ExternalInitializer( data, - Vector(shape), - computeStrides(shape, order), + Vector(shape.template cast()), + computeStrides(shape.template cast(), order), detail::NullOwner() ); } From a9616e7024eed190923802f0e34dbb3b1478dcf4 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Mon, 27 Jun 2016 14:43:31 -0400 Subject: [PATCH 013/102] Add allocating ctors from shape Vectors. --- include/ndarray/Array.h | 8 ++++++++ include/ndarray/ArrayRef.h.m4 | 8 ++++++++ include/ndarray/initialization.h | 14 ++++++++++++++ tests/ndarray.cc | 15 ++++++++++++++- 4 files changed, 44 insertions(+), 1 deletion(-) diff --git a/include/ndarray/Array.h b/include/ndarray/Array.h index 78de27d8..8c464a95 100644 --- a/include/ndarray/Array.h +++ b/include/ndarray/Array.h @@ -88,6 +88,14 @@ class Array : public ArrayBaseN< Array > { */ explicit Array(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 Array(Vector const & shape); + /** * @brief Non-converting shallow assignment. */ diff --git a/include/ndarray/ArrayRef.h.m4 b/include/ndarray/ArrayRef.h.m4 index 59708d9b..9ad960a9 100644 --- a/include/ndarray/ArrayRef.h.m4 +++ b/include/ndarray/ArrayRef.h.m4 @@ -84,6 +84,14 @@ public: */ 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. */ diff --git a/include/ndarray/initialization.h b/include/ndarray/initialization.h index 56945f19..ad0b8b75 100644 --- a/include/ndarray/initialization.h +++ b/include/ndarray/initialization.h @@ -285,11 +285,25 @@ Array::Array(Size n1, Size n2, Size n3, Size n4, Size n5, Size n6, Size n this->operator=(ndarray::allocate(shape)); } +template +template +Array::Array(Vector const & shape) + : Super(0, CorePtr()) +{ + this->operator=(ndarray::allocate(shape.template cast())); +} + template ArrayRef::ArrayRef(Size n1, Size n2, Size n3, Size n4, Size n5, Size n6, Size n7, Size n8) : Super(Array(n1, n2, n3, n4, n5, n6, n7, n8)) {} +template +template +ArrayRef::ArrayRef(Vector const & shape) + : Super(Array(shape)) +{} + } // namespace ndarray #endif // !NDARRAY_initialization_h_INCLUDED diff --git a/tests/ndarray.cc b/tests/ndarray.cc index 6f2b4b37..1c42a655 100644 --- a/tests/ndarray.cc +++ b/tests/ndarray.cc @@ -88,7 +88,20 @@ BOOST_AUTO_TEST_CASE(allocation) { BOOST_CHECK_EQUAL(c.getStride<1>(), 5); BOOST_CHECK_EQUAL(c.getStride<2>(), 5*6); BOOST_CHECK_EQUAL(c.getStrides(), ndarray::makeVector(1, 5, 5*6)); - + + ndarray::Array d(shape); + BOOST_CHECK_EQUAL(d.getStrides(), shape); + BOOST_CHECK_EQUAL(d.getStrides(), a.getStrides()); + ndarray::Array e(shape); + BOOST_CHECK_EQUAL(e.getStrides(), shape); + BOOST_CHECK_EQUAL(e.getStrides(), c.getStrides()); + ndarray::Vector shape2(shape); + ndarray::Array f(shape2); + BOOST_CHECK_EQUAL(f.getStrides(), shape); + BOOST_CHECK_EQUAL(f.getStrides(), a.getStrides()); + ndarray::Array g(shape2); + BOOST_CHECK_EQUAL(g.getStrides(), shape); + BOOST_CHECK_EQUAL(g.getStrides(), c.getStrides()); } BOOST_AUTO_TEST_CASE(external) { From ca342666fcb928a38a8fea705017f3c586f1aeda Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Tue, 28 Jun 2016 09:17:18 -0400 Subject: [PATCH 014/102] Fix bug in tests introduced in a9616e70. --- tests/ndarray.cc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tests/ndarray.cc b/tests/ndarray.cc index 1c42a655..7729e4ad 100644 --- a/tests/ndarray.cc +++ b/tests/ndarray.cc @@ -90,17 +90,17 @@ BOOST_AUTO_TEST_CASE(allocation) { BOOST_CHECK_EQUAL(c.getStrides(), ndarray::makeVector(1, 5, 5*6)); ndarray::Array d(shape); - BOOST_CHECK_EQUAL(d.getStrides(), shape); + BOOST_CHECK_EQUAL(d.getShape(), shape); BOOST_CHECK_EQUAL(d.getStrides(), a.getStrides()); ndarray::Array e(shape); - BOOST_CHECK_EQUAL(e.getStrides(), shape); + BOOST_CHECK_EQUAL(e.getShape(), shape); BOOST_CHECK_EQUAL(e.getStrides(), c.getStrides()); ndarray::Vector shape2(shape); ndarray::Array f(shape2); - BOOST_CHECK_EQUAL(f.getStrides(), shape); + BOOST_CHECK_EQUAL(f.getShape(), shape); BOOST_CHECK_EQUAL(f.getStrides(), a.getStrides()); ndarray::Array g(shape2); - BOOST_CHECK_EQUAL(g.getStrides(), shape); + BOOST_CHECK_EQUAL(g.getShape(), shape); BOOST_CHECK_EQUAL(g.getStrides(), c.getStrides()); } From d6c794e6087b0b3cbadab4bcfc69012ba8e15e78 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Tue, 28 Jun 2016 08:54:29 -0400 Subject: [PATCH 015/102] Squash Eigen warnings on gcc 6. Eigen is planning to do this in v3.3, but that's not out yet, and it really is a ton of warnings. --- include/ndarray/eigen.h | 5 +++++ include/ndarray/eigen/bp/ReturnInternal.h | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/include/ndarray/eigen.h b/include/ndarray/eigen.h index 689576a8..f2cd09ee 100644 --- a/include/ndarray/eigen.h +++ b/include/ndarray/eigen.h @@ -18,6 +18,11 @@ * \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" diff --git a/include/ndarray/eigen/bp/ReturnInternal.h b/include/ndarray/eigen/bp/ReturnInternal.h index 19c46d57..96580d56 100644 --- a/include/ndarray/eigen/bp/ReturnInternal.h +++ b/include/ndarray/eigen/bp/ReturnInternal.h @@ -11,6 +11,11 @@ #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 From 9b84cd73e27a33304c62965ed7c4e64c473aa55d Mon Sep 17 00:00:00 2001 From: Pim Schellart Date: Tue, 6 Sep 2016 12:11:12 -0400 Subject: [PATCH 016/102] Add CMake build system --- CMakeLists.txt | 57 ++++++++++++++++++++ README | 10 ++++ cmake/FindEigen3.cmake | 83 ++++++++++++++++++++++++++++ cmake/FindFFTW.cmake | 119 +++++++++++++++++++++++++++++++++++++++++ cmake/FindNumPy.cmake | 90 +++++++++++++++++++++++++++++++ include/CMakeLists.txt | 23 ++++++++ tests/CMakeLists.txt | 31 +++++++++++ 7 files changed, 413 insertions(+) create mode 100644 CMakeLists.txt create mode 100644 cmake/FindEigen3.cmake create mode 100644 cmake/FindFFTW.cmake create mode 100644 cmake/FindNumPy.cmake create mode 100644 include/CMakeLists.txt create mode 100644 tests/CMakeLists.txt diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 00000000..59a143c8 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,57 @@ +cmake_minimum_required(VERSION 2.8) + +project(ndarray) + +option(NDARRAY_TEST "Enable tests?" ON) +option(NDARRAY_SWIG "Enable Swig?" ON) +option(NDARRAY_BOOST_PYTHON "Enable Boost Python?" OFF) +option(NDARRAY_PYBIND11 "Enable Pybind11?" 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}) + +# find required packages +find_package(PythonInterp REQUIRED) +find_package(PythonLibs REQUIRED) +find_package(NumPy REQUIRED) +find_package(Boost COMPONENTS unit_test_framework REQUIRED) +find_package(FFTW REQUIRED) + +# allow user to specify EIGEN_DIR as an environment variable +# this is necessary to integrate with build systems that install Eigen +# in non-standard locations +set(EIGEN3_INCLUDE_DIR $ENV{EIGEN_DIR}) +if(NOT EIGEN3_INCLUDE_DIR) + find_package(Eigen3 REQUIRED) +else() + set(EIGEN3_INCLUDE_DIR ${EIGEN3_INCLUDE_DIR}/include) +endif(NOT EIGEN3_INCLUDE_DIR) + +include_directories( + ${PROJECT_SOURCE_DIR}/include + ${PYTHON_INCLUDE_DIRS} + ${NUMPY_INCLUDE_DIRS} + ${Boost_INCLUDE_DIRS} + ${FFTW_INCLUDES} + ${EIGEN3_INCLUDE_DIR} + ) + +add_subdirectory(include) + +if(NDARRAY_TEST) + enable_testing() + add_subdirectory(tests) +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/README b/README index 7a52bb61..786ee9b6 100644 --- a/README +++ b/README @@ -23,6 +23,16 @@ 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: + + mkdir build + cd build + cmake .. + make + BUILDING FROM COMPRESSED SOURCE diff --git a/cmake/FindEigen3.cmake b/cmake/FindEigen3.cmake new file mode 100644 index 00000000..0ec08d29 --- /dev/null +++ b/cmake/FindEigen3.cmake @@ -0,0 +1,83 @@ +# - 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 + ) + + 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 new file mode 100644 index 00000000..6c4dc9ab --- /dev/null +++ b/cmake/FindFFTW.cmake @@ -0,0 +1,119 @@ +# - 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() + +# 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 new file mode 100644 index 00000000..ecae7e6b --- /dev/null +++ b/cmake/FindNumPy.cmake @@ -0,0 +1,90 @@ +# - 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/include/CMakeLists.txt b/include/CMakeLists.txt new file mode 100644 index 00000000..3c952272 --- /dev/null +++ b/include/CMakeLists.txt @@ -0,0 +1,23 @@ +# 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(PREPROCESS_FILES "") +foreach(FILENAME ${FILES}) + list(APPEND PREPROCESS_FILES "${CMAKE_CURRENT_SOURCE_DIR}/${FILENAME}") +endforeach(FILENAME) + +foreach(FILENAME ${PREPROCESS_FILES}) + add_custom_command ( + OUTPUT ${FILENAME} + DEPENDS ${FILENAME}.m4 + COMMAND m4 ${FILENAME}.m4 > ${FILENAME} + ) +endforeach(FILENAME) + +add_custom_target(preprocess_includes ALL DEPENDS ${PREPROCESS_FILES}) \ No newline at end of file diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt new file mode 100644 index 00000000..86a7d9d3 --- /dev/null +++ b/tests/CMakeLists.txt @@ -0,0 +1,31 @@ +add_executable(ndarray ndarray.cc) +target_link_libraries(ndarray ${Boost_LIBRARIES}) + +add_executable(views views.cc) +target_link_libraries(views ${Boost_LIBRARIES}) + +add_executable(ndarray-eigen ndarray-eigen.cc) +target_link_libraries(ndarray-eigen ${Boost_LIBRARIES}) + +add_executable(ndarray-fft ndarray-fft.cc) +target_link_libraries(ndarray-fft ${Boost_LIBRARIES} ${FFTW_LIBRARIES}) + +add_test(test_ndarray ndarray) +add_test(test_views views) +add_test(test_ndarray-fft ndarray-fft) +add_test(test_ndarray_eigen ndarray-eigen) + +if(NDARRAY_SWIG) + find_package(SWIG) + include(${SWIG_USE_FILE}) + + set_source_files_properties(swig_test_mod.i PROPERTIES CPLUSPLUS ON) + swig_add_module(swig_test_mod python swig_test_mod.i) + swig_link_libraries(swig_test_mod ${PYTHON_LIBRARIES}) + + find_package(PythonInterp REQUIRED) + configure_file(swig_test.py swig_test.py COPYONLY) + add_test(NAME swig_test + COMMAND ${PYTHON_EXECUTABLE} + ${CMAKE_CURRENT_BINARY_DIR}/swig_test.py) +endif(NDARRAY_SWIG) From bf2c1eedefb29b51ce7188e2fa7df813ff9f9f61 Mon Sep 17 00:00:00 2001 From: Pim Schellart Date: Fri, 9 Sep 2016 18:41:56 -0400 Subject: [PATCH 017/102] Enable Python 3 support for Swig wrapper --- cmake/FindPythonInterp.cmake | 165 ++++++++++++++ cmake/FindPythonLibs.cmake | 354 +++++++++++++++++++++++++++++ include/ndarray/swig/PyConverter.h | 31 +-- include/ndarray/swig/numpy.h | 12 +- tests/CMakeLists.txt | 8 +- tests/python_test.py | 28 +-- tests/python_test_mod.cc | 32 ++- 7 files changed, 595 insertions(+), 35 deletions(-) create mode 100644 cmake/FindPythonInterp.cmake create mode 100644 cmake/FindPythonLibs.cmake diff --git a/cmake/FindPythonInterp.cmake b/cmake/FindPythonInterp.cmake new file mode 100644 index 00000000..4117f7f5 --- /dev/null +++ b/cmake/FindPythonInterp.cmake @@ -0,0 +1,165 @@ +#.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 new file mode 100644 index 00000000..5e6e6f6b --- /dev/null +++ b/cmake/FindPythonLibs.cmake @@ -0,0 +1,354 @@ +#.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/include/ndarray/swig/PyConverter.h b/include/ndarray/swig/PyConverter.h index 202e4402..2d988bb7 100644 --- a/include/ndarray/swig/PyConverter.h +++ b/include/ndarray/swig/PyConverter.h @@ -103,7 +103,12 @@ template struct PyIntConverterBase : public PyConverterBase { static bool fromPythonStage1(PyPtr & input) { - if (!PyInt_Check(input.get()) && !PyLong_Check(input.get())) { + 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 = PyString_AsString(s.get()); @@ -139,16 +144,16 @@ struct PyIntConverter : public PyIntConverterBase { static bool fromPythonStage2(PyPtr const & input, T & output) { NDARRAY_ASSERT(input); - output = PyInt_AsLong(input.get()); + output = PyLong_AsLong(input.get()); if (PyErr_Occurred()) return false; // could get OverflowError here. return true; } static PyObject * toPython(T input) { - return PyInt_FromLong(input); + return PyLong_FromLong(input); } - static PyTypeObject const * getPyType() { return &PyInt_Type; } + static PyTypeObject const * getPyType() { return &PyLong_Type; } }; @@ -162,16 +167,16 @@ struct PyIntConverter : public PyIntConverterBase { static bool fromPythonStage2(PyPtr const & input, T & output) { NDARRAY_ASSERT(input); - output = PyInt_AsLong(input.get()); + output = PyLong_AsLong(input.get()); if (PyErr_Occurred()) return false; // could get OverflowError here. return true; } static PyObject * toPython(T input) { - return PyInt_FromLong(input); + return PyLong_FromLong(input); } - static PyTypeObject const * getPyType() { return &PyInt_Type; } + static PyTypeObject const * getPyType() { return &PyLong_Type; } }; @@ -185,16 +190,16 @@ struct PyIntConverter : public PyIntConverterBase { static bool fromPythonStage2(PyPtr const & input, T & output) { NDARRAY_ASSERT(input); - output = PyInt_AsLong(input.get()); + output = PyLong_AsLong(input.get()); if (PyErr_Occurred()) return false; // could get OverflowError here. return true; } static PyObject * toPython(T input) { - return PyInt_FromLong(input); + return PyLong_FromLong(input); } - static PyTypeObject const * getPyType() { return &PyInt_Type; } + static PyTypeObject const * getPyType() { return &PyLong_Type; } }; @@ -475,16 +480,16 @@ struct PyConverter< std::string > : public detail::PyConverterBase NDARRAY_ASSERT(input); char * buf = 0; Py_ssize_t size = 0; - if (PyString_AsStringAndSize(input.get(),&buf,&size) == -1) return false; + 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 PyString_FromStringAndSize(input.data(),input.size()); + return PyBytes_FromStringAndSize(input.data(),input.size()); } - static PyTypeObject const * getPyType() { return &PyString_Type; } + static PyTypeObject const * getPyType() { return &PyBytes_Type; } }; /// \endcond diff --git a/include/ndarray/swig/numpy.h b/include/ndarray/swig/numpy.h index 5f3cc981..4968e668 100644 --- a/include/ndarray/swig/numpy.h +++ b/include/ndarray/swig/numpy.h @@ -16,6 +16,7 @@ * @brief Python C-API conversions between ndarray and numpy. */ +#include "Python.h" #include "ndarray.h" #include "ndarray/swig/PyConverter.h" @@ -116,8 +117,9 @@ template <> struct NumpyTraits > { * @internal @ingroup ndarrayPythonInternalGroup * @brief A destructor for a Python CObject that owns a shared_ptr. */ -inline void destroyCObject(void * p) { - ndarray::Manager::Ptr * b = reinterpret_cast(p); +inline void destroyCapsule(PyObject * p) { + void * m = PyCapsule_GetPointer(p, "ndarray.Manager"); + ndarray::Manager::Ptr * b = reinterpret_cast(m); delete b; } @@ -283,7 +285,11 @@ struct PyConverter< Array > : public detail::PyConverterBase< Array(array.get())->base = owner; } diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 86a7d9d3..6527030b 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -19,9 +19,13 @@ if(NDARRAY_SWIG) find_package(SWIG) include(${SWIG_USE_FILE}) - set_source_files_properties(swig_test_mod.i PROPERTIES CPLUSPLUS ON) + set_property(SOURCE swig_test_mod.i PROPERTY CPLUSPLUS ON) swig_add_module(swig_test_mod python swig_test_mod.i) - swig_link_libraries(swig_test_mod ${PYTHON_LIBRARIES}) + if (APPLE) + swig_link_libraries(swig_test_mod "-undefined dynamic_lookup") + else () + swig_link_libraries(swig_test_mod ${PYTHON_LIBRARY}) + endif() find_package(PythonInterp REQUIRED) configure_file(swig_test.py swig_test.py COPYONLY) diff --git a/tests/python_test.py b/tests/python_test.py index c541d0fa..2f02b05c 100755 --- a/tests/python_test.py +++ b/tests/python_test.py @@ -17,36 +17,36 @@ class TestNDArray(unittest.TestCase): def testIntArrayConversion(self): a1 = numpy.zeros((5,3,4),dtype=numpy.int32) a2 = a1[:,:,:2] - self.assert_(a1.flags["WRITEABLE"]) - self.assert_(a2.flags["WRITEABLE"]) + self.assertTrue(a1.flags["WRITEABLE"]) + self.assertTrue(a2.flags["WRITEABLE"]) ua1 = numpy.zeros((5,3,4),dtype=numpy.uint32) - self.assert_(ua1.flags["WRITEABLE"]) + self.assertTrue(ua1.flags["WRITEABLE"]) b1 = python_test_mod.passIntArray33(a1) - self.assert_(b1.flags["WRITEABLE"]) + self.assertTrue(b1.flags["WRITEABLE"]) self.assertEqual(a1.shape,b1.shape) self.assertEqual(a1.strides,b1.strides) ub1 = python_test_mod.passUIntArray33(ua1) - self.assert_(ub1.flags["WRITEABLE"]) + self.assertTrue(ub1.flags["WRITEABLE"]) self.assertEqual(a1.shape,ub1.shape) self.assertEqual(a1.strides,ub1.strides) c1 = python_test_mod.passIntArray30(a1) - self.assert_(c1.flags["WRITEABLE"]) + 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.assert_(not d1.flags.writeable) + self.assertTrue(not d1.flags.writeable) self.assertRaises(ValueError, python_test_mod.passIntArray33, a2) c2 = python_test_mod.passIntArray30(a2) - self.assert_(c2.flags["WRITEABLE"]) + self.assertTrue(c2.flags["WRITEABLE"]) self.assertEqual(a2.shape,c2.shape) self.assertEqual(a2.strides,c2.strides) @@ -65,29 +65,29 @@ def testVectorConversion(self): def testArrayConversion(self): a1 = numpy.zeros((5,3,4),dtype=float) a2 = a1[:,:,:2] - self.assert_(a1.flags["WRITEABLE"]) - self.assert_(a2.flags["WRITEABLE"]) + self.assertTrue(a1.flags["WRITEABLE"]) + self.assertTrue(a2.flags["WRITEABLE"]) b1 = python_test_mod.passFloatArray33(a1) - self.assert_(b1.flags["WRITEABLE"]) + self.assertTrue(b1.flags["WRITEABLE"]) self.assertEqual(a1.shape,b1.shape) self.assertEqual(a1.strides,b1.strides) c1 = python_test_mod.passFloatArray30(a1) - self.assert_(c1.flags["WRITEABLE"]) + 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.assert_(not d1.flags.writeable) + self.assertTrue(not d1.flags.writeable) self.assertRaises(ValueError, python_test_mod.passFloatArray33, a2) c2 = python_test_mod.passFloatArray30(a2) - self.assert_(c2.flags["WRITEABLE"]) + self.assertTrue(c2.flags["WRITEABLE"]) self.assertEqual(a2.shape,c2.shape) self.assertEqual(a2.strides,c2.strides) diff --git a/tests/python_test_mod.cc b/tests/python_test_mod.cc index f4cf15ab..e73bee88 100644 --- a/tests/python_test_mod.cc +++ b/tests/python_test_mod.cc @@ -16,6 +16,15 @@ #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; @@ -63,10 +72,27 @@ static PyMethodDef methods[] = { {NULL} }; -extern "C" -PyMODINIT_FUNC -initpython_test_mod(void) { +/* 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 428ad1cb0a62a24b8c422cb1f6ce0da46727b965 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Wed, 21 Sep 2016 14:23:38 -0400 Subject: [PATCH 018/102] Add swap() and reset() to EigenView. swap() in particular replaces an incorrect one inherited from MatrixBase, which led to segfaults if used. --- include/ndarray/eigen.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/include/ndarray/eigen.h b/include/ndarray/eigen.h index f2cd09ee..6c0600d0 100644 --- a/include/ndarray/eigen.h +++ b/include/ndarray/eigen.h @@ -353,9 +353,11 @@ class EigenView Array const & shallow() const { return _array; } ArrayRef deep() const { return _array.deep(); } - void reset(Array const & array) { _array = array; checkDimensions(); } + 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); } + private: Array _array; }; From 503a6b3bd492a12244ea1430c3808b1708be5dc9 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 30 Sep 2016 23:00:24 -0400 Subject: [PATCH 019/102] Allow use of inherited Eigen swap() as well --- include/ndarray/eigen.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/include/ndarray/eigen.h b/include/ndarray/eigen.h index 6c0600d0..27987705 100644 --- a/include/ndarray/eigen.h +++ b/include/ndarray/eigen.h @@ -358,6 +358,8 @@ class EigenView void swap(EigenView & other) { _array.swap(other._array); } + using Base::swap; + private: Array _array; }; From 841616f9e2ad5883d35cd99509865a4c3880c025 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 30 Sep 2016 23:02:59 -0400 Subject: [PATCH 020/102] Fix class/struct inconsistency in friend declaration. --- include/ndarray/formatting.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/ndarray/formatting.h b/include/ndarray/formatting.h index 52f4bc58..5248f463 100644 --- a/include/ndarray/formatting.h +++ b/include/ndarray/formatting.h @@ -63,7 +63,7 @@ class FormatOptions { detail::Formatter::apply(*this,os,expr,0); } - template friend struct detail::Formatter; + template friend class detail::Formatter; }; /// @brief Stream output for ExpressionBase using default-constructed FormatOptions. From f740e261d4fb18ef7a11803e3e2cbfe853632d24 Mon Sep 17 00:00:00 2001 From: Pim Schellart Date: Mon, 19 Sep 2016 18:44:39 -0400 Subject: [PATCH 021/102] Add support for pybind11 --- CMakeLists.txt | 11 +- cmake/FindPybind11.cmake | 43 ++++ include/ndarray.i | 2 +- include/ndarray/converter.h | 50 +++++ .../ndarray/{swig => converter}/PyConverter.h | 40 ++-- include/ndarray/{swig => converter}/Vector.h | 14 +- include/ndarray/{swig => converter}/eigen.h | 18 +- include/ndarray/{swig => converter}/numpy.h | 38 ++-- .../ndarray/{swig => converter}/ufunctors.h | 22 +- include/ndarray/pybind11.h | 207 ++++++++++++++++++ include/ndarray/swig.h | 6 +- tests/CMakeLists.txt | 21 +- tests/pybind11_test.py | 78 +++++++ tests/pybind11_test_mod.cc | 135 ++++++++++++ tests/swig_test_mod.i | 2 +- 15 files changed, 613 insertions(+), 74 deletions(-) create mode 100644 cmake/FindPybind11.cmake create mode 100644 include/ndarray/converter.h rename include/ndarray/{swig => converter}/PyConverter.h (95%) rename include/ndarray/{swig => converter}/Vector.h (93%) rename include/ndarray/{swig => converter}/eigen.h (94%) rename include/ndarray/{swig => converter}/numpy.h (95%) rename include/ndarray/{swig => converter}/ufunctors.h (93%) create mode 100644 include/ndarray/pybind11.h create mode 100755 tests/pybind11_test.py create mode 100644 tests/pybind11_test_mod.cc diff --git a/CMakeLists.txt b/CMakeLists.txt index 59a143c8..bbba6160 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,4 +1,4 @@ -cmake_minimum_required(VERSION 2.8) +cmake_minimum_required(VERSION 2.8.11) project(ndarray) @@ -31,6 +31,14 @@ else() set(EIGEN3_INCLUDE_DIR ${EIGEN3_INCLUDE_DIR}/include) endif(NOT EIGEN3_INCLUDE_DIR) +if (NDARRAY_SWIG) + find_package(SWIG REQUIRED) +endif (NDARRAY_SWIG) + +if (NDARRAY_PYBIND11) + find_package(Pybind11 REQUIRED) +endif (NDARRAY_PYBIND11) + include_directories( ${PROJECT_SOURCE_DIR}/include ${PYTHON_INCLUDE_DIRS} @@ -38,6 +46,7 @@ include_directories( ${Boost_INCLUDE_DIRS} ${FFTW_INCLUDES} ${EIGEN3_INCLUDE_DIR} + ${PYBIND11_INCLUDE_DIR} ) add_subdirectory(include) diff --git a/cmake/FindPybind11.cmake b/cmake/FindPybind11.cmake new file mode 100644 index 00000000..f2c8216b --- /dev/null +++ b/cmake/FindPybind11.cmake @@ -0,0 +1,43 @@ +#.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/include/ndarray.i b/include/ndarray.i index d147f543..0f1d39a8 100644 --- a/include/ndarray.i +++ b/include/ndarray.i @@ -11,7 +11,7 @@ %{ #include "ndarray.h" #include "ndarray/swig.h" -#include "ndarray/swig/eigen.h" +#include "ndarray/converter/eigen.h" #include %} diff --git a/include/ndarray/converter.h b/include/ndarray/converter.h new file mode 100644 index 00000000..d5aa2825 --- /dev/null +++ b/include/ndarray/converter.h @@ -0,0 +1,50 @@ +/* + * 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/swig/PyConverter.h b/include/ndarray/converter/PyConverter.h similarity index 95% rename from include/ndarray/swig/PyConverter.h rename to include/ndarray/converter/PyConverter.h index 2d988bb7..0b544c9a 100644 --- a/include/ndarray/swig/PyConverter.h +++ b/include/ndarray/converter/PyConverter.h @@ -8,11 +8,11 @@ * of the source distribution, or alternately available at: * https://github.com/ndarray/ndarray */ -#ifndef NDARRAY_SWIG_PyConverter_h_INCLUDED -#define NDARRAY_SWIG_PyConverter_h_INCLUDED +#ifndef NDARRAY_CONVERTER_PyConverter_h_INCLUDED +#define NDARRAY_CONVERTER_PyConverter_h_INCLUDED /** - * @file ndarray/swig/PyConverter.h + * @file ndarray/converter/PyConverter.h * @brief Python C-API conversions for standard numeric types. */ #include @@ -44,15 +44,15 @@ namespace detail { */ template struct PyConverterBase { - + /** * @brief Check if a Python object might be convertible to T. * - * \return true if the conversion may be successful, and + * \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 SWIG or + * 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. @@ -90,7 +90,7 @@ struct PyConverterBase { if (!PyConverter::fromPythonStage1(p)) return false; return PyConverter::fromPythonStage2(arg,*output); } - + }; /** @@ -111,7 +111,7 @@ struct PyIntConverterBase : public PyConverterBase { ) { PyPtr s(PyObject_Repr(input.get())); if (!s) return false; - char * cs = PyString_AsString(s.get()); + char * cs = PyBytes_AsString(s.get()); if (!cs) return false; PyErr_Format(PyExc_TypeError, "'%s' is not a valid C++ integer value.", cs); } @@ -296,7 +296,7 @@ struct PyIntConverter : public PyIntConverterBase { 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 @@ -350,7 +350,7 @@ struct PyConverter : public detail::PyConverterBase { if (!PyBool_Check(input.get())) { PyPtr s(PyObject_Repr(input.get())); if (!s) return false; - char * cs = PyString_AsString(s.get()); + char * cs = PyBytes_AsString(s.get()); if (!cs) return false; PyErr_Format(PyExc_TypeError,"'%s' is not a valid C++ bool value.",cs); } @@ -387,7 +387,7 @@ struct PyConverter : public detail::PyConverterBase { if (!PyFloat_Check(input.get())) { PyPtr s(PyObject_Repr(input.get())); if (!s) return false; - char * cs = PyString_AsString(s.get()); + char * cs = PyBytes_AsString(s.get()); if (!cs) return false; PyErr_Format(PyExc_TypeError,"'%s' is not a valid C++ float value.",cs); } @@ -403,7 +403,7 @@ struct PyConverter : public detail::PyConverterBase { static PyObject * toPython(float input) { return PyFloat_FromDouble(input); } - + static PyTypeObject const * getPyType() { return &PyFloat_Type; } }; @@ -414,7 +414,7 @@ struct PyConverter : public detail::PyConverterBase { if (!PyFloat_Check(input.get())) { PyPtr s(PyObject_Repr(input.get())); if (!s) return false; - char * cs = PyString_AsString(s.get()); + char * cs = PyBytes_AsString(s.get()); if (!cs) return false; PyErr_Format(PyExc_TypeError,"'%s' is not a valid C++ double value.",cs); } @@ -430,7 +430,7 @@ struct PyConverter : public detail::PyConverterBase { static PyObject * toPython(double input) { return PyFloat_FromDouble(input); } - + static PyTypeObject const * getPyType() { return &PyFloat_Type; } }; @@ -441,7 +441,7 @@ struct PyConverter< std::complex > : public detail::PyConverterBase< std::com if (!PyComplex_Check(input.get())) { PyPtr s(PyObject_Repr(input.get())); if (!s) return false; - char * cs = PyString_AsString(s.get()); + char * cs = PyBytes_AsString(s.get()); if (!cs) return false; PyErr_Format(PyExc_TypeError,"'%s' is not a valid C++ complex value.",cs); } @@ -458,7 +458,7 @@ struct PyConverter< std::complex > : public detail::PyConverterBase< std::com static PyObject * toPython(std::complex const & input) { return PyComplex_FromDoubles(input.real(),input.imag()); } - + static PyTypeObject const * getPyType() { return &PyComplex_Type; } }; @@ -466,10 +466,10 @@ template <> struct PyConverter< std::string > : public detail::PyConverterBase { static bool fromPythonStage1(PyPtr & input) { - if (!PyString_Check(input.get())) { + if (!PyBytes_Check(input.get())) { PyPtr s(PyObject_Repr(input.get())); if (!s) return false; - char * cs = PyString_AsString(s.get()); + char * cs = PyBytes_AsString(s.get()); if (!cs) return false; PyErr_Format(PyExc_TypeError,"'%s' is not a valid C++ string value.",cs); } @@ -488,7 +488,7 @@ struct PyConverter< std::string > : public detail::PyConverterBase static PyObject * toPython(std::string const & input) { return PyBytes_FromStringAndSize(input.data(),input.size()); } - + static PyTypeObject const * getPyType() { return &PyBytes_Type; } }; @@ -496,4 +496,4 @@ struct PyConverter< std::string > : public detail::PyConverterBase } // namespace ndarray -#endif // !NDARRAY_SWIG_PyConverter_h_INCLUDED +#endif // !NDARRAY_CONVERTER_PyConverter_h_INCLUDED diff --git a/include/ndarray/swig/Vector.h b/include/ndarray/converter/Vector.h similarity index 93% rename from include/ndarray/swig/Vector.h rename to include/ndarray/converter/Vector.h index d320c375..4ae8eadf 100644 --- a/include/ndarray/swig/Vector.h +++ b/include/ndarray/converter/Vector.h @@ -8,15 +8,15 @@ * of the source distribution, or alternately available at: * https://github.com/ndarray/ndarray */ -#ifndef NDARRAY_SWIG_Vector_h_INCLUDED -#define NDARRAY_SWIG_Vector_h_INCLUDED +#ifndef NDARRAY_CONVERTER_Vector_h_INCLUDED +#define NDARRAY_CONVERTER_Vector_h_INCLUDED -/** - * @file ndarray/swig/Vector.h +/** + * @file ndarray/converter/Vector.h * @brief Python C-API conversions for Vector. */ -#include "ndarray/swig/PyConverter.h" +#include "ndarray/converter/PyConverter.h" namespace ndarray { @@ -27,7 +27,7 @@ namespace ndarray { 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 @@ -102,4 +102,4 @@ struct PyConverter< Vector > : public detail::PyConverterBase< Vector } // namespace ndarray -#endif // !NDARRAY_SWIG_Vector_h_INCLUDED +#endif // !NDARRAY_CONVERTER_Vector_h_INCLUDED diff --git a/include/ndarray/swig/eigen.h b/include/ndarray/converter/eigen.h similarity index 94% rename from include/ndarray/swig/eigen.h rename to include/ndarray/converter/eigen.h index cc52695f..401b4362 100644 --- a/include/ndarray/swig/eigen.h +++ b/include/ndarray/converter/eigen.h @@ -8,17 +8,17 @@ * of the source distribution, or alternately available at: * https://github.com/ndarray/ndarray */ -#ifndef NDARRAY_SWIG_eigen_h_INCLUDED -#define NDARRAY_SWIG_eigen_h_INCLUDED +#ifndef NDARRAY_CONVERTER_eigen_h_INCLUDED +#define NDARRAY_CONVERTER_eigen_h_INCLUDED /** - * @file ndarray/swig/eigen.h + * @file ndarray/converter/eigen.h * @brief Python C-API conversions for Eigen matrices. */ #include "ndarray/eigen.h" -#include "ndarray/swig.h" -#include "ndarray/swig/eigen.h" +#include "ndarray/converter.h" +#include "ndarray/converter/eigen.h" namespace ndarray { @@ -28,7 +28,7 @@ namespace ndarray { */ 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())) { @@ -131,7 +131,7 @@ class EigenPyConverter : public detail::PyConverterBase { */ template struct PyConverter< Eigen::Matrix > - : public detail::EigenPyConverter< Eigen::Matrix > + : public detail::EigenPyConverter< Eigen::Matrix > {}; /** @@ -140,9 +140,9 @@ struct PyConverter< Eigen::Matrix > */ template struct PyConverter< Eigen::Array > - : public detail::EigenPyConverter< Eigen::Array > + : public detail::EigenPyConverter< Eigen::Array > {}; } // namespace ndarray -#endif // !NDARRAY_SWIG_eigen_h_INCLUDED +#endif // !NDARRAY_CONVERTER_eigen_h_INCLUDED diff --git a/include/ndarray/swig/numpy.h b/include/ndarray/converter/numpy.h similarity index 95% rename from include/ndarray/swig/numpy.h rename to include/ndarray/converter/numpy.h index 4968e668..e71b36f8 100644 --- a/include/ndarray/swig/numpy.h +++ b/include/ndarray/converter/numpy.h @@ -8,31 +8,31 @@ * of the source distribution, or alternately available at: * https://github.com/ndarray/ndarray */ -#ifndef NDARRAY_SWIG_numpy_h_INCLUDED -#define NDARRAY_SWIG_numpy_h_INCLUDED +#ifndef NDARRAY_CONVERTER_numpy_h_INCLUDED +#define NDARRAY_CONVERTER_numpy_h_INCLUDED -/** - * @file ndarray/swig/numpy.h +/** + * @file ndarray/converter/numpy.h * @brief Python C-API conversions between ndarray and numpy. */ #include "Python.h" #include "ndarray.h" -#include "ndarray/swig/PyConverter.h" +#include "ndarray/converter/PyConverter.h" namespace ndarray { namespace detail { -/** +/** * @internal @ingroup ndarrayPythonInternalGroup - * @brief Traits class that specifies Numpy typecodes for numeric types. + * @brief Traits class that specifies Numpy typecodes for numeric types. */ -template struct NumpyTraits { - static int getCode(); +template struct NumpyTraits { + static int getCode(); }; /// \cond SPECIALIZATIONS - + template <> struct NumpyTraits { static int getCode() { if (sizeof(bool)==sizeof(npy_bool)) return NPY_BOOL; @@ -96,24 +96,24 @@ template <> struct NumpyTraits { static int getCode() { return NPY_C template <> struct NumpyTraits { static int getCode() { return NPY_CDOUBLE; } }; template <> struct NumpyTraits { static int getCode() { return NPY_CLONGDOUBLE; } }; -template <> struct NumpyTraits > { +template <> struct NumpyTraits > { static int getCode() { assert(sizeof(std::complex)==sizeof(npy_cfloat)); return NPY_CFLOAT; } }; -template <> struct NumpyTraits > { +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; +template <> struct NumpyTraits > { + static int getCode() { + assert(sizeof(std::complex)==sizeof(npy_clongdouble)); + return NPY_CLONGDOUBLE; } }; /// \endcond -/** +/** * @internal @ingroup ndarrayPythonInternalGroup * @brief A destructor for a Python CObject that owns a shared_ptr. */ @@ -202,7 +202,7 @@ struct PyConverter< Array > : public detail::PyConverterBase< Array > : public detail::PyConverterBase< Array struct PyUnaryUFunctor { @@ -59,17 +59,17 @@ struct PyUnaryUFunctor { Py_DECREF(iter); return PyArray_Return(reinterpret_cast(output_array)); } - + }; -template struct PyBinaryUFunctor { - static PyObject* _call_(TBinaryFunctor const& self, PyObject* input1, PyObject* input2, + static PyObject* _call_(TBinaryFunctor const& self, PyObject* input1, PyObject* input2, PyObject* output) { PyObject* input1_array = PyArray_FROM_OTF(input1,detail::NumpyTraits::getCode(), NPY_ALIGNED); @@ -121,9 +121,9 @@ struct PyBinaryUFunctor { Py_DECREF(iter); return PyArray_Return(reinterpret_cast(output_array)); } - + }; } // namespace ndarray -#endif // !NDARRAY_SWIG_ufunctors_h_INCLUDED +#endif // !NDARRAY_CONVERTER_ufunctors_h_INCLUDED diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h new file mode 100644 index 00000000..22e59720 --- /dev/null +++ b/include/ndarray/pybind11.h @@ -0,0 +1,207 @@ +/* + * LSST Data Management System + * Copyright 2008-2016 AURA/LSST. + * + * 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_pybind11_h_INCLUDED +#define NDARRAY_pybind11_h_INCLUDED + +/** + * @file ndarray/pybind11.h + * @brief Public header file for pybind11-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 "pybind11.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" + +NAMESPACE_BEGIN(pybind11) +NAMESPACE_BEGIN(detail) + +/* @brief A pybind11 type_caster for ndarray::Array + */ +template +class type_caster< ndarray::Array > { +public: + bool load(handle src, bool) { + _src.reset(src.ptr(), 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); + } + void set_value() { + if (!ndarray::PyConverter< ndarray::Array >::fromPythonStage2(_src, _value)) { + throw error_already_set(); + } + } +/* 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; +public: + 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 * () { set_value(); return &_value; } + operator ndarray::Array & () { set_value(); return _value; } + template using cast_op_type = pybind11::detail::cast_op_type<_T>; +}; + +/* @brief A pybind11 type_caster for ndarray::EigenView + */ +template +class type_caster< ndarray::EigenView > { +public: + bool load(handle src, bool) { + _src.reset(src.ptr(), true); // keep alive for stage 2 + if (!ndarray::PyConverter< ndarray::EigenView >::fromPythonStage1(_src)) { + PyErr_Clear(); + return false; + } + return true; + } + static handle cast(const ndarray::EigenView &src, return_value_policy /* policy */, handle /* parent */) { + return ndarray::PyConverter< ndarray::EigenView >::toPython(src); + } + void set_value() { + if (!ndarray::PyConverter< ndarray::EigenView >::fromPythonStage2(_src, _value)) { + throw error_already_set(); + } + } +/* 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; +public: + 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 * () { set_value(); return &_value; } + operator ndarray::EigenView & () { set_value(); return _value; } + template using cast_op_type = pybind11::detail::cast_op_type<_T>; +}; + +/* @brief A pybind11 type_caster for Eigen::Array + */ +template +class type_caster< Eigen::Array > { +public: + bool load(handle src, bool) { + _src.reset(src.ptr(), 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); + } + void set_value() { + if (!ndarray::PyConverter< Eigen::Array >::fromPythonStage2(_src, _value)) { + throw error_already_set(); + } + } +/* 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; +public: + 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 * () { set_value(); return &_value; } + operator Eigen::Array & () { set_value(); return _value; } + template using cast_op_type = pybind11::detail::cast_op_type<_T>; +}; + +/* @brief A pybind11 type_caster for Eigen::Matrix + */ +template +class type_caster< Eigen::Matrix > { +public: + bool load(handle src, bool) { + _src.reset(src.ptr(), 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); + } + void set_value() { + if (!ndarray::PyConverter< Eigen::Matrix >::fromPythonStage2(_src, _value)) { + throw error_already_set(); + } + } +/* 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; +public: + 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 * () { set_value(); return &_value; } + operator Eigen::Matrix & () { set_value(); return _value; } + template using cast_op_type = pybind11::detail::cast_op_type<_T>; +}; + +NAMESPACE_END(detail) +NAMESPACE_END(pybind11) + +#endif // !NDARRAY_pybind11_h_INCLUDED diff --git a/include/ndarray/swig.h b/include/ndarray/swig.h index d3bf56b3..9f452e43 100644 --- a/include/ndarray/swig.h +++ b/include/ndarray/swig.h @@ -31,8 +31,8 @@ #include "Python.h" #include "ndarray.h" -#include "ndarray/swig/numpy.h" -#include "ndarray/swig/ufunctors.h" -#include "ndarray/swig/Vector.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 6527030b..ff119374 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -16,15 +16,15 @@ add_test(test_ndarray-fft ndarray-fft) add_test(test_ndarray_eigen ndarray-eigen) if(NDARRAY_SWIG) - find_package(SWIG) 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 ${PYTHON_LIBRARY}) + swig_link_libraries(swig_test_mod "-shared") endif() find_package(PythonInterp REQUIRED) @@ -33,3 +33,20 @@ if(NDARRAY_SWIG) COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/swig_test.py) endif(NDARRAY_SWIG) + +if(NDARRAY_PYBIND11) + 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() + + configure_file(pybind11_test.py pybind11_test.py COPYONLY) + add_test(NAME pybind11_test + COMMAND ${PYTHON_EXECUTABLE} + ${CMAKE_CURRENT_BINARY_DIR}/pybind11_test.py) +endif(NDARRAY_PYBIND11) diff --git a/tests/pybind11_test.py b/tests/pybind11_test.py new file mode 100755 index 00000000..8855acb3 --- /dev/null +++ b/tests/pybind11_test.py @@ -0,0 +1,78 @@ +# -*- 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 pybind11_test_mod +import unittest + +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)) + + 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)) + + 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)) + a3 = pybind11_test_mod.returnConstArray1() + self.assert_((a1 == a3).all()) + self.assert_(a3.flags["WRITEABLE"] == False) + + 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)) + a3 = pybind11_test_mod.returnConstArray3() + self.assert_((a1 == a3).all()) + self.assert_(a3.flags["WRITEABLE"] == False) + + 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)) + + 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 + array = numpy.zeros(1, dtype=float) + # just test that these don't throw + pybind11_test_mod.acceptArray10(array) + pybind11_test_mod.acceptArray10(array) + array = numpy.zeros(0, dtype=float) + pybind11_test_mod.acceptArray10(array) + pybind11_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, pybind11_test_mod.acceptArray10, table['f1']) + + +if __name__ == "__main__": + unittest.main() diff --git a/tests/pybind11_test_mod.cc b/tests/pybind11_test_mod.cc new file mode 100644 index 00000000..37703a22 --- /dev/null +++ b/tests/pybind11_test_mod.cc @@ -0,0 +1,135 @@ +#include "pybind11/pybind11.h" + +#include "numpy/arrayobject.h" +#include "ndarray/pybind11.h" +#include "ndarray/converter.h" + +namespace py = pybind11; + +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 (int 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 (int i = 0; i < a1.getSize<0>(); ++i) { + for (int 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 & getMember() { return member; } + explicit MatrixOwner() : member(MemberMatrix::Zero()) {} +}; + +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<>()); + + py::class_(cls, "MemberMatrix"); + + cls.def_readwrite("member", &MatrixOwner::member); + cls.def("getMember", &MatrixOwner::getMember); + mod.def("returnMatrixXd", returnMatrixXd); + mod.def("returnMatrix2d", returnMatrix2d); + mod.def("returnArray1", returnArray1); + mod.def("returnConstArray1", returnConstArray1); + mod.def("returnArray3", returnArray3); + mod.def("returnConstArray3", returnConstArray3); + mod.def("acceptMatrixXd", acceptMatrixXd); + mod.def("acceptMatrix2d", acceptMatrix2d); + mod.def("acceptArray1", acceptArray1); + mod.def("acceptArray10", acceptArray10); + mod.def("acceptArray3", acceptArray3); + mod.def("acceptOverload", (int (*)(int)) acceptOverload); + mod.def("acceptOverload", (int (*)(Eigen::Matrix2d const &)) acceptOverload); + mod.def("acceptOverload", (int (*)(Eigen::Matrix3d const &)) acceptOverload); + + return mod.ptr(); +} \ No newline at end of file diff --git a/tests/swig_test_mod.i b/tests/swig_test_mod.i index 143cd1af..10854470 100644 --- a/tests/swig_test_mod.i +++ b/tests/swig_test_mod.i @@ -13,7 +13,7 @@ #define PY_ARRAY_UNIQUE_SYMBOL LSST_SWIG_TEST_NUMPY_ARRAY_API #include "numpy/arrayobject.h" #include "ndarray/swig.h" -#include "ndarray/swig/eigen.h" +#include "ndarray/converter/eigen.h" #ifdef __GNUC__ #pragma GCC diagnostic ignored "-Wuninitialized" #endif From 4ba3db9d3822ab016c829f95a9374010ad39aa02 Mon Sep 17 00:00:00 2001 From: Russell Owen Date: Tue, 17 Jan 2017 12:36:58 -0800 Subject: [PATCH 022/102] Change a struct to class to end clang warnings --- include/ndarray/ArrayRef.h.m4 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/ndarray/ArrayRef.h.m4 b/include/ndarray/ArrayRef.h.m4 index 9ad960a9..ee5da55b 100644 --- a/include/ndarray/ArrayRef.h.m4 +++ b/include/ndarray/ArrayRef.h.m4 @@ -164,7 +164,7 @@ private: template friend class ArrayRef; template friend struct ArrayTraits; template friend class ArrayBase; - template friend struct detail::ArrayAccess; + template friend class detail::ArrayAccess; /// @internal @brief Construct an ArrayRef from a pointer and Core. ArrayRef(T * data, CorePtr const & core) : Super(data, core) {} From 3ccaffa52eeb34dcd2aba9590e403ec5d7b6ef05 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Tue, 7 Mar 2017 15:00:24 -0800 Subject: [PATCH 023/102] Add Doxygen build to CMake, Travis CI, and doc deployment. --- .travis.yml | 27 + CMakeLists.txt | 12 + README => README.md | 16 +- doxygen.conf.in | 2280 +++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 2331 insertions(+), 4 deletions(-) create mode 100644 .travis.yml rename README => README.md (75%) create mode 100644 doxygen.conf.in diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..b765a956 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,27 @@ +sudo: required +dist: trusty +language: cpp + +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 + +script: + - mkdir build + - cd build + - cmake -DPYTHON_EXECUTABLE=$PYTHON .. && make && make test ARGS="-V" + - make doc + +env: + - PYTHON=/usr/bin/python + - PYTHON=/usr/bin/python3 + +deploy: + provider: pages + skip_cleanup: true + github_token: $GITHUB_TOKEN # Set in travis-ci.org dashboard + on: + branch: master + local_dir: html diff --git a/CMakeLists.txt b/CMakeLists.txt index bbba6160..a2dc9450 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -51,6 +51,18 @@ include_directories( 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 +) +endif(DOXYGEN_FOUND) + if(NDARRAY_TEST) enable_testing() add_subdirectory(tests) diff --git a/README b/README.md similarity index 75% rename from README rename to README.md index 786ee9b6..c09269c1 100644 --- a/README +++ b/README.md @@ -1,13 +1,20 @@ +ndarray: NumPy-friendly multidimensional arrays in C++ +====================================================== +[![Build Status](https://travis-ci.org/ndarray/ndarray.svg?branch=master)](https://travis-ci.org/ndarray/ndarray) + ndarray is a template library that provides multidimensional array 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 Doxygen-generated documentation +More information can be found in the [documentation at +ndarray.github.io/ndarray](http://ndarray.github.io/ndarray/). + (which is unhelpfully not built automatically at present...read ndarray.h instead). -BUILDING FROM GIT +Building from Git +----------------- ndarray includes the Boost.NumPy library using git's "submodules" feature. When you clone the ndarray repository with git, you'll get @@ -34,11 +41,12 @@ build with cmake, do: make -BUILDING FROM COMPRESSED SOURCE +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. \ No newline at end of file +source so they can be built directly. diff --git a/doxygen.conf.in b/doxygen.conf.in new file mode 100644 index 00000000..ad7bedf6 --- /dev/null +++ b/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 +# , /