From 68eba3a60c5d94a9ff1374735c95a030cbdb7d3a Mon Sep 17 00:00:00 2001 From: Pierre Kestener Date: Tue, 17 Mar 2020 14:22:01 +0100 Subject: [PATCH 01/29] fix class type_caster reported in issue 77 --- include/ndarray/pybind11.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index 09eefac8..db0f5ff9 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -218,7 +218,7 @@ class type_caster< ndarray::Array > { return Helper::toPython(src); } - static PYBIND11_DESCR name() { return type_descr(_>()); } + static constexpr auto name = type_descr(_>()); static handle cast(const ndarray::Array *src, return_value_policy policy, handle parent) { return cast(*src, policy, parent); From 6fbb36c813c077d73dcfa0b2e32317998d0a23f6 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Sat, 19 Sep 2020 16:18:50 -0400 Subject: [PATCH 02/29] Directly report python type in pybind11 type caster. It looks to me like type_descr is only supposed to be used for regular wrapped types, not custom type casters of the sort we have here. And happily we don't need to use its magic to look up the right Python type from a compete (i.e. template-instantiated) C++ type, because we know all ndarray type casters map to "numpy.ndarray" regardless of their template parameters. --- include/ndarray/pybind11.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index db0f5ff9..5af4bcb9 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -218,7 +218,7 @@ class type_caster< ndarray::Array > { return Helper::toPython(src); } - static constexpr auto name = type_descr(_>()); + static constexpr auto name = _("numpy.ndarray"); static handle cast(const ndarray::Array *src, return_value_policy policy, handle parent) { return cast(*src, policy, parent); From b6350f850fd1a74b0fb09ad07a9a557a310bb0d4 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 8 Jan 2021 12:56:00 -0500 Subject: [PATCH 03/29] Avoid use of pybind11's namespace macro for version compatibility. The names of these macros apparently changed between 2.5 and 2.6, but we don't need them anyway, and the namespaces themselves did not change. This resolves #11. --- include/ndarray/pybind11.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/include/ndarray/pybind11.h b/include/ndarray/pybind11.h index 5af4bcb9..5d216dee 100644 --- a/include/ndarray/pybind11.h +++ b/include/ndarray/pybind11.h @@ -196,8 +196,8 @@ Pybind11Helper { } // namespace ndarray -NAMESPACE_BEGIN(pybind11) -NAMESPACE_BEGIN(detail) +namespace pybind11 { +namespace detail { /* @brief A pybind11 type_caster for ndarray::Array */ @@ -242,7 +242,7 @@ class type_caster< ndarray::Array > { Helper _helper; }; -NAMESPACE_END(detail) -NAMESPACE_END(pybind11) +} // namespace detail +} // namespace pybind11 #endif // !NDARRAY_pybind11_h_INCLUDED From f30938f7f507f833de8d7693b5c7fdedc9151408 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 8 Jan 2021 13:21:54 -0500 Subject: [PATCH 04/29] Switch from Travis CI to GitHub Actions. This does not include doc deploy yet. --- .github/workflows/build.yaml | 59 ++++++++++++++++++++++++++++++++++++ .travis.yml | 54 --------------------------------- README.md | 2 +- etc/conda-forge-testing.yaml | 11 +++++++ 4 files changed, 71 insertions(+), 55 deletions(-) create mode 100644 .github/workflows/build.yaml delete mode 100644 .travis.yml create mode 100644 etc/conda-forge-testing.yaml diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 00000000..81b4219e --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,59 @@ +name: build_and_test + +on: + - pull_request + +env: + # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.) + BUILD_TYPE: Release + +jobs: + build_and_test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [2.7, 3.7, 3.8, 3.9] + steps: + - uses: actions/checkout@v2 + - uses: conda-incubator/setup-miniconda@v2 + with: + auto-update-conda: true + miniconda-version: "latest" + channel-priority: strict + channels: conda-forge + python-version: ${{ matrix.python-version }} + environment-file: etc/conda-forge-testing.yaml + activate-environment: ndarray + + - name: Create Build Environment + # Some projects don't allow in-source building, so create a separate build directory + # We'll use this as our working directory for all subsequent commands + run: cmake -E make_directory ${{github.workspace}}/build + + - name: Configure CMake + # Use a bash shell so we can use the same syntax for environment variable + # access regardless of the host operating system + shell: bash -l {0} + working-directory: ${{github.workspace}}/build + # Note the current convention is to use the -S and -B options here to specify source + # and build directories, but this is only available with CMake 3.13 and higher. + # The CMake binaries on the Github Actions machines are (as of this writing) 3.12 + run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DBoost_NO_BOOST_CMAKE=ON -DNDARRAY_PYBIND11=ON -DCMAKE_PREFIX_PATH=$CONDA_PREFIX + + - name: Build + working-directory: ${{github.workspace}}/build + shell: bash -l {0} + # Execute the build. You can specify a specific target with "--target " + run: cmake --build . --config $BUILD_TYPE + + - name: Test + working-directory: ${{github.workspace}}/build + shell: bash -l {0} + # Execute tests defined by the CMake configuration. + # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail + run: ctest -C $BUILD_TYPE + + - name: Build Documentation + working-directory: ${{github.workspace}}/build + shell: bash -l {0} + run: make doc diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index f55cc76a..00000000 --- a/.travis.yml +++ /dev/null @@ -1,54 +0,0 @@ -dist: xenial -language: python -python: - # We don't actually use the Travis Python, but this keeps it organized. - - "2.7" - - "3.6" - - "3.7" -before_install: - - sudo apt-get install doxygen -install: - # We do this conditionally because it saves us some downloading if the - # version is the same. - - if [[ "$TRAVIS_PYTHON_VERSION" == "2.7" ]]; then - wget https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh -O miniconda.sh; - else - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh; - fi - - bash miniconda.sh -b -p $HOME/miniconda - - export PATH="$HOME/miniconda/bin:$PATH" - - hash -r - - conda config --set always_yes yes --set changeps1 no - - conda update -q conda - # Useful for debugging any issues with conda - - conda info -a - - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION boost fftw numpy pybind11 cmake gxx_linux-64 eigen - - source activate test-environment - - export BOOST_DIR=$CONDA_PREFIX - - export EIGEN_DIR=$CONDA_PREFIX - - export FFTW_DIR=$CONDA_PREFIX - - export CMAKE_PREFIX_PATH=$CONDA_PREFIX - -script: - - mkdir build - - cd build - - - cmake -DNDARRAY_PYBIND11=ON .. - - make - - make test ARGS="-V" - - - rm CMakeCache.txt - - cmake -DNDARRAY_PYBIND11=ON .. - - make - - make test ARGS="-V" - - - make doc - -deploy: - provider: pages - skip_cleanup: true - github_token: $GITHUB_TOKEN # Set in travis-ci.org dashboard - on: - branch: master - python: "3.7" - local_dir: build/html diff --git a/README.md b/README.md index 5e7fe9bf..b04d1a44 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ndarray: NumPy-friendly multidimensional arrays in C++ ====================================================== -[![Build Status](https://travis-ci.org/ndarray/ndarray.svg?branch=master)](https://travis-ci.org/ndarray/ndarray) +![Build Status](https://github.com/ndarray/ndarray/workflows/build_and_test/badge.svg) ndarray is a template library that provides multidimensional array objects in C++, with an interface and features designed to mimic the diff --git a/etc/conda-forge-testing.yaml b/etc/conda-forge-testing.yaml new file mode 100644 index 00000000..ce4fc26e --- /dev/null +++ b/etc/conda-forge-testing.yaml @@ -0,0 +1,11 @@ +name: ndarray +channels: + - conda-forge +dependencies: + - doxygen + - boost + - fftw + - numpy + - pybind11 + - gxx_linux-64 + - eigen From 3ae5a4dcac545100296399fbe0019894f8356a89 Mon Sep 17 00:00:00 2001 From: Jim Bosch Date: Fri, 8 Jan 2021 14:32:25 -0500 Subject: [PATCH 05/29] Attempt to move doc deploy to GitHub actions. --- .github/workflows/build.yaml | 10 ++++++++++ README.md | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 81b4219e..74c04023 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -1,6 +1,7 @@ name: build_and_test on: + - push - pull_request env: @@ -57,3 +58,12 @@ jobs: working-directory: ${{github.workspace}}/build shell: bash -l {0} run: make doc + + - name: Deploy Documentation (master/py3.8 only) + uses: JamesIves/github-pages-deploy-action@3.7.1 + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.python-version == 3.8 }} + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: gh-pages # The branch the action should deploy to. + FOLDER: build/html # The folder the action should deploy. + CLEAN: true # Automatically remove deleted files from the deploy branch diff --git a/README.md b/README.md index b04d1a44..2be217b7 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ objects in C++, with an interface and features designed to mimic the Python 'numpy' package as much as possible. More information can be found in the [documentation at -ndarray.github.io/ndarray](http://ndarray.github.io/ndarray/). +ndarray.github.io/ndarray](https://ndarray.github.io/ndarray/). Installation From 1e51250b2d29f36654f287f040633e8b98ae0cbd Mon Sep 17 00:00:00 2001 From: Matthias Wittgen Date: Sat, 9 Jan 2021 17:11:54 -0500 Subject: [PATCH 06/29] don't generate source code with m4 --- .gitignore | 6 - CMakeLists.txt | 1 - include/CMakeLists.txt | 41 - include/ndarray/ArrayBaseN.h | 229 +++++ include/ndarray/ArrayBaseN.h.m4 | 87 -- include/ndarray/ArrayRef.h | 401 +++++++++ include/ndarray/ArrayRef.h.m4 | 176 ---- include/ndarray/Vector.h | 815 +++++++++++++++++ include/ndarray/Vector.h.m4 | 465 ---------- include/ndarray/fft/FFTWTraits.h | 326 +++++++ include/ndarray/fft/FFTWTraits.h.m4 | 143 --- include/ndarray/operators.h | 1261 +++++++++++++++++++++++++++ include/ndarray/operators.h.m4 | 349 -------- tests/CMakeLists.txt | 10 +- 14 files changed, 3037 insertions(+), 1273 deletions(-) delete mode 100644 include/CMakeLists.txt create mode 100644 include/ndarray/ArrayBaseN.h delete mode 100644 include/ndarray/ArrayBaseN.h.m4 create mode 100644 include/ndarray/ArrayRef.h delete mode 100644 include/ndarray/ArrayRef.h.m4 create mode 100644 include/ndarray/Vector.h delete mode 100644 include/ndarray/Vector.h.m4 create mode 100644 include/ndarray/fft/FFTWTraits.h delete mode 100644 include/ndarray/fft/FFTWTraits.h.m4 create mode 100644 include/ndarray/operators.h delete mode 100644 include/ndarray/operators.h.m4 diff --git a/.gitignore b/.gitignore index 0edbcde6..51eb3e96 100644 --- a/.gitignore +++ b/.gitignore @@ -18,10 +18,4 @@ version.py tests/ndarray tests/ndarray-eigen tests/ndarray-fft -include/ndarray/Array.h -include/ndarray/ArrayBaseN.h -include/ndarray/ArrayRef.h -include/ndarray/Vector.h -include/ndarray/fft/FFTWTraits.h -include/ndarray/operators.h build/ diff --git a/CMakeLists.txt b/CMakeLists.txt index 5809b3a4..7031c7d4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -26,7 +26,6 @@ add_definitions(-std=c++11) # module search path set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH}) -add_subdirectory(include) # add a target to generate API documentation with Doxygen find_package(Doxygen) diff --git a/include/CMakeLists.txt b/include/CMakeLists.txt deleted file mode 100644 index 494b45b0..00000000 --- a/include/CMakeLists.txt +++ /dev/null @@ -1,41 +0,0 @@ -# preprocess files with m4 if needed -set(FILES1 - "ndarray/ArrayBaseN.h" - ) - -set(FILES2 - "ndarray/ArrayRef.h" - "ndarray/operators.h" - "ndarray/Vector.h" - "ndarray/fft/FFTWTraits.h" - ) - -set(PREPROCESS_FILES1 "") -foreach(FILENAME ${FILES1}) - list(APPEND PREPROCESS_FILES1 "${CMAKE_CURRENT_SOURCE_DIR}/${FILENAME}") -endforeach(FILENAME) - -set(PREPROCESS_FILES2 "") -foreach(FILENAME ${FILES2}) - list(APPEND PREPROCESS_FILES2 "${CMAKE_CURRENT_SOURCE_DIR}/${FILENAME}") -endforeach(FILENAME) - -foreach(FILENAME ${PREPROCESS_FILES1}) - add_custom_command ( - OUTPUT ${FILENAME} - DEPENDS ${FILENAME}.m4 - COMMAND m4 ${FILENAME}.m4 > ${FILENAME} - ) -endforeach(FILENAME) - -foreach(FILENAME ${PREPROCESS_FILES2}) - add_custom_command ( - OUTPUT ${FILENAME} - DEPENDS ${FILENAME}.m4 - COMMAND m4 ${FILENAME}.m4 > ${FILENAME} - ) -endforeach(FILENAME) - -add_custom_target(preprocess_includes1 ALL DEPENDS ${PREPROCESS_FILES1}) -add_custom_target(preprocess_includes2 ALL DEPENDS ${PREPROCESS_FILES2}) -add_dependencies(preprocess_includes2 preprocess_includes1) diff --git a/include/ndarray/ArrayBaseN.h b/include/ndarray/ArrayBaseN.h new file mode 100644 index 00000000..182e5670 --- /dev/null +++ b/include/ndarray/ArrayBaseN.h @@ -0,0 +1,229 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2012, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ + +#ifndef NDARRAY_ArrayBaseN_h_INCLUDED +#define NDARRAY_ArrayBaseN_h_INCLUDED + +/** + * @file ndarray/ArrayBaseN.h + * + * @brief Definition of ArrayBaseN, a dimension-specialized CRTP base class for Array and ArrayRef. + */ + +#include "ndarray/ArrayBase.h" + +namespace ndarray { + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef. + */ +template ::ND::value> +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; +private: + template friend class Array; + template friend class ArrayRef; + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + /// @internal @brief Construct an ArrayRef from a pointer and Core. + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 1). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0) const { + return this->operator[](makeVector(n0)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 2). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0, int n1) const { + return this->operator[](makeVector(n0, n1)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 3). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0, int n1, int n2) const { + return this->operator[](makeVector(n0, n1, n2)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 4). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0, int n1, int n2, int n3) const { + return this->operator[](makeVector(n0, n1, n2, n3)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 5). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0, int n1, int n2, int n3, int n4) const { + return this->operator[](makeVector(n0, n1, n2, n3, n4)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +/** + * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for 6). + */ +template +class ArrayBaseN : public ArrayBase< Derived > { + typedef ArrayBase Super; +protected: + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Element Element; + + Element & operator()(int n0, int n1, int n2, int n3, int n4, int n5) const { + return this->operator[](makeVector(n0, n1, n2, n3, n4, n5)); + } + +private: + template friend class Array; + template friend class ArrayRef; + + void operator=(ArrayBaseN const & other) { + Super::operator=(other); + } + + template + ArrayBaseN(ArrayBaseN const & other) : Super(other) {} + + ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} +}; + +} // namespace ndarray + +#endif // !NDARRAY_ArrayBaseN_h_INCLUDED diff --git a/include/ndarray/ArrayBaseN.h.m4 b/include/ndarray/ArrayBaseN.h.m4 deleted file mode 100644 index 2d112954..00000000 --- a/include/ndarray/ArrayBaseN.h.m4 +++ /dev/null @@ -1,87 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -changecom(`###')dnl -define(`SPECIALIZE', -` -/** - * @brief An intermediate CRTP base class for Array and ArrayRef (specialization for $1). - */ -template -class ArrayBaseN : public ArrayBase< Derived > { - typedef ArrayBase Super; -protected: - typedef typename Super::Core Core; - typedef typename Super::CorePtr CorePtr; -public: - typedef typename Super::Element Element; - - Element & operator()($2) const { - return this->operator[](makeVector($3)); - } - -private: - template friend class Array; - template friend class ArrayRef; - - void operator=(ArrayBaseN const & other) { - Super::operator=(other); - } - - template - ArrayBaseN(ArrayBaseN const & other) : Super(other) {} - - ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} -};')dnl -#ifndef NDARRAY_ArrayBaseN_h_INCLUDED -#define NDARRAY_ArrayBaseN_h_INCLUDED - -/** - * @file ndarray/ArrayBaseN.h - * - * @brief Definition of ArrayBaseN, a dimension-specialized CRTP base class for Array and ArrayRef. - */ - -#include "ndarray/ArrayBase.h" - -namespace ndarray { - -/** - * @brief An intermediate CRTP base class for Array and ArrayRef. - */ -template ::ND::value> -class ArrayBaseN : public ArrayBase< Derived > { - typedef ArrayBase Super; -protected: - typedef typename Super::Core Core; - typedef typename Super::CorePtr CorePtr; -public: - typedef typename Super::Element Element; -private: - template friend class Array; - template friend class ArrayRef; - void operator=(ArrayBaseN const & other) { - Super::operator=(other); - } - /// @internal @brief Construct an ArrayRef from a pointer and Core. - ArrayBaseN(Element * data, CorePtr const & core) : Super(data, core) {} -}; - -SPECIALIZE(1, `int n0', `n0') -SPECIALIZE(2, `int n0, int n1', `n0, n1') -SPECIALIZE(3, `int n0, int n1, int n2', `n0, n1, n2') -SPECIALIZE(4, `int n0, int n1, int n2, int n3', `n0, n1, n2, n3') -SPECIALIZE(5, `int n0, int n1, int n2, int n3, int n4', `n0, n1, n2, n3, n4') -SPECIALIZE(6, `int n0, int n1, int n2, int n3, int n4, int n5', `n0, n1, n2, n3, n4, n5') - -} // namespace ndarray - -#endif // !NDARRAY_ArrayBaseN_h_INCLUDED diff --git a/include/ndarray/ArrayRef.h b/include/ndarray/ArrayRef.h new file mode 100644 index 00000000..0fec2c0a --- /dev/null +++ b/include/ndarray/ArrayRef.h @@ -0,0 +1,401 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2012, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ +#ifndef NDARRAY_ArrayRef_h_INCLUDED +#define NDARRAY_ArrayRef_h_INCLUDED + +/** + * @file ndarray/ArrayRef.h + * + * @brief Definitions for ArrayRef. + */ + +#include "ndarray_fwd.h" +#include "ndarray/ArrayTraits.h" +#include "ndarray/ArrayBaseN.h" +#include "ndarray/detail/ArrayAccess.h" +#include "ndarray/Vector.h" +#include "ndarray/detail/Core.h" +#include "ndarray/views.h" + +namespace ndarray { + +/** + * @brief A proxy class for Array with deep assignment operators. + */ +template +class ArrayRef : public ArrayBaseN< ArrayRef > { + typedef ArrayBaseN Super; + typedef typename Super::Core Core; + typedef typename Super::CorePtr CorePtr; +public: + typedef typename Super::Iterator Iterator; + + /** + * @brief Construct an array with the given dimensions and allocated but uninitialized memory. + * + * Unspecified dimensions will have unit size, and if the number of argmuments is greater + * than the number of dimensions of the array, the extra arguments will be silently ignored. + * + * This is implemented in initialization.h. + */ + explicit ArrayRef(Size n1, Size n2=1, Size n3=1, Size n4=1, Size n5=1, Size n6=1, Size n7=1, Size n8=1); + + /** + * @brief Construct an array with the given dimensions and allocated but uninitialized memory. + * + * This is implemented in initialization.h. + */ + template + explicit ArrayRef(Vector const & shape); + + /** + * @brief Non-converting copy constructor. + */ + ArrayRef(ArrayRef const & other) : Super(other._data, other._core) {} + + /** + * @brief Converting copy constructor. + * + * Implicit conversion is allowed for non-const to const and for + * more guaranteed RMC to less guaranteed RMC (see \ref ndarrayTutorial). + */ + template + explicit ArrayRef( + Array const & other +#ifndef DOXYGEN + , typename boost::enable_if,void*>::type=0 +#endif + ) : Super(other._data, other._core) {} + + /** + * @brief Converting copy constructor. + * + * Implicit conversion is allowed for non-const to const and for + * more guaranteed RMC to less guaranteed RMC (see \ref ndarrayTutorial). + */ + template + ArrayRef( + ArrayRef const & other +#ifndef DOXYGEN + , typename boost::enable_if,void*>::type=0 +#endif + ) : Super(other._data, other._core) {} + + /** + * @name Assignment and Augmented Assignment Operators + * + * ArrayRef assignment is deep, and requires that + * the ArrayRef being assigned to has the same shape as + * the input array expression. Scalar assignment sets + * all elements of the ArrayRef to a single value. + */ + /// @{ + ArrayRef const & operator=(Array const & other) const { + NDARRAY_ASSERT(other.getShape() == this->getShape()); + std::copy(other.begin(), other.end(), this->begin()); + return *this; + } + + ArrayRef const & operator=(ArrayRef const & other) const { + NDARRAY_ASSERT(other.getShape() == this->getShape()); + std::copy(other.begin(), other.end(), this->begin()); + return *this; + } + + + /// \brief = assignment of arrays and array expressions. + template + ArrayRef const & + operator =(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + std::copy(expr.begin(),expr.end(),this->begin()); + return *this; + } + + /// \brief = assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator =(Scalar const & scalar) const { + Super::Traits::fill(this->begin(),this->end(),scalar); + return *this; + } + + /// \brief += assignment of arrays and array expressions. + template + ArrayRef const & + operator +=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) += (*j); + return *this; + } + + /// \brief += assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator +=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) += scalar; + return *this; + } + + /// \brief -= assignment of arrays and array expressions. + template + ArrayRef const & + operator -=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) -= (*j); + return *this; + } + + /// \brief -= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator -=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) -= scalar; + return *this; + } + + /// \brief *= assignment of arrays and array expressions. + template + ArrayRef const & + operator *=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) *= (*j); + return *this; + } + + /// \brief *= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator *=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) *= scalar; + return *this; + } + + /// \brief /= assignment of arrays and array expressions. + template + ArrayRef const & + operator /=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) /= (*j); + return *this; + } + + /// \brief /= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator /=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) /= scalar; + return *this; + } + + /// \brief %= assignment of arrays and array expressions. + template + ArrayRef const & + operator %=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) %= (*j); + return *this; + } + + /// \brief %= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator %=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) %= scalar; + return *this; + } + + /// \brief ^= assignment of arrays and array expressions. + template + ArrayRef const & + operator ^=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) ^= (*j); + return *this; + } + + /// \brief ^= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator ^=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) ^= scalar; + return *this; + } + + /// \brief &= assignment of arrays and array expressions. + template + ArrayRef const & + operator &=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) &= (*j); + return *this; + } + + /// \brief &= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator &=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) &= scalar; + return *this; + } + + /// \brief |= assignment of arrays and array expressions. + template + ArrayRef const & + operator |=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) |= (*j); + return *this; + } + + /// \brief |= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator |=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) |= scalar; + return *this; + } + + /// \brief <<= assignment of arrays and array expressions. + template + ArrayRef const & + operator <<=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) <<= (*j); + return *this; + } + + /// \brief <<= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator <<=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) <<= scalar; + return *this; + } + + /// \brief >>= assignment of arrays and array expressions. + template + ArrayRef const & + operator >>=(ExpressionBase const & expr) const { + NDARRAY_ASSERT(expr.getShape() + == this->getShape().template first::ND::value>()); + Iterator const i_end = this->end(); + typename Other::Iterator j = expr.begin(); + for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) >>= (*j); + return *this; + } + + /// \brief >>= assignment of scalars. + template +#ifndef DOXYGEN + typename boost::enable_if, ArrayRef const &>::type +#else + ArrayRef const & +#endif + operator >>=(Scalar const & scalar) const { + Iterator const i_end = this->end(); + for (Iterator i = this->begin(); i != i_end; ++i) (*i) >>= scalar; + return *this; + } + ///@} + +private: + template friend class Array; + template friend class ArrayRef; + template friend struct ArrayTraits; + template friend class ArrayBase; + template friend class detail::ArrayAccess; + + /// @internal @brief Construct an ArrayRef from a pointer and Core. + ArrayRef(T * data, CorePtr const & core) : Super(data, core) {} + +}; + +} // namespace ndarray + +#endif // !NDARRAY_ArrayRef_h_INCLUDED diff --git a/include/ndarray/ArrayRef.h.m4 b/include/ndarray/ArrayRef.h.m4 deleted file mode 100644 index ee5da55b..00000000 --- a/include/ndarray/ArrayRef.h.m4 +++ /dev/null @@ -1,176 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -changecom(`###')dnl -define(`GENERAL_ASSIGN', -` - /// \brief $1 assignment of arrays and array expressions. - template - ArrayRef const & - operator $1(ExpressionBase const & expr) const { - NDARRAY_ASSERT(expr.getShape() - == this->getShape().template first::ND::value>()); - indir(`$3',$1) - return *this; - } - - /// \brief $1 assignment of scalars. - template -#ifndef DOXYGEN - typename boost::enable_if, ArrayRef const &>::type -#else - ArrayRef const & -#endif - operator $1(Scalar const & scalar) const { - indir(`$2',$1) - return *this; - }')dnl -define(`BASIC_ASSIGN_SCALAR',`Super::Traits::fill(this->begin(),this->end(),scalar);')dnl -define(`BASIC_ASSIGN_EXPR',`std::copy(expr.begin(),expr.end(),this->begin());')dnl -define(`AUGMENTED_ASSIGN_SCALAR', -`Iterator const i_end = this->end(); - for (Iterator i = this->begin(); i != i_end; ++i) (*i) $1 scalar;')dnl -define(`AUGMENTED_ASSIGN_EXPR', -`Iterator const i_end = this->end(); - typename Other::Iterator j = expr.begin(); - for (Iterator i = this->begin(); i != i_end; ++i, ++j) (*i) $1 (*j);')dnl -define(`BASIC_ASSIGN',`GENERAL_ASSIGN(`=',`BASIC_ASSIGN_SCALAR',`BASIC_ASSIGN_EXPR')')dnl -define(`AUGMENTED_ASSIGN',`GENERAL_ASSIGN($1,`AUGMENTED_ASSIGN_SCALAR',`AUGMENTED_ASSIGN_EXPR')')dnl -#ifndef NDARRAY_ArrayRef_h_INCLUDED -#define NDARRAY_ArrayRef_h_INCLUDED - -/** - * @file ndarray/ArrayRef.h - * - * @brief Definitions for ArrayRef. - */ - -#include "ndarray_fwd.h" -#include "ndarray/ArrayTraits.h" -#include "ndarray/ArrayBaseN.h" -#include "ndarray/detail/ArrayAccess.h" -#include "ndarray/Vector.h" -#include "ndarray/detail/Core.h" -#include "ndarray/views.h" - -namespace ndarray { - -/** - * @brief A proxy class for Array with deep assignment operators. - */ -template -class ArrayRef : public ArrayBaseN< ArrayRef > { - typedef ArrayBaseN Super; - typedef typename Super::Core Core; - typedef typename Super::CorePtr CorePtr; -public: - typedef typename Super::Iterator Iterator; - - /** - * @brief Construct an array with the given dimensions and allocated but uninitialized memory. - * - * Unspecified dimensions will have unit size, and if the number of argmuments is greater - * than the number of dimensions of the array, the extra arguments will be silently ignored. - * - * This is implemented in initialization.h. - */ - explicit ArrayRef(Size n1, Size n2=1, Size n3=1, Size n4=1, Size n5=1, Size n6=1, Size n7=1, Size n8=1); - - /** - * @brief Construct an array with the given dimensions and allocated but uninitialized memory. - * - * This is implemented in initialization.h. - */ - template - explicit ArrayRef(Vector const & shape); - - /** - * @brief Non-converting copy constructor. - */ - ArrayRef(ArrayRef const & other) : Super(other._data, other._core) {} - - /** - * @brief Converting copy constructor. - * - * Implicit conversion is allowed for non-const to const and for - * more guaranteed RMC to less guaranteed RMC (see \ref ndarrayTutorial). - */ - template - explicit ArrayRef( - Array const & other -#ifndef DOXYGEN - , typename boost::enable_if,void*>::type=0 -#endif - ) : Super(other._data, other._core) {} - - /** - * @brief Converting copy constructor. - * - * Implicit conversion is allowed for non-const to const and for - * more guaranteed RMC to less guaranteed RMC (see \ref ndarrayTutorial). - */ - template - ArrayRef( - ArrayRef const & other -#ifndef DOXYGEN - , typename boost::enable_if,void*>::type=0 -#endif - ) : Super(other._data, other._core) {} - - /** - * @name Assignment and Augmented Assignment Operators - * - * ArrayRef assignment is deep, and requires that - * the ArrayRef being assigned to has the same shape as - * the input array expression. Scalar assignment sets - * all elements of the ArrayRef to a single value. - */ - /// @{ - ArrayRef const & operator=(Array const & other) const { - NDARRAY_ASSERT(other.getShape() == this->getShape()); - std::copy(other.begin(), other.end(), this->begin()); - return *this; - } - - ArrayRef const & operator=(ArrayRef const & other) const { - NDARRAY_ASSERT(other.getShape() == this->getShape()); - std::copy(other.begin(), other.end(), this->begin()); - return *this; - } - -BASIC_ASSIGN -AUGMENTED_ASSIGN(+=) -AUGMENTED_ASSIGN(-=) -AUGMENTED_ASSIGN(*=) -AUGMENTED_ASSIGN(/=) -AUGMENTED_ASSIGN(%=) -AUGMENTED_ASSIGN(^=) -AUGMENTED_ASSIGN(&=) -AUGMENTED_ASSIGN(|=) -AUGMENTED_ASSIGN(<<=) -AUGMENTED_ASSIGN(>>=) - ///@} - -private: - template friend class Array; - template friend class ArrayRef; - template friend struct ArrayTraits; - template friend class ArrayBase; - template friend class detail::ArrayAccess; - - /// @internal @brief Construct an ArrayRef from a pointer and Core. - ArrayRef(T * data, CorePtr const & core) : Super(data, core) {} - -}; - -} // namespace ndarray - -#endif // !NDARRAY_ArrayRef_h_INCLUDED diff --git a/include/ndarray/Vector.h b/include/ndarray/Vector.h new file mode 100644 index 00000000..f8e476c6 --- /dev/null +++ b/include/ndarray/Vector.h @@ -0,0 +1,815 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2012, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ + +#ifndef NDARRAY_Vector_h_INCLUDED +#define NDARRAY_Vector_h_INCLUDED + +/// @file ndarray/Vector.h Definition for Vector. + +#include +#include +#include +#include +#include +#include +#include + +#include + +#include "ndarray_fwd.h" +#include "ndarray/types.h" + +/// \cond MACROS +#define NDARRAY_MAKE_VECTOR_MAX 8 + +#define NDARRAY_MAKE_VECTOR_ARG_SPEC(Z,I,DATA) T v ## I +#define NDARRAY_MAKE_VECTOR_SET_SPEC(Z,I,DATA) r[I] = v ## I; + +#define NDARRAY_MAKE_VECTOR_SPEC(Z,N,DATA) \ + template \ + inline Vector makeVector( \ + BOOST_PP_ENUM(N,NDARRAY_MAKE_VECTOR_ARG_SPEC,unused) \ + ) { \ + Vector r; \ + BOOST_PP_REPEAT(N,NDARRAY_MAKE_VECTOR_SET_SPEC,unused) \ + return r; \ + } + +/// \endcond + +namespace ndarray { + +namespace detail { + +template ::value> +struct DefaultValue { + static T get() { return T(); } +}; + +template +struct DefaultValue { + static T get() { return T(0); } +}; + +} // namespace detail + +/// \addtogroup ndarrayVectorGroup +/// @{ + +/** + * @class Vector + * @brief A fixed-size 1D array class. + * + * Vector is primarily used as the data type for the shape + * (with T==Size) and strides (with T==Offset) attributes of Array. + * + * Vector is implemented almost exactly as a non-aggregate + * boost::array, but with the addition of mathematical + * operators and a few other utility functions. + */ +template < + typename T, ///< Data type. + int N ///< Number of elements. + > +struct Vector { + + typedef T Element; + typedef T Value; + typedef T & Reference; + typedef T const & ConstReference; + typedef T * Iterator; + typedef T const * ConstIterator; + + typedef Value value_type; + typedef Iterator iterator; + typedef ConstIterator const_iterator; + typedef Reference reference; + typedef ConstReference const_reference; + typedef boost::reverse_iterator reverse_iterator; + typedef boost::reverse_iterator const_reverse_iterator; + typedef T * pointer; + typedef int difference_type; + typedef int size_type; + + + typedef boost::mpl::int_ ND; + /// @brief Return the size of the Vector. + size_type size() const { return N; } + /// @brief Return the size of the Vector. + size_type max_size() const { return N; } + ///< @brief Return true if size() == 0. + bool empty() const { return N==0; } + /// @brief Return an iterator to the beginning of the Vector. + iterator begin() { return elems; } + /// @brief Return a const_iterator to the beginning of the Vector. + const_iterator begin() const { return elems; } + /// @brief Return an iterator to the end of the Vector. + iterator end() { return elems+N; } + /// @brief Return a const_iterator to the end of the Vector. + const_iterator end() const { return elems+N; } + /// @brief Return a reverse_iterator to the beginning of the reversed Vector. + reverse_iterator rbegin() { return reverse_iterator(end()); } + /// @brief Return a const_reverse_iterator to the beginning of the reversed Vector. + const_reverse_iterator rbegin() const { return const_reverse_iterator(end()); } + /// @brief Return a reverse_iterator to the end of the reversed Vector. + reverse_iterator rend() { return reverse_iterator(begin()); } + /// @brief Return a const_reverse_iterator to the end of the reversed Vector. + const_reverse_iterator rend() const { return const_reverse_iterator(begin()); } + + /// @brief Return a reference to the first element. + reference front() { return *elems; } + /// @brief Return a reference to the last element. + reference back() { return *(elems+N-1); } + /// @brief Return a const_reference to the first element. + const_reference front() const { return *elems; } + /// @brief Return a const_reference to the last element. + const_reference back() const { return *(elems+N-1); } + + /// @brief Return a reference to the element with the given index. + reference operator[](int i) { return elems[i]; } + /// @brief Return a const_reference to the element with the given index. + const_reference operator[](int i) const { return elems[i]; } + + /// @brief Create a new Vector that is a subset of this. + template + Vector getRange() const { + Vector r; + std::copy(begin() + Start, begin()+Stop, r.begin()); + return r; + } + + /// @brief Create a new Vector from the first M elements of this. + template Vector first() const { + Vector r; + std::copy(begin(), begin() + M, r.begin()); + return r; + } + + /// @brief Create a new Vector from the last M elements of this. + template Vector last() const { + Vector r; + std::copy(begin() + (N - M), begin() + N, r.begin()); + return r; + } + + /** @brief Stream output. */ + friend std::ostream& operator<<(std::ostream& os, Vector const & obj) { + os << "("; + std::copy(obj.begin(), obj.end(), std::ostream_iterator(os,",")); + return os << ")"; + } + + /** + * @brief Default constructor. + * + * Initializes the elements to zero. + */ + Vector() { this-> + #ifndef _MSC_VER + template + #endif + operator=(detail::DefaultValue::get()); } + + /// @brief Construct with copies of a scalar. + explicit Vector(T scalar) { + this->operator=(scalar); + } + + /// @brief Converting copy constructor. + template + Vector(Vector const & other) { + this-> + #ifndef _MSC_VER + template + #endif + operator=(other); + } + + /// @brief Return true if elements of other are equal to the elements of this. + bool operator==(Vector const & other) const { + return std::equal(begin(), end(), other.begin()); + } + + /// @brief Return false if any elements of other are not equal to the elements of this. + bool operator!=(Vector const & other) const { + return !(*this == other); + } + + /// @brief Return the sum of all elements. + T sum() const { + T r = 0; + for (ConstIterator i = begin(); i != end(); ++i) r += (*i); + return r; + } + + /// @brief Return the product of all elements. + T product() const { + T r = 1; + for (ConstIterator i = begin(); i != end(); ++i) r *= (*i); + return r; + } + + /// @brief Return a Vector with the elements reversed. + Vector reverse() const { + Vector r; + std::copy(begin(), end(), r.rbegin()); + return r; + } + + /// @brief Cast the vector element-wise to another type. + template + Vector cast() const { + Vector r; + for (int i = 0; i < N; ++i) { + r[i] = static_cast((*this)[i]); + } + return r; + } + + + /// @brief Augmented = assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator = (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) = (*j); + return *this; + } + /// @brief Augmented = assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator = (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) = scalar; + return *this; + } + + /// @brief Augmented += assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator += (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) += (*j); + return *this; + } + /// @brief Augmented += assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator += (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) += scalar; + return *this; + } + + /// @brief Augmented -= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator -= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) -= (*j); + return *this; + } + /// @brief Augmented -= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator -= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) -= scalar; + return *this; + } + + /// @brief Augmented *= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator *= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) *= (*j); + return *this; + } + /// @brief Augmented *= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator *= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) *= scalar; + return *this; + } + + /// @brief Augmented /= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator /= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) /= (*j); + return *this; + } + /// @brief Augmented /= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator /= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) /= scalar; + return *this; + } + + /// @brief Augmented %= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator %= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) %= (*j); + return *this; + } + /// @brief Augmented %= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator %= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) %= scalar; + return *this; + } + + /// @brief Augmented &= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator &= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) &= (*j); + return *this; + } + /// @brief Augmented &= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator &= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) &= scalar; + return *this; + } + + /// @brief Augmented ^= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator ^= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) ^= (*j); + return *this; + } + /// @brief Augmented ^= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator ^= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) ^= scalar; + return *this; + } + + /// @brief Augmented |= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator |= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) |= (*j); + return *this; + } + /// @brief Augmented |= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator |= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) |= scalar; + return *this; + } + + /// @brief Augmented <<= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator <<= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) <<= (*j); + return *this; + } + /// @brief Augmented <<= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator <<= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) <<= scalar; + return *this; + } + + /// @brief Augmented >>= assignment from another vector. + template + typename boost::enable_if,Vector&>::type + operator >>= (Vector const & other) { + typename Vector::ConstIterator j = other.begin(); + for (Iterator i = begin(); i != end(); ++i, ++j) (*i) >>= (*j); + return *this; + } + /// @brief Augmented >>= assignment from a scalar. + template + typename boost::enable_if,Vector&>::type + operator >>= (U scalar) { + for (Iterator i = begin(); i != end(); ++i) (*i) >>= scalar; + return *this; + } + + T elems[N]; +}; + +/// @brief PArtial specialization for zero-size vectors to avoid compiler errors on some platforms. +template +struct Vector { + + typedef T Element; + typedef T Value; + typedef T & Reference; + typedef T const & ConstReference; + typedef T * Iterator; + typedef T const * ConstIterator; + + typedef Value value_type; + typedef Iterator iterator; + typedef ConstIterator const_iterator; + typedef Reference reference; + typedef ConstReference const_reference; + typedef boost::reverse_iterator reverse_iterator; + typedef boost::reverse_iterator const_reverse_iterator; + typedef T * pointer; + typedef int difference_type; + typedef int size_type; + + + typedef boost::mpl::int_<0> ND; + + size_type size() const { return 0; } ///< @brief Return the size of the Vector. + size_type max_size() const { return 0; } ///< @brief Return the size of the Vector. + bool empty() const { return true; } ///< @brief Return true if size() == 0. + /// @brief Return an iterator to the beginning of the Vector. + iterator begin() { return 0; } + /// @brief Return a const_iterator to the beginning of the Vector. + const_iterator begin() const { return 0; } + /// @brief Return an iterator to the end of the Vector. + iterator end() { return 0; } + /// @brief Return a const_iterator to the end of the Vector. + const_iterator end() const { return 0; } + /// @brief Return a reverse_iterator to the beginning of the reversed Vector. + reverse_iterator rbegin() { return reverse_iterator(); } + /// @brief Return a const_reverse_iterator to the beginning of the reversed Vector. + const_reverse_iterator rbegin() const { return const_reverse_iterator(); } + /// @brief Return a reverse_iterator to the end of the reversed Vector. + reverse_iterator rend() { return reverse_iterator(); } + /// @brief Return a const_reverse_iterator to the end of the reversed Vector. + const_reverse_iterator rend() const { return const_reverse_iterator(); } + + /// @brief Return a reference to the first element. + reference front() { NDARRAY_ASSERT(false); return 0; } + /// @brief Return a reference to the last element. + reference back() { return NDARRAY_ASSERT(false); return 0; } + /// @brief Return a const_reference to the first element. + const_reference front() const { NDARRAY_ASSERT(false); return 0; } + /// @brief Return a const_reference to the last element. + const_reference back() const { NDARRAY_ASSERT(false); return 0; } + + /// @brief Return a reference to the element with the given index. + reference operator[](int i) { NDARRAY_ASSERT(false); return 0; } + /// @brief Return a const_reference to the element with the given index. + const_reference operator[](int i) const { NDARRAY_ASSERT(false); return 0; } + + /// @brief Create a new Vector that is a subset of this. + template + Vector getRange() const { + return Vector(); + } + + /// @brief Create a new Vector from the first M elements of this. + template Vector first() const { + return Vector(); + } + + /// @brief Create a new Vector from the last M elements of this. + template Vector last() const { + return Vector(); + } + + /** @brief Stream output. */ + friend std::ostream& operator<<(std::ostream& os, Vector const & obj) { + return os << "()"; + } + + /** + * @brief Default constructor. + * + * Initializes the elements to zero. + */ + Vector() {} + + /// @brief Construct with copies of a scalar. + explicit Vector(T scalar) {} + + /// @brief Converting copy constructor. + template + Vector(Vector const & other) {} + + /// @brief Return true if elements of other are equal to the elements of this. + bool operator==(Vector const & other) const { return true; } + + /// @brief Return false if any elements of other are not equal to the elements of this. + bool operator!=(Vector const & other) const { return false; } + + /// @brief Return the sum of all elements. + T sum() const { return 0; } + + /// @brief Return the product of all elements. + T product() const { return 1; } + + /// @brief Return a Vector with the elements reversed. + Vector reverse() const { return Vector(); } + + /// @brief Cast the vector element-wise to another type. + template + Vector cast() const { return Vector(); } + +}; + + +/// @brief Concatenate two Vectors into a single long Vector. +template +inline Vector concatenate(Vector const & a, Vector const & b) { + Vector r; + std::copy(a.begin(),a.end(),r.begin()); + std::copy(b.begin(),b.end(),r.begin()+N); + return r; +} + +/// @brief Return a new Vector with the given scalar appended to the original. +template +inline typename boost::enable_if,Vector >::type +concatenate(Vector const & a, U b) { + Vector r; + std::copy(a.begin(),a.end(),r.begin()); + r[N] = b; + return r; +} + +/// @brief Return a new Vector with the given scalar prepended to the original. +template +inline typename boost::enable_if,Vector >::type +concatenate(U a, Vector const & b) { + Vector r; + r[0] = a; + std::copy(b.begin(),b.end(),r.begin()+1); + return r; +} + +#ifndef DOXYGEN +BOOST_PP_REPEAT_FROM_TO(1, NDARRAY_MAKE_VECTOR_MAX, NDARRAY_MAKE_VECTOR_SPEC, unused) +#else +/** + * @brief Variadic constructor for Vector. + * + * Defined for N in [0 - NDARRAY_MAKE_VECTOR_MAX). + */ +template +Vector makeVector(T v1, T v2, ..., T vN); +#endif + +/** @brief Unary bitwise NOT for Vector. */ +template +inline Vector operator~(Vector const & vector) { + Vector r(vector); + for (typename Vector::Iterator i = r.begin(); i != r.end(); ++i) (*i) = ~(*i); + return r; +} + +/** @brief Unary negation for Vector. */ +template +inline Vector operator!(Vector const & vector) { + Vector r(vector); + for (typename Vector::Iterator i = r.begin(); i != r.end(); ++i) (*i) = !(*i); + return r; +} + + + /// @brief Operator overload for Vector + Vector. + template + Vector::Type,N> + operator +(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r += b; + } + /** @brief Operator overload for Vector + Scalar. */ + template + Vector::Type,N> + operator +(Vector const & a, U b) { + Vector::Type,N> r(a); + return r += b; + } + /** @brief Operator overload for Scalar + Vector. */ + template + Vector::Type,N> + operator +(U a, Vector const & b) { + Vector::Type,N> r(a); + return r += b; + } + + /// @brief Operator overload for Vector - Vector. + template + Vector::Type,N> + operator -(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r -= b; + } + /** @brief Operator overload for Vector - Scalar. */ + template + Vector::Type,N> + operator -(Vector const & a, U b) { + Vector::Type,N> r(a); + return r -= b; + } + /** @brief Operator overload for Scalar - Vector. */ + template + Vector::Type,N> + operator -(U a, Vector const & b) { + Vector::Type,N> r(a); + return r -= b; + } + + /// @brief Operator overload for Vector * Vector. + template + Vector::Type,N> + operator *(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r *= b; + } + /** @brief Operator overload for Vector * Scalar. */ + template + Vector::Type,N> + operator *(Vector const & a, U b) { + Vector::Type,N> r(a); + return r *= b; + } + /** @brief Operator overload for Scalar * Vector. */ + template + Vector::Type,N> + operator *(U a, Vector const & b) { + Vector::Type,N> r(a); + return r *= b; + } + + /// @brief Operator overload for Vector / Vector. + template + Vector::Type,N> + operator /(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r /= b; + } + /** @brief Operator overload for Vector / Scalar. */ + template + Vector::Type,N> + operator /(Vector const & a, U b) { + Vector::Type,N> r(a); + return r /= b; + } + /** @brief Operator overload for Scalar / Vector. */ + template + Vector::Type,N> + operator /(U a, Vector const & b) { + Vector::Type,N> r(a); + return r /= b; + } + + /// @brief Operator overload for Vector % Vector. + template + Vector::Type,N> + operator %(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r %= b; + } + /** @brief Operator overload for Vector % Scalar. */ + template + Vector::Type,N> + operator %(Vector const & a, U b) { + Vector::Type,N> r(a); + return r %= b; + } + /** @brief Operator overload for Scalar % Vector. */ + template + Vector::Type,N> + operator %(U a, Vector const & b) { + Vector::Type,N> r(a); + return r %= b; + } + + /// @brief Operator overload for Vector & Vector. + template + Vector::Type,N> + operator &(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r &= b; + } + /** @brief Operator overload for Vector & Scalar. */ + template + Vector::Type,N> + operator &(Vector const & a, U b) { + Vector::Type,N> r(a); + return r &= b; + } + /** @brief Operator overload for Scalar & Vector. */ + template + Vector::Type,N> + operator &(U a, Vector const & b) { + Vector::Type,N> r(a); + return r &= b; + } + + /// @brief Operator overload for Vector ^ Vector. + template + Vector::Type,N> + operator ^(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r ^= b; + } + /** @brief Operator overload for Vector ^ Scalar. */ + template + Vector::Type,N> + operator ^(Vector const & a, U b) { + Vector::Type,N> r(a); + return r ^= b; + } + /** @brief Operator overload for Scalar ^ Vector. */ + template + Vector::Type,N> + operator ^(U a, Vector const & b) { + Vector::Type,N> r(a); + return r ^= b; + } + + /// @brief Operator overload for Vector | Vector. + template + Vector::Type,N> + operator |(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r |= b; + } + /** @brief Operator overload for Vector | Scalar. */ + template + Vector::Type,N> + operator |(Vector const & a, U b) { + Vector::Type,N> r(a); + return r |= b; + } + /** @brief Operator overload for Scalar | Vector. */ + template + Vector::Type,N> + operator |(U a, Vector const & b) { + Vector::Type,N> r(a); + return r |= b; + } + + /// @brief Operator overload for Vector << Vector. + template + Vector::Type,N> + operator <<(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r <<= b; + } + /** @brief Operator overload for Vector << Scalar. */ + template + Vector::Type,N> + operator <<(Vector const & a, U b) { + Vector::Type,N> r(a); + return r <<= b; + } + /** @brief Operator overload for Scalar << Vector. */ + template + Vector::Type,N> + operator <<(U a, Vector const & b) { + Vector::Type,N> r(a); + return r <<= b; + } + + /// @brief Operator overload for Vector >> Vector. + template + Vector::Type,N> + operator >>(Vector const & a, Vector const & b) { + Vector::Type,N> r(a); + return r >>= b; + } + /** @brief Operator overload for Vector >> Scalar. */ + template + Vector::Type,N> + operator >>(Vector const & a, U b) { + Vector::Type,N> r(a); + return r >>= b; + } + /** @brief Operator overload for Scalar >> Vector. */ + template + Vector::Type,N> + operator >>(U a, Vector const & b) { + Vector::Type,N> r(a); + return r >>= b; + } + +/// @} + +} // namespace ndarray + +#endif // !NDARRAY_Vector_h_INCLUDED diff --git a/include/ndarray/Vector.h.m4 b/include/ndarray/Vector.h.m4 deleted file mode 100644 index f7201b11..00000000 --- a/include/ndarray/Vector.h.m4 +++ /dev/null @@ -1,465 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -changecom(`###')dnl -define(`VECTOR_ASSIGN', -` - /// @brief Augmented $1 assignment from another vector. - template - typename boost::enable_if,Vector&>::type - operator $1 (Vector const & other) { - typename Vector::ConstIterator j = other.begin(); - for (Iterator i = begin(); i != end(); ++i, ++j) (*i) $1 (*j); - return *this; - } - /// @brief Augmented $1 assignment from a scalar. - template - typename boost::enable_if,Vector&>::type - operator $1 (U scalar) { - for (Iterator i = begin(); i != end(); ++i) (*i) $1 scalar; - return *this; - }')dnl -define(`VECTOR_BINARY_OP', -` - /// @brief Operator overload for Vector $1 Vector. - template - Vector::Type,N> - operator $1(Vector const & a, Vector const & b) { - Vector::Type,N> r(a); - return r $1= b; - } - /** @brief Operator overload for Vector $1 Scalar. */ - template - Vector::Type,N> - operator $1(Vector const & a, U b) { - Vector::Type,N> r(a); - return r $1= b; - } - /** @brief Operator overload for Scalar $1 Vector. */ - template - Vector::Type,N> - operator $1(U a, Vector const & b) { - Vector::Type,N> r(a); - return r $1= b; - }')dnl -define(`VECTOR_TYPEDEFS', -` - typedef T Element; - typedef T Value; - typedef T & Reference; - typedef T const & ConstReference; - typedef T * Iterator; - typedef T const * ConstIterator; - - typedef Value value_type; - typedef Iterator iterator; - typedef ConstIterator const_iterator; - typedef Reference reference; - typedef ConstReference const_reference; - typedef boost::reverse_iterator reverse_iterator; - typedef boost::reverse_iterator const_reverse_iterator; - typedef T * pointer; - typedef int difference_type; - typedef int size_type; -')dnl -#ifndef NDARRAY_Vector_h_INCLUDED -#define NDARRAY_Vector_h_INCLUDED - -/// @file ndarray/Vector.h Definition for Vector. - -#include -#include -#include -#include -#include -#include -#include - -#include - -#include "ndarray_fwd.h" -#include "ndarray/types.h" - -/// \cond MACROS -#define NDARRAY_MAKE_VECTOR_MAX 8 - -#define NDARRAY_MAKE_VECTOR_ARG_SPEC(Z,I,DATA) T v ## I -#define NDARRAY_MAKE_VECTOR_SET_SPEC(Z,I,DATA) r[I] = v ## I; - -#define NDARRAY_MAKE_VECTOR_SPEC(Z,N,DATA) \ - template \ - inline Vector makeVector( \ - BOOST_PP_ENUM(N,NDARRAY_MAKE_VECTOR_ARG_SPEC,unused) \ - ) { \ - Vector r; \ - BOOST_PP_REPEAT(N,NDARRAY_MAKE_VECTOR_SET_SPEC,unused) \ - return r; \ - } - -/// \endcond - -namespace ndarray { - -namespace detail { - -template ::value> -struct DefaultValue { - static T get() { return T(); } -}; - -template -struct DefaultValue { - static T get() { return T(0); } -}; - -} // namespace detail - -/// \addtogroup ndarrayVectorGroup -/// @{ - -/** - * @class Vector - * @brief A fixed-size 1D array class. - * - * Vector is primarily used as the data type for the shape - * (with T==Size) and strides (with T==Offset) attributes of Array. - * - * Vector is implemented almost exactly as a non-aggregate - * boost::array, but with the addition of mathematical - * operators and a few other utility functions. - */ -template < - typename T, ///< Data type. - int N ///< Number of elements. - > -struct Vector { - VECTOR_TYPEDEFS - - typedef boost::mpl::int_ ND; - /// @brief Return the size of the Vector. - size_type size() const { return N; } - /// @brief Return the size of the Vector. - size_type max_size() const { return N; } - ///< @brief Return true if size() == 0. - bool empty() const { return N==0; } - /// @brief Return an iterator to the beginning of the Vector. - iterator begin() { return elems; } - /// @brief Return a const_iterator to the beginning of the Vector. - const_iterator begin() const { return elems; } - /// @brief Return an iterator to the end of the Vector. - iterator end() { return elems+N; } - /// @brief Return a const_iterator to the end of the Vector. - const_iterator end() const { return elems+N; } - /// @brief Return a reverse_iterator to the beginning of the reversed Vector. - reverse_iterator rbegin() { return reverse_iterator(end()); } - /// @brief Return a const_reverse_iterator to the beginning of the reversed Vector. - const_reverse_iterator rbegin() const { return const_reverse_iterator(end()); } - /// @brief Return a reverse_iterator to the end of the reversed Vector. - reverse_iterator rend() { return reverse_iterator(begin()); } - /// @brief Return a const_reverse_iterator to the end of the reversed Vector. - const_reverse_iterator rend() const { return const_reverse_iterator(begin()); } - - /// @brief Return a reference to the first element. - reference front() { return *elems; } - /// @brief Return a reference to the last element. - reference back() { return *(elems+N-1); } - /// @brief Return a const_reference to the first element. - const_reference front() const { return *elems; } - /// @brief Return a const_reference to the last element. - const_reference back() const { return *(elems+N-1); } - - /// @brief Return a reference to the element with the given index. - reference operator[](int i) { return elems[i]; } - /// @brief Return a const_reference to the element with the given index. - const_reference operator[](int i) const { return elems[i]; } - - /// @brief Create a new Vector that is a subset of this. - template - Vector getRange() const { - Vector r; - std::copy(begin() + Start, begin()+Stop, r.begin()); - return r; - } - - /// @brief Create a new Vector from the first M elements of this. - template Vector first() const { - Vector r; - std::copy(begin(), begin() + M, r.begin()); - return r; - } - - /// @brief Create a new Vector from the last M elements of this. - template Vector last() const { - Vector r; - std::copy(begin() + (N - M), begin() + N, r.begin()); - return r; - } - - /** @brief Stream output. */ - friend std::ostream& operator<<(std::ostream& os, Vector const & obj) { - os << "("; - std::copy(obj.begin(), obj.end(), std::ostream_iterator(os,",")); - return os << ")"; - } - - /** - * @brief Default constructor. - * - * Initializes the elements to zero. - */ - Vector() { this-> - #ifndef _MSC_VER - template - #endif - operator=(detail::DefaultValue::get()); } - - /// @brief Construct with copies of a scalar. - explicit Vector(T scalar) { - this->operator=(scalar); - } - - /// @brief Converting copy constructor. - template - Vector(Vector const & other) { - this-> - #ifndef _MSC_VER - template - #endif - operator=(other); - } - - /// @brief Return true if elements of other are equal to the elements of this. - bool operator==(Vector const & other) const { - return std::equal(begin(), end(), other.begin()); - } - - /// @brief Return false if any elements of other are not equal to the elements of this. - bool operator!=(Vector const & other) const { - return !(*this == other); - } - - /// @brief Return the sum of all elements. - T sum() const { - T r = 0; - for (ConstIterator i = begin(); i != end(); ++i) r += (*i); - return r; - } - - /// @brief Return the product of all elements. - T product() const { - T r = 1; - for (ConstIterator i = begin(); i != end(); ++i) r *= (*i); - return r; - } - - /// @brief Return a Vector with the elements reversed. - Vector reverse() const { - Vector r; - std::copy(begin(), end(), r.rbegin()); - return r; - } - - /// @brief Cast the vector element-wise to another type. - template - Vector cast() const { - Vector r; - for (int i = 0; i < N; ++i) { - r[i] = static_cast((*this)[i]); - } - return r; - } - - VECTOR_ASSIGN(=) - VECTOR_ASSIGN(+=) - VECTOR_ASSIGN(-=) - VECTOR_ASSIGN(*=) - VECTOR_ASSIGN(/=) - VECTOR_ASSIGN(%=) - VECTOR_ASSIGN(&=) - VECTOR_ASSIGN(^=) - VECTOR_ASSIGN(|=) - VECTOR_ASSIGN(<<=) - VECTOR_ASSIGN(>>=) - - T elems[N]; -}; - -/// @brief PArtial specialization for zero-size vectors to avoid compiler errors on some platforms. -template -struct Vector { - VECTOR_TYPEDEFS - - typedef boost::mpl::int_<0> ND; - - size_type size() const { return 0; } ///< @brief Return the size of the Vector. - size_type max_size() const { return 0; } ///< @brief Return the size of the Vector. - bool empty() const { return true; } ///< @brief Return true if size() == 0. - /// @brief Return an iterator to the beginning of the Vector. - iterator begin() { return 0; } - /// @brief Return a const_iterator to the beginning of the Vector. - const_iterator begin() const { return 0; } - /// @brief Return an iterator to the end of the Vector. - iterator end() { return 0; } - /// @brief Return a const_iterator to the end of the Vector. - const_iterator end() const { return 0; } - /// @brief Return a reverse_iterator to the beginning of the reversed Vector. - reverse_iterator rbegin() { return reverse_iterator(); } - /// @brief Return a const_reverse_iterator to the beginning of the reversed Vector. - const_reverse_iterator rbegin() const { return const_reverse_iterator(); } - /// @brief Return a reverse_iterator to the end of the reversed Vector. - reverse_iterator rend() { return reverse_iterator(); } - /// @brief Return a const_reverse_iterator to the end of the reversed Vector. - const_reverse_iterator rend() const { return const_reverse_iterator(); } - - /// @brief Return a reference to the first element. - reference front() { NDARRAY_ASSERT(false); return 0; } - /// @brief Return a reference to the last element. - reference back() { return NDARRAY_ASSERT(false); return 0; } - /// @brief Return a const_reference to the first element. - const_reference front() const { NDARRAY_ASSERT(false); return 0; } - /// @brief Return a const_reference to the last element. - const_reference back() const { NDARRAY_ASSERT(false); return 0; } - - /// @brief Return a reference to the element with the given index. - reference operator[](int i) { NDARRAY_ASSERT(false); return 0; } - /// @brief Return a const_reference to the element with the given index. - const_reference operator[](int i) const { NDARRAY_ASSERT(false); return 0; } - - /// @brief Create a new Vector that is a subset of this. - template - Vector getRange() const { - return Vector(); - } - - /// @brief Create a new Vector from the first M elements of this. - template Vector first() const { - return Vector(); - } - - /// @brief Create a new Vector from the last M elements of this. - template Vector last() const { - return Vector(); - } - - /** @brief Stream output. */ - friend std::ostream& operator<<(std::ostream& os, Vector const & obj) { - return os << "()"; - } - - /** - * @brief Default constructor. - * - * Initializes the elements to zero. - */ - Vector() {} - - /// @brief Construct with copies of a scalar. - explicit Vector(T scalar) {} - - /// @brief Converting copy constructor. - template - Vector(Vector const & other) {} - - /// @brief Return true if elements of other are equal to the elements of this. - bool operator==(Vector const & other) const { return true; } - - /// @brief Return false if any elements of other are not equal to the elements of this. - bool operator!=(Vector const & other) const { return false; } - - /// @brief Return the sum of all elements. - T sum() const { return 0; } - - /// @brief Return the product of all elements. - T product() const { return 1; } - - /// @brief Return a Vector with the elements reversed. - Vector reverse() const { return Vector(); } - - /// @brief Cast the vector element-wise to another type. - template - Vector cast() const { return Vector(); } - -}; - - -/// @brief Concatenate two Vectors into a single long Vector. -template -inline Vector concatenate(Vector const & a, Vector const & b) { - Vector r; - std::copy(a.begin(),a.end(),r.begin()); - std::copy(b.begin(),b.end(),r.begin()+N); - return r; -} - -/// @brief Return a new Vector with the given scalar appended to the original. -template -inline typename boost::enable_if,Vector >::type -concatenate(Vector const & a, U b) { - Vector r; - std::copy(a.begin(),a.end(),r.begin()); - r[N] = b; - return r; -} - -/// @brief Return a new Vector with the given scalar prepended to the original. -template -inline typename boost::enable_if,Vector >::type -concatenate(U a, Vector const & b) { - Vector r; - r[0] = a; - std::copy(b.begin(),b.end(),r.begin()+1); - return r; -} - -#ifndef DOXYGEN -BOOST_PP_REPEAT_FROM_TO(1, NDARRAY_MAKE_VECTOR_MAX, NDARRAY_MAKE_VECTOR_SPEC, unused) -#else -/** - * @brief Variadic constructor for Vector. - * - * Defined for N in [0 - NDARRAY_MAKE_VECTOR_MAX). - */ -template -Vector makeVector(T v1, T v2, ..., T vN); -#endif - -/** @brief Unary bitwise NOT for Vector. */ -template -inline Vector operator~(Vector const & vector) { - Vector r(vector); - for (typename Vector::Iterator i = r.begin(); i != r.end(); ++i) (*i) = ~(*i); - return r; -} - -/** @brief Unary negation for Vector. */ -template -inline Vector operator!(Vector const & vector) { - Vector r(vector); - for (typename Vector::Iterator i = r.begin(); i != r.end(); ++i) (*i) = !(*i); - return r; -} - -VECTOR_BINARY_OP(+) -VECTOR_BINARY_OP(-) -VECTOR_BINARY_OP(*) -VECTOR_BINARY_OP(/) -VECTOR_BINARY_OP(%) -VECTOR_BINARY_OP(&) -VECTOR_BINARY_OP(^) -VECTOR_BINARY_OP(|) -VECTOR_BINARY_OP(<<) -VECTOR_BINARY_OP(>>) - -/// @} - -} // namespace ndarray - -#endif // !NDARRAY_Vector_h_INCLUDED diff --git a/include/ndarray/fft/FFTWTraits.h b/include/ndarray/fft/FFTWTraits.h new file mode 100644 index 00000000..87f94cdc --- /dev/null +++ b/include/ndarray/fft/FFTWTraits.h @@ -0,0 +1,326 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2012, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ +// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. +#ifndef NDARRAY_FFT_FFTWTraits_h_INCLUDED +#define NDARRAY_FFT_FFTWTraits_h_INCLUDED + +/** + * @file ndarray/fft/FFTWTraits.h + * + * \brief Traits classes that wrap FFTW in a template-friendly interface. + */ + +#include +#include +#include "ndarray/fft/FourierTraits.h" + +namespace ndarray { +/// \cond INTERNAL +namespace detail { + +/** + * \internal \ingroup FFTInternalGroup + * \brief A traits class that maps C++ template types to FFTW types and wraps FFTW function calls. + */ +template struct FFTWTraits { BOOST_STATIC_ASSERT(sizeof(T) < 0); }; + +/// \cond SPECIALIZATIONS + + template <> struct FFTWTraits { + BOOST_STATIC_ASSERT((!boost::is_const::value)); + typedef fftwf_plan Plan; + typedef FourierTraits::ElementX ElementX; + typedef FourierTraits::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwf_plan_many_dft_r2c(rank, n, howmany, + in, inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwf_plan_many_dft_c2r(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + out, onembed, ostride, odist, + flags); + } + static inline void destroy(Plan p) { fftwf_destroy_plan(p); } + static inline void execute(Plan p) { fftwf_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftwf_malloc(sizeof(ElementX)*n) + ), + fftwf_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftwf_malloc(sizeof(ElementK)*n) + ), + fftwf_free + ); + } + }; + template <> struct FFTWTraits< std::complex > { + typedef fftwf_plan Plan; + typedef FourierTraits< std::complex >::ElementX ElementX; + typedef FourierTraits< std::complex >::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwf_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_FORWARD, flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwf_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_BACKWARD,flags); + } + static inline void destroy(Plan p) { fftwf_destroy_plan(p); } + static inline void execute(Plan p) { fftwf_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftwf_malloc(sizeof(ElementX)*n) + ), + fftwf_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftwf_malloc(sizeof(ElementK)*n) + ), + fftwf_free + ); + } + }; + + template <> struct FFTWTraits { + BOOST_STATIC_ASSERT((!boost::is_const::value)); + typedef fftw_plan Plan; + typedef FourierTraits::ElementX ElementX; + typedef FourierTraits::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftw_plan_many_dft_r2c(rank, n, howmany, + in, inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftw_plan_many_dft_c2r(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + out, onembed, ostride, odist, + flags); + } + static inline void destroy(Plan p) { fftw_destroy_plan(p); } + static inline void execute(Plan p) { fftw_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftw_malloc(sizeof(ElementX)*n) + ), + fftw_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftw_malloc(sizeof(ElementK)*n) + ), + fftw_free + ); + } + }; + template <> struct FFTWTraits< std::complex > { + typedef fftw_plan Plan; + typedef FourierTraits< std::complex >::ElementX ElementX; + typedef FourierTraits< std::complex >::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftw_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_FORWARD, flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftw_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_BACKWARD,flags); + } + static inline void destroy(Plan p) { fftw_destroy_plan(p); } + static inline void execute(Plan p) { fftw_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftw_malloc(sizeof(ElementX)*n) + ), + fftw_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftw_malloc(sizeof(ElementK)*n) + ), + fftw_free + ); + } + }; +#ifndef NDARRAY_FFT_NO_LONG_DOUBLE + + template <> struct FFTWTraits { + BOOST_STATIC_ASSERT((!boost::is_const::value)); + typedef fftwl_plan Plan; + typedef FourierTraits::ElementX ElementX; + typedef FourierTraits::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwl_plan_many_dft_r2c(rank, n, howmany, + in, inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwl_plan_many_dft_c2r(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + out, onembed, ostride, odist, + flags); + } + static inline void destroy(Plan p) { fftwl_destroy_plan(p); } + static inline void execute(Plan p) { fftwl_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftwl_malloc(sizeof(ElementX)*n) + ), + fftwl_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftwl_malloc(sizeof(ElementK)*n) + ), + fftwl_free + ); + } + }; + template <> struct FFTWTraits< std::complex > { + typedef fftwl_plan Plan; + typedef FourierTraits< std::complex >::ElementX ElementX; + typedef FourierTraits< std::complex >::ElementK ElementK; + typedef boost::shared_ptr OwnerX; + typedef boost::shared_ptr OwnerK; + static inline Plan forward(int rank, const int *n, int howmany, + ElementX *in, const int *inembed, int istride, int idist, + ElementK *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwl_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_FORWARD, flags); + } + static inline Plan inverse(int rank, const int *n, int howmany, + ElementK *in, const int *inembed, int istride, int idist, + ElementX *out, const int *onembed, int ostride, int odist, + unsigned flags) { + return fftwl_plan_many_dft(rank, n, howmany, + reinterpret_cast(in), + inembed, istride, idist, + reinterpret_cast(out), + onembed, ostride, odist, + FFTW_BACKWARD,flags); + } + static inline void destroy(Plan p) { fftwl_destroy_plan(p); } + static inline void execute(Plan p) { fftwl_execute(p); } + static inline OwnerX allocateX(int n) { + return OwnerX( + reinterpret_cast( + fftwl_malloc(sizeof(ElementX)*n) + ), + fftwl_free + ); + } + static inline OwnerK allocateK(int n) { + return OwnerK( + reinterpret_cast( + fftwl_malloc(sizeof(ElementK)*n) + ), + fftwl_free + ); + } + }; +#endif +/// \endcond + +} // namespace detail +/// \endcond +} // namespace ndarray + +#endif // !NDARRAY_FFT_FFTWTraits_h_INCLUDED diff --git a/include/ndarray/fft/FFTWTraits.h.m4 b/include/ndarray/fft/FFTWTraits.h.m4 deleted file mode 100644 index 5440673d..00000000 --- a/include/ndarray/fft/FFTWTraits.h.m4 +++ /dev/null @@ -1,143 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -changecom(`###')dnl -define(`FFTW_TRAITS', -` - template <> struct FFTWTraits<$1> { - BOOST_STATIC_ASSERT((!boost::is_const<$1>::value)); - typedef $2_plan Plan; - typedef FourierTraits<$1>::ElementX ElementX; - typedef FourierTraits<$1>::ElementK ElementK; - typedef boost::shared_ptr OwnerX; - typedef boost::shared_ptr OwnerK; - static inline Plan forward(int rank, const int *n, int howmany, - ElementX *in, const int *inembed, int istride, int idist, - ElementK *out, const int *onembed, int ostride, int odist, - unsigned flags) { - return $2_plan_many_dft_r2c(rank, n, howmany, - in, inembed, istride, idist, - reinterpret_cast<$2_complex*>(out), - onembed, ostride, odist, - flags); - } - static inline Plan inverse(int rank, const int *n, int howmany, - ElementK *in, const int *inembed, int istride, int idist, - ElementX *out, const int *onembed, int ostride, int odist, - unsigned flags) { - return $2_plan_many_dft_c2r(rank, n, howmany, - reinterpret_cast<$2_complex*>(in), - inembed, istride, idist, - out, onembed, ostride, odist, - flags); - } - static inline void destroy(Plan p) { $2_destroy_plan(p); } - static inline void execute(Plan p) { $2_execute(p); } - static inline OwnerX allocateX(int n) { - return OwnerX( - reinterpret_cast( - $2_malloc(sizeof(ElementX)*n) - ), - $2_free - ); - } - static inline OwnerK allocateK(int n) { - return OwnerK( - reinterpret_cast( - $2_malloc(sizeof(ElementK)*n) - ), - $2_free - ); - } - }; - template <> struct FFTWTraits< std::complex<$1> > { - typedef $2_plan Plan; - typedef FourierTraits< std::complex<$1> >::ElementX ElementX; - typedef FourierTraits< std::complex<$1> >::ElementK ElementK; - typedef boost::shared_ptr OwnerX; - typedef boost::shared_ptr OwnerK; - static inline Plan forward(int rank, const int *n, int howmany, - ElementX *in, const int *inembed, int istride, int idist, - ElementK *out, const int *onembed, int ostride, int odist, - unsigned flags) { - return $2_plan_many_dft(rank, n, howmany, - reinterpret_cast<$2_complex*>(in), - inembed, istride, idist, - reinterpret_cast<$2_complex*>(out), - onembed, ostride, odist, - FFTW_FORWARD, flags); - } - static inline Plan inverse(int rank, const int *n, int howmany, - ElementK *in, const int *inembed, int istride, int idist, - ElementX *out, const int *onembed, int ostride, int odist, - unsigned flags) { - return $2_plan_many_dft(rank, n, howmany, - reinterpret_cast<$2_complex*>(in), - inembed, istride, idist, - reinterpret_cast<$2_complex*>(out), - onembed, ostride, odist, - FFTW_BACKWARD,flags); - } - static inline void destroy(Plan p) { $2_destroy_plan(p); } - static inline void execute(Plan p) { $2_execute(p); } - static inline OwnerX allocateX(int n) { - return OwnerX( - reinterpret_cast( - $2_malloc(sizeof(ElementX)*n) - ), - $2_free - ); - } - static inline OwnerK allocateK(int n) { - return OwnerK( - reinterpret_cast( - $2_malloc(sizeof(ElementK)*n) - ), - $2_free - ); - } - }')dnl -#ifndef NDARRAY_FFT_FFTWTraits_h_INCLUDED -#define NDARRAY_FFT_FFTWTraits_h_INCLUDED - -/** - * @file ndarray/fft/FFTWTraits.h - * - * \brief Traits classes that wrap FFTW in a template-friendly interface. - */ - -#include -#include -#include "ndarray/fft/FourierTraits.h" - -namespace ndarray { -/// \cond INTERNAL -namespace detail { - -/** - * \internal \ingroup FFTInternalGroup - * \brief A traits class that maps C++ template types to FFTW types and wraps FFTW function calls. - */ -template struct FFTWTraits { BOOST_STATIC_ASSERT(sizeof(T) < 0); }; - -/// \cond SPECIALIZATIONS -FFTW_TRAITS(float,fftwf); -FFTW_TRAITS(double,fftw); -#ifndef NDARRAY_FFT_NO_LONG_DOUBLE -FFTW_TRAITS(long double, fftwl); -#endif -/// \endcond - -} // namespace detail -/// \endcond -} // namespace ndarray - -#endif // !NDARRAY_FFT_FFTWTraits_h_INCLUDED diff --git a/include/ndarray/operators.h b/include/ndarray/operators.h new file mode 100644 index 00000000..9d671444 --- /dev/null +++ b/include/ndarray/operators.h @@ -0,0 +1,1261 @@ +// -*- c++ -*- +/* + * Copyright (c) 2010-2012, Jim Bosch + * All rights reserved. + * + * ndarray is distributed under a simple BSD-like license; + * see the LICENSE file that should be present in the root + * of the source distribution, or alternately available at: + * https://github.com/ndarray/ndarray + */ + +#ifndef NDARRAY_operators_h_INCLUDED +#define NDARRAY_operators_h_INCLUDED + +/** + * \file ndarray/operators.h \brief Arithmetic and logical operators for Array. + */ + +#include "ndarray/Array.h" +#include +#include +#include + +#include "ndarray/detail/UnaryOp.h" +#include "ndarray/detail/BinaryOp.h" +#include "ndarray/types.h" + +namespace ndarray { + +/// \cond INTERNAL +namespace detail { + +/** + * \internal @class PromotingBinaryFunction + * \brief A typedef-providing base class for binary functors with numeric type promotion. + * + * \ingroup InternalGroup + */ +template +struct PromotingBinaryFunction { + typedef A ElementA; + typedef B ElementB; + typedef A first_argument_type; + typedef B second_argument_type; + typedef typename boost::call_traits::param_type ParamA; + typedef typename boost::call_traits::param_type ParamB; + typedef typename Promote::Type result_type; +}; + +/** + * \internal @class BinaryPredicate + * \brief A typedef-providing base class for binary predicates. + * + * \ingroup InternalGroup + */ +template +struct BinaryPredicate { + typedef A ElementA; + typedef B ElementB; + typedef A first_argument_type; + typedef B second_argument_type; + typedef typename boost::call_traits::param_type ParamA; + typedef typename boost::call_traits::param_type ParamB; + typedef bool result_type; +}; + +/** + * \internal @class AdaptableFunctionTag + * \brief A CRTP base class for non-template classes that contain a templated functor. + * + * \ingroup InternalGroup + */ +template +struct AdaptableFunctionTag { + + template + struct ScalarExpr { + typedef typename Derived::template ScalarFunction< + A, typename ExpressionTraits::Element + > BinaryFunction; + typedef boost::binder1st Bound; + static Bound bind(A const & scalar) { + return Bound(BinaryFunction(),scalar); + } + }; + + template + struct ExprScalar { + typedef typename Derived::template ScalarFunction< + typename ExpressionTraits::Element, B + > BinaryFunction; + typedef boost::binder2nd Bound; + static Bound bind(B const & scalar) { + return Bound(BinaryFunction(),scalar); + } + }; + + template + struct ExprExpr { + typedef typename Derived::template ScalarFunction< + typename ExpressionTraits::Element, + typename ExpressionTraits::Element + > BinaryFunction; + }; + +}; + +/** + * \internal @class BitwiseNot + * \ingroup InternalGroup + * \brief An STL Unary Function class for bitwise NOT (unary ~). + */ +template +struct BitwiseNot { + typedef T argument_type; + typedef T result_type; + + result_type operator()(argument_type arg) const { return ~arg; } +}; + + + struct PlusTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a + b; + } + }; + }; + + struct MinusTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a - b; + } + }; + }; + + struct MultipliesTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a * b; + } + }; + }; + + struct DividesTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a / b; + } + }; + }; + + struct ModulusTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a % b; + } + }; + }; + + struct BitwiseXorTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a ^ b; + } + }; + }; + + struct BitwiseOrTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a | b; + } + }; + }; + + struct BitwiseAndTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a & b; + } + }; + }; + + struct BitwiseLeftShiftTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a << b; + } + }; + }; + + struct BitwiseRightShiftTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public PromotingBinaryFunction { + typename PromotingBinaryFunction::result_type operator()( + typename PromotingBinaryFunction::ParamA a, + typename PromotingBinaryFunction::ParamB b + ) const { + return a >> b; + } + }; + }; + + + struct EqualToTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a == b; + } + }; + }; + + struct NotEqualToTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a != b; + } + }; + }; + + struct LessTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a < b; + } + }; + }; + + struct GreaterTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a > b; + } + }; + }; + + struct LessEqualTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a <= b; + } + }; + }; + + struct GreaterEqualTag : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a >= b; + } + }; + }; + + struct LogicalAnd : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a && b; + } + }; + }; + + struct LogicalOr : public AdaptableFunctionTag { + template + struct ScalarFunction : public BinaryPredicate { + typename BinaryPredicate::result_type operator()( + typename BinaryPredicate::ParamA a, + typename BinaryPredicate::ParamB b + ) const { + return a || b; + } + }; + }; + +} // namespace detail +/// \endcond + +/// \addtogroup ndarrayOpGroup +/// @{ + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::PlusTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator+(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::PlusTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::PlusTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator+(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::PlusTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::PlusTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator+(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::PlusTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::MinusTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator-(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::MinusTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::MinusTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator-(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::MinusTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::MinusTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator-(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::MinusTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::MultipliesTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator*(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::MultipliesTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::MultipliesTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator*(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::MultipliesTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::MultipliesTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator*(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::MultipliesTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::DividesTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator/(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::DividesTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::DividesTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator/(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::DividesTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::DividesTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator/(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::DividesTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::ModulusTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator%(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::ModulusTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::ModulusTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator%(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::ModulusTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::ModulusTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator%(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::ModulusTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseXorTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator^(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::BitwiseXorTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseXorTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator^(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::BitwiseXorTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::BitwiseXorTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator^(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::BitwiseXorTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseOrTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator|(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::BitwiseOrTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseOrTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator|(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::BitwiseOrTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::BitwiseOrTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator|(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::BitwiseOrTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseAndTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator&(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::BitwiseAndTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseAndTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator&(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::BitwiseAndTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::BitwiseAndTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator&(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::BitwiseAndTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseLeftShiftTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator<<(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::BitwiseLeftShiftTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseLeftShiftTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator<<(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::BitwiseLeftShiftTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::BitwiseLeftShiftTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator<<(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::BitwiseLeftShiftTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseRightShiftTag::template ExprScalar::Bound > + >::type +#else + +#endif + operator>>(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::BitwiseRightShiftTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::BitwiseRightShiftTag::template ScalarExpr::Bound > + >::type +#else + +#endif + operator>>(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::BitwiseRightShiftTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::BitwiseRightShiftTag::template ExprExpr::BinaryFunction + > +#else + +#endif + operator>>(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::BitwiseRightShiftTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::EqualToTag::template ExprScalar::Bound > + >::type +#else + +#endif + equal(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::EqualToTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::EqualToTag::template ScalarExpr::Bound > + >::type +#else + +#endif + equal(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::EqualToTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::EqualToTag::template ExprExpr::BinaryFunction + > +#else + +#endif + equal(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::EqualToTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::NotEqualToTag::template ExprScalar::Bound > + >::type +#else + +#endif + not_equal(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::NotEqualToTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::NotEqualToTag::template ScalarExpr::Bound > + >::type +#else + +#endif + not_equal(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::NotEqualToTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::NotEqualToTag::template ExprExpr::BinaryFunction + > +#else + +#endif + not_equal(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::NotEqualToTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LessTag::template ExprScalar::Bound > + >::type +#else + +#endif + less(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::LessTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LessTag::template ScalarExpr::Bound > + >::type +#else + +#endif + less(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::LessTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::LessTag::template ExprExpr::BinaryFunction + > +#else + +#endif + less(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::LessTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::GreaterTag::template ExprScalar::Bound > + >::type +#else + +#endif + greater(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::GreaterTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::GreaterTag::template ScalarExpr::Bound > + >::type +#else + +#endif + greater(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::GreaterTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::GreaterTag::template ExprExpr::BinaryFunction + > +#else + +#endif + greater(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::GreaterTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LessEqualTag::template ExprScalar::Bound > + >::type +#else + +#endif + less_equal(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::LessEqualTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LessEqualTag::template ScalarExpr::Bound > + >::type +#else + +#endif + less_equal(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::LessEqualTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::LessEqualTag::template ExprExpr::BinaryFunction + > +#else + +#endif + less_equal(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::LessEqualTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::GreaterEqualTag::template ExprScalar::Bound > + >::type +#else + +#endif + great_equal(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::GreaterEqualTag::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::GreaterEqualTag::template ScalarExpr::Bound > + >::type +#else + +#endif + great_equal(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::GreaterEqualTag::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::GreaterEqualTag::template ExprExpr::BinaryFunction + > +#else + +#endif + great_equal(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::GreaterEqualTag::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LogicalAnd::template ExprScalar::Bound > + >::type +#else + +#endif + logical_and(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::LogicalAnd::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LogicalAnd::template ScalarExpr::Bound > + >::type +#else + +#endif + logical_and(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::LogicalAnd::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::LogicalAnd::template ExprExpr::BinaryFunction + > +#else + +#endif + logical_and(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::LogicalAnd::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LogicalOr::template ExprScalar::Bound > + >::type +#else + +#endif + logical_or(ExpressionBase const & operand, Scalar const & scalar) { + return vectorize(detail::LogicalOr::template ExprScalar::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + typename boost::enable_if< + typename ExpressionTraits::IsScalar, + detail::UnaryOpExpression< Operand, typename detail::LogicalOr::template ScalarExpr::Bound > + >::type +#else + +#endif + logical_or(Scalar const & scalar, ExpressionBase const & operand) { + return vectorize(detail::LogicalOr::template ScalarExpr::bind(scalar),operand); + } + + template +#ifndef DOXYGEN + detail::BinaryOpExpression< + Operand1, Operand2, + typename detail::LogicalOr::template ExprExpr::BinaryFunction + > +#else + +#endif + logical_or(ExpressionBase const & operand1, ExpressionBase const & operand2) { + return vectorize( + typename detail::LogicalOr::template ExprExpr::BinaryFunction(), + operand1, + operand2 + ); + } + + + template +#ifndef DOXYGEN + detail::UnaryOpExpression< Operand, std::negate::Element> > +#else + +#endif + operator-(ExpressionBase const & operand) { + return vectorize(std::negate::Element>(),operand); + } + + template +#ifndef DOXYGEN + detail::UnaryOpExpression< Operand, std::logical_not::Element> > +#else + +#endif + logical_not(ExpressionBase const & operand) { + return vectorize(std::logical_not::Element>(),operand); + } + + template +#ifndef DOXYGEN + detail::UnaryOpExpression< Operand, detail::BitwiseNot::Element> > +#else + +#endif + operator~(ExpressionBase const & operand) { + return vectorize(detail::BitwiseNot::Element>(),operand); + } +/// @} + +template +inline typename boost::enable_if::IsScalar, bool>::type +any(Scalar const & scalar) { + return bool(scalar); +} + +/** + * \brief Return true if any of the elements of the given expression are true. + * + * \ingroup MainGroup + */ +template +inline bool +any(ExpressionBase const & expr) { + typename Derived::Iterator const i_end = expr.end(); + for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { + if (any(*i)) return true; + } + return false; +} + +template +inline typename boost::enable_if::IsScalar, bool>::type +all(Scalar const & scalar) { + return bool(scalar); +} + +/** + * \brief Return true if all of the elements of the given expression are true. + * + * \ingroup MainGroup + */ +template +inline bool +all(ExpressionBase const & expr) { + typename Derived::Iterator const i_end = expr.end(); + for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { + if (!all(*i)) return false; + } + return true; +} + +template +inline typename boost::enable_if< + boost::mpl::and_< + typename ExpressionTraits::IsScalar, + typename ExpressionTraits::IsScalar + >, + bool +>::type +allclose(Scalar1 const & scalar1, Scalar2 const & scalar2, double tol=1E-8) { + ApproximatelyEqual func(tol); + return func(scalar1, scalar2); +} + +template +inline typename boost::enable_if::IsScalar,bool>::type +allclose(Scalar const & scalar, ExpressionBase const & expr, double tol=1E-8) { + ApproximatelyEqual func(tol); + typename Derived::Iterator const i_end = expr.end(); + for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { + if (!allclose(scalar, *i, tol)) return false; + } + return true; +} + +template +inline typename boost::enable_if::IsScalar,bool>::type +allclose(ExpressionBase const & expr, Scalar const & scalar, double tol=1E-8) { + return allclose(scalar, expr, tol); +} + +template +inline bool +allclose(ExpressionBase const & expr1, ExpressionBase const & expr2, double tol=1E-8) { + typename Derived1::Iterator const i_end = expr1.end(); + typename Derived1::Iterator i = expr1.begin(); + typename Derived2::Iterator j = expr2.begin(); + for (; i != i_end; ++i, ++j) { + if (!allclose(*i, *j, tol)) return false; + } + return true; +} + + +template +inline typename boost::enable_if::IsScalar, Scalar>::type +sum(Scalar const & scalar) { return scalar; } + + +/** + * \brief Return the sum of all elements of the given expression. + * + * \ingroup MainGroup + */ +template +inline typename Derived::Element +sum(ExpressionBase const & expr) { + typename Derived::Iterator const i_end = expr.end(); + typename Derived::Element total = static_cast(0); + for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { + total += sum(*i); + } + return total; +} + + +} // namespace ndarray + +#endif // !NDARRAY_operators_h_INCLUDED diff --git a/include/ndarray/operators.h.m4 b/include/ndarray/operators.h.m4 deleted file mode 100644 index 0525c894..00000000 --- a/include/ndarray/operators.h.m4 +++ /dev/null @@ -1,349 +0,0 @@ -// -*- c++ -*- -/* - * Copyright (c) 2010-2012, Jim Bosch - * All rights reserved. - * - * ndarray is distributed under a simple BSD-like license; - * see the LICENSE file that should be present in the root - * of the source distribution, or alternately available at: - * https://github.com/ndarray/ndarray - */ -// THIS FILE IS MACHINE GENERATED BY SCONS. DO NOT EDIT MANUALLY. -changecom(`###')dnl -define(`FUNCTION_TAG', -` - struct $1 : public AdaptableFunctionTag<$1> { - template - struct ScalarFunction : public $2 { - typename $2::result_type operator()( - typename $2::ParamA a, - typename $2::ParamB b - ) const { - return a $3 b; - } - }; - };')dnl -define(`BINARY_OP', -` - template -#ifndef DOXYGEN - typename boost::enable_if< - typename ExpressionTraits::IsScalar, - detail::UnaryOpExpression< Operand, typename $1::template ExprScalar::Bound > - >::type -#else - -#endif - $2(ExpressionBase const & operand, Scalar const & scalar) { - return vectorize($1::template ExprScalar::bind(scalar),operand); - } - - template -#ifndef DOXYGEN - typename boost::enable_if< - typename ExpressionTraits::IsScalar, - detail::UnaryOpExpression< Operand, typename $1::template ScalarExpr::Bound > - >::type -#else - -#endif - $2(Scalar const & scalar, ExpressionBase const & operand) { - return vectorize($1::template ScalarExpr::bind(scalar),operand); - } - - template -#ifndef DOXYGEN - detail::BinaryOpExpression< - Operand1, Operand2, - typename $1::template ExprExpr::BinaryFunction - > -#else - -#endif - $2(ExpressionBase const & operand1, ExpressionBase const & operand2) { - return vectorize( - typename $1::template ExprExpr::BinaryFunction(), - operand1, - operand2 - ); - }')dnl -define(`UNARY_OP', -` - template -#ifndef DOXYGEN - detail::UnaryOpExpression< Operand, $1::Element> > -#else - -#endif - $2(ExpressionBase const & operand) { - return vectorize($1::Element>(),operand); - }')dnl -#ifndef NDARRAY_operators_h_INCLUDED -#define NDARRAY_operators_h_INCLUDED - -/** - * \file ndarray/operators.h \brief Arithmetic and logical operators for Array. - */ - -#include "ndarray/Array.h" -#include -#include -#include - -#include "ndarray/detail/UnaryOp.h" -#include "ndarray/detail/BinaryOp.h" -#include "ndarray/types.h" - -namespace ndarray { - -/// \cond INTERNAL -namespace detail { - -/** - * \internal @class PromotingBinaryFunction - * \brief A typedef-providing base class for binary functors with numeric type promotion. - * - * \ingroup InternalGroup - */ -template -struct PromotingBinaryFunction { - typedef A ElementA; - typedef B ElementB; - typedef A first_argument_type; - typedef B second_argument_type; - typedef typename boost::call_traits::param_type ParamA; - typedef typename boost::call_traits::param_type ParamB; - typedef typename Promote::Type result_type; -}; - -/** - * \internal @class BinaryPredicate - * \brief A typedef-providing base class for binary predicates. - * - * \ingroup InternalGroup - */ -template -struct BinaryPredicate { - typedef A ElementA; - typedef B ElementB; - typedef A first_argument_type; - typedef B second_argument_type; - typedef typename boost::call_traits::param_type ParamA; - typedef typename boost::call_traits::param_type ParamB; - typedef bool result_type; -}; - -/** - * \internal @class AdaptableFunctionTag - * \brief A CRTP base class for non-template classes that contain a templated functor. - * - * \ingroup InternalGroup - */ -template -struct AdaptableFunctionTag { - - template - struct ScalarExpr { - typedef typename Derived::template ScalarFunction< - A, typename ExpressionTraits::Element - > BinaryFunction; - typedef boost::binder1st Bound; - static Bound bind(A const & scalar) { - return Bound(BinaryFunction(),scalar); - } - }; - - template - struct ExprScalar { - typedef typename Derived::template ScalarFunction< - typename ExpressionTraits::Element, B - > BinaryFunction; - typedef boost::binder2nd Bound; - static Bound bind(B const & scalar) { - return Bound(BinaryFunction(),scalar); - } - }; - - template - struct ExprExpr { - typedef typename Derived::template ScalarFunction< - typename ExpressionTraits::Element, - typename ExpressionTraits::Element - > BinaryFunction; - }; - -}; - -/** - * \internal @class BitwiseNot - * \ingroup InternalGroup - * \brief An STL Unary Function class for bitwise NOT (unary ~). - */ -template -struct BitwiseNot { - typedef T argument_type; - typedef T result_type; - - result_type operator()(argument_type arg) const { return ~arg; } -}; - -FUNCTION_TAG(PlusTag,PromotingBinaryFunction,+) -FUNCTION_TAG(MinusTag,PromotingBinaryFunction,-) -FUNCTION_TAG(MultipliesTag,PromotingBinaryFunction,*) -FUNCTION_TAG(DividesTag,PromotingBinaryFunction,/) -FUNCTION_TAG(ModulusTag,PromotingBinaryFunction,%) -FUNCTION_TAG(BitwiseXorTag,PromotingBinaryFunction,^) -FUNCTION_TAG(BitwiseOrTag,PromotingBinaryFunction,|) -FUNCTION_TAG(BitwiseAndTag,PromotingBinaryFunction,&) -FUNCTION_TAG(BitwiseLeftShiftTag,PromotingBinaryFunction,<<) -FUNCTION_TAG(BitwiseRightShiftTag,PromotingBinaryFunction,>>) - -FUNCTION_TAG(EqualToTag,BinaryPredicate,==) -FUNCTION_TAG(NotEqualToTag,BinaryPredicate,!=) -FUNCTION_TAG(LessTag,BinaryPredicate,<) -FUNCTION_TAG(GreaterTag,BinaryPredicate,>) -FUNCTION_TAG(LessEqualTag,BinaryPredicate,<=) -FUNCTION_TAG(GreaterEqualTag,BinaryPredicate,>=) -FUNCTION_TAG(LogicalAnd,BinaryPredicate,&&) -FUNCTION_TAG(LogicalOr,BinaryPredicate,||) - -} // namespace detail -/// \endcond - -/// \addtogroup ndarrayOpGroup -/// @{ -BINARY_OP(detail::PlusTag,operator+) -BINARY_OP(detail::MinusTag,operator-) -BINARY_OP(detail::MultipliesTag,operator*) -BINARY_OP(detail::DividesTag,operator/) -BINARY_OP(detail::ModulusTag,operator%) -BINARY_OP(detail::BitwiseXorTag,operator^) -BINARY_OP(detail::BitwiseOrTag,operator|) -BINARY_OP(detail::BitwiseAndTag,operator&) -BINARY_OP(detail::BitwiseLeftShiftTag,operator<<) -BINARY_OP(detail::BitwiseRightShiftTag,operator>>) - -BINARY_OP(detail::EqualToTag, equal) -BINARY_OP(detail::NotEqualToTag, not_equal) -BINARY_OP(detail::LessTag, less) -BINARY_OP(detail::GreaterTag, greater) -BINARY_OP(detail::LessEqualTag, less_equal) -BINARY_OP(detail::GreaterEqualTag, great_equal) -BINARY_OP(detail::LogicalAnd, logical_and) -BINARY_OP(detail::LogicalOr, logical_or) - -UNARY_OP(std::negate,operator-) -UNARY_OP(std::logical_not, logical_not) -UNARY_OP(detail::BitwiseNot,operator~) -/// @} - -template -inline typename boost::enable_if::IsScalar, bool>::type -any(Scalar const & scalar) { - return bool(scalar); -} - -/** - * \brief Return true if any of the elements of the given expression are true. - * - * \ingroup MainGroup - */ -template -inline bool -any(ExpressionBase const & expr) { - typename Derived::Iterator const i_end = expr.end(); - for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { - if (any(*i)) return true; - } - return false; -} - -template -inline typename boost::enable_if::IsScalar, bool>::type -all(Scalar const & scalar) { - return bool(scalar); -} - -/** - * \brief Return true if all of the elements of the given expression are true. - * - * \ingroup MainGroup - */ -template -inline bool -all(ExpressionBase const & expr) { - typename Derived::Iterator const i_end = expr.end(); - for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { - if (!all(*i)) return false; - } - return true; -} - -template -inline typename boost::enable_if< - boost::mpl::and_< - typename ExpressionTraits::IsScalar, - typename ExpressionTraits::IsScalar - >, - bool ->::type -allclose(Scalar1 const & scalar1, Scalar2 const & scalar2, double tol=1E-8) { - ApproximatelyEqual func(tol); - return func(scalar1, scalar2); -} - -template -inline typename boost::enable_if::IsScalar,bool>::type -allclose(Scalar const & scalar, ExpressionBase const & expr, double tol=1E-8) { - ApproximatelyEqual func(tol); - typename Derived::Iterator const i_end = expr.end(); - for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { - if (!allclose(scalar, *i, tol)) return false; - } - return true; -} - -template -inline typename boost::enable_if::IsScalar,bool>::type -allclose(ExpressionBase const & expr, Scalar const & scalar, double tol=1E-8) { - return allclose(scalar, expr, tol); -} - -template -inline bool -allclose(ExpressionBase const & expr1, ExpressionBase const & expr2, double tol=1E-8) { - typename Derived1::Iterator const i_end = expr1.end(); - typename Derived1::Iterator i = expr1.begin(); - typename Derived2::Iterator j = expr2.begin(); - for (; i != i_end; ++i, ++j) { - if (!allclose(*i, *j, tol)) return false; - } - return true; -} - - -template -inline typename boost::enable_if::IsScalar, Scalar>::type -sum(Scalar const & scalar) { return scalar; } - - -/** - * \brief Return the sum of all elements of the given expression. - * - * \ingroup MainGroup - */ -template -inline typename Derived::Element -sum(ExpressionBase const & expr) { - typename Derived::Iterator const i_end = expr.end(); - typename Derived::Element total = static_cast(0); - for (typename Derived::Iterator i = expr.begin(); i != i_end; ++i) { - total += sum(*i); - } - return total; -} - - -} // namespace ndarray - -#endif // !NDARRAY_operators_h_INCLUDED diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 1f78168c..43c383ce 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -16,12 +16,12 @@ include_directories( ) add_executable(ndarray ndarray.cc) -add_dependencies(ndarray preprocess_includes2) + target_link_libraries(ndarray ${Boost_LIBRARIES}) add_test(test_ndarray ndarray) add_executable(views views.cc) -add_dependencies(views preprocess_includes2) + target_link_libraries(views ${Boost_LIBRARIES}) add_test(test_views views) @@ -33,7 +33,7 @@ if(NDARRAY_EIGEN) include_directories( ${EIGEN3_INCLUDE_DIR} ) add_executable(ndarray-eigen ndarray-eigen.cc) - add_dependencies(ndarray-eigen preprocess_includes2) + target_link_libraries(ndarray-eigen ${Boost_LIBRARIES}) add_test(test_ndarray_eigen ndarray-eigen) endif(NDARRAY_EIGEN) @@ -44,7 +44,7 @@ if(NDARRAY_FFTW) include_directories( ${FFTW_INCLUDES} ) add_executable(ndarray-fft ndarray-fft.cc) - add_dependencies(ndarray-fft preprocess_includes2) + target_link_libraries(ndarray-fft ${Boost_LIBRARIES} ${FFTW_LIBRARIES}) add_test(test_ndarray-fft ndarray-fft) endif(NDARRAY_FFTW) @@ -69,7 +69,7 @@ if(NDARRAY_PYBIND11) include_directories(${PYBIND11_INCLUDE_DIR}) pybind11_add_module(pybind11_test_mod pybind11_test_mod.cc) - add_dependencies(pybind11_test_mod preprocess_includes2) + configure_file(pybind11_test.py pybind11_test.py COPYONLY) add_test(NAME pybind11_test From d151f9fadf75775d58bbbbb18a1450eec5c0cf35 Mon Sep 17 00:00:00 2001 From: Matthias Wittgen Date: Mon, 11 Jan 2021 15:40:36 -0500 Subject: [PATCH 07/29] use modern cmake; clean up doxygen generation fix numpy detection --- .gitignore | 20 - CMakeLists.txt | 27 +- cmake/FindEigen3.cmake | 83 -- cmake/FindFFTW.cmake | 124 -- cmake/FindNumPy.cmake | 90 -- cmake/FindPythonInterp.cmake | 165 --- cmake/FindPythonLibs.cmake | 354 ------ doc/CMakeLists.txt | 7 + doc/doxygen.conf.in | 2280 ++++++++++++++++++++++++++++++++++ doxygen.conf.in | 2280 ---------------------------------- include/CMakeLists.txt | 19 + tests/CMakeLists.txt | 46 +- 12 files changed, 2328 insertions(+), 3167 deletions(-) delete mode 100644 cmake/FindEigen3.cmake delete mode 100644 cmake/FindFFTW.cmake delete mode 100644 cmake/FindNumPy.cmake delete mode 100644 cmake/FindPythonInterp.cmake delete mode 100644 cmake/FindPythonLibs.cmake create mode 100644 doc/CMakeLists.txt delete mode 100644 doxygen.conf.in create mode 100644 include/CMakeLists.txt diff --git a/.gitignore b/.gitignore index 51eb3e96..567609b1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,21 +1 @@ -.sconsign.dblite -config.log -.sconf_temp -*.dylib -*.o -*.os -*.so -*.cfgc -*.pyc -*_wrap.cc -doc/html -doc/*.tag -doc/*.inc -doc/doxygen.conf -tests/.tests -tests/*.test -version.py -tests/ndarray -tests/ndarray-eigen -tests/ndarray-fft build/ diff --git a/CMakeLists.txt b/CMakeLists.txt index 7031c7d4..60ca1684 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,6 +1,6 @@ -cmake_minimum_required(VERSION 2.8.11) - -project(ndarray) +cmake_minimum_required(VERSION 3.1 ) +project(ndarray LANGUAGES CXX) +set (CMAKE_CXX_STANDARD 11) # Build is split into two broad passes: # (1) Generation, which performs macro-expansion and header installation. @@ -14,29 +14,17 @@ project(ndarray) # The test phase may rely on external libraries, which are enabled via the # options below. Library resolution is deferred to tests/CMakeLists.txt and # only executed if NDARRAY_TEST is enabled. + option(NDARRAY_TEST "Enable tests?" ON) option(NDARRAY_EIGEN "Enable Eigen tests?" ON) option(NDARRAY_FFTW "Enable FFTW tests?" ON) option(NDARRAY_PYBIND11 "Enable Pybind11 tests?" OFF) -# enable C++11 support -add_definitions(-std=c++11) - -# put our local cmake find scripts at the beginning of the cmake -# module search path -set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH}) - +add_subdirectory(include) -# add a target to generate API documentation with Doxygen find_package(Doxygen) if(DOXYGEN_FOUND) - configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.conf.in - ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf @ONLY) - add_custom_target(doc ${DOXYGEN_EXECUTABLE} - ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} - COMMENT "Running Doxygen" VERBATIM -) + add_subdirectory(doc) endif(DOXYGEN_FOUND) if(NDARRAY_TEST) @@ -44,6 +32,3 @@ if(NDARRAY_TEST) add_subdirectory(tests) endif(NDARRAY_TEST) -# installation -install(DIRECTORY include/ DESTINATION include/ - FILES_MATCHING PATTERN "*.h") diff --git a/cmake/FindEigen3.cmake b/cmake/FindEigen3.cmake deleted file mode 100644 index 225d1d56..00000000 --- a/cmake/FindEigen3.cmake +++ /dev/null @@ -1,83 +0,0 @@ -# - Try to find Eigen3 lib -# -# This module supports requiring a minimum version, e.g. you can do -# find_package(Eigen3 3.1.2) -# to require version 3.1.2 or newer of Eigen3. -# -# Once done this will define -# -# EIGEN3_FOUND - system has eigen lib with correct version -# EIGEN3_INCLUDE_DIR - the eigen include directory -# EIGEN3_VERSION - eigen version - -# Copyright (c) 2006, 2007 Montel Laurent, -# Copyright (c) 2008, 2009 Gael Guennebaud, -# Copyright (c) 2009 Benoit Jacob -# Redistribution and use is allowed according to the terms of the 2-clause BSD license. - -if(NOT Eigen3_FIND_VERSION) - if(NOT Eigen3_FIND_VERSION_MAJOR) - set(Eigen3_FIND_VERSION_MAJOR 2) - endif(NOT Eigen3_FIND_VERSION_MAJOR) - if(NOT Eigen3_FIND_VERSION_MINOR) - set(Eigen3_FIND_VERSION_MINOR 91) - endif(NOT Eigen3_FIND_VERSION_MINOR) - if(NOT Eigen3_FIND_VERSION_PATCH) - set(Eigen3_FIND_VERSION_PATCH 0) - endif(NOT Eigen3_FIND_VERSION_PATCH) - - set(Eigen3_FIND_VERSION "${Eigen3_FIND_VERSION_MAJOR}.${Eigen3_FIND_VERSION_MINOR}.${Eigen3_FIND_VERSION_PATCH}") -endif(NOT Eigen3_FIND_VERSION) - -macro(_eigen3_check_version) - file(READ "${EIGEN3_INCLUDE_DIR}/Eigen/src/Core/util/Macros.h" _eigen3_version_header) - - string(REGEX MATCH "define[ \t]+EIGEN_WORLD_VERSION[ \t]+([0-9]+)" _eigen3_world_version_match "${_eigen3_version_header}") - set(EIGEN3_WORLD_VERSION "${CMAKE_MATCH_1}") - string(REGEX MATCH "define[ \t]+EIGEN_MAJOR_VERSION[ \t]+([0-9]+)" _eigen3_major_version_match "${_eigen3_version_header}") - set(EIGEN3_MAJOR_VERSION "${CMAKE_MATCH_1}") - string(REGEX MATCH "define[ \t]+EIGEN_MINOR_VERSION[ \t]+([0-9]+)" _eigen3_minor_version_match "${_eigen3_version_header}") - set(EIGEN3_MINOR_VERSION "${CMAKE_MATCH_1}") - - set(EIGEN3_VERSION ${EIGEN3_WORLD_VERSION}.${EIGEN3_MAJOR_VERSION}.${EIGEN3_MINOR_VERSION}) - if(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) - set(EIGEN3_VERSION_OK FALSE) - else(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) - set(EIGEN3_VERSION_OK TRUE) - endif(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) - - if(NOT EIGEN3_VERSION_OK) - - message(STATUS "Eigen3 version ${EIGEN3_VERSION} found in ${EIGEN3_INCLUDE_DIR}, " - "but at least version ${Eigen3_FIND_VERSION} is required") - endif(NOT EIGEN3_VERSION_OK) -endmacro(_eigen3_check_version) - -if (EIGEN3_INCLUDE_DIR) - - # in cache already - _eigen3_check_version() - set(EIGEN3_FOUND ${EIGEN3_VERSION_OK}) - -else (EIGEN3_INCLUDE_DIR) - message(STATUS "Trying to find eigen in $ENV{EIGEN_DIR}") - - find_path(EIGEN3_INCLUDE_DIR NAMES signature_of_eigen3_matrix_library - PATHS - $ENV{EIGEN_DIR} - ${CMAKE_INSTALL_PREFIX}/include - ${KDE4_INCLUDE_DIR} - PATH_SUFFIXES eigen3 eigen include include/eigen3 include/eigen - ) - - if(EIGEN3_INCLUDE_DIR) - _eigen3_check_version() - endif(EIGEN3_INCLUDE_DIR) - - include(FindPackageHandleStandardArgs) - find_package_handle_standard_args(Eigen3 DEFAULT_MSG EIGEN3_INCLUDE_DIR EIGEN3_VERSION_OK) - - mark_as_advanced(EIGEN3_INCLUDE_DIR) - -endif(EIGEN3_INCLUDE_DIR) - diff --git a/cmake/FindFFTW.cmake b/cmake/FindFFTW.cmake deleted file mode 100644 index 48aed3e8..00000000 --- a/cmake/FindFFTW.cmake +++ /dev/null @@ -1,124 +0,0 @@ -# - Find the FFTW library -# -# Usage: -# find_package(FFTW [REQUIRED] [QUIET] ) -# -# It sets the following variables: -# FFTW_FOUND ... true if fftw is found on the system -# FFTW_LIBRARIES ... full path to fftw library -# FFTW_INCLUDES ... fftw include directory -# -# The following variables will be checked by the function -# FFTW_USE_STATIC_LIBS ... if true, only static libraries are found -# FFTW_ROOT ... if set, the libraries are exclusively searched -# under this path -# FFTW_LIBRARY ... fftw library to use -# FFTW_INCLUDE_DIR ... fftw include directory -# - -#If environment variable FFTWDIR is specified, it has same effect as FFTW_ROOT -if( NOT FFTW_ROOT AND ENV{FFTWDIR} ) - set( FFTW_ROOT $ENV{FFTWDIR} ) -endif() - -#Add FFTW_DIR support to mirror other dependencies -if( NOT FFTW_ROOT AND ENV{FFTW_DIR} ) - set( FFTW_ROOT $ENV{FFTW_DIR} ) -endif() - -# Check if we can use PkgConfig -find_package(PkgConfig) - -#Determine from PKG -if( PKG_CONFIG_FOUND AND NOT FFTW_ROOT ) - pkg_check_modules( PKG_FFTW QUIET "fftw3" ) -endif() - -#Check whether to search static or dynamic libs -set( CMAKE_FIND_LIBRARY_SUFFIXES_SAV ${CMAKE_FIND_LIBRARY_SUFFIXES} ) - -if( ${FFTW_USE_STATIC_LIBS} ) - set( CMAKE_FIND_LIBRARY_SUFFIXES ${CMAKE_STATIC_LIBRARY_SUFFIX} ) -else() - set( CMAKE_FIND_LIBRARY_SUFFIXES ${CMAKE_SHARED_LIBRARY_SUFFIX} ) -endif() - -if( FFTW_ROOT ) - - #find libs - find_library( - FFTW_LIB - NAMES "fftw3" - PATHS ${FFTW_ROOT} - PATH_SUFFIXES "lib" "lib64" - NO_DEFAULT_PATH - ) - - find_library( - FFTWF_LIB - NAMES "fftw3f" - PATHS ${FFTW_ROOT} - PATH_SUFFIXES "lib" "lib64" - NO_DEFAULT_PATH - ) - - find_library( - FFTWL_LIB - NAMES "fftw3l" - PATHS ${FFTW_ROOT} - PATH_SUFFIXES "lib" "lib64" - NO_DEFAULT_PATH - ) - - #find includes - find_path( - FFTW_INCLUDES - NAMES "fftw3.h" - PATHS ${FFTW_ROOT} - PATH_SUFFIXES "include" - NO_DEFAULT_PATH - ) - -else() - - find_library( - FFTW_LIB - NAMES "fftw3" - PATHS ${PKG_FFTW_LIBRARY_DIRS} ${LIB_INSTALL_DIR} - ) - - find_library( - FFTWF_LIB - NAMES "fftw3f" - PATHS ${PKG_FFTW_LIBRARY_DIRS} ${LIB_INSTALL_DIR} - ) - - - find_library( - FFTWL_LIB - NAMES "fftw3l" - PATHS ${PKG_FFTW_LIBRARY_DIRS} ${LIB_INSTALL_DIR} - ) - - find_path( - FFTW_INCLUDES - NAMES "fftw3.h" - PATHS ${PKG_FFTW_INCLUDE_DIRS} ${INCLUDE_INSTALL_DIR} - ) - -endif( FFTW_ROOT ) - -set(FFTW_LIBRARIES ${FFTW_LIB} ${FFTWF_LIB}) - -if(FFTWL_LIB) - set(FFTW_LIBRARIES ${FFTW_LIBRARIES} ${FFTWL_LIB}) -endif() - -set( CMAKE_FIND_LIBRARY_SUFFIXES ${CMAKE_FIND_LIBRARY_SUFFIXES_SAV} ) - -include(FindPackageHandleStandardArgs) -find_package_handle_standard_args(FFTW DEFAULT_MSG - FFTW_INCLUDES FFTW_LIBRARIES) - -mark_as_advanced(FFTW_INCLUDES FFTW_LIBRARIES FFTW_LIB FFTWF_LIB FFTWL_LIB) - diff --git a/cmake/FindNumPy.cmake b/cmake/FindNumPy.cmake deleted file mode 100644 index ecae7e6b..00000000 --- a/cmake/FindNumPy.cmake +++ /dev/null @@ -1,90 +0,0 @@ -# - Find the NumPy libraries -# This module finds if NumPy is installed, and sets the following variables -# indicating where it is. -# -# TODO: Update to provide the libraries and paths for linking npymath lib. -# -# NUMPY_FOUND - was NumPy found -# NUMPY_VERSION - the version of NumPy found as a string -# NUMPY_VERSION_MAJOR - the major version number of NumPy -# NUMPY_VERSION_MINOR - the minor version number of NumPy -# NUMPY_VERSION_PATCH - the patch version number of NumPy -# NUMPY_VERSION_DECIMAL - e.g. version 1.6.1 is 10601 -# NUMPY_INCLUDE_DIRS - path to the NumPy include files - -#============================================================================ -# Copyright 2012 Continuum Analytics, Inc. -# -# MIT License -# -# Permission is hereby granted, free of charge, to any person obtaining -# a copy of this software and associated documentation files -# (the "Software"), to deal in the Software without restriction, including -# without limitation the rights to use, copy, modify, merge, publish, -# distribute, sublicense, and/or sell copies of the Software, and to permit -# persons to whom the Software is furnished to do so, subject to -# the following conditions: -# -# The above copyright notice and this permission notice shall be included -# in all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR -# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -# OTHER DEALINGS IN THE SOFTWARE. -# -#============================================================================ - -# Finding NumPy involves calling the Python interpreter -if(NumPy_FIND_REQUIRED) - find_package(PythonInterp REQUIRED) -else() - find_package(PythonInterp) -endif() - -if(NOT PYTHONINTERP_FOUND) - set(NUMPY_FOUND FALSE) -endif() - -execute_process(COMMAND "${PYTHON_EXECUTABLE}" "-c" - "import numpy as n; print(n.__version__); print(n.get_include());" - RESULT_VARIABLE _NUMPY_SEARCH_SUCCESS - OUTPUT_VARIABLE _NUMPY_VALUES - ERROR_VARIABLE _NUMPY_ERROR_VALUE - OUTPUT_STRIP_TRAILING_WHITESPACE) - -if(NOT _NUMPY_SEARCH_SUCCESS MATCHES 0) - if(NumPy_FIND_REQUIRED) - message(FATAL_ERROR - "NumPy import failure:\n${_NUMPY_ERROR_VALUE}") - endif() - set(NUMPY_FOUND FALSE) -endif() - -# Convert the process output into a list -string(REGEX REPLACE ";" "\\\\;" _NUMPY_VALUES ${_NUMPY_VALUES}) -string(REGEX REPLACE "\n" ";" _NUMPY_VALUES ${_NUMPY_VALUES}) -list(GET _NUMPY_VALUES 0 NUMPY_VERSION) -list(GET _NUMPY_VALUES 1 NUMPY_INCLUDE_DIRS) - -# Make sure all directory separators are '/' -string(REGEX REPLACE "\\\\" "/" NUMPY_INCLUDE_DIRS ${NUMPY_INCLUDE_DIRS}) - -# Get the major and minor version numbers -string(REGEX REPLACE "\\." ";" _NUMPY_VERSION_LIST ${NUMPY_VERSION}) -list(GET _NUMPY_VERSION_LIST 0 NUMPY_VERSION_MAJOR) -list(GET _NUMPY_VERSION_LIST 1 NUMPY_VERSION_MINOR) -list(GET _NUMPY_VERSION_LIST 2 NUMPY_VERSION_PATCH) -string(REGEX MATCH "[0-9]*" NUMPY_VERSION_PATCH ${NUMPY_VERSION_PATCH}) -math(EXPR NUMPY_VERSION_DECIMAL - "(${NUMPY_VERSION_MAJOR} * 10000) + (${NUMPY_VERSION_MINOR} * 100) + ${NUMPY_VERSION_PATCH}") - -find_package_message(NUMPY - "Found NumPy: version \"${NUMPY_VERSION}\" ${NUMPY_INCLUDE_DIRS}" - "${NUMPY_INCLUDE_DIRS}${NUMPY_VERSION}") - -set(NUMPY_FOUND TRUE) - diff --git a/cmake/FindPythonInterp.cmake b/cmake/FindPythonInterp.cmake deleted file mode 100644 index 4117f7f5..00000000 --- a/cmake/FindPythonInterp.cmake +++ /dev/null @@ -1,165 +0,0 @@ -#.rst: -# FindPythonInterp -# ---------------- -# -# Find python interpreter -# -# This module finds if Python interpreter is installed and determines -# where the executables are. This code sets the following variables: -# -# :: -# -# PYTHONINTERP_FOUND - Was the Python executable found -# PYTHON_EXECUTABLE - path to the Python interpreter -# -# -# -# :: -# -# PYTHON_VERSION_STRING - Python version found e.g. 2.5.2 -# PYTHON_VERSION_MAJOR - Python major version found e.g. 2 -# PYTHON_VERSION_MINOR - Python minor version found e.g. 5 -# PYTHON_VERSION_PATCH - Python patch version found e.g. 2 -# -# -# -# The Python_ADDITIONAL_VERSIONS variable can be used to specify a list -# of version numbers that should be taken into account when searching -# for Python. You need to set this variable before calling -# find_package(PythonInterp). -# -# If calling both ``find_package(PythonInterp)`` and -# ``find_package(PythonLibs)``, call ``find_package(PythonInterp)`` first to -# get the currently active Python version by default with a consistent version -# of PYTHON_LIBRARIES. - -#============================================================================= -# Copyright 2005-2010 Kitware, Inc. -# Copyright 2011 Bjoern Ricks -# Copyright 2012 Rolf Eike Beer -# -# Distributed under the OSI-approved BSD License (the "License"); -# see accompanying file Copyright.txt for details. -# -# This software is distributed WITHOUT ANY WARRANTY; without even the -# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# See the License for more information. -#============================================================================= -# (To distribute this file outside of CMake, substitute the full -# License text for the above reference.) - -unset(_Python_NAMES) - -set(_PYTHON1_VERSIONS 1.6 1.5) -set(_PYTHON2_VERSIONS 2.7 2.6 2.5 2.4 2.3 2.2 2.1 2.0) -set(_PYTHON3_VERSIONS 3.6 3.5 3.4 3.3 3.2 3.1 3.0) - -if(PythonInterp_FIND_VERSION) - if(PythonInterp_FIND_VERSION_COUNT GREATER 1) - set(_PYTHON_FIND_MAJ_MIN "${PythonInterp_FIND_VERSION_MAJOR}.${PythonInterp_FIND_VERSION_MINOR}") - list(APPEND _Python_NAMES - python${_PYTHON_FIND_MAJ_MIN} - python${PythonInterp_FIND_VERSION_MAJOR}) - unset(_PYTHON_FIND_OTHER_VERSIONS) - if(NOT PythonInterp_FIND_VERSION_EXACT) - foreach(_PYTHON_V ${_PYTHON${PythonInterp_FIND_VERSION_MAJOR}_VERSIONS}) - if(NOT _PYTHON_V VERSION_LESS _PYTHON_FIND_MAJ_MIN) - list(APPEND _PYTHON_FIND_OTHER_VERSIONS ${_PYTHON_V}) - endif() - endforeach() - endif() - unset(_PYTHON_FIND_MAJ_MIN) - else() - list(APPEND _Python_NAMES python${PythonInterp_FIND_VERSION_MAJOR}) - set(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON${PythonInterp_FIND_VERSION_MAJOR}_VERSIONS}) - endif() -else() - set(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON3_VERSIONS} ${_PYTHON2_VERSIONS} ${_PYTHON1_VERSIONS}) -endif() -find_program(PYTHON_EXECUTABLE NAMES ${_Python_NAMES}) - -# Set up the versions we know about, in the order we will search. Always add -# the user supplied additional versions to the front. -set(_Python_VERSIONS ${Python_ADDITIONAL_VERSIONS}) -# If FindPythonInterp has already found the major and minor version, -# insert that version next to get consistent versions of the interpreter and -# library. -if(DEFINED PYTHONLIBS_VERSION_STRING) - string(REPLACE "." ";" _PYTHONLIBS_VERSION "${PYTHONLIBS_VERSION_STRING}") - list(GET _PYTHONLIBS_VERSION 0 _PYTHONLIBS_VERSION_MAJOR) - list(GET _PYTHONLIBS_VERSION 1 _PYTHONLIBS_VERSION_MINOR) - list(APPEND _Python_VERSIONS ${_PYTHONLIBS_VERSION_MAJOR}.${_PYTHONLIBS_VERSION_MINOR}) -endif() -# Search for the current active python version first -list(APPEND _Python_VERSIONS ";") -list(APPEND _Python_VERSIONS ${_PYTHON_FIND_OTHER_VERSIONS}) - -unset(_PYTHON_FIND_OTHER_VERSIONS) -unset(_PYTHON1_VERSIONS) -unset(_PYTHON2_VERSIONS) -unset(_PYTHON3_VERSIONS) - -# Search for newest python version if python executable isn't found -if(NOT PYTHON_EXECUTABLE) - foreach(_CURRENT_VERSION IN LISTS _Python_VERSIONS) - set(_Python_NAMES python${_CURRENT_VERSION}) - if(WIN32) - list(APPEND _Python_NAMES python) - endif() - find_program(PYTHON_EXECUTABLE - NAMES ${_Python_NAMES} - PATHS [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath] - ) - endforeach() -endif() - -# determine python version string -if(PYTHON_EXECUTABLE) - execute_process(COMMAND "${PYTHON_EXECUTABLE}" -c - "import sys; sys.stdout.write(';'.join([str(x) for x in sys.version_info[:3]]))" - OUTPUT_VARIABLE _VERSION - RESULT_VARIABLE _PYTHON_VERSION_RESULT - ERROR_QUIET) - if(NOT _PYTHON_VERSION_RESULT) - string(REPLACE ";" "." PYTHON_VERSION_STRING "${_VERSION}") - list(GET _VERSION 0 PYTHON_VERSION_MAJOR) - list(GET _VERSION 1 PYTHON_VERSION_MINOR) - list(GET _VERSION 2 PYTHON_VERSION_PATCH) - if(PYTHON_VERSION_PATCH EQUAL 0) - # it's called "Python 2.7", not "2.7.0" - string(REGEX REPLACE "\\.0$" "" PYTHON_VERSION_STRING "${PYTHON_VERSION_STRING}") - endif() - else() - # sys.version predates sys.version_info, so use that - execute_process(COMMAND "${PYTHON_EXECUTABLE}" -c "import sys; sys.stdout.write(sys.version)" - OUTPUT_VARIABLE _VERSION - RESULT_VARIABLE _PYTHON_VERSION_RESULT - ERROR_QUIET) - if(NOT _PYTHON_VERSION_RESULT) - string(REGEX REPLACE " .*" "" PYTHON_VERSION_STRING "${_VERSION}") - string(REGEX REPLACE "^([0-9]+)\\.[0-9]+.*" "\\1" PYTHON_VERSION_MAJOR "${PYTHON_VERSION_STRING}") - string(REGEX REPLACE "^[0-9]+\\.([0-9])+.*" "\\1" PYTHON_VERSION_MINOR "${PYTHON_VERSION_STRING}") - if(PYTHON_VERSION_STRING MATCHES "^[0-9]+\\.[0-9]+\\.([0-9]+)") - set(PYTHON_VERSION_PATCH "${CMAKE_MATCH_1}") - else() - set(PYTHON_VERSION_PATCH "0") - endif() - else() - # sys.version was first documented for Python 1.5, so assume - # this is older. - set(PYTHON_VERSION_STRING "1.4") - set(PYTHON_VERSION_MAJOR "1") - set(PYTHON_VERSION_MINOR "4") - set(PYTHON_VERSION_PATCH "0") - endif() - endif() - unset(_PYTHON_VERSION_RESULT) - unset(_VERSION) -endif() - -# handle the QUIETLY and REQUIRED arguments and set PYTHONINTERP_FOUND to TRUE if -# all listed variables are TRUE -include(FindPackageHandleStandardArgs) -FIND_PACKAGE_HANDLE_STANDARD_ARGS(PythonInterp REQUIRED_VARS PYTHON_EXECUTABLE VERSION_VAR PYTHON_VERSION_STRING) - -mark_as_advanced(PYTHON_EXECUTABLE) diff --git a/cmake/FindPythonLibs.cmake b/cmake/FindPythonLibs.cmake deleted file mode 100644 index 5e6e6f6b..00000000 --- a/cmake/FindPythonLibs.cmake +++ /dev/null @@ -1,354 +0,0 @@ -#.rst: -# FindPythonLibs -# -------------- -# -# Find python libraries -# -# This module finds if Python is installed and determines where the -# include files and libraries are. It also determines what the name of -# the library is. This code sets the following variables: -# -# :: -# -# PYTHONLIBS_FOUND - have the Python libs been found -# PYTHON_LIBRARIES - path to the python library -# PYTHON_INCLUDE_PATH - path to where Python.h is found (deprecated) -# PYTHON_INCLUDE_DIRS - path to where Python.h is found -# PYTHON_DEBUG_LIBRARIES - path to the debug library (deprecated) -# PYTHONLIBS_VERSION_STRING - version of the Python libs found (since CMake 2.8.8) -# -# -# -# The Python_ADDITIONAL_VERSIONS variable can be used to specify a list -# of version numbers that should be taken into account when searching -# for Python. You need to set this variable before calling -# find_package(PythonLibs). -# -# If you'd like to specify the installation of Python to use, you should -# modify the following cache variables: -# -# :: -# -# PYTHON_LIBRARY - path to the python library -# PYTHON_INCLUDE_DIR - path to where Python.h is found -# -# If calling both ``find_package(PythonInterp)`` and -# ``find_package(PythonLibs)``, call ``find_package(PythonInterp)`` first to -# get the currently active Python version by default with a consistent version -# of PYTHON_LIBRARIES. - -#============================================================================= -# Copyright 2001-2009 Kitware, Inc. -# -# Distributed under the OSI-approved BSD License (the "License"); -# see accompanying file Copyright.txt for details. -# -# This software is distributed WITHOUT ANY WARRANTY; without even the -# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# See the License for more information. -#============================================================================= -# (To distribute this file outside of CMake, substitute the full -# License text for the above reference.) - -# Use the executable's path as a hint -set(_Python_LIBRARY_PATH_HINT) -if(PYTHON_EXECUTABLE) - if(WIN32) - get_filename_component(_Python_PREFIX ${PYTHON_EXECUTABLE} PATH) - if(_Python_PREFIX) - set(_Python_LIBRARY_PATH_HINT ${_Python_PREFIX}/libs) - endif() - unset(_Python_PREFIX) - else() - get_filename_component(_Python_PREFIX ${PYTHON_EXECUTABLE} PATH) - get_filename_component(_Python_PREFIX ${_Python_PREFIX} PATH) - if(_Python_PREFIX) - set(_Python_LIBRARY_PATH_HINT ${_Python_PREFIX}/lib) - endif() - unset(_Python_PREFIX) - endif() -endif() - -include(CMakeFindFrameworks) -# Search for the python framework on Apple. -CMAKE_FIND_FRAMEWORKS(Python) - -# Save CMAKE_FIND_FRAMEWORK -if(DEFINED CMAKE_FIND_FRAMEWORK) - set(_PythonLibs_CMAKE_FIND_FRAMEWORK ${CMAKE_FIND_FRAMEWORK}) -else() - unset(_PythonLibs_CMAKE_FIND_FRAMEWORK) -endif() -# To avoid picking up the system Python.h pre-maturely. -set(CMAKE_FIND_FRAMEWORK LAST) - -set(_PYTHON1_VERSIONS 1.6 1.5) -set(_PYTHON2_VERSIONS 2.7 2.6 2.5 2.4 2.3 2.2 2.1 2.0) -set(_PYTHON3_VERSIONS 3.6 3.5 3.4 3.3 3.2 3.1 3.0) - -if(PythonLibs_FIND_VERSION) - if(PythonLibs_FIND_VERSION_COUNT GREATER 1) - set(_PYTHON_FIND_MAJ_MIN "${PythonLibs_FIND_VERSION_MAJOR}.${PythonLibs_FIND_VERSION_MINOR}") - unset(_PYTHON_FIND_OTHER_VERSIONS) - if(PythonLibs_FIND_VERSION_EXACT) - if(_PYTHON_FIND_MAJ_MIN STREQUAL PythonLibs_FIND_VERSION) - set(_PYTHON_FIND_OTHER_VERSIONS "${PythonLibs_FIND_VERSION}") - else() - set(_PYTHON_FIND_OTHER_VERSIONS "${PythonLibs_FIND_VERSION}" "${_PYTHON_FIND_MAJ_MIN}") - endif() - else() - foreach(_PYTHON_V ${_PYTHON${PythonLibs_FIND_VERSION_MAJOR}_VERSIONS}) - if(NOT _PYTHON_V VERSION_LESS _PYTHON_FIND_MAJ_MIN) - list(APPEND _PYTHON_FIND_OTHER_VERSIONS ${_PYTHON_V}) - endif() - endforeach() - endif() - unset(_PYTHON_FIND_MAJ_MIN) - else() - set(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON${PythonLibs_FIND_VERSION_MAJOR}_VERSIONS}) - endif() -else() - set(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON3_VERSIONS} ${_PYTHON2_VERSIONS} ${_PYTHON1_VERSIONS}) -endif() - -# Set up the versions we know about, in the order we will search. Always add -# the user supplied additional versions to the front. -# If FindPythonInterp has already found the major and minor version, -# insert that version between the user supplied versions and the stock -# version list. -set(_Python_VERSIONS ${Python_ADDITIONAL_VERSIONS}) -if(DEFINED PYTHON_VERSION_MAJOR AND DEFINED PYTHON_VERSION_MINOR) - list(APPEND _Python_VERSIONS ${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}) -endif() -list(APPEND _Python_VERSIONS ${_PYTHON_FIND_OTHER_VERSIONS}) - -unset(_PYTHON_FIND_OTHER_VERSIONS) -unset(_PYTHON1_VERSIONS) -unset(_PYTHON2_VERSIONS) -unset(_PYTHON3_VERSIONS) - -foreach(_CURRENT_VERSION ${_Python_VERSIONS}) - string(REPLACE "." "" _CURRENT_VERSION_NO_DOTS ${_CURRENT_VERSION}) - if(WIN32) - find_library(PYTHON_DEBUG_LIBRARY - NAMES python${_CURRENT_VERSION_NO_DOTS}_d python - HINTS ${_Python_LIBRARY_PATH_HINT} - PATHS - [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs/Debug - [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs/Debug - [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs - [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs - ) - endif() - - set(PYTHON_FRAMEWORK_LIBRARIES) - if(Python_FRAMEWORKS AND NOT PYTHON_LIBRARY) - foreach(dir ${Python_FRAMEWORKS}) - list(APPEND PYTHON_FRAMEWORK_LIBRARIES - ${dir}/Versions/${_CURRENT_VERSION}/lib) - endforeach() - endif() - find_library(PYTHON_LIBRARY - NAMES - python${_CURRENT_VERSION_NO_DOTS} - python${_CURRENT_VERSION}mu - python${_CURRENT_VERSION}m - python${_CURRENT_VERSION}u - python${_CURRENT_VERSION} - HINTS - ${_Python_LIBRARY_PATH_HINT} - PATHS - ${PYTHON_FRAMEWORK_LIBRARIES} - [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs - [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs - # Avoid finding the .dll in the PATH. We want the .lib. - NO_SYSTEM_ENVIRONMENT_PATH - ) - # Look for the static library in the Python config directory - find_library(PYTHON_LIBRARY - NAMES python${_CURRENT_VERSION_NO_DOTS} python${_CURRENT_VERSION} - # Avoid finding the .dll in the PATH. We want the .lib. - NO_SYSTEM_ENVIRONMENT_PATH - # This is where the static library is usually located - PATH_SUFFIXES python${_CURRENT_VERSION}/config - ) - - # Don't search for include dir until library location is known - if(PYTHON_LIBRARY) - - # Use the library's install prefix as a hint - set(_Python_INCLUDE_PATH_HINT) - get_filename_component(_Python_PREFIX ${PYTHON_LIBRARY} PATH) - get_filename_component(_Python_PREFIX ${_Python_PREFIX} PATH) - if(_Python_PREFIX) - set(_Python_INCLUDE_PATH_HINT ${_Python_PREFIX}/include) - endif() - unset(_Python_PREFIX) - - # Add framework directories to the search paths - set(PYTHON_FRAMEWORK_INCLUDES) - if(Python_FRAMEWORKS AND NOT PYTHON_INCLUDE_DIR) - foreach(dir ${Python_FRAMEWORKS}) - list(APPEND PYTHON_FRAMEWORK_INCLUDES - ${dir}/Versions/${_CURRENT_VERSION}/include) - endforeach() - endif() - - find_path(PYTHON_INCLUDE_DIR - NAMES Python.h - HINTS - ${_Python_INCLUDE_PATH_HINT} - PATHS - ${PYTHON_FRAMEWORK_INCLUDES} - [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/include - [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/include - PATH_SUFFIXES - python${_CURRENT_VERSION}mu - python${_CURRENT_VERSION}m - python${_CURRENT_VERSION}u - python${_CURRENT_VERSION} - ) - endif() - - # For backward compatibility, set PYTHON_INCLUDE_PATH. - set(PYTHON_INCLUDE_PATH "${PYTHON_INCLUDE_DIR}") - - if(PYTHON_INCLUDE_DIR AND EXISTS "${PYTHON_INCLUDE_DIR}/patchlevel.h") - file(STRINGS "${PYTHON_INCLUDE_DIR}/patchlevel.h" python_version_str - REGEX "^#define[ \t]+PY_VERSION[ \t]+\"[^\"]+\"") - string(REGEX REPLACE "^#define[ \t]+PY_VERSION[ \t]+\"([^\"]+)\".*" "\\1" - PYTHONLIBS_VERSION_STRING "${python_version_str}") - unset(python_version_str) - endif() - - if(PYTHON_LIBRARY AND PYTHON_INCLUDE_DIR) - break() - endif() -endforeach() - -unset(_Python_INCLUDE_PATH_HINT) -unset(_Python_LIBRARY_PATH_HINT) - -mark_as_advanced( - PYTHON_DEBUG_LIBRARY - PYTHON_LIBRARY - PYTHON_INCLUDE_DIR -) - -# We use PYTHON_INCLUDE_DIR, PYTHON_LIBRARY and PYTHON_DEBUG_LIBRARY for the -# cache entries because they are meant to specify the location of a single -# library. We now set the variables listed by the documentation for this -# module. -set(PYTHON_INCLUDE_DIRS "${PYTHON_INCLUDE_DIR}") -set(PYTHON_DEBUG_LIBRARIES "${PYTHON_DEBUG_LIBRARY}") - -# These variables have been historically named in this module different from -# what SELECT_LIBRARY_CONFIGURATIONS() expects. -set(PYTHON_LIBRARY_DEBUG "${PYTHON_DEBUG_LIBRARY}") -set(PYTHON_LIBRARY_RELEASE "${PYTHON_LIBRARY}") -include(SelectLibraryConfigurations) -SELECT_LIBRARY_CONFIGURATIONS(PYTHON) -# SELECT_LIBRARY_CONFIGURATIONS() sets ${PREFIX}_FOUND if it has a library. -# Unset this, this prefix doesn't match the module prefix, they are different -# for historical reasons. -unset(PYTHON_FOUND) - -# Restore CMAKE_FIND_FRAMEWORK -if(DEFINED _PythonLibs_CMAKE_FIND_FRAMEWORK) - set(CMAKE_FIND_FRAMEWORK ${_PythonLibs_CMAKE_FIND_FRAMEWORK}) - unset(_PythonLibs_CMAKE_FIND_FRAMEWORK) -else() - unset(CMAKE_FIND_FRAMEWORK) -endif() - -include(FindPackageHandleStandardArgs) -FIND_PACKAGE_HANDLE_STANDARD_ARGS(PythonLibs - REQUIRED_VARS PYTHON_LIBRARIES PYTHON_INCLUDE_DIRS - VERSION_VAR PYTHONLIBS_VERSION_STRING) - -# PYTHON_ADD_MODULE( src1 src2 ... srcN) is used to build modules for python. -# PYTHON_WRITE_MODULES_HEADER() writes a header file you can include -# in your sources to initialize the static python modules -function(PYTHON_ADD_MODULE _NAME ) - get_property(_TARGET_SUPPORTS_SHARED_LIBS - GLOBAL PROPERTY TARGET_SUPPORTS_SHARED_LIBS) - option(PYTHON_ENABLE_MODULE_${_NAME} "Add module ${_NAME}" TRUE) - option(PYTHON_MODULE_${_NAME}_BUILD_SHARED - "Add module ${_NAME} shared" ${_TARGET_SUPPORTS_SHARED_LIBS}) - - # Mark these options as advanced - mark_as_advanced(PYTHON_ENABLE_MODULE_${_NAME} - PYTHON_MODULE_${_NAME}_BUILD_SHARED) - - if(PYTHON_ENABLE_MODULE_${_NAME}) - if(PYTHON_MODULE_${_NAME}_BUILD_SHARED) - set(PY_MODULE_TYPE MODULE) - else() - set(PY_MODULE_TYPE STATIC) - set_property(GLOBAL APPEND PROPERTY PY_STATIC_MODULES_LIST ${_NAME}) - endif() - - set_property(GLOBAL APPEND PROPERTY PY_MODULES_LIST ${_NAME}) - add_library(${_NAME} ${PY_MODULE_TYPE} ${ARGN}) -# target_link_libraries(${_NAME} ${PYTHON_LIBRARIES}) - - if(PYTHON_MODULE_${_NAME}_BUILD_SHARED) - set_target_properties(${_NAME} PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}") - if(WIN32 AND NOT CYGWIN) - set_target_properties(${_NAME} PROPERTIES SUFFIX ".pyd") - endif() - endif() - - endif() -endfunction() - -function(PYTHON_WRITE_MODULES_HEADER _filename) - - get_property(PY_STATIC_MODULES_LIST GLOBAL PROPERTY PY_STATIC_MODULES_LIST) - - get_filename_component(_name "${_filename}" NAME) - string(REPLACE "." "_" _name "${_name}") - string(TOUPPER ${_name} _nameUpper) - set(_filename ${CMAKE_CURRENT_BINARY_DIR}/${_filename}) - - set(_filenameTmp "${_filename}.in") - file(WRITE ${_filenameTmp} "/*Created by cmake, do not edit, changes will be lost*/\n") - file(APPEND ${_filenameTmp} -"#ifndef ${_nameUpper} -#define ${_nameUpper} - -#include - -#ifdef __cplusplus -extern \"C\" { -#endif /* __cplusplus */ - -") - - foreach(_currentModule ${PY_STATIC_MODULES_LIST}) - file(APPEND ${_filenameTmp} "extern void init${PYTHON_MODULE_PREFIX}${_currentModule}(void);\n\n") - endforeach() - - file(APPEND ${_filenameTmp} -"#ifdef __cplusplus -} -#endif /* __cplusplus */ - -") - - - foreach(_currentModule ${PY_STATIC_MODULES_LIST}) - file(APPEND ${_filenameTmp} "int ${_name}_${_currentModule}(void) \n{\n static char name[]=\"${PYTHON_MODULE_PREFIX}${_currentModule}\"; return PyImport_AppendInittab(name, init${PYTHON_MODULE_PREFIX}${_currentModule});\n}\n\n") - endforeach() - - file(APPEND ${_filenameTmp} "void ${_name}_LoadAllPythonModules(void)\n{\n") - foreach(_currentModule ${PY_STATIC_MODULES_LIST}) - file(APPEND ${_filenameTmp} " ${_name}_${_currentModule}();\n") - endforeach() - file(APPEND ${_filenameTmp} "}\n\n") - file(APPEND ${_filenameTmp} "#ifndef EXCLUDE_LOAD_ALL_FUNCTION\nvoid CMakeLoadAllPythonModules(void)\n{\n ${_name}_LoadAllPythonModules();\n}\n#endif\n\n#endif\n") - -# with configure_file() cmake complains that you may not use a file created using file(WRITE) as input file for configure_file() - execute_process(COMMAND ${CMAKE_COMMAND} -E copy_if_different "${_filenameTmp}" "${_filename}" OUTPUT_QUIET ERROR_QUIET) - -endfunction() diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 00000000..5f154054 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,7 @@ +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.conf.in + ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf @ONLY) +add_custom_target(doc ${DOXYGEN_EXECUTABLE} + ${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Running Doxygen" VERBATIM) + diff --git a/doc/doxygen.conf.in b/doc/doxygen.conf.in index e69de29b..ad7bedf6 100644 --- a/doc/doxygen.conf.in +++ b/doc/doxygen.conf.in @@ -0,0 +1,2280 @@ +# Doxyfile 1.8.5 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "ndarray" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "NumPy-friendly multidimensional arrays in C++" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese- +# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, +# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/include/ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.h + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /