diff --git a/.ci/azure/pipelines.py b/.ci/azure/pipelines.py deleted file mode 100755 index de945ba4bda2e74a1a40d9c211371933cbf3b648..0000000000000000000000000000000000000000 --- a/.ci/azure/pipelines.py +++ /dev/null @@ -1,39 +0,0 @@ -#!/usr/bin/env python3 -# kate: indent-width 2; - -tpl = '''# THIS FILE IS AUTOGENERATED -- DO NOT EDIT # -# Edit and Re-run .ci/azure/pipelines.py instead # - -resources: - repositories: - - repository: templates - type: github - name: dune-community/dune-xt-ci - endpoint: dune-xt-ci - -jobs: -{% for image, subdir in matrix -%} -- template: azure-job-template.yml@templates - parameters: - dockerimage: {{ image }} - jobname: {{subdir}}_{{ image[image.find('debian')+1+6:] }} - subdir: {{ subdir }} - module: 'dune-xt' -{% endfor %} -# - job: "Misc_Checks" -# steps: -# - bash: | -# [[ -f ./.gitsuper ]] && echo "Please remove .gitsuper from the repo" && exit 1 -# displayName: 'Forbit .gitsuper' -''' - -import os -import jinja2 -import sys -from itertools import product -tpl = jinja2.Template(tpl) -images = ['debian-unstable_gcc_full', 'debian_gcc_full', 'debian_clang_full'] -subdirs = ['common', 'grid', 'functions', 'la'] -matrix = product(images, subdirs) -with open(os.path.join(os.path.dirname(__file__), 'pipelines.yml'), 'wt') as yml: - yml.write(tpl.render(matrix=matrix)) diff --git a/.ci/azure/pipelines.yml b/.ci/azure/pipelines.yml deleted file mode 100644 index 65b95b35058eb613b6b561f7e1c78abe36735992..0000000000000000000000000000000000000000 --- a/.ci/azure/pipelines.yml +++ /dev/null @@ -1,89 +0,0 @@ -# THIS FILE IS AUTOGENERATED -- DO NOT EDIT # -# Edit and Re-run .ci/azure/pipelines.py instead # - -resources: - repositories: - - repository: templates - type: github - name: dune-community/dune-xt-ci - endpoint: dune-xt-ci - -jobs: -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian-unstable_gcc_full - jobname: common_unstable_gcc_full - subdir: common - module: 'dune-xt' -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian-unstable_gcc_full - jobname: grid_unstable_gcc_full - subdir: grid - module: 'dune-xt' -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian-unstable_gcc_full - jobname: functions_unstable_gcc_full - subdir: functions - module: 'dune-xt' -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian-unstable_gcc_full - jobname: la_unstable_gcc_full - subdir: la - module: 'dune-xt' -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian_gcc_full - jobname: common_gcc_full - subdir: common - module: 'dune-xt' -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian_gcc_full - jobname: grid_gcc_full - subdir: grid - module: 'dune-xt' -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian_gcc_full - jobname: functions_gcc_full - subdir: functions - module: 'dune-xt' -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian_gcc_full - jobname: la_gcc_full - subdir: la - module: 'dune-xt' -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian_clang_full - jobname: common_clang_full - subdir: common - module: 'dune-xt' -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian_clang_full - jobname: grid_clang_full - subdir: grid - module: 'dune-xt' -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian_clang_full - jobname: functions_clang_full - subdir: functions - module: 'dune-xt' -- template: azure-job-template.yml@templates - parameters: - dockerimage: debian_clang_full - jobname: la_clang_full - subdir: la - module: 'dune-xt' - -# - job: "Misc_Checks" -# steps: -# - bash: | -# [[ -f ./.gitsuper ]] && echo "Please remove .gitsuper from the repo" && exit 1 -# displayName: 'Forbit .gitsuper' \ No newline at end of file diff --git a/.ci/gitlab/.gitignore b/.ci/gitlab/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..e704cda1a45376affcf7fe54f6b9f54c31ce58b0 --- /dev/null +++ b/.ci/gitlab/.gitignore @@ -0,0 +1 @@ +!config.yml diff --git a/.ci/gitlab/config.yml b/.ci/gitlab/config.yml new file mode 100644 index 0000000000000000000000000000000000000000..4ed15b0f1d319d4e5f59db28fed35fbf7c392e50 --- /dev/null +++ b/.ci/gitlab/config.yml @@ -0,0 +1,153 @@ +# THIS FILE IS AUTOGENERATED -- DO NOT EDIT # +# Edit and Re-run .ci/gitlab/config_tpl.py instead # +stages: + - test + +variables: + GIT_SUBMODULE_STRATEGY: recursive + TRAVIS_BRANCH: ${CI_COMMIT_REF_NAME} + TRAVIS_COMMIT: ${CI_COMMIT_SHA} + MY_MODULE: dune-xt + +.subdir-test: + tags: + - docker-in-docker + - long execution time + stage: test + retry: + max: 2 + when: + - runner_system_failure + - stuck_or_timeout_failure + - api_failure + only: ['branches', 'tags', 'triggers', 'merge_requests'] + except: + - /^staging/.*$/i + retry: + max: 2 + when: + - always + image: docker:stable + variables: + DOCKER_HOST: tcp://docker:2375/ + DOCKER_DRIVER: overlay2 + IMAGE: $CI_REGISTRY/ag-ohlberger/dune-community/dune-xt/ci_testing_${DOCKER_TAG}:${CI_COMMIT_SHORT_SHA} + before_script: + - | + apk --update add openssh-client rsync git file bash python3 curl + pip3 install -U docker jinja2 docopt + + export BASEIMAGE="${MY_MODULE}-testing_${DOCKER_TAG}:${CI_COMMIT_REF_NAME/\//_}" + # get image with fallback to master branch of the super repo + docker pull dunecommunity/${BASEIMAGE} || export BASEIMAGE="${MY_MODULE}-testing_${DOCKER_TAG}:master" ; docker pull dunecommunity/${BASEIMAGE} + export ENV_FILE=${HOME}/env + mkdir ${CI_PROJECT_DIR}/testresults && chmod -R 777 ${CI_PROJECT_DIR}/testresults + DOCKER_RUN="docker run -v ${CI_PROJECT_DIR}/testresults:/home/dune-ci/testresults --env-file ${ENV_FILE} ${IMAGE}" + git submodule update --init --recursive + docker build --build-arg BASE=${BASEIMAGE} -t ${IMAGE} -f .ci/shared/docker/ci_run/Dockerfile . + script: + - | + [[ -f ./.gitsuper ]] && echo "Please remove .gitsuper from the repo" && exit 1 + python3 ./.ci/shared/scripts/make_env_file.py + ${DOCKER_RUN} /home/dune-ci/src/${MY_MODULE}/.ci/shared/scripts/test_cpp.bash + ${DOCKER_RUN} /home/dune-ci/src/${MY_MODULE}/.ci/shared/scripts/test_python.bash + touch $CI_PROJECT_DIR/success + + after_script: + - | + if [ -e $CI_PROJECT_DIR/success ]; then + echo "Not pushing ${IMAGE}" + else + docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY + docker push ${IMAGE} + fi + + artifacts: + reports: + junit: '${CI_PROJECT_DIR}/testresults/*xml' + services: + - docker:dind + environment: + name: unsafe + + +common unstable_gcc_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian-unstable_gcc_full + TESTS_MODULE_SUBDIR: common + +grid unstable_gcc_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian-unstable_gcc_full + TESTS_MODULE_SUBDIR: grid + +functions unstable_gcc_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian-unstable_gcc_full + TESTS_MODULE_SUBDIR: functions + tags: + - amm-only + +la unstable_gcc_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian-unstable_gcc_full + TESTS_MODULE_SUBDIR: la + tags: + - amm-only + +common gcc_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian_gcc_full + TESTS_MODULE_SUBDIR: common + +grid gcc_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian_gcc_full + TESTS_MODULE_SUBDIR: grid + +functions gcc_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian_gcc_full + TESTS_MODULE_SUBDIR: functions + tags: + - amm-only + +la gcc_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian_gcc_full + TESTS_MODULE_SUBDIR: la + tags: + - amm-only + +common clang_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian_clang_full + TESTS_MODULE_SUBDIR: common + +grid clang_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian_clang_full + TESTS_MODULE_SUBDIR: grid + +functions clang_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian_clang_full + TESTS_MODULE_SUBDIR: functions + +la clang_full: + extends: .subdir-test + variables: + DOCKER_TAG: debian_clang_full + TESTS_MODULE_SUBDIR: la + diff --git a/.ci/gitlab/config_template.py b/.ci/gitlab/config_template.py new file mode 100755 index 0000000000000000000000000000000000000000..097631df726ab6590a5a154affdb5e0332eb2bfe --- /dev/null +++ b/.ci/gitlab/config_template.py @@ -0,0 +1,99 @@ +#!/usr/bin/env python3 +# kate: indent-width 2; + +tpl = '''# THIS FILE IS AUTOGENERATED -- DO NOT EDIT # +# Edit and Re-run .ci/gitlab/config_tpl.py instead # +stages: + - test + +variables: + GIT_SUBMODULE_STRATEGY: recursive + TRAVIS_BRANCH: ${CI_COMMIT_REF_NAME} + TRAVIS_COMMIT: ${CI_COMMIT_SHA} + MY_MODULE: dune-xt + +.subdir-test: + tags: + - docker-in-docker + - long execution time + stage: test + retry: + max: 2 + when: + - runner_system_failure + - stuck_or_timeout_failure + - api_failure + only: ['branches', 'tags', 'triggers', 'merge_requests'] + except: + - /^staging/.*$/i + retry: + max: 2 + when: + - always + image: docker:stable + variables: + DOCKER_HOST: tcp://docker:2375/ + DOCKER_DRIVER: overlay2 + IMAGE: $CI_REGISTRY/ag-ohlberger/dune-community/dune-xt/ci_testing_${DOCKER_TAG}:${CI_COMMIT_SHORT_SHA} + before_script: + - | + apk --update add openssh-client rsync git file bash python3 curl + pip3 install -U docker jinja2 docopt + + export BASEIMAGE="${MY_MODULE}-testing_${DOCKER_TAG}:${CI_COMMIT_REF_NAME/\//_}" + # get image with fallback to master branch of the super repo + docker pull dunecommunity/${BASEIMAGE} || export BASEIMAGE="${MY_MODULE}-testing_${DOCKER_TAG}:master" ; docker pull dunecommunity/${BASEIMAGE} + export ENV_FILE=${HOME}/env + mkdir ${CI_PROJECT_DIR}/testresults && chmod -R 777 ${CI_PROJECT_DIR}/testresults + DOCKER_RUN="docker run -v ${CI_PROJECT_DIR}/testresults:/home/dune-ci/testresults --env-file ${ENV_FILE} ${IMAGE}" + git submodule update --init --recursive + docker build --build-arg BASE=${BASEIMAGE} -t ${IMAGE} -f .ci/shared/docker/ci_run/Dockerfile . + script: + - | + [[ -f ./.gitsuper ]] && echo "Please remove .gitsuper from the repo" && exit 1 + python3 ./.ci/shared/scripts/make_env_file.py + ${DOCKER_RUN} /home/dune-ci/src/${MY_MODULE}/.ci/shared/scripts/test_cpp.bash + ${DOCKER_RUN} /home/dune-ci/src/${MY_MODULE}/.ci/shared/scripts/test_python.bash + touch $CI_PROJECT_DIR/success + + after_script: + - | + if [ -e $CI_PROJECT_DIR/success ]; then + echo "Not pushing ${IMAGE}" + else + docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY + docker push ${IMAGE} + fi + + artifacts: + reports: + junit: '${CI_PROJECT_DIR}/testresults/*xml' + services: + - docker:dind + environment: + name: unsafe + +{% for image, subdir in matrix %} +{{subdir}} {{ image[image.find('debian')+1+6:] }}: + extends: .subdir-test + variables: + DOCKER_TAG: {{ image }} + TESTS_MODULE_SUBDIR: {{ subdir }} + {%- if subdir in ['functions', 'la'] and 'gcc' in image %} + tags: + - amm-only + {%- endif %} +{% endfor %} + +''' + +import os +import jinja2 +import sys +from itertools import product +tpl = jinja2.Template(tpl) +images = ['debian-unstable_gcc_full', 'debian_gcc_full', 'debian_clang_full'] +subdirs = ['common', 'grid', 'functions', 'la'] +matrix = product(images, subdirs) +with open(os.path.join(os.path.dirname(__file__), 'config.yml'), 'wt') as yml: + yml.write(tpl.render(matrix=matrix)) diff --git a/.ci/shared b/.ci/shared index fb2c0668d7c85faaa868ebecdcbf53f0d3743e20..a08102fed49dae633a61d7f4a0c76370c42037eb 160000 --- a/.ci/shared +++ b/.ci/shared @@ -1 +1 @@ -Subproject commit fb2c0668d7c85faaa868ebecdcbf53f0d3743e20 +Subproject commit a08102fed49dae633a61d7f4a0c76370c42037eb diff --git a/.gitattributes b/.gitattributes index 26cf386870608295beb01d4b9ff7c3441df76fd3..4c855ffae2cd27a0643614bb2acf7ec864027826 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2012, 2015, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ stamp-vc export-ignore diff --git a/.gitignore b/.gitignore index 5d39a0326277ea63571c36b31f977022c054996c..c54e36c3de7a910373f0f3ababd396a20289ddab 100644 --- a/.gitignore +++ b/.gitignore @@ -1,23 +1,17 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2012 - 2013, 2016 - 2017) # René Fritze (2009 - 2012, 2015, 2017 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ doc/doxygen -# License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) -# or GPL-2.0+ (http://opensource.org/licenses/gpl-license) -# with "runtime exception" (http://www.dune-project.org/license.html) -# Authors: -# Felix Schindler (2012 - 2013, 2016 - 2017) -# René Fritze (2009 - 2012, 2015, 2017 - 2018) build* *~ *.orig @@ -33,7 +27,7 @@ Makefile stamp-h1 config.* !config.h.cmake -dune-xt-common.pc +dune-xt.pc *.swp CMakeLists.txt.user demos diff --git a/.mailmap b/.mailmap index 4b6f68dbf5de50650f37d9036098ff823d892199..945dc916f5c7e28b58acd0d9df3f00c0e89b7591 100644 --- a/.mailmap +++ b/.mailmap @@ -1,7 +1,7 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ # Felix Schindler (2014 - 2017) # René Fritze (2011, 2013, 2015 - 2016, 2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ René Fritze <rene.fritze@wwu.de> Rene Milk <rene.milk@wwu.de> diff --git a/.pylicense-cpp.py b/.pylicense-cpp.py index cde2991ae2c2c2d2c5f3d4fd11987eb3eb291ac9..9902da0cc9a17ff9cefce64b320691e52b3a2064 100644 --- a/.pylicense-cpp.py +++ b/.pylicense-cpp.py @@ -1,24 +1,24 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ name = 'This file is part of the dune-xt project:' url = 'https://github.com/dune-community/dune-xt' -copyright_statement = 'Copyright 2009-2018 dune-xt developers and contributors. All rights reserved.' +copyright_statement = 'Copyright 2009-2020 dune-xt developers and contributors. All rights reserved.' license = '''Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) or GPL-2.0+ (http://opensource.org/licenses/gpl-license) with "runtime exception" (http://www.dune-project.org/license.html)''' prefix = '//' include_patterns = ('*.cc', '*.cxx', '*.hh', '*.hxx', '*cmake_config.h.in', '*headercheck.cpp.in', '*config.h.cmake', - '*version.hh.in', '*.pbh') + '*version.hh.in', '*.pbh', '*.tpl') exclude_patterns = ('*mathexpr.*', '*gtest-all.cc', '*.vcsetup*', '*gtest-all.cxx', '*dune/xt/functions/expression/mathexpr.cc', '*dune/xt/functions/expression/mathexpr.hh') diff --git a/.pylicense-md.py b/.pylicense-md.py new file mode 100644 index 0000000000000000000000000000000000000000..f81dddea172ab2bfdacb07464039eed151a6ef0d --- /dev/null +++ b/.pylicense-md.py @@ -0,0 +1,24 @@ +# ~~~ +# This file is part of the dune-xt project: +# https://github.com/dune-community/dune-xt +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +# License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +# or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +# with "runtime exception" (http://www.dune-project.org/license.html) +# Authors: +# René Fritze (2018 - 2019) +# Tobias Leibner (2019 - 2020) +# ~~~ + +name = 'This file is part of the dune-xt project:' +url = 'https://github.com/dune-community/dune-xt' +copyright_statement = 'Copyright 2009-2020 dune-xt developers and contributors. All rights reserved.' +license = '''Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) + or GPL-2.0+ (http://opensource.org/licenses/gpl-license) + with "runtime exception" (http://www.dune-project.org/license.html)''' +prefix = '#' +lead_in = '```' +lead_out = '```' + +include_patterns = ('*.md',) +exclude_patterns = () diff --git a/.pylicense-other.py b/.pylicense-other.py index 28a3e4cef2d3b2be7a4a32e3572a1dcff99c1b99..36df6c60ae397f14c434caa8fca6e84a8b9a579e 100644 --- a/.pylicense-other.py +++ b/.pylicense-other.py @@ -1,18 +1,18 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ name = 'This file is part of the dune-xt project:' url = 'https://github.com/dune-community/dune-xt' -copyright_statement = 'Copyright 2009-2018 dune-xt developers and contributors. All rights reserved.' +copyright_statement = 'Copyright 2009-2020 dune-xt developers and contributors. All rights reserved.' license = '''Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) or GPL-2.0+ (http://opensource.org/licenses/gpl-license) with "runtime exception" (http://www.dune-project.org/license.html)''' @@ -23,5 +23,5 @@ lead_out = '# ~~~' include_patterns = ('*.txt', '*.cmake', '*.py', '*.sh', '*.bash', '*.dgf', '*.msh', '*.gdb', '*.cfg', '*.travis.*', '*.gitignore', '*.mailmap', '*.gitattributes', '*gitignore-*', '*stamp-vc', '*dune.module', '*Doxylocal', '*.clang-format', '*COPYING-CMAKE-SCRIPTS', '*README', '*LICENSE', '*mainpage', - '*switch-build_dir', '*dune-xt.pc.in', '*CMakeLists.txt') + '*switch-build_dir', '*dune-xt.pc.in', '*CMakeLists.txt', '*.cmake.in', '*.py.in*') exclude_patterns = ('*config.h.cmake', '*.vcsetup*', 'FindEigen3.cmake', '*.dgf', '*builder_definitions.cmake') diff --git a/.travis.cfg.in b/.travis.cfg.in index 2dfd82e0798bce2ec359de7f12b73ee5d0e0644c..b6b6f844facda23f961c026556a9a22fc1879ee6 100644 --- a/.travis.cfg.in +++ b/.travis.cfg.in @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2015 - 2016, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ "travis" : { diff --git a/.travis.ctest b/.travis.ctest index 73b5484439d855a507c37434c0d1533d2a31325c..e0899b744deb8af7057b4630d317a2db4c78ac2a 100644 --- a/.travis.ctest +++ b/.travis.ctest @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2015 - 2016, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ string(SUBSTRING "$ENV{TRAVIS_COMMIT}" 0 7 COMMIT_ID) @@ -15,7 +16,7 @@ set(CTEST_SITE "travis") set(CTEST_BUILD_NAME "$ENV{TRAVIS_BUILD_NUMBER}-${COMMIT_ID}-$ENV{TRAVIS_OS_NAME}-$ENV{CXX}") set(CTEST_SOURCE_DIRECTORY "$ENV{TRAVIS_BUILD_DIR}") -set(CTEST_BINARY_DIRECTORY "$ENV{DUNE_BUILD_DIR}/dune-xt-common") +set(CTEST_BINARY_DIRECTORY "$ENV{DUNE_BUILD_DIR}/dune-xt") configure_file(${CTEST_SOURCE_DIRECTORY}/.travis.cfg.in ${CTEST_BINARY_DIRECTORY}/travis.cfg) set(CTEST_NOTES_FILES ${CTEST_BINARY_DIRECTORY}/travis.cfg) diff --git a/.vcsetup b/.vcsetup index 27c3987ea1495410a89910484d8d1f37aad39bd2..fdd97a58e991f5939631e68bb1b0c68e607ab614 160000 --- a/.vcsetup +++ b/.vcsetup @@ -1 +1 @@ -Subproject commit 27c3987ea1495410a89910484d8d1f37aad39bd2 +Subproject commit fdd97a58e991f5939631e68bb1b0c68e607ab614 diff --git a/CMakeLists.txt b/CMakeLists.txt index 0198ee8163c95245fe5562f10a19708af32a5dcc..93d9cb1f68eb373fe455d9b37bfaa658e4bd9b9b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,7 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) @@ -10,7 +10,7 @@ # René Fritze (2010 - 2019) # Sven Kaulmann (2013) # Tim Keil (2018) -# Tobias Leibner (2016, 2018 - 2019) +# Tobias Leibner (2016, 2018 - 2020) # ~~~ project("dune-xt" CXX) @@ -35,11 +35,7 @@ endif() # find dune-common and set the module path find_package(dune-common REQUIRED) -find_package(dune-pybindxi REQUIRED) -list(APPEND CMAKE_MODULE_PATH - ${dune-common_MODULE_PATH} - ${dune-pybindxi_MODULE_PATH} - ${PROJECT_SOURCE_DIR}/cmake/modules) +list(APPEND CMAKE_MODULE_PATH ${dune-common_MODULE_PATH} ${PROJECT_SOURCE_DIR}/cmake/modules) # include the dune macros include(DuneMacros) @@ -47,9 +43,49 @@ include(DuneMacros) # start a dune project with information from dune.module dune_project() -# dune-xt-common cmake includes +# dune-xt cmake includes list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) +dune_enable_all_packages(INCLUDE_DIRS + ${dune-xt-common_SOURCE_DIR}/dune + MODULE_LIBRARIES + dunepybindxiinterface + dunepybindximodule + dunepybindxiembed + dunepybindxi + gtest_dune_xt + dunext) +# The -fsized-deallocation flag is not needed anymore in newer versions of pybind11. TODO: Remove once we update +# pybind11. +if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") + target_compile_options(dunepybindxi INTERFACE -fsized-deallocation) + target_compile_options(dunepybindxiinterface INTERFACE -fsized-deallocation) + target_compile_options(dunepybindximodule INTERFACE -fsized-deallocation) + target_compile_options(dunepybindxiembed INTERFACE -fsized-deallocation) +endif() +# Build an interface library target: +add_library(pybind11::pybind11 ALIAS dunepybindxiinterface) # to match exported target +target_include_directories(dunepybindxiinterface + INTERFACE $<BUILD_INTERFACE:${PYBIND11_INCLUDE_DIR}> + $<BUILD_INTERFACE:${PYTHON_INCLUDE_DIRS}> + $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>) +target_compile_options(dunepybindxiinterface INTERFACE $<BUILD_INTERFACE:${PYBIND11_CPP_STANDARD}>) + +add_library(pybind11::module ALIAS dunepybindximodule) +if(NOT MSVC) + target_compile_options(dunepybindximodule PRIVATE -fvisibility=hidden) +endif() +target_link_libraries(dunepybindximodule INTERFACE pybind11::pybind11) +if(WIN32 OR CYGWIN) + target_link_libraries(dunepybindximodule INTERFACE $<BUILD_INTERFACE:${PYTHON_LIBRARIES}>) +elseif(APPLE) + target_link_libraries(dunepybindximodule INTERFACE "-undefined dynamic_lookup") +endif() + +target_link_libraries(dunepybindxiembed INTERFACE pybind11::pybind11 $<BUILD_INTERFACE:${PYTHON_LIBRARIES}>) +add_library(pybind11::embed ALIAS dunepybindxiembed) +target_link_libraries(dunepybindxi dunepybindxiembed) + # ---------------------------------------------------------------------------------------------------- # General Settings # ---------------------------------------------------------------------------------------------------- @@ -58,11 +94,10 @@ execute_process(COMMAND ${CMAKE_SOURCE_DIR}/getRevision.sh ERROR_VARIABLE shell_error OUTPUT_STRIP_TRAILING_WHITESPACE) -dune_enable_all_packages(INCLUDE_DIRS ${dune-xt-common_SOURCE_DIR}/dune MODULE_LIBRARIES gtest_dune_xt dunext) - include(DunePybindxiInstallPythonPackage) # this symlinks all files in python/ to the binary dir and install into the virtualenv from there thereby making the # compiled extensions directly usable from the venv +make_dependent_modules_sys_included() dune_pybindxi_install_python_package(PATH python) include_dependent_binary_python_dirs() # do not change order here diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79fa18a49178e226bad4216c0886c6dbd8b31dc3..af8bfce5c6920f72fbef712c380b4dbf7a6bead1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,13 @@ ``` # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2017 dune-xt-common developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: -# Felix Schindler (2016 - 2017) -# Rene Milk (2016) +# Felix Schindler (2013 - 2014, 2016 - 2017, 2019) +# René Fritze (2009, 2015, 2016, 2019) ``` # Help @@ -15,7 +15,7 @@ If you are experiencing problems or would like to get help, open up a new [issue](https://github.com/dune-community/dune-xt/issues/new) and tag it accordingly or ask for help on the [mailinglist](https://listserv.uni-muenster.de/mailman/listinfo/dune-xt-dev). -Please note that dune-xt-common is not one of the core DUNE modules. Thus, you will not get +Please note that dune-xt is not one of the core DUNE modules. Thus, you will not get any support from the official channels (such as the DUNE mailinglist, the DUNE bugtracker, etc...). When submitting bugs, please read these @@ -120,7 +120,7 @@ Sort the groups by * stl * other external dependency * dune core modules - * dune-xt-common + * dune-xt * local header within the same (sub)folder For example: diff --git a/CTestConfig.cmake b/CTestConfig.cmake index f4367415fe96db904c3856448f1344f4e02c074a..81880cf8aef13913a7fd32322b3c872953f0aa5d 100644 --- a/CTestConfig.cmake +++ b/CTestConfig.cmake @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2015, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ set(CTEST_PROJECT_NAME "DUNE-Stuff") diff --git a/LICENSE b/LICENSE index 0b777d181e2fb1afbaf7a8d01371003bda8e90b8..4ef3baa5dc897f948b0ccb138dbdf099f71d6a29 100644 --- a/LICENSE +++ b/LICENSE @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2013 - 2014, 2016 - 2017) # René Fritze (2015 - 2016, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ BSD 2-Clause License @@ -36,7 +37,7 @@ GNU GENERAL PUBLIC LICENSE Version 2, June 1991 -Copyright (C) 1989, 1991 Free Software Foundation, Inc. +Copyright (C) 1989, 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies @@ -123,7 +124,7 @@ END OF TERMS AND CONDITIONS Runtime Exception ----------------- -As a special exception, you may use the dune-xt-common library without +As a special exception, you may use the dune-xt library without restriction. Specifically, if other files instantiate templates or use macros or inline functions from one or more of the DUNE source files, or you compile one or more of the DUNE source files and link diff --git a/README.md b/README.md index e20118f23c40d14867eecc41b1aaa8a63ab39f0c..5322fa9d999877995a737fb272d6ebfabd53a1ae 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ ``` # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2017 dune-xt-common developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: -# Felix Schindler (2013 - 2014, 2016 - 2017) -# Rene Milk (2009, 2015) +# Felix Schindler (2013 - 2014, 2016 - 2017, 2019) +# René Fritze (2009, 2015, 2019) ``` [](https://travis-ci.org/dune-community/dune-xt-common) diff --git a/cmake/UseDoxygen.cmake b/cmake/UseDoxygen.cmake index 998981be337692c16026d3e8f8053b4da26c6ee0..5eafd0cb3d9bd4607ed2998c907761364ae9b5ef 100644 --- a/cmake/UseDoxygen.cmake +++ b/cmake/UseDoxygen.cmake @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2014, 2016 - 2017) # René Fritze (2010, 2012, 2015, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ # Redistribution and use in source and binary forms, with or without modification, are permitted provided that the diff --git a/cmake/modules/AddALUGridCompileFlags.cmake b/cmake/modules/AddALUGridCompileFlags.cmake index 004fbb00a7d35b51d5f4367c1fbb114dcc231b42..606e32f1ae478c41ded66c142b4153c97a80de4a 100644 --- a/cmake/modules/AddALUGridCompileFlags.cmake +++ b/cmake/modules/AddALUGridCompileFlags.cmake @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2015 - 2017) # René Fritze (2015, 2018 - 2019) +# Tobias Leibner (2020) # # Module providing a convenience method to add ALUGrid compile flags. # diff --git a/cmake/modules/CMakeLists.txt b/cmake/modules/CMakeLists.txt index 6169ee9f07ff45988473816fdeca5078fafad23c..cb83df50612164e995d6c8e45cc9846bd78a3872 100644 --- a/cmake/modules/CMakeLists.txt +++ b/cmake/modules/CMakeLists.txt @@ -1,19 +1,23 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2014, 2016 - 2017) # René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ install(FILES AddALUGridCompileFlags.cmake DuneTBB.cmake DuneUtils.cmake DuneXtMacros.cmake + DunePybindxiMacros.cmake + DunePybindxiUtils.cmake + FindPythonLibsNew.cmake FindClangFormat.cmake FindClangTidy.cmake FindEigen3.cmake diff --git a/cmake/modules/DunePybindxiHelper.cmake b/cmake/modules/DunePybindxiHelper.cmake new file mode 100644 index 0000000000000000000000000000000000000000..15dc1e50911fe0c05b7d07fcfdd91557300a56b7 --- /dev/null +++ b/cmake/modules/DunePybindxiHelper.cmake @@ -0,0 +1,5 @@ +function(dune_pybindxi_add_helper_lib target_name) + message(WARNING "dune_pybindxi_add_helper_lib is deprecated. Add source to bindings lib directly") + add_library(${target_name} EXCLUDE_FROM_ALL ${ARGN}) + target_include_directories(${target_name} PRIVATE ${PYBIND11_INCLUDE_DIR} PRIVATE ${PYTHON_INCLUDE_DIRS}) +endfunction() diff --git a/cmake/modules/DunePybindxiInstallPythonPackage.cmake b/cmake/modules/DunePybindxiInstallPythonPackage.cmake new file mode 100644 index 0000000000000000000000000000000000000000..c6a3111b096399b45643bd4c6526fe3efe58bf67 --- /dev/null +++ b/cmake/modules/DunePybindxiInstallPythonPackage.cmake @@ -0,0 +1,145 @@ +# ~~~ +# This file is part of the dune-xt-common project: +# https://github.com/dune-community/dune-xt-common +# Copyright 2009-2018 dune-xt-common developers and contributors. All rights reserved. +# License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +# Authors: +# Rene Milk (2018) +# +# ~~~ + +macro(include_dependent_binary_python_dirs) # disable most warnings from dependent modules + foreach(_mod ${ALL_DEPENDENCIES} ${PROJECT_NAME}) + dune_module_path(MODULE ${_mod} RESULT ${_mod}_binary_dir BUILD_DIR) + set(tdir ${${_mod}_binary_dir}) + if(IS_DIRECTORY ${tdir}) + dune_register_package_flags(INCLUDE_DIRS ${tdir}) + endif() + endforeach(_mod DEPENDENCIES) +endmacro(include_dependent_binary_python_dirs) + +# copy of dune_python_install_package from dune-common changes: - package is always installed into the dune-env, even +# if a setup.py.in is found instead of a setup.py - if a setup.py.in is found, the whole directory is symlinked to the +# binary dir +function(dune_pybindxi_install_python_package) + # Parse Arguments + set(OPTION) + set(SINGLE PATH) + set(MULTI ADDITIONAL_PIP_PARAMS) + include(CMakeParseArguments) + cmake_parse_arguments(PYINST "${OPTION}" "${SINGLE}" "${MULTI}" ${ARGN}) + if(PYINST_UNPARSED_ARGUMENTS) + message(WARNING "Unparsed arguments in dune_python_install_package: This often indicates typos!") + endif() + + # Check for the presence of the pip package + dune_python_find_package(PACKAGE pip INTERPRETER ${DUNE_PYTHON_VIRTUALENV_EXECUTABLE}) + if(NOT DUNE_PYTHON_pip_FOUND) + message(FATAL_ERROR "dune_python_install_package: Requested installations, but pip was not found!") + endif() + + set(PYINST_FULLPATH ${CMAKE_CURRENT_SOURCE_DIR}/${PYINST_PATH}) + if(EXISTS ${PYINST_FULLPATH}/setup.py.in) + # symlink files to binary dir + file(GLOB_RECURSE files "${PYINST_FULLPATH}/*") + foreach(fn ${files}) + file(RELATIVE_PATH rel_fn ${CMAKE_CURRENT_SOURCE_DIR} ${fn}) + get_filename_component(directory ${rel_fn} DIRECTORY) + file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/${directory}) + execute_process(COMMAND ${CMAKE_COMMAND} "-E" "create_symlink" "${CMAKE_CURRENT_SOURCE_DIR}/${rel_fn}" + "${CMAKE_CURRENT_BINARY_DIR}/${rel_fn}") + endforeach() + configure_file(${PYINST_PATH}/setup.py.in ${PYINST_PATH}/setup.py) + set(PYINST_FULLPATH ${CMAKE_CURRENT_BINARY_DIR}/${PYINST_PATH}) + set(PYINST_PUREPYTHON TRUE) + elseif(EXISTS ${PYINST_FULLPATH}/setup.py) + set(PYINST_PUREPYTHON TRUE) + else() + message( + FATAL_ERROR "dune_python_install_package: Requested installations, but neither setup.py nor setup.py.in found!") + endif() + + # Find out whether we should install in editable mode + set(INSTALL_EDITABLE 1) + + # Construct the wheel house installation option string + set(WHEEL_OPTION "") + if(IS_DIRECTORY ${DUNE_PYTHON_WHEELHOUSE}) + set(WHEEL_OPTION "--find-links=${DUNE_PYTHON_WHEELHOUSE}") + # + # The following line is a bummer! We cannot have editable packages once we start using global installations! This + # is related to the nightmare that is https://github.com/pypa/pip/issues/3 + # + set(INSTALL_EDITABLE FALSE) + endif() + + # Construct the editable option string + set(EDIT_OPTION "") + if(INSTALL_EDITABLE) + set(EDIT_OPTION "-e") + endif() + + # Construct the installation location option string + set(INSTALL_OPTION "") + if("${DUNE_PYTHON_INSTALL_LOCATION}" STREQUAL "user") + set(INSTALL_OPTION "--user") + endif() + + set(INSTALL_CMDLINE + -m + pip + install + "${INSTALL_OPTION}" + "${WHEEL_OPTION}" + "${EDIT_OPTION}" + ${PYINST_ADDITIONAL_PIP_PARAMS} + "${PYINST_FULLPATH}") + + # + # If requested, install into the configure-time Dune virtualenv + # + + if(PYINST_PUREPYTHON AND DUNE_PYTHON_VIRTUALENV_SETUP) + message("-- Installing python package at ${CMAKE_CURRENT_SOURCE_DIR}/${PYINST_PATH} into the virtualenv...") + dune_execute_process(COMMAND + "${DUNE_PYTHON_VIRTUALENV_EXECUTABLE}" + "${INSTALL_CMDLINE}" + ERROR_MESSAGE + "dune_python_install_package: Error installing into virtualenv!") + endif() + + # + # Now define rules for `make install_python`. + # + + # Leave this function if no installation rules are required + dune_module_path(MODULE dune-common RESULT scriptdir SCRIPT_DIR) + + # Determine a target name for installing this package + string(REPLACE "/" + "_" + targetname + "install_python_${CMAKE_CURRENT_SOURCE_DIR}_${PYINST_PATH}") + + # Add a custom target that globally installs this package if requested + add_custom_target(${targetname} + COMMAND ${DUNE_PYTHON_VIRTUALENV_EXECUTABLE} ${INSTALL_CMDLINE} + COMMENT "Installing the python package at ${PYINST_FULLPATH}") + + add_dependencies(install_python ${targetname}) + + # Define rules for `make install` that install a wheel into a central wheelhouse + # + # NB: This is necessary, to allow mixing installed and non-installed modules with python packages. The wheelhouse + # will allow to install any missing python packages into a virtual environment. + # + + # Construct the wheel installation commandline + set(WHEEL_COMMAND ${PYTHON_EXECUTABLE} -m pip wheel -w ${DUNE_PYTHON_WHEELHOUSE} ${PYINST_FULLPATH}) + + # Add the installation rule + install(CODE "message(\"Installing wheel for python package at ${PYINST_FULLPATH}...\") + dune_execute_process(COMMAND ${WHEEL_COMMAND} + ERROR_MESSAGE \"Error installing wheel for python package at ${PYINST_FULLPATH}\" + )") +endfunction() diff --git a/cmake/modules/DunePybindxiMacros.cmake b/cmake/modules/DunePybindxiMacros.cmake new file mode 100644 index 0000000000000000000000000000000000000000..f556ce8873c89bf3130538ec7a45689a7ee19233 --- /dev/null +++ b/cmake/modules/DunePybindxiMacros.cmake @@ -0,0 +1,43 @@ +# This file is part of the dune-pybindx1 project: https://github.com/dune-community/dune-pybindx1 The copyright lies +# with the authors of this file (see below). License: BSD 2-Clause License +# (http://opensource.org/licenses/BSD-2-Clause) Authors: Felix Schindler (2016) +# +# The code below is a renamed copy of parts of ../../pybind11/CMakeLists.txt, see ../../pybind11/LICENSE for license +# information. + +# dune-python's way of forcing a version +set(CMAKE_POSITION_INDEPENDENT_CODE ON) + +# Add a CMake parameter for choosing a desired Python version +set(DUNE_PYBINDXI_PYTHON_VERSION "" CACHE STRING "Python version to use for dune-pybindxi") + +set(PYTHON_EXECUTABLE ${DUNE_PYTHON_VIRTUALENV_INTERPRETER}) +unset(PYTHON_LIBRARY) +unset(PYTHON_LIBRARY CACHE) +find_package(PythonLibsNew ${PYBIND11_PYTHON_VERSION} REQUIRED) + +set(PYTHON_INCLUDE_DIRS ${PYTHON_INCLUDE_DIRS} CACHE INTERNAL "") +set(PYTHON_LIBRARIES ${PYTHON_LIBRARIES} CACHE INTERNAL "") +set(PYTHON_MODULE_PREFIX ${PYTHON_MODULE_PREFIX} CACHE INTERNAL "") +set(PYTHON_MODULE_EXTENSION ${PYTHON_MODULE_EXTENSION} CACHE INTERNAL "") + +include(CheckCXXCompilerFlag) +if(NOT MSVC AND NOT DUNE_PYBINDXI_CPP_STANDARD) + check_cxx_compiler_flag("-std=c++14" HAS_CPP14_FLAG) + check_cxx_compiler_flag("-std=c++11" HAS_CPP11_FLAG) + + if(HAS_CPP14_FLAG) + set(DUNE_PYBINDXI_CPP_STANDARD -std=c++14) + elseif(HAS_CPP11_FLAG) + set(DUNE_PYBINDXI_CPP_STANDARD -std=c++11) + else() + message(FATAL_ERROR "Unsupported compiler -- pybind11 requires C++11 support!") + endif() + + set(DUNE_PYBINDXI_CPP_STANDARD ${DUNE_PYBINDXI_CPP_STANDARD} + CACHE STRING "C++ standard flag, e.g. -std=c++11 or -std=c++14. Defaults to C++11." + FORCE) +endif() + +include(DunePybindxiUtils) +include(DunePybindxiHelper) diff --git a/cmake/modules/DunePybindxiUtils.cmake b/cmake/modules/DunePybindxiUtils.cmake new file mode 100644 index 0000000000000000000000000000000000000000..717890a2676ed97b83cb1f3d2d2d09fbc1ce175e --- /dev/null +++ b/cmake/modules/DunePybindxiUtils.cmake @@ -0,0 +1,216 @@ +# This file is part of the dune-pybindx1 project: https://github.com/dune-community/dune-pybindx1 The copyright lies +# with the authors of this file (see below). License: BSD 2-Clause License +# (http://opensource.org/licenses/BSD-2-Clause) Authors: Felix Schindler (2016) +# +# The code below is a renamed copy of parts of ../../pybind11/CMakeLists.txt, see ../../pybind11/LICENSE for license +# information. + +# Checks whether the given CXX/linker flags can compile and link a cxx file. cxxflags and linkerflags are lists of +# flags to use. The result variable is a unique variable name for each set of flags: the compilation result will be +# cached base on the result variable. If the flags work, sets them in cxxflags_out/linkerflags_out internal cache +# variables (in addition to ${result}). +function(_dune_pybind11_return_if_cxx_and_linker_flags_work result cxxflags linkerflags cxxflags_out linkerflags_out) + set(CMAKE_REQUIRED_LIBRARIES ${linkerflags}) + check_cxx_compiler_flag("${cxxflags}" ${result}) + if(${result}) + set(${cxxflags_out} "${cxxflags}" CACHE INTERNAL "" FORCE) + set(${linkerflags_out} "${linkerflags}" CACHE INTERNAL "" FORCE) + endif() +endfunction() + +# Internal: find the appropriate link time optimization flags for this compiler +function(_dune_pybind11_add_lto_flags target_name prefer_thin_lto) + if(NOT DEFINED PYBIND11_LTO_CXX_FLAGS) + set(PYBIND11_LTO_CXX_FLAGS "" CACHE INTERNAL "") + set(PYBIND11_LTO_LINKER_FLAGS "" CACHE INTERNAL "") + + if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang") + set(cxx_append "") + set(linker_append "") + if(CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND NOT APPLE) + # Clang Gold plugin does not support -Os; append -O3 to MinSizeRel builds to override it + set(linker_append ";$<$<CONFIG:MinSizeRel>:-O3>") + elseif(CMAKE_CXX_COMPILER_ID MATCHES "GNU") + set(cxx_append ";-fno-fat-lto-objects") + endif() + + if(CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND prefer_thin_lto) + _dune_pybind11_return_if_cxx_and_linker_flags_work(HAS_FLTO_THIN + "-flto=thin${cxx_append}" + "-flto=thin${linker_append}" + PYBIND11_LTO_CXX_FLAGS + PYBIND11_LTO_LINKER_FLAGS) + endif() + + if(NOT HAS_FLTO_THIN) + _dune_pybind11_return_if_cxx_and_linker_flags_work(HAS_FLTO + "-flto${cxx_append}" + "-flto${linker_append}" + PYBIND11_LTO_CXX_FLAGS + PYBIND11_LTO_LINKER_FLAGS) + endif() + elseif(CMAKE_CXX_COMPILER_ID MATCHES "Intel") + # Intel equivalent to LTO is called IPO + _dune_pybind11_return_if_cxx_and_linker_flags_work(HAS_INTEL_IPO + "-ipo" + "-ipo" + PYBIND11_LTO_CXX_FLAGS + PYBIND11_LTO_LINKER_FLAGS) + elseif(MSVC) + # cmake only interprets libraries as linker flags when they start with a - (otherwise it converts /LTCG to \LTCG + # as if it was a Windows path). Luckily MSVC supports passing flags with - instead of /, even if it is a bit + # non-standard: + _dune_pybind11_return_if_cxx_and_linker_flags_work(HAS_MSVC_GL_LTCG + "/GL" + "-LTCG" + PYBIND11_LTO_CXX_FLAGS + PYBIND11_LTO_LINKER_FLAGS) + endif() + + if(PYBIND11_LTO_CXX_FLAGS) + message(STATUS "LTO enabled") + else() + message(STATUS "LTO disabled (not supported by the compiler and/or linker)") + endif() + endif() + + # Enable LTO flags if found, except for Debug builds + if(PYBIND11_LTO_CXX_FLAGS) + target_compile_options(${target_name} PRIVATE "$<$<NOT:$<CONFIG:Debug>>:${PYBIND11_LTO_CXX_FLAGS}>") + endif() + if(PYBIND11_LTO_LINKER_FLAGS) + target_link_libraries(${target_name} "$<$<NOT:$<CONFIG:Debug>>:${PYBIND11_LTO_LINKER_FLAGS}>") + endif() +endfunction() + +# Build a Python extension module: dune_pybind11_add_module(<name> [MODULE | SHARED] [EXCLUDE_FROM_ALL] [NO_EXTRAS] +# [THIN_LTO] source1 [source2 ...]) +# +function(dune_pybindxi_add_module target_name) + set(options MODULE SHARED EXCLUDE_FROM_ALL NO_EXTRAS THIN_LTO) + set(oneValueArgs LIBNAME) + cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "" ${ARGN}) + + if(ARG_MODULE AND ARG_SHARED) + message(FATAL_ERROR "Can't be both MODULE and SHARED") + elseif(ARG_SHARED) + set(lib_type SHARED) + else() + set(lib_type MODULE) + endif() + + if(NOT ARG_LIBNAME) + set(lib_name bindings) + else() + set(lib_name ${ARG_LIBNAME}) + endif() + + if(ARG_EXCLUDE_FROM_ALL) + set(exclude_from_all EXCLUDE_FROM_ALL) + endif() + + add_library(${target_name} ${lib_type} ${exclude_from_all} ${ARG_UNPARSED_ARGUMENTS}) + dune_target_link_libraries(${target_name} "${DUNE_LIB_ADD_LIBS}") + + if(ARG_SYSTEM) + set(inc_isystem SYSTEM) + endif() + + target_include_directories(${target_name} ${inc_isystem} + PRIVATE ${PYBIND11_INCLUDE_DIR} # from project CMakeLists.txt + PRIVATE ${pybind11_INCLUDE_DIR} # from pybind11Config + PRIVATE ${PYTHON_INCLUDE_DIRS}) + + # Python debug libraries expose slightly different objects https://docs.python.org/3.6/c-api/intro.html#debugging- + # builds https://stackoverflow.com/questions/39161202/how-to-work-around-missing-pymodule-create2-in-amd64-win- + # python35-d-lib + if(PYTHON_IS_DEBUG) + target_compile_definitions(${target_name} PRIVATE Py_DEBUG) + endif() + + # The prefix and extension are provided by FindPythonLibsNew.cmake + set_target_properties(${target_name} PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}") + set_target_properties(${target_name} PROPERTIES SUFFIX "${PYTHON_MODULE_EXTENSION}") + + # -fvisibility=hidden is required to allow multiple modules compiled against different pybind versions to work + # properly, and for some features (e.g. py::module_local). We force it on everything inside the `pybind11` + # namespace; also turning it on for a pybind module compilation here avoids potential warnings or issues from having + # mixed hidden/non-hidden types. + set_target_properties(${target_name} PROPERTIES CXX_VISIBILITY_PRESET "hidden") + set_target_properties(${target_name} PROPERTIES VISIBILITY_INLINES_HIDDEN TRUE) + + if(WIN32 OR CYGWIN) + # Link against the Python shared library on Windows + target_link_libraries(${target_name} ${PYTHON_LIBRARIES}) + elseif(APPLE) + # It's quite common to have multiple copies of the same Python version installed on one's system. E.g.: one copy + # from the OS and another copy that's statically linked into an application like Blender or Maya. If we link our + # plugin library against the OS Python here and import it into Blender or Maya later on, this will cause segfaults + # when multiple conflicting Python instances are active at the same time (even when they are of the same version). + + # Windows is not affected by this issue since it handles DLL imports differently. The solution for Linux and Mac OS + # is simple: we just don't link against the Python library. The resulting shared library will have missing symbols, + # but that's perfectly fine -- they will be resolved at import time. + + target_link_libraries(${target_name} "-undefined dynamic_lookup") + + if(ARG_SHARED) + # Suppress CMake >= 3.0 warning for shared libraries + set_target_properties(${target_name} PROPERTIES MACOSX_RPATH ON) + endif() + endif() + + # Make sure C++11/14 are enabled + target_compile_options(${target_name} PUBLIC ${PYBIND11_CPP_STANDARD} -g) + add_dune_all_flags(${target_name}) + target_include_directories(${target_name} PUBLIC ${MPI4PY_INCLUDE_DIR}) + + if(TARGET ${lib_name}) + add_dependencies(${lib_name} ${target_name}) + add_dependencies(${lib_name}_no_ext ${target_name}) + else() + if(DUNE_XT_WITH_PYTHON_BINDINGS) + add_custom_target(${lib_name} ALL DEPENDS ${target_name}) + add_custom_target(${lib_name}_no_ext ALL DEPENDS ${target_name}) + else() + add_custom_target(${lib_name} DEPENDS ${target_name}) + add_custom_target(${lib_name}_no_ext DEPENDS ${target_name}) + endif() + endif() + + if(ARG_NO_EXTRAS) + return() + endif() + + if(CMAKE_COMPILER_IS_GNUCC AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 8) + message(WARNING "not enabling LTO although it was requested due to buggy gcc version") + else() + _dune_pybind11_add_lto_flags(${target_name} ${ARG_THIN_LTO}) + endif() + + if(MSVC) + # /MP enables multithreaded builds (relevant when there are many files), /bigobj is needed for bigger binding + # projects due to the limit to 64k addressable sections + target_compile_options(${target_name} PRIVATE /MP /bigobj) + endif() + +endfunction() + +macro(dxt_add_make_dependent_bindings) + add_custom_target(dependent_bindings) + if(TARGET bindings AND NOT DXT_NO_AUTO_BINDINGS_DEPENDS) + add_dependencies(bindings dependent_bindings) + endif() + foreach(_mod ${ARGN}) + dune_module_path(MODULE ${_mod} RESULT ${_mod}_binary_dir BUILD_DIR) + set(tdir ${${_mod}_binary_dir}) + if(IS_DIRECTORY ${tdir}) + add_custom_target(${_mod}_bindings + COMMAND ${CMAKE_COMMAND} + --build ${tdir} + --target bindings_no_ext + -- -j1) + add_dependencies(dependent_bindings ${_mod}_bindings) + endif() + endforeach() +endmacro() diff --git a/cmake/modules/DuneTBB.cmake b/cmake/modules/DuneTBB.cmake index 3337b30d9e1ba038879de3e4dd923445f8fe79ce..4091389ac041d1b0391f51053ac818c683ac0d62 100644 --- a/cmake/modules/DuneTBB.cmake +++ b/cmake/modules/DuneTBB.cmake @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2014 - 2015, 2017 - 2019) +# Tobias Leibner (2020) # # Searches for Intel's Thread Building Blocks library # diff --git a/cmake/modules/DuneUtils.cmake b/cmake/modules/DuneUtils.cmake index 3b91873698bfffcab9bd680b30eefadb6b56ec00..993891b8fdcf3124aa2cc8f9c88b67f740fe1559 100644 --- a/cmake/modules/DuneUtils.cmake +++ b/cmake/modules/DuneUtils.cmake @@ -1,7 +1,7 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ # Felix Schindler (2012 - 2019) # René Fritze (2010 - 2019) # Sven Kaulmann (2013) -# Tobias Leibner (2015 - 2019) +# Tobias Leibner (2015 - 2020) # ~~~ include(CheckCXXSourceCompiles) @@ -26,9 +26,9 @@ function(TO_LIST_SPACES _LIST_NAME OUTPUT_VAR) endfunction() if(DEFINED dune-xt_DIR) - set(dune-xt-common-path ${dune-xt_DIR}) + set(dune-xt-path ${dune-xt_DIR}) else(DEFINED dune-xt_DIR) - set(dune-xt-common-path ${dune-xt_SOURCE_DIR}) + set(dune-xt-path ${dune-xt_SOURCE_DIR}) endif(DEFINED dune-xt_DIR) if(DEFINED dune-xt_MODULE_PATH) # dependent modules set(dune-xt-module-path ${dune-xt_MODULE_PATH}) diff --git a/cmake/modules/DuneXTTesting.cmake b/cmake/modules/DuneXTTesting.cmake index 5c0ba0c5182cb5e9f7bc6a7ba636de35a6ec339c..c7af9d21a8895a60a71ba782af52e8e8428f4d14 100644 --- a/cmake/modules/DuneXTTesting.cmake +++ b/cmake/modules/DuneXTTesting.cmake @@ -1,7 +1,7 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ # Felix Schindler (2012 - 2017, 2019) # René Fritze (2010 - 2019) # Sven Kaulmann (2013) -# Tobias Leibner (2015 - 2019) +# Tobias Leibner (2015 - 2020) # ~~~ macro(dxt_headercheck_target_name arg) @@ -54,7 +54,6 @@ macro(get_headercheck_targets subdir) dxt_headercheck_target_name(${targname}) list(APPEND ${subdir}_dxt_headercheck_targets "${targname}") add_dependencies(${subdir}_headercheck ${targname}) - message(STATUS "${subdir}_headercheck FOOBAR ${subdir}_headercheck || ${targname}") endforeach(header ${headerlist}) endif(ENABLE_HEADERCHECK) endmacro(get_headercheck_targets) diff --git a/cmake/modules/DuneXtMacros.cmake b/cmake/modules/DuneXtMacros.cmake index 6de3f24646e7fd8260f88c6414066aac35602551..3399d2aa8fdb57f907fd79294a30bdc740edaf24 100644 --- a/cmake/modules/DuneXtMacros.cmake +++ b/cmake/modules/DuneXtMacros.cmake @@ -1,7 +1,7 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ # Felix Schindler (2013 - 2014, 2016 - 2017) # René Fritze (2013 - 2016, 2018 - 2019) # Sven Kaulmann (2014) -# Tobias Leibner (2016, 2018 - 2019) +# Tobias Leibner (2016, 2018 - 2020) # ~~~ # enables "IN_LIST operator @@ -88,13 +88,21 @@ include(DuneTBB) if(HAVE_MPI) include(FindMPI4PY) + if(MPI4PY_FOUND) + + else() + execute_process(COMMAND ${CMAKE_BINARY_DIR}/run-in-dune-env pip install mpi4py + ERROR_VARIABLE shell_error + OUTPUT_STRIP_TRAILING_WHITESPACE) + myfind_mpi4py() + endif() if(MPI4PY_FOUND) # this only works in dependent modules dune_register_package_flags(INCLUDE_DIRS "${MPI4PY_INCLUDE_DIR}") - # this only works in dune-xt-common itself - include_directories("${MPI4PY_INCLUDE_DIR}") + # this only works in dune-xt itself + include_directories("${MPI4PY_INCLUDE_DIR}" ${PYTHON_INCLUDE_DIRS}) else() - message(FATAL_ERROR "MPI enabled builds need mpi4py too") + message(FATAL_ERROR kaput) endif() endif() # end library checks ##################################################################### @@ -113,3 +121,4 @@ set(DXT_TEST_PROCS 1 CACHE STRING "run N tests in parallel") set(DUNE_GRID_EXPERIMENTAL_GRID_EXTENSIONS TRUE) +include(DunePybindxiMacros) diff --git a/cmake/modules/FindCBLAS.cmake b/cmake/modules/FindCBLAS.cmake index e43326b0cd330eb1c54707b2a890aa18b429f191..3c5af662ca6dfc37495e431586733e936a119f81 100644 --- a/cmake/modules/FindCBLAS.cmake +++ b/cmake/modules/FindCBLAS.cmake @@ -1,19 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018) -# -# dune-xt-common developers and contributors. All rights reserved. License: Dual licensed as BSD 2-Clause License -# (http://opensource.org/licenses/BSD-2-Clause) Authors: Felix Schindler (2017) Rene Milk (2018) Tobias Leibner -# (2017) -# -# project.org/license.html) +# Tobias Leibner (2018, 2020) # ~~~ include(Hints) diff --git a/cmake/modules/FindClangFormat.cmake b/cmake/modules/FindClangFormat.cmake index 12ab0018dd8db6aafdff53118864f14903c6e897..033f2e28a60b23e7c3cf47743b5946d01d109599 100644 --- a/cmake/modules/FindClangFormat.cmake +++ b/cmake/modules/FindClangFormat.cmake @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2016 - 2019) -# Tobias Leibner (2017 - 2018) +# Tobias Leibner (2017 - 2018, 2020) # # Use this module by invoking find_package with the form:: # diff --git a/cmake/modules/FindClangTidy.cmake b/cmake/modules/FindClangTidy.cmake index 542f943e3c43546dffe2bd7984bde9f5e9553ffa..34988560f110617e09506e66bc0a31885b8de432 100644 --- a/cmake/modules/FindClangTidy.cmake +++ b/cmake/modules/FindClangTidy.cmake @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2016, 2018 - 2019) +# Tobias Leibner (2020) # # Use this module by invoking find_package with the form:: # diff --git a/cmake/modules/FindClp.cmake b/cmake/modules/FindClp.cmake index 927c7fff96313a31f2e3f4593afb0091bcf91f8f..14013d910825126d399ad703db9977a4872fa78e 100644 --- a/cmake/modules/FindClp.cmake +++ b/cmake/modules/FindClp.cmake @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018) +# Tobias Leibner (2018, 2020) # ~~~ include(Hints) diff --git a/cmake/modules/FindEigen3.cmake b/cmake/modules/FindEigen3.cmake index 26ed02bcb7dd3ee70cf5d61c398b20f232de8fae..9c29380a0268a7a6ebefd0e2b8af3a40757e31f8 100644 --- a/cmake/modules/FindEigen3.cmake +++ b/cmake/modules/FindEigen3.cmake @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2014, 2016 - 2017) # René Fritze (2014 - 2015, 2018 - 2019) +# Tobias Leibner (2019 - 2020) # # Redistribution and use is allowed according to the terms of the 2-clause BSD license. # ~~~ diff --git a/cmake/modules/FindFASP.cmake b/cmake/modules/FindFASP.cmake index 3850a98785a16752e7e5e65d7f38bf7f09fd0fc8..53be59111b3a724eb06b702ca8bee40014622db5 100644 --- a/cmake/modules/FindFASP.cmake +++ b/cmake/modules/FindFASP.cmake @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2014, 2016 - 2017) # René Fritze (2013, 2015, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ message("-- checking for 'fasp' library") diff --git a/cmake/modules/FindLAPACKE.cmake b/cmake/modules/FindLAPACKE.cmake index f72fa955f87a6d3d39332a5f927253b91278a1e3..06de3895cf157b4e569653bbbf7077568040b8df 100644 --- a/cmake/modules/FindLAPACKE.cmake +++ b/cmake/modules/FindLAPACKE.cmake @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2018 - 2019) -# Tobias Leibner (2017 - 2018) +# Tobias Leibner (2017 - 2018, 2020) # ~~~ include(Hints) diff --git a/cmake/modules/FindLIKWID.cmake b/cmake/modules/FindLIKWID.cmake index 262cdf1793bb5eb4ab298f1e313cda70839efebc..3461f9ccd153c51ed608519accbbeebf4713092c 100644 --- a/cmake/modules/FindLIKWID.cmake +++ b/cmake/modules/FindLIKWID.cmake @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2013 - 2014, 2016 - 2017) # René Fritze (2013, 2015, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ find_path(LIKWID_INCLUDE_DIR NAMES likwid.h PATHS ${LIKWID_ROOT} PATH_SUFFIXES include) diff --git a/cmake/modules/FindMKL.cmake b/cmake/modules/FindMKL.cmake index f276088fdebb967d28e5de131318eed189d6629d..1fb68b3c2902e035f5b85081a3ccabbead1044a2 100644 --- a/cmake/modules/FindMKL.cmake +++ b/cmake/modules/FindMKL.cmake @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2017 - 2018) +# Tobias Leibner (2017 - 2020) # ~~~ include(Hints) diff --git a/cmake/modules/FindMPI4PY.cmake b/cmake/modules/FindMPI4PY.cmake index 95beb66a8c5a319531bcafb392a0e13a90548dd5..80d95bbbd8acdb4a3c491eebe0c9deea4513d400 100644 --- a/cmake/modules/FindMPI4PY.cmake +++ b/cmake/modules/FindMPI4PY.cmake @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # # * FindMPI4PY Find mpi4py includes and library This module defines: MPI4PY_INCLUDE_DIR, where to find mpi4py.h, etc. # MPI4PY_FOUND @@ -15,35 +15,38 @@ # https://compacc.fnal.gov/projects/repositories/entry/synergia2/CMake/FindMPI4PY.cmake?rev=c147eafb60728606af4fe7b1b16 # 1a660df142e9a - -if(NOT MPI4PY_INCLUDE_DIR) - execute_process(COMMAND "${DUNE_PYTHON_VIRTUALENV_EXECUTABLE}" "-c" "import mpi4py; print(mpi4py.get_include())" - OUTPUT_VARIABLE MPI4PY_INCLUDE_DIR - RESULT_VARIABLE MPI4PY_COMMAND_RESULT - OUTPUT_STRIP_TRAILING_WHITESPACE) - if(MPI4PY_COMMAND_RESULT) - execute_process(COMMAND "${PYTHON_EXECUTABLE}" "-c" "import mpi4py; print(mpi4py.get_include())" +macro(myfind_mpi4py) + if(NOT MPI4PY_INCLUDE_DIR) + execute_process(COMMAND "${DUNE_PYTHON_VIRTUALENV_EXECUTABLE}" "-c" "import mpi4py; print(mpi4py.get_include())" OUTPUT_VARIABLE MPI4PY_INCLUDE_DIR RESULT_VARIABLE MPI4PY_COMMAND_RESULT OUTPUT_STRIP_TRAILING_WHITESPACE) - endif() - if(MPI4PY_COMMAND_RESULT) - message("jfa: mpi4py not found") - set(MPI4PY_FOUND FALSE) - else(MPI4PY_COMMAND_RESULT) - if(MPI4PY_INCLUDE_DIR MATCHES "Traceback") - message("jfa: mpi4py matches traceback") - # Did not successfully include MPI4PY + if(MPI4PY_COMMAND_RESULT) + execute_process(COMMAND "${PYTHON_EXECUTABLE}" "-c" "import mpi4py; print(mpi4py.get_include())" + OUTPUT_VARIABLE MPI4PY_INCLUDE_DIR + RESULT_VARIABLE MPI4PY_COMMAND_RESULT + OUTPUT_STRIP_TRAILING_WHITESPACE) + endif() + if(MPI4PY_COMMAND_RESULT) + message("jfa: mpi4py not found") set(MPI4PY_FOUND FALSE) - else(MPI4PY_INCLUDE_DIR MATCHES "Traceback") - # successful - set(MPI4PY_FOUND TRUE) - set(MPI4PY_INCLUDE_DIR ${MPI4PY_INCLUDE_DIR} CACHE STRING "mpi4py include path") - endif(MPI4PY_INCLUDE_DIR MATCHES "Traceback") - endif(MPI4PY_COMMAND_RESULT) -else(NOT MPI4PY_INCLUDE_DIR) - set(MPI4PY_FOUND TRUE) -endif(NOT MPI4PY_INCLUDE_DIR) + else(MPI4PY_COMMAND_RESULT) + if(MPI4PY_INCLUDE_DIR MATCHES "Traceback") + message("jfa: mpi4py matches traceback") + # Did not successfully include MPI4PY + set(MPI4PY_FOUND FALSE) + else(MPI4PY_INCLUDE_DIR MATCHES "Traceback") + # successful + set(MPI4PY_FOUND TRUE) + set(MPI4PY_INCLUDE_DIR ${MPI4PY_INCLUDE_DIR} CACHE STRING "mpi4py include path") + endif(MPI4PY_INCLUDE_DIR MATCHES "Traceback") + endif(MPI4PY_COMMAND_RESULT) + else(NOT MPI4PY_INCLUDE_DIR) + set(MPI4PY_FOUND TRUE) + endif(NOT MPI4PY_INCLUDE_DIR) + + include(FindPackageHandleStandardArgs) + find_package_handle_standard_args(MPI4PY DEFAULT_MSG MPI4PY_INCLUDE_DIR) +endmacro() -include(FindPackageHandleStandardArgs) -find_package_handle_standard_args(MPI4PY DEFAULT_MSG MPI4PY_INCLUDE_DIR) +myfind_mpi4py() diff --git a/cmake/modules/FindPythonLibsNew.cmake b/cmake/modules/FindPythonLibsNew.cmake new file mode 100644 index 0000000000000000000000000000000000000000..bb542b7e26c99f604aa7d0e5a3e51aff67b78026 --- /dev/null +++ b/cmake/modules/FindPythonLibsNew.cmake @@ -0,0 +1,194 @@ +# * Find python libraries This module finds the libraries corresponding to the Python interpreter FindPythonInterp +# provides. This code sets the following variables: +# +# PYTHONLIBS_FOUND - have the Python libs been found PYTHON_PREFIX - path to the Python +# installation PYTHON_LIBRARIES - path to the python library PYTHON_INCLUDE_DIRS - path to where +# Python.h is found PYTHON_MODULE_EXTENSION - lib extension, e.g. '.so' or '.pyd' PYTHON_MODULE_PREFIX - lib +# name prefix: usually an empty string PYTHON_SITE_PACKAGES - path to installation site-packages PYTHON_IS_DEBUG +# - whether the Python interpreter is a debug build +# +# Thanks to talljimbo for the patch adding the 'LDVERSION' config variable usage. + +# ============================================================================= +# Copyright 2001-2009 Kitware, Inc. Copyright 2012 Continuum Analytics, Inc. +# +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the +# following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions and the following +# disclaimer. +# +# * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following +# disclaimer in the documentation and/or other materials provided with the distribution. +# +# * Neither the names of Kitware, Inc., the Insight Software Consortium, nor the names of their contributors may be +# used to endorse or promote products derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, +# INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ============================================================================= + +# Checking for the extension makes sure that `LibsNew` was found and not just `Libs`. +if(PYTHONLIBS_FOUND AND PYTHON_MODULE_EXTENSION) + return() +endif() + +# Use the Python interpreter to find the libs. +if(PythonLibsNew_FIND_REQUIRED) + find_package(PythonInterp ${PythonLibsNew_FIND_VERSION} REQUIRED) +else() + find_package(PythonInterp ${PythonLibsNew_FIND_VERSION}) +endif() + +if(NOT PYTHONINTERP_FOUND) + set(PYTHONLIBS_FOUND FALSE) + set(PythonLibsNew_FOUND FALSE) + return() +endif() + +# According to http://stackoverflow.com/questions/646518/python-how-to-detect-debug-interpreter testing whether sys has +# the gettotalrefcount function is a reliable, cross-platform way to detect a CPython debug interpreter. +# +# The library suffix is from the config var LDVERSION sometimes, otherwise VERSION. VERSION will typically be like +# "2.7" on unix, and "27" on windows. +execute_process(COMMAND "${PYTHON_EXECUTABLE}" "-c" "from distutils import sysconfig as s;import sys;import struct; +print('.'.join(str(v) for v in sys.version_info)); +print(sys.prefix); +print(s.get_python_inc(plat_specific=True)); +print(s.get_python_lib(plat_specific=True)); +print(s.get_config_var('SO')); +print(hasattr(sys, 'gettotalrefcount')+0); +print(struct.calcsize('@P')); +print(s.get_config_var('LDVERSION') or s.get_config_var('VERSION')); +print(s.get_config_var('LIBDIR') or ''); +print(s.get_config_var('MULTIARCH') or ''); +" RESULT_VARIABLE _PYTHON_SUCCESS OUTPUT_VARIABLE _PYTHON_VALUES ERROR_VARIABLE _PYTHON_ERROR_VALUE) + +if(NOT _PYTHON_SUCCESS MATCHES 0) + if(PythonLibsNew_FIND_REQUIRED) + message(FATAL_ERROR "Python config failure:\n${_PYTHON_ERROR_VALUE}") + endif() + set(PYTHONLIBS_FOUND FALSE) + set(PythonLibsNew_FOUND FALSE) + return() +endif() + +# Convert the process output into a list +if(WIN32) + string(REGEX + REPLACE "\\\\" + "/" + _PYTHON_VALUES + ${_PYTHON_VALUES}) +endif() +string(REGEX + REPLACE ";" + "\\\\;" + _PYTHON_VALUES + ${_PYTHON_VALUES}) +string(REGEX + REPLACE "\n" + ";" + _PYTHON_VALUES + ${_PYTHON_VALUES}) +list(GET _PYTHON_VALUES 0 _PYTHON_VERSION_LIST) +list(GET _PYTHON_VALUES 1 PYTHON_PREFIX) +list(GET _PYTHON_VALUES 2 PYTHON_INCLUDE_DIR) +list(GET _PYTHON_VALUES 3 PYTHON_SITE_PACKAGES) +list(GET _PYTHON_VALUES 4 PYTHON_MODULE_EXTENSION) +list(GET _PYTHON_VALUES 5 PYTHON_IS_DEBUG) +list(GET _PYTHON_VALUES 6 PYTHON_SIZEOF_VOID_P) +list(GET _PYTHON_VALUES 7 PYTHON_LIBRARY_SUFFIX) +list(GET _PYTHON_VALUES 8 PYTHON_LIBDIR) +list(GET _PYTHON_VALUES 9 PYTHON_MULTIARCH) + +# Make sure the Python has the same pointer-size as the chosen compiler Skip if CMAKE_SIZEOF_VOID_P is not defined +if(CMAKE_SIZEOF_VOID_P AND (NOT "${PYTHON_SIZEOF_VOID_P}" STREQUAL "${CMAKE_SIZEOF_VOID_P}")) + if(PythonLibsNew_FIND_REQUIRED) + math(EXPR _PYTHON_BITS "${PYTHON_SIZEOF_VOID_P} * 8") + math(EXPR _CMAKE_BITS "${CMAKE_SIZEOF_VOID_P} * 8") + message(FATAL_ERROR "Python config failure: Python is ${_PYTHON_BITS}-bit, " + "chosen compiler is ${_CMAKE_BITS}-bit") + endif() + set(PYTHONLIBS_FOUND FALSE) + set(PythonLibsNew_FOUND FALSE) + return() +endif() + +# The built-in FindPython didn't always give the version numbers +string(REGEX + REPLACE "\\." + ";" + _PYTHON_VERSION_LIST + ${_PYTHON_VERSION_LIST}) +list(GET _PYTHON_VERSION_LIST 0 PYTHON_VERSION_MAJOR) +list(GET _PYTHON_VERSION_LIST 1 PYTHON_VERSION_MINOR) +list(GET _PYTHON_VERSION_LIST 2 PYTHON_VERSION_PATCH) + +# Make sure all directory separators are '/' +string(REGEX + REPLACE "\\\\" + "/" + PYTHON_PREFIX + ${PYTHON_PREFIX}) +string(REGEX + REPLACE "\\\\" + "/" + PYTHON_INCLUDE_DIR + ${PYTHON_INCLUDE_DIR}) +string(REGEX + REPLACE "\\\\" + "/" + PYTHON_SITE_PACKAGES + ${PYTHON_SITE_PACKAGES}) + +if(CMAKE_HOST_WIN32) + set(PYTHON_LIBRARY "${PYTHON_PREFIX}/libs/Python${PYTHON_LIBRARY_SUFFIX}.lib") + + # when run in a venv, PYTHON_PREFIX points to it. But the libraries remain in the original python installation. They + # may be found relative to PYTHON_INCLUDE_DIR. + if(NOT EXISTS "${PYTHON_LIBRARY}") + get_filename_component(_PYTHON_ROOT ${PYTHON_INCLUDE_DIR} DIRECTORY) + set(PYTHON_LIBRARY "${_PYTHON_ROOT}/libs/Python${PYTHON_LIBRARY_SUFFIX}.lib") + endif() + + # raise an error if the python libs are still not found. + if(NOT EXISTS "${PYTHON_LIBRARY}") + message(FATAL_ERROR "Python libraries not found") + endif() + +else() + if(PYTHON_MULTIARCH) + set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}/${PYTHON_MULTIARCH}" "${PYTHON_LIBDIR}") + else() + set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}") + endif() + # message(STATUS "Searching for Python libs in ${_PYTHON_LIBS_SEARCH}") Probably this needs to be more involved. It + # would be nice if the config information the python interpreter itself gave us were more complete. + find_library(PYTHON_LIBRARY NAMES "python${PYTHON_LIBRARY_SUFFIX}" PATHS ${_PYTHON_LIBS_SEARCH} NO_DEFAULT_PATH) + + # If all else fails, just set the name/version and let the linker figure out the path. + if(NOT PYTHON_LIBRARY) + set(PYTHON_LIBRARY python${PYTHON_LIBRARY_SUFFIX}) + endif() +endif() + +mark_as_advanced(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_LIBRARIES "${PYTHON_LIBRARY}") +set(PYTHON_DEBUG_LIBRARIES "${PYTHON_DEBUG_LIBRARY}") + +find_package_message(PYTHON "Found PythonLibs: ${PYTHON_LIBRARY}" "${PYTHON_EXECUTABLE}${PYTHON_VERSION}") + +set(PYTHONLIBS_FOUND TRUE) +set(PythonLibsNew_FOUND TRUE) diff --git a/cmake/modules/FindQhull.cmake b/cmake/modules/FindQhull.cmake index 81331a376bacc165a2a1ca60af9b0137d9e0a1d7..ea4181d984f0b7233fed0d284fa6af7b60df6871 100644 --- a/cmake/modules/FindQhull.cmake +++ b/cmake/modules/FindQhull.cmake @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2017 - 2018) +# Tobias Leibner (2017 - 2018, 2020) # ~~~ include(Hints) diff --git a/cmake/modules/FindTBB.cmake b/cmake/modules/FindTBB.cmake index fc128cc162b37e7d4f83e22c218ad23eca6f30e9..fb8eb4f5655b278a5bd8da78a4834e0874ce842d 100644 --- a/cmake/modules/FindTBB.cmake +++ b/cmake/modules/FindTBB.cmake @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2014 - 2015, 2018 - 2019) -# Tobias Leibner (2018) +# Tobias Leibner (2018 - 2020) # # Locate Intel Threading Building Blocks include paths and libraries # diff --git a/cmake/modules/GridUtils.cmake b/cmake/modules/GridUtils.cmake index 4ba15306708c22d59f8ffa37299440dc177939e8..7e016d562daf133c6c11a0058e9850236625aaf5 100644 --- a/cmake/modules/GridUtils.cmake +++ b/cmake/modules/GridUtils.cmake @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2013 - 2017) # René Fritze (2014 - 2015, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ set(GRIDTYPE "YASPGRID" CACHE STRING "GRIDTYPE") diff --git a/cmake/modules/Hints.cmake b/cmake/modules/Hints.cmake index 4a8be11c721a89cc88fe614b84052ee8cc4412af..ea3ab056a86b12c994f477c4c111577df31742a5 100644 --- a/cmake/modules/Hints.cmake +++ b/cmake/modules/Hints.cmake @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018) +# Tobias Leibner (2018 - 2020) # ~~~ macro(append_to_each INPUTLIST POSTFIX OUTPUTLIST) diff --git a/cmake/modules/XtCompilerSupport.cmake b/cmake/modules/XtCompilerSupport.cmake index 69f4f2a7f8fe7fb3006af45219bdbcccd5adba2f..eff7904c94b1e944bcf06ff9f66a26fa606d32cd 100644 --- a/cmake/modules/XtCompilerSupport.cmake +++ b/cmake/modules/XtCompilerSupport.cmake @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2016 - 2019) -# Tobias Leibner (2018) +# Tobias Leibner (2018, 2020) # ~~~ macro(ADD_IF_SUPPORTED dest) diff --git a/cmake/modules/XtTooling.cmake b/cmake/modules/XtTooling.cmake index 22b150cef4f74e8c17ab3aa6938c95e6ccd1a607..dc64ada5eeab7588a324914d1aa98cc6df5aa9fa 100644 --- a/cmake/modules/XtTooling.cmake +++ b/cmake/modules/XtTooling.cmake @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2016 - 2019) -# Tobias Leibner (2016, 2018 - 2019) +# Tobias Leibner (2016, 2018 - 2020) # ~~~ macro(add_analyze) @@ -129,7 +129,7 @@ macro(DEPENDENCYCHECK) set(XARGS ${TEST_NAME_FLAGS} -DHAVE_CONFIG_H -H -c ${HEADER} -w) add_custom_target(${TEST_NAME} + - ${dune-xt-common_SOURCE_DIR}/cmake/dependencyinfo.py + ${dune-xt_SOURCE_DIR}/cmake/dependencyinfo.py ${CMAKE_CXX_COMPILER} ${XARGS} ${CMAKE_CURRENT_SOURCE_DIR} diff --git a/cmake/modules/dxt_all_sorted_testnames.cmake.in b/cmake/modules/dxt_all_sorted_testnames.cmake.in index d1c9dedcedb61e75575ba2c83fd27fd3ea81e5b1..2836e71e4e3a9b5035d665ab2d7e79955c9ed48f 100644 --- a/cmake/modules/dxt_all_sorted_testnames.cmake.in +++ b/cmake/modules/dxt_all_sorted_testnames.cmake.in @@ -1 +1,12 @@ +# ~~~ +# This file is part of the dune-xt project: +# https://github.com/dune-community/dune-xt +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +# License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +# or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +# with "runtime exception" (http://www.dune-project.org/license.html) +# Authors: +# René Fritze (2016) +# ~~~ + ${all_sorted_testnames} \ No newline at end of file diff --git a/cmake/modules/dxt_headercheck_targets.cmake.in b/cmake/modules/dxt_headercheck_targets.cmake.in index 5a9d659458e8c82f911f49cabbc04c5d5b6dc968..27fbc58c9c6301f2267dac4256e0b42a73763565 100644 --- a/cmake/modules/dxt_headercheck_targets.cmake.in +++ b/cmake/modules/dxt_headercheck_targets.cmake.in @@ -1 +1,12 @@ +# ~~~ +# This file is part of the dune-xt project: +# https://github.com/dune-community/dune-xt +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +# License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +# or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +# with "runtime exception" (http://www.dune-project.org/license.html) +# Authors: +# René Fritze (2016) +# ~~~ + ${dxt_headercheck_targets} \ No newline at end of file diff --git a/cmake/modules/dxt_test_binaries.cmake.in b/cmake/modules/dxt_test_binaries.cmake.in index 82026fb7d8c18074797428c8bceafa277a20b06e..52e9111e471694e12f59d36bdebf85b06c4538ba 100644 --- a/cmake/modules/dxt_test_binaries.cmake.in +++ b/cmake/modules/dxt_test_binaries.cmake.in @@ -1 +1,12 @@ +# ~~~ +# This file is part of the dune-xt project: +# https://github.com/dune-community/dune-xt +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +# License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +# or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +# with "runtime exception" (http://www.dune-project.org/license.html) +# Authors: +# René Fritze (2016) +# ~~~ + ${dxt_test_binaries} \ No newline at end of file diff --git a/config.h.cmake b/config.h.cmake index f0f84cd3a74e4b37b819f435cba2cf2ba9071865..390c479bea4ab3aa45987bf608760c7b81be644b 100644 --- a/config.h.cmake +++ b/config.h.cmake @@ -1,28 +1,28 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2018) // René Fritze (2013 - 2019) -// Tobias Leibner (2014, 2016 - 2019) +// Tobias Leibner (2014, 2016 - 2020) -/* begin dune-xt-common */ +/* begin dune-xt */ // NEVER delete/alter above comment, dune's cmake relies on it -/* Define to the version of dune-xt-common */ -#define DUNE_XT_COMMON_VERSION ${DUNE_XT_COMMON_VERSION} +/* Define to the version of dune-xt */ +#define DUNE_XT_VERSION ${DUNE_XT_VERSION} -/* Define to the major version of dune-xt-common */ -#define DUNE_XT_COMMON_VERSION_MAJOR ${DUNE_XT_COMMON_VERSION_MAJOR} +/* Define to the major version of dune-xt */ +#define DUNE_XT_VERSION_MAJOR ${DUNE_XT_VERSION_MAJOR} -/* Define to the minor version of dune-xt-common */ -#define DUNE_XT_COMMON_VERSION_MINOR ${DUNE_XT_COMMON_VERSION_MINOR} +/* Define to the minor version of dune-xt */ +#define DUNE_XT_VERSION_MINOR ${DUNE_XT_VERSION_MINOR} -/* Define to the revision of dune-xt-common */ -#define DUNE_XT_COMMON_VERSION_REVISION ${DUNE_XT_COMMON_VERSION_REVISION} +/* Define to the revision of dune-xt */ +#define DUNE_XT_VERSION_REVISION ${DUNE_XT_VERSION_REVISION} #ifndef HAVE_CBLAS #cmakedefine01 HAVE_CBLAS @@ -93,8 +93,8 @@ #endif /* needed in dune/xt/common/profiler.hh */ -#ifndef DUNE_XT_COMMON_DO_TIMING -#define DUNE_XT_COMMON_DO_TIMING 0 +#ifndef DUNE_XT_DO_TIMING +#define DUNE_XT_DO_TIMING 0 #endif #cmakedefine01 DUNE_XT_WITH_PYTHON_BINDINGS @@ -214,5 +214,5 @@ // This is an unfortunate hack, see the header for an explanation. #include <dune/xt/common/fix-ambiguous-std-math-overloads.hh> -/* end dune-xt-common */ +/* end dune-xt */ // NEVER delete/alter above comment, dune's cmake relies on it diff --git a/doc/doxygen/CMakeLists.txt b/doc/doxygen/CMakeLists.txt index f8939fdf046fab03d7470d1410a2a420163dde30..b28dddbd7a75053698c4bbbf4e55ee48e82beddd 100644 --- a/doc/doxygen/CMakeLists.txt +++ b/doc/doxygen/CMakeLists.txt @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2015, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ add_forced_doxygen_target() diff --git a/doc/doxygen/Doxylocal b/doc/doxygen/Doxylocal index 2322504a9217ba7589e05365f84a9e9e887ffdf4..f132983060693de9a7da751277f67bcc9bb3333a 100644 --- a/doc/doxygen/Doxylocal +++ b/doc/doxygen/Doxylocal @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2015, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ # Where to search and which files to use diff --git a/doc/doxygen/mainpage b/doc/doxygen/mainpage index 2c068c96bbeeffc2191b2f49f1c80fa8da20bd2e..6318f7707822662874fd13bb0ba2888b82d9f866 100644 --- a/doc/doxygen/mainpage +++ b/doc/doxygen/mainpage @@ -1,16 +1,17 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2015, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ -/** \mainpage dune-xt-common Automatic Documentation +/** \mainpage dune-xt Automatic Documentation \section intro Introduction diff --git a/dune-xt.pc.in b/dune-xt.pc.in index 676329c005085b9f33019611faf050e8712046ed..3f5a2a44072544ba98ef2d409e318ca4d9aaa806 100644 --- a/dune-xt.pc.in +++ b/dune-xt.pc.in @@ -1,7 +1,7 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,6 +9,7 @@ # Felix Schindler (2014, 2016 - 2017) # René Fritze (2010, 2015, 2018 - 2019) # Sven Kaulmann (2013) +# Tobias Leibner (2020) # ~~~ prefix=@prefix@ diff --git a/dune.module b/dune.module index 8e9f61d1c72c38e26b82ab1bc837857faee45184..d52584a6d5e2901e2b1ae4c1e355463b946c3631 100755 --- a/dune.module +++ b/dune.module @@ -1,18 +1,18 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2012 - 2014, 2016 - 2017, 2019) # René Fritze (2009, 2011 - 2015, 2017 - 2019) -# Tobias Leibner (2015, 2018 - 2019) +# Tobias Leibner (2015, 2018 - 2020) # ~~~ Module: dune-xt Version: 18.11-dev Maintainer: dune-xt-dev@listserv.uni-muenster.de -Depends: dune-common (>= 2.6) dune-geometry (>= 2.6) dune-grid (>= 2.6) dune-istl (>= 2.6) dune-pybindxi (>= 18.11) dune-xt-data (>= 18.11) +Depends: dune-common (>= 2.6) dune-geometry (>= 2.6) dune-grid (>= 2.6) dune-istl (>= 2.6) dune-xt-data (>= 18.11) Suggests: dune-testtools (>= 2.6) dune-alugrid (>= 2.6) dune-grid-glue (>= 2.6) dune-uggrid (>= 2.6) diff --git a/dune/CMakeLists.txt b/dune/CMakeLists.txt index daa2d96f4ad41f6f049afd0d09db2cf4d177da88..94d139e780a6a79d4f92172c268fb440fc3d8bab 100644 --- a/dune/CMakeLists.txt +++ b/dune/CMakeLists.txt @@ -1,15 +1,16 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2014, 2016 - 2017) # René Fritze (2012, 2015 - 2016, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ add_subdirectory(xt) - +add_subdirectory(pybindxi) install(DIRECTORY xt DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/dune/ FILES_MATCHING PATTERN "*.hh") diff --git a/dune/pybindxi/CMakeLists.txt b/dune/pybindxi/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..db41241ab0e324e7c40b21f31daa6c73853ca958 --- /dev/null +++ b/dune/pybindxi/CMakeLists.txt @@ -0,0 +1,26 @@ +# This file is part of the dune-pybindx1 project: https://github.com/dune-community/dune-pybindx1 The copyright lies +# with the authors of this file (see below). License: BSD 2-Clause License +# (http://opensource.org/licenses/BSD-2-Clause) Authors: Felix Schindler (2016) + +dune_library_add_sources(dunepybindxi SOURCES interpreter.cc) + +install(FILES attr.h + buffer_info.h + cast.h + chrono.h + common.h + complex.h + eigen.h + embed.h + eval.h + functional.h + interpreter.hh + iostream.h + numpy.h + operators.h + options.h + pybind11.h + pytypes.h + stl.h + stl_bind.h + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/dune/pybindxi) diff --git a/dune/pybindxi/attr.h b/dune/pybindxi/attr.h new file mode 100644 index 0000000000000000000000000000000000000000..ae5df633e0d174b3b590f0249058bbfbdc4eaf4b --- /dev/null +++ b/dune/pybindxi/attr.h @@ -0,0 +1,679 @@ +#pragma GCC system_header +/* + pybind11/attr.h: Infrastructure for processing custom + type and function attributes + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "cast.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/// \addtogroup annotations +/// @{ + +/// Annotation for methods +struct is_method +{ + handle class_; + is_method(const handle& c) + : class_(c) + {} +}; + +/// Annotation for operators +struct is_operator +{}; + +/// Annotation for parent scope +struct scope +{ + handle value; + scope(const handle& s) + : value(s) + {} +}; + +/// Annotation for documentation +struct doc +{ + const char* value; + doc(const char* value) + : value(value) + {} +}; + +/// Annotation for function names +struct name +{ + const char* value; + name(const char* value) + : value(value) + {} +}; + +/// Annotation indicating that a function is an overload associated with a given "sibling" +struct sibling +{ + handle value; + sibling(const handle& value) + : value(value.ptr()) + {} +}; + +/// Annotation indicating that a class derives from another given type +template <typename T> +struct base +{ + PYBIND11_DEPRECATED("base<T>() was deprecated in favor of specifying 'T' as a template argument to class_") + base() {} +}; + +/// Keep patient alive while nurse lives +template <size_t Nurse, size_t Patient> +struct keep_alive +{}; + +/// Annotation indicating that a class is involved in a multiple inheritance relationship +struct multiple_inheritance +{}; + +/// Annotation which enables dynamic attributes, i.e. adds `__dict__` to a class +struct dynamic_attr +{}; + +/// Annotation which enables the buffer protocol for a type +struct buffer_protocol +{}; + +/// Annotation which requests that a special metaclass is created for a type +struct metaclass +{ + handle value; + + PYBIND11_DEPRECATED("py::metaclass() is no longer required. It's turned on by default now.") + metaclass() {} + + /// Override pybind11's default metaclass + explicit metaclass(handle value) + : value(value) + {} +}; + +/// Annotation that marks a class as local to the module: +struct module_local +{ + const bool value; + constexpr module_local(bool v = true) + : value(v) + {} +}; + +/// Annotation to mark enums as an arithmetic type +struct arithmetic +{}; + +/** \rst + A call policy which places one or more guard variables (``Ts...``) around the function call. + + For example, this definition: + + .. code-block:: cpp + + m.def("foo", foo, py::call_guard<T>()); + + is equivalent to the following pseudocode: + + .. code-block:: cpp + + m.def("foo", [](args...) { + T scope_guard; + return foo(args...); // forwarded arguments + }); + \endrst */ +template <typename... Ts> +struct call_guard; + +template <> +struct call_guard<> +{ + using type = detail::void_type; +}; + +template <typename T> +struct call_guard<T> +{ + static_assert(std::is_default_constructible<T>::value, "The guard type must be default constructible"); + + using type = T; +}; + +template <typename T, typename... Ts> +struct call_guard<T, Ts...> +{ + struct type + { + T guard{}; // Compose multiple guard types with left-to-right default-constructor order + typename call_guard<Ts...>::type next{}; + }; +}; + +/// @} annotations + +NAMESPACE_BEGIN(detail) +/* Forward declarations */ +enum op_id : int; +enum op_type : int; +struct undefined_t; +template <op_id id, op_type ot, typename L = undefined_t, typename R = undefined_t> +struct op_; +inline void keep_alive_impl(size_t Nurse, size_t Patient, function_call& call, handle ret); + +/// Internal data structure which holds metadata about a keyword argument +struct argument_record +{ + const char* name; ///< Argument name + const char* descr; ///< Human-readable version of the argument value + handle value; ///< Associated Python object + bool convert : 1; ///< True if the argument is allowed to convert when loading + bool none : 1; ///< True if None is allowed when loading + + argument_record(const char* name, const char* descr, handle value, bool convert, bool none) + : name(name) + , descr(descr) + , value(value) + , convert(convert) + , none(none) + {} +}; + +/// Internal data structure which holds metadata about a bound function (signature, overloads, etc.) +struct function_record +{ + function_record() + : is_constructor(false) + , is_new_style_constructor(false) + , is_stateless(false) + , is_operator(false) + , has_args(false) + , has_kwargs(false) + , is_method(false) + {} + + /// Function name + char* name = nullptr; /* why no C++ strings? They generate heavier code.. */ + + // User-specified documentation string + char* doc = nullptr; + + /// Human-readable version of the function signature + char* signature = nullptr; + + /// List of registered keyword arguments + std::vector<argument_record> args; + + /// Pointer to lambda function which converts arguments and performs the actual call + handle (*impl)(function_call&) = nullptr; + + /// Storage for the wrapped function pointer and captured data, if any + void* data[3] = {}; + + /// Pointer to custom destructor for 'data' (if needed) + void (*free_data)(function_record* ptr) = nullptr; + + /// Return value policy associated with this function + return_value_policy policy = return_value_policy::automatic; + + /// True if name == '__init__' + bool is_constructor : 1; + + /// True if this is a new-style `__init__` defined in `detail/init.h` + bool is_new_style_constructor : 1; + + /// True if this is a stateless function pointer + bool is_stateless : 1; + + /// True if this is an operator (__add__), etc. + bool is_operator : 1; + + /// True if the function has a '*args' argument + bool has_args : 1; + + /// True if the function has a '**kwargs' argument + bool has_kwargs : 1; + + /// True if this is a method + bool is_method : 1; + + /// Number of arguments (including py::args and/or py::kwargs, if present) + std::uint16_t nargs; + + /// Python method object + PyMethodDef* def = nullptr; + + /// Python handle to the parent scope (a class or a module) + handle scope; + + /// Python handle to the sibling function representing an overload chain + handle sibling; + + /// Pointer to next overload + function_record* next = nullptr; +}; + +/// Special data structure which (temporarily) holds metadata about a bound class +struct type_record +{ + PYBIND11_NOINLINE type_record() + : multiple_inheritance(false) + , dynamic_attr(false) + , buffer_protocol(false) + , default_holder(true) + , module_local(false) + {} + + /// Handle to the parent scope + handle scope; + + /// Name of the class + const char* name = nullptr; + + // Pointer to RTTI type_info data structure + const std::type_info* type = nullptr; + + /// How large is the underlying C++ type? + size_t type_size = 0; + + /// What is the alignment of the underlying C++ type? + size_t type_align = 0; + + /// How large is the type's holder? + size_t holder_size = 0; + + /// The global operator new can be overridden with a class-specific variant + void* (*operator_new)(size_t) = nullptr; + + /// Function pointer to class_<..>::init_instance + void (*init_instance)(instance*, const void*) = nullptr; + + /// Function pointer to class_<..>::dealloc + void (*dealloc)(detail::value_and_holder&) = nullptr; + + /// List of base classes of the newly created type + list bases; + + /// Optional docstring + const char* doc = nullptr; + + /// Custom metaclass (optional) + handle metaclass; + + /// Multiple inheritance marker + bool multiple_inheritance : 1; + + /// Does the class manage a __dict__? + bool dynamic_attr : 1; + + /// Does the class implement the buffer protocol? + bool buffer_protocol : 1; + + /// Is the default (unique_ptr) holder type used? + bool default_holder : 1; + + /// Is the class definition local to the module shared object? + bool module_local : 1; + + PYBIND11_NOINLINE void add_base(const std::type_info& base, void* (*caster)(void*)) + { + auto base_info = detail::get_type_info(base, false); + if (!base_info) { + std::string tname(base.name()); + detail::clean_type_id(tname); + pybind11_fail("generic_type: type \"" + std::string(name) + "\" referenced unknown base type \"" + tname + "\""); + } + + if (default_holder != base_info->default_holder) { + std::string tname(base.name()); + detail::clean_type_id(tname); + pybind11_fail("generic_type: type \"" + std::string(name) + "\" " + (default_holder ? "does not have" : "has") + + " a non-default holder type while its base \"" + tname + "\" " + + (base_info->default_holder ? "does not" : "does")); + } + + bases.append((PyObject*)base_info->type); + + if (base_info->type->tp_dictoffset != 0) + dynamic_attr = true; + + if (caster) + base_info->implicit_casts.emplace_back(type, caster); + } +}; + +inline function_call::function_call(const function_record& f, handle p) + : func(f) + , parent(p) +{ + args.reserve(f.nargs); + args_convert.reserve(f.nargs); +} + +/// Tag for a new-style `__init__` defined in `detail/init.h` +struct is_new_style_constructor +{}; + +/** + * Partial template specializations to process custom attributes provided to + * cpp_function_ and class_. These are either used to initialize the respective + * fields in the type_record and function_record data structures or executed at + * runtime to deal with custom call policies (e.g. keep_alive). + */ +template <typename T, typename SFINAE = void> +struct process_attribute; + +template <typename T> +struct process_attribute_default +{ + /// Default implementation: do nothing + static void init(const T&, function_record*) {} + static void init(const T&, type_record*) {} + static void precall(function_call&) {} + static void postcall(function_call&, handle) {} +}; + +/// Process an attribute specifying the function's name +template <> +struct process_attribute<name> : process_attribute_default<name> +{ + static void init(const name& n, function_record* r) + { + r->name = const_cast<char*>(n.value); + } +}; + +/// Process an attribute specifying the function's docstring +template <> +struct process_attribute<doc> : process_attribute_default<doc> +{ + static void init(const doc& n, function_record* r) + { + r->doc = const_cast<char*>(n.value); + } +}; + +/// Process an attribute specifying the function's docstring (provided as a C-style string) +template <> +struct process_attribute<const char*> : process_attribute_default<const char*> +{ + static void init(const char* d, function_record* r) + { + r->doc = const_cast<char*>(d); + } + static void init(const char* d, type_record* r) + { + r->doc = const_cast<char*>(d); + } +}; +template <> +struct process_attribute<char*> : process_attribute<const char*> +{}; + +/// Process an attribute indicating the function's return value policy +template <> +struct process_attribute<return_value_policy> : process_attribute_default<return_value_policy> +{ + static void init(const return_value_policy& p, function_record* r) + { + r->policy = p; + } +}; + +/// Process an attribute which indicates that this is an overloaded function associated with a given sibling +template <> +struct process_attribute<sibling> : process_attribute_default<sibling> +{ + static void init(const sibling& s, function_record* r) + { + r->sibling = s.value; + } +}; + +/// Process an attribute which indicates that this function is a method +template <> +struct process_attribute<is_method> : process_attribute_default<is_method> +{ + static void init(const is_method& s, function_record* r) + { + r->is_method = true; + r->scope = s.class_; + } +}; + +/// Process an attribute which indicates the parent scope of a method +template <> +struct process_attribute<scope> : process_attribute_default<scope> +{ + static void init(const scope& s, function_record* r) + { + r->scope = s.value; + } +}; + +/// Process an attribute which indicates that this function is an operator +template <> +struct process_attribute<is_operator> : process_attribute_default<is_operator> +{ + static void init(const is_operator&, function_record* r) + { + r->is_operator = true; + } +}; + +template <> +struct process_attribute<is_new_style_constructor> : process_attribute_default<is_new_style_constructor> +{ + static void init(const is_new_style_constructor&, function_record* r) + { + r->is_new_style_constructor = true; + } +}; + +/// Process a keyword argument attribute (*without* a default value) +template <> +struct process_attribute<arg> : process_attribute_default<arg> +{ + static void init(const arg& a, function_record* r) + { + if (r->is_method && r->args.empty()) + r->args.emplace_back("self", nullptr, handle(), true /*convert*/, false /*none not allowed*/); + r->args.emplace_back(a.name, nullptr, handle(), !a.flag_noconvert, a.flag_none); + } +}; + +/// Process a keyword argument attribute (*with* a default value) +template <> +struct process_attribute<arg_v> : process_attribute_default<arg_v> +{ + static void init(const arg_v& a, function_record* r) + { + if (r->is_method && r->args.empty()) + r->args.emplace_back( + "self", nullptr /*descr*/, handle() /*parent*/, true /*convert*/, false /*none not allowed*/); + + if (!a.value) { +#if !defined(NDEBUG) + std::string descr("'"); + if (a.name) + descr += std::string(a.name) + ": "; + descr += a.type + "'"; + if (r->is_method) { + if (r->name) + descr += " in method '" + (std::string)str(r->scope) + "." + (std::string)r->name + "'"; + else + descr += " in method of '" + (std::string)str(r->scope) + "'"; + } else if (r->name) { + descr += " in function '" + (std::string)r->name + "'"; + } + pybind11_fail("arg(): could not convert default argument " + descr + + " into a Python object (type not registered yet?)"); +#else + pybind11_fail("arg(): could not convert default argument " + "into a Python object (type not registered yet?). " + "Compile in debug mode for more information."); +#endif + } + r->args.emplace_back(a.name, a.descr, a.value.inc_ref(), !a.flag_noconvert, a.flag_none); + } +}; + +/// Process a parent class attribute. Single inheritance only (class_ itself already guarantees that) +template <typename T> +struct process_attribute<T, enable_if_t<is_pyobject<T>::value>> : process_attribute_default<handle> +{ + static void init(const handle& h, type_record* r) + { + r->bases.append(h); + } +}; + +/// Process a parent class attribute (deprecated, does not support multiple inheritance) +template <typename T> +struct process_attribute<base<T>> : process_attribute_default<base<T>> +{ + static void init(const base<T>&, type_record* r) + { + r->add_base(typeid(T), nullptr); + } +}; + +/// Process a multiple inheritance attribute +template <> +struct process_attribute<multiple_inheritance> : process_attribute_default<multiple_inheritance> +{ + static void init(const multiple_inheritance&, type_record* r) + { + r->multiple_inheritance = true; + } +}; + +template <> +struct process_attribute<dynamic_attr> : process_attribute_default<dynamic_attr> +{ + static void init(const dynamic_attr&, type_record* r) + { + r->dynamic_attr = true; + } +}; + +template <> +struct process_attribute<buffer_protocol> : process_attribute_default<buffer_protocol> +{ + static void init(const buffer_protocol&, type_record* r) + { + r->buffer_protocol = true; + } +}; + +template <> +struct process_attribute<metaclass> : process_attribute_default<metaclass> +{ + static void init(const metaclass& m, type_record* r) + { + r->metaclass = m.value; + } +}; + +template <> +struct process_attribute<module_local> : process_attribute_default<module_local> +{ + static void init(const module_local& l, type_record* r) + { + r->module_local = l.value; + } +}; + +/// Process an 'arithmetic' attribute for enums (does nothing here) +template <> +struct process_attribute<arithmetic> : process_attribute_default<arithmetic> +{}; + +template <typename... Ts> +struct process_attribute<call_guard<Ts...>> : process_attribute_default<call_guard<Ts...>> +{}; + +/** + * Process a keep_alive call policy -- invokes keep_alive_impl during the + * pre-call handler if both Nurse, Patient != 0 and use the post-call handler + * otherwise + */ +template <size_t Nurse, size_t Patient> +struct process_attribute<keep_alive<Nurse, Patient>> : public process_attribute_default<keep_alive<Nurse, Patient>> +{ + template <size_t N = Nurse, size_t P = Patient, enable_if_t<N != 0 && P != 0, int> = 0> + static void precall(function_call& call) + { + keep_alive_impl(Nurse, Patient, call, handle()); + } + template <size_t N = Nurse, size_t P = Patient, enable_if_t<N != 0 && P != 0, int> = 0> + static void postcall(function_call&, handle) + {} + template <size_t N = Nurse, size_t P = Patient, enable_if_t<N == 0 || P == 0, int> = 0> + static void precall(function_call&) + {} + template <size_t N = Nurse, size_t P = Patient, enable_if_t<N == 0 || P == 0, int> = 0> + static void postcall(function_call& call, handle ret) + { + keep_alive_impl(Nurse, Patient, call, ret); + } +}; + +/// Recursively iterate over variadic template arguments +template <typename... Args> +struct process_attributes +{ + static void init(const Args&... args, function_record* r) + { + int unused[] = {0, (process_attribute<typename std::decay<Args>::type>::init(args, r), 0)...}; + ignore_unused(unused); + } + static void init(const Args&... args, type_record* r) + { + int unused[] = {0, (process_attribute<typename std::decay<Args>::type>::init(args, r), 0)...}; + ignore_unused(unused); + } + static void precall(function_call& call) + { + int unused[] = {0, (process_attribute<typename std::decay<Args>::type>::precall(call), 0)...}; + ignore_unused(unused); + } + static void postcall(function_call& call, handle fn_ret) + { + int unused[] = {0, (process_attribute<typename std::decay<Args>::type>::postcall(call, fn_ret), 0)...}; + ignore_unused(unused); + } +}; + +template <typename T> +using is_call_guard = is_instantiation<call_guard, T>; + +/// Extract the ``type`` from the first `call_guard` in `Extras...` (or `void_type` if none found) +template <typename... Extra> +using extract_guard_t = typename exactly_one_t<is_call_guard, call_guard<>, Extra...>::type; + +/// Check the number of named arguments at compile time +template <typename... Extra, + size_t named = constexpr_sum(std::is_base_of<arg, Extra>::value...), + size_t self = constexpr_sum(std::is_same<is_method, Extra>::value...)> +constexpr bool expected_num_args(size_t nargs, bool has_args, bool has_kwargs) +{ + return named == 0 || (self + named + has_args + has_kwargs) == nargs; +} + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/buffer_info.h b/dune/pybindxi/buffer_info.h new file mode 100644 index 0000000000000000000000000000000000000000..925133c379dfd3f2af67995424db9f83e5aebbc4 --- /dev/null +++ b/dune/pybindxi/buffer_info.h @@ -0,0 +1,154 @@ +#pragma GCC system_header +/* + pybind11/buffer_info.h: Python buffer object interface + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/// Information record describing a Python buffer object +struct buffer_info +{ + void* ptr = nullptr; // Pointer to the underlying storage + ssize_t itemsize = 0; // Size of individual items in bytes + ssize_t size = 0; // Total number of entries + std::string format; // For homogeneous buffers, this should be set to format_descriptor<T>::format() + ssize_t ndim = 0; // Number of dimensions + std::vector<ssize_t> shape; // Shape of the tensor (1 entry per dimension) + std::vector<ssize_t> strides; // Number of entries between adjacent entries (for each per dimension) + + buffer_info() {} + + buffer_info(void* ptr, + ssize_t itemsize, + const std::string& format, + ssize_t ndim, + detail::any_container<ssize_t> shape_in, + detail::any_container<ssize_t> strides_in) + : ptr(ptr) + , itemsize(itemsize) + , size(1) + , format(format) + , ndim(ndim) + , shape(std::move(shape_in)) + , strides(std::move(strides_in)) + { + if (ndim != (ssize_t)shape.size() || ndim != (ssize_t)strides.size()) + pybind11_fail("buffer_info: ndim doesn't match shape and/or strides length"); + for (size_t i = 0; i < (size_t)ndim; ++i) + size *= shape[i]; + } + + template <typename T> + buffer_info(T* ptr, detail::any_container<ssize_t> shape_in, detail::any_container<ssize_t> strides_in) + : buffer_info(private_ctr_tag(), + ptr, + sizeof(T), + format_descriptor<T>::format(), + static_cast<ssize_t>(shape_in->size()), + std::move(shape_in), + std::move(strides_in)) + {} + + buffer_info(void* ptr, ssize_t itemsize, const std::string& format, ssize_t size) + : buffer_info(ptr, itemsize, format, 1, {size}, {itemsize}) + {} + + template <typename T> + buffer_info(T* ptr, ssize_t size) + : buffer_info(ptr, sizeof(T), format_descriptor<T>::format(), size) + {} + + explicit buffer_info(Py_buffer* view, bool ownview = true) + : buffer_info(view->buf, + view->itemsize, + view->format, + view->ndim, + {view->shape, view->shape + view->ndim}, + {view->strides, view->strides + view->ndim}) + { + this->view = view; + this->ownview = ownview; + } + + buffer_info(const buffer_info&) = delete; + buffer_info& operator=(const buffer_info&) = delete; + + buffer_info(buffer_info&& other) + { + (*this) = std::move(other); + } + + buffer_info& operator=(buffer_info&& rhs) + { + ptr = rhs.ptr; + itemsize = rhs.itemsize; + size = rhs.size; + format = std::move(rhs.format); + ndim = rhs.ndim; + shape = std::move(rhs.shape); + strides = std::move(rhs.strides); + std::swap(view, rhs.view); + std::swap(ownview, rhs.ownview); + return *this; + } + + ~buffer_info() + { + if (view && ownview) { + PyBuffer_Release(view); + delete view; + } + } + +private: + struct private_ctr_tag + {}; + + buffer_info(private_ctr_tag, + void* ptr, + ssize_t itemsize, + const std::string& format, + ssize_t ndim, + detail::any_container<ssize_t>&& shape_in, + detail::any_container<ssize_t>&& strides_in) + : buffer_info(ptr, itemsize, format, ndim, std::move(shape_in), std::move(strides_in)) + {} + + Py_buffer* view = nullptr; + bool ownview = false; +}; + +NAMESPACE_BEGIN(detail) + +template <typename T, typename SFINAE = void> +struct compare_buffer_info +{ + static bool compare(const buffer_info& b) + { + return b.format == format_descriptor<T>::format() && b.itemsize == (ssize_t)sizeof(T); + } +}; + +template <typename T> +struct compare_buffer_info<T, detail::enable_if_t<std::is_integral<T>::value>> +{ + static bool compare(const buffer_info& b) + { + return (size_t)b.itemsize == sizeof(T) + && (b.format == format_descriptor<T>::value + || ((sizeof(T) == sizeof(long)) && b.format == (std::is_unsigned<T>::value ? "L" : "l")) + || ((sizeof(T) == sizeof(size_t)) && b.format == (std::is_unsigned<T>::value ? "N" : "n"))); + } +}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/cast.h b/dune/pybindxi/cast.h new file mode 100644 index 0000000000000000000000000000000000000000..f27d176f23865b5fddf8074914a7163cfc8a8dda --- /dev/null +++ b/dune/pybindxi/cast.h @@ -0,0 +1,2602 @@ +#pragma GCC system_header +/* + pybind11/cast.h: Partial template specializations to cast between + C++ and Python types + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pytypes.h" +#include "detail/typeid.h" +#include "detail/descr.h" +#include "detail/internals.h" +#include <array> +#include <limits> +#include <tuple> +#include <type_traits> + +#if defined(PYBIND11_CPP17) +# if defined(__has_include) +# if __has_include(<string_view>) +# define PYBIND11_HAS_STRING_VIEW +# endif +# elif defined(_MSC_VER) +# define PYBIND11_HAS_STRING_VIEW +# endif +#endif +#ifdef PYBIND11_HAS_STRING_VIEW +# include <string_view> +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// A life support system for temporary objects created by `type_caster::load()`. +/// Adding a patient will keep it alive up until the enclosing function returns. +class loader_life_support +{ +public: + /// A new patient frame is created when a function is entered + loader_life_support() + { + get_internals().loader_patient_stack.push_back(nullptr); + } + + /// ... and destroyed after it returns + ~loader_life_support() + { + auto& stack = get_internals().loader_patient_stack; + if (stack.empty()) + pybind11_fail("loader_life_support: internal error"); + + auto ptr = stack.back(); + stack.pop_back(); + Py_CLEAR(ptr); + + // A heuristic to reduce the stack's capacity (e.g. after long recursive calls) + if (stack.capacity() > 16 && stack.size() != 0 && stack.capacity() / stack.size() > 2) + stack.shrink_to_fit(); + } + + /// This can only be used inside a pybind11-bound function, either by `argument_loader` + /// at argument preparation time or by `py::cast()` at execution time. + PYBIND11_NOINLINE static void add_patient(handle h) + { + auto& stack = get_internals().loader_patient_stack; + if (stack.empty()) + throw cast_error("When called outside a bound function, py::cast() cannot " + "do Python -> C++ conversions which require the creation " + "of temporary values"); + + auto& list_ptr = stack.back(); + if (list_ptr == nullptr) { + list_ptr = PyList_New(1); + if (!list_ptr) + pybind11_fail("loader_life_support: error allocating list"); + PyList_SET_ITEM(list_ptr, 0, h.inc_ref().ptr()); + } else { + auto result = PyList_Append(list_ptr, h.ptr()); + if (result == -1) + pybind11_fail("loader_life_support: error adding patient"); + } + } +}; + +// Gets the cache entry for the given type, creating it if necessary. The return value is the pair +// returned by emplace, i.e. an iterator for the entry and a bool set to `true` if the entry was +// just created. +inline std::pair<decltype(internals::registered_types_py)::iterator, bool> all_type_info_get_cache(PyTypeObject* type); + +// Populates a just-created cache entry. +PYBIND11_NOINLINE inline void all_type_info_populate(PyTypeObject* t, std::vector<type_info*>& bases) +{ + std::vector<PyTypeObject*> check; + for (handle parent : reinterpret_borrow<tuple>(t->tp_bases)) + check.push_back((PyTypeObject*)parent.ptr()); + + auto const& type_dict = get_internals().registered_types_py; + for (size_t i = 0; i < check.size(); i++) { + auto type = check[i]; + // Ignore Python2 old-style class super type: + if (!PyType_Check((PyObject*)type)) + continue; + + // Check `type` in the current set of registered python types: + auto it = type_dict.find(type); + if (it != type_dict.end()) { + // We found a cache entry for it, so it's either pybind-registered or has pre-computed + // pybind bases, but we have to make sure we haven't already seen the type(s) before: we + // want to follow Python/virtual C++ rules that there should only be one instance of a + // common base. + for (auto* tinfo : it->second) { + // NB: Could use a second set here, rather than doing a linear search, but since + // having a large number of immediate pybind11-registered types seems fairly + // unlikely, that probably isn't worthwhile. + bool found = false; + for (auto* known : bases) { + if (known == tinfo) { + found = true; + break; + } + } + if (!found) + bases.push_back(tinfo); + } + } else if (type->tp_bases) { + // It's some python type, so keep follow its bases classes to look for one or more + // registered types + if (i + 1 == check.size()) { + // When we're at the end, we can pop off the current element to avoid growing + // `check` when adding just one base (which is typical--i.e. when there is no + // multiple inheritance) + check.pop_back(); + i--; + } + for (handle parent : reinterpret_borrow<tuple>(type->tp_bases)) + check.push_back((PyTypeObject*)parent.ptr()); + } + } +} + +/** + * Extracts vector of type_info pointers of pybind-registered roots of the given Python type. Will + * be just 1 pybind type for the Python type of a pybind-registered class, or for any Python-side + * derived class that uses single inheritance. Will contain as many types as required for a Python + * class that uses multiple inheritance to inherit (directly or indirectly) from multiple + * pybind-registered classes. Will be empty if neither the type nor any base classes are + * pybind-registered. + * + * The value is cached for the lifetime of the Python type. + */ +inline const std::vector<detail::type_info*>& all_type_info(PyTypeObject* type) +{ + auto ins = all_type_info_get_cache(type); + if (ins.second) + // New cache entry: populate it + all_type_info_populate(type, ins.first->second); + + return ins.first->second; +} + +/** + * Gets a single pybind11 type info for a python type. Returns nullptr if neither the type nor any + * ancestors are pybind11-registered. Throws an exception if there are multiple bases--use + * `all_type_info` instead if you want to support multiple bases. + */ +PYBIND11_NOINLINE inline detail::type_info* get_type_info(PyTypeObject* type) +{ + auto& bases = all_type_info(type); + if (bases.size() == 0) + return nullptr; + if (bases.size() > 1) + pybind11_fail("pybind11::detail::get_type_info: type has multiple pybind11-registered bases"); + return bases.front(); +} + +inline detail::type_info* get_local_type_info(const std::type_index& tp) +{ + auto& locals = registered_local_types_cpp(); + auto it = locals.find(tp); + if (it != locals.end()) + return it->second; + return nullptr; +} + +inline detail::type_info* get_global_type_info(const std::type_index& tp) +{ + auto& types = get_internals().registered_types_cpp; + auto it = types.find(tp); + if (it != types.end()) + return it->second; + return nullptr; +} + +/// Return the type info for a given C++ type; on lookup failure can either throw or return nullptr. +PYBIND11_NOINLINE inline detail::type_info* get_type_info(const std::type_index& tp, bool throw_if_missing = false) +{ + if (auto ltype = get_local_type_info(tp)) + return ltype; + if (auto gtype = get_global_type_info(tp)) + return gtype; + + if (throw_if_missing) { + std::string tname = tp.name(); + detail::clean_type_id(tname); + pybind11_fail("pybind11::detail::get_type_info: unable to find type info for \"" + tname + "\""); + } + return nullptr; +} + +PYBIND11_NOINLINE inline handle get_type_handle(const std::type_info& tp, bool throw_if_missing) +{ + detail::type_info* type_info = get_type_info(tp, throw_if_missing); + return handle(type_info ? ((PyObject*)type_info->type) : nullptr); +} + +struct value_and_holder +{ + instance* inst = nullptr; + size_t index = 0u; + const detail::type_info* type = nullptr; + void** vh = nullptr; + + // Main constructor for a found value/holder: + value_and_holder(instance* i, const detail::type_info* type, size_t vpos, size_t index) + : inst{i} + , index{index} + , type{type} + , vh{inst->simple_layout ? inst->simple_value_holder : &inst->nonsimple.values_and_holders[vpos]} + {} + + // Default constructor (used to signal a value-and-holder not found by get_value_and_holder()) + value_and_holder() {} + + // Used for past-the-end iterator + value_and_holder(size_t index) + : index{index} + {} + + template <typename V = void> + V*& value_ptr() const + { + return reinterpret_cast<V*&>(vh[0]); + } + // True if this `value_and_holder` has a non-null value pointer + explicit operator bool() const + { + return value_ptr(); + } + + template <typename H> + H& holder() const + { + return reinterpret_cast<H&>(vh[1]); + } + bool holder_constructed() const + { + return inst->simple_layout ? inst->simple_holder_constructed + : inst->nonsimple.status[index] & instance::status_holder_constructed; + } + void set_holder_constructed(bool v = true) + { + if (inst->simple_layout) + inst->simple_holder_constructed = v; + else if (v) + inst->nonsimple.status[index] |= instance::status_holder_constructed; + else + inst->nonsimple.status[index] &= (uint8_t)~instance::status_holder_constructed; + } + bool instance_registered() const + { + return inst->simple_layout ? inst->simple_instance_registered + : inst->nonsimple.status[index] & instance::status_instance_registered; + } + void set_instance_registered(bool v = true) + { + if (inst->simple_layout) + inst->simple_instance_registered = v; + else if (v) + inst->nonsimple.status[index] |= instance::status_instance_registered; + else + inst->nonsimple.status[index] &= (uint8_t)~instance::status_instance_registered; + } +}; + +// Container for accessing and iterating over an instance's values/holders +struct values_and_holders +{ +private: + instance* inst; + using type_vec = std::vector<detail::type_info*>; + const type_vec& tinfo; + +public: + values_and_holders(instance* inst) + : inst{inst} + , tinfo(all_type_info(Py_TYPE(inst))) + {} + + struct iterator + { + private: + instance* inst = nullptr; + const type_vec* types = nullptr; + value_and_holder curr; + friend struct values_and_holders; + iterator(instance* inst, const type_vec* tinfo) + : inst{inst} + , types{tinfo} + , curr(inst /* instance */, + types->empty() ? nullptr : (*types)[0] /* type info */, + 0, /* vpos: (non-simple types only): the first vptr comes first */ + 0 /* index */) + {} + // Past-the-end iterator: + iterator(size_t end) + : curr(end) + {} + + public: + bool operator==(const iterator& other) + { + return curr.index == other.curr.index; + } + bool operator!=(const iterator& other) + { + return curr.index != other.curr.index; + } + iterator& operator++() + { + if (!inst->simple_layout) + curr.vh += 1 + (*types)[curr.index]->holder_size_in_ptrs; + ++curr.index; + curr.type = curr.index < types->size() ? (*types)[curr.index] : nullptr; + return *this; + } + value_and_holder& operator*() + { + return curr; + } + value_and_holder* operator->() + { + return &curr; + } + }; + + iterator begin() + { + return iterator(inst, &tinfo); + } + iterator end() + { + return iterator(tinfo.size()); + } + + iterator find(const type_info* find_type) + { + auto it = begin(), endit = end(); + while (it != endit && it->type != find_type) + ++it; + return it; + } + + size_t size() + { + return tinfo.size(); + } +}; + +/** + * Extracts C++ value and holder pointer references from an instance (which may contain multiple + * values/holders for python-side multiple inheritance) that match the given type. Throws an error + * if the given type (or ValueType, if omitted) is not a pybind11 base of the given instance. If + * `find_type` is omitted (or explicitly specified as nullptr) the first value/holder are returned, + * regardless of type (and the resulting .type will be nullptr). + * + * The returned object should be short-lived: in particular, it must not outlive the called-upon + * instance. + */ +PYBIND11_NOINLINE inline value_and_holder +instance::get_value_and_holder(const type_info* find_type /*= nullptr default in common.h*/, + bool throw_if_missing /*= true in common.h*/) +{ + // Optimize common case: + if (!find_type || Py_TYPE(this) == find_type->type) + return value_and_holder(this, find_type, 0, 0); + + detail::values_and_holders vhs(this); + auto it = vhs.find(find_type); + if (it != vhs.end()) + return *it; + + if (!throw_if_missing) + return value_and_holder(); + +#if defined(NDEBUG) + pybind11_fail("pybind11::detail::instance::get_value_and_holder: " + "type is not a pybind11 base of the given instance " + "(compile in debug mode for type details)"); +#else + pybind11_fail("pybind11::detail::instance::get_value_and_holder: `" + std::string(find_type->type->tp_name) + + "' is not a pybind11 base of the given `" + std::string(Py_TYPE(this)->tp_name) + "' instance"); +#endif +} + +PYBIND11_NOINLINE inline void instance::allocate_layout() +{ + auto& tinfo = all_type_info(Py_TYPE(this)); + + const size_t n_types = tinfo.size(); + + if (n_types == 0) + pybind11_fail("instance allocation failed: new instance has no pybind11-registered base types"); + + simple_layout = n_types == 1 && tinfo.front()->holder_size_in_ptrs <= instance_simple_holder_in_ptrs(); + + // Simple path: no python-side multiple inheritance, and a small-enough holder + if (simple_layout) { + simple_value_holder[0] = nullptr; + simple_holder_constructed = false; + simple_instance_registered = false; + } else { // multiple base types or a too-large holder + // Allocate space to hold: [v1*][h1][v2*][h2]...[bb...] where [vN*] is a value pointer, + // [hN] is the (uninitialized) holder instance for value N, and [bb...] is a set of bool + // values that tracks whether each associated holder has been initialized. Each [block] is + // padded, if necessary, to an integer multiple of sizeof(void *). + size_t space = 0; + for (auto t : tinfo) { + space += 1; // value pointer + space += t->holder_size_in_ptrs; // holder instance + } + size_t flags_at = space; + space += size_in_ptrs(n_types); // status bytes (holder_constructed and instance_registered) + + // Allocate space for flags, values, and holders, and initialize it to 0 (flags and values, + // in particular, need to be 0). Use Python's memory allocation functions: in Python 3.6 + // they default to using pymalloc, which is designed to be efficient for small allocations + // like the one we're doing here; in earlier versions (and for larger allocations) they are + // just wrappers around malloc. +#if PY_VERSION_HEX >= 0x03050000 + nonsimple.values_and_holders = (void**)PyMem_Calloc(space, sizeof(void*)); + if (!nonsimple.values_and_holders) + throw std::bad_alloc(); +#else + nonsimple.values_and_holders = (void**)PyMem_New(void*, space); + if (!nonsimple.values_and_holders) + throw std::bad_alloc(); + std::memset(nonsimple.values_and_holders, 0, space * sizeof(void*)); +#endif + nonsimple.status = reinterpret_cast<uint8_t*>(&nonsimple.values_and_holders[flags_at]); + } + owned = true; +} + +PYBIND11_NOINLINE inline void instance::deallocate_layout() +{ + if (!simple_layout) + PyMem_Free(nonsimple.values_and_holders); +} + +PYBIND11_NOINLINE inline bool isinstance_generic(handle obj, const std::type_info& tp) +{ + handle type = detail::get_type_handle(tp, false); + if (!type) + return false; + return isinstance(obj, type); +} + +PYBIND11_NOINLINE inline std::string error_string() +{ + if (!PyErr_Occurred()) { + PyErr_SetString(PyExc_RuntimeError, "Unknown internal error occurred"); + return "Unknown internal error occurred"; + } + + error_scope scope; // Preserve error state + + std::string errorString; + if (scope.type) { + errorString += handle(scope.type).attr("__name__").cast<std::string>(); + errorString += ": "; + } + if (scope.value) + errorString += (std::string)str(scope.value); + + PyErr_NormalizeException(&scope.type, &scope.value, &scope.trace); + +#if PY_MAJOR_VERSION >= 3 + if (scope.trace != nullptr) + PyException_SetTraceback(scope.value, scope.trace); +#endif + +#if !defined(PYPY_VERSION) + if (scope.trace) { + PyTracebackObject* trace = (PyTracebackObject*)scope.trace; + + /* Get the deepest trace possible */ + while (trace->tb_next) + trace = trace->tb_next; + + PyFrameObject* frame = trace->tb_frame; + errorString += "\n\nAt:\n"; + while (frame) { + int lineno = PyFrame_GetLineNumber(frame); + errorString += " " + handle(frame->f_code->co_filename).cast<std::string>() + "(" + std::to_string(lineno) + + "): " + handle(frame->f_code->co_name).cast<std::string>() + "\n"; + frame = frame->f_back; + } + } +#endif + + return errorString; +} + +PYBIND11_NOINLINE inline handle get_object_handle(const void* ptr, const detail::type_info* type) +{ + auto& instances = get_internals().registered_instances; + auto range = instances.equal_range(ptr); + for (auto it = range.first; it != range.second; ++it) { + for (auto vh : values_and_holders(it->second)) { + if (vh.type == type) + return handle((PyObject*)it->second); + } + } + return handle(); +} + +inline PyThreadState* get_thread_state_unchecked() +{ +#if defined(PYPY_VERSION) + return PyThreadState_GET(); +#elif PY_VERSION_HEX < 0x03000000 + return _PyThreadState_Current; +#elif PY_VERSION_HEX < 0x03050000 + return (PyThreadState*)_Py_atomic_load_relaxed(&_PyThreadState_Current); +#elif PY_VERSION_HEX < 0x03050200 + return (PyThreadState*)_PyThreadState_Current.value; +#else + return _PyThreadState_UncheckedGet(); +#endif +} + +// Forward declarations +inline void keep_alive_impl(handle nurse, handle patient); +inline PyObject* make_new_instance(PyTypeObject* type); + +class type_caster_generic +{ +public: + PYBIND11_NOINLINE type_caster_generic(const std::type_info& type_info) + : typeinfo(get_type_info(type_info)) + , cpptype(&type_info) + {} + + type_caster_generic(const type_info* typeinfo) + : typeinfo(typeinfo) + , cpptype(typeinfo ? typeinfo->cpptype : nullptr) + {} + + bool load(handle src, bool convert) + { + return load_impl<type_caster_generic>(src, convert); + } + + PYBIND11_NOINLINE static handle cast(const void* _src, + return_value_policy policy, + handle parent, + const detail::type_info* tinfo, + void* (*copy_constructor)(const void*), + void* (*move_constructor)(const void*), + const void* existing_holder = nullptr) + { + if (!tinfo) // no type info: error will be set already + return handle(); + + void* src = const_cast<void*>(_src); + if (src == nullptr) + return none().release(); + + auto it_instances = get_internals().registered_instances.equal_range(src); + for (auto it_i = it_instances.first; it_i != it_instances.second; ++it_i) { + for (auto instance_type : detail::all_type_info(Py_TYPE(it_i->second))) { + if (instance_type && same_type(*instance_type->cpptype, *tinfo->cpptype)) + return handle((PyObject*)it_i->second).inc_ref(); + } + } + + auto inst = reinterpret_steal<object>(make_new_instance(tinfo->type)); + auto wrapper = reinterpret_cast<instance*>(inst.ptr()); + wrapper->owned = false; + void*& valueptr = values_and_holders(wrapper).begin()->value_ptr(); + + switch (policy) { + case return_value_policy::automatic: + case return_value_policy::take_ownership: + valueptr = src; + wrapper->owned = true; + break; + + case return_value_policy::automatic_reference: + case return_value_policy::reference: + valueptr = src; + wrapper->owned = false; + break; + + case return_value_policy::copy: + if (copy_constructor) + valueptr = copy_constructor(src); + else + throw cast_error("return_value_policy = copy, but the " + "object is non-copyable!"); + wrapper->owned = true; + break; + + case return_value_policy::move: + if (move_constructor) + valueptr = move_constructor(src); + else if (copy_constructor) + valueptr = copy_constructor(src); + else + throw cast_error("return_value_policy = move, but the " + "object is neither movable nor copyable!"); + wrapper->owned = true; + break; + + case return_value_policy::reference_internal: + valueptr = src; + wrapper->owned = false; + keep_alive_impl(inst, parent); + break; + + default: + throw cast_error("unhandled return_value_policy: should not happen!"); + } + + tinfo->init_instance(wrapper, existing_holder); + + return inst.release(); + } + + // Base methods for generic caster; there are overridden in copyable_holder_caster + void load_value(value_and_holder&& v_h) + { + auto*& vptr = v_h.value_ptr(); + // Lazy allocation for unallocated values: + if (vptr == nullptr) { + auto* type = v_h.type ? v_h.type : typeinfo; + if (type->operator_new) { + vptr = type->operator_new(type->type_size); + } else { +#if defined(PYBIND11_CPP17) + if (type->type_align > __STDCPP_DEFAULT_NEW_ALIGNMENT__) + vptr = ::operator new(type->type_size, (std::align_val_t)type->type_align); + else +#endif + vptr = ::operator new(type->type_size); + } + } + value = vptr; + } + bool try_implicit_casts(handle src, bool convert) + { + for (auto& cast : typeinfo->implicit_casts) { + type_caster_generic sub_caster(*cast.first); + if (sub_caster.load(src, convert)) { + value = cast.second(sub_caster.value); + return true; + } + } + return false; + } + bool try_direct_conversions(handle src) + { + for (auto& converter : *typeinfo->direct_conversions) { + if (converter(src.ptr(), value)) + return true; + } + return false; + } + void check_holder_compat() {} + + PYBIND11_NOINLINE static void* local_load(PyObject* src, const type_info* ti) + { + auto caster = type_caster_generic(ti); + if (caster.load(src, false)) + return caster.value; + return nullptr; + } + + /// Try to load with foreign typeinfo, if available. Used when there is no + /// native typeinfo, or when the native one wasn't able to produce a value. + PYBIND11_NOINLINE bool try_load_foreign_module_local(handle src) + { + constexpr auto* local_key = PYBIND11_MODULE_LOCAL_ID; + const auto pytype = src.get_type(); + if (!hasattr(pytype, local_key)) + return false; + + type_info* foreign_typeinfo = reinterpret_borrow<capsule>(getattr(pytype, local_key)); + // Only consider this foreign loader if actually foreign and is a loader of the correct cpp type + if (foreign_typeinfo->module_local_load == &local_load + || (cpptype && !same_type(*cpptype, *foreign_typeinfo->cpptype))) + return false; + + if (auto result = foreign_typeinfo->module_local_load(src.ptr(), foreign_typeinfo)) { + value = result; + return true; + } + return false; + } + + // Implementation of `load`; this takes the type of `this` so that it can dispatch the relevant + // bits of code between here and copyable_holder_caster where the two classes need different + // logic (without having to resort to virtual inheritance). + template <typename ThisT> + PYBIND11_NOINLINE bool load_impl(handle src, bool convert) + { + if (!src) + return false; + if (!typeinfo) + return try_load_foreign_module_local(src); + if (src.is_none()) { + // Defer accepting None to other overloads (if we aren't in convert mode): + if (!convert) + return false; + value = nullptr; + return true; + } + + auto& this_ = static_cast<ThisT&>(*this); + this_.check_holder_compat(); + + PyTypeObject* srctype = Py_TYPE(src.ptr()); + + // Case 1: If src is an exact type match for the target type then we can reinterpret_cast + // the instance's value pointer to the target type: + if (srctype == typeinfo->type) { + this_.load_value(reinterpret_cast<instance*>(src.ptr())->get_value_and_holder()); + return true; + } + // Case 2: We have a derived class + else if (PyType_IsSubtype(srctype, typeinfo->type)) { + auto& bases = all_type_info(srctype); + bool no_cpp_mi = typeinfo->simple_type; + + // Case 2a: the python type is a Python-inherited derived class that inherits from just + // one simple (no MI) pybind11 class, or is an exact match, so the C++ instance is of + // the right type and we can use reinterpret_cast. + // (This is essentially the same as case 2b, but because not using multiple inheritance + // is extremely common, we handle it specially to avoid the loop iterator and type + // pointer lookup overhead) + if (bases.size() == 1 && (no_cpp_mi || bases.front()->type == typeinfo->type)) { + this_.load_value(reinterpret_cast<instance*>(src.ptr())->get_value_and_holder()); + return true; + } + // Case 2b: the python type inherits from multiple C++ bases. Check the bases to see if + // we can find an exact match (or, for a simple C++ type, an inherited match); if so, we + // can safely reinterpret_cast to the relevant pointer. + else if (bases.size() > 1) { + for (auto base : bases) { + if (no_cpp_mi ? PyType_IsSubtype(base->type, typeinfo->type) : base->type == typeinfo->type) { + this_.load_value(reinterpret_cast<instance*>(src.ptr())->get_value_and_holder(base)); + return true; + } + } + } + + // Case 2c: C++ multiple inheritance is involved and we couldn't find an exact type match + // in the registered bases, above, so try implicit casting (needed for proper C++ casting + // when MI is involved). + if (this_.try_implicit_casts(src, convert)) + return true; + } + + // Perform an implicit conversion + if (convert) { + for (auto& converter : typeinfo->implicit_conversions) { + auto temp = reinterpret_steal<object>(converter(src.ptr(), typeinfo->type)); + if (load_impl<ThisT>(temp, false)) { + loader_life_support::add_patient(temp); + return true; + } + } + if (this_.try_direct_conversions(src)) + return true; + } + + // Failed to match local typeinfo. Try again with global. + if (typeinfo->module_local) { + if (auto gtype = get_global_type_info(*typeinfo->cpptype)) { + typeinfo = gtype; + return load(src, false); + } + } + + // Global typeinfo has precedence over foreign module_local + return try_load_foreign_module_local(src); + } + + + // Called to do type lookup and wrap the pointer and type in a pair when a dynamic_cast + // isn't needed or can't be used. If the type is unknown, sets the error and returns a pair + // with .second = nullptr. (p.first = nullptr is not an error: it becomes None). + PYBIND11_NOINLINE static std::pair<const void*, const type_info*> + src_and_type(const void* src, const std::type_info& cast_type, const std::type_info* rtti_type = nullptr) + { + if (auto* tpi = get_type_info(cast_type)) + return {src, const_cast<const type_info*>(tpi)}; + + // Not found, set error: + std::string tname = rtti_type ? rtti_type->name() : cast_type.name(); + detail::clean_type_id(tname); + std::string msg = "Unregistered type : " + tname; + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return {nullptr, nullptr}; + } + + const type_info* typeinfo = nullptr; + const std::type_info* cpptype = nullptr; + void* value = nullptr; +}; + +/** + * Determine suitable casting operator for pointer-or-lvalue-casting type casters. The type caster + * needs to provide `operator T*()` and `operator T&()` operators. + * + * If the type supports moving the value away via an `operator T&&() &&` method, it should use + * `movable_cast_op_type` instead. + */ +template <typename T> +using cast_op_type = conditional_t<std::is_pointer<remove_reference_t<T>>::value, + typename std::add_pointer<intrinsic_t<T>>::type, + typename std::add_lvalue_reference<intrinsic_t<T>>::type>; + +/** + * Determine suitable casting operator for a type caster with a movable value. Such a type caster + * needs to provide `operator T*()`, `operator T&()`, and `operator T&&() &&`. The latter will be + * called in appropriate contexts where the value can be moved rather than copied. + * + * These operator are automatically provided when using the PYBIND11_TYPE_CASTER macro. + */ +template <typename T> +using movable_cast_op_type = conditional_t<std::is_pointer<typename std::remove_reference<T>::type>::value, + typename std::add_pointer<intrinsic_t<T>>::type, + conditional_t<std::is_rvalue_reference<T>::value, + typename std::add_rvalue_reference<intrinsic_t<T>>::type, + typename std::add_lvalue_reference<intrinsic_t<T>>::type>>; + +// std::is_copy_constructible isn't quite enough: it lets std::vector<T> (and similar) through when +// T is non-copyable, but code containing such a copy constructor fails to actually compile. +template <typename T, typename SFINAE = void> +struct is_copy_constructible : std::is_copy_constructible<T> +{}; + +// Specialization for types that appear to be copy constructible but also look like stl containers +// (we specifically check for: has `value_type` and `reference` with `reference = value_type&`): if +// so, copy constructability depends on whether the value_type is copy constructible. +template <typename Container> +struct is_copy_constructible< + Container, + enable_if_t<all_of<std::is_copy_constructible<Container>, + std::is_same<typename Container::value_type&, typename Container::reference>>::value>> + : is_copy_constructible<typename Container::value_type> +{}; + +#if !defined(PYBIND11_CPP17) +// Likewise for std::pair before C++17 (which mandates that the copy constructor not exist when the +// two types aren't themselves copy constructible). +template <typename T1, typename T2> +struct is_copy_constructible<std::pair<T1, T2>> : all_of<is_copy_constructible<T1>, is_copy_constructible<T2>> +{}; +#endif + +NAMESPACE_END(detail) + +// polymorphic_type_hook<itype>::get(src, tinfo) determines whether the object pointed +// to by `src` actually is an instance of some class derived from `itype`. +// If so, it sets `tinfo` to point to the std::type_info representing that derived +// type, and returns a pointer to the start of the most-derived object of that type +// (in which `src` is a subobject; this will be the same address as `src` in most +// single inheritance cases). If not, or if `src` is nullptr, it simply returns `src` +// and leaves `tinfo` at its default value of nullptr. +// +// The default polymorphic_type_hook just returns src. A specialization for polymorphic +// types determines the runtime type of the passed object and adjusts the this-pointer +// appropriately via dynamic_cast<void*>. This is what enables a C++ Animal* to appear +// to Python as a Dog (if Dog inherits from Animal, Animal is polymorphic, Dog is +// registered with pybind11, and this Animal is in fact a Dog). +// +// You may specialize polymorphic_type_hook yourself for types that want to appear +// polymorphic to Python but do not use C++ RTTI. (This is a not uncommon pattern +// in performance-sensitive applications, used most notably in LLVM.) +template <typename itype, typename SFINAE = void> +struct polymorphic_type_hook +{ + static const void* get(const itype* src, const std::type_info*&) + { + return src; + } +}; +template <typename itype> +struct polymorphic_type_hook<itype, detail::enable_if_t<std::is_polymorphic<itype>::value>> +{ + static const void* get(const itype* src, const std::type_info*& type) + { + type = src ? &typeid(*src) : nullptr; + return dynamic_cast<const void*>(src); + } +}; + +NAMESPACE_BEGIN(detail) + +/// Generic type caster for objects stored on the heap +template <typename type> +class type_caster_base : public type_caster_generic +{ + using itype = intrinsic_t<type>; + +public: + static constexpr auto name = _<type>(); + + type_caster_base() + : type_caster_base(typeid(type)) + {} + explicit type_caster_base(const std::type_info& info) + : type_caster_generic(info) + {} + + static handle cast(const itype& src, return_value_policy policy, handle parent) + { + if (policy == return_value_policy::automatic || policy == return_value_policy::automatic_reference) + policy = return_value_policy::copy; + return cast(&src, policy, parent); + } + + static handle cast(itype&& src, return_value_policy, handle parent) + { + return cast(&src, return_value_policy::move, parent); + } + + // Returns a (pointer, type_info) pair taking care of necessary type lookup for a + // polymorphic type (using RTTI by default, but can be overridden by specializing + // polymorphic_type_hook). If the instance isn't derived, returns the base version. + static std::pair<const void*, const type_info*> src_and_type(const itype* src) + { + auto& cast_type = typeid(itype); + const std::type_info* instance_type = nullptr; + const void* vsrc = polymorphic_type_hook<itype>::get(src, instance_type); + if (instance_type && !same_type(cast_type, *instance_type)) { + // This is a base pointer to a derived type. If the derived type is registered + // with pybind11, we want to make the full derived object available. + // In the typical case where itype is polymorphic, we get the correct + // derived pointer (which may be != base pointer) by a dynamic_cast to + // most derived type. If itype is not polymorphic, we won't get here + // except via a user-provided specialization of polymorphic_type_hook, + // and the user has promised that no this-pointer adjustment is + // required in that case, so it's OK to use static_cast. + if (const auto* tpi = get_type_info(*instance_type)) + return {vsrc, tpi}; + } + // Otherwise we have either a nullptr, an `itype` pointer, or an unknown derived pointer, so + // don't do a cast + return type_caster_generic::src_and_type(src, cast_type, instance_type); + } + + static handle cast(const itype* src, return_value_policy policy, handle parent) + { + auto st = src_and_type(src); + return type_caster_generic::cast( + st.first, policy, parent, st.second, make_copy_constructor(src), make_move_constructor(src)); + } + + static handle cast_holder(const itype* src, const void* holder) + { + auto st = src_and_type(src); + return type_caster_generic::cast( + st.first, return_value_policy::take_ownership, {}, st.second, nullptr, nullptr, holder); + } + + template <typename T> + using cast_op_type = detail::cast_op_type<T>; + + operator itype*() + { + return (type*)value; + } + operator itype&() + { + if (!value) + throw reference_cast_error(); + return *((itype*)value); + } + +protected: + using Constructor = void* (*)(const void*); + + /* Only enabled when the types are {copy,move}-constructible *and* when the type + does not have a private operator new implementation. */ + template <typename T, typename = enable_if_t<is_copy_constructible<T>::value>> + static auto make_copy_constructor(const T* x) -> decltype(new T(*x), Constructor{}) + { + return [](const void* arg) -> void* { return new T(*reinterpret_cast<const T*>(arg)); }; + } + + template <typename T, typename = enable_if_t<std::is_move_constructible<T>::value>> + static auto make_move_constructor(const T* x) -> decltype(new T(std::move(*const_cast<T*>(x))), Constructor{}) + { + return [](const void* arg) -> void* { return new T(std::move(*const_cast<T*>(reinterpret_cast<const T*>(arg)))); }; + } + + static Constructor make_copy_constructor(...) + { + return nullptr; + } + static Constructor make_move_constructor(...) + { + return nullptr; + } +}; + +template <typename type, typename SFINAE = void> +class type_caster : public type_caster_base<type> +{}; +template <typename type> +using make_caster = type_caster<intrinsic_t<type>>; + +// Shortcut for calling a caster's `cast_op_type` cast operator for casting a type_caster to a T +template <typename T> +typename make_caster<T>::template cast_op_type<T> cast_op(make_caster<T>& caster) +{ + return caster.operator typename make_caster<T>::template cast_op_type<T>(); +} +template <typename T> +typename make_caster<T>::template cast_op_type<typename std::add_rvalue_reference<T>::type> +cast_op(make_caster<T>&& caster) +{ + return std::move(caster). + operator typename make_caster<T>::template cast_op_type<typename std::add_rvalue_reference<T>::type>(); +} + +template <typename type> +class type_caster<std::reference_wrapper<type>> +{ +private: + using caster_t = make_caster<type>; + caster_t subcaster; + using subcaster_cast_op_type = typename caster_t::template cast_op_type<type>; + static_assert(std::is_same<typename std::remove_const<type>::type&, subcaster_cast_op_type>::value, + "std::reference_wrapper<T> caster requires T to have a caster with an `T &` operator"); + +public: + bool load(handle src, bool convert) + { + return subcaster.load(src, convert); + } + static constexpr auto name = caster_t::name; + static handle cast(const std::reference_wrapper<type>& src, return_value_policy policy, handle parent) + { + // It is definitely wrong to take ownership of this pointer, so mask that rvp + if (policy == return_value_policy::take_ownership || policy == return_value_policy::automatic) + policy = return_value_policy::automatic_reference; + return caster_t::cast(&src.get(), policy, parent); + } + template <typename T> + using cast_op_type = std::reference_wrapper<type>; + operator std::reference_wrapper<type>() + { + return subcaster.operator subcaster_cast_op_type&(); + } +}; + +#define PYBIND11_TYPE_CASTER(type, py_name) \ +protected: \ + type value; \ + \ +public: \ + static constexpr auto name = py_name; \ + template <typename T_, enable_if_t<std::is_same<type, remove_cv_t<T_>>::value, int> = 0> \ + static handle cast(T_* src, return_value_policy policy, handle parent) \ + { \ + if (!src) \ + return none().release(); \ + if (policy == return_value_policy::take_ownership) { \ + auto h = cast(std::move(*src), policy, parent); \ + delete src; \ + return h; \ + } else { \ + return cast(*src, policy, parent); \ + } \ + } \ + operator type*() \ + { \ + return &value; \ + } \ + operator type&() \ + { \ + return value; \ + } \ + operator type &&()&& \ + { \ + return std::move(value); \ + } \ + template <typename T_> \ + using cast_op_type = pybind11::detail::movable_cast_op_type<T_> + + +template <typename CharT> +using is_std_char_type = any_of<std::is_same<CharT, char>, /* std::string */ + std::is_same<CharT, char16_t>, /* std::u16string */ + std::is_same<CharT, char32_t>, /* std::u32string */ + std::is_same<CharT, wchar_t> /* std::wstring */ + >; + +template <typename T> +struct type_caster<T, enable_if_t<std::is_arithmetic<T>::value && !is_std_char_type<T>::value>> +{ + using _py_type_0 = conditional_t<sizeof(T) <= sizeof(long), long, long long>; + using _py_type_1 = conditional_t<std::is_signed<T>::value, _py_type_0, typename std::make_unsigned<_py_type_0>::type>; + using py_type = conditional_t<std::is_floating_point<T>::value, double, _py_type_1>; + +public: + bool load(handle src, bool convert) + { + py_type py_value; + + if (!src) + return false; + + if (std::is_floating_point<T>::value) { + if (convert || PyFloat_Check(src.ptr())) + py_value = (py_type)PyFloat_AsDouble(src.ptr()); + else + return false; + } else if (PyFloat_Check(src.ptr())) { + return false; + } else if (std::is_unsigned<py_type>::value) { + py_value = as_unsigned<py_type>(src.ptr()); + } else { // signed integer: + py_value = + sizeof(T) <= sizeof(long) ? (py_type)PyLong_AsLong(src.ptr()) : (py_type)PYBIND11_LONG_AS_LONGLONG(src.ptr()); + } + + bool py_err = py_value == (py_type)-1 && PyErr_Occurred(); + if (py_err + || (std::is_integral<T>::value && sizeof(py_type) != sizeof(T) + && (py_value < (py_type)std::numeric_limits<T>::min() + || py_value > (py_type)std::numeric_limits<T>::max()))) { + bool type_error = py_err + && PyErr_ExceptionMatches( +#if PY_VERSION_HEX < 0x03000000 && !defined(PYPY_VERSION) + PyExc_SystemError +#else + PyExc_TypeError +#endif + ); + PyErr_Clear(); + if (type_error && convert && PyNumber_Check(src.ptr())) { + auto tmp = reinterpret_steal<object>(std::is_floating_point<T>::value ? PyNumber_Float(src.ptr()) + : PyNumber_Long(src.ptr())); + PyErr_Clear(); + return load(tmp, false); + } + return false; + } + + value = (T)py_value; + return true; + } + + template <typename U = T> + static typename std::enable_if<std::is_floating_point<U>::value, handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) + { + return PyFloat_FromDouble((double)src); + } + + template <typename U = T> + static typename std::enable_if<!std::is_floating_point<U>::value && std::is_signed<U>::value + && (sizeof(U) <= sizeof(long)), + handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) + { + return PYBIND11_LONG_FROM_SIGNED((long)src); + } + + template <typename U = T> + static typename std::enable_if<!std::is_floating_point<U>::value && std::is_unsigned<U>::value + && (sizeof(U) <= sizeof(unsigned long)), + handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) + { + return PYBIND11_LONG_FROM_UNSIGNED((unsigned long)src); + } + + template <typename U = T> + static typename std::enable_if<!std::is_floating_point<U>::value && std::is_signed<U>::value + && (sizeof(U) > sizeof(long)), + handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) + { + return PyLong_FromLongLong((long long)src); + } + + template <typename U = T> + static typename std::enable_if<!std::is_floating_point<U>::value && std::is_unsigned<U>::value + && (sizeof(U) > sizeof(unsigned long)), + handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) + { + return PyLong_FromUnsignedLongLong((unsigned long long)src); + } + + PYBIND11_TYPE_CASTER(T, _<std::is_integral<T>::value>("int", "float")); +}; + +template <typename T> +struct void_caster +{ +public: + bool load(handle src, bool) + { + if (src && src.is_none()) + return true; + return false; + } + static handle cast(T, return_value_policy /* policy */, handle /* parent */) + { + return none().inc_ref(); + } + PYBIND11_TYPE_CASTER(T, _("None")); +}; + +template <> +class type_caster<void_type> : public void_caster<void_type> +{}; + +template <> +class type_caster<void> : public type_caster<void_type> +{ +public: + using type_caster<void_type>::cast; + + bool load(handle h, bool) + { + if (!h) { + return false; + } else if (h.is_none()) { + value = nullptr; + return true; + } + + /* Check if this is a capsule */ + if (isinstance<capsule>(h)) { + value = reinterpret_borrow<capsule>(h); + return true; + } + + /* Check if this is a C++ type */ + auto& bases = all_type_info((PyTypeObject*)h.get_type().ptr()); + if (bases.size() == 1) { // Only allowing loading from a single-value type + value = values_and_holders(reinterpret_cast<instance*>(h.ptr())).begin()->value_ptr(); + return true; + } + + /* Fail */ + return false; + } + + static handle cast(const void* ptr, return_value_policy /* policy */, handle /* parent */) + { + if (ptr) + return capsule(ptr).release(); + else + return none().inc_ref(); + } + + template <typename T> + using cast_op_type = void*&; + operator void*&() + { + return value; + } + static constexpr auto name = _("capsule"); + +private: + void* value = nullptr; +}; + +template <> +class type_caster<std::nullptr_t> : public void_caster<std::nullptr_t> +{}; + +template <> +class type_caster<bool> +{ +public: + bool load(handle src, bool convert) + { + if (!src) + return false; + else if (src.ptr() == Py_True) { + value = true; + return true; + } else if (src.ptr() == Py_False) { + value = false; + return true; + } else if (convert || !strcmp("numpy.bool_", Py_TYPE(src.ptr())->tp_name)) { + // (allow non-implicit conversion for numpy booleans) + + Py_ssize_t res = -1; + if (src.is_none()) { + res = 0; // None is implicitly converted to False + } +#if defined(PYPY_VERSION) + // On PyPy, check that "__bool__" (or "__nonzero__" on Python 2.7) attr exists + else if (hasattr(src, PYBIND11_BOOL_ATTR)) { + res = PyObject_IsTrue(src.ptr()); + } +#else + // Alternate approach for CPython: this does the same as the above, but optimized + // using the CPython API so as to avoid an unneeded attribute lookup. + else if (auto tp_as_number = src.ptr()->ob_type->tp_as_number) { + if (PYBIND11_NB_BOOL(tp_as_number)) { + res = (*PYBIND11_NB_BOOL(tp_as_number))(src.ptr()); + } + } +#endif + if (res == 0 || res == 1) { + value = (bool)res; + return true; + } + } + return false; + } + static handle cast(bool src, return_value_policy /* policy */, handle /* parent */) + { + return handle(src ? Py_True : Py_False).inc_ref(); + } + PYBIND11_TYPE_CASTER(bool, _("bool")); +}; + +// Helper class for UTF-{8,16,32} C++ stl strings: +template <typename StringType, bool IsView = false> +struct string_caster +{ + using CharT = typename StringType::value_type; + + // Simplify life by being able to assume standard char sizes (the standard only guarantees + // minimums, but Python requires exact sizes) + static_assert(!std::is_same<CharT, char>::value || sizeof(CharT) == 1, "Unsupported char size != 1"); + static_assert(!std::is_same<CharT, char16_t>::value || sizeof(CharT) == 2, "Unsupported char16_t size != 2"); + static_assert(!std::is_same<CharT, char32_t>::value || sizeof(CharT) == 4, "Unsupported char32_t size != 4"); + // wchar_t can be either 16 bits (Windows) or 32 (everywhere else) + static_assert(!std::is_same<CharT, wchar_t>::value || sizeof(CharT) == 2 || sizeof(CharT) == 4, + "Unsupported wchar_t size != 2/4"); + static constexpr size_t UTF_N = 8 * sizeof(CharT); + + bool load(handle src, bool) + { +#if PY_MAJOR_VERSION < 3 + object temp; +#endif + handle load_src = src; + if (!src) { + return false; + } else if (!PyUnicode_Check(load_src.ptr())) { +#if PY_MAJOR_VERSION >= 3 + return load_bytes(load_src); +#else + if (sizeof(CharT) == 1) { + return load_bytes(load_src); + } + + // The below is a guaranteed failure in Python 3 when PyUnicode_Check returns false + if (!PYBIND11_BYTES_CHECK(load_src.ptr())) + return false; + + temp = reinterpret_steal<object>(PyUnicode_FromObject(load_src.ptr())); + if (!temp) { + PyErr_Clear(); + return false; + } + load_src = temp; +#endif + } + + object utfNbytes = reinterpret_steal<object>( + PyUnicode_AsEncodedString(load_src.ptr(), UTF_N == 8 ? "utf-8" : UTF_N == 16 ? "utf-16" : "utf-32", nullptr)); + if (!utfNbytes) { + PyErr_Clear(); + return false; + } + + const CharT* buffer = reinterpret_cast<const CharT*>(PYBIND11_BYTES_AS_STRING(utfNbytes.ptr())); + size_t length = (size_t)PYBIND11_BYTES_SIZE(utfNbytes.ptr()) / sizeof(CharT); + if (UTF_N > 8) { + buffer++; + length--; + } // Skip BOM for UTF-16/32 + value = StringType(buffer, length); + + // If we're loading a string_view we need to keep the encoded Python object alive: + if (IsView) + loader_life_support::add_patient(utfNbytes); + + return true; + } + + static handle cast(const StringType& src, return_value_policy /* policy */, handle /* parent */) + { + const char* buffer = reinterpret_cast<const char*>(src.data()); + ssize_t nbytes = ssize_t(src.size() * sizeof(CharT)); + handle s = decode_utfN(buffer, nbytes); + if (!s) + throw error_already_set(); + return s; + } + + PYBIND11_TYPE_CASTER(StringType, _(PYBIND11_STRING_NAME)); + +private: + static handle decode_utfN(const char* buffer, ssize_t nbytes) + { +#if !defined(PYPY_VERSION) + return UTF_N == 8 ? PyUnicode_DecodeUTF8(buffer, nbytes, nullptr) + : UTF_N == 16 ? PyUnicode_DecodeUTF16(buffer, nbytes, nullptr, nullptr) + : PyUnicode_DecodeUTF32(buffer, nbytes, nullptr, nullptr); +#else + // PyPy seems to have multiple problems related to PyUnicode_UTF*: the UTF8 version + // sometimes segfaults for unknown reasons, while the UTF16 and 32 versions require a + // non-const char * arguments, which is also a nuisance, so bypass the whole thing by just + // passing the encoding as a string value, which works properly: + return PyUnicode_Decode(buffer, nbytes, UTF_N == 8 ? "utf-8" : UTF_N == 16 ? "utf-16" : "utf-32", nullptr); +#endif + } + + // When loading into a std::string or char*, accept a bytes object as-is (i.e. + // without any encoding/decoding attempt). For other C++ char sizes this is a no-op. + // which supports loading a unicode from a str, doesn't take this path. + template <typename C = CharT> + bool load_bytes(enable_if_t<sizeof(C) == 1, handle> src) + { + if (PYBIND11_BYTES_CHECK(src.ptr())) { + // We were passed a Python 3 raw bytes; accept it into a std::string or char* + // without any encoding attempt. + const char* bytes = PYBIND11_BYTES_AS_STRING(src.ptr()); + if (bytes) { + value = StringType(bytes, (size_t)PYBIND11_BYTES_SIZE(src.ptr())); + return true; + } + } + + return false; + } + + template <typename C = CharT> + bool load_bytes(enable_if_t<sizeof(C) != 1, handle>) + { + return false; + } +}; + +template <typename CharT, class Traits, class Allocator> +struct type_caster<std::basic_string<CharT, Traits, Allocator>, enable_if_t<is_std_char_type<CharT>::value>> + : string_caster<std::basic_string<CharT, Traits, Allocator>> +{}; + +#ifdef PYBIND11_HAS_STRING_VIEW +template <typename CharT, class Traits> +struct type_caster<std::basic_string_view<CharT, Traits>, enable_if_t<is_std_char_type<CharT>::value>> + : string_caster<std::basic_string_view<CharT, Traits>, true> +{}; +#endif + +// Type caster for C-style strings. We basically use a std::string type caster, but also add the +// ability to use None as a nullptr char* (which the string caster doesn't allow). +template <typename CharT> +struct type_caster<CharT, enable_if_t<is_std_char_type<CharT>::value>> +{ + using StringType = std::basic_string<CharT>; + using StringCaster = type_caster<StringType>; + StringCaster str_caster; + bool none = false; + CharT one_char = 0; + +public: + bool load(handle src, bool convert) + { + if (!src) + return false; + if (src.is_none()) { + // Defer accepting None to other overloads (if we aren't in convert mode): + if (!convert) + return false; + none = true; + return true; + } + return str_caster.load(src, convert); + } + + static handle cast(const CharT* src, return_value_policy policy, handle parent) + { + if (src == nullptr) + return pybind11::none().inc_ref(); + return StringCaster::cast(StringType(src), policy, parent); + } + + static handle cast(CharT src, return_value_policy policy, handle parent) + { + if (std::is_same<char, CharT>::value) { + handle s = PyUnicode_DecodeLatin1((const char*)&src, 1, nullptr); + if (!s) + throw error_already_set(); + return s; + } + return StringCaster::cast(StringType(1, src), policy, parent); + } + + operator CharT*() + { + return none ? nullptr : const_cast<CharT*>(static_cast<StringType&>(str_caster).c_str()); + } + operator CharT&() + { + if (none) + throw value_error("Cannot convert None to a character"); + + auto& value = static_cast<StringType&>(str_caster); + size_t str_len = value.size(); + if (str_len == 0) + throw value_error("Cannot convert empty string to a character"); + + // If we're in UTF-8 mode, we have two possible failures: one for a unicode character that + // is too high, and one for multiple unicode characters (caught later), so we need to figure + // out how long the first encoded character is in bytes to distinguish between these two + // errors. We also allow want to allow unicode characters U+0080 through U+00FF, as those + // can fit into a single char value. + if (StringCaster::UTF_N == 8 && str_len > 1 && str_len <= 4) { + unsigned char v0 = static_cast<unsigned char>(value[0]); + size_t char0_bytes = !(v0 & 0x80) ? 1 : // low bits only: 0-127 + (v0 & 0xE0) == 0xC0 ? 2 : // 0b110xxxxx - start of 2-byte sequence + (v0 & 0xF0) == 0xE0 ? 3 : // 0b1110xxxx - start of 3-byte sequence + 4; // 0b11110xxx - start of 4-byte sequence + + if (char0_bytes == str_len) { + // If we have a 128-255 value, we can decode it into a single char: + if (char0_bytes == 2 && (v0 & 0xFC) == 0xC0) { // 0x110000xx 0x10xxxxxx + one_char = static_cast<CharT>(((v0 & 3) << 6) + (static_cast<unsigned char>(value[1]) & 0x3F)); + return one_char; + } + // Otherwise we have a single character, but it's > U+00FF + throw value_error("Character code point not in range(0x100)"); + } + } + + // UTF-16 is much easier: we can only have a surrogate pair for values above U+FFFF, thus a + // surrogate pair with total length 2 instantly indicates a range error (but not a "your + // string was too long" error). + else if (StringCaster::UTF_N == 16 && str_len == 2) { + one_char = static_cast<CharT>(value[0]); + if (one_char >= 0xD800 && one_char < 0xE000) + throw value_error("Character code point not in range(0x10000)"); + } + + if (str_len != 1) + throw value_error("Expected a character, but multi-character string found"); + + one_char = value[0]; + return one_char; + } + + static constexpr auto name = _(PYBIND11_STRING_NAME); + template <typename _T> + using cast_op_type = pybind11::detail::cast_op_type<_T>; +}; + +// Base implementation for std::tuple and std::pair +template <template <typename...> class Tuple, typename... Ts> +class tuple_caster +{ + using type = Tuple<Ts...>; + static constexpr auto size = sizeof...(Ts); + using indices = make_index_sequence<size>; + +public: + bool load(handle src, bool convert) + { + if (!isinstance<sequence>(src)) + return false; + const auto seq = reinterpret_borrow<sequence>(src); + if (seq.size() != size) + return false; + return load_impl(seq, convert, indices{}); + } + + template <typename T> + static handle cast(T&& src, return_value_policy policy, handle parent) + { + return cast_impl(std::forward<T>(src), policy, parent, indices{}); + } + + static constexpr auto name = _("Tuple[") + concat(make_caster<Ts>::name...) + _("]"); + + template <typename T> + using cast_op_type = type; + + operator type() & + { + return implicit_cast(indices{}); + } + operator type() && + { + return std::move(*this).implicit_cast(indices{}); + } + +protected: + template <size_t... Is> + type implicit_cast(index_sequence<Is...>) & + { + return type(cast_op<Ts>(std::get<Is>(subcasters))...); + } + template <size_t... Is> + type implicit_cast(index_sequence<Is...>) && + { + return type(cast_op<Ts>(std::move(std::get<Is>(subcasters)))...); + } + + static constexpr bool load_impl(const sequence&, bool, index_sequence<>) + { + return true; + } + + template <size_t... Is> + bool load_impl(const sequence& seq, bool convert, index_sequence<Is...>) + { + for (bool r : {std::get<Is>(subcasters).load(seq[Is], convert)...}) + if (!r) + return false; + return true; + } + + /* Implementation: Convert a C++ tuple into a Python tuple */ + template <typename T, size_t... Is> + static handle cast_impl(T&& src, return_value_policy policy, handle parent, index_sequence<Is...>) + { + std::array<object, size> entries{ + {reinterpret_steal<object>(make_caster<Ts>::cast(std::get<Is>(std::forward<T>(src)), policy, parent))...}}; + for (const auto& entry : entries) + if (!entry) + return handle(); + tuple result(size); + int counter = 0; + for (auto& entry : entries) + PyTuple_SET_ITEM(result.ptr(), counter++, entry.release().ptr()); + return result.release(); + } + + Tuple<make_caster<Ts>...> subcasters; +}; + +template <typename T1, typename T2> +class type_caster<std::pair<T1, T2>> : public tuple_caster<std::pair, T1, T2> +{}; + +template <typename... Ts> +class type_caster<std::tuple<Ts...>> : public tuple_caster<std::tuple, Ts...> +{}; + +/// Helper class which abstracts away certain actions. Users can provide specializations for +/// custom holders, but it's only necessary if the type has a non-standard interface. +template <typename T> +struct holder_helper +{ + static auto get(const T& p) -> decltype(p.get()) + { + return p.get(); + } +}; + +/// Type caster for holder types like std::shared_ptr, etc. +template <typename type, typename holder_type> +struct copyable_holder_caster : public type_caster_base<type> +{ +public: + using base = type_caster_base<type>; + static_assert(std::is_base_of<base, type_caster<type>>::value, "Holder classes are only supported for custom types"); + using base::base; + using base::cast; + using base::typeinfo; + using base::value; + + bool load(handle src, bool convert) + { + return base::template load_impl<copyable_holder_caster<type, holder_type>>(src, convert); + } + + explicit operator type*() + { + return this->value; + } + explicit operator type&() + { + return *(this->value); + } + explicit operator holder_type*() + { + return std::addressof(holder); + } + +// Workaround for Intel compiler bug +// see pybind11 issue 94 +#if defined(__ICC) || defined(__INTEL_COMPILER) + operator holder_type&() + { + return holder; + } +#else + explicit operator holder_type&() + { + return holder; + } +#endif + + static handle cast(const holder_type& src, return_value_policy, handle) + { + const auto* ptr = holder_helper<holder_type>::get(src); + return type_caster_base<type>::cast_holder(ptr, &src); + } + +protected: + friend class type_caster_generic; + void check_holder_compat() + { + if (typeinfo->default_holder) + throw cast_error("Unable to load a custom holder type from a default-holder instance"); + } + + bool load_value(value_and_holder&& v_h) + { + if (v_h.holder_constructed()) { + value = v_h.value_ptr(); + holder = v_h.template holder<holder_type>(); + return true; + } else { + throw cast_error("Unable to cast from non-held to held instance (T& to Holder<T>) " +#if defined(NDEBUG) + "(compile in debug mode for type information)"); +#else + "of type '" + + type_id<holder_type>() + "''"); +#endif + } + } + + template <typename T = holder_type, detail::enable_if_t<!std::is_constructible<T, const T&, type*>::value, int> = 0> + bool try_implicit_casts(handle, bool) + { + return false; + } + + template <typename T = holder_type, detail::enable_if_t<std::is_constructible<T, const T&, type*>::value, int> = 0> + bool try_implicit_casts(handle src, bool convert) + { + for (auto& cast : typeinfo->implicit_casts) { + copyable_holder_caster sub_caster(*cast.first); + if (sub_caster.load(src, convert)) { + value = cast.second(sub_caster.value); + holder = holder_type(sub_caster.holder, (type*)value); + return true; + } + } + return false; + } + + static bool try_direct_conversions(handle) + { + return false; + } + + + holder_type holder; +}; + +/// Specialize for the common std::shared_ptr, so users don't need to +template <typename T> +class type_caster<std::shared_ptr<T>> : public copyable_holder_caster<T, std::shared_ptr<T>> +{}; + +template <typename type, typename holder_type> +struct move_only_holder_caster +{ + static_assert(std::is_base_of<type_caster_base<type>, type_caster<type>>::value, + "Holder classes are only supported for custom types"); + + static handle cast(holder_type&& src, return_value_policy, handle) + { + auto* ptr = holder_helper<holder_type>::get(src); + return type_caster_base<type>::cast_holder(ptr, std::addressof(src)); + } + static constexpr auto name = type_caster_base<type>::name; +}; + +template <typename type, typename deleter> +class type_caster<std::unique_ptr<type, deleter>> : public move_only_holder_caster<type, std::unique_ptr<type, deleter>> +{}; + +template <typename type, typename holder_type> +using type_caster_holder = conditional_t<is_copy_constructible<holder_type>::value, + copyable_holder_caster<type, holder_type>, + move_only_holder_caster<type, holder_type>>; + +template <typename T, bool Value = false> +struct always_construct_holder +{ + static constexpr bool value = Value; +}; + +/// Create a specialization for custom holder types (silently ignores std::shared_ptr) +#define PYBIND11_DECLARE_HOLDER_TYPE(type, holder_type, ...) \ + namespace pybind11 { \ + namespace detail { \ + template <typename type> \ + struct always_construct_holder<holder_type> : always_construct_holder<void, ##__VA_ARGS__> \ + {}; \ + template <typename type> \ + class type_caster<holder_type, enable_if_t<!is_shared_ptr<holder_type>::value>> \ + : public type_caster_holder<type, holder_type> \ + {}; \ + } \ + } + +// PYBIND11_DECLARE_HOLDER_TYPE holder types: +template <typename base, typename holder> +struct is_holder_type : std::is_base_of<detail::type_caster_holder<base, holder>, detail::type_caster<holder>> +{}; +// Specialization for always-supported unique_ptr holders: +template <typename base, typename deleter> +struct is_holder_type<base, std::unique_ptr<base, deleter>> : std::true_type +{}; + +template <typename T> +struct handle_type_name +{ + static constexpr auto name = _<T>(); +}; +template <> +struct handle_type_name<bytes> +{ + static constexpr auto name = _(PYBIND11_BYTES_NAME); +}; +template <> +struct handle_type_name<args> +{ + static constexpr auto name = _("*args"); +}; +template <> +struct handle_type_name<kwargs> +{ + static constexpr auto name = _("**kwargs"); +}; + +template <typename type> +struct pyobject_caster +{ + template <typename T = type, enable_if_t<std::is_same<T, handle>::value, int> = 0> + bool load(handle src, bool /* convert */) + { + value = src; + return static_cast<bool>(value); + } + + template <typename T = type, enable_if_t<std::is_base_of<object, T>::value, int> = 0> + bool load(handle src, bool /* convert */) + { + if (!isinstance<type>(src)) + return false; + value = reinterpret_borrow<type>(src); + return true; + } + + static handle cast(const handle& src, return_value_policy /* policy */, handle /* parent */) + { + return src.inc_ref(); + } + PYBIND11_TYPE_CASTER(type, handle_type_name<type>::name); +}; + +template <typename T> +class type_caster<T, enable_if_t<is_pyobject<T>::value>> : public pyobject_caster<T> +{}; + +// Our conditions for enabling moving are quite restrictive: +// At compile time: +// - T needs to be a non-const, non-pointer, non-reference type +// - type_caster<T>::operator T&() must exist +// - the type must be move constructible (obviously) +// At run-time: +// - if the type is non-copy-constructible, the object must be the sole owner of the type (i.e. it +// must have ref_count() == 1)h +// If any of the above are not satisfied, we fall back to copying. +template <typename T> +using move_is_plain_type = satisfies_none_of<T, std::is_void, std::is_pointer, std::is_reference, std::is_const>; +template <typename T, typename SFINAE = void> +struct move_always : std::false_type +{}; +template <typename T> +struct move_always<T, + enable_if_t<all_of<move_is_plain_type<T>, + negation<is_copy_constructible<T>>, + std::is_move_constructible<T>, + std::is_same<decltype(std::declval<make_caster<T>>().operator T&()), T&>>::value>> + : std::true_type +{}; +template <typename T, typename SFINAE = void> +struct move_if_unreferenced : std::false_type +{}; +template <typename T> +struct move_if_unreferenced< + T, + enable_if_t<all_of<move_is_plain_type<T>, + negation<move_always<T>>, + std::is_move_constructible<T>, + std::is_same<decltype(std::declval<make_caster<T>>().operator T&()), T&>>::value>> + : std::true_type +{}; +template <typename T> +using move_never = none_of<move_always<T>, move_if_unreferenced<T>>; + +// Detect whether returning a `type` from a cast on type's type_caster is going to result in a +// reference or pointer to a local variable of the type_caster. Basically, only +// non-reference/pointer `type`s and reference/pointers from a type_caster_generic are safe; +// everything else returns a reference/pointer to a local variable. +template <typename type> +using cast_is_temporary_value_reference = + bool_constant<(std::is_reference<type>::value || std::is_pointer<type>::value) + && !std::is_base_of<type_caster_generic, make_caster<type>>::value + && !std::is_same<intrinsic_t<type>, void>::value>; + +// When a value returned from a C++ function is being cast back to Python, we almost always want to +// force `policy = move`, regardless of the return value policy the function/method was declared +// with. +template <typename Return, typename SFINAE = void> +struct return_value_policy_override +{ + static return_value_policy policy(return_value_policy p) + { + return p; + } +}; + +template <typename Return> +struct return_value_policy_override< + Return, + detail::enable_if_t<std::is_base_of<type_caster_generic, make_caster<Return>>::value, void>> +{ + static return_value_policy policy(return_value_policy p) + { + return !std::is_lvalue_reference<Return>::value && !std::is_pointer<Return>::value ? return_value_policy::move : p; + } +}; + +// Basic python -> C++ casting; throws if casting fails +template <typename T, typename SFINAE> +type_caster<T, SFINAE>& load_type(type_caster<T, SFINAE>& conv, const handle& handle) +{ + if (!conv.load(handle, true)) { +#if defined(NDEBUG) + throw cast_error("Unable to cast Python instance to C++ type (compile in debug mode for details)"); +#else + throw cast_error("Unable to cast Python instance of type " + (std::string)str(handle.get_type()) + " to C++ type '" + + type_id<T>() + "'"); +#endif + } + return conv; +} +// Wrapper around the above that also constructs and returns a type_caster +template <typename T> +make_caster<T> load_type(const handle& handle) +{ + make_caster<T> conv; + load_type(conv, handle); + return conv; +} + +NAMESPACE_END(detail) + +// pytype -> C++ type +template <typename T, detail::enable_if_t<!detail::is_pyobject<T>::value, int> = 0> +T cast(const handle& handle) +{ + using namespace detail; + static_assert(!cast_is_temporary_value_reference<T>::value, + "Unable to cast type to reference: value is local to type caster"); + return cast_op<T>(load_type<T>(handle)); +} + +// pytype -> pytype (calls converting constructor) +template <typename T, detail::enable_if_t<detail::is_pyobject<T>::value, int> = 0> +T cast(const handle& handle) +{ + return T(reinterpret_borrow<object>(handle)); +} + +// C++ type -> py::object +template <typename T, detail::enable_if_t<!detail::is_pyobject<T>::value, int> = 0> +object +cast(const T& value, return_value_policy policy = return_value_policy::automatic_reference, handle parent = handle()) +{ + if (policy == return_value_policy::automatic) + policy = std::is_pointer<T>::value ? return_value_policy::take_ownership : return_value_policy::copy; + else if (policy == return_value_policy::automatic_reference) + policy = std::is_pointer<T>::value ? return_value_policy::reference : return_value_policy::copy; + return reinterpret_steal<object>(detail::make_caster<T>::cast(value, policy, parent)); +} + +template <typename T> +T handle::cast() const +{ + return pybind11::cast<T>(*this); +} +template <> +inline void handle::cast() const +{ + return; +} + +template <typename T> +detail::enable_if_t<!detail::move_never<T>::value, T> move(object&& obj) +{ + if (obj.ref_count() > 1) +#if defined(NDEBUG) + throw cast_error("Unable to cast Python instance to C++ rvalue: instance has multiple references" + " (compile in debug mode for details)"); +#else + throw cast_error("Unable to move from Python " + (std::string)str(obj.get_type()) + " instance to C++ " + + type_id<T>() + " instance: instance has multiple references"); +#endif + + // Move into a temporary and return that, because the reference may be a local value of `conv` + T ret = std::move(detail::load_type<T>(obj).operator T&()); + return ret; +} + +// Calling cast() on an rvalue calls pybind::cast with the object rvalue, which does: +// - If we have to move (because T has no copy constructor), do it. This will fail if the moved +// object has multiple references, but trying to copy will fail to compile. +// - If both movable and copyable, check ref count: if 1, move; otherwise copy +// - Otherwise (not movable), copy. +template <typename T> +detail::enable_if_t<detail::move_always<T>::value, T> cast(object&& object) +{ + return move<T>(std::move(object)); +} +template <typename T> +detail::enable_if_t<detail::move_if_unreferenced<T>::value, T> cast(object&& object) +{ + if (object.ref_count() > 1) + return cast<T>(object); + else + return move<T>(std::move(object)); +} +template <typename T> +detail::enable_if_t<detail::move_never<T>::value, T> cast(object&& object) +{ + return cast<T>(object); +} + +template <typename T> +T object::cast() const& +{ + return pybind11::cast<T>(*this); +} +template <typename T> +T object::cast() && +{ + return pybind11::cast<T>(std::move(*this)); +} +template <> +inline void object::cast() const& +{ + return; +} +template <> +inline void object::cast() && +{ + return; +} + +NAMESPACE_BEGIN(detail) + +// Declared in pytypes.h: +template <typename T, enable_if_t<!is_pyobject<T>::value, int>> +object object_or_cast(T&& o) +{ + return pybind11::cast(std::forward<T>(o)); +} + +struct overload_unused +{}; // Placeholder type for the unneeded (and dead code) static variable in the OVERLOAD_INT macro +template <typename ret_type> +using overload_caster_t = + conditional_t<cast_is_temporary_value_reference<ret_type>::value, make_caster<ret_type>, overload_unused>; + +// Trampoline use: for reference/pointer types to value-converted values, we do a value cast, then +// store the result in the given variable. For other types, this is a no-op. +template <typename T> +enable_if_t<cast_is_temporary_value_reference<T>::value, T> cast_ref(object&& o, make_caster<T>& caster) +{ + return cast_op<T>(load_type(caster, o)); +} +template <typename T> +enable_if_t<!cast_is_temporary_value_reference<T>::value, T> cast_ref(object&&, overload_unused&) +{ + pybind11_fail("Internal error: cast_ref fallback invoked"); +} + +// Trampoline use: Having a pybind11::cast with an invalid reference type is going to static_assert, even +// though if it's in dead code, so we provide a "trampoline" to pybind11::cast that only does anything in +// cases where pybind11::cast is valid. +template <typename T> +enable_if_t<!cast_is_temporary_value_reference<T>::value, T> cast_safe(object&& o) +{ + return pybind11::cast<T>(std::move(o)); +} +template <typename T> +enable_if_t<cast_is_temporary_value_reference<T>::value, T> cast_safe(object&&) +{ + pybind11_fail("Internal error: cast_safe fallback invoked"); +} +template <> +inline void cast_safe<void>(object&&) +{} + +NAMESPACE_END(detail) + +template <return_value_policy policy = return_value_policy::automatic_reference> +tuple make_tuple() +{ + return tuple(0); +} + +template <return_value_policy policy = return_value_policy::automatic_reference, typename... Args> +tuple make_tuple(Args&&... args_) +{ + constexpr size_t size = sizeof...(Args); + std::array<object, size> args{ + {reinterpret_steal<object>(detail::make_caster<Args>::cast(std::forward<Args>(args_), policy, nullptr))...}}; + for (size_t i = 0; i < args.size(); i++) { + if (!args[i]) { +#if defined(NDEBUG) + throw cast_error( + "make_tuple(): unable to convert arguments to Python object (compile in debug mode for details)"); +#else + std::array<std::string, size> argtypes{{type_id<Args>()...}}; + throw cast_error("make_tuple(): unable to convert argument of type '" + argtypes[i] + "' to Python object"); +#endif + } + } + tuple result(size); + int counter = 0; + for (auto& arg_value : args) + PyTuple_SET_ITEM(result.ptr(), counter++, arg_value.release().ptr()); + return result; +} + +/// \ingroup annotations +/// Annotation for arguments +struct arg +{ + /// Constructs an argument with the name of the argument; if null or omitted, this is a positional argument. + constexpr explicit arg(const char* name = nullptr) + : name(name) + , flag_noconvert(false) + , flag_none(true) + {} + /// Assign a value to this argument + template <typename T> + arg_v operator=(T&& value) const; + /// Indicate that the type should not be converted in the type caster + arg& noconvert(bool flag = true) + { + flag_noconvert = flag; + return *this; + } + /// Indicates that the argument should/shouldn't allow None (e.g. for nullable pointer args) + arg& none(bool flag = true) + { + flag_none = flag; + return *this; + } + + const char* name; ///< If non-null, this is a named kwargs argument + bool flag_noconvert : 1; ///< If set, do not allow conversion (requires a supporting type caster!) + bool flag_none : 1; ///< If set (the default), allow None to be passed to this argument +}; + +/// \ingroup annotations +/// Annotation for arguments with values +struct arg_v : arg +{ +private: + template <typename T> + arg_v(arg&& base, T&& x, const char* descr = nullptr) + : arg(base) + , value(reinterpret_steal<object>(detail::make_caster<T>::cast(x, return_value_policy::automatic, {}))) + , descr(descr) +#if !defined(NDEBUG) + , type(type_id<T>()) +#endif + {} + +public: + /// Direct construction with name, default, and description + template <typename T> + arg_v(const char* name, T&& x, const char* descr = nullptr) + : arg_v(arg(name), std::forward<T>(x), descr) + {} + + /// Called internally when invoking `py::arg("a") = value` + template <typename T> + arg_v(const arg& base, T&& x, const char* descr = nullptr) + : arg_v(arg(base), std::forward<T>(x), descr) + {} + + /// Same as `arg::noconvert()`, but returns *this as arg_v&, not arg& + arg_v& noconvert(bool flag = true) + { + arg::noconvert(flag); + return *this; + } + + /// Same as `arg::nonone()`, but returns *this as arg_v&, not arg& + arg_v& none(bool flag = true) + { + arg::none(flag); + return *this; + } + + /// The default value + object value; + /// The (optional) description of the default value + const char* descr; +#if !defined(NDEBUG) + /// The C++ type name of the default value (only available when compiled in debug mode) + std::string type; +#endif +}; + +template <typename T> +arg_v arg::operator=(T&& value) const +{ + return {std::move(*this), std::forward<T>(value)}; +} + +/// Alias for backward compatibility -- to be removed in version 2.0 +template <typename /*unused*/> +using arg_t = arg_v; + +inline namespace literals { +/** \rst + String literal version of `arg` + \endrst */ +constexpr arg operator"" _a(const char* name, size_t) +{ + return arg(name); +} +} // namespace literals + +NAMESPACE_BEGIN(detail) + +// forward declaration (definition in attr.h) +struct function_record; + +/// Internal data associated with a single function call +struct function_call +{ + function_call(const function_record& f, handle p); // Implementation in attr.h + + /// The function data: + const function_record& func; + + /// Arguments passed to the function: + std::vector<handle> args; + + /// The `convert` value the arguments should be loaded with + std::vector<bool> args_convert; + + /// Extra references for the optional `py::args` and/or `py::kwargs` arguments (which, if + /// present, are also in `args` but without a reference). + object args_ref, kwargs_ref; + + /// The parent, if any + handle parent; + + /// If this is a call to an initializer, this argument contains `self` + handle init_self; +}; + + +/// Helper class which loads arguments for C++ functions called from Python +template <typename... Args> +class argument_loader +{ + using indices = make_index_sequence<sizeof...(Args)>; + + template <typename Arg> + using argument_is_args = std::is_same<intrinsic_t<Arg>, args>; + template <typename Arg> + using argument_is_kwargs = std::is_same<intrinsic_t<Arg>, kwargs>; + // Get args/kwargs argument positions relative to the end of the argument list: + static constexpr auto args_pos = constexpr_first<argument_is_args, Args...>() - (int)sizeof...(Args), + kwargs_pos = constexpr_first<argument_is_kwargs, Args...>() - (int)sizeof...(Args); + + static constexpr bool args_kwargs_are_last = kwargs_pos >= -1 && args_pos >= kwargs_pos - 1; + + static_assert(args_kwargs_are_last, "py::args/py::kwargs are only permitted as the last argument(s) of a function"); + +public: + static constexpr bool has_kwargs = kwargs_pos < 0; + static constexpr bool has_args = args_pos < 0; + + static constexpr auto arg_names = concat(type_descr(make_caster<Args>::name)...); + + bool load_args(function_call& call) + { + return load_impl_sequence(call, indices{}); + } + + template <typename Return, typename Guard, typename Func> + enable_if_t<!std::is_void<Return>::value, Return> call(Func&& f) && + { + return std::move(*this).template call_impl<Return>(std::forward<Func>(f), indices{}, Guard{}); + } + + template <typename Return, typename Guard, typename Func> + enable_if_t<std::is_void<Return>::value, void_type> call(Func&& f) && + { + std::move(*this).template call_impl<Return>(std::forward<Func>(f), indices{}, Guard{}); + return void_type(); + } + +private: + static bool load_impl_sequence(function_call&, index_sequence<>) + { + return true; + } + + template <size_t... Is> + bool load_impl_sequence(function_call& call, index_sequence<Is...>) + { + for (bool r : {std::get<Is>(argcasters).load(call.args[Is], call.args_convert[Is])...}) + if (!r) + return false; + return true; + } + + template <typename Return, typename Func, size_t... Is, typename Guard> + Return call_impl(Func&& f, index_sequence<Is...>, Guard&&) + { + return std::forward<Func>(f)(cast_op<Args>(std::move(std::get<Is>(argcasters)))...); + } + + std::tuple<make_caster<Args>...> argcasters; +}; + +/// Helper class which collects only positional arguments for a Python function call. +/// A fancier version below can collect any argument, but this one is optimal for simple calls. +template <return_value_policy policy> +class simple_collector +{ +public: + template <typename... Ts> + explicit simple_collector(Ts&&... values) + : m_args(pybind11::make_tuple<policy>(std::forward<Ts>(values)...)) + {} + + const tuple& args() const& + { + return m_args; + } + dict kwargs() const + { + return {}; + } + + tuple args() && + { + return std::move(m_args); + } + + /// Call a Python function and pass the collected arguments + object call(PyObject* ptr) const + { + PyObject* result = PyObject_CallObject(ptr, m_args.ptr()); + if (!result) + throw error_already_set(); + return reinterpret_steal<object>(result); + } + +private: + tuple m_args; +}; + +/// Helper class which collects positional, keyword, * and ** arguments for a Python function call +template <return_value_policy policy> +class unpacking_collector +{ +public: + template <typename... Ts> + explicit unpacking_collector(Ts&&... values) + { + // Tuples aren't (easily) resizable so a list is needed for collection, + // but the actual function call strictly requires a tuple. + auto args_list = list(); + int _[] = {0, (process(args_list, std::forward<Ts>(values)), 0)...}; + ignore_unused(_); + + m_args = std::move(args_list); + } + + const tuple& args() const& + { + return m_args; + } + const dict& kwargs() const& + { + return m_kwargs; + } + + tuple args() && + { + return std::move(m_args); + } + dict kwargs() && + { + return std::move(m_kwargs); + } + + /// Call a Python function and pass the collected arguments + object call(PyObject* ptr) const + { + PyObject* result = PyObject_Call(ptr, m_args.ptr(), m_kwargs.ptr()); + if (!result) + throw error_already_set(); + return reinterpret_steal<object>(result); + } + +private: + template <typename T> + void process(list& args_list, T&& x) + { + auto o = reinterpret_steal<object>(detail::make_caster<T>::cast(std::forward<T>(x), policy, {})); + if (!o) { +#if defined(NDEBUG) + argument_cast_error(); +#else + argument_cast_error(std::to_string(args_list.size()), type_id<T>()); +#endif + } + args_list.append(o); + } + + void process(list& args_list, detail::args_proxy ap) + { + for (const auto& a : ap) + args_list.append(a); + } + + void process(list& /*args_list*/, arg_v a) + { + if (!a.name) +#if defined(NDEBUG) + nameless_argument_error(); +#else + nameless_argument_error(a.type); +#endif + + if (m_kwargs.contains(a.name)) { +#if defined(NDEBUG) + multiple_values_error(); +#else + multiple_values_error(a.name); +#endif + } + if (!a.value) { +#if defined(NDEBUG) + argument_cast_error(); +#else + argument_cast_error(a.name, a.type); +#endif + } + m_kwargs[a.name] = a.value; + } + + void process(list& /*args_list*/, detail::kwargs_proxy kp) + { + if (!kp) + return; + for (const auto& k : reinterpret_borrow<dict>(kp)) { + if (m_kwargs.contains(k.first)) { +#if defined(NDEBUG) + multiple_values_error(); +#else + multiple_values_error(str(k.first)); +#endif + } + m_kwargs[k.first] = k.second; + } + } + + [[noreturn]] static void nameless_argument_error() + { + throw type_error("Got kwargs without a name; only named arguments " + "may be passed via py::arg() to a python function call. " + "(compile in debug mode for details)"); + } + [[noreturn]] static void nameless_argument_error(std::string type) + { + throw type_error("Got kwargs without a name of type '" + type + + "'; only named " + "arguments may be passed via py::arg() to a python function call. "); + } + [[noreturn]] static void multiple_values_error() + { + throw type_error("Got multiple values for keyword argument " + "(compile in debug mode for details)"); + } + + [[noreturn]] static void multiple_values_error(std::string name) + { + throw type_error("Got multiple values for keyword argument '" + name + "'"); + } + + [[noreturn]] static void argument_cast_error() + { + throw cast_error("Unable to convert call argument to Python object " + "(compile in debug mode for details)"); + } + + [[noreturn]] static void argument_cast_error(std::string name, std::string type) + { + throw cast_error("Unable to convert call argument '" + name + "' of type '" + type + "' to Python object"); + } + +private: + tuple m_args; + dict m_kwargs; +}; + +/// Collect only positional arguments for a Python function call +template <return_value_policy policy, typename... Args, typename = enable_if_t<all_of<is_positional<Args>...>::value>> +simple_collector<policy> collect_arguments(Args&&... args) +{ + return simple_collector<policy>(std::forward<Args>(args)...); +} + +/// Collect all arguments, including keywords and unpacking (only instantiated when needed) +template <return_value_policy policy, typename... Args, typename = enable_if_t<!all_of<is_positional<Args>...>::value>> +unpacking_collector<policy> collect_arguments(Args&&... args) +{ + // Following argument order rules for generalized unpacking according to PEP 448 + static_assert(constexpr_last<is_positional, Args...>() < constexpr_first<is_keyword_or_ds, Args...>() + && constexpr_last<is_s_unpacking, Args...>() < constexpr_first<is_ds_unpacking, Args...>(), + "Invalid function call: positional args must precede keywords and ** unpacking; " + "* unpacking must precede ** unpacking"); + return unpacking_collector<policy>(std::forward<Args>(args)...); +} + +template <typename Derived> +template <return_value_policy policy, typename... Args> +object object_api<Derived>::operator()(Args&&... args) const +{ + return detail::collect_arguments<policy>(std::forward<Args>(args)...).call(derived().ptr()); +} + +template <typename Derived> +template <return_value_policy policy, typename... Args> +object object_api<Derived>::call(Args&&... args) const +{ + return operator()<policy>(std::forward<Args>(args)...); +} + +NAMESPACE_END(detail) + +#define PYBIND11_MAKE_OPAQUE(...) \ + namespace pybind11 { \ + namespace detail { \ + template <> \ + class type_caster<__VA_ARGS__> : public type_caster_base<__VA_ARGS__> \ + {}; \ + } \ + } + +/// Lets you pass a type containing a `,` through a macro parameter without needing a separate +/// typedef, e.g.: `PYBIND11_OVERLOAD(PYBIND11_TYPE(ReturnType<A, B>), PYBIND11_TYPE(Parent<C, D>), f, arg)` +#define PYBIND11_TYPE(...) __VA_ARGS__ + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/chrono.h b/dune/pybindxi/chrono.h new file mode 100644 index 0000000000000000000000000000000000000000..df72db32f6c1dfac5f708bf794857de2f9261aa7 --- /dev/null +++ b/dune/pybindxi/chrono.h @@ -0,0 +1,187 @@ +#pragma GCC system_header +/* + pybind11/chrono.h: Transparent conversion between std::chrono and python's datetime + + Copyright (c) 2016 Trent Houliston <trent@houliston.me> and + Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include <cmath> +#include <ctime> +#include <chrono> +#include <datetime.h> + +// Backport the PyDateTime_DELTA functions from Python3.3 if required +#ifndef PyDateTime_DELTA_GET_DAYS +# define PyDateTime_DELTA_GET_DAYS(o) (((PyDateTime_Delta*)o)->days) +#endif +#ifndef PyDateTime_DELTA_GET_SECONDS +# define PyDateTime_DELTA_GET_SECONDS(o) (((PyDateTime_Delta*)o)->seconds) +#endif +#ifndef PyDateTime_DELTA_GET_MICROSECONDS +# define PyDateTime_DELTA_GET_MICROSECONDS(o) (((PyDateTime_Delta*)o)->microseconds) +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +template <typename type> +class duration_caster +{ +public: + typedef typename type::rep rep; + typedef typename type::period period; + + typedef std::chrono::duration<uint_fast32_t, std::ratio<86400>> days; + + bool load(handle src, bool) + { + using namespace std::chrono; + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { + PyDateTime_IMPORT; + } + + if (!src) + return false; + // If invoked with datetime.delta object + if (PyDelta_Check(src.ptr())) { + value = type(duration_cast<duration<rep, period>>(days(PyDateTime_DELTA_GET_DAYS(src.ptr())) + + seconds(PyDateTime_DELTA_GET_SECONDS(src.ptr())) + + microseconds(PyDateTime_DELTA_GET_MICROSECONDS(src.ptr())))); + return true; + } + // If invoked with a float we assume it is seconds and convert + else if (PyFloat_Check(src.ptr())) { + value = type(duration_cast<duration<rep, period>>(duration<double>(PyFloat_AsDouble(src.ptr())))); + return true; + } else + return false; + } + + // If this is a duration just return it back + static const std::chrono::duration<rep, period>& get_duration(const std::chrono::duration<rep, period>& src) + { + return src; + } + + // If this is a time_point get the time_since_epoch + template <typename Clock> + static std::chrono::duration<rep, period> + get_duration(const std::chrono::time_point<Clock, std::chrono::duration<rep, period>>& src) + { + return src.time_since_epoch(); + } + + static handle cast(const type& src, return_value_policy /* policy */, handle /* parent */) + { + using namespace std::chrono; + + // Use overloaded function to get our duration from our source + // Works out if it is a duration or time_point and get the duration + auto d = get_duration(src); + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { + PyDateTime_IMPORT; + } + + // Declare these special duration types so the conversions happen with the correct primitive types (int) + using dd_t = duration<int, std::ratio<86400>>; + using ss_t = duration<int, std::ratio<1>>; + using us_t = duration<int, std::micro>; + + auto dd = duration_cast<dd_t>(d); + auto subd = d - dd; + auto ss = duration_cast<ss_t>(subd); + auto us = duration_cast<us_t>(subd - ss); + return PyDelta_FromDSU(dd.count(), ss.count(), us.count()); + } + + PYBIND11_TYPE_CASTER(type, _("datetime.timedelta")); +}; + +// This is for casting times on the system clock into datetime.datetime instances +template <typename Duration> +class type_caster<std::chrono::time_point<std::chrono::system_clock, Duration>> +{ +public: + typedef std::chrono::time_point<std::chrono::system_clock, Duration> type; + bool load(handle src, bool) + { + using namespace std::chrono; + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { + PyDateTime_IMPORT; + } + + if (!src) + return false; + if (PyDateTime_Check(src.ptr())) { + std::tm cal; + cal.tm_sec = PyDateTime_DATE_GET_SECOND(src.ptr()); + cal.tm_min = PyDateTime_DATE_GET_MINUTE(src.ptr()); + cal.tm_hour = PyDateTime_DATE_GET_HOUR(src.ptr()); + cal.tm_mday = PyDateTime_GET_DAY(src.ptr()); + cal.tm_mon = PyDateTime_GET_MONTH(src.ptr()) - 1; + cal.tm_year = PyDateTime_GET_YEAR(src.ptr()) - 1900; + cal.tm_isdst = -1; + + value = system_clock::from_time_t(std::mktime(&cal)) + microseconds(PyDateTime_DATE_GET_MICROSECOND(src.ptr())); + return true; + } else + return false; + } + + static handle cast(const std::chrono::time_point<std::chrono::system_clock, Duration>& src, + return_value_policy /* policy */, + handle /* parent */) + { + using namespace std::chrono; + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { + PyDateTime_IMPORT; + } + + std::time_t tt = system_clock::to_time_t(time_point_cast<system_clock::duration>(src)); + // this function uses static memory so it's best to copy it out asap just in case + // otherwise other code that is using localtime may break this (not just python code) + std::tm localtime = *std::localtime(&tt); + + // Declare these special duration types so the conversions happen with the correct primitive types (int) + using us_t = duration<int, std::micro>; + + return PyDateTime_FromDateAndTime(localtime.tm_year + 1900, + localtime.tm_mon + 1, + localtime.tm_mday, + localtime.tm_hour, + localtime.tm_min, + localtime.tm_sec, + (duration_cast<us_t>(src.time_since_epoch() % seconds(1))).count()); + } + PYBIND11_TYPE_CASTER(type, _("datetime.datetime")); +}; + +// Other clocks that are not the system clock are not measured as datetime.datetime objects +// since they are not measured on calendar time. So instead we just make them timedeltas +// Or if they have passed us a time as a float we convert that +template <typename Clock, typename Duration> +class type_caster<std::chrono::time_point<Clock, Duration>> + : public duration_caster<std::chrono::time_point<Clock, Duration>> +{}; + +template <typename Rep, typename Period> +class type_caster<std::chrono::duration<Rep, Period>> : public duration_caster<std::chrono::duration<Rep, Period>> +{}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/common.h b/dune/pybindxi/common.h new file mode 100644 index 0000000000000000000000000000000000000000..3dfa83604d10f8cbbc7f220fec47d2986fac3df9 --- /dev/null +++ b/dune/pybindxi/common.h @@ -0,0 +1,3 @@ +#pragma GCC system_header +#include "detail/common.h" +#warning "Including 'common.h' is deprecated. It will be removed in v3.0. Use 'pybind11.h'." diff --git a/dune/pybindxi/complex.h b/dune/pybindxi/complex.h new file mode 100644 index 0000000000000000000000000000000000000000..97e839be39a1066adf07a995bd212ed8763995fb --- /dev/null +++ b/dune/pybindxi/complex.h @@ -0,0 +1,78 @@ +#pragma GCC system_header +/* + pybind11/complex.h: Complex number support + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include <complex> + +/// glibc defines I as a macro which breaks things, e.g., boost template names +#ifdef I +# undef I +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +template <typename T> +struct format_descriptor<std::complex<T>, detail::enable_if_t<std::is_floating_point<T>::value>> +{ + static constexpr const char c = format_descriptor<T>::c; + static constexpr const char value[3] = {'Z', c, '\0'}; + static std::string format() + { + return std::string(value); + } +}; + +#ifndef PYBIND11_CPP17 + +template <typename T> +constexpr const char + format_descriptor<std::complex<T>, detail::enable_if_t<std::is_floating_point<T>::value>>::value[3]; + +#endif + +NAMESPACE_BEGIN(detail) + +template <typename T> +struct is_fmt_numeric<std::complex<T>, detail::enable_if_t<std::is_floating_point<T>::value>> +{ + static constexpr bool value = true; + static constexpr int index = is_fmt_numeric<T>::index + 3; +}; + +template <typename T> +class type_caster<std::complex<T>> +{ +public: + bool load(handle src, bool convert) + { + if (!src) + return false; + if (!convert && !PyComplex_Check(src.ptr())) + return false; + Py_complex result = PyComplex_AsCComplex(src.ptr()); + if (result.real == -1.0 && PyErr_Occurred()) { + PyErr_Clear(); + return false; + } + value = std::complex<T>((T)result.real, (T)result.imag); + return true; + } + + static handle cast(const std::complex<T>& src, return_value_policy /* policy */, handle /* parent */) + { + return PyComplex_FromDoubles((double)src.real(), (double)src.imag()); + } + + PYBIND11_TYPE_CASTER(std::complex<T>, _("complex")); +}; +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/detail/class.h b/dune/pybindxi/detail/class.h new file mode 100644 index 0000000000000000000000000000000000000000..2f2945b5f3ce8b3d8488382546a1541cf86eeecf --- /dev/null +++ b/dune/pybindxi/detail/class.h @@ -0,0 +1,653 @@ +#pragma GCC system_header +/* + pybind11/detail/class.h: Python C API implementation details for py::class_ + + Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "../attr.h" +#include "../options.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +#if PY_VERSION_HEX >= 0x03030000 +# define PYBIND11_BUILTIN_QUALNAME +# define PYBIND11_SET_OLDPY_QUALNAME(obj, nameobj) +#else +// In pre-3.3 Python, we still set __qualname__ so that we can produce reliable function type +// signatures; in 3.3+ this macro expands to nothing: +# define PYBIND11_SET_OLDPY_QUALNAME(obj, nameobj) setattr((PyObject*)obj, "__qualname__", nameobj) +#endif + +inline PyTypeObject* type_incref(PyTypeObject* type) +{ + Py_INCREF(type); + return type; +} + +#if !defined(PYPY_VERSION) + +/// `pybind11_static_property.__get__()`: Always pass the class instead of the instance. +extern "C" inline PyObject* pybind11_static_get(PyObject* self, PyObject* /*ob*/, PyObject* cls) +{ + return PyProperty_Type.tp_descr_get(self, cls, cls); +} + +/// `pybind11_static_property.__set__()`: Just like the above `__get__()`. +extern "C" inline int pybind11_static_set(PyObject* self, PyObject* obj, PyObject* value) +{ + PyObject* cls = PyType_Check(obj) ? obj : (PyObject*)Py_TYPE(obj); + return PyProperty_Type.tp_descr_set(self, cls, value); +} + +/** A `static_property` is the same as a `property` but the `__get__()` and `__set__()` + methods are modified to always use the object type instead of a concrete instance. + Return value: New reference. */ +inline PyTypeObject* make_static_property_type() +{ + constexpr auto* name = "pybind11_static_property"; + auto name_obj = reinterpret_steal<object>(PYBIND11_FROM_STRING(name)); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto heap_type = (PyHeapTypeObject*)PyType_Type.tp_alloc(&PyType_Type, 0); + if (!heap_type) + pybind11_fail("make_static_property_type(): error allocating type!"); + + heap_type->ht_name = name_obj.inc_ref().ptr(); +# ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = name_obj.inc_ref().ptr(); +# endif + + auto type = &heap_type->ht_type; + type->tp_name = name; + type->tp_base = type_incref(&PyProperty_Type); + type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; + type->tp_descr_get = pybind11_static_get; + type->tp_descr_set = pybind11_static_set; + + if (PyType_Ready(type) < 0) + pybind11_fail("make_static_property_type(): failure in PyType_Ready()!"); + + setattr((PyObject*)type, "__module__", str("pybind11_builtins")); + PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); + + return type; +} + +#else // PYPY + +/** PyPy has some issues with the above C API, so we evaluate Python code instead. + This function will only be called once so performance isn't really a concern. + Return value: New reference. */ +inline PyTypeObject* make_static_property_type() +{ + auto d = dict(); + PyObject* result = PyRun_String(R"(\ + class pybind11_static_property(property): + def __get__(self, obj, cls): + return property.__get__(self, cls, cls) + + def __set__(self, obj, value): + cls = obj if isinstance(obj, type) else type(obj) + property.__set__(self, cls, value) + )", + Py_file_input, + d.ptr(), + d.ptr()); + if (result == nullptr) + throw error_already_set(); + Py_DECREF(result); + return (PyTypeObject*)d["pybind11_static_property"].cast<object>().release().ptr(); +} + +#endif // PYPY + +/** Types with static properties need to handle `Type.static_prop = x` in a specific way. + By default, Python replaces the `static_property` itself, but for wrapped C++ types + we need to call `static_property.__set__()` in order to propagate the new value to + the underlying C++ data structure. */ +extern "C" inline int pybind11_meta_setattro(PyObject* obj, PyObject* name, PyObject* value) +{ + // Use `_PyType_Lookup()` instead of `PyObject_GetAttr()` in order to get the raw + // descriptor (`property`) instead of calling `tp_descr_get` (`property.__get__()`). + PyObject* descr = _PyType_Lookup((PyTypeObject*)obj, name); + + // The following assignment combinations are possible: + // 1. `Type.static_prop = value` --> descr_set: `Type.static_prop.__set__(value)` + // 2. `Type.static_prop = other_static_prop` --> setattro: replace existing `static_prop` + // 3. `Type.regular_attribute = value` --> setattro: regular attribute assignment + const auto static_prop = (PyObject*)get_internals().static_property_type; + const auto call_descr_set = + descr && PyObject_IsInstance(descr, static_prop) && !PyObject_IsInstance(value, static_prop); + if (call_descr_set) { + // Call `static_property.__set__()` instead of replacing the `static_property`. +#if !defined(PYPY_VERSION) + return Py_TYPE(descr)->tp_descr_set(descr, obj, value); +#else + if (PyObject* result = PyObject_CallMethod(descr, "__set__", "OO", obj, value)) { + Py_DECREF(result); + return 0; + } else { + return -1; + } +#endif + } else { + // Replace existing attribute. + return PyType_Type.tp_setattro(obj, name, value); + } +} + +#if PY_MAJOR_VERSION >= 3 +/** + * Python 3's PyInstanceMethod_Type hides itself via its tp_descr_get, which prevents aliasing + * methods via cls.attr("m2") = cls.attr("m1"): instead the tp_descr_get returns a plain function, + * when called on a class, or a PyMethod, when called on an instance. Override that behaviour here + * to do a special case bypass for PyInstanceMethod_Types. + */ +extern "C" inline PyObject* pybind11_meta_getattro(PyObject* obj, PyObject* name) +{ + PyObject* descr = _PyType_Lookup((PyTypeObject*)obj, name); + if (descr && PyInstanceMethod_Check(descr)) { + Py_INCREF(descr); + return descr; + } else { + return PyType_Type.tp_getattro(obj, name); + } +} +#endif + +/** This metaclass is assigned by default to all pybind11 types and is required in order + for static properties to function correctly. Users may override this using `py::metaclass`. + Return value: New reference. */ +inline PyTypeObject* make_default_metaclass() +{ + constexpr auto* name = "pybind11_type"; + auto name_obj = reinterpret_steal<object>(PYBIND11_FROM_STRING(name)); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto heap_type = (PyHeapTypeObject*)PyType_Type.tp_alloc(&PyType_Type, 0); + if (!heap_type) + pybind11_fail("make_default_metaclass(): error allocating metaclass!"); + + heap_type->ht_name = name_obj.inc_ref().ptr(); +#ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = name_obj.inc_ref().ptr(); +#endif + + auto type = &heap_type->ht_type; + type->tp_name = name; + type->tp_base = type_incref(&PyType_Type); + type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; + + type->tp_setattro = pybind11_meta_setattro; +#if PY_MAJOR_VERSION >= 3 + type->tp_getattro = pybind11_meta_getattro; +#endif + + if (PyType_Ready(type) < 0) + pybind11_fail("make_default_metaclass(): failure in PyType_Ready()!"); + + setattr((PyObject*)type, "__module__", str("pybind11_builtins")); + PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); + + return type; +} + +/// For multiple inheritance types we need to recursively register/deregister base pointers for any +/// base classes with pointers that are difference from the instance value pointer so that we can +/// correctly recognize an offset base class pointer. This calls a function with any offset base ptrs. +inline void traverse_offset_bases(void* valueptr, + const detail::type_info* tinfo, + instance* self, + bool (*f)(void* /*parentptr*/, instance* /*self*/)) +{ + for (handle h : reinterpret_borrow<tuple>(tinfo->type->tp_bases)) { + if (auto parent_tinfo = get_type_info((PyTypeObject*)h.ptr())) { + for (auto& c : parent_tinfo->implicit_casts) { + if (c.first == tinfo->cpptype) { + auto* parentptr = c.second(valueptr); + if (parentptr != valueptr) + f(parentptr, self); + traverse_offset_bases(parentptr, parent_tinfo, self, f); + break; + } + } + } + } +} + +inline bool register_instance_impl(void* ptr, instance* self) +{ + get_internals().registered_instances.emplace(ptr, self); + return true; // unused, but gives the same signature as the deregister func +} +inline bool deregister_instance_impl(void* ptr, instance* self) +{ + auto& registered_instances = get_internals().registered_instances; + auto range = registered_instances.equal_range(ptr); + for (auto it = range.first; it != range.second; ++it) { + if (Py_TYPE(self) == Py_TYPE(it->second)) { + registered_instances.erase(it); + return true; + } + } + return false; +} + +inline void register_instance(instance* self, void* valptr, const type_info* tinfo) +{ + register_instance_impl(valptr, self); + if (!tinfo->simple_ancestors) + traverse_offset_bases(valptr, tinfo, self, register_instance_impl); +} + +inline bool deregister_instance(instance* self, void* valptr, const type_info* tinfo) +{ + bool ret = deregister_instance_impl(valptr, self); + if (!tinfo->simple_ancestors) + traverse_offset_bases(valptr, tinfo, self, deregister_instance_impl); + return ret; +} + +/// Instance creation function for all pybind11 types. It allocates the internal instance layout for +/// holding C++ objects and holders. Allocation is done lazily (the first time the instance is cast +/// to a reference or pointer), and initialization is done by an `__init__` function. +inline PyObject* make_new_instance(PyTypeObject* type) +{ +#if defined(PYPY_VERSION) + // PyPy gets tp_basicsize wrong (issue 2482) under multiple inheritance when the first inherited + // object is a a plain Python type (i.e. not derived from an extension type). Fix it. + ssize_t instance_size = static_cast<ssize_t>(sizeof(instance)); + if (type->tp_basicsize < instance_size) { + type->tp_basicsize = instance_size; + } +#endif + PyObject* self = type->tp_alloc(type, 0); + auto inst = reinterpret_cast<instance*>(self); + // Allocate the value/holder internals: + inst->allocate_layout(); + + inst->owned = true; + + return self; +} + +/// Instance creation function for all pybind11 types. It only allocates space for the +/// C++ object, but doesn't call the constructor -- an `__init__` function must do that. +extern "C" inline PyObject* pybind11_object_new(PyTypeObject* type, PyObject*, PyObject*) +{ + return make_new_instance(type); +} + +/// An `__init__` function constructs the C++ object. Users should provide at least one +/// of these using `py::init` or directly with `.def(__init__, ...)`. Otherwise, the +/// following default function will be used which simply throws an exception. +extern "C" inline int pybind11_object_init(PyObject* self, PyObject*, PyObject*) +{ + PyTypeObject* type = Py_TYPE(self); + std::string msg; +#if defined(PYPY_VERSION) + msg += handle((PyObject*)type).attr("__module__").cast<std::string>() + "."; +#endif + msg += type->tp_name; + msg += ": No constructor defined!"; + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return -1; +} + +inline void add_patient(PyObject* nurse, PyObject* patient) +{ + auto& internals = get_internals(); + auto instance = reinterpret_cast<detail::instance*>(nurse); + instance->has_patients = true; + Py_INCREF(patient); + internals.patients[nurse].push_back(patient); +} + +inline void clear_patients(PyObject* self) +{ + auto instance = reinterpret_cast<detail::instance*>(self); + auto& internals = get_internals(); + auto pos = internals.patients.find(self); + assert(pos != internals.patients.end()); + // Clearing the patients can cause more Python code to run, which + // can invalidate the iterator. Extract the vector of patients + // from the unordered_map first. + auto patients = std::move(pos->second); + internals.patients.erase(pos); + instance->has_patients = false; + for (PyObject*& patient : patients) + Py_CLEAR(patient); +} + +/// Clears all internal data from the instance and removes it from registered instances in +/// preparation for deallocation. +inline void clear_instance(PyObject* self) +{ + auto instance = reinterpret_cast<detail::instance*>(self); + + // Deallocate any values/holders, if present: + for (auto& v_h : values_and_holders(instance)) { + if (v_h) { + + // We have to deregister before we call dealloc because, for virtual MI types, we still + // need to be able to get the parent pointers. + if (v_h.instance_registered() && !deregister_instance(instance, v_h.value_ptr(), v_h.type)) + pybind11_fail("pybind11_object_dealloc(): Tried to deallocate unregistered instance!"); + + if (instance->owned || v_h.holder_constructed()) + v_h.type->dealloc(v_h); + } + } + // Deallocate the value/holder layout internals: + instance->deallocate_layout(); + + if (instance->weakrefs) + PyObject_ClearWeakRefs(self); + + PyObject** dict_ptr = _PyObject_GetDictPtr(self); + if (dict_ptr) + Py_CLEAR(*dict_ptr); + + if (instance->has_patients) + clear_patients(self); +} + +/// Instance destructor function for all pybind11 types. It calls `type_info.dealloc` +/// to destroy the C++ object itself, while the rest is Python bookkeeping. +extern "C" inline void pybind11_object_dealloc(PyObject* self) +{ + clear_instance(self); + + auto type = Py_TYPE(self); + type->tp_free(self); + + // `type->tp_dealloc != pybind11_object_dealloc` means that we're being called + // as part of a derived type's dealloc, in which case we're not allowed to decref + // the type here. For cross-module compatibility, we shouldn't compare directly + // with `pybind11_object_dealloc`, but with the common one stashed in internals. + auto pybind11_object_type = (PyTypeObject*)get_internals().instance_base; + if (type->tp_dealloc == pybind11_object_type->tp_dealloc) + Py_DECREF(type); +} + +/** Create the type which can be used as a common base for all classes. This is + needed in order to satisfy Python's requirements for multiple inheritance. + Return value: New reference. */ +inline PyObject* make_object_base_type(PyTypeObject* metaclass) +{ + constexpr auto* name = "pybind11_object"; + auto name_obj = reinterpret_steal<object>(PYBIND11_FROM_STRING(name)); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto heap_type = (PyHeapTypeObject*)metaclass->tp_alloc(metaclass, 0); + if (!heap_type) + pybind11_fail("make_object_base_type(): error allocating type!"); + + heap_type->ht_name = name_obj.inc_ref().ptr(); +#ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = name_obj.inc_ref().ptr(); +#endif + + auto type = &heap_type->ht_type; + type->tp_name = name; + type->tp_base = type_incref(&PyBaseObject_Type); + type->tp_basicsize = static_cast<ssize_t>(sizeof(instance)); + type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; + + type->tp_new = pybind11_object_new; + type->tp_init = pybind11_object_init; + type->tp_dealloc = pybind11_object_dealloc; + + /* Support weak references (needed for the keep_alive feature) */ + type->tp_weaklistoffset = offsetof(instance, weakrefs); + + if (PyType_Ready(type) < 0) + pybind11_fail("PyType_Ready failed in make_object_base_type():" + error_string()); + + setattr((PyObject*)type, "__module__", str("pybind11_builtins")); + PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); + + assert(!PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC)); + return (PyObject*)heap_type; +} + +/// dynamic_attr: Support for `d = instance.__dict__`. +extern "C" inline PyObject* pybind11_get_dict(PyObject* self, void*) +{ + PyObject*& dict = *_PyObject_GetDictPtr(self); + if (!dict) + dict = PyDict_New(); + Py_XINCREF(dict); + return dict; +} + +/// dynamic_attr: Support for `instance.__dict__ = dict()`. +extern "C" inline int pybind11_set_dict(PyObject* self, PyObject* new_dict, void*) +{ + if (!PyDict_Check(new_dict)) { + PyErr_Format(PyExc_TypeError, "__dict__ must be set to a dictionary, not a '%.200s'", Py_TYPE(new_dict)->tp_name); + return -1; + } + PyObject*& dict = *_PyObject_GetDictPtr(self); + Py_INCREF(new_dict); + Py_CLEAR(dict); + dict = new_dict; + return 0; +} + +/// dynamic_attr: Allow the garbage collector to traverse the internal instance `__dict__`. +extern "C" inline int pybind11_traverse(PyObject* self, visitproc visit, void* arg) +{ + PyObject*& dict = *_PyObject_GetDictPtr(self); + Py_VISIT(dict); + return 0; +} + +/// dynamic_attr: Allow the GC to clear the dictionary. +extern "C" inline int pybind11_clear(PyObject* self) +{ + PyObject*& dict = *_PyObject_GetDictPtr(self); + Py_CLEAR(dict); + return 0; +} + +/// Give instances of this type a `__dict__` and opt into garbage collection. +inline void enable_dynamic_attributes(PyHeapTypeObject* heap_type) +{ + auto type = &heap_type->ht_type; +#if defined(PYPY_VERSION) + pybind11_fail(std::string(type->tp_name) + + ": dynamic attributes are " + "currently not supported in " + "conjunction with PyPy!"); +#endif + type->tp_flags |= Py_TPFLAGS_HAVE_GC; + type->tp_dictoffset = type->tp_basicsize; // place dict at the end + type->tp_basicsize += (ssize_t)sizeof(PyObject*); // and allocate enough space for it + type->tp_traverse = pybind11_traverse; + type->tp_clear = pybind11_clear; + + static PyGetSetDef getset[] = { + {const_cast<char*>("__dict__"), pybind11_get_dict, pybind11_set_dict, nullptr, nullptr}, + {nullptr, nullptr, nullptr, nullptr, nullptr}}; + type->tp_getset = getset; +} + +/// buffer_protocol: Fill in the view as specified by flags. +extern "C" inline int pybind11_getbuffer(PyObject* obj, Py_buffer* view, int flags) +{ + // Look for a `get_buffer` implementation in this type's info or any bases (following MRO). + type_info* tinfo = nullptr; + for (auto type : reinterpret_borrow<tuple>(Py_TYPE(obj)->tp_mro)) { + tinfo = get_type_info((PyTypeObject*)type.ptr()); + if (tinfo && tinfo->get_buffer) + break; + } + if (view == nullptr || !tinfo || !tinfo->get_buffer) { + if (view) + view->obj = nullptr; + PyErr_SetString(PyExc_BufferError, "pybind11_getbuffer(): Internal error"); + return -1; + } + std::memset(view, 0, sizeof(Py_buffer)); + buffer_info* info = tinfo->get_buffer(obj, tinfo->get_buffer_data); + view->obj = obj; + view->ndim = 1; + view->internal = info; + view->buf = info->ptr; + view->itemsize = info->itemsize; + view->len = view->itemsize; + for (auto s : info->shape) + view->len *= s; + if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT) + view->format = const_cast<char*>(info->format.c_str()); + if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES) { + view->ndim = (int)info->ndim; + view->strides = &info->strides[0]; + view->shape = &info->shape[0]; + } + Py_INCREF(view->obj); + return 0; +} + +/// buffer_protocol: Release the resources of the buffer. +extern "C" inline void pybind11_releasebuffer(PyObject*, Py_buffer* view) +{ + delete (buffer_info*)view->internal; +} + +/// Give this type a buffer interface. +inline void enable_buffer_protocol(PyHeapTypeObject* heap_type) +{ + heap_type->ht_type.tp_as_buffer = &heap_type->as_buffer; +#if PY_MAJOR_VERSION < 3 + heap_type->ht_type.tp_flags |= Py_TPFLAGS_HAVE_NEWBUFFER; +#endif + + heap_type->as_buffer.bf_getbuffer = pybind11_getbuffer; + heap_type->as_buffer.bf_releasebuffer = pybind11_releasebuffer; +} + +/** Create a brand new Python type according to the `type_record` specification. + Return value: New reference. */ +inline PyObject* make_new_python_type(const type_record& rec) +{ + auto name = reinterpret_steal<object>(PYBIND11_FROM_STRING(rec.name)); + + auto qualname = name; + if (rec.scope && !PyModule_Check(rec.scope.ptr()) && hasattr(rec.scope, "__qualname__")) { +#if PY_MAJOR_VERSION >= 3 + qualname = + reinterpret_steal<object>(PyUnicode_FromFormat("%U.%U", rec.scope.attr("__qualname__").ptr(), name.ptr())); +#else + qualname = str(rec.scope.attr("__qualname__").cast<std::string>() + "." + rec.name); +#endif + } + + object module; + if (rec.scope) { + if (hasattr(rec.scope, "__module__")) + module = rec.scope.attr("__module__"); + else if (hasattr(rec.scope, "__name__")) + module = rec.scope.attr("__name__"); + } + + auto full_name = c_str( +#if !defined(PYPY_VERSION) + module ? str(module).cast<std::string>() + "." + rec.name : +#endif + rec.name); + + char* tp_doc = nullptr; + if (rec.doc && options::show_user_defined_docstrings()) { + /* Allocate memory for docstring (using PyObject_MALLOC, since + Python will free this later on) */ + size_t size = strlen(rec.doc) + 1; + tp_doc = (char*)PyObject_MALLOC(size); + memcpy((void*)tp_doc, rec.doc, size); + } + + auto& internals = get_internals(); + auto bases = tuple(rec.bases); + auto base = (bases.size() == 0) ? internals.instance_base : bases[0].ptr(); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto metaclass = rec.metaclass.ptr() ? (PyTypeObject*)rec.metaclass.ptr() : internals.default_metaclass; + + auto heap_type = (PyHeapTypeObject*)metaclass->tp_alloc(metaclass, 0); + if (!heap_type) + pybind11_fail(std::string(rec.name) + ": Unable to create type object!"); + + heap_type->ht_name = name.release().ptr(); +#ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = qualname.inc_ref().ptr(); +#endif + + auto type = &heap_type->ht_type; + type->tp_name = full_name; + type->tp_doc = tp_doc; + type->tp_base = type_incref((PyTypeObject*)base); + type->tp_basicsize = static_cast<ssize_t>(sizeof(instance)); + if (bases.size() > 0) + type->tp_bases = bases.release().ptr(); + + /* Don't inherit base __init__ */ + type->tp_init = pybind11_object_init; + + /* Supported protocols */ + type->tp_as_number = &heap_type->as_number; + type->tp_as_sequence = &heap_type->as_sequence; + type->tp_as_mapping = &heap_type->as_mapping; + + /* Flags */ + type->tp_flags |= Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; +#if PY_MAJOR_VERSION < 3 + type->tp_flags |= Py_TPFLAGS_CHECKTYPES; +#endif + + if (rec.dynamic_attr) + enable_dynamic_attributes(heap_type); + + if (rec.buffer_protocol) + enable_buffer_protocol(heap_type); + + if (PyType_Ready(type) < 0) + pybind11_fail(std::string(rec.name) + ": PyType_Ready failed (" + error_string() + ")!"); + + assert(rec.dynamic_attr ? PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC) : !PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC)); + + /* Register type with the parent scope */ + if (rec.scope) + setattr(rec.scope, rec.name, (PyObject*)type); + else + Py_INCREF(type); // Keep it alive forever (reference leak) + + if (module) // Needed by pydoc + setattr((PyObject*)type, "__module__", module); + + PYBIND11_SET_OLDPY_QUALNAME(type, qualname); + + return (PyObject*)type; +} + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/detail/common.h b/dune/pybindxi/detail/common.h new file mode 100644 index 0000000000000000000000000000000000000000..ed9476d97bb2372026bbbfcad2a5d6211d2c67c5 --- /dev/null +++ b/dune/pybindxi/detail/common.h @@ -0,0 +1,1045 @@ +#pragma GCC system_header +/* + pybind11/detail/common.h -- Basic macros + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#if !defined(NAMESPACE_BEGIN) +# define NAMESPACE_BEGIN(name) namespace name { +#endif +#if !defined(NAMESPACE_END) +# define NAMESPACE_END(name) } +#endif + +// Robust support for some features and loading modules compiled against different pybind versions +// requires forcing hidden visibility on pybind code, so we enforce this by setting the attribute on +// the main `pybind11` namespace. +#if !defined(PYBIND11_NAMESPACE) +# ifdef __GNUG__ +# define PYBIND11_NAMESPACE pybind11 __attribute__((visibility("hidden"))) +# else +# define PYBIND11_NAMESPACE pybind11 +# endif +#endif + +#if !(defined(_MSC_VER) && __cplusplus == 199711L) && !defined(__INTEL_COMPILER) +# if __cplusplus >= 201402L +# define PYBIND11_CPP14 +# if __cplusplus >= 201703L +# define PYBIND11_CPP17 +# endif +# endif +#elif defined(_MSC_VER) && __cplusplus == 199711L +// MSVC sets _MSVC_LANG rather than __cplusplus (supposedly until the standard is fully implemented) +// Unless you use the /Zc:__cplusplus flag on Visual Studio 2017 15.7 Preview 3 or newer +# if _MSVC_LANG >= 201402L +# define PYBIND11_CPP14 +# if _MSVC_LANG > 201402L && _MSC_VER >= 1910 +# define PYBIND11_CPP17 +# endif +# endif +#endif + +// Compiler version assertions +#if defined(__INTEL_COMPILER) +# if __INTEL_COMPILER < 1700 +# error pybind11 requires Intel C++ compiler v17 or newer +# endif +#elif defined(__clang__) && !defined(__apple_build_version__) +# if __clang_major__ < 3 || (__clang_major__ == 3 && __clang_minor__ < 3) +# error pybind11 requires clang 3.3 or newer +# endif +#elif defined(__clang__) +// Apple changes clang version macros to its Xcode version; the first Xcode release based on +// (upstream) clang 3.3 was Xcode 5: +# if __clang_major__ < 5 +# error pybind11 requires Xcode/clang 5.0 or newer +# endif +#elif defined(__GNUG__) +# if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 8) +# error pybind11 requires gcc 4.8 or newer +# endif +#elif defined(_MSC_VER) +// Pybind hits various compiler bugs in 2015u2 and earlier, and also makes use of some stl features +// (e.g. std::negation) added in 2015u3: +# if _MSC_FULL_VER < 190024210 +# error pybind11 requires MSVC 2015 update 3 or newer +# endif +#endif + +#if !defined(PYBIND11_EXPORT) +# if defined(WIN32) || defined(_WIN32) +# define PYBIND11_EXPORT __declspec(dllexport) +# else +# define PYBIND11_EXPORT __attribute__((visibility("default"))) +# endif +#endif + +#if defined(_MSC_VER) +# define PYBIND11_NOINLINE __declspec(noinline) +#else +# define PYBIND11_NOINLINE __attribute__((noinline)) +#endif + +#if defined(PYBIND11_CPP14) +# define PYBIND11_DEPRECATED(reason) [[deprecated(reason)]] +#else +# define PYBIND11_DEPRECATED(reason) __attribute__((deprecated(reason))) +#endif + +#define PYBIND11_VERSION_MAJOR 2 +#define PYBIND11_VERSION_MINOR 3 +#define PYBIND11_VERSION_PATCH dev1 + +/// Include Python header, disable linking to pythonX_d.lib on Windows in debug mode +#if defined(_MSC_VER) +# if (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION < 4) +# define HAVE_ROUND 1 +# endif +# pragma warning(push) +# pragma warning(disable : 4510 4610 4512 4005) +# if defined(_DEBUG) +# define PYBIND11_DEBUG_MARKER +# undef _DEBUG +# endif +#endif + +#include <Python.h> +#include <frameobject.h> +#include <pythread.h> + +#if defined(_WIN32) && (defined(min) || defined(max)) +# error Macro clash with min and max -- define NOMINMAX when compiling your program on Windows +#endif + +#if defined(isalnum) +# undef isalnum +# undef isalpha +# undef islower +# undef isspace +# undef isupper +# undef tolower +# undef toupper +#endif + +#if defined(_MSC_VER) +# if defined(PYBIND11_DEBUG_MARKER) +# define _DEBUG +# undef PYBIND11_DEBUG_MARKER +# endif +# pragma warning(pop) +#endif + +#include <cstddef> +#include <cstring> +#include <forward_list> +#include <vector> +#include <string> +#include <stdexcept> +#include <unordered_set> +#include <unordered_map> +#include <memory> +#include <typeindex> +#include <type_traits> + +#if PY_MAJOR_VERSION >= 3 /// Compatibility macros for various Python versions +# define PYBIND11_INSTANCE_METHOD_NEW(ptr, class_) PyInstanceMethod_New(ptr) +# define PYBIND11_INSTANCE_METHOD_CHECK PyInstanceMethod_Check +# define PYBIND11_INSTANCE_METHOD_GET_FUNCTION PyInstanceMethod_GET_FUNCTION +# define PYBIND11_BYTES_CHECK PyBytes_Check +# define PYBIND11_BYTES_FROM_STRING PyBytes_FromString +# define PYBIND11_BYTES_FROM_STRING_AND_SIZE PyBytes_FromStringAndSize +# define PYBIND11_BYTES_AS_STRING_AND_SIZE PyBytes_AsStringAndSize +# define PYBIND11_BYTES_AS_STRING PyBytes_AsString +# define PYBIND11_BYTES_SIZE PyBytes_Size +# define PYBIND11_LONG_CHECK(o) PyLong_Check(o) +# define PYBIND11_LONG_AS_LONGLONG(o) PyLong_AsLongLong(o) +# define PYBIND11_LONG_FROM_SIGNED(o) PyLong_FromSsize_t((ssize_t)o) +# define PYBIND11_LONG_FROM_UNSIGNED(o) PyLong_FromSize_t((size_t)o) +# define PYBIND11_BYTES_NAME "bytes" +# define PYBIND11_STRING_NAME "str" +# define PYBIND11_SLICE_OBJECT PyObject +# define PYBIND11_FROM_STRING PyUnicode_FromString +# define PYBIND11_STR_TYPE ::pybind11::str +# define PYBIND11_BOOL_ATTR "__bool__" +# define PYBIND11_NB_BOOL(ptr) ((ptr)->nb_bool) +# define PYBIND11_PLUGIN_IMPL(name) extern "C" PYBIND11_EXPORT PyObject* PyInit_##name() + +#else +# define PYBIND11_INSTANCE_METHOD_NEW(ptr, class_) PyMethod_New(ptr, nullptr, class_) +# define PYBIND11_INSTANCE_METHOD_CHECK PyMethod_Check +# define PYBIND11_INSTANCE_METHOD_GET_FUNCTION PyMethod_GET_FUNCTION +# define PYBIND11_BYTES_CHECK PyString_Check +# define PYBIND11_BYTES_FROM_STRING PyString_FromString +# define PYBIND11_BYTES_FROM_STRING_AND_SIZE PyString_FromStringAndSize +# define PYBIND11_BYTES_AS_STRING_AND_SIZE PyString_AsStringAndSize +# define PYBIND11_BYTES_AS_STRING PyString_AsString +# define PYBIND11_BYTES_SIZE PyString_Size +# define PYBIND11_LONG_CHECK(o) (PyInt_Check(o) || PyLong_Check(o)) +# define PYBIND11_LONG_AS_LONGLONG(o) (PyInt_Check(o) ? (long long)PyLong_AsLong(o) : PyLong_AsLongLong(o)) +# define PYBIND11_LONG_FROM_SIGNED(o) PyInt_FromSsize_t((ssize_t)o) // Returns long if needed. +# define PYBIND11_LONG_FROM_UNSIGNED(o) PyInt_FromSize_t((size_t)o) // Returns long if needed. +# define PYBIND11_BYTES_NAME "str" +# define PYBIND11_STRING_NAME "unicode" +# define PYBIND11_SLICE_OBJECT PySliceObject +# define PYBIND11_FROM_STRING PyString_FromString +# define PYBIND11_STR_TYPE ::pybind11::bytes +# define PYBIND11_BOOL_ATTR "__nonzero__" +# define PYBIND11_NB_BOOL(ptr) ((ptr)->nb_nonzero) +# define PYBIND11_PLUGIN_IMPL(name) \ + static PyObject* pybind11_init_wrapper(); \ + extern "C" PYBIND11_EXPORT void init##name() \ + { \ + (void)pybind11_init_wrapper(); \ + } \ + PyObject* pybind11_init_wrapper() +#endif + +#if PY_VERSION_HEX >= 0x03050000 && PY_VERSION_HEX < 0x03050200 +extern "C" +{ + struct _Py_atomic_address + { + void* value; + }; + PyAPI_DATA(_Py_atomic_address) _PyThreadState_Current; +} +#endif + +#define PYBIND11_TRY_NEXT_OVERLOAD ((PyObject*)1) // special failure return code +#define PYBIND11_STRINGIFY(x) #x +#define PYBIND11_TOSTRING(x) PYBIND11_STRINGIFY(x) +#define PYBIND11_CONCAT(first, second) first##second + +#define PYBIND11_CHECK_PYTHON_VERSION \ + { \ + const char* compiled_ver = PYBIND11_TOSTRING(PY_MAJOR_VERSION) "." PYBIND11_TOSTRING(PY_MINOR_VERSION); \ + const char* runtime_ver = Py_GetVersion(); \ + size_t len = std::strlen(compiled_ver); \ + if (std::strncmp(runtime_ver, compiled_ver, len) != 0 || (runtime_ver[len] >= '0' && runtime_ver[len] <= '9')) { \ + PyErr_Format(PyExc_ImportError, \ + "Python version mismatch: module was compiled for Python %s, " \ + "but the interpreter version is incompatible: %s.", \ + compiled_ver, \ + runtime_ver); \ + return nullptr; \ + } \ + } + +#define PYBIND11_CATCH_INIT_EXCEPTIONS \ + catch (pybind11::error_already_set & e) \ + { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } \ + catch (const std::exception& e) \ + { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } + +/** \rst + ***Deprecated in favor of PYBIND11_MODULE*** + + This macro creates the entry point that will be invoked when the Python interpreter + imports a plugin library. Please create a `module` in the function body and return + the pointer to its underlying Python object at the end. + + .. code-block:: cpp + + PYBIND11_PLUGIN(example) { + pybind11::module m("example", "pybind11 example plugin"); + /// Set up bindings here + return m.ptr(); + } +\endrst */ +#define PYBIND11_PLUGIN(name) \ + PYBIND11_DEPRECATED("PYBIND11_PLUGIN is deprecated, use PYBIND11_MODULE") \ + static PyObject* pybind11_init(); \ + PYBIND11_PLUGIN_IMPL(name) \ + { \ + PYBIND11_CHECK_PYTHON_VERSION \ + try { \ + return pybind11_init(); \ + } \ + PYBIND11_CATCH_INIT_EXCEPTIONS \ + } \ + PyObject* pybind11_init() + +/** \rst + This macro creates the entry point that will be invoked when the Python interpreter + imports an extension module. The module name is given as the fist argument and it + should not be in quotes. The second macro argument defines a variable of type + `py::module` which can be used to initialize the module. + + .. code-block:: cpp + + PYBIND11_MODULE(example, m) { + m.doc() = "pybind11 example module"; + + // Add bindings here + m.def("foo", []() { + return "Hello, World!"; + }); + } +\endrst */ +#define PYBIND11_MODULE(name, variable) \ + static void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module&); \ + PYBIND11_PLUGIN_IMPL(name) \ + { \ + PYBIND11_CHECK_PYTHON_VERSION \ + auto m = pybind11::module(PYBIND11_TOSTRING(name)); \ + try { \ + PYBIND11_CONCAT(pybind11_init_, name)(m); \ + return m.ptr(); \ + } \ + PYBIND11_CATCH_INIT_EXCEPTIONS \ + } \ + void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module & variable) + + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +using ssize_t = Py_ssize_t; +using size_t = std::size_t; + +/// Approach used to cast a previously unknown C++ instance into a Python object +enum class return_value_policy : uint8_t +{ + /** This is the default return value policy, which falls back to the policy + return_value_policy::take_ownership when the return value is a pointer. + Otherwise, it uses return_value::move or return_value::copy for rvalue + and lvalue references, respectively. See below for a description of what + all of these different policies do. */ + automatic = 0, + + /** As above, but use policy return_value_policy::reference when the return + value is a pointer. This is the default conversion policy for function + arguments when calling Python functions manually from C++ code (i.e. via + handle::operator()). You probably won't need to use this. */ + automatic_reference, + + /** Reference an existing object (i.e. do not create a new copy) and take + ownership. Python will call the destructor and delete operator when the + object’s reference count reaches zero. Undefined behavior ensues when + the C++ side does the same.. */ + take_ownership, + + /** Create a new copy of the returned object, which will be owned by + Python. This policy is comparably safe because the lifetimes of the two + instances are decoupled. */ + copy, + + /** Use std::move to move the return value contents into a new instance + that will be owned by Python. This policy is comparably safe because the + lifetimes of the two instances (move source and destination) are + decoupled. */ + move, + + /** Reference an existing object, but do not take ownership. The C++ side + is responsible for managing the object’s lifetime and deallocating it + when it is no longer used. Warning: undefined behavior will ensue when + the C++ side deletes an object that is still referenced and used by + Python. */ + reference, + + /** This policy only applies to methods and properties. It references the + object without taking ownership similar to the above + return_value_policy::reference policy. In contrast to that policy, the + function or property’s implicit this argument (called the parent) is + considered to be the the owner of the return value (the child). + pybind11 then couples the lifetime of the parent to the child via a + reference relationship that ensures that the parent cannot be garbage + collected while Python is still using the child. More advanced + variations of this scheme are also possible using combinations of + return_value_policy::reference and the keep_alive call policy */ + reference_internal +}; + +NAMESPACE_BEGIN(detail) + +inline static constexpr int log2(size_t n, int k = 0) +{ + return (n <= 1) ? k : log2(n >> 1, k + 1); +} + +// Returns the size as a multiple of sizeof(void *), rounded up. +inline static constexpr size_t size_in_ptrs(size_t s) +{ + return 1 + ((s - 1) >> log2(sizeof(void*))); +} + +/** + * The space to allocate for simple layout instance holders (see below) in multiple of the size of + * a pointer (e.g. 2 means 16 bytes on 64-bit architectures). The default is the minimum required + * to holder either a std::unique_ptr or std::shared_ptr (which is almost always + * sizeof(std::shared_ptr<T>)). + */ +constexpr size_t instance_simple_holder_in_ptrs() +{ + static_assert(sizeof(std::shared_ptr<int>) >= sizeof(std::unique_ptr<int>), + "pybind assumes std::shared_ptrs are at least as big as std::unique_ptrs"); + return size_in_ptrs(sizeof(std::shared_ptr<int>)); +} + +// Forward declarations +struct type_info; +struct value_and_holder; + +struct nonsimple_values_and_holders +{ + void** values_and_holders; + uint8_t* status; +}; + +/// The 'instance' type which needs to be standard layout (need to be able to use 'offsetof') +struct instance +{ + PyObject_HEAD + /// Storage for pointers and holder; see simple_layout, below, for a description + union + { + void* simple_value_holder[1 + instance_simple_holder_in_ptrs()]; + nonsimple_values_and_holders nonsimple; + }; + /// Weak references + PyObject* weakrefs; + /// If true, the pointer is owned which means we're free to manage it with a holder. + bool owned : 1; + /** + * An instance has two possible value/holder layouts. + * + * Simple layout (when this flag is true), means the `simple_value_holder` is set with a pointer + * and the holder object governing that pointer, i.e. [val1*][holder]. This layout is applied + * whenever there is no python-side multiple inheritance of bound C++ types *and* the type's + * holder will fit in the default space (which is large enough to hold either a std::unique_ptr + * or std::shared_ptr). + * + * Non-simple layout applies when using custom holders that require more space than `shared_ptr` + * (which is typically the size of two pointers), or when multiple inheritance is used on the + * python side. Non-simple layout allocates the required amount of memory to have multiple + * bound C++ classes as parents. Under this layout, `nonsimple.values_and_holders` is set to a + * pointer to allocated space of the required space to hold a sequence of value pointers and + * holders followed `status`, a set of bit flags (1 byte each), i.e. + * [val1*][holder1][val2*][holder2]...[bb...] where each [block] is rounded up to a multiple of + * `sizeof(void *)`. `nonsimple.status` is, for convenience, a pointer to the + * beginning of the [bb...] block (but not independently allocated). + * + * Status bits indicate whether the associated holder is constructed (& + * status_holder_constructed) and whether the value pointer is registered (& + * status_instance_registered) in `registered_instances`. + */ + bool simple_layout : 1; + /// For simple layout, tracks whether the holder has been constructed + bool simple_holder_constructed : 1; + /// For simple layout, tracks whether the instance is registered in `registered_instances` + bool simple_instance_registered : 1; + /// If true, get_internals().patients has an entry for this object + bool has_patients : 1; + + /// Initializes all of the above type/values/holders data (but not the instance values themselves) + void allocate_layout(); + + /// Destroys/deallocates all of the above + void deallocate_layout(); + + /// Returns the value_and_holder wrapper for the given type (or the first, if `find_type` + /// omitted). Returns a default-constructed (with `.inst = nullptr`) object on failure if + /// `throw_if_missing` is false. + value_and_holder get_value_and_holder(const type_info* find_type = nullptr, bool throw_if_missing = true); + + /// Bit values for the non-simple status flags + static constexpr uint8_t status_holder_constructed = 1; + static constexpr uint8_t status_instance_registered = 2; +}; + +static_assert(std::is_standard_layout<instance>::value, + "Internal error: `pybind11::detail::instance` is not standard layout!"); + +/// from __cpp_future__ import (convenient aliases from C++14/17) +#if defined(PYBIND11_CPP14) && (!defined(_MSC_VER) || _MSC_VER >= 1910) +using std::conditional_t; +using std::enable_if_t; +using std::remove_cv_t; +using std::remove_reference_t; +#else +template <bool B, typename T = void> +using enable_if_t = typename std::enable_if<B, T>::type; +template <bool B, typename T, typename F> +using conditional_t = typename std::conditional<B, T, F>::type; +template <typename T> +using remove_cv_t = typename std::remove_cv<T>::type; +template <typename T> +using remove_reference_t = typename std::remove_reference<T>::type; +#endif + +/// Index sequences +#if defined(PYBIND11_CPP14) +using std::index_sequence; +using std::make_index_sequence; +#else +template <size_t...> +struct index_sequence +{}; +template <size_t N, size_t... S> +struct make_index_sequence_impl : make_index_sequence_impl<N - 1, N - 1, S...> +{}; +template <size_t... S> +struct make_index_sequence_impl<0, S...> +{ + typedef index_sequence<S...> type; +}; +template <size_t N> +using make_index_sequence = typename make_index_sequence_impl<N>::type; +#endif + +/// Make an index sequence of the indices of true arguments +template <typename ISeq, size_t, bool...> +struct select_indices_impl +{ + using type = ISeq; +}; +template <size_t... IPrev, size_t I, bool B, bool... Bs> +struct select_indices_impl<index_sequence<IPrev...>, I, B, Bs...> + : select_indices_impl<conditional_t<B, index_sequence<IPrev..., I>, index_sequence<IPrev...>>, I + 1, Bs...> +{}; +template <bool... Bs> +using select_indices = typename select_indices_impl<index_sequence<>, 0, Bs...>::type; + +/// Backports of std::bool_constant and std::negation to accommodate older compilers +template <bool B> +using bool_constant = std::integral_constant<bool, B>; +template <typename T> +struct negation : bool_constant<!T::value> +{}; + +template <typename...> +struct void_t_impl +{ + using type = void; +}; +template <typename... Ts> +using void_t = typename void_t_impl<Ts...>::type; + +/// Compile-time all/any/none of that check the boolean value of all template types +#if defined(__cpp_fold_expressions) && !(defined(_MSC_VER) && (_MSC_VER < 1916)) +template <class... Ts> +using all_of = bool_constant<(Ts::value && ...)>; +template <class... Ts> +using any_of = bool_constant<(Ts::value || ...)>; +#elif !defined(_MSC_VER) +template <bool...> +struct bools +{}; +template <class... Ts> +using all_of = std::is_same<bools<Ts::value..., true>, bools<true, Ts::value...>>; +template <class... Ts> +using any_of = negation<all_of<negation<Ts>...>>; +#else +// MSVC has trouble with the above, but supports std::conjunction, which we can use instead (albeit +// at a slight loss of compilation efficiency). +template <class... Ts> +using all_of = std::conjunction<Ts...>; +template <class... Ts> +using any_of = std::disjunction<Ts...>; +#endif +template <class... Ts> +using none_of = negation<any_of<Ts...>>; + +template <class T, template <class> class... Predicates> +using satisfies_all_of = all_of<Predicates<T>...>; +template <class T, template <class> class... Predicates> +using satisfies_any_of = any_of<Predicates<T>...>; +template <class T, template <class> class... Predicates> +using satisfies_none_of = none_of<Predicates<T>...>; + +/// Strip the class from a method type +template <typename T> +struct remove_class +{}; +template <typename C, typename R, typename... A> +struct remove_class<R (C::*)(A...)> +{ + typedef R type(A...); +}; +template <typename C, typename R, typename... A> +struct remove_class<R (C::*)(A...) const> +{ + typedef R type(A...); +}; + +/// Helper template to strip away type modifiers +template <typename T> +struct intrinsic_type +{ + typedef T type; +}; +template <typename T> +struct intrinsic_type<const T> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T> +struct intrinsic_type<T*> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T> +struct intrinsic_type<T&> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T> +struct intrinsic_type<T&&> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T, size_t N> +struct intrinsic_type<const T[N]> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T, size_t N> +struct intrinsic_type<T[N]> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T> +using intrinsic_t = typename intrinsic_type<T>::type; + +/// Helper type to replace 'void' in some expressions +struct void_type +{}; + +/// Helper template which holds a list of types +template <typename...> +struct type_list +{}; + +/// Compile-time integer sum +#ifdef __cpp_fold_expressions +template <typename... Ts> +constexpr size_t constexpr_sum(Ts... ns) +{ + return (0 + ... + size_t{ns}); +} +#else +constexpr size_t constexpr_sum() +{ + return 0; +} +template <typename T, typename... Ts> +constexpr size_t constexpr_sum(T n, Ts... ns) +{ + return size_t{n} + constexpr_sum(ns...); +} +#endif + +NAMESPACE_BEGIN(constexpr_impl) +/// Implementation details for constexpr functions +constexpr int first(int i) +{ + return i; +} +template <typename T, typename... Ts> +constexpr int first(int i, T v, Ts... vs) +{ + return v ? i : first(i + 1, vs...); +} + +constexpr int last(int /*i*/, int result) +{ + return result; +} +template <typename T, typename... Ts> +constexpr int last(int i, int result, T v, Ts... vs) +{ + return last(i + 1, v ? i : result, vs...); +} +NAMESPACE_END(constexpr_impl) + +/// Return the index of the first type in Ts which satisfies Predicate<T>. Returns sizeof...(Ts) if +/// none match. +template <template <typename> class Predicate, typename... Ts> +constexpr int constexpr_first() +{ + return constexpr_impl::first(0, Predicate<Ts>::value...); +} + +/// Return the index of the last type in Ts which satisfies Predicate<T>, or -1 if none match. +template <template <typename> class Predicate, typename... Ts> +constexpr int constexpr_last() +{ + return constexpr_impl::last(0, -1, Predicate<Ts>::value...); +} + +/// Return the Nth element from the parameter pack +template <size_t N, typename T, typename... Ts> +struct pack_element +{ + using type = typename pack_element<N - 1, Ts...>::type; +}; +template <typename T, typename... Ts> +struct pack_element<0, T, Ts...> +{ + using type = T; +}; + +/// Return the one and only type which matches the predicate, or Default if none match. +/// If more than one type matches the predicate, fail at compile-time. +template <template <typename> class Predicate, typename Default, typename... Ts> +struct exactly_one +{ + static constexpr auto found = constexpr_sum(Predicate<Ts>::value...); + static_assert(found <= 1, "Found more than one type matching the predicate"); + + static constexpr auto index = found ? constexpr_first<Predicate, Ts...>() : 0; + using type = conditional_t<found, typename pack_element<index, Ts...>::type, Default>; +}; +template <template <typename> class P, typename Default> +struct exactly_one<P, Default> +{ + using type = Default; +}; + +template <template <typename> class Predicate, typename Default, typename... Ts> +using exactly_one_t = typename exactly_one<Predicate, Default, Ts...>::type; + +/// Defer the evaluation of type T until types Us are instantiated +template <typename T, typename... /*Us*/> +struct deferred_type +{ + using type = T; +}; +template <typename T, typename... Us> +using deferred_t = typename deferred_type<T, Us...>::type; + +/// Like is_base_of, but requires a strict base (i.e. `is_strict_base_of<T, T>::value == false`, +/// unlike `std::is_base_of`) +template <typename Base, typename Derived> +using is_strict_base_of = bool_constant<std::is_base_of<Base, Derived>::value && !std::is_same<Base, Derived>::value>; + +/// Like is_base_of, but also requires that the base type is accessible (i.e. that a Derived pointer +/// can be converted to a Base pointer) +template <typename Base, typename Derived> +using is_accessible_base_of = + bool_constant<std::is_base_of<Base, Derived>::value && std::is_convertible<Derived*, Base*>::value>; + +template <template <typename...> class Base> +struct is_template_base_of_impl +{ + template <typename... Us> + static std::true_type check(Base<Us...>*); + static std::false_type check(...); +}; + +/// Check if a template is the base of a type. For example: +/// `is_template_base_of<Base, T>` is true if `struct T : Base<U> {}` where U can be anything +template <template <typename...> class Base, typename T> +#if !defined(_MSC_VER) +using is_template_base_of = decltype(is_template_base_of_impl<Base>::check((intrinsic_t<T>*)nullptr)); +#else // MSVC2015 has trouble with decltype in template aliases +struct is_template_base_of : decltype(is_template_base_of_impl<Base>::check((intrinsic_t<T>*)nullptr)) +{}; +#endif + +/// Check if T is an instantiation of the template `Class`. For example: +/// `is_instantiation<shared_ptr, T>` is true if `T == shared_ptr<U>` where U can be anything. +template <template <typename...> class Class, typename T> +struct is_instantiation : std::false_type +{}; +template <template <typename...> class Class, typename... Us> +struct is_instantiation<Class, Class<Us...>> : std::true_type +{}; + +/// Check if T is std::shared_ptr<U> where U can be anything +template <typename T> +using is_shared_ptr = is_instantiation<std::shared_ptr, T>; + +/// Check if T looks like an input iterator +template <typename T, typename = void> +struct is_input_iterator : std::false_type +{}; +template <typename T> +struct is_input_iterator<T, void_t<decltype(*std::declval<T&>()), decltype(++std::declval<T&>())>> : std::true_type +{}; + +template <typename T> +using is_function_pointer = + bool_constant<std::is_pointer<T>::value && std::is_function<typename std::remove_pointer<T>::type>::value>; + +template <typename F> +struct strip_function_object +{ + using type = typename remove_class<decltype(&F::operator())>::type; +}; + +// Extracts the function signature from a function, function pointer or lambda. +template <typename Function, typename F = remove_reference_t<Function>> +using function_signature_t = + conditional_t<std::is_function<F>::value, + F, + typename conditional_t<std::is_pointer<F>::value || std::is_member_pointer<F>::value, + std::remove_pointer<F>, + strip_function_object<F>>::type>; + +/// Returns true if the type looks like a lambda: that is, isn't a function, pointer or member +/// pointer. Note that this can catch all sorts of other things, too; this is intended to be used +/// in a place where passing a lambda makes sense. +template <typename T> +using is_lambda = satisfies_none_of<remove_reference_t<T>, std::is_function, std::is_pointer, std::is_member_pointer>; + +/// Ignore that a variable is unused in compiler warnings +inline void ignore_unused(const int*) {} + +/// Apply a function over each element of a parameter pack +#ifdef __cpp_fold_expressions +# define PYBIND11_EXPAND_SIDE_EFFECTS(PATTERN) (((PATTERN), void()), ...) +#else +using expand_side_effects = bool[]; +# define PYBIND11_EXPAND_SIDE_EFFECTS(PATTERN) \ + pybind11::detail::expand_side_effects \ + { \ + ((PATTERN), void(), false)..., false \ + } +#endif + +NAMESPACE_END(detail) + +/// C++ bindings of builtin Python exceptions +class builtin_exception : public std::runtime_error +{ +public: + using std::runtime_error::runtime_error; + /// Set the error using the Python C API + virtual void set_error() const = 0; +}; + +#define PYBIND11_RUNTIME_EXCEPTION(name, type) \ + class name : public builtin_exception \ + { \ + public: \ + using builtin_exception::builtin_exception; \ + name() \ + : name("") \ + {} \ + void set_error() const override \ + { \ + PyErr_SetString(type, what()); \ + } \ + }; + +PYBIND11_RUNTIME_EXCEPTION(stop_iteration, PyExc_StopIteration) +PYBIND11_RUNTIME_EXCEPTION(index_error, PyExc_IndexError) +PYBIND11_RUNTIME_EXCEPTION(key_error, PyExc_KeyError) +PYBIND11_RUNTIME_EXCEPTION(value_error, PyExc_ValueError) +PYBIND11_RUNTIME_EXCEPTION(type_error, PyExc_TypeError) +PYBIND11_RUNTIME_EXCEPTION(cast_error, PyExc_RuntimeError) /// Thrown when pybind11::cast or handle::call fail due to a + /// type casting error +PYBIND11_RUNTIME_EXCEPTION(reference_cast_error, PyExc_RuntimeError) /// Used internally + +[[noreturn]] PYBIND11_NOINLINE inline void pybind11_fail(const char* reason) +{ + throw std::runtime_error(reason); +} +[[noreturn]] PYBIND11_NOINLINE inline void pybind11_fail(const std::string& reason) +{ + throw std::runtime_error(reason); +} + +template <typename T, typename SFINAE = void> +struct format_descriptor +{}; + +NAMESPACE_BEGIN(detail) +// Returns the index of the given type in the type char array below, and in the list in numpy.h +// The order here is: bool; 8 ints ((signed,unsigned)x(8,16,32,64)bits); float,double,long double; +// complex float,double,long double. Note that the long double types only participate when long +// double is actually longer than double (it isn't under MSVC). +// NB: not only the string below but also complex.h and numpy.h rely on this order. +template <typename T, typename SFINAE = void> +struct is_fmt_numeric +{ + static constexpr bool value = false; +}; +template <typename T> +struct is_fmt_numeric<T, enable_if_t<std::is_arithmetic<T>::value>> +{ + static constexpr bool value = true; + static constexpr int index = + std::is_same<T, bool>::value + ? 0 + : 1 + + (std::is_integral<T>::value + ? detail::log2(sizeof(T)) * 2 + std::is_unsigned<T>::value + : 8 + (std::is_same<T, double>::value ? 1 : std::is_same<T, long double>::value ? 2 : 0)); +}; +NAMESPACE_END(detail) + +template <typename T> +struct format_descriptor<T, detail::enable_if_t<std::is_arithmetic<T>::value>> +{ + static constexpr const char c = "?bBhHiIqQfdg"[detail::is_fmt_numeric<T>::index]; + static constexpr const char value[2] = {c, '\0'}; + static std::string format() + { + return std::string(1, c); + } +}; + +#if !defined(PYBIND11_CPP17) + +template <typename T> +constexpr const char format_descriptor<T, detail::enable_if_t<std::is_arithmetic<T>::value>>::value[2]; + +#endif + +/// RAII wrapper that temporarily clears any Python error state +struct error_scope +{ + PyObject *type, *value, *trace; + error_scope() + { + PyErr_Fetch(&type, &value, &trace); + } + ~error_scope() + { + PyErr_Restore(type, value, trace); + } +}; + +/// Dummy destructor wrapper that can be used to expose classes with a private destructor +struct nodelete +{ + template <typename T> + void operator()(T*) + {} +}; + +// overload_cast requires variable templates: C++14 +#if defined(PYBIND11_CPP14) +# define PYBIND11_OVERLOAD_CAST 1 + +NAMESPACE_BEGIN(detail) +template <typename... Args> +struct overload_cast_impl +{ + constexpr overload_cast_impl() {} // MSVC 2015 needs this + + template <typename Return> + constexpr auto operator()(Return (*pf)(Args...)) const noexcept -> decltype(pf) + { + return pf; + } + + template <typename Return, typename Class> + constexpr auto operator()(Return (Class::*pmf)(Args...), std::false_type = {}) const noexcept -> decltype(pmf) + { + return pmf; + } + + template <typename Return, typename Class> + constexpr auto operator()(Return (Class::*pmf)(Args...) const, std::true_type) const noexcept -> decltype(pmf) + { + return pmf; + } +}; +NAMESPACE_END(detail) + +/// Syntax sugar for resolving overloaded function pointers: +/// - regular: static_cast<Return (Class::*)(Arg0, Arg1, Arg2)>(&Class::func) +/// - sweet: overload_cast<Arg0, Arg1, Arg2>(&Class::func) +template <typename... Args> +static constexpr detail::overload_cast_impl<Args...> overload_cast = {}; +// MSVC 2015 only accepts this particular initialization syntax for this variable template. + +/// Const member function selector for overload_cast +/// - regular: static_cast<Return (Class::*)(Arg) const>(&Class::func) +/// - sweet: overload_cast<Arg>(&Class::func, const_) +static constexpr auto const_ = std::true_type{}; + +#else // no overload_cast: providing something that static_assert-fails: +template <typename... Args> +struct overload_cast +{ + static_assert(detail::deferred_t<std::false_type, Args...>::value, + "pybind11::overload_cast<...> requires compiling in C++14 mode"); +}; +#endif // overload_cast + +NAMESPACE_BEGIN(detail) + +// Adaptor for converting arbitrary container arguments into a vector; implicitly convertible from +// any standard container (or C-style array) supporting std::begin/std::end, any singleton +// arithmetic type (if T is arithmetic), or explicitly constructible from an iterator pair. +template <typename T> +class any_container +{ + std::vector<T> v; + +public: + any_container() = default; + + // Can construct from a pair of iterators + template <typename It, typename = enable_if_t<is_input_iterator<It>::value>> + any_container(It first, It last) + : v(first, last) + {} + + // Implicit conversion constructor from any arbitrary container type with values convertible to T + template < + typename Container, + typename = enable_if_t<std::is_convertible<decltype(*std::begin(std::declval<const Container&>())), T>::value>> + any_container(const Container& c) + : any_container(std::begin(c), std::end(c)) + {} + + // initializer_list's aren't deducible, so don't get matched by the above template; we need this + // to explicitly allow implicit conversion from one: + template <typename TIn, typename = enable_if_t<std::is_convertible<TIn, T>::value>> + any_container(const std::initializer_list<TIn>& c) + : any_container(c.begin(), c.end()) + {} + + // Avoid copying if given an rvalue vector of the correct type. + any_container(std::vector<T>&& v) + : v(std::move(v)) + {} + + // Moves the vector out of an rvalue any_container + operator std::vector<T> &&() && + { + return std::move(v); + } + + // Dereferencing obtains a reference to the underlying vector + std::vector<T>& operator*() + { + return v; + } + const std::vector<T>& operator*() const + { + return v; + } + + // -> lets you call methods on the underlying vector + std::vector<T>* operator->() + { + return &v; + } + const std::vector<T>* operator->() const + { + return &v; + } +}; + +NAMESPACE_END(detail) + + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/detail/descr.h b/dune/pybindxi/detail/descr.h new file mode 100644 index 0000000000000000000000000000000000000000..e6b65fd0496bc1cbc3edf8f0b53060b5e0acfc1b --- /dev/null +++ b/dune/pybindxi/detail/descr.h @@ -0,0 +1,145 @@ +#pragma GCC system_header +/* + pybind11/detail/descr.h: Helper type for concatenating type signatures at compile time + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "common.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +#if !defined(_MSC_VER) +# define PYBIND11_DESCR_CONSTEXPR static constexpr +#else +# define PYBIND11_DESCR_CONSTEXPR const +#endif + +/* Concatenate type signatures at compile time */ +template <size_t N, typename... Ts> +struct descr +{ + char text[N + 1]; + + constexpr descr() + : text{'\0'} + {} + constexpr descr(char const (&s)[N + 1]) + : descr(s, make_index_sequence<N>()) + {} + + template <size_t... Is> + constexpr descr(char const (&s)[N + 1], index_sequence<Is...>) + : text{s[Is]..., '\0'} + {} + + template <typename... Chars> + constexpr descr(char c, Chars... cs) + : text{c, static_cast<char>(cs)..., '\0'} + {} + + static constexpr std::array<const std::type_info*, sizeof...(Ts) + 1> types() + { + return {{&typeid(Ts)..., nullptr}}; + } +}; + +template <size_t N1, size_t N2, typename... Ts1, typename... Ts2, size_t... Is1, size_t... Is2> +constexpr descr<N1 + N2, Ts1..., Ts2...> +plus_impl(const descr<N1, Ts1...>& a, const descr<N2, Ts2...>& b, index_sequence<Is1...>, index_sequence<Is2...>) +{ + return {a.text[Is1]..., b.text[Is2]...}; +} + +template <size_t N1, size_t N2, typename... Ts1, typename... Ts2> +constexpr descr<N1 + N2, Ts1..., Ts2...> operator+(const descr<N1, Ts1...>& a, const descr<N2, Ts2...>& b) +{ + return plus_impl(a, b, make_index_sequence<N1>(), make_index_sequence<N2>()); +} + +template <size_t N> +constexpr descr<N - 1> _(char const (&text)[N]) +{ + return descr<N - 1>(text); +} +constexpr descr<0> _(char const (&)[1]) +{ + return {}; +} + +template <size_t Rem, size_t... Digits> +struct int_to_str : int_to_str<Rem / 10, Rem % 10, Digits...> +{}; +template <size_t... Digits> +struct int_to_str<0, Digits...> +{ + static constexpr auto digits = descr<sizeof...(Digits)>(('0' + Digits)...); +}; + +// Ternary description (like std::conditional) +template <bool B, size_t N1, size_t N2> +constexpr enable_if_t<B, descr<N1 - 1>> _(char const (&text1)[N1], char const (&)[N2]) +{ + return _(text1); +} +template <bool B, size_t N1, size_t N2> +constexpr enable_if_t<!B, descr<N2 - 1>> _(char const (&)[N1], char const (&text2)[N2]) +{ + return _(text2); +} + +template <bool B, typename T1, typename T2> +constexpr enable_if_t<B, T1> _(const T1& d, const T2&) +{ + return d; +} +template <bool B, typename T1, typename T2> +constexpr enable_if_t<!B, T2> _(const T1&, const T2& d) +{ + return d; +} + +template <size_t Size> +auto constexpr _() -> decltype(int_to_str<Size / 10, Size % 10>::digits) +{ + return int_to_str<Size / 10, Size % 10>::digits; +} + +template <typename Type> +constexpr descr<1, Type> _() +{ + return {'%'}; +} + +constexpr descr<0> concat() +{ + return {}; +} + +template <size_t N, typename... Ts> +constexpr descr<N, Ts...> concat(const descr<N, Ts...>& descr) +{ + return descr; +} + +template <size_t N, typename... Ts, typename... Args> +constexpr auto concat(const descr<N, Ts...>& d, const Args&... args) + -> decltype(std::declval<descr<N + 2, Ts...>>() + concat(args...)) +{ + return d + _(", ") + concat(args...); +} + +template <size_t N, typename... Ts> +constexpr descr<N + 2, Ts...> type_descr(const descr<N, Ts...>& descr) +{ + return _("{") + descr + _("}"); +} + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/detail/init.h b/dune/pybindxi/detail/init.h new file mode 100644 index 0000000000000000000000000000000000000000..c7cc18e9110b1b5a24ba0207f8a2e6059398ca4c --- /dev/null +++ b/dune/pybindxi/detail/init.h @@ -0,0 +1,407 @@ +#pragma GCC system_header +/* + pybind11/detail/init.h: init factory function implementation and support code. + + Copyright (c) 2017 Jason Rhinelander <jason@imaginary.ca> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "class.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +template <> +class type_caster<value_and_holder> +{ +public: + bool load(handle h, bool) + { + value = reinterpret_cast<value_and_holder*>(h.ptr()); + return true; + } + + template <typename> + using cast_op_type = value_and_holder&; + operator value_and_holder&() + { + return *value; + } + static constexpr auto name = _<value_and_holder>(); + +private: + value_and_holder* value = nullptr; +}; + +NAMESPACE_BEGIN(initimpl) + +inline void no_nullptr(void* ptr) +{ + if (!ptr) + throw type_error("pybind11::init(): factory function returned nullptr"); +} + +// Implementing functions for all forms of py::init<...> and py::init(...) +template <typename Class> +using Cpp = typename Class::type; +template <typename Class> +using Alias = typename Class::type_alias; +template <typename Class> +using Holder = typename Class::holder_type; + +template <typename Class> +using is_alias_constructible = std::is_constructible<Alias<Class>, Cpp<Class>&&>; + +// Takes a Cpp pointer and returns true if it actually is a polymorphic Alias instance. +template <typename Class, enable_if_t<Class::has_alias, int> = 0> +bool is_alias(Cpp<Class>* ptr) +{ + return dynamic_cast<Alias<Class>*>(ptr) != nullptr; +} +// Failing fallback version of the above for a no-alias class (always returns false) +template <typename /*Class*/> +constexpr bool is_alias(void*) +{ + return false; +} + +// Constructs and returns a new object; if the given arguments don't map to a constructor, we fall +// back to brace aggregate initiailization so that for aggregate initialization can be used with +// py::init, e.g. `py::init<int, int>` to initialize a `struct T { int a; int b; }`. For +// non-aggregate types, we need to use an ordinary T(...) constructor (invoking as `T{...}` usually +// works, but will not do the expected thing when `T` has an `initializer_list<T>` constructor). +template <typename Class, typename... Args, detail::enable_if_t<std::is_constructible<Class, Args...>::value, int> = 0> +inline Class* construct_or_initialize(Args&&... args) +{ + return new Class(std::forward<Args>(args)...); +} +template <typename Class, typename... Args, detail::enable_if_t<!std::is_constructible<Class, Args...>::value, int> = 0> +inline Class* construct_or_initialize(Args&&... args) +{ + return new Class{std::forward<Args>(args)...}; +} + +// Attempts to constructs an alias using a `Alias(Cpp &&)` constructor. This allows types with +// an alias to provide only a single Cpp factory function as long as the Alias can be +// constructed from an rvalue reference of the base Cpp type. This means that Alias classes +// can, when appropriate, simply define a `Alias(Cpp &&)` constructor rather than needing to +// inherit all the base class constructors. +template <typename Class> +void construct_alias_from_cpp(std::true_type /*is_alias_constructible*/, value_and_holder& v_h, Cpp<Class>&& base) +{ + v_h.value_ptr() = new Alias<Class>(std::move(base)); +} +template <typename Class> +[[noreturn]] void +construct_alias_from_cpp(std::false_type /*!is_alias_constructible*/, value_and_holder&, Cpp<Class>&&) { + throw type_error("pybind11::init(): unable to convert returned instance to required " + "alias class: no `Alias<Class>(Class &&)` constructor available"); +} + +// Error-generating fallback for factories that don't match one of the below construction +// mechanisms. +template <typename Class> +void construct(...) +{ + static_assert(!std::is_same<Class, Class>::value /* always false */, + "pybind11::init(): init function must return a compatible pointer, " + "holder, or value"); +} + +// Pointer return v1: the factory function returns a class pointer for a registered class. +// If we don't need an alias (because this class doesn't have one, or because the final type is +// inherited on the Python side) we can simply take over ownership. Otherwise we need to try to +// construct an Alias from the returned base instance. +template <typename Class> +void construct(value_and_holder& v_h, Cpp<Class>* ptr, bool need_alias) +{ + no_nullptr(ptr); + if (Class::has_alias && need_alias && !is_alias<Class>(ptr)) { + // We're going to try to construct an alias by moving the cpp type. Whether or not + // that succeeds, we still need to destroy the original cpp pointer (either the + // moved away leftover, if the alias construction works, or the value itself if we + // throw an error), but we can't just call `delete ptr`: it might have a special + // deleter, or might be shared_from_this. So we construct a holder around it as if + // it was a normal instance, then steal the holder away into a local variable; thus + // the holder and destruction happens when we leave the C++ scope, and the holder + // class gets to handle the destruction however it likes. + v_h.value_ptr() = ptr; + v_h.set_instance_registered(true); // To prevent init_instance from registering it + v_h.type->init_instance(v_h.inst, nullptr); // Set up the holder + Holder<Class> temp_holder(std::move(v_h.holder<Holder<Class>>())); // Steal the holder + v_h.type->dealloc(v_h); // Destroys the moved-out holder remains, resets value ptr to null + v_h.set_instance_registered(false); + + construct_alias_from_cpp<Class>(is_alias_constructible<Class>{}, v_h, std::move(*ptr)); + } else { + // Otherwise the type isn't inherited, so we don't need an Alias + v_h.value_ptr() = ptr; + } +} + +// Pointer return v2: a factory that always returns an alias instance ptr. We simply take over +// ownership of the pointer. +template <typename Class, enable_if_t<Class::has_alias, int> = 0> +void construct(value_and_holder& v_h, Alias<Class>* alias_ptr, bool) +{ + no_nullptr(alias_ptr); + v_h.value_ptr() = static_cast<Cpp<Class>*>(alias_ptr); +} + +// Holder return: copy its pointer, and move or copy the returned holder into the new instance's +// holder. This also handles types like std::shared_ptr<T> and std::unique_ptr<T> where T is a +// derived type (through those holder's implicit conversion from derived class holder constructors). +template <typename Class> +void construct(value_and_holder& v_h, Holder<Class> holder, bool need_alias) +{ + auto* ptr = holder_helper<Holder<Class>>::get(holder); + // If we need an alias, check that the held pointer is actually an alias instance + if (Class::has_alias && need_alias && !is_alias<Class>(ptr)) + throw type_error("pybind11::init(): construction failed: returned holder-wrapped instance " + "is not an alias instance"); + + v_h.value_ptr() = ptr; + v_h.type->init_instance(v_h.inst, &holder); +} + +// return-by-value version 1: returning a cpp class by value. If the class has an alias and an +// alias is required the alias must have an `Alias(Cpp &&)` constructor so that we can construct +// the alias from the base when needed (i.e. because of Python-side inheritance). When we don't +// need it, we simply move-construct the cpp value into a new instance. +template <typename Class> +void construct(value_and_holder& v_h, Cpp<Class>&& result, bool need_alias) +{ + static_assert(std::is_move_constructible<Cpp<Class>>::value, + "pybind11::init() return-by-value factory function requires a movable class"); + if (Class::has_alias && need_alias) + construct_alias_from_cpp<Class>(is_alias_constructible<Class>{}, v_h, std::move(result)); + else + v_h.value_ptr() = new Cpp<Class>(std::move(result)); +} + +// return-by-value version 2: returning a value of the alias type itself. We move-construct an +// Alias instance (even if no the python-side inheritance is involved). The is intended for +// cases where Alias initialization is always desired. +template <typename Class> +void construct(value_and_holder& v_h, Alias<Class>&& result, bool) +{ + static_assert(std::is_move_constructible<Alias<Class>>::value, + "pybind11::init() return-by-alias-value factory function requires a movable alias class"); + v_h.value_ptr() = new Alias<Class>(std::move(result)); +} + +// Implementing class for py::init<...>() +template <typename... Args> +struct constructor +{ + template <typename Class, typename... Extra, enable_if_t<!Class::has_alias, int> = 0> + static void execute(Class& cl, const Extra&... extra) + { + cl.def("__init__", + [](value_and_holder& v_h, Args... args) { + v_h.value_ptr() = construct_or_initialize<Cpp<Class>>(std::forward<Args>(args)...); + }, + is_new_style_constructor(), + extra...); + } + + template <typename Class, + typename... Extra, + enable_if_t<Class::has_alias && std::is_constructible<Cpp<Class>, Args...>::value, int> = 0> + static void execute(Class& cl, const Extra&... extra) + { + cl.def("__init__", + [](value_and_holder& v_h, Args... args) { + if (Py_TYPE(v_h.inst) == v_h.type->type) + v_h.value_ptr() = construct_or_initialize<Cpp<Class>>(std::forward<Args>(args)...); + else + v_h.value_ptr() = construct_or_initialize<Alias<Class>>(std::forward<Args>(args)...); + }, + is_new_style_constructor(), + extra...); + } + + template <typename Class, + typename... Extra, + enable_if_t<Class::has_alias && !std::is_constructible<Cpp<Class>, Args...>::value, int> = 0> + static void execute(Class& cl, const Extra&... extra) + { + cl.def("__init__", + [](value_and_holder& v_h, Args... args) { + v_h.value_ptr() = construct_or_initialize<Alias<Class>>(std::forward<Args>(args)...); + }, + is_new_style_constructor(), + extra...); + } +}; + +// Implementing class for py::init_alias<...>() +template <typename... Args> +struct alias_constructor +{ + template <typename Class, + typename... Extra, + enable_if_t<Class::has_alias && std::is_constructible<Alias<Class>, Args...>::value, int> = 0> + static void execute(Class& cl, const Extra&... extra) + { + cl.def("__init__", + [](value_and_holder& v_h, Args... args) { + v_h.value_ptr() = construct_or_initialize<Alias<Class>>(std::forward<Args>(args)...); + }, + is_new_style_constructor(), + extra...); + } +}; + +// Implementation class for py::init(Func) and py::init(Func, AliasFunc) +template <typename CFunc, + typename AFunc = void_type (*)(), + typename = function_signature_t<CFunc>, + typename = function_signature_t<AFunc>> +struct factory; + +// Specialization for py::init(Func) +template <typename Func, typename Return, typename... Args> +struct factory<Func, void_type (*)(), Return(Args...)> +{ + remove_reference_t<Func> class_factory; + + factory(Func&& f) + : class_factory(std::forward<Func>(f)) + {} + + // The given class either has no alias or has no separate alias factory; + // this always constructs the class itself. If the class is registered with an alias + // type and an alias instance is needed (i.e. because the final type is a Python class + // inheriting from the C++ type) the returned value needs to either already be an alias + // instance, or the alias needs to be constructible from a `Class &&` argument. + template <typename Class, typename... Extra> + void execute(Class& cl, const Extra&... extra) && + { +#if defined(PYBIND11_CPP14) + cl.def("__init__", + [func = std::move(class_factory)] +#else + auto& func = class_factory; + cl.def("__init__", + [func] +#endif + (value_and_holder& v_h, Args... args) { + construct<Class>(v_h, func(std::forward<Args>(args)...), Py_TYPE(v_h.inst) != v_h.type->type); + }, + is_new_style_constructor(), + extra...); + } +}; + +// Specialization for py::init(Func, AliasFunc) +template <typename CFunc, typename AFunc, typename CReturn, typename... CArgs, typename AReturn, typename... AArgs> +struct factory<CFunc, AFunc, CReturn(CArgs...), AReturn(AArgs...)> +{ + static_assert(sizeof...(CArgs) == sizeof...(AArgs), + "pybind11::init(class_factory, alias_factory): class and alias factories " + "must have identical argument signatures"); + static_assert(all_of<std::is_same<CArgs, AArgs>...>::value, + "pybind11::init(class_factory, alias_factory): class and alias factories " + "must have identical argument signatures"); + + remove_reference_t<CFunc> class_factory; + remove_reference_t<AFunc> alias_factory; + + factory(CFunc&& c, AFunc&& a) + : class_factory(std::forward<CFunc>(c)) + , alias_factory(std::forward<AFunc>(a)) + {} + + // The class factory is called when the `self` type passed to `__init__` is the direct + // class (i.e. not inherited), the alias factory when `self` is a Python-side subtype. + template <typename Class, typename... Extra> + void execute(Class& cl, const Extra&... extra) && + { + static_assert(Class::has_alias, + "The two-argument version of `py::init()` can " + "only be used if the class has an alias"); +#if defined(PYBIND11_CPP14) + cl.def("__init__", + [class_func = std::move(class_factory), alias_func = std::move(alias_factory)] +#else + auto& class_func = class_factory; + auto& alias_func = alias_factory; + cl.def("__init__", + [class_func, alias_func] +#endif + (value_and_holder& v_h, CArgs... args) { + if (Py_TYPE(v_h.inst) == v_h.type->type) + // If the instance type equals the registered type we don't have inheritance, so + // don't need the alias and can construct using the class function: + construct<Class>(v_h, class_func(std::forward<CArgs>(args)...), false); + else + construct<Class>(v_h, alias_func(std::forward<CArgs>(args)...), true); + }, + is_new_style_constructor(), + extra...); + } +}; + +/// Set just the C++ state. Same as `__init__`. +template <typename Class, typename T> +void setstate(value_and_holder& v_h, T&& result, bool need_alias) +{ + construct<Class>(v_h, std::forward<T>(result), need_alias); +} + +/// Set both the C++ and Python states +template <typename Class, typename T, typename O, enable_if_t<std::is_convertible<O, handle>::value, int> = 0> +void setstate(value_and_holder& v_h, std::pair<T, O>&& result, bool need_alias) +{ + construct<Class>(v_h, std::move(result.first), need_alias); + setattr((PyObject*)v_h.inst, "__dict__", result.second); +} + +/// Implementation for py::pickle(GetState, SetState) +template <typename Get, typename Set, typename = function_signature_t<Get>, typename = function_signature_t<Set>> +struct pickle_factory; + +template <typename Get, typename Set, typename RetState, typename Self, typename NewInstance, typename ArgState> +struct pickle_factory<Get, Set, RetState(Self), NewInstance(ArgState)> +{ + static_assert(std::is_same<intrinsic_t<RetState>, intrinsic_t<ArgState>>::value, + "The type returned by `__getstate__` must be the same " + "as the argument accepted by `__setstate__`"); + + remove_reference_t<Get> get; + remove_reference_t<Set> set; + + pickle_factory(Get get, Set set) + : get(std::forward<Get>(get)) + , set(std::forward<Set>(set)) + {} + + template <typename Class, typename... Extra> + void execute(Class& cl, const Extra&... extra) && + { + cl.def("__getstate__", std::move(get)); + +#if defined(PYBIND11_CPP14) + cl.def("__setstate__", + [func = std::move(set)] +#else + auto& func = set; + cl.def("__setstate__", + [func] +#endif + (value_and_holder& v_h, ArgState state) { + setstate<Class>(v_h, func(std::forward<ArgState>(state)), Py_TYPE(v_h.inst) != v_h.type->type); + }, + is_new_style_constructor(), + extra...); + } +}; + +NAMESPACE_END(initimpl) +NAMESPACE_END(detail) +NAMESPACE_END(pybind11) diff --git a/dune/pybindxi/detail/internals.h b/dune/pybindxi/detail/internals.h new file mode 100644 index 0000000000000000000000000000000000000000..7ddaf73f2161c21682d3b5bc004f33022ac527a9 --- /dev/null +++ b/dune/pybindxi/detail/internals.h @@ -0,0 +1,331 @@ +#pragma GCC system_header +/* + pybind11/detail/internals.h: Internal data structure and related functions + + Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "../pytypes.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) +// Forward declarations +inline PyTypeObject* make_static_property_type(); +inline PyTypeObject* make_default_metaclass(); +inline PyObject* make_object_base_type(PyTypeObject* metaclass); + +// The old Python Thread Local Storage (TLS) API is deprecated in Python 3.7 in favor of the new +// Thread Specific Storage (TSS) API. +#if PY_VERSION_HEX >= 0x03070000 +# define PYBIND11_TLS_KEY_INIT(var) Py_tss_t* var = nullptr +# define PYBIND11_TLS_GET_VALUE(key) PyThread_tss_get((key)) +# define PYBIND11_TLS_REPLACE_VALUE(key, value) PyThread_tss_set((key), (value)) +# define PYBIND11_TLS_DELETE_VALUE(key) PyThread_tss_set((key), nullptr) +#else +// Usually an int but a long on Cygwin64 with Python 3.x +# define PYBIND11_TLS_KEY_INIT(var) decltype(PyThread_create_key()) var = 0 +# define PYBIND11_TLS_GET_VALUE(key) PyThread_get_key_value((key)) +# if PY_MAJOR_VERSION < 3 +# define PYBIND11_TLS_DELETE_VALUE(key) PyThread_delete_key_value(key) +# define PYBIND11_TLS_REPLACE_VALUE(key, value) \ + do { \ + PyThread_delete_key_value((key)); \ + PyThread_set_key_value((key), (value)); \ + } while (false) +# else +# define PYBIND11_TLS_DELETE_VALUE(key) PyThread_set_key_value((key), nullptr) +# define PYBIND11_TLS_REPLACE_VALUE(key, value) PyThread_set_key_value((key), (value)) +# endif +#endif + +// Python loads modules by default with dlopen with the RTLD_LOCAL flag; under libc++ and possibly +// other STLs, this means `typeid(A)` from one module won't equal `typeid(A)` from another module +// even when `A` is the same, non-hidden-visibility type (e.g. from a common include). Under +// libstdc++, this doesn't happen: equality and the type_index hash are based on the type name, +// which works. If not under a known-good stl, provide our own name-based hash and equality +// functions that use the type name. +#if defined(__GLIBCXX__) +inline bool same_type(const std::type_info& lhs, const std::type_info& rhs) +{ + return lhs == rhs; +} +using type_hash = std::hash<std::type_index>; +using type_equal_to = std::equal_to<std::type_index>; +#else +inline bool same_type(const std::type_info& lhs, const std::type_info& rhs) +{ + return lhs.name() == rhs.name() || std::strcmp(lhs.name(), rhs.name()) == 0; +} + +struct type_hash +{ + size_t operator()(const std::type_index& t) const + { + size_t hash = 5381; + const char* ptr = t.name(); + while (auto c = static_cast<unsigned char>(*ptr++)) + hash = (hash * 33) ^ c; + return hash; + } +}; + +struct type_equal_to +{ + bool operator()(const std::type_index& lhs, const std::type_index& rhs) const + { + return lhs.name() == rhs.name() || std::strcmp(lhs.name(), rhs.name()) == 0; + } +}; +#endif + +template <typename value_type> +using type_map = std::unordered_map<std::type_index, value_type, type_hash, type_equal_to>; + +struct overload_hash +{ + inline size_t operator()(const std::pair<const PyObject*, const char*>& v) const + { + size_t value = std::hash<const void*>()(v.first); + value ^= std::hash<const void*>()(v.second) + 0x9e3779b9 + (value << 6) + (value >> 2); + return value; + } +}; + +/// Internal data structure used to track registered instances and types. +/// Whenever binary incompatible changes are made to this structure, +/// `PYBIND11_INTERNALS_VERSION` must be incremented. +struct internals +{ + type_map<type_info*> registered_types_cpp; // std::type_index -> pybind11's type information + std::unordered_map<PyTypeObject*, std::vector<type_info*>> registered_types_py; // PyTypeObject* -> base type_info(s) + std::unordered_multimap<const void*, instance*> registered_instances; // void * -> instance* + std::unordered_set<std::pair<const PyObject*, const char*>, overload_hash> inactive_overload_cache; + type_map<std::vector<bool (*)(PyObject*, void*&)>> direct_conversions; + std::unordered_map<const PyObject*, std::vector<PyObject*>> patients; + std::forward_list<void (*)(std::exception_ptr)> registered_exception_translators; + std::unordered_map<std::string, void*> shared_data; // Custom data to be shared across extensions + std::vector<PyObject*> loader_patient_stack; // Used by `loader_life_support` + std::forward_list<std::string> static_strings; // Stores the std::strings backing detail::c_str() + PyTypeObject* static_property_type; + PyTypeObject* default_metaclass; + PyObject* instance_base; +#if defined(WITH_THREAD) + PYBIND11_TLS_KEY_INIT(tstate); + PyInterpreterState* istate = nullptr; +#endif +}; + +/// Additional type information which does not fit into the PyTypeObject. +/// Changes to this struct also require bumping `PYBIND11_INTERNALS_VERSION`. +struct type_info +{ + PyTypeObject* type; + const std::type_info* cpptype; + size_t type_size, type_align, holder_size_in_ptrs; + void* (*operator_new)(size_t); + void (*init_instance)(instance*, const void*); + void (*dealloc)(value_and_holder& v_h); + std::vector<PyObject* (*)(PyObject*, PyTypeObject*)> implicit_conversions; + std::vector<std::pair<const std::type_info*, void* (*)(void*)>> implicit_casts; + std::vector<bool (*)(PyObject*, void*&)>* direct_conversions; + buffer_info* (*get_buffer)(PyObject*, void*) = nullptr; + void* get_buffer_data = nullptr; + void* (*module_local_load)(PyObject*, const type_info*) = nullptr; + /* A simple type never occurs as a (direct or indirect) parent + * of a class that makes use of multiple inheritance */ + bool simple_type : 1; + /* True if there is no multiple inheritance in this type's inheritance tree */ + bool simple_ancestors : 1; + /* for base vs derived holder_type checks */ + bool default_holder : 1; + /* true if this is a type registered with py::module_local */ + bool module_local : 1; +}; + +/// Tracks the `internals` and `type_info` ABI version independent of the main library version +#define PYBIND11_INTERNALS_VERSION 3 + +#if defined(_DEBUG) +# define PYBIND11_BUILD_TYPE "_debug" +#else +# define PYBIND11_BUILD_TYPE "" +#endif + +#if defined(WITH_THREAD) +# define PYBIND11_INTERNALS_KIND "" +#else +# define PYBIND11_INTERNALS_KIND "_without_thread" +#endif + +#define PYBIND11_INTERNALS_ID \ + "__pybind11_internals_v" PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) PYBIND11_INTERNALS_KIND PYBIND11_BUILD_TYPE \ + "__" + +#define PYBIND11_MODULE_LOCAL_ID \ + "__pybind11_module_local_v" PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) \ + PYBIND11_INTERNALS_KIND PYBIND11_BUILD_TYPE "__" + +/// Each module locally stores a pointer to the `internals` data. The data +/// itself is shared among modules with the same `PYBIND11_INTERNALS_ID`. +inline internals**& get_internals_pp() +{ + static internals** internals_pp = nullptr; + return internals_pp; +} + +/// Return a reference to the current `internals` data +PYBIND11_NOINLINE inline internals& get_internals() +{ + auto**& internals_pp = get_internals_pp(); + if (internals_pp && *internals_pp) + return **internals_pp; + + constexpr auto* id = PYBIND11_INTERNALS_ID; + auto builtins = handle(PyEval_GetBuiltins()); + if (builtins.contains(id) && isinstance<capsule>(builtins[id])) { + internals_pp = static_cast<internals**>(capsule(builtins[id])); + + // We loaded builtins through python's builtins, which means that our `error_already_set` + // and `builtin_exception` may be different local classes than the ones set up in the + // initial exception translator, below, so add another for our local exception classes. + // + // libstdc++ doesn't require this (types there are identified only by name) +#if !defined(__GLIBCXX__) + (*internals_pp)->registered_exception_translators.push_front([](std::exception_ptr p) -> void { + try { + if (p) + std::rethrow_exception(p); + } catch (error_already_set& e) { + e.restore(); + return; + } catch (const builtin_exception& e) { + e.set_error(); + return; + } + }); +#endif + } else { + if (!internals_pp) + internals_pp = new internals*(); + auto*& internals_ptr = *internals_pp; + internals_ptr = new internals(); +#if defined(WITH_THREAD) + PyEval_InitThreads(); + PyThreadState* tstate = PyThreadState_Get(); +# if PY_VERSION_HEX >= 0x03070000 + internals_ptr->tstate = PyThread_tss_alloc(); + if (!internals_ptr->tstate || PyThread_tss_create(internals_ptr->tstate)) + pybind11_fail("get_internals: could not successfully initialize the TSS key!"); + PyThread_tss_set(internals_ptr->tstate, tstate); +# else + internals_ptr->tstate = PyThread_create_key(); + if (internals_ptr->tstate == -1) + pybind11_fail("get_internals: could not successfully initialize the TLS key!"); + PyThread_set_key_value(internals_ptr->tstate, tstate); +# endif + internals_ptr->istate = tstate->interp; +#endif + builtins[id] = capsule(internals_pp); + internals_ptr->registered_exception_translators.push_front([](std::exception_ptr p) -> void { + try { + if (p) + std::rethrow_exception(p); + } catch (error_already_set& e) { + e.restore(); + return; + } catch (const builtin_exception& e) { + e.set_error(); + return; + } catch (const std::bad_alloc& e) { + PyErr_SetString(PyExc_MemoryError, e.what()); + return; + } catch (const std::domain_error& e) { + PyErr_SetString(PyExc_ValueError, e.what()); + return; + } catch (const std::invalid_argument& e) { + PyErr_SetString(PyExc_ValueError, e.what()); + return; + } catch (const std::length_error& e) { + PyErr_SetString(PyExc_ValueError, e.what()); + return; + } catch (const std::out_of_range& e) { + PyErr_SetString(PyExc_IndexError, e.what()); + return; + } catch (const std::range_error& e) { + PyErr_SetString(PyExc_ValueError, e.what()); + return; + } catch (const std::exception& e) { + PyErr_SetString(PyExc_RuntimeError, e.what()); + return; + } catch (...) { + PyErr_SetString(PyExc_RuntimeError, "Caught an unknown exception!"); + return; + } + }); + internals_ptr->static_property_type = make_static_property_type(); + internals_ptr->default_metaclass = make_default_metaclass(); + internals_ptr->instance_base = make_object_base_type(internals_ptr->default_metaclass); + } + return **internals_pp; +} + +/// Works like `internals.registered_types_cpp`, but for module-local registered types: +inline type_map<type_info*>& registered_local_types_cpp() +{ + static type_map<type_info*> locals{}; + return locals; +} + +/// Constructs a std::string with the given arguments, stores it in `internals`, and returns its +/// `c_str()`. Such strings objects have a long storage duration -- the internal strings are only +/// cleared when the program exits or after interpreter shutdown (when embedding), and so are +/// suitable for c-style strings needed by Python internals (such as PyTypeObject's tp_name). +template <typename... Args> +const char* c_str(Args&&... args) +{ + auto& strings = get_internals().static_strings; + strings.emplace_front(std::forward<Args>(args)...); + return strings.front().c_str(); +} + +NAMESPACE_END(detail) + +/// Returns a named pointer that is shared among all extension modules (using the same +/// pybind11 version) running in the current interpreter. Names starting with underscores +/// are reserved for internal usage. Returns `nullptr` if no matching entry was found. +inline PYBIND11_NOINLINE void* get_shared_data(const std::string& name) +{ + auto& internals = detail::get_internals(); + auto it = internals.shared_data.find(name); + return it != internals.shared_data.end() ? it->second : nullptr; +} + +/// Set the shared data that can be later recovered by `get_shared_data()`. +inline PYBIND11_NOINLINE void* set_shared_data(const std::string& name, void* data) +{ + detail::get_internals().shared_data[name] = data; + return data; +} + +/// Returns a typed reference to a shared data entry (by using `get_shared_data()`) if +/// such entry exists. Otherwise, a new object of default-constructible type `T` is +/// added to the shared data under the given name and a reference to it is returned. +template <typename T> +T& get_or_create_shared_data(const std::string& name) +{ + auto& internals = detail::get_internals(); + auto it = internals.shared_data.find(name); + T* ptr = (T*)(it != internals.shared_data.end() ? it->second : nullptr); + if (!ptr) { + ptr = new T(); + internals.shared_data[name] = ptr; + } + return *ptr; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/detail/typeid.h b/dune/pybindxi/detail/typeid.h new file mode 100644 index 0000000000000000000000000000000000000000..f2d5d631111810216c241d7c6a7c3da372fe2d94 --- /dev/null +++ b/dune/pybindxi/detail/typeid.h @@ -0,0 +1,60 @@ +#pragma GCC system_header +/* + pybind11/detail/typeid.h: Compiler-independent access to type identifiers + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include <cstdio> +#include <cstdlib> + +#if defined(__GNUG__) +# include <cxxabi.h> +#endif + +#include "common.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) +/// Erase all occurrences of a substring +inline void erase_all(std::string& string, const std::string& search) +{ + for (size_t pos = 0;;) { + pos = string.find(search, pos); + if (pos == std::string::npos) + break; + string.erase(pos, search.length()); + } +} + +PYBIND11_NOINLINE inline void clean_type_id(std::string& name) +{ +#if defined(__GNUG__) + int status = 0; + std::unique_ptr<char, void (*)(void*)> res{abi::__cxa_demangle(name.c_str(), nullptr, nullptr, &status), std::free}; + if (status == 0) + name = res.get(); +#else + detail::erase_all(name, "class "); + detail::erase_all(name, "struct "); + detail::erase_all(name, "enum "); +#endif + detail::erase_all(name, "pybind11::"); +} +NAMESPACE_END(detail) + +/// Return a string representation of a C++ type +template <typename T> +static std::string type_id() +{ + std::string name(typeid(T).name()); + detail::clean_type_id(name); + return name; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/disable_pybindxi_warnings.sh b/dune/pybindxi/disable_pybindxi_warnings.sh new file mode 100755 index 0000000000000000000000000000000000000000..1b0ee98c3b66a0136c436d28df8d62bc939a297a --- /dev/null +++ b/dune/pybindxi/disable_pybindxi_warnings.sh @@ -0,0 +1,5 @@ +# specifies all pybind11 headers as system headers to disable warnings +# should also work for clang which supports some GCC macros for compatibility +# including as system folder does not work as we would have to include the whole dune-xt folder using -isystem +sed -i '1 i\#pragma GCC system_header' *.h +sed -i '1 i\#pragma GCC system_header' detail/*.h diff --git a/dune/pybindxi/eigen.h b/dune/pybindxi/eigen.h new file mode 100644 index 0000000000000000000000000000000000000000..56ecd9797faa0ea0e83023e079a369a4b1ae32d1 --- /dev/null +++ b/dune/pybindxi/eigen.h @@ -0,0 +1,703 @@ +#pragma GCC system_header +/* + pybind11/eigen.h: Transparent conversion for dense and sparse Eigen matrices + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "numpy.h" + +#if defined(__INTEL_COMPILER) +# pragma warning(disable : 1682) // implicit conversion of a 64-bit integral type to a smaller integral type (potential + // portability problem) +#elif defined(__GNUG__) || defined(__clang__) +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wconversion" +# pragma GCC diagnostic ignored "-Wdeprecated-declarations" +# ifdef __clang__ +// Eigen generates a bunch of implicit-copy-constructor-is-deprecated warnings with -Wdeprecated +// under Clang, so disable that warning here: +# pragma GCC diagnostic ignored "-Wdeprecated" +# endif +# if __GNUC__ >= 7 +# pragma GCC diagnostic ignored "-Wint-in-bool-context" +# endif +#endif + +#if defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable : 4127) // warning C4127: Conditional expression is constant +# pragma warning(disable : 4996) // warning C4996: std::unary_negate is deprecated in C++17 +#endif + +#include <Eigen/Core> +#include <Eigen/SparseCore> + +// Eigen prior to 3.2.7 doesn't have proper move constructors--but worse, some classes get implicit +// move constructors that break things. We could detect this an explicitly copy, but an extra copy +// of matrices seems highly undesirable. +static_assert(EIGEN_VERSION_AT_LEAST(3, 2, 7), "Eigen support in pybind11 requires Eigen >= 3.2.7"); + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +// Provide a convenience alias for easier pass-by-ref usage with fully dynamic strides: +using EigenDStride = Eigen::Stride<Eigen::Dynamic, Eigen::Dynamic>; +template <typename MatrixType> +using EigenDRef = Eigen::Ref<MatrixType, 0, EigenDStride>; +template <typename MatrixType> +using EigenDMap = Eigen::Map<MatrixType, 0, EigenDStride>; + +NAMESPACE_BEGIN(detail) + +#if EIGEN_VERSION_AT_LEAST(3, 3, 0) +using EigenIndex = Eigen::Index; +#else +using EigenIndex = EIGEN_DEFAULT_DENSE_INDEX_TYPE; +#endif + +// Matches Eigen::Map, Eigen::Ref, blocks, etc: +template <typename T> +using is_eigen_dense_map = + all_of<is_template_base_of<Eigen::DenseBase, T>, std::is_base_of<Eigen::MapBase<T, Eigen::ReadOnlyAccessors>, T>>; +template <typename T> +using is_eigen_mutable_map = std::is_base_of<Eigen::MapBase<T, Eigen::WriteAccessors>, T>; +template <typename T> +using is_eigen_dense_plain = all_of<negation<is_eigen_dense_map<T>>, is_template_base_of<Eigen::PlainObjectBase, T>>; +template <typename T> +using is_eigen_sparse = is_template_base_of<Eigen::SparseMatrixBase, T>; +// Test for objects inheriting from EigenBase<Derived> that aren't captured by the above. This +// basically covers anything that can be assigned to a dense matrix but that don't have a typical +// matrix data layout that can be copied from their .data(). For example, DiagonalMatrix and +// SelfAdjointView fall into this category. +template <typename T> +using is_eigen_other = all_of<is_template_base_of<Eigen::EigenBase, T>, + negation<any_of<is_eigen_dense_map<T>, is_eigen_dense_plain<T>, is_eigen_sparse<T>>>>; + +// Captures numpy/eigen conformability status (returned by EigenProps::conformable()): +template <bool EigenRowMajor> +struct EigenConformable +{ + bool conformable = false; + EigenIndex rows = 0, cols = 0; + EigenDStride stride{0, 0}; // Only valid if negativestrides is false! + bool negativestrides = false; // If true, do not use stride! + + EigenConformable(bool fits = false) + : conformable{fits} + {} + // Matrix type: + EigenConformable(EigenIndex r, EigenIndex c, EigenIndex rstride, EigenIndex cstride) + : conformable{true} + , rows{r} + , cols{c} + { + // TODO: when Eigen bug #747 is fixed, remove the tests for non-negativity. + // http://eigen.tuxfamily.org/bz/show_bug.cgi?id=747 + if (rstride < 0 || cstride < 0) { + negativestrides = true; + } else { + stride = {EigenRowMajor ? rstride : cstride /* outer stride */, + EigenRowMajor ? cstride : rstride /* inner stride */}; + } + } + // Vector type: + EigenConformable(EigenIndex r, EigenIndex c, EigenIndex stride) + : EigenConformable(r, c, r == 1 ? c * stride : stride, c == 1 ? r : r * stride) + {} + + template <typename props> + bool stride_compatible() const + { + // To have compatible strides, we need (on both dimensions) one of fully dynamic strides, + // matching strides, or a dimension size of 1 (in which case the stride value is irrelevant) + return !negativestrides + && (props::inner_stride == Eigen::Dynamic || props::inner_stride == stride.inner() + || (EigenRowMajor ? cols : rows) == 1) + && (props::outer_stride == Eigen::Dynamic || props::outer_stride == stride.outer() + || (EigenRowMajor ? rows : cols) == 1); + } + operator bool() const + { + return conformable; + } +}; + +template <typename Type> +struct eigen_extract_stride +{ + using type = Type; +}; +template <typename PlainObjectType, int MapOptions, typename StrideType> +struct eigen_extract_stride<Eigen::Map<PlainObjectType, MapOptions, StrideType>> +{ + using type = StrideType; +}; +template <typename PlainObjectType, int Options, typename StrideType> +struct eigen_extract_stride<Eigen::Ref<PlainObjectType, Options, StrideType>> +{ + using type = StrideType; +}; + +// Helper struct for extracting information from an Eigen type +template <typename Type_> +struct EigenProps +{ + using Type = Type_; + using Scalar = typename Type::Scalar; + using StrideType = typename eigen_extract_stride<Type>::type; + static constexpr EigenIndex rows = Type::RowsAtCompileTime, cols = Type::ColsAtCompileTime, + size = Type::SizeAtCompileTime; + static constexpr bool row_major = Type::IsRowMajor, + vector = Type::IsVectorAtCompileTime, // At least one dimension has fixed size 1 + fixed_rows = rows != Eigen::Dynamic, fixed_cols = cols != Eigen::Dynamic, + fixed = size != Eigen::Dynamic, // Fully-fixed size + dynamic = !fixed_rows && !fixed_cols; // Fully-dynamic size + + template <EigenIndex i, EigenIndex ifzero> + using if_zero = std::integral_constant<EigenIndex, i == 0 ? ifzero : i>; + static constexpr EigenIndex inner_stride = if_zero<StrideType::InnerStrideAtCompileTime, 1>::value, + outer_stride = if_zero < StrideType::OuterStrideAtCompileTime, + vector ? size : row_major ? cols : rows > ::value; + static constexpr bool dynamic_stride = inner_stride == Eigen::Dynamic && outer_stride == Eigen::Dynamic; + static constexpr bool requires_row_major = + !dynamic_stride && !vector && (row_major ? inner_stride : outer_stride) == 1; + static constexpr bool requires_col_major = + !dynamic_stride && !vector && (row_major ? outer_stride : inner_stride) == 1; + + // Takes an input array and determines whether we can make it fit into the Eigen type. If + // the array is a vector, we attempt to fit it into either an Eigen 1xN or Nx1 vector + // (preferring the latter if it will fit in either, i.e. for a fully dynamic matrix type). + static EigenConformable<row_major> conformable(const array& a) + { + const auto dims = a.ndim(); + if (dims < 1 || dims > 2) + return false; + + if (dims == 2) { // Matrix type: require exact match (or dynamic) + + EigenIndex np_rows = a.shape(0), np_cols = a.shape(1), + np_rstride = a.strides(0) / static_cast<ssize_t>(sizeof(Scalar)), + np_cstride = a.strides(1) / static_cast<ssize_t>(sizeof(Scalar)); + if ((fixed_rows && np_rows != rows) || (fixed_cols && np_cols != cols)) + return false; + + return {np_rows, np_cols, np_rstride, np_cstride}; + } + + // Otherwise we're storing an n-vector. Only one of the strides will be used, but whichever + // is used, we want the (single) numpy stride value. + const EigenIndex n = a.shape(0), stride = a.strides(0) / static_cast<ssize_t>(sizeof(Scalar)); + + if (vector) { // Eigen type is a compile-time vector + if (fixed && size != n) + return false; // Vector size mismatch + return {rows == 1 ? 1 : n, cols == 1 ? 1 : n, stride}; + } else if (fixed) { + // The type has a fixed size, but is not a vector: abort + return false; + } else if (fixed_cols) { + // Since this isn't a vector, cols must be != 1. We allow this only if it exactly + // equals the number of elements (rows is Dynamic, and so 1 row is allowed). + if (cols != n) + return false; + return {1, n, stride}; + } else { + // Otherwise it's either fully dynamic, or column dynamic; both become a column vector + if (fixed_rows && rows != n) + return false; + return {n, 1, stride}; + } + } + + static constexpr bool show_writeable = is_eigen_dense_map<Type>::value && is_eigen_mutable_map<Type>::value; + static constexpr bool show_order = is_eigen_dense_map<Type>::value; + static constexpr bool show_c_contiguous = show_order && requires_row_major; + static constexpr bool show_f_contiguous = !show_c_contiguous && show_order && requires_col_major; + + static constexpr auto descriptor = + _("numpy.ndarray[") + npy_format_descriptor<Scalar>::name + _("[") + _<fixed_rows>(_<(size_t)rows>(), _("m")) + + _(", ") + _<fixed_cols>(_<(size_t)cols>(), _("n")) + _("]") + + // For a reference type (e.g. Ref<MatrixXd>) we have other constraints that might need to be + // satisfied: writeable=True (for a mutable reference), and, depending on the map's stride + // options, possibly f_contiguous or c_contiguous. We include them in the descriptor output + // to provide some hint as to why a TypeError is occurring (otherwise it can be confusing to + // see that a function accepts a 'numpy.ndarray[float64[3,2]]' and an error message that you + // *gave* a numpy.ndarray of the right type and dimensions. + _<show_writeable>(", flags.writeable", "") + _<show_c_contiguous>(", flags.c_contiguous", "") + + _<show_f_contiguous>(", flags.f_contiguous", "") + _("]"); +}; + +// Casts an Eigen type to numpy array. If given a base, the numpy array references the src data, +// otherwise it'll make a copy. writeable lets you turn off the writeable flag for the array. +template <typename props> +handle eigen_array_cast(typename props::Type const& src, handle base = handle(), bool writeable = true) +{ + constexpr ssize_t elem_size = sizeof(typename props::Scalar); + array a; + if (props::vector) + a = array({src.size()}, {elem_size * src.innerStride()}, src.data(), base); + else + a = array({src.rows(), src.cols()}, {elem_size * src.rowStride(), elem_size * src.colStride()}, src.data(), base); + + if (!writeable) + array_proxy(a.ptr())->flags &= ~detail::npy_api::NPY_ARRAY_WRITEABLE_; + + return a.release(); +} + +// Takes an lvalue ref to some Eigen type and a (python) base object, creating a numpy array that +// reference the Eigen object's data with `base` as the python-registered base class (if omitted, +// the base will be set to None, and lifetime management is up to the caller). The numpy array is +// non-writeable if the given type is const. +template <typename props, typename Type> +handle eigen_ref_array(Type& src, handle parent = none()) +{ + // none here is to get past array's should-we-copy detection, which currently always + // copies when there is no base. Setting the base to None should be harmless. + return eigen_array_cast<props>(src, parent, !std::is_const<Type>::value); +} + +// Takes a pointer to some dense, plain Eigen type, builds a capsule around it, then returns a numpy +// array that references the encapsulated data with a python-side reference to the capsule to tie +// its destruction to that of any dependent python objects. Const-ness is determined by whether or +// not the Type of the pointer given is const. +template <typename props, typename Type, typename = enable_if_t<is_eigen_dense_plain<Type>::value>> +handle eigen_encapsulate(Type* src) +{ + capsule base(src, [](void* o) { delete static_cast<Type*>(o); }); + return eigen_ref_array<props>(*src, base); +} + +// Type caster for regular, dense matrix types (e.g. MatrixXd), but not maps/refs/etc. of dense +// types. +template <typename Type> +struct type_caster<Type, enable_if_t<is_eigen_dense_plain<Type>::value>> +{ + using Scalar = typename Type::Scalar; + using props = EigenProps<Type>; + + bool load(handle src, bool convert) + { + // If we're in no-convert mode, only load if given an array of the correct type + if (!convert && !isinstance<array_t<Scalar>>(src)) + return false; + + // Coerce into an array, but don't do type conversion yet; the copy below handles it. + auto buf = array::ensure(src); + + if (!buf) + return false; + + auto dims = buf.ndim(); + if (dims < 1 || dims > 2) + return false; + + auto fits = props::conformable(buf); + if (!fits) + return false; + + // Allocate the new type, then build a numpy reference into it + value = Type(fits.rows, fits.cols); + auto ref = reinterpret_steal<array>(eigen_ref_array<props>(value)); + if (dims == 1) + ref = ref.squeeze(); + else if (ref.ndim() == 1) + buf = buf.squeeze(); + + int result = detail::npy_api::get().PyArray_CopyInto_(ref.ptr(), buf.ptr()); + + if (result < 0) { // Copy failed! + PyErr_Clear(); + return false; + } + + return true; + } + +private: + // Cast implementation + template <typename CType> + static handle cast_impl(CType* src, return_value_policy policy, handle parent) + { + switch (policy) { + case return_value_policy::take_ownership: + case return_value_policy::automatic: + return eigen_encapsulate<props>(src); + case return_value_policy::move: + return eigen_encapsulate<props>(new CType(std::move(*src))); + case return_value_policy::copy: + return eigen_array_cast<props>(*src); + case return_value_policy::reference: + case return_value_policy::automatic_reference: + return eigen_ref_array<props>(*src); + case return_value_policy::reference_internal: + return eigen_ref_array<props>(*src, parent); + default: + throw cast_error("unhandled return_value_policy: should not happen!"); + }; + } + +public: + // Normal returned non-reference, non-const value: + static handle cast(Type&& src, return_value_policy /* policy */, handle parent) + { + return cast_impl(&src, return_value_policy::move, parent); + } + // If you return a non-reference const, we mark the numpy array readonly: + static handle cast(const Type&& src, return_value_policy /* policy */, handle parent) + { + return cast_impl(&src, return_value_policy::move, parent); + } + // lvalue reference return; default (automatic) becomes copy + static handle cast(Type& src, return_value_policy policy, handle parent) + { + if (policy == return_value_policy::automatic || policy == return_value_policy::automatic_reference) + policy = return_value_policy::copy; + return cast_impl(&src, policy, parent); + } + // const lvalue reference return; default (automatic) becomes copy + static handle cast(const Type& src, return_value_policy policy, handle parent) + { + if (policy == return_value_policy::automatic || policy == return_value_policy::automatic_reference) + policy = return_value_policy::copy; + return cast(&src, policy, parent); + } + // non-const pointer return + static handle cast(Type* src, return_value_policy policy, handle parent) + { + return cast_impl(src, policy, parent); + } + // const pointer return + static handle cast(const Type* src, return_value_policy policy, handle parent) + { + return cast_impl(src, policy, parent); + } + + static constexpr auto name = props::descriptor; + + operator Type*() + { + return &value; + } + operator Type&() + { + return value; + } + operator Type &&() && + { + return std::move(value); + } + template <typename T> + using cast_op_type = movable_cast_op_type<T>; + +private: + Type value; +}; + +// Base class for casting reference/map/block/etc. objects back to python. +template <typename MapType> +struct eigen_map_caster +{ +private: + using props = EigenProps<MapType>; + +public: + // Directly referencing a ref/map's data is a bit dangerous (whatever the map/ref points to has + // to stay around), but we'll allow it under the assumption that you know what you're doing (and + // have an appropriate keep_alive in place). We return a numpy array pointing directly at the + // ref's data (The numpy array ends up read-only if the ref was to a const matrix type.) Note + // that this means you need to ensure you don't destroy the object in some other way (e.g. with + // an appropriate keep_alive, or with a reference to a statically allocated matrix). + static handle cast(const MapType& src, return_value_policy policy, handle parent) + { + switch (policy) { + case return_value_policy::copy: + return eigen_array_cast<props>(src); + case return_value_policy::reference_internal: + return eigen_array_cast<props>(src, parent, is_eigen_mutable_map<MapType>::value); + case return_value_policy::reference: + case return_value_policy::automatic: + case return_value_policy::automatic_reference: + return eigen_array_cast<props>(src, none(), is_eigen_mutable_map<MapType>::value); + default: + // move, take_ownership don't make any sense for a ref/map: + pybind11_fail("Invalid return_value_policy for Eigen Map/Ref/Block type"); + } + } + + static constexpr auto name = props::descriptor; + + // Explicitly delete these: support python -> C++ conversion on these (i.e. these can be return + // types but not bound arguments). We still provide them (with an explicitly delete) so that + // you end up here if you try anyway. + bool load(handle, bool) = delete; + operator MapType() = delete; + template <typename> + using cast_op_type = MapType; +}; + +// We can return any map-like object (but can only load Refs, specialized next): +template <typename Type> +struct type_caster<Type, enable_if_t<is_eigen_dense_map<Type>::value>> : eigen_map_caster<Type> +{}; + +// Loader for Ref<...> arguments. See the documentation for info on how to make this work without +// copying (it requires some extra effort in many cases). +template <typename PlainObjectType, typename StrideType> +struct type_caster<Eigen::Ref<PlainObjectType, 0, StrideType>, + enable_if_t<is_eigen_dense_map<Eigen::Ref<PlainObjectType, 0, StrideType>>::value>> + : public eigen_map_caster<Eigen::Ref<PlainObjectType, 0, StrideType>> +{ +private: + using Type = Eigen::Ref<PlainObjectType, 0, StrideType>; + using props = EigenProps<Type>; + using Scalar = typename props::Scalar; + using MapType = Eigen::Map<PlainObjectType, 0, StrideType>; + using Array = + array_t<Scalar, + array::forcecast + | ((props::row_major ? props::inner_stride : props::outer_stride) == 1 + ? array::c_style + : (props::row_major ? props::outer_stride : props::inner_stride) == 1 ? array::f_style : 0)>; + static constexpr bool need_writeable = is_eigen_mutable_map<Type>::value; + // Delay construction (these have no default constructor) + std::unique_ptr<MapType> map; + std::unique_ptr<Type> ref; + // Our array. When possible, this is just a numpy array pointing to the source data, but + // sometimes we can't avoid copying (e.g. input is not a numpy array at all, has an incompatible + // layout, or is an array of a type that needs to be converted). Using a numpy temporary + // (rather than an Eigen temporary) saves an extra copy when we need both type conversion and + // storage order conversion. (Note that we refuse to use this temporary copy when loading an + // argument for a Ref<M> with M non-const, i.e. a read-write reference). + Array copy_or_ref; + +public: + bool load(handle src, bool convert) + { + // First check whether what we have is already an array of the right type. If not, we can't + // avoid a copy (because the copy is also going to do type conversion). + bool need_copy = !isinstance<Array>(src); + + EigenConformable<props::row_major> fits; + if (!need_copy) { + // We don't need a converting copy, but we also need to check whether the strides are + // compatible with the Ref's stride requirements + Array aref = reinterpret_borrow<Array>(src); + + if (aref && (!need_writeable || aref.writeable())) { + fits = props::conformable(aref); + if (!fits) + return false; // Incompatible dimensions + if (!fits.template stride_compatible<props>()) + need_copy = true; + else + copy_or_ref = std::move(aref); + } else { + need_copy = true; + } + } + + if (need_copy) { + // We need to copy: If we need a mutable reference, or we're not supposed to convert + // (either because we're in the no-convert overload pass, or because we're explicitly + // instructed not to copy (via `py::arg().noconvert()`) we have to fail loading. + if (!convert || need_writeable) + return false; + + Array copy = Array::ensure(src); + if (!copy) + return false; + fits = props::conformable(copy); + if (!fits || !fits.template stride_compatible<props>()) + return false; + copy_or_ref = std::move(copy); + loader_life_support::add_patient(copy_or_ref); + } + + ref.reset(); + map.reset( + new MapType(data(copy_or_ref), fits.rows, fits.cols, make_stride(fits.stride.outer(), fits.stride.inner()))); + ref.reset(new Type(*map)); + + return true; + } + + operator Type*() + { + return ref.get(); + } + operator Type&() + { + return *ref; + } + template <typename _T> + using cast_op_type = pybind11::detail::cast_op_type<_T>; + +private: + template <typename T = Type, enable_if_t<is_eigen_mutable_map<T>::value, int> = 0> + Scalar* data(Array& a) + { + return a.mutable_data(); + } + + template <typename T = Type, enable_if_t<!is_eigen_mutable_map<T>::value, int> = 0> + const Scalar* data(Array& a) + { + return a.data(); + } + + // Attempt to figure out a constructor of `Stride` that will work. + // If both strides are fixed, use a default constructor: + template <typename S> + using stride_ctor_default = + bool_constant<S::InnerStrideAtCompileTime != Eigen::Dynamic && S::OuterStrideAtCompileTime != Eigen::Dynamic + && std::is_default_constructible<S>::value>; + // Otherwise, if there is a two-index constructor, assume it is (outer,inner) like + // Eigen::Stride, and use it: + template <typename S> + using stride_ctor_dual = + bool_constant<!stride_ctor_default<S>::value && std::is_constructible<S, EigenIndex, EigenIndex>::value>; + // Otherwise, if there is a one-index constructor, and just one of the strides is dynamic, use + // it (passing whichever stride is dynamic). + template <typename S> + using stride_ctor_outer = + bool_constant<!any_of<stride_ctor_default<S>, stride_ctor_dual<S>>::value + && S::OuterStrideAtCompileTime == Eigen::Dynamic && S::InnerStrideAtCompileTime != Eigen::Dynamic + && std::is_constructible<S, EigenIndex>::value>; + template <typename S> + using stride_ctor_inner = + bool_constant<!any_of<stride_ctor_default<S>, stride_ctor_dual<S>>::value + && S::InnerStrideAtCompileTime == Eigen::Dynamic && S::OuterStrideAtCompileTime != Eigen::Dynamic + && std::is_constructible<S, EigenIndex>::value>; + + template <typename S = StrideType, enable_if_t<stride_ctor_default<S>::value, int> = 0> + static S make_stride(EigenIndex, EigenIndex) + { + return S(); + } + template <typename S = StrideType, enable_if_t<stride_ctor_dual<S>::value, int> = 0> + static S make_stride(EigenIndex outer, EigenIndex inner) + { + return S(outer, inner); + } + template <typename S = StrideType, enable_if_t<stride_ctor_outer<S>::value, int> = 0> + static S make_stride(EigenIndex outer, EigenIndex) + { + return S(outer); + } + template <typename S = StrideType, enable_if_t<stride_ctor_inner<S>::value, int> = 0> + static S make_stride(EigenIndex, EigenIndex inner) + { + return S(inner); + } +}; + +// type_caster for special matrix types (e.g. DiagonalMatrix), which are EigenBase, but not +// EigenDense (i.e. they don't have a data(), at least not with the usual matrix layout). +// load() is not supported, but we can cast them into the python domain by first copying to a +// regular Eigen::Matrix, then casting that. +template <typename Type> +struct type_caster<Type, enable_if_t<is_eigen_other<Type>::value>> +{ +protected: + using Matrix = Eigen::Matrix<typename Type::Scalar, Type::RowsAtCompileTime, Type::ColsAtCompileTime>; + using props = EigenProps<Matrix>; + +public: + static handle cast(const Type& src, return_value_policy /* policy */, handle /* parent */) + { + handle h = eigen_encapsulate<props>(new Matrix(src)); + return h; + } + static handle cast(const Type* src, return_value_policy policy, handle parent) + { + return cast(*src, policy, parent); + } + + static constexpr auto name = props::descriptor; + + // Explicitly delete these: support python -> C++ conversion on these (i.e. these can be return + // types but not bound arguments). We still provide them (with an explicitly delete) so that + // you end up here if you try anyway. + bool load(handle, bool) = delete; + operator Type() = delete; + template <typename> + using cast_op_type = Type; +}; + +template <typename Type> +struct type_caster<Type, enable_if_t<is_eigen_sparse<Type>::value>> +{ + typedef typename Type::Scalar Scalar; + typedef remove_reference_t<decltype(*std::declval<Type>().outerIndexPtr())> StorageIndex; + typedef typename Type::Index Index; + static constexpr bool rowMajor = Type::IsRowMajor; + + bool load(handle src, bool) + { + if (!src) + return false; + + auto obj = reinterpret_borrow<object>(src); + object sparse_module = module::import("scipy.sparse"); + object matrix_type = sparse_module.attr(rowMajor ? "csr_matrix" : "csc_matrix"); + + if (!obj.get_type().is(matrix_type)) { + try { + obj = matrix_type(obj); + } catch (const error_already_set&) { + return false; + } + } + + auto values = array_t<Scalar>((object)obj.attr("data")); + auto innerIndices = array_t<StorageIndex>((object)obj.attr("indices")); + auto outerIndices = array_t<StorageIndex>((object)obj.attr("indptr")); + auto shape = pybind11::tuple((pybind11::object)obj.attr("shape")); + auto nnz = obj.attr("nnz").cast<Index>(); + + if (!values || !innerIndices || !outerIndices) + return false; + + value = Eigen::MappedSparseMatrix<Scalar, Type::Flags, StorageIndex>(shape[0].cast<Index>(), + shape[1].cast<Index>(), + nnz, + outerIndices.mutable_data(), + innerIndices.mutable_data(), + values.mutable_data()); + + return true; + } + + static handle cast(const Type& src, return_value_policy /* policy */, handle /* parent */) + { + const_cast<Type&>(src).makeCompressed(); + + object matrix_type = module::import("scipy.sparse").attr(rowMajor ? "csr_matrix" : "csc_matrix"); + + array data(src.nonZeros(), src.valuePtr()); + array outerIndices((rowMajor ? src.rows() : src.cols()) + 1, src.outerIndexPtr()); + array innerIndices(src.nonZeros(), src.innerIndexPtr()); + + return matrix_type(std::make_tuple(data, innerIndices, outerIndices), std::make_pair(src.rows(), src.cols())) + .release(); + } + + PYBIND11_TYPE_CASTER(Type, + _<(Type::IsRowMajor) != 0>("scipy.sparse.csr_matrix[", "scipy.sparse.csc_matrix[") + + npy_format_descriptor<Scalar>::name + _("]")); +}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(__GNUG__) || defined(__clang__) +# pragma GCC diagnostic pop +#elif defined(_MSC_VER) +# pragma warning(pop) +#endif diff --git a/dune/pybindxi/embed.h b/dune/pybindxi/embed.h new file mode 100644 index 0000000000000000000000000000000000000000..0aedd584701998d4fd913d9a519555fbaed35f74 --- /dev/null +++ b/dune/pybindxi/embed.h @@ -0,0 +1,213 @@ +#pragma GCC system_header +/* + pybind11/embed.h: Support for embedding the interpreter + + Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include "eval.h" + +#if defined(PYPY_VERSION) +# error Embedding the interpreter is not supported with PyPy +#endif + +#if PY_MAJOR_VERSION >= 3 +# define PYBIND11_EMBEDDED_MODULE_IMPL(name) \ + extern "C" PyObject* pybind11_init_impl_##name() \ + { \ + return pybind11_init_wrapper_##name(); \ + } +#else +# define PYBIND11_EMBEDDED_MODULE_IMPL(name) \ + extern "C" void pybind11_init_impl_##name() \ + { \ + pybind11_init_wrapper_##name(); \ + } +#endif + +/** \rst + Add a new module to the table of builtins for the interpreter. Must be + defined in global scope. The first macro parameter is the name of the + module (without quotes). The second parameter is the variable which will + be used as the interface to add functions and classes to the module. + + .. code-block:: cpp + + PYBIND11_EMBEDDED_MODULE(example, m) { + // ... initialize functions and classes here + m.def("foo", []() { + return "Hello, World!"; + }); + } + \endrst */ +#define PYBIND11_EMBEDDED_MODULE(name, variable) \ + static void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module&); \ + static PyObject PYBIND11_CONCAT(*pybind11_init_wrapper_, name)() \ + { \ + auto m = pybind11::module(PYBIND11_TOSTRING(name)); \ + try { \ + PYBIND11_CONCAT(pybind11_init_, name)(m); \ + return m.ptr(); \ + } catch (pybind11::error_already_set & e) { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } catch (const std::exception& e) { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } \ + } \ + PYBIND11_EMBEDDED_MODULE_IMPL(name) \ + pybind11::detail::embedded_module name(PYBIND11_TOSTRING(name), PYBIND11_CONCAT(pybind11_init_impl_, name)); \ + void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module & variable) + + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// Python 2.7/3.x compatible version of `PyImport_AppendInittab` and error checks. +struct embedded_module +{ +#if PY_MAJOR_VERSION >= 3 + using init_t = PyObject* (*)(); +#else + using init_t = void (*)(); +#endif + embedded_module(const char* name, init_t init) + { + if (Py_IsInitialized()) + pybind11_fail("Can't add new modules after the interpreter has been initialized"); + + auto result = PyImport_AppendInittab(name, init); + if (result == -1) + pybind11_fail("Insufficient memory to add a new module"); + } +}; + +NAMESPACE_END(detail) + +/** \rst + Initialize the Python interpreter. No other pybind11 or CPython API functions can be + called before this is done; with the exception of `PYBIND11_EMBEDDED_MODULE`. The + optional parameter can be used to skip the registration of signal handlers (see the + `Python documentation`_ for details). Calling this function again after the interpreter + has already been initialized is a fatal error. + + If initializing the Python interpreter fails, then the program is terminated. (This + is controlled by the CPython runtime and is an exception to pybind11's normal behavior + of throwing exceptions on errors.) + + .. _Python documentation: https://docs.python.org/3/c-api/init.html#c.Py_InitializeEx + \endrst */ +inline void initialize_interpreter(bool init_signal_handlers = true) +{ + if (Py_IsInitialized()) + pybind11_fail("The interpreter is already running"); + + Py_InitializeEx(init_signal_handlers ? 1 : 0); + + // Make .py files in the working directory available by default + module::import("sys").attr("path").cast<list>().append("."); +} + +/** \rst + Shut down the Python interpreter. No pybind11 or CPython API functions can be called + after this. In addition, pybind11 objects must not outlive the interpreter: + + .. code-block:: cpp + + { // BAD + py::initialize_interpreter(); + auto hello = py::str("Hello, World!"); + py::finalize_interpreter(); + } // <-- BOOM, hello's destructor is called after interpreter shutdown + + { // GOOD + py::initialize_interpreter(); + { // scoped + auto hello = py::str("Hello, World!"); + } // <-- OK, hello is cleaned up properly + py::finalize_interpreter(); + } + + { // BETTER + py::scoped_interpreter guard{}; + auto hello = py::str("Hello, World!"); + } + + .. warning:: + + The interpreter can be restarted by calling `initialize_interpreter` again. + Modules created using pybind11 can be safely re-initialized. However, Python + itself cannot completely unload binary extension modules and there are several + caveats with regard to interpreter restarting. All the details can be found + in the CPython documentation. In short, not all interpreter memory may be + freed, either due to reference cycles or user-created global data. + + \endrst */ +inline void finalize_interpreter() +{ + handle builtins(PyEval_GetBuiltins()); + const char* id = PYBIND11_INTERNALS_ID; + + // Get the internals pointer (without creating it if it doesn't exist). It's possible for the + // internals to be created during Py_Finalize() (e.g. if a py::capsule calls `get_internals()` + // during destruction), so we get the pointer-pointer here and check it after Py_Finalize(). + detail::internals** internals_ptr_ptr = detail::get_internals_pp(); + // It could also be stashed in builtins, so look there too: + if (builtins.contains(id) && isinstance<capsule>(builtins[id])) + internals_ptr_ptr = capsule(builtins[id]); + + Py_Finalize(); + + if (internals_ptr_ptr) { + delete *internals_ptr_ptr; + *internals_ptr_ptr = nullptr; + } +} + +/** \rst + Scope guard version of `initialize_interpreter` and `finalize_interpreter`. + This a move-only guard and only a single instance can exist. + + .. code-block:: cpp + + #include <pybind11/embed.h> + + int main() { + py::scoped_interpreter guard{}; + py::print(Hello, World!); + } // <-- interpreter shutdown + \endrst */ +class scoped_interpreter +{ +public: + scoped_interpreter(bool init_signal_handlers = true) + { + initialize_interpreter(init_signal_handlers); + } + + scoped_interpreter(const scoped_interpreter&) = delete; + scoped_interpreter(scoped_interpreter&& other) noexcept + { + other.is_valid = false; + } + scoped_interpreter& operator=(const scoped_interpreter&) = delete; + scoped_interpreter& operator=(scoped_interpreter&&) = delete; + + ~scoped_interpreter() + { + if (is_valid) + finalize_interpreter(); + } + +private: + bool is_valid = true; +}; + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/eval.h b/dune/pybindxi/eval.h new file mode 100644 index 0000000000000000000000000000000000000000..6cf02abb8bf926409f62e5e9c5a8d01b05347eca --- /dev/null +++ b/dune/pybindxi/eval.h @@ -0,0 +1,134 @@ +#pragma GCC system_header +/* + pybind11/exec.h: Support for evaluating Python expressions and statements + from strings and files + + Copyright (c) 2016 Klemens Morgenstern <klemens.morgenstern@ed-chemnitz.de> and + Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +enum eval_mode +{ + /// Evaluate a string containing an isolated expression + eval_expr, + + /// Evaluate a string containing a single statement. Returns \c none + eval_single_statement, + + /// Evaluate a string containing a sequence of statement. Returns \c none + eval_statements +}; + +template <eval_mode mode = eval_expr> +object eval(str expr, object global = globals(), object local = object()) +{ + if (!local) + local = global; + + /* PyRun_String does not accept a PyObject / encoding specifier, + this seems to be the only alternative */ + std::string buffer = "# -*- coding: utf-8 -*-\n" + (std::string)expr; + + int start; + switch (mode) { + case eval_expr: + start = Py_eval_input; + break; + case eval_single_statement: + start = Py_single_input; + break; + case eval_statements: + start = Py_file_input; + break; + default: + pybind11_fail("invalid evaluation mode"); + } + + PyObject* result = PyRun_String(buffer.c_str(), start, global.ptr(), local.ptr()); + if (!result) + throw error_already_set(); + return reinterpret_steal<object>(result); +} + +template <eval_mode mode = eval_expr, size_t N> +object eval(const char (&s)[N], object global = globals(), object local = object()) +{ + /* Support raw string literals by removing common leading whitespace */ + auto expr = (s[0] == '\n') ? str(module::import("textwrap").attr("dedent")(s)) : str(s); + return eval<mode>(expr, global, local); +} + +inline void exec(str expr, object global = globals(), object local = object()) +{ + eval<eval_statements>(expr, global, local); +} + +template <size_t N> +void exec(const char (&s)[N], object global = globals(), object local = object()) +{ + eval<eval_statements>(s, global, local); +} + +template <eval_mode mode = eval_statements> +object eval_file(str fname, object global = globals(), object local = object()) +{ + if (!local) + local = global; + + int start; + switch (mode) { + case eval_expr: + start = Py_eval_input; + break; + case eval_single_statement: + start = Py_single_input; + break; + case eval_statements: + start = Py_file_input; + break; + default: + pybind11_fail("invalid evaluation mode"); + } + + int closeFile = 1; + std::string fname_str = (std::string)fname; +#if PY_VERSION_HEX >= 0x03040000 + FILE* f = _Py_fopen_obj(fname.ptr(), "r"); +#elif PY_VERSION_HEX >= 0x03000000 + FILE* f = _Py_fopen(fname.ptr(), "r"); +#else + /* No unicode support in open() :( */ + auto fobj = + reinterpret_steal<object>(PyFile_FromString(const_cast<char*>(fname_str.c_str()), const_cast<char*>("r"))); + FILE* f = nullptr; + if (fobj) + f = PyFile_AsFile(fobj.ptr()); + closeFile = 0; +#endif + if (!f) { + PyErr_Clear(); + pybind11_fail("File \"" + fname_str + "\" could not be opened!"); + } + +#if PY_VERSION_HEX < 0x03000000 && defined(PYPY_VERSION) + PyObject* result = PyRun_File(f, fname_str.c_str(), start, global.ptr(), local.ptr()); + (void)closeFile; +#else + PyObject* result = PyRun_FileEx(f, fname_str.c_str(), start, global.ptr(), local.ptr(), closeFile); +#endif + + if (!result) + throw error_already_set(); + return reinterpret_steal<object>(result); +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/functional.h b/dune/pybindxi/functional.h new file mode 100644 index 0000000000000000000000000000000000000000..6e515584529cd3c43e308c5533567469e2191150 --- /dev/null +++ b/dune/pybindxi/functional.h @@ -0,0 +1,107 @@ +#pragma GCC system_header +/* + pybind11/functional.h: std::function<> support + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include <functional> + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +template <typename Return, typename... Args> +struct type_caster<std::function<Return(Args...)>> +{ + using type = std::function<Return(Args...)>; + using retval_type = conditional_t<std::is_same<Return, void>::value, void_type, Return>; + using function_type = Return (*)(Args...); + +public: + bool load(handle src, bool convert) + { + if (src.is_none()) { + // Defer accepting None to other overloads (if we aren't in convert mode): + if (!convert) + return false; + return true; + } + + if (!isinstance<function>(src)) + return false; + + auto func = reinterpret_borrow<function>(src); + + /* + When passing a C++ function as an argument to another C++ + function via Python, every function call would normally involve + a full C++ -> Python -> C++ roundtrip, which can be prohibitive. + Here, we try to at least detect the case where the function is + stateless (i.e. function pointer or lambda function without + captured variables), in which case the roundtrip can be avoided. + */ + if (auto cfunc = func.cpp_function()) { + auto c = reinterpret_borrow<capsule>(PyCFunction_GET_SELF(cfunc.ptr())); + auto rec = (function_record*)c; + + if (rec && rec->is_stateless + && same_type(typeid(function_type), *reinterpret_cast<const std::type_info*>(rec->data[1]))) { + struct capture + { + function_type f; + }; + value = ((capture*)&rec->data)->f; + return true; + } + } + + // ensure GIL is held during functor destruction + struct func_handle + { + function f; + func_handle(function&& f_) + : f(std::move(f_)) + {} + func_handle(const func_handle&) = default; + ~func_handle() + { + gil_scoped_acquire acq; + function kill_f(std::move(f)); + } + }; + + value = [hfunc = func_handle(std::move(func))](Args... args) -> Return { + gil_scoped_acquire acq; + object retval(hfunc.f(std::forward<Args>(args)...)); + /* Visual studio 2015 parser issue: need parentheses around this expression */ + return (retval.template cast<Return>()); + }; + return true; + } + + template <typename Func> + static handle cast(Func&& f_, return_value_policy policy, handle /* parent */) + { + if (!f_) + return none().inc_ref(); + + auto result = f_.template target<function_type>(); + if (result) + return cpp_function(*result, policy).release(); + else + return cpp_function(std::forward<Func>(f_), policy).release(); + } + + PYBIND11_TYPE_CASTER(type, + _("Callable[[") + concat(make_caster<Args>::name...) + _("], ") + make_caster<retval_type>::name + + _("]")); +}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/interpreter.cc b/dune/pybindxi/interpreter.cc new file mode 100644 index 0000000000000000000000000000000000000000..ee956181afa8cd2fbd2fe85f2bd70f16bf7bc755 --- /dev/null +++ b/dune/pybindxi/interpreter.cc @@ -0,0 +1,36 @@ +// This file is part of the dune-pybindxi project: +// https://github.com/dune-community/dune-pybindxi +// Copyright 2009-2017 dune-pybindxi developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// Felix Schindler (2017) + +#include "interpreter.hh" + +namespace Dune { +namespace PybindXI { + + +pybind11::module ScopedInterpreter::import_module(const std::string& module_name) +{ + auto result = modules_.find(module_name); + if (result != modules_.end()) + return result->second; + else { + modules_[module_name] = pybind11::module::import(module_name.c_str()); + return modules_[module_name]; + } +} // ... load_module(...) + + +ScopedInterpreter& GlobalInterpreter() +{ + static ScopedInterpreter global_interpreter; + return global_interpreter; +} + + +} // namespace PybindXI +} // namespace Dune diff --git a/dune/pybindxi/interpreter.hh b/dune/pybindxi/interpreter.hh new file mode 100644 index 0000000000000000000000000000000000000000..64ca078e3202628afddd55fadfa6005c9bfe067d --- /dev/null +++ b/dune/pybindxi/interpreter.hh @@ -0,0 +1,45 @@ +// This file is part of the dune-pybindxi project: +// https://github.com/dune-community/dune-pybindxi +// Copyright 2009-2017 dune-pybindxi developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// Felix Schindler (2017) + +#ifndef DUNE_PYBINDXI_INTERPRETER_HH +#define DUNE_PYBINDXI_INTERPRETER_HH + +#include <map> +#include <string> + +#include <dune/common/visibility.hh> + +#include "embed.h" + +namespace Dune { +namespace PybindXI { + + +/** + * \note Most likely, you do not want to use this class directly, but + * GlobalInterpreter instead! + */ +class DUNE_EXPORT ScopedInterpreter +{ +public: + pybind11::module import_module(const std::string& module_name); + +private: + pybind11::scoped_interpreter interpreter_; + std::map<std::string, pybind11::module> modules_; +}; // class ScopedInterpreter + + +DUNE_EXPORT ScopedInterpreter& GlobalInterpreter(); + + +} // namespace PybindXI +} // namespace Dune + +#endif // DUNE_PYBINDXI_INTERPRETER_HH diff --git a/dune/pybindxi/iostream.h b/dune/pybindxi/iostream.h new file mode 100644 index 0000000000000000000000000000000000000000..60c98dce87e12d5b56a8e1589943a7728ae7205e --- /dev/null +++ b/dune/pybindxi/iostream.h @@ -0,0 +1,220 @@ +#pragma GCC system_header +/* + pybind11/iostream.h -- Tools to assist with redirecting cout and cerr to Python + + Copyright (c) 2017 Henry F. Schreiner + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" + +#include <streambuf> +#include <ostream> +#include <string> +#include <memory> +#include <iostream> + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +// Buffer that writes to Python instead of C++ +class pythonbuf : public std::streambuf +{ +private: + using traits_type = std::streambuf::traits_type; + + const size_t buf_size; + std::unique_ptr<char[]> d_buffer; + object pywrite; + object pyflush; + + int overflow(int c) + { + if (!traits_type::eq_int_type(c, traits_type::eof())) { + *pptr() = traits_type::to_char_type(c); + pbump(1); + } + return sync() == 0 ? traits_type::not_eof(c) : traits_type::eof(); + } + + int sync() + { + if (pbase() != pptr()) { + // This subtraction cannot be negative, so dropping the sign + str line(pbase(), static_cast<size_t>(pptr() - pbase())); + + { + gil_scoped_acquire tmp; + pywrite(line); + pyflush(); + } + + setp(pbase(), epptr()); + } + return 0; + } + +public: + pythonbuf(object pyostream, size_t buffer_size = 1024) + : buf_size(buffer_size) + , d_buffer(new char[buf_size]) + , pywrite(pyostream.attr("write")) + , pyflush(pyostream.attr("flush")) + { + setp(d_buffer.get(), d_buffer.get() + buf_size - 1); + } + + /// Sync before destroy + ~pythonbuf() + { + sync(); + } +}; + +NAMESPACE_END(detail) + + +/** \rst + This a move-only guard that redirects output. + + .. code-block:: cpp + + #include <pybind11/iostream.h> + + ... + + { + py::scoped_ostream_redirect output; + std::cout << "Hello, World!"; // Python stdout + } // <-- return std::cout to normal + + You can explicitly pass the c++ stream and the python object, + for example to guard stderr instead. + + .. code-block:: cpp + + { + py::scoped_ostream_redirect output{std::cerr, py::module::import("sys").attr("stderr")}; + std::cerr << "Hello, World!"; + } + \endrst */ +class scoped_ostream_redirect +{ +protected: + std::streambuf* old; + std::ostream& costream; + detail::pythonbuf buffer; + +public: + scoped_ostream_redirect(std::ostream& costream = std::cout, object pyostream = module::import("sys").attr("stdout")) + : costream(costream) + , buffer(pyostream) + { + old = costream.rdbuf(&buffer); + } + + ~scoped_ostream_redirect() + { + costream.rdbuf(old); + } + + scoped_ostream_redirect(const scoped_ostream_redirect&) = delete; + scoped_ostream_redirect(scoped_ostream_redirect&& other) = default; + scoped_ostream_redirect& operator=(const scoped_ostream_redirect&) = delete; + scoped_ostream_redirect& operator=(scoped_ostream_redirect&&) = delete; +}; + + +/** \rst + Like `scoped_ostream_redirect`, but redirects cerr by default. This class + is provided primary to make ``py::call_guard`` easier to make. + + .. code-block:: cpp + + m.def("noisy_func", &noisy_func, + py::call_guard<scoped_ostream_redirect, + scoped_estream_redirect>()); + +\endrst */ +class scoped_estream_redirect : public scoped_ostream_redirect +{ +public: + scoped_estream_redirect(std::ostream& costream = std::cerr, object pyostream = module::import("sys").attr("stderr")) + : scoped_ostream_redirect(costream, pyostream) + {} +}; + + +NAMESPACE_BEGIN(detail) + +// Class to redirect output as a context manager. C++ backend. +class OstreamRedirect +{ + bool do_stdout_; + bool do_stderr_; + std::unique_ptr<scoped_ostream_redirect> redirect_stdout; + std::unique_ptr<scoped_estream_redirect> redirect_stderr; + +public: + OstreamRedirect(bool do_stdout = true, bool do_stderr = true) + : do_stdout_(do_stdout) + , do_stderr_(do_stderr) + {} + + void enter() + { + if (do_stdout_) + redirect_stdout.reset(new scoped_ostream_redirect()); + if (do_stderr_) + redirect_stderr.reset(new scoped_estream_redirect()); + } + + void exit() + { + redirect_stdout.reset(); + redirect_stderr.reset(); + } +}; + +NAMESPACE_END(detail) + +/** \rst + This is a helper function to add a C++ redirect context manager to Python + instead of using a C++ guard. To use it, add the following to your binding code: + + .. code-block:: cpp + + #include <pybind11/iostream.h> + + ... + + py::add_ostream_redirect(m, "ostream_redirect"); + + You now have a Python context manager that redirects your output: + + .. code-block:: python + + with m.ostream_redirect(): + m.print_to_cout_function() + + This manager can optionally be told which streams to operate on: + + .. code-block:: python + + with m.ostream_redirect(stdout=true, stderr=true): + m.noisy_function_with_error_printing() + + \endrst */ +inline class_<detail::OstreamRedirect> add_ostream_redirect(module m, std::string name = "ostream_redirect") +{ + return class_<detail::OstreamRedirect>(m, name.c_str(), module_local()) + .def(init<bool, bool>(), arg("stdout") = true, arg("stderr") = true) + .def("__enter__", &detail::OstreamRedirect::enter) + .def("__exit__", [](detail::OstreamRedirect& self_, args) { self_.exit(); }); +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/numpy.h b/dune/pybindxi/numpy.h new file mode 100644 index 0000000000000000000000000000000000000000..042101e52495f8a7f0a0c6351ba2a2cdb916a69d --- /dev/null +++ b/dune/pybindxi/numpy.h @@ -0,0 +1,1929 @@ +#pragma GCC system_header +/* + pybind11/numpy.h: Basic NumPy support, vectorize() wrapper + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include "complex.h" +#include <numeric> +#include <algorithm> +#include <array> +#include <cstdlib> +#include <cstring> +#include <sstream> +#include <string> +#include <functional> +#include <utility> +#include <vector> +#include <typeindex> + +#if defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable : 4127) // warning C4127: Conditional expression is constant +#endif + +/* This will be true on all flat address space platforms and allows us to reduce the + whole npy_intp / ssize_t / Py_intptr_t business down to just ssize_t for all size + and dimension types (e.g. shape, strides, indexing), instead of inflicting this + upon the library user. */ +static_assert(sizeof(ssize_t) == sizeof(Py_intptr_t), "ssize_t != Py_intptr_t"); + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +class array; // Forward declaration + +NAMESPACE_BEGIN(detail) +template <typename type, typename SFINAE = void> +struct npy_format_descriptor; + +struct PyArrayDescr_Proxy +{ + PyObject_HEAD PyObject* typeobj; + char kind; + char type; + char byteorder; + char flags; + int type_num; + int elsize; + int alignment; + char* subarray; + PyObject* fields; + PyObject* names; +}; + +struct PyArray_Proxy +{ + PyObject_HEAD char* data; + int nd; + ssize_t* dimensions; + ssize_t* strides; + PyObject* base; + PyObject* descr; + int flags; +}; + +struct PyVoidScalarObject_Proxy +{ + PyObject_VAR_HEAD char* obval; + PyArrayDescr_Proxy* descr; + int flags; + PyObject* base; +}; + +struct numpy_type_info +{ + PyObject* dtype_ptr; + std::string format_str; +}; + +struct numpy_internals +{ + std::unordered_map<std::type_index, numpy_type_info> registered_dtypes; + + numpy_type_info* get_type_info(const std::type_info& tinfo, bool throw_if_missing = true) + { + auto it = registered_dtypes.find(std::type_index(tinfo)); + if (it != registered_dtypes.end()) + return &(it->second); + if (throw_if_missing) + pybind11_fail(std::string("NumPy type info missing for ") + tinfo.name()); + return nullptr; + } + + template <typename T> + numpy_type_info* get_type_info(bool throw_if_missing = true) + { + return get_type_info(typeid(typename std::remove_cv<T>::type), throw_if_missing); + } +}; + +inline PYBIND11_NOINLINE void load_numpy_internals(numpy_internals*& ptr) +{ + ptr = &get_or_create_shared_data<numpy_internals>("_numpy_internals"); +} + +inline numpy_internals& get_numpy_internals() +{ + static numpy_internals* ptr = nullptr; + if (!ptr) + load_numpy_internals(ptr); + return *ptr; +} + +struct npy_api +{ + enum constants + { + NPY_ARRAY_C_CONTIGUOUS_ = 0x0001, + NPY_ARRAY_F_CONTIGUOUS_ = 0x0002, + NPY_ARRAY_OWNDATA_ = 0x0004, + NPY_ARRAY_FORCECAST_ = 0x0010, + NPY_ARRAY_ENSUREARRAY_ = 0x0040, + NPY_ARRAY_ALIGNED_ = 0x0100, + NPY_ARRAY_WRITEABLE_ = 0x0400, + NPY_BOOL_ = 0, + NPY_BYTE_, + NPY_UBYTE_, + NPY_SHORT_, + NPY_USHORT_, + NPY_INT_, + NPY_UINT_, + NPY_LONG_, + NPY_ULONG_, + NPY_LONGLONG_, + NPY_ULONGLONG_, + NPY_FLOAT_, + NPY_DOUBLE_, + NPY_LONGDOUBLE_, + NPY_CFLOAT_, + NPY_CDOUBLE_, + NPY_CLONGDOUBLE_, + NPY_OBJECT_ = 17, + NPY_STRING_, + NPY_UNICODE_, + NPY_VOID_ + }; + + typedef struct + { + Py_intptr_t* ptr; + int len; + } PyArray_Dims; + + static npy_api& get() + { + static npy_api api = lookup(); + return api; + } + + bool PyArray_Check_(PyObject* obj) const + { + return (bool)PyObject_TypeCheck(obj, PyArray_Type_); + } + bool PyArrayDescr_Check_(PyObject* obj) const + { + return (bool)PyObject_TypeCheck(obj, PyArrayDescr_Type_); + } + + unsigned int (*PyArray_GetNDArrayCFeatureVersion_)(); + PyObject* (*PyArray_DescrFromType_)(int); + PyObject* (*PyArray_NewFromDescr_)(PyTypeObject*, PyObject*, int, Py_intptr_t*, Py_intptr_t*, void*, int, PyObject*); + PyObject* (*PyArray_DescrNewFromType_)(int); + int (*PyArray_CopyInto_)(PyObject*, PyObject*); + PyObject* (*PyArray_NewCopy_)(PyObject*, int); + PyTypeObject* PyArray_Type_; + PyTypeObject* PyVoidArrType_Type_; + PyTypeObject* PyArrayDescr_Type_; + PyObject* (*PyArray_DescrFromScalar_)(PyObject*); + PyObject* (*PyArray_FromAny_)(PyObject*, PyObject*, int, int, int, PyObject*); + int (*PyArray_DescrConverter_)(PyObject*, PyObject**); + bool (*PyArray_EquivTypes_)(PyObject*, PyObject*); + int (*PyArray_GetArrayParamsFromObject_)( + PyObject*, PyObject*, char, PyObject**, int*, Py_ssize_t*, PyObject**, PyObject*); + PyObject* (*PyArray_Squeeze_)(PyObject*); + int (*PyArray_SetBaseObject_)(PyObject*, PyObject*); + PyObject* (*PyArray_Resize_)(PyObject*, PyArray_Dims*, int, int); + +private: + enum functions + { + API_PyArray_GetNDArrayCFeatureVersion = 211, + API_PyArray_Type = 2, + API_PyArrayDescr_Type = 3, + API_PyVoidArrType_Type = 39, + API_PyArray_DescrFromType = 45, + API_PyArray_DescrFromScalar = 57, + API_PyArray_FromAny = 69, + API_PyArray_Resize = 80, + API_PyArray_CopyInto = 82, + API_PyArray_NewCopy = 85, + API_PyArray_NewFromDescr = 94, + API_PyArray_DescrNewFromType = 9, + API_PyArray_DescrConverter = 174, + API_PyArray_EquivTypes = 182, + API_PyArray_GetArrayParamsFromObject = 278, + API_PyArray_Squeeze = 136, + API_PyArray_SetBaseObject = 282 + }; + + static npy_api lookup() + { + module m = module::import("numpy.core.multiarray"); + auto c = m.attr("_ARRAY_API"); +#if PY_MAJOR_VERSION >= 3 + void** api_ptr = (void**)PyCapsule_GetPointer(c.ptr(), NULL); +#else + void** api_ptr = (void**)PyCObject_AsVoidPtr(c.ptr()); +#endif + npy_api api; +#define DECL_NPY_API(Func) api.Func##_ = (decltype(api.Func##_))api_ptr[API_##Func]; + DECL_NPY_API(PyArray_GetNDArrayCFeatureVersion); + if (api.PyArray_GetNDArrayCFeatureVersion_() < 0x7) + pybind11_fail("pybind11 numpy support requires numpy >= 1.7.0"); + DECL_NPY_API(PyArray_Type); + DECL_NPY_API(PyVoidArrType_Type); + DECL_NPY_API(PyArrayDescr_Type); + DECL_NPY_API(PyArray_DescrFromType); + DECL_NPY_API(PyArray_DescrFromScalar); + DECL_NPY_API(PyArray_FromAny); + DECL_NPY_API(PyArray_Resize); + DECL_NPY_API(PyArray_CopyInto); + DECL_NPY_API(PyArray_NewCopy); + DECL_NPY_API(PyArray_NewFromDescr); + DECL_NPY_API(PyArray_DescrNewFromType); + DECL_NPY_API(PyArray_DescrConverter); + DECL_NPY_API(PyArray_EquivTypes); + DECL_NPY_API(PyArray_GetArrayParamsFromObject); + DECL_NPY_API(PyArray_Squeeze); + DECL_NPY_API(PyArray_SetBaseObject); +#undef DECL_NPY_API + return api; + } +}; + +inline PyArray_Proxy* array_proxy(void* ptr) +{ + return reinterpret_cast<PyArray_Proxy*>(ptr); +} + +inline const PyArray_Proxy* array_proxy(const void* ptr) +{ + return reinterpret_cast<const PyArray_Proxy*>(ptr); +} + +inline PyArrayDescr_Proxy* array_descriptor_proxy(PyObject* ptr) +{ + return reinterpret_cast<PyArrayDescr_Proxy*>(ptr); +} + +inline const PyArrayDescr_Proxy* array_descriptor_proxy(const PyObject* ptr) +{ + return reinterpret_cast<const PyArrayDescr_Proxy*>(ptr); +} + +inline bool check_flags(const void* ptr, int flag) +{ + return (flag == (array_proxy(ptr)->flags & flag)); +} + +template <typename T> +struct is_std_array : std::false_type +{}; +template <typename T, size_t N> +struct is_std_array<std::array<T, N>> : std::true_type +{}; +template <typename T> +struct is_complex : std::false_type +{}; +template <typename T> +struct is_complex<std::complex<T>> : std::true_type +{}; + +template <typename T> +struct array_info_scalar +{ + typedef T type; + static constexpr bool is_array = false; + static constexpr bool is_empty = false; + static constexpr auto extents = _(""); + static void append_extents(list& /* shape */) {} +}; +// Computes underlying type and a comma-separated list of extents for array +// types (any mix of std::array and built-in arrays). An array of char is +// treated as scalar because it gets special handling. +template <typename T> +struct array_info : array_info_scalar<T> +{}; +template <typename T, size_t N> +struct array_info<std::array<T, N>> +{ + using type = typename array_info<T>::type; + static constexpr bool is_array = true; + static constexpr bool is_empty = (N == 0) || array_info<T>::is_empty; + static constexpr size_t extent = N; + + // appends the extents to shape + static void append_extents(list& shape) + { + shape.append(N); + array_info<T>::append_extents(shape); + } + + static constexpr auto extents = _<array_info<T>::is_array>(concat(_<N>(), array_info<T>::extents), _<N>()); +}; +// For numpy we have special handling for arrays of characters, so we don't include +// the size in the array extents. +template <size_t N> +struct array_info<char[N]> : array_info_scalar<char[N]> +{}; +template <size_t N> +struct array_info<std::array<char, N>> : array_info_scalar<std::array<char, N>> +{}; +template <typename T, size_t N> +struct array_info<T[N]> : array_info<std::array<T, N>> +{}; +template <typename T> +using remove_all_extents_t = typename array_info<T>::type; + +template <typename T> +using is_pod_struct = all_of< + std::is_standard_layout<T>, // since we're accessing directly in memory we need a standard layout type +#if !defined(__GNUG__) || defined(_LIBCPP_VERSION) || defined(_GLIBCXX_USE_CXX11_ABI) + // _GLIBCXX_USE_CXX11_ABI indicates that we're using libstdc++ from GCC 5 or newer, independent + // of the actual compiler (Clang can also use libstdc++, but it always defines __GNUC__ == 4). + std::is_trivially_copyable<T>, +#else + // GCC 4 doesn't implement is_trivially_copyable, so approximate it + std::is_trivially_destructible<T>, + satisfies_any_of<T, std::has_trivial_copy_constructor, std::has_trivial_copy_assign>, +#endif + satisfies_none_of<T, std::is_reference, std::is_array, is_std_array, std::is_arithmetic, is_complex, std::is_enum>>; + +template <ssize_t Dim = 0, typename Strides> +ssize_t byte_offset_unsafe(const Strides&) +{ + return 0; +} +template <ssize_t Dim = 0, typename Strides, typename... Ix> +ssize_t byte_offset_unsafe(const Strides& strides, ssize_t i, Ix... index) +{ + return i * strides[Dim] + byte_offset_unsafe<Dim + 1>(strides, index...); +} + +/** + * Proxy class providing unsafe, unchecked const access to array data. This is constructed through + * the `unchecked<T, N>()` method of `array` or the `unchecked<N>()` method of `array_t<T>`. `Dims` + * will be -1 for dimensions determined at runtime. + */ +template <typename T, ssize_t Dims> +class unchecked_reference +{ +protected: + static constexpr bool Dynamic = Dims < 0; + const unsigned char* data_; + // Storing the shape & strides in local variables (i.e. these arrays) allows the compiler to + // make large performance gains on big, nested loops, but requires compile-time dimensions + conditional_t<Dynamic, const ssize_t*, std::array<ssize_t, (size_t)Dims>> shape_, strides_; + const ssize_t dims_; + + friend class pybind11::array; + // Constructor for compile-time dimensions: + template <bool Dyn = Dynamic> + unchecked_reference(const void* data, const ssize_t* shape, const ssize_t* strides, enable_if_t<!Dyn, ssize_t>) + : data_{reinterpret_cast<const unsigned char*>(data)} + , dims_{Dims} + { + for (size_t i = 0; i < (size_t)dims_; i++) { + shape_[i] = shape[i]; + strides_[i] = strides[i]; + } + } + // Constructor for runtime dimensions: + template <bool Dyn = Dynamic> + unchecked_reference(const void* data, const ssize_t* shape, const ssize_t* strides, enable_if_t<Dyn, ssize_t> dims) + : data_{reinterpret_cast<const unsigned char*>(data)} + , shape_{shape} + , strides_{strides} + , dims_{dims} + {} + +public: + /** + * Unchecked const reference access to data at the given indices. For a compile-time known + * number of dimensions, this requires the correct number of arguments; for run-time + * dimensionality, this is not checked (and so is up to the caller to use safely). + */ + template <typename... Ix> + const T& operator()(Ix... index) const + { + static_assert(ssize_t{sizeof...(Ix)} == Dims || Dynamic, "Invalid number of indices for unchecked array reference"); + return *reinterpret_cast<const T*>(data_ + byte_offset_unsafe(strides_, ssize_t(index)...)); + } + /** + * Unchecked const reference access to data; this operator only participates if the reference + * is to a 1-dimensional array. When present, this is exactly equivalent to `obj(index)`. + */ + template <ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>> + const T& operator[](ssize_t index) const + { + return operator()(index); + } + + /// Pointer access to the data at the given indices. + template <typename... Ix> + const T* data(Ix... ix) const + { + return &operator()(ssize_t(ix)...); + } + + /// Returns the item size, i.e. sizeof(T) + constexpr static ssize_t itemsize() + { + return sizeof(T); + } + + /// Returns the shape (i.e. size) of dimension `dim` + ssize_t shape(ssize_t dim) const + { + return shape_[(size_t)dim]; + } + + /// Returns the number of dimensions of the array + ssize_t ndim() const + { + return dims_; + } + + /// Returns the total number of elements in the referenced array, i.e. the product of the shapes + template <bool Dyn = Dynamic> + enable_if_t<!Dyn, ssize_t> size() const + { + return std::accumulate(shape_.begin(), shape_.end(), (ssize_t)1, std::multiplies<ssize_t>()); + } + template <bool Dyn = Dynamic> + enable_if_t<Dyn, ssize_t> size() const + { + return std::accumulate(shape_, shape_ + ndim(), (ssize_t)1, std::multiplies<ssize_t>()); + } + + /// Returns the total number of bytes used by the referenced data. Note that the actual span in + /// memory may be larger if the referenced array has non-contiguous strides (e.g. for a slice). + ssize_t nbytes() const + { + return size() * itemsize(); + } +}; + +template <typename T, ssize_t Dims> +class unchecked_mutable_reference : public unchecked_reference<T, Dims> +{ + friend class pybind11::array; + using ConstBase = unchecked_reference<T, Dims>; + using ConstBase::ConstBase; + using ConstBase::Dynamic; + +public: + /// Mutable, unchecked access to data at the given indices. + template <typename... Ix> + T& operator()(Ix... index) + { + static_assert(ssize_t{sizeof...(Ix)} == Dims || Dynamic, "Invalid number of indices for unchecked array reference"); + return const_cast<T&>(ConstBase::operator()(index...)); + } + /** + * Mutable, unchecked access data at the given index; this operator only participates if the + * reference is to a 1-dimensional array (or has runtime dimensions). When present, this is + * exactly equivalent to `obj(index)`. + */ + template <ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>> + T& operator[](ssize_t index) + { + return operator()(index); + } + + /// Mutable pointer access to the data at the given indices. + template <typename... Ix> + T* mutable_data(Ix... ix) + { + return &operator()(ssize_t(ix)...); + } +}; + +template <typename T, ssize_t Dim> +struct type_caster<unchecked_reference<T, Dim>> +{ + static_assert(Dim == 0 && Dim > 0 /* always fail */, "unchecked array proxy object is not castable"); +}; +template <typename T, ssize_t Dim> +struct type_caster<unchecked_mutable_reference<T, Dim>> : type_caster<unchecked_reference<T, Dim>> +{}; + +NAMESPACE_END(detail) + +class dtype : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(dtype, object, detail::npy_api::get().PyArrayDescr_Check_); + + explicit dtype(const buffer_info& info) + { + dtype descr(_dtype_from_pep3118()(PYBIND11_STR_TYPE(info.format))); + // If info.itemsize == 0, use the value calculated from the format string + m_ptr = descr.strip_padding(info.itemsize ? info.itemsize : descr.itemsize()).release().ptr(); + } + + explicit dtype(const std::string& format) + { + m_ptr = from_args(pybind11::str(format)).release().ptr(); + } + + dtype(const char* format) + : dtype(std::string(format)) + {} + + dtype(list names, list formats, list offsets, ssize_t itemsize) + { + dict args; + args["names"] = names; + args["formats"] = formats; + args["offsets"] = offsets; + args["itemsize"] = pybind11::int_(itemsize); + m_ptr = from_args(args).release().ptr(); + } + + /// This is essentially the same as calling numpy.dtype(args) in Python. + static dtype from_args(object args) + { + PyObject* ptr = nullptr; + if (!detail::npy_api::get().PyArray_DescrConverter_(args.ptr(), &ptr) || !ptr) + throw error_already_set(); + return reinterpret_steal<dtype>(ptr); + } + + /// Return dtype associated with a C++ type. + template <typename T> + static dtype of() + { + return detail::npy_format_descriptor<typename std::remove_cv<T>::type>::dtype(); + } + + /// Size of the data type in bytes. + ssize_t itemsize() const + { + return detail::array_descriptor_proxy(m_ptr)->elsize; + } + + /// Returns true for structured data types. + bool has_fields() const + { + return detail::array_descriptor_proxy(m_ptr)->names != nullptr; + } + + /// Single-character type code. + char kind() const + { + return detail::array_descriptor_proxy(m_ptr)->kind; + } + +private: + static object _dtype_from_pep3118() + { + static PyObject* obj = + module::import("numpy.core._internal").attr("_dtype_from_pep3118").cast<object>().release().ptr(); + return reinterpret_borrow<object>(obj); + } + + dtype strip_padding(ssize_t itemsize) + { + // Recursively strip all void fields with empty names that are generated for + // padding fields (as of NumPy v1.11). + if (!has_fields()) + return *this; + + struct field_descr + { + PYBIND11_STR_TYPE name; + object format; + pybind11::int_ offset; + }; + std::vector<field_descr> field_descriptors; + + for (auto field : attr("fields").attr("items")()) { + auto spec = field.cast<tuple>(); + auto name = spec[0].cast<pybind11::str>(); + auto format = spec[1].cast<tuple>()[0].cast<dtype>(); + auto offset = spec[1].cast<tuple>()[1].cast<pybind11::int_>(); + if (!len(name) && format.kind() == 'V') + continue; + field_descriptors.push_back({(PYBIND11_STR_TYPE)name, format.strip_padding(format.itemsize()), offset}); + } + + std::sort(field_descriptors.begin(), field_descriptors.end(), [](const field_descr& a, const field_descr& b) { + return a.offset.cast<int>() < b.offset.cast<int>(); + }); + + list names, formats, offsets; + for (auto& descr : field_descriptors) { + names.append(descr.name); + formats.append(descr.format); + offsets.append(descr.offset); + } + return dtype(names, formats, offsets, itemsize); + } +}; + +class array : public buffer +{ +public: + PYBIND11_OBJECT_CVT(array, buffer, detail::npy_api::get().PyArray_Check_, raw_array) + + enum + { + c_style = detail::npy_api::NPY_ARRAY_C_CONTIGUOUS_, + f_style = detail::npy_api::NPY_ARRAY_F_CONTIGUOUS_, + forcecast = detail::npy_api::NPY_ARRAY_FORCECAST_ + }; + + array() + : array({{0}}, static_cast<const double*>(nullptr)) + {} + + using ShapeContainer = detail::any_container<ssize_t>; + using StridesContainer = detail::any_container<ssize_t>; + + // Constructs an array taking shape/strides from arbitrary container types + array(const pybind11::dtype& dt, + ShapeContainer shape, + StridesContainer strides, + const void* ptr = nullptr, + handle base = handle()) + { + + if (strides->empty()) + *strides = c_strides(*shape, dt.itemsize()); + + auto ndim = shape->size(); + if (ndim != strides->size()) + pybind11_fail("NumPy: shape ndim doesn't match strides ndim"); + auto descr = dt; + + int flags = 0; + if (base && ptr) { + if (isinstance<array>(base)) + /* Copy flags from base (except ownership bit) */ + flags = reinterpret_borrow<array>(base).flags() & ~detail::npy_api::NPY_ARRAY_OWNDATA_; + else + /* Writable by default, easy to downgrade later on if needed */ + flags = detail::npy_api::NPY_ARRAY_WRITEABLE_; + } + + auto& api = detail::npy_api::get(); + auto tmp = reinterpret_steal<object>(api.PyArray_NewFromDescr_(api.PyArray_Type_, + descr.release().ptr(), + (int)ndim, + shape->data(), + strides->data(), + const_cast<void*>(ptr), + flags, + nullptr)); + if (!tmp) + throw error_already_set(); + if (ptr) { + if (base) { + api.PyArray_SetBaseObject_(tmp.ptr(), base.inc_ref().ptr()); + } else { + tmp = reinterpret_steal<object>(api.PyArray_NewCopy_(tmp.ptr(), -1 /* any order */)); + } + } + m_ptr = tmp.release().ptr(); + } + + array(const pybind11::dtype& dt, ShapeContainer shape, const void* ptr = nullptr, handle base = handle()) + : array(dt, std::move(shape), {}, ptr, base) + {} + + template <typename T, typename = detail::enable_if_t<std::is_integral<T>::value && !std::is_same<bool, T>::value>> + array(const pybind11::dtype& dt, T count, const void* ptr = nullptr, handle base = handle()) + : array(dt, {{count}}, ptr, base) + {} + + template <typename T> + array(ShapeContainer shape, StridesContainer strides, const T* ptr, handle base = handle()) + : array(pybind11::dtype::of<T>(), std::move(shape), std::move(strides), ptr, base) + {} + + template <typename T> + array(ShapeContainer shape, const T* ptr, handle base = handle()) + : array(std::move(shape), {}, ptr, base) + {} + + template <typename T> + explicit array(ssize_t count, const T* ptr, handle base = handle()) + : array({count}, {}, ptr, base) + {} + + explicit array(const buffer_info& info) + : array(pybind11::dtype(info), info.shape, info.strides, info.ptr) + {} + + /// Array descriptor (dtype) + pybind11::dtype dtype() const + { + return reinterpret_borrow<pybind11::dtype>(detail::array_proxy(m_ptr)->descr); + } + + /// Total number of elements + ssize_t size() const + { + return std::accumulate(shape(), shape() + ndim(), (ssize_t)1, std::multiplies<ssize_t>()); + } + + /// Byte size of a single element + ssize_t itemsize() const + { + return detail::array_descriptor_proxy(detail::array_proxy(m_ptr)->descr)->elsize; + } + + /// Total number of bytes + ssize_t nbytes() const + { + return size() * itemsize(); + } + + /// Number of dimensions + ssize_t ndim() const + { + return detail::array_proxy(m_ptr)->nd; + } + + /// Base object + object base() const + { + return reinterpret_borrow<object>(detail::array_proxy(m_ptr)->base); + } + + /// Dimensions of the array + const ssize_t* shape() const + { + return detail::array_proxy(m_ptr)->dimensions; + } + + /// Dimension along a given axis + ssize_t shape(ssize_t dim) const + { + if (dim >= ndim()) + fail_dim_check(dim, "invalid axis"); + return shape()[dim]; + } + + /// Strides of the array + const ssize_t* strides() const + { + return detail::array_proxy(m_ptr)->strides; + } + + /// Stride along a given axis + ssize_t strides(ssize_t dim) const + { + if (dim >= ndim()) + fail_dim_check(dim, "invalid axis"); + return strides()[dim]; + } + + /// Return the NumPy array flags + int flags() const + { + return detail::array_proxy(m_ptr)->flags; + } + + /// If set, the array is writeable (otherwise the buffer is read-only) + bool writeable() const + { + return detail::check_flags(m_ptr, detail::npy_api::NPY_ARRAY_WRITEABLE_); + } + + /// If set, the array owns the data (will be freed when the array is deleted) + bool owndata() const + { + return detail::check_flags(m_ptr, detail::npy_api::NPY_ARRAY_OWNDATA_); + } + + /// Pointer to the contained data. If index is not provided, points to the + /// beginning of the buffer. May throw if the index would lead to out of bounds access. + template <typename... Ix> + const void* data(Ix... index) const + { + return static_cast<const void*>(detail::array_proxy(m_ptr)->data + offset_at(index...)); + } + + /// Mutable pointer to the contained data. If index is not provided, points to the + /// beginning of the buffer. May throw if the index would lead to out of bounds access. + /// May throw if the array is not writeable. + template <typename... Ix> + void* mutable_data(Ix... index) + { + check_writeable(); + return static_cast<void*>(detail::array_proxy(m_ptr)->data + offset_at(index...)); + } + + /// Byte offset from beginning of the array to a given index (full or partial). + /// May throw if the index would lead to out of bounds access. + template <typename... Ix> + ssize_t offset_at(Ix... index) const + { + if ((ssize_t)sizeof...(index) > ndim()) + fail_dim_check(sizeof...(index), "too many indices for an array"); + return byte_offset(ssize_t(index)...); + } + + ssize_t offset_at() const + { + return 0; + } + + /// Item count from beginning of the array to a given index (full or partial). + /// May throw if the index would lead to out of bounds access. + template <typename... Ix> + ssize_t index_at(Ix... index) const + { + return offset_at(index...) / itemsize(); + } + + /** + * Returns a proxy object that provides access to the array's data without bounds or + * dimensionality checking. Will throw if the array is missing the `writeable` flag. Use with + * care: the array must not be destroyed or reshaped for the duration of the returned object, + * and the caller must take care not to access invalid dimensions or dimension indices. + */ + template <typename T, ssize_t Dims = -1> + detail::unchecked_mutable_reference<T, Dims> mutable_unchecked() & + { + if (Dims >= 0 && ndim() != Dims) + throw std::domain_error("array has incorrect number of dimensions: " + std::to_string(ndim()) + "; expected " + + std::to_string(Dims)); + return detail::unchecked_mutable_reference<T, Dims>(mutable_data(), shape(), strides(), ndim()); + } + + /** + * Returns a proxy object that provides const access to the array's data without bounds or + * dimensionality checking. Unlike `mutable_unchecked()`, this does not require that the + * underlying array have the `writable` flag. Use with care: the array must not be destroyed or + * reshaped for the duration of the returned object, and the caller must take care not to access + * invalid dimensions or dimension indices. + */ + template <typename T, ssize_t Dims = -1> + detail::unchecked_reference<T, Dims> unchecked() const& + { + if (Dims >= 0 && ndim() != Dims) + throw std::domain_error("array has incorrect number of dimensions: " + std::to_string(ndim()) + "; expected " + + std::to_string(Dims)); + return detail::unchecked_reference<T, Dims>(data(), shape(), strides(), ndim()); + } + + /// Return a new view with all of the dimensions of length 1 removed + array squeeze() + { + auto& api = detail::npy_api::get(); + return reinterpret_steal<array>(api.PyArray_Squeeze_(m_ptr)); + } + + /// Resize array to given shape + /// If refcheck is true and more that one reference exist to this array + /// then resize will succeed only if it makes a reshape, i.e. original size doesn't change + void resize(ShapeContainer new_shape, bool refcheck = true) + { + detail::npy_api::PyArray_Dims d = {new_shape->data(), int(new_shape->size())}; + // try to resize, set ordering param to -1 cause it's not used anyway + object new_array = reinterpret_steal<object>(detail::npy_api::get().PyArray_Resize_(m_ptr, &d, int(refcheck), -1)); + if (!new_array) + throw error_already_set(); + if (isinstance<array>(new_array)) { + *this = std::move(new_array); + } + } + + /// Ensure that the argument is a NumPy array + /// In case of an error, nullptr is returned and the Python error is cleared. + static array ensure(handle h, int ExtraFlags = 0) + { + auto result = reinterpret_steal<array>(raw_array(h.ptr(), ExtraFlags)); + if (!result) + PyErr_Clear(); + return result; + } + +protected: + template <typename, typename> + friend struct detail::npy_format_descriptor; + + void fail_dim_check(ssize_t dim, const std::string& msg) const + { + throw index_error(msg + ": " + std::to_string(dim) + " (ndim = " + std::to_string(ndim()) + ")"); + } + + template <typename... Ix> + ssize_t byte_offset(Ix... index) const + { + check_dimensions(index...); + return detail::byte_offset_unsafe(strides(), ssize_t(index)...); + } + + void check_writeable() const + { + if (!writeable()) + throw std::domain_error("array is not writeable"); + } + + // Default, C-style strides + static std::vector<ssize_t> c_strides(const std::vector<ssize_t>& shape, ssize_t itemsize) + { + auto ndim = shape.size(); + std::vector<ssize_t> strides(ndim, itemsize); + if (ndim > 0) + for (size_t i = ndim - 1; i > 0; --i) + strides[i - 1] = strides[i] * shape[i]; + return strides; + } + + // F-style strides; default when constructing an array_t with `ExtraFlags & f_style` + static std::vector<ssize_t> f_strides(const std::vector<ssize_t>& shape, ssize_t itemsize) + { + auto ndim = shape.size(); + std::vector<ssize_t> strides(ndim, itemsize); + for (size_t i = 1; i < ndim; ++i) + strides[i] = strides[i - 1] * shape[i - 1]; + return strides; + } + + template <typename... Ix> + void check_dimensions(Ix... index) const + { + check_dimensions_impl(ssize_t(0), shape(), ssize_t(index)...); + } + + void check_dimensions_impl(ssize_t, const ssize_t*) const {} + + template <typename... Ix> + void check_dimensions_impl(ssize_t axis, const ssize_t* shape, ssize_t i, Ix... index) const + { + if (i >= *shape) { + throw index_error(std::string("index ") + std::to_string(i) + " is out of bounds for axis " + std::to_string(axis) + + " with size " + std::to_string(*shape)); + } + check_dimensions_impl(axis + 1, shape + 1, index...); + } + + /// Create array from any object -- always returns a new reference + static PyObject* raw_array(PyObject* ptr, int ExtraFlags = 0) + { + if (ptr == nullptr) { + PyErr_SetString(PyExc_ValueError, "cannot create a pybind11::array from a nullptr"); + return nullptr; + } + return detail::npy_api::get().PyArray_FromAny_( + ptr, nullptr, 0, 0, detail::npy_api::NPY_ARRAY_ENSUREARRAY_ | ExtraFlags, nullptr); + } +}; + +template <typename T, int ExtraFlags = array::forcecast> +class array_t : public array +{ +private: + struct private_ctor + {}; + // Delegating constructor needed when both moving and accessing in the same constructor + array_t(private_ctor, ShapeContainer&& shape, StridesContainer&& strides, const T* ptr, handle base) + : array(std::move(shape), std::move(strides), ptr, base) + {} + +public: + static_assert(!detail::array_info<T>::is_array, "Array types cannot be used with array_t"); + + using value_type = T; + + array_t() + : array(0, static_cast<const T*>(nullptr)) + {} + array_t(handle h, borrowed_t) + : array(h, borrowed_t{}) + {} + array_t(handle h, stolen_t) + : array(h, stolen_t{}) + {} + + PYBIND11_DEPRECATED("Use array_t<T>::ensure() instead") + array_t(handle h, bool is_borrowed) + : array(raw_array_t(h.ptr()), stolen_t{}) + { + if (!m_ptr) + PyErr_Clear(); + if (!is_borrowed) + Py_XDECREF(h.ptr()); + } + + array_t(const object& o) + : array(raw_array_t(o.ptr()), stolen_t{}) + { + if (!m_ptr) + throw error_already_set(); + } + + explicit array_t(const buffer_info& info) + : array(info) + {} + + array_t(ShapeContainer shape, StridesContainer strides, const T* ptr = nullptr, handle base = handle()) + : array(std::move(shape), std::move(strides), ptr, base) + {} + + explicit array_t(ShapeContainer shape, const T* ptr = nullptr, handle base = handle()) + : array_t(private_ctor{}, + std::move(shape), + ExtraFlags & f_style ? f_strides(*shape, itemsize()) : c_strides(*shape, itemsize()), + ptr, + base) + {} + + explicit array_t(size_t count, const T* ptr = nullptr, handle base = handle()) + : array({count}, {}, ptr, base) + {} + + constexpr ssize_t itemsize() const + { + return sizeof(T); + } + + template <typename... Ix> + ssize_t index_at(Ix... index) const + { + return offset_at(index...) / itemsize(); + } + + template <typename... Ix> + const T* data(Ix... index) const + { + return static_cast<const T*>(array::data(index...)); + } + + template <typename... Ix> + T* mutable_data(Ix... index) + { + return static_cast<T*>(array::mutable_data(index...)); + } + + // Reference to element at a given index + template <typename... Ix> + const T& at(Ix... index) const + { + if ((ssize_t)sizeof...(index) != ndim()) + fail_dim_check(sizeof...(index), "index dimension mismatch"); + return *(static_cast<const T*>(array::data()) + byte_offset(ssize_t(index)...) / itemsize()); + } + + // Mutable reference to element at a given index + template <typename... Ix> + T& mutable_at(Ix... index) + { + if ((ssize_t)sizeof...(index) != ndim()) + fail_dim_check(sizeof...(index), "index dimension mismatch"); + return *(static_cast<T*>(array::mutable_data()) + byte_offset(ssize_t(index)...) / itemsize()); + } + + /** + * Returns a proxy object that provides access to the array's data without bounds or + * dimensionality checking. Will throw if the array is missing the `writeable` flag. Use with + * care: the array must not be destroyed or reshaped for the duration of the returned object, + * and the caller must take care not to access invalid dimensions or dimension indices. + */ + template <ssize_t Dims = -1> + detail::unchecked_mutable_reference<T, Dims> mutable_unchecked() & + { + return array::mutable_unchecked<T, Dims>(); + } + + /** + * Returns a proxy object that provides const access to the array's data without bounds or + * dimensionality checking. Unlike `unchecked()`, this does not require that the underlying + * array have the `writable` flag. Use with care: the array must not be destroyed or reshaped + * for the duration of the returned object, and the caller must take care not to access invalid + * dimensions or dimension indices. + */ + template <ssize_t Dims = -1> + detail::unchecked_reference<T, Dims> unchecked() const& + { + return array::unchecked<T, Dims>(); + } + + /// Ensure that the argument is a NumPy array of the correct dtype (and if not, try to convert + /// it). In case of an error, nullptr is returned and the Python error is cleared. + static array_t ensure(handle h) + { + auto result = reinterpret_steal<array_t>(raw_array_t(h.ptr())); + if (!result) + PyErr_Clear(); + return result; + } + + static bool check_(handle h) + { + const auto& api = detail::npy_api::get(); + return api.PyArray_Check_(h.ptr()) + && api.PyArray_EquivTypes_(detail::array_proxy(h.ptr())->descr, dtype::of<T>().ptr()); + } + +protected: + /// Create array from any object -- always returns a new reference + static PyObject* raw_array_t(PyObject* ptr) + { + if (ptr == nullptr) { + PyErr_SetString(PyExc_ValueError, "cannot create a pybind11::array_t from a nullptr"); + return nullptr; + } + return detail::npy_api::get().PyArray_FromAny_( + ptr, dtype::of<T>().release().ptr(), 0, 0, detail::npy_api::NPY_ARRAY_ENSUREARRAY_ | ExtraFlags, nullptr); + } +}; + +template <typename T> +struct format_descriptor<T, detail::enable_if_t<detail::is_pod_struct<T>::value>> +{ + static std::string format() + { + return detail::npy_format_descriptor<typename std::remove_cv<T>::type>::format(); + } +}; + +template <size_t N> +struct format_descriptor<char[N]> +{ + static std::string format() + { + return std::to_string(N) + "s"; + } +}; +template <size_t N> +struct format_descriptor<std::array<char, N>> +{ + static std::string format() + { + return std::to_string(N) + "s"; + } +}; + +template <typename T> +struct format_descriptor<T, detail::enable_if_t<std::is_enum<T>::value>> +{ + static std::string format() + { + return format_descriptor<typename std::remove_cv<typename std::underlying_type<T>::type>::type>::format(); + } +}; + +template <typename T> +struct format_descriptor<T, detail::enable_if_t<detail::array_info<T>::is_array>> +{ + static std::string format() + { + using namespace detail; + static constexpr auto extents = _("(") + array_info<T>::extents + _(")"); + return extents.text + format_descriptor<remove_all_extents_t<T>>::format(); + } +}; + +NAMESPACE_BEGIN(detail) +template <typename T, int ExtraFlags> +struct pyobject_caster<array_t<T, ExtraFlags>> +{ + using type = array_t<T, ExtraFlags>; + + bool load(handle src, bool convert) + { + if (!convert && !type::check_(src)) + return false; + value = type::ensure(src); + return static_cast<bool>(value); + } + + static handle cast(const handle& src, return_value_policy /* policy */, handle /* parent */) + { + return src.inc_ref(); + } + PYBIND11_TYPE_CASTER(type, handle_type_name<type>::name); +}; + +template <typename T> +struct compare_buffer_info<T, detail::enable_if_t<detail::is_pod_struct<T>::value>> +{ + static bool compare(const buffer_info& b) + { + return npy_api::get().PyArray_EquivTypes_(dtype::of<T>().ptr(), dtype(b).ptr()); + } +}; + +template <typename T, typename = void> +struct npy_format_descriptor_name; + +template <typename T> +struct npy_format_descriptor_name<T, enable_if_t<std::is_integral<T>::value>> +{ + static constexpr auto name = + _<std::is_same<T, bool>::value>(_("bool"), _<std::is_signed<T>::value>("int", "uint") + _<sizeof(T) * 8>()); +}; + +template <typename T> +struct npy_format_descriptor_name<T, enable_if_t<std::is_floating_point<T>::value>> +{ + static constexpr auto name = _ < std::is_same<T, float>::value + || std::is_same<T, double>::value > (_("float") + _<sizeof(T) * 8>(), _("longdouble")); +}; + +template <typename T> +struct npy_format_descriptor_name<T, enable_if_t<is_complex<T>::value>> +{ + static constexpr auto name = _ < std::is_same<typename T::value_type, float>::value + || std::is_same<typename T::value_type, double>::value + > (_("complex") + _<sizeof(typename T::value_type) * 16>(), _("longcomplex")); +}; + +template <typename T> +struct npy_format_descriptor<T, enable_if_t<satisfies_any_of<T, std::is_arithmetic, is_complex>::value>> + : npy_format_descriptor_name<T> +{ +private: + // NB: the order here must match the one in common.h + constexpr static const int values[15] = {npy_api::NPY_BOOL_, + npy_api::NPY_BYTE_, + npy_api::NPY_UBYTE_, + npy_api::NPY_SHORT_, + npy_api::NPY_USHORT_, + npy_api::NPY_INT_, + npy_api::NPY_UINT_, + npy_api::NPY_LONGLONG_, + npy_api::NPY_ULONGLONG_, + npy_api::NPY_FLOAT_, + npy_api::NPY_DOUBLE_, + npy_api::NPY_LONGDOUBLE_, + npy_api::NPY_CFLOAT_, + npy_api::NPY_CDOUBLE_, + npy_api::NPY_CLONGDOUBLE_}; + +public: + static constexpr int value = values[detail::is_fmt_numeric<T>::index]; + + static pybind11::dtype dtype() + { + if (auto ptr = npy_api::get().PyArray_DescrFromType_(value)) + return reinterpret_borrow<pybind11::dtype>(ptr); + pybind11_fail("Unsupported buffer format!"); + } +}; + +#define PYBIND11_DECL_CHAR_FMT \ + static constexpr auto name = _("S") + _<N>(); \ + static pybind11::dtype dtype() \ + { \ + return pybind11::dtype(std::string("S") + std::to_string(N)); \ + } +template <size_t N> +struct npy_format_descriptor<char[N]> +{ + PYBIND11_DECL_CHAR_FMT +}; +template <size_t N> +struct npy_format_descriptor<std::array<char, N>> +{ + PYBIND11_DECL_CHAR_FMT +}; +#undef PYBIND11_DECL_CHAR_FMT + +template <typename T> +struct npy_format_descriptor<T, enable_if_t<array_info<T>::is_array>> +{ +private: + using base_descr = npy_format_descriptor<typename array_info<T>::type>; + +public: + static_assert(!array_info<T>::is_empty, "Zero-sized arrays are not supported"); + + static constexpr auto name = _("(") + array_info<T>::extents + _(")") + base_descr::name; + static pybind11::dtype dtype() + { + list shape; + array_info<T>::append_extents(shape); + return pybind11::dtype::from_args(pybind11::make_tuple(base_descr::dtype(), shape)); + } +}; + +template <typename T> +struct npy_format_descriptor<T, enable_if_t<std::is_enum<T>::value>> +{ +private: + using base_descr = npy_format_descriptor<typename std::underlying_type<T>::type>; + +public: + static constexpr auto name = base_descr::name; + static pybind11::dtype dtype() + { + return base_descr::dtype(); + } +}; + +struct field_descriptor +{ + const char* name; + ssize_t offset; + ssize_t size; + std::string format; + dtype descr; +}; + +inline PYBIND11_NOINLINE void register_structured_dtype(any_container<field_descriptor> fields, + const std::type_info& tinfo, + ssize_t itemsize, + bool (*direct_converter)(PyObject*, void*&)) +{ + + auto& numpy_internals = get_numpy_internals(); + if (numpy_internals.get_type_info(tinfo, false)) + pybind11_fail("NumPy: dtype is already registered"); + + list names, formats, offsets; + for (auto field : *fields) { + if (!field.descr) + pybind11_fail(std::string("NumPy: unsupported field dtype: `") + field.name + "` @ " + tinfo.name()); + names.append(PYBIND11_STR_TYPE(field.name)); + formats.append(field.descr); + offsets.append(pybind11::int_(field.offset)); + } + auto dtype_ptr = pybind11::dtype(names, formats, offsets, itemsize).release().ptr(); + + // There is an existing bug in NumPy (as of v1.11): trailing bytes are + // not encoded explicitly into the format string. This will supposedly + // get fixed in v1.12; for further details, see these: + // - https://github.com/numpy/numpy/issues/7797 + // - https://github.com/numpy/numpy/pull/7798 + // Because of this, we won't use numpy's logic to generate buffer format + // strings and will just do it ourselves. + std::vector<field_descriptor> ordered_fields(std::move(fields)); + std::sort(ordered_fields.begin(), ordered_fields.end(), [](const field_descriptor& a, const field_descriptor& b) { + return a.offset < b.offset; + }); + ssize_t offset = 0; + std::ostringstream oss; + // mark the structure as unaligned with '^', because numpy and C++ don't + // always agree about alignment (particularly for complex), and we're + // explicitly listing all our padding. This depends on none of the fields + // overriding the endianness. Putting the ^ in front of individual fields + // isn't guaranteed to work due to https://github.com/numpy/numpy/issues/9049 + oss << "^T{"; + for (auto& field : ordered_fields) { + if (field.offset > offset) + oss << (field.offset - offset) << 'x'; + oss << field.format << ':' << field.name << ':'; + offset = field.offset + field.size; + } + if (itemsize > offset) + oss << (itemsize - offset) << 'x'; + oss << '}'; + auto format_str = oss.str(); + + // Sanity check: verify that NumPy properly parses our buffer format string + auto& api = npy_api::get(); + auto arr = array(buffer_info(nullptr, itemsize, format_str, 1)); + if (!api.PyArray_EquivTypes_(dtype_ptr, arr.dtype().ptr())) + pybind11_fail("NumPy: invalid buffer descriptor!"); + + auto tindex = std::type_index(tinfo); + numpy_internals.registered_dtypes[tindex] = {dtype_ptr, format_str}; + get_internals().direct_conversions[tindex].push_back(direct_converter); +} + +template <typename T, typename SFINAE> +struct npy_format_descriptor +{ + static_assert(is_pod_struct<T>::value, "Attempt to use a non-POD or unimplemented POD type as a numpy dtype"); + + static constexpr auto name = make_caster<T>::name; + + static pybind11::dtype dtype() + { + return reinterpret_borrow<pybind11::dtype>(dtype_ptr()); + } + + static std::string format() + { + static auto format_str = get_numpy_internals().get_type_info<T>(true)->format_str; + return format_str; + } + + static void register_dtype(any_container<field_descriptor> fields) + { + register_structured_dtype( + std::move(fields), typeid(typename std::remove_cv<T>::type), sizeof(T), &direct_converter); + } + +private: + static PyObject* dtype_ptr() + { + static PyObject* ptr = get_numpy_internals().get_type_info<T>(true)->dtype_ptr; + return ptr; + } + + static bool direct_converter(PyObject* obj, void*& value) + { + auto& api = npy_api::get(); + if (!PyObject_TypeCheck(obj, api.PyVoidArrType_Type_)) + return false; + if (auto descr = reinterpret_steal<object>(api.PyArray_DescrFromScalar_(obj))) { + if (api.PyArray_EquivTypes_(dtype_ptr(), descr.ptr())) { + value = ((PyVoidScalarObject_Proxy*)obj)->obval; + return true; + } + } + return false; + } +}; + +#ifdef __CLION_IDE__ // replace heavy macro with dummy code for the IDE (doesn't affect code) +# define PYBIND11_NUMPY_DTYPE(Type, ...) ((void)0) +# define PYBIND11_NUMPY_DTYPE_EX(Type, ...) ((void)0) +#else + +# define PYBIND11_FIELD_DESCRIPTOR_EX(T, Field, Name) \ + ::pybind11::detail::field_descriptor \ + { \ + Name, offsetof(T, Field), sizeof(decltype(std::declval<T>().Field)), \ + ::pybind11::format_descriptor<decltype(std::declval<T>().Field)>::format(), \ + ::pybind11::detail::npy_format_descriptor<decltype(std::declval<T>().Field)>::dtype() \ + } + +// Extract name, offset and format descriptor for a struct field +# define PYBIND11_FIELD_DESCRIPTOR(T, Field) PYBIND11_FIELD_DESCRIPTOR_EX(T, Field, # Field) + +// The main idea of this macro is borrowed from https://github.com/swansontec/map-macro +// (C) William Swanson, Paul Fultz +# define PYBIND11_EVAL0(...) __VA_ARGS__ +# define PYBIND11_EVAL1(...) PYBIND11_EVAL0(PYBIND11_EVAL0(PYBIND11_EVAL0(__VA_ARGS__))) +# define PYBIND11_EVAL2(...) PYBIND11_EVAL1(PYBIND11_EVAL1(PYBIND11_EVAL1(__VA_ARGS__))) +# define PYBIND11_EVAL3(...) PYBIND11_EVAL2(PYBIND11_EVAL2(PYBIND11_EVAL2(__VA_ARGS__))) +# define PYBIND11_EVAL4(...) PYBIND11_EVAL3(PYBIND11_EVAL3(PYBIND11_EVAL3(__VA_ARGS__))) +# define PYBIND11_EVAL(...) PYBIND11_EVAL4(PYBIND11_EVAL4(PYBIND11_EVAL4(__VA_ARGS__))) +# define PYBIND11_MAP_END(...) +# define PYBIND11_MAP_OUT +# define PYBIND11_MAP_COMMA , +# define PYBIND11_MAP_GET_END() 0, PYBIND11_MAP_END +# define PYBIND11_MAP_NEXT0(test, next, ...) next PYBIND11_MAP_OUT +# define PYBIND11_MAP_NEXT1(test, next) PYBIND11_MAP_NEXT0(test, next, 0) +# define PYBIND11_MAP_NEXT(test, next) PYBIND11_MAP_NEXT1(PYBIND11_MAP_GET_END test, next) +# ifdef _MSC_VER // MSVC is not as eager to expand macros, hence this workaround +# define PYBIND11_MAP_LIST_NEXT1(test, next) PYBIND11_EVAL0(PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0)) +# else +# define PYBIND11_MAP_LIST_NEXT1(test, next) PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0) +# endif +# define PYBIND11_MAP_LIST_NEXT(test, next) PYBIND11_MAP_LIST_NEXT1(PYBIND11_MAP_GET_END test, next) +# define PYBIND11_MAP_LIST0(f, t, x, peek, ...) \ + f(t, x) PYBIND11_MAP_LIST_NEXT(peek, PYBIND11_MAP_LIST1)(f, t, peek, __VA_ARGS__) +# define PYBIND11_MAP_LIST1(f, t, x, peek, ...) \ + f(t, x) PYBIND11_MAP_LIST_NEXT(peek, PYBIND11_MAP_LIST0)(f, t, peek, __VA_ARGS__) +// PYBIND11_MAP_LIST(f, t, a1, a2, ...) expands to f(t, a1), f(t, a2), ... +# define PYBIND11_MAP_LIST(f, t, ...) PYBIND11_EVAL(PYBIND11_MAP_LIST1(f, t, __VA_ARGS__, (), 0)) + +# define PYBIND11_NUMPY_DTYPE(Type, ...) \ + ::pybind11::detail::npy_format_descriptor<Type>::register_dtype( \ + ::std::vector<::pybind11::detail::field_descriptor>{ \ + PYBIND11_MAP_LIST(PYBIND11_FIELD_DESCRIPTOR, Type, __VA_ARGS__)}) + +# ifdef _MSC_VER +# define PYBIND11_MAP2_LIST_NEXT1(test, next) PYBIND11_EVAL0(PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0)) +# else +# define PYBIND11_MAP2_LIST_NEXT1(test, next) PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0) +# endif +# define PYBIND11_MAP2_LIST_NEXT(test, next) PYBIND11_MAP2_LIST_NEXT1(PYBIND11_MAP_GET_END test, next) +# define PYBIND11_MAP2_LIST0(f, t, x1, x2, peek, ...) \ + f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT(peek, PYBIND11_MAP2_LIST1)(f, t, peek, __VA_ARGS__) +# define PYBIND11_MAP2_LIST1(f, t, x1, x2, peek, ...) \ + f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT(peek, PYBIND11_MAP2_LIST0)(f, t, peek, __VA_ARGS__) +// PYBIND11_MAP2_LIST(f, t, a1, a2, ...) expands to f(t, a1, a2), f(t, a3, a4), ... +# define PYBIND11_MAP2_LIST(f, t, ...) PYBIND11_EVAL(PYBIND11_MAP2_LIST1(f, t, __VA_ARGS__, (), 0)) + +# define PYBIND11_NUMPY_DTYPE_EX(Type, ...) \ + ::pybind11::detail::npy_format_descriptor<Type>::register_dtype( \ + ::std::vector<::pybind11::detail::field_descriptor>{ \ + PYBIND11_MAP2_LIST(PYBIND11_FIELD_DESCRIPTOR_EX, Type, __VA_ARGS__)}) + +#endif // __CLION_IDE__ + +template <class T> +using array_iterator = typename std::add_pointer<T>::type; + +template <class T> +array_iterator<T> array_begin(const buffer_info& buffer) +{ + return array_iterator<T>(reinterpret_cast<T*>(buffer.ptr)); +} + +template <class T> +array_iterator<T> array_end(const buffer_info& buffer) +{ + return array_iterator<T>(reinterpret_cast<T*>(buffer.ptr) + buffer.size); +} + +class common_iterator +{ +public: + using container_type = std::vector<ssize_t>; + using value_type = container_type::value_type; + using size_type = container_type::size_type; + + common_iterator() + : p_ptr(0) + , m_strides() + {} + + common_iterator(void* ptr, const container_type& strides, const container_type& shape) + : p_ptr(reinterpret_cast<char*>(ptr)) + , m_strides(strides.size()) + { + m_strides.back() = static_cast<value_type>(strides.back()); + for (size_type i = m_strides.size() - 1; i != 0; --i) { + size_type j = i - 1; + value_type s = static_cast<value_type>(shape[i]); + m_strides[j] = strides[j] + m_strides[i] - strides[i] * s; + } + } + + void increment(size_type dim) + { + p_ptr += m_strides[dim]; + } + + void* data() const + { + return p_ptr; + } + +private: + char* p_ptr; + container_type m_strides; +}; + +template <size_t N> +class multi_array_iterator +{ +public: + using container_type = std::vector<ssize_t>; + + multi_array_iterator(const std::array<buffer_info, N>& buffers, const container_type& shape) + : m_shape(shape.size()) + , m_index(shape.size(), 0) + , m_common_iterator() + { + + // Manual copy to avoid conversion warning if using std::copy + for (size_t i = 0; i < shape.size(); ++i) + m_shape[i] = shape[i]; + + container_type strides(shape.size()); + for (size_t i = 0; i < N; ++i) + init_common_iterator(buffers[i], shape, m_common_iterator[i], strides); + } + + multi_array_iterator& operator++() + { + for (size_t j = m_index.size(); j != 0; --j) { + size_t i = j - 1; + if (++m_index[i] != m_shape[i]) { + increment_common_iterator(i); + break; + } else { + m_index[i] = 0; + } + } + return *this; + } + + template <size_t K, class T = void> + T* data() const + { + return reinterpret_cast<T*>(m_common_iterator[K].data()); + } + +private: + using common_iter = common_iterator; + + void init_common_iterator(const buffer_info& buffer, + const container_type& shape, + common_iter& iterator, + container_type& strides) + { + auto buffer_shape_iter = buffer.shape.rbegin(); + auto buffer_strides_iter = buffer.strides.rbegin(); + auto shape_iter = shape.rbegin(); + auto strides_iter = strides.rbegin(); + + while (buffer_shape_iter != buffer.shape.rend()) { + if (*shape_iter == *buffer_shape_iter) + *strides_iter = *buffer_strides_iter; + else + *strides_iter = 0; + + ++buffer_shape_iter; + ++buffer_strides_iter; + ++shape_iter; + ++strides_iter; + } + + std::fill(strides_iter, strides.rend(), 0); + iterator = common_iter(buffer.ptr, strides, shape); + } + + void increment_common_iterator(size_t dim) + { + for (auto& iter : m_common_iterator) + iter.increment(dim); + } + + container_type m_shape; + container_type m_index; + std::array<common_iter, N> m_common_iterator; +}; + +enum class broadcast_trivial +{ + non_trivial, + c_trivial, + f_trivial +}; + +// Populates the shape and number of dimensions for the set of buffers. Returns a broadcast_trivial +// enum value indicating whether the broadcast is "trivial"--that is, has each buffer being either a +// singleton or a full-size, C-contiguous (`c_trivial`) or Fortran-contiguous (`f_trivial`) storage +// buffer; returns `non_trivial` otherwise. +template <size_t N> +broadcast_trivial broadcast(const std::array<buffer_info, N>& buffers, ssize_t& ndim, std::vector<ssize_t>& shape) +{ + ndim = std::accumulate(buffers.begin(), buffers.end(), ssize_t(0), [](ssize_t res, const buffer_info& buf) { + return std::max(res, buf.ndim); + }); + + shape.clear(); + shape.resize((size_t)ndim, 1); + + // Figure out the output size, and make sure all input arrays conform (i.e. are either size 1 or + // the full size). + for (size_t i = 0; i < N; ++i) { + auto res_iter = shape.rbegin(); + auto end = buffers[i].shape.rend(); + for (auto shape_iter = buffers[i].shape.rbegin(); shape_iter != end; ++shape_iter, ++res_iter) { + const auto& dim_size_in = *shape_iter; + auto& dim_size_out = *res_iter; + + // Each input dimension can either be 1 or `n`, but `n` values must match across buffers + if (dim_size_out == 1) + dim_size_out = dim_size_in; + else if (dim_size_in != 1 && dim_size_in != dim_size_out) + pybind11_fail("pybind11::vectorize: incompatible size/dimension of inputs!"); + } + } + + bool trivial_broadcast_c = true; + bool trivial_broadcast_f = true; + for (size_t i = 0; i < N && (trivial_broadcast_c || trivial_broadcast_f); ++i) { + if (buffers[i].size == 1) + continue; + + // Require the same number of dimensions: + if (buffers[i].ndim != ndim) + return broadcast_trivial::non_trivial; + + // Require all dimensions be full-size: + if (!std::equal(buffers[i].shape.cbegin(), buffers[i].shape.cend(), shape.cbegin())) + return broadcast_trivial::non_trivial; + + // Check for C contiguity (but only if previous inputs were also C contiguous) + if (trivial_broadcast_c) { + ssize_t expect_stride = buffers[i].itemsize; + auto end = buffers[i].shape.crend(); + for (auto shape_iter = buffers[i].shape.crbegin(), stride_iter = buffers[i].strides.crbegin(); + trivial_broadcast_c && shape_iter != end; + ++shape_iter, ++stride_iter) { + if (expect_stride == *stride_iter) + expect_stride *= *shape_iter; + else + trivial_broadcast_c = false; + } + } + + // Check for Fortran contiguity (if previous inputs were also F contiguous) + if (trivial_broadcast_f) { + ssize_t expect_stride = buffers[i].itemsize; + auto end = buffers[i].shape.cend(); + for (auto shape_iter = buffers[i].shape.cbegin(), stride_iter = buffers[i].strides.cbegin(); + trivial_broadcast_f && shape_iter != end; + ++shape_iter, ++stride_iter) { + if (expect_stride == *stride_iter) + expect_stride *= *shape_iter; + else + trivial_broadcast_f = false; + } + } + } + + return trivial_broadcast_c ? broadcast_trivial::c_trivial + : trivial_broadcast_f ? broadcast_trivial::f_trivial : broadcast_trivial::non_trivial; +} + +template <typename T> +struct vectorize_arg +{ + static_assert(!std::is_rvalue_reference<T>::value, "Functions with rvalue reference arguments cannot be vectorized"); + // The wrapped function gets called with this type: + using call_type = remove_reference_t<T>; + // Is this a vectorized argument? + static constexpr bool vectorize = + satisfies_any_of<call_type, std::is_arithmetic, is_complex, std::is_pod>::value + && satisfies_none_of<call_type, std::is_pointer, std::is_array, is_std_array, std::is_enum>::value + && (!std::is_reference<T>::value || (std::is_lvalue_reference<T>::value && std::is_const<call_type>::value)); + // Accept this type: an array for vectorized types, otherwise the type as-is: + using type = conditional_t<vectorize, array_t<remove_cv_t<call_type>, array::forcecast>, T>; +}; + +template <typename Func, typename Return, typename... Args> +struct vectorize_helper +{ +private: + static constexpr size_t N = sizeof...(Args); + static constexpr size_t NVectorized = constexpr_sum(vectorize_arg<Args>::vectorize...); + static_assert(NVectorized >= 1, + "pybind11::vectorize(...) requires a function with at least one vectorizable argument"); + +public: + template <typename T> + explicit vectorize_helper(T&& f) + : f(std::forward<T>(f)) + {} + + object operator()(typename vectorize_arg<Args>::type... args) + { + return run(args..., + make_index_sequence<N>(), + select_indices<vectorize_arg<Args>::vectorize...>(), + make_index_sequence<NVectorized>()); + } + +private: + remove_reference_t<Func> f; + + // Internal compiler error in MSVC 19.16.27025.1 (Visual Studio 2017 15.9.4), when compiling with "/permissive-" flag + // when arg_call_types is manually inlined. + using arg_call_types = std::tuple<typename vectorize_arg<Args>::call_type...>; + template <size_t Index> + using param_n_t = typename std::tuple_element<Index, arg_call_types>::type; + + // Runs a vectorized function given arguments tuple and three index sequences: + // - Index is the full set of 0 ... (N-1) argument indices; + // - VIndex is the subset of argument indices with vectorized parameters, letting us access + // vectorized arguments (anything not in this sequence is passed through) + // - BIndex is a incremental sequence (beginning at 0) of the same size as VIndex, so that + // we can store vectorized buffer_infos in an array (argument VIndex has its buffer at + // index BIndex in the array). + template <size_t... Index, size_t... VIndex, size_t... BIndex> + object run(typename vectorize_arg<Args>::type&... args, + index_sequence<Index...> i_seq, + index_sequence<VIndex...> vi_seq, + index_sequence<BIndex...> bi_seq) + { + + // Pointers to values the function was called with; the vectorized ones set here will start + // out as array_t<T> pointers, but they will be changed them to T pointers before we make + // call the wrapped function. Non-vectorized pointers are left as-is. + std::array<void*, N> params{{&args...}}; + + // The array of `buffer_info`s of vectorized arguments: + std::array<buffer_info, NVectorized> buffers{{reinterpret_cast<array*>(params[VIndex])->request()...}}; + + /* Determine dimensions parameters of output array */ + ssize_t nd = 0; + std::vector<ssize_t> shape(0); + auto trivial = broadcast(buffers, nd, shape); + size_t ndim = (size_t)nd; + + size_t size = std::accumulate(shape.begin(), shape.end(), (size_t)1, std::multiplies<size_t>()); + + // If all arguments are 0-dimension arrays (i.e. single values) return a plain value (i.e. + // not wrapped in an array). + if (size == 1 && ndim == 0) { + PYBIND11_EXPAND_SIDE_EFFECTS(params[VIndex] = buffers[BIndex].ptr); + return cast(f(*reinterpret_cast<param_n_t<Index>*>(params[Index])...)); + } + + array_t<Return> result; + if (trivial == broadcast_trivial::f_trivial) + result = array_t<Return, array::f_style>(shape); + else + result = array_t<Return>(shape); + + if (size == 0) + return std::move(result); + + /* Call the function */ + if (trivial == broadcast_trivial::non_trivial) + apply_broadcast(buffers, params, result, i_seq, vi_seq, bi_seq); + else + apply_trivial(buffers, params, result.mutable_data(), size, i_seq, vi_seq, bi_seq); + + return std::move(result); + } + + template <size_t... Index, size_t... VIndex, size_t... BIndex> + void apply_trivial(std::array<buffer_info, NVectorized>& buffers, + std::array<void*, N>& params, + Return* out, + size_t size, + index_sequence<Index...>, + index_sequence<VIndex...>, + index_sequence<BIndex...>) + { + + // Initialize an array of mutable byte references and sizes with references set to the + // appropriate pointer in `params`; as we iterate, we'll increment each pointer by its size + // (except for singletons, which get an increment of 0). + std::array<std::pair<unsigned char*&, const size_t>, NVectorized> vecparams{ + {std::pair<unsigned char*&, const size_t>( + reinterpret_cast<unsigned char*&>(params[VIndex] = buffers[BIndex].ptr), + buffers[BIndex].size == 1 ? 0 : sizeof(param_n_t<VIndex>))...}}; + + for (size_t i = 0; i < size; ++i) { + out[i] = f(*reinterpret_cast<param_n_t<Index>*>(params[Index])...); + for (auto& x : vecparams) + x.first += x.second; + } + } + + template <size_t... Index, size_t... VIndex, size_t... BIndex> + void apply_broadcast(std::array<buffer_info, NVectorized>& buffers, + std::array<void*, N>& params, + array_t<Return>& output_array, + index_sequence<Index...>, + index_sequence<VIndex...>, + index_sequence<BIndex...>) + { + + buffer_info output = output_array.request(); + multi_array_iterator<NVectorized> input_iter(buffers, output.shape); + + for (array_iterator<Return> iter = array_begin<Return>(output), end = array_end<Return>(output); iter != end; + ++iter, ++input_iter) { + PYBIND11_EXPAND_SIDE_EFFECTS((params[VIndex] = input_iter.template data<BIndex>())); + *iter = f(*reinterpret_cast<param_n_t<Index>*>(std::get<Index>(params))...); + } + } +}; + +template <typename Func, typename Return, typename... Args> +vectorize_helper<Func, Return, Args...> vectorize_extractor(const Func& f, Return (*)(Args...)) +{ + return detail::vectorize_helper<Func, Return, Args...>(f); +} + +template <typename T, int Flags> +struct handle_type_name<array_t<T, Flags>> +{ + static constexpr auto name = _("numpy.ndarray[") + npy_format_descriptor<T>::name + _("]"); +}; + +NAMESPACE_END(detail) + +// Vanilla pointer vectorizer: +template <typename Return, typename... Args> +detail::vectorize_helper<Return (*)(Args...), Return, Args...> vectorize(Return (*f)(Args...)) +{ + return detail::vectorize_helper<Return (*)(Args...), Return, Args...>(f); +} + +// lambda vectorizer: +template <typename Func, detail::enable_if_t<detail::is_lambda<Func>::value, int> = 0> +auto vectorize(Func&& f) + -> decltype(detail::vectorize_extractor(std::forward<Func>(f), (detail::function_signature_t<Func>*)nullptr)) +{ + return detail::vectorize_extractor(std::forward<Func>(f), (detail::function_signature_t<Func>*)nullptr); +} + +// Vectorize a class method (non-const): +template < + typename Return, + typename Class, + typename... Args, + typename Helper = detail:: + vectorize_helper<decltype(std::mem_fn(std::declval<Return (Class::*)(Args...)>())), Return, Class*, Args...>> +Helper vectorize(Return (Class::*f)(Args...)) +{ + return Helper(std::mem_fn(f)); +} + +// Vectorize a class method (const): +template < + typename Return, + typename Class, + typename... Args, + typename Helper = detail::vectorize_helper<decltype(std::mem_fn(std::declval<Return (Class::*)(Args...) const>())), + Return, + const Class*, + Args...>> +Helper vectorize(Return (Class::*f)(Args...) const) +{ + return Helper(std::mem_fn(f)); +} + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) +# pragma warning(pop) +#endif diff --git a/dune/pybindxi/operators.h b/dune/pybindxi/operators.h new file mode 100644 index 0000000000000000000000000000000000000000..8131edf9f9dd6db6328e1d5680e7e552526e78fe --- /dev/null +++ b/dune/pybindxi/operators.h @@ -0,0 +1,275 @@ +#pragma GCC system_header +/* + pybind11/operator.h: Metatemplates for operator overloading + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" + +#if defined(__clang__) && !defined(__INTEL_COMPILER) +# pragma clang diagnostic ignored \ + "-Wunsequenced" // multiple unsequenced modifications to 'self' (when using def(py::self OP Type())) +#elif defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable : 4127) // warning C4127: Conditional expression is constant +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// Enumeration with all supported operator types +enum op_id : int +{ + op_add, + op_sub, + op_mul, + op_div, + op_mod, + op_divmod, + op_pow, + op_lshift, + op_rshift, + op_and, + op_xor, + op_or, + op_neg, + op_pos, + op_abs, + op_invert, + op_int, + op_long, + op_float, + op_str, + op_cmp, + op_gt, + op_ge, + op_lt, + op_le, + op_eq, + op_ne, + op_iadd, + op_isub, + op_imul, + op_idiv, + op_imod, + op_ilshift, + op_irshift, + op_iand, + op_ixor, + op_ior, + op_complex, + op_bool, + op_nonzero, + op_repr, + op_truediv, + op_itruediv, + op_hash +}; + +enum op_type : int +{ + op_l, /* base type on left */ + op_r, /* base type on right */ + op_u /* unary operator */ +}; + +struct self_t +{}; +static const self_t self = self_t(); + +/// Type for an unused type slot +struct undefined_t +{}; + +/// Don't warn about an unused variable +inline self_t __self() +{ + return self; +} + +/// base template of operator implementations +template <op_id, op_type, typename B, typename L, typename R> +struct op_impl +{}; + +/// Operator implementation generator +template <op_id id, op_type ot, typename L, typename R> +struct op_ +{ + template <typename Class, typename... Extra> + void execute(Class& cl, const Extra&... extra) const + { + using Base = typename Class::type; + using L_type = conditional_t<std::is_same<L, self_t>::value, Base, L>; + using R_type = conditional_t<std::is_same<R, self_t>::value, Base, R>; + using op = op_impl<id, ot, Base, L_type, R_type>; + cl.def(op::name(), &op::execute, is_operator(), extra...); +#if PY_MAJOR_VERSION < 3 + if (id == op_truediv || id == op_itruediv) + cl.def( + id == op_itruediv ? "__idiv__" : ot == op_l ? "__div__" : "__rdiv__", &op::execute, is_operator(), extra...); +#endif + } + template <typename Class, typename... Extra> + void execute_cast(Class& cl, const Extra&... extra) const + { + using Base = typename Class::type; + using L_type = conditional_t<std::is_same<L, self_t>::value, Base, L>; + using R_type = conditional_t<std::is_same<R, self_t>::value, Base, R>; + using op = op_impl<id, ot, Base, L_type, R_type>; + cl.def(op::name(), &op::execute_cast, is_operator(), extra...); +#if PY_MAJOR_VERSION < 3 + if (id == op_truediv || id == op_itruediv) + cl.def( + id == op_itruediv ? "__idiv__" : ot == op_l ? "__div__" : "__rdiv__", &op::execute, is_operator(), extra...); +#endif + } +}; + +#define PYBIND11_BINARY_OPERATOR(id, rid, op, expr) \ + template <typename B, typename L, typename R> \ + struct op_impl<op_##id, op_l, B, L, R> \ + { \ + static char const* name() \ + { \ + return "__" #id "__"; \ + } \ + static auto execute(const L& l, const R& r) -> decltype(expr) \ + { \ + return (expr); \ + } \ + static B execute_cast(const L& l, const R& r) \ + { \ + return B(expr); \ + } \ + }; \ + template <typename B, typename L, typename R> \ + struct op_impl<op_##id, op_r, B, L, R> \ + { \ + static char const* name() \ + { \ + return "__" #rid "__"; \ + } \ + static auto execute(const R& r, const L& l) -> decltype(expr) \ + { \ + return (expr); \ + } \ + static B execute_cast(const R& r, const L& l) \ + { \ + return B(expr); \ + } \ + }; \ + inline op_<op_##id, op_l, self_t, self_t> op(const self_t&, const self_t&) \ + { \ + return op_<op_##id, op_l, self_t, self_t>(); \ + } \ + template <typename T> \ + op_<op_##id, op_l, self_t, T> op(const self_t&, const T&) \ + { \ + return op_<op_##id, op_l, self_t, T>(); \ + } \ + template <typename T> \ + op_<op_##id, op_r, T, self_t> op(const T&, const self_t&) \ + { \ + return op_<op_##id, op_r, T, self_t>(); \ + } + +#define PYBIND11_INPLACE_OPERATOR(id, op, expr) \ + template <typename B, typename L, typename R> \ + struct op_impl<op_##id, op_l, B, L, R> \ + { \ + static char const* name() \ + { \ + return "__" #id "__"; \ + } \ + static auto execute(L& l, const R& r) -> decltype(expr) \ + { \ + return expr; \ + } \ + static B execute_cast(L& l, const R& r) \ + { \ + return B(expr); \ + } \ + }; \ + template <typename T> \ + op_<op_##id, op_l, self_t, T> op(const self_t&, const T&) \ + { \ + return op_<op_##id, op_l, self_t, T>(); \ + } + +#define PYBIND11_UNARY_OPERATOR(id, op, expr) \ + template <typename B, typename L> \ + struct op_impl<op_##id, op_u, B, L, undefined_t> \ + { \ + static char const* name() \ + { \ + return "__" #id "__"; \ + } \ + static auto execute(const L& l) -> decltype(expr) \ + { \ + return expr; \ + } \ + static B execute_cast(const L& l) \ + { \ + return B(expr); \ + } \ + }; \ + inline op_<op_##id, op_u, self_t, undefined_t> op(const self_t&) \ + { \ + return op_<op_##id, op_u, self_t, undefined_t>(); \ + } + +PYBIND11_BINARY_OPERATOR(sub, rsub, operator-, l - r) +PYBIND11_BINARY_OPERATOR(add, radd, operator+, l + r) +PYBIND11_BINARY_OPERATOR(mul, rmul, operator*, l* r) +PYBIND11_BINARY_OPERATOR(truediv, rtruediv, operator/, l / r) +PYBIND11_BINARY_OPERATOR(mod, rmod, operator%, l % r) +PYBIND11_BINARY_OPERATOR(lshift, rlshift, operator<<, l << r) +PYBIND11_BINARY_OPERATOR(rshift, rrshift, operator>>, l>> r) +PYBIND11_BINARY_OPERATOR(and, rand, operator&, l& r) +PYBIND11_BINARY_OPERATOR (xor, rxor, operator^, l ^ r) +PYBIND11_BINARY_OPERATOR(eq, eq, operator==, l == r) +PYBIND11_BINARY_OPERATOR(ne, ne, operator!=, l != r) +PYBIND11_BINARY_OPERATOR(or, ror, operator|, l | r) +PYBIND11_BINARY_OPERATOR(gt, lt, operator>, l> r) +PYBIND11_BINARY_OPERATOR(ge, le, operator>=, l >= r) +PYBIND11_BINARY_OPERATOR(lt, gt, operator<, l<r) +PYBIND11_BINARY_OPERATOR(le, ge, operator<=, l <= r) +// PYBIND11_BINARY_OPERATOR(pow, rpow, pow, std::pow(l, r)) +PYBIND11_INPLACE_OPERATOR(iadd, operator+=, l += r) +PYBIND11_INPLACE_OPERATOR(isub, operator-=, l -= r) +PYBIND11_INPLACE_OPERATOR(imul, operator*=, l *= r) +PYBIND11_INPLACE_OPERATOR(itruediv, operator/=, l /= r) +PYBIND11_INPLACE_OPERATOR(imod, operator%=, l %= r) +PYBIND11_INPLACE_OPERATOR(ilshift, operator<<=, l <<= r) +PYBIND11_INPLACE_OPERATOR(irshift, operator>>=, l >>= r) +PYBIND11_INPLACE_OPERATOR(iand, operator&=, l &= r) +PYBIND11_INPLACE_OPERATOR(ixor, operator^=, l ^= r) +PYBIND11_INPLACE_OPERATOR(ior, operator|=, l |= r) +PYBIND11_UNARY_OPERATOR(neg, operator-, - l) +PYBIND11_UNARY_OPERATOR(pos, operator+, + l) +PYBIND11_UNARY_OPERATOR(abs, abs, std::abs(l)) +PYBIND11_UNARY_OPERATOR(hash, hash, std::hash<L>()(l)) +PYBIND11_UNARY_OPERATOR(invert, operator~,(~l)) +PYBIND11_UNARY_OPERATOR(bool, operator!, !!l) +PYBIND11_UNARY_OPERATOR(int, int_, (int)l) +PYBIND11_UNARY_OPERATOR(float, float_, (double)l) + +#undef PYBIND11_BINARY_OPERATOR +#undef PYBIND11_INPLACE_OPERATOR +#undef PYBIND11_UNARY_OPERATOR +NAMESPACE_END(detail) + +using detail::self; + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) +# pragma warning(pop) +#endif diff --git a/dune/pybindxi/options.h b/dune/pybindxi/options.h new file mode 100644 index 0000000000000000000000000000000000000000..68b19364e17bf52681bc4f1d5540e1dfcf82d275 --- /dev/null +++ b/dune/pybindxi/options.h @@ -0,0 +1,92 @@ +#pragma GCC system_header +/* + pybind11/options.h: global settings that are configurable at runtime. + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +class options +{ +public: + // Default RAII constructor, which leaves settings as they currently are. + options() + : previous_state(global_state()) + {} + + // Class is non-copyable. + options(const options&) = delete; + options& operator=(const options&) = delete; + + // Destructor, which restores settings that were in effect before. + ~options() + { + global_state() = previous_state; + } + + // Setter methods (affect the global state): + + options& disable_user_defined_docstrings() & + { + global_state().show_user_defined_docstrings = false; + return *this; + } + + options& enable_user_defined_docstrings() & + { + global_state().show_user_defined_docstrings = true; + return *this; + } + + options& disable_function_signatures() & + { + global_state().show_function_signatures = false; + return *this; + } + + options& enable_function_signatures() & + { + global_state().show_function_signatures = true; + return *this; + } + + // Getter methods (return the global state): + + static bool show_user_defined_docstrings() + { + return global_state().show_user_defined_docstrings; + } + + static bool show_function_signatures() + { + return global_state().show_function_signatures; + } + + // This type is not meant to be allocated on the heap. + void* operator new(size_t) = delete; + +private: + struct state + { + bool show_user_defined_docstrings = true; //< Include user-supplied texts in docstrings. + bool show_function_signatures = true; //< Include auto-generated function signatures in docstrings. + }; + + static state& global_state() + { + static state instance; + return instance; + } + + state previous_state; +}; + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/pybind11.h b/dune/pybindxi/pybind11.h new file mode 100644 index 0000000000000000000000000000000000000000..158ae4f4348ba8edb728f88f96189c590d80a1e5 --- /dev/null +++ b/dune/pybindxi/pybind11.h @@ -0,0 +1,2371 @@ +#pragma GCC system_header +/* + pybind11/pybind11.h: Main header file of the C++11 python + binding generator library + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#if defined(__INTEL_COMPILER) +# pragma warning push +# pragma warning disable 68 // integer conversion resulted in a change of sign +# pragma warning disable 186 // pointless comparison of unsigned integer with zero +# pragma warning disable 878 // incompatible exception specifications +# pragma warning disable 1334 // the "template" keyword used for syntactic disambiguation may only be used within a + // template +# pragma warning disable 1682 // implicit conversion of a 64-bit integral type to a smaller integral type (potential + // portability problem) +# pragma warning disable 1786 // function "strdup" was declared deprecated +# pragma warning disable 1875 // offsetof applied to non-POD (Plain Old Data) types is nonstandard +# pragma warning disable 2196 // warning #2196: routine is both "inline" and "noinline" +#elif defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable : 4100) // warning C4100: Unreferenced formal parameter +# pragma warning(disable : 4127) // warning C4127: Conditional expression is constant +# pragma warning(disable : 4512) // warning C4512: Assignment operator was implicitly defined as deleted +# pragma warning(disable : 4800) // warning C4800: 'int': forcing value to bool 'true' or 'false' (performance warning) +# pragma warning(disable : 4996) // warning C4996: The POSIX name for this item is deprecated. Instead, use the ISO C + // and C++ conformant name +# pragma warning(disable : 4702) // warning C4702: unreachable code +# pragma warning(disable : 4522) // warning C4522: multiple assignment operators specified +#elif defined(__GNUG__) && !defined(__clang__) +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wunused-but-set-parameter" +# pragma GCC diagnostic ignored "-Wunused-but-set-variable" +# pragma GCC diagnostic ignored "-Wmissing-field-initializers" +# pragma GCC diagnostic ignored "-Wstrict-aliasing" +# pragma GCC diagnostic ignored "-Wattributes" +# if __GNUC__ >= 7 +# pragma GCC diagnostic ignored "-Wnoexcept-type" +# endif +#endif + +#include "attr.h" +#include "options.h" +#include "detail/class.h" +#include "detail/init.h" + +#if defined(__GNUG__) && !defined(__clang__) +# include <cxxabi.h> +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/// Wraps an arbitrary C++ function/method/lambda function/.. into a callable Python object +class cpp_function : public function +{ +public: + cpp_function() {} + cpp_function(std::nullptr_t) {} + + /// Construct a cpp_function from a vanilla function pointer + template <typename Return, typename... Args, typename... Extra> + cpp_function(Return (*f)(Args...), const Extra&... extra) + { + initialize(f, f, extra...); + } + + /// Construct a cpp_function from a lambda function (possibly with internal state) + template <typename Func, typename... Extra, typename = detail::enable_if_t<detail::is_lambda<Func>::value>> + cpp_function(Func&& f, const Extra&... extra) + { + initialize(std::forward<Func>(f), (detail::function_signature_t<Func>*)nullptr, extra...); + } + + /// Construct a cpp_function from a class method (non-const) + template <typename Return, typename Class, typename... Arg, typename... Extra> + cpp_function(Return (Class::*f)(Arg...), const Extra&... extra) + { + initialize([f](Class* c, Arg... args) -> Return { return (c->*f)(args...); }, + (Return(*)(Class*, Arg...)) nullptr, + extra...); + } + + /// Construct a cpp_function from a class method (const) + template <typename Return, typename Class, typename... Arg, typename... Extra> + cpp_function(Return (Class::*f)(Arg...) const, const Extra&... extra) + { + initialize([f](const Class* c, Arg... args) -> Return { return (c->*f)(args...); }, + (Return(*)(const Class*, Arg...)) nullptr, + extra...); + } + + /// Return the function name + object name() const + { + return attr("__name__"); + } + +protected: + /// Space optimization: don't inline this frequently instantiated fragment + PYBIND11_NOINLINE detail::function_record* make_function_record() + { + return new detail::function_record(); + } + + /// Special internal constructor for functors, lambda functions, etc. + template <typename Func, typename Return, typename... Args, typename... Extra> + void initialize(Func&& f, Return (*)(Args...), const Extra&... extra) + { + using namespace detail; + struct capture + { + remove_reference_t<Func> f; + }; + + /* Store the function including any extra state it might have (e.g. a lambda capture object) */ + auto rec = make_function_record(); + + /* Store the capture object directly in the function record if there is enough space */ + if (sizeof(capture) <= sizeof(rec->data)) { + /* Without these pragmas, GCC warns that there might not be + enough space to use the placement new operator. However, the + 'if' statement above ensures that this is the case. */ +#if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6 +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wplacement-new" +#endif + new ((capture*)&rec->data) capture{std::forward<Func>(f)}; +#if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6 +# pragma GCC diagnostic pop +#endif + if (!std::is_trivially_destructible<Func>::value) + rec->free_data = [](function_record* r) { ((capture*)&r->data)->~capture(); }; + } else { + rec->data[0] = new capture{std::forward<Func>(f)}; + rec->free_data = [](function_record* r) { delete ((capture*)r->data[0]); }; + } + + /* Type casters for the function arguments and return value */ + using cast_in = argument_loader<Args...>; + using cast_out = make_caster<conditional_t<std::is_void<Return>::value, void_type, Return>>; + + static_assert(expected_num_args<Extra...>(sizeof...(Args), cast_in::has_args, cast_in::has_kwargs), + "The number of argument annotations does not match the number of function arguments"); + + /* Dispatch code which converts function arguments and performs the actual function call */ + rec->impl = [](function_call& call) -> handle { + cast_in args_converter; + + /* Try to cast the function arguments into the C++ domain */ + if (!args_converter.load_args(call)) + return PYBIND11_TRY_NEXT_OVERLOAD; + + /* Invoke call policy pre-call hook */ + process_attributes<Extra...>::precall(call); + + /* Get a pointer to the capture object */ + auto data = (sizeof(capture) <= sizeof(call.func.data) ? &call.func.data : call.func.data[0]); + capture* cap = const_cast<capture*>(reinterpret_cast<const capture*>(data)); + + /* Override policy for rvalues -- usually to enforce rvp::move on an rvalue */ + return_value_policy policy = return_value_policy_override<Return>::policy(call.func.policy); + + /* Function scope guard -- defaults to the compile-to-nothing `void_type` */ + using Guard = extract_guard_t<Extra...>; + + /* Perform the function call */ + handle result = + cast_out::cast(std::move(args_converter).template call<Return, Guard>(cap->f), policy, call.parent); + + /* Invoke call policy post-call hook */ + process_attributes<Extra...>::postcall(call, result); + + return result; + }; + + /* Process any user-provided function attributes */ + process_attributes<Extra...>::init(extra..., rec); + + /* Generate a readable signature describing the function's arguments and return value types */ + static constexpr auto signature = _("(") + cast_in::arg_names + _(") -> ") + cast_out::name; + PYBIND11_DESCR_CONSTEXPR auto types = decltype(signature)::types(); + + /* Register the function with Python from generic (non-templated) code */ + initialize_generic(rec, signature.text, types.data(), sizeof...(Args)); + + if (cast_in::has_args) + rec->has_args = true; + if (cast_in::has_kwargs) + rec->has_kwargs = true; + + /* Stash some additional information used by an important optimization in 'functional.h' */ + using FunctionType = Return (*)(Args...); + constexpr bool is_function_ptr = std::is_convertible<Func, FunctionType>::value && sizeof(capture) == sizeof(void*); + if (is_function_ptr) { + rec->is_stateless = true; + rec->data[1] = const_cast<void*>(reinterpret_cast<const void*>(&typeid(FunctionType))); + } + } + + /// Register a function call with Python (generic non-templated code goes here) + void + initialize_generic(detail::function_record* rec, const char* text, const std::type_info* const* types, size_t args) + { + + /* Create copies of all referenced C-style strings */ + rec->name = strdup(rec->name ? rec->name : ""); + if (rec->doc) + rec->doc = strdup(rec->doc); + for (auto& a : rec->args) { + if (a.name) + a.name = strdup(a.name); + if (a.descr) + a.descr = strdup(a.descr); + else if (a.value) + a.descr = strdup(a.value.attr("__repr__")().cast<std::string>().c_str()); + } + + rec->is_constructor = !strcmp(rec->name, "__init__") || !strcmp(rec->name, "__setstate__"); + +#if !defined(NDEBUG) && !defined(PYBIND11_DISABLE_NEW_STYLE_INIT_WARNING) + if (rec->is_constructor && !rec->is_new_style_constructor) { + const auto class_name = std::string(((PyTypeObject*)rec->scope.ptr())->tp_name); + const auto func_name = std::string(rec->name); + PyErr_WarnEx(PyExc_FutureWarning, + ("pybind11-bound class '" + class_name + + "' is using an old-style " + "placement-new '" + + func_name + + "' which has been deprecated. See " + "the upgrade guide in pybind11's docs. This message is only visible " + "when compiled in debug mode.") + .c_str(), + 0); + } +#endif + + /* Generate a proper function signature */ + std::string signature; + size_t type_index = 0, arg_index = 0; + for (auto* pc = text; *pc != '\0'; ++pc) { + const auto c = *pc; + + if (c == '{') { + // Write arg name for everything except *args and **kwargs. + if (*(pc + 1) == '*') + continue; + + if (arg_index < rec->args.size() && rec->args[arg_index].name) { + signature += rec->args[arg_index].name; + } else if (arg_index == 0 && rec->is_method) { + signature += "self"; + } else { + signature += "arg" + std::to_string(arg_index - (rec->is_method ? 1 : 0)); + } + signature += ": "; + } else if (c == '}') { + // Write default value if available. + if (arg_index < rec->args.size() && rec->args[arg_index].descr) { + signature += " = "; + signature += rec->args[arg_index].descr; + } + arg_index++; + } else if (c == '%') { + const std::type_info* t = types[type_index++]; + if (!t) + pybind11_fail("Internal error while parsing type signature (1)"); + if (auto tinfo = detail::get_type_info(*t)) { + handle th((PyObject*)tinfo->type); + signature += + th.attr("__module__").cast<std::string>() + "." + + th.attr("__qualname__").cast<std::string>(); // Python 3.3+, but we backport it to earlier versions + } else if (rec->is_new_style_constructor && arg_index == 0) { + // A new-style `__init__` takes `self` as `value_and_holder`. + // Rewrite it to the proper class type. + signature += rec->scope.attr("__module__").cast<std::string>() + "." + + rec->scope.attr("__qualname__").cast<std::string>(); + } else { + std::string tname(t->name()); + detail::clean_type_id(tname); + signature += tname; + } + } else { + signature += c; + } + } + if (arg_index != args || types[type_index] != nullptr) + pybind11_fail("Internal error while parsing type signature (2)"); + +#if PY_MAJOR_VERSION < 3 + if (strcmp(rec->name, "__next__") == 0) { + std::free(rec->name); + rec->name = strdup("next"); + } else if (strcmp(rec->name, "__bool__") == 0) { + std::free(rec->name); + rec->name = strdup("__nonzero__"); + } +#endif + rec->signature = strdup(signature.c_str()); + rec->args.shrink_to_fit(); + rec->nargs = (std::uint16_t)args; + + if (rec->sibling && PYBIND11_INSTANCE_METHOD_CHECK(rec->sibling.ptr())) + rec->sibling = PYBIND11_INSTANCE_METHOD_GET_FUNCTION(rec->sibling.ptr()); + + detail::function_record *chain = nullptr, *chain_start = rec; + if (rec->sibling) { + if (PyCFunction_Check(rec->sibling.ptr())) { + auto rec_capsule = reinterpret_borrow<capsule>(PyCFunction_GET_SELF(rec->sibling.ptr())); + chain = (detail::function_record*)rec_capsule; + /* Never append a method to an overload chain of a parent class; + instead, hide the parent's overloads in this case */ + if (!chain->scope.is(rec->scope)) + chain = nullptr; + } + // Don't trigger for things like the default __init__, which are wrapper_descriptors that we are intentionally + // replacing + else if (!rec->sibling.is_none() && rec->name[0] != '_') + pybind11_fail("Cannot overload existing non-function object \"" + std::string(rec->name) + + "\" with a function of the same name"); + } + + if (!chain) { + /* No existing overload was found, create a new function object */ + rec->def = new PyMethodDef(); + std::memset(rec->def, 0, sizeof(PyMethodDef)); + rec->def->ml_name = rec->name; + rec->def->ml_meth = reinterpret_cast<PyCFunction>(reinterpret_cast<void (*)(void)>(*dispatcher)); + rec->def->ml_flags = METH_VARARGS | METH_KEYWORDS; + + capsule rec_capsule(rec, [](void* ptr) { destruct((detail::function_record*)ptr); }); + + object scope_module; + if (rec->scope) { + if (hasattr(rec->scope, "__module__")) { + scope_module = rec->scope.attr("__module__"); + } else if (hasattr(rec->scope, "__name__")) { + scope_module = rec->scope.attr("__name__"); + } + } + + m_ptr = PyCFunction_NewEx(rec->def, rec_capsule.ptr(), scope_module.ptr()); + if (!m_ptr) + pybind11_fail("cpp_function::cpp_function(): Could not allocate function object"); + } else { + /* Append at the end of the overload chain */ + m_ptr = rec->sibling.ptr(); + inc_ref(); + chain_start = chain; + if (chain->is_method != rec->is_method) + pybind11_fail("overloading a method with both static and instance methods is not supported; " +#if defined(NDEBUG) + "compile in debug mode for more details" +#else + "error while attempting to bind " + + std::string(rec->is_method ? "instance" : "static") + " method " + + std::string(pybind11::str(rec->scope.attr("__name__"))) + "." + std::string(rec->name) + + signature +#endif + ); + while (chain->next) + chain = chain->next; + chain->next = rec; + } + + std::string signatures; + int index = 0; + /* Create a nice pydoc rec including all signatures and + docstrings of the functions in the overload chain */ + if (chain && options::show_function_signatures()) { + // First a generic signature + signatures += rec->name; + signatures += "(*args, **kwargs)\n"; + signatures += "Overloaded function.\n\n"; + } + // Then specific overload signatures + bool first_user_def = true; + for (auto it = chain_start; it != nullptr; it = it->next) { + if (options::show_function_signatures()) { + if (index > 0) + signatures += "\n"; + if (chain) + signatures += std::to_string(++index) + ". "; + signatures += rec->name; + signatures += it->signature; + signatures += "\n"; + } + if (it->doc && strlen(it->doc) > 0 && options::show_user_defined_docstrings()) { + // If we're appending another docstring, and aren't printing function signatures, we + // need to append a newline first: + if (!options::show_function_signatures()) { + if (first_user_def) + first_user_def = false; + else + signatures += "\n"; + } + if (options::show_function_signatures()) + signatures += "\n"; + signatures += it->doc; + if (options::show_function_signatures()) + signatures += "\n"; + } + } + + /* Install docstring */ + PyCFunctionObject* func = (PyCFunctionObject*)m_ptr; + if (func->m_ml->ml_doc) + std::free(const_cast<char*>(func->m_ml->ml_doc)); + func->m_ml->ml_doc = strdup(signatures.c_str()); + + if (rec->is_method) { + m_ptr = PYBIND11_INSTANCE_METHOD_NEW(m_ptr, rec->scope.ptr()); + if (!m_ptr) + pybind11_fail("cpp_function::cpp_function(): Could not allocate instance method object"); + Py_DECREF(func); + } + } + + /// When a cpp_function is GCed, release any memory allocated by pybind11 + static void destruct(detail::function_record* rec) + { + while (rec) { + detail::function_record* next = rec->next; + if (rec->free_data) + rec->free_data(rec); + std::free((char*)rec->name); + std::free((char*)rec->doc); + std::free((char*)rec->signature); + for (auto& arg : rec->args) { + std::free(const_cast<char*>(arg.name)); + std::free(const_cast<char*>(arg.descr)); + arg.value.dec_ref(); + } + if (rec->def) { + std::free(const_cast<char*>(rec->def->ml_doc)); + delete rec->def; + } + delete rec; + rec = next; + } + } + + /// Main dispatch logic for calls to functions bound using pybind11 + static PyObject* dispatcher(PyObject* self, PyObject* args_in, PyObject* kwargs_in) + { + using namespace detail; + + /* Iterator over the list of potentially admissible overloads */ + const function_record *overloads = (function_record*)PyCapsule_GetPointer(self, nullptr), *it = overloads; + + /* Need to know how many arguments + keyword arguments there are to pick the right overload */ + const size_t n_args_in = (size_t)PyTuple_GET_SIZE(args_in); + + handle parent = n_args_in > 0 ? PyTuple_GET_ITEM(args_in, 0) : nullptr, result = PYBIND11_TRY_NEXT_OVERLOAD; + + auto self_value_and_holder = value_and_holder(); + if (overloads->is_constructor) { + const auto tinfo = get_type_info((PyTypeObject*)overloads->scope.ptr()); + const auto pi = reinterpret_cast<instance*>(parent.ptr()); + self_value_and_holder = pi->get_value_and_holder(tinfo, false); + + if (!self_value_and_holder.type || !self_value_and_holder.inst) { + PyErr_SetString(PyExc_TypeError, "__init__(self, ...) called with invalid `self` argument"); + return nullptr; + } + + // If this value is already registered it must mean __init__ is invoked multiple times; + // we really can't support that in C++, so just ignore the second __init__. + if (self_value_and_holder.instance_registered()) + return none().release().ptr(); + } + + try { + // We do this in two passes: in the first pass, we load arguments with `convert=false`; + // in the second, we allow conversion (except for arguments with an explicit + // py::arg().noconvert()). This lets us prefer calls without conversion, with + // conversion as a fallback. + std::vector<function_call> second_pass; + + // However, if there are no overloads, we can just skip the no-convert pass entirely + const bool overloaded = it != nullptr && it->next != nullptr; + + for (; it != nullptr; it = it->next) { + + /* For each overload: + 1. Copy all positional arguments we were given, also checking to make sure that + named positional arguments weren't *also* specified via kwarg. + 2. If we weren't given enough, try to make up the omitted ones by checking + whether they were provided by a kwarg matching the `py::arg("name")` name. If + so, use it (and remove it from kwargs; if not, see if the function binding + provided a default that we can use. + 3. Ensure that either all keyword arguments were "consumed", or that the function + takes a kwargs argument to accept unconsumed kwargs. + 4. Any positional arguments still left get put into a tuple (for args), and any + leftover kwargs get put into a dict. + 5. Pack everything into a vector; if we have py::args or py::kwargs, they are an + extra tuple or dict at the end of the positional arguments. + 6. Call the function call dispatcher (function_record::impl) + + If one of these fail, move on to the next overload and keep trying until we get a + result other than PYBIND11_TRY_NEXT_OVERLOAD. + */ + + const function_record& func = *it; + size_t pos_args = func.nargs; // Number of positional arguments that we need + if (func.has_args) + --pos_args; // (but don't count py::args + if (func.has_kwargs) + --pos_args; // or py::kwargs) + + if (!func.has_args && n_args_in > pos_args) + continue; // Too many arguments for this overload + + if (n_args_in < pos_args && func.args.size() < pos_args) + continue; // Not enough arguments given, and not enough defaults to fill in the blanks + + function_call call(func, parent); + + size_t args_to_copy = std::min(pos_args, n_args_in); + size_t args_copied = 0; + + // 0. Inject new-style `self` argument + if (func.is_new_style_constructor) { + // The `value` may have been preallocated by an old-style `__init__` + // if it was a preceding candidate for overload resolution. + if (self_value_and_holder) + self_value_and_holder.type->dealloc(self_value_and_holder); + + call.init_self = PyTuple_GET_ITEM(args_in, 0); + call.args.push_back(reinterpret_cast<PyObject*>(&self_value_and_holder)); + call.args_convert.push_back(false); + ++args_copied; + } + + // 1. Copy any position arguments given. + bool bad_arg = false; + for (; args_copied < args_to_copy; ++args_copied) { + const argument_record* arg_rec = args_copied < func.args.size() ? &func.args[args_copied] : nullptr; + if (kwargs_in && arg_rec && arg_rec->name && PyDict_GetItemString(kwargs_in, arg_rec->name)) { + bad_arg = true; + break; + } + + handle arg(PyTuple_GET_ITEM(args_in, args_copied)); + if (arg_rec && !arg_rec->none && arg.is_none()) { + bad_arg = true; + break; + } + call.args.push_back(arg); + call.args_convert.push_back(arg_rec ? arg_rec->convert : true); + } + if (bad_arg) + continue; // Maybe it was meant for another overload (issue #688) + + // We'll need to copy this if we steal some kwargs for defaults + dict kwargs = reinterpret_borrow<dict>(kwargs_in); + + // 2. Check kwargs and, failing that, defaults that may help complete the list + if (args_copied < pos_args) { + bool copied_kwargs = false; + + for (; args_copied < pos_args; ++args_copied) { + const auto& arg = func.args[args_copied]; + + handle value; + if (kwargs_in && arg.name) + value = PyDict_GetItemString(kwargs.ptr(), arg.name); + + if (value) { + // Consume a kwargs value + if (!copied_kwargs) { + kwargs = reinterpret_steal<dict>(PyDict_Copy(kwargs.ptr())); + copied_kwargs = true; + } + PyDict_DelItemString(kwargs.ptr(), arg.name); + } else if (arg.value) { + value = arg.value; + } + + if (value) { + call.args.push_back(value); + call.args_convert.push_back(arg.convert); + } else + break; + } + + if (args_copied < pos_args) + continue; // Not enough arguments, defaults, or kwargs to fill the positional arguments + } + + // 3. Check everything was consumed (unless we have a kwargs arg) + if (kwargs && kwargs.size() > 0 && !func.has_kwargs) + continue; // Unconsumed kwargs, but no py::kwargs argument to accept them + + // 4a. If we have a py::args argument, create a new tuple with leftovers + if (func.has_args) { + tuple extra_args; + if (args_to_copy == 0) { + // We didn't copy out any position arguments from the args_in tuple, so we + // can reuse it directly without copying: + extra_args = reinterpret_borrow<tuple>(args_in); + } else if (args_copied >= n_args_in) { + extra_args = tuple(0); + } else { + size_t args_size = n_args_in - args_copied; + extra_args = tuple(args_size); + for (size_t i = 0; i < args_size; ++i) { + extra_args[i] = PyTuple_GET_ITEM(args_in, args_copied + i); + } + } + call.args.push_back(extra_args); + call.args_convert.push_back(false); + call.args_ref = std::move(extra_args); + } + + // 4b. If we have a py::kwargs, pass on any remaining kwargs + if (func.has_kwargs) { + if (!kwargs.ptr()) + kwargs = dict(); // If we didn't get one, send an empty one + call.args.push_back(kwargs); + call.args_convert.push_back(false); + call.kwargs_ref = std::move(kwargs); + } + +// 5. Put everything in a vector. Not technically step 5, we've been building it +// in `call.args` all along. +#if !defined(NDEBUG) + if (call.args.size() != func.nargs || call.args_convert.size() != func.nargs) + pybind11_fail("Internal error: function call dispatcher inserted wrong number of arguments!"); +#endif + + std::vector<bool> second_pass_convert; + if (overloaded) { + // We're in the first no-convert pass, so swap out the conversion flags for a + // set of all-false flags. If the call fails, we'll swap the flags back in for + // the conversion-allowed call below. + second_pass_convert.resize(func.nargs, false); + call.args_convert.swap(second_pass_convert); + } + + // 6. Call the function. + try { + loader_life_support guard{}; + result = func.impl(call); + } catch (reference_cast_error&) { + result = PYBIND11_TRY_NEXT_OVERLOAD; + } + + if (result.ptr() != PYBIND11_TRY_NEXT_OVERLOAD) + break; + + if (overloaded) { + // The (overloaded) call failed; if the call has at least one argument that + // permits conversion (i.e. it hasn't been explicitly specified `.noconvert()`) + // then add this call to the list of second pass overloads to try. + for (size_t i = func.is_method ? 1 : 0; i < pos_args; i++) { + if (second_pass_convert[i]) { + // Found one: swap the converting flags back in and store the call for + // the second pass. + call.args_convert.swap(second_pass_convert); + second_pass.push_back(std::move(call)); + break; + } + } + } + } + + if (overloaded && !second_pass.empty() && result.ptr() == PYBIND11_TRY_NEXT_OVERLOAD) { + // The no-conversion pass finished without success, try again with conversion allowed + for (auto& call : second_pass) { + try { + loader_life_support guard{}; + result = call.func.impl(call); + } catch (reference_cast_error&) { + result = PYBIND11_TRY_NEXT_OVERLOAD; + } + + if (result.ptr() != PYBIND11_TRY_NEXT_OVERLOAD) { + // The error reporting logic below expects 'it' to be valid, as it would be + // if we'd encountered this failure in the first-pass loop. + if (!result) + it = &call.func; + break; + } + } + } + } catch (error_already_set& e) { + e.restore(); + return nullptr; +#if defined(__GNUG__) && !defined(__clang__) + } catch (abi::__forced_unwind&) { + throw; +#endif + } catch (...) { + /* When an exception is caught, give each registered exception + translator a chance to translate it to a Python exception + in reverse order of registration. + + A translator may choose to do one of the following: + + - catch the exception and call PyErr_SetString or PyErr_SetObject + to set a standard (or custom) Python exception, or + - do nothing and let the exception fall through to the next translator, or + - delegate translation to the next translator by throwing a new type of exception. */ + + auto last_exception = std::current_exception(); + auto& registered_exception_translators = get_internals().registered_exception_translators; + for (auto& translator : registered_exception_translators) { + try { + translator(last_exception); + } catch (...) { + last_exception = std::current_exception(); + continue; + } + return nullptr; + } + PyErr_SetString(PyExc_SystemError, "Exception escaped from default exception translator!"); + return nullptr; + } + + auto append_note_if_missing_header_is_suspected = [](std::string& msg) { + if (msg.find("std::") != std::string::npos) { + msg += "\n\n" + "Did you forget to `#include <pybind11/stl.h>`? Or <pybind11/complex.h>,\n" + "<pybind11/functional.h>, <pybind11/chrono.h>, etc. Some automatic\n" + "conversions are optional and require extra headers to be included\n" + "when compiling your pybind11 module."; + } + }; + + if (result.ptr() == PYBIND11_TRY_NEXT_OVERLOAD) { + if (overloads->is_operator) + return handle(Py_NotImplemented).inc_ref().ptr(); + + std::string msg = std::string(overloads->name) + "(): incompatible " + + std::string(overloads->is_constructor ? "constructor" : "function") + + " arguments. The following argument types are supported:\n"; + + int ctr = 0; + for (const function_record* it2 = overloads; it2 != nullptr; it2 = it2->next) { + msg += " " + std::to_string(++ctr) + ". "; + + bool wrote_sig = false; + if (overloads->is_constructor) { + // For a constructor, rewrite `(self: Object, arg0, ...) -> NoneType` as `Object(arg0, ...)` + std::string sig = it2->signature; + size_t start = sig.find('(') + 7; // skip "(self: " + if (start < sig.size()) { + // End at the , for the next argument + size_t end = sig.find(", "), next = end + 2; + size_t ret = sig.rfind(" -> "); + // Or the ), if there is no comma: + if (end >= sig.size()) + next = end = sig.find(')'); + if (start < end && next < sig.size()) { + msg.append(sig, start, end - start); + msg += '('; + msg.append(sig, next, ret - next); + wrote_sig = true; + } + } + } + if (!wrote_sig) + msg += it2->signature; + + msg += "\n"; + } + msg += "\nInvoked with: "; + auto args_ = reinterpret_borrow<tuple>(args_in); + bool some_args = false; + for (size_t ti = overloads->is_constructor ? 1 : 0; ti < args_.size(); ++ti) { + if (!some_args) + some_args = true; + else + msg += ", "; + msg += pybind11::repr(args_[ti]); + } + if (kwargs_in) { + auto kwargs = reinterpret_borrow<dict>(kwargs_in); + if (kwargs.size() > 0) { + if (some_args) + msg += "; "; + msg += "kwargs: "; + bool first = true; + for (auto kwarg : kwargs) { + if (first) + first = false; + else + msg += ", "; + msg += pybind11::str("{}={!r}").format(kwarg.first, kwarg.second); + } + } + } + + append_note_if_missing_header_is_suspected(msg); + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return nullptr; + } else if (!result) { + std::string msg = "Unable to convert function return value to a " + "Python type! The signature was\n\t"; + msg += it->signature; + append_note_if_missing_header_is_suspected(msg); + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return nullptr; + } else { + if (overloads->is_constructor && !self_value_and_holder.holder_constructed()) { + auto* pi = reinterpret_cast<instance*>(parent.ptr()); + self_value_and_holder.type->init_instance(pi, nullptr); + } + return result.ptr(); + } + } +}; + +/// Wrapper for Python extension modules +class module : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(module, object, PyModule_Check) + + /// Create a new top-level Python module with the given name and docstring + explicit module(const char* name, const char* doc = nullptr) + { + if (!options::show_user_defined_docstrings()) + doc = nullptr; +#if PY_MAJOR_VERSION >= 3 + PyModuleDef* def = new PyModuleDef(); + std::memset(def, 0, sizeof(PyModuleDef)); + def->m_name = name; + def->m_doc = doc; + def->m_size = -1; + Py_INCREF(def); + m_ptr = PyModule_Create(def); +#else + m_ptr = Py_InitModule3(name, nullptr, doc); +#endif + if (m_ptr == nullptr) + pybind11_fail("Internal error in module::module()"); + inc_ref(); + } + + /** \rst + Create Python binding for a new function within the module scope. ``Func`` + can be a plain C++ function, a function pointer, or a lambda function. For + details on the ``Extra&& ... extra`` argument, see section :ref:`extras`. + \endrst */ + template <typename Func, typename... Extra> + module& def(const char* name_, Func&& f, const Extra&... extra) + { + cpp_function func( + std::forward<Func>(f), name(name_), scope(*this), sibling(getattr(*this, name_, none())), extra...); + // NB: allow overwriting here because cpp_function sets up a chain with the intention of + // overwriting (and has already checked internally that it isn't overwriting non-functions). + add_object(name_, func, true /* overwrite */); + return *this; + } + + /** \rst + Create and return a new Python submodule with the given name and docstring. + This also works recursively, i.e. + + .. code-block:: cpp + + py::module m("example", "pybind11 example plugin"); + py::module m2 = m.def_submodule("sub", "A submodule of 'example'"); + py::module m3 = m2.def_submodule("subsub", "A submodule of 'example.sub'"); + \endrst */ + module def_submodule(const char* name, const char* doc = nullptr) + { + std::string full_name = std::string(PyModule_GetName(m_ptr)) + std::string(".") + std::string(name); + auto result = reinterpret_borrow<module>(PyImport_AddModule(full_name.c_str())); + if (doc && options::show_user_defined_docstrings()) + result.attr("__doc__") = pybind11::str(doc); + attr(name) = result; + return result; + } + + /// Import and return a module or throws `error_already_set`. + static module import(const char* name) + { + PyObject* obj = PyImport_ImportModule(name); + if (!obj) + throw error_already_set(); + return reinterpret_steal<module>(obj); + } + + /// Reload the module or throws `error_already_set`. + void reload() + { + PyObject* obj = PyImport_ReloadModule(ptr()); + if (!obj) + throw error_already_set(); + *this = reinterpret_steal<module>(obj); + } + + // Adds an object to the module using the given name. Throws if an object with the given name + // already exists. + // + // overwrite should almost always be false: attempting to overwrite objects that pybind11 has + // established will, in most cases, break things. + PYBIND11_NOINLINE void add_object(const char* name, handle obj, bool overwrite = false) + { + if (!overwrite && hasattr(*this, name)) + pybind11_fail("Error during initialization: multiple incompatible definitions with name \"" + std::string(name) + + "\""); + + PyModule_AddObject(ptr(), name, obj.inc_ref().ptr() /* steals a reference */); + } +}; + +/// \ingroup python_builtins +/// Return a dictionary representing the global variables in the current execution frame, +/// or ``__main__.__dict__`` if there is no frame (usually when the interpreter is embedded). +inline dict globals() +{ + PyObject* p = PyEval_GetGlobals(); + return reinterpret_borrow<dict>(p ? p : module::import("__main__").attr("__dict__").ptr()); +} + +NAMESPACE_BEGIN(detail) +/// Generic support for creating new Python heap types +class generic_type : public object +{ + template <typename...> + friend class class_; + +public: + PYBIND11_OBJECT_DEFAULT(generic_type, object, PyType_Check) +protected: + void initialize(const type_record& rec) + { + if (rec.scope && hasattr(rec.scope, rec.name)) + pybind11_fail("generic_type: cannot initialize type \"" + std::string(rec.name) + + "\": an object with that name is already defined"); + + if (rec.module_local ? get_local_type_info(*rec.type) : get_global_type_info(*rec.type)) + pybind11_fail("generic_type: type \"" + std::string(rec.name) + "\" is already registered!"); + + m_ptr = make_new_python_type(rec); + + /* Register supplemental type information in C++ dict */ + auto* tinfo = new detail::type_info(); + tinfo->type = (PyTypeObject*)m_ptr; + tinfo->cpptype = rec.type; + tinfo->type_size = rec.type_size; + tinfo->type_align = rec.type_align; + tinfo->operator_new = rec.operator_new; + tinfo->holder_size_in_ptrs = size_in_ptrs(rec.holder_size); + tinfo->init_instance = rec.init_instance; + tinfo->dealloc = rec.dealloc; + tinfo->simple_type = true; + tinfo->simple_ancestors = true; + tinfo->default_holder = rec.default_holder; + tinfo->module_local = rec.module_local; + + auto& internals = get_internals(); + auto tindex = std::type_index(*rec.type); + tinfo->direct_conversions = &internals.direct_conversions[tindex]; + if (rec.module_local) + registered_local_types_cpp()[tindex] = tinfo; + else + internals.registered_types_cpp[tindex] = tinfo; + internals.registered_types_py[(PyTypeObject*)m_ptr] = {tinfo}; + + if (rec.bases.size() > 1 || rec.multiple_inheritance) { + mark_parents_nonsimple(tinfo->type); + tinfo->simple_ancestors = false; + } else if (rec.bases.size() == 1) { + auto parent_tinfo = get_type_info((PyTypeObject*)rec.bases[0].ptr()); + tinfo->simple_ancestors = parent_tinfo->simple_ancestors; + } + + if (rec.module_local) { + // Stash the local typeinfo and loader so that external modules can access it. + tinfo->module_local_load = &type_caster_generic::local_load; + setattr(m_ptr, PYBIND11_MODULE_LOCAL_ID, capsule(tinfo)); + } + } + + /// Helper function which tags all parents of a type using mult. inheritance + void mark_parents_nonsimple(PyTypeObject* value) + { + auto t = reinterpret_borrow<tuple>(value->tp_bases); + for (handle h : t) { + auto tinfo2 = get_type_info((PyTypeObject*)h.ptr()); + if (tinfo2) + tinfo2->simple_type = false; + mark_parents_nonsimple((PyTypeObject*)h.ptr()); + } + } + + void install_buffer_funcs(buffer_info* (*get_buffer)(PyObject*, void*), void* get_buffer_data) + { + PyHeapTypeObject* type = (PyHeapTypeObject*)m_ptr; + auto tinfo = detail::get_type_info(&type->ht_type); + + if (!type->ht_type.tp_as_buffer) + pybind11_fail("To be able to register buffer protocol support for the type '" + std::string(tinfo->type->tp_name) + + "' the associated class<>(..) invocation must " + "include the pybind11::buffer_protocol() annotation!"); + + tinfo->get_buffer = get_buffer; + tinfo->get_buffer_data = get_buffer_data; + } + + // rec_func must be set for either fget or fset. + void def_property_static_impl(const char* name, handle fget, handle fset, detail::function_record* rec_func) + { + const auto is_static = rec_func && !(rec_func->is_method && rec_func->scope); + const auto has_doc = rec_func && rec_func->doc && pybind11::options::show_user_defined_docstrings(); + auto property = handle((PyObject*)(is_static ? get_internals().static_property_type : &PyProperty_Type)); + attr(name) = property(fget.ptr() ? fget : none(), + fset.ptr() ? fset : none(), + /*deleter*/ none(), + pybind11::str(has_doc ? rec_func->doc : "")); + } +}; + +/// Set the pointer to operator new if it exists. The cast is needed because it can be overloaded. +template <typename T, typename = void_t<decltype(static_cast<void* (*)(size_t)>(T::operator new))>> +void set_operator_new(type_record* r) +{ + r->operator_new = &T::operator new; +} + +template <typename> +void set_operator_new(...) +{} + +template <typename T, typename SFINAE = void> +struct has_operator_delete : std::false_type +{}; +template <typename T> +struct has_operator_delete<T, void_t<decltype(static_cast<void (*)(void*)>(T::operator delete))>> : std::true_type +{}; +template <typename T, typename SFINAE = void> +struct has_operator_delete_size : std::false_type +{}; +template <typename T> +struct has_operator_delete_size<T, void_t<decltype(static_cast<void (*)(void*, size_t)>(T::operator delete))>> + : std::true_type +{}; +/// Call class-specific delete if it exists or global otherwise. Can also be an overload set. +template <typename T, enable_if_t<has_operator_delete<T>::value, int> = 0> +void call_operator_delete(T* p, size_t, size_t) +{ + T::operator delete(p); +} +template <typename T, enable_if_t<!has_operator_delete<T>::value && has_operator_delete_size<T>::value, int> = 0> +void call_operator_delete(T* p, size_t s, size_t) +{ + T::operator delete(p, s); +} + +inline void call_operator_delete(void* p, size_t s, size_t a) +{ + (void)s; + (void)a; +#if defined(PYBIND11_CPP17) + if (a > __STDCPP_DEFAULT_NEW_ALIGNMENT__) + ::operator delete(p, s, std::align_val_t(a)); + else + ::operator delete(p, s); +#else + ::operator delete(p); +#endif +} + +NAMESPACE_END(detail) + +/// Given a pointer to a member function, cast it to its `Derived` version. +/// Forward everything else unchanged. +template <typename /*Derived*/, typename F> +auto method_adaptor(F&& f) -> decltype(std::forward<F>(f)) +{ + return std::forward<F>(f); +} + +template <typename Derived, typename Return, typename Class, typename... Args> +auto method_adaptor(Return (Class::*pmf)(Args...)) -> Return (Derived::*)(Args...) +{ + static_assert(detail::is_accessible_base_of<Class, Derived>::value, + "Cannot bind an inaccessible base class method; use a lambda definition instead"); + return pmf; +} + +template <typename Derived, typename Return, typename Class, typename... Args> +auto method_adaptor(Return (Class::*pmf)(Args...) const) -> Return (Derived::*)(Args...) const +{ + static_assert(detail::is_accessible_base_of<Class, Derived>::value, + "Cannot bind an inaccessible base class method; use a lambda definition instead"); + return pmf; +} + +template <typename type_, typename... options> +class class_ : public detail::generic_type +{ + template <typename T> + using is_holder = detail::is_holder_type<type_, T>; + template <typename T> + using is_subtype = detail::is_strict_base_of<type_, T>; + template <typename T> + using is_base = detail::is_strict_base_of<T, type_>; + // struct instead of using here to help MSVC: + template <typename T> + struct is_valid_class_option : detail::any_of<is_holder<T>, is_subtype<T>, is_base<T>> + {}; + +public: + using type = type_; + using type_alias = detail::exactly_one_t<is_subtype, void, options...>; + constexpr static bool has_alias = !std::is_void<type_alias>::value; + using holder_type = detail::exactly_one_t<is_holder, std::unique_ptr<type>, options...>; + + static_assert(detail::all_of<is_valid_class_option<options>...>::value, + "Unknown/invalid class_ template parameters provided"); + + static_assert(!has_alias || std::is_polymorphic<type>::value, + "Cannot use an alias class with a non-polymorphic type"); + + PYBIND11_OBJECT(class_, generic_type, PyType_Check) + + template <typename... Extra> + class_(handle scope, const char* name, const Extra&... extra) + { + using namespace detail; + + // MI can only be specified via class_ template options, not constructor parameters + static_assert(none_of<is_pyobject<Extra>...>::value || // no base class arguments, or: + (constexpr_sum(is_pyobject<Extra>::value...) == 1 && // Exactly one base + constexpr_sum(is_base<options>::value...) == 0 && // no template option bases + none_of<std::is_same<multiple_inheritance, Extra>...>::value), // no multiple_inheritance attr + "Error: multiple inheritance bases must be specified via class_ template options"); + + type_record record; + record.scope = scope; + record.name = name; + record.type = &typeid(type); + record.type_size = sizeof(conditional_t<has_alias, type_alias, type>); + record.type_align = alignof(conditional_t<has_alias, type_alias, type>&); + record.holder_size = sizeof(holder_type); + record.init_instance = init_instance; + record.dealloc = dealloc; + record.default_holder = detail::is_instantiation<std::unique_ptr, holder_type>::value; + + set_operator_new<type>(&record); + + /* Register base classes specified via template arguments to class_, if any */ + PYBIND11_EXPAND_SIDE_EFFECTS(add_base<options>(record)); + + /* Process optional arguments, if any */ + process_attributes<Extra...>::init(extra..., &record); + + generic_type::initialize(record); + + if (has_alias) { + auto& instances = record.module_local ? registered_local_types_cpp() : get_internals().registered_types_cpp; + instances[std::type_index(typeid(type_alias))] = instances[std::type_index(typeid(type))]; + } + } + + template <typename Base, detail::enable_if_t<is_base<Base>::value, int> = 0> + static void add_base(detail::type_record& rec) + { + rec.add_base(typeid(Base), [](void* src) -> void* { return static_cast<Base*>(reinterpret_cast<type*>(src)); }); + } + + template <typename Base, detail::enable_if_t<!is_base<Base>::value, int> = 0> + static void add_base(detail::type_record&) + {} + + template <typename Func, typename... Extra> + class_& def(const char* name_, Func&& f, const Extra&... extra) + { + cpp_function cf(method_adaptor<type>(std::forward<Func>(f)), + name(name_), + is_method(*this), + sibling(getattr(*this, name_, none())), + extra...); + attr(cf.name()) = cf; + return *this; + } + + template <typename Func, typename... Extra> + class_& def_static(const char* name_, Func&& f, const Extra&... extra) + { + static_assert(!std::is_member_function_pointer<Func>::value, + "def_static(...) called with a non-static member function pointer"); + cpp_function cf(std::forward<Func>(f), name(name_), scope(*this), sibling(getattr(*this, name_, none())), extra...); + attr(cf.name()) = staticmethod(cf); + return *this; + } + + template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra> + class_& def(const detail::op_<id, ot, L, R>& op, const Extra&... extra) + { + op.execute(*this, extra...); + return *this; + } + + template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra> + class_& def_cast(const detail::op_<id, ot, L, R>& op, const Extra&... extra) + { + op.execute_cast(*this, extra...); + return *this; + } + + template <typename... Args, typename... Extra> + class_& def(const detail::initimpl::constructor<Args...>& init, const Extra&... extra) + { + init.execute(*this, extra...); + return *this; + } + + template <typename... Args, typename... Extra> + class_& def(const detail::initimpl::alias_constructor<Args...>& init, const Extra&... extra) + { + init.execute(*this, extra...); + return *this; + } + + template <typename... Args, typename... Extra> + class_& def(detail::initimpl::factory<Args...>&& init, const Extra&... extra) + { + std::move(init).execute(*this, extra...); + return *this; + } + + template <typename... Args, typename... Extra> + class_& def(detail::initimpl::pickle_factory<Args...>&& pf, const Extra&... extra) + { + std::move(pf).execute(*this, extra...); + return *this; + } + + template <typename Func> + class_& def_buffer(Func&& func) + { + struct capture + { + Func func; + }; + capture* ptr = new capture{std::forward<Func>(func)}; + install_buffer_funcs( + [](PyObject* obj, void* ptr) -> buffer_info* { + detail::make_caster<type> caster; + if (!caster.load(obj, false)) + return nullptr; + return new buffer_info(((capture*)ptr)->func(caster)); + }, + ptr); + return *this; + } + + template <typename Return, typename Class, typename... Args> + class_& def_buffer(Return (Class::*func)(Args...)) + { + return def_buffer([func](type& obj) { return (obj.*func)(); }); + } + + template <typename Return, typename Class, typename... Args> + class_& def_buffer(Return (Class::*func)(Args...) const) + { + return def_buffer([func](const type& obj) { return (obj.*func)(); }); + } + + template <typename C, typename D, typename... Extra> + class_& def_readwrite(const char* name, D C::*pm, const Extra&... extra) + { + static_assert(std::is_same<C, type>::value || std::is_base_of<C, type>::value, + "def_readwrite() requires a class member (or base class member)"); + cpp_function fget([pm](const type&c) -> const D& { return c.*pm; }, is_method(*this)), + fset([pm](type&c, const D&value) { c.*pm = value; }, is_method(*this)); + def_property(name, fget, fset, return_value_policy::reference_internal, extra...); + return *this; + } + + template <typename C, typename D, typename... Extra> + class_& def_readonly(const char* name, const D C::*pm, const Extra&... extra) + { + static_assert(std::is_same<C, type>::value || std::is_base_of<C, type>::value, + "def_readonly() requires a class member (or base class member)"); + cpp_function fget([pm](const type& c) -> const D& { return c.*pm; }, is_method(*this)); + def_property_readonly(name, fget, return_value_policy::reference_internal, extra...); + return *this; + } + + template <typename D, typename... Extra> + class_& def_readwrite_static(const char* name, D* pm, const Extra&... extra) + { + cpp_function fget([pm](object) -> const D& { return *pm; }, scope(*this)), + fset([pm](object, const D&value) { *pm = value; }, scope(*this)); + def_property_static(name, fget, fset, return_value_policy::reference, extra...); + return *this; + } + + template <typename D, typename... Extra> + class_& def_readonly_static(const char* name, const D* pm, const Extra&... extra) + { + cpp_function fget([pm](object) -> const D& { return *pm; }, scope(*this)); + def_property_readonly_static(name, fget, return_value_policy::reference, extra...); + return *this; + } + + /// Uses return_value_policy::reference_internal by default + template <typename Getter, typename... Extra> + class_& def_property_readonly(const char* name, const Getter& fget, const Extra&... extra) + { + return def_property_readonly( + name, cpp_function(method_adaptor<type>(fget)), return_value_policy::reference_internal, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template <typename... Extra> + class_& def_property_readonly(const char* name, const cpp_function& fget, const Extra&... extra) + { + return def_property(name, fget, nullptr, extra...); + } + + /// Uses return_value_policy::reference by default + template <typename Getter, typename... Extra> + class_& def_property_readonly_static(const char* name, const Getter& fget, const Extra&... extra) + { + return def_property_readonly_static(name, cpp_function(fget), return_value_policy::reference, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template <typename... Extra> + class_& def_property_readonly_static(const char* name, const cpp_function& fget, const Extra&... extra) + { + return def_property_static(name, fget, nullptr, extra...); + } + + /// Uses return_value_policy::reference_internal by default + template <typename Getter, typename Setter, typename... Extra> + class_& def_property(const char* name, const Getter& fget, const Setter& fset, const Extra&... extra) + { + return def_property(name, fget, cpp_function(method_adaptor<type>(fset)), extra...); + } + template <typename Getter, typename... Extra> + class_& def_property(const char* name, const Getter& fget, const cpp_function& fset, const Extra&... extra) + { + return def_property( + name, cpp_function(method_adaptor<type>(fget)), fset, return_value_policy::reference_internal, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template <typename... Extra> + class_& def_property(const char* name, const cpp_function& fget, const cpp_function& fset, const Extra&... extra) + { + return def_property_static(name, fget, fset, is_method(*this), extra...); + } + + /// Uses return_value_policy::reference by default + template <typename Getter, typename... Extra> + class_& def_property_static(const char* name, const Getter& fget, const cpp_function& fset, const Extra&... extra) + { + return def_property_static(name, cpp_function(fget), fset, return_value_policy::reference, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template <typename... Extra> + class_& + def_property_static(const char* name, const cpp_function& fget, const cpp_function& fset, const Extra&... extra) + { + static_assert(0 == detail::constexpr_sum(std::is_base_of<arg, Extra>::value...), + "Argument annotations are not allowed for properties"); + auto rec_fget = get_function_record(fget), rec_fset = get_function_record(fset); + auto* rec_active = rec_fget; + if (rec_fget) { + char* doc_prev = rec_fget->doc; /* 'extra' field may include a property-specific documentation string */ + detail::process_attributes<Extra...>::init(extra..., rec_fget); + if (rec_fget->doc && rec_fget->doc != doc_prev) { + free(doc_prev); + rec_fget->doc = strdup(rec_fget->doc); + } + } + if (rec_fset) { + char* doc_prev = rec_fset->doc; + detail::process_attributes<Extra...>::init(extra..., rec_fset); + if (rec_fset->doc && rec_fset->doc != doc_prev) { + free(doc_prev); + rec_fset->doc = strdup(rec_fset->doc); + } + if (!rec_active) + rec_active = rec_fset; + } + def_property_static_impl(name, fget, fset, rec_active); + return *this; + } + +private: + /// Initialize holder object, variant 1: object derives from enable_shared_from_this + template <typename T> + static void init_holder(detail::instance* inst, + detail::value_and_holder& v_h, + const holder_type* /* unused */, + const std::enable_shared_from_this<T>* /* dummy */) + { + try { + auto sh = + std::dynamic_pointer_cast<typename holder_type::element_type>(v_h.value_ptr<type>()->shared_from_this()); + if (sh) { + new (std::addressof(v_h.holder<holder_type>())) holder_type(std::move(sh)); + v_h.set_holder_constructed(); + } + } catch (const std::bad_weak_ptr&) { + } + + if (!v_h.holder_constructed() && inst->owned) { + new (std::addressof(v_h.holder<holder_type>())) holder_type(v_h.value_ptr<type>()); + v_h.set_holder_constructed(); + } + } + + static void init_holder_from_existing(const detail::value_and_holder& v_h, + const holder_type* holder_ptr, + std::true_type /*is_copy_constructible*/) + { + new (std::addressof(v_h.holder<holder_type>())) holder_type(*reinterpret_cast<const holder_type*>(holder_ptr)); + } + + static void init_holder_from_existing(const detail::value_and_holder& v_h, + const holder_type* holder_ptr, + std::false_type /*is_copy_constructible*/) + { + new (std::addressof(v_h.holder<holder_type>())) holder_type(std::move(*const_cast<holder_type*>(holder_ptr))); + } + + /// Initialize holder object, variant 2: try to construct from existing holder object, if possible + static void init_holder(detail::instance* inst, + detail::value_and_holder& v_h, + const holder_type* holder_ptr, + const void* /* dummy -- not enable_shared_from_this<T>) */) + { + if (holder_ptr) { + init_holder_from_existing(v_h, holder_ptr, std::is_copy_constructible<holder_type>()); + v_h.set_holder_constructed(); + } else if (inst->owned || detail::always_construct_holder<holder_type>::value) { + new (std::addressof(v_h.holder<holder_type>())) holder_type(v_h.value_ptr<type>()); + v_h.set_holder_constructed(); + } + } + + /// Performs instance initialization including constructing a holder and registering the known + /// instance. Should be called as soon as the `type` value_ptr is set for an instance. Takes an + /// optional pointer to an existing holder to use; if not specified and the instance is + /// `.owned`, a new holder will be constructed to manage the value pointer. + static void init_instance(detail::instance* inst, const void* holder_ptr) + { + auto v_h = inst->get_value_and_holder(detail::get_type_info(typeid(type))); + if (!v_h.instance_registered()) { + register_instance(inst, v_h.value_ptr(), v_h.type); + v_h.set_instance_registered(); + } + init_holder(inst, v_h, (const holder_type*)holder_ptr, v_h.value_ptr<type>()); + } + + /// Deallocates an instance; via holder, if constructed; otherwise via operator delete. + static void dealloc(detail::value_and_holder& v_h) + { + if (v_h.holder_constructed()) { + v_h.holder<holder_type>().~holder_type(); + v_h.set_holder_constructed(false); + } else { + detail::call_operator_delete(v_h.value_ptr<type>(), v_h.type->type_size, v_h.type->type_align); + } + v_h.value_ptr() = nullptr; + } + + static detail::function_record* get_function_record(handle h) + { + h = detail::get_function(h); + return h ? (detail::function_record*)reinterpret_borrow<capsule>(PyCFunction_GET_SELF(h.ptr())) : nullptr; + } +}; + +/// Binds an existing constructor taking arguments Args... +template <typename... Args> +detail::initimpl::constructor<Args...> init() +{ + return {}; +} +/// Like `init<Args...>()`, but the instance is always constructed through the alias class (even +/// when not inheriting on the Python side). +template <typename... Args> +detail::initimpl::alias_constructor<Args...> init_alias() +{ + return {}; +} + +/// Binds a factory function as a constructor +template <typename Func, typename Ret = detail::initimpl::factory<Func>> +Ret init(Func&& f) +{ + return {std::forward<Func>(f)}; +} + +/// Dual-argument factory function: the first function is called when no alias is needed, the second +/// when an alias is needed (i.e. due to python-side inheritance). Arguments must be identical. +template <typename CFunc, typename AFunc, typename Ret = detail::initimpl::factory<CFunc, AFunc>> +Ret init(CFunc&& c, AFunc&& a) +{ + return {std::forward<CFunc>(c), std::forward<AFunc>(a)}; +} + +/// Binds pickling functions `__getstate__` and `__setstate__` and ensures that the type +/// returned by `__getstate__` is the same as the argument accepted by `__setstate__`. +template <typename GetState, typename SetState> +detail::initimpl::pickle_factory<GetState, SetState> pickle(GetState&& g, SetState&& s) +{ + return {std::forward<GetState>(g), std::forward<SetState>(s)}; +} + +NAMESPACE_BEGIN(detail) +struct enum_base +{ + enum_base(handle base, handle parent) + : m_base(base) + , m_parent(parent) + {} + + PYBIND11_NOINLINE void init(bool is_arithmetic, bool is_convertible) + { + m_base.attr("__entries") = dict(); + auto property = handle((PyObject*)&PyProperty_Type); + auto static_property = handle((PyObject*)get_internals().static_property_type); + + m_base.attr("__repr__") = cpp_function( + [](handle arg) -> str { + handle type = arg.get_type(); + object type_name = type.attr("__name__"); + dict entries = type.attr("__entries"); + for (const auto& kv : entries) { + object other = kv.second[int_(0)]; + if (other.equal(arg)) + return pybind11::str("{}.{}").format(type_name, kv.first); + } + return pybind11::str("{}.???").format(type_name); + }, + is_method(m_base)); + + m_base.attr("name") = property(cpp_function( + [](handle arg) -> str { + dict entries = arg.get_type().attr("__entries"); + for (const auto& kv : entries) { + if (handle(kv.second[int_(0)]).equal(arg)) + return pybind11::str(kv.first); + } + return "???"; + }, + is_method(m_base))); + + m_base.attr("__doc__") = static_property(cpp_function([](handle arg) -> std::string { + std::string docstring; + dict entries = arg.attr("__entries"); + if (((PyTypeObject*)arg.ptr())->tp_doc) + docstring += std::string(((PyTypeObject*)arg.ptr())->tp_doc) + "\n\n"; + docstring += "Members:"; + for (const auto& kv : entries) { + auto key = std::string(pybind11::str(kv.first)); + auto comment = kv.second[int_(1)]; + docstring += "\n\n " + key; + if (!comment.is_none()) + docstring += " : " + (std::string)pybind11::str(comment); + } + return docstring; + }), + none(), + none(), + ""); + + m_base.attr("__members__") = static_property(cpp_function([](handle arg) -> dict { + dict entries = arg.attr("__entries"), m; + for (const auto& kv : entries) + m[kv.first] = kv.second[int_(0)]; + return m; + }), + none(), + none(), + ""); + +#define PYBIND11_ENUM_OP_STRICT(op, expr, strict_behavior) \ + m_base.attr(op) = cpp_function( \ + [](object a, object b) { \ + if (!a.get_type().is(b.get_type())) \ + strict_behavior; \ + return expr; \ + }, \ + is_method(m_base)) + +#define PYBIND11_ENUM_OP_CONV(op, expr) \ + m_base.attr(op) = cpp_function( \ + [](object a_, object b_) { \ + int_ a(a_), b(b_); \ + return expr; \ + }, \ + is_method(m_base)) + + if (is_convertible) { + PYBIND11_ENUM_OP_CONV("__eq__", !b.is_none() && a.equal(b)); + PYBIND11_ENUM_OP_CONV("__ne__", b.is_none() || !a.equal(b)); + + if (is_arithmetic) { + PYBIND11_ENUM_OP_CONV("__lt__", a < b); + PYBIND11_ENUM_OP_CONV("__gt__", a > b); + PYBIND11_ENUM_OP_CONV("__le__", a <= b); + PYBIND11_ENUM_OP_CONV("__ge__", a >= b); + PYBIND11_ENUM_OP_CONV("__and__", a & b); + PYBIND11_ENUM_OP_CONV("__rand__", a & b); + PYBIND11_ENUM_OP_CONV("__or__", a | b); + PYBIND11_ENUM_OP_CONV("__ror__", a | b); + PYBIND11_ENUM_OP_CONV("__xor__", a ^ b); + PYBIND11_ENUM_OP_CONV("__rxor__", a ^ b); + } + } else { + PYBIND11_ENUM_OP_STRICT("__eq__", int_(a).equal(int_(b)), return false); + PYBIND11_ENUM_OP_STRICT("__ne__", !int_(a).equal(int_(b)), return true); + + if (is_arithmetic) { +#define PYBIND11_THROW throw type_error("Expected an enumeration of matching type!"); + PYBIND11_ENUM_OP_STRICT("__lt__", int_(a) < int_(b), PYBIND11_THROW); + PYBIND11_ENUM_OP_STRICT("__gt__", int_(a) > int_(b), PYBIND11_THROW); + PYBIND11_ENUM_OP_STRICT("__le__", int_(a) <= int_(b), PYBIND11_THROW); + PYBIND11_ENUM_OP_STRICT("__ge__", int_(a) >= int_(b), PYBIND11_THROW); +#undef PYBIND11_THROW + } + } + +#undef PYBIND11_ENUM_OP_CONV +#undef PYBIND11_ENUM_OP_STRICT + + object getstate = cpp_function([](object arg) { return int_(arg); }, is_method(m_base)); + + m_base.attr("__getstate__") = getstate; + m_base.attr("__hash__") = getstate; + } + + PYBIND11_NOINLINE void value(char const* name_, object value, const char* doc = nullptr) + { + dict entries = m_base.attr("__entries"); + str name(name_); + if (entries.contains(name)) { + std::string type_name = (std::string)str(m_base.attr("__name__")); + throw value_error(type_name + ": element \"" + std::string(name_) + "\" already exists!"); + } + + entries[name] = std::make_pair(value, doc); + m_base.attr(name) = value; + } + + PYBIND11_NOINLINE void export_values() + { + dict entries = m_base.attr("__entries"); + for (const auto& kv : entries) + m_parent.attr(kv.first) = kv.second[int_(0)]; + } + + handle m_base; + handle m_parent; +}; + +NAMESPACE_END(detail) + +/// Binds C++ enumerations and enumeration classes to Python +template <typename Type> +class enum_ : public class_<Type> +{ +public: + using Base = class_<Type>; + using Base::attr; + using Base::def; + using Base::def_property_readonly; + using Base::def_property_readonly_static; + using Scalar = typename std::underlying_type<Type>::type; + + template <typename... Extra> + enum_(const handle& scope, const char* name, const Extra&... extra) + : class_<Type>(scope, name, extra...) + , m_base(*this, scope) + { + constexpr bool is_arithmetic = detail::any_of<std::is_same<arithmetic, Extra>...>::value; + constexpr bool is_convertible = std::is_convertible<Type, Scalar>::value; + m_base.init(is_arithmetic, is_convertible); + + def(init([](Scalar i) { return static_cast<Type>(i); })); + def("__int__", [](Type value) { return (Scalar)value; }); +#if PY_MAJOR_VERSION < 3 + def("__long__", [](Type value) { return (Scalar)value; }); +#endif + cpp_function setstate([](Type& value, Scalar arg) { value = static_cast<Type>(arg); }, is_method(*this)); + attr("__setstate__") = setstate; + } + + /// Export enumeration entries into the parent scope + enum_& export_values() + { + m_base.export_values(); + return *this; + } + + /// Add an enumeration entry + enum_& value(char const* name, Type value, const char* doc = nullptr) + { + m_base.value(name, pybind11::cast(value, return_value_policy::copy), doc); + return *this; + } + +private: + detail::enum_base m_base; +}; + +NAMESPACE_BEGIN(detail) + + +inline void keep_alive_impl(handle nurse, handle patient) +{ + if (!nurse || !patient) + pybind11_fail("Could not activate keep_alive!"); + + if (patient.is_none() || nurse.is_none()) + return; /* Nothing to keep alive or nothing to be kept alive by */ + + auto tinfo = all_type_info(Py_TYPE(nurse.ptr())); + if (!tinfo.empty()) { + /* It's a pybind-registered type, so we can store the patient in the + * internal list. */ + add_patient(nurse.ptr(), patient.ptr()); + } else { + /* Fall back to clever approach based on weak references taken from + * Boost.Python. This is not used for pybind-registered types because + * the objects can be destroyed out-of-order in a GC pass. */ + cpp_function disable_lifesupport([patient](handle weakref) { + patient.dec_ref(); + weakref.dec_ref(); + }); + + weakref wr(nurse, disable_lifesupport); + + patient.inc_ref(); /* reference patient and leak the weak reference */ + (void)wr.release(); + } +} + +PYBIND11_NOINLINE inline void keep_alive_impl(size_t Nurse, size_t Patient, function_call& call, handle ret) +{ + auto get_arg = [&](size_t n) { + if (n == 0) + return ret; + else if (n == 1 && call.init_self) + return call.init_self; + else if (n <= call.args.size()) + return call.args[n - 1]; + return handle(); + }; + + keep_alive_impl(get_arg(Nurse), get_arg(Patient)); +} + +inline std::pair<decltype(internals::registered_types_py)::iterator, bool> all_type_info_get_cache(PyTypeObject* type) +{ + auto res = get_internals() + .registered_types_py +#ifdef __cpp_lib_unordered_map_try_emplace + .try_emplace(type); +#else + .emplace(type, std::vector<detail::type_info*>()); +#endif + if (res.second) { + // New cache entry created; set up a weak reference to automatically remove it if the type + // gets destroyed: + weakref((PyObject*)type, cpp_function([type](handle wr) { + get_internals().registered_types_py.erase(type); + wr.dec_ref(); + })) + .release(); + } + + return res; +} + +template <typename Iterator, typename Sentinel, bool KeyIterator, return_value_policy Policy> +struct iterator_state +{ + Iterator it; + Sentinel end; + bool first_or_done; +}; + +NAMESPACE_END(detail) + +/// Makes a python iterator from a first and past-the-end C++ InputIterator. +template <return_value_policy Policy = return_value_policy::reference_internal, + typename Iterator, + typename Sentinel, + typename ValueType = decltype(*std::declval<Iterator>()), + typename... Extra> +iterator make_iterator(Iterator first, Sentinel last, Extra&&... extra) +{ + typedef detail::iterator_state<Iterator, Sentinel, false, Policy> state; + + if (!detail::get_type_info(typeid(state), false)) { + class_<state>(handle(), "iterator", pybind11::module_local()) + .def("__iter__", [](state& s) -> state& { return s; }) + .def("__next__", + [](state& s) -> ValueType { + if (!s.first_or_done) + ++s.it; + else + s.first_or_done = false; + if (s.it == s.end) { + s.first_or_done = true; + throw stop_iteration(); + } + return *s.it; + }, + std::forward<Extra>(extra)..., + Policy); + } + + return cast(state{first, last, true}); +} + +/// Makes an python iterator over the keys (`.first`) of a iterator over pairs from a +/// first and past-the-end InputIterator. +template <return_value_policy Policy = return_value_policy::reference_internal, + typename Iterator, + typename Sentinel, + typename KeyType = decltype((*std::declval<Iterator>()).first), + typename... Extra> +iterator make_key_iterator(Iterator first, Sentinel last, Extra&&... extra) +{ + typedef detail::iterator_state<Iterator, Sentinel, true, Policy> state; + + if (!detail::get_type_info(typeid(state), false)) { + class_<state>(handle(), "iterator", pybind11::module_local()) + .def("__iter__", [](state& s) -> state& { return s; }) + .def("__next__", + [](state& s) -> KeyType { + if (!s.first_or_done) + ++s.it; + else + s.first_or_done = false; + if (s.it == s.end) { + s.first_or_done = true; + throw stop_iteration(); + } + return (*s.it).first; + }, + std::forward<Extra>(extra)..., + Policy); + } + + return cast(state{first, last, true}); +} + +/// Makes an iterator over values of an stl container or other container supporting +/// `std::begin()`/`std::end()` +template <return_value_policy Policy = return_value_policy::reference_internal, typename Type, typename... Extra> +iterator make_iterator(Type& value, Extra&&... extra) +{ + return make_iterator<Policy>(std::begin(value), std::end(value), extra...); +} + +/// Makes an iterator over the keys (`.first`) of a stl map-like container supporting +/// `std::begin()`/`std::end()` +template <return_value_policy Policy = return_value_policy::reference_internal, typename Type, typename... Extra> +iterator make_key_iterator(Type& value, Extra&&... extra) +{ + return make_key_iterator<Policy>(std::begin(value), std::end(value), extra...); +} + +template <typename InputType, typename OutputType> +void implicitly_convertible() +{ + struct set_flag + { + bool& flag; + set_flag(bool& flag) + : flag(flag) + { + flag = true; + } + ~set_flag() + { + flag = false; + } + }; + auto implicit_caster = [](PyObject* obj, PyTypeObject* type) -> PyObject* { + static bool currently_used = false; + if (currently_used) // implicit conversions are non-reentrant + return nullptr; + set_flag flag_helper(currently_used); + if (!detail::make_caster<InputType>().load(obj, false)) + return nullptr; + tuple args(1); + args[0] = obj; + PyObject* result = PyObject_Call((PyObject*)type, args.ptr(), nullptr); + if (result == nullptr) + PyErr_Clear(); + return result; + }; + + if (auto tinfo = detail::get_type_info(typeid(OutputType))) + tinfo->implicit_conversions.push_back(implicit_caster); + else + pybind11_fail("implicitly_convertible: Unable to find type " + type_id<OutputType>()); +} + +template <typename ExceptionTranslator> +void register_exception_translator(ExceptionTranslator&& translator) +{ + detail::get_internals().registered_exception_translators.push_front(std::forward<ExceptionTranslator>(translator)); +} + +/** + * Wrapper to generate a new Python exception type. + * + * This should only be used with PyErr_SetString for now. + * It is not (yet) possible to use as a py::base. + * Template type argument is reserved for future use. + */ +template <typename type> +class exception : public object +{ +public: + exception() = default; + exception(handle scope, const char* name, PyObject* base = PyExc_Exception) + { + std::string full_name = scope.attr("__name__").cast<std::string>() + std::string(".") + name; + m_ptr = PyErr_NewException(const_cast<char*>(full_name.c_str()), base, NULL); + if (hasattr(scope, name)) + pybind11_fail("Error during initialization: multiple incompatible " + "definitions with name \"" + + std::string(name) + "\""); + scope.attr(name) = *this; + } + + // Sets the current python exception to this exception object with the given message + void operator()(const char* message) + { + PyErr_SetString(m_ptr, message); + } +}; + +NAMESPACE_BEGIN(detail) +// Returns a reference to a function-local static exception object used in the simple +// register_exception approach below. (It would be simpler to have the static local variable +// directly in register_exception, but that makes clang <3.5 segfault - issue #1349). +template <typename CppException> +exception<CppException>& get_exception_object() +{ + static exception<CppException> ex; + return ex; +} +NAMESPACE_END(detail) + +/** + * Registers a Python exception in `m` of the given `name` and installs an exception translator to + * translate the C++ exception to the created Python exception using the exceptions what() method. + * This is intended for simple exception translations; for more complex translation, register the + * exception object and translator directly. + */ +template <typename CppException> +exception<CppException>& register_exception(handle scope, const char* name, PyObject* base = PyExc_Exception) +{ + auto& ex = detail::get_exception_object<CppException>(); + if (!ex) + ex = exception<CppException>(scope, name, base); + + register_exception_translator([](std::exception_ptr p) { + if (!p) + return; + try { + std::rethrow_exception(p); + } catch (const CppException& e) { + detail::get_exception_object<CppException>()(e.what()); + } + }); + return ex; +} + +NAMESPACE_BEGIN(detail) +PYBIND11_NOINLINE inline void print(tuple args, dict kwargs) +{ + auto strings = tuple(args.size()); + for (size_t i = 0; i < args.size(); ++i) { + strings[i] = str(args[i]); + } + auto sep = kwargs.contains("sep") ? kwargs["sep"] : cast(" "); + auto line = sep.attr("join")(strings); + + object file; + if (kwargs.contains("file")) { + file = kwargs["file"].cast<object>(); + } else { + try { + file = module::import("sys").attr("stdout"); + } catch (const error_already_set&) { + /* If print() is called from code that is executed as + part of garbage collection during interpreter shutdown, + importing 'sys' can fail. Give up rather than crashing the + interpreter in this case. */ + return; + } + } + + auto write = file.attr("write"); + write(line); + write(kwargs.contains("end") ? kwargs["end"] : cast("\n")); + + if (kwargs.contains("flush") && kwargs["flush"].cast<bool>()) + file.attr("flush")(); +} +NAMESPACE_END(detail) + +template <return_value_policy policy = return_value_policy::automatic_reference, typename... Args> +void print(Args&&... args) +{ + auto c = detail::collect_arguments<policy>(std::forward<Args>(args)...); + detail::print(c.args(), c.kwargs()); +} + +#if defined(WITH_THREAD) && !defined(PYPY_VERSION) + +/* The functions below essentially reproduce the PyGILState_* API using a RAII + * pattern, but there are a few important differences: + * + * 1. When acquiring the GIL from an non-main thread during the finalization + * phase, the GILState API blindly terminates the calling thread, which + * is often not what is wanted. This API does not do this. + * + * 2. The gil_scoped_release function can optionally cut the relationship + * of a PyThreadState and its associated thread, which allows moving it to + * another thread (this is a fairly rare/advanced use case). + * + * 3. The reference count of an acquired thread state can be controlled. This + * can be handy to prevent cases where callbacks issued from an external + * thread would otherwise constantly construct and destroy thread state data + * structures. + * + * See the Python bindings of NanoGUI (http://github.com/wjakob/nanogui) for an + * example which uses features 2 and 3 to migrate the Python thread of + * execution to another thread (to run the event loop on the original thread, + * in this case). + */ + +class gil_scoped_acquire +{ +public: + PYBIND11_NOINLINE gil_scoped_acquire() + { + auto const& internals = detail::get_internals(); + tstate = (PyThreadState*)PYBIND11_TLS_GET_VALUE(internals.tstate); + + if (!tstate) { + /* Check if the GIL was acquired using the PyGILState_* API instead (e.g. if + calling from a Python thread). Since we use a different key, this ensures + we don't create a new thread state and deadlock in PyEval_AcquireThread + below. Note we don't save this state with internals.tstate, since we don't + create it we would fail to clear it (its reference count should be > 0). */ + tstate = PyGILState_GetThisThreadState(); + } + + if (!tstate) { + tstate = PyThreadState_New(internals.istate); +# if !defined(NDEBUG) + if (!tstate) + pybind11_fail("scoped_acquire: could not create thread state!"); +# endif + tstate->gilstate_counter = 0; + PYBIND11_TLS_REPLACE_VALUE(internals.tstate, tstate); + } else { + release = detail::get_thread_state_unchecked() != tstate; + } + + if (release) { +/* Work around an annoying assertion in PyThreadState_Swap */ +# if defined(Py_DEBUG) + PyInterpreterState* interp = tstate->interp; + tstate->interp = nullptr; +# endif + PyEval_AcquireThread(tstate); +# if defined(Py_DEBUG) + tstate->interp = interp; +# endif + } + + inc_ref(); + } + + void inc_ref() + { + ++tstate->gilstate_counter; + } + + PYBIND11_NOINLINE void dec_ref() + { + --tstate->gilstate_counter; +# if !defined(NDEBUG) + if (detail::get_thread_state_unchecked() != tstate) + pybind11_fail("scoped_acquire::dec_ref(): thread state must be current!"); + if (tstate->gilstate_counter < 0) + pybind11_fail("scoped_acquire::dec_ref(): reference count underflow!"); +# endif + if (tstate->gilstate_counter == 0) { +# if !defined(NDEBUG) + if (!release) + pybind11_fail("scoped_acquire::dec_ref(): internal error!"); +# endif + PyThreadState_Clear(tstate); + PyThreadState_DeleteCurrent(); + PYBIND11_TLS_DELETE_VALUE(detail::get_internals().tstate); + release = false; + } + } + + PYBIND11_NOINLINE ~gil_scoped_acquire() + { + dec_ref(); + if (release) + PyEval_SaveThread(); + } + +private: + PyThreadState* tstate = nullptr; + bool release = true; +}; + +class gil_scoped_release +{ +public: + explicit gil_scoped_release(bool disassoc = false) + : disassoc(disassoc) + { + // `get_internals()` must be called here unconditionally in order to initialize + // `internals.tstate` for subsequent `gil_scoped_acquire` calls. Otherwise, an + // initialization race could occur as multiple threads try `gil_scoped_acquire`. + const auto& internals = detail::get_internals(); + tstate = PyEval_SaveThread(); + if (disassoc) { + auto key = internals.tstate; + PYBIND11_TLS_DELETE_VALUE(key); + } + } + ~gil_scoped_release() + { + if (!tstate) + return; + PyEval_RestoreThread(tstate); + if (disassoc) { + auto key = detail::get_internals().tstate; + PYBIND11_TLS_REPLACE_VALUE(key, tstate); + } + } + +private: + PyThreadState* tstate; + bool disassoc; +}; +#elif defined(PYPY_VERSION) +class gil_scoped_acquire +{ + PyGILState_STATE state; + +public: + gil_scoped_acquire() + { + state = PyGILState_Ensure(); + } + ~gil_scoped_acquire() + { + PyGILState_Release(state); + } +}; + +class gil_scoped_release +{ + PyThreadState* state; + +public: + gil_scoped_release() + { + state = PyEval_SaveThread(); + } + ~gil_scoped_release() + { + PyEval_RestoreThread(state); + } +}; +#else +class gil_scoped_acquire +{}; +class gil_scoped_release +{}; +#endif + +error_already_set::~error_already_set() +{ + if (m_type) { + error_scope scope; + gil_scoped_acquire gil; + m_type.release().dec_ref(); + m_value.release().dec_ref(); + m_trace.release().dec_ref(); + } +} + +inline function get_type_overload(const void* this_ptr, const detail::type_info* this_type, const char* name) +{ + handle self = detail::get_object_handle(this_ptr, this_type); + if (!self) + return function(); + handle type = self.get_type(); + auto key = std::make_pair(type.ptr(), name); + + /* Cache functions that aren't overloaded in Python to avoid + many costly Python dictionary lookups below */ + auto& cache = detail::get_internals().inactive_overload_cache; + if (cache.find(key) != cache.end()) + return function(); + + function overload = getattr(self, name, function()); + if (overload.is_cpp_function()) { + cache.insert(key); + return function(); + } + + /* Don't call dispatch code if invoked from overridden function. + Unfortunately this doesn't work on PyPy. */ +#if !defined(PYPY_VERSION) + PyFrameObject* frame = PyThreadState_Get()->frame; + if (frame && (std::string)str(frame->f_code->co_name) == name && frame->f_code->co_argcount > 0) { + PyFrame_FastToLocals(frame); + PyObject* self_caller = PyDict_GetItem(frame->f_locals, PyTuple_GET_ITEM(frame->f_code->co_varnames, 0)); + if (self_caller == self.ptr()) + return function(); + } +#else + /* PyPy currently doesn't provide a detailed cpyext emulation of + frame objects, so we have to emulate this using Python. This + is going to be slow..*/ + dict d; + d["self"] = self; + d["name"] = pybind11::str(name); + PyObject* result = PyRun_String("import inspect\n" + "frame = inspect.currentframe()\n" + "if frame is not None:\n" + " frame = frame.f_back\n" + " if frame is not None and str(frame.f_code.co_name) == name and " + "frame.f_code.co_argcount > 0:\n" + " self_caller = frame.f_locals[frame.f_code.co_varnames[0]]\n" + " if self_caller == self:\n" + " self = None\n", + Py_file_input, + d.ptr(), + d.ptr()); + if (result == nullptr) + throw error_already_set(); + if (d["self"].is_none()) + return function(); + Py_DECREF(result); +#endif + + return overload; +} + +/** \rst + Try to retrieve a python method by the provided name from the instance pointed to by the this_ptr. + + :this_ptr: The pointer to the object the overload should be retrieved for. This should be the first + non-trampoline class encountered in the inheritance chain. + :name: The name of the overloaded Python method to retrieve. + :return: The Python method by this name from the object or an empty function wrapper. + \endrst */ +template <class T> +function get_overload(const T* this_ptr, const char* name) +{ + auto tinfo = detail::get_type_info(typeid(T)); + return tinfo ? get_type_overload(this_ptr, tinfo, name) : function(); +} + +#define PYBIND11_OVERLOAD_INT(ret_type, cname, name, ...) \ + { \ + pybind11::gil_scoped_acquire gil; \ + pybind11::function overload = pybind11::get_overload(static_cast<const cname*>(this), name); \ + if (overload) { \ + auto o = overload(__VA_ARGS__); \ + if (pybind11::detail::cast_is_temporary_value_reference<ret_type>::value) { \ + static pybind11::detail::overload_caster_t<ret_type> caster; \ + return pybind11::detail::cast_ref<ret_type>(std::move(o), caster); \ + } else \ + return pybind11::detail::cast_safe<ret_type>(std::move(o)); \ + } \ + } + +/** \rst + Macro to populate the virtual method in the trampoline class. This macro tries to look up a method named 'fn' + from the Python side, deals with the :ref:`gil` and necessary argument conversions to call this method and return + the appropriate type. See :ref:`overriding_virtuals` for more information. This macro should be used when the method + name in C is not the same as the method name in Python. For example with `__str__`. + + .. code-block:: cpp + + std::string toString() override { + PYBIND11_OVERLOAD_NAME( + std::string, // Return type (ret_type) + Animal, // Parent class (cname) + toString, // Name of function in C++ (name) + "__str__", // Name of method in Python (fn) + ); + } +\endrst */ +#define PYBIND11_OVERLOAD_NAME(ret_type, cname, name, fn, ...) \ + PYBIND11_OVERLOAD_INT(PYBIND11_TYPE(ret_type), PYBIND11_TYPE(cname), name, __VA_ARGS__) \ + return cname::fn(__VA_ARGS__) + +/** \rst + Macro for pure virtual functions, this function is identical to :c:macro:`PYBIND11_OVERLOAD_NAME`, except that it + throws if no overload can be found. +\endrst */ +#define PYBIND11_OVERLOAD_PURE_NAME(ret_type, cname, name, fn, ...) \ + PYBIND11_OVERLOAD_INT(PYBIND11_TYPE(ret_type), PYBIND11_TYPE(cname), name, __VA_ARGS__) \ + pybind11::pybind11_fail("Tried to call pure virtual function \"" PYBIND11_STRINGIFY(cname) "::" name "\""); + +/** \rst + Macro to populate the virtual method in the trampoline class. This macro tries to look up the method + from the Python side, deals with the :ref:`gil` and necessary argument conversions to call this method and return + the appropriate type. This macro should be used if the method name in C and in Python are identical. + See :ref:`overriding_virtuals` for more information. + + .. code-block:: cpp + + class PyAnimal : public Animal { + public: + // Inherit the constructors + using Animal::Animal; + + // Trampoline (need one for each virtual function) + std::string go(int n_times) override { + PYBIND11_OVERLOAD_PURE( + std::string, // Return type (ret_type) + Animal, // Parent class (cname) + go, // Name of function in C++ (must match Python name) (fn) + n_times // Argument(s) (...) + ); + } + }; +\endrst */ +#define PYBIND11_OVERLOAD(ret_type, cname, fn, ...) \ + PYBIND11_OVERLOAD_NAME(PYBIND11_TYPE(ret_type), PYBIND11_TYPE(cname), #fn, fn, __VA_ARGS__) + +/** \rst + Macro for pure virtual functions, this function is identical to :c:macro:`PYBIND11_OVERLOAD`, except that it throws + if no overload can be found. +\endrst */ +#define PYBIND11_OVERLOAD_PURE(ret_type, cname, fn, ...) \ + PYBIND11_OVERLOAD_PURE_NAME(PYBIND11_TYPE(ret_type), PYBIND11_TYPE(cname), #fn, fn, __VA_ARGS__) + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) && !defined(__INTEL_COMPILER) +# pragma warning(pop) +#elif defined(__GNUG__) && !defined(__clang__) +# pragma GCC diagnostic pop +#endif diff --git a/dune/pybindxi/pytypes.h b/dune/pybindxi/pytypes.h new file mode 100644 index 0000000000000000000000000000000000000000..65bd1d1faa2e8631d4aa243d6e464a5d8672af29 --- /dev/null +++ b/dune/pybindxi/pytypes.h @@ -0,0 +1,2147 @@ +#pragma GCC system_header +/* + pybind11/pytypes.h: Convenience wrapper classes for basic Python types + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" +#include "buffer_info.h" +#include <utility> +#include <type_traits> + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/* A few forward declarations */ +class handle; +class object; +class str; +class iterator; +struct arg; +struct arg_v; + +NAMESPACE_BEGIN(detail) +class args_proxy; +inline bool isinstance_generic(handle obj, const std::type_info& tp); + +// Accessor forward declarations +template <typename Policy> +class accessor; +namespace accessor_policies { +struct obj_attr; +struct str_attr; +struct generic_item; +struct sequence_item; +struct list_item; +struct tuple_item; +} // namespace accessor_policies +using obj_attr_accessor = accessor<accessor_policies::obj_attr>; +using str_attr_accessor = accessor<accessor_policies::str_attr>; +using item_accessor = accessor<accessor_policies::generic_item>; +using sequence_accessor = accessor<accessor_policies::sequence_item>; +using list_accessor = accessor<accessor_policies::list_item>; +using tuple_accessor = accessor<accessor_policies::tuple_item>; + +/// Tag and check to identify a class which implements the Python object API +class pyobject_tag +{}; +template <typename T> +using is_pyobject = std::is_base_of<pyobject_tag, remove_reference_t<T>>; + +/** \rst + A mixin class which adds common functions to `handle`, `object` and various accessors. + The only requirement for `Derived` is to implement ``PyObject *Derived::ptr() const``. +\endrst */ +template <typename Derived> +class object_api : public pyobject_tag +{ + const Derived& derived() const + { + return static_cast<const Derived&>(*this); + } + +public: + /** \rst + Return an iterator equivalent to calling ``iter()`` in Python. The object + must be a collection which supports the iteration protocol. + \endrst */ + iterator begin() const; + /// Return a sentinel which ends iteration. + iterator end() const; + + /** \rst + Return an internal functor to invoke the object's sequence protocol. Casting + the returned ``detail::item_accessor`` instance to a `handle` or `object` + subclass causes a corresponding call to ``__getitem__``. Assigning a `handle` + or `object` subclass causes a call to ``__setitem__``. + \endrst */ + item_accessor operator[](handle key) const; + /// See above (the only difference is that they key is provided as a string literal) + item_accessor operator[](const char* key) const; + + /** \rst + Return an internal functor to access the object's attributes. Casting the + returned ``detail::obj_attr_accessor`` instance to a `handle` or `object` + subclass causes a corresponding call to ``getattr``. Assigning a `handle` + or `object` subclass causes a call to ``setattr``. + \endrst */ + obj_attr_accessor attr(handle key) const; + /// See above (the only difference is that they key is provided as a string literal) + str_attr_accessor attr(const char* key) const; + + /** \rst + Matches * unpacking in Python, e.g. to unpack arguments out of a ``tuple`` + or ``list`` for a function call. Applying another * to the result yields + ** unpacking, e.g. to unpack a dict as function keyword arguments. + See :ref:`calling_python_functions`. + \endrst */ + args_proxy operator*() const; + + /// Check if the given item is contained within this object, i.e. ``item in obj``. + template <typename T> + bool contains(T&& item) const; + + /** \rst + Assuming the Python object is a function or implements the ``__call__`` + protocol, ``operator()`` invokes the underlying function, passing an + arbitrary set of parameters. The result is returned as a `object` and + may need to be converted back into a Python object using `handle::cast()`. + + When some of the arguments cannot be converted to Python objects, the + function will throw a `cast_error` exception. When the Python function + call fails, a `error_already_set` exception is thrown. + \endrst */ + template <return_value_policy policy = return_value_policy::automatic_reference, typename... Args> + object operator()(Args&&... args) const; + template <return_value_policy policy = return_value_policy::automatic_reference, typename... Args> + PYBIND11_DEPRECATED("call(...) was deprecated in favor of operator()(...)") + object call(Args&&... args) const; + + /// Equivalent to ``obj is other`` in Python. + bool is(object_api const& other) const + { + return derived().ptr() == other.derived().ptr(); + } + /// Equivalent to ``obj is None`` in Python. + bool is_none() const + { + return derived().ptr() == Py_None; + } + /// Equivalent to obj == other in Python + bool equal(object_api const& other) const + { + return rich_compare(other, Py_EQ); + } + bool not_equal(object_api const& other) const + { + return rich_compare(other, Py_NE); + } + bool operator<(object_api const& other) const + { + return rich_compare(other, Py_LT); + } + bool operator<=(object_api const& other) const + { + return rich_compare(other, Py_LE); + } + bool operator>(object_api const& other) const + { + return rich_compare(other, Py_GT); + } + bool operator>=(object_api const& other) const + { + return rich_compare(other, Py_GE); + } + + object operator-() const; + object operator~() const; + object operator+(object_api const& other) const; + object operator+=(object_api const& other) const; + object operator-(object_api const& other) const; + object operator-=(object_api const& other) const; + object operator*(object_api const& other) const; + object operator*=(object_api const& other) const; + object operator/(object_api const& other) const; + object operator/=(object_api const& other) const; + object operator|(object_api const& other) const; + object operator|=(object_api const& other) const; + object operator&(object_api const& other) const; + object operator&=(object_api const& other) const; + object operator^(object_api const& other) const; + object operator^=(object_api const& other) const; + object operator<<(object_api const& other) const; + object operator<<=(object_api const& other) const; + object operator>>(object_api const& other) const; + object operator>>=(object_api const& other) const; + + PYBIND11_DEPRECATED("Use py::str(obj) instead") + pybind11::str str() const; + + /// Get or set the object's docstring, i.e. ``obj.__doc__``. + str_attr_accessor doc() const; + + /// Return the object's current reference count + int ref_count() const + { + return static_cast<int>(Py_REFCNT(derived().ptr())); + } + /// Return a handle to the Python type object underlying the instance + handle get_type() const; + +private: + bool rich_compare(object_api const& other, int value) const; +}; + +NAMESPACE_END(detail) + +/** \rst + Holds a reference to a Python object (no reference counting) + + The `handle` class is a thin wrapper around an arbitrary Python object (i.e. a + ``PyObject *`` in Python's C API). It does not perform any automatic reference + counting and merely provides a basic C++ interface to various Python API functions. + + .. seealso:: + The `object` class inherits from `handle` and adds automatic reference + counting features. +\endrst */ +class handle : public detail::object_api<handle> +{ +public: + /// The default constructor creates a handle with a ``nullptr``-valued pointer + handle() = default; + /// Creates a ``handle`` from the given raw Python object pointer + handle(PyObject* ptr) + : m_ptr(ptr) + {} // Allow implicit conversion from PyObject* + + /// Return the underlying ``PyObject *`` pointer + PyObject* ptr() const + { + return m_ptr; + } + PyObject*& ptr() + { + return m_ptr; + } + + /** \rst + Manually increase the reference count of the Python object. Usually, it is + preferable to use the `object` class which derives from `handle` and calls + this function automatically. Returns a reference to itself. + \endrst */ + const handle& inc_ref() const& + { + Py_XINCREF(m_ptr); + return *this; + } + + /** \rst + Manually decrease the reference count of the Python object. Usually, it is + preferable to use the `object` class which derives from `handle` and calls + this function automatically. Returns a reference to itself. + \endrst */ + const handle& dec_ref() const& + { + Py_XDECREF(m_ptr); + return *this; + } + + /** \rst + Attempt to cast the Python object into the given C++ type. A `cast_error` + will be throw upon failure. + \endrst */ + template <typename T> + T cast() const; + /// Return ``true`` when the `handle` wraps a valid Python object + explicit operator bool() const + { + return m_ptr != nullptr; + } + /** \rst + Deprecated: Check that the underlying pointers are the same. + Equivalent to ``obj1 is obj2`` in Python. + \endrst */ + PYBIND11_DEPRECATED("Use obj1.is(obj2) instead") + bool operator==(const handle& h) const + { + return m_ptr == h.m_ptr; + } + PYBIND11_DEPRECATED("Use !obj1.is(obj2) instead") + bool operator!=(const handle& h) const + { + return m_ptr != h.m_ptr; + } + PYBIND11_DEPRECATED("Use handle::operator bool() instead") + bool check() const + { + return m_ptr != nullptr; + } + +protected: + PyObject* m_ptr = nullptr; +}; + +/** \rst + Holds a reference to a Python object (with reference counting) + + Like `handle`, the `object` class is a thin wrapper around an arbitrary Python + object (i.e. a ``PyObject *`` in Python's C API). In contrast to `handle`, it + optionally increases the object's reference count upon construction, and it + *always* decreases the reference count when the `object` instance goes out of + scope and is destructed. When using `object` instances consistently, it is much + easier to get reference counting right at the first attempt. +\endrst */ +class object : public handle +{ +public: + object() = default; + PYBIND11_DEPRECATED("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") + object(handle h, bool is_borrowed) + : handle(h) + { + if (is_borrowed) + inc_ref(); + } + /// Copy constructor; always increases the reference count + object(const object& o) + : handle(o) + { + inc_ref(); + } + /// Move constructor; steals the object from ``other`` and preserves its reference count + object(object&& other) noexcept + { + m_ptr = other.m_ptr; + other.m_ptr = nullptr; + } + /// Destructor; automatically calls `handle::dec_ref()` + ~object() + { + dec_ref(); + } + + /** \rst + Resets the internal pointer to ``nullptr`` without without decreasing the + object's reference count. The function returns a raw handle to the original + Python object. + \endrst */ + handle release() + { + PyObject* tmp = m_ptr; + m_ptr = nullptr; + return handle(tmp); + } + + object& operator=(const object& other) + { + other.inc_ref(); + dec_ref(); + m_ptr = other.m_ptr; + return *this; + } + + object& operator=(object&& other) noexcept + { + if (this != &other) { + handle temp(m_ptr); + m_ptr = other.m_ptr; + other.m_ptr = nullptr; + temp.dec_ref(); + } + return *this; + } + + // Calling cast() on an object lvalue just copies (via handle::cast) + template <typename T> + T cast() const&; + // Calling on an object rvalue does a move, if needed and/or possible + template <typename T> + T cast() &&; + +protected: + // Tags for choosing constructors from raw PyObject * + struct borrowed_t + {}; + struct stolen_t + {}; + + template <typename T> + friend T reinterpret_borrow(handle); + template <typename T> + friend T reinterpret_steal(handle); + +public: + // Only accessible from derived classes and the reinterpret_* functions + object(handle h, borrowed_t) + : handle(h) + { + inc_ref(); + } + object(handle h, stolen_t) + : handle(h) + {} +}; + +/** \rst + Declare that a `handle` or ``PyObject *`` is a certain type and borrow the reference. + The target type ``T`` must be `object` or one of its derived classes. The function + doesn't do any conversions or checks. It's up to the user to make sure that the + target type is correct. + + .. code-block:: cpp + + PyObject *p = PyList_GetItem(obj, index); + py::object o = reinterpret_borrow<py::object>(p); + // or + py::tuple t = reinterpret_borrow<py::tuple>(p); // <-- `p` must be already be a `tuple` +\endrst */ +template <typename T> +T reinterpret_borrow(handle h) +{ + return {h, object::borrowed_t{}}; +} + +/** \rst + Like `reinterpret_borrow`, but steals the reference. + + .. code-block:: cpp + + PyObject *p = PyObject_Str(obj); + py::str s = reinterpret_steal<py::str>(p); // <-- `p` must be already be a `str` +\endrst */ +template <typename T> +T reinterpret_steal(handle h) +{ + return {h, object::stolen_t{}}; +} + +NAMESPACE_BEGIN(detail) +inline std::string error_string(); +NAMESPACE_END(detail) + +/// Fetch and hold an error which was already set in Python. An instance of this is typically +/// thrown to propagate python-side errors back through C++ which can either be caught manually or +/// else falls back to the function dispatcher (which then raises the captured error back to +/// python). +class error_already_set : public std::runtime_error +{ +public: + /// Constructs a new exception from the current Python error indicator, if any. The current + /// Python error indicator will be cleared. + error_already_set() + : std::runtime_error(detail::error_string()) + { + PyErr_Fetch(&m_type.ptr(), &m_value.ptr(), &m_trace.ptr()); + } + + error_already_set(const error_already_set&) = default; + error_already_set(error_already_set&&) = default; + + inline ~error_already_set(); + + /// Give the currently-held error back to Python, if any. If there is currently a Python error + /// already set it is cleared first. After this call, the current object no longer stores the + /// error variables (but the `.what()` string is still available). + void restore() + { + PyErr_Restore(m_type.release().ptr(), m_value.release().ptr(), m_trace.release().ptr()); + } + + // Does nothing; provided for backwards compatibility. + PYBIND11_DEPRECATED("Use of error_already_set.clear() is deprecated") + void clear() {} + + /// Check if the currently trapped error type matches the given Python exception class (or a + /// subclass thereof). May also be passed a tuple to search for any exception class matches in + /// the given tuple. + bool matches(handle exc) const + { + return PyErr_GivenExceptionMatches(m_type.ptr(), exc.ptr()); + } + + const object& type() const + { + return m_type; + } + const object& value() const + { + return m_value; + } + const object& trace() const + { + return m_trace; + } + +private: + object m_type, m_value, m_trace; +}; + +/** \defgroup python_builtins _ + Unless stated otherwise, the following C++ functions behave the same + as their Python counterparts. + */ + +/** \ingroup python_builtins + \rst + Return true if ``obj`` is an instance of ``T``. Type ``T`` must be a subclass of + `object` or a class which was exposed to Python as ``py::class_<T>``. +\endrst */ +template <typename T, detail::enable_if_t<std::is_base_of<object, T>::value, int> = 0> +bool isinstance(handle obj) +{ + return T::check_(obj); +} + +template <typename T, detail::enable_if_t<!std::is_base_of<object, T>::value, int> = 0> +bool isinstance(handle obj) +{ + return detail::isinstance_generic(obj, typeid(T)); +} + +template <> +inline bool isinstance<handle>(handle obj) = delete; +template <> +inline bool isinstance<object>(handle obj) +{ + return obj.ptr() != nullptr; +} + +/// \ingroup python_builtins +/// Return true if ``obj`` is an instance of the ``type``. +inline bool isinstance(handle obj, handle type) +{ + const auto result = PyObject_IsInstance(obj.ptr(), type.ptr()); + if (result == -1) + throw error_already_set(); + return result != 0; +} + +/// \addtogroup python_builtins +/// @{ +inline bool hasattr(handle obj, handle name) +{ + return PyObject_HasAttr(obj.ptr(), name.ptr()) == 1; +} + +inline bool hasattr(handle obj, const char* name) +{ + return PyObject_HasAttrString(obj.ptr(), name) == 1; +} + +inline void delattr(handle obj, handle name) +{ + if (PyObject_DelAttr(obj.ptr(), name.ptr()) != 0) { + throw error_already_set(); + } +} + +inline void delattr(handle obj, const char* name) +{ + if (PyObject_DelAttrString(obj.ptr(), name) != 0) { + throw error_already_set(); + } +} + +inline object getattr(handle obj, handle name) +{ + PyObject* result = PyObject_GetAttr(obj.ptr(), name.ptr()); + if (!result) { + throw error_already_set(); + } + return reinterpret_steal<object>(result); +} + +inline object getattr(handle obj, const char* name) +{ + PyObject* result = PyObject_GetAttrString(obj.ptr(), name); + if (!result) { + throw error_already_set(); + } + return reinterpret_steal<object>(result); +} + +inline object getattr(handle obj, handle name, handle default_) +{ + if (PyObject* result = PyObject_GetAttr(obj.ptr(), name.ptr())) { + return reinterpret_steal<object>(result); + } else { + PyErr_Clear(); + return reinterpret_borrow<object>(default_); + } +} + +inline object getattr(handle obj, const char* name, handle default_) +{ + if (PyObject* result = PyObject_GetAttrString(obj.ptr(), name)) { + return reinterpret_steal<object>(result); + } else { + PyErr_Clear(); + return reinterpret_borrow<object>(default_); + } +} + +inline void setattr(handle obj, handle name, handle value) +{ + if (PyObject_SetAttr(obj.ptr(), name.ptr(), value.ptr()) != 0) { + throw error_already_set(); + } +} + +inline void setattr(handle obj, const char* name, handle value) +{ + if (PyObject_SetAttrString(obj.ptr(), name, value.ptr()) != 0) { + throw error_already_set(); + } +} + +inline ssize_t hash(handle obj) +{ + auto h = PyObject_Hash(obj.ptr()); + if (h == -1) { + throw error_already_set(); + } + return h; +} + +/// @} python_builtins + +NAMESPACE_BEGIN(detail) +inline handle get_function(handle value) +{ + if (value) { +#if PY_MAJOR_VERSION >= 3 + if (PyInstanceMethod_Check(value.ptr())) + value = PyInstanceMethod_GET_FUNCTION(value.ptr()); + else +#endif + if (PyMethod_Check(value.ptr())) + value = PyMethod_GET_FUNCTION(value.ptr()); + } + return value; +} + +// Helper aliases/functions to support implicit casting of values given to python accessors/methods. +// When given a pyobject, this simply returns the pyobject as-is; for other C++ type, the value goes +// through pybind11::cast(obj) to convert it to an `object`. +template <typename T, enable_if_t<is_pyobject<T>::value, int> = 0> +auto object_or_cast(T&& o) -> decltype(std::forward<T>(o)) +{ + return std::forward<T>(o); +} +// The following casting version is implemented in cast.h: +template <typename T, enable_if_t<!is_pyobject<T>::value, int> = 0> +object object_or_cast(T&& o); +// Match a PyObject*, which we want to convert directly to handle via its converting constructor +inline handle object_or_cast(PyObject* ptr) +{ + return ptr; +} + +template <typename Policy> +class accessor : public object_api<accessor<Policy>> +{ + using key_type = typename Policy::key_type; + +public: + accessor(handle obj, key_type key) + : obj(obj) + , key(std::move(key)) + {} + accessor(const accessor&) = default; + accessor(accessor&&) = default; + + // accessor overload required to override default assignment operator (templates are not allowed + // to replace default compiler-generated assignments). + void operator=(const accessor& a) && + { + std::move(*this).operator=(handle(a)); + } + void operator=(const accessor& a) & + { + operator=(handle(a)); + } + + template <typename T> + void operator=(T&& value) && + { + Policy::set(obj, key, object_or_cast(std::forward<T>(value))); + } + template <typename T> + void operator=(T&& value) & + { + get_cache() = reinterpret_borrow<object>(object_or_cast(std::forward<T>(value))); + } + + template <typename T = Policy> + PYBIND11_DEPRECATED("Use of obj.attr(...) as bool is deprecated in favor of pybind11::hasattr(obj, ...)") + explicit operator enable_if_t<std::is_same<T, accessor_policies::str_attr>::value + || std::is_same<T, accessor_policies::obj_attr>::value, + bool>() const + { + return hasattr(obj, key); + } + template <typename T = Policy> + PYBIND11_DEPRECATED("Use of obj[key] as bool is deprecated in favor of obj.contains(key)") + explicit operator enable_if_t<std::is_same<T, accessor_policies::generic_item>::value, bool>() const + { + return obj.contains(key); + } + + operator object() const + { + return get_cache(); + } + PyObject* ptr() const + { + return get_cache().ptr(); + } + template <typename T> + T cast() const + { + return get_cache().template cast<T>(); + } + +private: + object& get_cache() const + { + if (!cache) { + cache = Policy::get(obj, key); + } + return cache; + } + +private: + handle obj; + key_type key; + mutable object cache; +}; + +NAMESPACE_BEGIN(accessor_policies) +struct obj_attr +{ + using key_type = object; + static object get(handle obj, handle key) + { + return getattr(obj, key); + } + static void set(handle obj, handle key, handle val) + { + setattr(obj, key, val); + } +}; + +struct str_attr +{ + using key_type = const char*; + static object get(handle obj, const char* key) + { + return getattr(obj, key); + } + static void set(handle obj, const char* key, handle val) + { + setattr(obj, key, val); + } +}; + +struct generic_item +{ + using key_type = object; + + static object get(handle obj, handle key) + { + PyObject* result = PyObject_GetItem(obj.ptr(), key.ptr()); + if (!result) { + throw error_already_set(); + } + return reinterpret_steal<object>(result); + } + + static void set(handle obj, handle key, handle val) + { + if (PyObject_SetItem(obj.ptr(), key.ptr(), val.ptr()) != 0) { + throw error_already_set(); + } + } +}; + +struct sequence_item +{ + using key_type = size_t; + + static object get(handle obj, size_t index) + { + PyObject* result = PySequence_GetItem(obj.ptr(), static_cast<ssize_t>(index)); + if (!result) { + throw error_already_set(); + } + return reinterpret_steal<object>(result); + } + + static void set(handle obj, size_t index, handle val) + { + // PySequence_SetItem does not steal a reference to 'val' + if (PySequence_SetItem(obj.ptr(), static_cast<ssize_t>(index), val.ptr()) != 0) { + throw error_already_set(); + } + } +}; + +struct list_item +{ + using key_type = size_t; + + static object get(handle obj, size_t index) + { + PyObject* result = PyList_GetItem(obj.ptr(), static_cast<ssize_t>(index)); + if (!result) { + throw error_already_set(); + } + return reinterpret_borrow<object>(result); + } + + static void set(handle obj, size_t index, handle val) + { + // PyList_SetItem steals a reference to 'val' + if (PyList_SetItem(obj.ptr(), static_cast<ssize_t>(index), val.inc_ref().ptr()) != 0) { + throw error_already_set(); + } + } +}; + +struct tuple_item +{ + using key_type = size_t; + + static object get(handle obj, size_t index) + { + PyObject* result = PyTuple_GetItem(obj.ptr(), static_cast<ssize_t>(index)); + if (!result) { + throw error_already_set(); + } + return reinterpret_borrow<object>(result); + } + + static void set(handle obj, size_t index, handle val) + { + // PyTuple_SetItem steals a reference to 'val' + if (PyTuple_SetItem(obj.ptr(), static_cast<ssize_t>(index), val.inc_ref().ptr()) != 0) { + throw error_already_set(); + } + } +}; +NAMESPACE_END(accessor_policies) + +/// STL iterator template used for tuple, list, sequence and dict +template <typename Policy> +class generic_iterator : public Policy +{ + using It = generic_iterator; + +public: + using difference_type = ssize_t; + using iterator_category = typename Policy::iterator_category; + using value_type = typename Policy::value_type; + using reference = typename Policy::reference; + using pointer = typename Policy::pointer; + + generic_iterator() = default; + generic_iterator(handle seq, ssize_t index) + : Policy(seq, index) + {} + + reference operator*() const + { + return Policy::dereference(); + } + reference operator[](difference_type n) const + { + return *(*this + n); + } + pointer operator->() const + { + return **this; + } + + It& operator++() + { + Policy::increment(); + return *this; + } + It operator++(int) + { + auto copy = *this; + Policy::increment(); + return copy; + } + It& operator--() + { + Policy::decrement(); + return *this; + } + It operator--(int) + { + auto copy = *this; + Policy::decrement(); + return copy; + } + It& operator+=(difference_type n) + { + Policy::advance(n); + return *this; + } + It& operator-=(difference_type n) + { + Policy::advance(-n); + return *this; + } + + friend It operator+(const It& a, difference_type n) + { + auto copy = a; + return copy += n; + } + friend It operator+(difference_type n, const It& b) + { + return b + n; + } + friend It operator-(const It& a, difference_type n) + { + auto copy = a; + return copy -= n; + } + friend difference_type operator-(const It& a, const It& b) + { + return a.distance_to(b); + } + + friend bool operator==(const It& a, const It& b) + { + return a.equal(b); + } + friend bool operator!=(const It& a, const It& b) + { + return !(a == b); + } + friend bool operator<(const It& a, const It& b) + { + return b - a > 0; + } + friend bool operator>(const It& a, const It& b) + { + return b < a; + } + friend bool operator>=(const It& a, const It& b) + { + return !(a < b); + } + friend bool operator<=(const It& a, const It& b) + { + return !(a > b); + } +}; + +NAMESPACE_BEGIN(iterator_policies) +/// Quick proxy class needed to implement ``operator->`` for iterators which can't return pointers +template <typename T> +struct arrow_proxy +{ + T value; + + arrow_proxy(T&& value) + : value(std::move(value)) + {} + T* operator->() const + { + return &value; + } +}; + +/// Lightweight iterator policy using just a simple pointer: see ``PySequence_Fast_ITEMS`` +class sequence_fast_readonly +{ +protected: + using iterator_category = std::random_access_iterator_tag; + using value_type = handle; + using reference = const handle; + using pointer = arrow_proxy<const handle>; + + sequence_fast_readonly(handle obj, ssize_t n) + : ptr(PySequence_Fast_ITEMS(obj.ptr()) + n) + {} + + reference dereference() const + { + return *ptr; + } + void increment() + { + ++ptr; + } + void decrement() + { + --ptr; + } + void advance(ssize_t n) + { + ptr += n; + } + bool equal(const sequence_fast_readonly& b) const + { + return ptr == b.ptr; + } + ssize_t distance_to(const sequence_fast_readonly& b) const + { + return ptr - b.ptr; + } + +private: + PyObject** ptr; +}; + +/// Full read and write access using the sequence protocol: see ``detail::sequence_accessor`` +class sequence_slow_readwrite +{ +protected: + using iterator_category = std::random_access_iterator_tag; + using value_type = object; + using reference = sequence_accessor; + using pointer = arrow_proxy<const sequence_accessor>; + + sequence_slow_readwrite(handle obj, ssize_t index) + : obj(obj) + , index(index) + {} + + reference dereference() const + { + return {obj, static_cast<size_t>(index)}; + } + void increment() + { + ++index; + } + void decrement() + { + --index; + } + void advance(ssize_t n) + { + index += n; + } + bool equal(const sequence_slow_readwrite& b) const + { + return index == b.index; + } + ssize_t distance_to(const sequence_slow_readwrite& b) const + { + return index - b.index; + } + +private: + handle obj; + ssize_t index; +}; + +/// Python's dictionary protocol permits this to be a forward iterator +class dict_readonly +{ +protected: + using iterator_category = std::forward_iterator_tag; + using value_type = std::pair<handle, handle>; + using reference = const value_type; + using pointer = arrow_proxy<const value_type>; + + dict_readonly() = default; + dict_readonly(handle obj, ssize_t pos) + : obj(obj) + , pos(pos) + { + increment(); + } + + reference dereference() const + { + return {key, value}; + } + void increment() + { + if (!PyDict_Next(obj.ptr(), &pos, &key, &value)) { + pos = -1; + } + } + bool equal(const dict_readonly& b) const + { + return pos == b.pos; + } + +private: + handle obj; + PyObject *key = nullptr, *value = nullptr; + ssize_t pos = -1; +}; +NAMESPACE_END(iterator_policies) + +#if !defined(PYPY_VERSION) +using tuple_iterator = generic_iterator<iterator_policies::sequence_fast_readonly>; +using list_iterator = generic_iterator<iterator_policies::sequence_fast_readonly>; +#else +using tuple_iterator = generic_iterator<iterator_policies::sequence_slow_readwrite>; +using list_iterator = generic_iterator<iterator_policies::sequence_slow_readwrite>; +#endif + +using sequence_iterator = generic_iterator<iterator_policies::sequence_slow_readwrite>; +using dict_iterator = generic_iterator<iterator_policies::dict_readonly>; + +inline bool PyIterable_Check(PyObject* obj) +{ + PyObject* iter = PyObject_GetIter(obj); + if (iter) { + Py_DECREF(iter); + return true; + } else { + PyErr_Clear(); + return false; + } +} + +inline bool PyNone_Check(PyObject* o) +{ + return o == Py_None; +} +#if PY_MAJOR_VERSION >= 3 +inline bool PyEllipsis_Check(PyObject* o) +{ + return o == Py_Ellipsis; +} +#endif + +inline bool PyUnicode_Check_Permissive(PyObject* o) +{ + return PyUnicode_Check(o) || PYBIND11_BYTES_CHECK(o); +} + +inline bool PyStaticMethod_Check(PyObject* o) +{ + return o->ob_type == &PyStaticMethod_Type; +} + +class kwargs_proxy : public handle +{ +public: + explicit kwargs_proxy(handle h) + : handle(h) + {} +}; + +class args_proxy : public handle +{ +public: + explicit args_proxy(handle h) + : handle(h) + {} + kwargs_proxy operator*() const + { + return kwargs_proxy(*this); + } +}; + +/// Python argument categories (using PEP 448 terms) +template <typename T> +using is_keyword = std::is_base_of<arg, T>; +template <typename T> +using is_s_unpacking = std::is_same<args_proxy, T>; // * unpacking +template <typename T> +using is_ds_unpacking = std::is_same<kwargs_proxy, T>; // ** unpacking +template <typename T> +using is_positional = satisfies_none_of<T, is_keyword, is_s_unpacking, is_ds_unpacking>; +template <typename T> +using is_keyword_or_ds = satisfies_any_of<T, is_keyword, is_ds_unpacking>; + +// Call argument collector forward declarations +template <return_value_policy policy = return_value_policy::automatic_reference> +class simple_collector; +template <return_value_policy policy = return_value_policy::automatic_reference> +class unpacking_collector; + +NAMESPACE_END(detail) + +// TODO: After the deprecated constructors are removed, this macro can be simplified by +// inheriting ctors: `using Parent::Parent`. It's not an option right now because +// the `using` statement triggers the parent deprecation warning even if the ctor +// isn't even used. +#define PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) \ +public: \ + PYBIND11_DEPRECATED("Use reinterpret_borrow<" #Name ">() or reinterpret_steal<" #Name ">()") \ + Name(handle h, bool is_borrowed) \ + : Parent(is_borrowed ? Parent(h, borrowed_t{}) : Parent(h, stolen_t{})) \ + {} \ + Name(handle h, borrowed_t) \ + : Parent(h, borrowed_t{}) \ + {} \ + Name(handle h, stolen_t) \ + : Parent(h, stolen_t{}) \ + {} \ + PYBIND11_DEPRECATED("Use py::isinstance<py::python_type>(obj) instead") \ + bool check() const \ + { \ + return m_ptr != nullptr && (bool)CheckFun(m_ptr); \ + } \ + static bool check_(handle h) \ + { \ + return h.ptr() != nullptr && CheckFun(h.ptr()); \ + } + +#define PYBIND11_OBJECT_CVT(Name, Parent, CheckFun, ConvertFun) \ + PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) \ + /* This is deliberately not 'explicit' to allow implicit conversion from object: */ \ + Name(const object& o) \ + : Parent(check_(o) ? o.inc_ref().ptr() : ConvertFun(o.ptr()), stolen_t{}) \ + { \ + if (!m_ptr) \ + throw error_already_set(); \ + } \ + Name(object&& o) \ + : Parent(check_(o) ? o.release().ptr() : ConvertFun(o.ptr()), stolen_t{}) \ + { \ + if (!m_ptr) \ + throw error_already_set(); \ + } \ + template <typename Policy_> \ + Name(const ::pybind11::detail::accessor<Policy_>& a) \ + : Name(object(a)) \ + {} + +#define PYBIND11_OBJECT(Name, Parent, CheckFun) \ + PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) \ + /* This is deliberately not 'explicit' to allow implicit conversion from object: */ \ + Name(const object& o) \ + : Parent(o) \ + {} \ + Name(object&& o) \ + : Parent(std::move(o)) \ + {} + +#define PYBIND11_OBJECT_DEFAULT(Name, Parent, CheckFun) \ + PYBIND11_OBJECT(Name, Parent, CheckFun) \ + Name() \ + : Parent() \ + {} + +/// \addtogroup pytypes +/// @{ + +/** \rst + Wraps a Python iterator so that it can also be used as a C++ input iterator + + Caveat: copying an iterator does not (and cannot) clone the internal + state of the Python iterable. This also applies to the post-increment + operator. This iterator should only be used to retrieve the current + value using ``operator*()``. +\endrst */ +class iterator : public object +{ +public: + using iterator_category = std::input_iterator_tag; + using difference_type = ssize_t; + using value_type = handle; + using reference = const handle; + using pointer = const handle*; + + PYBIND11_OBJECT_DEFAULT(iterator, object, PyIter_Check) + + iterator& operator++() + { + advance(); + return *this; + } + + iterator operator++(int) + { + auto rv = *this; + advance(); + return rv; + } + + reference operator*() const + { + if (m_ptr && !value.ptr()) { + auto& self = const_cast<iterator&>(*this); + self.advance(); + } + return value; + } + + pointer operator->() const + { + operator*(); + return &value; + } + + /** \rst + The value which marks the end of the iteration. ``it == iterator::sentinel()`` + is equivalent to catching ``StopIteration`` in Python. + + .. code-block:: cpp + + void foo(py::iterator it) { + while (it != py::iterator::sentinel()) { + // use `*it` + ++it; + } + } + \endrst */ + static iterator sentinel() + { + return {}; + } + + friend bool operator==(const iterator& a, const iterator& b) + { + return a->ptr() == b->ptr(); + } + friend bool operator!=(const iterator& a, const iterator& b) + { + return a->ptr() != b->ptr(); + } + +private: + void advance() + { + value = reinterpret_steal<object>(PyIter_Next(m_ptr)); + if (PyErr_Occurred()) { + throw error_already_set(); + } + } + +private: + object value = {}; +}; + +class iterable : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(iterable, object, detail::PyIterable_Check) +}; + +class bytes; + +class str : public object +{ +public: + PYBIND11_OBJECT_CVT(str, object, detail::PyUnicode_Check_Permissive, raw_str) + + str(const char* c, size_t n) + : object(PyUnicode_FromStringAndSize(c, (ssize_t)n), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate string object!"); + } + + // 'explicit' is explicitly omitted from the following constructors to allow implicit conversion to py::str from C++ + // string-like objects + str(const char* c = "") + : object(PyUnicode_FromString(c), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate string object!"); + } + + str(const std::string& s) + : str(s.data(), s.size()) + {} + + explicit str(const bytes& b); + + /** \rst + Return a string representation of the object. This is analogous to + the ``str()`` function in Python. + \endrst */ + explicit str(handle h) + : object(raw_str(h.ptr()), stolen_t{}) + {} + + operator std::string() const + { + object temp = *this; + if (PyUnicode_Check(m_ptr)) { + temp = reinterpret_steal<object>(PyUnicode_AsUTF8String(m_ptr)); + if (!temp) + pybind11_fail("Unable to extract string contents! (encoding issue)"); + } + char* buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(temp.ptr(), &buffer, &length)) + pybind11_fail("Unable to extract string contents! (invalid type)"); + return std::string(buffer, (size_t)length); + } + + template <typename... Args> + str format(Args&&... args) const + { + return attr("format")(std::forward<Args>(args)...); + } + +private: + /// Return string representation -- always returns a new reference, even if already a str + static PyObject* raw_str(PyObject* op) + { + PyObject* str_value = PyObject_Str(op); +#if PY_MAJOR_VERSION < 3 + if (!str_value) + throw error_already_set(); + PyObject* unicode = PyUnicode_FromEncodedObject(str_value, "utf-8", nullptr); + Py_XDECREF(str_value); + str_value = unicode; +#endif + return str_value; + } +}; +/// @} pytypes + +inline namespace literals { +/** \rst + String literal version of `str` + \endrst */ +inline str operator"" _s(const char* s, size_t size) +{ + return {s, size}; +} +} // namespace literals + +/// \addtogroup pytypes +/// @{ +class bytes : public object +{ +public: + PYBIND11_OBJECT(bytes, object, PYBIND11_BYTES_CHECK) + + // Allow implicit conversion: + bytes(const char* c = "") + : object(PYBIND11_BYTES_FROM_STRING(c), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate bytes object!"); + } + + bytes(const char* c, size_t n) + : object(PYBIND11_BYTES_FROM_STRING_AND_SIZE(c, (ssize_t)n), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate bytes object!"); + } + + // Allow implicit conversion: + bytes(const std::string& s) + : bytes(s.data(), s.size()) + {} + + explicit bytes(const pybind11::str& s); + + operator std::string() const + { + char* buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(m_ptr, &buffer, &length)) + pybind11_fail("Unable to extract bytes contents!"); + return std::string(buffer, (size_t)length); + } +}; + +inline bytes::bytes(const pybind11::str& s) +{ + object temp = s; + if (PyUnicode_Check(s.ptr())) { + temp = reinterpret_steal<object>(PyUnicode_AsUTF8String(s.ptr())); + if (!temp) + pybind11_fail("Unable to extract string contents! (encoding issue)"); + } + char* buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(temp.ptr(), &buffer, &length)) + pybind11_fail("Unable to extract string contents! (invalid type)"); + auto obj = reinterpret_steal<object>(PYBIND11_BYTES_FROM_STRING_AND_SIZE(buffer, length)); + if (!obj) + pybind11_fail("Could not allocate bytes object!"); + m_ptr = obj.release().ptr(); +} + +inline str::str(const bytes& b) +{ + char* buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(b.ptr(), &buffer, &length)) + pybind11_fail("Unable to extract bytes contents!"); + auto obj = reinterpret_steal<object>(PyUnicode_FromStringAndSize(buffer, (ssize_t)length)); + if (!obj) + pybind11_fail("Could not allocate string object!"); + m_ptr = obj.release().ptr(); +} + +class none : public object +{ +public: + PYBIND11_OBJECT(none, object, detail::PyNone_Check) + none() + : object(Py_None, borrowed_t{}) + {} +}; + +#if PY_MAJOR_VERSION >= 3 +class ellipsis : public object +{ +public: + PYBIND11_OBJECT(ellipsis, object, detail::PyEllipsis_Check) + ellipsis() + : object(Py_Ellipsis, borrowed_t{}) + {} +}; +#endif + +class bool_ : public object +{ +public: + PYBIND11_OBJECT_CVT(bool_, object, PyBool_Check, raw_bool) + bool_() + : object(Py_False, borrowed_t{}) + {} + // Allow implicit conversion from and to `bool`: + bool_(bool value) + : object(value ? Py_True : Py_False, borrowed_t{}) + {} + operator bool() const + { + return m_ptr && PyLong_AsLong(m_ptr) != 0; + } + +private: + /// Return the truth value of an object -- always returns a new reference + static PyObject* raw_bool(PyObject* op) + { + const auto value = PyObject_IsTrue(op); + if (value == -1) + return nullptr; + return handle(value ? Py_True : Py_False).inc_ref().ptr(); + } +}; + +NAMESPACE_BEGIN(detail) +// Converts a value to the given unsigned type. If an error occurs, you get back (Unsigned) -1; +// otherwise you get back the unsigned long or unsigned long long value cast to (Unsigned). +// (The distinction is critically important when casting a returned -1 error value to some other +// unsigned type: (A)-1 != (B)-1 when A and B are unsigned types of different sizes). +template <typename Unsigned> +Unsigned as_unsigned(PyObject* o) +{ + if (sizeof(Unsigned) <= sizeof(unsigned long) +#if PY_VERSION_HEX < 0x03000000 + || PyInt_Check(o) +#endif + ) { + unsigned long v = PyLong_AsUnsignedLong(o); + return v == (unsigned long)-1 && PyErr_Occurred() ? (Unsigned)-1 : (Unsigned)v; + } else { + unsigned long long v = PyLong_AsUnsignedLongLong(o); + return v == (unsigned long long)-1 && PyErr_Occurred() ? (Unsigned)-1 : (Unsigned)v; + } +} +NAMESPACE_END(detail) + +class int_ : public object +{ +public: + PYBIND11_OBJECT_CVT(int_, object, PYBIND11_LONG_CHECK, PyNumber_Long) + int_() + : object(PyLong_FromLong(0), stolen_t{}) + {} + // Allow implicit conversion from C++ integral types: + template <typename T, detail::enable_if_t<std::is_integral<T>::value, int> = 0> + int_(T value) + { + if (sizeof(T) <= sizeof(long)) { + if (std::is_signed<T>::value) + m_ptr = PyLong_FromLong((long)value); + else + m_ptr = PyLong_FromUnsignedLong((unsigned long)value); + } else { + if (std::is_signed<T>::value) + m_ptr = PyLong_FromLongLong((long long)value); + else + m_ptr = PyLong_FromUnsignedLongLong((unsigned long long)value); + } + if (!m_ptr) + pybind11_fail("Could not allocate int object!"); + } + + template <typename T, detail::enable_if_t<std::is_integral<T>::value, int> = 0> + operator T() const + { + return std::is_unsigned<T>::value + ? detail::as_unsigned<T>(m_ptr) + : sizeof(T) <= sizeof(long) ? (T)PyLong_AsLong(m_ptr) : (T)PYBIND11_LONG_AS_LONGLONG(m_ptr); + } +}; + +class float_ : public object +{ +public: + PYBIND11_OBJECT_CVT(float_, object, PyFloat_Check, PyNumber_Float) + // Allow implicit conversion from float/double: + float_(float value) + : object(PyFloat_FromDouble((double)value), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate float object!"); + } + float_(double value = .0) + : object(PyFloat_FromDouble((double)value), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate float object!"); + } + operator float() const + { + return (float)PyFloat_AsDouble(m_ptr); + } + operator double() const + { + return (double)PyFloat_AsDouble(m_ptr); + } +}; + +class weakref : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(weakref, object, PyWeakref_Check) + explicit weakref(handle obj, handle callback = {}) + : object(PyWeakref_NewRef(obj.ptr(), callback.ptr()), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate weak reference!"); + } +}; + +class slice : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(slice, object, PySlice_Check) + slice(ssize_t start_, ssize_t stop_, ssize_t step_) + { + int_ start(start_), stop(stop_), step(step_); + m_ptr = PySlice_New(start.ptr(), stop.ptr(), step.ptr()); + if (!m_ptr) + pybind11_fail("Could not allocate slice object!"); + } + bool compute(size_t length, size_t* start, size_t* stop, size_t* step, size_t* slicelength) const + { + return PySlice_GetIndicesEx((PYBIND11_SLICE_OBJECT*)m_ptr, + (ssize_t)length, + (ssize_t*)start, + (ssize_t*)stop, + (ssize_t*)step, + (ssize_t*)slicelength) + == 0; + } + bool compute(ssize_t length, ssize_t* start, ssize_t* stop, ssize_t* step, ssize_t* slicelength) const + { + return PySlice_GetIndicesEx((PYBIND11_SLICE_OBJECT*)m_ptr, length, start, stop, step, slicelength) == 0; + } +}; + +class capsule : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(capsule, object, PyCapsule_CheckExact) + PYBIND11_DEPRECATED("Use reinterpret_borrow<capsule>() or reinterpret_steal<capsule>()") + capsule(PyObject* ptr, bool is_borrowed) + : object(is_borrowed ? object(ptr, borrowed_t{}) : object(ptr, stolen_t{})) + {} + + explicit capsule(const void* value, const char* name = nullptr, void (*destructor)(PyObject*) = nullptr) + : object(PyCapsule_New(const_cast<void*>(value), name, destructor), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + } + + PYBIND11_DEPRECATED("Please pass a destructor that takes a void pointer as input") + capsule(const void* value, void (*destruct)(PyObject*)) + : object(PyCapsule_New(const_cast<void*>(value), nullptr, destruct), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + } + + capsule(const void* value, void (*destructor)(void*)) + { + m_ptr = PyCapsule_New(const_cast<void*>(value), nullptr, [](PyObject* o) { + auto destructor = reinterpret_cast<void (*)(void*)>(PyCapsule_GetContext(o)); + void* ptr = PyCapsule_GetPointer(o, nullptr); + destructor(ptr); + }); + + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + + if (PyCapsule_SetContext(m_ptr, (void*)destructor) != 0) + pybind11_fail("Could not set capsule context!"); + } + + capsule(void (*destructor)()) + { + m_ptr = PyCapsule_New(reinterpret_cast<void*>(destructor), nullptr, [](PyObject* o) { + auto destructor = reinterpret_cast<void (*)()>(PyCapsule_GetPointer(o, nullptr)); + destructor(); + }); + + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + } + + template <typename T> + operator T*() const + { + auto name = this->name(); + T* result = static_cast<T*>(PyCapsule_GetPointer(m_ptr, name)); + if (!result) + pybind11_fail("Unable to extract capsule contents!"); + return result; + } + + const char* name() const + { + return PyCapsule_GetName(m_ptr); + } +}; + +class tuple : public object +{ +public: + PYBIND11_OBJECT_CVT(tuple, object, PyTuple_Check, PySequence_Tuple) + explicit tuple(size_t size = 0) + : object(PyTuple_New((ssize_t)size), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate tuple object!"); + } + size_t size() const + { + return (size_t)PyTuple_Size(m_ptr); + } + detail::tuple_accessor operator[](size_t index) const + { + return {*this, index}; + } + detail::item_accessor operator[](handle h) const + { + return object::operator[](h); + } + detail::tuple_iterator begin() const + { + return {*this, 0}; + } + detail::tuple_iterator end() const + { + return {*this, PyTuple_GET_SIZE(m_ptr)}; + } +}; + +class dict : public object +{ +public: + PYBIND11_OBJECT_CVT(dict, object, PyDict_Check, raw_dict) + dict() + : object(PyDict_New(), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate dict object!"); + } + template <typename... Args, + typename = detail::enable_if_t<detail::all_of<detail::is_keyword_or_ds<Args>...>::value>, + // MSVC workaround: it can't compile an out-of-line definition, so defer the collector + typename collector = detail::deferred_t<detail::unpacking_collector<>, Args...>> + explicit dict(Args&&... args) + : dict(collector(std::forward<Args>(args)...).kwargs()) + {} + + size_t size() const + { + return (size_t)PyDict_Size(m_ptr); + } + detail::dict_iterator begin() const + { + return {*this, 0}; + } + detail::dict_iterator end() const + { + return {}; + } + void clear() const + { + PyDict_Clear(ptr()); + } + bool contains(handle key) const + { + return PyDict_Contains(ptr(), key.ptr()) == 1; + } + bool contains(const char* key) const + { + return PyDict_Contains(ptr(), pybind11::str(key).ptr()) == 1; + } + +private: + /// Call the `dict` Python type -- always returns a new reference + static PyObject* raw_dict(PyObject* op) + { + if (PyDict_Check(op)) + return handle(op).inc_ref().ptr(); + return PyObject_CallFunctionObjArgs((PyObject*)&PyDict_Type, op, nullptr); + } +}; + +class sequence : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(sequence, object, PySequence_Check) + size_t size() const + { + return (size_t)PySequence_Size(m_ptr); + } + detail::sequence_accessor operator[](size_t index) const + { + return {*this, index}; + } + detail::item_accessor operator[](handle h) const + { + return object::operator[](h); + } + detail::sequence_iterator begin() const + { + return {*this, 0}; + } + detail::sequence_iterator end() const + { + return {*this, PySequence_Size(m_ptr)}; + } +}; + +class list : public object +{ +public: + PYBIND11_OBJECT_CVT(list, object, PyList_Check, PySequence_List) + explicit list(size_t size = 0) + : object(PyList_New((ssize_t)size), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate list object!"); + } + size_t size() const + { + return (size_t)PyList_Size(m_ptr); + } + detail::list_accessor operator[](size_t index) const + { + return {*this, index}; + } + detail::item_accessor operator[](handle h) const + { + return object::operator[](h); + } + detail::list_iterator begin() const + { + return {*this, 0}; + } + detail::list_iterator end() const + { + return {*this, PyList_GET_SIZE(m_ptr)}; + } + template <typename T> + void append(T&& val) const + { + PyList_Append(m_ptr, detail::object_or_cast(std::forward<T>(val)).ptr()); + } +}; + +class args : public tuple +{ + PYBIND11_OBJECT_DEFAULT(args, tuple, PyTuple_Check) +}; +class kwargs : public dict +{ + PYBIND11_OBJECT_DEFAULT(kwargs, dict, PyDict_Check) +}; + +class set : public object +{ +public: + PYBIND11_OBJECT_CVT(set, object, PySet_Check, PySet_New) + set() + : object(PySet_New(nullptr), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate set object!"); + } + size_t size() const + { + return (size_t)PySet_Size(m_ptr); + } + template <typename T> + bool add(T&& val) const + { + return PySet_Add(m_ptr, detail::object_or_cast(std::forward<T>(val)).ptr()) == 0; + } + void clear() const + { + PySet_Clear(m_ptr); + } +}; + +class function : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(function, object, PyCallable_Check) + handle cpp_function() const + { + handle fun = detail::get_function(m_ptr); + if (fun && PyCFunction_Check(fun.ptr())) + return fun; + return handle(); + } + bool is_cpp_function() const + { + return (bool)cpp_function(); + } +}; + +class staticmethod : public object +{ +public: + PYBIND11_OBJECT_CVT(staticmethod, object, detail::PyStaticMethod_Check, PyStaticMethod_New) +}; + +class buffer : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(buffer, object, PyObject_CheckBuffer) + + buffer_info request(bool writable = false) + { + int flags = PyBUF_STRIDES | PyBUF_FORMAT; + if (writable) + flags |= PyBUF_WRITABLE; + Py_buffer* view = new Py_buffer(); + if (PyObject_GetBuffer(m_ptr, view, flags) != 0) { + delete view; + throw error_already_set(); + } + return buffer_info(view); + } +}; + +class memoryview : public object +{ +public: + explicit memoryview(const buffer_info& info) + { + static Py_buffer buf{}; + // Py_buffer uses signed sizes, strides and shape!.. + static std::vector<Py_ssize_t> py_strides{}; + static std::vector<Py_ssize_t> py_shape{}; + buf.buf = info.ptr; + buf.itemsize = info.itemsize; + buf.format = const_cast<char*>(info.format.c_str()); + buf.ndim = (int)info.ndim; + buf.len = info.size; + py_strides.clear(); + py_shape.clear(); + for (size_t i = 0; i < (size_t)info.ndim; ++i) { + py_strides.push_back(info.strides[i]); + py_shape.push_back(info.shape[i]); + } + buf.strides = py_strides.data(); + buf.shape = py_shape.data(); + buf.suboffsets = nullptr; + buf.readonly = false; + buf.internal = nullptr; + + m_ptr = PyMemoryView_FromBuffer(&buf); + if (!m_ptr) + pybind11_fail("Unable to create memoryview from buffer descriptor"); + } + + PYBIND11_OBJECT_CVT(memoryview, object, PyMemoryView_Check, PyMemoryView_FromObject) +}; +/// @} pytypes + +/// \addtogroup python_builtins +/// @{ +inline size_t len(handle h) +{ + ssize_t result = PyObject_Length(h.ptr()); + if (result < 0) + pybind11_fail("Unable to compute length of object"); + return (size_t)result; +} + +inline size_t len_hint(handle h) +{ +#if PY_VERSION_HEX >= 0x03040000 + ssize_t result = PyObject_LengthHint(h.ptr(), 0); +#else + ssize_t result = PyObject_Length(h.ptr()); +#endif + if (result < 0) { + // Sometimes a length can't be determined at all (eg generators) + // In which case simply return 0 + PyErr_Clear(); + return 0; + } + return (size_t)result; +} + +inline str repr(handle h) +{ + PyObject* str_value = PyObject_Repr(h.ptr()); + if (!str_value) + throw error_already_set(); +#if PY_MAJOR_VERSION < 3 + PyObject* unicode = PyUnicode_FromEncodedObject(str_value, "utf-8", nullptr); + Py_XDECREF(str_value); + str_value = unicode; + if (!str_value) + throw error_already_set(); +#endif + return reinterpret_steal<str>(str_value); +} + +inline iterator iter(handle obj) +{ + PyObject* result = PyObject_GetIter(obj.ptr()); + if (!result) { + throw error_already_set(); + } + return reinterpret_steal<iterator>(result); +} +/// @} python_builtins + +NAMESPACE_BEGIN(detail) +template <typename D> +iterator object_api<D>::begin() const +{ + return iter(derived()); +} +template <typename D> +iterator object_api<D>::end() const +{ + return iterator::sentinel(); +} +template <typename D> +item_accessor object_api<D>::operator[](handle key) const +{ + return {derived(), reinterpret_borrow<object>(key)}; +} +template <typename D> +item_accessor object_api<D>::operator[](const char* key) const +{ + return {derived(), pybind11::str(key)}; +} +template <typename D> +obj_attr_accessor object_api<D>::attr(handle key) const +{ + return {derived(), reinterpret_borrow<object>(key)}; +} +template <typename D> +str_attr_accessor object_api<D>::attr(const char* key) const +{ + return {derived(), key}; +} +template <typename D> +args_proxy object_api<D>::operator*() const +{ + return args_proxy(derived().ptr()); +} +template <typename D> +template <typename T> +bool object_api<D>::contains(T&& item) const +{ + return attr("__contains__")(std::forward<T>(item)).template cast<bool>(); +} + +template <typename D> +pybind11::str object_api<D>::str() const +{ + return pybind11::str(derived()); +} + +template <typename D> +str_attr_accessor object_api<D>::doc() const +{ + return attr("__doc__"); +} + +template <typename D> +handle object_api<D>::get_type() const +{ + return (PyObject*)Py_TYPE(derived().ptr()); +} + +template <typename D> +bool object_api<D>::rich_compare(object_api const& other, int value) const +{ + int rv = PyObject_RichCompareBool(derived().ptr(), other.derived().ptr(), value); + if (rv == -1) + throw error_already_set(); + return rv == 1; +} + +#define PYBIND11_MATH_OPERATOR_UNARY(op, fn) \ + template <typename D> \ + object object_api<D>::op() const \ + { \ + object result = reinterpret_steal<object>(fn(derived().ptr())); \ + if (!result.ptr()) \ + throw error_already_set(); \ + return result; \ + } + +#define PYBIND11_MATH_OPERATOR_BINARY(op, fn) \ + template <typename D> \ + object object_api<D>::op(object_api const& other) const \ + { \ + object result = reinterpret_steal<object>(fn(derived().ptr(), other.derived().ptr())); \ + if (!result.ptr()) \ + throw error_already_set(); \ + return result; \ + } + +PYBIND11_MATH_OPERATOR_UNARY(operator~, PyNumber_Invert) +PYBIND11_MATH_OPERATOR_UNARY(operator-, PyNumber_Negative) +PYBIND11_MATH_OPERATOR_BINARY(operator+, PyNumber_Add) +PYBIND11_MATH_OPERATOR_BINARY(operator+=, PyNumber_InPlaceAdd) +PYBIND11_MATH_OPERATOR_BINARY(operator-, PyNumber_Subtract) +PYBIND11_MATH_OPERATOR_BINARY(operator-=, PyNumber_InPlaceSubtract) +PYBIND11_MATH_OPERATOR_BINARY(operator*, PyNumber_Multiply) +PYBIND11_MATH_OPERATOR_BINARY(operator*=, PyNumber_InPlaceMultiply) +PYBIND11_MATH_OPERATOR_BINARY(operator/, PyNumber_TrueDivide) +PYBIND11_MATH_OPERATOR_BINARY(operator/=, PyNumber_InPlaceTrueDivide) +PYBIND11_MATH_OPERATOR_BINARY(operator|, PyNumber_Or) +PYBIND11_MATH_OPERATOR_BINARY(operator|=, PyNumber_InPlaceOr) +PYBIND11_MATH_OPERATOR_BINARY(operator&, PyNumber_And) +PYBIND11_MATH_OPERATOR_BINARY(operator&=, PyNumber_InPlaceAnd) +PYBIND11_MATH_OPERATOR_BINARY(operator^, PyNumber_Xor) +PYBIND11_MATH_OPERATOR_BINARY(operator^=, PyNumber_InPlaceXor) +PYBIND11_MATH_OPERATOR_BINARY(operator<<, PyNumber_Lshift) +PYBIND11_MATH_OPERATOR_BINARY(operator<<=, PyNumber_InPlaceLshift) +PYBIND11_MATH_OPERATOR_BINARY(operator>>, PyNumber_Rshift) +PYBIND11_MATH_OPERATOR_BINARY(operator>>=, PyNumber_InPlaceRshift) + +#undef PYBIND11_MATH_OPERATOR_UNARY +#undef PYBIND11_MATH_OPERATOR_BINARY + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/pybindxi/stl.h b/dune/pybindxi/stl.h new file mode 100644 index 0000000000000000000000000000000000000000..9272e6daf57b863a4873de6bddd0eb4edb16a748 --- /dev/null +++ b/dune/pybindxi/stl.h @@ -0,0 +1,440 @@ +#pragma GCC system_header +/* + pybind11/stl.h: Transparent conversion for STL data types + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include <set> +#include <unordered_set> +#include <map> +#include <unordered_map> +#include <iostream> +#include <list> +#include <deque> +#include <valarray> + +#if defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable : 4127) // warning C4127: Conditional expression is constant +#endif + +#ifdef __has_include +// std::optional (but including it in c++14 mode isn't allowed) +# if defined(PYBIND11_CPP17) && __has_include(<optional>) +# include <optional> +# define PYBIND11_HAS_OPTIONAL 1 +# endif +// std::experimental::optional (but not allowed in c++11 mode) +# if defined(PYBIND11_CPP14) && (__has_include(<experimental/optional>) && \ + !__has_include(<optional>)) +# include <experimental/optional> +# define PYBIND11_HAS_EXP_OPTIONAL 1 +# endif +// std::variant +# if defined(PYBIND11_CPP17) && __has_include(<variant>) +# include <variant> +# define PYBIND11_HAS_VARIANT 1 +# endif +#elif defined(_MSC_VER) && defined(PYBIND11_CPP17) +# include <optional> +# include <variant> +# define PYBIND11_HAS_OPTIONAL 1 +# define PYBIND11_HAS_VARIANT 1 +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// Extracts an const lvalue reference or rvalue reference for U based on the type of T (e.g. for +/// forwarding a container element). Typically used indirect via forwarded_type(), below. +template <typename T, typename U> +using forwarded_type = + conditional_t<std::is_lvalue_reference<T>::value, remove_reference_t<U>&, remove_reference_t<U>&&>; + +/// Forwards a value U as rvalue or lvalue according to whether T is rvalue or lvalue; typically +/// used for forwarding a container's elements. +template <typename T, typename U> +forwarded_type<T, U> forward_like(U&& u) +{ + return std::forward<detail::forwarded_type<T, U>>(std::forward<U>(u)); +} + +template <typename Type, typename Key> +struct set_caster +{ + using type = Type; + using key_conv = make_caster<Key>; + + bool load(handle src, bool convert) + { + if (!isinstance<pybind11::set>(src)) + return false; + auto s = reinterpret_borrow<pybind11::set>(src); + value.clear(); + for (auto entry : s) { + key_conv conv; + if (!conv.load(entry, convert)) + return false; + value.insert(cast_op<Key&&>(std::move(conv))); + } + return true; + } + + template <typename T> + static handle cast(T&& src, return_value_policy policy, handle parent) + { + if (!std::is_lvalue_reference<T>::value) + policy = return_value_policy_override<Key>::policy(policy); + pybind11::set s; + for (auto&& value : src) { + auto value_ = reinterpret_steal<object>(key_conv::cast(forward_like<T>(value), policy, parent)); + if (!value_ || !s.add(value_)) + return handle(); + } + return s.release(); + } + + PYBIND11_TYPE_CASTER(type, _("Set[") + key_conv::name + _("]")); +}; + +template <typename Type, typename Key, typename Value> +struct map_caster +{ + using key_conv = make_caster<Key>; + using value_conv = make_caster<Value>; + + bool load(handle src, bool convert) + { + if (!isinstance<dict>(src)) + return false; + auto d = reinterpret_borrow<dict>(src); + value.clear(); + for (auto it : d) { + key_conv kconv; + value_conv vconv; + if (!kconv.load(it.first.ptr(), convert) || !vconv.load(it.second.ptr(), convert)) + return false; + value.emplace(cast_op<Key&&>(std::move(kconv)), cast_op<Value&&>(std::move(vconv))); + } + return true; + } + + template <typename T> + static handle cast(T&& src, return_value_policy policy, handle parent) + { + dict d; + return_value_policy policy_key = policy; + return_value_policy policy_value = policy; + if (!std::is_lvalue_reference<T>::value) { + policy_key = return_value_policy_override<Key>::policy(policy_key); + policy_value = return_value_policy_override<Value>::policy(policy_value); + } + for (auto&& kv : src) { + auto key = reinterpret_steal<object>(key_conv::cast(forward_like<T>(kv.first), policy_key, parent)); + auto value = reinterpret_steal<object>(value_conv::cast(forward_like<T>(kv.second), policy_value, parent)); + if (!key || !value) + return handle(); + d[key] = value; + } + return d.release(); + } + + PYBIND11_TYPE_CASTER(Type, _("Dict[") + key_conv::name + _(", ") + value_conv::name + _("]")); +}; + +template <typename Type, typename Value> +struct list_caster +{ + using value_conv = make_caster<Value>; + + bool load(handle src, bool convert) + { + if (!isinstance<sequence>(src) || isinstance<str>(src)) + return false; + auto s = reinterpret_borrow<sequence>(src); + value.clear(); + reserve_maybe(s, &value); + for (auto it : s) { + value_conv conv; + if (!conv.load(it, convert)) + return false; + value.push_back(cast_op<Value&&>(std::move(conv))); + } + return true; + } + +private: + template <typename T = Type, enable_if_t<std::is_same<decltype(std::declval<T>().reserve(0)), void>::value, int> = 0> + void reserve_maybe(sequence s, Type*) + { + value.reserve(s.size()); + } + void reserve_maybe(sequence, void*) {} + +public: + template <typename T> + static handle cast(T&& src, return_value_policy policy, handle parent) + { + if (!std::is_lvalue_reference<T>::value) + policy = return_value_policy_override<Value>::policy(policy); + list l(src.size()); + size_t index = 0; + for (auto&& value : src) { + auto value_ = reinterpret_steal<object>(value_conv::cast(forward_like<T>(value), policy, parent)); + if (!value_) + return handle(); + PyList_SET_ITEM(l.ptr(), (ssize_t)index++, value_.release().ptr()); // steals a reference + } + return l.release(); + } + + PYBIND11_TYPE_CASTER(Type, _("List[") + value_conv::name + _("]")); +}; + +template <typename Type, typename Alloc> +struct type_caster<std::vector<Type, Alloc>> : list_caster<std::vector<Type, Alloc>, Type> +{}; + +template <typename Type, typename Alloc> +struct type_caster<std::deque<Type, Alloc>> : list_caster<std::deque<Type, Alloc>, Type> +{}; + +template <typename Type, typename Alloc> +struct type_caster<std::list<Type, Alloc>> : list_caster<std::list<Type, Alloc>, Type> +{}; + +template <typename ArrayType, typename Value, bool Resizable, size_t Size = 0> +struct array_caster +{ + using value_conv = make_caster<Value>; + +private: + template <bool R = Resizable> + bool require_size(enable_if_t<R, size_t> size) + { + if (value.size() != size) + value.resize(size); + return true; + } + template <bool R = Resizable> + bool require_size(enable_if_t<!R, size_t> size) + { + return size == Size; + } + +public: + bool load(handle src, bool convert) + { + if (!isinstance<sequence>(src)) + return false; + auto l = reinterpret_borrow<sequence>(src); + if (!require_size(l.size())) + return false; + size_t ctr = 0; + for (auto it : l) { + value_conv conv; + if (!conv.load(it, convert)) + return false; + value[ctr++] = cast_op<Value&&>(std::move(conv)); + } + return true; + } + + template <typename T> + static handle cast(T&& src, return_value_policy policy, handle parent) + { + list l(src.size()); + size_t index = 0; + for (auto&& value : src) { + auto value_ = reinterpret_steal<object>(value_conv::cast(forward_like<T>(value), policy, parent)); + if (!value_) + return handle(); + PyList_SET_ITEM(l.ptr(), (ssize_t)index++, value_.release().ptr()); // steals a reference + } + return l.release(); + } + + PYBIND11_TYPE_CASTER(ArrayType, + _("List[") + value_conv::name + _<Resizable>(_(""), _("[") + _<Size>() + _("]")) + _("]")); +}; + +template <typename Type, size_t Size> +struct type_caster<std::array<Type, Size>> : array_caster<std::array<Type, Size>, Type, false, Size> +{}; + +template <typename Type> +struct type_caster<std::valarray<Type>> : array_caster<std::valarray<Type>, Type, true> +{}; + +template <typename Key, typename Compare, typename Alloc> +struct type_caster<std::set<Key, Compare, Alloc>> : set_caster<std::set<Key, Compare, Alloc>, Key> +{}; + +template <typename Key, typename Hash, typename Equal, typename Alloc> +struct type_caster<std::unordered_set<Key, Hash, Equal, Alloc>> + : set_caster<std::unordered_set<Key, Hash, Equal, Alloc>, Key> +{}; + +template <typename Key, typename Value, typename Compare, typename Alloc> +struct type_caster<std::map<Key, Value, Compare, Alloc>> : map_caster<std::map<Key, Value, Compare, Alloc>, Key, Value> +{}; + +template <typename Key, typename Value, typename Hash, typename Equal, typename Alloc> +struct type_caster<std::unordered_map<Key, Value, Hash, Equal, Alloc>> + : map_caster<std::unordered_map<Key, Value, Hash, Equal, Alloc>, Key, Value> +{}; + +// This type caster is intended to be used for std::optional and std::experimental::optional +template <typename T> +struct optional_caster +{ + using value_conv = make_caster<typename T::value_type>; + + template <typename T_> + static handle cast(T_&& src, return_value_policy policy, handle parent) + { + if (!src) + return none().inc_ref(); + policy = return_value_policy_override<typename T::value_type>::policy(policy); + return value_conv::cast(*std::forward<T_>(src), policy, parent); + } + + bool load(handle src, bool convert) + { + if (!src) { + return false; + } else if (src.is_none()) { + return true; // default-constructed value is already empty + } + value_conv inner_caster; + if (!inner_caster.load(src, convert)) + return false; + + value.emplace(cast_op<typename T::value_type&&>(std::move(inner_caster))); + return true; + } + + PYBIND11_TYPE_CASTER(T, _("Optional[") + value_conv::name + _("]")); +}; + +#if PYBIND11_HAS_OPTIONAL +template <typename T> +struct type_caster<std::optional<T>> : public optional_caster<std::optional<T>> +{}; + +template <> +struct type_caster<std::nullopt_t> : public void_caster<std::nullopt_t> +{}; +#endif + +#if PYBIND11_HAS_EXP_OPTIONAL +template <typename T> +struct type_caster<std::experimental::optional<T>> : public optional_caster<std::experimental::optional<T>> +{}; + +template <> +struct type_caster<std::experimental::nullopt_t> : public void_caster<std::experimental::nullopt_t> +{}; +#endif + +/// Visit a variant and cast any found type to Python +struct variant_caster_visitor +{ + return_value_policy policy; + handle parent; + + using result_type = handle; // required by boost::variant in C++11 + + template <typename T> + result_type operator()(T&& src) const + { + return make_caster<T>::cast(std::forward<T>(src), policy, parent); + } +}; + +/// Helper class which abstracts away variant's `visit` function. `std::variant` and similar +/// `namespace::variant` types which provide a `namespace::visit()` function are handled here +/// automatically using argument-dependent lookup. Users can provide specializations for other +/// variant-like classes, e.g. `boost::variant` and `boost::apply_visitor`. +template <template <typename...> class Variant> +struct visit_helper +{ + template <typename... Args> + static auto call(Args&&... args) -> decltype(visit(std::forward<Args>(args)...)) + { + return visit(std::forward<Args>(args)...); + } +}; + +/// Generic variant caster +template <typename Variant> +struct variant_caster; + +template <template <typename...> class V, typename... Ts> +struct variant_caster<V<Ts...>> +{ + static_assert(sizeof...(Ts) > 0, "Variant must consist of at least one alternative."); + + template <typename U, typename... Us> + bool load_alternative(handle src, bool convert, type_list<U, Us...>) + { + auto caster = make_caster<U>(); + if (caster.load(src, convert)) { + value = cast_op<U>(caster); + return true; + } + return load_alternative(src, convert, type_list<Us...>{}); + } + + bool load_alternative(handle, bool, type_list<>) + { + return false; + } + + bool load(handle src, bool convert) + { + // Do a first pass without conversions to improve constructor resolution. + // E.g. `py::int_(1).cast<variant<double, int>>()` needs to fill the `int` + // slot of the variant. Without two-pass loading `double` would be filled + // because it appears first and a conversion is possible. + if (convert && load_alternative(src, false, type_list<Ts...>{})) + return true; + return load_alternative(src, convert, type_list<Ts...>{}); + } + + template <typename Variant> + static handle cast(Variant&& src, return_value_policy policy, handle parent) + { + return visit_helper<V>::call(variant_caster_visitor{policy, parent}, std::forward<Variant>(src)); + } + + using Type = V<Ts...>; + PYBIND11_TYPE_CASTER(Type, _("Union[") + detail::concat(make_caster<Ts>::name...) + _("]")); +}; + +#if PYBIND11_HAS_VARIANT +template <typename... Ts> +struct type_caster<std::variant<Ts...>> : variant_caster<std::variant<Ts...>> +{}; +#endif + +NAMESPACE_END(detail) + +inline std::ostream& operator<<(std::ostream& os, const handle& obj) +{ + os << (std::string)str(obj); + return os; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) +# pragma warning(pop) +#endif diff --git a/dune/pybindxi/stl_bind.h b/dune/pybindxi/stl_bind.h new file mode 100644 index 0000000000000000000000000000000000000000..299ac4ba0eb29ccc09dba98d767ee9b51fb13245 --- /dev/null +++ b/dune/pybindxi/stl_bind.h @@ -0,0 +1,630 @@ +#pragma GCC system_header +/* + pybind11/std_bind.h: Binding generators for STL data types + + Copyright (c) 2016 Sergey Lyskov and Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" +#include "operators.h" + +#include <algorithm> +#include <sstream> + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/* SFINAE helper class used by 'is_comparable */ +template <typename T> +struct container_traits +{ + template <typename T2> + static std::true_type test_comparable(decltype(std::declval<const T2&>() == std::declval<const T2&>())*); + template <typename T2> + static std::false_type test_comparable(...); + template <typename T2> + static std::true_type test_value(typename T2::value_type*); + template <typename T2> + static std::false_type test_value(...); + template <typename T2> + static std::true_type test_pair(typename T2::first_type*, typename T2::second_type*); + template <typename T2> + static std::false_type test_pair(...); + + static constexpr const bool is_comparable = + std::is_same<std::true_type, decltype(test_comparable<T>(nullptr))>::value; + static constexpr const bool is_pair = std::is_same<std::true_type, decltype(test_pair<T>(nullptr, nullptr))>::value; + static constexpr const bool is_vector = std::is_same<std::true_type, decltype(test_value<T>(nullptr))>::value; + static constexpr const bool is_element = !is_pair && !is_vector; +}; + +/* Default: is_comparable -> std::false_type */ +template <typename T, typename SFINAE = void> +struct is_comparable : std::false_type +{}; + +/* For non-map data structures, check whether operator== can be instantiated */ +template <typename T> +struct is_comparable<T, enable_if_t<container_traits<T>::is_element && container_traits<T>::is_comparable>> + : std::true_type +{}; + +/* For a vector/map data structure, recursively check the value type (which is std::pair for maps) */ +template <typename T> +struct is_comparable<T, enable_if_t<container_traits<T>::is_vector>> +{ + static constexpr const bool value = is_comparable<typename T::value_type>::value; +}; + +/* For pairs, recursively check the two data types */ +template <typename T> +struct is_comparable<T, enable_if_t<container_traits<T>::is_pair>> +{ + static constexpr const bool value = + is_comparable<typename T::first_type>::value && is_comparable<typename T::second_type>::value; +}; + +/* Fallback functions */ +template <typename, typename, typename... Args> +void vector_if_copy_constructible(const Args&...) +{} +template <typename, typename, typename... Args> +void vector_if_equal_operator(const Args&...) +{} +template <typename, typename, typename... Args> +void vector_if_insertion_operator(const Args&...) +{} +template <typename, typename, typename... Args> +void vector_modifiers(const Args&...) +{} + +template <typename Vector, typename Class_> +void vector_if_copy_constructible(enable_if_t<is_copy_constructible<Vector>::value, Class_>& cl) +{ + cl.def(init<const Vector&>(), "Copy constructor"); +} + +template <typename Vector, typename Class_> +void vector_if_equal_operator(enable_if_t<is_comparable<Vector>::value, Class_>& cl) +{ + using T = typename Vector::value_type; + + cl.def(self == self); + cl.def(self != self); + + cl.def("count", + [](const Vector& v, const T& x) { return std::count(v.begin(), v.end(), x); }, + arg("x"), + "Return the number of times ``x`` appears in the list"); + + cl.def("remove", + [](Vector& v, const T& x) { + auto p = std::find(v.begin(), v.end(), x); + if (p != v.end()) + v.erase(p); + else + throw value_error(); + }, + arg("x"), + "Remove the first item from the list whose value is x. " + "It is an error if there is no such item."); + + cl.def("__contains__", + [](const Vector& v, const T& x) { return std::find(v.begin(), v.end(), x) != v.end(); }, + arg("x"), + "Return true the container contains ``x``"); +} + +// Vector modifiers -- requires a copyable vector_type: +// (Technically, some of these (pop and __delitem__) don't actually require copyability, but it seems +// silly to allow deletion but not insertion, so include them here too.) +template <typename Vector, typename Class_> +void vector_modifiers(enable_if_t<is_copy_constructible<typename Vector::value_type>::value, Class_>& cl) +{ + using T = typename Vector::value_type; + using SizeType = typename Vector::size_type; + using DiffType = typename Vector::difference_type; + + cl.def( + "append", [](Vector& v, const T& value) { v.push_back(value); }, arg("x"), "Add an item to the end of the list"); + + cl.def(init([](iterable it) { + auto v = std::unique_ptr<Vector>(new Vector()); + v->reserve(len_hint(it)); + for (handle h : it) + v->push_back(h.cast<T>()); + return v.release(); + })); + + cl.def("extend", + [](Vector& v, const Vector& src) { v.insert(v.end(), src.begin(), src.end()); }, + arg("L"), + "Extend the list by appending all the items in the given list"); + + cl.def("extend", + [](Vector& v, iterable it) { + const size_t old_size = v.size(); + v.reserve(old_size + len_hint(it)); + try { + for (handle h : it) { + v.push_back(h.cast<T>()); + } + } catch (const cast_error&) { + v.erase(v.begin() + static_cast<typename Vector::difference_type>(old_size), v.end()); + try { + v.shrink_to_fit(); + } catch (const std::exception&) { + // Do nothing + } + throw; + } + }, + arg("L"), + "Extend the list by appending all the items in the given list"); + + cl.def("insert", + [](Vector& v, SizeType i, const T& x) { + if (i > v.size()) + throw index_error(); + v.insert(v.begin() + (DiffType)i, x); + }, + arg("i"), + arg("x"), + "Insert an item at a given position."); + + cl.def("pop", + [](Vector& v) { + if (v.empty()) + throw index_error(); + T t = v.back(); + v.pop_back(); + return t; + }, + "Remove and return the last item"); + + cl.def("pop", + [](Vector& v, SizeType i) { + if (i >= v.size()) + throw index_error(); + T t = v[i]; + v.erase(v.begin() + (DiffType)i); + return t; + }, + arg("i"), + "Remove and return the item at index ``i``"); + + cl.def("__setitem__", [](Vector& v, SizeType i, const T& t) { + if (i >= v.size()) + throw index_error(); + v[i] = t; + }); + + /// Slicing protocol + cl.def("__getitem__", + [](const Vector& v, slice slice) -> Vector* { + size_t start, stop, step, slicelength; + + if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) + throw error_already_set(); + + Vector* seq = new Vector(); + seq->reserve((size_t)slicelength); + + for (size_t i = 0; i < slicelength; ++i) { + seq->push_back(v[start]); + start += step; + } + return seq; + }, + arg("s"), + "Retrieve list elements using a slice object"); + + cl.def("__setitem__", + [](Vector& v, slice slice, const Vector& value) { + size_t start, stop, step, slicelength; + if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) + throw error_already_set(); + + if (slicelength != value.size()) + throw std::runtime_error("Left and right hand size of slice assignment have different sizes!"); + + for (size_t i = 0; i < slicelength; ++i) { + v[start] = value[i]; + start += step; + } + }, + "Assign list elements using a slice object"); + + cl.def("__delitem__", + [](Vector& v, SizeType i) { + if (i >= v.size()) + throw index_error(); + v.erase(v.begin() + DiffType(i)); + }, + "Delete the list elements at index ``i``"); + + cl.def("__delitem__", + [](Vector& v, slice slice) { + size_t start, stop, step, slicelength; + + if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) + throw error_already_set(); + + if (step == 1 && false) { + v.erase(v.begin() + (DiffType)start, v.begin() + DiffType(start + slicelength)); + } else { + for (size_t i = 0; i < slicelength; ++i) { + v.erase(v.begin() + DiffType(start)); + start += step - 1; + } + } + }, + "Delete list elements using a slice object"); +} + +// If the type has an operator[] that doesn't return a reference (most notably std::vector<bool>), +// we have to access by copying; otherwise we return by reference. +template <typename Vector> +using vector_needs_copy = negation< + std::is_same<decltype(std::declval<Vector>()[typename Vector::size_type()]), typename Vector::value_type&>>; + +// The usual case: access and iterate by reference +template <typename Vector, typename Class_> +void vector_accessor(enable_if_t<!vector_needs_copy<Vector>::value, Class_>& cl) +{ + using T = typename Vector::value_type; + using SizeType = typename Vector::size_type; + using ItType = typename Vector::iterator; + + cl.def("__getitem__", + [](Vector& v, SizeType i) -> T& { + if (i >= v.size()) + throw index_error(); + return v[i]; + }, + return_value_policy::reference_internal // ref + keepalive + ); + + cl.def("__iter__", + [](Vector& v) { + return make_iterator<return_value_policy::reference_internal, ItType, ItType, T&>(v.begin(), v.end()); + }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); +} + +// The case for special objects, like std::vector<bool>, that have to be returned-by-copy: +template <typename Vector, typename Class_> +void vector_accessor(enable_if_t<vector_needs_copy<Vector>::value, Class_>& cl) +{ + using T = typename Vector::value_type; + using SizeType = typename Vector::size_type; + using ItType = typename Vector::iterator; + cl.def("__getitem__", [](const Vector& v, SizeType i) -> T { + if (i >= v.size()) + throw index_error(); + return v[i]; + }); + + cl.def("__iter__", + [](Vector& v) { return make_iterator<return_value_policy::copy, ItType, ItType, T>(v.begin(), v.end()); }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); +} + +template <typename Vector, typename Class_> +auto vector_if_insertion_operator(Class_& cl, std::string const& name) + -> decltype(std::declval<std::ostream&>() << std::declval<typename Vector::value_type>(), void()) +{ + using size_type = typename Vector::size_type; + + cl.def("__repr__", + [name](Vector& v) { + std::ostringstream s; + s << name << '['; + for (size_type i = 0; i < v.size(); ++i) { + s << v[i]; + if (i != v.size() - 1) + s << ", "; + } + s << ']'; + return s.str(); + }, + "Return the canonical string representation of this list."); +} + +// Provide the buffer interface for vectors if we have data() and we have a format for it +// GCC seems to have "void std::vector<bool>::data()" - doing SFINAE on the existence of data() is insufficient, we need +// to check it returns an appropriate pointer +template <typename Vector, typename = void> +struct vector_has_data_and_format : std::false_type +{}; +template <typename Vector> +struct vector_has_data_and_format< + Vector, + enable_if_t< + std::is_same<decltype(format_descriptor<typename Vector::value_type>::format(), std::declval<Vector>().data()), + typename Vector::value_type*>::value>> : std::true_type +{}; + +// Add the buffer interface to a vector +template <typename Vector, typename Class_, typename... Args> +enable_if_t<detail::any_of<std::is_same<Args, buffer_protocol>...>::value> vector_buffer(Class_& cl) +{ + using T = typename Vector::value_type; + + static_assert(vector_has_data_and_format<Vector>::value, + "There is not an appropriate format descriptor for this vector"); + + // numpy.h declares this for arbitrary types, but it may raise an exception and crash hard at runtime if + // PYBIND11_NUMPY_DTYPE hasn't been called, so check here + format_descriptor<T>::format(); + + cl.def_buffer([](Vector& v) -> buffer_info { + return buffer_info( + v.data(), static_cast<ssize_t>(sizeof(T)), format_descriptor<T>::format(), 1, {v.size()}, {sizeof(T)}); + }); + + cl.def(init([](buffer buf) { + auto info = buf.request(); + if (info.ndim != 1 || info.strides[0] % static_cast<ssize_t>(sizeof(T))) + throw type_error("Only valid 1D buffers can be copied to a vector"); + if (!detail::compare_buffer_info<T>::compare(info) || (ssize_t)sizeof(T) != info.itemsize) + throw type_error("Format mismatch (Python: " + info.format + " C++: " + format_descriptor<T>::format() + ")"); + + auto vec = std::unique_ptr<Vector>(new Vector()); + vec->reserve((size_t)info.shape[0]); + T* p = static_cast<T*>(info.ptr); + ssize_t step = info.strides[0] / static_cast<ssize_t>(sizeof(T)); + T* end = p + info.shape[0] * step; + for (; p != end; p += step) + vec->push_back(*p); + return vec.release(); + })); + + return; +} + +template <typename Vector, typename Class_, typename... Args> +enable_if_t<!detail::any_of<std::is_same<Args, buffer_protocol>...>::value> vector_buffer(Class_&) +{} + +NAMESPACE_END(detail) + +// +// std::vector +// +template <typename Vector, typename holder_type = std::unique_ptr<Vector>, typename... Args> +class_<Vector, holder_type> bind_vector(handle scope, std::string const& name, Args&&... args) +{ + using Class_ = class_<Vector, holder_type>; + + // If the value_type is unregistered (e.g. a converting type) or is itself registered + // module-local then make the vector binding module-local as well: + using vtype = typename Vector::value_type; + auto vtype_info = detail::get_type_info(typeid(vtype)); + bool local = !vtype_info || vtype_info->module_local; + + Class_ cl(scope, name.c_str(), pybind11::module_local(local), std::forward<Args>(args)...); + + // Declare the buffer interface if a buffer_protocol() is passed in + detail::vector_buffer<Vector, Class_, Args...>(cl); + + cl.def(init<>()); + + // Register copy constructor (if possible) + detail::vector_if_copy_constructible<Vector, Class_>(cl); + + // Register comparison-related operators and functions (if possible) + detail::vector_if_equal_operator<Vector, Class_>(cl); + + // Register stream insertion operator (if possible) + detail::vector_if_insertion_operator<Vector, Class_>(cl, name); + + // Modifiers require copyable vector value type + detail::vector_modifiers<Vector, Class_>(cl); + + // Accessor and iterator; return by value if copyable, otherwise we return by ref + keep-alive + detail::vector_accessor<Vector, Class_>(cl); + + cl.def("__bool__", [](const Vector& v) -> bool { return !v.empty(); }, "Check whether the list is nonempty"); + + cl.def("__len__", &Vector::size); + + +#if 0 + // C++ style functions deprecated, leaving it here as an example + cl.def(init<size_type>()); + + cl.def("resize", + (void (Vector::*) (size_type count)) & Vector::resize, + "changes the number of elements stored"); + + cl.def("erase", + [](Vector &v, SizeType i) { + if (i >= v.size()) + throw index_error(); + v.erase(v.begin() + i); + }, "erases element at index ``i``"); + + cl.def("empty", &Vector::empty, "checks whether the container is empty"); + cl.def("size", &Vector::size, "returns the number of elements"); + cl.def("push_back", (void (Vector::*)(const T&)) &Vector::push_back, "adds an element to the end"); + cl.def("pop_back", &Vector::pop_back, "removes the last element"); + + cl.def("max_size", &Vector::max_size, "returns the maximum possible number of elements"); + cl.def("reserve", &Vector::reserve, "reserves storage"); + cl.def("capacity", &Vector::capacity, "returns the number of elements that can be held in currently allocated storage"); + cl.def("shrink_to_fit", &Vector::shrink_to_fit, "reduces memory usage by freeing unused memory"); + + cl.def("clear", &Vector::clear, "clears the contents"); + cl.def("swap", &Vector::swap, "swaps the contents"); + + cl.def("front", [](Vector &v) { + if (v.size()) return v.front(); + else throw index_error(); + }, "access the first element"); + + cl.def("back", [](Vector &v) { + if (v.size()) return v.back(); + else throw index_error(); + }, "access the last element "); + +#endif + + return cl; +} + + +// +// std::map, std::unordered_map +// + +NAMESPACE_BEGIN(detail) + +/* Fallback functions */ +template <typename, typename, typename... Args> +void map_if_insertion_operator(const Args&...) +{} +template <typename, typename, typename... Args> +void map_assignment(const Args&...) +{} + +// Map assignment when copy-assignable: just copy the value +template <typename Map, typename Class_> +void map_assignment(enable_if_t<std::is_copy_assignable<typename Map::mapped_type>::value, Class_>& cl) +{ + using KeyType = typename Map::key_type; + using MappedType = typename Map::mapped_type; + + cl.def("__setitem__", [](Map& m, const KeyType& k, const MappedType& v) { + auto it = m.find(k); + if (it != m.end()) + it->second = v; + else + m.emplace(k, v); + }); +} + +// Not copy-assignable, but still copy-constructible: we can update the value by erasing and reinserting +template <typename Map, typename Class_> +void map_assignment(enable_if_t<!std::is_copy_assignable<typename Map::mapped_type>::value + && is_copy_constructible<typename Map::mapped_type>::value, + Class_>& cl) +{ + using KeyType = typename Map::key_type; + using MappedType = typename Map::mapped_type; + + cl.def("__setitem__", [](Map& m, const KeyType& k, const MappedType& v) { + // We can't use m[k] = v; because value type might not be default constructable + auto r = m.emplace(k, v); + if (!r.second) { + // value type is not copy assignable so the only way to insert it is to erase it first... + m.erase(r.first); + m.emplace(k, v); + } + }); +} + + +template <typename Map, typename Class_> +auto map_if_insertion_operator(Class_& cl, std::string const& name) + -> decltype(std::declval<std::ostream&>() + << std::declval<typename Map::key_type>() << std::declval<typename Map::mapped_type>(), + void()) +{ + + cl.def("__repr__", + [name](Map& m) { + std::ostringstream s; + s << name << '{'; + bool f = false; + for (auto const& kv : m) { + if (f) + s << ", "; + s << kv.first << ": " << kv.second; + f = true; + } + s << '}'; + return s.str(); + }, + "Return the canonical string representation of this map."); +} + + +NAMESPACE_END(detail) + +template <typename Map, typename holder_type = std::unique_ptr<Map>, typename... Args> +class_<Map, holder_type> bind_map(handle scope, const std::string& name, Args&&... args) +{ + using KeyType = typename Map::key_type; + using MappedType = typename Map::mapped_type; + using Class_ = class_<Map, holder_type>; + + // If either type is a non-module-local bound type then make the map binding non-local as well; + // otherwise (e.g. both types are either module-local or converting) the map will be + // module-local. + auto tinfo = detail::get_type_info(typeid(MappedType)); + bool local = !tinfo || tinfo->module_local; + if (local) { + tinfo = detail::get_type_info(typeid(KeyType)); + local = !tinfo || tinfo->module_local; + } + + Class_ cl(scope, name.c_str(), pybind11::module_local(local), std::forward<Args>(args)...); + + cl.def(init<>()); + + // Register stream insertion operator (if possible) + detail::map_if_insertion_operator<Map, Class_>(cl, name); + + cl.def("__bool__", [](const Map& m) -> bool { return !m.empty(); }, "Check whether the map is nonempty"); + + cl.def("__iter__", + [](Map& m) { return make_key_iterator(m.begin(), m.end()); }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); + + cl.def("items", + [](Map& m) { return make_iterator(m.begin(), m.end()); }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); + + cl.def("__getitem__", + [](Map& m, const KeyType& k) -> MappedType& { + auto it = m.find(k); + if (it == m.end()) + throw key_error(); + return it->second; + }, + return_value_policy::reference_internal // ref + keepalive + ); + + cl.def("__contains__", [](Map& m, const KeyType& k) -> bool { + auto it = m.find(k); + if (it == m.end()) + return false; + return true; + }); + + // Assignment provided only if the type is copyable + detail::map_assignment<Map, Class_>(cl); + + cl.def("__delitem__", [](Map& m, const KeyType& k) { + auto it = m.find(k); + if (it == m.end()) + throw key_error(); + m.erase(it); + }); + + cl.def("__len__", &Map::size); + + return cl; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/dune/xt/CMakeLists.txt b/dune/xt/CMakeLists.txt index f778fcdf09fe4e1ab35beb02bb686a5fce2790bc..54ca7f4ec17371add34511275df3afa7c417fc48 100644 --- a/dune/xt/CMakeLists.txt +++ b/dune/xt/CMakeLists.txt @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2013 - 2017) # René Fritze (2012 - 2016, 2018 - 2019) -# Tobias Leibner (2016, 2018) +# Tobias Leibner (2016, 2018, 2020) # ~~~ add_subdirectory(grid) diff --git a/dune/xt/common/CMakeLists.txt b/dune/xt/common/CMakeLists.txt index fca0b401e8f829cddc2ad8258762eb47086591ec..f3a46b361cafb90d7c89c1d5c0787eb5bb87f520 100644 --- a/dune/xt/common/CMakeLists.txt +++ b/dune/xt/common/CMakeLists.txt @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017 - 2019) # René Fritze (2017 - 2019) -# Tobias Leibner (2017 - 2019) +# Tobias Leibner (2017 - 2020) # ~~~ set(lib_dune_xt_common_sources diff --git a/dune/xt/common/algorithm.hh b/dune/xt/common/algorithm.hh index 5a6a3997d4da055a649fff4b63fd2397040504af..946ac48e0af0fdf9cd69ed2e35e377426ba23c23 100644 --- a/dune/xt/common/algorithm.hh +++ b/dune/xt/common/algorithm.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2017) // René Fritze (2014 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_ALGORITHM_HH #define DUNE_XT_COMMON_ALGORITHM_HH diff --git a/dune/xt/common/bisect.cc b/dune/xt/common/bisect.cc index 8f9a67a5f3513885dd432c360d815692ef98293f..ad9c46e0bb78af32d960dc2749e170cb5265e046 100644 --- a/dune/xt/common/bisect.cc +++ b/dune/xt/common/bisect.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018) // René Fritze (2019) -// Tobias Leibner (2019) +// Tobias Leibner (2019 - 2020) #include <functional> diff --git a/dune/xt/common/bisect.hh b/dune/xt/common/bisect.hh index 89cb12e5f2798caf7b8491b88d0995a77a251756..6c12a79cc63467b195462426af2e7c118557b546 100644 --- a/dune/xt/common/bisect.hh +++ b/dune/xt/common/bisect.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018) // René Fritze (2019) -// Tobias Leibner (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_COMMON_BISECT_HH #define DUNE_XT_COMMON_BISECT_HH diff --git a/dune/xt/common/cblas.cc b/dune/xt/common/cblas.cc index f2ae429cd8389419ce2837dff20ce891fd331527..c9c8167fa7058bcaf35ca8f459ca2b9980d20659 100644 --- a/dune/xt/common/cblas.cc +++ b/dune/xt/common/cblas.cc @@ -1,18 +1,19 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) // René Fritze (2019) +// Tobias Leibner (2020) #include "config.h" #include <cmath> -// Due to probles with old cblas versions, we only use the MKL cblas for the moment. See also +// Due to problems with old cblas versions, we only use the MKL cblas for the moment. See also // https://github.com/dune-community/dune-xt/pull/198. #if HAVE_MKL # include <mkl.h> diff --git a/dune/xt/common/cblas.hh b/dune/xt/common/cblas.hh index 7529ce3b361d17a497d0b7de70d93a062818b98d..28961dd9e97777ec28f6510d2f538a7748a17672 100644 --- a/dune/xt/common/cblas.hh +++ b/dune/xt/common/cblas.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) // René Fritze (2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_BLAS_HH #define DUNE_XT_COMMON_BLAS_HH diff --git a/dune/xt/common/color.cc b/dune/xt/common/color.cc index 97dfb47e4582dd029cea870b0c5af985eb1d7ab2..1662f59dfa2a5dcaf08d534e0ff7a49f0abad250 100644 --- a/dune/xt/common/color.cc +++ b/dune/xt/common/color.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2017) // René Fritze (2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2018) +// Tobias Leibner (2014, 2018, 2020) #include <config.h> #include "color.hh" diff --git a/dune/xt/common/color.hh b/dune/xt/common/color.hh index 739bdc87f3bec26e77e04177cbf7645fc0015e97..e8a80c3258927e0ffad68a71dbfb3a80a043ad7d 100644 --- a/dune/xt/common/color.hh +++ b/dune/xt/common/color.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2012 - 2017) // René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) // Stefan Girke (2012) -// Tobias Leibner (2014) +// Tobias Leibner (2014, 2020) #ifndef DUNE_XT_COMMON_COLOR_HH #define DUNE_XT_COMMON_COLOR_HH diff --git a/dune/xt/common/compiler.hh b/dune/xt/common/compiler.hh index 3c0535b2c02edac34c69244fa18ab32aa482bbc9..91a9c63e9f30bf19cc321d6c84b70f84fa23c31b 100644 --- a/dune/xt/common/compiler.hh +++ b/dune/xt/common/compiler.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2015 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_COMPILER_HH #define DUNE_XT_COMMON_COMPILER_HH diff --git a/dune/xt/common/configuration.cc b/dune/xt/common/configuration.cc index 6c80e3c4f7ecbda8671a17ba96867e89051ae0f6..1c2296dd1149b25fb9fe364709b7ac13627d082e 100644 --- a/dune/xt/common/configuration.cc +++ b/dune/xt/common/configuration.cc @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2013 - 2018) // René Fritze (2013 - 2019) // Sven Kaulmann (2013) -// Tobias Leibner (2014, 2018 - 2019) +// Tobias Leibner (2014, 2018 - 2020) #include "config.h" diff --git a/dune/xt/common/configuration.hh b/dune/xt/common/configuration.hh index 60cf558e82a6a1806663a65031d22ed7d648109c..b2db3b92e18f14f88cfba7ecd2b4b0766eb5289b 100644 --- a/dune/xt/common/configuration.hh +++ b/dune/xt/common/configuration.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ // René Fritze (2012 - 2019) // Sven Kaulmann (2013) // Tim Keil (2018) -// Tobias Leibner (2014, 2016, 2018 - 2019) +// Tobias Leibner (2014, 2016, 2018 - 2020) #ifndef DUNE_XT_COMMON_CONFIGURATION_HH #define DUNE_XT_COMMON_CONFIGURATION_HH diff --git a/dune/xt/common/convergence-study.cc b/dune/xt/common/convergence-study.cc index 4a0b2c4b427c3961cf7197e429a8f292f34b1baa..badc3a1581561ce501df33216d9dd1887dec4173 100644 --- a/dune/xt/common/convergence-study.cc +++ b/dune/xt/common/convergence-study.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2019) // René Fritze (2015 - 2016, 2018 - 2019) -// Tobias Leibner (2019) +// Tobias Leibner (2019 - 2020) #include "config.h" diff --git a/dune/xt/common/convergence-study.hh b/dune/xt/common/convergence-study.hh index 958aae942ffe5b9c40a17756b74856e028a67fd3..5ccbfaf88b376de12ae53ecb8d184e15a7c5c219 100644 --- a/dune/xt/common/convergence-study.hh +++ b/dune/xt/common/convergence-study.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2019) // René Fritze (2014 - 2016, 2018 - 2019) -// Tobias Leibner (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_COMMON_CONVERGENCE_STUDY_HH #define DUNE_XT_COMMON_CONVERGENCE_STUDY_HH diff --git a/dune/xt/common/crtp.hh b/dune/xt/common/crtp.hh index 019501194e178f35a81fa6c0f29f95379b327803..60fb864e78b381bb3d78ae0afaf56d8b27dc8fbc 100644 --- a/dune/xt/common/crtp.hh +++ b/dune/xt/common/crtp.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2018) // René Fritze (2014 - 2016, 2018 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_COMMON_CRTP_HH #define DUNE_XT_COMMON_CRTP_HH diff --git a/dune/xt/common/debug.hh b/dune/xt/common/debug.hh index cf29ead3f82b493d3d56d4f0488c559d846f7182..9a911e4965495db751fe427b0c96caebb1bd3551 100644 --- a/dune/xt/common/debug.hh +++ b/dune/xt/common/debug.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014, 2016 - 2017) // René Fritze (2010 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018 - 2020) #ifndef DUNE_XT_COMMON_DEBUG_HH #define DUNE_XT_COMMON_DEBUG_HH diff --git a/dune/xt/common/densevector.hh b/dune/xt/common/densevector.hh index e3cc04a4fde768f8d104884b59e2a4429360b267..ef2ef3f2ad1f717b742d13b7fc7c647ec1a93361 100644 --- a/dune/xt/common/densevector.hh +++ b/dune/xt/common/densevector.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_DENSEVECTOR_HH #define DUNE_XT_COMMON_DENSEVECTOR_HH diff --git a/dune/xt/common/deprecated.hh b/dune/xt/common/deprecated.hh index 34ff5151e2a72e1ff00a022db0b84272f2599142..f5f2c131501a9de62af9202b4bb8ff51a939ad7c 100644 --- a/dune/xt/common/deprecated.hh +++ b/dune/xt/common/deprecated.hh @@ -1,11 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// René Fritze (2018 - 2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_DEPRECATED_HH #define DUNE_XT_COMMON_DEPRECATED_HH diff --git a/dune/xt/common/disable_warnings.hh b/dune/xt/common/disable_warnings.hh index 14729931a435e177d0de940cb59c53e39f37dc7e..b2f76d08e7db17b53a471dc62c84c09a6ac5641d 100644 --- a/dune/xt/common/disable_warnings.hh +++ b/dune/xt/common/disable_warnings.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Andreas Buhr (2014) // Felix Schindler (2012 - 2014, 2016 - 2017) // René Fritze (2011 - 2012, 2014 - 2019) -// Tobias Leibner (2014, 2016 - 2019) +// Tobias Leibner (2014, 2016 - 2020) #include <boost/config.hpp> diff --git a/dune/xt/common/exceptions.cc b/dune/xt/common/exceptions.cc index a79af662f54bc98e70a74550269f2c1649bc5e1f..ba69a0159cf4af7df3395684bef12771b8b98b29 100644 --- a/dune/xt/common/exceptions.cc +++ b/dune/xt/common/exceptions.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2017 - 2019) -// Tobias Leibner (2017 - 2018) +// Tobias Leibner (2017 - 2018, 2020) #include <config.h> diff --git a/dune/xt/common/exceptions.hh b/dune/xt/common/exceptions.hh index 4300f255d8cbab2230f40f90927026a857271ac2..9c0d787638c3de719b14470f297cee0b33f90dca 100644 --- a/dune/xt/common/exceptions.hh +++ b/dune/xt/common/exceptions.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2013 - 2019) // René Fritze (2014 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014, 2017 - 2019) +// Tobias Leibner (2014, 2017 - 2020) #ifndef DUNE_XT_COMMON_EXCEPTIONS_HH #define DUNE_XT_COMMON_EXCEPTIONS_HH @@ -82,6 +82,12 @@ if (a.size() != b.size()) } \ } while (0) +#ifndef NDEBUG +# define DEBUG_THROW_IF(condition, E, m) DUNE_THROW_IF(condition, E, m) +#else +# define DEBUG_THROW_IF(condition, E, m) (void)0 +#endif + namespace Dune { namespace XT { @@ -131,17 +137,9 @@ class debug_assertion : public Dune::Exception class bisection_error : public wrong_input_given {}; -class DUNE_DEPRECATED_MSG("Use Dune::XT::Functions::Exceptions:;reinterpretation_error (09.04.2018)!") - reinterpretation_error : public Dune::Exception -{}; - class parameter_error : public Dune::Exception {}; -class DXT_DEPRECATED_MSG("moved into dune-xt-functions Dune::XT::Functions::Exceptions (2018/03/16") - spe10_data_file_missing : public Dune::IOError -{}; - class dependency_missing : public Dune::Exception {}; diff --git a/dune/xt/common/filesystem.cc b/dune/xt/common/filesystem.cc index 9aefb730dbed9ea2924548652b57798fdf2f3a28..7b488bc2279a90939e1a31dc42ac8bf1a8fd8904 100644 --- a/dune/xt/common/filesystem.cc +++ b/dune/xt/common/filesystem.cc @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,6 +8,7 @@ // Felix Schindler (2012, 2014, 2016 - 2017) // René Fritze (2010 - 2016, 2018 - 2019) // Sven Kaulmann (2011) +// Tobias Leibner (2020) #include "config.h" @@ -51,14 +52,14 @@ std::unique_ptr<boost::filesystem::ofstream> make_ofstream(const boost::filesyst const std::ios_base::openmode mode) { test_create_directory(path.string()); - return Dune::XT::Common::make_unique<boost::filesystem::ofstream>(path, mode); + return std::make_unique<boost::filesystem::ofstream>(path, mode); } std::unique_ptr<boost::filesystem::ifstream> make_ifstream(const boost::filesystem::path& path, const std::ios_base::openmode mode) { test_create_directory(path.string()); - return Dune::XT::Common::make_unique<boost::filesystem::ifstream>(path, mode); + return std::make_unique<boost::filesystem::ifstream>(path, mode); } //! read a file and output all lines containing filter string to a stream diff --git a/dune/xt/common/filesystem.hh b/dune/xt/common/filesystem.hh index f01cb179cd4a1b9a7878af6d9f8e3e2334906cb8..14f0f9158f1b46e5399978f6d63eb9d9c185694c 100644 --- a/dune/xt/common/filesystem.hh +++ b/dune/xt/common/filesystem.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,6 +8,7 @@ // Felix Schindler (2012, 2014, 2016 - 2017) // René Fritze (2010 - 2016, 2018 - 2019) // Sven Kaulmann (2011) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_FILESYSTEM_HH #define DUNE_XT_COMMON_FILESYSTEM_HH diff --git a/dune/xt/common/fix-ambiguous-std-math-overloads.cc b/dune/xt/common/fix-ambiguous-std-math-overloads.cc index 80d2fd82f70b5b80e06fa65b56fb14af16641d05..b6adccafd774e4ad3847f407c66242039ff0a91c 100644 --- a/dune/xt/common/fix-ambiguous-std-math-overloads.cc +++ b/dune/xt/common/fix-ambiguous-std-math-overloads.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2018) // René Fritze (2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #include "config.h" diff --git a/dune/xt/common/fix-ambiguous-std-math-overloads.hh b/dune/xt/common/fix-ambiguous-std-math-overloads.hh index a3ac7084e16b090b2770ed6a7e2888babda48f47..cab9f4a010ed2399273195ba1d2b08f61b96f9db 100644 --- a/dune/xt/common/fix-ambiguous-std-math-overloads.hh +++ b/dune/xt/common/fix-ambiguous-std-math-overloads.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018 - 2019) // René Fritze (2019) -// Tobias Leibner (2019) +// Tobias Leibner (2019 - 2020) /// \file Should be included before any other DUNE header. /// diff --git a/dune/xt/common/fixed_map.hh b/dune/xt/common/fixed_map.hh index fc2770b822c358276bf911ecb890b40e90e924c3..d2bdbd7aad387cc097e4b9c935aca72bffef8943 100644 --- a/dune/xt/common/fixed_map.hh +++ b/dune/xt/common/fixed_map.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2009, 2012 - 2014, 2016 - 2017) // René Fritze (2009 - 2019) // Sven Kaulmann (2011 - 2012) -// Tobias Leibner (2014, 2016) +// Tobias Leibner (2014, 2016, 2020) #ifndef DUNE_XT_COMMON_FIXED_MAP_HH #define DUNE_XT_COMMON_FIXED_MAP_HH diff --git a/dune/xt/common/float_cmp.hh b/dune/xt/common/float_cmp.hh index 14487d3ac3885bbf916cfe9e5b9f0a785d95b449..c63074fc664e6fc104efe83e9d820361109e7b40 100644 --- a/dune/xt/common/float_cmp.hh +++ b/dune/xt/common/float_cmp.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Barbara Verfürth (2015) // Felix Schindler (2013 - 2018) // René Fritze (2013 - 2016, 2018 - 2019) -// Tobias Leibner (2014 - 2015, 2018) +// Tobias Leibner (2014 - 2015, 2018, 2020) #ifndef DUNE_XT_COMMON_FLOAT_CMP_HH #define DUNE_XT_COMMON_FLOAT_CMP_HH diff --git a/dune/xt/common/float_cmp_generated.hxx b/dune/xt/common/float_cmp_generated.hxx index 40508634db0d0cde46bebb71b29bdee56a5a98fb..179ae701d4de529e05cf7c532e316d0985f1702c 100644 --- a/dune/xt/common/float_cmp_generated.hxx +++ b/dune/xt/common/float_cmp_generated.hxx @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2016, 2018 - 2019) +// Tobias Leibner (2020) template <Style style, class FirstType, class SecondType, class ToleranceType = typename MT<FirstType>::Eps> typename std::enable_if<internal::cmp_type_check<FirstType, SecondType, ToleranceType>::value, bool>::type diff --git a/dune/xt/common/float_cmp_internal.hh b/dune/xt/common/float_cmp_internal.hh index 812804a8c329d6f1de86db9b8d3dbe500ea4bfe0..cf194880c7727920241a182006c4a6cd046d242f 100644 --- a/dune/xt/common/float_cmp_internal.hh +++ b/dune/xt/common/float_cmp_internal.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ // Felix Schindler (2016 - 2017) // René Fritze (2015 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_COMMON_FLOAT_CMP_INTERNAL_HH #define DUNE_XT_COMMON_FLOAT_CMP_INTERNAL_HH diff --git a/dune/xt/common/float_cmp_style.hh b/dune/xt/common/float_cmp_style.hh index 8e6021bb5ce861f8993040eada906f13357e5d54..0844c1c93b9fe3e54f5dbca1445f30cff34e2ec6 100644 --- a/dune/xt/common/float_cmp_style.hh +++ b/dune/xt/common/float_cmp_style.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2015 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_FLOAT_CMP_STYLE_HH #define DUNE_XT_COMMON_FLOAT_CMP_STYLE_HH diff --git a/dune/xt/common/fmatrix.hh b/dune/xt/common/fmatrix.hh index 5b311f6a63395d2b10badcf1d99e7046f2a32239..e8babcdd5a0feaffcc733785d21ab5baadf65b0d 100644 --- a/dune/xt/common/fmatrix.hh +++ b/dune/xt/common/fmatrix.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2014, 2016 - 2018) // René Fritze (2015 - 2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014, 2018 - 2019) +// Tobias Leibner (2014, 2018 - 2020) #ifndef DUNE_XT_COMMON_FMATRIX_HH #define DUNE_XT_COMMON_FMATRIX_HH diff --git a/dune/xt/common/fvector.hh b/dune/xt/common/fvector.hh index f4ab76dcf8fc148e699657d1ac075cc23be00de7..5f834af88066ab40f0563223a557b4100bd5c2b6 100644 --- a/dune/xt/common/fvector.hh +++ b/dune/xt/common/fvector.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2014 - 2017) // René Fritze (2014 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014, 2016 - 2019) +// Tobias Leibner (2014, 2016 - 2020) #ifndef DUNE_XT_COMMON_FVECTOR_HH #define DUNE_XT_COMMON_FVECTOR_HH diff --git a/dune/xt/common/lapacke.cc b/dune/xt/common/lapacke.cc index 5d202cd806a497e39bcf429699f9eb7a2c6b6d47..8cbb03340b95f5421ed1909ed8d6dfae4055ffde 100644 --- a/dune/xt/common/lapacke.cc +++ b/dune/xt/common/lapacke.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) // René Fritze (2018 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #include "config.h" diff --git a/dune/xt/common/lapacke.hh b/dune/xt/common/lapacke.hh index e3380e61b93d0fa89d5856ce29c60e5c7d02171c..082c6cb8b79c8768576c4748599be67a30f9a28c 100644 --- a/dune/xt/common/lapacke.hh +++ b/dune/xt/common/lapacke.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2014, 2016 - 2019) // René Fritze (2011 - 2012, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2017 - 2018) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_COMMON_LAPACKE_HH #define DUNE_XT_COMMON_LAPACKE_HH diff --git a/dune/xt/common/localization-study.cc b/dune/xt/common/localization-study.cc index 3059c06eb8007c88303f5e6b944cd1bed2ac030c..dec48faf19ca34859b5841907ab178e7afa53e52 100644 --- a/dune/xt/common/localization-study.cc +++ b/dune/xt/common/localization-study.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2017) // René Fritze (2015 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #include "config.h" diff --git a/dune/xt/common/localization-study.hh b/dune/xt/common/localization-study.hh index a2113b290a50cbc4a9fefd91e9f3cf37f5cc0e2c..acf139829630d8cf66f907d7783785f03bab4146 100644 --- a/dune/xt/common/localization-study.hh +++ b/dune/xt/common/localization-study.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2017) // René Fritze (2015 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_LOCALIZATION_STUDY_HH #define DUNE_XT_COMMON_LOCALIZATION_STUDY_HH diff --git a/dune/xt/common/logging.cc b/dune/xt/common/logging.cc index 67cb1f79d72aa3b8597efb1f61b7ed2240ed52bb..b964e74a581a1ccadd2b2032af888810cecec112 100644 --- a/dune/xt/common/logging.cc +++ b/dune/xt/common/logging.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2014, 2016 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #include "config.h" @@ -29,7 +30,7 @@ Logging::Logging() , emptyLogStream_(logflags_) { for (const auto id : streamIDs_) - streammap_[id] = Dune::XT::Common::make_unique<EmptyLogStream>(logflags_); + streammap_[id] = std::make_unique<EmptyLogStream>(logflags_); } void Logging::deinit() @@ -67,7 +68,7 @@ void Logging::create(int logflags, const std::string logfile, const std::string for (const auto id : streamIDs_) { flagmap_[id] = logflags; - streammap_[id] = Dune::XT::Common::make_unique<DualLogStream>(id, flagmap_[id], std::cout, logfile_); + streammap_[id] = std::make_unique<DualLogStream>(id, flagmap_[id], std::cout, logfile_); } } // create @@ -120,8 +121,7 @@ int Logging::add_stream(int flags) int streamID = streamID_int; streamIDs_.push_back(streamID); flagmap_[streamID] = (flags | streamID); - streammap_[streamID] = - Dune::XT::Common::make_unique<DualLogStream>(streamID, flagmap_[streamID], std::cout, logfile_); + streammap_[streamID] = std::make_unique<DualLogStream>(streamID, flagmap_[streamID], std::cout, logfile_); return streamID_int; } // add_stream diff --git a/dune/xt/common/logging.hh b/dune/xt/common/logging.hh index a234db318b18a75954cf3b33f5e1e7d0a94b14db..9174af0aaf10958d557b5a558b867d216e053867 100644 --- a/dune/xt/common/logging.hh +++ b/dune/xt/common/logging.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2014, 2016 - 2017) // René Fritze (2009 - 2019) -// Tobias Leibner (2014, 2018) +// Tobias Leibner (2014, 2018, 2020) /** * \file logging.hh diff --git a/dune/xt/common/logstreams.cc b/dune/xt/common/logstreams.cc index 65e5a2ccaf46213e921ff82f6aa2b7e4d9fb18ad..be0ccac10ccd5972f3fc8b8963bc93a8d3f3f91b 100644 --- a/dune/xt/common/logstreams.cc +++ b/dune/xt/common/logstreams.cc @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2014, 2016 - 2017) // René Fritze (2013 - 2016, 2018 - 2019) // Sven Kaulmann (2014) -// Tobias Leibner (2016, 2019) +// Tobias Leibner (2016, 2019 - 2020) #include "config.h" #include "logstreams.hh" diff --git a/dune/xt/common/logstreams.hh b/dune/xt/common/logstreams.hh index c848abda344cfe8e027d231400dd990f43219f1f..56c92509efbc8c6c83829c473abed16ff3c3e0ae 100644 --- a/dune/xt/common/logstreams.hh +++ b/dune/xt/common/logstreams.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2012 - 2014, 2016 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) // Sven Kaulmann (2014) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_COMMON_LOGSTREAMS_HH #define DUNE_XT_COMMON_LOGSTREAMS_HH diff --git a/dune/xt/common/math.cc b/dune/xt/common/math.cc index 011cd9475ed4eb78b75abe1a1db09ea06123b3c7..33c9491c762daf199f4aedacba4af834e2f81362 100644 --- a/dune/xt/common/math.cc +++ b/dune/xt/common/math.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2018) // René Fritze (2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #include "config.h" diff --git a/dune/xt/common/math.hh b/dune/xt/common/math.hh index 24c4276bc0dc2b7d9f6bc5e7ecb50e4c08aada04..bd008519a8146954a09f27b023e3125f575f9179 100644 --- a/dune/xt/common/math.hh +++ b/dune/xt/common/math.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ // Felix Schindler (2012 - 2019) // René Fritze (2010 - 2019) // Sven Kaulmann (2013) -// Tobias Leibner (2014, 2017 - 2019) +// Tobias Leibner (2014, 2017 - 2020) #ifndef DUNE_XT_COMMON_MATH_HH #define DUNE_XT_COMMON_MATH_HH diff --git a/dune/xt/common/matrix.hh b/dune/xt/common/matrix.hh index af9a54dc30562951b6c064fec108c76299577f9b..c4dd5fb2d26736fffce713d0db684ac6bc8bbc6f 100644 --- a/dune/xt/common/matrix.hh +++ b/dune/xt/common/matrix.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ // Felix Schindler (2012 - 2017, 2019) // René Fritze (2010 - 2016, 2018 - 2019) // Sven Kaulmann (2010 - 2011) -// Tobias Leibner (2014, 2017 - 2018) +// Tobias Leibner (2014, 2017 - 2018, 2020) #ifndef DUNE_XT_COMMON_MATRIX_HH #define DUNE_XT_COMMON_MATRIX_HH diff --git a/dune/xt/common/memory.cc b/dune/xt/common/memory.cc index f8bb173c6b7715b93d4a07b37460e019ae441350..7eaca0d55faa77048adff9ab0b88b00f306bb51f 100644 --- a/dune/xt/common/memory.cc +++ b/dune/xt/common/memory.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2017 - 2019) -// Tobias Leibner (2017) +// Tobias Leibner (2017, 2020) #include <config.h> diff --git a/dune/xt/common/memory.hh b/dune/xt/common/memory.hh index 7b02c85822b2b6a8104d0af52a2037eabd0f5ebb..c84c62b399a33a34a484e85fbd23a2c6b7cb7c4d 100644 --- a/dune/xt/common/memory.hh +++ b/dune/xt/common/memory.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014 - 2019) // René Fritze (2011 - 2012, 2014 - 2019) -// Tobias Leibner (2017, 2019) +// Tobias Leibner (2017, 2019 - 2020) #ifndef DUNE_XT_COMMON_MEMORY_HH #define DUNE_XT_COMMON_MEMORY_HH @@ -23,15 +23,6 @@ namespace XT { namespace Common { -//! make_unique implementation via herb sutter: http://herbsutter.com/gotw/_102/ -//! \TODO this can be delegated to stdlib with c++14 -template <typename T, typename... Args> -std::unique_ptr<T> make_unique(Args&&... args) -{ - return std::unique_ptr<T>(new T(std::forward<Args>(args)...)); -} - - //! just like boost::noncopyable, but for move assign/ctor struct nonmoveable { @@ -90,12 +81,12 @@ public: /** * \attention This ctor transfers ownership to ConstAccessByPointer, do not delete tt manually! */ - explicit ConstAccessByPointer(const T*&& tt) + explicit ConstAccessByPointer(T* tt) : tt_(tt) {} explicit ConstAccessByPointer(std::unique_ptr<const T>&& tt) - : tt_(tt) + : tt_(std::move(tt)) {} explicit ConstAccessByPointer(std::shared_ptr<const T> tt) @@ -116,6 +107,27 @@ private: std::shared_ptr<const T> tt_; }; // class ConstAccessByPointer +template <class T> +class ConstAccessByValue : public ConstAccessInterface<T> +{ +public: + explicit ConstAccessByValue(T&& tt) + : tt_(tt) + {} + + const T& access() const override final + { + return tt_; + } + + ConstAccessInterface<T>* copy() const override final + { + return new ConstAccessByValue<T>(T(tt_)); + } + +private: + const T tt_; +}; // class ConstAccessByValue template <class T> class AccessInterface @@ -174,7 +186,7 @@ public: {} explicit AccessByPointer(std::unique_ptr<T>&& tt) - : tt_(tt) + : tt_(std::move(tt)) {} explicit AccessByPointer(std::shared_ptr<T> tt) @@ -200,6 +212,32 @@ private: std::shared_ptr<T> tt_; }; // class AccessByPointer +template <class T> +class AccessByValue : public ConstAccessInterface<T> +{ +public: + explicit AccessByValue(T&& tt) + : tt_(tt) + {} + + const T& access() const override final + { + return tt_; + } + + T& access() override final + { + return tt_; + } + + AccessInterface<T>* copy() const override final + { + return new AccessByValue<T>(T(tt_)); + } + +private: + T tt_; +}; // class AccessByValue } // namespace internal @@ -276,15 +314,14 @@ public: /** * \attention This ctor transfers ownership to ConstStorageProvider, do not delete tt manually! */ - explicit ConstStorageProvider(const T*&& tt) - : storage_(new internal::ConstAccessByPointer<T>(std::move(tt))) + explicit ConstStorageProvider(T*&& tt) + : storage_(new internal::ConstAccessByPointer<T>(tt)) {} - /** - * \attention This ctor transfers ownership to ConstStorageProvider, do not delete tt manually! - */ - explicit ConstStorageProvider(T*&& tt) - : storage_(new internal::ConstAccessByPointer<T>(std::move(tt))) + // We have to disable this constructor if T is not a complete type to avoid compilation failures + template <class S, typename std::enable_if_t<std::is_constructible<T, S&&>::value, bool> = true> + explicit ConstStorageProvider(S&& tt) + : storage_(new internal::ConstAccessByValue<T>(std::move(tt))) {} explicit ConstStorageProvider(std::shared_ptr<const T> tt) @@ -292,7 +329,7 @@ public: {} explicit ConstStorageProvider(std::unique_ptr<const T>&& tt) - : storage_(tt) + : storage_(new internal::ConstAccessByPointer<T>(std::move(tt))) {} ConstStorageProvider(const ConstStorageProvider<T>& other) @@ -362,6 +399,10 @@ public: : storage_(new internal::AccessByPointer<T>(std::move(tt))) {} + explicit StorageProvider(T&& tt) + : storage_(new internal::ConstAccessByValue<T>(std::move(tt))) + {} + explicit StorageProvider(std::shared_ptr<T> tt) : storage_(new internal::AccessByPointer<T>(tt)) {} diff --git a/dune/xt/common/misc.cc b/dune/xt/common/misc.cc index 6b5a5f256bcb0098534bbda80b7e8e9b85f505d0..555c53a28ce049c669db3ea2eff6d90d2b66a1ac 100644 --- a/dune/xt/common/misc.cc +++ b/dune/xt/common/misc.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2015 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/common/misc.hh b/dune/xt/common/misc.hh index 26d92c1f4c23648270989393c9e7c981009cf8c1..fed29dbff3412d524d04bc8014ff85b0920b9e1d 100644 --- a/dune/xt/common/misc.hh +++ b/dune/xt/common/misc.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ // Felix Schindler (2009, 2012 - 2017) // René Fritze (2009 - 2016, 2018 - 2019) // Sven Kaulmann (2011 - 2012) -// Tobias Leibner (2014, 2018) +// Tobias Leibner (2014, 2018, 2020) #ifndef DUNE_XT_COMMON_MISC_HH #define DUNE_XT_COMMON_MISC_HH diff --git a/dune/xt/common/mkl.cc b/dune/xt/common/mkl.cc index 98cc4468e2b75ebcca751a4b27f5e05be67d97df..8c9c231000e9fefce46eb2777bc11a86c96533b9 100644 --- a/dune/xt/common/mkl.cc +++ b/dune/xt/common/mkl.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2019) // René Fritze (2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #include "config.h" diff --git a/dune/xt/common/mkl.hh b/dune/xt/common/mkl.hh index f85cfb0db7b7fc688eff881e5ba0d3e8c80ce3a1..5488df8001bcc0cf03855959b5191056e43b77b3 100644 --- a/dune/xt/common/mkl.hh +++ b/dune/xt/common/mkl.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2019) // René Fritze (2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #ifndef DUNE_XT_COMMON_MKL_HH #define DUNE_XT_COMMON_MKL_HH diff --git a/dune/xt/common/numeric.hh b/dune/xt/common/numeric.hh index 38fb0ca977ca1767b4bc1c915fcc43720d3167f2..3071b4e5d2730ec9c305c892edfa40e6c51a120c 100644 --- a/dune/xt/common/numeric.hh +++ b/dune/xt/common/numeric.hh @@ -1,19 +1,21 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Tobias Leibner (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_COMMON_NUMERIC_HH #define DUNE_XT_COMMON_NUMERIC_HH +#if defined(__has_include) && __has_include(<version>) +# include <version> +#endif // C++17 parallel TS features -#if defined(__has_include) && defined(__cpp_lib_execution) && defined(__cpp_lib_parallel_algorithm) -# define CPP17_PARALLELISM_TS_SUPPORTED \ - __has_include(<execution>) && __cpp_lib_execution >= 201603 && __cpp_lib_parallel_algorithm >= 201603 +#if defined(__has_include) && (defined(__cpp_lib_execution) || __has_include(<execution>)) && defined(__cpp_lib_parallel_algorithm) +# define CPP17_PARALLELISM_TS_SUPPORTED __has_include(<execution>) && __cpp_lib_parallel_algorithm >= 201603 #else # define CPP17_PARALLELISM_TS_SUPPORTED 0 #endif @@ -25,43 +27,23 @@ namespace XT { namespace Common { -template <class InputIt, class T> -T reduce(InputIt first, InputIt last, T init) -{ -#if CPP17_PARALLELISM_TS_SUPPORTED - return std::reduce(first, last, init); -#else - return std::accumulate(first, last, init); -#endif -} - -template <class InputIt, class T, class BinaryOp> -T reduce(InputIt first, InputIt last, T init, BinaryOp binary_op) -{ -#if CPP17_PARALLELISM_TS_SUPPORTED - return std::reduce(first, last, init, binary_op); -#else - return std::accumulate(first, last, init, binary_op); -#endif -} - -template <class InputIt1, class InputIt2, class T> -T transform_reduce(InputIt1 first1, InputIt1 last1, InputIt2 first2, T init) +template <class... Args> +decltype(auto) reduce(Args&&... args) { #if CPP17_PARALLELISM_TS_SUPPORTED - return std::transform_reduce(first1, last1, first2, init); + return std::reduce(std::forward<Args>(args)...); #else - return std::inner_product(first1, last1, first2, init); + return std::accumulate(std::forward<Args>(args)...); #endif } -template <class InputIt1, class InputIt2, class T, class BinaryOp1, class BinaryOp2> -T transform_reduce(InputIt1 first1, InputIt1 last1, InputIt2 first2, T init, BinaryOp1 binary_op1, BinaryOp2 binary_op2) +template <class... Args> +decltype(auto) transform_reduce(Args&&... args) { #if CPP17_PARALLELISM_TS_SUPPORTED - return std::transform_reduce(first1, last1, first2, init, binary_op1, binary_op2); + return std::transform_reduce(std::forward<Args>(args)...); #else - return std::inner_product(first1, last1, first2, init, binary_op1, binary_op2); + return std::inner_product(std::forward<Args>(args)...); #endif } diff --git a/dune/xt/common/numeric_cast.hh b/dune/xt/common/numeric_cast.hh index 8eb6227200966623f73791b24d288ae87568b5a0..90fea9d24219928eda6570d32358a6c8492b8ba8 100644 --- a/dune/xt/common/numeric_cast.hh +++ b/dune/xt/common/numeric_cast.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2018 - 2019) -// Tobias Leibner (2017) +// Tobias Leibner (2017, 2020) #ifndef DUNE_XT_COMMON_NUMERIC_CAST_HH #define DUNE_XT_COMMON_NUMERIC_CAST_HH diff --git a/dune/xt/common/parallel/communicator.cc b/dune/xt/common/parallel/communicator.cc index 991b924c8126d84afd795c14dd2d76c395d75b25..98346978e8af9a3e8b0ac99648cb5c3b01acd4d7 100644 --- a/dune/xt/common/parallel/communicator.cc +++ b/dune/xt/common/parallel/communicator.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2018) // René Fritze (2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #include "config.h" diff --git a/dune/xt/common/parallel/communicator.hh b/dune/xt/common/parallel/communicator.hh index 35f7f00c7745cf4de1d1087c03435d1f0a866a92..e883412c51685429f0af05eed46e784776c5891e 100644 --- a/dune/xt/common/parallel/communicator.hh +++ b/dune/xt/common/parallel/communicator.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2018) // René Fritze (2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #ifndef DUNE_XT_COMMON_PARALLEL_COMMUNICATOR_HH #define DUNE_XT_COMMON_PARALLEL_COMMUNICATOR_HH diff --git a/dune/xt/common/parallel/helper.cc b/dune/xt/common/parallel/helper.cc index fad5d779cc1523ad3157f3fdb185efa09e64edad..3dad08dd0ff2555e7d65c8814955627bfea52ecc 100644 --- a/dune/xt/common/parallel/helper.cc +++ b/dune/xt/common/parallel/helper.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2014, 2016 - 2017) // René Fritze (2011 - 2012, 2014 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/common/parallel/helper.hh b/dune/xt/common/parallel/helper.hh index ea9b75127cbec6bd799892019739ceabd668b658..6123550df6bdf0c0680c4747336aa662649c802d 100644 --- a/dune/xt/common/parallel/helper.hh +++ b/dune/xt/common/parallel/helper.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2017) // René Fritze (2014 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2019) +// Tobias Leibner (2014, 2019 - 2020) #ifndef DUNE_XT_COMMON_PARALLEL_HELPER_HH #define DUNE_XT_COMMON_PARALLEL_HELPER_HH diff --git a/dune/xt/common/parallel/mpi_comm_wrapper.cc b/dune/xt/common/parallel/mpi_comm_wrapper.cc index d8d2795c0130f09a5f19988de9dc1c40f93a840f..cd0f8a030515507827dc47779d8d5742af7e69b7 100644 --- a/dune/xt/common/parallel/mpi_comm_wrapper.cc +++ b/dune/xt/common/parallel/mpi_comm_wrapper.cc @@ -1,11 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// René Fritze (2018 - 2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> #include "dune/xt/common/parallel/mpi_comm_wrapper.hh" diff --git a/dune/xt/common/parallel/mpi_comm_wrapper.hh b/dune/xt/common/parallel/mpi_comm_wrapper.hh index 0545a658ece47af0e92c50333ac7d3c25d979b05..b30cce326cae86392f4243910866d7359f66b4a7 100644 --- a/dune/xt/common/parallel/mpi_comm_wrapper.hh +++ b/dune/xt/common/parallel/mpi_comm_wrapper.hh @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // René Fritze (2018 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018 - 2020) #ifndef DUNE_XT_COMMON_MPI_COMM_WRAPPER_HH #define DUNE_XT_COMMON_MPI_COMM_WRAPPER_HH diff --git a/dune/xt/common/parallel/partitioner.hh b/dune/xt/common/parallel/partitioner.hh index 15f63556cd8f459dffe4a94b7a138eb91bcad62b..ebfaf43258363120dff535375ce084feb4f63946 100644 --- a/dune/xt/common/parallel/partitioner.hh +++ b/dune/xt/common/parallel/partitioner.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2014 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_PARALLEL_PARTITIONER_HH #define DUNE_XT_COMMON_PARALLEL_PARTITIONER_HH diff --git a/dune/xt/common/parallel/threadmanager.cc b/dune/xt/common/parallel/threadmanager.cc index e0c743ad4457a6db1ac74a70ac072b203283bd4f..45bc26ef70b8ebb022c3e08902275851a317abd9 100644 --- a/dune/xt/common/parallel/threadmanager.cc +++ b/dune/xt/common/parallel/threadmanager.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2017) // René Fritze (2013 - 2016, 2018 - 2019) -// Tobias Leibner (2014 - 2016, 2018) +// Tobias Leibner (2014 - 2016, 2018, 2020) #include "config.h" diff --git a/dune/xt/common/parallel/threadmanager.hh b/dune/xt/common/parallel/threadmanager.hh index 3ec8f8b6df3033c1eb68eb83098243ce99fc8e7a..d8b2fb4e1006ffa117557c27d37027e451fd9005 100644 --- a/dune/xt/common/parallel/threadmanager.hh +++ b/dune/xt/common/parallel/threadmanager.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2017) // René Fritze (2013 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_THREADMANAGER_HH #define DUNE_XT_COMMON_THREADMANAGER_HH diff --git a/dune/xt/common/parallel/threadstorage.hh b/dune/xt/common/parallel/threadstorage.hh index 7d252bba0c3f853b0c433fb3ba51cf5bb9fb8a5b..feb129fdb9d191402225c6ae79c5284303387aa0 100644 --- a/dune/xt/common/parallel/threadstorage.hh +++ b/dune/xt/common/parallel/threadstorage.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2019) // René Fritze (2013 - 2016, 2018 - 2019) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #ifndef DUNE_XT_COMMON_PARALLEL_THREADSTORAGE_HH #define DUNE_XT_COMMON_PARALLEL_THREADSTORAGE_HH diff --git a/dune/xt/common/parameter.cc b/dune/xt/common/parameter.cc index c96fd029574e13981772b592fa13aa70a326c46f..614fb2b595b872aa005eefcec88d4937d71eea74 100644 --- a/dune/xt/common/parameter.cc +++ b/dune/xt/common/parameter.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) // René Fritze (2018 - 2019) -// Tobias Leibner (2017 - 2018) +// Tobias Leibner (2017 - 2018, 2020) #include "config.h" @@ -192,7 +192,7 @@ bool Parameter::operator<(const Parameter& other) const ParameterType Parameter::type() const { ParameterType ret; - for (const auto key_value_pairs : dict_) + for (const auto& key_value_pairs : dict_) ret.set(key_value_pairs.first, key_value_pairs.second.size()); return ret; } diff --git a/dune/xt/common/parameter.hh b/dune/xt/common/parameter.hh index 2008a567469784bbb579f1171ffb1ac3a72766a2..3ab963d15b600b79563ad7a148eb85fb8029f665 100644 --- a/dune/xt/common/parameter.hh +++ b/dune/xt/common/parameter.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) // René Fritze (2017 - 2019) -// Tobias Leibner (2017 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_COMMON_PARAMETER_HH #define DUNE_XT_COMMON_PARAMETER_HH diff --git a/dune/xt/common/print.hh b/dune/xt/common/print.hh index 7e7867c9b1c85c8f873377682efd01705db2c0ff..8525bcb607b027103a2ccefce69dfc6f4156282a 100644 --- a/dune/xt/common/print.hh +++ b/dune/xt/common/print.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2010, 2012 - 2017) // René Fritze (2009 - 2016, 2018 - 2019) // Sven Kaulmann (2011 - 2012) -// Tobias Leibner (2014, 2018) +// Tobias Leibner (2014, 2018, 2020) #ifndef DUNE_XT_COMMON_PRINT_HH #define DUNE_XT_COMMON_PRINT_HH diff --git a/dune/xt/common/python.cc b/dune/xt/common/python.cc index 67ba4f01eec8f2a847a1e9a8412d8e682780fd4c..acd117ff24609f1c7db763103723e1494021bb1b 100644 --- a/dune/xt/common/python.cc +++ b/dune/xt/common/python.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017, 2019) // René Fritze (2018 - 2019) -// Tobias Leibner (2017) +// Tobias Leibner (2017, 2020) #include <config.h> diff --git a/dune/xt/common/python.hh b/dune/xt/common/python.hh index 13fb9436bec55e1b3bb52adcc879ecb21450ef02..e24afca6b52e31184becc56c9864b7c5d35eb75f 100644 --- a/dune/xt/common/python.hh +++ b/dune/xt/common/python.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) // René Fritze (2018 - 2019) +// Tobias Leibner (2020) // // Created by r_milk01 on 4/25/18. diff --git a/dune/xt/common/random.hh b/dune/xt/common/random.hh index a846eb9bac9ec750276cb07d9c599432f71aee43..38ae3bb8820654e49227ba9e1faa210009a737a4 100644 --- a/dune/xt/common/random.hh +++ b/dune/xt/common/random.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2017) // René Fritze (2012 - 2019) -// Tobias Leibner (2014) +// Tobias Leibner (2014, 2020) #ifndef DUNE_XT_COMMON_RANDOM_HH #define DUNE_XT_COMMON_RANDOM_HH diff --git a/dune/xt/common/ranges.hh b/dune/xt/common/ranges.hh index 0eb3823c3400332afca9948a1c1bc985f6c821a5..38d8f5f68a1f5bfc04166df54096d38b2b114309 100644 --- a/dune/xt/common/ranges.hh +++ b/dune/xt/common/ranges.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2012 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) // Sven Kaulmann (2012 - 2013) -// Tobias Leibner (2014, 2018) +// Tobias Leibner (2014, 2018, 2020) #ifndef DUNE_XT_COMMON_RANGES_HH #define DUNE_XT_COMMON_RANGES_HH diff --git a/dune/xt/common/reenable_warnings.hh b/dune/xt/common/reenable_warnings.hh index 3415fdf5f9ff57a972454e4f8127df5ea19df3ec..8db2790c4c94eff7c126b57a8c4ecf7b97400fd3 100644 --- a/dune/xt/common/reenable_warnings.hh +++ b/dune/xt/common/reenable_warnings.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2014, 2016 - 2017) // René Fritze (2011 - 2012, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #ifdef __GNUC__ # pragma GCC diagnostic pop diff --git a/dune/xt/common/signals.cc b/dune/xt/common/signals.cc index a96a0cc1417c56630844f798a580c401f18133e2..bc3d5c9421e3e90fa2cb3be33665b871f7d99a0d 100644 --- a/dune/xt/common/signals.cc +++ b/dune/xt/common/signals.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2017) // René Fritze (2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #include "config.h" diff --git a/dune/xt/common/signals.hh b/dune/xt/common/signals.hh index 0235d6a336cf4d1e82e9cb053f56e7e97c29f721..1225c0ad93f3685a273647064d9177487190830f 100644 --- a/dune/xt/common/signals.hh +++ b/dune/xt/common/signals.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014, 2016 - 2017) // René Fritze (2010, 2012 - 2013, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_SIGNALS #define DUNE_XT_COMMON_SIGNALS diff --git a/dune/xt/common/string.cc b/dune/xt/common/string.cc index 51efeaaa816b27365481bf7e7d2914eacd1c7324..31f9204de2b7880b5a65bcaef6906b51e44b6cfe 100644 --- a/dune/xt/common/string.cc +++ b/dune/xt/common/string.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2017) // René Fritze (2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018 - 2020) #include <config.h> diff --git a/dune/xt/common/string.hh b/dune/xt/common/string.hh index 601b71465d7c1e4b829c424f6f4a5ffb78cf4532..5f16a9435e78d76cbd822466588c284f542b106f 100644 --- a/dune/xt/common/string.hh +++ b/dune/xt/common/string.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ // Felix Schindler (2009, 2012 - 2018) // René Fritze (2009 - 2016, 2018 - 2019) // Sven Kaulmann (2011 - 2012) -// Tobias Leibner (2014, 2017 - 2018) +// Tobias Leibner (2014, 2017 - 2020) /** * \file string.hh diff --git a/dune/xt/common/string_internal.hh b/dune/xt/common/string_internal.hh index 31be118dd4a8e41ae164b5940a02727cb70424c3..133396ce5037efc0da95f2d919caf580a2f07c92 100644 --- a/dune/xt/common/string_internal.hh +++ b/dune/xt/common/string_internal.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ // Felix Schindler (2009, 2012 - 2018) // René Fritze (2009 - 2016, 2018 - 2019) // Sven Kaulmann (2011 - 2012) -// Tobias Leibner (2014 - 2015, 2017 - 2019) +// Tobias Leibner (2014 - 2015, 2017 - 2020) #ifndef DUNE_XT_COMMON_STRING_INTERNAL_HH #define DUNE_XT_COMMON_STRING_INTERNAL_HH diff --git a/dune/xt/common/timedlogging.cc b/dune/xt/common/timedlogging.cc index 689ceb17e0a12a78fae308ab5de54fab5a6dfb2a..e1245eb3daba394bff8db9ef0d34dc63c4afe65b 100644 --- a/dune/xt/common/timedlogging.cc +++ b/dune/xt/common/timedlogging.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2014, 2016 - 2017, 2019) // René Fritze (2012 - 2016, 2018 - 2019) -// Tobias Leibner (2016) +// Tobias Leibner (2016, 2020) #include "config.h" diff --git a/dune/xt/common/timedlogging.hh b/dune/xt/common/timedlogging.hh index 81a101ddffb987eed3d2af37f8157f6ba04910de..493cb23f6ef22d911f0d90f9285296de215aa824 100644 --- a/dune/xt/common/timedlogging.hh +++ b/dune/xt/common/timedlogging.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2014, 2016 - 2019) // René Fritze (2009 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2017 - 2018) +// Tobias Leibner (2014, 2017 - 2018, 2020) /** * \file logging.hh diff --git a/dune/xt/common/timings.cc b/dune/xt/common/timings.cc index 9f67cc2bc5b9899f57ed0b7eab48273ea8b3a868..d8124eed6def31b684e4b0ec06cd38224fb13ab2 100644 --- a/dune/xt/common/timings.cc +++ b/dune/xt/common/timings.cc @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2013 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) // Sven Kaulmann (2013) -// Tobias Leibner (2014, 2018) +// Tobias Leibner (2014, 2018, 2020) #include "config.h" #include "timings.hh" diff --git a/dune/xt/common/timings.hh b/dune/xt/common/timings.hh index d7400c033b13d7bbc58913075946cbb998f793bb..e5efc72237eb8e4f4d394eb5c9527ae8bd748ac1 100644 --- a/dune/xt/common/timings.hh +++ b/dune/xt/common/timings.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2012, 2014 - 2017) // René Fritze (2009 - 2016, 2018 - 2019) // Sven Kaulmann (2011) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_COMMON_PROFILER_HH #define DUNE_XT_COMMON_PROFILER_HH @@ -17,6 +17,10 @@ # define DUNE_XT_COMMON_DO_PROFILE 0 #endif +#ifndef DUNE_XT_COMMON_DO_TIMING +# define DUNE_XT_COMMON_DO_TIMING 0 +#endif + #include <string> #include <map> #include <vector> diff --git a/dune/xt/common/tuple.hh b/dune/xt/common/tuple.hh index 7206b267c69e29b872b8a0ec3d8d125bd191f72f..863424c0348fca1c0aa4c0b7776013b5ce08004d 100644 --- a/dune/xt/common/tuple.hh +++ b/dune/xt/common/tuple.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2012, 2014 - 2017) // René Fritze (2010 - 2013, 2015 - 2016, 2018 - 2019) // Stefan Girke (2012) -// Tobias Leibner (2014, 2016 - 2018) +// Tobias Leibner (2014, 2016 - 2018, 2020) #ifndef DUNE_XT_COMMON_TUPLE_HH #define DUNE_XT_COMMON_TUPLE_HH diff --git a/dune/xt/common/type_traits.hh b/dune/xt/common/type_traits.hh index d31555c8e72ab59d1d18284d20b12b6790743e32..eb7b179e19fc3ac0a421cebf1b79bda1008b7e94 100644 --- a/dune/xt/common/type_traits.hh +++ b/dune/xt/common/type_traits.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2018) // René Fritze (2012 - 2019) -// Tobias Leibner (2016, 2018) +// Tobias Leibner (2016, 2018 - 2020) #ifndef DUNE_XT_COMMON_TYPE_TRAITS_HH #define DUNE_XT_COMMON_TYPE_TRAITS_HH @@ -25,6 +25,7 @@ #include <dune/common/typetraits.hh> #include <dune/common/unused.hh> +#include <dune/xt/common/exceptions.hh> /** use this to define Typename specializations in the GLOBAL namespace ONLY **/ #define DUNE_XT_COMMON_TYPENAME(NAME) \ diff --git a/dune/xt/common/unused.hh b/dune/xt/common/unused.hh index 633a30cbe3604aeeac1adf2865ffcc825479f493..21d1c0936a0feb11efe9d2ae3ccc21cca4d77b07 100644 --- a/dune/xt/common/unused.hh +++ b/dune/xt/common/unused.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2015 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #ifndef DXTC_UNUSED_HH #define DXTC_UNUSED_HH diff --git a/dune/xt/common/validation.hh b/dune/xt/common/validation.hh index 72d62d7f384481948755416ab4bd37c6c4adf575..7dc92c0c8e7f26b3c0777bcbfdff4634c3e49d35 100644 --- a/dune/xt/common/validation.hh +++ b/dune/xt/common/validation.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014, 2016 - 2017) // René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2014) +// Tobias Leibner (2014, 2020) #ifndef DUNE_XT_COMMON_VALIDATION_HH #define DUNE_XT_COMMON_VALIDATION_HH diff --git a/dune/xt/common/vector.hh b/dune/xt/common/vector.hh index edb152c42f1d92ebb5802c9403948e95e1516a03..17931b6f5b52fac833cbd3a8f476c0dd85c2e1fe 100644 --- a/dune/xt/common/vector.hh +++ b/dune/xt/common/vector.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ // Felix Schindler (2012 - 2017, 2019) // René Fritze (2012 - 2019) // Sven Kaulmann (2013) -// Tobias Leibner (2014 - 2019) +// Tobias Leibner (2014 - 2020) #ifndef DUNE_XT_COMMON_VECTOR_HH #define DUNE_XT_COMMON_VECTOR_HH diff --git a/dune/xt/common/vector_less.hh b/dune/xt/common/vector_less.hh index ad0735a8a46c347ae9e5d18393fb083a267e7a9e..7cc5d49468581b48af8d14cbc323ecf3d7e23d95 100644 --- a/dune/xt/common/vector_less.hh +++ b/dune/xt/common/vector_less.hh @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // René Fritze (2019) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #ifndef DUNE_XT_COMMON_VECTOR_LESS_HH #define DUNE_XT_COMMON_VECTOR_LESS_HH diff --git a/dune/xt/common/vector_statistics.hh b/dune/xt/common/vector_statistics.hh index 36252ab07299a63919271118eb48220985865b82..d474f72b31fae819c1c3b5fcebc7ce7b5e78c428 100644 --- a/dune/xt/common/vector_statistics.hh +++ b/dune/xt/common/vector_statistics.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2017 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_VECTOR_STATISTICS_HH #define DUNE_XT_COMMON_VECTOR_STATISTICS_HH diff --git a/dune/xt/functions/CMakeLists.txt b/dune/xt/functions/CMakeLists.txt index e2bea24be78ef66f8cfa7977c36060496e7b2543..4c209fc409b795c0cc641f118d32ebbde53b244a 100644 --- a/dune/xt/functions/CMakeLists.txt +++ b/dune/xt/functions/CMakeLists.txt @@ -1,7 +1,7 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ # Felix Schindler (2016 - 2017) # René Fritze (2016, 2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2016, 2018) +# Tobias Leibner (2016, 2018 - 2020) # ~~~ set(lib_dune_xt_functions_sources expression/mathexpr.cc) diff --git a/dune/xt/functions/ESV2007.hh b/dune/xt/functions/ESV2007.hh index df0af2edc6778ab675a7dc94790057e5d3a34cce..09b21467f02cd9924c32acc964c8a164724595f8 100644 --- a/dune/xt/functions/ESV2007.hh +++ b/dune/xt/functions/ESV2007.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2018) -// René Fritze (2014 - 2016, 2018) +// René Fritze (2014 - 2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014 - 2018) +// Tobias Leibner (2014 - 2020) #ifndef DUNEXT_FUNCTIONS_ESV2007_HH #define DUNEXT_FUNCTIONS_ESV2007_HH diff --git a/dune/xt/functions/base/combined-element-functions.hh b/dune/xt/functions/base/combined-element-functions.hh index 7b6d1a429e635793f0cd575bf1f18c7592bd2fe0..637d3f6dd428478c26228b5e46903375b3613c94 100644 --- a/dune/xt/functions/base/combined-element-functions.hh +++ b/dune/xt/functions/base/combined-element-functions.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_BASE_COMBINED_ELEMENT_FUNCTIONS_HH #define DUNE_XT_FUNCTIONS_BASE_COMBINED_ELEMENT_FUNCTIONS_HH diff --git a/dune/xt/functions/base/combined-functions.hh b/dune/xt/functions/base/combined-functions.hh index b7567b350d455fdf60a4ad43f7b9cb3487e5d206..a6580b0b21b04a52a842531383603a1868ee7a23 100644 --- a/dune/xt/functions/base/combined-functions.hh +++ b/dune/xt/functions/base/combined-functions.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #ifndef DUNE_XT_FUNCTIONS_BASE_COMBINED_FUNCTIONS_HH #define DUNE_XT_FUNCTIONS_BASE_COMBINED_FUNCTIONS_HH diff --git a/dune/xt/functions/base/combined-grid-functions.hh b/dune/xt/functions/base/combined-grid-functions.hh index d70763786971f379f32f28bd3e9e780dcd0939f9..aabcbb9041ff75680af6cd4d24c3d95291687d01 100644 --- a/dune/xt/functions/base/combined-grid-functions.hh +++ b/dune/xt/functions/base/combined-grid-functions.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #ifndef DUNE_XT_FUNCTIONS_BASE_COMBINED_GRID_FUNCTIONS_HH #define DUNE_XT_FUNCTIONS_BASE_COMBINED_GRID_FUNCTIONS_HH @@ -376,34 +376,34 @@ public: using LocalFunctionType = typename BaseType::LocalFunctionType; CombinedGridFunction(const LeftType& left, const RightType& right, const std::string nm = "") - : left_(Common::make_unique<LeftStorageType>(left)) - , right_(Common::make_unique<RightStorageType>(right)) + : left_(std::make_unique<LeftStorageType>(left)) + , right_(std::make_unique<RightStorageType>(right)) , name_(get_name(left_->access(), right_->access(), nm)) {} CombinedGridFunction(const std::shared_ptr<const LeftType> left, const std::shared_ptr<const RightType> right, const std::string nm = "") - : left_(Common::make_unique<LeftStorageType>(left)) - , right_(Common::make_unique<RightStorageType>(right)) + : left_(std::make_unique<LeftStorageType>(left)) + , right_(std::make_unique<RightStorageType>(right)) , name_(get_name(left_->access(), right_->access(), nm)) {} CombinedGridFunction(const LeftType& left, const std::shared_ptr<const RightType> right, const std::string nm = "") - : left_(Common::make_unique<LeftStorageType>(left)) - , right_(Common::make_unique<RightStorageType>(right)) + : left_(std::make_unique<LeftStorageType>(left)) + , right_(std::make_unique<RightStorageType>(right)) , name_(get_name(left_->access(), right_->access(), nm)) {} CombinedGridFunction(const std::shared_ptr<const LeftType> left, const RightType& right, const std::string nm = "") - : left_(Common::make_unique<LeftStorageType>(left)) - , right_(Common::make_unique<RightStorageType>(right)) + : left_(std::make_unique<LeftStorageType>(left)) + , right_(std::make_unique<RightStorageType>(right)) , name_(get_name(left_->access(), right_->access(), nm)) {} CombinedGridFunction(LeftType*&& left, RightType*&& right, const std::string nm = "") - : left_(Common::make_unique<LeftStorageType>(std::move(left))) - , right_(Common::make_unique<RightStorageType>(std::move(right))) + : left_(std::make_unique<LeftStorageType>(std::move(left))) + , right_(std::make_unique<RightStorageType>(std::move(right))) , name_(get_name(left_->access(), right_->access(), nm)) {} @@ -420,7 +420,7 @@ public: using RealLocalFunctionType = CombinedLocalFunction<LeftType, RightType, comb>; assert(left_); assert(right_); - return Common::make_unique<RealLocalFunctionType>(left_->access(), right_->access()); + return std::make_unique<RealLocalFunctionType>(left_->access(), right_->access()); } // ... local_function(...) std::string name() const override final diff --git a/dune/xt/functions/base/composition.hh b/dune/xt/functions/base/composition.hh index f128e6a10c63bcb255d971a256c788876eb464f0..4701fe3808dcc660ab0f326ad462057c569ea91e 100644 --- a/dune/xt/functions/base/composition.hh +++ b/dune/xt/functions/base/composition.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2016 - 2018) +// René Fritze (2016 - 2019) // Tim Keil (2018) -// Tobias Leibner (2016 - 2017) +// Tobias Leibner (2016 - 2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_COMPOSITION_HH #define DUNE_XT_FUNCTIONS_COMPOSITION_HH @@ -254,7 +254,7 @@ public: std::unique_ptr<LocalFunctionType> local_function() const override final { - return Common::make_unique<ElementFunction>(inner_function_, outer_function_, element_search_); + return std::make_unique<ElementFunction>(inner_function_, outer_function_, element_search_); } // ... local_function(...) diff --git a/dune/xt/functions/base/derivatives-of-element-functions.hh b/dune/xt/functions/base/derivatives-of-element-functions.hh index ebbbba8ec9675383c90fb6c5339aad18766db55a..f9694119980ce7f2bc55bd3a3c349c558f613b72 100644 --- a/dune/xt/functions/base/derivatives-of-element-functions.hh +++ b/dune/xt/functions/base/derivatives-of-element-functions.hh @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_FUNCTIONS_BASE_DERIVATIVES_OF_ELEMENT_FUNCTIONS_HH #define DUNE_XT_FUNCTIONS_BASE_DERIVATIVES_OF_ELEMENT_FUNCTIONS_HH diff --git a/dune/xt/functions/base/function-as-flux-function.hh b/dune/xt/functions/base/function-as-flux-function.hh index 59f07090b0503b7a483b9b9722562d5c1a93f071..234a3438ecb68cea9d4d98943e29e0810e05c17f 100644 --- a/dune/xt/functions/base/function-as-flux-function.hh +++ b/dune/xt/functions/base/function-as-flux-function.hh @@ -1,11 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_BASE_FUNCTION_AS_FLUX_FUNCTION_HH #define DUNE_XT_FUNCTIONS_BASE_FUNCTION_AS_FLUX_FUNCTION_HH @@ -39,11 +40,7 @@ public: : function_storage_(function) {} - StateFunctionAsFluxFunctionWrapper(const FunctionType*&& function_ptr) - : function_storage_(std::move(function_ptr)) - {} - - StateFunctionAsFluxFunctionWrapper(std::unique_ptr<FunctionType>&& function_ptr) + StateFunctionAsFluxFunctionWrapper(std::unique_ptr<const FunctionType>&& function_ptr) : function_storage_(std::move(function_ptr)) {} diff --git a/dune/xt/functions/base/function-as-grid-function.hh b/dune/xt/functions/base/function-as-grid-function.hh index 078e58ddb343c0f009d65dc79652f608bb12de8f..94d1233f5df5f4f5805b571bcd90317c5ea752de 100644 --- a/dune/xt/functions/base/function-as-grid-function.hh +++ b/dune/xt/functions/base/function-as-grid-function.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) -// René Fritze (2017 - 2018) +// René Fritze (2017 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017) +// Tobias Leibner (2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_BASE_FUNCTION_AS_GRID_FUNCTION_HH #define DUNE_XT_FUNCTIONS_BASE_FUNCTION_AS_GRID_FUNCTION_HH @@ -41,7 +41,7 @@ public: : function_storage_(function) {} - FunctionAsGridFunctionWrapper(const FunctionType*&& function_ptr) + FunctionAsGridFunctionWrapper(FunctionType*&& function_ptr) : function_storage_(std::move(function_ptr)) {} diff --git a/dune/xt/functions/base/reinterpret.hh b/dune/xt/functions/base/reinterpret.hh index 3019d082b37202a114c2d3f3d2f87a11f4b1792d..9986d56f6a988c17415aaebee199a94f37636649 100644 --- a/dune/xt/functions/base/reinterpret.hh +++ b/dune/xt/functions/base/reinterpret.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) -// René Fritze (2016, 2018) +// René Fritze (2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2016 - 2018) +// Tobias Leibner (2016 - 2020) #ifndef DUNE_XT_FUNCTIONS_BASE_REINTERPRET_HH #define DUNE_XT_FUNCTIONS_BASE_REINTERPRET_HH @@ -102,7 +102,7 @@ private: { // See if we find a source element which contais target_element completely. Therefore // * collect all vertices - const auto& reference_element = ReferenceElements<D, d>::general(target_element.geometry().type()); + const auto& reference_element = ReferenceElements<D, d>::general(target_element.type()); const auto num_vertices = reference_element.size(1); if (vertices_.size() != num_vertices) vertices_.resize(num_vertices); diff --git a/dune/xt/functions/base/sliced.hh b/dune/xt/functions/base/sliced.hh index ccdb771f325758e6b9784e3b9d896421bc972561..efaf20a8a7d6e69ee320fedba6621344ee1e1810 100644 --- a/dune/xt/functions/base/sliced.hh +++ b/dune/xt/functions/base/sliced.hh @@ -1,13 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) +// Tobias Leibner (2020) #ifndef DUNE_XT_FUNCTIONS_BASE_SLICED_HH #define DUNE_XT_FUNCTIONS_BASE_SLICED_HH diff --git a/dune/xt/functions/base/transformed.hh b/dune/xt/functions/base/transformed.hh index 0ca8e6f8445e0e13ce026f3bd0c379bf52e1bfbd..5df43f34df4dd11312d2531bbd085025fe3b082e 100644 --- a/dune/xt/functions/base/transformed.hh +++ b/dune/xt/functions/base/transformed.hh @@ -1,13 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) +// Tobias Leibner (2020) #ifndef DUNE_XT_FUNCTIONS_BASE_TRANSFORMED_HH #define DUNE_XT_FUNCTIONS_BASE_TRANSFORMED_HH diff --git a/dune/xt/functions/base/visualization.hh b/dune/xt/functions/base/visualization.hh index 62da3c524bea23fcb2c7d7d0de4e25d991f640ac..db5602a04181c7f1d98b0e17411c2ddbf2b9cbaa 100644 --- a/dune/xt/functions/base/visualization.hh +++ b/dune/xt/functions/base/visualization.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2019) -// René Fritze (2013 - 2016, 2018) +// René Fritze (2013 - 2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014, 2019) +// Tobias Leibner (2014, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_BASE_VISUALIZATION_HH #define DUNE_XT_FUNCTIONS_BASE_VISUALIZATION_HH diff --git a/dune/xt/functions/checkerboard.hh b/dune/xt/functions/checkerboard.hh index ebc8af7bfb97645f61ba26942ca4f380876f6404..cd9d7e7a22f8460cd6c59b8f992d62200ed5d25d 100644 --- a/dune/xt/functions/checkerboard.hh +++ b/dune/xt/functions/checkerboard.hh @@ -1,15 +1,15 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Andreas Buhr (2014) // Felix Schindler (2012 - 2018) -// René Fritze (2013 - 2018) +// René Fritze (2013 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014 - 2017) +// Tobias Leibner (2014 - 2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_CHECKERBOARD_HH #define DUNE_XT_FUNCTIONS_CHECKERBOARD_HH diff --git a/dune/xt/functions/constant.hh b/dune/xt/functions/constant.hh index f440ce85752c1abbf6c3124ada234271eb00149c..4404577c1096e8a6bea8a6c364ce80f3e5f7a284 100644 --- a/dune/xt/functions/constant.hh +++ b/dune/xt/functions/constant.hh @@ -1,15 +1,15 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2019) // Kirsten Weber (2013) -// René Fritze (2013 - 2018) +// René Fritze (2013 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014 - 2015, 2017, 2019) +// Tobias Leibner (2014 - 2015, 2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_CONSTANT_HH #define DUNE_XT_FUNCTIONS_CONSTANT_HH diff --git a/dune/xt/functions/derivatives.hh b/dune/xt/functions/derivatives.hh index 78f288ae16b323f1a0bf000afd8b319f52d165e5..497f8a2071da0cdc85e266d1e9bb1a9c12e97e2e 100644 --- a/dune/xt/functions/derivatives.hh +++ b/dune/xt/functions/derivatives.hh @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_FUNCTIONS_DERIVATIVES_HH #define DUNE_XT_FUNCTIONS_DERIVATIVES_HH diff --git a/dune/xt/functions/exceptions.hh b/dune/xt/functions/exceptions.hh index 2aaf3f1bd2d27d7c1f2dad8857f2b852b44a70f0..4ea3254e980fc0f05e857b11ea3c0a6e7d8141f9 100644 --- a/dune/xt/functions/exceptions.hh +++ b/dune/xt/functions/exceptions.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_FUNCTIONS_EXCEPTIONS_HH #define DUNE_XT_FUNCTIONS_EXCEPTIONS_HH diff --git a/dune/xt/functions/expression.hh b/dune/xt/functions/expression.hh index fec0a4daf8d121b574ef9454ff4ec9cb904b8884..bec983bae7f205de1fa4fa8359b7a46726cc925d 100644 --- a/dune/xt/functions/expression.hh +++ b/dune/xt/functions/expression.hh @@ -1,15 +1,15 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2017) // Kirsten Weber (2013) -// René Fritze (2012 - 2016, 2018) +// René Fritze (2012 - 2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014 - 2017) +// Tobias Leibner (2014 - 2017, 2020) #ifndef DUNE_XT_FUNCTIONS_EXPRESSION_HH #define DUNE_XT_FUNCTIONS_EXPRESSION_HH diff --git a/dune/xt/functions/expression/base.hh b/dune/xt/functions/expression/base.hh index 1208276955ec1c93b44ebdf99fcf8ff07d3ae933..0063af14bdf9db3befccbadfe95dd50af90b5775 100644 --- a/dune/xt/functions/expression/base.hh +++ b/dune/xt/functions/expression/base.hh @@ -1,15 +1,15 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Andreas Buhr (2014) // Felix Schindler (2013 - 2017) -// René Fritze (2013, 2015 - 2016, 2018) +// René Fritze (2013, 2015 - 2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014 - 2015, 2017) +// Tobias Leibner (2014 - 2015, 2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_EXPRESSION_BASE_HH #define DUNE_XT_FUNCTIONS_EXPRESSION_BASE_HH @@ -304,12 +304,11 @@ private: if (ex.empty()) DUNE_THROW(Common::Exceptions::wrong_input_given, "Given expressions must not be empty!"); if (vars.size() > maxDimDomain) - DUNE_THROW( - Common::Exceptions::shapes_do_not_match, - "This expression function of dynamic size was compiled to work for up to " - << DUNE_XT_FUNCTIONS_EXPRESSION_BASE_MAX_DYNAMIC_SIZE << " variables, but you provided " << vars.size() - << "!\n\n" - << "Configure dune-xt-functions with a larger DUNE_XT_FUNCTIONS_EXPRESSION_BASE_MAX_DYNAMIC_SIZE!"); + DUNE_THROW(Common::Exceptions::shapes_do_not_match, + "This expression function of dynamic size was compiled to work for up to " + << DUNE_XT_FUNCTIONS_EXPRESSION_BASE_MAX_DYNAMIC_SIZE << " variables, but you provided " + << vars.size() << "!\n\n" + << "Configure dune-xt with a larger DUNE_XT_FUNCTIONS_EXPRESSION_BASE_MAX_DYNAMIC_SIZE!"); originalvars_ = vars; for (const auto& var : originalvars_) if (var.empty()) diff --git a/dune/xt/functions/expression/default.hh b/dune/xt/functions/expression/default.hh index fb8afa337e75d54aebc11f53be8f67337777800a..3ef72e8f90d8a91a076f4ac9edd9d98c2e5e3794 100644 --- a/dune/xt/functions/expression/default.hh +++ b/dune/xt/functions/expression/default.hh @@ -1,15 +1,15 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2018) // Kirsten Weber (2013) -// René Fritze (2012 - 2016, 2018) +// René Fritze (2012 - 2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014 - 2018) +// Tobias Leibner (2014 - 2020) #ifndef DUNE_XT_FUNCTIONS_EXPRESSION_DEFAULT_HH #define DUNE_XT_FUNCTIONS_EXPRESSION_DEFAULT_HH diff --git a/dune/xt/functions/expression/mathexpr.cc b/dune/xt/functions/expression/mathexpr.cc index bcc45e48cf2432aa1cebb5539dee22e53fd31055..6c34e44d0fce25cc1d659ed8f6625eb2dd8b7e09 100644 --- a/dune/xt/functions/expression/mathexpr.cc +++ b/dune/xt/functions/expression/mathexpr.cc @@ -1,14 +1,3 @@ -// This file is part of the dune-xt-functions project: -// https://github.com/dune-community/dune-xt-functions -// Copyright 2009-2018 dune-xt-functions developers and contributors. All rights reserved. -// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) -// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) -// with "runtime exception" (http://www.dune-project.org/license.html) -// Authors: -// Felix Schindler (2012 - 2013, 2015 - 2016) -// René Fritze (2012, 2018) -// Tim Keil (2018) - /* mathexpr.cpp version 2.0 diff --git a/dune/xt/functions/expression/parametric.hh b/dune/xt/functions/expression/parametric.hh index 9d46974e05257f4ab75c2cf0c7380dc81dfb2eb3..1711475741c8b0a9d5f44d08e112cb32fb453b4c 100644 --- a/dune/xt/functions/expression/parametric.hh +++ b/dune/xt/functions/expression/parametric.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017 - 2018) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_FUNCTIONS_EXPRESSION_PARAMETRIC_HH #define DUNE_XT_FUNCTIONS_EXPRESSION_PARAMETRIC_HH diff --git a/dune/xt/functions/flattop.hh b/dune/xt/functions/flattop.hh index 31afddb29c9351c067ddccf5dbcdcede736c35b8..faecc54fbe856c1d423e766212b1974f91e76754 100644 --- a/dune/xt/functions/flattop.hh +++ b/dune/xt/functions/flattop.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2018) -// René Fritze (2014 - 2016, 2018) +// René Fritze (2014 - 2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2015, 2017) +// Tobias Leibner (2015, 2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_FLATTOP_HH #define DUNE_XT_FUNCTIONS_FLATTOP_HH diff --git a/dune/xt/functions/generic/element-function.hh b/dune/xt/functions/generic/element-function.hh index a42f9aca44005177e3d3d275134017c7c1312b30..eb0c7073c0fa32f3d41629dcdd881454015cc19e 100644 --- a/dune/xt/functions/generic/element-function.hh +++ b/dune/xt/functions/generic/element-function.hh @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_FUNCTIONS_GENERIC_ELEMENT_FUNCTION_HH #define DUNE_XT_FUNCTIONS_GENERIC_ELEMENT_FUNCTION_HH diff --git a/dune/xt/functions/generic/flux-function.hh b/dune/xt/functions/generic/flux-function.hh index 56ca36f525c060da381fe848a29a7bdb709f470a..a95db10aa7baeb0bd280a1a2488bb4406130ff7f 100644 --- a/dune/xt/functions/generic/flux-function.hh +++ b/dune/xt/functions/generic/flux-function.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017, 2019) +// Tobias Leibner (2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_GENERIC_FLUX_FUNCTION_HH #define DUNE_XT_FUNCTIONS_GENERIC_FLUX_FUNCTION_HH diff --git a/dune/xt/functions/generic/function.hh b/dune/xt/functions/generic/function.hh index baf2a0c77be1dff0a4767b3afbdfc86dd4f81dd1..79f572678df1993ac12c6a2f66ead2bd74c98911 100644 --- a/dune/xt/functions/generic/function.hh +++ b/dune/xt/functions/generic/function.hh @@ -1,15 +1,15 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2019) -// René Fritze (2013 - 2016, 2018) +// René Fritze (2013 - 2016, 2018 - 2019) // Sven Kaulmann (2013) // Tim Keil (2018) -// Tobias Leibner (2014, 2017) +// Tobias Leibner (2014, 2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_GENERIC_FUNCTION_HH #define DUNE_XT_FUNCTIONS_GENERIC_FUNCTION_HH diff --git a/dune/xt/functions/generic/grid-function.hh b/dune/xt/functions/generic/grid-function.hh index 17c0053dfffd683140441fbd9a243ba854eeccae..b80c4183d3672c53ec34f4d44b2416a26b7bb273 100644 --- a/dune/xt/functions/generic/grid-function.hh +++ b/dune/xt/functions/generic/grid-function.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017, 2019) +// Tobias Leibner (2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_GENERIC_GRID_FUNCTION_HH #define DUNE_XT_FUNCTIONS_GENERIC_GRID_FUNCTION_HH diff --git a/dune/xt/functions/grid-function.hh b/dune/xt/functions/grid-function.hh index 544be9f0a8b70c48266d54c59934746f04431d9c..f4d30443642bd67c78080ce9fd41c9d20bb3f023 100644 --- a/dune/xt/functions/grid-function.hh +++ b/dune/xt/functions/grid-function.hh @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_GRID_FUNCTION_HH #define DUNE_XT_FUNCTIONS_GRID_FUNCTION_HH diff --git a/dune/xt/functions/indicator.hh b/dune/xt/functions/indicator.hh index bd37248c97ff9e8afa981305e7a9036274525803..ef546c1fe9e83024b6051d7ed99bd779328b2db3 100644 --- a/dune/xt/functions/indicator.hh +++ b/dune/xt/functions/indicator.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2015 - 2018) -// René Fritze (2015 - 2016, 2018) +// René Fritze (2015 - 2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017) +// Tobias Leibner (2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_INDICATOR_HH #define DUNE_XT_FUNCTIONS_INDICATOR_HH diff --git a/dune/xt/functions/interfaces/element-flux-functions.hh b/dune/xt/functions/interfaces/element-flux-functions.hh index 192f61bbd20670344dbcb81bdb040699b76307b2..de8d115be6d42f4375604fa591b41d572cb2641a 100644 --- a/dune/xt/functions/interfaces/element-flux-functions.hh +++ b/dune/xt/functions/interfaces/element-flux-functions.hh @@ -1,15 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017, 2019) - +// Tobias Leibner (2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_INTERFACES_ELEMENT_FLUX_FUNCTIONS_HH #define DUNE_XT_FUNCTIONS_INTERFACES_ELEMENT_FLUX_FUNCTIONS_HH @@ -305,7 +304,7 @@ protected: #ifndef DUNE_XT_FUNCTIONS_DISABLE_CHECKS void assert_inside_reference_element(const DomainType& point_in_reference_element) const { - if (!ReferenceElements<D, d>::general(this->element().geometry().type()).checkInside(point_in_reference_element)) { + if (!ReferenceElements<D, d>::general(this->element().type()).checkInside(point_in_reference_element)) { std::stringstream error_message; error_message << "Given point_in_reference_element is not inside the current elements reference element!\n\n"; XT::Grid::print_entity(this->element(), XT::Common::Typename<E>::value(), error_message, " "); diff --git a/dune/xt/functions/interfaces/element-functions.hh b/dune/xt/functions/interfaces/element-functions.hh index e5f1d0cc799c515d609d4e9688c7830ff8eb0335..126611fe2fc202e7815fe1711e9fc765e1a4fb72 100644 --- a/dune/xt/functions/interfaces/element-functions.hh +++ b/dune/xt/functions/interfaces/element-functions.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017, 2019) +// Tobias Leibner (2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_INTERFACES_ELEMENT_FUNCTIONS_HH #define DUNE_XT_FUNCTIONS_INTERFACES_ELEMENT_FUNCTIONS_HH @@ -386,7 +386,7 @@ protected: #ifndef DUNE_XT_FUNCTIONS_DISABLE_CHECKS void assert_inside_reference_element(const DomainType& point_in_reference_element) const { - if (!ReferenceElements<D, d>::general(this->element().geometry().type()).checkInside(point_in_reference_element)) { + if (!ReferenceElements<D, d>::general(this->element().type()).checkInside(point_in_reference_element)) { std::stringstream error_message; error_message << "Given point_in_reference_element is not inside the current elements reference element!\n\n"; XT::Grid::print_entity(this->element(), XT::Common::Typename<E>::value(), error_message, " "); diff --git a/dune/xt/functions/interfaces/flux-function.hh b/dune/xt/functions/interfaces/flux-function.hh index a5ddbf9df54b5bc12f22b1a7445f6cbb8d2377a0..eff81d41652fba846f9aa4152e8c0214c4a18380 100644 --- a/dune/xt/functions/interfaces/flux-function.hh +++ b/dune/xt/functions/interfaces/flux-function.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_INTERFACES_FLUX_FUNCTION_HH #define DUNE_XT_FUNCTIONS_INTERFACES_FLUX_FUNCTION_HH diff --git a/dune/xt/functions/interfaces/function.hh b/dune/xt/functions/interfaces/function.hh index 3ad86702de363eab44ba1ceb05072c4deca69c61..f46b78cf19c7bafe272e005c14f32ef87720fef8 100644 --- a/dune/xt/functions/interfaces/function.hh +++ b/dune/xt/functions/interfaces/function.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_INTERFACES_FUNCTION_HH #define DUNE_XT_FUNCTIONS_INTERFACES_FUNCTION_HH diff --git a/dune/xt/functions/interfaces/grid-function.hh b/dune/xt/functions/interfaces/grid-function.hh index 57989a9cd86fc90a433b1c31d7033ca1e0f23c86..85cff2b20010b0fa268c1e1f3ea18d27313beda6 100644 --- a/dune/xt/functions/interfaces/grid-function.hh +++ b/dune/xt/functions/interfaces/grid-function.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017, 2019) +// Tobias Leibner (2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_INTERFACES_GRID_FUNCTION_HH #define DUNE_XT_FUNCTIONS_INTERFACES_GRID_FUNCTION_HH diff --git a/dune/xt/functions/inverse.hh b/dune/xt/functions/inverse.hh index 49fc9ac939758407de5c46ade8ecb46d3ca5660c..e2be97d232e7f01346b2c8009c3e198af783a9b4 100644 --- a/dune/xt/functions/inverse.hh +++ b/dune/xt/functions/inverse.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_INVERSE_HH #define DUNE_XT_FUNCTIONS_INVERSE_HH diff --git a/dune/xt/functions/spe10/model1.hh b/dune/xt/functions/spe10/model1.hh index b8a108f1fb0ef160aef0cdda0f892e0490ee749b..8d865e7cf176549c00860ae017666a9cae8a46bb 100644 --- a/dune/xt/functions/spe10/model1.hh +++ b/dune/xt/functions/spe10/model1.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2018) -// René Fritze (2014 - 2016, 2018) +// René Fritze (2014 - 2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014, 2018) +// Tobias Leibner (2014, 2018 - 2020) #ifndef DUNE_XT_FUNCTIONS_SPE10_MODEL1_HH #define DUNE_XT_FUNCTIONS_SPE10_MODEL1_HH diff --git a/dune/xt/functions/spe10/model2.hh b/dune/xt/functions/spe10/model2.hh index d2fa346fbb95dc95181e928307e6bb312adc725e..b93b5c6071eb4a78dc2f28cdf7e7be8725920c44 100644 --- a/dune/xt/functions/spe10/model2.hh +++ b/dune/xt/functions/spe10/model2.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2018) -// René Fritze (2015 - 2016, 2018) +// René Fritze (2015 - 2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017 - 2018) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_FUNCTIONS_SPE10_MODEL2_HH #define DUNE_XT_FUNCTIONS_SPE10_MODEL2_HH diff --git a/dune/xt/functions/test/.gitignore b/dune/xt/functions/test/.gitignore index 7070f060e454046ec8ba336f9d198f11dcf5683a..6cc7cd31f48fdd0d5b7faa22d8441afe540f184e 100644 --- a/dune/xt/functions/test/.gitignore +++ b/dune/xt/functions/test/.gitignore @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2013, 2016 - 2017) -# René Fritze (2012, 2015 - 2018) -# Tobias Leibner (2016) +# René Fritze (2012, 2015 - 2019) +# Tobias Leibner (2016, 2020) # ~~~ test_validation diff --git a/dune/xt/functions/type_traits.hh b/dune/xt/functions/type_traits.hh index 82b5e82154edaa27cd5a2e2d7d34c88817c72b1a..dda718840e2344147a47eebd7dafaca2f16ea1e1 100644 --- a/dune/xt/functions/type_traits.hh +++ b/dune/xt/functions/type_traits.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017, 2019) +// Tobias Leibner (2017, 2019 - 2020) #ifndef DUNE_XT_FUNCTIONS_TYPE_TRAITS_HH #define DUNE_XT_FUNCTIONS_TYPE_TRAITS_HH diff --git a/dune/xt/grid/CMakeLists.txt b/dune/xt/grid/CMakeLists.txt index f02bd388bac7ceaee05ccefc9a06ae8758ba021b..475f625cffaec3b27b70983e56a6f2604daa0571 100644 --- a/dune/xt/grid/CMakeLists.txt +++ b/dune/xt/grid/CMakeLists.txt @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2013 - 2017) # René Fritze (2012 - 2016, 2018 - 2019) -# Tobias Leibner (2016) +# Tobias Leibner (2016, 2019 - 2020) # ~~~ set(lib_dune_xt_grid_sources boundaryinfo/interfaces.cc) diff --git a/dune/xt/grid/bound-object.hh b/dune/xt/grid/bound-object.hh index ddd5d73d870e3ebc21d491e11220fc6b68a39ead..72f7631ce52948a6e864e2a107457d6218535218 100644 --- a/dune/xt/grid/bound-object.hh +++ b/dune/xt/grid/bound-object.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018) -// René Fritze (2018) -// Tobias Leibner (2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_GRID_BOUND_OBJECTS_HH #define DUNE_XT_GRID_BOUND_OBJECTS_HH diff --git a/dune/xt/grid/boundaryinfo.hh b/dune/xt/grid/boundaryinfo.hh index 78f484c9b25a7fab2d0f2565eb2f5d5728549878..c83b21cbc11f316c4981ae9b7ec92d85e5231394 100644 --- a/dune/xt/grid/boundaryinfo.hh +++ b/dune/xt/grid/boundaryinfo.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2017) -// René Fritze (2012 - 2016, 2018) +// René Fritze (2012 - 2016, 2018 - 2019) // Sven Kaulmann (2013 - 2014) -// Tobias Leibner (2014, 2017) +// Tobias Leibner (2014, 2017, 2020) #ifndef DUNE_XT_GRID_BOUNDARYINFO_HH #define DUNE_XT_GRID_BOUNDARYINFO_HH diff --git a/dune/xt/grid/boundaryinfo/alldirichlet.hh b/dune/xt/grid/boundaryinfo/alldirichlet.hh index 92ad58fb50bbaa7de4ea388f619771fd689f47c8..6277177664f3dcc6d73b7e157e44804e637bea88 100644 --- a/dune/xt/grid/boundaryinfo/alldirichlet.hh +++ b/dune/xt/grid/boundaryinfo/alldirichlet.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) -// René Fritze (2016 - 2018) -// Tobias Leibner (2016 - 2017, 2019) +// René Fritze (2016 - 2019) +// Tobias Leibner (2016 - 2017, 2019 - 2020) #ifndef DUNE_XT_GRID_BOUNDARYINFO_ALLDIRICHLET_HH #define DUNE_XT_GRID_BOUNDARYINFO_ALLDIRICHLET_HH @@ -73,14 +73,14 @@ template <class I> std::unique_ptr<AllDirichletBoundaryInfo<I>> make_alldirichlet_boundaryinfo(const Common::Configuration& /*cfg*/ = Common::Configuration()) { - return XT::Common::make_unique<AllDirichletBoundaryInfo<I>>(); + return std::make_unique<AllDirichletBoundaryInfo<I>>(); } template <class GV> std::unique_ptr<AllDirichletBoundaryInfo<extract_intersection_t<GV>>> make_alldirichlet_boundaryinfo(GV, const Common::Configuration& /*cfg*/ = Common::Configuration()) { - return XT::Common::make_unique<AllDirichletBoundaryInfo<extract_intersection_t<GV>>>(); + return std::make_unique<AllDirichletBoundaryInfo<extract_intersection_t<GV>>>(); } template <class IntersectionImp> diff --git a/dune/xt/grid/boundaryinfo/allneumann.hh b/dune/xt/grid/boundaryinfo/allneumann.hh index ec632e4065c95b5214d6579df905182869e4b486..345c2b827a03853fafc631ad3438914df75caf20 100644 --- a/dune/xt/grid/boundaryinfo/allneumann.hh +++ b/dune/xt/grid/boundaryinfo/allneumann.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) -// René Fritze (2016 - 2018) -// Tobias Leibner (2016 - 2017) +// René Fritze (2016 - 2019) +// Tobias Leibner (2016 - 2017, 2019 - 2020) #ifndef DUNE_XT_GRID_BOUNDARYINFO_ALLNEUMANN_HH #define DUNE_XT_GRID_BOUNDARYINFO_ALLNEUMANN_HH @@ -73,7 +73,7 @@ template <class I> std::unique_ptr<AllNeumannBoundaryInfo<I>> make_allneumann_boundaryinfo(const Common::Configuration& /*cfg*/ = Common::Configuration()) { - return XT::Common::make_unique<AllNeumannBoundaryInfo<I>>(); + return std::make_unique<AllNeumannBoundaryInfo<I>>(); } diff --git a/dune/xt/grid/boundaryinfo/allreflecting.hh b/dune/xt/grid/boundaryinfo/allreflecting.hh index 10ea39ee17b137448096bc4ee7bd0401e2ee9d7c..3a29824d4b59cf1d4346d314cb552fd5e4717ead 100644 --- a/dune/xt/grid/boundaryinfo/allreflecting.hh +++ b/dune/xt/grid/boundaryinfo/allreflecting.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) -// René Fritze (2016 - 2018) -// Tobias Leibner (2016 - 2017) +// René Fritze (2016 - 2019) +// Tobias Leibner (2016 - 2017, 2019 - 2020) #ifndef DUNE_XT_GRID_BOUNDARYINFO_ALLREFLECTING_HH #define DUNE_XT_GRID_BOUNDARYINFO_ALLREFLECTING_HH @@ -73,7 +73,7 @@ template <class I> std::unique_ptr<AllReflectingBoundaryInfo<I>> make_allreflecting_boundaryinfo(const Common::Configuration& /*cfg*/ = Common::Configuration()) { - return XT::Common::make_unique<AllReflectingBoundaryInfo<I>>(); + return std::make_unique<AllReflectingBoundaryInfo<I>>(); } diff --git a/dune/xt/grid/boundaryinfo/boundarysegment.hh b/dune/xt/grid/boundaryinfo/boundarysegment.hh index 864c5838bf85e006570ed157e5e166a5281bfb44..ed1497b1a9031c7865181590ac1f8a5e36346010 100644 --- a/dune/xt/grid/boundaryinfo/boundarysegment.hh +++ b/dune/xt/grid/boundaryinfo/boundarysegment.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2019 - 2020) #ifndef DUNE_XT_GRID_BOUNDARYINFO_BOUNDARYSEGMENT_HH #define DUNE_XT_GRID_BOUNDARYINFO_BOUNDARYSEGMENT_HH @@ -79,7 +79,7 @@ public: } } // return - return Common::make_unique<ThisType>(default_type, id_map); + return std::make_unique<ThisType>(default_type, id_map); } // ... create(...) BoundarySegmentIndexBasedBoundaryInfo(const std::string& def, diff --git a/dune/xt/grid/boundaryinfo/factory.hh b/dune/xt/grid/boundaryinfo/factory.hh index c294f5109ac048d6abf19d80643f7bb6ada8bc83..026ac168ecc6acc47cc58369d15944aa13af2825 100644 --- a/dune/xt/grid/boundaryinfo/factory.hh +++ b/dune/xt/grid/boundaryinfo/factory.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2018) -// René Fritze (2016, 2018) +// René Fritze (2016, 2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_BOUNDARYINFO_FACTORY_HH #define DUNE_XT_GRID_BOUNDARYINFO_FACTORY_HH diff --git a/dune/xt/grid/boundaryinfo/interfaces.cc b/dune/xt/grid/boundaryinfo/interfaces.cc index 5b91e1925048312cad3622166496d366139a7117..f518bd6f050c7d29528714097d53a0cd672ff030 100644 --- a/dune/xt/grid/boundaryinfo/interfaces.cc +++ b/dune/xt/grid/boundaryinfo/interfaces.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014, 2016 - 2017) -// René Fritze (2012 - 2013, 2015 - 2016, 2018) -// Tobias Leibner (2014, 2016) +// René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2016, 2020) #include <config.h> diff --git a/dune/xt/grid/boundaryinfo/interfaces.hh b/dune/xt/grid/boundaryinfo/interfaces.hh index e8e2d72756eeecccbf529831add833df2a1c4d29..d7c26da5b079aeecc2f0bcf7fa75ba8961017e61 100644 --- a/dune/xt/grid/boundaryinfo/interfaces.hh +++ b/dune/xt/grid/boundaryinfo/interfaces.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2018) -// René Fritze (2016, 2018) -// Tobias Leibner (2016 - 2018) +// René Fritze (2016, 2018 - 2019) +// Tobias Leibner (2016 - 2020) #ifndef DUNE_XT_GRID_BOUNDARYINFO_INTERFACE_HH #define DUNE_XT_GRID_BOUNDARYINFO_INTERFACE_HH diff --git a/dune/xt/grid/boundaryinfo/normalbased.hh b/dune/xt/grid/boundaryinfo/normalbased.hh index f059be7bcd2b27b2899444f1d94a419729912101..45d026b86ddd01bb1ae25713c03751f8ae284682 100644 --- a/dune/xt/grid/boundaryinfo/normalbased.hh +++ b/dune/xt/grid/boundaryinfo/normalbased.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2018) -// René Fritze (2016, 2018) -// Tobias Leibner (2016 - 2018) +// René Fritze (2016, 2018 - 2019) +// Tobias Leibner (2016 - 2020) #ifndef DUNE_XT_GRID_BOUNDARYINFO_NORMALBASED_HH #define DUNE_XT_GRID_BOUNDARYINFO_NORMALBASED_HH diff --git a/dune/xt/grid/boundaryinfo/types.hh b/dune/xt/grid/boundaryinfo/types.hh index b26cfb34c2bd3833dd80d67fc95155b5da826108..44c82292a0c297e8c3ec5fe7d94f7097ad9ae536 100644 --- a/dune/xt/grid/boundaryinfo/types.hh +++ b/dune/xt/grid/boundaryinfo/types.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2018) -// René Fritze (2016, 2018) -// Tobias Leibner (2016 - 2018) +// René Fritze (2016, 2018 - 2019) +// Tobias Leibner (2016 - 2020) #ifndef DUNE_XT_GRID_BOUNDARYINFO_TYPES_HH #define DUNE_XT_GRID_BOUNDARYINFO_TYPES_HH diff --git a/dune/xt/grid/capabilities.hh b/dune/xt/grid/capabilities.hh index cc4d463c2d0af90155665663b4921f633a34be2d..4cd440844437fbce887543be5cd9849ca0523129 100644 --- a/dune/xt/grid/capabilities.hh +++ b/dune/xt/grid/capabilities.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2018 - 2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2018 - 2020) #ifndef DUNE_XT_GRID_CAPABILITIES_HH #define DUNE_XT_GRID_CAPABILITIES_HH diff --git a/dune/xt/grid/dd/glued.hh b/dune/xt/grid/dd/glued.hh index 26f22fa4627ed4618eb80cb93119bdac0f14608b..bb0863e05c9d0417b57204546d741c794459ed92 100644 --- a/dune/xt/grid/dd/glued.hh +++ b/dune/xt/grid/dd/glued.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) -// Tobias Leibner (2017 - 2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_GRID_DD_GLUED_HH #define DUNE_XT_GRID_DD_GLUED_HH @@ -734,7 +734,7 @@ private: subdomain_factory.insertVertex(vertex); vertex_ids[local_vertex_id] = local_vertex_id; } - subdomain_factory.insertElement(macro_entity.geometry().type(), vertex_ids); + subdomain_factory.insertElement(macro_entity.type(), vertex_ids); return std::make_shared<XT::Grid::GridProvider<LocalGridType>>(subdomain_factory.createGrid()); } catch (GridError& ee) { DUNE_THROW(GridError, @@ -922,7 +922,7 @@ private: template count<dimDomain>(); # endif entity_to_vertex_ids[macro_index][micro_index] = std::vector<unsigned int>(num_vertices); - geometry_types[macro_index][micro_index] = micro_entity.geometry().type(); + geometry_types[macro_index][micro_index] = micro_entity.type(); for (unsigned int local_vertex_id = 0; local_vertex_id < num_vertices; ++local_vertex_id) { const unsigned int global_vertex_id = find_insert_vertex(vertices, micro_entity diff --git a/dune/xt/grid/entity.hh b/dune/xt/grid/entity.hh index 700b31224d24e02d6b30675aba250f4887bae5e7..86ce3ab950e861eb3ab15a4e16866789b11b73af 100644 --- a/dune/xt/grid/entity.hh +++ b/dune/xt/grid/entity.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2019) -// René Fritze (2012 - 2018) +// René Fritze (2012 - 2019) // Sven Kaulmann (2014) -// Tobias Leibner (2014, 2016) +// Tobias Leibner (2014, 2016, 2020) #ifndef DUNE_XT_GRID_ENTITY_HH #define DUNE_XT_GRID_ENTITY_HH diff --git a/dune/xt/grid/exceptions.hh b/dune/xt/grid/exceptions.hh index 2a1919b53dc3769e0617ff01f8b6dac505c5c819..31a5cbb19967974c7ba13827ab556032ddade8e1 100644 --- a/dune/xt/grid/exceptions.hh +++ b/dune/xt/grid/exceptions.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014, 2016 - 2018) -// René Fritze (2012 - 2013, 2015 - 2016, 2018) -// Tobias Leibner (2014, 2016) +// René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2016, 2020) #ifndef DUNE_XT_GRID_EXCEPTIONS_HH #define DUNE_XT_GRID_EXCEPTIONS_HH diff --git a/dune/xt/grid/filters.hh b/dune/xt/grid/filters.hh index 95a2338abe0aae5f393dc6235ac7cabc63cb4eae..ff6908d0bf4725e1a7e605cf426a9956ce7d468b 100644 --- a/dune/xt/grid/filters.hh +++ b/dune/xt/grid/filters.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_FILTERS_HH #define DUNE_XT_GRID_FILTERS_HH diff --git a/dune/xt/grid/filters/base.hh b/dune/xt/grid/filters/base.hh index 42148a6fedd32eb2309ba11ea9393e99d814c763..36360d3047f5f7367041f7fe30f43f400d2f18ca 100644 --- a/dune/xt/grid/filters/base.hh +++ b/dune/xt/grid/filters/base.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018) -// René Fritze (2018) -// Tobias Leibner (2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_GRID_FILTERS_BASE_HH #define DUNE_XT_GRID_FILTERS_BASE_HH diff --git a/dune/xt/grid/filters/element.hh b/dune/xt/grid/filters/element.hh index b6028799dbdecef751c54274d06c1959ca953a34..5f8f5c4f1e6be3f2482c29ff5a1e84149bb90ed7 100644 --- a/dune/xt/grid/filters/element.hh +++ b/dune/xt/grid/filters/element.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018) -// René Fritze (2018) -// Tobias Leibner (2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_GRID_FILTERS_ELEMENT_HH #define DUNE_XT_GRID_FILTERS_ELEMENT_HH diff --git a/dune/xt/grid/filters/intersection.hh b/dune/xt/grid/filters/intersection.hh index fa60134d376c1c1878bb073ff769ea69068e0ef2..8db6ed0cb267d4229380391e488cc872d6294828 100644 --- a/dune/xt/grid/filters/intersection.hh +++ b/dune/xt/grid/filters/intersection.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2018) -// René Fritze (2014 - 2018) -// Tobias Leibner (2015 - 2019) +// René Fritze (2014 - 2019) +// Tobias Leibner (2015 - 2020) #ifndef DUNE_XT_GRID_FILTERS_INTERSECTION_HH #define DUNE_XT_GRID_FILTERS_INTERSECTION_HH diff --git a/dune/xt/grid/functors/boundary-detector.hh b/dune/xt/grid/functors/boundary-detector.hh index 989590edd72774fad90e7b0b59ff4036f057d954..aaad27c007ba2aa58962f203e4d0ac30be6c584c 100644 --- a/dune/xt/grid/functors/boundary-detector.hh +++ b/dune/xt/grid/functors/boundary-detector.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) -// Tobias Leibner (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2018 - 2020) #ifndef DUNE_XT_GRID_FUNCTORS_BOUNDARY_DETECTOR_HH #define DUNE_XT_GRID_FUNCTORS_BOUNDARY_DETECTOR_HH diff --git a/dune/xt/grid/functors/bounding-box.hh b/dune/xt/grid/functors/bounding-box.hh index 082ae7e78a90023a5b1c88e25c2d1706c98d1eb2..bf9c0eec5d091f4bdc9b69e07c0135180aff746a 100644 --- a/dune/xt/grid/functors/bounding-box.hh +++ b/dune/xt/grid/functors/bounding-box.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_FUNCTORS_BOUNDING_BOX_HH #define DUNE_XT_GRID_FUNCTORS_BOUNDING_BOX_HH diff --git a/dune/xt/grid/functors/generic.hh b/dune/xt/grid/functors/generic.hh index 89864ba5b7d4dd1d793c6f3969a734ad8f109f70..17ee26153bc6304591d9e8ad1ab5b890213e26f6 100644 --- a/dune/xt/grid/functors/generic.hh +++ b/dune/xt/grid/functors/generic.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018) -// René Fritze (2018) -// Tobias Leibner (2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_GRID_FUNCTORS_GENERIC_HH #define DUNE_XT_GRID_FUNCTORS_GENERIC_HH diff --git a/dune/xt/grid/functors/interfaces.hh b/dune/xt/grid/functors/interfaces.hh index baa37e41d1c88907853f4913def4fe09d156f7a5..81fa25987053d6769f13f02e72b126560d2e1efa 100644 --- a/dune/xt/grid/functors/interfaces.hh +++ b/dune/xt/grid/functors/interfaces.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2018) -// René Fritze (2014 - 2018) +// René Fritze (2014 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_FUNCTORS_INTERFACES_HH #define DUNE_XT_GRID_FUNCTORS_INTERFACES_HH diff --git a/dune/xt/grid/functors/refinement.hh b/dune/xt/grid/functors/refinement.hh index c59fefdc8bcf341e302c79672d96bf296fbbbada..9873e38d83a6de1d0cae976c37096593fbff6a06 100644 --- a/dune/xt/grid/functors/refinement.hh +++ b/dune/xt/grid/functors/refinement.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014 - 2018) -// René Fritze (2012, 2015 - 2016, 2018) +// René Fritze (2012, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_FUNCTORS_REFINEMENT_HH #define DUNE_XT_GRID_FUNCTORS_REFINEMENT_HH diff --git a/dune/xt/grid/gridprovider.hh b/dune/xt/grid/gridprovider.hh index ac40decfb21f3366a7dfa055fc4915e97a039855..9fd66017c69a6ee60a789e25d1a0a2fea98831db 100644 --- a/dune/xt/grid/gridprovider.hh +++ b/dune/xt/grid/gridprovider.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_GRIDPROVIDER_HH #define DUNE_XT_GRID_GRIDPROVIDER_HH diff --git a/dune/xt/grid/gridprovider/cube.hh b/dune/xt/grid/gridprovider/cube.hh index 455de5c25f7c0ed50981d681ff817fa3575e77bf..a1d0a0695ef25a7344b2e98d60dc0d11c4e16869 100644 --- a/dune/xt/grid/gridprovider/cube.hh +++ b/dune/xt/grid/gridprovider/cube.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,8 +9,8 @@ // Barbara Verfürth (2015) // Felix Schindler (2012 - 2017, 2019) // Kirsten Weber (2012) -// René Fritze (2012 - 2018) -// Tobias Leibner (2014, 2016, 2018) +// René Fritze (2012 - 2019) +// Tobias Leibner (2014, 2016, 2018, 2020) #ifndef DUNE_XT_GRID_GRIDPROVIDER_CUBE_HH #define DUNE_XT_GRID_GRIDPROVIDER_CUBE_HH diff --git a/dune/xt/grid/gridprovider/cube.lib.hh b/dune/xt/grid/gridprovider/cube.lib.hh index f2cd69289f2915fd0f6f4bd0336c5d6789197efa..0ef26fc2d817abe9afaf8cfb385fa6e647afefc9 100644 --- a/dune/xt/grid/gridprovider/cube.lib.hh +++ b/dune/xt/grid/gridprovider/cube.lib.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017, 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_GRIDPROVIDER_CUBE_LIB_HH #define DUNE_XT_GRID_GRIDPROVIDER_CUBE_LIB_HH diff --git a/dune/xt/grid/gridprovider/cube.lib/alu_2d_simplex_conforming.cc b/dune/xt/grid/gridprovider/cube.lib/alu_2d_simplex_conforming.cc index 2b26aebb3abf8d9bba51129a30d935721fc77630..cdea3d5fbf58a3d4982ab96c115b4331d8face76 100644 --- a/dune/xt/grid/gridprovider/cube.lib/alu_2d_simplex_conforming.cc +++ b/dune/xt/grid/gridprovider/cube.lib/alu_2d_simplex_conforming.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/grid/gridprovider/cube.lib/yasp_1d_equidistant_offset.cc b/dune/xt/grid/gridprovider/cube.lib/yasp_1d_equidistant_offset.cc index e32bede42c8068a445cc52d75ce44fed61fa246b..b32db5c672780c5f54a30599a8b142007366b98a 100644 --- a/dune/xt/grid/gridprovider/cube.lib/yasp_1d_equidistant_offset.cc +++ b/dune/xt/grid/gridprovider/cube.lib/yasp_1d_equidistant_offset.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/grid/gridprovider/cube.lib/yasp_2d_equidistant_offset.cc b/dune/xt/grid/gridprovider/cube.lib/yasp_2d_equidistant_offset.cc index 3495933c0f053b0ae46a794307ebda84b51a1d81..996b33101a1acb19ef6a702f9737793dae78b9f1 100644 --- a/dune/xt/grid/gridprovider/cube.lib/yasp_2d_equidistant_offset.cc +++ b/dune/xt/grid/gridprovider/cube.lib/yasp_2d_equidistant_offset.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/grid/gridprovider/cube.lib/yasp_3d_equidistant_offset.cc b/dune/xt/grid/gridprovider/cube.lib/yasp_3d_equidistant_offset.cc index c7422f80d1bf315ae18c76e0d7df4dbf876c0cda..f88683d20eed1d9a5e047b3e19b96e882bbb076c 100644 --- a/dune/xt/grid/gridprovider/cube.lib/yasp_3d_equidistant_offset.cc +++ b/dune/xt/grid/gridprovider/cube.lib/yasp_3d_equidistant_offset.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/grid/gridprovider/dgf.hh b/dune/xt/grid/gridprovider/dgf.hh index c58919bd84ec4cd9a39494c8d327bc4f38097eea..f557135c2da28201991d4c4fd12cae94a92d1d6a 100644 --- a/dune/xt/grid/gridprovider/dgf.hh +++ b/dune/xt/grid/gridprovider/dgf.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,8 +8,8 @@ // Andreas Buhr (2014) // Felix Schindler (2012 - 2017, 2019) // Kirsten Weber (2012) -// René Fritze (2012 - 2013, 2015 - 2016, 2018) -// Tobias Leibner (2014, 2016) +// René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2016, 2020) #ifndef DUNE_XT_GRID_GRIDPROVIDER_DGF_HH #define DUNE_XT_GRID_GRIDPROVIDER_DGF_HH diff --git a/dune/xt/grid/gridprovider/eoc.hh b/dune/xt/grid/gridprovider/eoc.hh index a622b977975fec0c9f9fd2e24b6b97eed0b36f53..a8d794dcd6edee543688bb6c5e5142e35406f537 100644 --- a/dune/xt/grid/gridprovider/eoc.hh +++ b/dune/xt/grid/gridprovider/eoc.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017, 2019) -// René Fritze (2016, 2018) -// Tobias Leibner (2018) +// René Fritze (2016, 2018 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_GRID_PROVIDER_EOC_HH #define DUNE_XT_GRID_PROVIDER_EOC_HH diff --git a/dune/xt/grid/gridprovider/factory.hh b/dune/xt/grid/gridprovider/factory.hh index 68ad042641b19eccd785f6856f8e11d72652f8eb..b8f402e14470236d9564b86f87e6edc750648677 100644 --- a/dune/xt/grid/gridprovider/factory.hh +++ b/dune/xt/grid/gridprovider/factory.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2012 - 2017, 2019) // Kirsten Weber (2013) // René Fritze (2013 - 2019) -// Tobias Leibner (2014, 2017 - 2019) +// Tobias Leibner (2014, 2017 - 2020) #ifndef DUNE_XT_GRID_PROVIDER_HH #define DUNE_XT_GRID_PROVIDER_HH diff --git a/dune/xt/grid/gridprovider/gmsh.hh b/dune/xt/grid/gridprovider/gmsh.hh index 44eb5502d220d83df062fa28bb7f4eca1aa4692e..424aa10cb3661da4dbc5a1fd62c33c6768b9d328 100644 --- a/dune/xt/grid/gridprovider/gmsh.hh +++ b/dune/xt/grid/gridprovider/gmsh.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,8 +8,8 @@ // Andreas Buhr (2014) // Felix Schindler (2012 - 2017, 2019) // Kirsten Weber (2012) -// René Fritze (2012 - 2013, 2015 - 2016, 2018) -// Tobias Leibner (2014 - 2016) +// René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2014 - 2016, 2020) #ifndef DUNE_XT_GRID_GRIDPROVIDER_GMSH_HH #define DUNE_XT_GRID_GRIDPROVIDER_GMSH_HH diff --git a/dune/xt/grid/gridprovider/provider.hh b/dune/xt/grid/gridprovider/provider.hh index 1c422164e4a1672a4dc556809d16eda1d7be9370..cde6b5e60f74b7687571a150a9b343e269386bda 100644 --- a/dune/xt/grid/gridprovider/provider.hh +++ b/dune/xt/grid/gridprovider/provider.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -10,7 +10,7 @@ // Kirsten Weber (2012) // René Fritze (2012 - 2019) // Sven Kaulmann (2014) -// Tobias Leibner (2014, 2016 - 2017) +// Tobias Leibner (2014, 2016 - 2017, 2020) #ifndef DUNE_XT_GRID_PROVIDER_PROVIDER_HH #define DUNE_XT_GRID_PROVIDER_PROVIDER_HH diff --git a/dune/xt/grid/gridprovider/provider.lib.hh b/dune/xt/grid/gridprovider/provider.lib.hh index b63e52f32e9b99bb29ab615eeed7162a5484376a..7cddb164033b8c25ef3610ebc2bbee239c63f21a 100644 --- a/dune/xt/grid/gridprovider/provider.lib.hh +++ b/dune/xt/grid/gridprovider/provider.lib.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017, 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_PROVIDER_PROVIDER_LIB_HH #define DUNE_XT_GRID_PROVIDER_PROVIDER_LIB_HH diff --git a/dune/xt/grid/gridprovider/provider.lib/alu_2d_simplex_conforming.cc b/dune/xt/grid/gridprovider/provider.lib/alu_2d_simplex_conforming.cc index 8886735649286c2f1a96ad3f49c1a54f1483bb45..7799eaee9277f1072385ba18ca2da10427ebcfb8 100644 --- a/dune/xt/grid/gridprovider/provider.lib/alu_2d_simplex_conforming.cc +++ b/dune/xt/grid/gridprovider/provider.lib/alu_2d_simplex_conforming.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/grid/gridprovider/provider.lib/yasp_1d_equidistant_offset.cc b/dune/xt/grid/gridprovider/provider.lib/yasp_1d_equidistant_offset.cc index f2b807c612655ea79622f6b6c5e2c4dcc577c8bf..39c550bf1e7c38b3f16fba9a8826711d6154405f 100644 --- a/dune/xt/grid/gridprovider/provider.lib/yasp_1d_equidistant_offset.cc +++ b/dune/xt/grid/gridprovider/provider.lib/yasp_1d_equidistant_offset.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/grid/gridprovider/provider.lib/yasp_2d_equidistant_offset.cc b/dune/xt/grid/gridprovider/provider.lib/yasp_2d_equidistant_offset.cc index 52e872963c0ad09e7db71c23239349abdb2309fc..59f145df3fd2395b2db4ddc3c3bed6563408d98f 100644 --- a/dune/xt/grid/gridprovider/provider.lib/yasp_2d_equidistant_offset.cc +++ b/dune/xt/grid/gridprovider/provider.lib/yasp_2d_equidistant_offset.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/grid/gridprovider/provider.lib/yasp_3d_equidistant_offset.cc b/dune/xt/grid/gridprovider/provider.lib/yasp_3d_equidistant_offset.cc index 0bc6dd0ea4ea253d5f8f2aa8fce22412d9604d24..e471c575e9abac3ebbe3f1477423657761963185 100644 --- a/dune/xt/grid/gridprovider/provider.lib/yasp_3d_equidistant_offset.cc +++ b/dune/xt/grid/gridprovider/provider.lib/yasp_3d_equidistant_offset.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/grid/gridprovider/starcd.hh b/dune/xt/grid/gridprovider/starcd.hh index b4f2ca672753123c25881819211cbc2b6292ddc9..9cfe3f3130837567a252c387180cfd8f3dae4dbc 100644 --- a/dune/xt/grid/gridprovider/starcd.hh +++ b/dune/xt/grid/gridprovider/starcd.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2017) // Kirsten Weber (2012 - 2013) -// René Fritze (2012 - 2018) -// Tobias Leibner (2014, 2018 - 2019) +// René Fritze (2012 - 2019) +// Tobias Leibner (2014, 2018 - 2020) #ifndef DUNE_XT_GRID_GRIDPROVIDER_STARCD_HH #define DUNE_XT_GRID_GRIDPROVIDER_STARCD_HH diff --git a/dune/xt/grid/grids.hh b/dune/xt/grid/grids.hh index 85cb7cbb3b64b2ceaac0c94ec3550df5fbce67cc..92b193d721aaa2e19d5a0b77ab050f132bfd3240 100644 --- a/dune/xt/grid/grids.hh +++ b/dune/xt/grid/grids.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2019) -// René Fritze (2017 - 2018) +// René Fritze (2017 - 2019) // Tim Keil (2018) -// Tobias Leibner (2016) +// Tobias Leibner (2016, 2020) #ifndef DUNE_XT_GRID_GRIDS_HH #define DUNE_XT_GRID_GRIDS_HH diff --git a/dune/xt/grid/information.hh b/dune/xt/grid/information.hh index bb5eb10a0d5245e5c98437bc12c20958689e3180..6b65183e910bab34f5b755b2375d900759eac5fb 100644 --- a/dune/xt/grid/information.hh +++ b/dune/xt/grid/information.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014 - 2018) -// René Fritze (2012 - 2018) +// René Fritze (2012 - 2019) // Sven Kaulmann (2014) -// Tobias Leibner (2014, 2016 - 2018) +// Tobias Leibner (2014, 2016 - 2018, 2020) #ifndef DUNE_XT_GRID_INFORMATION_HH #define DUNE_XT_GRID_INFORMATION_HH diff --git a/dune/xt/grid/integrals.hh b/dune/xt/grid/integrals.hh index 8b2cec5453e33d3d30dbb9f139fa0d53c2338912..981a1f839cf0bdabc75737dc643bc6f06a57e0a3 100644 --- a/dune/xt/grid/integrals.hh +++ b/dune/xt/grid/integrals.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_GRID_INTEGRALS_HH #define DUNE_XT_GRID_INTEGRALS_HH @@ -39,7 +40,7 @@ element_integral(const Entity<0, d, G, E>& element, { RangeType result(0.), local_result; for (auto&& quadrature_point : QuadratureRules<typename Entity<0, d, G, E>::Geometry::ctype, G::dimension>::rule( - element.geometry().type(), polynomial_order_of_the_function)) { + element.type(), polynomial_order_of_the_function)) { const auto point_in_reference_element = quadrature_point.position(); const auto quadrature_weight = quadrature_point.weight(); const auto integration_factor = element.geometry().integrationElement(point_in_reference_element); diff --git a/dune/xt/grid/intersection.hh b/dune/xt/grid/intersection.hh index a69dfb916f7456210e23d0fc6d8f4cdfa1ee6a55..8dfb84a49c7176586e5e0e5a5a91c30af39b3f4b 100644 --- a/dune/xt/grid/intersection.hh +++ b/dune/xt/grid/intersection.hh @@ -1,15 +1,15 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Andreas Buhr (2014) // Felix Schindler (2012 - 2019) -// René Fritze (2012 - 2013, 2015 - 2016, 2018) +// René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) // Sven Kaulmann (2013) -// Tobias Leibner (2014) +// Tobias Leibner (2014, 2020) #ifndef DUNE_XT_GRID_INTERSECTION_HH #define DUNE_XT_GRID_INTERSECTION_HH diff --git a/dune/xt/grid/layers.hh b/dune/xt/grid/layers.hh index 03fe4170e93de7e66bbafac7bbc41642dee91ab3..452dd2e8029104fd38e0033db879e745147bb3d6 100644 --- a/dune/xt/grid/layers.hh +++ b/dune/xt/grid/layers.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Andreas Buhr (2014) // Felix Schindler (2014 - 2017, 2019) -// René Fritze (2014 - 2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2014 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_GRID_LAYERS_HH #define DUNE_XT_GRID_LAYERS_HH diff --git a/dune/xt/grid/output/entity_visualization.hh b/dune/xt/grid/output/entity_visualization.hh index 0a556417ba39bfb59e69d7b4dcb0a9f7f7717759..de2592d59e46d7520ca9ea29a8fb7f16042caf79 100644 --- a/dune/xt/grid/output/entity_visualization.hh +++ b/dune/xt/grid/output/entity_visualization.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2013 - 2017, 2019) // René Fritze (2013 - 2016, 2018 - 2019) // Sven Kaulmann (2013) -// Tobias Leibner (2014, 2016) +// Tobias Leibner (2014, 2016, 2019 - 2020) #ifndef DUNE_XT_GRID_OUTPUT_ENTITY_VISUALIZATION_HH #define DUNE_XT_GRID_OUTPUT_ENTITY_VISUALIZATION_HH diff --git a/dune/xt/grid/output/pgf.hh b/dune/xt/grid/output/pgf.hh index 35155b487b3a1093c6de9d90789bc2210568185d..174c1acb718f8ce1bca06e36de3f94cb9ec63940 100644 --- a/dune/xt/grid/output/pgf.hh +++ b/dune/xt/grid/output/pgf.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Andreas Buhr (2014) // Felix Schindler (2013 - 2018) -// René Fritze (2012 - 2013, 2015 - 2016, 2018) -// Tobias Leibner (2014, 2016, 2018) +// René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2016, 2018, 2020) #ifndef DUNE_XT_GRID_OUTPUT_PGF_HH #define DUNE_XT_GRID_OUTPUT_PGF_HH diff --git a/dune/xt/grid/parallel/partitioning/ranged-internal.hh b/dune/xt/grid/parallel/partitioning/ranged-internal.hh index 96258911d2ccbdd1faa7dbdeba69d6ad686692ec..598f57f35a01dc8eccce194b7935f549abacc13f 100644 --- a/dune/xt/grid/parallel/partitioning/ranged-internal.hh +++ b/dune/xt/grid/parallel/partitioning/ranged-internal.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2020) #ifndef DUNE_XT_GRID_PARALLEL_PARTITIONING_RANGED_INTERNAL_HH #define DUNE_XT_GRID_PARALLEL_PARTITIONING_RANGED_INTERNAL_HH diff --git a/dune/xt/grid/parallel/partitioning/ranged.hh b/dune/xt/grid/parallel/partitioning/ranged.hh index b6ad77367504c31b89869eb702c47038cdfbdc7a..70f38b53ccc7c7c56dd251899de1a08f40157789 100644 --- a/dune/xt/grid/parallel/partitioning/ranged.hh +++ b/dune/xt/grid/parallel/partitioning/ranged.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2017 - 2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2017 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_GRID_PARALLEL_PARTITIONING_RANGED_HH #define DUNE_XT_GRID_PARALLEL_PARTITIONING_RANGED_HH diff --git a/dune/xt/grid/search.hh b/dune/xt/grid/search.hh index c8c27dbf21d27d6c399964f563ea6291debdd17c..4567be404f483e10a72cf49d0bb05e4d778f033b 100644 --- a/dune/xt/grid/search.hh +++ b/dune/xt/grid/search.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2017) -// René Fritze (2013 - 2016, 2018) -// Tobias Leibner (2014 - 2017) +// René Fritze (2013 - 2016, 2018 - 2019) +// Tobias Leibner (2014 - 2017, 2020) #ifndef DUNE_XT_GRID_SEARCH_HH #define DUNE_XT_GRID_SEARCH_HH @@ -100,7 +100,7 @@ private: { const auto& geometry = entity.geometry(); if (CheckInside<codim>::check(geometry, point)) { - return Common::make_unique<typename BaseType::EntityType>(entity); + return std::make_unique<typename BaseType::EntityType>(entity); } return nullptr; } @@ -178,7 +178,7 @@ private: { const auto& geometry = entity.geometry(); if (CheckInside<codim>::check(geometry, point)) { - return Common::make_unique<typename BaseType::EntityType>(entity); + return std::make_unique<typename BaseType::EntityType>(entity); } return nullptr; } diff --git a/dune/xt/grid/structuredgridfactory.hh b/dune/xt/grid/structuredgridfactory.hh index fb0ec241205df94ccdd7bd77afa1da7cec80bdfc..d16247e36ca79d4c8f0e67cc96cbcf9af885fc4a 100644 --- a/dune/xt/grid/structuredgridfactory.hh +++ b/dune/xt/grid/structuredgridfactory.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2017) -// René Fritze (2014 - 2016, 2018) +// René Fritze (2014 - 2016, 2018 - 2019) // Sven Kaulmann (2014) -// Tobias Leibner (2014, 2016, 2018) +// Tobias Leibner (2014, 2016, 2018, 2020) #ifndef DUNE_XT_GRID_STRUCTUREDGRIDFACTORY_HH #define DUNE_XT_GRID_STRUCTUREDGRIDFACTORY_HH diff --git a/dune/xt/grid/test/.gitignore b/dune/xt/grid/test/.gitignore index 7070f060e454046ec8ba336f9d198f11dcf5683a..6cc7cd31f48fdd0d5b7faa22d8441afe540f184e 100644 --- a/dune/xt/grid/test/.gitignore +++ b/dune/xt/grid/test/.gitignore @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2013, 2016 - 2017) -# René Fritze (2012, 2015 - 2018) -# Tobias Leibner (2016) +# René Fritze (2012, 2015 - 2019) +# Tobias Leibner (2016, 2020) # ~~~ test_validation diff --git a/dune/xt/grid/type_traits.hh b/dune/xt/grid/type_traits.hh index 1df49c634cbb47ba105198e10d2b1b71c3a8d7de..7fe9d3a76f77a115e1168dfecd4d4725d067ce1b 100644 --- a/dune/xt/grid/type_traits.hh +++ b/dune/xt/grid/type_traits.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2019) -// René Fritze (2016 - 2018) -// Tobias Leibner (2016 - 2019) +// René Fritze (2016 - 2019) +// Tobias Leibner (2016 - 2020) #ifndef DUNE_XT_GRID_TYPE_TRAITS_HH #define DUNE_XT_GRID_TYPE_TRAITS_HH diff --git a/dune/xt/grid/view/from-part.hh b/dune/xt/grid/view/from-part.hh index 51219b8d97bd5ca26adccb292e532957f36230ba..d86898fbb29466058650f27c04dc400b1b914c20 100644 --- a/dune/xt/grid/view/from-part.hh +++ b/dune/xt/grid/view/from-part.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017, 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_VIEW_FROM_PART_HH #define DUNE_XT_GRID_VIEW_FROM_PART_HH diff --git a/dune/xt/grid/view/periodic.hh b/dune/xt/grid/view/periodic.hh index b5c7dc388180494dfdd3b9632b06a4f946aaae5a..9b0cc9d70c65945836377347d7a7b8e8f9d55175 100644 --- a/dune/xt/grid/view/periodic.hh +++ b/dune/xt/grid/view/periodic.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2015 - 2018) -// René Fritze (2015 - 2018) -// Tobias Leibner (2015 - 2018) +// René Fritze (2015 - 2019) +// Tobias Leibner (2015 - 2018, 2020) #ifndef DUNE_XT_GRID_VIEW_PERIODIC_HH #define DUNE_XT_GRID_VIEW_PERIODIC_HH @@ -190,7 +190,7 @@ struct IndexMapCreatorBase const auto& type_index = index.first; const auto& entity_index = index.second; const auto periodic_entity_index = real_index_set_.index(periodic_entity); - const auto& periodic_entity_type_index = GlobalGeometryTypeIndex::index(periodic_entity.geometry().type()); + const auto& periodic_entity_type_index = GlobalGeometryTypeIndex::index(periodic_entity.type()); new_indices_[type_index][entity_index] = new_indices_[periodic_entity_type_index][periodic_entity_index]; } @@ -253,7 +253,7 @@ struct IndexMapCreator for (IndexType local_index = 0; local_index < codim0_entity.subEntities(codim); ++local_index) { const auto& entity = codim0_entity.template subEntity<codim>(local_index); const auto old_index = real_grid_layer_.indexSet().index(entity); - const auto type_index = GlobalGeometryTypeIndex::index(entity.geometry().type()); + const auto type_index = GlobalGeometryTypeIndex::index(entity.type()); if (!visited_entities_[type_index].count(old_index)) { this->loop_body(entity, type_index, old_index); visited_entities_[type_index].insert(old_index); @@ -283,7 +283,7 @@ struct IndexMapCreator<true, codim, DomainType, dimDomain, RealGridLayerType, In { for (const auto& entity : entities(real_grid_layer_, Dune::Codim<codim>())) { const auto old_index = real_grid_layer_.indexSet().index(entity); - const auto type_index = GlobalGeometryTypeIndex::index(entity.geometry().type()); + const auto type_index = GlobalGeometryTypeIndex::index(entity.type()); this->loop_body(entity, type_index, old_index); } this->after_loop(); @@ -345,7 +345,7 @@ public: if (cd == 0) return real_entity_index; else { - const auto type_index = GlobalGeometryTypeIndex::index(entity.geometry().type()); + const auto type_index = GlobalGeometryTypeIndex::index(entity.type()); return new_indices_[type_index][real_entity_index]; } } @@ -559,7 +559,7 @@ public: , has_boundary_intersections_(other.has_boundary_intersections_) , intersection_map_(other.intersection_map_) , nonperiodic_pair_(other.nonperiodic_pair_) - , current_intersection_(Dune::XT::Common::make_unique<Intersection>(*(other.current_intersection_))) + , current_intersection_(std::make_unique<Intersection>(*(other.current_intersection_))) {} // methods that differ from BaseType @@ -580,7 +580,7 @@ private: { assert(!has_boundary_intersections_ || intersection_map_.size() > static_cast<size_t>((BaseType::operator*()).indexInInside())); - return Common::make_unique<Intersection>( + return std::make_unique<Intersection>( IntersectionImp(BaseType::operator*(), real_grid_layer_, has_boundary_intersections_ ? intersection_map_[(BaseType::operator*()).indexInInside()] @@ -593,11 +593,11 @@ private: const RealIntersectionType real_intersection = is_iend ? *real_grid_layer_.ibegin(entity_) : BaseType::operator*(); assert(is_iend || !has_boundary_intersections_ || intersection_map_.size() > static_cast<size_t>(real_intersection.indexInInside())); - return Common::make_unique<Intersection>(IntersectionImp(real_intersection, - real_grid_layer_, - has_boundary_intersections_ && !is_iend - ? intersection_map_[real_intersection.indexInInside()] - : (const PeriodicPairType&)nonperiodic_pair_)); + return std::make_unique<Intersection>(IntersectionImp(real_intersection, + real_grid_layer_, + has_boundary_intersections_ && !is_iend + ? intersection_map_[real_intersection.indexInInside()] + : (const PeriodicPairType&)nonperiodic_pair_)); } // ... create_current_intersection_safely() const const RealGridLayerType& real_grid_layer_; @@ -661,7 +661,7 @@ public: { BaseType::operator++(); while (cd > 0 && *this != *real_it_end_ - && (*entities_to_skip_)[GlobalGeometryTypeIndex::index((*this)->geometry().type())].count( + && (*entities_to_skip_)[GlobalGeometryTypeIndex::index((*this)->type())].count( real_index_set_->index(this->operator*()))) BaseType::operator++(); return *this; @@ -885,7 +885,7 @@ public: IntersectionIterator ibegin(const typename Codim<0>::Entity& entity) const { - const auto& type_index = GlobalGeometryTypeIndex::index(entity.geometry().type()); + const auto& type_index = GlobalGeometryTypeIndex::index(entity.type()); assert(!entity.hasBoundaryIntersections() || (*entity_to_intersection_map_map_)[type_index].count(this->indexSet().index(entity))); return IntersectionIterator(BaseType::ibegin(entity), @@ -900,7 +900,7 @@ public: IntersectionIterator iend(const typename Codim<0>::Entity& entity) const { - const auto& type_index = GlobalGeometryTypeIndex::index(entity.geometry().type()); + const auto& type_index = GlobalGeometryTypeIndex::index(entity.type()); assert(!entity.hasBoundaryIntersections() || (*entity_to_intersection_map_map_)[type_index].count(this->indexSet().index(entity))); return IntersectionIterator(BaseType::iend(entity), diff --git a/dune/xt/grid/walker.hh b/dune/xt/grid/walker.hh index 5d5a697f0122284dccc700783b54f1ffb67a4f78..3cf9ea514b834b52cd7718c1d2291fc4a4a251a2 100644 --- a/dune/xt/grid/walker.hh +++ b/dune/xt/grid/walker.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2019) -// René Fritze (2014 - 2018) -// Tobias Leibner (2014 - 2015, 2017 - 2019) +// René Fritze (2014 - 2019) +// Tobias Leibner (2014 - 2015, 2017 - 2020) #ifndef DUNE_XT_GRID_WALKER_HH #define DUNE_XT_GRID_WALKER_HH diff --git a/dune/xt/grid/walker.lib.hh b/dune/xt/grid/walker.lib.hh index 47db44e73eb6a6300e6c86ada0db7fbbe273206b..50cf784eb88b1e67d0e5e53f512933effeaf0495 100644 --- a/dune/xt/grid/walker.lib.hh +++ b/dune/xt/grid/walker.lib.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017, 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_WALKER_LIB_HH #define DUNE_XT_GRID_WALKER_LIB_HH diff --git a/dune/xt/grid/walker.lib/alu_2d_simplex_conforming.cc b/dune/xt/grid/walker.lib/alu_2d_simplex_conforming.cc index 864376003310e768e3a1fcc445cdfcb3edfadf3e..8d37101c5cc86788f468ad23280eb1870c54a6da 100644 --- a/dune/xt/grid/walker.lib/alu_2d_simplex_conforming.cc +++ b/dune/xt/grid/walker.lib/alu_2d_simplex_conforming.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/grid/walker.lib/yasp_1d_equidistant_offset.cc b/dune/xt/grid/walker.lib/yasp_1d_equidistant_offset.cc index 7e81b4fce5fd3e483d427dc80509364730b16bd4..d9f324fa373e3e19fc1c2467d5fafc8e5db9e2af 100644 --- a/dune/xt/grid/walker.lib/yasp_1d_equidistant_offset.cc +++ b/dune/xt/grid/walker.lib/yasp_1d_equidistant_offset.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/grid/walker.lib/yasp_2d_equidistant_offset.cc b/dune/xt/grid/walker.lib/yasp_2d_equidistant_offset.cc index 0db1ad61467cdf1b56e29ba60e8f782b2cbaa885..75fd804fdc2bb76e5db20e3c870055c3653a1afa 100644 --- a/dune/xt/grid/walker.lib/yasp_2d_equidistant_offset.cc +++ b/dune/xt/grid/walker.lib/yasp_2d_equidistant_offset.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/grid/walker.lib/yasp_3d_equidistant_offset.cc b/dune/xt/grid/walker.lib/yasp_3d_equidistant_offset.cc index a2fe33bfe6d2a12124f3df356abbf8a7159090fb..c5eee053e756a27b8f18bba55a375e0d9d5e5e04 100644 --- a/dune/xt/grid/walker.lib/yasp_3d_equidistant_offset.cc +++ b/dune/xt/grid/walker.lib/yasp_3d_equidistant_offset.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <config.h> diff --git a/dune/xt/la/CMakeLists.txt b/dune/xt/la/CMakeLists.txt index 6e013ea864006f77257a1e0de46eeba1f0dc6300..4256060d1a6d4efea93d51c50c7ada5a8855aaf3 100644 --- a/dune/xt/la/CMakeLists.txt +++ b/dune/xt/la/CMakeLists.txt @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2016, 2018 - 2019) -# Tobias Leibner (2016 - 2018) +# Tobias Leibner (2016 - 2020) # ~~~ set(lib_dune_xt_la_sources container/pattern.cc eigen-solver/internal/numpy.cc) diff --git a/dune/xt/la/algorithms.hh b/dune/xt/la/algorithms.hh index 571d5b464a238244922808b488167d51fe4ade44..073d8305d480f46198e11174dd7455c209f1d50a 100644 --- a/dune/xt/la/algorithms.hh +++ b/dune/xt/la/algorithms.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_LA_ALGORITHMS_HH #define DUNE_XT_LA_ALGORITHMS_HH diff --git a/dune/xt/la/algorithms/cholesky.hh b/dune/xt/la/algorithms/cholesky.hh index 531cb8049d185bc4ee16d5679d64da4577a60991..df0b4d4de7bab39be37307ccb1799ded4c6c5f82 100644 --- a/dune/xt/la/algorithms/cholesky.hh +++ b/dune/xt/la/algorithms/cholesky.hh @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// René Fritze (2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_LA_ALGORITHMS_CHOLESKY_HH #define DUNE_XT_LA_ALGORITHMS_CHOLESKY_HH diff --git a/dune/xt/la/algorithms/qr.hh b/dune/xt/la/algorithms/qr.hh index 6c212117e91fdfbdb5c2f7e70c6bd8cd775652bf..e0ae422e137a28e5b7e22ca99eef449cde1b7137 100644 --- a/dune/xt/la/algorithms/qr.hh +++ b/dune/xt/la/algorithms/qr.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) -// René Fritze (2018) -// Tobias Leibner (2017 - 2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_LA_ALGORITHMS_QR_HH #define DUNE_XT_LA_ALGORITHMS_QR_HH diff --git a/dune/xt/la/algorithms/solve_sym_tridiag_posdef.hh b/dune/xt/la/algorithms/solve_sym_tridiag_posdef.hh index 95e958f32433d6eb67e1db6780b5ba041e46b6f4..e89b1ce7e09a06add57c5a92bafcd5f775f05595 100644 --- a/dune/xt/la/algorithms/solve_sym_tridiag_posdef.hh +++ b/dune/xt/la/algorithms/solve_sym_tridiag_posdef.hh @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// René Fritze (2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_LA_ALGORITHMS_SOLVE_SYM_TRIDIAG_POSDEF_HH #define DUNE_XT_LA_ALGORITHMS_SOLVE_SYM_TRIDIAG_POSDEF_HH diff --git a/dune/xt/la/algorithms/triangular_solves.hh b/dune/xt/la/algorithms/triangular_solves.hh index 7357dcaea7b96907bc8efce9fd0d80a509868bd2..1e9e3819246f41be34e8517ab2036490094bbff6 100644 --- a/dune/xt/la/algorithms/triangular_solves.hh +++ b/dune/xt/la/algorithms/triangular_solves.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) -// René Fritze (2018) -// Tobias Leibner (2017 - 2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_LA_ALGORITHMS_SOLVE_LOWER_TRIANGULAR_HH #define DUNE_XT_LA_ALGORITHMS_SOLVE_LOWER_TRIANGULAR_HH diff --git a/dune/xt/la/container.hh b/dune/xt/la/container.hh index d68dcaac1eb0ae04c06fe785ca0bfc1f879da26f..ea6925d0729b2aa240446e4b91c16e6673ce7dd9 100644 --- a/dune/xt/la/container.hh +++ b/dune/xt/la/container.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2017, 2019) -// René Fritze (2015 - 2016, 2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2015 - 2016, 2018 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_LA_CONTAINER_HH #define DUNE_XT_LA_CONTAINER_HH diff --git a/dune/xt/la/container/common.cc b/dune/xt/la/container/common.cc index cf44c9e3796d2f3fe2cb3c0e8d5778f0bc5e5edf..6842b8bbf667584e5b1fa38b09613d958f2ccf95 100644 --- a/dune/xt/la/container/common.cc +++ b/dune/xt/la/container/common.cc @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2017) +// Tobias Leibner (2017, 2020) #include <config.h> diff --git a/dune/xt/la/container/common.hh b/dune/xt/la/container/common.hh index 3d77bab2d42f30025d39051048a50986238d6d1d..f77b69a0ca596c15e7447104df119d627b32d6fd 100644 --- a/dune/xt/la/container/common.hh +++ b/dune/xt/la/container/common.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2013 - 2017) -// René Fritze (2014 - 2016, 2018) -// Tobias Leibner (2014, 2016 - 2017) +// René Fritze (2014 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2016 - 2017, 2020) #ifndef DUNE_XT_LA_CONTAINER_COMMON_HH #define DUNE_XT_LA_CONTAINER_COMMON_HH diff --git a/dune/xt/la/container/common/matrix.hh b/dune/xt/la/container/common/matrix.hh index af5ff40642a25753fd559e98a581dd6c24dce581..98125fd327094b6943950759ed97a7d0e58dcfe9 100644 --- a/dune/xt/la/container/common/matrix.hh +++ b/dune/xt/la/container/common/matrix.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2020) #ifndef DUNE_XT_LA_CONTAINER_COMMON_MATRIX_HH #define DUNE_XT_LA_CONTAINER_COMMON_MATRIX_HH diff --git a/dune/xt/la/container/common/matrix/dense.hh b/dune/xt/la/container/common/matrix/dense.hh index 79efd88b1b69bbd29b8a14990acec476bca367ca..2d5fdf5b7be5d3644df4f93b0c0aeb7dbe5cc3ae 100644 --- a/dune/xt/la/container/common/matrix/dense.hh +++ b/dune/xt/la/container/common/matrix/dense.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) -// Tobias Leibner (2017 - 2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_LA_CONTAINER_COMMON_MATRIX_DENSE_HH #define DUNE_XT_LA_CONTAINER_COMMON_MATRIX_DENSE_HH diff --git a/dune/xt/la/container/common/matrix/sparse.hh b/dune/xt/la/container/common/matrix/sparse.hh index 99b72a68cb12e87f315afec7b289e3d80e2a8510..b3d4e535d2103e2e7b865826ab5eaaa5eca08874 100644 --- a/dune/xt/la/container/common/matrix/sparse.hh +++ b/dune/xt/la/container/common/matrix/sparse.hh @@ -1,15 +1,15 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2013 - 2018) -// René Fritze (2014 - 2016, 2018) +// René Fritze (2014 - 2016, 2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2014, 2016 - 2019) +// Tobias Leibner (2014, 2016 - 2020) #ifndef DUNE_XT_LA_CONTAINER_COMMON_MATRIX_SPARSE_HH #define DUNE_XT_LA_CONTAINER_COMMON_MATRIX_SPARSE_HH diff --git a/dune/xt/la/container/common/vector.hh b/dune/xt/la/container/common/vector.hh index 1df5585af885dac67a78d89c0f3300abb34291d3..0e734f8398aa3a14d6550932e7a27f09514915fa 100644 --- a/dune/xt/la/container/common/vector.hh +++ b/dune/xt/la/container/common/vector.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2020) #ifndef DUNE_XT_LA_CONTAINER_COMMON_VECTOR_HH #define DUNE_XT_LA_CONTAINER_COMMON_VECTOR_HH diff --git a/dune/xt/la/container/common/vector/dense.hh b/dune/xt/la/container/common/vector/dense.hh index 307bc7030024e8379b0645e4efffa1376d6399f9..729c682116e86596750bbed05689f2dfeb85c06d 100644 --- a/dune/xt/la/container/common/vector/dense.hh +++ b/dune/xt/la/container/common/vector/dense.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018) -// René Fritze (2018) -// Tobias Leibner (2017 - 2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_LA_CONTAINER_COMMON_VECTOR_DENSE_HH #define DUNE_XT_LA_CONTAINER_COMMON_VECTOR_DENSE_HH diff --git a/dune/xt/la/container/common/vector/sparse.hh b/dune/xt/la/container/common/vector/sparse.hh index da1d9d39f81cf87c985c9f56ed408f4427d11a84..981078b8edfd930f1e0293d75901c246f1a53194 100644 --- a/dune/xt/la/container/common/vector/sparse.hh +++ b/dune/xt/la/container/common/vector/sparse.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018) -// René Fritze (2017 - 2018) -// Tobias Leibner (2017 - 2019) +// René Fritze (2017 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_LA_CONTAINER_COMMON_VECTOR_SPARSE_HH #define DUNE_XT_LA_CONTAINER_COMMON_VECTOR_SPARSE_HH diff --git a/dune/xt/la/container/container-interface.hh b/dune/xt/la/container/container-interface.hh index 7b3019f2402cc7d823ace7a6566ef848537cf259..08b66562b61cba2544fe21f91a7e8c4a073403e8 100644 --- a/dune/xt/la/container/container-interface.hh +++ b/dune/xt/la/container/container-interface.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2018) -// René Fritze (2014 - 2018) -// Tobias Leibner (2014 - 2015, 2017 - 2019) +// René Fritze (2014 - 2019) +// Tobias Leibner (2014 - 2015, 2017 - 2020) #ifndef DUNE_XT_LA_CONTAINER_CONTAINER_INTERFACE_HH #define DUNE_XT_LA_CONTAINER_CONTAINER_INTERFACE_HH diff --git a/dune/xt/la/container/conversion.hh b/dune/xt/la/container/conversion.hh index e09d0d827b1307c6bfc16c788788f761014424cd..dc6bd1daf051a8d1bd3762bbee3eb77845db5d76 100644 --- a/dune/xt/la/container/conversion.hh +++ b/dune/xt/la/container/conversion.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) -// René Fritze (2018) -// Tobias Leibner (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_EIGEN_CONTAINER_CONVERSION_HH #define DUNE_XT_LA_EIGEN_CONTAINER_CONVERSION_HH diff --git a/dune/xt/la/container/eigen.hh b/dune/xt/la/container/eigen.hh index b9bc30e7e31af55d69e65dc15e913e6b33ee6d05..1f60370a4dbe5c7709d8c4c2ddce5a7d1c25a2d9 100644 --- a/dune/xt/la/container/eigen.hh +++ b/dune/xt/la/container/eigen.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2014, 2016 - 2017) -// René Fritze (2013 - 2016, 2018) +// René Fritze (2013 - 2016, 2018 - 2019) // Sven Kaulmann (2014) -// Tobias Leibner (2014, 2017) +// Tobias Leibner (2014, 2017, 2020) #ifndef DUNE_XT_LA_CONTAINER_EIGEN_HH #define DUNE_XT_LA_CONTAINER_EIGEN_HH diff --git a/dune/xt/la/container/eigen/base.hh b/dune/xt/la/container/eigen/base.hh index f2abf29469eaf8599d6271720abc238ee7e0bc3a..ba66d1068ee15f86013ae51d5a25793edb32bd92 100644 --- a/dune/xt/la/container/eigen/base.hh +++ b/dune/xt/la/container/eigen/base.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2014 - 2018) -// René Fritze (2015 - 2016, 2018) -// Tobias Leibner (2014, 2017 - 2019) +// René Fritze (2015 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2017 - 2020) #ifndef DUNE_XT_LA_CONTAINER_EIGEN_BASE_HH #define DUNE_XT_LA_CONTAINER_EIGEN_BASE_HH @@ -96,8 +96,7 @@ public: VectorImpType& operator=(const ScalarType& value) { - for (auto& element : *this) - element = value; + *backend_ = BackendType::Constant(size(), value); return this->as_imp(); } // ... operator=(...) diff --git a/dune/xt/la/container/eigen/dense.cc b/dune/xt/la/container/eigen/dense.cc index 1f774a2f801eac760f302f8cf34f9ba76c88c955..2ced90b3429b2035f4eceb3892bf67cd74f6df6b 100644 --- a/dune/xt/la/container/eigen/dense.cc +++ b/dune/xt/la/container/eigen/dense.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2020) #include <config.h> diff --git a/dune/xt/la/container/eigen/dense.hh b/dune/xt/la/container/eigen/dense.hh index d9ead9abc96f6c9c97a1ce68bf4df670d4646a69..fb79e7890d69a77efbd6ed2cffe4ea2d5f9ca5b8 100644 --- a/dune/xt/la/container/eigen/dense.hh +++ b/dune/xt/la/container/eigen/dense.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2014 - 2018) -// René Fritze (2014 - 2016, 2018) -// Tobias Leibner (2014, 2016 - 2019) +// René Fritze (2014 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2016 - 2020) #ifndef DUNE_XT_LA_CONTAINER_EIGEN_DENSE_HH #define DUNE_XT_LA_CONTAINER_EIGEN_DENSE_HH @@ -225,6 +225,11 @@ public: return backend().data(); } + const DataType* data() const + { + return backend().data(); + } + size_t data_size() const { return this->size(); diff --git a/dune/xt/la/container/eigen/sparse.cc b/dune/xt/la/container/eigen/sparse.cc index cedb9f23198c77aa48f1e59722b592977e42c929..783569174006cf8538951e0e9e5ff9ce73bfb367 100644 --- a/dune/xt/la/container/eigen/sparse.cc +++ b/dune/xt/la/container/eigen/sparse.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2020) #include <config.h> diff --git a/dune/xt/la/container/eigen/sparse.hh b/dune/xt/la/container/eigen/sparse.hh index faf4be84064d11034f7c69b1848a87704cf81f0f..2f6ca5c603af189b9a66192d8efc5d7f98af2ee2 100644 --- a/dune/xt/la/container/eigen/sparse.hh +++ b/dune/xt/la/container/eigen/sparse.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2014 - 2018) -// René Fritze (2014 - 2016, 2018) -// Tobias Leibner (2014 - 2015, 2017 - 2019) +// René Fritze (2014 - 2016, 2018 - 2019) +// Tobias Leibner (2014 - 2015, 2017 - 2020) #ifndef DUNE_XT_LA_CONTAINER_EIGEN_SPARSE_HH #define DUNE_XT_LA_CONTAINER_EIGEN_SPARSE_HH diff --git a/dune/xt/la/container/eye-matrix.hh b/dune/xt/la/container/eye-matrix.hh index 56fb642ea2f38eba05094ff49fcb25974d368aed..b5ec630a9ccf7833741ba85d8b975c5165d02de4 100644 --- a/dune/xt/la/container/eye-matrix.hh +++ b/dune/xt/la/container/eye-matrix.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_CONTAINER_EYE_MATRIX_HH #define DUNE_XT_LA_CONTAINER_EYE_MATRIX_HH diff --git a/dune/xt/la/container/interfaces.hh b/dune/xt/la/container/interfaces.hh index 616b15d331e8d9590c7e03b8a41409fffc42a810..607650c8c32a9c82ab9e2e3b59c726b689c72964 100644 --- a/dune/xt/la/container/interfaces.hh +++ b/dune/xt/la/container/interfaces.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2014, 2016 - 2017) -// René Fritze (2013 - 2016, 2018) -// Tobias Leibner (2014, 2017) +// René Fritze (2013 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2017, 2020) #ifndef DUNE_XT_LA_CONTAINER_INTERFACES_HH #define DUNE_XT_LA_CONTAINER_INTERFACES_HH diff --git a/dune/xt/la/container/io.hh b/dune/xt/la/container/io.hh index 2715f8bdfc59cb10945ac956fa4526be33514b1e..588159b59b0f07f58b97a0b08223536ad28c73dd 100644 --- a/dune/xt/la/container/io.hh +++ b/dune/xt/la/container/io.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2020) #ifndef DUNE_XT_LA_CONTAINER_IO_HH #define DUNE_XT_LA_CONTAINER_IO_HH diff --git a/dune/xt/la/container/istl.cc b/dune/xt/la/container/istl.cc index 0b6765cd2c5f256a7704402a6d4b6a62b4321471..51e9e09a6e9cd7929393574c53ab724ef38bd7a6 100644 --- a/dune/xt/la/container/istl.cc +++ b/dune/xt/la/container/istl.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2020) #include <config.h> diff --git a/dune/xt/la/container/istl.hh b/dune/xt/la/container/istl.hh index 03400e7da88227e9133d8b142823bc203282485d..16359f95d4d978e60a23ae3013f6c1e697abb880 100644 --- a/dune/xt/la/container/istl.hh +++ b/dune/xt/la/container/istl.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,8 +8,8 @@ // Andreas Buhr (2014) // Barbara Verfürth (2015) // Felix Schindler (2013 - 2018) -// René Fritze (2014 - 2016, 2018) -// Tobias Leibner (2014, 2016 - 2019) +// René Fritze (2014 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2016 - 2020) #ifndef DUNE_XT_LA_CONTAINER_ISTL_HH #define DUNE_XT_LA_CONTAINER_ISTL_HH diff --git a/dune/xt/la/container/matrix-interface.hh b/dune/xt/la/container/matrix-interface.hh index f120e078fd428bac0e9e68d0f2b1c2941ffab0cf..3172e004ef0ae840bc3c4b5ade23050858d5b862 100644 --- a/dune/xt/la/container/matrix-interface.hh +++ b/dune/xt/la/container/matrix-interface.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2014 - 2018) -// René Fritze (2015 - 2016, 2018) -// Tobias Leibner (2014, 2017 - 2019) +// René Fritze (2015 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2017 - 2020) #ifndef DUNE_XT_LA_CONTAINER_MATRIX_INTERFACE_HH #define DUNE_XT_LA_CONTAINER_MATRIX_INTERFACE_HH @@ -357,7 +357,7 @@ public: template <int ROWS, int COLS> explicit operator std::unique_ptr<Dune::FieldMatrix<ScalarType, ROWS, COLS>>() const { - auto ret = XT::Common::make_unique<Dune::FieldMatrix<ScalarType, ROWS, COLS>>(ScalarType(0)); + auto ret = std::make_unique<Dune::FieldMatrix<ScalarType, ROWS, COLS>>(ScalarType(0)); CHECK_CRTP(this->as_imp().copy_to_densematrix(*ret)); this->as_imp().copy_to_densematrix(*ret); return ret; diff --git a/dune/xt/la/container/matrix-market.hh b/dune/xt/la/container/matrix-market.hh index db419bd1a9ca79af204f36bfb018f76b281a639c..2f5556c4377772491969cb1ee664155f32fa311a 100644 --- a/dune/xt/la/container/matrix-market.hh +++ b/dune/xt/la/container/matrix-market.hh @@ -1,11 +1,11 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Tobias Leibner (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_LA_CONTAINER_MATRIX_MARKET_HH #define DUNE_XT_LA_CONTAINER_MATRIX_MARKET_HH diff --git a/dune/xt/la/container/matrix-view.hh b/dune/xt/la/container/matrix-view.hh index 3e6524927007b35e146d1449212ccd220b9b7a38..3e08b397272b017d286a540b260b390512f621fa 100644 --- a/dune/xt/la/container/matrix-view.hh +++ b/dune/xt/la/container/matrix-view.hh @@ -1,11 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_LA_CONTAINER_MATRIX_VIEW_HH #define DUNE_XT_LA_CONTAINER_MATRIX_VIEW_HH diff --git a/dune/xt/la/container/pattern.cc b/dune/xt/la/container/pattern.cc index 3bdefcef3ca6a07966fd9b5521f0cdf2c68fa639..4bf9dcfc5a1ffdd5d330198329f15a49a05b0c1e 100644 --- a/dune/xt/la/container/pattern.cc +++ b/dune/xt/la/container/pattern.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2017) // René Fritze (2015 - 2016, 2018 - 2019) -// Tobias Leibner (2017 - 2019) +// Tobias Leibner (2017 - 2020) #include <cassert> #include <algorithm> diff --git a/dune/xt/la/container/pattern.hh b/dune/xt/la/container/pattern.hh index cfe9126d3ccc10f8d96f3d072c942e2428cc8887..c6013dca6546e1be5c07f586127b3f57bcbd709b 100644 --- a/dune/xt/la/container/pattern.hh +++ b/dune/xt/la/container/pattern.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2014, 2016 - 2017) -// René Fritze (2013 - 2016, 2018) +// René Fritze (2013 - 2016, 2018 - 2019) // Sven Kaulmann (2014) -// Tobias Leibner (2017 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_LA_CONTAINER_PATTERN_HH #define DUNE_XT_LA_CONTAINER_PATTERN_HH diff --git a/dune/xt/la/container/vector-array/interface.hh b/dune/xt/la/container/vector-array/interface.hh index 3b66f30862293b8049e976356b922fcfdc3c8c6a..6d8e6d8983a418969e41c18f16cef8495b473c6d 100644 --- a/dune/xt/la/container/vector-array/interface.hh +++ b/dune/xt/la/container/vector-array/interface.hh @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018) +// René Fritze (2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_LA_CONTAINER_VECTOR_ARRAY_INTERFACE_HH #define DUNE_XT_LA_CONTAINER_VECTOR_ARRAY_INTERFACE_HH diff --git a/dune/xt/la/container/vector-array/list.hh b/dune/xt/la/container/vector-array/list.hh index 7c0e01d75db0e3abe87be9d2e2099100ba01f30b..5f29d38bd2d45758cf0dac2c605dff50ae5da6db 100644 --- a/dune/xt/la/container/vector-array/list.hh +++ b/dune/xt/la/container/vector-array/list.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_LA_CONTAINER_VECTOR_ARRAY_LIST_HH #define DUNE_XT_LA_CONTAINER_VECTOR_ARRAY_LIST_HH diff --git a/dune/xt/la/container/vector-interface-internal.hh b/dune/xt/la/container/vector-interface-internal.hh index 9e8948924824511ccf8a31e456d694ac2144ecc2..257076042f9fc99f226dbb04dd71cde55525bb38 100644 --- a/dune/xt/la/container/vector-interface-internal.hh +++ b/dune/xt/la/container/vector-interface-internal.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2015 - 2017) -// René Fritze (2014 - 2016, 2018) -// Tobias Leibner (2014, 2017, 2019) +// René Fritze (2014 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2017, 2019 - 2020) #ifndef DUNE_XT_LA_CONTAINER_VECTOR_INTERFACE_INTERNAL_HH #define DUNE_XT_LA_CONTAINER_VECTOR_INTERFACE_INTERNAL_HH diff --git a/dune/xt/la/container/vector-interface.hh b/dune/xt/la/container/vector-interface.hh index 04274b335ee1ebbe54de023c59620f082e22b4e3..20862bbd5e33ffd9b6a9b579fb71630e777227f6 100644 --- a/dune/xt/la/container/vector-interface.hh +++ b/dune/xt/la/container/vector-interface.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2012 - 2019) -// René Fritze (2013 - 2018) -// Tobias Leibner (2014, 2017 - 2019) +// René Fritze (2013 - 2019) +// Tobias Leibner (2014, 2017 - 2020) #ifndef DUNE_XT_LA_CONTAINER_VECTOR_INTERFACE_HH #define DUNE_XT_LA_CONTAINER_VECTOR_INTERFACE_HH @@ -229,7 +229,7 @@ public: */ virtual std::pair<size_t, RealType> amax() const { - using std::abs; + using XT::Common::abs; auto result = std::make_pair(size_t(0), RealType(0)); for (size_t ii = 0; ii < size(); ++ii) { const auto value = abs(get_unchecked_ref(ii)); @@ -297,7 +297,7 @@ public: */ virtual RealType l1_norm() const { - using std::abs; + using XT::Common::abs; RealType result = 0; for (size_t ii = 0; ii < size(); ++ii) result += abs(get_unchecked_ref(ii)); @@ -317,8 +317,8 @@ public: */ virtual RealType l2_norm() const { - using std::abs; using std::sqrt; + using XT::Common::abs; return sqrt(abs(dot(this->as_imp()))); // std::abs is only needed for the right return type: // v.dot(v) should always be a ScalarType with zero imaginary part } diff --git a/dune/xt/la/container/vector-view.hh b/dune/xt/la/container/vector-view.hh index 0974df7f8bdf2178166e8349659366bf052ca147..7b7a7035dcd515a4436f31907cdb84af8205439e 100644 --- a/dune/xt/la/container/vector-view.hh +++ b/dune/xt/la/container/vector-view.hh @@ -1,11 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_LA_CONTAINER_VECTOR_VIEW_HH #define DUNE_XT_LA_CONTAINER_VECTOR_VIEW_HH diff --git a/dune/xt/la/eigen-solver.hh b/dune/xt/la/eigen-solver.hh index dd9c6fd85b87b8b4cd9fe77a70e14a484459004b..f3701a686c44c5333a3f8d709d51ece9142dc0d3 100644 --- a/dune/xt/la/eigen-solver.hh +++ b/dune/xt/la/eigen-solver.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_LA_EIGEN_SOLVER_HH #define DUNE_XT_LA_EIGEN_SOLVER_HH diff --git a/dune/xt/la/eigen-solver/default.hh b/dune/xt/la/eigen-solver/default.hh index e3ad5285ca3ba09fa096a1a017f7d7bc4fed01ab..a8a9f52e44d5543c3931dbd8c51562f208dfefd1 100644 --- a/dune/xt/la/eigen-solver/default.hh +++ b/dune/xt/la/eigen-solver/default.hh @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// René Fritze (2018) -// Tobias Leibner (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_EIGEN_SOLVER_DEFAULT_HH #define DUNE_XT_LA_EIGEN_SOLVER_DEFAULT_HH diff --git a/dune/xt/la/eigen-solver/eigen.hh b/dune/xt/la/eigen-solver/eigen.hh index 4b7c154315357135452fecea67365cd18ab034dd..c4b674a8d1fc82937c8acd6a4e61c7c7f3fe7824 100644 --- a/dune/xt/la/eigen-solver/eigen.hh +++ b/dune/xt/la/eigen-solver/eigen.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2017 - 2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2017 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_LA_EIGEN_SOLVER_EIGEN_HH #define DUNE_XT_LA_EIGEN_SOLVER_EIGEN_HH diff --git a/dune/xt/la/eigen-solver/fmatrix.hh b/dune/xt/la/eigen-solver/fmatrix.hh index caba6df43baba304cb5540fc24bcdf576d9037d3..2a5f66ad927215e9e591ce7cf2bfe973ccda7721 100644 --- a/dune/xt/la/eigen-solver/fmatrix.hh +++ b/dune/xt/la/eigen-solver/fmatrix.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2017 - 2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2017 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_LA_EIGEN_SOLVER_FMATRIX_HH #define DUNE_XT_LA_EIGEN_SOLVER_FMATRIX_HH diff --git a/dune/xt/la/eigen-solver/internal/base.hh b/dune/xt/la/eigen-solver/internal/base.hh index b12217ee141f28c2c322b4609a3d267974851ee2..44f5ea17cc8b77d08b49c3eff7fbe9eb1a9fe053 100644 --- a/dune/xt/la/eigen-solver/internal/base.hh +++ b/dune/xt/la/eigen-solver/internal/base.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) -// René Fritze (2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_LA_EIGEN_SOLVER_INTERNAL_BASE_HH #define DUNE_XT_LA_EIGEN_SOLVER_INTERNAL_BASE_HH diff --git a/dune/xt/la/eigen-solver/internal/eigen.hh b/dune/xt/la/eigen-solver/internal/eigen.hh index 8d4fca3087eb17889ba0c3670bca011bff1e6aee..3122863f3d4a309e7675cee1aead5efd50974279 100644 --- a/dune/xt/la/eigen-solver/internal/eigen.hh +++ b/dune/xt/la/eigen-solver/internal/eigen.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_LA_EIGEN_SOLVER_INTERNAL_EIGEN_HH #define DUNE_XT_LA_EIGEN_SOLVER_INTERNAL_EIGEN_HH diff --git a/dune/xt/la/eigen-solver/internal/lapacke.hh b/dune/xt/la/eigen-solver/internal/lapacke.hh index 16d9bfb56651808bea8ff11acb0b88196a4c5c71..9e7d69d70584397e28f11f926643bd2b42f5369e 100644 --- a/dune/xt/la/eigen-solver/internal/lapacke.hh +++ b/dune/xt/la/eigen-solver/internal/lapacke.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_LA_EIGEN_SOLVER_INTERNAL_LAPACKE_HH #define DUNE_XT_LA_EIGEN_SOLVER_INTERNAL_LAPACKE_HH diff --git a/dune/xt/la/eigen-solver/internal/numpy.cc b/dune/xt/la/eigen-solver/internal/numpy.cc index 7408be5b424ed5ca94e2d2e76bc1adb9727dd640..351a13ecb07d2b49f93cdeca8db5d938926fef5f 100644 --- a/dune/xt/la/eigen-solver/internal/numpy.cc +++ b/dune/xt/la/eigen-solver/internal/numpy.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include "config.h" diff --git a/dune/xt/la/eigen-solver/internal/numpy.hh b/dune/xt/la/eigen-solver/internal/numpy.hh index ad6af57e83d713788de6284d42ffa0f9b57afa64..800a3e3c7747e5dc5597581679f84b78c0fc4721 100644 --- a/dune/xt/la/eigen-solver/internal/numpy.hh +++ b/dune/xt/la/eigen-solver/internal/numpy.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_EIGEN_SOLVER_INTERNAL_NUMPY_HH #define DUNE_XT_LA_EIGEN_SOLVER_INTERNAL_NUMPY_HH diff --git a/dune/xt/la/eigen-solver/internal/shifted-qr.hh b/dune/xt/la/eigen-solver/internal/shifted-qr.hh index ab7eba724ede8b0eebc0add17149bf0ab4566658..b9834fb0d466e69ef416de6d04f5f1ee1672e986 100644 --- a/dune/xt/la/eigen-solver/internal/shifted-qr.hh +++ b/dune/xt/la/eigen-solver/internal/shifted-qr.hh @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// René Fritze (2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_LA_EIGEN_SOLVER_INTERNAL_SHIFTEDQR_HH #define DUNE_XT_LA_EIGEN_SOLVER_INTERNAL_SHIFTEDQR_HH diff --git a/dune/xt/la/exceptions.hh b/dune/xt/la/exceptions.hh index bef5965d0fee6999a970f1379c38df8eaace0f57..d6c79c2a6039f43fce986b9f79ed7240988e2376 100644 --- a/dune/xt/la/exceptions.hh +++ b/dune/xt/la/exceptions.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2020) #ifndef DUNE_XT_LA_EXCEPTIONS_HH #define DUNE_XT_LA_EXCEPTIONS_HH diff --git a/dune/xt/la/generalized-eigen-solver.hh b/dune/xt/la/generalized-eigen-solver.hh index 396712966f5abed8100e60c8ba743373f5be7a0d..fffd65d99a04e4e76566c6f0c4f1d4de0ddca0df 100644 --- a/dune/xt/la/generalized-eigen-solver.hh +++ b/dune/xt/la/generalized-eigen-solver.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017, 2019) -// René Fritze (2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2018, 2020) #ifndef DUNE_XT_LA_GENERALIZED_EIGEN_SOLVER_HH #define DUNE_XT_LA_GENERALIZED_EIGEN_SOLVER_HH diff --git a/dune/xt/la/generalized-eigen-solver/default.hh b/dune/xt/la/generalized-eigen-solver/default.hh index f1f93ed95796fb6ea5a1147a1828bd042774adcd..03f27a17a394440fc60af267c6a96b44d62e2ccd 100644 --- a/dune/xt/la/generalized-eigen-solver/default.hh +++ b/dune/xt/la/generalized-eigen-solver/default.hh @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_LA_GENERALIZED_EIGEN_SOLVER_DEFAULT_HH #define DUNE_XT_LA_GENERALIZED_EIGEN_SOLVER_DEFAULT_HH diff --git a/dune/xt/la/generalized-eigen-solver/internal/base.hh b/dune/xt/la/generalized-eigen-solver/internal/base.hh index 81a980c8bacf2e8e8602e2a00f7057060ad0d2aa..46bacab9ba7e6d73ce63a616736cd55da296a0d0 100644 --- a/dune/xt/la/generalized-eigen-solver/internal/base.hh +++ b/dune/xt/la/generalized-eigen-solver/internal/base.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) -// René Fritze (2018) -// Tobias Leibner (2017 - 2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_LA_GENERALIZED_EIGEN_SOLVER_INTERNAL_BASE_HH #define DUNE_XT_LA_GENERALIZED_EIGEN_SOLVER_INTERNAL_BASE_HH diff --git a/dune/xt/la/generalized-eigen-solver/internal/lapacke.hh b/dune/xt/la/generalized-eigen-solver/internal/lapacke.hh index ca0aaddc51bb4036978d7a26bfc87189d51c1ed8..b38beb378badbe8ed6304311695d4fef3ad82659 100644 --- a/dune/xt/la/generalized-eigen-solver/internal/lapacke.hh +++ b/dune/xt/la/generalized-eigen-solver/internal/lapacke.hh @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_LA_GENERALIZED_EIGEN_SOLVER_INTERNAL_LAPACKE_HH #define DUNE_XT_LA_GENERALIZED_EIGEN_SOLVER_INTERNAL_LAPACKE_HH diff --git a/dune/xt/la/matrix-inverter.hh b/dune/xt/la/matrix-inverter.hh index 08b158c653c184c109ab834f33093e035495ebe8..c1a7eea8730092cd654deac5fa05513d925bbaaa 100644 --- a/dune/xt/la/matrix-inverter.hh +++ b/dune/xt/la/matrix-inverter.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2017 - 2018) -// Tobias Leibner (2018) +// René Fritze (2017 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_MATRIX_INVERTER_HH #define DUNE_XT_LA_MATRIX_INVERTER_HH diff --git a/dune/xt/la/matrix-inverter/default.hh b/dune/xt/la/matrix-inverter/default.hh index 28a1d7952db0b57cc7e8855e02d15986b05f78f4..42326b168867aabb9bb8927eec312f485ba8c67b 100644 --- a/dune/xt/la/matrix-inverter/default.hh +++ b/dune/xt/la/matrix-inverter/default.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2017 - 2018) -// Tobias Leibner (2018) +// René Fritze (2017 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_MATRIX_INVERTER_DEFAULT_HH #define DUNE_XT_LA_MATRIX_INVERTER_DEFAULT_HH diff --git a/dune/xt/la/matrix-inverter/eigen.hh b/dune/xt/la/matrix-inverter/eigen.hh index dc7071fa2176c84bfafd739ee614a0dc84345bc8..8de2dda459b5b808d83ca773eb6c07d86fae97b4 100644 --- a/dune/xt/la/matrix-inverter/eigen.hh +++ b/dune/xt/la/matrix-inverter/eigen.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_MATRIX_INVERTER_EIGEN_HH #define DUNE_XT_LA_MATRIX_INVERTER_EIGEN_HH diff --git a/dune/xt/la/matrix-inverter/fmatrix.hh b/dune/xt/la/matrix-inverter/fmatrix.hh index db8dc973ba5d8866d7000ccc2f36805e87a14a82..c06110fdb25a110f03281f35e21dd35972765a0c 100644 --- a/dune/xt/la/matrix-inverter/fmatrix.hh +++ b/dune/xt/la/matrix-inverter/fmatrix.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2017 - 2018) -// Tobias Leibner (2018) +// René Fritze (2017 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_MATRIX_INVERTER_FMATRIX_HH #define DUNE_XT_LA_MATRIX_INVERTER_FMATRIX_HH diff --git a/dune/xt/la/matrix-inverter/internal/base.hh b/dune/xt/la/matrix-inverter/internal/base.hh index 9392b38dc316b54e419bd90167359763fdd42176..466f1783ce6f1016422b667e991f4d99159ba2d8 100644 --- a/dune/xt/la/matrix-inverter/internal/base.hh +++ b/dune/xt/la/matrix-inverter/internal/base.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2017 - 2018) -// Tobias Leibner (2018) +// René Fritze (2017 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_MATRIX_INVERTER_BASE_HH #define DUNE_XT_LA_MATRIX_INVERTER_BASE_HH diff --git a/dune/xt/la/matrix-inverter/internal/eigen.hh b/dune/xt/la/matrix-inverter/internal/eigen.hh index 4c7043c453b9800e9c93cee654f2600694aa62fb..63ce27c58e8e2bcbbb919f9d887516d1877d6093 100644 --- a/dune/xt/la/matrix-inverter/internal/eigen.hh +++ b/dune/xt/la/matrix-inverter/internal/eigen.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_MATRIX_INVERTER_INTERNAL_EIGEN_HH #define DUNE_XT_LA_MATRIX_INVERTER_INTERNAL_EIGEN_HH diff --git a/dune/xt/la/solver.hh b/dune/xt/la/solver.hh index 4ab6ecf2bb1554480d567a6f4c2af8320ae171e8..dd96d990bc728581602ca313dd3eebe8c405c828 100644 --- a/dune/xt/la/solver.hh +++ b/dune/xt/la/solver.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2019) -// René Fritze (2013, 2015 - 2016, 2018) -// Tobias Leibner (2014, 2018 - 2019) +// René Fritze (2013, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2018 - 2020) #ifndef DUNE_XT_LA_SOLVER_HH #define DUNE_XT_LA_SOLVER_HH diff --git a/dune/xt/la/solver/common.cc b/dune/xt/la/solver/common.cc index f28d8ead6efdf006a3f15408dcace939bdee4d7c..b46b8255d0d86b834970fd11b62f88e2547bff05 100644 --- a/dune/xt/la/solver/common.cc +++ b/dune/xt/la/solver/common.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2020) #include <config.h> diff --git a/dune/xt/la/solver/common.hh b/dune/xt/la/solver/common.hh index 151bff8c40b04ea70b8b2934c9a1ff85a31df58c..efb80389c44616ab26169545eb539bf080d06ab6 100644 --- a/dune/xt/la/solver/common.hh +++ b/dune/xt/la/solver/common.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2014 - 2018) -// René Fritze (2015 - 2018) -// Tobias Leibner (2014, 2018) +// René Fritze (2015 - 2019) +// Tobias Leibner (2014, 2018, 2020) #ifndef DUNE_XT_LA_SOLVER_COMMON_HH #define DUNE_XT_LA_SOLVER_COMMON_HH diff --git a/dune/xt/la/solver/dense.hh b/dune/xt/la/solver/dense.hh index 436d363be3273e6c068f41b6eff2c6ac0306d175..c2a4a284adcbd5a195cdf2a0f21f08c62e60ca5b 100644 --- a/dune/xt/la/solver/dense.hh +++ b/dune/xt/la/solver/dense.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2014 - 2019) -// René Fritze (2015 - 2018) -// Tobias Leibner (2014, 2018) +// René Fritze (2015 - 2019) +// Tobias Leibner (2014, 2018, 2020) #ifndef DUNE_XT_LA_SOLVER_DENSE_HH #define DUNE_XT_LA_SOLVER_DENSE_HH diff --git a/dune/xt/la/solver/eigen.cc b/dune/xt/la/solver/eigen.cc index cb8b2d0059a3c808e63fce3a65581d2e075c4c20..68b67225ca9a7e082013a1567c8d3b447b249995 100644 --- a/dune/xt/la/solver/eigen.cc +++ b/dune/xt/la/solver/eigen.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2020) #include <config.h> diff --git a/dune/xt/la/solver/eigen.hh b/dune/xt/la/solver/eigen.hh index 5b62b95330ba324d97c76332743cb6f4684f32e6..5739abeb83dfb15fb456e01f4c05c1d29dff2754 100644 --- a/dune/xt/la/solver/eigen.hh +++ b/dune/xt/la/solver/eigen.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2012 - 2017) -// René Fritze (2012 - 2013, 2015 - 2018) -// Tobias Leibner (2014, 2017 - 2019) +// René Fritze (2012 - 2013, 2015 - 2019) +// Tobias Leibner (2014, 2017 - 2020) #ifndef DUNE_XT_LA_SOLVER_EIGEN_HH #define DUNE_XT_LA_SOLVER_EIGEN_HH diff --git a/dune/xt/la/solver/fasp.hh b/dune/xt/la/solver/fasp.hh index 1f7ecc1eeb57bc199d441b97d8ea149980723844..469c89c8be6be5c7f1d0eb1db5c8fc50adb9878c 100644 --- a/dune/xt/la/solver/fasp.hh +++ b/dune/xt/la/solver/fasp.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2017) -// René Fritze (2013, 2015 - 2016, 2018) -// Tobias Leibner (2017) +// René Fritze (2013, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2017, 2020) #ifndef DUNE_XT_LA_SOLVER_FASP_HH #define DUNE_XT_LA_SOLVER_FASP_HH diff --git a/dune/xt/la/solver/istl.cc b/dune/xt/la/solver/istl.cc index 79c1f6efa8dd7beaa8987ef6e70ab730d0164cce..e240fb57ab1516c918412ebf0647ebfa777c8c8a 100644 --- a/dune/xt/la/solver/istl.cc +++ b/dune/xt/la/solver/istl.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) -// Tobias Leibner (2017) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017, 2020) #include <config.h> diff --git a/dune/xt/la/solver/istl.hh b/dune/xt/la/solver/istl.hh index 9b9a8c74c6214cbe0752ba6e45acadb0946b0cb2..68a45d8acd5608ee6d6fb41c6f744f87d709b1de 100644 --- a/dune/xt/la/solver/istl.hh +++ b/dune/xt/la/solver/istl.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2013 - 2019) -// René Fritze (2014 - 2018) -// Tobias Leibner (2014 - 2015, 2018 - 2019) +// René Fritze (2014 - 2019) +// Tobias Leibner (2014 - 2015, 2018 - 2020) #ifndef DUNE_XT_LA_SOLVER_ISTL_HH #define DUNE_XT_LA_SOLVER_ISTL_HH @@ -61,11 +61,14 @@ struct IstlSolverTraits } template <class SequentialPreconditionerType> - static BlockPreconditioner<IstlVectorType, IstlVectorType, CommunicatorType, SequentialPreconditionerType> - make_preconditioner(SequentialPreconditionerType& seq_preconditioner, const CommunicatorType& communicator) + static std::shared_ptr< + BlockPreconditioner<IstlVectorType, IstlVectorType, CommunicatorType, SequentialPreconditionerType>> + make_preconditioner(const std::shared_ptr<SequentialPreconditionerType>& seq_preconditioner, + const CommunicatorType& communicator) { - return BlockPreconditioner<IstlVectorType, IstlVectorType, CommunicatorType, SequentialPreconditionerType>( - seq_preconditioner, communicator); + return std::make_shared< + BlockPreconditioner<IstlVectorType, IstlVectorType, CommunicatorType, SequentialPreconditionerType>>( + *seq_preconditioner, communicator); } }; @@ -89,8 +92,9 @@ struct IstlSolverTraits<S, SequentialCommunication> } template <class SequentialPreconditionerType> - static SequentialPreconditionerType make_preconditioner(const SequentialPreconditionerType& seq_preconditioner, - const SequentialCommunication& /*communicator*/) + static std::shared_ptr<SequentialPreconditionerType> + make_preconditioner(const std::shared_ptr<SequentialPreconditionerType>& seq_preconditioner, + const SequentialCommunication& /*communicator*/) { return seq_preconditioner; } @@ -169,7 +173,7 @@ public: Solver(const MatrixType& matrix) : matrix_(matrix) - , communicator_(new CommunicatorType()) + , communicator_(CommunicatorType()) {} Solver(const MatrixType& matrix, const CommunicatorType& communicator) @@ -239,15 +243,15 @@ public: .call(writable_rhs, solution, opts, default_opts, type.substr(13)); } else if (type == "bicgstab.ilut") { auto matrix_operator = Traits::make_operator(matrix_.backend(), communicator_.access()); - typedef SeqILUn<typename MatrixType::BackendType, IstlVectorType, IstlVectorType> SequentialPreconditionerType; - SequentialPreconditionerType seq_preconditioner( + typedef SeqILU<typename MatrixType::BackendType, IstlVectorType, IstlVectorType> SequentialPreconditionerType; + auto seq_preconditioner = std::make_shared<SequentialPreconditionerType>( matrix_.backend(), opts.get("preconditioner.iterations", default_opts.get<int>("preconditioner.iterations")), opts.get("preconditioner.relaxation_factor", default_opts.get<S>("preconditioner.relaxation_factor"))); auto preconditioner = Traits::make_preconditioner(seq_preconditioner, communicator_.access()); BiCgSolverType solver(matrix_operator, scalar_product, - preconditioner, + *preconditioner, opts.get("precision", default_opts.get<R>("precision")), opts.get("max_iter", default_opts.get<int>("max_iter")), verbosity(opts, default_opts)); @@ -255,14 +259,14 @@ public: } else if (type == "bicgstab.ssor") { auto matrix_operator = Traits::make_operator(matrix_.backend(), communicator_.access()); typedef SeqSSOR<typename MatrixType::BackendType, IstlVectorType, IstlVectorType> SequentialPreconditionerType; - SequentialPreconditionerType seq_preconditioner( + auto seq_preconditioner = std::make_shared<SequentialPreconditionerType>( matrix_.backend(), opts.get("preconditioner.iterations", default_opts.get<int>("preconditioner.iterations")), opts.get("preconditioner.relaxation_factor", default_opts.get<S>("preconditioner.relaxation_factor"))); auto preconditioner = Traits::make_preconditioner(seq_preconditioner, communicator_.access()); BiCgSolverType solver(matrix_operator, scalar_product, - preconditioner, + *preconditioner, opts.get("precision", default_opts.get<S>("precision")), opts.get("max_iter", default_opts.get<int>("max_iter")), verbosity(opts, default_opts)); @@ -271,12 +275,12 @@ public: auto matrix_operator = Traits::make_operator(matrix_.backend(), communicator_.access()); const auto cat = matrix_operator.category(); typedef IdentityPreconditioner<MatrixOperatorType> SequentialPreconditioner; - SequentialPreconditioner seq_preconditioner(cat); + auto seq_preconditioner = std::make_shared<SequentialPreconditioner>(cat); auto preconditioner = Traits::make_preconditioner(seq_preconditioner, communicator_.access()); // define the BiCGStab as the actual solver BiCgSolverType solver(matrix_operator, scalar_product, - preconditioner, + *preconditioner, opts.get("precision", default_opts.get<S>("precision")), opts.get("max_iter", default_opts.get<int>("max_iter")), verbosity(opts, default_opts)); @@ -285,12 +289,12 @@ public: auto matrix_operator = Traits::make_operator(matrix_.backend(), communicator_.access()); const auto cat = matrix_operator.category(); typedef IdentityPreconditioner<MatrixOperatorType> SequentialPreconditioner; - SequentialPreconditioner seq_preconditioner(cat); + auto seq_preconditioner = std::make_shared<SequentialPreconditioner>(cat); auto preconditioner = Traits::make_preconditioner(seq_preconditioner, communicator_.access()); // define the CG as the actual solver CgSolverType solver(matrix_operator, scalar_product, - preconditioner, + *preconditioner, opts.get("precision", default_opts.get<S>("precision")), opts.get("max_iter", default_opts.get<int>("max_iter")), verbosity(opts, default_opts), diff --git a/dune/xt/la/solver/istl/amg.hh b/dune/xt/la/solver/istl/amg.hh index f11bb53316c310dea1222ef2c3769531e132553c..12cb72a2b00cd0f8946b60076664a2fd4997c1f5 100644 --- a/dune/xt/la/solver/istl/amg.hh +++ b/dune/xt/la/solver/istl/amg.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Barbara Verfürth (2015) // Felix Schindler (2014 - 2017, 2019) -// René Fritze (2014 - 2016, 2018) -// Tobias Leibner (2014, 2017 - 2019) +// René Fritze (2014 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2017 - 2020) #ifndef DUNE_XT_LA_SOLVER_ISTL_AMG_HH #define DUNE_XT_LA_SOLVER_ISTL_AMG_HH @@ -64,7 +64,7 @@ public: OverlappingSchwarzScalarProduct<IstlVectorType, CommunicatorType> scalar_product(communicator_); // ILU0 as the smoother for the AMG - typedef SeqILU0<IstlMatrixType, IstlVectorType, IstlVectorType, 1> SequentialSmootherType_ILU; + typedef SeqILU<IstlMatrixType, IstlVectorType, IstlVectorType, 1> SequentialSmootherType_ILU; typedef BlockPreconditioner<IstlVectorType, IstlVectorType, CommunicatorType, SequentialSmootherType_ILU> SmootherType_ILU; typename Amg::SmootherTraits<SmootherType_ILU>::Arguments smoother_parameters_ILU; @@ -186,7 +186,7 @@ public: InverseOperatorResult stats; if (smoother_type == "ilu0") { - typedef SeqILU0<IstlMatrixType, IstlVectorType, IstlVectorType> SmootherType; + typedef SeqILU<IstlMatrixType, IstlVectorType, IstlVectorType> SmootherType; typename Amg::SmootherTraits<SmootherType>::Arguments smoother_parameters; smoother_parameters.iterations = opts.get("smoother.iterations", default_opts.get<int>("smoother.iterations")); diff --git a/dune/xt/la/solver/istl/preconditioners.hh b/dune/xt/la/solver/istl/preconditioners.hh index 7a8f754984b74c9ed79ce5bae5cefac1180beb46..d69e566a9b3792a2719b9e290b7f936d7982f05a 100644 --- a/dune/xt/la/solver/istl/preconditioners.hh +++ b/dune/xt/la/solver/istl/preconditioners.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_LA_SOLVER_ISTL_PRECONDITIONERS_HH #define DUNE_XT_LA_SOLVER_ISTL_PRECONDITIONERS_HH diff --git a/dune/xt/la/solver/istl/saddlepoint.hh b/dune/xt/la/solver/istl/saddlepoint.hh index 3a91e60cd89a4700ba8fa4cc74e46d3c83a3c5b2..371a65f3b75bd83097db5fa8de465abd288afe60 100644 --- a/dune/xt/la/solver/istl/saddlepoint.hh +++ b/dune/xt/la/solver/istl/saddlepoint.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_LA_SOLVER_ISTL_SADDLEPOINT_HH #define DUNE_XT_LA_SOLVER_ISTL_SADDLEPOINT_HH diff --git a/dune/xt/la/solver/istl/schurcomplement.hh b/dune/xt/la/solver/istl/schurcomplement.hh index dffb5219d47876bd8975f565e145890eb869503c..06c71fb8b964ed5bf7cdd0276a55de37fa675a8e 100644 --- a/dune/xt/la/solver/istl/schurcomplement.hh +++ b/dune/xt/la/solver/istl/schurcomplement.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_LA_SOLVER_ISTL_SCHURCOMPLEMENT_HH #define DUNE_XT_LA_SOLVER_ISTL_SCHURCOMPLEMENT_HH diff --git a/dune/xt/la/solver/view.hh b/dune/xt/la/solver/view.hh index 5d745ebd16227337452c65d7ab7d38cfe60ac478..df76086ca7a141a98877b7288ed5da7314678dbf 100644 --- a/dune/xt/la/solver/view.hh +++ b/dune/xt/la/solver/view.hh @@ -1,11 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_LA_SOLVER_VIEW_HH #define DUNE_XT_LA_SOLVER_VIEW_HH diff --git a/dune/xt/la/test/.gitignore b/dune/xt/la/test/.gitignore index aa616ecc12adf301fdd9ba935481bd48d617620a..f144820393c3526fbfd8bea285f88996a2a9a25c 100644 --- a/dune/xt/la/test/.gitignore +++ b/dune/xt/la/test/.gitignore @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2013, 2016 - 2017) -# René Fritze (2012, 2015, 2017 - 2018) +# René Fritze (2012, 2015, 2017 - 2019) +# Tobias Leibner (2020) # ~~~ test_validation diff --git a/dune/xt/la/type_traits.hh b/dune/xt/la/type_traits.hh index 147b4fd21deb1123a85e9805358f5a4a9e2a0c9f..5ae588981c82416d3b22da30adc1b1da0df1580f 100644 --- a/dune/xt/la/type_traits.hh +++ b/dune/xt/la/type_traits.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2018) -// René Fritze (2018) -// Tobias Leibner (2017 - 2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2017 - 2020) #ifndef DUNE_XT_LA_TYPE_TRAITS_HH #define DUNE_XT_LA_TYPE_TRAITS_HH diff --git a/dune/xt/test/.gitignore b/dune/xt/test/.gitignore index 3663a3a62c82594cebd9bb30228a74105c62d956..cc35a27430be7919eb1498343b36f4c9b79623fe 100644 --- a/dune/xt/test/.gitignore +++ b/dune/xt/test/.gitignore @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2013, 2016 - 2017) # René Fritze (2012, 2015, 2018 - 2019) -# Tobias Leibner (2016) +# Tobias Leibner (2016, 2020) # ~~~ test_validation diff --git a/dune/xt/test/CMakeLists.txt b/dune/xt/test/CMakeLists.txt index 55000ca77f7aa71fa6ceff9cb20698cb332ea041..8fb4842a66b3d7b23a9feb281b2d5b717f26bc2e 100644 --- a/dune/xt/test/CMakeLists.txt +++ b/dune/xt/test/CMakeLists.txt @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2014 - 2016) # René Fritze (2012 - 2016, 2019) -# Tobias Leibner (2015 - 2016) +# Tobias Leibner (2015 - 2016, 2019 - 2020) # ~~~ enable_testing() diff --git a/dune/xt/test/common.cxx b/dune/xt/test/common.cxx index 163366214a591c97a1916afb6d1a5a8834166c31..d70d75f32f92b78101e644bef652b5034e00bcbe 100644 --- a/dune/xt/test/common.cxx +++ b/dune/xt/test/common.cxx @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2019) // René Fritze (2015 - 2019) -// Tobias Leibner (2016 - 2017, 2019) +// Tobias Leibner (2016 - 2017, 2019 - 2020) #include "config.h" diff --git a/dune/xt/test/common.hh b/dune/xt/test/common.hh index abadac3a6f3a52375d9f8a0ccd586f26179f3434..5bb0f423f327a73b13c6f153874e540ef851a332 100644 --- a/dune/xt/test/common.hh +++ b/dune/xt/test/common.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2017, 2019) // René Fritze (2015 - 2016, 2018 - 2019) -// Tobias Leibner (2016 - 2017, 2019) +// Tobias Leibner (2016 - 2017, 2019 - 2020) #ifndef DUNE_XT_COMMON_TEST_MAIN_COMMON_HH #define DUNE_XT_COMMON_TEST_MAIN_COMMON_HH diff --git a/dune/xt/test/common/algorithm.cc b/dune/xt/test/common/algorithm.cc index 35b1eeee770cd0a079e08279fbf8fb233a9048c4..02f0e945da1c14e33b62a5ee5606f3054dbf8364 100644 --- a/dune/xt/test/common/algorithm.cc +++ b/dune/xt/test/common/algorithm.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2015 - 2016, 2018 - 2019) -// Tobias Leibner (2016) +// Tobias Leibner (2016, 2020) #include <dune/xt/test/main.hxx> #include <vector> diff --git a/dune/xt/test/common/bisection.cc b/dune/xt/test/common/bisection.cc index 48da87169569cc451b57fa354b74da683a39f11c..8f5a7a1689b06f2d111b4837f1d08fd068bfec6c 100644 --- a/dune/xt/test/common/bisection.cc +++ b/dune/xt/test/common/bisection.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018) // René Fritze (2018 - 2019) -// Tobias Leibner (2019) +// Tobias Leibner (2019 - 2020) #include <dune/xt/test/main.hxx> // <- Has to come first, includes the config.h! #include <dune/xt/common/bisect.hh> diff --git a/dune/xt/test/common/color.cc b/dune/xt/test/common/color.cc index 6a799f8c68c9e427537416fd1c74f079fabd435d..2bb1d8f8e19bfe211e11ed5db28c25dc965e67c9 100644 --- a/dune/xt/test/common/color.cc +++ b/dune/xt/test/common/color.cc @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2012, 2014 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) // Stefan Girke (2012) -// Tobias Leibner (2014, 2016, 2018) +// Tobias Leibner (2014, 2016, 2018, 2020) #include <dune/xt/test/main.hxx> #include <dune/xt/common/color.hh> diff --git a/dune/xt/test/common/communicator.cc b/dune/xt/test/common/communicator.cc index ca4b92fcf6e8aaca2d86c41c34459f521327ae3d..5cf9d87f4ea7ccaa769ad0898d70208d8c03833a 100644 --- a/dune/xt/test/common/communicator.cc +++ b/dune/xt/test/common/communicator.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014, 2016 - 2017) // René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2016, 2018 - 2019) +// Tobias Leibner (2014, 2016, 2018 - 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/compile_pgf_output.sh b/dune/xt/test/common/compile_pgf_output.sh index f19d8e54c22f6e7d91dc4a5599c373f90574cce1..d34d62e64c8331eb2814e5816546ab33b442088e 100755 --- a/dune/xt/test/common/compile_pgf_output.sh +++ b/dune/xt/test/common/compile_pgf_output.sh @@ -3,14 +3,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2012, 2015, 2018 - 2019) -# Tobias Leibner (2016) +# Tobias Leibner (2016, 2020) # ~~~ make grid_output_pgf diff --git a/dune/xt/test/common/configuration.cc b/dune/xt/test/common/configuration.cc index f0be2894da44edf380669c04d4aa273f07be9187..03e0c91992973c19c6b162279a0ce0c153f530ba 100644 --- a/dune/xt/test/common/configuration.cc +++ b/dune/xt/test/common/configuration.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2017) // René Fritze (2012 - 2019) -// Tobias Leibner (2014, 2016) +// Tobias Leibner (2014, 2016, 2020) // This one has to come first (includes the config.h)! #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/crtp.cc b/dune/xt/test/common/crtp.cc index 25a9f68765ac29e08de2c6f8816cf8357abf2db2..8e778c093061d214cd73a000975570457f07b4ad 100644 --- a/dune/xt/test/common/crtp.cc +++ b/dune/xt/test/common/crtp.cc @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // René Fritze (2018 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) // This one has to come first (includes the config.h)! #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/debug.cc b/dune/xt/test/common/debug.cc index e5cffad2bf2d0afe0c0b8c0b84b0f54d7f644f9c..f77fa6a00b0fd3adcae5e3ad810b5c22357cf191 100644 --- a/dune/xt/test/common/debug.cc +++ b/dune/xt/test/common/debug.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014, 2016 - 2017) // René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2016, 2018) +// Tobias Leibner (2014, 2016, 2018 - 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/empty.cc b/dune/xt/test/common/empty.cc index 40c622ea40fcb52a2efcff4725d708cf5440a2ba..40769ce42c3bd30f3d53619820b519fdc395c224 100644 --- a/dune/xt/test/common/empty.cc +++ b/dune/xt/test/common/empty.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014, 2016 - 2017) // René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2016, 2018) +// Tobias Leibner (2014, 2016, 2018, 2020) /** * This file is intended as a starting point for quick testing. diff --git a/dune/xt/test/common/fixed_map.cc b/dune/xt/test/common/fixed_map.cc index 499b816692a899b83a9d39fe58876226b3c677ff..44d823271bf532ba0faef3c38f2657cba2ab7655 100644 --- a/dune/xt/test/common/fixed_map.cc +++ b/dune/xt/test/common/fixed_map.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2017) // René Fritze (2012 - 2019) -// Tobias Leibner (2014, 2016 - 2017) +// Tobias Leibner (2014, 2016 - 2017, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/float_cmp.cc b/dune/xt/test/common/float_cmp.cc index 73edc49d480587ed2d9eb7bb209d1e127579fd4f..ff853c8345749cdcab9caa962ee913c97813aa03 100644 --- a/dune/xt/test/common/float_cmp.cc +++ b/dune/xt/test/common/float_cmp.cc @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2015 - 2017) // René Fritze (2015 - 2019) // Tim Keil (2018) -// Tobias Leibner (2016 - 2019) +// Tobias Leibner (2016 - 2020) #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 diff --git a/dune/xt/test/common/float_cmp.hh b/dune/xt/test/common/float_cmp.hh index 78006e0e1eec552876c6a10c77fae9f8fab6c475..3de47247c8ab3b327f642989c603519b562cb64c 100644 --- a/dune/xt/test/common/float_cmp.hh +++ b/dune/xt/test/common/float_cmp.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2015 - 2016, 2018 - 2019) -// Tobias Leibner (2016) +// Tobias Leibner (2016, 2020) #ifndef DUNE_XT_COMMON_TEST_FLOAT_COMPARE_HH #define DUNE_XT_COMMON_TEST_FLOAT_COMPARE_HH diff --git a/dune/xt/test/common/float_cmp_generated.hxx b/dune/xt/test/common/float_cmp_generated.hxx index 98a05b64e1d27ad403d9e93c2dccfaaa4fc2348d..3ca2b29abb9447d67235055c980ddac589bff078 100644 --- a/dune/xt/test/common/float_cmp_generated.hxx +++ b/dune/xt/test/common/float_cmp_generated.hxx @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2016, 2018 - 2019) +// Tobias Leibner (2020) template <Dune::XT::Common::FloatCmp::Style style, class FirstType, diff --git a/dune/xt/test/common/fmatrix.cc b/dune/xt/test/common/fmatrix.cc index 52f7cde128cfa50d51c3ebe343abfe0cb0461fff..83b2ce6ff9ac7365cf1bd61339d9dae9066d0c47 100644 --- a/dune/xt/test/common/fmatrix.cc +++ b/dune/xt/test/common/fmatrix.cc @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // René Fritze (2018 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #include <dune/xt/test/main.hxx> // <- Needs to come first, include the config.h. diff --git a/dune/xt/test/common/fvector.cc b/dune/xt/test/common/fvector.cc index 85f08bf68d03fc0db520dede7c301865cbd933f2..c449adad54aeab7364ba9adc3646426b3384e67f 100644 --- a/dune/xt/test/common/fvector.cc +++ b/dune/xt/test/common/fvector.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2018 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #include <dune/xt/test/main.hxx> // <- Needs to come first, include the config.h. diff --git a/dune/xt/test/common/logging.cc b/dune/xt/test/common/logging.cc index dc474a9f611791d5a736fe31fa51c128fcbf4788..541150ac86582a73cab423c51c27edd8dd1fa515 100644 --- a/dune/xt/test/common/logging.cc +++ b/dune/xt/test/common/logging.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014 - 2017) // René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2016) +// Tobias Leibner (2014, 2016, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/math.cc b/dune/xt/test/common/math.cc index bf96168d1c8f6054fab26387e06708225b1e7575..083c4583d87e549eebcb467b21098bb84d84e3aa 100644 --- a/dune/xt/test/common/math.cc +++ b/dune/xt/test/common/math.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2016, 2019) +// Tobias Leibner (2014, 2016, 2019 - 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/matrix.cc b/dune/xt/test/common/matrix.cc index 414aed8384dc61a54796424d090082ddb0f3bec3..9a45d70f73a40f8613dfdde388969b63e2c9e8d4 100644 --- a/dune/xt/test/common/matrix.cc +++ b/dune/xt/test/common/matrix.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2018 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/memory.cc b/dune/xt/test/common/memory.cc index 675063850cd729af6c0f7c463054a923b0ad4a74..10d55ea4f572fdb4590112540f240596818b88db 100644 --- a/dune/xt/test/common/memory.cc +++ b/dune/xt/test/common/memory.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2016, 2018 - 2019) +// Tobias Leibner (2020) #include <dune/xt/test/main.hxx> @@ -21,8 +22,9 @@ using namespace Dune::XT::Common; struct ScopeTest : public testing::Test { - typedef int T; + using T = int; static constexpr T constant = 1; + template <class P> void deref(P& p) { @@ -31,6 +33,13 @@ struct ScopeTest : public testing::Test EXPECT_EQ(constant, g); } + template <class P> + void access(const P& p) + { + auto g = p.access(); + EXPECT_EQ(constant, g); + } + template <template <class F> class Provider, class P> void scope(P& p) { @@ -46,10 +55,20 @@ struct ScopeTest : public testing::Test scope<StorageProvider>(shared); deref(shared); } + + void check_const() + { + using CSP = ConstStorageProvider<T>; + access(CSP{new T(constant)}); + CSP{}; + T e{constant}; + CSP{e}; + } }; constexpr typename ScopeTest::T ScopeTest::constant; TEST_F(ScopeTest, All) { this->check_shared(); + this->check_const(); } diff --git a/dune/xt/test/common/numeric.cc b/dune/xt/test/common/numeric.cc index 8f785622cec78b369c0cbdbe755d2cbcc51ba50f..fda88a69eafe16820fe2d8b3b4048195d39c253d 100644 --- a/dune/xt/test/common/numeric.cc +++ b/dune/xt/test/common/numeric.cc @@ -1,13 +1,11 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2016 - 2017) -// René Fritze (2015 - 2016, 2018 - 2019) -// Tobias Leibner (2016) +// Tobias Leibner (2019 - 2020) #include <dune/xt/test/main.hxx> #include <vector> diff --git a/dune/xt/test/common/parallel.cc b/dune/xt/test/common/parallel.cc index b104186ea101934381f5c9d1a5c6576b06b08444..0dc46fc291c23a8f65299bc371053a1b7b40f44b 100644 --- a/dune/xt/test/common/parallel.cc +++ b/dune/xt/test/common/parallel.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2014 - 2016, 2018 - 2019) -// Tobias Leibner (2016, 2018) +// Tobias Leibner (2016, 2018, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/parallel/mpi_comm_wrapper.cc b/dune/xt/test/common/parallel/mpi_comm_wrapper.cc index fe96633c577d21e49dfe25c7d1124964946b0c6c..2b375cdf68d0c0330b57688e863235b417811a3f 100644 --- a/dune/xt/test/common/parallel/mpi_comm_wrapper.cc +++ b/dune/xt/test/common/parallel/mpi_comm_wrapper.cc @@ -1,11 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// René Fritze (2018 - 2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/parameter.cc b/dune/xt/test/common/parameter.cc index cefaa4e4414c22036bfe438f88cbfcdc4f7caa9c..55d97647238ce646311240c960589bef885f53e1 100644 --- a/dune/xt/test/common/parameter.cc +++ b/dune/xt/test/common/parameter.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) // René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/print.cc b/dune/xt/test/common/print.cc index 66a719d0ad40e754e2fbad7bd2b302b0b598744f..d397d95bfb2d2c21bae2d1fdfc2a9b7fe624757b 100644 --- a/dune/xt/test/common/print.cc +++ b/dune/xt/test/common/print.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2015 - 2016, 2018 - 2019) -// Tobias Leibner (2016) +// Tobias Leibner (2016, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/random.cc b/dune/xt/test/common/random.cc index 0e8e727c283d50e26e4a75370ef4a84db2c91396..8a23f7d8c864f84c0044d004024e6e5d07bd8827 100644 --- a/dune/xt/test/common/random.cc +++ b/dune/xt/test/common/random.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2016 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/string.cc b/dune/xt/test/common/string.cc index 6c4d396e262f05b1992093ba3ae3efbde1eb67a7..82bdea21ebe39e96e062935a8eafe3d9388d0de5 100644 --- a/dune/xt/test/common/string.cc +++ b/dune/xt/test/common/string.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2018) // René Fritze (2012 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2016, 2018) +// Tobias Leibner (2014, 2016, 2018 - 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/timedlogging.cc b/dune/xt/test/common/timedlogging.cc index 77cda36612e900606be54fb945a629b6a035a013..6e213b9d7751c0dc72d4e41b2e3db65066fd1358 100644 --- a/dune/xt/test/common/timedlogging.cc +++ b/dune/xt/test/common/timedlogging.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2017) // René Fritze (2014 - 2016, 2018 - 2019) -// Tobias Leibner (2016) +// Tobias Leibner (2016, 2020) #ifndef DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS # define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 0 diff --git a/dune/xt/test/common/timings.cc b/dune/xt/test/common/timings.cc index ec455cb8e016462bd270a7af23f94d8e42e64f85..5485e9965060ffe33d9352702b9343eea9704d69 100644 --- a/dune/xt/test/common/timings.cc +++ b/dune/xt/test/common/timings.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2016, 2018) +// Tobias Leibner (2014, 2016, 2018, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/tuple.cc b/dune/xt/test/common/tuple.cc index d0fdbd6b626d0fdecd1e01b38c871b54e1dcae66..98d44609da85da1f38f9cb0b79fd1c80be99aa2e 100644 --- a/dune/xt/test/common/tuple.cc +++ b/dune/xt/test/common/tuple.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2016) +// Tobias Leibner (2014, 2016, 2020) #include <tuple> diff --git a/dune/xt/test/common/type_traits.cc b/dune/xt/test/common/type_traits.cc index fe2cd4f30b48047fed1eb2df81c0c2cf67b947d0..8a88911eb0b958bc2b62c2db6ab8d22b562baabb 100644 --- a/dune/xt/test/common/type_traits.cc +++ b/dune/xt/test/common/type_traits.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014, 2016 - 2017) // René Fritze (2012 - 2013, 2015 - 2019) -// Tobias Leibner (2014, 2016) +// Tobias Leibner (2014, 2016, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/type_utils.cc b/dune/xt/test/common/type_utils.cc index 14a1d3302d64eede0fb030abb528452af602ee8f..e9ba9cdf0d4d98714a7c6287858b3367201c4982 100644 --- a/dune/xt/test/common/type_utils.cc +++ b/dune/xt/test/common/type_utils.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2016) +// Tobias Leibner (2014, 2016, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/validation.cc b/dune/xt/test/common/validation.cc index 7e0ba69a9aa0d01e1e2fc88a48ebbdc36715d624..102bff8c6b6d020adb5f24644258a4c065f09c87 100644 --- a/dune/xt/test/common/validation.cc +++ b/dune/xt/test/common/validation.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014, 2016 - 2017) // René Fritze (2012 - 2019) -// Tobias Leibner (2014, 2016) +// Tobias Leibner (2014, 2016, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/common/vector_statistics.cc b/dune/xt/test/common/vector_statistics.cc index f9c29b1d7b747f4e72b8d5cd5870e507458ca960..6c42e2237069fe9c2fa5a0cd09406029f7d4e94f 100644 --- a/dune/xt/test/common/vector_statistics.cc +++ b/dune/xt/test/common/vector_statistics.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012, 2014, 2016 - 2017) // René Fritze (2012 - 2013, 2015 - 2019) -// Tobias Leibner (2014, 2016) +// Tobias Leibner (2014, 2016, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/ESV2007_cutoff_1d.py b/dune/xt/test/functions/ESV2007_cutoff_1d.py index 15048db73b2fc4eb94bb85f68878f38e73b430b9..47c8c7b59a6d981456f700b2f92140f6e0582f93 100644 --- a/dune/xt/test/functions/ESV2007_cutoff_1d.py +++ b/dune/xt/test/functions/ESV2007_cutoff_1d.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/ESV2007_cutoff_1d.tpl b/dune/xt/test/functions/ESV2007_cutoff_1d.tpl index 962847a61e9eaeb15639937edd51846e9480a291..a4a187715e351b787779dd6ab4f0b18a8671aab8 100644 --- a/dune/xt/test/functions/ESV2007_cutoff_1d.tpl +++ b/dune/xt/test/functions/ESV2007_cutoff_1d.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2015 - 2017) -// Rene Milk (2015 - 2016, 2018) -// Tobias Leibner (2015 - 2016) +// René Fritze (2019) +// Tim Keil (2018) #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 diff --git a/dune/xt/test/functions/ESV2007_cutoff_2d_3d.py b/dune/xt/test/functions/ESV2007_cutoff_2d_3d.py index e7739a5e907ed88152c4a34f61206892fd7bf8b7..849bfe002b2e0973a632774766c0c6837b49483d 100644 --- a/dune/xt/test/functions/ESV2007_cutoff_2d_3d.py +++ b/dune/xt/test/functions/ESV2007_cutoff_2d_3d.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/ESV2007_cutoff_2d_3d.tpl b/dune/xt/test/functions/ESV2007_cutoff_2d_3d.tpl index ab6cfad9fd4f2735c83aa39af485599a3978b0a6..97f3f2670ef468e125bd9e99b5ce57a622f250f9 100644 --- a/dune/xt/test/functions/ESV2007_cutoff_2d_3d.tpl +++ b/dune/xt/test/functions/ESV2007_cutoff_2d_3d.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2015 - 2017) -// Rene Milk (2015 - 2016, 2018) -// Tobias Leibner (2015 - 2016) +// René Fritze (2019) +// Tim Keil (2018) #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 diff --git a/dune/xt/test/functions/ESV2007_exact_solution.py b/dune/xt/test/functions/ESV2007_exact_solution.py index b73ba30c772337bca24ee5e58226088a20c29823..f65dd8c757653509cee4934b108f213b6c49c7cf 100644 --- a/dune/xt/test/functions/ESV2007_exact_solution.py +++ b/dune/xt/test/functions/ESV2007_exact_solution.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/ESV2007_exact_solution.tpl b/dune/xt/test/functions/ESV2007_exact_solution.tpl index d05374020d89e520f8aead7c0f17a6e81655fb23..5f226befe72fa62a71a65d9a41aa2f1aa5c29df7 100644 --- a/dune/xt/test/functions/ESV2007_exact_solution.tpl +++ b/dune/xt/test/functions/ESV2007_exact_solution.tpl @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2015 - 2017) -// Rene Milk (2015 - 2016, 2018) -// Tobias Leibner (2015 - 2016) +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018) #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 diff --git a/dune/xt/test/functions/ESV2007_force.py b/dune/xt/test/functions/ESV2007_force.py index b73ba30c772337bca24ee5e58226088a20c29823..f65dd8c757653509cee4934b108f213b6c49c7cf 100644 --- a/dune/xt/test/functions/ESV2007_force.py +++ b/dune/xt/test/functions/ESV2007_force.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/ESV2007_force.tpl b/dune/xt/test/functions/ESV2007_force.tpl index 862a09c1c2df54ad1b6e58569e77f985d01e967c..045ca243355751d29c78de417777ed7172902bd3 100644 --- a/dune/xt/test/functions/ESV2007_force.tpl +++ b/dune/xt/test/functions/ESV2007_force.tpl @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2015 - 2017) -// Rene Milk (2015 - 2016, 2018) -// Tobias Leibner (2015 - 2016) +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018) #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 diff --git a/dune/xt/test/functions/checkerboard.py b/dune/xt/test/functions/checkerboard.py index 89b81c3187880a1d606034730910145cfbd43369..fc32d7c0542e448cd4fec456559362a3f060ae92 100644 --- a/dune/xt/test/functions/checkerboard.py +++ b/dune/xt/test/functions/checkerboard.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/checkerboard.tpl b/dune/xt/test/functions/checkerboard.tpl index 974e78a4fec55df2778d02307efff5d275f4b220..cc481e0c2ac743178af3f8469226fb0f3def96d4 100644 --- a/dune/xt/test/functions/checkerboard.tpl +++ b/dune/xt/test/functions/checkerboard.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018) + #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/constant.py b/dune/xt/test/functions/constant.py index 89b81c3187880a1d606034730910145cfbd43369..fc32d7c0542e448cd4fec456559362a3f060ae92 100644 --- a/dune/xt/test/functions/constant.py +++ b/dune/xt/test/functions/constant.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/constant.tpl b/dune/xt/test/functions/constant.tpl index 6b7d6ca0e78cd622b949cea441637d1b97fce480..50d367d1c786ad4bc1035f8151a640d112976035 100644 --- a/dune/xt/test/functions/constant.tpl +++ b/dune/xt/test/functions/constant.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018 - 2019) + #include <dune/xt/test/main.hxx> #include <dune/xt/grid/grids.hh> diff --git a/dune/xt/test/functions/difference.py b/dune/xt/test/functions/difference.py index 89b81c3187880a1d606034730910145cfbd43369..fc32d7c0542e448cd4fec456559362a3f060ae92 100644 --- a/dune/xt/test/functions/difference.py +++ b/dune/xt/test/functions/difference.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/difference.tpl b/dune/xt/test/functions/difference.tpl index 0ff518c8c43e27dfab272fa778d1c64113c6fd40..dc5f4b73847489da6e7b662962f1f14dbee1823d 100644 --- a/dune/xt/test/functions/difference.tpl +++ b/dune/xt/test/functions/difference.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018) + #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/expression_matrix_valued.py b/dune/xt/test/functions/expression_matrix_valued.py index 2524170c88f4bdb863572c80b3a971ddfd3dae8b..67484dc63fb71df98fbb2991de49e32153d606b5 100644 --- a/dune/xt/test/functions/expression_matrix_valued.py +++ b/dune/xt/test/functions/expression_matrix_valued.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/expression_matrix_valued.tpl b/dune/xt/test/functions/expression_matrix_valued.tpl index 98d3d097f9e4b147e27591e870e48a0b71065d4a..0b7f16ae6edf1fe47a6cbae80e74e44ce8c56049 100644 --- a/dune/xt/test/functions/expression_matrix_valued.tpl +++ b/dune/xt/test/functions/expression_matrix_valued.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018) + #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/expression_parametric.py b/dune/xt/test/functions/expression_parametric.py index 26c0cba63f19508f456b4082a440c12f8e6e7e55..b98f6169506e9d0c57deb6e3d6ff01ac9abd42da 100644 --- a/dune/xt/test/functions/expression_parametric.py +++ b/dune/xt/test/functions/expression_parametric.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/expression_parametric.tpl b/dune/xt/test/functions/expression_parametric.tpl index fc4f07ac2f515fe1c54ba0c9148af49b95b94233..a88923b1741b23dee4bb134b1ce2f6486668fa40 100644 --- a/dune/xt/test/functions/expression_parametric.tpl +++ b/dune/xt/test/functions/expression_parametric.tpl @@ -1,3 +1,13 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) + #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/expression_vector_valued.py b/dune/xt/test/functions/expression_vector_valued.py index 26c0cba63f19508f456b4082a440c12f8e6e7e55..b98f6169506e9d0c57deb6e3d6ff01ac9abd42da 100644 --- a/dune/xt/test/functions/expression_vector_valued.py +++ b/dune/xt/test/functions/expression_vector_valued.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/expression_vector_valued.tpl b/dune/xt/test/functions/expression_vector_valued.tpl index 46a62e823044b62c1c23edff60f16bb10b94c2d7..6cd5a98a2b7b43f8075ce5d3da457d3a484fdab2 100644 --- a/dune/xt/test/functions/expression_vector_valued.tpl +++ b/dune/xt/test/functions/expression_vector_valued.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018) + #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/flattop.py b/dune/xt/test/functions/flattop.py index 4349ac7f5a61a000342316f110b9078da3de85f9..7a431db1bde12dbf1848fd3a4f8f974df8af66cf 100644 --- a/dune/xt/test/functions/flattop.py +++ b/dune/xt/test/functions/flattop.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/flattop.tpl b/dune/xt/test/functions/flattop.tpl index b8ade446eeb36114361afef665d95eba4bb0100b..bfb971286e01c528530cd67a47d8804c6058e625 100644 --- a/dune/xt/test/functions/flattop.tpl +++ b/dune/xt/test/functions/flattop.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018) + #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/generic_flux_function.py b/dune/xt/test/functions/generic_flux_function.py index 0d376ead262eb73c4136b104e8cae599f25646a9..d1b711f8a7250edb05497f956ca667a146667870 100644 --- a/dune/xt/test/functions/generic_flux_function.py +++ b/dune/xt/test/functions/generic_flux_function.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/generic_flux_function.tpl b/dune/xt/test/functions/generic_flux_function.tpl index 99d07faf9c2cabadf7774b272e74e485bba34832..3d49c5bd77597cfaeb84127ebacd17a6d666a1dc 100644 --- a/dune/xt/test/functions/generic_flux_function.tpl +++ b/dune/xt/test/functions/generic_flux_function.tpl @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2014 - 2017) -// Rene Milk (2014 - 2016, 2018) -// Tobias Leibner (2014 - 2017) +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018 - 2019) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/generic_function.py b/dune/xt/test/functions/generic_function.py index 89b81c3187880a1d606034730910145cfbd43369..fc32d7c0542e448cd4fec456559362a3f060ae92 100644 --- a/dune/xt/test/functions/generic_function.py +++ b/dune/xt/test/functions/generic_function.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/generic_function.tpl b/dune/xt/test/functions/generic_function.tpl index db37ed0cb1d3a2a7b04136de7149f7e84448b041..4f4ee03b0ab8a944721ef6da670fbb435e3abd08 100644 --- a/dune/xt/test/functions/generic_function.tpl +++ b/dune/xt/test/functions/generic_function.tpl @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2014 - 2017) -// Rene Milk (2014 - 2016, 2018) -// Tobias Leibner (2014 - 2017) +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018 - 2019) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/generic_grid_function.py b/dune/xt/test/functions/generic_grid_function.py index 89b81c3187880a1d606034730910145cfbd43369..fc32d7c0542e448cd4fec456559362a3f060ae92 100644 --- a/dune/xt/test/functions/generic_grid_function.py +++ b/dune/xt/test/functions/generic_grid_function.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/generic_grid_function.tpl b/dune/xt/test/functions/generic_grid_function.tpl index fddca0a72cf3462bfcc6e46bbba0f1886c9dd547..68f01edf82ef99b6358ce7419f5d73085b1620b5 100644 --- a/dune/xt/test/functions/generic_grid_function.tpl +++ b/dune/xt/test/functions/generic_grid_function.tpl @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2014 - 2017) -// Rene Milk (2014 - 2016, 2018) -// Tobias Leibner (2014 - 2017) +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018 - 2019) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/grid_function.cc b/dune/xt/test/functions/grid_function.cc index c7bf1727b796c85c60bc598f6d543d2045e5e75f..e47fa810ed80a45cf1359607d89b25b9176edbdc 100644 --- a/dune/xt/test/functions/grid_function.cc +++ b/dune/xt/test/functions/grid_function.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) // René Fritze (2019) +// Tobias Leibner (2020) #include <dune/xt/test/main.hxx> // <- Has to come first, includes the config.h! @@ -96,7 +97,7 @@ GTEST_TEST(ScalarGridFunction, constructible_from_function_lvalueptr) } GTEST_TEST(ScalarGridFunction, convertible_from_function_lvalueptr) { - accepts_scalar_grid_function(new GenericFunction<d>{0, [](auto&, auto&) { return 1.; }, "THE_NAME"}); + accepts_scalar_grid_function(GenericFunction<d>{0, [](auto&, auto&) { return 1.; }, "THE_NAME"}); } GTEST_TEST(ScalarGridFunction, constructible_from_grid_function_rvalueref) { @@ -118,7 +119,7 @@ GTEST_TEST(ScalarGridFunction, constructible_from_grid_function_lvalueptr) GTEST_TEST(ScalarGridFunction, convertible_from_grid_function_lvalueptr) { accepts_scalar_grid_function( - new GenericGridFunction<E>{0, [](auto&) {}, [](auto&, auto&) { return 1.; }, {}, "THE_NAME"}); + GenericGridFunction<E>{0, [](auto&) {}, [](auto&, auto&) { return 1.; }, {}, "THE_NAME"}); } @@ -159,7 +160,7 @@ GTEST_TEST(VectorGridFunction, constructible_from_function_lvalueptr) } GTEST_TEST(VectorGridFunction, convertible_from_function_lvalueptr) { - accepts_vector_grid_function(new GenericFunction<d, r>{0, [](auto&, auto&) { return 1.; }, "THE_NAME"}); + accepts_vector_grid_function(GenericFunction<d, r>{0, [](auto&, auto&) { return 1.; }, "THE_NAME"}); } GTEST_TEST(VectorGridFunction, constructible_from_grid_function_rvalueref) { @@ -182,7 +183,7 @@ GTEST_TEST(VectorGridFunction, constructible_from_grid_function_lvalueptr) GTEST_TEST(VectorGridFunction, convertible_from_grid_function_lvalueptr) { accepts_vector_grid_function( - new GenericGridFunction<E, r>{0, [](auto&) {}, [](auto&, auto&) { return 1.; }, {}, "THE_NAME"}); + GenericGridFunction<E, r>{0, [](auto&) {}, [](auto&, auto&) { return 1.; }, {}, "THE_NAME"}); } @@ -231,7 +232,7 @@ GTEST_TEST(SquareMatrixGridFunction, constructible_from_function_lvalueptr) } GTEST_TEST(SquareMatrixGridFunction, convertible_from_function_lvalueptr) { - accepts_square_matrix_grid_function(new GenericFunction<d, r, r>{0, [](auto&, auto&) { return 1.; }, "THE_NAME"}); + accepts_square_matrix_grid_function(GenericFunction<d, r, r>{0, [](auto&, auto&) { return 1.; }, "THE_NAME"}); } GTEST_TEST(SquareMatrixGridFunction, constructible_from_grid_function_rvalueref) { @@ -254,7 +255,7 @@ GTEST_TEST(SquareMatrixGridFunction, constructible_from_grid_function_lvalueptr) GTEST_TEST(SquareMatrixGridFunction, convertible_from_grid_function_lvalueptr) { accepts_square_matrix_grid_function( - new GenericGridFunction<E, r, r>{0, [](auto&) {}, [](auto&, auto&) { return 1.; }, {}, "THE_NAME"}); + GenericGridFunction<E, r, r>{0, [](auto&) {}, [](auto&, auto&) { return 1.; }, {}, "THE_NAME"}); } @@ -295,7 +296,7 @@ GTEST_TEST(MatrixGridFunction, constructible_from_function_lvalueptr) } GTEST_TEST(MatrixGridFunction, convertible_from_function_lvalueptr) { - accepts_matrix_grid_function(new GenericFunction<d, r, rC>{0, [](auto&, auto&) { return 1.; }, "THE_NAME"}); + accepts_matrix_grid_function(GenericFunction<d, r, rC>{0, [](auto&, auto&) { return 1.; }, "THE_NAME"}); } GTEST_TEST(MatrixGridFunction, constructible_from_grid_function_rvalueref) { @@ -318,5 +319,5 @@ GTEST_TEST(MatrixGridFunction, constructible_from_grid_function_lvalueptr) GTEST_TEST(MatrixGridFunction, convertible_from_grid_function_lvalueptr) { accepts_matrix_grid_function( - new GenericGridFunction<E, r, rC>{0, [](auto&) {}, [](auto&, auto&) { return 1.; }, {}, "THE_NAME"}); + GenericGridFunction<E, r, rC>{0, [](auto&) {}, [](auto&, auto&) { return 1.; }, {}, "THE_NAME"}); } diff --git a/dune/xt/test/functions/grids.py b/dune/xt/test/functions/grids.py index 3e8b757374db94484749fbb012dc7586fe674a6d..4827214ff655d64438da6ec391bde5c08e3ed3b6 100644 --- a/dune/xt/test/functions/grids.py +++ b/dune/xt/test/functions/grids.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import itertools diff --git a/dune/xt/test/functions/indicator_function.py b/dune/xt/test/functions/indicator_function.py index 070123d7e85ab075b6f2da99106a7819ce883ecd..3f1b5b7264cffb396177ede82ff23e8bbd9dd3b8 100644 --- a/dune/xt/test/functions/indicator_function.py +++ b/dune/xt/test/functions/indicator_function.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/indicator_function.tpl b/dune/xt/test/functions/indicator_function.tpl index d3dda9b0f6aeafb508d9e3c1a3b0d68cc74aec65..66c302673a92a14dea20ab31ede69d901c15e1eb 100644 --- a/dune/xt/test/functions/indicator_function.tpl +++ b/dune/xt/test/functions/indicator_function.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018 - 2019) + #include <dune/xt/test/main.hxx> #include <dune/xt/grid/grids.hh> diff --git a/dune/xt/test/functions/indicator_grid_function.py b/dune/xt/test/functions/indicator_grid_function.py index 070123d7e85ab075b6f2da99106a7819ce883ecd..3f1b5b7264cffb396177ede82ff23e8bbd9dd3b8 100644 --- a/dune/xt/test/functions/indicator_grid_function.py +++ b/dune/xt/test/functions/indicator_grid_function.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/indicator_grid_function.tpl b/dune/xt/test/functions/indicator_grid_function.tpl index 77b13821f8d2d5b0fe8d5386652d6d5f457803de..9f50dd72435fbe9c4fe3c1e76c0dc1754545841f 100644 --- a/dune/xt/test/functions/indicator_grid_function.tpl +++ b/dune/xt/test/functions/indicator_grid_function.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018 - 2019) + #include <dune/xt/test/main.hxx> #include <dune/xt/grid/grids.hh> diff --git a/dune/xt/test/functions/product.py b/dune/xt/test/functions/product.py index 89b81c3187880a1d606034730910145cfbd43369..fc32d7c0542e448cd4fec456559362a3f060ae92 100644 --- a/dune/xt/test/functions/product.py +++ b/dune/xt/test/functions/product.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/product.tpl b/dune/xt/test/functions/product.tpl index 421216dcc8cffbccf300a54ef7728c803b1692c5..e2bd308cb8172d95ff10ac05f1a0e770eb2431cd 100644 --- a/dune/xt/test/functions/product.tpl +++ b/dune/xt/test/functions/product.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018) + #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/spe10_model1.py b/dune/xt/test/functions/spe10_model1.py index b73ba30c772337bca24ee5e58226088a20c29823..f65dd8c757653509cee4934b108f213b6c49c7cf 100644 --- a/dune/xt/test/functions/spe10_model1.py +++ b/dune/xt/test/functions/spe10_model1.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/spe10_model1.tpl b/dune/xt/test/functions/spe10_model1.tpl index 5c321d8670bb3d775bde90a42ed154da2050f75d..36d5c60d6ccd5eac61ba6d879666d8a8d01d7fe5 100644 --- a/dune/xt/test/functions/spe10_model1.tpl +++ b/dune/xt/test/functions/spe10_model1.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018) + #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/spe10_model2.py b/dune/xt/test/functions/spe10_model2.py index cab751a15e5191e5fec5384a4909282c7c1c04c9..20b3a76d630f9c4c85d361710aed26a979f17e4c 100644 --- a/dune/xt/test/functions/spe10_model2.py +++ b/dune/xt/test/functions/spe10_model2.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/spe10_model2.tpl b/dune/xt/test/functions/spe10_model2.tpl index a0eb499dc894bc0d7ff2d8769cef3012264e0fed..3bfeaa265742a7a808e7a2d1699ab9867a0a948f 100644 --- a/dune/xt/test/functions/spe10_model2.tpl +++ b/dune/xt/test/functions/spe10_model2.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018 - 2019) + #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/sum_for_functions.py b/dune/xt/test/functions/sum_for_functions.py index 89b81c3187880a1d606034730910145cfbd43369..fc32d7c0542e448cd4fec456559362a3f060ae92 100644 --- a/dune/xt/test/functions/sum_for_functions.py +++ b/dune/xt/test/functions/sum_for_functions.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/sum_for_functions.tpl b/dune/xt/test/functions/sum_for_functions.tpl index 79b4b16cda62e074ef941fd6b2056b21384ca5cd..cd5c4ed5bf647951ab85cbed68d32de2738d5820 100644 --- a/dune/xt/test/functions/sum_for_functions.tpl +++ b/dune/xt/test/functions/sum_for_functions.tpl @@ -1,3 +1,13 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) + #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/sum_for_grid_functions.py b/dune/xt/test/functions/sum_for_grid_functions.py index 89b81c3187880a1d606034730910145cfbd43369..fc32d7c0542e448cd4fec456559362a3f060ae92 100644 --- a/dune/xt/test/functions/sum_for_grid_functions.py +++ b/dune/xt/test/functions/sum_for_grid_functions.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/sum_for_grid_functions.tpl b/dune/xt/test/functions/sum_for_grid_functions.tpl index a61f29d6fc9cb5d425becb81ee236f387398550c..944178261be6de79a22dfada1517c1a03673cbb7 100644 --- a/dune/xt/test/functions/sum_for_grid_functions.tpl +++ b/dune/xt/test/functions/sum_for_grid_functions.tpl @@ -1,3 +1,14 @@ +// This file is part of the dune-xt project: +// https://github.com/dune-community/dune-xt +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +// License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +// or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +// with "runtime exception" (http://www.dune-project.org/license.html) +// Authors: +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018) + #define DUNE_XT_COMMON_TEST_MAIN_CATCH_EXCEPTIONS 1 #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/functions/visualization.py b/dune/xt/test/functions/visualization.py index 26c0cba63f19508f456b4082a440c12f8e6e7e55..b98f6169506e9d0c57deb6e3d6ff01ac9abd42da 100644 --- a/dune/xt/test/functions/visualization.py +++ b/dune/xt/test/functions/visualization.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import grids diff --git a/dune/xt/test/functions/visualization.tpl b/dune/xt/test/functions/visualization.tpl index b285efaec6001f9c759b4f93a0c6187a9e18a918..aa6af896212e989f483fd1b3a0a1120ab71d2804 100644 --- a/dune/xt/test/functions/visualization.tpl +++ b/dune/xt/test/functions/visualization.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2014 - 2017) -// Rene Milk (2014 - 2016, 2018) -// Tobias Leibner (2014 - 2017) +// René Fritze (2019) +// Tobias Leibner (2019) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/gmsh_2d_simplices.msh b/dune/xt/test/gmsh_2d_simplices.msh index 0ed9df7f5b978d6d87835699dd4ef5c2ba0d4728..392b64fccb86051ec85c7d7c2979cb05ce77b134 100644 --- a/dune/xt/test/gmsh_2d_simplices.msh +++ b/dune/xt/test/gmsh_2d_simplices.msh @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2018 - 2019) -# Tobias Leibner (2016) +# Tobias Leibner (2016, 2020) # ~~~ $MeshFormat diff --git a/dune/xt/test/grid/CMakeLists.txt b/dune/xt/test/grid/CMakeLists.txt index f869e8c722dbf8ac7a027747e43986e2b0d53167..52c72bc74d2d19a3949560f220f11a73356ff4b8 100644 --- a/dune/xt/test/grid/CMakeLists.txt +++ b/dune/xt/test/grid/CMakeLists.txt @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2016 - 2019) -# Tobias Leibner (2016, 2018) +# Tobias Leibner (2016, 2018, 2020) # ~~~ dxt_exclude_from_headercheck(dd_subdomains_cube.hh) diff --git a/dune/xt/test/grid/boundaryinfo_factory.cc b/dune/xt/test/grid/boundaryinfo_factory.cc index db7ecb387f11e5b7e660941a7905d33da19869e2..71ad539775520bf6c27d96a69b2f0c1e0d9e510c 100644 --- a/dune/xt/test/grid/boundaryinfo_factory.cc +++ b/dune/xt/test/grid/boundaryinfo_factory.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2018 - 2019) -// Tobias Leibner (2016) +// Tobias Leibner (2016, 2020) /** * This file is intended as a starting point for quick testing. diff --git a/dune/xt/test/grid/cube_gridprovider.cc b/dune/xt/test/grid/cube_gridprovider.cc index 8f12c1509871ad59623d27ee6def3c7bb5bfb3bc..8dbdebaa24edf184dd12ab56259df38b3471df14 100644 --- a/dune/xt/test/grid/cube_gridprovider.cc +++ b/dune/xt/test/grid/cube_gridprovider.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) -// Tobias Leibner (2014 - 2016) +// Tobias Leibner (2014 - 2016, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/grid/dd_glued.hh b/dune/xt/test/grid/dd_glued.hh index bd7c4fa24191e843efeea4a3a9944e135c8613eb..6ee39f21fac265188868639346783c55771b5d19 100644 --- a/dune/xt/test/grid/dd_glued.hh +++ b/dune/xt/test/grid/dd_glued.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) // René Fritze (2018 - 2019) +// Tobias Leibner (2019 - 2020) #ifndef DUNE_XT_GRID_TEST_DD_GLUED_HH #define DUNE_XT_GRID_TEST_DD_GLUED_HH diff --git a/dune/xt/test/grid/dd_glued_2d.cc b/dune/xt/test/grid/dd_glued_2d.cc index d43e510114021a46af41e4f550bfca137b31551b..81ed00ad9e2a7cf8a60aabf97abd9006d3f91eb3 100644 --- a/dune/xt/test/grid/dd_glued_2d.cc +++ b/dune/xt/test/grid/dd_glued_2d.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) // René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <dune/xt/test/main.hxx> // <- this one has to come first (includes the config.h)! diff --git a/dune/xt/test/grid/dd_glued_3d.cc b/dune/xt/test/grid/dd_glued_3d.cc index c492304179d0c37f1d9058bfc10d48063407492d..eda7d9e528b2bb73ef86268a2457372cf0308a3c 100644 --- a/dune/xt/test/grid/dd_glued_3d.cc +++ b/dune/xt/test/grid/dd_glued_3d.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2018) // René Fritze (2018 - 2019) -// Tobias Leibner (2017 - 2019) +// Tobias Leibner (2017 - 2020) #include <dune/xt/test/main.hxx> // <- this one has to come first (includes the config.h)! diff --git a/dune/xt/test/grid/dgf_gridprovider.cc b/dune/xt/test/grid/dgf_gridprovider.cc index 6b05aa42f4c951479c3f110ea8329c06a0ed84ea..eaf6356521fd08bdc8a94f3f71d6d97f07a3ccf3 100644 --- a/dune/xt/test/grid/dgf_gridprovider.cc +++ b/dune/xt/test/grid/dgf_gridprovider.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/grid/eoc_gridprovider.py b/dune/xt/test/grid/eoc_gridprovider.py index fe6c8eaa6f8a0b78c2753c1080ebe4089a903e31..e765df3f48ea2d4195bbc5bdcb95e56b327b1158 100644 --- a/dune/xt/test/grid/eoc_gridprovider.py +++ b/dune/xt/test/grid/eoc_gridprovider.py @@ -1,12 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: -# René Fritze (2018 - 2019) +# René Fritze (2018 - 2019) +# Tobias Leibner (2020) # ~~~ import dune.xt.grid.types as grid_types diff --git a/dune/xt/test/grid/eoc_gridprovider.tpl b/dune/xt/test/grid/eoc_gridprovider.tpl index ce797963bc6ba7d76de1dc3771206c9216b5b84f..e2e94e914166ccb0c5647f512169b6e883af4a2d 100644 --- a/dune/xt/test/grid/eoc_gridprovider.tpl +++ b/dune/xt/test/grid/eoc_gridprovider.tpl @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Rene Milk (2018) +// Felix Schindler (2012, 2014, 2016 - 2017, 2019) +// René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2016, 2018) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/grid/gmsh_gridprovider.cc b/dune/xt/test/grid/gmsh_gridprovider.cc index 387713556ae9c9c01a16b051caa9da6f479819eb..37a93d48f7a7c6a3939671e18ba9d9f4af13fc14 100644 --- a/dune/xt/test/grid/gmsh_gridprovider.cc +++ b/dune/xt/test/grid/gmsh_gridprovider.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) -// Tobias Leibner (2014 - 2016) +// Tobias Leibner (2014 - 2016, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/grid/information.cc b/dune/xt/test/grid/information.cc index 22ff2de95a82c0c1fe1c96f2c17e107f990366b6..f3a1a7df9d810427534bb3dd856d50809ba78535 100644 --- a/dune/xt/test/grid/information.cc +++ b/dune/xt/test/grid/information.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2017, 2019) // René Fritze (2012 - 2016, 2018 - 2019) -// Tobias Leibner (2014 - 2016) +// Tobias Leibner (2014 - 2016, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/grid/mpi_grid.py b/dune/xt/test/grid/mpi_grid.py index fe6c8eaa6f8a0b78c2753c1080ebe4089a903e31..e765df3f48ea2d4195bbc5bdcb95e56b327b1158 100644 --- a/dune/xt/test/grid/mpi_grid.py +++ b/dune/xt/test/grid/mpi_grid.py @@ -1,12 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: -# René Fritze (2018 - 2019) +# René Fritze (2018 - 2019) +# Tobias Leibner (2020) # ~~~ import dune.xt.grid.types as grid_types diff --git a/dune/xt/test/grid/mpi_grid.tpl b/dune/xt/test/grid/mpi_grid.tpl index 5122bf9eeebe2fbc6872fba32e90b1f77318db77..2dfbb3e2d62636c8e1c8c7b1ffbae9337e72e7bb 100644 --- a/dune/xt/test/grid/mpi_grid.tpl +++ b/dune/xt/test/grid/mpi_grid.tpl @@ -1,11 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Rene Milk (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2019) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/grid/output.py b/dune/xt/test/grid/output.py index fadf84eb0368d4fd77652282d625261070ce6fd2..39049799870fc7cd0181acee1968e717d90fbfbc 100644 --- a/dune/xt/test/grid/output.py +++ b/dune/xt/test/grid/output.py @@ -1,12 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: -# René Fritze (2019) +# René Fritze (2019) +# Tobias Leibner (2020) # ~~~ import dune.xt.grid.types as grid_types diff --git a/dune/xt/test/grid/output.tpl b/dune/xt/test/grid/output.tpl index efc52fddf636301cd75a1e264e40e15168b502b1..5aa8ba7d7dd66ff4e6623502378b9b665826f783 100644 --- a/dune/xt/test/grid/output.tpl +++ b/dune/xt/test/grid/output.tpl @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Rene Milk (2018) +// Felix Schindler (2012, 2014, 2016 - 2017) +// René Fritze (2012 - 2013, 2015 - 2016, 2018 - 2019) +// Tobias Leibner (2014, 2016, 2018) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/grid/output_pgf.cc b/dune/xt/test/grid/output_pgf.cc index ecd99990269a0ee26750e017dbadbabac5693e9f..a57dd16d5efc7629f8710654338b9379050cecf2 100644 --- a/dune/xt/test/grid/output_pgf.cc +++ b/dune/xt/test/grid/output_pgf.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2017) // René Fritze (2012 - 2016, 2018 - 2019) -// Tobias Leibner (2014, 2016) +// Tobias Leibner (2014, 2016, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/grid/periodic_gridview.cc b/dune/xt/test/grid/periodic_gridview.cc index d82472e101b57e6ad6c2e728e5752386111cf46c..840a679dfcddc0ca104f1c841a0a8631b0c7cf8a 100644 --- a/dune/xt/test/grid/periodic_gridview.cc +++ b/dune/xt/test/grid/periodic_gridview.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2015 - 2017) // René Fritze (2015 - 2019) -// Tobias Leibner (2015 - 2017) +// Tobias Leibner (2015 - 2017, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/grid/provider.hh b/dune/xt/test/grid/provider.hh index aff88f73ac8a5f987617aeddf51a9f0021940f33..8c7f06b7825ecfa4db5cb1108ecb8689c6b9811d 100644 --- a/dune/xt/test/grid/provider.hh +++ b/dune/xt/test/grid/provider.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2012 - 2017, 2019) // René Fritze (2012 - 2019) -// Tobias Leibner (2014 - 2016, 2018) +// Tobias Leibner (2014 - 2016, 2018, 2020) #ifndef DUNE_XT_TEST_GRID_PROVIDER_HH #define DUNE_XT_TEST_GRID_PROVIDER_HH diff --git a/dune/xt/test/grid/search.cc b/dune/xt/test/grid/search.cc index 3ad2b22c52e160350a5b91cd447ac3f2dba632bc..f77adf1a523ef2d7218ccbc206c415cc42601fed 100644 --- a/dune/xt/test/grid/search.cc +++ b/dune/xt/test/grid/search.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017, 2019) // René Fritze (2016, 2018 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #include <dune/xt/test/main.hxx> #include <dune/xt/common/logging.hh> diff --git a/dune/xt/test/grid/walker.cc b/dune/xt/test/grid/walker.cc index 23d03cc7c4e1386be33195b0fe05b24da5979b8e..0c6bdb45b65288f74ee262f66e4306b7ab096c11 100644 --- a/dune/xt/test/grid/walker.cc +++ b/dune/xt/test/grid/walker.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2015 - 2019) // René Fritze (2014 - 2019) -// Tobias Leibner (2015 - 2016, 2018) +// Tobias Leibner (2015 - 2016, 2018, 2020) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/CMakeLists.txt b/dune/xt/test/la/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..1f756b0566ae1342db1c596b6c53b33572668d36 --- /dev/null +++ b/dune/xt/test/la/CMakeLists.txt @@ -0,0 +1,12 @@ +# ~~~ +# This file is part of the dune-xt project: +# https://github.com/dune-community/dune-xt +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. +# License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +# or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +# with "runtime exception" (http://www.dune-project.org/license.html) +# Authors: +# Felix Schindler (2016 - 2017) +# René Fritze (2018 - 2019) +# Tobias Leibner (2020) +# ~~~ diff --git a/dune/xt/test/la/algorithms.py b/dune/xt/test/la/algorithms.py index 09f4e05c04294721d20eb0ccc481f524779b2077..40f6fce38b735724dc4019e0b56a64d87f4fb9ea 100644 --- a/dune/xt/test/la/algorithms.py +++ b/dune/xt/test/la/algorithms.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from matrices import latype, commontype, dunetype diff --git a/dune/xt/test/la/algorithms_cholesky.py b/dune/xt/test/la/algorithms_cholesky.py index b114dec0a84855d544f1570fa02ff0ba6b135226..da57f7594be90e596a6ce20978f0868402909ee5 100644 --- a/dune/xt/test/la/algorithms_cholesky.py +++ b/dune/xt/test/la/algorithms_cholesky.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from algorithms import la_types, testtypes_creator diff --git a/dune/xt/test/la/algorithms_cholesky.tpl b/dune/xt/test/la/algorithms_cholesky.tpl index 0e2418287c6679d6d7e6d2351e6817a8b089bd8d..8e2f2fae19c0b08ae665615aa6a9b3f8f5daf7c1 100644 --- a/dune/xt/test/la/algorithms_cholesky.tpl +++ b/dune/xt/test/la/algorithms_cholesky.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2019) +// Tobias Leibner (2018) // This one has to come first (includes the config.h)! #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/algorithms_qr_5x3.py b/dune/xt/test/la/algorithms_qr_5x3.py index 7a3e08a360805299eff477303ea09390f31c877c..a01c94f9c71142bb4963cf98d9bcf829a0f366ee 100644 --- a/dune/xt/test/la/algorithms_qr_5x3.py +++ b/dune/xt/test/la/algorithms_qr_5x3.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from algorithms import la_types, testtypes_creator diff --git a/dune/xt/test/la/algorithms_qr_5x3.tpl b/dune/xt/test/la/algorithms_qr_5x3.tpl index 776a59935edcc384a2a117bde0e7c43f97ddb1bc..173ad2f85ff16a904c92eb19ce29aa8846cefa92 100644 --- a/dune/xt/test/la/algorithms_qr_5x3.tpl +++ b/dune/xt/test/la/algorithms_qr_5x3.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2019) +// Tobias Leibner (2018) // This one has to come first (includes the config.h)! #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/algorithms_qr_5x5.py b/dune/xt/test/la/algorithms_qr_5x5.py index b114dec0a84855d544f1570fa02ff0ba6b135226..da57f7594be90e596a6ce20978f0868402909ee5 100644 --- a/dune/xt/test/la/algorithms_qr_5x5.py +++ b/dune/xt/test/la/algorithms_qr_5x5.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from algorithms import la_types, testtypes_creator diff --git a/dune/xt/test/la/algorithms_qr_5x5.tpl b/dune/xt/test/la/algorithms_qr_5x5.tpl index d1f6690c75cca48012b0dfd53fdff5de57ec1a2d..267461623ae607e74adbfb721ac14f660cb93297 100644 --- a/dune/xt/test/la/algorithms_qr_5x5.tpl +++ b/dune/xt/test/la/algorithms_qr_5x5.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2019) +// Tobias Leibner (2018) // This one has to come first (includes the config.h)! #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/algorithms_qr_block_2x3x3.py b/dune/xt/test/la/algorithms_qr_block_2x3x3.py index 132228c98d1a6da499154f70f53d4acbdcda8de3..a0dfa54d448e2ad78ad469e19d8ec4e7de832578 100644 --- a/dune/xt/test/la/algorithms_qr_block_2x3x3.py +++ b/dune/xt/test/la/algorithms_qr_block_2x3x3.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from algorithms import la_types, testtypes_creator diff --git a/dune/xt/test/la/algorithms_qr_block_2x3x3.tpl b/dune/xt/test/la/algorithms_qr_block_2x3x3.tpl index 2920f3804b1d401b4a8d75fc65a3572e58398dc4..54ed7e42c8bb4cb5565c52c86faaf2f31f4ff913 100644 --- a/dune/xt/test/la/algorithms_qr_block_2x3x3.tpl +++ b/dune/xt/test/la/algorithms_qr_block_2x3x3.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2019) +// Tobias Leibner (2018) // This one has to come first (includes the config.h)! #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/algorithms_solve_sym_tridiag_posdef.py b/dune/xt/test/la/algorithms_solve_sym_tridiag_posdef.py index b114dec0a84855d544f1570fa02ff0ba6b135226..da57f7594be90e596a6ce20978f0868402909ee5 100644 --- a/dune/xt/test/la/algorithms_solve_sym_tridiag_posdef.py +++ b/dune/xt/test/la/algorithms_solve_sym_tridiag_posdef.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from algorithms import la_types, testtypes_creator diff --git a/dune/xt/test/la/algorithms_solve_sym_tridiag_posdef.tpl b/dune/xt/test/la/algorithms_solve_sym_tridiag_posdef.tpl index d303d6b8d9a3ee9a6ab4dae3e5d5edcaeefd573f..7140957934272a29c0c48f5577228be7fb33abc5 100644 --- a/dune/xt/test/la/algorithms_solve_sym_tridiag_posdef.tpl +++ b/dune/xt/test/la/algorithms_solve_sym_tridiag_posdef.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2019) +// Tobias Leibner (2018) // This one has to come first (includes the config.h)! #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/algorithms_triangular_solves_2x2.py b/dune/xt/test/la/algorithms_triangular_solves_2x2.py index 8cdbd2ef11a4f0571bf408fce73a0353c28cc608..d136e9b8589463d55b8434bd7793d88b2177d033 100644 --- a/dune/xt/test/la/algorithms_triangular_solves_2x2.py +++ b/dune/xt/test/la/algorithms_triangular_solves_2x2.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from algorithms import la_types, testtypes_creator diff --git a/dune/xt/test/la/algorithms_triangular_solves_2x2.tpl b/dune/xt/test/la/algorithms_triangular_solves_2x2.tpl index 365db37329d627d04807db1ae2fc2d4afbff6023..947e799af8eb31ee2d5e9d648634aa3f43b00e7f 100644 --- a/dune/xt/test/la/algorithms_triangular_solves_2x2.tpl +++ b/dune/xt/test/la/algorithms_triangular_solves_2x2.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2019) +// Tobias Leibner (2018) // This one has to come first (includes the config.h)! #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/algorithms_triangular_solves_3x3.py b/dune/xt/test/la/algorithms_triangular_solves_3x3.py index f57f4e0ee2c4d0a9fbc8333c97c05d30d2d795f2..d8428c9c1c3a85e053e56db5cc29248fb9169e8d 100644 --- a/dune/xt/test/la/algorithms_triangular_solves_3x3.py +++ b/dune/xt/test/la/algorithms_triangular_solves_3x3.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016) # René Fritze (2016 - 2019) -# Tobias Leibner (2015 - 2018) +# Tobias Leibner (2015 - 2018, 2020) # ~~~ from algorithms import la_types, common_types, dune_types, testtypes_creator diff --git a/dune/xt/test/la/algorithms_triangular_solves_3x3.tpl b/dune/xt/test/la/algorithms_triangular_solves_3x3.tpl index b3c19f450a5293b1e47ac2fcb0bb5f6a8761435d..a1970ee56cb3f7e78c81d1547e2a501edf6c190f 100644 --- a/dune/xt/test/la/algorithms_triangular_solves_3x3.tpl +++ b/dune/xt/test/la/algorithms_triangular_solves_3x3.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2019) +// Tobias Leibner (2018) // This one has to come first (includes the config.h)! #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/container.hh b/dune/xt/test/la/container.hh index ccff684c74c444fcfcb438d07f46468b8588710e..4a4f892d992772af99d409c4ca02b17ae39d47bf 100644 --- a/dune/xt/test/la/container.hh +++ b/dune/xt/test/la/container.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014, 2016 - 2017) // René Fritze (2014 - 2016, 2018 - 2019) -// Tobias Leibner (2014 - 2019) +// Tobias Leibner (2014 - 2020) #ifndef DUNE_XT_TEST_LA_CONTAINER_HH #define DUNE_XT_TEST_LA_CONTAINER_HH diff --git a/dune/xt/test/la/container.py b/dune/xt/test/la/container.py index fc6125ff74f1b804e429561d1e5b10cdfb624327..98d25f173518bc3cef1adf860157247d09336fae 100644 --- a/dune/xt/test/la/container.py +++ b/dune/xt/test/la/container.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2017 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ from itertools import product diff --git a/dune/xt/test/la/container.tpl b/dune/xt/test/la/container.tpl index 885c3a32c6e765aad5f1e8e18387352674a74212..0ebc2a2ee320e9b60ff75ed674c42fecbb77d0d9 100644 --- a/dune/xt/test/la/container.tpl +++ b/dune/xt/test/la/container.tpl @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2014, 2016 - 2017) -// Rene Milk (2014 - 2016) +// Felix Schindler (2013 - 2014, 2016 - 2018) +// René Fritze (2014 - 2017, 2019) // Tobias Leibner (2014 - 2017) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/container_matrix.py b/dune/xt/test/la/container_matrix.py index 3f48c5ce2099fb26d27c003da70dd5d5785a9299..9e68b46b499534b51b2b9fbf7dc6a2a366ef5768 100644 --- a/dune/xt/test/la/container_matrix.py +++ b/dune/xt/test/la/container_matrix.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016) # René Fritze (2017 - 2019) -# Tobias Leibner (2015, 2019) +# Tobias Leibner (2015, 2019 - 2020) # ~~~ from itertools import product diff --git a/dune/xt/test/la/container_matrix.tpl b/dune/xt/test/la/container_matrix.tpl index 61670348c43062efedd367970b0b6006a2609aa7..d4edc2f9dc0751d052581a293a18d2212931aa41 100644 --- a/dune/xt/test/la/container_matrix.tpl +++ b/dune/xt/test/la/container_matrix.tpl @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) -// Rene Milk (2016) -// Tobias Leibner (2015, 2017) +// René Fritze (2016 - 2019) +// Tobias Leibner (2015, 2017, 2019) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/container_vector.py b/dune/xt/test/la/container_vector.py index df757ebb62a617d53dacf1ae22f5b66088054131..c5794615e8549a149e2cd6c26a53ba2f42828ef5 100644 --- a/dune/xt/test/la/container_vector.py +++ b/dune/xt/test/la/container_vector.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016) # René Fritze (2017 - 2019) -# Tobias Leibner (2015, 2019) +# Tobias Leibner (2015, 2019 - 2020) # ~~~ from itertools import product diff --git a/dune/xt/test/la/container_vector.tpl b/dune/xt/test/la/container_vector.tpl index fb3f45ecf8661086ac6c0429dc7ebc4386b502be..45778b0c13a2c0eb27f4f423b76980287758f555 100644 --- a/dune/xt/test/la/container_vector.tpl +++ b/dune/xt/test/la/container_vector.tpl @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2014, 2016 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2017) +// René Fritze (2014 - 2017, 2019) +// Tobias Leibner (2014 - 2019) #include <dune/xt/test/main.hxx> #include <dune/xt/common/vector.hh> diff --git a/dune/xt/test/la/convert.cc b/dune/xt/test/la/convert.cc index 279a6385bf07ecfb82313803de9f868dd3956250..5f8db88099bf6eb95e0c208180da312b9b0e6c0f 100644 --- a/dune/xt/test/la/convert.cc +++ b/dune/xt/test/la/convert.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2018 - 2019) +// Tobias Leibner (2020) /** * This file is intended as a starting point for quick testing. diff --git a/dune/xt/test/la/eigensolver.hh b/dune/xt/test/la/eigensolver.hh index e265dd183232a70cd383de4333b4a5f5c5f0c0f0..085c22780539fc8531d44537311c0a3de85b79df 100644 --- a/dune/xt/test/la/eigensolver.hh +++ b/dune/xt/test/la/eigensolver.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2017) // René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_TEST_EIGENSOLVER_HH #define DUNE_XT_LA_TEST_EIGENSOLVER_HH diff --git a/dune/xt/test/la/eigensolver_for_matrix_from_eigens_example.py b/dune/xt/test/la/eigensolver_for_matrix_from_eigens_example.py index 2b20afdc7a7bb02ba44821f89981ddc9ec1af339..3f005ad97c5425e4cf3e793b620a385c081daea7 100644 --- a/dune/xt/test/la/eigensolver_for_matrix_from_eigens_example.py +++ b/dune/xt/test/la/eigensolver_for_matrix_from_eigens_example.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2017 - 2019) -# Tobias Leibner (2017, 2019) +# Tobias Leibner (2017, 2019 - 2020) # ~~~ from dune.xt.codegen import typeid_to_typedef_name as safe_name, have_eigen diff --git a/dune/xt/test/la/eigensolver_for_matrix_from_eigens_example.tpl b/dune/xt/test/la/eigensolver_for_matrix_from_eigens_example.tpl index 8948fc6c166e9f26e0309a2bbcb64c716a0e268d..e537d207219ae272839c0581584e03f2f67c6a52 100644 --- a/dune/xt/test/la/eigensolver_for_matrix_from_eigens_example.tpl +++ b/dune/xt/test/la/eigensolver_for_matrix_from_eigens_example.tpl @@ -1,13 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// Felix Schindler (2017) +// René Fritze (2017, 2019) +// Tim Keil (2018) +// Tobias Leibner (2018) #include <dune/xt/test/main.hxx> // <- has to come first (includes the config.h)! @@ -153,12 +154,12 @@ TEST_F(EigenSolverForMatrixFromEigensExample_{{T_NAME}}, is_constructible) TEST_F(EigenSolverForMatrixFromEigensExample_{{T_NAME}}, gives_correct_eigenvalues) { - gives_correct_eigenvalues({ {"lapack", "1e-14"}, {"eigen", "1e-15"}, {"numpy", "1e-14"}, {"shifted_qr", /*we_expect_a_failure: */ "-1"} }); + gives_correct_eigenvalues({ {"lapack", "1e-6"}, {"eigen", "1e-6"}, {"numpy", "1e-6"}, {"shifted_qr", /*we_expect_a_failure: */ "-1"} }); } TEST_F(EigenSolverForMatrixFromEigensExample_{{T_NAME}}, gives_correct_eigendecomposition) { - gives_correct_eigendecomposition({ {"lapack", "1e-14"}, {"eigen", "1e-14"}, {"numpy", "1e-14"}, {"shifted_qr", /*we_expect_a_failure: */ "-1"} }); + gives_correct_eigendecomposition({ {"lapack", "1e-6"}, {"eigen", "1e-6"}, {"numpy", "1e-6"}, {"shifted_qr", /*we_expect_a_failure: */ "-1"} }); } {% endfor %} diff --git a/dune/xt/test/la/eigensolver_for_real_matrix_with_complex_evs.py b/dune/xt/test/la/eigensolver_for_real_matrix_with_complex_evs.py index 70e98a49fae6589bcb79487c21af41f35328953c..8029e12370104a7ad19c1dcd7ed58992dd5130e1 100644 --- a/dune/xt/test/la/eigensolver_for_real_matrix_with_complex_evs.py +++ b/dune/xt/test/la/eigensolver_for_real_matrix_with_complex_evs.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2017 - 2019) -# Tobias Leibner (2017, 2019) +# Tobias Leibner (2017, 2019 - 2020) # ~~~ from dune.xt.codegen import typeid_to_typedef_name as safe_name, have_eigen diff --git a/dune/xt/test/la/eigensolver_for_real_matrix_with_complex_evs.tpl b/dune/xt/test/la/eigensolver_for_real_matrix_with_complex_evs.tpl index 557c22f10a2843da6dccd86da5187fe3ae0133d0..e4a5c02c952e41b2ef216ab5b46870f719e1e04f 100644 --- a/dune/xt/test/la/eigensolver_for_real_matrix_with_complex_evs.tpl +++ b/dune/xt/test/la/eigensolver_for_real_matrix_with_complex_evs.tpl @@ -1,13 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// Felix Schindler (2017) +// René Fritze (2017, 2019) +// Tim Keil (2018) +// Tobias Leibner (2018) #include <dune/xt/test/main.hxx> // <- has to come first (includes the config.h)! diff --git a/dune/xt/test/la/eigensolver_for_real_matrix_with_distinct_real_evs.py b/dune/xt/test/la/eigensolver_for_real_matrix_with_distinct_real_evs.py index 5922a6b4c599744044bbd56913900d47caf2af32..0b6375f6bf9bb6f42cc94973b91ede3732b9773c 100644 --- a/dune/xt/test/la/eigensolver_for_real_matrix_with_distinct_real_evs.py +++ b/dune/xt/test/la/eigensolver_for_real_matrix_with_distinct_real_evs.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2017 - 2019) -# Tobias Leibner (2017 - 2019) +# Tobias Leibner (2017 - 2020) # ~~~ from dune.xt.codegen import typeid_to_typedef_name as safe_name, have_eigen diff --git a/dune/xt/test/la/eigensolver_for_real_matrix_with_distinct_real_evs.tpl b/dune/xt/test/la/eigensolver_for_real_matrix_with_distinct_real_evs.tpl index a9a336acc5d3d2d14a21e40547b90320004c0b0b..2c8ef188648747895da7d3229b0098bdf161d00c 100644 --- a/dune/xt/test/la/eigensolver_for_real_matrix_with_distinct_real_evs.tpl +++ b/dune/xt/test/la/eigensolver_for_real_matrix_with_distinct_real_evs.tpl @@ -1,13 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// Felix Schindler (2017) +// René Fritze (2017, 2019) +// Tim Keil (2018) +// Tobias Leibner (2018) #include <dune/xt/test/main.hxx> // <- has to come first (includes the config.h)! diff --git a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs.py b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs.py index 405976d638a6a0e7097f9c165130b63533cde7f6..404757321020f6a7df4fbd3de013cee3ceb8d6c1 100644 --- a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs.py +++ b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2017 - 2019) -# Tobias Leibner (2017 - 2019) +# Tobias Leibner (2017 - 2020) # ~~~ from dune.xt.codegen import typeid_to_typedef_name as safe_name, have_eigen diff --git a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs.tpl b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs.tpl index e7aff61cffe35c744e237c5d62ef357285d5630a..50dde2c7a4a8d976a9cc3d341120004970c33865 100644 --- a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs.tpl +++ b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs.tpl @@ -1,13 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// Felix Schindler (2017) +// René Fritze (2017, 2019) +// Tim Keil (2018) +// Tobias Leibner (2018) #include <dune/xt/test/main.hxx> // <- has to come first (includes the config.h)! diff --git a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_2d_euler_equations.py b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_2d_euler_equations.py index 6eba5a9835a8c7c9f89ca04907719dedf468a144..b9d54d70342bf8a3f8b1a0d78c444ea1c720cfec 100644 --- a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_2d_euler_equations.py +++ b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_2d_euler_equations.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2017 - 2019) -# Tobias Leibner (2017 - 2019) +# Tobias Leibner (2017 - 2020) # ~~~ from dune.xt.codegen import typeid_to_typedef_name as safe_name, have_eigen diff --git a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_2d_euler_equations.tpl b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_2d_euler_equations.tpl index 23b5b70db726809723e6a15915e64032e73837c9..64022514f332e9937c2df42f46563d55aa507a86 100644 --- a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_2d_euler_equations.tpl +++ b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_2d_euler_equations.tpl @@ -1,13 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// Felix Schindler (2017) +// René Fritze (2017, 2019) +// Tim Keil (2018) +// Tobias Leibner (2018) #include <dune/xt/test/main.hxx> // <- has to come first (includes the config.h)! diff --git a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_3d_pointsource.py b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_3d_pointsource.py index 4c820dcd2865dd20bc3cda7fa9b91e6d957fb223..4f908614609a513a93bb040795722ed2239f9e5e 100644 --- a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_3d_pointsource.py +++ b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_3d_pointsource.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2017 - 2019) -# Tobias Leibner (2017 - 2019) +# Tobias Leibner (2017 - 2020) # ~~~ from dune.xt.codegen import typeid_to_typedef_name as safe_name, have_eigen diff --git a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_3d_pointsource.tpl b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_3d_pointsource.tpl index 4189ae68698663daa4a82d7a433c88655e74ff75..1d86a99e7d8ad9c602345e2500c8d36009bb3202 100644 --- a/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_3d_pointsource.tpl +++ b/dune/xt/test/la/eigensolver_for_real_matrix_with_real_evs_from_3d_pointsource.tpl @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2019) +// Tim Keil (2018) +// Tobias Leibner (2018) #include <dune/xt/test/main.hxx> // <- has to come first (includes the config.h)! diff --git a/dune/xt/test/la/generalized-eigensolver.hh b/dune/xt/test/la/generalized-eigensolver.hh index 2f54a0c5e2add1d24d78bc1b0282930df5b377fa..8044d2dab3629ac71ac666c4d993cf189b33ae3f 100644 --- a/dune/xt/test/la/generalized-eigensolver.hh +++ b/dune/xt/test/la/generalized-eigensolver.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2017, 2019) // René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_TEST_GENERALIZED_EIGENSOLVER_HH #define DUNE_XT_LA_TEST_GENERALIZED_EIGENSOLVER_HH diff --git a/dune/xt/test/la/generalized-eigensolver_for_real_matrix_with_real_evs.py b/dune/xt/test/la/generalized-eigensolver_for_real_matrix_with_real_evs.py index 78238cbd8946a7b399f6348c8abf8d272106fcb4..84f5ccbf07051cb803dcdb4b2039b9514c27d2a4 100644 --- a/dune/xt/test/la/generalized-eigensolver_for_real_matrix_with_real_evs.py +++ b/dune/xt/test/la/generalized-eigensolver_for_real_matrix_with_real_evs.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017, 2019) # René Fritze (2017 - 2019) -# Tobias Leibner (2017 - 2019) +# Tobias Leibner (2017 - 2020) # ~~~ from dune.xt.codegen import typeid_to_typedef_name as safe_name, have_eigen diff --git a/dune/xt/test/la/generalized-eigensolver_for_real_matrix_with_real_evs.tpl b/dune/xt/test/la/generalized-eigensolver_for_real_matrix_with_real_evs.tpl index d88567d8bc4fb35ae210524095e81a63ba029976..3049e374cf34136620306e3bdd3e0a1d1362d199 100644 --- a/dune/xt/test/la/generalized-eigensolver_for_real_matrix_with_real_evs.tpl +++ b/dune/xt/test/la/generalized-eigensolver_for_real_matrix_with_real_evs.tpl @@ -1,11 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2019) +// Felix Schindler (2017, 2019) +// René Fritze (2017, 2019) +// Tim Keil (2018) +// Tobias Leibner (2018) #include <dune/xt/test/main.hxx> // <- has to come first (includes the config.h)! diff --git a/dune/xt/test/la/matrices.py b/dune/xt/test/la/matrices.py index 6c8472284379e6934f51ad204bad6fbbbdf55140..7a9ac2c1ef321e1016dface810f80f9aa911c00b 100644 --- a/dune/xt/test/la/matrices.py +++ b/dune/xt/test/la/matrices.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2017 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from dune.xt import codegen diff --git a/dune/xt/test/la/matrix-market.py b/dune/xt/test/la/matrix-market.py index de9486d17332cade0d885ef971359d2df987799d..cfe5cfaa8530c799cc66a5f26af6ebda4e37b2ef 100644 --- a/dune/xt/test/la/matrix-market.py +++ b/dune/xt/test/la/matrix-market.py @@ -1,12 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: -# Tobias Leibner (2019) +# René Fritze (2019) +# Tobias Leibner (2019 - 2020) # ~~~ from itertools import product diff --git a/dune/xt/test/la/matrix-market.tpl b/dune/xt/test/la/matrix-market.tpl index 8327fb14699276b2845bc8335e68f608cdd13268..69db5f72fade758e4d78e0d271defc35c1069fd7 100644 --- a/dune/xt/test/la/matrix-market.tpl +++ b/dune/xt/test/la/matrix-market.tpl @@ -1,13 +1,11 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2016 - 2017) -// Rene Milk (2016) -// Tobias Leibner (2015, 2017) +// Tobias Leibner (2019) #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/matrix_and_vector_view.py b/dune/xt/test/la/matrix_and_vector_view.py index 3f48c5ce2099fb26d27c003da70dd5d5785a9299..9e68b46b499534b51b2b9fbf7dc6a2a366ef5768 100644 --- a/dune/xt/test/la/matrix_and_vector_view.py +++ b/dune/xt/test/la/matrix_and_vector_view.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016) # René Fritze (2017 - 2019) -# Tobias Leibner (2015, 2019) +# Tobias Leibner (2015, 2019 - 2020) # ~~~ from itertools import product diff --git a/dune/xt/test/la/matrix_and_vector_view.tpl b/dune/xt/test/la/matrix_and_vector_view.tpl index ccb7509de4ba1c1cdf3fa0ec9e48cf277c66aba1..fe75534ce21821ba84afbb39ae5f32718298f547 100644 --- a/dune/xt/test/la/matrix_and_vector_view.tpl +++ b/dune/xt/test/la/matrix_and_vector_view.tpl @@ -1,11 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Tobias Leibner (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #include <dune/xt/test/main.hxx> #include <dune/xt/test/common/float_cmp.hh> diff --git a/dune/xt/test/la/matrixinverter.hh b/dune/xt/test/la/matrixinverter.hh index 7e2461d4d6481a54cd680f3e8a72b0febc02089b..69ff3a682f39ed237ef34ab6ec5e2e854cc29579 100644 --- a/dune/xt/test/la/matrixinverter.hh +++ b/dune/xt/test/la/matrixinverter.hh @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // René Fritze (2018 - 2019) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_TEST_MATRIXINVERTER_HH #define DUNE_XT_LA_TEST_MATRIXINVERTER_HH diff --git a/dune/xt/test/la/matrixinverter_for_complex_matrix.py b/dune/xt/test/la/matrixinverter_for_complex_matrix.py index 5096eacaf2da4bb421fb0fc3b407fa6621f2c3d4..79b832383973904ff3a94ca6eef80226a0bbef82 100644 --- a/dune/xt/test/la/matrixinverter_for_complex_matrix.py +++ b/dune/xt/test/la/matrixinverter_for_complex_matrix.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from dune.xt.codegen import typeid_to_typedef_name as safe_name, have_eigen diff --git a/dune/xt/test/la/matrixinverter_for_complex_matrix.tpl b/dune/xt/test/la/matrixinverter_for_complex_matrix.tpl index d809c12fd1b9adebcd390803d9b7d927bad129a2..1f042f22b61f05fdcd59d7600364a353cc4b1db4 100644 --- a/dune/xt/test/la/matrixinverter_for_complex_matrix.tpl +++ b/dune/xt/test/la/matrixinverter_for_complex_matrix.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2019) +// Tobias Leibner (2018) #include <dune/xt/test/main.hxx> // <- has to come first (includes the config.h)! diff --git a/dune/xt/test/la/matrixinverter_for_complex_matrix_2.py b/dune/xt/test/la/matrixinverter_for_complex_matrix_2.py index 2932a6765b6dab274f405f3faa66ce40aa54f745..b6d5314ef37a92a4489d10f3f9d29d170519ae65 100644 --- a/dune/xt/test/la/matrixinverter_for_complex_matrix_2.py +++ b/dune/xt/test/la/matrixinverter_for_complex_matrix_2.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from dune.xt.codegen import typeid_to_typedef_name as safe_name, have_eigen diff --git a/dune/xt/test/la/matrixinverter_for_complex_matrix_2.tpl b/dune/xt/test/la/matrixinverter_for_complex_matrix_2.tpl index 2f047f915b42e53b36a1b206e7aa83210734ef66..51d64057575eed2acecbd57f1cd098c8f12af39a 100644 --- a/dune/xt/test/la/matrixinverter_for_complex_matrix_2.tpl +++ b/dune/xt/test/la/matrixinverter_for_complex_matrix_2.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2019) +// Tobias Leibner (2018) #include <dune/xt/test/main.hxx> // <- has to come first (includes the config.h)! diff --git a/dune/xt/test/la/matrixinverter_for_real_matrix_from_3d_pointsource.py b/dune/xt/test/la/matrixinverter_for_real_matrix_from_3d_pointsource.py index 023a195232ac7144f3b2320490ee6413d7ac061b..1138b5ef9bedc0a628c069e6db244a9a71e92eb9 100644 --- a/dune/xt/test/la/matrixinverter_for_real_matrix_from_3d_pointsource.py +++ b/dune/xt/test/la/matrixinverter_for_real_matrix_from_3d_pointsource.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from dune.xt.codegen import typeid_to_typedef_name as safe_name, have_eigen diff --git a/dune/xt/test/la/matrixinverter_for_real_matrix_from_3d_pointsource.tpl b/dune/xt/test/la/matrixinverter_for_real_matrix_from_3d_pointsource.tpl index 55ffbcb334af13be6d42d5eb820a9670e9b07a5e..f9c6e742eca1f20a4c6f59baa152d68fc7e729f3 100644 --- a/dune/xt/test/la/matrixinverter_for_real_matrix_from_3d_pointsource.tpl +++ b/dune/xt/test/la/matrixinverter_for_real_matrix_from_3d_pointsource.tpl @@ -1,13 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2019) +// Tobias Leibner (2018) #include <dune/xt/test/main.hxx> // <- has to come first (includes the config.h)! diff --git a/dune/xt/test/la/pattern.cc b/dune/xt/test/la/pattern.cc index 8e1b704eb2e9b595f8d59581883e8428db13b3a8..740e78cc254b3ae9e77d049e430812cc9512e32a 100644 --- a/dune/xt/test/la/pattern.cc +++ b/dune/xt/test/la/pattern.cc @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // René Fritze (2019) -// Tobias Leibner (2019) +// Tobias Leibner (2019 - 2020) #define DUNE_XT_COMMON_TEST_MAIN_ENABLE_DEBUG_LOGGING 1 #define DUNE_XT_COMMON_TEST_MAIN_ENABLE_INFO_LOGGING 1 diff --git a/dune/xt/test/la/saddlepoint.cc b/dune/xt/test/la/saddlepoint.cc index c14007bc89753eacce554e41283ab29a6e8889ce..accd4dde149b0e3b10f60114afc7e4406da7325e 100644 --- a/dune/xt/test/la/saddlepoint.cc +++ b/dune/xt/test/la/saddlepoint.cc @@ -1,12 +1,12 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // René Fritze (2019) -// Tobias Leibner (2019) +// Tobias Leibner (2019 - 2020) #define DUNE_XT_COMMON_TEST_MAIN_ENABLE_DEBUG_LOGGING 1 #define DUNE_XT_COMMON_TEST_MAIN_ENABLE_INFO_LOGGING 1 diff --git a/dune/xt/test/la/solver.py b/dune/xt/test/la/solver.py index 414ff47b6dc19025fa7d98983fd169564b7207a9..c15c5a773c3aa774990c5f09720691a829588d7b 100644 --- a/dune/xt/test/la/solver.py +++ b/dune/xt/test/la/solver.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016) # René Fritze (2017 - 2019) -# Tobias Leibner (2015 - 2017, 2019) +# Tobias Leibner (2015 - 2017, 2019 - 2020) # ~~~ from matrices import latype diff --git a/dune/xt/test/la/solver.tpl b/dune/xt/test/la/solver.tpl index 4f8cc587de4f979bebea79dfb72f72df12790a17..2d1daf54a10ea7d4191f07af902bd06326475442 100644 --- a/dune/xt/test/la/solver.tpl +++ b/dune/xt/test/la/solver.tpl @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2017 dune-xt-la developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2013 - 2017) -// Rene Milk (2014 - 2016) -// Tobias Leibner (2014 - 2015, 2017) +// René Fritze (2014 - 2017, 2019) +// Tobias Leibner (2014 - 2015, 2017, 2019) // This one has to come first (includes the config.h)! #include <dune/xt/test/main.hxx> diff --git a/dune/xt/test/la/spaces.py b/dune/xt/test/la/spaces.py index 6aa7ca02f12995f7cf4ff37710d634550c71f848..610b49ee7652edad17c238ec0db4e9234683640a 100644 --- a/dune/xt/test/la/spaces.py +++ b/dune/xt/test/la/spaces.py @@ -1,11 +1,11 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2017 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ diff --git a/dune/xt/test/la/vectors.py b/dune/xt/test/la/vectors.py index 9571c8e8ef7072360dd62bc0ead0f6da0f11d74c..f1eba9fb36b3e700e65106113cb279b7ecee3892 100644 --- a/dune/xt/test/la/vectors.py +++ b/dune/xt/test/la/vectors.py @@ -1,12 +1,12 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016) # René Fritze (2016 - 2019) -# Tobias Leibner (2015 - 2017, 2019) +# Tobias Leibner (2015 - 2017, 2019 - 2020) # ~~~ diff --git a/dune/xt/test/main.hxx b/dune/xt/test/main.hxx index 050e83ceceab4b72dc37f8f84f72c28efa761ec4..30c4a1b715ba1bfa370456d633f7ddfe029526db 100644 --- a/dune/xt/test/main.hxx +++ b/dune/xt/test/main.hxx @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2014 - 2018) // René Fritze (2014 - 2016, 2018 - 2019) -// Tobias Leibner (2015 - 2018) +// Tobias Leibner (2015 - 2018, 2020) #include "config.h" diff --git a/pybind11/.appveyor.yml b/pybind11/.appveyor.yml new file mode 100644 index 0000000000000000000000000000000000000000..8fbb726108f2a3e7c24075d17c49beb1110474d6 --- /dev/null +++ b/pybind11/.appveyor.yml @@ -0,0 +1,70 @@ +version: 1.0.{build} +image: +- Visual Studio 2017 +- Visual Studio 2015 +test: off +skip_branch_with_pr: true +build: + parallel: true +platform: +- x64 +- x86 +environment: + matrix: + - PYTHON: 36 + CPP: 14 + CONFIG: Debug + - PYTHON: 27 + CPP: 14 + CONFIG: Debug + - CONDA: 36 + CPP: latest + CONFIG: Release +matrix: + exclude: + - image: Visual Studio 2015 + platform: x86 + - image: Visual Studio 2015 + CPP: latest + - image: Visual Studio 2017 + CPP: latest + platform: x86 +install: +- ps: | + if ($env:PLATFORM -eq "x64") { $env:CMAKE_ARCH = "x64" } + if ($env:APPVEYOR_JOB_NAME -like "*Visual Studio 2017*") { + $env:CMAKE_GENERATOR = "Visual Studio 15 2017" + $env:CMAKE_INCLUDE_PATH = "C:\Libraries\boost_1_64_0" + $env:CXXFLAGS = "-permissive-" + } else { + $env:CMAKE_GENERATOR = "Visual Studio 14 2015" + } + if ($env:PYTHON) { + if ($env:PLATFORM -eq "x64") { $env:PYTHON = "$env:PYTHON-x64" } + $env:PATH = "C:\Python$env:PYTHON\;C:\Python$env:PYTHON\Scripts\;$env:PATH" + python -W ignore -m pip install --upgrade pip wheel + python -W ignore -m pip install pytest numpy --no-warn-script-location + } elseif ($env:CONDA) { + if ($env:CONDA -eq "27") { $env:CONDA = "" } + if ($env:PLATFORM -eq "x64") { $env:CONDA = "$env:CONDA-x64" } + $env:PATH = "C:\Miniconda$env:CONDA\;C:\Miniconda$env:CONDA\Scripts\;$env:PATH" + $env:PYTHONHOME = "C:\Miniconda$env:CONDA" + conda --version + conda install -y -q pytest numpy scipy + } +- ps: | + Start-FileDownload 'http://bitbucket.org/eigen/eigen/get/3.3.3.zip' + 7z x 3.3.3.zip -y > $null + $env:CMAKE_INCLUDE_PATH = "eigen-eigen-67e894c6cd8f;$env:CMAKE_INCLUDE_PATH" +build_script: +- cmake -G "%CMAKE_GENERATOR%" -A "%CMAKE_ARCH%" + -DPYBIND11_CPP_STANDARD=/std:c++%CPP% + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DCMAKE_SUPPRESS_REGENERATION=1 + . +- set MSBuildLogger="C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" +- cmake --build . --config %CONFIG% --target pytest -- /m /v:m /logger:%MSBuildLogger% +- cmake --build . --config %CONFIG% --target cpptest -- /m /v:m /logger:%MSBuildLogger% +- if "%CPP%"=="latest" (cmake --build . --config %CONFIG% --target test_cmake_build -- /m /v:m /logger:%MSBuildLogger%) +on_failure: if exist "tests\test_cmake_build" type tests\test_cmake_build\*.log* diff --git a/pybind11/.gitignore b/pybind11/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..979fd4431bfa1f5f36bc245d0805867f76495a2d --- /dev/null +++ b/pybind11/.gitignore @@ -0,0 +1,38 @@ +CMakeCache.txt +CMakeFiles +Makefile +cmake_install.cmake +.DS_Store +*.so +*.pyd +*.dll +*.sln +*.sdf +*.opensdf +*.vcxproj +*.filters +example.dir +Win32 +x64 +Release +Debug +.vs +CTestTestfile.cmake +Testing +autogen +MANIFEST +/.ninja_* +/*.ninja +/docs/.build +*.py[co] +*.egg-info +*~ +.*.swp +.DS_Store +/dist +/build +/cmake/ +.cache/ +sosize-*.txt +pybind11Config*.cmake +pybind11Targets.cmake diff --git a/pybind11/.gitmodules b/pybind11/.gitmodules new file mode 100644 index 0000000000000000000000000000000000000000..d063a8e89ddf5b923112a97fa09bf171636c2bd4 --- /dev/null +++ b/pybind11/.gitmodules @@ -0,0 +1,3 @@ +[submodule "tools/clang"] + path = tools/clang + url = ../../wjakob/clang-cindex-python3 diff --git a/pybind11/.readthedocs.yml b/pybind11/.readthedocs.yml new file mode 100644 index 0000000000000000000000000000000000000000..c9c61617ca9b13a3e31d33226c52ba9529872a0d --- /dev/null +++ b/pybind11/.readthedocs.yml @@ -0,0 +1,3 @@ +python: + version: 3 +requirements_file: docs/requirements.txt diff --git a/pybind11/.travis.yml b/pybind11/.travis.yml new file mode 100644 index 0000000000000000000000000000000000000000..4cc5cf07c04abdd3bc2944f88113295392ed4219 --- /dev/null +++ b/pybind11/.travis.yml @@ -0,0 +1,280 @@ +language: cpp +matrix: + include: + # This config does a few things: + # - Checks C++ and Python code styles (check-style.sh and flake8). + # - Makes sure sphinx can build the docs without any errors or warnings. + # - Tests setup.py sdist and install (all header files should be present). + # - Makes sure that everything still works without optional deps (numpy/scipy/eigen) and + # also tests the automatic discovery functions in CMake (Python version, C++ standard). + - os: linux + dist: xenial # Necessary to run doxygen 1.8.15 + name: Style, docs, and pip + cache: false + before_install: + - pyenv global $(pyenv whence 2to3) # activate all python versions + - PY_CMD=python3 + - $PY_CMD -m pip install --user --upgrade pip wheel setuptools + install: + - $PY_CMD -m pip install --user --upgrade sphinx sphinx_rtd_theme breathe flake8 pep8-naming pytest + - curl -fsSL https://sourceforge.net/projects/doxygen/files/rel-1.8.15/doxygen-1.8.15.linux.bin.tar.gz/download | tar xz + - export PATH="$PWD/doxygen-1.8.15/bin:$PATH" + script: + - tools/check-style.sh + - flake8 + - $PY_CMD -m sphinx -W -b html docs docs/.build + - | + # Make sure setup.py distributes and installs all the headers + $PY_CMD setup.py sdist + $PY_CMD -m pip install --user -U ./dist/* + installed=$($PY_CMD -c "import pybind11; print(pybind11.get_include(True) + '/pybind11')") + diff -rq $installed ./include/pybind11 + - | + # Barebones build + cmake -DCMAKE_BUILD_TYPE=Debug -DPYBIND11_WERROR=ON -DDOWNLOAD_CATCH=ON -DPYTHON_EXECUTABLE=$(which $PY_CMD) . + make pytest -j 2 + make cpptest -j 2 + # The following are regular test configurations, including optional dependencies. + # With regard to each other they differ in Python version, C++ standard and compiler. + - os: linux + dist: trusty + name: Python 2.7, c++11, gcc 4.8 + env: PYTHON=2.7 CPP=11 GCC=4.8 + addons: + apt: + packages: + - cmake=2.\* + - cmake-data=2.\* + - os: linux + dist: trusty + name: Python 3.6, c++11, gcc 4.8 + env: PYTHON=3.6 CPP=11 GCC=4.8 + addons: + apt: + sources: + - deadsnakes + packages: + - python3.6-dev + - python3.6-venv + - cmake=2.\* + - cmake-data=2.\* + - os: linux + dist: trusty + env: PYTHON=2.7 CPP=14 GCC=6 CMAKE=1 + name: Python 2.7, c++14, gcc 4.8, CMake test + addons: + apt: + sources: + - ubuntu-toolchain-r-test + packages: + - g++-6 + - os: linux + dist: trusty + name: Python 3.5, c++14, gcc 6, Debug build + # N.B. `ensurepip` could be installed transitively by `python3.5-venv`, but + # seems to have apt conflicts (at least for Trusty). Use Docker instead. + services: docker + env: DOCKER=debian:stretch PYTHON=3.5 CPP=14 GCC=6 DEBUG=1 + - os: linux + dist: xenial + env: PYTHON=3.6 CPP=17 GCC=7 + name: Python 3.6, c++17, gcc 7 + addons: + apt: + sources: + - deadsnakes + - ubuntu-toolchain-r-test + packages: + - g++-7 + - python3.6-dev + - python3.6-venv + - os: linux + dist: xenial + env: PYTHON=3.6 CPP=17 CLANG=7 + name: Python 3.6, c++17, Clang 7 + addons: + apt: + sources: + - deadsnakes + - llvm-toolchain-xenial-7 + packages: + - python3.6-dev + - python3.6-venv + - clang-7 + - libclang-7-dev + - llvm-7-dev + - lld-7 + - libc++-7-dev + - libc++abi-7-dev # Why is this necessary??? + - os: osx + name: Python 2.7, c++14, AppleClang 7.3, CMake test + osx_image: xcode7.3 + env: PYTHON=2.7 CPP=14 CLANG CMAKE=1 + - os: osx + name: Python 3.7, c++14, AppleClang 9, Debug build + osx_image: xcode9 + env: PYTHON=3.7 CPP=14 CLANG DEBUG=1 + # Test a PyPy 2.7 build + - os: linux + dist: trusty + env: PYPY=5.8 PYTHON=2.7 CPP=11 GCC=4.8 + name: PyPy 5.8, Python 2.7, c++11, gcc 4.8 + addons: + apt: + packages: + - libblas-dev + - liblapack-dev + - gfortran + # Build in 32-bit mode and tests against the CMake-installed version + - os: linux + dist: trusty + services: docker + env: DOCKER=i386/debian:stretch PYTHON=3.5 CPP=14 GCC=6 INSTALL=1 + name: Python 3.4, c++14, gcc 6, 32-bit + script: + - | + # Consolidated 32-bit Docker Build + Install + set -ex + $SCRIPT_RUN_PREFIX sh -c " + set -ex + cmake ${CMAKE_EXTRA_ARGS} -DPYBIND11_INSTALL=1 -DPYBIND11_TEST=0 . + make install + cp -a tests /pybind11-tests + mkdir /build-tests && cd /build-tests + cmake ../pybind11-tests ${CMAKE_EXTRA_ARGS} -DPYBIND11_WERROR=ON + make pytest -j 2" + set +ex +cache: + directories: + - $HOME/.local/bin + - $HOME/.local/lib + - $HOME/.local/include + - $HOME/Library/Python +before_install: +- | + # Configure build variables + set -ex + if [ "$TRAVIS_OS_NAME" = "linux" ]; then + if [ -n "$CLANG" ]; then + export CXX=clang++-$CLANG CC=clang-$CLANG + EXTRA_PACKAGES+=" clang-$CLANG llvm-$CLANG-dev" + else + if [ -z "$GCC" ]; then GCC=4.8 + else EXTRA_PACKAGES+=" g++-$GCC" + fi + export CXX=g++-$GCC CC=gcc-$GCC + fi + elif [ "$TRAVIS_OS_NAME" = "osx" ]; then + export CXX=clang++ CC=clang; + fi + if [ -n "$CPP" ]; then CPP=-std=c++$CPP; fi + if [ "${PYTHON:0:1}" = "3" ]; then PY=3; fi + if [ -n "$DEBUG" ]; then CMAKE_EXTRA_ARGS+=" -DCMAKE_BUILD_TYPE=Debug"; fi + set +ex +- | + # Initialize environment + set -ex + if [ -n "$DOCKER" ]; then + docker pull $DOCKER + + containerid=$(docker run --detach --tty \ + --volume="$PWD":/pybind11 --workdir=/pybind11 \ + --env="CC=$CC" --env="CXX=$CXX" --env="DEBIAN_FRONTEND=$DEBIAN_FRONTEND" \ + --env=GCC_COLORS=\ \ + $DOCKER) + SCRIPT_RUN_PREFIX="docker exec --tty $containerid" + $SCRIPT_RUN_PREFIX sh -c 'for s in 0 15; do sleep $s; apt-get update && apt-get -qy dist-upgrade && break; done' + else + if [ "$PYPY" = "5.8" ]; then + curl -fSL https://bitbucket.org/pypy/pypy/downloads/pypy2-v5.8.0-linux64.tar.bz2 | tar xj + PY_CMD=$(echo `pwd`/pypy2-v5.8.0-linux64/bin/pypy) + CMAKE_EXTRA_ARGS+=" -DPYTHON_EXECUTABLE:FILEPATH=$PY_CMD" + else + PY_CMD=python$PYTHON + if [ "$TRAVIS_OS_NAME" = "osx" ]; then + if [ "$PY" = "3" ]; then + brew update && brew upgrade python + else + curl -fsSL https://bootstrap.pypa.io/get-pip.py | $PY_CMD - --user + fi + fi + fi + if [ "$PY" = 3 ] || [ -n "$PYPY" ]; then + $PY_CMD -m ensurepip --user + fi + $PY_CMD --version + $PY_CMD -m pip install --user --upgrade pip wheel + fi + set +ex +install: +- | + # Install dependencies + set -ex + cmake --version + if [ -n "$DOCKER" ]; then + if [ -n "$DEBUG" ]; then + PY_DEBUG="python$PYTHON-dbg python$PY-scipy-dbg" + CMAKE_EXTRA_ARGS+=" -DPYTHON_EXECUTABLE=/usr/bin/python${PYTHON}dm" + fi + $SCRIPT_RUN_PREFIX sh -c "for s in 0 15; do sleep \$s; \ + apt-get -qy --no-install-recommends install \ + $PY_DEBUG python$PYTHON-dev python$PY-pytest python$PY-scipy \ + libeigen3-dev libboost-dev cmake make ${EXTRA_PACKAGES} && break; done" + else + + if [ "$CLANG" = "7" ]; then + export CXXFLAGS="-stdlib=libc++" + fi + + export NPY_NUM_BUILD_JOBS=2 + echo "Installing pytest, numpy, scipy..." + local PIP_CMD="" + if [ -n $PYPY ]; then + # For expediency, install only versions that are available on the extra index. + travis_wait 30 \ + $PY_CMD -m pip install --user --upgrade --extra-index-url https://imaginary.ca/trusty-pypi \ + pytest numpy==1.15.4 scipy==1.2.0 + else + $PY_CMD -m pip install --user --upgrade pytest numpy scipy + fi + echo "done." + + mkdir eigen + curl -fsSL https://bitbucket.org/eigen/eigen/get/3.3.4.tar.bz2 | \ + tar --extract -j --directory=eigen --strip-components=1 + export CMAKE_INCLUDE_PATH="${CMAKE_INCLUDE_PATH:+$CMAKE_INCLUDE_PATH:}$PWD/eigen" + fi + set +ex +script: +- | + # CMake Configuration + set -ex + $SCRIPT_RUN_PREFIX cmake ${CMAKE_EXTRA_ARGS} \ + -DPYBIND11_PYTHON_VERSION=$PYTHON \ + -DPYBIND11_CPP_STANDARD=$CPP \ + -DPYBIND11_WERROR=${WERROR:-ON} \ + -DDOWNLOAD_CATCH=${DOWNLOAD_CATCH:-ON} \ + . + set +ex +- | + # pytest + set -ex + $SCRIPT_RUN_PREFIX make pytest -j 2 VERBOSE=1 + set +ex +- | + # cpptest + set -ex + $SCRIPT_RUN_PREFIX make cpptest -j 2 + set +ex +- | + # CMake Build Interface + set -ex + if [ -n "$CMAKE" ]; then $SCRIPT_RUN_PREFIX make test_cmake_build; fi + set +ex +after_failure: cat tests/test_cmake_build/*.log* +after_script: +- | + # Cleanup (Docker) + set -ex + if [ -n "$DOCKER" ]; then docker stop "$containerid"; docker rm "$containerid"; fi + set +ex diff --git a/pybind11/CMakeLists.txt b/pybind11/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..493724613188e7456f15eb9b319fe3a172475986 --- /dev/null +++ b/pybind11/CMakeLists.txt @@ -0,0 +1,162 @@ +# CMakeLists.txt -- Build system for the pybind11 modules +# +# Copyright (c) 2015 Wenzel Jakob <wenzel@inf.ethz.ch> +# +# All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE +# file. + +cmake_minimum_required(VERSION 2.8.12) + +if(POLICY CMP0048) + # cmake warns if loaded from a min-3.0-required parent dir, so silence the warning: + cmake_policy(SET CMP0048 NEW) +endif() + +# CMake versions < 3.4.0 do not support try_compile/pthread checks without C as active language. +if(CMAKE_VERSION VERSION_LESS 3.4.0) + project(pybind11) +else() + project(pybind11 CXX) +endif() + +# Check if pybind11 is being used directly or via add_subdirectory +set(PYBIND11_MASTER_PROJECT OFF) +if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) + set(PYBIND11_MASTER_PROJECT ON) +endif() + +option(PYBIND11_INSTALL "Install pybind11 header files?" ${PYBIND11_MASTER_PROJECT}) +option(PYBIND11_TEST "Build pybind11 test suite?" ${PYBIND11_MASTER_PROJECT}) + +list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/tools") + +include(pybind11Tools) + +# Cache variables so pybind11_add_module can be used in parent projects +set(PYBIND11_INCLUDE_DIR "${CMAKE_CURRENT_LIST_DIR}/include" CACHE INTERNAL "") +set(PYTHON_INCLUDE_DIRS ${PYTHON_INCLUDE_DIRS} CACHE INTERNAL "") +set(PYTHON_LIBRARIES ${PYTHON_LIBRARIES} CACHE INTERNAL "") +set(PYTHON_MODULE_PREFIX ${PYTHON_MODULE_PREFIX} CACHE INTERNAL "") +set(PYTHON_MODULE_EXTENSION ${PYTHON_MODULE_EXTENSION} CACHE INTERNAL "") +set(PYTHON_VERSION_MAJOR ${PYTHON_VERSION_MAJOR} CACHE INTERNAL "") +set(PYTHON_VERSION_MINOR ${PYTHON_VERSION_MINOR} CACHE INTERNAL "") + +# NB: when adding a header don't forget to also add it to setup.py +set(PYBIND11_HEADERS + include/pybind11/detail/class.h + include/pybind11/detail/common.h + include/pybind11/detail/descr.h + include/pybind11/detail/init.h + include/pybind11/detail/internals.h + include/pybind11/detail/typeid.h + include/pybind11/attr.h + include/pybind11/buffer_info.h + include/pybind11/cast.h + include/pybind11/chrono.h + include/pybind11/common.h + include/pybind11/complex.h + include/pybind11/options.h + include/pybind11/eigen.h + include/pybind11/embed.h + include/pybind11/eval.h + include/pybind11/functional.h + include/pybind11/numpy.h + include/pybind11/operators.h + include/pybind11/pybind11.h + include/pybind11/pytypes.h + include/pybind11/stl.h + include/pybind11/stl_bind.h) +string(REPLACE "include/" + "${CMAKE_CURRENT_SOURCE_DIR}/include/" + PYBIND11_HEADERS + "${PYBIND11_HEADERS}") + +if(PYBIND11_TEST) + add_subdirectory(tests) +endif() + +include(GNUInstallDirs) +include(CMakePackageConfigHelpers) + +# extract project version from source +file(STRINGS "${PYBIND11_INCLUDE_DIR}/pybind11/detail/common.h" pybind11_version_defines + REGEX "#define PYBIND11_VERSION_(MAJOR|MINOR|PATCH) ") +foreach(ver ${pybind11_version_defines}) + if(ver MATCHES "#define PYBIND11_VERSION_(MAJOR|MINOR|PATCH) +([^ ]+)$") + set(PYBIND11_VERSION_${CMAKE_MATCH_1} "${CMAKE_MATCH_2}" CACHE INTERNAL "") + endif() +endforeach() +set(${PROJECT_NAME}_VERSION ${PYBIND11_VERSION_MAJOR}.${PYBIND11_VERSION_MINOR}.${PYBIND11_VERSION_PATCH}) +message(STATUS "pybind11 v${${PROJECT_NAME}_VERSION}") + +option(USE_PYTHON_INCLUDE_DIR + "Install pybind11 headers in Python include directory instead of default installation prefix" OFF) +if(USE_PYTHON_INCLUDE_DIR) + file(RELATIVE_PATH CMAKE_INSTALL_INCLUDEDIR ${CMAKE_INSTALL_PREFIX} ${PYTHON_INCLUDE_DIRS}) +endif() + +if(NOT (CMAKE_VERSION VERSION_LESS 3.0)) # CMake >= 3.0 Build an interface library target: + add_library(pybind11 INTERFACE) + add_library(pybind11::pybind11 ALIAS pybind11) # to match exported target + target_include_directories(pybind11 + INTERFACE $<BUILD_INTERFACE:${PYBIND11_INCLUDE_DIR}> + $<BUILD_INTERFACE:${PYTHON_INCLUDE_DIRS}> + $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>) + target_compile_options(pybind11 INTERFACE $<BUILD_INTERFACE:${PYBIND11_CPP_STANDARD}>) + + add_library(module INTERFACE) + add_library(pybind11::module ALIAS module) + if(NOT MSVC) + target_compile_options(module PRIVATE -fvisibility=hidden) + endif() + target_link_libraries(module INTERFACE pybind11::pybind11) + if(WIN32 OR CYGWIN) + target_link_libraries(module INTERFACE $<BUILD_INTERFACE:${PYTHON_LIBRARIES}>) + elseif(APPLE) + target_link_libraries(module INTERFACE "-undefined dynamic_lookup") + endif() + + add_library(embed INTERFACE) + add_library(pybind11::embed ALIAS embed) + target_link_libraries(embed INTERFACE pybind11::pybind11 $<BUILD_INTERFACE:${PYTHON_LIBRARIES}>) +endif() + +if(PYBIND11_INSTALL) + install(DIRECTORY ${PYBIND11_INCLUDE_DIR}/pybind11 DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) + # GNUInstallDirs "DATADIR" wrong here; CMake search path wants "share". + set(PYBIND11_CMAKECONFIG_INSTALL_DIR "share/cmake/${PROJECT_NAME}" + CACHE STRING "install path for pybind11Config.cmake") + + configure_package_config_file(tools/${PROJECT_NAME}Config.cmake.in + "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake" + INSTALL_DESTINATION + ${PYBIND11_CMAKECONFIG_INSTALL_DIR}) + # Remove CMAKE_SIZEOF_VOID_P from ConfigVersion.cmake since the library does not depend on architecture specific + # settings or libraries. + set(_PYBIND11_CMAKE_SIZEOF_VOID_P ${CMAKE_SIZEOF_VOID_P}) + unset(CMAKE_SIZEOF_VOID_P) + write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake + VERSION + ${${PROJECT_NAME}_VERSION} + COMPATIBILITY + AnyNewerVersion) + set(CMAKE_SIZEOF_VOID_P ${_PYBIND11_CMAKE_SIZEOF_VOID_P}) + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake + ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake + tools/FindPythonLibsNew.cmake + tools/pybind11Tools.cmake + DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR}) + + if(NOT (CMAKE_VERSION VERSION_LESS 3.0)) + if(NOT PYBIND11_EXPORT_NAME) + set(PYBIND11_EXPORT_NAME "${PROJECT_NAME}Targets") + endif() + + install(TARGETS pybind11 module embed EXPORT "${PYBIND11_EXPORT_NAME}") + if(PYBIND11_MASTER_PROJECT) + install(EXPORT "${PYBIND11_EXPORT_NAME}" + NAMESPACE "${PROJECT_NAME}::" + DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR}) + endif() + endif() +endif() diff --git a/pybind11/CONTRIBUTING.md b/pybind11/CONTRIBUTING.md new file mode 100644 index 0000000000000000000000000000000000000000..01596d94f3aba5b125a4d5a9f029f3d0086654aa --- /dev/null +++ b/pybind11/CONTRIBUTING.md @@ -0,0 +1,49 @@ +Thank you for your interest in this project! Please refer to the following +sections on how to contribute code and bug reports. + +### Reporting bugs + +At the moment, this project is run in the spare time of a single person +([Wenzel Jakob](http://rgl.epfl.ch/people/wjakob)) with very limited resources +for issue tracker tickets. Thus, before submitting a question or bug report, +please take a moment of your time and ensure that your issue isn't already +discussed in the project documentation provided at +[http://pybind11.readthedocs.org/en/latest](http://pybind11.readthedocs.org/en/latest). + +Assuming that you have identified a previously unknown problem or an important +question, it's essential that you submit a self-contained and minimal piece of +code that reproduces the problem. In other words: no external dependencies, +isolate the function(s) that cause breakage, submit matched and complete C++ +and Python snippets that can be easily compiled and run on my end. + +## Pull requests +Contributions are submitted, reviewed, and accepted using Github pull requests. +Please refer to [this +article](https://help.github.com/articles/using-pull-requests) for details and +adhere to the following rules to make the process as smooth as possible: + +* Make a new branch for every feature you're working on. +* Make small and clean pull requests that are easy to review but make sure they + do add value by themselves. +* Add tests for any new functionality and run the test suite (``make pytest``) + to ensure that no existing features break. +* Please run ``flake8`` and ``tools/check-style.sh`` to check your code matches + the project style. (Note that ``check-style.sh`` requires ``gawk``.) +* This project has a strong focus on providing general solutions using a + minimal amount of code, thus small pull requests are greatly preferred. + +### Licensing of contributions + +pybind11 is provided under a BSD-style license that can be found in the +``LICENSE`` file. By using, distributing, or contributing to this project, you +agree to the terms and conditions of this license. + +You are under no obligation whatsoever to provide any bug fixes, patches, or +upgrades to the features, functionality or performance of the source code +("Enhancements") to anyone; however, if you choose to make your Enhancements +available either publicly, or directly to the author of this software, without +imposing a separate written license agreement for such Enhancements, then you +hereby grant the following license: a non-exclusive, royalty-free perpetual +license to install, use, modify, prepare derivative works, incorporate into +other computer software, distribute, and sublicense such enhancements or +derivative works thereof, in binary and source code form. diff --git a/pybind11/ISSUE_TEMPLATE.md b/pybind11/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000000000000000000000000000000000..75df39981ad2dc14ba50d00a078d7161f2bb2349 --- /dev/null +++ b/pybind11/ISSUE_TEMPLATE.md @@ -0,0 +1,17 @@ +Make sure you've completed the following steps before submitting your issue -- thank you! + +1. Check if your question has already been answered in the [FAQ](http://pybind11.readthedocs.io/en/latest/faq.html) section. +2. Make sure you've read the [documentation](http://pybind11.readthedocs.io/en/latest/). Your issue may be addressed there. +3. If those resources didn't help and you only have a short question (not a bug report), consider asking in the [Gitter chat room](https://gitter.im/pybind/Lobby). +4. If you have a genuine bug report or a more complex question which is not answered in the previous items (or not suitable for chat), please fill in the details below. +5. Include a self-contained and minimal piece of code that reproduces the problem. If that's not possible, try to make the description as clear as possible. + +*After reading, remove this checklist and the template text in parentheses below.* + +## Issue description + +(Provide a short description, state the expected behavior and what actually happens.) + +## Reproducible example code + +(The code should be minimal, have no external dependencies, isolate the function(s) that cause breakage. Submit matched and complete C++ and Python snippets that can be easily compiled and run to diagnose the issue.) diff --git a/pybind11/LICENSE b/pybind11/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..6f15578cc4044061e01305227eaefb3dc49f4e11 --- /dev/null +++ b/pybind11/LICENSE @@ -0,0 +1,29 @@ +Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>, All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Please also refer to the file CONTRIBUTING.md, which clarifies licensing of +external contributions to this project including patches, pull requests, etc. diff --git a/pybind11/MANIFEST.in b/pybind11/MANIFEST.in new file mode 100644 index 0000000000000000000000000000000000000000..6e57baeeef3e935b40f0f2ad5e638b58fd98db0b --- /dev/null +++ b/pybind11/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include include/pybind11 *.h +include LICENSE README.md CONTRIBUTING.md diff --git a/pybind11/README.md b/pybind11/README.md new file mode 100644 index 0000000000000000000000000000000000000000..35d2d76ff98d7b9a9df7e74be3b583581da4182a --- /dev/null +++ b/pybind11/README.md @@ -0,0 +1,129 @@ + + +# pybind11 — Seamless operability between C++11 and Python + +[](http://pybind11.readthedocs.org/en/master/?badge=master) +[](http://pybind11.readthedocs.org/en/stable/?badge=stable) +[](https://gitter.im/pybind/Lobby) +[](https://travis-ci.org/pybind/pybind11) +[](https://ci.appveyor.com/project/wjakob/pybind11) + +**pybind11** is a lightweight header-only library that exposes C++ types in Python +and vice versa, mainly to create Python bindings of existing C++ code. Its +goals and syntax are similar to the excellent +[Boost.Python](http://www.boost.org/doc/libs/1_58_0/libs/python/doc/) library +by David Abrahams: to minimize boilerplate code in traditional extension +modules by inferring type information using compile-time introspection. + +The main issue with Boost.Python—and the reason for creating such a similar +project—is Boost. Boost is an enormously large and complex suite of utility +libraries that works with almost every C++ compiler in existence. This +compatibility has its cost: arcane template tricks and workarounds are +necessary to support the oldest and buggiest of compiler specimens. Now that +C++11-compatible compilers are widely available, this heavy machinery has +become an excessively large and unnecessary dependency. + +Think of this library as a tiny self-contained version of Boost.Python with +everything stripped away that isn't relevant for binding generation. Without +comments, the core header files only require ~4K lines of code and depend on +Python (2.7 or 3.x, or PyPy2.7 >= 5.7) and the C++ standard library. This +compact implementation was possible thanks to some of the new C++11 language +features (specifically: tuples, lambda functions and variadic templates). Since +its creation, this library has grown beyond Boost.Python in many ways, leading +to dramatically simpler binding code in many common situations. + +Tutorial and reference documentation is provided at +[http://pybind11.readthedocs.org/en/master](http://pybind11.readthedocs.org/en/master). +A PDF version of the manual is available +[here](https://media.readthedocs.org/pdf/pybind11/master/pybind11.pdf). + +## Core features +pybind11 can map the following core C++ features to Python + +- Functions accepting and returning custom data structures per value, reference, or pointer +- Instance methods and static methods +- Overloaded functions +- Instance attributes and static attributes +- Arbitrary exception types +- Enumerations +- Callbacks +- Iterators and ranges +- Custom operators +- Single and multiple inheritance +- STL data structures +- Smart pointers with reference counting like ``std::shared_ptr`` +- Internal references with correct reference counting +- C++ classes with virtual (and pure virtual) methods can be extended in Python + +## Goodies +In addition to the core functionality, pybind11 provides some extra goodies: + +- Python 2.7, 3.x, and PyPy (PyPy2.7 >= 5.7) are supported with an + implementation-agnostic interface. + +- It is possible to bind C++11 lambda functions with captured variables. The + lambda capture data is stored inside the resulting Python function object. + +- pybind11 uses C++11 move constructors and move assignment operators whenever + possible to efficiently transfer custom data types. + +- It's easy to expose the internal storage of custom data types through + Pythons' buffer protocols. This is handy e.g. for fast conversion between + C++ matrix classes like Eigen and NumPy without expensive copy operations. + +- pybind11 can automatically vectorize functions so that they are transparently + applied to all entries of one or more NumPy array arguments. + +- Python's slice-based access and assignment operations can be supported with + just a few lines of code. + +- Everything is contained in just a few header files; there is no need to link + against any additional libraries. + +- Binaries are generally smaller by a factor of at least 2 compared to + equivalent bindings generated by Boost.Python. A recent pybind11 conversion + of PyRosetta, an enormous Boost.Python binding project, + [reported](http://graylab.jhu.edu/RosettaCon2016/PyRosetta-4.pdf) a binary + size reduction of **5.4x** and compile time reduction by **5.8x**. + +- Function signatures are precomputed at compile time (using ``constexpr``), + leading to smaller binaries. + +- With little extra effort, C++ types can be pickled and unpickled similar to + regular Python objects. + +## Supported compilers + +1. Clang/LLVM 3.3 or newer (for Apple Xcode's clang, this is 5.0.0 or newer) +2. GCC 4.8 or newer +3. Microsoft Visual Studio 2015 Update 3 or newer +4. Intel C++ compiler 17 or newer (16 with pybind11 v2.0 and 15 with pybind11 v2.0 and a [workaround](https://github.com/pybind/pybind11/issues/276)) +5. Cygwin/GCC (tested on 2.5.1) + +## About + +This project was created by [Wenzel Jakob](http://rgl.epfl.ch/people/wjakob). +Significant features and/or improvements to the code were contributed by +Jonas Adler, +Lori A. Burns, +Sylvain Corlay, +Trent Houliston, +Axel Huebl, +@hulucc, +Sergey Lyskov +Johan Mabille, +Tomasz MiÄ…sko, +Dean Moldovan, +Ben Pritchard, +Jason Rhinelander, +Boris Schäling, +Pim Schellart, +Henry Schreiner, +Ivan Smirnov, and +Patrick Stewart. + +### License + +pybind11 is provided under a BSD-style license that can be found in the +``LICENSE`` file. By using, distributing, or contributing to this project, +you agree to the terms and conditions of this license. diff --git a/pybind11/docs/Doxyfile b/pybind11/docs/Doxyfile new file mode 100644 index 0000000000000000000000000000000000000000..1b9d1297c513ab44d834a5a880def48f62cf524b --- /dev/null +++ b/pybind11/docs/Doxyfile @@ -0,0 +1,20 @@ +PROJECT_NAME = pybind11 +INPUT = ../include/pybind11/ +RECURSIVE = YES + +GENERATE_HTML = NO +GENERATE_LATEX = NO +GENERATE_XML = YES +XML_OUTPUT = .build/doxygenxml +XML_PROGRAMLISTING = YES + +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +EXPAND_AS_DEFINED = PYBIND11_RUNTIME_EXCEPTION + +ALIASES = "rst=\verbatim embed:rst" +ALIASES += "endrst=\endverbatim" + +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = NO diff --git a/pybind11/docs/_static/theme_overrides.css b/pybind11/docs/_static/theme_overrides.css new file mode 100644 index 0000000000000000000000000000000000000000..1071809fa0fecf7c28d3356f37363266e9128b81 --- /dev/null +++ b/pybind11/docs/_static/theme_overrides.css @@ -0,0 +1,11 @@ +.wy-table-responsive table td, +.wy-table-responsive table th { + white-space: initial !important; +} +.rst-content table.docutils td { + vertical-align: top !important; +} +div[class^='highlight'] pre { + white-space: pre; + white-space: pre-wrap; +} diff --git a/pybind11/docs/advanced/cast/chrono.rst b/pybind11/docs/advanced/cast/chrono.rst new file mode 100644 index 0000000000000000000000000000000000000000..8c6b3d7e59098724533402847e902aa9317fa8ee --- /dev/null +++ b/pybind11/docs/advanced/cast/chrono.rst @@ -0,0 +1,81 @@ +Chrono +====== + +When including the additional header file :file:`pybind11/chrono.h` conversions +from C++11 chrono datatypes to python datetime objects are automatically enabled. +This header also enables conversions of python floats (often from sources such +as ``time.monotonic()``, ``time.perf_counter()`` and ``time.process_time()``) +into durations. + +An overview of clocks in C++11 +------------------------------ + +A point of confusion when using these conversions is the differences between +clocks provided in C++11. There are three clock types defined by the C++11 +standard and users can define their own if needed. Each of these clocks have +different properties and when converting to and from python will give different +results. + +The first clock defined by the standard is ``std::chrono::system_clock``. This +clock measures the current date and time. However, this clock changes with to +updates to the operating system time. For example, if your time is synchronised +with a time server this clock will change. This makes this clock a poor choice +for timing purposes but good for measuring the wall time. + +The second clock defined in the standard is ``std::chrono::steady_clock``. +This clock ticks at a steady rate and is never adjusted. This makes it excellent +for timing purposes, however the value in this clock does not correspond to the +current date and time. Often this clock will be the amount of time your system +has been on, although it does not have to be. This clock will never be the same +clock as the system clock as the system clock can change but steady clocks +cannot. + +The third clock defined in the standard is ``std::chrono::high_resolution_clock``. +This clock is the clock that has the highest resolution out of the clocks in the +system. It is normally a typedef to either the system clock or the steady clock +but can be its own independent clock. This is important as when using these +conversions as the types you get in python for this clock might be different +depending on the system. +If it is a typedef of the system clock, python will get datetime objects, but if +it is a different clock they will be timedelta objects. + +Provided conversions +-------------------- + +.. rubric:: C++ to Python + +- ``std::chrono::system_clock::time_point`` → ``datetime.datetime`` + System clock times are converted to python datetime instances. They are + in the local timezone, but do not have any timezone information attached + to them (they are naive datetime objects). + +- ``std::chrono::duration`` → ``datetime.timedelta`` + Durations are converted to timedeltas, any precision in the duration + greater than microseconds is lost by rounding towards zero. + +- ``std::chrono::[other_clocks]::time_point`` → ``datetime.timedelta`` + Any clock time that is not the system clock is converted to a time delta. + This timedelta measures the time from the clocks epoch to now. + +.. rubric:: Python to C++ + +- ``datetime.datetime`` → ``std::chrono::system_clock::time_point`` + Date/time objects are converted into system clock timepoints. Any + timezone information is ignored and the type is treated as a naive + object. + +- ``datetime.timedelta`` → ``std::chrono::duration`` + Time delta are converted into durations with microsecond precision. + +- ``datetime.timedelta`` → ``std::chrono::[other_clocks]::time_point`` + Time deltas that are converted into clock timepoints are treated as + the amount of time from the start of the clocks epoch. + +- ``float`` → ``std::chrono::duration`` + Floats that are passed to C++ as durations be interpreted as a number of + seconds. These will be converted to the duration using ``duration_cast`` + from the float. + +- ``float`` → ``std::chrono::[other_clocks]::time_point`` + Floats that are passed to C++ as time points will be interpreted as the + number of seconds from the start of the clocks epoch. diff --git a/pybind11/docs/advanced/cast/custom.rst b/pybind11/docs/advanced/cast/custom.rst new file mode 100644 index 0000000000000000000000000000000000000000..e4f99ac5b086355ff8e691a22ad5e16ea84dfed7 --- /dev/null +++ b/pybind11/docs/advanced/cast/custom.rst @@ -0,0 +1,91 @@ +Custom type casters +=================== + +In very rare cases, applications may require custom type casters that cannot be +expressed using the abstractions provided by pybind11, thus requiring raw +Python C API calls. This is fairly advanced usage and should only be pursued by +experts who are familiar with the intricacies of Python reference counting. + +The following snippets demonstrate how this works for a very simple ``inty`` +type that that should be convertible from Python types that provide a +``__int__(self)`` method. + +.. code-block:: cpp + + struct inty { long long_value; }; + + void print(inty s) { + std::cout << s.long_value << std::endl; + } + +The following Python snippet demonstrates the intended usage from the Python side: + +.. code-block:: python + + class A: + def __int__(self): + return 123 + + from example import print + print(A()) + +To register the necessary conversion routines, it is necessary to add +a partial overload to the ``pybind11::detail::type_caster<T>`` template. +Although this is an implementation detail, adding partial overloads to this +type is explicitly allowed. + +.. code-block:: cpp + + namespace pybind11 { namespace detail { + template <> struct type_caster<inty> { + public: + /** + * This macro establishes the name 'inty' in + * function signatures and declares a local variable + * 'value' of type inty + */ + PYBIND11_TYPE_CASTER(inty, _("inty")); + + /** + * Conversion part 1 (Python->C++): convert a PyObject into a inty + * instance or return false upon failure. The second argument + * indicates whether implicit conversions should be applied. + */ + bool load(handle src, bool) { + /* Extract PyObject from handle */ + PyObject *source = src.ptr(); + /* Try converting into a Python integer value */ + PyObject *tmp = PyNumber_Long(source); + if (!tmp) + return false; + /* Now try to convert into a C++ int */ + value.long_value = PyLong_AsLong(tmp); + Py_DECREF(tmp); + /* Ensure return code was OK (to avoid out-of-range errors etc) */ + return !(value.long_value == -1 && !PyErr_Occurred()); + } + + /** + * Conversion part 2 (C++ -> Python): convert an inty instance into + * a Python object. The second and third arguments are used to + * indicate the return value policy and parent object (for + * ``return_value_policy::reference_internal``) and are generally + * ignored by implicit casters. + */ + static handle cast(inty src, return_value_policy /* policy */, handle /* parent */) { + return PyLong_FromLong(src.long_value); + } + }; + }} // namespace pybind11::detail + +.. note:: + + A ``type_caster<T>`` defined with ``PYBIND11_TYPE_CASTER(T, ...)`` requires + that ``T`` is default-constructible (``value`` is first default constructed + and then ``load()`` assigns to it). + +.. warning:: + + When using custom type casters, it's important to declare them consistently + in every compilation unit of the Python extension module. Otherwise, + undefined behavior can ensue. diff --git a/pybind11/docs/advanced/cast/eigen.rst b/pybind11/docs/advanced/cast/eigen.rst new file mode 100644 index 0000000000000000000000000000000000000000..59ba08c3c4297556f6aaa2e0c8db328eb1490e40 --- /dev/null +++ b/pybind11/docs/advanced/cast/eigen.rst @@ -0,0 +1,310 @@ +Eigen +##### + +`Eigen <http://eigen.tuxfamily.org>`_ is C++ header-based library for dense and +sparse linear algebra. Due to its popularity and widespread adoption, pybind11 +provides transparent conversion and limited mapping support between Eigen and +Scientific Python linear algebra data types. + +To enable the built-in Eigen support you must include the optional header file +:file:`pybind11/eigen.h`. + +Pass-by-value +============= + +When binding a function with ordinary Eigen dense object arguments (for +example, ``Eigen::MatrixXd``), pybind11 will accept any input value that is +already (or convertible to) a ``numpy.ndarray`` with dimensions compatible with +the Eigen type, copy its values into a temporary Eigen variable of the +appropriate type, then call the function with this temporary variable. + +Sparse matrices are similarly copied to or from +``scipy.sparse.csr_matrix``/``scipy.sparse.csc_matrix`` objects. + +Pass-by-reference +================= + +One major limitation of the above is that every data conversion implicitly +involves a copy, which can be both expensive (for large matrices) and disallows +binding functions that change their (Matrix) arguments. Pybind11 allows you to +work around this by using Eigen's ``Eigen::Ref<MatrixType>`` class much as you +would when writing a function taking a generic type in Eigen itself (subject to +some limitations discussed below). + +When calling a bound function accepting a ``Eigen::Ref<const MatrixType>`` +type, pybind11 will attempt to avoid copying by using an ``Eigen::Map`` object +that maps into the source ``numpy.ndarray`` data: this requires both that the +data types are the same (e.g. ``dtype='float64'`` and ``MatrixType::Scalar`` is +``double``); and that the storage is layout compatible. The latter limitation +is discussed in detail in the section below, and requires careful +consideration: by default, numpy matrices and Eigen matrices are *not* storage +compatible. + +If the numpy matrix cannot be used as is (either because its types differ, e.g. +passing an array of integers to an Eigen parameter requiring doubles, or +because the storage is incompatible), pybind11 makes a temporary copy and +passes the copy instead. + +When a bound function parameter is instead ``Eigen::Ref<MatrixType>`` (note the +lack of ``const``), pybind11 will only allow the function to be called if it +can be mapped *and* if the numpy array is writeable (that is +``a.flags.writeable`` is true). Any access (including modification) made to +the passed variable will be transparently carried out directly on the +``numpy.ndarray``. + +This means you can can write code such as the following and have it work as +expected: + +.. code-block:: cpp + + void scale_by_2(Eigen::Ref<Eigen::VectorXd> v) { + v *= 2; + } + +Note, however, that you will likely run into limitations due to numpy and +Eigen's difference default storage order for data; see the below section on +:ref:`storage_orders` for details on how to bind code that won't run into such +limitations. + +.. note:: + + Passing by reference is not supported for sparse types. + +Returning values to Python +========================== + +When returning an ordinary dense Eigen matrix type to numpy (e.g. +``Eigen::MatrixXd`` or ``Eigen::RowVectorXf``) pybind11 keeps the matrix and +returns a numpy array that directly references the Eigen matrix: no copy of the +data is performed. The numpy array will have ``array.flags.owndata`` set to +``False`` to indicate that it does not own the data, and the lifetime of the +stored Eigen matrix will be tied to the returned ``array``. + +If you bind a function with a non-reference, ``const`` return type (e.g. +``const Eigen::MatrixXd``), the same thing happens except that pybind11 also +sets the numpy array's ``writeable`` flag to false. + +If you return an lvalue reference or pointer, the usual pybind11 rules apply, +as dictated by the binding function's return value policy (see the +documentation on :ref:`return_value_policies` for full details). That means, +without an explicit return value policy, lvalue references will be copied and +pointers will be managed by pybind11. In order to avoid copying, you should +explicitly specify an appropriate return value policy, as in the following +example: + +.. code-block:: cpp + + class MyClass { + Eigen::MatrixXd big_mat = Eigen::MatrixXd::Zero(10000, 10000); + public: + Eigen::MatrixXd &getMatrix() { return big_mat; } + const Eigen::MatrixXd &viewMatrix() { return big_mat; } + }; + + // Later, in binding code: + py::class_<MyClass>(m, "MyClass") + .def(py::init<>()) + .def("copy_matrix", &MyClass::getMatrix) // Makes a copy! + .def("get_matrix", &MyClass::getMatrix, py::return_value_policy::reference_internal) + .def("view_matrix", &MyClass::viewMatrix, py::return_value_policy::reference_internal) + ; + +.. code-block:: python + + a = MyClass() + m = a.get_matrix() # flags.writeable = True, flags.owndata = False + v = a.view_matrix() # flags.writeable = False, flags.owndata = False + c = a.copy_matrix() # flags.writeable = True, flags.owndata = True + # m[5,6] and v[5,6] refer to the same element, c[5,6] does not. + +Note in this example that ``py::return_value_policy::reference_internal`` is +used to tie the life of the MyClass object to the life of the returned arrays. + +You may also return an ``Eigen::Ref``, ``Eigen::Map`` or other map-like Eigen +object (for example, the return value of ``matrix.block()`` and related +methods) that map into a dense Eigen type. When doing so, the default +behaviour of pybind11 is to simply reference the returned data: you must take +care to ensure that this data remains valid! You may ask pybind11 to +explicitly *copy* such a return value by using the +``py::return_value_policy::copy`` policy when binding the function. You may +also use ``py::return_value_policy::reference_internal`` or a +``py::keep_alive`` to ensure the data stays valid as long as the returned numpy +array does. + +When returning such a reference of map, pybind11 additionally respects the +readonly-status of the returned value, marking the numpy array as non-writeable +if the reference or map was itself read-only. + +.. note:: + + Sparse types are always copied when returned. + +.. _storage_orders: + +Storage orders +============== + +Passing arguments via ``Eigen::Ref`` has some limitations that you must be +aware of in order to effectively pass matrices by reference. First and +foremost is that the default ``Eigen::Ref<MatrixType>`` class requires +contiguous storage along columns (for column-major types, the default in Eigen) +or rows if ``MatrixType`` is specifically an ``Eigen::RowMajor`` storage type. +The former, Eigen's default, is incompatible with ``numpy``'s default row-major +storage, and so you will not be able to pass numpy arrays to Eigen by reference +without making one of two changes. + +(Note that this does not apply to vectors (or column or row matrices): for such +types the "row-major" and "column-major" distinction is meaningless). + +The first approach is to change the use of ``Eigen::Ref<MatrixType>`` to the +more general ``Eigen::Ref<MatrixType, 0, Eigen::Stride<Eigen::Dynamic, +Eigen::Dynamic>>`` (or similar type with a fully dynamic stride type in the +third template argument). Since this is a rather cumbersome type, pybind11 +provides a ``py::EigenDRef<MatrixType>`` type alias for your convenience (along +with EigenDMap for the equivalent Map, and EigenDStride for just the stride +type). + +This type allows Eigen to map into any arbitrary storage order. This is not +the default in Eigen for performance reasons: contiguous storage allows +vectorization that cannot be done when storage is not known to be contiguous at +compile time. The default ``Eigen::Ref`` stride type allows non-contiguous +storage along the outer dimension (that is, the rows of a column-major matrix +or columns of a row-major matrix), but not along the inner dimension. + +This type, however, has the added benefit of also being able to map numpy array +slices. For example, the following (contrived) example uses Eigen with a numpy +slice to multiply by 2 all coefficients that are both on even rows (0, 2, 4, +...) and in columns 2, 5, or 8: + +.. code-block:: cpp + + m.def("scale", [](py::EigenDRef<Eigen::MatrixXd> m, double c) { m *= c; }); + +.. code-block:: python + + # a = np.array(...) + scale_by_2(myarray[0::2, 2:9:3]) + +The second approach to avoid copying is more intrusive: rearranging the +underlying data types to not run into the non-contiguous storage problem in the +first place. In particular, that means using matrices with ``Eigen::RowMajor`` +storage, where appropriate, such as: + +.. code-block:: cpp + + using RowMatrixXd = Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>; + // Use RowMatrixXd instead of MatrixXd + +Now bound functions accepting ``Eigen::Ref<RowMatrixXd>`` arguments will be +callable with numpy's (default) arrays without involving a copying. + +You can, alternatively, change the storage order that numpy arrays use by +adding the ``order='F'`` option when creating an array: + +.. code-block:: python + + myarray = np.array(source, order='F') + +Such an object will be passable to a bound function accepting an +``Eigen::Ref<MatrixXd>`` (or similar column-major Eigen type). + +One major caveat with this approach, however, is that it is not entirely as +easy as simply flipping all Eigen or numpy usage from one to the other: some +operations may alter the storage order of a numpy array. For example, ``a2 = +array.transpose()`` results in ``a2`` being a view of ``array`` that references +the same data, but in the opposite storage order! + +While this approach allows fully optimized vectorized calculations in Eigen, it +cannot be used with array slices, unlike the first approach. + +When *returning* a matrix to Python (either a regular matrix, a reference via +``Eigen::Ref<>``, or a map/block into a matrix), no special storage +consideration is required: the created numpy array will have the required +stride that allows numpy to properly interpret the array, whatever its storage +order. + +Failing rather than copying +=========================== + +The default behaviour when binding ``Eigen::Ref<const MatrixType>`` Eigen +references is to copy matrix values when passed a numpy array that does not +conform to the element type of ``MatrixType`` or does not have a compatible +stride layout. If you want to explicitly avoid copying in such a case, you +should bind arguments using the ``py::arg().noconvert()`` annotation (as +described in the :ref:`nonconverting_arguments` documentation). + +The following example shows an example of arguments that don't allow data +copying to take place: + +.. code-block:: cpp + + // The method and function to be bound: + class MyClass { + // ... + double some_method(const Eigen::Ref<const MatrixXd> &matrix) { /* ... */ } + }; + float some_function(const Eigen::Ref<const MatrixXf> &big, + const Eigen::Ref<const MatrixXf> &small) { + // ... + } + + // The associated binding code: + using namespace pybind11::literals; // for "arg"_a + py::class_<MyClass>(m, "MyClass") + // ... other class definitions + .def("some_method", &MyClass::some_method, py::arg().noconvert()); + + m.def("some_function", &some_function, + "big"_a.noconvert(), // <- Don't allow copying for this arg + "small"_a // <- This one can be copied if needed + ); + +With the above binding code, attempting to call the the ``some_method(m)`` +method on a ``MyClass`` object, or attempting to call ``some_function(m, m2)`` +will raise a ``RuntimeError`` rather than making a temporary copy of the array. +It will, however, allow the ``m2`` argument to be copied into a temporary if +necessary. + +Note that explicitly specifying ``.noconvert()`` is not required for *mutable* +Eigen references (e.g. ``Eigen::Ref<MatrixXd>`` without ``const`` on the +``MatrixXd``): mutable references will never be called with a temporary copy. + +Vectors versus column/row matrices +================================== + +Eigen and numpy have fundamentally different notions of a vector. In Eigen, a +vector is simply a matrix with the number of columns or rows set to 1 at +compile time (for a column vector or row vector, respectively). Numpy, in +contrast, has comparable 2-dimensional 1xN and Nx1 arrays, but *also* has +1-dimensional arrays of size N. + +When passing a 2-dimensional 1xN or Nx1 array to Eigen, the Eigen type must +have matching dimensions: That is, you cannot pass a 2-dimensional Nx1 numpy +array to an Eigen value expecting a row vector, or a 1xN numpy array as a +column vector argument. + +On the other hand, pybind11 allows you to pass 1-dimensional arrays of length N +as Eigen parameters. If the Eigen type can hold a column vector of length N it +will be passed as such a column vector. If not, but the Eigen type constraints +will accept a row vector, it will be passed as a row vector. (The column +vector takes precedence when both are supported, for example, when passing a +1D numpy array to a MatrixXd argument). Note that the type need not be +explicitly a vector: it is permitted to pass a 1D numpy array of size 5 to an +Eigen ``Matrix<double, Dynamic, 5>``: you would end up with a 1x5 Eigen matrix. +Passing the same to an ``Eigen::MatrixXd`` would result in a 5x1 Eigen matrix. + +When returning an Eigen vector to numpy, the conversion is ambiguous: a row +vector of length 4 could be returned as either a 1D array of length 4, or as a +2D array of size 1x4. When encountering such a situation, pybind11 compromises +by considering the returned Eigen type: if it is a compile-time vector--that +is, the type has either the number of rows or columns set to 1 at compile +time--pybind11 converts to a 1D numpy array when returning the value. For +instances that are a vector only at run-time (e.g. ``MatrixXd``, +``Matrix<float, Dynamic, 4>``), pybind11 returns the vector as a 2D array to +numpy. If this isn't want you want, you can use ``array.reshape(...)`` to get +a view of the same data in the desired dimensions. + +.. seealso:: + + The file :file:`tests/test_eigen.cpp` contains a complete example that + shows how to pass Eigen sparse and dense data types in more detail. diff --git a/pybind11/docs/advanced/cast/functional.rst b/pybind11/docs/advanced/cast/functional.rst new file mode 100644 index 0000000000000000000000000000000000000000..d9b46057598f0d182422accd088fbff9785b0b53 --- /dev/null +++ b/pybind11/docs/advanced/cast/functional.rst @@ -0,0 +1,109 @@ +Functional +########## + +The following features must be enabled by including :file:`pybind11/functional.h`. + + +Callbacks and passing anonymous functions +========================================= + +The C++11 standard brought lambda functions and the generic polymorphic +function wrapper ``std::function<>`` to the C++ programming language, which +enable powerful new ways of working with functions. Lambda functions come in +two flavors: stateless lambda function resemble classic function pointers that +link to an anonymous piece of code, while stateful lambda functions +additionally depend on captured variables that are stored in an anonymous +*lambda closure object*. + +Here is a simple example of a C++ function that takes an arbitrary function +(stateful or stateless) with signature ``int -> int`` as an argument and runs +it with the value 10. + +.. code-block:: cpp + + int func_arg(const std::function<int(int)> &f) { + return f(10); + } + +The example below is more involved: it takes a function of signature ``int -> int`` +and returns another function of the same kind. The return value is a stateful +lambda function, which stores the value ``f`` in the capture object and adds 1 to +its return value upon execution. + +.. code-block:: cpp + + std::function<int(int)> func_ret(const std::function<int(int)> &f) { + return [f](int i) { + return f(i) + 1; + }; + } + +This example demonstrates using python named parameters in C++ callbacks which +requires using ``py::cpp_function`` as a wrapper. Usage is similar to defining +methods of classes: + +.. code-block:: cpp + + py::cpp_function func_cpp() { + return py::cpp_function([](int i) { return i+1; }, + py::arg("number")); + } + +After including the extra header file :file:`pybind11/functional.h`, it is almost +trivial to generate binding code for all of these functions. + +.. code-block:: cpp + + #include <pybind11/functional.h> + + PYBIND11_MODULE(example, m) { + m.def("func_arg", &func_arg); + m.def("func_ret", &func_ret); + m.def("func_cpp", &func_cpp); + } + +The following interactive session shows how to call them from Python. + +.. code-block:: pycon + + $ python + >>> import example + >>> def square(i): + ... return i * i + ... + >>> example.func_arg(square) + 100L + >>> square_plus_1 = example.func_ret(square) + >>> square_plus_1(4) + 17L + >>> plus_1 = func_cpp() + >>> plus_1(number=43) + 44L + +.. warning:: + + Keep in mind that passing a function from C++ to Python (or vice versa) + will instantiate a piece of wrapper code that translates function + invocations between the two languages. Naturally, this translation + increases the computational cost of each function call somewhat. A + problematic situation can arise when a function is copied back and forth + between Python and C++ many times in a row, in which case the underlying + wrappers will accumulate correspondingly. The resulting long sequence of + C++ -> Python -> C++ -> ... roundtrips can significantly decrease + performance. + + There is one exception: pybind11 detects case where a stateless function + (i.e. a function pointer or a lambda function without captured variables) + is passed as an argument to another C++ function exposed in Python. In this + case, there is no overhead. Pybind11 will extract the underlying C++ + function pointer from the wrapped function to sidestep a potential C++ -> + Python -> C++ roundtrip. This is demonstrated in :file:`tests/test_callbacks.cpp`. + +.. note:: + + This functionality is very useful when generating bindings for callbacks in + C++ libraries (e.g. GUI libraries, asynchronous networking libraries, etc.). + + The file :file:`tests/test_callbacks.cpp` contains a complete example + that demonstrates how to work with callbacks and anonymous functions in + more detail. diff --git a/pybind11/docs/advanced/cast/index.rst b/pybind11/docs/advanced/cast/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..54c10570b1ccd106ee98c92ead8c28fde5134d5d --- /dev/null +++ b/pybind11/docs/advanced/cast/index.rst @@ -0,0 +1,42 @@ +Type conversions +################ + +Apart from enabling cross-language function calls, a fundamental problem +that a binding tool like pybind11 must address is to provide access to +native Python types in C++ and vice versa. There are three fundamentally +different ways to do this—which approach is preferable for a particular type +depends on the situation at hand. + +1. Use a native C++ type everywhere. In this case, the type must be wrapped + using pybind11-generated bindings so that Python can interact with it. + +2. Use a native Python type everywhere. It will need to be wrapped so that + C++ functions can interact with it. + +3. Use a native C++ type on the C++ side and a native Python type on the + Python side. pybind11 refers to this as a *type conversion*. + + Type conversions are the most "natural" option in the sense that native + (non-wrapped) types are used everywhere. The main downside is that a copy + of the data must be made on every Python ↔ C++ transition: this is + needed since the C++ and Python versions of the same type generally won't + have the same memory layout. + + pybind11 can perform many kinds of conversions automatically. An overview + is provided in the table ":ref:`conversion_table`". + +The following subsections discuss the differences between these options in more +detail. The main focus in this section is on type conversions, which represent +the last case of the above list. + +.. toctree:: + :maxdepth: 1 + + overview + strings + stl + functional + chrono + eigen + custom + diff --git a/pybind11/docs/advanced/cast/overview.rst b/pybind11/docs/advanced/cast/overview.rst new file mode 100644 index 0000000000000000000000000000000000000000..b0e32a52f9c8bb2945e230416216c38e3c3a4a9b --- /dev/null +++ b/pybind11/docs/advanced/cast/overview.rst @@ -0,0 +1,165 @@ +Overview +######## + +.. rubric:: 1. Native type in C++, wrapper in Python + +Exposing a custom C++ type using :class:`py::class_` was covered in detail +in the :doc:`/classes` section. There, the underlying data structure is +always the original C++ class while the :class:`py::class_` wrapper provides +a Python interface. Internally, when an object like this is sent from C++ to +Python, pybind11 will just add the outer wrapper layer over the native C++ +object. Getting it back from Python is just a matter of peeling off the +wrapper. + +.. rubric:: 2. Wrapper in C++, native type in Python + +This is the exact opposite situation. Now, we have a type which is native to +Python, like a ``tuple`` or a ``list``. One way to get this data into C++ is +with the :class:`py::object` family of wrappers. These are explained in more +detail in the :doc:`/advanced/pycpp/object` section. We'll just give a quick +example here: + +.. code-block:: cpp + + void print_list(py::list my_list) { + for (auto item : my_list) + std::cout << item << " "; + } + +.. code-block:: pycon + + >>> print_list([1, 2, 3]) + 1 2 3 + +The Python ``list`` is not converted in any way -- it's just wrapped in a C++ +:class:`py::list` class. At its core it's still a Python object. Copying a +:class:`py::list` will do the usual reference-counting like in Python. +Returning the object to Python will just remove the thin wrapper. + +.. rubric:: 3. Converting between native C++ and Python types + +In the previous two cases we had a native type in one language and a wrapper in +the other. Now, we have native types on both sides and we convert between them. + +.. code-block:: cpp + + void print_vector(const std::vector<int> &v) { + for (auto item : v) + std::cout << item << "\n"; + } + +.. code-block:: pycon + + >>> print_vector([1, 2, 3]) + 1 2 3 + +In this case, pybind11 will construct a new ``std::vector<int>`` and copy each +element from the Python ``list``. The newly constructed object will be passed +to ``print_vector``. The same thing happens in the other direction: a new +``list`` is made to match the value returned from C++. + +Lots of these conversions are supported out of the box, as shown in the table +below. They are very convenient, but keep in mind that these conversions are +fundamentally based on copying data. This is perfectly fine for small immutable +types but it may become quite expensive for large data structures. This can be +avoided by overriding the automatic conversion with a custom wrapper (i.e. the +above-mentioned approach 1). This requires some manual effort and more details +are available in the :ref:`opaque` section. + +.. _conversion_table: + +List of all builtin conversions +------------------------------- + +The following basic data types are supported out of the box (some may require +an additional extension header to be included). To pass other data structures +as arguments and return values, refer to the section on binding :ref:`classes`. + ++------------------------------------+---------------------------+-------------------------------+ +| Data type | Description | Header file | ++====================================+===========================+===============================+ +| ``int8_t``, ``uint8_t`` | 8-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``int16_t``, ``uint16_t`` | 16-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``int32_t``, ``uint32_t`` | 32-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``int64_t``, ``uint64_t`` | 64-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``ssize_t``, ``size_t`` | Platform-dependent size | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``float``, ``double`` | Floating point types | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``bool`` | Two-state Boolean type | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``char`` | Character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``char16_t`` | UTF-16 character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``char32_t`` | UTF-32 character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``wchar_t`` | Wide character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``const char *`` | UTF-8 string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``const char16_t *`` | UTF-16 string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``const char32_t *`` | UTF-32 string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``const wchar_t *`` | Wide string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::string`` | STL dynamic UTF-8 string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::u16string`` | STL dynamic UTF-16 string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::u32string`` | STL dynamic UTF-32 string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::wstring`` | STL dynamic wide string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::string_view``, | STL C++17 string views | :file:`pybind11/pybind11.h` | +| ``std::u16string_view``, etc. | | | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::pair<T1, T2>`` | Pair of two custom types | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::tuple<...>`` | Arbitrary tuple of types | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::reference_wrapper<...>`` | Reference type wrapper | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::complex<T>`` | Complex numbers | :file:`pybind11/complex.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::array<T, Size>`` | STL static array | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::vector<T>`` | STL dynamic array | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::deque<T>`` | STL double-ended queue | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::valarray<T>`` | STL value array | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::list<T>`` | STL linked list | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::map<T1, T2>`` | STL ordered map | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::unordered_map<T1, T2>`` | STL unordered map | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::set<T>`` | STL ordered set | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::unordered_set<T>`` | STL unordered set | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::optional<T>`` | STL optional type (C++17) | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::experimental::optional<T>`` | STL optional type (exp.) | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::variant<...>`` | Type-safe union (C++17) | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::function<...>`` | STL polymorphic function | :file:`pybind11/functional.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::chrono::duration<...>`` | STL time duration | :file:`pybind11/chrono.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::chrono::time_point<...>`` | STL date/time | :file:`pybind11/chrono.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``Eigen::Matrix<...>`` | Eigen: dense matrix | :file:`pybind11/eigen.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``Eigen::Map<...>`` | Eigen: mapped memory | :file:`pybind11/eigen.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``Eigen::SparseMatrix<...>`` | Eigen: sparse matrix | :file:`pybind11/eigen.h` | ++------------------------------------+---------------------------+-------------------------------+ diff --git a/pybind11/docs/advanced/cast/stl.rst b/pybind11/docs/advanced/cast/stl.rst new file mode 100644 index 0000000000000000000000000000000000000000..e48409f025d021b35e4e26f4fee754b2d858daa4 --- /dev/null +++ b/pybind11/docs/advanced/cast/stl.rst @@ -0,0 +1,240 @@ +STL containers +############## + +Automatic conversion +==================== + +When including the additional header file :file:`pybind11/stl.h`, conversions +between ``std::vector<>``/``std::deque<>``/``std::list<>``/``std::array<>``, +``std::set<>``/``std::unordered_set<>``, and +``std::map<>``/``std::unordered_map<>`` and the Python ``list``, ``set`` and +``dict`` data structures are automatically enabled. The types ``std::pair<>`` +and ``std::tuple<>`` are already supported out of the box with just the core +:file:`pybind11/pybind11.h` header. + +The major downside of these implicit conversions is that containers must be +converted (i.e. copied) on every Python->C++ and C++->Python transition, which +can have implications on the program semantics and performance. Please read the +next sections for more details and alternative approaches that avoid this. + +.. note:: + + Arbitrary nesting of any of these types is possible. + +.. seealso:: + + The file :file:`tests/test_stl.cpp` contains a complete + example that demonstrates how to pass STL data types in more detail. + +.. _cpp17_container_casters: + +C++17 library containers +======================== + +The :file:`pybind11/stl.h` header also includes support for ``std::optional<>`` +and ``std::variant<>``. These require a C++17 compiler and standard library. +In C++14 mode, ``std::experimental::optional<>`` is supported if available. + +Various versions of these containers also exist for C++11 (e.g. in Boost). +pybind11 provides an easy way to specialize the ``type_caster`` for such +types: + +.. code-block:: cpp + + // `boost::optional` as an example -- can be any `std::optional`-like container + namespace pybind11 { namespace detail { + template <typename T> + struct type_caster<boost::optional<T>> : optional_caster<boost::optional<T>> {}; + }} + +The above should be placed in a header file and included in all translation units +where automatic conversion is needed. Similarly, a specialization can be provided +for custom variant types: + +.. code-block:: cpp + + // `boost::variant` as an example -- can be any `std::variant`-like container + namespace pybind11 { namespace detail { + template <typename... Ts> + struct type_caster<boost::variant<Ts...>> : variant_caster<boost::variant<Ts...>> {}; + + // Specifies the function used to visit the variant -- `apply_visitor` instead of `visit` + template <> + struct visit_helper<boost::variant> { + template <typename... Args> + static auto call(Args &&...args) -> decltype(boost::apply_visitor(args...)) { + return boost::apply_visitor(args...); + } + }; + }} // namespace pybind11::detail + +The ``visit_helper`` specialization is not required if your ``name::variant`` provides +a ``name::visit()`` function. For any other function name, the specialization must be +included to tell pybind11 how to visit the variant. + +.. note:: + + pybind11 only supports the modern implementation of ``boost::variant`` + which makes use of variadic templates. This requires Boost 1.56 or newer. + Additionally, on Windows, MSVC 2017 is required because ``boost::variant`` + falls back to the old non-variadic implementation on MSVC 2015. + +.. _opaque: + +Making opaque types +=================== + +pybind11 heavily relies on a template matching mechanism to convert parameters +and return values that are constructed from STL data types such as vectors, +linked lists, hash tables, etc. This even works in a recursive manner, for +instance to deal with lists of hash maps of pairs of elementary and custom +types, etc. + +However, a fundamental limitation of this approach is that internal conversions +between Python and C++ types involve a copy operation that prevents +pass-by-reference semantics. What does this mean? + +Suppose we bind the following function + +.. code-block:: cpp + + void append_1(std::vector<int> &v) { + v.push_back(1); + } + +and call it from Python, the following happens: + +.. code-block:: pycon + + >>> v = [5, 6] + >>> append_1(v) + >>> print(v) + [5, 6] + +As you can see, when passing STL data structures by reference, modifications +are not propagated back the Python side. A similar situation arises when +exposing STL data structures using the ``def_readwrite`` or ``def_readonly`` +functions: + +.. code-block:: cpp + + /* ... definition ... */ + + class MyClass { + std::vector<int> contents; + }; + + /* ... binding code ... */ + + py::class_<MyClass>(m, "MyClass") + .def(py::init<>()) + .def_readwrite("contents", &MyClass::contents); + +In this case, properties can be read and written in their entirety. However, an +``append`` operation involving such a list type has no effect: + +.. code-block:: pycon + + >>> m = MyClass() + >>> m.contents = [5, 6] + >>> print(m.contents) + [5, 6] + >>> m.contents.append(7) + >>> print(m.contents) + [5, 6] + +Finally, the involved copy operations can be costly when dealing with very +large lists. To deal with all of the above situations, pybind11 provides a +macro named ``PYBIND11_MAKE_OPAQUE(T)`` that disables the template-based +conversion machinery of types, thus rendering them *opaque*. The contents of +opaque objects are never inspected or extracted, hence they *can* be passed by +reference. For instance, to turn ``std::vector<int>`` into an opaque type, add +the declaration + +.. code-block:: cpp + + PYBIND11_MAKE_OPAQUE(std::vector<int>); + +before any binding code (e.g. invocations to ``class_::def()``, etc.). This +macro must be specified at the top level (and outside of any namespaces), since +it instantiates a partial template overload. If your binding code consists of +multiple compilation units, it must be present in every file (typically via a +common header) preceding any usage of ``std::vector<int>``. Opaque types must +also have a corresponding ``class_`` declaration to associate them with a name +in Python, and to define a set of available operations, e.g.: + +.. code-block:: cpp + + py::class_<std::vector<int>>(m, "IntVector") + .def(py::init<>()) + .def("clear", &std::vector<int>::clear) + .def("pop_back", &std::vector<int>::pop_back) + .def("__len__", [](const std::vector<int> &v) { return v.size(); }) + .def("__iter__", [](std::vector<int> &v) { + return py::make_iterator(v.begin(), v.end()); + }, py::keep_alive<0, 1>()) /* Keep vector alive while iterator is used */ + // .... + +.. seealso:: + + The file :file:`tests/test_opaque_types.cpp` contains a complete + example that demonstrates how to create and expose opaque types using + pybind11 in more detail. + +.. _stl_bind: + +Binding STL containers +====================== + +The ability to expose STL containers as native Python objects is a fairly +common request, hence pybind11 also provides an optional header file named +:file:`pybind11/stl_bind.h` that does exactly this. The mapped containers try +to match the behavior of their native Python counterparts as much as possible. + +The following example showcases usage of :file:`pybind11/stl_bind.h`: + +.. code-block:: cpp + + // Don't forget this + #include <pybind11/stl_bind.h> + + PYBIND11_MAKE_OPAQUE(std::vector<int>); + PYBIND11_MAKE_OPAQUE(std::map<std::string, double>); + + // ... + + // later in binding code: + py::bind_vector<std::vector<int>>(m, "VectorInt"); + py::bind_map<std::map<std::string, double>>(m, "MapStringDouble"); + +When binding STL containers pybind11 considers the types of the container's +elements to decide whether the container should be confined to the local module +(via the :ref:`module_local` feature). If the container element types are +anything other than already-bound custom types bound without +``py::module_local()`` the container binding will have ``py::module_local()`` +applied. This includes converting types such as numeric types, strings, Eigen +types; and types that have not yet been bound at the time of the stl container +binding. This module-local binding is designed to avoid potential conflicts +between module bindings (for example, from two separate modules each attempting +to bind ``std::vector<int>`` as a python type). + +It is possible to override this behavior to force a definition to be either +module-local or global. To do so, you can pass the attributes +``py::module_local()`` (to make the binding module-local) or +``py::module_local(false)`` (to make the binding global) into the +``py::bind_vector`` or ``py::bind_map`` arguments: + +.. code-block:: cpp + + py::bind_vector<std::vector<int>>(m, "VectorInt", py::module_local(false)); + +Note, however, that such a global binding would make it impossible to load this +module at the same time as any other pybind module that also attempts to bind +the same container type (``std::vector<int>`` in the above example). + +See :ref:`module_local` for more details on module-local bindings. + +.. seealso:: + + The file :file:`tests/test_stl_binders.cpp` shows how to use the + convenience STL container wrappers. diff --git a/pybind11/docs/advanced/cast/strings.rst b/pybind11/docs/advanced/cast/strings.rst new file mode 100644 index 0000000000000000000000000000000000000000..e25701ecabd80142f4fd705f5419ef7c10cc6c56 --- /dev/null +++ b/pybind11/docs/advanced/cast/strings.rst @@ -0,0 +1,305 @@ +Strings, bytes and Unicode conversions +###################################### + +.. note:: + + This section discusses string handling in terms of Python 3 strings. For + Python 2.7, replace all occurrences of ``str`` with ``unicode`` and + ``bytes`` with ``str``. Python 2.7 users may find it best to use ``from + __future__ import unicode_literals`` to avoid unintentionally using ``str`` + instead of ``unicode``. + +Passing Python strings to C++ +============================= + +When a Python ``str`` is passed from Python to a C++ function that accepts +``std::string`` or ``char *`` as arguments, pybind11 will encode the Python +string to UTF-8. All Python ``str`` can be encoded in UTF-8, so this operation +does not fail. + +The C++ language is encoding agnostic. It is the responsibility of the +programmer to track encodings. It's often easiest to simply `use UTF-8 +everywhere <http://utf8everywhere.org/>`_. + +.. code-block:: c++ + + m.def("utf8_test", + [](const std::string &s) { + cout << "utf-8 is icing on the cake.\n"; + cout << s; + } + ); + m.def("utf8_charptr", + [](const char *s) { + cout << "My favorite food is\n"; + cout << s; + } + ); + +.. code-block:: python + + >>> utf8_test('🎂') + utf-8 is icing on the cake. + 🎂 + + >>> utf8_charptr('ðŸ•') + My favorite food is + 🕠+ +.. note:: + + Some terminal emulators do not support UTF-8 or emoji fonts and may not + display the example above correctly. + +The results are the same whether the C++ function accepts arguments by value or +reference, and whether or not ``const`` is used. + +Passing bytes to C++ +-------------------- + +A Python ``bytes`` object will be passed to C++ functions that accept +``std::string`` or ``char*`` *without* conversion. On Python 3, in order to +make a function *only* accept ``bytes`` (and not ``str``), declare it as taking +a ``py::bytes`` argument. + + +Returning C++ strings to Python +=============================== + +When a C++ function returns a ``std::string`` or ``char*`` to a Python caller, +**pybind11 will assume that the string is valid UTF-8** and will decode it to a +native Python ``str``, using the same API as Python uses to perform +``bytes.decode('utf-8')``. If this implicit conversion fails, pybind11 will +raise a ``UnicodeDecodeError``. + +.. code-block:: c++ + + m.def("std_string_return", + []() { + return std::string("This string needs to be UTF-8 encoded"); + } + ); + +.. code-block:: python + + >>> isinstance(example.std_string_return(), str) + True + + +Because UTF-8 is inclusive of pure ASCII, there is never any issue with +returning a pure ASCII string to Python. If there is any possibility that the +string is not pure ASCII, it is necessary to ensure the encoding is valid +UTF-8. + +.. warning:: + + Implicit conversion assumes that a returned ``char *`` is null-terminated. + If there is no null terminator a buffer overrun will occur. + +Explicit conversions +-------------------- + +If some C++ code constructs a ``std::string`` that is not a UTF-8 string, one +can perform a explicit conversion and return a ``py::str`` object. Explicit +conversion has the same overhead as implicit conversion. + +.. code-block:: c++ + + // This uses the Python C API to convert Latin-1 to Unicode + m.def("str_output", + []() { + std::string s = "Send your r\xe9sum\xe9 to Alice in HR"; // Latin-1 + py::str py_s = PyUnicode_DecodeLatin1(s.data(), s.length()); + return py_s; + } + ); + +.. code-block:: python + + >>> str_output() + 'Send your résumé to Alice in HR' + +The `Python C API +<https://docs.python.org/3/c-api/unicode.html#built-in-codecs>`_ provides +several built-in codecs. + + +One could also use a third party encoding library such as libiconv to transcode +to UTF-8. + +Return C++ strings without conversion +------------------------------------- + +If the data in a C++ ``std::string`` does not represent text and should be +returned to Python as ``bytes``, then one can return the data as a +``py::bytes`` object. + +.. code-block:: c++ + + m.def("return_bytes", + []() { + std::string s("\xba\xd0\xba\xd0"); // Not valid UTF-8 + return py::bytes(s); // Return the data without transcoding + } + ); + +.. code-block:: python + + >>> example.return_bytes() + b'\xba\xd0\xba\xd0' + + +Note the asymmetry: pybind11 will convert ``bytes`` to ``std::string`` without +encoding, but cannot convert ``std::string`` back to ``bytes`` implicitly. + +.. code-block:: c++ + + m.def("asymmetry", + [](std::string s) { // Accepts str or bytes from Python + return s; // Looks harmless, but implicitly converts to str + } + ); + +.. code-block:: python + + >>> isinstance(example.asymmetry(b"have some bytes"), str) + True + + >>> example.asymmetry(b"\xba\xd0\xba\xd0") # invalid utf-8 as bytes + UnicodeDecodeError: 'utf-8' codec can't decode byte 0xba in position 0: invalid start byte + + +Wide character strings +====================== + +When a Python ``str`` is passed to a C++ function expecting ``std::wstring``, +``wchar_t*``, ``std::u16string`` or ``std::u32string``, the ``str`` will be +encoded to UTF-16 or UTF-32 depending on how the C++ compiler implements each +type, in the platform's native endianness. When strings of these types are +returned, they are assumed to contain valid UTF-16 or UTF-32, and will be +decoded to Python ``str``. + +.. code-block:: c++ + + #define UNICODE + #include <windows.h> + + m.def("set_window_text", + [](HWND hwnd, std::wstring s) { + // Call SetWindowText with null-terminated UTF-16 string + ::SetWindowText(hwnd, s.c_str()); + } + ); + m.def("get_window_text", + [](HWND hwnd) { + const int buffer_size = ::GetWindowTextLength(hwnd) + 1; + auto buffer = std::make_unique< wchar_t[] >(buffer_size); + + ::GetWindowText(hwnd, buffer.data(), buffer_size); + + std::wstring text(buffer.get()); + + // wstring will be converted to Python str + return text; + } + ); + +.. warning:: + + Wide character strings may not work as described on Python 2.7 or Python + 3.3 compiled with ``--enable-unicode=ucs2``. + +Strings in multibyte encodings such as Shift-JIS must transcoded to a +UTF-8/16/32 before being returned to Python. + + +Character literals +================== + +C++ functions that accept character literals as input will receive the first +character of a Python ``str`` as their input. If the string is longer than one +Unicode character, trailing characters will be ignored. + +When a character literal is returned from C++ (such as a ``char`` or a +``wchar_t``), it will be converted to a ``str`` that represents the single +character. + +.. code-block:: c++ + + m.def("pass_char", [](char c) { return c; }); + m.def("pass_wchar", [](wchar_t w) { return w; }); + +.. code-block:: python + + >>> example.pass_char('A') + 'A' + +While C++ will cast integers to character types (``char c = 0x65;``), pybind11 +does not convert Python integers to characters implicitly. The Python function +``chr()`` can be used to convert integers to characters. + +.. code-block:: python + + >>> example.pass_char(0x65) + TypeError + + >>> example.pass_char(chr(0x65)) + 'A' + +If the desire is to work with an 8-bit integer, use ``int8_t`` or ``uint8_t`` +as the argument type. + +Grapheme clusters +----------------- + +A single grapheme may be represented by two or more Unicode characters. For +example 'é' is usually represented as U+00E9 but can also be expressed as the +combining character sequence U+0065 U+0301 (that is, the letter 'e' followed by +a combining acute accent). The combining character will be lost if the +two-character sequence is passed as an argument, even though it renders as a +single grapheme. + +.. code-block:: python + + >>> example.pass_wchar('é') + 'é' + + >>> combining_e_acute = 'e' + '\u0301' + + >>> combining_e_acute + 'eÌ' + + >>> combining_e_acute == 'é' + False + + >>> example.pass_wchar(combining_e_acute) + 'e' + +Normalizing combining characters before passing the character literal to C++ +may resolve *some* of these issues: + +.. code-block:: python + + >>> example.pass_wchar(unicodedata.normalize('NFC', combining_e_acute)) + 'é' + +In some languages (Thai for example), there are `graphemes that cannot be +expressed as a single Unicode code point +<http://unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries>`_, so there is +no way to capture them in a C++ character type. + + +C++17 string views +================== + +C++17 string views are automatically supported when compiling in C++17 mode. +They follow the same rules for encoding and decoding as the corresponding STL +string type (for example, a ``std::u16string_view`` argument will be passed +UTF-16-encoded data, and a returned ``std::string_view`` will be decoded as +UTF-8). + +References +========== + +* `The Absolute Minimum Every Software Developer Absolutely, Positively Must Know About Unicode and Character Sets (No Excuses!) <https://www.joelonsoftware.com/2003/10/08/the-absolute-minimum-every-software-developer-absolutely-positively-must-know-about-unicode-and-character-sets-no-excuses/>`_ +* `C++ - Using STL Strings at Win32 API Boundaries <https://msdn.microsoft.com/en-ca/magazine/mt238407.aspx>`_ diff --git a/pybind11/docs/advanced/classes.rst b/pybind11/docs/advanced/classes.rst new file mode 100644 index 0000000000000000000000000000000000000000..c9a0da5a12078eed1bf3b6e67241d1dd46c23023 --- /dev/null +++ b/pybind11/docs/advanced/classes.rst @@ -0,0 +1,1125 @@ +Classes +####### + +This section presents advanced binding code for classes and it is assumed +that you are already familiar with the basics from :doc:`/classes`. + +.. _overriding_virtuals: + +Overriding virtual functions in Python +====================================== + +Suppose that a C++ class or interface has a virtual function that we'd like to +to override from within Python (we'll focus on the class ``Animal``; ``Dog`` is +given as a specific example of how one would do this with traditional C++ +code). + +.. code-block:: cpp + + class Animal { + public: + virtual ~Animal() { } + virtual std::string go(int n_times) = 0; + }; + + class Dog : public Animal { + public: + std::string go(int n_times) override { + std::string result; + for (int i=0; i<n_times; ++i) + result += "woof! "; + return result; + } + }; + +Let's also suppose that we are given a plain function which calls the +function ``go()`` on an arbitrary ``Animal`` instance. + +.. code-block:: cpp + + std::string call_go(Animal *animal) { + return animal->go(3); + } + +Normally, the binding code for these classes would look as follows: + +.. code-block:: cpp + + PYBIND11_MODULE(example, m) { + py::class_<Animal>(m, "Animal") + .def("go", &Animal::go); + + py::class_<Dog, Animal>(m, "Dog") + .def(py::init<>()); + + m.def("call_go", &call_go); + } + +However, these bindings are impossible to extend: ``Animal`` is not +constructible, and we clearly require some kind of "trampoline" that +redirects virtual calls back to Python. + +Defining a new type of ``Animal`` from within Python is possible but requires a +helper class that is defined as follows: + +.. code-block:: cpp + + class PyAnimal : public Animal { + public: + /* Inherit the constructors */ + using Animal::Animal; + + /* Trampoline (need one for each virtual function) */ + std::string go(int n_times) override { + PYBIND11_OVERLOAD_PURE( + std::string, /* Return type */ + Animal, /* Parent class */ + go, /* Name of function in C++ (must match Python name) */ + n_times /* Argument(s) */ + ); + } + }; + +The macro :c:macro:`PYBIND11_OVERLOAD_PURE` should be used for pure virtual +functions, and :c:macro:`PYBIND11_OVERLOAD` should be used for functions which have +a default implementation. There are also two alternate macros +:c:macro:`PYBIND11_OVERLOAD_PURE_NAME` and :c:macro:`PYBIND11_OVERLOAD_NAME` which +take a string-valued name argument between the *Parent class* and *Name of the +function* slots, which defines the name of function in Python. This is required +when the C++ and Python versions of the +function have different names, e.g. ``operator()`` vs ``__call__``. + +The binding code also needs a few minor adaptations (highlighted): + +.. code-block:: cpp + :emphasize-lines: 2,3 + + PYBIND11_MODULE(example, m) { + py::class_<Animal, PyAnimal /* <--- trampoline*/>(m, "Animal") + .def(py::init<>()) + .def("go", &Animal::go); + + py::class_<Dog, Animal>(m, "Dog") + .def(py::init<>()); + + m.def("call_go", &call_go); + } + +Importantly, pybind11 is made aware of the trampoline helper class by +specifying it as an extra template argument to :class:`class_`. (This can also +be combined with other template arguments such as a custom holder type; the +order of template types does not matter). Following this, we are able to +define a constructor as usual. + +Bindings should be made against the actual class, not the trampoline helper class. + +.. code-block:: cpp + :emphasize-lines: 3 + + py::class_<Animal, PyAnimal /* <--- trampoline*/>(m, "Animal"); + .def(py::init<>()) + .def("go", &PyAnimal::go); /* <--- THIS IS WRONG, use &Animal::go */ + +Note, however, that the above is sufficient for allowing python classes to +extend ``Animal``, but not ``Dog``: see :ref:`virtual_and_inheritance` for the +necessary steps required to providing proper overload support for inherited +classes. + +The Python session below shows how to override ``Animal::go`` and invoke it via +a virtual method call. + +.. code-block:: pycon + + >>> from example import * + >>> d = Dog() + >>> call_go(d) + u'woof! woof! woof! ' + >>> class Cat(Animal): + ... def go(self, n_times): + ... return "meow! " * n_times + ... + >>> c = Cat() + >>> call_go(c) + u'meow! meow! meow! ' + +If you are defining a custom constructor in a derived Python class, you *must* +ensure that you explicitly call the bound C++ constructor using ``__init__``, +*regardless* of whether it is a default constructor or not. Otherwise, the +memory for the C++ portion of the instance will be left uninitialized, which +will generally leave the C++ instance in an invalid state and cause undefined +behavior if the C++ instance is subsequently used. + +Here is an example: + +.. code-block:: python + + class Dachshund(Dog): + def __init__(self, name): + Dog.__init__(self) # Without this, undefined behavior may occur if the C++ portions are referenced. + self.name = name + def bark(self): + return "yap!" + +Note that a direct ``__init__`` constructor *should be called*, and ``super()`` +should not be used. For simple cases of linear inheritance, ``super()`` +may work, but once you begin mixing Python and C++ multiple inheritance, +things will fall apart due to differences between Python's MRO and C++'s +mechanisms. + +Please take a look at the :ref:`macro_notes` before using this feature. + +.. note:: + + When the overridden type returns a reference or pointer to a type that + pybind11 converts from Python (for example, numeric values, std::string, + and other built-in value-converting types), there are some limitations to + be aware of: + + - because in these cases there is no C++ variable to reference (the value + is stored in the referenced Python variable), pybind11 provides one in + the PYBIND11_OVERLOAD macros (when needed) with static storage duration. + Note that this means that invoking the overloaded method on *any* + instance will change the referenced value stored in *all* instances of + that type. + + - Attempts to modify a non-const reference will not have the desired + effect: it will change only the static cache variable, but this change + will not propagate to underlying Python instance, and the change will be + replaced the next time the overload is invoked. + +.. seealso:: + + The file :file:`tests/test_virtual_functions.cpp` contains a complete + example that demonstrates how to override virtual functions using pybind11 + in more detail. + +.. _virtual_and_inheritance: + +Combining virtual functions and inheritance +=========================================== + +When combining virtual methods with inheritance, you need to be sure to provide +an override for each method for which you want to allow overrides from derived +python classes. For example, suppose we extend the above ``Animal``/``Dog`` +example as follows: + +.. code-block:: cpp + + class Animal { + public: + virtual std::string go(int n_times) = 0; + virtual std::string name() { return "unknown"; } + }; + class Dog : public Animal { + public: + std::string go(int n_times) override { + std::string result; + for (int i=0; i<n_times; ++i) + result += bark() + " "; + return result; + } + virtual std::string bark() { return "woof!"; } + }; + +then the trampoline class for ``Animal`` must, as described in the previous +section, override ``go()`` and ``name()``, but in order to allow python code to +inherit properly from ``Dog``, we also need a trampoline class for ``Dog`` that +overrides both the added ``bark()`` method *and* the ``go()`` and ``name()`` +methods inherited from ``Animal`` (even though ``Dog`` doesn't directly +override the ``name()`` method): + +.. code-block:: cpp + + class PyAnimal : public Animal { + public: + using Animal::Animal; // Inherit constructors + std::string go(int n_times) override { PYBIND11_OVERLOAD_PURE(std::string, Animal, go, n_times); } + std::string name() override { PYBIND11_OVERLOAD(std::string, Animal, name, ); } + }; + class PyDog : public Dog { + public: + using Dog::Dog; // Inherit constructors + std::string go(int n_times) override { PYBIND11_OVERLOAD(std::string, Dog, go, n_times); } + std::string name() override { PYBIND11_OVERLOAD(std::string, Dog, name, ); } + std::string bark() override { PYBIND11_OVERLOAD(std::string, Dog, bark, ); } + }; + +.. note:: + + Note the trailing commas in the ``PYBIND11_OVERLOAD`` calls to ``name()`` + and ``bark()``. These are needed to portably implement a trampoline for a + function that does not take any arguments. For functions that take + a nonzero number of arguments, the trailing comma must be omitted. + +A registered class derived from a pybind11-registered class with virtual +methods requires a similar trampoline class, *even if* it doesn't explicitly +declare or override any virtual methods itself: + +.. code-block:: cpp + + class Husky : public Dog {}; + class PyHusky : public Husky { + public: + using Husky::Husky; // Inherit constructors + std::string go(int n_times) override { PYBIND11_OVERLOAD_PURE(std::string, Husky, go, n_times); } + std::string name() override { PYBIND11_OVERLOAD(std::string, Husky, name, ); } + std::string bark() override { PYBIND11_OVERLOAD(std::string, Husky, bark, ); } + }; + +There is, however, a technique that can be used to avoid this duplication +(which can be especially helpful for a base class with several virtual +methods). The technique involves using template trampoline classes, as +follows: + +.. code-block:: cpp + + template <class AnimalBase = Animal> class PyAnimal : public AnimalBase { + public: + using AnimalBase::AnimalBase; // Inherit constructors + std::string go(int n_times) override { PYBIND11_OVERLOAD_PURE(std::string, AnimalBase, go, n_times); } + std::string name() override { PYBIND11_OVERLOAD(std::string, AnimalBase, name, ); } + }; + template <class DogBase = Dog> class PyDog : public PyAnimal<DogBase> { + public: + using PyAnimal<DogBase>::PyAnimal; // Inherit constructors + // Override PyAnimal's pure virtual go() with a non-pure one: + std::string go(int n_times) override { PYBIND11_OVERLOAD(std::string, DogBase, go, n_times); } + std::string bark() override { PYBIND11_OVERLOAD(std::string, DogBase, bark, ); } + }; + +This technique has the advantage of requiring just one trampoline method to be +declared per virtual method and pure virtual method override. It does, +however, require the compiler to generate at least as many methods (and +possibly more, if both pure virtual and overridden pure virtual methods are +exposed, as above). + +The classes are then registered with pybind11 using: + +.. code-block:: cpp + + py::class_<Animal, PyAnimal<>> animal(m, "Animal"); + py::class_<Dog, PyDog<>> dog(m, "Dog"); + py::class_<Husky, PyDog<Husky>> husky(m, "Husky"); + // ... add animal, dog, husky definitions + +Note that ``Husky`` did not require a dedicated trampoline template class at +all, since it neither declares any new virtual methods nor provides any pure +virtual method implementations. + +With either the repeated-virtuals or templated trampoline methods in place, you +can now create a python class that inherits from ``Dog``: + +.. code-block:: python + + class ShihTzu(Dog): + def bark(self): + return "yip!" + +.. seealso:: + + See the file :file:`tests/test_virtual_functions.cpp` for complete examples + using both the duplication and templated trampoline approaches. + +.. _extended_aliases: + +Extended trampoline class functionality +======================================= + +.. _extended_class_functionality_forced_trampoline: + +Forced trampoline class initialisation +-------------------------------------- +The trampoline classes described in the previous sections are, by default, only +initialized when needed. More specifically, they are initialized when a python +class actually inherits from a registered type (instead of merely creating an +instance of the registered type), or when a registered constructor is only +valid for the trampoline class but not the registered class. This is primarily +for performance reasons: when the trampoline class is not needed for anything +except virtual method dispatching, not initializing the trampoline class +improves performance by avoiding needing to do a run-time check to see if the +inheriting python instance has an overloaded method. + +Sometimes, however, it is useful to always initialize a trampoline class as an +intermediate class that does more than just handle virtual method dispatching. +For example, such a class might perform extra class initialization, extra +destruction operations, and might define new members and methods to enable a +more python-like interface to a class. + +In order to tell pybind11 that it should *always* initialize the trampoline +class when creating new instances of a type, the class constructors should be +declared using ``py::init_alias<Args, ...>()`` instead of the usual +``py::init<Args, ...>()``. This forces construction via the trampoline class, +ensuring member initialization and (eventual) destruction. + +.. seealso:: + + See the file :file:`tests/test_virtual_functions.cpp` for complete examples + showing both normal and forced trampoline instantiation. + +Different method signatures +--------------------------- +The macro's introduced in :ref:`overriding_virtuals` cover most of the standard +use cases when exposing C++ classes to Python. Sometimes it is hard or unwieldy +to create a direct one-on-one mapping between the arguments and method return +type. + +An example would be when the C++ signature contains output arguments using +references (See also :ref:`faq_reference_arguments`). Another way of solving +this is to use the method body of the trampoline class to do conversions to the +input and return of the Python method. + +The main building block to do so is the :func:`get_overload`, this function +allows retrieving a method implemented in Python from within the trampoline's +methods. Consider for example a C++ method which has the signature +``bool myMethod(int32_t& value)``, where the return indicates whether +something should be done with the ``value``. This can be made convenient on the +Python side by allowing the Python function to return ``None`` or an ``int``: + +.. code-block:: cpp + + bool MyClass::myMethod(int32_t& value) + { + pybind11::gil_scoped_acquire gil; // Acquire the GIL while in this scope. + // Try to look up the overloaded method on the Python side. + pybind11::function overload = pybind11::get_overload(this, "myMethod"); + if (overload) { // method is found + auto obj = overload(value); // Call the Python function. + if (py::isinstance<py::int_>(obj)) { // check if it returned a Python integer type + value = obj.cast<int32_t>(); // Cast it and assign it to the value. + return true; // Return true; value should be used. + } else { + return false; // Python returned none, return false. + } + } + return false; // Alternatively return MyClass::myMethod(value); + } + + +.. _custom_constructors: + +Custom constructors +=================== + +The syntax for binding constructors was previously introduced, but it only +works when a constructor of the appropriate arguments actually exists on the +C++ side. To extend this to more general cases, pybind11 makes it possible +to bind factory functions as constructors. For example, suppose you have a +class like this: + +.. code-block:: cpp + + class Example { + private: + Example(int); // private constructor + public: + // Factory function: + static Example create(int a) { return Example(a); } + }; + + py::class_<Example>(m, "Example") + .def(py::init(&Example::create)); + +While it is possible to create a straightforward binding of the static +``create`` method, it may sometimes be preferable to expose it as a constructor +on the Python side. This can be accomplished by calling ``.def(py::init(...))`` +with the function reference returning the new instance passed as an argument. +It is also possible to use this approach to bind a function returning a new +instance by raw pointer or by the holder (e.g. ``std::unique_ptr``). + +The following example shows the different approaches: + +.. code-block:: cpp + + class Example { + private: + Example(int); // private constructor + public: + // Factory function - returned by value: + static Example create(int a) { return Example(a); } + + // These constructors are publicly callable: + Example(double); + Example(int, int); + Example(std::string); + }; + + py::class_<Example>(m, "Example") + // Bind the factory function as a constructor: + .def(py::init(&Example::create)) + // Bind a lambda function returning a pointer wrapped in a holder: + .def(py::init([](std::string arg) { + return std::unique_ptr<Example>(new Example(arg)); + })) + // Return a raw pointer: + .def(py::init([](int a, int b) { return new Example(a, b); })) + // You can mix the above with regular C++ constructor bindings as well: + .def(py::init<double>()) + ; + +When the constructor is invoked from Python, pybind11 will call the factory +function and store the resulting C++ instance in the Python instance. + +When combining factory functions constructors with :ref:`virtual function +trampolines <overriding_virtuals>` there are two approaches. The first is to +add a constructor to the alias class that takes a base value by +rvalue-reference. If such a constructor is available, it will be used to +construct an alias instance from the value returned by the factory function. +The second option is to provide two factory functions to ``py::init()``: the +first will be invoked when no alias class is required (i.e. when the class is +being used but not inherited from in Python), and the second will be invoked +when an alias is required. + +You can also specify a single factory function that always returns an alias +instance: this will result in behaviour similar to ``py::init_alias<...>()``, +as described in the :ref:`extended trampoline class documentation +<extended_aliases>`. + +The following example shows the different factory approaches for a class with +an alias: + +.. code-block:: cpp + + #include <pybind11/factory.h> + class Example { + public: + // ... + virtual ~Example() = default; + }; + class PyExample : public Example { + public: + using Example::Example; + PyExample(Example &&base) : Example(std::move(base)) {} + }; + py::class_<Example, PyExample>(m, "Example") + // Returns an Example pointer. If a PyExample is needed, the Example + // instance will be moved via the extra constructor in PyExample, above. + .def(py::init([]() { return new Example(); })) + // Two callbacks: + .def(py::init([]() { return new Example(); } /* no alias needed */, + []() { return new PyExample(); } /* alias needed */)) + // *Always* returns an alias instance (like py::init_alias<>()) + .def(py::init([]() { return new PyExample(); })) + ; + +Brace initialization +-------------------- + +``pybind11::init<>`` internally uses C++11 brace initialization to call the +constructor of the target class. This means that it can be used to bind +*implicit* constructors as well: + +.. code-block:: cpp + + struct Aggregate { + int a; + std::string b; + }; + + py::class_<Aggregate>(m, "Aggregate") + .def(py::init<int, const std::string &>()); + +.. note:: + + Note that brace initialization preferentially invokes constructor overloads + taking a ``std::initializer_list``. In the rare event that this causes an + issue, you can work around it by using ``py::init(...)`` with a lambda + function that constructs the new object as desired. + +.. _classes_with_non_public_destructors: + +Non-public destructors +====================== + +If a class has a private or protected destructor (as might e.g. be the case in +a singleton pattern), a compile error will occur when creating bindings via +pybind11. The underlying issue is that the ``std::unique_ptr`` holder type that +is responsible for managing the lifetime of instances will reference the +destructor even if no deallocations ever take place. In order to expose classes +with private or protected destructors, it is possible to override the holder +type via a holder type argument to ``class_``. Pybind11 provides a helper class +``py::nodelete`` that disables any destructor invocations. In this case, it is +crucial that instances are deallocated on the C++ side to avoid memory leaks. + +.. code-block:: cpp + + /* ... definition ... */ + + class MyClass { + private: + ~MyClass() { } + }; + + /* ... binding code ... */ + + py::class_<MyClass, std::unique_ptr<MyClass, py::nodelete>>(m, "MyClass") + .def(py::init<>()) + +.. _implicit_conversions: + +Implicit conversions +==================== + +Suppose that instances of two types ``A`` and ``B`` are used in a project, and +that an ``A`` can easily be converted into an instance of type ``B`` (examples of this +could be a fixed and an arbitrary precision number type). + +.. code-block:: cpp + + py::class_<A>(m, "A") + /// ... members ... + + py::class_<B>(m, "B") + .def(py::init<A>()) + /// ... members ... + + m.def("func", + [](const B &) { /* .... */ } + ); + +To invoke the function ``func`` using a variable ``a`` containing an ``A`` +instance, we'd have to write ``func(B(a))`` in Python. On the other hand, C++ +will automatically apply an implicit type conversion, which makes it possible +to directly write ``func(a)``. + +In this situation (i.e. where ``B`` has a constructor that converts from +``A``), the following statement enables similar implicit conversions on the +Python side: + +.. code-block:: cpp + + py::implicitly_convertible<A, B>(); + +.. note:: + + Implicit conversions from ``A`` to ``B`` only work when ``B`` is a custom + data type that is exposed to Python via pybind11. + + To prevent runaway recursion, implicit conversions are non-reentrant: an + implicit conversion invoked as part of another implicit conversion of the + same type (i.e. from ``A`` to ``B``) will fail. + +.. _static_properties: + +Static properties +================= + +The section on :ref:`properties` discussed the creation of instance properties +that are implemented in terms of C++ getters and setters. + +Static properties can also be created in a similar way to expose getters and +setters of static class attributes. Note that the implicit ``self`` argument +also exists in this case and is used to pass the Python ``type`` subclass +instance. This parameter will often not be needed by the C++ side, and the +following example illustrates how to instantiate a lambda getter function +that ignores it: + +.. code-block:: cpp + + py::class_<Foo>(m, "Foo") + .def_property_readonly_static("foo", [](py::object /* self */) { return Foo(); }); + +Operator overloading +==================== + +Suppose that we're given the following ``Vector2`` class with a vector addition +and scalar multiplication operation, all implemented using overloaded operators +in C++. + +.. code-block:: cpp + + class Vector2 { + public: + Vector2(float x, float y) : x(x), y(y) { } + + Vector2 operator+(const Vector2 &v) const { return Vector2(x + v.x, y + v.y); } + Vector2 operator*(float value) const { return Vector2(x * value, y * value); } + Vector2& operator+=(const Vector2 &v) { x += v.x; y += v.y; return *this; } + Vector2& operator*=(float v) { x *= v; y *= v; return *this; } + + friend Vector2 operator*(float f, const Vector2 &v) { + return Vector2(f * v.x, f * v.y); + } + + std::string toString() const { + return "[" + std::to_string(x) + ", " + std::to_string(y) + "]"; + } + private: + float x, y; + }; + +The following snippet shows how the above operators can be conveniently exposed +to Python. + +.. code-block:: cpp + + #include <pybind11/operators.h> + + PYBIND11_MODULE(example, m) { + py::class_<Vector2>(m, "Vector2") + .def(py::init<float, float>()) + .def(py::self + py::self) + .def(py::self += py::self) + .def(py::self *= float()) + .def(float() * py::self) + .def(py::self * float()) + .def("__repr__", &Vector2::toString); + } + +Note that a line like + +.. code-block:: cpp + + .def(py::self * float()) + +is really just short hand notation for + +.. code-block:: cpp + + .def("__mul__", [](const Vector2 &a, float b) { + return a * b; + }, py::is_operator()) + +This can be useful for exposing additional operators that don't exist on the +C++ side, or to perform other types of customization. The ``py::is_operator`` +flag marker is needed to inform pybind11 that this is an operator, which +returns ``NotImplemented`` when invoked with incompatible arguments rather than +throwing a type error. + +.. note:: + + To use the more convenient ``py::self`` notation, the additional + header file :file:`pybind11/operators.h` must be included. + +.. seealso:: + + The file :file:`tests/test_operator_overloading.cpp` contains a + complete example that demonstrates how to work with overloaded operators in + more detail. + +.. _pickling: + +Pickling support +================ + +Python's ``pickle`` module provides a powerful facility to serialize and +de-serialize a Python object graph into a binary data stream. To pickle and +unpickle C++ classes using pybind11, a ``py::pickle()`` definition must be +provided. Suppose the class in question has the following signature: + +.. code-block:: cpp + + class Pickleable { + public: + Pickleable(const std::string &value) : m_value(value) { } + const std::string &value() const { return m_value; } + + void setExtra(int extra) { m_extra = extra; } + int extra() const { return m_extra; } + private: + std::string m_value; + int m_extra = 0; + }; + +Pickling support in Python is enabled by defining the ``__setstate__`` and +``__getstate__`` methods [#f3]_. For pybind11 classes, use ``py::pickle()`` +to bind these two functions: + +.. code-block:: cpp + + py::class_<Pickleable>(m, "Pickleable") + .def(py::init<std::string>()) + .def("value", &Pickleable::value) + .def("extra", &Pickleable::extra) + .def("setExtra", &Pickleable::setExtra) + .def(py::pickle( + [](const Pickleable &p) { // __getstate__ + /* Return a tuple that fully encodes the state of the object */ + return py::make_tuple(p.value(), p.extra()); + }, + [](py::tuple t) { // __setstate__ + if (t.size() != 2) + throw std::runtime_error("Invalid state!"); + + /* Create a new C++ instance */ + Pickleable p(t[0].cast<std::string>()); + + /* Assign any additional state */ + p.setExtra(t[1].cast<int>()); + + return p; + } + )); + +The ``__setstate__`` part of the ``py::picke()`` definition follows the same +rules as the single-argument version of ``py::init()``. The return type can be +a value, pointer or holder type. See :ref:`custom_constructors` for details. + +An instance can now be pickled as follows: + +.. code-block:: python + + try: + import cPickle as pickle # Use cPickle on Python 2.7 + except ImportError: + import pickle + + p = Pickleable("test_value") + p.setExtra(15) + data = pickle.dumps(p, 2) + +Note that only the cPickle module is supported on Python 2.7. The second +argument to ``dumps`` is also crucial: it selects the pickle protocol version +2, since the older version 1 is not supported. Newer versions are also fine—for +instance, specify ``-1`` to always use the latest available version. Beware: +failure to follow these instructions will cause important pybind11 memory +allocation routines to be skipped during unpickling, which will likely lead to +memory corruption and/or segmentation faults. + +.. seealso:: + + The file :file:`tests/test_pickling.cpp` contains a complete example + that demonstrates how to pickle and unpickle types using pybind11 in more + detail. + +.. [#f3] http://docs.python.org/3/library/pickle.html#pickling-class-instances + +Multiple Inheritance +==================== + +pybind11 can create bindings for types that derive from multiple base types +(aka. *multiple inheritance*). To do so, specify all bases in the template +arguments of the ``class_`` declaration: + +.. code-block:: cpp + + py::class_<MyType, BaseType1, BaseType2, BaseType3>(m, "MyType") + ... + +The base types can be specified in arbitrary order, and they can even be +interspersed with alias types and holder types (discussed earlier in this +document)---pybind11 will automatically find out which is which. The only +requirement is that the first template argument is the type to be declared. + +It is also permitted to inherit multiply from exported C++ classes in Python, +as well as inheriting from multiple Python and/or pybind11-exported classes. + +There is one caveat regarding the implementation of this feature: + +When only one base type is specified for a C++ type that actually has multiple +bases, pybind11 will assume that it does not participate in multiple +inheritance, which can lead to undefined behavior. In such cases, add the tag +``multiple_inheritance`` to the class constructor: + +.. code-block:: cpp + + py::class_<MyType, BaseType2>(m, "MyType", py::multiple_inheritance()); + +The tag is redundant and does not need to be specified when multiple base types +are listed. + +.. _module_local: + +Module-local class bindings +=========================== + +When creating a binding for a class, pybind11 by default makes that binding +"global" across modules. What this means is that a type defined in one module +can be returned from any module resulting in the same Python type. For +example, this allows the following: + +.. code-block:: cpp + + // In the module1.cpp binding code for module1: + py::class_<Pet>(m, "Pet") + .def(py::init<std::string>()) + .def_readonly("name", &Pet::name); + +.. code-block:: cpp + + // In the module2.cpp binding code for module2: + m.def("create_pet", [](std::string name) { return new Pet(name); }); + +.. code-block:: pycon + + >>> from module1 import Pet + >>> from module2 import create_pet + >>> pet1 = Pet("Kitty") + >>> pet2 = create_pet("Doggy") + >>> pet2.name() + 'Doggy' + +When writing binding code for a library, this is usually desirable: this +allows, for example, splitting up a complex library into multiple Python +modules. + +In some cases, however, this can cause conflicts. For example, suppose two +unrelated modules make use of an external C++ library and each provide custom +bindings for one of that library's classes. This will result in an error when +a Python program attempts to import both modules (directly or indirectly) +because of conflicting definitions on the external type: + +.. code-block:: cpp + + // dogs.cpp + + // Binding for external library class: + py::class<pets::Pet>(m, "Pet") + .def("name", &pets::Pet::name); + + // Binding for local extension class: + py::class<Dog, pets::Pet>(m, "Dog") + .def(py::init<std::string>()); + +.. code-block:: cpp + + // cats.cpp, in a completely separate project from the above dogs.cpp. + + // Binding for external library class: + py::class<pets::Pet>(m, "Pet") + .def("get_name", &pets::Pet::name); + + // Binding for local extending class: + py::class<Cat, pets::Pet>(m, "Cat") + .def(py::init<std::string>()); + +.. code-block:: pycon + + >>> import cats + >>> import dogs + Traceback (most recent call last): + File "<stdin>", line 1, in <module> + ImportError: generic_type: type "Pet" is already registered! + +To get around this, you can tell pybind11 to keep the external class binding +localized to the module by passing the ``py::module_local()`` attribute into +the ``py::class_`` constructor: + +.. code-block:: cpp + + // Pet binding in dogs.cpp: + py::class<pets::Pet>(m, "Pet", py::module_local()) + .def("name", &pets::Pet::name); + +.. code-block:: cpp + + // Pet binding in cats.cpp: + py::class<pets::Pet>(m, "Pet", py::module_local()) + .def("get_name", &pets::Pet::name); + +This makes the Python-side ``dogs.Pet`` and ``cats.Pet`` into distinct classes, +avoiding the conflict and allowing both modules to be loaded. C++ code in the +``dogs`` module that casts or returns a ``Pet`` instance will result in a +``dogs.Pet`` Python instance, while C++ code in the ``cats`` module will result +in a ``cats.Pet`` Python instance. + +This does come with two caveats, however: First, external modules cannot return +or cast a ``Pet`` instance to Python (unless they also provide their own local +bindings). Second, from the Python point of view they are two distinct classes. + +Note that the locality only applies in the C++ -> Python direction. When +passing such a ``py::module_local`` type into a C++ function, the module-local +classes are still considered. This means that if the following function is +added to any module (including but not limited to the ``cats`` and ``dogs`` +modules above) it will be callable with either a ``dogs.Pet`` or ``cats.Pet`` +argument: + +.. code-block:: cpp + + m.def("pet_name", [](const pets::Pet &pet) { return pet.name(); }); + +For example, suppose the above function is added to each of ``cats.cpp``, +``dogs.cpp`` and ``frogs.cpp`` (where ``frogs.cpp`` is some other module that +does *not* bind ``Pets`` at all). + +.. code-block:: pycon + + >>> import cats, dogs, frogs # No error because of the added py::module_local() + >>> mycat, mydog = cats.Cat("Fluffy"), dogs.Dog("Rover") + >>> (cats.pet_name(mycat), dogs.pet_name(mydog)) + ('Fluffy', 'Rover') + >>> (cats.pet_name(mydog), dogs.pet_name(mycat), frogs.pet_name(mycat)) + ('Rover', 'Fluffy', 'Fluffy') + +It is possible to use ``py::module_local()`` registrations in one module even +if another module registers the same type globally: within the module with the +module-local definition, all C++ instances will be cast to the associated bound +Python type. In other modules any such values are converted to the global +Python type created elsewhere. + +.. note:: + + STL bindings (as provided via the optional :file:`pybind11/stl_bind.h` + header) apply ``py::module_local`` by default when the bound type might + conflict with other modules; see :ref:`stl_bind` for details. + +.. note:: + + The localization of the bound types is actually tied to the shared object + or binary generated by the compiler/linker. For typical modules created + with ``PYBIND11_MODULE()``, this distinction is not significant. It is + possible, however, when :ref:`embedding` to embed multiple modules in the + same binary (see :ref:`embedding_modules`). In such a case, the + localization will apply across all embedded modules within the same binary. + +.. seealso:: + + The file :file:`tests/test_local_bindings.cpp` contains additional examples + that demonstrate how ``py::module_local()`` works. + +Binding protected member functions +================================== + +It's normally not possible to expose ``protected`` member functions to Python: + +.. code-block:: cpp + + class A { + protected: + int foo() const { return 42; } + }; + + py::class_<A>(m, "A") + .def("foo", &A::foo); // error: 'foo' is a protected member of 'A' + +On one hand, this is good because non-``public`` members aren't meant to be +accessed from the outside. But we may want to make use of ``protected`` +functions in derived Python classes. + +The following pattern makes this possible: + +.. code-block:: cpp + + class A { + protected: + int foo() const { return 42; } + }; + + class Publicist : public A { // helper type for exposing protected functions + public: + using A::foo; // inherited with different access modifier + }; + + py::class_<A>(m, "A") // bind the primary class + .def("foo", &Publicist::foo); // expose protected methods via the publicist + +This works because ``&Publicist::foo`` is exactly the same function as +``&A::foo`` (same signature and address), just with a different access +modifier. The only purpose of the ``Publicist`` helper class is to make +the function name ``public``. + +If the intent is to expose ``protected`` ``virtual`` functions which can be +overridden in Python, the publicist pattern can be combined with the previously +described trampoline: + +.. code-block:: cpp + + class A { + public: + virtual ~A() = default; + + protected: + virtual int foo() const { return 42; } + }; + + class Trampoline : public A { + public: + int foo() const override { PYBIND11_OVERLOAD(int, A, foo, ); } + }; + + class Publicist : public A { + public: + using A::foo; + }; + + py::class_<A, Trampoline>(m, "A") // <-- `Trampoline` here + .def("foo", &Publicist::foo); // <-- `Publicist` here, not `Trampoline`! + +.. note:: + + MSVC 2015 has a compiler bug (fixed in version 2017) which + requires a more explicit function binding in the form of + ``.def("foo", static_cast<int (A::*)() const>(&Publicist::foo));`` + where ``int (A::*)() const`` is the type of ``A::foo``. + +Custom automatic downcasters +============================ + +As explained in :ref:`inheritance`, pybind11 comes with built-in +understanding of the dynamic type of polymorphic objects in C++; that +is, returning a Pet to Python produces a Python object that knows it's +wrapping a Dog, if Pet has virtual methods and pybind11 knows about +Dog and this Pet is in fact a Dog. Sometimes, you might want to +provide this automatic downcasting behavior when creating bindings for +a class hierarchy that does not use standard C++ polymorphism, such as +LLVM [#f4]_. As long as there's some way to determine at runtime +whether a downcast is safe, you can proceed by specializing the +``pybind11::polymorphic_type_hook`` template: + +.. code-block:: cpp + + enum class PetKind { Cat, Dog, Zebra }; + struct Pet { // Not polymorphic: has no virtual methods + const PetKind kind; + int age = 0; + protected: + Pet(PetKind _kind) : kind(_kind) {} + }; + struct Dog : Pet { + Dog() : Pet(PetKind::Dog) {} + std::string sound = "woof!"; + std::string bark() const { return sound; } + }; + + namespace pybind11 { + template<> struct polymorphic_type_hook<Pet> { + static const void *get(const Pet *src, const std::type_info*& type) { + // note that src may be nullptr + if (src && src->kind == PetKind::Dog) { + type = &typeid(Dog); + return static_cast<const Dog*>(src); + } + return src; + } + }; + } // namespace pybind11 + +When pybind11 wants to convert a C++ pointer of type ``Base*`` to a +Python object, it calls ``polymorphic_type_hook<Base>::get()`` to +determine if a downcast is possible. The ``get()`` function should use +whatever runtime information is available to determine if its ``src`` +parameter is in fact an instance of some class ``Derived`` that +inherits from ``Base``. If it finds such a ``Derived``, it sets ``type += &typeid(Derived)`` and returns a pointer to the ``Derived`` object +that contains ``src``. Otherwise, it just returns ``src``, leaving +``type`` at its default value of nullptr. If you set ``type`` to a +type that pybind11 doesn't know about, no downcasting will occur, and +the original ``src`` pointer will be used with its static type +``Base*``. + +It is critical that the returned pointer and ``type`` argument of +``get()`` agree with each other: if ``type`` is set to something +non-null, the returned pointer must point to the start of an object +whose type is ``type``. If the hierarchy being exposed uses only +single inheritance, a simple ``return src;`` will achieve this just +fine, but in the general case, you must cast ``src`` to the +appropriate derived-class pointer (e.g. using +``static_cast<Derived>(src)``) before allowing it to be returned as a +``void*``. + +.. [#f4] https://llvm.org/docs/HowToSetUpLLVMStyleRTTI.html + +.. note:: + + pybind11's standard support for downcasting objects whose types + have virtual methods is implemented using + ``polymorphic_type_hook`` too, using the standard C++ ability to + determine the most-derived type of a polymorphic object using + ``typeid()`` and to cast a base pointer to that most-derived type + (even if you don't know what it is) using ``dynamic_cast<void*>``. + +.. seealso:: + + The file :file:`tests/test_tagbased_polymorphic.cpp` contains a + more complete example, including a demonstration of how to provide + automatic downcasting for an entire class hierarchy without + writing one get() function for each class. diff --git a/pybind11/docs/advanced/embedding.rst b/pybind11/docs/advanced/embedding.rst new file mode 100644 index 0000000000000000000000000000000000000000..3930316032b047021ee41b9d8928509a1b55f0ce --- /dev/null +++ b/pybind11/docs/advanced/embedding.rst @@ -0,0 +1,261 @@ +.. _embedding: + +Embedding the interpreter +######################### + +While pybind11 is mainly focused on extending Python using C++, it's also +possible to do the reverse: embed the Python interpreter into a C++ program. +All of the other documentation pages still apply here, so refer to them for +general pybind11 usage. This section will cover a few extra things required +for embedding. + +Getting started +=============== + +A basic executable with an embedded interpreter can be created with just a few +lines of CMake and the ``pybind11::embed`` target, as shown below. For more +information, see :doc:`/compiling`. + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.0) + project(example) + + find_package(pybind11 REQUIRED) # or `add_subdirectory(pybind11)` + + add_executable(example main.cpp) + target_link_libraries(example PRIVATE pybind11::embed) + +The essential structure of the ``main.cpp`` file looks like this: + +.. code-block:: cpp + + #include <pybind11/embed.h> // everything needed for embedding + namespace py = pybind11; + + int main() { + py::scoped_interpreter guard{}; // start the interpreter and keep it alive + + py::print("Hello, World!"); // use the Python API + } + +The interpreter must be initialized before using any Python API, which includes +all the functions and classes in pybind11. The RAII guard class `scoped_interpreter` +takes care of the interpreter lifetime. After the guard is destroyed, the interpreter +shuts down and clears its memory. No Python functions can be called after this. + +Executing Python code +===================== + +There are a few different ways to run Python code. One option is to use `eval`, +`exec` or `eval_file`, as explained in :ref:`eval`. Here is a quick example in +the context of an executable with an embedded interpreter: + +.. code-block:: cpp + + #include <pybind11/embed.h> + namespace py = pybind11; + + int main() { + py::scoped_interpreter guard{}; + + py::exec(R"( + kwargs = dict(name="World", number=42) + message = "Hello, {name}! The answer is {number}".format(**kwargs) + print(message) + )"); + } + +Alternatively, similar results can be achieved using pybind11's API (see +:doc:`/advanced/pycpp/index` for more details). + +.. code-block:: cpp + + #include <pybind11/embed.h> + namespace py = pybind11; + using namespace py::literals; + + int main() { + py::scoped_interpreter guard{}; + + auto kwargs = py::dict("name"_a="World", "number"_a=42); + auto message = "Hello, {name}! The answer is {number}"_s.format(**kwargs); + py::print(message); + } + +The two approaches can also be combined: + +.. code-block:: cpp + + #include <pybind11/embed.h> + #include <iostream> + + namespace py = pybind11; + using namespace py::literals; + + int main() { + py::scoped_interpreter guard{}; + + auto locals = py::dict("name"_a="World", "number"_a=42); + py::exec(R"( + message = "Hello, {name}! The answer is {number}".format(**locals()) + )", py::globals(), locals); + + auto message = locals["message"].cast<std::string>(); + std::cout << message; + } + +Importing modules +================= + +Python modules can be imported using `module::import()`: + +.. code-block:: cpp + + py::module sys = py::module::import("sys"); + py::print(sys.attr("path")); + +For convenience, the current working directory is included in ``sys.path`` when +embedding the interpreter. This makes it easy to import local Python files: + +.. code-block:: python + + """calc.py located in the working directory""" + + def add(i, j): + return i + j + + +.. code-block:: cpp + + py::module calc = py::module::import("calc"); + py::object result = calc.attr("add")(1, 2); + int n = result.cast<int>(); + assert(n == 3); + +Modules can be reloaded using `module::reload()` if the source is modified e.g. +by an external process. This can be useful in scenarios where the application +imports a user defined data processing script which needs to be updated after +changes by the user. Note that this function does not reload modules recursively. + +.. _embedding_modules: + +Adding embedded modules +======================= + +Embedded binary modules can be added using the `PYBIND11_EMBEDDED_MODULE` macro. +Note that the definition must be placed at global scope. They can be imported +like any other module. + +.. code-block:: cpp + + #include <pybind11/embed.h> + namespace py = pybind11; + + PYBIND11_EMBEDDED_MODULE(fast_calc, m) { + // `m` is a `py::module` which is used to bind functions and classes + m.def("add", [](int i, int j) { + return i + j; + }); + } + + int main() { + py::scoped_interpreter guard{}; + + auto fast_calc = py::module::import("fast_calc"); + auto result = fast_calc.attr("add")(1, 2).cast<int>(); + assert(result == 3); + } + +Unlike extension modules where only a single binary module can be created, on +the embedded side an unlimited number of modules can be added using multiple +`PYBIND11_EMBEDDED_MODULE` definitions (as long as they have unique names). + +These modules are added to Python's list of builtins, so they can also be +imported in pure Python files loaded by the interpreter. Everything interacts +naturally: + +.. code-block:: python + + """py_module.py located in the working directory""" + import cpp_module + + a = cpp_module.a + b = a + 1 + + +.. code-block:: cpp + + #include <pybind11/embed.h> + namespace py = pybind11; + + PYBIND11_EMBEDDED_MODULE(cpp_module, m) { + m.attr("a") = 1; + } + + int main() { + py::scoped_interpreter guard{}; + + auto py_module = py::module::import("py_module"); + + auto locals = py::dict("fmt"_a="{} + {} = {}", **py_module.attr("__dict__")); + assert(locals["a"].cast<int>() == 1); + assert(locals["b"].cast<int>() == 2); + + py::exec(R"( + c = a + b + message = fmt.format(a, b, c) + )", py::globals(), locals); + + assert(locals["c"].cast<int>() == 3); + assert(locals["message"].cast<std::string>() == "1 + 2 = 3"); + } + + +Interpreter lifetime +==================== + +The Python interpreter shuts down when `scoped_interpreter` is destroyed. After +this, creating a new instance will restart the interpreter. Alternatively, the +`initialize_interpreter` / `finalize_interpreter` pair of functions can be used +to directly set the state at any time. + +Modules created with pybind11 can be safely re-initialized after the interpreter +has been restarted. However, this may not apply to third-party extension modules. +The issue is that Python itself cannot completely unload extension modules and +there are several caveats with regard to interpreter restarting. In short, not +all memory may be freed, either due to Python reference cycles or user-created +global data. All the details can be found in the CPython documentation. + +.. warning:: + + Creating two concurrent `scoped_interpreter` guards is a fatal error. So is + calling `initialize_interpreter` for a second time after the interpreter + has already been initialized. + + Do not use the raw CPython API functions ``Py_Initialize`` and + ``Py_Finalize`` as these do not properly handle the lifetime of + pybind11's internal data. + + +Sub-interpreter support +======================= + +Creating multiple copies of `scoped_interpreter` is not possible because it +represents the main Python interpreter. Sub-interpreters are something different +and they do permit the existence of multiple interpreters. This is an advanced +feature of the CPython API and should be handled with care. pybind11 does not +currently offer a C++ interface for sub-interpreters, so refer to the CPython +documentation for all the details regarding this feature. + +We'll just mention a couple of caveats the sub-interpreters support in pybind11: + + 1. Sub-interpreters will not receive independent copies of embedded modules. + Instead, these are shared and modifications in one interpreter may be + reflected in another. + + 2. Managing multiple threads, multiple interpreters and the GIL can be + challenging and there are several caveats here, even within the pure + CPython API (please refer to the Python docs for details). As for + pybind11, keep in mind that `gil_scoped_release` and `gil_scoped_acquire` + do not take sub-interpreters into account. diff --git a/pybind11/docs/advanced/exceptions.rst b/pybind11/docs/advanced/exceptions.rst new file mode 100644 index 0000000000000000000000000000000000000000..75ac24ae9a524b67cbe36660377a4ef7ee825dc6 --- /dev/null +++ b/pybind11/docs/advanced/exceptions.rst @@ -0,0 +1,142 @@ +Exceptions +########## + +Built-in exception translation +============================== + +When C++ code invoked from Python throws an ``std::exception``, it is +automatically converted into a Python ``Exception``. pybind11 defines multiple +special exception classes that will map to different types of Python +exceptions: + +.. tabularcolumns:: |p{0.5\textwidth}|p{0.45\textwidth}| + ++--------------------------------------+--------------------------------------+ +| C++ exception type | Python exception type | ++======================================+======================================+ +| :class:`std::exception` | ``RuntimeError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::bad_alloc` | ``MemoryError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::domain_error` | ``ValueError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::invalid_argument` | ``ValueError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::length_error` | ``ValueError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::out_of_range` | ``IndexError`` | ++--------------------------------------+--------------------------------------+ +| :class:`std::range_error` | ``ValueError`` | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::stop_iteration` | ``StopIteration`` (used to implement | +| | custom iterators) | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::index_error` | ``IndexError`` (used to indicate out | +| | of bounds access in ``__getitem__``, | +| | ``__setitem__``, etc.) | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::value_error` | ``ValueError`` (used to indicate | +| | wrong value passed in | +| | ``container.remove(...)``) | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::key_error` | ``KeyError`` (used to indicate out | +| | of bounds access in ``__getitem__``, | +| | ``__setitem__`` in dict-like | +| | objects, etc.) | ++--------------------------------------+--------------------------------------+ +| :class:`pybind11::error_already_set` | Indicates that the Python exception | +| | flag has already been set via Python | +| | API calls from C++ code; this C++ | +| | exception is used to propagate such | +| | a Python exception back to Python. | ++--------------------------------------+--------------------------------------+ + +When a Python function invoked from C++ throws an exception, it is converted +into a C++ exception of type :class:`error_already_set` whose string payload +contains a textual summary. + +There is also a special exception :class:`cast_error` that is thrown by +:func:`handle::call` when the input arguments cannot be converted to Python +objects. + +Registering custom translators +============================== + +If the default exception conversion policy described above is insufficient, +pybind11 also provides support for registering custom exception translators. +To register a simple exception conversion that translates a C++ exception into +a new Python exception using the C++ exception's ``what()`` method, a helper +function is available: + +.. code-block:: cpp + + py::register_exception<CppExp>(module, "PyExp"); + +This call creates a Python exception class with the name ``PyExp`` in the given +module and automatically converts any encountered exceptions of type ``CppExp`` +into Python exceptions of type ``PyExp``. + +When more advanced exception translation is needed, the function +``py::register_exception_translator(translator)`` can be used to register +functions that can translate arbitrary exception types (and which may include +additional logic to do so). The function takes a stateless callable (e.g. a +function pointer or a lambda function without captured variables) with the call +signature ``void(std::exception_ptr)``. + +When a C++ exception is thrown, the registered exception translators are tried +in reverse order of registration (i.e. the last registered translator gets the +first shot at handling the exception). + +Inside the translator, ``std::rethrow_exception`` should be used within +a try block to re-throw the exception. One or more catch clauses to catch +the appropriate exceptions should then be used with each clause using +``PyErr_SetString`` to set a Python exception or ``ex(string)`` to set +the python exception to a custom exception type (see below). + +To declare a custom Python exception type, declare a ``py::exception`` variable +and use this in the associated exception translator (note: it is often useful +to make this a static declaration when using it inside a lambda expression +without requiring capturing). + + +The following example demonstrates this for a hypothetical exception classes +``MyCustomException`` and ``OtherException``: the first is translated to a +custom python exception ``MyCustomError``, while the second is translated to a +standard python RuntimeError: + +.. code-block:: cpp + + static py::exception<MyCustomException> exc(m, "MyCustomError"); + py::register_exception_translator([](std::exception_ptr p) { + try { + if (p) std::rethrow_exception(p); + } catch (const MyCustomException &e) { + exc(e.what()); + } catch (const OtherException &e) { + PyErr_SetString(PyExc_RuntimeError, e.what()); + } + }); + +Multiple exceptions can be handled by a single translator, as shown in the +example above. If the exception is not caught by the current translator, the +previously registered one gets a chance. + +If none of the registered exception translators is able to handle the +exception, it is handled by the default converter as described in the previous +section. + +.. seealso:: + + The file :file:`tests/test_exceptions.cpp` contains examples + of various custom exception translators and custom exception types. + +.. note:: + + You must call either ``PyErr_SetString`` or a custom exception's call + operator (``exc(string)``) for every exception caught in a custom exception + translator. Failure to do so will cause Python to crash with ``SystemError: + error return without exception set``. + + Exceptions that you do not plan to handle should simply not be caught, or + may be explicitly (re-)thrown to delegate it to the other, + previously-declared existing exception translators. diff --git a/pybind11/docs/advanced/functions.rst b/pybind11/docs/advanced/functions.rst new file mode 100644 index 0000000000000000000000000000000000000000..3e1a3ff0e8ea89c18b1a80f97e9b03aa54771560 --- /dev/null +++ b/pybind11/docs/advanced/functions.rst @@ -0,0 +1,507 @@ +Functions +######### + +Before proceeding with this section, make sure that you are already familiar +with the basics of binding functions and classes, as explained in :doc:`/basics` +and :doc:`/classes`. The following guide is applicable to both free and member +functions, i.e. *methods* in Python. + +.. _return_value_policies: + +Return value policies +===================== + +Python and C++ use fundamentally different ways of managing the memory and +lifetime of objects managed by them. This can lead to issues when creating +bindings for functions that return a non-trivial type. Just by looking at the +type information, it is not clear whether Python should take charge of the +returned value and eventually free its resources, or if this is handled on the +C++ side. For this reason, pybind11 provides a several *return value policy* +annotations that can be passed to the :func:`module::def` and +:func:`class_::def` functions. The default policy is +:enum:`return_value_policy::automatic`. + +Return value policies are tricky, and it's very important to get them right. +Just to illustrate what can go wrong, consider the following simple example: + +.. code-block:: cpp + + /* Function declaration */ + Data *get_data() { return _data; /* (pointer to a static data structure) */ } + ... + + /* Binding code */ + m.def("get_data", &get_data); // <-- KABOOM, will cause crash when called from Python + +What's going on here? When ``get_data()`` is called from Python, the return +value (a native C++ type) must be wrapped to turn it into a usable Python type. +In this case, the default return value policy (:enum:`return_value_policy::automatic`) +causes pybind11 to assume ownership of the static ``_data`` instance. + +When Python's garbage collector eventually deletes the Python +wrapper, pybind11 will also attempt to delete the C++ instance (via ``operator +delete()``) due to the implied ownership. At this point, the entire application +will come crashing down, though errors could also be more subtle and involve +silent data corruption. + +In the above example, the policy :enum:`return_value_policy::reference` should have +been specified so that the global data instance is only *referenced* without any +implied transfer of ownership, i.e.: + +.. code-block:: cpp + + m.def("get_data", &get_data, return_value_policy::reference); + +On the other hand, this is not the right policy for many other situations, +where ignoring ownership could lead to resource leaks. +As a developer using pybind11, it's important to be familiar with the different +return value policies, including which situation calls for which one of them. +The following table provides an overview of available policies: + +.. tabularcolumns:: |p{0.5\textwidth}|p{0.45\textwidth}| + ++--------------------------------------------------+----------------------------------------------------------------------------+ +| Return value policy | Description | ++==================================================+============================================================================+ +| :enum:`return_value_policy::take_ownership` | Reference an existing object (i.e. do not create a new copy) and take | +| | ownership. Python will call the destructor and delete operator when the | +| | object's reference count reaches zero. Undefined behavior ensues when the | +| | C++ side does the same, or when the data was not dynamically allocated. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::copy` | Create a new copy of the returned object, which will be owned by Python. | +| | This policy is comparably safe because the lifetimes of the two instances | +| | are decoupled. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::move` | Use ``std::move`` to move the return value contents into a new instance | +| | that will be owned by Python. This policy is comparably safe because the | +| | lifetimes of the two instances (move source and destination) are decoupled.| ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::reference` | Reference an existing object, but do not take ownership. The C++ side is | +| | responsible for managing the object's lifetime and deallocating it when | +| | it is no longer used. Warning: undefined behavior will ensue when the C++ | +| | side deletes an object that is still referenced and used by Python. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::reference_internal` | Indicates that the lifetime of the return value is tied to the lifetime | +| | of a parent object, namely the implicit ``this``, or ``self`` argument of | +| | the called method or property. Internally, this policy works just like | +| | :enum:`return_value_policy::reference` but additionally applies a | +| | ``keep_alive<0, 1>`` *call policy* (described in the next section) that | +| | prevents the parent object from being garbage collected as long as the | +| | return value is referenced by Python. This is the default policy for | +| | property getters created via ``def_property``, ``def_readwrite``, etc. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::automatic` | **Default policy.** This policy falls back to the policy | +| | :enum:`return_value_policy::take_ownership` when the return value is a | +| | pointer. Otherwise, it uses :enum:`return_value_policy::move` or | +| | :enum:`return_value_policy::copy` for rvalue and lvalue references, | +| | respectively. See above for a description of what all of these different | +| | policies do. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::automatic_reference` | As above, but use policy :enum:`return_value_policy::reference` when the | +| | return value is a pointer. This is the default conversion policy for | +| | function arguments when calling Python functions manually from C++ code | +| | (i.e. via handle::operator()). You probably won't need to use this. | ++--------------------------------------------------+----------------------------------------------------------------------------+ + +Return value policies can also be applied to properties: + +.. code-block:: cpp + + class_<MyClass>(m, "MyClass") + .def_property("data", &MyClass::getData, &MyClass::setData, + py::return_value_policy::copy); + +Technically, the code above applies the policy to both the getter and the +setter function, however, the setter doesn't really care about *return* +value policies which makes this a convenient terse syntax. Alternatively, +targeted arguments can be passed through the :class:`cpp_function` constructor: + +.. code-block:: cpp + + class_<MyClass>(m, "MyClass") + .def_property("data" + py::cpp_function(&MyClass::getData, py::return_value_policy::copy), + py::cpp_function(&MyClass::setData) + ); + +.. warning:: + + Code with invalid return value policies might access uninitialized memory or + free data structures multiple times, which can lead to hard-to-debug + non-determinism and segmentation faults, hence it is worth spending the + time to understand all the different options in the table above. + +.. note:: + + One important aspect of the above policies is that they only apply to + instances which pybind11 has *not* seen before, in which case the policy + clarifies essential questions about the return value's lifetime and + ownership. When pybind11 knows the instance already (as identified by its + type and address in memory), it will return the existing Python object + wrapper rather than creating a new copy. + +.. note:: + + The next section on :ref:`call_policies` discusses *call policies* that can be + specified *in addition* to a return value policy from the list above. Call + policies indicate reference relationships that can involve both return values + and parameters of functions. + +.. note:: + + As an alternative to elaborate call policies and lifetime management logic, + consider using smart pointers (see the section on :ref:`smart_pointers` for + details). Smart pointers can tell whether an object is still referenced from + C++ or Python, which generally eliminates the kinds of inconsistencies that + can lead to crashes or undefined behavior. For functions returning smart + pointers, it is not necessary to specify a return value policy. + +.. _call_policies: + +Additional call policies +======================== + +In addition to the above return value policies, further *call policies* can be +specified to indicate dependencies between parameters or ensure a certain state +for the function call. + +Keep alive +---------- + +In general, this policy is required when the C++ object is any kind of container +and another object is being added to the container. ``keep_alive<Nurse, Patient>`` +indicates that the argument with index ``Patient`` should be kept alive at least +until the argument with index ``Nurse`` is freed by the garbage collector. Argument +indices start at one, while zero refers to the return value. For methods, index +``1`` refers to the implicit ``this`` pointer, while regular arguments begin at +index ``2``. Arbitrarily many call policies can be specified. When a ``Nurse`` +with value ``None`` is detected at runtime, the call policy does nothing. + +When the nurse is not a pybind11-registered type, the implementation internally +relies on the ability to create a *weak reference* to the nurse object. When +the nurse object is not a pybind11-registered type and does not support weak +references, an exception will be thrown. + +Consider the following example: here, the binding code for a list append +operation ties the lifetime of the newly added element to the underlying +container: + +.. code-block:: cpp + + py::class_<List>(m, "List") + .def("append", &List::append, py::keep_alive<1, 2>()); + +For consistency, the argument indexing is identical for constructors. Index +``1`` still refers to the implicit ``this`` pointer, i.e. the object which is +being constructed. Index ``0`` refers to the return type which is presumed to +be ``void`` when a constructor is viewed like a function. The following example +ties the lifetime of the constructor element to the constructed object: + +.. code-block:: cpp + + py::class_<Nurse>(m, "Nurse") + .def(py::init<Patient &>(), py::keep_alive<1, 2>()); + +.. note:: + + ``keep_alive`` is analogous to the ``with_custodian_and_ward`` (if Nurse, + Patient != 0) and ``with_custodian_and_ward_postcall`` (if Nurse/Patient == + 0) policies from Boost.Python. + +Call guard +---------- + +The ``call_guard<T>`` policy allows any scope guard type ``T`` to be placed +around the function call. For example, this definition: + +.. code-block:: cpp + + m.def("foo", foo, py::call_guard<T>()); + +is equivalent to the following pseudocode: + +.. code-block:: cpp + + m.def("foo", [](args...) { + T scope_guard; + return foo(args...); // forwarded arguments + }); + +The only requirement is that ``T`` is default-constructible, but otherwise any +scope guard will work. This is very useful in combination with `gil_scoped_release`. +See :ref:`gil`. + +Multiple guards can also be specified as ``py::call_guard<T1, T2, T3...>``. The +constructor order is left to right and destruction happens in reverse. + +.. seealso:: + + The file :file:`tests/test_call_policies.cpp` contains a complete example + that demonstrates using `keep_alive` and `call_guard` in more detail. + +.. _python_objects_as_args: + +Python objects as arguments +=========================== + +pybind11 exposes all major Python types using thin C++ wrapper classes. These +wrapper classes can also be used as parameters of functions in bindings, which +makes it possible to directly work with native Python types on the C++ side. +For instance, the following statement iterates over a Python ``dict``: + +.. code-block:: cpp + + void print_dict(py::dict dict) { + /* Easily interact with Python types */ + for (auto item : dict) + std::cout << "key=" << std::string(py::str(item.first)) << ", " + << "value=" << std::string(py::str(item.second)) << std::endl; + } + +It can be exported: + +.. code-block:: cpp + + m.def("print_dict", &print_dict); + +And used in Python as usual: + +.. code-block:: pycon + + >>> print_dict({'foo': 123, 'bar': 'hello'}) + key=foo, value=123 + key=bar, value=hello + +For more information on using Python objects in C++, see :doc:`/advanced/pycpp/index`. + +Accepting \*args and \*\*kwargs +=============================== + +Python provides a useful mechanism to define functions that accept arbitrary +numbers of arguments and keyword arguments: + +.. code-block:: python + + def generic(*args, **kwargs): + ... # do something with args and kwargs + +Such functions can also be created using pybind11: + +.. code-block:: cpp + + void generic(py::args args, py::kwargs kwargs) { + /// .. do something with args + if (kwargs) + /// .. do something with kwargs + } + + /// Binding code + m.def("generic", &generic); + +The class ``py::args`` derives from ``py::tuple`` and ``py::kwargs`` derives +from ``py::dict``. + +You may also use just one or the other, and may combine these with other +arguments as long as the ``py::args`` and ``py::kwargs`` arguments are the last +arguments accepted by the function. + +Please refer to the other examples for details on how to iterate over these, +and on how to cast their entries into C++ objects. A demonstration is also +available in ``tests/test_kwargs_and_defaults.cpp``. + +.. note:: + + When combining \*args or \*\*kwargs with :ref:`keyword_args` you should + *not* include ``py::arg`` tags for the ``py::args`` and ``py::kwargs`` + arguments. + +Default arguments revisited +=========================== + +The section on :ref:`default_args` previously discussed basic usage of default +arguments using pybind11. One noteworthy aspect of their implementation is that +default arguments are converted to Python objects right at declaration time. +Consider the following example: + +.. code-block:: cpp + + py::class_<MyClass>("MyClass") + .def("myFunction", py::arg("arg") = SomeType(123)); + +In this case, pybind11 must already be set up to deal with values of the type +``SomeType`` (via a prior instantiation of ``py::class_<SomeType>``), or an +exception will be thrown. + +Another aspect worth highlighting is that the "preview" of the default argument +in the function signature is generated using the object's ``__repr__`` method. +If not available, the signature may not be very helpful, e.g.: + +.. code-block:: pycon + + FUNCTIONS + ... + | myFunction(...) + | Signature : (MyClass, arg : SomeType = <SomeType object at 0x101b7b080>) -> NoneType + ... + +The first way of addressing this is by defining ``SomeType.__repr__``. +Alternatively, it is possible to specify the human-readable preview of the +default argument manually using the ``arg_v`` notation: + +.. code-block:: cpp + + py::class_<MyClass>("MyClass") + .def("myFunction", py::arg_v("arg", SomeType(123), "SomeType(123)")); + +Sometimes it may be necessary to pass a null pointer value as a default +argument. In this case, remember to cast it to the underlying type in question, +like so: + +.. code-block:: cpp + + py::class_<MyClass>("MyClass") + .def("myFunction", py::arg("arg") = (SomeType *) nullptr); + +.. _nonconverting_arguments: + +Non-converting arguments +======================== + +Certain argument types may support conversion from one type to another. Some +examples of conversions are: + +* :ref:`implicit_conversions` declared using ``py::implicitly_convertible<A,B>()`` +* Calling a method accepting a double with an integer argument +* Calling a ``std::complex<float>`` argument with a non-complex python type + (for example, with a float). (Requires the optional ``pybind11/complex.h`` + header). +* Calling a function taking an Eigen matrix reference with a numpy array of the + wrong type or of an incompatible data layout. (Requires the optional + ``pybind11/eigen.h`` header). + +This behaviour is sometimes undesirable: the binding code may prefer to raise +an error rather than convert the argument. This behaviour can be obtained +through ``py::arg`` by calling the ``.noconvert()`` method of the ``py::arg`` +object, such as: + +.. code-block:: cpp + + m.def("floats_only", [](double f) { return 0.5 * f; }, py::arg("f").noconvert()); + m.def("floats_preferred", [](double f) { return 0.5 * f; }, py::arg("f")); + +Attempting the call the second function (the one without ``.noconvert()``) with +an integer will succeed, but attempting to call the ``.noconvert()`` version +will fail with a ``TypeError``: + +.. code-block:: pycon + + >>> floats_preferred(4) + 2.0 + >>> floats_only(4) + Traceback (most recent call last): + File "<stdin>", line 1, in <module> + TypeError: floats_only(): incompatible function arguments. The following argument types are supported: + 1. (f: float) -> float + + Invoked with: 4 + +You may, of course, combine this with the :var:`_a` shorthand notation (see +:ref:`keyword_args`) and/or :ref:`default_args`. It is also permitted to omit +the argument name by using the ``py::arg()`` constructor without an argument +name, i.e. by specifying ``py::arg().noconvert()``. + +.. note:: + + When specifying ``py::arg`` options it is necessary to provide the same + number of options as the bound function has arguments. Thus if you want to + enable no-convert behaviour for just one of several arguments, you will + need to specify a ``py::arg()`` annotation for each argument with the + no-convert argument modified to ``py::arg().noconvert()``. + +.. _none_arguments: + +Allow/Prohibiting None arguments +================================ + +When a C++ type registered with :class:`py::class_` is passed as an argument to +a function taking the instance as pointer or shared holder (e.g. ``shared_ptr`` +or a custom, copyable holder as described in :ref:`smart_pointers`), pybind +allows ``None`` to be passed from Python which results in calling the C++ +function with ``nullptr`` (or an empty holder) for the argument. + +To explicitly enable or disable this behaviour, using the +``.none`` method of the :class:`py::arg` object: + +.. code-block:: cpp + + py::class_<Dog>(m, "Dog").def(py::init<>()); + py::class_<Cat>(m, "Cat").def(py::init<>()); + m.def("bark", [](Dog *dog) -> std::string { + if (dog) return "woof!"; /* Called with a Dog instance */ + else return "(no dog)"; /* Called with None, dog == nullptr */ + }, py::arg("dog").none(true)); + m.def("meow", [](Cat *cat) -> std::string { + // Can't be called with None argument + return "meow"; + }, py::arg("cat").none(false)); + +With the above, the Python call ``bark(None)`` will return the string ``"(no +dog)"``, while attempting to call ``meow(None)`` will raise a ``TypeError``: + +.. code-block:: pycon + + >>> from animals import Dog, Cat, bark, meow + >>> bark(Dog()) + 'woof!' + >>> meow(Cat()) + 'meow' + >>> bark(None) + '(no dog)' + >>> meow(None) + Traceback (most recent call last): + File "<stdin>", line 1, in <module> + TypeError: meow(): incompatible function arguments. The following argument types are supported: + 1. (cat: animals.Cat) -> str + + Invoked with: None + +The default behaviour when the tag is unspecified is to allow ``None``. + +.. note:: + + Even when ``.none(true)`` is specified for an argument, ``None`` will be converted to a + ``nullptr`` *only* for custom and :ref:`opaque <opaque>` types. Pointers to built-in types + (``double *``, ``int *``, ...) and STL types (``std::vector<T> *``, ...; if ``pybind11/stl.h`` + is included) are copied when converted to C++ (see :doc:`/advanced/cast/overview`) and will + not allow ``None`` as argument. To pass optional argument of these copied types consider + using ``std::optional<T>`` + +Overload resolution order +========================= + +When a function or method with multiple overloads is called from Python, +pybind11 determines which overload to call in two passes. The first pass +attempts to call each overload without allowing argument conversion (as if +every argument had been specified as ``py::arg().noconvert()`` as described +above). + +If no overload succeeds in the no-conversion first pass, a second pass is +attempted in which argument conversion is allowed (except where prohibited via +an explicit ``py::arg().noconvert()`` attribute in the function definition). + +If the second pass also fails a ``TypeError`` is raised. + +Within each pass, overloads are tried in the order they were registered with +pybind11. + +What this means in practice is that pybind11 will prefer any overload that does +not require conversion of arguments to an overload that does, but otherwise prefers +earlier-defined overloads to later-defined ones. + +.. note:: + + pybind11 does *not* further prioritize based on the number/pattern of + overloaded arguments. That is, pybind11 does not prioritize a function + requiring one conversion over one requiring three, but only prioritizes + overloads requiring no conversion at all to overloads that require + conversion of at least one argument. diff --git a/pybind11/docs/advanced/misc.rst b/pybind11/docs/advanced/misc.rst new file mode 100644 index 0000000000000000000000000000000000000000..5b38ec7598703b5a29663dedfc92c183d66c1b70 --- /dev/null +++ b/pybind11/docs/advanced/misc.rst @@ -0,0 +1,306 @@ +Miscellaneous +############# + +.. _macro_notes: + +General notes regarding convenience macros +========================================== + +pybind11 provides a few convenience macros such as +:func:`PYBIND11_DECLARE_HOLDER_TYPE` and ``PYBIND11_OVERLOAD_*``. Since these +are "just" macros that are evaluated in the preprocessor (which has no concept +of types), they *will* get confused by commas in a template argument; for +example, consider: + +.. code-block:: cpp + + PYBIND11_OVERLOAD(MyReturnType<T1, T2>, Class<T3, T4>, func) + +The limitation of the C preprocessor interprets this as five arguments (with new +arguments beginning after each comma) rather than three. To get around this, +there are two alternatives: you can use a type alias, or you can wrap the type +using the ``PYBIND11_TYPE`` macro: + +.. code-block:: cpp + + // Version 1: using a type alias + using ReturnType = MyReturnType<T1, T2>; + using ClassType = Class<T3, T4>; + PYBIND11_OVERLOAD(ReturnType, ClassType, func); + + // Version 2: using the PYBIND11_TYPE macro: + PYBIND11_OVERLOAD(PYBIND11_TYPE(MyReturnType<T1, T2>), + PYBIND11_TYPE(Class<T3, T4>), func) + +The ``PYBIND11_MAKE_OPAQUE`` macro does *not* require the above workarounds. + +.. _gil: + +Global Interpreter Lock (GIL) +============================= + +When calling a C++ function from Python, the GIL is always held. +The classes :class:`gil_scoped_release` and :class:`gil_scoped_acquire` can be +used to acquire and release the global interpreter lock in the body of a C++ +function call. In this way, long-running C++ code can be parallelized using +multiple Python threads. Taking :ref:`overriding_virtuals` as an example, this +could be realized as follows (important changes highlighted): + +.. code-block:: cpp + :emphasize-lines: 8,9,31,32 + + class PyAnimal : public Animal { + public: + /* Inherit the constructors */ + using Animal::Animal; + + /* Trampoline (need one for each virtual function) */ + std::string go(int n_times) { + /* Acquire GIL before calling Python code */ + py::gil_scoped_acquire acquire; + + PYBIND11_OVERLOAD_PURE( + std::string, /* Return type */ + Animal, /* Parent class */ + go, /* Name of function */ + n_times /* Argument(s) */ + ); + } + }; + + PYBIND11_MODULE(example, m) { + py::class_<Animal, PyAnimal> animal(m, "Animal"); + animal + .def(py::init<>()) + .def("go", &Animal::go); + + py::class_<Dog>(m, "Dog", animal) + .def(py::init<>()); + + m.def("call_go", [](Animal *animal) -> std::string { + /* Release GIL before calling into (potentially long-running) C++ code */ + py::gil_scoped_release release; + return call_go(animal); + }); + } + +The ``call_go`` wrapper can also be simplified using the `call_guard` policy +(see :ref:`call_policies`) which yields the same result: + +.. code-block:: cpp + + m.def("call_go", &call_go, py::call_guard<py::gil_scoped_release>()); + + +Binding sequence data types, iterators, the slicing protocol, etc. +================================================================== + +Please refer to the supplemental example for details. + +.. seealso:: + + The file :file:`tests/test_sequences_and_iterators.cpp` contains a + complete example that shows how to bind a sequence data type, including + length queries (``__len__``), iterators (``__iter__``), the slicing + protocol and other kinds of useful operations. + + +Partitioning code over multiple extension modules +================================================= + +It's straightforward to split binding code over multiple extension modules, +while referencing types that are declared elsewhere. Everything "just" works +without any special precautions. One exception to this rule occurs when +extending a type declared in another extension module. Recall the basic example +from Section :ref:`inheritance`. + +.. code-block:: cpp + + py::class_<Pet> pet(m, "Pet"); + pet.def(py::init<const std::string &>()) + .def_readwrite("name", &Pet::name); + + py::class_<Dog>(m, "Dog", pet /* <- specify parent */) + .def(py::init<const std::string &>()) + .def("bark", &Dog::bark); + +Suppose now that ``Pet`` bindings are defined in a module named ``basic``, +whereas the ``Dog`` bindings are defined somewhere else. The challenge is of +course that the variable ``pet`` is not available anymore though it is needed +to indicate the inheritance relationship to the constructor of ``class_<Dog>``. +However, it can be acquired as follows: + +.. code-block:: cpp + + py::object pet = (py::object) py::module::import("basic").attr("Pet"); + + py::class_<Dog>(m, "Dog", pet) + .def(py::init<const std::string &>()) + .def("bark", &Dog::bark); + +Alternatively, you can specify the base class as a template parameter option to +``class_``, which performs an automated lookup of the corresponding Python +type. Like the above code, however, this also requires invoking the ``import`` +function once to ensure that the pybind11 binding code of the module ``basic`` +has been executed: + +.. code-block:: cpp + + py::module::import("basic"); + + py::class_<Dog, Pet>(m, "Dog") + .def(py::init<const std::string &>()) + .def("bark", &Dog::bark); + +Naturally, both methods will fail when there are cyclic dependencies. + +Note that pybind11 code compiled with hidden-by-default symbol visibility (e.g. +via the command line flag ``-fvisibility=hidden`` on GCC/Clang), which is +required for proper pybind11 functionality, can interfere with the ability to +access types defined in another extension module. Working around this requires +manually exporting types that are accessed by multiple extension modules; +pybind11 provides a macro to do just this: + +.. code-block:: cpp + + class PYBIND11_EXPORT Dog : public Animal { + ... + }; + +Note also that it is possible (although would rarely be required) to share arbitrary +C++ objects between extension modules at runtime. Internal library data is shared +between modules using capsule machinery [#f6]_ which can be also utilized for +storing, modifying and accessing user-defined data. Note that an extension module +will "see" other extensions' data if and only if they were built with the same +pybind11 version. Consider the following example: + +.. code-block:: cpp + + auto data = (MyData *) py::get_shared_data("mydata"); + if (!data) + data = (MyData *) py::set_shared_data("mydata", new MyData(42)); + +If the above snippet was used in several separately compiled extension modules, +the first one to be imported would create a ``MyData`` instance and associate +a ``"mydata"`` key with a pointer to it. Extensions that are imported later +would be then able to access the data behind the same pointer. + +.. [#f6] https://docs.python.org/3/extending/extending.html#using-capsules + +Module Destructors +================== + +pybind11 does not provide an explicit mechanism to invoke cleanup code at +module destruction time. In rare cases where such functionality is required, it +is possible to emulate it using Python capsules or weak references with a +destruction callback. + +.. code-block:: cpp + + auto cleanup_callback = []() { + // perform cleanup here -- this function is called with the GIL held + }; + + m.add_object("_cleanup", py::capsule(cleanup_callback)); + +This approach has the potential downside that instances of classes exposed +within the module may still be alive when the cleanup callback is invoked +(whether this is acceptable will generally depend on the application). + +Alternatively, the capsule may also be stashed within a type object, which +ensures that it not called before all instances of that type have been +collected: + +.. code-block:: cpp + + auto cleanup_callback = []() { /* ... */ }; + m.attr("BaseClass").attr("_cleanup") = py::capsule(cleanup_callback); + +Both approaches also expose a potentially dangerous ``_cleanup`` attribute in +Python, which may be undesirable from an API standpoint (a premature explicit +call from Python might lead to undefined behavior). Yet another approach that +avoids this issue involves weak reference with a cleanup callback: + +.. code-block:: cpp + + // Register a callback function that is invoked when the BaseClass object is colelcted + py::cpp_function cleanup_callback( + [](py::handle weakref) { + // perform cleanup here -- this function is called with the GIL held + + weakref.dec_ref(); // release weak reference + } + ); + + // Create a weak reference with a cleanup callback and initially leak it + (void) py::weakref(m.attr("BaseClass"), cleanup_callback).release(); + +.. note:: + + PyPy (at least version 5.9) does not garbage collect objects when the + interpreter exits. An alternative approach (which also works on CPython) is to use + the :py:mod:`atexit` module [#f7]_, for example: + + .. code-block:: cpp + + auto atexit = py::module::import("atexit"); + atexit.attr("register")(py::cpp_function([]() { + // perform cleanup here -- this function is called with the GIL held + })); + + .. [#f7] https://docs.python.org/3/library/atexit.html + + +Generating documentation using Sphinx +===================================== + +Sphinx [#f4]_ has the ability to inspect the signatures and documentation +strings in pybind11-based extension modules to automatically generate beautiful +documentation in a variety formats. The python_example repository [#f5]_ contains a +simple example repository which uses this approach. + +There are two potential gotchas when using this approach: first, make sure that +the resulting strings do not contain any :kbd:`TAB` characters, which break the +docstring parsing routines. You may want to use C++11 raw string literals, +which are convenient for multi-line comments. Conveniently, any excess +indentation will be automatically be removed by Sphinx. However, for this to +work, it is important that all lines are indented consistently, i.e.: + +.. code-block:: cpp + + // ok + m.def("foo", &foo, R"mydelimiter( + The foo function + + Parameters + ---------- + )mydelimiter"); + + // *not ok* + m.def("foo", &foo, R"mydelimiter(The foo function + + Parameters + ---------- + )mydelimiter"); + +By default, pybind11 automatically generates and prepends a signature to the docstring of a function +registered with ``module::def()`` and ``class_::def()``. Sometimes this +behavior is not desirable, because you want to provide your own signature or remove +the docstring completely to exclude the function from the Sphinx documentation. +The class ``options`` allows you to selectively suppress auto-generated signatures: + +.. code-block:: cpp + + PYBIND11_MODULE(example, m) { + py::options options; + options.disable_function_signatures(); + + m.def("add", [](int a, int b) { return a + b; }, "A function which adds two numbers"); + } + +Note that changes to the settings affect only function bindings created during the +lifetime of the ``options`` instance. When it goes out of scope at the end of the module's init function, +the default settings are restored to prevent unwanted side effects. + +.. [#f4] http://www.sphinx-doc.org +.. [#f5] http://github.com/pybind/python_example diff --git a/pybind11/docs/advanced/pycpp/index.rst b/pybind11/docs/advanced/pycpp/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..6885bdcff1b56bbab5605873ccb1e0676864bb03 --- /dev/null +++ b/pybind11/docs/advanced/pycpp/index.rst @@ -0,0 +1,13 @@ +Python C++ interface +#################### + +pybind11 exposes Python types and functions using thin C++ wrappers, which +makes it possible to conveniently call Python code from C++ without resorting +to Python's C API. + +.. toctree:: + :maxdepth: 2 + + object + numpy + utilities diff --git a/pybind11/docs/advanced/pycpp/numpy.rst b/pybind11/docs/advanced/pycpp/numpy.rst new file mode 100644 index 0000000000000000000000000000000000000000..458f99e9787ec1a7469afa05099abe25c685103d --- /dev/null +++ b/pybind11/docs/advanced/pycpp/numpy.rst @@ -0,0 +1,386 @@ +.. _numpy: + +NumPy +##### + +Buffer protocol +=============== + +Python supports an extremely general and convenient approach for exchanging +data between plugin libraries. Types can expose a buffer view [#f2]_, which +provides fast direct access to the raw internal data representation. Suppose we +want to bind the following simplistic Matrix class: + +.. code-block:: cpp + + class Matrix { + public: + Matrix(size_t rows, size_t cols) : m_rows(rows), m_cols(cols) { + m_data = new float[rows*cols]; + } + float *data() { return m_data; } + size_t rows() const { return m_rows; } + size_t cols() const { return m_cols; } + private: + size_t m_rows, m_cols; + float *m_data; + }; + +The following binding code exposes the ``Matrix`` contents as a buffer object, +making it possible to cast Matrices into NumPy arrays. It is even possible to +completely avoid copy operations with Python expressions like +``np.array(matrix_instance, copy = False)``. + +.. code-block:: cpp + + py::class_<Matrix>(m, "Matrix", py::buffer_protocol()) + .def_buffer([](Matrix &m) -> py::buffer_info { + return py::buffer_info( + m.data(), /* Pointer to buffer */ + sizeof(float), /* Size of one scalar */ + py::format_descriptor<float>::format(), /* Python struct-style format descriptor */ + 2, /* Number of dimensions */ + { m.rows(), m.cols() }, /* Buffer dimensions */ + { sizeof(float) * m.cols(), /* Strides (in bytes) for each index */ + sizeof(float) } + ); + }); + +Supporting the buffer protocol in a new type involves specifying the special +``py::buffer_protocol()`` tag in the ``py::class_`` constructor and calling the +``def_buffer()`` method with a lambda function that creates a +``py::buffer_info`` description record on demand describing a given matrix +instance. The contents of ``py::buffer_info`` mirror the Python buffer protocol +specification. + +.. code-block:: cpp + + struct buffer_info { + void *ptr; + ssize_t itemsize; + std::string format; + ssize_t ndim; + std::vector<ssize_t> shape; + std::vector<ssize_t> strides; + }; + +To create a C++ function that can take a Python buffer object as an argument, +simply use the type ``py::buffer`` as one of its arguments. Buffers can exist +in a great variety of configurations, hence some safety checks are usually +necessary in the function body. Below, you can see an basic example on how to +define a custom constructor for the Eigen double precision matrix +(``Eigen::MatrixXd``) type, which supports initialization from compatible +buffer objects (e.g. a NumPy matrix). + +.. code-block:: cpp + + /* Bind MatrixXd (or some other Eigen type) to Python */ + typedef Eigen::MatrixXd Matrix; + + typedef Matrix::Scalar Scalar; + constexpr bool rowMajor = Matrix::Flags & Eigen::RowMajorBit; + + py::class_<Matrix>(m, "Matrix", py::buffer_protocol()) + .def("__init__", [](Matrix &m, py::buffer b) { + typedef Eigen::Stride<Eigen::Dynamic, Eigen::Dynamic> Strides; + + /* Request a buffer descriptor from Python */ + py::buffer_info info = b.request(); + + /* Some sanity checks ... */ + if (info.format != py::format_descriptor<Scalar>::format()) + throw std::runtime_error("Incompatible format: expected a double array!"); + + if (info.ndim != 2) + throw std::runtime_error("Incompatible buffer dimension!"); + + auto strides = Strides( + info.strides[rowMajor ? 0 : 1] / (py::ssize_t)sizeof(Scalar), + info.strides[rowMajor ? 1 : 0] / (py::ssize_t)sizeof(Scalar)); + + auto map = Eigen::Map<Matrix, 0, Strides>( + static_cast<Scalar *>(info.ptr), info.shape[0], info.shape[1], strides); + + new (&m) Matrix(map); + }); + +For reference, the ``def_buffer()`` call for this Eigen data type should look +as follows: + +.. code-block:: cpp + + .def_buffer([](Matrix &m) -> py::buffer_info { + return py::buffer_info( + m.data(), /* Pointer to buffer */ + sizeof(Scalar), /* Size of one scalar */ + py::format_descriptor<Scalar>::format(), /* Python struct-style format descriptor */ + 2, /* Number of dimensions */ + { m.rows(), m.cols() }, /* Buffer dimensions */ + { sizeof(Scalar) * (rowMajor ? m.cols() : 1), + sizeof(Scalar) * (rowMajor ? 1 : m.rows()) } + /* Strides (in bytes) for each index */ + ); + }) + +For a much easier approach of binding Eigen types (although with some +limitations), refer to the section on :doc:`/advanced/cast/eigen`. + +.. seealso:: + + The file :file:`tests/test_buffers.cpp` contains a complete example + that demonstrates using the buffer protocol with pybind11 in more detail. + +.. [#f2] http://docs.python.org/3/c-api/buffer.html + +Arrays +====== + +By exchanging ``py::buffer`` with ``py::array`` in the above snippet, we can +restrict the function so that it only accepts NumPy arrays (rather than any +type of Python object satisfying the buffer protocol). + +In many situations, we want to define a function which only accepts a NumPy +array of a certain data type. This is possible via the ``py::array_t<T>`` +template. For instance, the following function requires the argument to be a +NumPy array containing double precision values. + +.. code-block:: cpp + + void f(py::array_t<double> array); + +When it is invoked with a different type (e.g. an integer or a list of +integers), the binding code will attempt to cast the input into a NumPy array +of the requested type. Note that this feature requires the +:file:`pybind11/numpy.h` header to be included. + +Data in NumPy arrays is not guaranteed to packed in a dense manner; +furthermore, entries can be separated by arbitrary column and row strides. +Sometimes, it can be useful to require a function to only accept dense arrays +using either the C (row-major) or Fortran (column-major) ordering. This can be +accomplished via a second template argument with values ``py::array::c_style`` +or ``py::array::f_style``. + +.. code-block:: cpp + + void f(py::array_t<double, py::array::c_style | py::array::forcecast> array); + +The ``py::array::forcecast`` argument is the default value of the second +template parameter, and it ensures that non-conforming arguments are converted +into an array satisfying the specified requirements instead of trying the next +function overload. + +Structured types +================ + +In order for ``py::array_t`` to work with structured (record) types, we first +need to register the memory layout of the type. This can be done via +``PYBIND11_NUMPY_DTYPE`` macro, called in the plugin definition code, which +expects the type followed by field names: + +.. code-block:: cpp + + struct A { + int x; + double y; + }; + + struct B { + int z; + A a; + }; + + // ... + PYBIND11_MODULE(test, m) { + // ... + + PYBIND11_NUMPY_DTYPE(A, x, y); + PYBIND11_NUMPY_DTYPE(B, z, a); + /* now both A and B can be used as template arguments to py::array_t */ + } + +The structure should consist of fundamental arithmetic types, ``std::complex``, +previously registered substructures, and arrays of any of the above. Both C++ +arrays and ``std::array`` are supported. While there is a static assertion to +prevent many types of unsupported structures, it is still the user's +responsibility to use only "plain" structures that can be safely manipulated as +raw memory without violating invariants. + +Vectorizing functions +===================== + +Suppose we want to bind a function with the following signature to Python so +that it can process arbitrary NumPy array arguments (vectors, matrices, general +N-D arrays) in addition to its normal arguments: + +.. code-block:: cpp + + double my_func(int x, float y, double z); + +After including the ``pybind11/numpy.h`` header, this is extremely simple: + +.. code-block:: cpp + + m.def("vectorized_func", py::vectorize(my_func)); + +Invoking the function like below causes 4 calls to be made to ``my_func`` with +each of the array elements. The significant advantage of this compared to +solutions like ``numpy.vectorize()`` is that the loop over the elements runs +entirely on the C++ side and can be crunched down into a tight, optimized loop +by the compiler. The result is returned as a NumPy array of type +``numpy.dtype.float64``. + +.. code-block:: pycon + + >>> x = np.array([[1, 3],[5, 7]]) + >>> y = np.array([[2, 4],[6, 8]]) + >>> z = 3 + >>> result = vectorized_func(x, y, z) + +The scalar argument ``z`` is transparently replicated 4 times. The input +arrays ``x`` and ``y`` are automatically converted into the right types (they +are of type ``numpy.dtype.int64`` but need to be ``numpy.dtype.int32`` and +``numpy.dtype.float32``, respectively). + +.. note:: + + Only arithmetic, complex, and POD types passed by value or by ``const &`` + reference are vectorized; all other arguments are passed through as-is. + Functions taking rvalue reference arguments cannot be vectorized. + +In cases where the computation is too complicated to be reduced to +``vectorize``, it will be necessary to create and access the buffer contents +manually. The following snippet contains a complete example that shows how this +works (the code is somewhat contrived, since it could have been done more +simply using ``vectorize``). + +.. code-block:: cpp + + #include <pybind11/pybind11.h> + #include <pybind11/numpy.h> + + namespace py = pybind11; + + py::array_t<double> add_arrays(py::array_t<double> input1, py::array_t<double> input2) { + py::buffer_info buf1 = input1.request(), buf2 = input2.request(); + + if (buf1.ndim != 1 || buf2.ndim != 1) + throw std::runtime_error("Number of dimensions must be one"); + + if (buf1.size != buf2.size) + throw std::runtime_error("Input shapes must match"); + + /* No pointer is passed, so NumPy will allocate the buffer */ + auto result = py::array_t<double>(buf1.size); + + py::buffer_info buf3 = result.request(); + + double *ptr1 = (double *) buf1.ptr, + *ptr2 = (double *) buf2.ptr, + *ptr3 = (double *) buf3.ptr; + + for (size_t idx = 0; idx < buf1.shape[0]; idx++) + ptr3[idx] = ptr1[idx] + ptr2[idx]; + + return result; + } + + PYBIND11_MODULE(test, m) { + m.def("add_arrays", &add_arrays, "Add two NumPy arrays"); + } + +.. seealso:: + + The file :file:`tests/test_numpy_vectorize.cpp` contains a complete + example that demonstrates using :func:`vectorize` in more detail. + +Direct access +============= + +For performance reasons, particularly when dealing with very large arrays, it +is often desirable to directly access array elements without internal checking +of dimensions and bounds on every access when indices are known to be already +valid. To avoid such checks, the ``array`` class and ``array_t<T>`` template +class offer an unchecked proxy object that can be used for this unchecked +access through the ``unchecked<N>`` and ``mutable_unchecked<N>`` methods, +where ``N`` gives the required dimensionality of the array: + +.. code-block:: cpp + + m.def("sum_3d", [](py::array_t<double> x) { + auto r = x.unchecked<3>(); // x must have ndim = 3; can be non-writeable + double sum = 0; + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + for (ssize_t k = 0; k < r.shape(2); k++) + sum += r(i, j, k); + return sum; + }); + m.def("increment_3d", [](py::array_t<double> x) { + auto r = x.mutable_unchecked<3>(); // Will throw if ndim != 3 or flags.writeable is false + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + for (ssize_t k = 0; k < r.shape(2); k++) + r(i, j, k) += 1.0; + }, py::arg().noconvert()); + +To obtain the proxy from an ``array`` object, you must specify both the data +type and number of dimensions as template arguments, such as ``auto r = +myarray.mutable_unchecked<float, 2>()``. + +If the number of dimensions is not known at compile time, you can omit the +dimensions template parameter (i.e. calling ``arr_t.unchecked()`` or +``arr.unchecked<T>()``. This will give you a proxy object that works in the +same way, but results in less optimizable code and thus a small efficiency +loss in tight loops. + +Note that the returned proxy object directly references the array's data, and +only reads its shape, strides, and writeable flag when constructed. You must +take care to ensure that the referenced array is not destroyed or reshaped for +the duration of the returned object, typically by limiting the scope of the +returned instance. + +The returned proxy object supports some of the same methods as ``py::array`` so +that it can be used as a drop-in replacement for some existing, index-checked +uses of ``py::array``: + +- ``r.ndim()`` returns the number of dimensions + +- ``r.data(1, 2, ...)`` and ``r.mutable_data(1, 2, ...)``` returns a pointer to + the ``const T`` or ``T`` data, respectively, at the given indices. The + latter is only available to proxies obtained via ``a.mutable_unchecked()``. + +- ``itemsize()`` returns the size of an item in bytes, i.e. ``sizeof(T)``. + +- ``ndim()`` returns the number of dimensions. + +- ``shape(n)`` returns the size of dimension ``n`` + +- ``size()`` returns the total number of elements (i.e. the product of the shapes). + +- ``nbytes()`` returns the number of bytes used by the referenced elements + (i.e. ``itemsize()`` times ``size()``). + +.. seealso:: + + The file :file:`tests/test_numpy_array.cpp` contains additional examples + demonstrating the use of this feature. + +Ellipsis +======== + +Python 3 provides a convenient ``...`` ellipsis notation that is often used to +slice multidimensional arrays. For instance, the following snippet extracts the +middle dimensions of a tensor with the first and last index set to zero. + +.. code-block:: python + + a = # a NumPy array + b = a[0, ..., 0] + +The function ``py::ellipsis()`` function can be used to perform the same +operation on the C++ side: + +.. code-block:: cpp + + py::array a = /* A NumPy array */; + py::array b = a[py::make_tuple(0, py::ellipsis(), 0)]; diff --git a/pybind11/docs/advanced/pycpp/object.rst b/pybind11/docs/advanced/pycpp/object.rst new file mode 100644 index 0000000000000000000000000000000000000000..117131edcb3665563442e5402338f0e33d77d0e0 --- /dev/null +++ b/pybind11/docs/advanced/pycpp/object.rst @@ -0,0 +1,170 @@ +Python types +############ + +Available wrappers +================== + +All major Python types are available as thin C++ wrapper classes. These +can also be used as function parameters -- see :ref:`python_objects_as_args`. + +Available types include :class:`handle`, :class:`object`, :class:`bool_`, +:class:`int_`, :class:`float_`, :class:`str`, :class:`bytes`, :class:`tuple`, +:class:`list`, :class:`dict`, :class:`slice`, :class:`none`, :class:`capsule`, +:class:`iterable`, :class:`iterator`, :class:`function`, :class:`buffer`, +:class:`array`, and :class:`array_t`. + +Casting back and forth +====================== + +In this kind of mixed code, it is often necessary to convert arbitrary C++ +types to Python, which can be done using :func:`py::cast`: + +.. code-block:: cpp + + MyClass *cls = ..; + py::object obj = py::cast(cls); + +The reverse direction uses the following syntax: + +.. code-block:: cpp + + py::object obj = ...; + MyClass *cls = obj.cast<MyClass *>(); + +When conversion fails, both directions throw the exception :class:`cast_error`. + +.. _python_libs: + +Accessing Python libraries from C++ +=================================== + +It is also possible to import objects defined in the Python standard +library or available in the current Python environment (``sys.path``) and work +with these in C++. + +This example obtains a reference to the Python ``Decimal`` class. + +.. code-block:: cpp + + // Equivalent to "from decimal import Decimal" + py::object Decimal = py::module::import("decimal").attr("Decimal"); + +.. code-block:: cpp + + // Try to import scipy + py::object scipy = py::module::import("scipy"); + return scipy.attr("__version__"); + +.. _calling_python_functions: + +Calling Python functions +======================== + +It is also possible to call Python classes, functions and methods +via ``operator()``. + +.. code-block:: cpp + + // Construct a Python object of class Decimal + py::object pi = Decimal("3.14159"); + +.. code-block:: cpp + + // Use Python to make our directories + py::object os = py::module::import("os"); + py::object makedirs = os.attr("makedirs"); + makedirs("/tmp/path/to/somewhere"); + +One can convert the result obtained from Python to a pure C++ version +if a ``py::class_`` or type conversion is defined. + +.. code-block:: cpp + + py::function f = <...>; + py::object result_py = f(1234, "hello", some_instance); + MyClass &result = result_py.cast<MyClass>(); + +.. _calling_python_methods: + +Calling Python methods +======================== + +To call an object's method, one can again use ``.attr`` to obtain access to the +Python method. + +.. code-block:: cpp + + // Calculate e^Ï€ in decimal + py::object exp_pi = pi.attr("exp")(); + py::print(py::str(exp_pi)); + +In the example above ``pi.attr("exp")`` is a *bound method*: it will always call +the method for that same instance of the class. Alternately one can create an +*unbound method* via the Python class (instead of instance) and pass the ``self`` +object explicitly, followed by other arguments. + +.. code-block:: cpp + + py::object decimal_exp = Decimal.attr("exp"); + + // Compute the e^n for n=0..4 + for (int n = 0; n < 5; n++) { + py::print(decimal_exp(Decimal(n)); + } + +Keyword arguments +================= + +Keyword arguments are also supported. In Python, there is the usual call syntax: + +.. code-block:: python + + def f(number, say, to): + ... # function code + + f(1234, say="hello", to=some_instance) # keyword call in Python + +In C++, the same call can be made using: + +.. code-block:: cpp + + using namespace pybind11::literals; // to bring in the `_a` literal + f(1234, "say"_a="hello", "to"_a=some_instance); // keyword call in C++ + +Unpacking arguments +=================== + +Unpacking of ``*args`` and ``**kwargs`` is also possible and can be mixed with +other arguments: + +.. code-block:: cpp + + // * unpacking + py::tuple args = py::make_tuple(1234, "hello", some_instance); + f(*args); + + // ** unpacking + py::dict kwargs = py::dict("number"_a=1234, "say"_a="hello", "to"_a=some_instance); + f(**kwargs); + + // mixed keywords, * and ** unpacking + py::tuple args = py::make_tuple(1234); + py::dict kwargs = py::dict("to"_a=some_instance); + f(*args, "say"_a="hello", **kwargs); + +Generalized unpacking according to PEP448_ is also supported: + +.. code-block:: cpp + + py::dict kwargs1 = py::dict("number"_a=1234); + py::dict kwargs2 = py::dict("to"_a=some_instance); + f(**kwargs1, "say"_a="hello", **kwargs2); + +.. seealso:: + + The file :file:`tests/test_pytypes.cpp` contains a complete + example that demonstrates passing native Python types in more detail. The + file :file:`tests/test_callbacks.cpp` presents a few examples of calling + Python functions from C++, including keywords arguments and unpacking. + +.. _PEP448: https://www.python.org/dev/peps/pep-0448/ diff --git a/pybind11/docs/advanced/pycpp/utilities.rst b/pybind11/docs/advanced/pycpp/utilities.rst new file mode 100644 index 0000000000000000000000000000000000000000..369e7c94dbd69f3ce7bb2d837a53ea2853a04efc --- /dev/null +++ b/pybind11/docs/advanced/pycpp/utilities.rst @@ -0,0 +1,144 @@ +Utilities +######### + +Using Python's print function in C++ +==================================== + +The usual way to write output in C++ is using ``std::cout`` while in Python one +would use ``print``. Since these methods use different buffers, mixing them can +lead to output order issues. To resolve this, pybind11 modules can use the +:func:`py::print` function which writes to Python's ``sys.stdout`` for consistency. + +Python's ``print`` function is replicated in the C++ API including optional +keyword arguments ``sep``, ``end``, ``file``, ``flush``. Everything works as +expected in Python: + +.. code-block:: cpp + + py::print(1, 2.0, "three"); // 1 2.0 three + py::print(1, 2.0, "three", "sep"_a="-"); // 1-2.0-three + + auto args = py::make_tuple("unpacked", true); + py::print("->", *args, "end"_a="<-"); // -> unpacked True <- + +.. _ostream_redirect: + +Capturing standard output from ostream +====================================== + +Often, a library will use the streams ``std::cout`` and ``std::cerr`` to print, +but this does not play well with Python's standard ``sys.stdout`` and ``sys.stderr`` +redirection. Replacing a library's printing with `py::print <print>` may not +be feasible. This can be fixed using a guard around the library function that +redirects output to the corresponding Python streams: + +.. code-block:: cpp + + #include <pybind11/iostream.h> + + ... + + // Add a scoped redirect for your noisy code + m.def("noisy_func", []() { + py::scoped_ostream_redirect stream( + std::cout, // std::ostream& + py::module::import("sys").attr("stdout") // Python output + ); + call_noisy_func(); + }); + +This method respects flushes on the output streams and will flush if needed +when the scoped guard is destroyed. This allows the output to be redirected in +real time, such as to a Jupyter notebook. The two arguments, the C++ stream and +the Python output, are optional, and default to standard output if not given. An +extra type, `py::scoped_estream_redirect <scoped_estream_redirect>`, is identical +except for defaulting to ``std::cerr`` and ``sys.stderr``; this can be useful with +`py::call_guard`, which allows multiple items, but uses the default constructor: + +.. code-block:: py + + // Alternative: Call single function using call guard + m.def("noisy_func", &call_noisy_function, + py::call_guard<py::scoped_ostream_redirect, + py::scoped_estream_redirect>()); + +The redirection can also be done in Python with the addition of a context +manager, using the `py::add_ostream_redirect() <add_ostream_redirect>` function: + +.. code-block:: cpp + + py::add_ostream_redirect(m, "ostream_redirect"); + +The name in Python defaults to ``ostream_redirect`` if no name is passed. This +creates the following context manager in Python: + +.. code-block:: python + + with ostream_redirect(stdout=True, stderr=True): + noisy_function() + +It defaults to redirecting both streams, though you can use the keyword +arguments to disable one of the streams if needed. + +.. note:: + + The above methods will not redirect C-level output to file descriptors, such + as ``fprintf``. For those cases, you'll need to redirect the file + descriptors either directly in C or with Python's ``os.dup2`` function + in an operating-system dependent way. + +.. _eval: + +Evaluating Python expressions from strings and files +==================================================== + +pybind11 provides the `eval`, `exec` and `eval_file` functions to evaluate +Python expressions and statements. The following example illustrates how they +can be used. + +.. code-block:: cpp + + // At beginning of file + #include <pybind11/eval.h> + + ... + + // Evaluate in scope of main module + py::object scope = py::module::import("__main__").attr("__dict__"); + + // Evaluate an isolated expression + int result = py::eval("my_variable + 10", scope).cast<int>(); + + // Evaluate a sequence of statements + py::exec( + "print('Hello')\n" + "print('world!');", + scope); + + // Evaluate the statements in an separate Python file on disk + py::eval_file("script.py", scope); + +C++11 raw string literals are also supported and quite handy for this purpose. +The only requirement is that the first statement must be on a new line following +the raw string delimiter ``R"(``, ensuring all lines have common leading indent: + +.. code-block:: cpp + + py::exec(R"( + x = get_answer() + if x == 42: + print('Hello World!') + else: + print('Bye!') + )", scope + ); + +.. note:: + + `eval` and `eval_file` accept a template parameter that describes how the + string/file should be interpreted. Possible choices include ``eval_expr`` + (isolated expression), ``eval_single_statement`` (a single statement, return + value is always ``none``), and ``eval_statements`` (sequence of statements, + return value is always ``none``). `eval` defaults to ``eval_expr``, + `eval_file` defaults to ``eval_statements`` and `exec` is just a shortcut + for ``eval<eval_statements>``. diff --git a/pybind11/docs/advanced/smart_ptrs.rst b/pybind11/docs/advanced/smart_ptrs.rst new file mode 100644 index 0000000000000000000000000000000000000000..da57748ca585a92000198a6c607a087704b1f07c --- /dev/null +++ b/pybind11/docs/advanced/smart_ptrs.rst @@ -0,0 +1,173 @@ +Smart pointers +############## + +std::unique_ptr +=============== + +Given a class ``Example`` with Python bindings, it's possible to return +instances wrapped in C++11 unique pointers, like so + +.. code-block:: cpp + + std::unique_ptr<Example> create_example() { return std::unique_ptr<Example>(new Example()); } + +.. code-block:: cpp + + m.def("create_example", &create_example); + +In other words, there is nothing special that needs to be done. While returning +unique pointers in this way is allowed, it is *illegal* to use them as function +arguments. For instance, the following function signature cannot be processed +by pybind11. + +.. code-block:: cpp + + void do_something_with_example(std::unique_ptr<Example> ex) { ... } + +The above signature would imply that Python needs to give up ownership of an +object that is passed to this function, which is generally not possible (for +instance, the object might be referenced elsewhere). + +std::shared_ptr +=============== + +The binding generator for classes, :class:`class_`, can be passed a template +type that denotes a special *holder* type that is used to manage references to +the object. If no such holder type template argument is given, the default for +a type named ``Type`` is ``std::unique_ptr<Type>``, which means that the object +is deallocated when Python's reference count goes to zero. + +It is possible to switch to other types of reference counting wrappers or smart +pointers, which is useful in codebases that rely on them. For instance, the +following snippet causes ``std::shared_ptr`` to be used instead. + +.. code-block:: cpp + + py::class_<Example, std::shared_ptr<Example> /* <- holder type */> obj(m, "Example"); + +Note that any particular class can only be associated with a single holder type. + +One potential stumbling block when using holder types is that they need to be +applied consistently. Can you guess what's broken about the following binding +code? + +.. code-block:: cpp + + class Child { }; + + class Parent { + public: + Parent() : child(std::make_shared<Child>()) { } + Child *get_child() { return child.get(); } /* Hint: ** DON'T DO THIS ** */ + private: + std::shared_ptr<Child> child; + }; + + PYBIND11_MODULE(example, m) { + py::class_<Child, std::shared_ptr<Child>>(m, "Child"); + + py::class_<Parent, std::shared_ptr<Parent>>(m, "Parent") + .def(py::init<>()) + .def("get_child", &Parent::get_child); + } + +The following Python code will cause undefined behavior (and likely a +segmentation fault). + +.. code-block:: python + + from example import Parent + print(Parent().get_child()) + +The problem is that ``Parent::get_child()`` returns a pointer to an instance of +``Child``, but the fact that this instance is already managed by +``std::shared_ptr<...>`` is lost when passing raw pointers. In this case, +pybind11 will create a second independent ``std::shared_ptr<...>`` that also +claims ownership of the pointer. In the end, the object will be freed **twice** +since these shared pointers have no way of knowing about each other. + +There are two ways to resolve this issue: + +1. For types that are managed by a smart pointer class, never use raw pointers + in function arguments or return values. In other words: always consistently + wrap pointers into their designated holder types (such as + ``std::shared_ptr<...>``). In this case, the signature of ``get_child()`` + should be modified as follows: + +.. code-block:: cpp + + std::shared_ptr<Child> get_child() { return child; } + +2. Adjust the definition of ``Child`` by specifying + ``std::enable_shared_from_this<T>`` (see cppreference_ for details) as a + base class. This adds a small bit of information to ``Child`` that allows + pybind11 to realize that there is already an existing + ``std::shared_ptr<...>`` and communicate with it. In this case, the + declaration of ``Child`` should look as follows: + +.. _cppreference: http://en.cppreference.com/w/cpp/memory/enable_shared_from_this + +.. code-block:: cpp + + class Child : public std::enable_shared_from_this<Child> { }; + +.. _smart_pointers: + +Custom smart pointers +===================== + +pybind11 supports ``std::unique_ptr`` and ``std::shared_ptr`` right out of the +box. For any other custom smart pointer, transparent conversions can be enabled +using a macro invocation similar to the following. It must be declared at the +top namespace level before any binding code: + +.. code-block:: cpp + + PYBIND11_DECLARE_HOLDER_TYPE(T, SmartPtr<T>); + +The first argument of :func:`PYBIND11_DECLARE_HOLDER_TYPE` should be a +placeholder name that is used as a template parameter of the second argument. +Thus, feel free to use any identifier, but use it consistently on both sides; +also, don't use the name of a type that already exists in your codebase. + +The macro also accepts a third optional boolean parameter that is set to false +by default. Specify + +.. code-block:: cpp + + PYBIND11_DECLARE_HOLDER_TYPE(T, SmartPtr<T>, true); + +if ``SmartPtr<T>`` can always be initialized from a ``T*`` pointer without the +risk of inconsistencies (such as multiple independent ``SmartPtr`` instances +believing that they are the sole owner of the ``T*`` pointer). A common +situation where ``true`` should be passed is when the ``T`` instances use +*intrusive* reference counting. + +Please take a look at the :ref:`macro_notes` before using this feature. + +By default, pybind11 assumes that your custom smart pointer has a standard +interface, i.e. provides a ``.get()`` member function to access the underlying +raw pointer. If this is not the case, pybind11's ``holder_helper`` must be +specialized: + +.. code-block:: cpp + + // Always needed for custom holder types + PYBIND11_DECLARE_HOLDER_TYPE(T, SmartPtr<T>); + + // Only needed if the type's `.get()` goes by another name + namespace pybind11 { namespace detail { + template <typename T> + struct holder_helper<SmartPtr<T>> { // <-- specialization + static const T *get(const SmartPtr<T> &p) { return p.getPointer(); } + }; + }} + +The above specialization informs pybind11 that the custom ``SmartPtr`` class +provides ``.get()`` functionality via ``.getPointer()``. + +.. seealso:: + + The file :file:`tests/test_smart_ptr.cpp` contains a complete example + that demonstrates how to work with custom reference-counting holder types + in more detail. diff --git a/pybind11/docs/basics.rst b/pybind11/docs/basics.rst new file mode 100644 index 0000000000000000000000000000000000000000..447250ed9e88dbe09cc7d06329e021761103b038 --- /dev/null +++ b/pybind11/docs/basics.rst @@ -0,0 +1,293 @@ +.. _basics: + +First steps +########### + +This sections demonstrates the basic features of pybind11. Before getting +started, make sure that development environment is set up to compile the +included set of test cases. + + +Compiling the test cases +======================== + +Linux/MacOS +----------- + +On Linux you'll need to install the **python-dev** or **python3-dev** packages as +well as **cmake**. On Mac OS, the included python version works out of the box, +but **cmake** must still be installed. + +After installing the prerequisites, run + +.. code-block:: bash + + mkdir build + cd build + cmake .. + make check -j 4 + +The last line will both compile and run the tests. + +Windows +------- + +On Windows, only **Visual Studio 2015** and newer are supported since pybind11 relies +on various C++11 language features that break older versions of Visual Studio. + +To compile and run the tests: + +.. code-block:: batch + + mkdir build + cd build + cmake .. + cmake --build . --config Release --target check + +This will create a Visual Studio project, compile and run the target, all from the +command line. + +.. Note:: + + If all tests fail, make sure that the Python binary and the testcases are compiled + for the same processor type and bitness (i.e. either **i386** or **x86_64**). You + can specify **x86_64** as the target architecture for the generated Visual Studio + project using ``cmake -A x64 ..``. + +.. seealso:: + + Advanced users who are already familiar with Boost.Python may want to skip + the tutorial and look at the test cases in the :file:`tests` directory, + which exercise all features of pybind11. + +Header and namespace conventions +================================ + +For brevity, all code examples assume that the following two lines are present: + +.. code-block:: cpp + + #include <pybind11/pybind11.h> + + namespace py = pybind11; + +Some features may require additional headers, but those will be specified as needed. + +.. _simple_example: + +Creating bindings for a simple function +======================================= + +Let's start by creating Python bindings for an extremely simple function, which +adds two numbers and returns their result: + +.. code-block:: cpp + + int add(int i, int j) { + return i + j; + } + +For simplicity [#f1]_, we'll put both this function and the binding code into +a file named :file:`example.cpp` with the following contents: + +.. code-block:: cpp + + #include <pybind11/pybind11.h> + + int add(int i, int j) { + return i + j; + } + + PYBIND11_MODULE(example, m) { + m.doc() = "pybind11 example plugin"; // optional module docstring + + m.def("add", &add, "A function which adds two numbers"); + } + +.. [#f1] In practice, implementation and binding code will generally be located + in separate files. + +The :func:`PYBIND11_MODULE` macro creates a function that will be called when an +``import`` statement is issued from within Python. The module name (``example``) +is given as the first macro argument (it should not be in quotes). The second +argument (``m``) defines a variable of type :class:`py::module <module>` which +is the main interface for creating bindings. The method :func:`module::def` +generates binding code that exposes the ``add()`` function to Python. + +.. note:: + + Notice how little code was needed to expose our function to Python: all + details regarding the function's parameters and return value were + automatically inferred using template metaprogramming. This overall + approach and the used syntax are borrowed from Boost.Python, though the + underlying implementation is very different. + +pybind11 is a header-only library, hence it is not necessary to link against +any special libraries and there are no intermediate (magic) translation steps. +On Linux, the above example can be compiled using the following command: + +.. code-block:: bash + + $ c++ -O3 -Wall -shared -std=c++11 -fPIC `python3 -m pybind11 --includes` example.cpp -o example`python3-config --extension-suffix` + +For more details on the required compiler flags on Linux and MacOS, see +:ref:`building_manually`. For complete cross-platform compilation instructions, +refer to the :ref:`compiling` page. + +The `python_example`_ and `cmake_example`_ repositories are also a good place +to start. They are both complete project examples with cross-platform build +systems. The only difference between the two is that `python_example`_ uses +Python's ``setuptools`` to build the module, while `cmake_example`_ uses CMake +(which may be preferable for existing C++ projects). + +.. _python_example: https://github.com/pybind/python_example +.. _cmake_example: https://github.com/pybind/cmake_example + +Building the above C++ code will produce a binary module file that can be +imported to Python. Assuming that the compiled module is located in the +current directory, the following interactive Python session shows how to +load and execute the example: + +.. code-block:: pycon + + $ python + Python 2.7.10 (default, Aug 22 2015, 20:33:39) + [GCC 4.2.1 Compatible Apple LLVM 7.0.0 (clang-700.0.59.1)] on darwin + Type "help", "copyright", "credits" or "license" for more information. + >>> import example + >>> example.add(1, 2) + 3L + >>> + +.. _keyword_args: + +Keyword arguments +================= + +With a simple modification code, it is possible to inform Python about the +names of the arguments ("i" and "j" in this case). + +.. code-block:: cpp + + m.def("add", &add, "A function which adds two numbers", + py::arg("i"), py::arg("j")); + +:class:`arg` is one of several special tag classes which can be used to pass +metadata into :func:`module::def`. With this modified binding code, we can now +call the function using keyword arguments, which is a more readable alternative +particularly for functions taking many parameters: + +.. code-block:: pycon + + >>> import example + >>> example.add(i=1, j=2) + 3L + +The keyword names also appear in the function signatures within the documentation. + +.. code-block:: pycon + + >>> help(example) + + .... + + FUNCTIONS + add(...) + Signature : (i: int, j: int) -> int + + A function which adds two numbers + +A shorter notation for named arguments is also available: + +.. code-block:: cpp + + // regular notation + m.def("add1", &add, py::arg("i"), py::arg("j")); + // shorthand + using namespace pybind11::literals; + m.def("add2", &add, "i"_a, "j"_a); + +The :var:`_a` suffix forms a C++11 literal which is equivalent to :class:`arg`. +Note that the literal operator must first be made visible with the directive +``using namespace pybind11::literals``. This does not bring in anything else +from the ``pybind11`` namespace except for literals. + +.. _default_args: + +Default arguments +================= + +Suppose now that the function to be bound has default arguments, e.g.: + +.. code-block:: cpp + + int add(int i = 1, int j = 2) { + return i + j; + } + +Unfortunately, pybind11 cannot automatically extract these parameters, since they +are not part of the function's type information. However, they are simple to specify +using an extension of :class:`arg`: + +.. code-block:: cpp + + m.def("add", &add, "A function which adds two numbers", + py::arg("i") = 1, py::arg("j") = 2); + +The default values also appear within the documentation. + +.. code-block:: pycon + + >>> help(example) + + .... + + FUNCTIONS + add(...) + Signature : (i: int = 1, j: int = 2) -> int + + A function which adds two numbers + +The shorthand notation is also available for default arguments: + +.. code-block:: cpp + + // regular notation + m.def("add1", &add, py::arg("i") = 1, py::arg("j") = 2); + // shorthand + m.def("add2", &add, "i"_a=1, "j"_a=2); + +Exporting variables +=================== + +To expose a value from C++, use the ``attr`` function to register it in a +module as shown below. Built-in types and general objects (more on that later) +are automatically converted when assigned as attributes, and can be explicitly +converted using the function ``py::cast``. + +.. code-block:: cpp + + PYBIND11_MODULE(example, m) { + m.attr("the_answer") = 42; + py::object world = py::cast("World"); + m.attr("what") = world; + } + +These are then accessible from Python: + +.. code-block:: pycon + + >>> import example + >>> example.the_answer + 42 + >>> example.what + 'World' + +.. _supported_types: + +Supported data types +==================== + +A large number of data types are supported out of the box and can be used +seamlessly as functions arguments, return values or with ``py::cast`` in general. +For a full overview, see the :doc:`advanced/cast/index` section. diff --git a/pybind11/docs/benchmark.py b/pybind11/docs/benchmark.py new file mode 100644 index 0000000000000000000000000000000000000000..a25fa3e9143f3b3e4f1347472877b75c236ca339 --- /dev/null +++ b/pybind11/docs/benchmark.py @@ -0,0 +1,88 @@ +import random +import os +import time +import datetime as dt + +nfns = 4 # Functions per class +nargs = 4 # Arguments per function + + +def generate_dummy_code_pybind11(nclasses=10): + decl = "" + bindings = "" + + for cl in range(nclasses): + decl += "class cl%03i;\n" % cl + decl += '\n' + + for cl in range(nclasses): + decl += "class cl%03i {\n" % cl + decl += "public:\n" + bindings += ' py::class_<cl%03i>(m, "cl%03i")\n' % (cl, cl) + for fn in range(nfns): + ret = random.randint(0, nclasses - 1) + params = [random.randint(0, nclasses - 1) for i in range(nargs)] + decl += " cl%03i *fn_%03i(" % (ret, fn) + decl += ", ".join("cl%03i *" % p for p in params) + decl += ");\n" + bindings += ' .def("fn_%03i", &cl%03i::fn_%03i)\n' % \ + (fn, cl, fn) + decl += "};\n\n" + bindings += ' ;\n' + + result = "#include <pybind11/pybind11.h>\n\n" + result += "namespace py = pybind11;\n\n" + result += decl + '\n' + result += "PYBIND11_MODULE(example, m) {\n" + result += bindings + result += "}" + return result + + +def generate_dummy_code_boost(nclasses=10): + decl = "" + bindings = "" + + for cl in range(nclasses): + decl += "class cl%03i;\n" % cl + decl += '\n' + + for cl in range(nclasses): + decl += "class cl%03i {\n" % cl + decl += "public:\n" + bindings += ' py::class_<cl%03i>("cl%03i")\n' % (cl, cl) + for fn in range(nfns): + ret = random.randint(0, nclasses - 1) + params = [random.randint(0, nclasses - 1) for i in range(nargs)] + decl += " cl%03i *fn_%03i(" % (ret, fn) + decl += ", ".join("cl%03i *" % p for p in params) + decl += ");\n" + bindings += ' .def("fn_%03i", &cl%03i::fn_%03i, py::return_value_policy<py::manage_new_object>())\n' % \ + (fn, cl, fn) + decl += "};\n\n" + bindings += ' ;\n' + + result = "#include <boost/python.hpp>\n\n" + result += "namespace py = boost::python;\n\n" + result += decl + '\n' + result += "BOOST_PYTHON_MODULE(example) {\n" + result += bindings + result += "}" + return result + + +for codegen in [generate_dummy_code_pybind11, generate_dummy_code_boost]: + print("{") + for i in range(0, 10): + nclasses = 2**i + with open("test.cpp", "w") as f: + f.write(codegen(nclasses)) + n1 = dt.datetime.now() + os.system("g++ -Os -shared -rdynamic -undefined dynamic_lookup " + "-fvisibility=hidden -std=c++14 test.cpp -I include " + "-I /System/Library/Frameworks/Python.framework/Headers -o test.so") + n2 = dt.datetime.now() + elapsed = (n2 - n1).total_seconds() + size = os.stat('test.so').st_size + print(" {%i, %f, %i}," % (nclasses * nfns, elapsed, size)) + print("}") diff --git a/pybind11/docs/benchmark.rst b/pybind11/docs/benchmark.rst new file mode 100644 index 0000000000000000000000000000000000000000..59d533df9480c541b8fa9d6ba1e57b4c14a371aa --- /dev/null +++ b/pybind11/docs/benchmark.rst @@ -0,0 +1,97 @@ +Benchmark +========= + +The following is the result of a synthetic benchmark comparing both compilation +time and module size of pybind11 against Boost.Python. A detailed report about a +Boost.Python to pybind11 conversion of a real project is available here: [#f1]_. + +.. [#f1] http://graylab.jhu.edu/RosettaCon2016/PyRosetta-4.pdf + +Setup +----- + +A python script (see the ``docs/benchmark.py`` file) was used to generate a set +of files with dummy classes whose count increases for each successive benchmark +(between 1 and 2048 classes in powers of two). Each class has four methods with +a randomly generated signature with a return value and four arguments. (There +was no particular reason for this setup other than the desire to generate many +unique function signatures whose count could be controlled in a simple way.) + +Here is an example of the binding code for one class: + +.. code-block:: cpp + + ... + class cl034 { + public: + cl279 *fn_000(cl084 *, cl057 *, cl065 *, cl042 *); + cl025 *fn_001(cl098 *, cl262 *, cl414 *, cl121 *); + cl085 *fn_002(cl445 *, cl297 *, cl145 *, cl421 *); + cl470 *fn_003(cl200 *, cl323 *, cl332 *, cl492 *); + }; + ... + + PYBIND11_MODULE(example, m) { + ... + py::class_<cl034>(m, "cl034") + .def("fn_000", &cl034::fn_000) + .def("fn_001", &cl034::fn_001) + .def("fn_002", &cl034::fn_002) + .def("fn_003", &cl034::fn_003) + ... + } + +The Boost.Python version looks almost identical except that a return value +policy had to be specified as an argument to ``def()``. For both libraries, +compilation was done with + +.. code-block:: bash + + Apple LLVM version 7.0.2 (clang-700.1.81) + +and the following compilation flags + +.. code-block:: bash + + g++ -Os -shared -rdynamic -undefined dynamic_lookup -fvisibility=hidden -std=c++14 + +Compilation time +---------------- + +The following log-log plot shows how the compilation time grows for an +increasing number of class and function declarations. pybind11 includes many +fewer headers, which initially leads to shorter compilation times, but the +performance is ultimately fairly similar (pybind11 is 19.8 seconds faster for +the largest largest file with 2048 classes and a total of 8192 methods -- a +modest **1.2x** speedup relative to Boost.Python, which required 116.35 +seconds). + +.. only:: not latex + + .. image:: pybind11_vs_boost_python1.svg + +.. only:: latex + + .. image:: pybind11_vs_boost_python1.png + +Module size +----------- + +Differences between the two libraries become much more pronounced when +considering the file size of the generated Python plugin: for the largest file, +the binary generated by Boost.Python required 16.8 MiB, which was **2.17 +times** / **9.1 megabytes** larger than the output generated by pybind11. For +very small inputs, Boost.Python has an edge in the plot below -- however, note +that it stores many definitions in an external library, whose size was not +included here, hence the comparison is slightly shifted in Boost.Python's +favor. + +.. only:: not latex + + .. image:: pybind11_vs_boost_python2.svg + +.. only:: latex + + .. image:: pybind11_vs_boost_python2.png + + diff --git a/pybind11/docs/changelog.rst b/pybind11/docs/changelog.rst new file mode 100644 index 0000000000000000000000000000000000000000..f99d3516a90122e5e70242e156b9ad82ffd30461 --- /dev/null +++ b/pybind11/docs/changelog.rst @@ -0,0 +1,1158 @@ +.. _changelog: + +Changelog +######### + +Starting with version 1.8.0, pybind11 releases use a `semantic versioning +<http://semver.org>`_ policy. + + +v2.3.1 (Not yet released) +----------------------------------------------------- + +* TBA + +v2.3.0 (June 11, 2019) +----------------------------------------------------- + +* Significantly reduced module binary size (10-20%) when compiled in C++11 mode + with GCC/Clang, or in any mode with MSVC. Function signatures are now always + precomputed at compile time (this was previously only available in C++14 mode + for non-MSVC compilers). + `#934 <https://github.com/pybind/pybind11/pull/934>`_. + +* Add basic support for tag-based static polymorphism, where classes + provide a method to returns the desired type of an instance. + `#1326 <https://github.com/pybind/pybind11/pull/1326>`_. + +* Python type wrappers (``py::handle``, ``py::object``, etc.) + now support map Python's number protocol onto C++ arithmetic + operators such as ``operator+``, ``operator/=``, etc. + `#1511 <https://github.com/pybind/pybind11/pull/1511>`_. + +* A number of improvements related to enumerations: + + 1. The ``enum_`` implementation was rewritten from scratch to reduce + code bloat. Rather than instantiating a full implementation for each + enumeration, most code is now contained in a generic base class. + `#1511 <https://github.com/pybind/pybind11/pull/1511>`_. + + 2. The ``value()`` method of ``py::enum_`` now accepts an optional + docstring that will be shown in the documentation of the associated + enumeration. `#1160 <https://github.com/pybind/pybind11/pull/1160>`_. + + 3. check for already existing enum value and throw an error if present. + `#1453 <https://github.com/pybind/pybind11/pull/1453>`_. + +* Support for over-aligned type allocation via C++17's aligned ``new`` + statement. `#1582 <https://github.com/pybind/pybind11/pull/1582>`_. + +* Added ``py::ellipsis()`` method for slicing of multidimensional NumPy arrays + `#1502 <https://github.com/pybind/pybind11/pull/1502>`_. + +* Numerous Improvements to the ``mkdoc.py`` script for extracting documentation + from C++ header files. + `#1788 <https://github.com/pybind/pybind11/pull/1788>`_. + +* ``pybind11_add_module()``: allow including Python as a ``SYSTEM`` include path. + `#1416 <https://github.com/pybind/pybind11/pull/1416>`_. + +* ``pybind11/stl.h`` does not convert strings to ``vector<string>`` anymore. + `#1258 <https://github.com/pybind/pybind11/issues/1258>`_. + +* Mark static methods as such to fix auto-generated Sphinx documentation. + `#1732 <https://github.com/pybind/pybind11/pull/1732>`_. + +* Re-throw forced unwind exceptions (e.g. during pthread termination). + `#1208 <https://github.com/pybind/pybind11/pull/1208>`_. + +* Added ``__contains__`` method to the bindings of maps (``std::map``, + ``std::unordered_map``). + `#1767 <https://github.com/pybind/pybind11/pull/1767>`_. + +* Improvements to ``gil_scoped_acquire``. + `#1211 <https://github.com/pybind/pybind11/pull/1211>`_. + +* Type caster support for ``std::deque<T>``. + `#1609 <https://github.com/pybind/pybind11/pull/1609>`_. + +* Support for ``std::unique_ptr`` holders, whose deleters differ between a base and derived + class. `#1353 <https://github.com/pybind/pybind11/pull/1353>`_. + +* Construction of STL array/vector-like data structures from + iterators. Added an ``extend()`` operation. + `#1709 <https://github.com/pybind/pybind11/pull/1709>`_, + +* CMake build system improvements for projects that include non-C++ + files (e.g. plain C, CUDA) in ``pybind11_add_module`` et al. + `#1678 <https://github.com/pybind/pybind11/pull/1678>`_. + +* Fixed asynchronous invocation and deallocation of Python functions + wrapped in ``std::function``. + `#1595 <https://github.com/pybind/pybind11/pull/1595>`_. + +* Fixes regarding return value policy propagation in STL type casters. + `#1603 <https://github.com/pybind/pybind11/pull/1603>`_. + +* Fixed scoped enum comparisons. + `#1571 <https://github.com/pybind/pybind11/pull/1571>`_. + +* Fixed iostream redirection for code that releases the GIL. + `#1368 <https://github.com/pybind/pybind11/pull/1368>`_, + +* A number of CI-related fixes. + `#1757 <https://github.com/pybind/pybind11/pull/1757>`_, + `#1744 <https://github.com/pybind/pybind11/pull/1744>`_, + `#1670 <https://github.com/pybind/pybind11/pull/1670>`_. + + +v2.2.4 (September 11, 2018) +----------------------------------------------------- + +* Use new Python 3.7 Thread Specific Storage (TSS) implementation if available. + `#1454 <https://github.com/pybind/pybind11/pull/1454>`_, + `#1517 <https://github.com/pybind/pybind11/pull/1517>`_. + +* Fixes for newer MSVC versions and C++17 mode. + `#1347 <https://github.com/pybind/pybind11/pull/1347>`_, + `#1462 <https://github.com/pybind/pybind11/pull/1462>`_. + +* Propagate return value policies to type-specific casters + when casting STL containers. + `#1455 <https://github.com/pybind/pybind11/pull/1455>`_. + +* Allow ostream-redirection of more than 1024 characters. + `#1479 <https://github.com/pybind/pybind11/pull/1479>`_. + +* Set ``Py_DEBUG`` define when compiling against a debug Python build. + `#1438 <https://github.com/pybind/pybind11/pull/1438>`_. + +* Untangle integer logic in number type caster to work for custom + types that may only be castable to a restricted set of builtin types. + `#1442 <https://github.com/pybind/pybind11/pull/1442>`_. + +* CMake build system: Remember Python version in cache file. + `#1434 <https://github.com/pybind/pybind11/pull/1434>`_. + +* Fix for custom smart pointers: use ``std::addressof`` to obtain holder + address instead of ``operator&``. + `#1435 <https://github.com/pybind/pybind11/pull/1435>`_. + +* Properly report exceptions thrown during module initialization. + `#1362 <https://github.com/pybind/pybind11/pull/1362>`_. + +* Fixed a segmentation fault when creating empty-shaped NumPy array. + `#1371 <https://github.com/pybind/pybind11/pull/1371>`_. + +* The version of Intel C++ compiler must be >= 2017, and this is now checked by + the header files. `#1363 <https://github.com/pybind/pybind11/pull/1363>`_. + +* A few minor typo fixes and improvements to the test suite, and + patches that silence compiler warnings. + +* Vectors now support construction from generators, as well as ``extend()`` from a + list or generator. + `#1496 <https://github.com/pybind/pybind11/pull/1496>`_. + + +v2.2.3 (April 29, 2018) +----------------------------------------------------- + +* The pybind11 header location detection was replaced by a new implementation + that no longer depends on ``pip`` internals (the recently released ``pip`` + 10 has restricted access to this API). + `#1190 <https://github.com/pybind/pybind11/pull/1190>`_. + +* Small adjustment to an implementation detail to work around a compiler segmentation fault in Clang 3.3/3.4. + `#1350 <https://github.com/pybind/pybind11/pull/1350>`_. + +* The minimal supported version of the Intel compiler was >= 17.0 since + pybind11 v2.1. This check is now explicit, and a compile-time error is raised + if the compiler meet the requirement. + `#1363 <https://github.com/pybind/pybind11/pull/1363>`_. + +* Fixed an endianness-related fault in the test suite. + `#1287 <https://github.com/pybind/pybind11/pull/1287>`_. + +v2.2.2 (February 7, 2018) +----------------------------------------------------- + +* Fixed a segfault when combining embedded interpreter + shutdown/reinitialization with external loaded pybind11 modules. + `#1092 <https://github.com/pybind/pybind11/pull/1092>`_. + +* Eigen support: fixed a bug where Nx1/1xN numpy inputs couldn't be passed as + arguments to Eigen vectors (which for Eigen are simply compile-time fixed + Nx1/1xN matrices). + `#1106 <https://github.com/pybind/pybind11/pull/1106>`_. + +* Clarified to license by moving the licensing of contributions from + ``LICENSE`` into ``CONTRIBUTING.md``: the licensing of contributions is not + actually part of the software license as distributed. This isn't meant to be + a substantial change in the licensing of the project, but addresses concerns + that the clause made the license non-standard. + `#1109 <https://github.com/pybind/pybind11/issues/1109>`_. + +* Fixed a regression introduced in 2.1 that broke binding functions with lvalue + character literal arguments. + `#1128 <https://github.com/pybind/pybind11/pull/1128>`_. + +* MSVC: fix for compilation failures under /permissive-, and added the flag to + the appveyor test suite. + `#1155 <https://github.com/pybind/pybind11/pull/1155>`_. + +* Fixed ``__qualname__`` generation, and in turn, fixes how class names + (especially nested class names) are shown in generated docstrings. + `#1171 <https://github.com/pybind/pybind11/pull/1171>`_. + +* Updated the FAQ with a suggested project citation reference. + `#1189 <https://github.com/pybind/pybind11/pull/1189>`_. + +* Added fixes for deprecation warnings when compiled under C++17 with + ``-Wdeprecated`` turned on, and add ``-Wdeprecated`` to the test suite + compilation flags. + `#1191 <https://github.com/pybind/pybind11/pull/1191>`_. + +* Fixed outdated PyPI URLs in ``setup.py``. + `#1213 <https://github.com/pybind/pybind11/pull/1213>`_. + +* Fixed a refcount leak for arguments that end up in a ``py::args`` argument + for functions with both fixed positional and ``py::args`` arguments. + `#1216 <https://github.com/pybind/pybind11/pull/1216>`_. + +* Fixed a potential segfault resulting from possible premature destruction of + ``py::args``/``py::kwargs`` arguments with overloaded functions. + `#1223 <https://github.com/pybind/pybind11/pull/1223>`_. + +* Fixed ``del map[item]`` for a ``stl_bind.h`` bound stl map. + `#1229 <https://github.com/pybind/pybind11/pull/1229>`_. + +* Fixed a regression from v2.1.x where the aggregate initialization could + unintentionally end up at a constructor taking a templated + ``std::initializer_list<T>`` argument. + `#1249 <https://github.com/pybind/pybind11/pull/1249>`_. + +* Fixed an issue where calling a function with a keep_alive policy on the same + nurse/patient pair would cause the internal patient storage to needlessly + grow (unboundedly, if the nurse is long-lived). + `#1251 <https://github.com/pybind/pybind11/issues/1251>`_. + +* Various other minor fixes. + +v2.2.1 (September 14, 2017) +----------------------------------------------------- + +* Added ``py::module::reload()`` member function for reloading a module. + `#1040 <https://github.com/pybind/pybind11/pull/1040>`_. + +* Fixed a reference leak in the number converter. + `#1078 <https://github.com/pybind/pybind11/pull/1078>`_. + +* Fixed compilation with Clang on host GCC < 5 (old libstdc++ which isn't fully + C++11 compliant). `#1062 <https://github.com/pybind/pybind11/pull/1062>`_. + +* Fixed a regression where the automatic ``std::vector<bool>`` caster would + fail to compile. The same fix also applies to any container which returns + element proxies instead of references. + `#1053 <https://github.com/pybind/pybind11/pull/1053>`_. + +* Fixed a regression where the ``py::keep_alive`` policy could not be applied + to constructors. `#1065 <https://github.com/pybind/pybind11/pull/1065>`_. + +* Fixed a nullptr dereference when loading a ``py::module_local`` type + that's only registered in an external module. + `#1058 <https://github.com/pybind/pybind11/pull/1058>`_. + +* Fixed implicit conversion of accessors to types derived from ``py::object``. + `#1076 <https://github.com/pybind/pybind11/pull/1076>`_. + +* The ``name`` in ``PYBIND11_MODULE(name, variable)`` can now be a macro. + `#1082 <https://github.com/pybind/pybind11/pull/1082>`_. + +* Relaxed overly strict ``py::pickle()`` check for matching get and set types. + `#1064 <https://github.com/pybind/pybind11/pull/1064>`_. + +* Conversion errors now try to be more informative when it's likely that + a missing header is the cause (e.g. forgetting ``<pybind11/stl.h>``). + `#1077 <https://github.com/pybind/pybind11/pull/1077>`_. + +v2.2.0 (August 31, 2017) +----------------------------------------------------- + +* Support for embedding the Python interpreter. See the + :doc:`documentation page </advanced/embedding>` for a + full overview of the new features. + `#774 <https://github.com/pybind/pybind11/pull/774>`_, + `#889 <https://github.com/pybind/pybind11/pull/889>`_, + `#892 <https://github.com/pybind/pybind11/pull/892>`_, + `#920 <https://github.com/pybind/pybind11/pull/920>`_. + + .. code-block:: cpp + + #include <pybind11/embed.h> + namespace py = pybind11; + + int main() { + py::scoped_interpreter guard{}; // start the interpreter and keep it alive + + py::print("Hello, World!"); // use the Python API + } + +* Support for inheriting from multiple C++ bases in Python. + `#693 <https://github.com/pybind/pybind11/pull/693>`_. + + .. code-block:: python + + from cpp_module import CppBase1, CppBase2 + + class PyDerived(CppBase1, CppBase2): + def __init__(self): + CppBase1.__init__(self) # C++ bases must be initialized explicitly + CppBase2.__init__(self) + +* ``PYBIND11_MODULE`` is now the preferred way to create module entry points. + ``PYBIND11_PLUGIN`` is deprecated. See :ref:`macros` for details. + `#879 <https://github.com/pybind/pybind11/pull/879>`_. + + .. code-block:: cpp + + // new + PYBIND11_MODULE(example, m) { + m.def("add", [](int a, int b) { return a + b; }); + } + + // old + PYBIND11_PLUGIN(example) { + py::module m("example"); + m.def("add", [](int a, int b) { return a + b; }); + return m.ptr(); + } + +* pybind11's headers and build system now more strictly enforce hidden symbol + visibility for extension modules. This should be seamless for most users, + but see the :doc:`upgrade` if you use a custom build system. + `#995 <https://github.com/pybind/pybind11/pull/995>`_. + +* Support for ``py::module_local`` types which allow multiple modules to + export the same C++ types without conflicts. This is useful for opaque + types like ``std::vector<int>``. ``py::bind_vector`` and ``py::bind_map`` + now default to ``py::module_local`` if their elements are builtins or + local types. See :ref:`module_local` for details. + `#949 <https://github.com/pybind/pybind11/pull/949>`_, + `#981 <https://github.com/pybind/pybind11/pull/981>`_, + `#995 <https://github.com/pybind/pybind11/pull/995>`_, + `#997 <https://github.com/pybind/pybind11/pull/997>`_. + +* Custom constructors can now be added very easily using lambdas or factory + functions which return a class instance by value, pointer or holder. This + supersedes the old placement-new ``__init__`` technique. + See :ref:`custom_constructors` for details. + `#805 <https://github.com/pybind/pybind11/pull/805>`_, + `#1014 <https://github.com/pybind/pybind11/pull/1014>`_. + + .. code-block:: cpp + + struct Example { + Example(std::string); + }; + + py::class_<Example>(m, "Example") + .def(py::init<std::string>()) // existing constructor + .def(py::init([](int n) { // custom constructor + return std::make_unique<Example>(std::to_string(n)); + })); + +* Similarly to custom constructors, pickling support functions are now bound + using the ``py::pickle()`` adaptor which improves type safety. See the + :doc:`upgrade` and :ref:`pickling` for details. + `#1038 <https://github.com/pybind/pybind11/pull/1038>`_. + +* Builtin support for converting C++17 standard library types and general + conversion improvements: + + 1. C++17 ``std::variant`` is supported right out of the box. C++11/14 + equivalents (e.g. ``boost::variant``) can also be added with a simple + user-defined specialization. See :ref:`cpp17_container_casters` for details. + `#811 <https://github.com/pybind/pybind11/pull/811>`_, + `#845 <https://github.com/pybind/pybind11/pull/845>`_, + `#989 <https://github.com/pybind/pybind11/pull/989>`_. + + 2. Out-of-the-box support for C++17 ``std::string_view``. + `#906 <https://github.com/pybind/pybind11/pull/906>`_. + + 3. Improved compatibility of the builtin ``optional`` converter. + `#874 <https://github.com/pybind/pybind11/pull/874>`_. + + 4. The ``bool`` converter now accepts ``numpy.bool_`` and types which + define ``__bool__`` (Python 3.x) or ``__nonzero__`` (Python 2.7). + `#925 <https://github.com/pybind/pybind11/pull/925>`_. + + 5. C++-to-Python casters are now more efficient and move elements out + of rvalue containers whenever possible. + `#851 <https://github.com/pybind/pybind11/pull/851>`_, + `#936 <https://github.com/pybind/pybind11/pull/936>`_, + `#938 <https://github.com/pybind/pybind11/pull/938>`_. + + 6. Fixed ``bytes`` to ``std::string/char*`` conversion on Python 3. + `#817 <https://github.com/pybind/pybind11/pull/817>`_. + + 7. Fixed lifetime of temporary C++ objects created in Python-to-C++ conversions. + `#924 <https://github.com/pybind/pybind11/pull/924>`_. + +* Scope guard call policy for RAII types, e.g. ``py::call_guard<py::gil_scoped_release>()``, + ``py::call_guard<py::scoped_ostream_redirect>()``. See :ref:`call_policies` for details. + `#740 <https://github.com/pybind/pybind11/pull/740>`_. + +* Utility for redirecting C++ streams to Python (e.g. ``std::cout`` -> + ``sys.stdout``). Scope guard ``py::scoped_ostream_redirect`` in C++ and + a context manager in Python. See :ref:`ostream_redirect`. + `#1009 <https://github.com/pybind/pybind11/pull/1009>`_. + +* Improved handling of types and exceptions across module boundaries. + `#915 <https://github.com/pybind/pybind11/pull/915>`_, + `#951 <https://github.com/pybind/pybind11/pull/951>`_, + `#995 <https://github.com/pybind/pybind11/pull/995>`_. + +* Fixed destruction order of ``py::keep_alive`` nurse/patient objects + in reference cycles. + `#856 <https://github.com/pybind/pybind11/pull/856>`_. + +* Numpy and buffer protocol related improvements: + + 1. Support for negative strides in Python buffer objects/numpy arrays. This + required changing integers from unsigned to signed for the related C++ APIs. + Note: If you have compiler warnings enabled, you may notice some new conversion + warnings after upgrading. These can be resolved with ``static_cast``. + `#782 <https://github.com/pybind/pybind11/pull/782>`_. + + 2. Support ``std::complex`` and arrays inside ``PYBIND11_NUMPY_DTYPE``. + `#831 <https://github.com/pybind/pybind11/pull/831>`_, + `#832 <https://github.com/pybind/pybind11/pull/832>`_. + + 3. Support for constructing ``py::buffer_info`` and ``py::arrays`` using + arbitrary containers or iterators instead of requiring a ``std::vector``. + `#788 <https://github.com/pybind/pybind11/pull/788>`_, + `#822 <https://github.com/pybind/pybind11/pull/822>`_, + `#860 <https://github.com/pybind/pybind11/pull/860>`_. + + 4. Explicitly check numpy version and require >= 1.7.0. + `#819 <https://github.com/pybind/pybind11/pull/819>`_. + +* Support for allowing/prohibiting ``None`` for specific arguments and improved + ``None`` overload resolution order. See :ref:`none_arguments` for details. + `#843 <https://github.com/pybind/pybind11/pull/843>`_. + `#859 <https://github.com/pybind/pybind11/pull/859>`_. + +* Added ``py::exec()`` as a shortcut for ``py::eval<py::eval_statements>()`` + and support for C++11 raw string literals as input. See :ref:`eval`. + `#766 <https://github.com/pybind/pybind11/pull/766>`_, + `#827 <https://github.com/pybind/pybind11/pull/827>`_. + +* ``py::vectorize()`` ignores non-vectorizable arguments and supports + member functions. + `#762 <https://github.com/pybind/pybind11/pull/762>`_. + +* Support for bound methods as callbacks (``pybind11/functional.h``). + `#815 <https://github.com/pybind/pybind11/pull/815>`_. + +* Allow aliasing pybind11 methods: ``cls.attr("foo") = cls.attr("bar")``. + `#802 <https://github.com/pybind/pybind11/pull/802>`_. + +* Don't allow mixed static/non-static overloads. + `#804 <https://github.com/pybind/pybind11/pull/804>`_. + +* Fixed overriding static properties in derived classes. + `#784 <https://github.com/pybind/pybind11/pull/784>`_. + +* Added support for write only properties. + `#1144 <https://github.com/pybind/pybind11/pull/1144>`_. + +* Improved deduction of member functions of a derived class when its bases + aren't registered with pybind11. + `#855 <https://github.com/pybind/pybind11/pull/855>`_. + + .. code-block:: cpp + + struct Base { + int foo() { return 42; } + } + + struct Derived : Base {} + + // Now works, but previously required also binding `Base` + py::class_<Derived>(m, "Derived") + .def("foo", &Derived::foo); // function is actually from `Base` + +* The implementation of ``py::init<>`` now uses C++11 brace initialization + syntax to construct instances, which permits binding implicit constructors of + aggregate types. `#1015 <https://github.com/pybind/pybind11/pull/1015>`_. + + .. code-block:: cpp + + struct Aggregate { + int a; + std::string b; + }; + + py::class_<Aggregate>(m, "Aggregate") + .def(py::init<int, const std::string &>()); + +* Fixed issues with multiple inheritance with offset base/derived pointers. + `#812 <https://github.com/pybind/pybind11/pull/812>`_, + `#866 <https://github.com/pybind/pybind11/pull/866>`_, + `#960 <https://github.com/pybind/pybind11/pull/960>`_. + +* Fixed reference leak of type objects. + `#1030 <https://github.com/pybind/pybind11/pull/1030>`_. + +* Improved support for the ``/std:c++14`` and ``/std:c++latest`` modes + on MSVC 2017. + `#841 <https://github.com/pybind/pybind11/pull/841>`_, + `#999 <https://github.com/pybind/pybind11/pull/999>`_. + +* Fixed detection of private operator new on MSVC. + `#893 <https://github.com/pybind/pybind11/pull/893>`_, + `#918 <https://github.com/pybind/pybind11/pull/918>`_. + +* Intel C++ compiler compatibility fixes. + `#937 <https://github.com/pybind/pybind11/pull/937>`_. + +* Fixed implicit conversion of `py::enum_` to integer types on Python 2.7. + `#821 <https://github.com/pybind/pybind11/pull/821>`_. + +* Added ``py::hash`` to fetch the hash value of Python objects, and + ``.def(hash(py::self))`` to provide the C++ ``std::hash`` as the Python + ``__hash__`` method. + `#1034 <https://github.com/pybind/pybind11/pull/1034>`_. + +* Fixed ``__truediv__`` on Python 2 and ``__itruediv__`` on Python 3. + `#867 <https://github.com/pybind/pybind11/pull/867>`_. + +* ``py::capsule`` objects now support the ``name`` attribute. This is useful + for interfacing with ``scipy.LowLevelCallable``. + `#902 <https://github.com/pybind/pybind11/pull/902>`_. + +* Fixed ``py::make_iterator``'s ``__next__()`` for past-the-end calls. + `#897 <https://github.com/pybind/pybind11/pull/897>`_. + +* Added ``error_already_set::matches()`` for checking Python exceptions. + `#772 <https://github.com/pybind/pybind11/pull/772>`_. + +* Deprecated ``py::error_already_set::clear()``. It's no longer needed + following a simplification of the ``py::error_already_set`` class. + `#954 <https://github.com/pybind/pybind11/pull/954>`_. + +* Deprecated ``py::handle::operator==()`` in favor of ``py::handle::is()`` + `#825 <https://github.com/pybind/pybind11/pull/825>`_. + +* Deprecated ``py::object::borrowed``/``py::object::stolen``. + Use ``py::object::borrowed_t{}``/``py::object::stolen_t{}`` instead. + `#771 <https://github.com/pybind/pybind11/pull/771>`_. + +* Changed internal data structure versioning to avoid conflicts between + modules compiled with different revisions of pybind11. + `#1012 <https://github.com/pybind/pybind11/pull/1012>`_. + +* Additional compile-time and run-time error checking and more informative messages. + `#786 <https://github.com/pybind/pybind11/pull/786>`_, + `#794 <https://github.com/pybind/pybind11/pull/794>`_, + `#803 <https://github.com/pybind/pybind11/pull/803>`_. + +* Various minor improvements and fixes. + `#764 <https://github.com/pybind/pybind11/pull/764>`_, + `#791 <https://github.com/pybind/pybind11/pull/791>`_, + `#795 <https://github.com/pybind/pybind11/pull/795>`_, + `#840 <https://github.com/pybind/pybind11/pull/840>`_, + `#844 <https://github.com/pybind/pybind11/pull/844>`_, + `#846 <https://github.com/pybind/pybind11/pull/846>`_, + `#849 <https://github.com/pybind/pybind11/pull/849>`_, + `#858 <https://github.com/pybind/pybind11/pull/858>`_, + `#862 <https://github.com/pybind/pybind11/pull/862>`_, + `#871 <https://github.com/pybind/pybind11/pull/871>`_, + `#872 <https://github.com/pybind/pybind11/pull/872>`_, + `#881 <https://github.com/pybind/pybind11/pull/881>`_, + `#888 <https://github.com/pybind/pybind11/pull/888>`_, + `#899 <https://github.com/pybind/pybind11/pull/899>`_, + `#928 <https://github.com/pybind/pybind11/pull/928>`_, + `#931 <https://github.com/pybind/pybind11/pull/931>`_, + `#944 <https://github.com/pybind/pybind11/pull/944>`_, + `#950 <https://github.com/pybind/pybind11/pull/950>`_, + `#952 <https://github.com/pybind/pybind11/pull/952>`_, + `#962 <https://github.com/pybind/pybind11/pull/962>`_, + `#965 <https://github.com/pybind/pybind11/pull/965>`_, + `#970 <https://github.com/pybind/pybind11/pull/970>`_, + `#978 <https://github.com/pybind/pybind11/pull/978>`_, + `#979 <https://github.com/pybind/pybind11/pull/979>`_, + `#986 <https://github.com/pybind/pybind11/pull/986>`_, + `#1020 <https://github.com/pybind/pybind11/pull/1020>`_, + `#1027 <https://github.com/pybind/pybind11/pull/1027>`_, + `#1037 <https://github.com/pybind/pybind11/pull/1037>`_. + +* Testing improvements. + `#798 <https://github.com/pybind/pybind11/pull/798>`_, + `#882 <https://github.com/pybind/pybind11/pull/882>`_, + `#898 <https://github.com/pybind/pybind11/pull/898>`_, + `#900 <https://github.com/pybind/pybind11/pull/900>`_, + `#921 <https://github.com/pybind/pybind11/pull/921>`_, + `#923 <https://github.com/pybind/pybind11/pull/923>`_, + `#963 <https://github.com/pybind/pybind11/pull/963>`_. + +v2.1.1 (April 7, 2017) +----------------------------------------------------- + +* Fixed minimum version requirement for MSVC 2015u3 + `#773 <https://github.com/pybind/pybind11/pull/773>`_. + +v2.1.0 (March 22, 2017) +----------------------------------------------------- + +* pybind11 now performs function overload resolution in two phases. The first + phase only considers exact type matches, while the second allows for implicit + conversions to take place. A special ``noconvert()`` syntax can be used to + completely disable implicit conversions for specific arguments. + `#643 <https://github.com/pybind/pybind11/pull/643>`_, + `#634 <https://github.com/pybind/pybind11/pull/634>`_, + `#650 <https://github.com/pybind/pybind11/pull/650>`_. + +* Fixed a regression where static properties no longer worked with classes + using multiple inheritance. The ``py::metaclass`` attribute is no longer + necessary (and deprecated as of this release) when binding classes with + static properties. + `#679 <https://github.com/pybind/pybind11/pull/679>`_, + +* Classes bound using ``pybind11`` can now use custom metaclasses. + `#679 <https://github.com/pybind/pybind11/pull/679>`_, + +* ``py::args`` and ``py::kwargs`` can now be mixed with other positional + arguments when binding functions using pybind11. + `#611 <https://github.com/pybind/pybind11/pull/611>`_. + +* Improved support for C++11 unicode string and character types; added + extensive documentation regarding pybind11's string conversion behavior. + `#624 <https://github.com/pybind/pybind11/pull/624>`_, + `#636 <https://github.com/pybind/pybind11/pull/636>`_, + `#715 <https://github.com/pybind/pybind11/pull/715>`_. + +* pybind11 can now avoid expensive copies when converting Eigen arrays to NumPy + arrays (and vice versa). `#610 <https://github.com/pybind/pybind11/pull/610>`_. + +* The "fast path" in ``py::vectorize`` now works for any full-size group of C or + F-contiguous arrays. The non-fast path is also faster since it no longer performs + copies of the input arguments (except when type conversions are necessary). + `#610 <https://github.com/pybind/pybind11/pull/610>`_. + +* Added fast, unchecked access to NumPy arrays via a proxy object. + `#746 <https://github.com/pybind/pybind11/pull/746>`_. + +* Transparent support for class-specific ``operator new`` and + ``operator delete`` implementations. + `#755 <https://github.com/pybind/pybind11/pull/755>`_. + +* Slimmer and more efficient STL-compatible iterator interface for sequence types. + `#662 <https://github.com/pybind/pybind11/pull/662>`_. + +* Improved custom holder type support. + `#607 <https://github.com/pybind/pybind11/pull/607>`_. + +* ``nullptr`` to ``None`` conversion fixed in various builtin type casters. + `#732 <https://github.com/pybind/pybind11/pull/732>`_. + +* ``enum_`` now exposes its members via a special ``__members__`` attribute. + `#666 <https://github.com/pybind/pybind11/pull/666>`_. + +* ``std::vector`` bindings created using ``stl_bind.h`` can now optionally + implement the buffer protocol. `#488 <https://github.com/pybind/pybind11/pull/488>`_. + +* Automated C++ reference documentation using doxygen and breathe. + `#598 <https://github.com/pybind/pybind11/pull/598>`_. + +* Added minimum compiler version assertions. + `#727 <https://github.com/pybind/pybind11/pull/727>`_. + +* Improved compatibility with C++1z. + `#677 <https://github.com/pybind/pybind11/pull/677>`_. + +* Improved ``py::capsule`` API. Can be used to implement cleanup + callbacks that are involved at module destruction time. + `#752 <https://github.com/pybind/pybind11/pull/752>`_. + +* Various minor improvements and fixes. + `#595 <https://github.com/pybind/pybind11/pull/595>`_, + `#588 <https://github.com/pybind/pybind11/pull/588>`_, + `#589 <https://github.com/pybind/pybind11/pull/589>`_, + `#603 <https://github.com/pybind/pybind11/pull/603>`_, + `#619 <https://github.com/pybind/pybind11/pull/619>`_, + `#648 <https://github.com/pybind/pybind11/pull/648>`_, + `#695 <https://github.com/pybind/pybind11/pull/695>`_, + `#720 <https://github.com/pybind/pybind11/pull/720>`_, + `#723 <https://github.com/pybind/pybind11/pull/723>`_, + `#729 <https://github.com/pybind/pybind11/pull/729>`_, + `#724 <https://github.com/pybind/pybind11/pull/724>`_, + `#742 <https://github.com/pybind/pybind11/pull/742>`_, + `#753 <https://github.com/pybind/pybind11/pull/753>`_. + +v2.0.1 (Jan 4, 2017) +----------------------------------------------------- + +* Fix pointer to reference error in type_caster on MSVC + `#583 <https://github.com/pybind/pybind11/pull/583>`_. + +* Fixed a segmentation in the test suite due to a typo + `cd7eac <https://github.com/pybind/pybind11/commit/cd7eac>`_. + +v2.0.0 (Jan 1, 2017) +----------------------------------------------------- + +* Fixed a reference counting regression affecting types with custom metaclasses + (introduced in v2.0.0-rc1). + `#571 <https://github.com/pybind/pybind11/pull/571>`_. + +* Quenched a CMake policy warning. + `#570 <https://github.com/pybind/pybind11/pull/570>`_. + +v2.0.0-rc1 (Dec 23, 2016) +----------------------------------------------------- + +The pybind11 developers are excited to issue a release candidate of pybind11 +with a subsequent v2.0.0 release planned in early January next year. + +An incredible amount of effort by went into pybind11 over the last ~5 months, +leading to a release that is jam-packed with exciting new features and numerous +usability improvements. The following list links PRs or individual commits +whenever applicable. + +Happy Christmas! + +* Support for binding C++ class hierarchies that make use of multiple + inheritance. `#410 <https://github.com/pybind/pybind11/pull/410>`_. + +* PyPy support: pybind11 now supports nightly builds of PyPy and will + interoperate with the future 5.7 release. No code changes are necessary, + everything "just" works as usual. Note that we only target the Python 2.7 + branch for now; support for 3.x will be added once its ``cpyext`` extension + support catches up. A few minor features remain unsupported for the time + being (notably dynamic attributes in custom types). + `#527 <https://github.com/pybind/pybind11/pull/527>`_. + +* Significant work on the documentation -- in particular, the monolithic + ``advanced.rst`` file was restructured into a easier to read hierarchical + organization. `#448 <https://github.com/pybind/pybind11/pull/448>`_. + +* Many NumPy-related improvements: + + 1. Object-oriented API to access and modify NumPy ``ndarray`` instances, + replicating much of the corresponding NumPy C API functionality. + `#402 <https://github.com/pybind/pybind11/pull/402>`_. + + 2. NumPy array ``dtype`` array descriptors are now first-class citizens and + are exposed via a new class ``py::dtype``. + + 3. Structured dtypes can be registered using the ``PYBIND11_NUMPY_DTYPE()`` + macro. Special ``array`` constructors accepting dtype objects were also + added. + + One potential caveat involving this change: format descriptor strings + should now be accessed via ``format_descriptor::format()`` (however, for + compatibility purposes, the old syntax ``format_descriptor::value`` will + still work for non-structured data types). `#308 + <https://github.com/pybind/pybind11/pull/308>`_. + + 4. Further improvements to support structured dtypes throughout the system. + `#472 <https://github.com/pybind/pybind11/pull/472>`_, + `#474 <https://github.com/pybind/pybind11/pull/474>`_, + `#459 <https://github.com/pybind/pybind11/pull/459>`_, + `#453 <https://github.com/pybind/pybind11/pull/453>`_, + `#452 <https://github.com/pybind/pybind11/pull/452>`_, and + `#505 <https://github.com/pybind/pybind11/pull/505>`_. + + 5. Fast access operators. `#497 <https://github.com/pybind/pybind11/pull/497>`_. + + 6. Constructors for arrays whose storage is owned by another object. + `#440 <https://github.com/pybind/pybind11/pull/440>`_. + + 7. Added constructors for ``array`` and ``array_t`` explicitly accepting shape + and strides; if strides are not provided, they are deduced assuming + C-contiguity. Also added simplified constructors for 1-dimensional case. + + 8. Added buffer/NumPy support for ``char[N]`` and ``std::array<char, N>`` types. + + 9. Added ``memoryview`` wrapper type which is constructible from ``buffer_info``. + +* Eigen: many additional conversions and support for non-contiguous + arrays/slices. + `#427 <https://github.com/pybind/pybind11/pull/427>`_, + `#315 <https://github.com/pybind/pybind11/pull/315>`_, + `#316 <https://github.com/pybind/pybind11/pull/316>`_, + `#312 <https://github.com/pybind/pybind11/pull/312>`_, and + `#267 <https://github.com/pybind/pybind11/pull/267>`_ + +* Incompatible changes in ``class_<...>::class_()``: + + 1. Declarations of types that provide access via the buffer protocol must + now include the ``py::buffer_protocol()`` annotation as an argument to + the ``class_`` constructor. + + 2. Declarations of types that require a custom metaclass (i.e. all classes + which include static properties via commands such as + ``def_readwrite_static()``) must now include the ``py::metaclass()`` + annotation as an argument to the ``class_`` constructor. + + These two changes were necessary to make type definitions in pybind11 + future-proof, and to support PyPy via its cpyext mechanism. `#527 + <https://github.com/pybind/pybind11/pull/527>`_. + + + 3. This version of pybind11 uses a redesigned mechanism for instantiating + trampoline classes that are used to override virtual methods from within + Python. This led to the following user-visible syntax change: instead of + + .. code-block:: cpp + + py::class_<TrampolineClass>("MyClass") + .alias<MyClass>() + .... + + write + + .. code-block:: cpp + + py::class_<MyClass, TrampolineClass>("MyClass") + .... + + Importantly, both the original and the trampoline class are now + specified as an arguments (in arbitrary order) to the ``py::class_`` + template, and the ``alias<..>()`` call is gone. The new scheme has zero + overhead in cases when Python doesn't override any functions of the + underlying C++ class. `rev. 86d825 + <https://github.com/pybind/pybind11/commit/86d825>`_. + +* Added ``eval`` and ``eval_file`` functions for evaluating expressions and + statements from a string or file. `rev. 0d3fc3 + <https://github.com/pybind/pybind11/commit/0d3fc3>`_. + +* pybind11 can now create types with a modifiable dictionary. + `#437 <https://github.com/pybind/pybind11/pull/437>`_ and + `#444 <https://github.com/pybind/pybind11/pull/444>`_. + +* Support for translation of arbitrary C++ exceptions to Python counterparts. + `#296 <https://github.com/pybind/pybind11/pull/296>`_ and + `#273 <https://github.com/pybind/pybind11/pull/273>`_. + +* Report full backtraces through mixed C++/Python code, better reporting for + import errors, fixed GIL management in exception processing. + `#537 <https://github.com/pybind/pybind11/pull/537>`_, + `#494 <https://github.com/pybind/pybind11/pull/494>`_, + `rev. e72d95 <https://github.com/pybind/pybind11/commit/e72d95>`_, and + `rev. 099d6e <https://github.com/pybind/pybind11/commit/099d6e>`_. + +* Support for bit-level operations, comparisons, and serialization of C++ + enumerations. `#503 <https://github.com/pybind/pybind11/pull/503>`_, + `#508 <https://github.com/pybind/pybind11/pull/508>`_, + `#380 <https://github.com/pybind/pybind11/pull/380>`_, + `#309 <https://github.com/pybind/pybind11/pull/309>`_. + `#311 <https://github.com/pybind/pybind11/pull/311>`_. + +* The ``class_`` constructor now accepts its template arguments in any order. + `#385 <https://github.com/pybind/pybind11/pull/385>`_. + +* Attribute and item accessors now have a more complete interface which makes + it possible to chain attributes as in + ``obj.attr("a")[key].attr("b").attr("method")(1, 2, 3)``. `#425 + <https://github.com/pybind/pybind11/pull/425>`_. + +* Major redesign of the default and conversion constructors in ``pytypes.h``. + `#464 <https://github.com/pybind/pybind11/pull/464>`_. + +* Added built-in support for ``std::shared_ptr`` holder type. It is no longer + necessary to to include a declaration of the form + ``PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr<T>)`` (though continuing to + do so won't cause an error). + `#454 <https://github.com/pybind/pybind11/pull/454>`_. + +* New ``py::overload_cast`` casting operator to select among multiple possible + overloads of a function. An example: + + .. code-block:: cpp + + py::class_<Pet>(m, "Pet") + .def("set", py::overload_cast<int>(&Pet::set), "Set the pet's age") + .def("set", py::overload_cast<const std::string &>(&Pet::set), "Set the pet's name"); + + This feature only works on C++14-capable compilers. + `#541 <https://github.com/pybind/pybind11/pull/541>`_. + +* C++ types are automatically cast to Python types, e.g. when assigning + them as an attribute. For instance, the following is now legal: + + .. code-block:: cpp + + py::module m = /* ... */ + m.attr("constant") = 123; + + (Previously, a ``py::cast`` call was necessary to avoid a compilation error.) + `#551 <https://github.com/pybind/pybind11/pull/551>`_. + +* Redesigned ``pytest``-based test suite. `#321 <https://github.com/pybind/pybind11/pull/321>`_. + +* Instance tracking to detect reference leaks in test suite. `#324 <https://github.com/pybind/pybind11/pull/324>`_ + +* pybind11 can now distinguish between multiple different instances that are + located at the same memory address, but which have different types. + `#329 <https://github.com/pybind/pybind11/pull/329>`_. + +* Improved logic in ``move`` return value policy. + `#510 <https://github.com/pybind/pybind11/pull/510>`_, + `#297 <https://github.com/pybind/pybind11/pull/297>`_. + +* Generalized unpacking API to permit calling Python functions from C++ using + notation such as ``foo(a1, a2, *args, "ka"_a=1, "kb"_a=2, **kwargs)``. `#372 <https://github.com/pybind/pybind11/pull/372>`_. + +* ``py::print()`` function whose behavior matches that of the native Python + ``print()`` function. `#372 <https://github.com/pybind/pybind11/pull/372>`_. + +* Added ``py::dict`` keyword constructor:``auto d = dict("number"_a=42, + "name"_a="World");``. `#372 <https://github.com/pybind/pybind11/pull/372>`_. + +* Added ``py::str::format()`` method and ``_s`` literal: ``py::str s = "1 + 2 + = {}"_s.format(3);``. `#372 <https://github.com/pybind/pybind11/pull/372>`_. + +* Added ``py::repr()`` function which is equivalent to Python's builtin + ``repr()``. `#333 <https://github.com/pybind/pybind11/pull/333>`_. + +* Improved construction and destruction logic for holder types. It is now + possible to reference instances with smart pointer holder types without + constructing the holder if desired. The ``PYBIND11_DECLARE_HOLDER_TYPE`` + macro now accepts an optional second parameter to indicate whether the holder + type uses intrusive reference counting. + `#533 <https://github.com/pybind/pybind11/pull/533>`_ and + `#561 <https://github.com/pybind/pybind11/pull/561>`_. + +* Mapping a stateless C++ function to Python and back is now "for free" (i.e. + no extra indirections or argument conversion overheads). `rev. 954b79 + <https://github.com/pybind/pybind11/commit/954b79>`_. + +* Bindings for ``std::valarray<T>``. + `#545 <https://github.com/pybind/pybind11/pull/545>`_. + +* Improved support for C++17 capable compilers. + `#562 <https://github.com/pybind/pybind11/pull/562>`_. + +* Bindings for ``std::optional<t>``. + `#475 <https://github.com/pybind/pybind11/pull/475>`_, + `#476 <https://github.com/pybind/pybind11/pull/476>`_, + `#479 <https://github.com/pybind/pybind11/pull/479>`_, + `#499 <https://github.com/pybind/pybind11/pull/499>`_, and + `#501 <https://github.com/pybind/pybind11/pull/501>`_. + +* ``stl_bind.h``: general improvements and support for ``std::map`` and + ``std::unordered_map``. + `#490 <https://github.com/pybind/pybind11/pull/490>`_, + `#282 <https://github.com/pybind/pybind11/pull/282>`_, + `#235 <https://github.com/pybind/pybind11/pull/235>`_. + +* The ``std::tuple``, ``std::pair``, ``std::list``, and ``std::vector`` type + casters now accept any Python sequence type as input. `rev. 107285 + <https://github.com/pybind/pybind11/commit/107285>`_. + +* Improved CMake Python detection on multi-architecture Linux. + `#532 <https://github.com/pybind/pybind11/pull/532>`_. + +* Infrastructure to selectively disable or enable parts of the automatically + generated docstrings. `#486 <https://github.com/pybind/pybind11/pull/486>`_. + +* ``reference`` and ``reference_internal`` are now the default return value + properties for static and non-static properties, respectively. `#473 + <https://github.com/pybind/pybind11/pull/473>`_. (the previous defaults + were ``automatic``). `#473 <https://github.com/pybind/pybind11/pull/473>`_. + +* Support for ``std::unique_ptr`` with non-default deleters or no deleter at + all (``py::nodelete``). `#384 <https://github.com/pybind/pybind11/pull/384>`_. + +* Deprecated ``handle::call()`` method. The new syntax to call Python + functions is simply ``handle()``. It can also be invoked explicitly via + ``handle::operator<X>()``, where ``X`` is an optional return value policy. + +* Print more informative error messages when ``make_tuple()`` or ``cast()`` + fail. `#262 <https://github.com/pybind/pybind11/pull/262>`_. + +* Creation of holder types for classes deriving from + ``std::enable_shared_from_this<>`` now also works for ``const`` values. + `#260 <https://github.com/pybind/pybind11/pull/260>`_. + +* ``make_iterator()`` improvements for better compatibility with various + types (now uses prefix increment operator); it now also accepts iterators + with different begin/end types as long as they are equality comparable. + `#247 <https://github.com/pybind/pybind11/pull/247>`_. + +* ``arg()`` now accepts a wider range of argument types for default values. + `#244 <https://github.com/pybind/pybind11/pull/244>`_. + +* Support ``keep_alive`` where the nurse object may be ``None``. `#341 + <https://github.com/pybind/pybind11/pull/341>`_. + +* Added constructors for ``str`` and ``bytes`` from zero-terminated char + pointers, and from char pointers and length. Added constructors for ``str`` + from ``bytes`` and for ``bytes`` from ``str``, which will perform UTF-8 + decoding/encoding as required. + +* Many other improvements of library internals without user-visible changes + + +1.8.1 (July 12, 2016) +---------------------- +* Fixed a rare but potentially very severe issue when the garbage collector ran + during pybind11 type creation. + +1.8.0 (June 14, 2016) +---------------------- +* Redesigned CMake build system which exports a convenient + ``pybind11_add_module`` function to parent projects. +* ``std::vector<>`` type bindings analogous to Boost.Python's ``indexing_suite`` +* Transparent conversion of sparse and dense Eigen matrices and vectors (``eigen.h``) +* Added an ``ExtraFlags`` template argument to the NumPy ``array_t<>`` wrapper + to disable an enforced cast that may lose precision, e.g. to create overloads + for different precisions and complex vs real-valued matrices. +* Prevent implicit conversion of floating point values to integral types in + function arguments +* Fixed incorrect default return value policy for functions returning a shared + pointer +* Don't allow registering a type via ``class_`` twice +* Don't allow casting a ``None`` value into a C++ lvalue reference +* Fixed a crash in ``enum_::operator==`` that was triggered by the ``help()`` command +* Improved detection of whether or not custom C++ types can be copy/move-constructed +* Extended ``str`` type to also work with ``bytes`` instances +* Added a ``"name"_a`` user defined string literal that is equivalent to ``py::arg("name")``. +* When specifying function arguments via ``py::arg``, the test that verifies + the number of arguments now runs at compile time. +* Added ``[[noreturn]]`` attribute to ``pybind11_fail()`` to quench some + compiler warnings +* List function arguments in exception text when the dispatch code cannot find + a matching overload +* Added ``PYBIND11_OVERLOAD_NAME`` and ``PYBIND11_OVERLOAD_PURE_NAME`` macros which + can be used to override virtual methods whose name differs in C++ and Python + (e.g. ``__call__`` and ``operator()``) +* Various minor ``iterator`` and ``make_iterator()`` improvements +* Transparently support ``__bool__`` on Python 2.x and Python 3.x +* Fixed issue with destructor of unpickled object not being called +* Minor CMake build system improvements on Windows +* New ``pybind11::args`` and ``pybind11::kwargs`` types to create functions which + take an arbitrary number of arguments and keyword arguments +* New syntax to call a Python function from C++ using ``*args`` and ``*kwargs`` +* The functions ``def_property_*`` now correctly process docstring arguments (these + formerly caused a segmentation fault) +* Many ``mkdoc.py`` improvements (enumerations, template arguments, ``DOC()`` + macro accepts more arguments) +* Cygwin support +* Documentation improvements (pickling support, ``keep_alive``, macro usage) + +1.7 (April 30, 2016) +---------------------- +* Added a new ``move`` return value policy that triggers C++11 move semantics. + The automatic return value policy falls back to this case whenever a rvalue + reference is encountered +* Significantly more general GIL state routines that are used instead of + Python's troublesome ``PyGILState_Ensure`` and ``PyGILState_Release`` API +* Redesign of opaque types that drastically simplifies their usage +* Extended ability to pass values of type ``[const] void *`` +* ``keep_alive`` fix: don't fail when there is no patient +* ``functional.h``: acquire the GIL before calling a Python function +* Added Python RAII type wrappers ``none`` and ``iterable`` +* Added ``*args`` and ``*kwargs`` pass-through parameters to + ``pybind11.get_include()`` function +* Iterator improvements and fixes +* Documentation on return value policies and opaque types improved + +1.6 (April 30, 2016) +---------------------- +* Skipped due to upload to PyPI gone wrong and inability to recover + (https://github.com/pypa/packaging-problems/issues/74) + +1.5 (April 21, 2016) +---------------------- +* For polymorphic types, use RTTI to try to return the closest type registered with pybind11 +* Pickling support for serializing and unserializing C++ instances to a byte stream in Python +* Added a convenience routine ``make_iterator()`` which turns a range indicated + by a pair of C++ iterators into a iterable Python object +* Added ``len()`` and a variadic ``make_tuple()`` function +* Addressed a rare issue that could confuse the current virtual function + dispatcher and another that could lead to crashes in multi-threaded + applications +* Added a ``get_include()`` function to the Python module that returns the path + of the directory containing the installed pybind11 header files +* Documentation improvements: import issues, symbol visibility, pickling, limitations +* Added casting support for ``std::reference_wrapper<>`` + +1.4 (April 7, 2016) +-------------------------- +* Transparent type conversion for ``std::wstring`` and ``wchar_t`` +* Allow passing ``nullptr``-valued strings +* Transparent passing of ``void *`` pointers using capsules +* Transparent support for returning values wrapped in ``std::unique_ptr<>`` +* Improved docstring generation for compatibility with Sphinx +* Nicer debug error message when default parameter construction fails +* Support for "opaque" types that bypass the transparent conversion layer for STL containers +* Redesigned type casting interface to avoid ambiguities that could occasionally cause compiler errors +* Redesigned property implementation; fixes crashes due to an unfortunate default return value policy +* Anaconda package generation support + +1.3 (March 8, 2016) +-------------------------- + +* Added support for the Intel C++ compiler (v15+) +* Added support for the STL unordered set/map data structures +* Added support for the STL linked list data structure +* NumPy-style broadcasting support in ``pybind11::vectorize`` +* pybind11 now displays more verbose error messages when ``arg::operator=()`` fails +* pybind11 internal data structures now live in a version-dependent namespace to avoid ABI issues +* Many, many bugfixes involving corner cases and advanced usage + +1.2 (February 7, 2016) +-------------------------- + +* Optional: efficient generation of function signatures at compile time using C++14 +* Switched to a simpler and more general way of dealing with function default + arguments. Unused keyword arguments in function calls are now detected and + cause errors as expected +* New ``keep_alive`` call policy analogous to Boost.Python's ``with_custodian_and_ward`` +* New ``pybind11::base<>`` attribute to indicate a subclass relationship +* Improved interface for RAII type wrappers in ``pytypes.h`` +* Use RAII type wrappers consistently within pybind11 itself. This + fixes various potential refcount leaks when exceptions occur +* Added new ``bytes`` RAII type wrapper (maps to ``string`` in Python 2.7) +* Made handle and related RAII classes const correct, using them more + consistently everywhere now +* Got rid of the ugly ``__pybind11__`` attributes on the Python side---they are + now stored in a C++ hash table that is not visible in Python +* Fixed refcount leaks involving NumPy arrays and bound functions +* Vastly improved handling of shared/smart pointers +* Removed an unnecessary copy operation in ``pybind11::vectorize`` +* Fixed naming clashes when both pybind11 and NumPy headers are included +* Added conversions for additional exception types +* Documentation improvements (using multiple extension modules, smart pointers, + other minor clarifications) +* unified infrastructure for parsing variadic arguments in ``class_`` and cpp_function +* Fixed license text (was: ZLIB, should have been: 3-clause BSD) +* Python 3.2 compatibility +* Fixed remaining issues when accessing types in another plugin module +* Added enum comparison and casting methods +* Improved SFINAE-based detection of whether types are copy-constructible +* Eliminated many warnings about unused variables and the use of ``offsetof()`` +* Support for ``std::array<>`` conversions + +1.1 (December 7, 2015) +-------------------------- + +* Documentation improvements (GIL, wrapping functions, casting, fixed many typos) +* Generalized conversion of integer types +* Improved support for casting function objects +* Improved support for ``std::shared_ptr<>`` conversions +* Initial support for ``std::set<>`` conversions +* Fixed type resolution issue for types defined in a separate plugin module +* Cmake build system improvements +* Factored out generic functionality to non-templated code (smaller code size) +* Added a code size / compile time benchmark vs Boost.Python +* Added an appveyor CI script + +1.0 (October 15, 2015) +------------------------ +* Initial release diff --git a/pybind11/docs/classes.rst b/pybind11/docs/classes.rst new file mode 100644 index 0000000000000000000000000000000000000000..1deec9b537fbae32145e5366b4b92d71389b054d --- /dev/null +++ b/pybind11/docs/classes.rst @@ -0,0 +1,521 @@ +.. _classes: + +Object-oriented code +#################### + +Creating bindings for a custom type +=================================== + +Let's now look at a more complex example where we'll create bindings for a +custom C++ data structure named ``Pet``. Its definition is given below: + +.. code-block:: cpp + + struct Pet { + Pet(const std::string &name) : name(name) { } + void setName(const std::string &name_) { name = name_; } + const std::string &getName() const { return name; } + + std::string name; + }; + +The binding code for ``Pet`` looks as follows: + +.. code-block:: cpp + + #include <pybind11/pybind11.h> + + namespace py = pybind11; + + PYBIND11_MODULE(example, m) { + py::class_<Pet>(m, "Pet") + .def(py::init<const std::string &>()) + .def("setName", &Pet::setName) + .def("getName", &Pet::getName); + } + +:class:`class_` creates bindings for a C++ *class* or *struct*-style data +structure. :func:`init` is a convenience function that takes the types of a +constructor's parameters as template arguments and wraps the corresponding +constructor (see the :ref:`custom_constructors` section for details). An +interactive Python session demonstrating this example is shown below: + +.. code-block:: pycon + + % python + >>> import example + >>> p = example.Pet('Molly') + >>> print(p) + <example.Pet object at 0x10cd98060> + >>> p.getName() + u'Molly' + >>> p.setName('Charly') + >>> p.getName() + u'Charly' + +.. seealso:: + + Static member functions can be bound in the same way using + :func:`class_::def_static`. + +Keyword and default arguments +============================= +It is possible to specify keyword and default arguments using the syntax +discussed in the previous chapter. Refer to the sections :ref:`keyword_args` +and :ref:`default_args` for details. + +Binding lambda functions +======================== + +Note how ``print(p)`` produced a rather useless summary of our data structure in the example above: + +.. code-block:: pycon + + >>> print(p) + <example.Pet object at 0x10cd98060> + +To address this, we could bind an utility function that returns a human-readable +summary to the special method slot named ``__repr__``. Unfortunately, there is no +suitable functionality in the ``Pet`` data structure, and it would be nice if +we did not have to change it. This can easily be accomplished by binding a +Lambda function instead: + +.. code-block:: cpp + + py::class_<Pet>(m, "Pet") + .def(py::init<const std::string &>()) + .def("setName", &Pet::setName) + .def("getName", &Pet::getName) + .def("__repr__", + [](const Pet &a) { + return "<example.Pet named '" + a.name + "'>"; + } + ); + +Both stateless [#f1]_ and stateful lambda closures are supported by pybind11. +With the above change, the same Python code now produces the following output: + +.. code-block:: pycon + + >>> print(p) + <example.Pet named 'Molly'> + +.. [#f1] Stateless closures are those with an empty pair of brackets ``[]`` as the capture object. + +.. _properties: + +Instance and static fields +========================== + +We can also directly expose the ``name`` field using the +:func:`class_::def_readwrite` method. A similar :func:`class_::def_readonly` +method also exists for ``const`` fields. + +.. code-block:: cpp + + py::class_<Pet>(m, "Pet") + .def(py::init<const std::string &>()) + .def_readwrite("name", &Pet::name) + // ... remainder ... + +This makes it possible to write + +.. code-block:: pycon + + >>> p = example.Pet('Molly') + >>> p.name + u'Molly' + >>> p.name = 'Charly' + >>> p.name + u'Charly' + +Now suppose that ``Pet::name`` was a private internal variable +that can only be accessed via setters and getters. + +.. code-block:: cpp + + class Pet { + public: + Pet(const std::string &name) : name(name) { } + void setName(const std::string &name_) { name = name_; } + const std::string &getName() const { return name; } + private: + std::string name; + }; + +In this case, the method :func:`class_::def_property` +(:func:`class_::def_property_readonly` for read-only data) can be used to +provide a field-like interface within Python that will transparently call +the setter and getter functions: + +.. code-block:: cpp + + py::class_<Pet>(m, "Pet") + .def(py::init<const std::string &>()) + .def_property("name", &Pet::getName, &Pet::setName) + // ... remainder ... + +Write only properties can be defined by passing ``nullptr`` as the +input for the read function. + +.. seealso:: + + Similar functions :func:`class_::def_readwrite_static`, + :func:`class_::def_readonly_static` :func:`class_::def_property_static`, + and :func:`class_::def_property_readonly_static` are provided for binding + static variables and properties. Please also see the section on + :ref:`static_properties` in the advanced part of the documentation. + +Dynamic attributes +================== + +Native Python classes can pick up new attributes dynamically: + +.. code-block:: pycon + + >>> class Pet: + ... name = 'Molly' + ... + >>> p = Pet() + >>> p.name = 'Charly' # overwrite existing + >>> p.age = 2 # dynamically add a new attribute + +By default, classes exported from C++ do not support this and the only writable +attributes are the ones explicitly defined using :func:`class_::def_readwrite` +or :func:`class_::def_property`. + +.. code-block:: cpp + + py::class_<Pet>(m, "Pet") + .def(py::init<>()) + .def_readwrite("name", &Pet::name); + +Trying to set any other attribute results in an error: + +.. code-block:: pycon + + >>> p = example.Pet() + >>> p.name = 'Charly' # OK, attribute defined in C++ + >>> p.age = 2 # fail + AttributeError: 'Pet' object has no attribute 'age' + +To enable dynamic attributes for C++ classes, the :class:`py::dynamic_attr` tag +must be added to the :class:`py::class_` constructor: + +.. code-block:: cpp + + py::class_<Pet>(m, "Pet", py::dynamic_attr()) + .def(py::init<>()) + .def_readwrite("name", &Pet::name); + +Now everything works as expected: + +.. code-block:: pycon + + >>> p = example.Pet() + >>> p.name = 'Charly' # OK, overwrite value in C++ + >>> p.age = 2 # OK, dynamically add a new attribute + >>> p.__dict__ # just like a native Python class + {'age': 2} + +Note that there is a small runtime cost for a class with dynamic attributes. +Not only because of the addition of a ``__dict__``, but also because of more +expensive garbage collection tracking which must be activated to resolve +possible circular references. Native Python classes incur this same cost by +default, so this is not anything to worry about. By default, pybind11 classes +are more efficient than native Python classes. Enabling dynamic attributes +just brings them on par. + +.. _inheritance: + +Inheritance and automatic downcasting +===================================== + +Suppose now that the example consists of two data structures with an +inheritance relationship: + +.. code-block:: cpp + + struct Pet { + Pet(const std::string &name) : name(name) { } + std::string name; + }; + + struct Dog : Pet { + Dog(const std::string &name) : Pet(name) { } + std::string bark() const { return "woof!"; } + }; + +There are two different ways of indicating a hierarchical relationship to +pybind11: the first specifies the C++ base class as an extra template +parameter of the :class:`class_`: + +.. code-block:: cpp + + py::class_<Pet>(m, "Pet") + .def(py::init<const std::string &>()) + .def_readwrite("name", &Pet::name); + + // Method 1: template parameter: + py::class_<Dog, Pet /* <- specify C++ parent type */>(m, "Dog") + .def(py::init<const std::string &>()) + .def("bark", &Dog::bark); + +Alternatively, we can also assign a name to the previously bound ``Pet`` +:class:`class_` object and reference it when binding the ``Dog`` class: + +.. code-block:: cpp + + py::class_<Pet> pet(m, "Pet"); + pet.def(py::init<const std::string &>()) + .def_readwrite("name", &Pet::name); + + // Method 2: pass parent class_ object: + py::class_<Dog>(m, "Dog", pet /* <- specify Python parent type */) + .def(py::init<const std::string &>()) + .def("bark", &Dog::bark); + +Functionality-wise, both approaches are equivalent. Afterwards, instances will +expose fields and methods of both types: + +.. code-block:: pycon + + >>> p = example.Dog('Molly') + >>> p.name + u'Molly' + >>> p.bark() + u'woof!' + +The C++ classes defined above are regular non-polymorphic types with an +inheritance relationship. This is reflected in Python: + +.. code-block:: cpp + + // Return a base pointer to a derived instance + m.def("pet_store", []() { return std::unique_ptr<Pet>(new Dog("Molly")); }); + +.. code-block:: pycon + + >>> p = example.pet_store() + >>> type(p) # `Dog` instance behind `Pet` pointer + Pet # no pointer downcasting for regular non-polymorphic types + >>> p.bark() + AttributeError: 'Pet' object has no attribute 'bark' + +The function returned a ``Dog`` instance, but because it's a non-polymorphic +type behind a base pointer, Python only sees a ``Pet``. In C++, a type is only +considered polymorphic if it has at least one virtual function and pybind11 +will automatically recognize this: + +.. code-block:: cpp + + struct PolymorphicPet { + virtual ~PolymorphicPet() = default; + }; + + struct PolymorphicDog : PolymorphicPet { + std::string bark() const { return "woof!"; } + }; + + // Same binding code + py::class_<PolymorphicPet>(m, "PolymorphicPet"); + py::class_<PolymorphicDog, PolymorphicPet>(m, "PolymorphicDog") + .def(py::init<>()) + .def("bark", &PolymorphicDog::bark); + + // Again, return a base pointer to a derived instance + m.def("pet_store2", []() { return std::unique_ptr<PolymorphicPet>(new PolymorphicDog); }); + +.. code-block:: pycon + + >>> p = example.pet_store2() + >>> type(p) + PolymorphicDog # automatically downcast + >>> p.bark() + u'woof!' + +Given a pointer to a polymorphic base, pybind11 performs automatic downcasting +to the actual derived type. Note that this goes beyond the usual situation in +C++: we don't just get access to the virtual functions of the base, we get the +concrete derived type including functions and attributes that the base type may +not even be aware of. + +.. seealso:: + + For more information about polymorphic behavior see :ref:`overriding_virtuals`. + + +Overloaded methods +================== + +Sometimes there are several overloaded C++ methods with the same name taking +different kinds of input arguments: + +.. code-block:: cpp + + struct Pet { + Pet(const std::string &name, int age) : name(name), age(age) { } + + void set(int age_) { age = age_; } + void set(const std::string &name_) { name = name_; } + + std::string name; + int age; + }; + +Attempting to bind ``Pet::set`` will cause an error since the compiler does not +know which method the user intended to select. We can disambiguate by casting +them to function pointers. Binding multiple functions to the same Python name +automatically creates a chain of function overloads that will be tried in +sequence. + +.. code-block:: cpp + + py::class_<Pet>(m, "Pet") + .def(py::init<const std::string &, int>()) + .def("set", (void (Pet::*)(int)) &Pet::set, "Set the pet's age") + .def("set", (void (Pet::*)(const std::string &)) &Pet::set, "Set the pet's name"); + +The overload signatures are also visible in the method's docstring: + +.. code-block:: pycon + + >>> help(example.Pet) + + class Pet(__builtin__.object) + | Methods defined here: + | + | __init__(...) + | Signature : (Pet, str, int) -> NoneType + | + | set(...) + | 1. Signature : (Pet, int) -> NoneType + | + | Set the pet's age + | + | 2. Signature : (Pet, str) -> NoneType + | + | Set the pet's name + +If you have a C++14 compatible compiler [#cpp14]_, you can use an alternative +syntax to cast the overloaded function: + +.. code-block:: cpp + + py::class_<Pet>(m, "Pet") + .def("set", py::overload_cast<int>(&Pet::set), "Set the pet's age") + .def("set", py::overload_cast<const std::string &>(&Pet::set), "Set the pet's name"); + +Here, ``py::overload_cast`` only requires the parameter types to be specified. +The return type and class are deduced. This avoids the additional noise of +``void (Pet::*)()`` as seen in the raw cast. If a function is overloaded based +on constness, the ``py::const_`` tag should be used: + +.. code-block:: cpp + + struct Widget { + int foo(int x, float y); + int foo(int x, float y) const; + }; + + py::class_<Widget>(m, "Widget") + .def("foo_mutable", py::overload_cast<int, float>(&Widget::foo)) + .def("foo_const", py::overload_cast<int, float>(&Widget::foo, py::const_)); + + +.. [#cpp14] A compiler which supports the ``-std=c++14`` flag + or Visual Studio 2015 Update 2 and newer. + +.. note:: + + To define multiple overloaded constructors, simply declare one after the + other using the ``.def(py::init<...>())`` syntax. The existing machinery + for specifying keyword and default arguments also works. + +Enumerations and internal types +=============================== + +Let's now suppose that the example class contains an internal enumeration type, +e.g.: + +.. code-block:: cpp + + struct Pet { + enum Kind { + Dog = 0, + Cat + }; + + Pet(const std::string &name, Kind type) : name(name), type(type) { } + + std::string name; + Kind type; + }; + +The binding code for this example looks as follows: + +.. code-block:: cpp + + py::class_<Pet> pet(m, "Pet"); + + pet.def(py::init<const std::string &, Pet::Kind>()) + .def_readwrite("name", &Pet::name) + .def_readwrite("type", &Pet::type); + + py::enum_<Pet::Kind>(pet, "Kind") + .value("Dog", Pet::Kind::Dog) + .value("Cat", Pet::Kind::Cat) + .export_values(); + +To ensure that the ``Kind`` type is created within the scope of ``Pet``, the +``pet`` :class:`class_` instance must be supplied to the :class:`enum_`. +constructor. The :func:`enum_::export_values` function exports the enum entries +into the parent scope, which should be skipped for newer C++11-style strongly +typed enums. + +.. code-block:: pycon + + >>> p = Pet('Lucy', Pet.Cat) + >>> p.type + Kind.Cat + >>> int(p.type) + 1L + +The entries defined by the enumeration type are exposed in the ``__members__`` property: + +.. code-block:: pycon + + >>> Pet.Kind.__members__ + {'Dog': Kind.Dog, 'Cat': Kind.Cat} + +The ``name`` property returns the name of the enum value as a unicode string. + +.. note:: + + It is also possible to use ``str(enum)``, however these accomplish different + goals. The following shows how these two approaches differ. + + .. code-block:: pycon + + >>> p = Pet( "Lucy", Pet.Cat ) + >>> pet_type = p.type + >>> pet_type + Pet.Cat + >>> str(pet_type) + 'Pet.Cat' + >>> pet_type.name + 'Cat' + +.. note:: + + When the special tag ``py::arithmetic()`` is specified to the ``enum_`` + constructor, pybind11 creates an enumeration that also supports rudimentary + arithmetic and bit-level operations like comparisons, and, or, xor, negation, + etc. + + .. code-block:: cpp + + py::enum_<Pet::Kind>(pet, "Kind", py::arithmetic()) + ... + + By default, these are omitted to conserve space. diff --git a/pybind11/docs/compiling.rst b/pybind11/docs/compiling.rst new file mode 100644 index 0000000000000000000000000000000000000000..c50c7d8afbb9bf0fad068a35ad27d5d411dcbeda --- /dev/null +++ b/pybind11/docs/compiling.rst @@ -0,0 +1,289 @@ +.. _compiling: + +Build systems +############# + +Building with setuptools +======================== + +For projects on PyPI, building with setuptools is the way to go. Sylvain Corlay +has kindly provided an example project which shows how to set up everything, +including automatic generation of documentation using Sphinx. Please refer to +the [python_example]_ repository. + +.. [python_example] https://github.com/pybind/python_example + +Building with cppimport +======================== + +[cppimport]_ is a small Python import hook that determines whether there is a C++ +source file whose name matches the requested module. If there is, the file is +compiled as a Python extension using pybind11 and placed in the same folder as +the C++ source file. Python is then able to find the module and load it. + +.. [cppimport] https://github.com/tbenthompson/cppimport + +.. _cmake: + +Building with CMake +=================== + +For C++ codebases that have an existing CMake-based build system, a Python +extension module can be created with just a few lines of code: + +.. code-block:: cmake + + cmake_minimum_required(VERSION 2.8.12) + project(example) + + add_subdirectory(pybind11) + pybind11_add_module(example example.cpp) + +This assumes that the pybind11 repository is located in a subdirectory named +:file:`pybind11` and that the code is located in a file named :file:`example.cpp`. +The CMake command ``add_subdirectory`` will import the pybind11 project which +provides the ``pybind11_add_module`` function. It will take care of all the +details needed to build a Python extension module on any platform. + +A working sample project, including a way to invoke CMake from :file:`setup.py` for +PyPI integration, can be found in the [cmake_example]_ repository. + +.. [cmake_example] https://github.com/pybind/cmake_example + +pybind11_add_module +------------------- + +To ease the creation of Python extension modules, pybind11 provides a CMake +function with the following signature: + +.. code-block:: cmake + + pybind11_add_module(<name> [MODULE | SHARED] [EXCLUDE_FROM_ALL] + [NO_EXTRAS] [SYSTEM] [THIN_LTO] source1 [source2 ...]) + +This function behaves very much like CMake's builtin ``add_library`` (in fact, +it's a wrapper function around that command). It will add a library target +called ``<name>`` to be built from the listed source files. In addition, it +will take care of all the Python-specific compiler and linker flags as well +as the OS- and Python-version-specific file extension. The produced target +``<name>`` can be further manipulated with regular CMake commands. + +``MODULE`` or ``SHARED`` may be given to specify the type of library. If no +type is given, ``MODULE`` is used by default which ensures the creation of a +Python-exclusive module. Specifying ``SHARED`` will create a more traditional +dynamic library which can also be linked from elsewhere. ``EXCLUDE_FROM_ALL`` +removes this target from the default build (see CMake docs for details). + +Since pybind11 is a template library, ``pybind11_add_module`` adds compiler +flags to ensure high quality code generation without bloat arising from long +symbol names and duplication of code in different translation units. It +sets default visibility to *hidden*, which is required for some pybind11 +features and functionality when attempting to load multiple pybind11 modules +compiled under different pybind11 versions. It also adds additional flags +enabling LTO (Link Time Optimization) and strip unneeded symbols. See the +:ref:`FAQ entry <faq:symhidden>` for a more detailed explanation. These +latter optimizations are never applied in ``Debug`` mode. If ``NO_EXTRAS`` is +given, they will always be disabled, even in ``Release`` mode. However, this +will result in code bloat and is generally not recommended. + +By default, pybind11 and Python headers will be included with ``-I``. In order +to include pybind11 as system library, e.g. to avoid warnings in downstream +code with warn-levels outside of pybind11's scope, set the option ``SYSTEM``. + +As stated above, LTO is enabled by default. Some newer compilers also support +different flavors of LTO such as `ThinLTO`_. Setting ``THIN_LTO`` will cause +the function to prefer this flavor if available. The function falls back to +regular LTO if ``-flto=thin`` is not available. + +.. _ThinLTO: http://clang.llvm.org/docs/ThinLTO.html + +Configuration variables +----------------------- + +By default, pybind11 will compile modules with the C++14 standard, if available +on the target compiler, falling back to C++11 if C++14 support is not +available. Note, however, that this default is subject to change: future +pybind11 releases are expected to migrate to newer C++ standards as they become +available. To override this, the standard flag can be given explicitly in +``PYBIND11_CPP_STANDARD``: + +.. code-block:: cmake + + # Use just one of these: + # GCC/clang: + set(PYBIND11_CPP_STANDARD -std=c++11) + set(PYBIND11_CPP_STANDARD -std=c++14) + set(PYBIND11_CPP_STANDARD -std=c++1z) # Experimental C++17 support + # MSVC: + set(PYBIND11_CPP_STANDARD /std:c++14) + set(PYBIND11_CPP_STANDARD /std:c++latest) # Enables some MSVC C++17 features + + add_subdirectory(pybind11) # or find_package(pybind11) + +Note that this and all other configuration variables must be set **before** the +call to ``add_subdirectory`` or ``find_package``. The variables can also be set +when calling CMake from the command line using the ``-D<variable>=<value>`` flag. + +The target Python version can be selected by setting ``PYBIND11_PYTHON_VERSION`` +or an exact Python installation can be specified with ``PYTHON_EXECUTABLE``. +For example: + +.. code-block:: bash + + cmake -DPYBIND11_PYTHON_VERSION=3.6 .. + # or + cmake -DPYTHON_EXECUTABLE=path/to/python .. + +find_package vs. add_subdirectory +--------------------------------- + +For CMake-based projects that don't include the pybind11 repository internally, +an external installation can be detected through ``find_package(pybind11)``. +See the `Config file`_ docstring for details of relevant CMake variables. + +.. code-block:: cmake + + cmake_minimum_required(VERSION 2.8.12) + project(example) + + find_package(pybind11 REQUIRED) + pybind11_add_module(example example.cpp) + +Note that ``find_package(pybind11)`` will only work correctly if pybind11 +has been correctly installed on the system, e. g. after downloading or cloning +the pybind11 repository : + +.. code-block:: bash + + cd pybind11 + mkdir build + cd build + cmake .. + make install + +Once detected, the aforementioned ``pybind11_add_module`` can be employed as +before. The function usage and configuration variables are identical no matter +if pybind11 is added as a subdirectory or found as an installed package. You +can refer to the same [cmake_example]_ repository for a full sample project +-- just swap out ``add_subdirectory`` for ``find_package``. + +.. _Config file: https://github.com/pybind/pybind11/blob/master/tools/pybind11Config.cmake.in + +Advanced: interface library target +---------------------------------- + +When using a version of CMake greater than 3.0, pybind11 can additionally +be used as a special *interface library* . The target ``pybind11::module`` +is available with pybind11 headers, Python headers and libraries as needed, +and C++ compile definitions attached. This target is suitable for linking +to an independently constructed (through ``add_library``, not +``pybind11_add_module``) target in the consuming project. + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.0) + project(example) + + find_package(pybind11 REQUIRED) # or add_subdirectory(pybind11) + + add_library(example MODULE main.cpp) + target_link_libraries(example PRIVATE pybind11::module) + set_target_properties(example PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}" + SUFFIX "${PYTHON_MODULE_EXTENSION}") + +.. warning:: + + Since pybind11 is a metatemplate library, it is crucial that certain + compiler flags are provided to ensure high quality code generation. In + contrast to the ``pybind11_add_module()`` command, the CMake interface + library only provides the *minimal* set of parameters to ensure that the + code using pybind11 compiles, but it does **not** pass these extra compiler + flags (i.e. this is up to you). + + These include Link Time Optimization (``-flto`` on GCC/Clang/ICPC, ``/GL`` + and ``/LTCG`` on Visual Studio) and .OBJ files with many sections on Visual + Studio (``/bigobj``). The :ref:`FAQ <faq:symhidden>` contains an + explanation on why these are needed. + +Embedding the Python interpreter +-------------------------------- + +In addition to extension modules, pybind11 also supports embedding Python into +a C++ executable or library. In CMake, simply link with the ``pybind11::embed`` +target. It provides everything needed to get the interpreter running. The Python +headers and libraries are attached to the target. Unlike ``pybind11::module``, +there is no need to manually set any additional properties here. For more +information about usage in C++, see :doc:`/advanced/embedding`. + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.0) + project(example) + + find_package(pybind11 REQUIRED) # or add_subdirectory(pybind11) + + add_executable(example main.cpp) + target_link_libraries(example PRIVATE pybind11::embed) + +.. _building_manually: + +Building manually +================= + +pybind11 is a header-only library, hence it is not necessary to link against +any special libraries and there are no intermediate (magic) translation steps. + +On Linux, you can compile an example such as the one given in +:ref:`simple_example` using the following command: + +.. code-block:: bash + + $ c++ -O3 -Wall -shared -std=c++11 -fPIC `python3 -m pybind11 --includes` example.cpp -o example`python3-config --extension-suffix` + +The flags given here assume that you're using Python 3. For Python 2, just +change the executable appropriately (to ``python`` or ``python2``). + +The ``python3 -m pybind11 --includes`` command fetches the include paths for +both pybind11 and Python headers. This assumes that pybind11 has been installed +using ``pip`` or ``conda``. If it hasn't, you can also manually specify +``-I <path-to-pybind11>/include`` together with the Python includes path +``python3-config --includes``. + +Note that Python 2.7 modules don't use a special suffix, so you should simply +use ``example.so`` instead of ``example`python3-config --extension-suffix```. +Besides, the ``--extension-suffix`` option may or may not be available, depending +on the distribution; in the latter case, the module extension can be manually +set to ``.so``. + +On Mac OS: the build command is almost the same but it also requires passing +the ``-undefined dynamic_lookup`` flag so as to ignore missing symbols when +building the module: + +.. code-block:: bash + + $ c++ -O3 -Wall -shared -std=c++11 -undefined dynamic_lookup `python3 -m pybind11 --includes` example.cpp -o example`python3-config --extension-suffix` + +In general, it is advisable to include several additional build parameters +that can considerably reduce the size of the created binary. Refer to section +:ref:`cmake` for a detailed example of a suitable cross-platform CMake-based +build system that works on all platforms including Windows. + +.. note:: + + On Linux and macOS, it's better to (intentionally) not link against + ``libpython``. The symbols will be resolved when the extension library + is loaded into a Python binary. This is preferable because you might + have several different installations of a given Python version (e.g. the + system-provided Python, and one that ships with a piece of commercial + software). In this way, the plugin will work with both versions, instead + of possibly importing a second Python library into a process that already + contains one (which will lead to a segfault). + +Generating binding code automatically +===================================== + +The ``Binder`` project is a tool for automatic generation of pybind11 binding +code by introspecting existing C++ codebases using LLVM/Clang. See the +[binder]_ documentation for details. + +.. [binder] http://cppbinder.readthedocs.io/en/latest/about.html diff --git a/pybind11/docs/conf.py b/pybind11/docs/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..54879dd357e27ec3f96ce6ba7d4051db4dd3169c --- /dev/null +++ b/pybind11/docs/conf.py @@ -0,0 +1,319 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# pybind11 documentation build configuration file, created by +# sphinx-quickstart on Sun Oct 11 19:23:48 2015. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex +import subprocess + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['breathe'] + +breathe_projects = {'pybind11': '.build/doxygenxml/'} +breathe_default_project = 'pybind11' +breathe_domain_by_extension = {'h': 'cpp'} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['.templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'pybind11' +copyright = '2017, Wenzel Jakob' +author = 'Wenzel Jakob' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '2.3' +# The full version, including alpha/beta/rc tags. +release = '2.3.dev1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['.build', 'release.rst'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +default_role = 'any' + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +#pygments_style = 'monokai' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. + +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + + html_context = {'css_files': ['_static/theme_overrides.css']} +else: + html_context = { + 'css_files': [ + '//media.readthedocs.org/css/sphinx_rtd_theme.css', + '//media.readthedocs.org/css/readthedocs-doc-embed.css', '_static/theme_overrides.css' + ] + } + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# "<project> v<release> documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'pybind11doc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + 'preamble': '\DeclareUnicodeCharacter{00A0}{}', + + # Latex figure (float) alignment + #'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'pybind11.tex', 'pybind11 Documentation', 'Wenzel Jakob', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = 'pybind11-logo.png' + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [(master_doc, 'pybind11', 'pybind11 Documentation', [author], 1)] + +# If true, show URL addresses after external links. +#man_show_urls = False + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'pybind11', 'pybind11 Documentation', author, 'pybind11', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + +primary_domain = 'cpp' +highlight_language = 'cpp' + + +def generate_doxygen_xml(app): + build_dir = os.path.join(app.confdir, '.build') + if not os.path.exists(build_dir): + os.mkdir(build_dir) + + try: + subprocess.call(['doxygen', '--version']) + retcode = subprocess.call(['doxygen'], cwd=app.confdir) + if retcode < 0: + sys.stderr.write("doxygen error code: {}\n".format(-retcode)) + except OSError as e: + sys.stderr.write("doxygen execution failed: {}\n".format(e)) + + +def setup(app): + """Add hook for building doxygen xml when needed""" + app.connect("builder-inited", generate_doxygen_xml) diff --git a/pybind11/docs/faq.rst b/pybind11/docs/faq.rst new file mode 100644 index 0000000000000000000000000000000000000000..93ccf10e57c16d07e585331d9839d43b4b5ddc39 --- /dev/null +++ b/pybind11/docs/faq.rst @@ -0,0 +1,297 @@ +Frequently asked questions +########################## + +"ImportError: dynamic module does not define init function" +=========================================================== + +1. Make sure that the name specified in PYBIND11_MODULE is identical to the +filename of the extension library (without prefixes such as .so) + +2. If the above did not fix the issue, you are likely using an incompatible +version of Python (for instance, the extension library was compiled against +Python 2, while the interpreter is running on top of some version of Python +3, or vice versa). + +"Symbol not found: ``__Py_ZeroStruct`` / ``_PyInstanceMethod_Type``" +======================================================================== + +See the first answer. + +"SystemError: dynamic module not initialized properly" +====================================================== + +See the first answer. + +The Python interpreter immediately crashes when importing my module +=================================================================== + +See the first answer. + +CMake doesn't detect the right Python version +============================================= + +The CMake-based build system will try to automatically detect the installed +version of Python and link against that. When this fails, or when there are +multiple versions of Python and it finds the wrong one, delete +``CMakeCache.txt`` and then invoke CMake as follows: + +.. code-block:: bash + + cmake -DPYTHON_EXECUTABLE:FILEPATH=<path-to-python-executable> . + +.. _faq_reference_arguments: + +Limitations involving reference arguments +========================================= + +In C++, it's fairly common to pass arguments using mutable references or +mutable pointers, which allows both read and write access to the value +supplied by the caller. This is sometimes done for efficiency reasons, or to +realize functions that have multiple return values. Here are two very basic +examples: + +.. code-block:: cpp + + void increment(int &i) { i++; } + void increment_ptr(int *i) { (*i)++; } + +In Python, all arguments are passed by reference, so there is no general +issue in binding such code from Python. + +However, certain basic Python types (like ``str``, ``int``, ``bool``, +``float``, etc.) are **immutable**. This means that the following attempt +to port the function to Python doesn't have the same effect on the value +provided by the caller -- in fact, it does nothing at all. + +.. code-block:: python + + def increment(i): + i += 1 # nope.. + +pybind11 is also affected by such language-level conventions, which means that +binding ``increment`` or ``increment_ptr`` will also create Python functions +that don't modify their arguments. + +Although inconvenient, one workaround is to encapsulate the immutable types in +a custom type that does allow modifications. + +An other alternative involves binding a small wrapper lambda function that +returns a tuple with all output arguments (see the remainder of the +documentation for examples on binding lambda functions). An example: + +.. code-block:: cpp + + int foo(int &i) { i++; return 123; } + +and the binding code + +.. code-block:: cpp + + m.def("foo", [](int i) { int rv = foo(i); return std::make_tuple(rv, i); }); + + +How can I reduce the build time? +================================ + +It's good practice to split binding code over multiple files, as in the +following example: + +:file:`example.cpp`: + +.. code-block:: cpp + + void init_ex1(py::module &); + void init_ex2(py::module &); + /* ... */ + + PYBIND11_MODULE(example, m) { + init_ex1(m); + init_ex2(m); + /* ... */ + } + +:file:`ex1.cpp`: + +.. code-block:: cpp + + void init_ex1(py::module &m) { + m.def("add", [](int a, int b) { return a + b; }); + } + +:file:`ex2.cpp`: + +.. code-block:: cpp + + void init_ex2(py::module &m) { + m.def("sub", [](int a, int b) { return a - b; }); + } + +:command:`python`: + +.. code-block:: pycon + + >>> import example + >>> example.add(1, 2) + 3 + >>> example.sub(1, 1) + 0 + +As shown above, the various ``init_ex`` functions should be contained in +separate files that can be compiled independently from one another, and then +linked together into the same final shared object. Following this approach +will: + +1. reduce memory requirements per compilation unit. + +2. enable parallel builds (if desired). + +3. allow for faster incremental builds. For instance, when a single class + definition is changed, only a subset of the binding code will generally need + to be recompiled. + +"recursive template instantiation exceeded maximum depth of 256" +================================================================ + +If you receive an error about excessive recursive template evaluation, try +specifying a larger value, e.g. ``-ftemplate-depth=1024`` on GCC/Clang. The +culprit is generally the generation of function signatures at compile time +using C++14 template metaprogramming. + +.. _`faq:hidden_visibility`: + +"‘SomeClass’ declared with greater visibility than the type of its field ‘SomeClass::member’ [-Wattributes]" +============================================================================================================ + +This error typically indicates that you are compiling without the required +``-fvisibility`` flag. pybind11 code internally forces hidden visibility on +all internal code, but if non-hidden (and thus *exported*) code attempts to +include a pybind type (for example, ``py::object`` or ``py::list``) you can run +into this warning. + +To avoid it, make sure you are specifying ``-fvisibility=hidden`` when +compiling pybind code. + +As to why ``-fvisibility=hidden`` is necessary, because pybind modules could +have been compiled under different versions of pybind itself, it is also +important that the symbols defined in one module do not clash with the +potentially-incompatible symbols defined in another. While Python extension +modules are usually loaded with localized symbols (under POSIX systems +typically using ``dlopen`` with the ``RTLD_LOCAL`` flag), this Python default +can be changed, but even if it isn't it is not always enough to guarantee +complete independence of the symbols involved when not using +``-fvisibility=hidden``. + +Additionally, ``-fvisiblity=hidden`` can deliver considerably binary size +savings. (See the following section for more details). + + +.. _`faq:symhidden`: + +How can I create smaller binaries? +================================== + +To do its job, pybind11 extensively relies on a programming technique known as +*template metaprogramming*, which is a way of performing computation at compile +time using type information. Template metaprogamming usually instantiates code +involving significant numbers of deeply nested types that are either completely +removed or reduced to just a few instructions during the compiler's optimization +phase. However, due to the nested nature of these types, the resulting symbol +names in the compiled extension library can be extremely long. For instance, +the included test suite contains the following symbol: + +.. only:: html + + .. code-block:: none + + _​_​Z​N​8​p​y​b​i​n​d​1​1​1​2​c​p​p​_​f​u​n​c​t​i​o​n​C​1​I​v​8​E​x​a​m​p​l​e​2​J​R​N​S​t​3​_​_​1​6​v​e​c​t​o​r​I​N​S​3​_​1​2​b​a​s​i​c​_​s​t​r​i​n​g​I​w​N​S​3​_​1​1​c​h​a​r​_​t​r​a​i​t​s​I​w​E​E​N​S​3​_​9​a​l​l​o​c​a​t​o​r​I​w​E​E​E​E​N​S​8​_​I​S​A​_​E​E​E​E​E​J​N​S​_​4​n​a​m​e​E​N​S​_​7​s​i​b​l​i​n​g​E​N​S​_​9​i​s​_​m​e​t​h​o​d​E​A​2​8​_​c​E​E​E​M​T​0​_​F​T​_​D​p​T​1​_​E​D​p​R​K​T​2​_ + +.. only:: not html + + .. code-block:: cpp + + __ZN8pybind1112cpp_functionC1Iv8Example2JRNSt3__16vectorINS3_12basic_stringIwNS3_11char_traitsIwEENS3_9allocatorIwEEEENS8_ISA_EEEEEJNS_4nameENS_7siblingENS_9is_methodEA28_cEEEMT0_FT_DpT1_EDpRKT2_ + +which is the mangled form of the following function type: + +.. code-block:: cpp + + pybind11::cpp_function::cpp_function<void, Example2, std::__1::vector<std::__1::basic_string<wchar_t, std::__1::char_traits<wchar_t>, std::__1::allocator<wchar_t> >, std::__1::allocator<std::__1::basic_string<wchar_t, std::__1::char_traits<wchar_t>, std::__1::allocator<wchar_t> > > >&, pybind11::name, pybind11::sibling, pybind11::is_method, char [28]>(void (Example2::*)(std::__1::vector<std::__1::basic_string<wchar_t, std::__1::char_traits<wchar_t>, std::__1::allocator<wchar_t> >, std::__1::allocator<std::__1::basic_string<wchar_t, std::__1::char_traits<wchar_t>, std::__1::allocator<wchar_t> > > >&), pybind11::name const&, pybind11::sibling const&, pybind11::is_method const&, char const (&) [28]) + +The memory needed to store just the mangled name of this function (196 bytes) +is larger than the actual piece of code (111 bytes) it represents! On the other +hand, it's silly to even give this function a name -- after all, it's just a +tiny cog in a bigger piece of machinery that is not exposed to the outside +world. So we'll generally only want to export symbols for those functions which +are actually called from the outside. + +This can be achieved by specifying the parameter ``-fvisibility=hidden`` to GCC +and Clang, which sets the default symbol visibility to *hidden*, which has a +tremendous impact on the final binary size of the resulting extension library. +(On Visual Studio, symbols are already hidden by default, so nothing needs to +be done there.) + +In addition to decreasing binary size, ``-fvisibility=hidden`` also avoids +potential serious issues when loading multiple modules and is required for +proper pybind operation. See the previous FAQ entry for more details. + +Working with ancient Visual Studio 2008 builds on Windows +========================================================= + +The official Windows distributions of Python are compiled using truly +ancient versions of Visual Studio that lack good C++11 support. Some users +implicitly assume that it would be impossible to load a plugin built with +Visual Studio 2015 into a Python distribution that was compiled using Visual +Studio 2008. However, no such issue exists: it's perfectly legitimate to +interface DLLs that are built with different compilers and/or C libraries. +Common gotchas to watch out for involve not ``free()``-ing memory region +that that were ``malloc()``-ed in another shared library, using data +structures with incompatible ABIs, and so on. pybind11 is very careful not +to make these types of mistakes. + +Inconsistent detection of Python version in CMake and pybind11 +============================================================== + +The functions ``find_package(PythonInterp)`` and ``find_package(PythonLibs)`` provided by CMake +for Python version detection are not used by pybind11 due to unreliability and limitations that make +them unsuitable for pybind11's needs. Instead pybind provides its own, more reliable Python detection +CMake code. Conflicts can arise, however, when using pybind11 in a project that *also* uses the CMake +Python detection in a system with several Python versions installed. + +This difference may cause inconsistencies and errors if *both* mechanisms are used in the same project. Consider the following +Cmake code executed in a system with Python 2.7 and 3.x installed: + +.. code-block:: cmake + + find_package(PythonInterp) + find_package(PythonLibs) + find_package(pybind11) + +It will detect Python 2.7 and pybind11 will pick it as well. + +In contrast this code: + +.. code-block:: cmake + + find_package(pybind11) + find_package(PythonInterp) + find_package(PythonLibs) + +will detect Python 3.x for pybind11 and may crash on ``find_package(PythonLibs)`` afterwards. + +It is advised to avoid using ``find_package(PythonInterp)`` and ``find_package(PythonLibs)`` from CMake and rely +on pybind11 in detecting Python version. If this is not possible CMake machinery should be called *before* including pybind11. + +How to cite this project? +========================= + +We suggest the following BibTeX template to cite pybind11 in scientific +discourse: + +.. code-block:: bash + + @misc{pybind11, + author = {Wenzel Jakob and Jason Rhinelander and Dean Moldovan}, + year = {2017}, + note = {https://github.com/pybind/pybind11}, + title = {pybind11 -- Seamless operability between C++11 and Python} + } diff --git a/pybind11/docs/index.rst b/pybind11/docs/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..d236611b7224454415f395194cb72f783a42af37 --- /dev/null +++ b/pybind11/docs/index.rst @@ -0,0 +1,47 @@ +.. only: not latex + + .. image:: pybind11-logo.png + +pybind11 --- Seamless operability between C++11 and Python +========================================================== + +.. only: not latex + + Contents: + +.. toctree:: + :maxdepth: 1 + + intro + changelog + upgrade + +.. toctree:: + :caption: The Basics + :maxdepth: 2 + + basics + classes + compiling + +.. toctree:: + :caption: Advanced Topics + :maxdepth: 2 + + advanced/functions + advanced/classes + advanced/exceptions + advanced/smart_ptrs + advanced/cast/index + advanced/pycpp/index + advanced/embedding + advanced/misc + +.. toctree:: + :caption: Extra Information + :maxdepth: 1 + + faq + benchmark + limitations + reference diff --git a/pybind11/docs/intro.rst b/pybind11/docs/intro.rst new file mode 100644 index 0000000000000000000000000000000000000000..10e1799a19d4a2be8efb8f58515b290ef36514f8 --- /dev/null +++ b/pybind11/docs/intro.rst @@ -0,0 +1,93 @@ +.. image:: pybind11-logo.png + +About this project +================== +**pybind11** is a lightweight header-only library that exposes C++ types in Python +and vice versa, mainly to create Python bindings of existing C++ code. Its +goals and syntax are similar to the excellent `Boost.Python`_ library by David +Abrahams: to minimize boilerplate code in traditional extension modules by +inferring type information using compile-time introspection. + +.. _Boost.Python: http://www.boost.org/doc/libs/release/libs/python/doc/index.html + +The main issue with Boost.Python—and the reason for creating such a similar +project—is Boost. Boost is an enormously large and complex suite of utility +libraries that works with almost every C++ compiler in existence. This +compatibility has its cost: arcane template tricks and workarounds are +necessary to support the oldest and buggiest of compiler specimens. Now that +C++11-compatible compilers are widely available, this heavy machinery has +become an excessively large and unnecessary dependency. +Think of this library as a tiny self-contained version of Boost.Python with +everything stripped away that isn't relevant for binding generation. Without +comments, the core header files only require ~4K lines of code and depend on +Python (2.7 or 3.x, or PyPy2.7 >= 5.7) and the C++ standard library. This +compact implementation was possible thanks to some of the new C++11 language +features (specifically: tuples, lambda functions and variadic templates). Since +its creation, this library has grown beyond Boost.Python in many ways, leading +to dramatically simpler binding code in many common situations. + +Core features +************* +The following core C++ features can be mapped to Python + +- Functions accepting and returning custom data structures per value, reference, or pointer +- Instance methods and static methods +- Overloaded functions +- Instance attributes and static attributes +- Arbitrary exception types +- Enumerations +- Callbacks +- Iterators and ranges +- Custom operators +- Single and multiple inheritance +- STL data structures +- Smart pointers with reference counting like ``std::shared_ptr`` +- Internal references with correct reference counting +- C++ classes with virtual (and pure virtual) methods can be extended in Python + +Goodies +******* +In addition to the core functionality, pybind11 provides some extra goodies: + +- Python 2.7, 3.x, and PyPy (PyPy2.7 >= 5.7) are supported with an + implementation-agnostic interface. + +- It is possible to bind C++11 lambda functions with captured variables. The + lambda capture data is stored inside the resulting Python function object. + +- pybind11 uses C++11 move constructors and move assignment operators whenever + possible to efficiently transfer custom data types. + +- It's easy to expose the internal storage of custom data types through + Pythons' buffer protocols. This is handy e.g. for fast conversion between + C++ matrix classes like Eigen and NumPy without expensive copy operations. + +- pybind11 can automatically vectorize functions so that they are transparently + applied to all entries of one or more NumPy array arguments. + +- Python's slice-based access and assignment operations can be supported with + just a few lines of code. + +- Everything is contained in just a few header files; there is no need to link + against any additional libraries. + +- Binaries are generally smaller by a factor of at least 2 compared to + equivalent bindings generated by Boost.Python. A recent pybind11 conversion + of `PyRosetta`_, an enormous Boost.Python binding project, reported a binary + size reduction of **5.4x** and compile time reduction by **5.8x**. + +- Function signatures are precomputed at compile time (using ``constexpr``), + leading to smaller binaries. + +- With little extra effort, C++ types can be pickled and unpickled similar to + regular Python objects. + +.. _PyRosetta: http://graylab.jhu.edu/RosettaCon2016/PyRosetta-4.pdf + +Supported compilers +******************* + +1. Clang/LLVM (any non-ancient version with C++11 support) +2. GCC 4.8 or newer +3. Microsoft Visual Studio 2015 or newer +4. Intel C++ compiler v17 or newer (v16 with pybind11 v2.0 and v15 with pybind11 v2.0 and a `workaround <https://github.com/pybind/pybind11/issues/276>`_ ) diff --git a/pybind11/docs/limitations.rst b/pybind11/docs/limitations.rst new file mode 100644 index 0000000000000000000000000000000000000000..a1a4f1affa2c9b993fe8749a102088171daa6e22 --- /dev/null +++ b/pybind11/docs/limitations.rst @@ -0,0 +1,20 @@ +Limitations +########### + +pybind11 strives to be a general solution to binding generation, but it also has +certain limitations: + +- pybind11 casts away ``const``-ness in function arguments and return values. + This is in line with the Python language, which has no concept of ``const`` + values. This means that some additional care is needed to avoid bugs that + would be caught by the type checker in a traditional C++ program. + +- The NumPy interface ``pybind11::array`` greatly simplifies accessing + numerical data from C++ (and vice versa), but it's not a full-blown array + class like ``Eigen::Array`` or ``boost.multi_array``. + +These features could be implemented but would lead to a significant increase in +complexity. I've decided to draw the line here to keep this project simple and +compact. Users who absolutely require these features are encouraged to fork +pybind11. + diff --git a/pybind11/docs/pybind11-logo.png b/pybind11/docs/pybind11-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..4cbad54f797d3ced04d4048f282df5e4336d4af4 Binary files /dev/null and b/pybind11/docs/pybind11-logo.png differ diff --git a/pybind11/docs/pybind11_vs_boost_python1.png b/pybind11/docs/pybind11_vs_boost_python1.png new file mode 100644 index 0000000000000000000000000000000000000000..833231f240809884fb6eb4079db528b9b3c0a9ac Binary files /dev/null and b/pybind11/docs/pybind11_vs_boost_python1.png differ diff --git a/pybind11/docs/pybind11_vs_boost_python1.svg b/pybind11/docs/pybind11_vs_boost_python1.svg new file mode 100644 index 0000000000000000000000000000000000000000..5bf950e6fdc81676d9a9774926a623b4f6a2e2a8 --- /dev/null +++ b/pybind11/docs/pybind11_vs_boost_python1.svg @@ -0,0 +1,427 @@ +<?xml version="1.0" encoding="UTF-8"?> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="468pt" height="252pt" viewBox="0 0 468 252" version="1.1"> +<defs> +<g> +<symbol overflow="visible" id="glyph0-0"> +<path style="stroke:none;" d=""/> +</symbol> +<symbol overflow="visible" id="glyph0-1"> +<path style="stroke:none;" d="M 3.726562 0 L 2.847656 0 L 2.847656 -5.601562 C 2.636719 -5.398438 2.359375 -5.195312 2.015625 -4.996094 C 1.671875 -4.792969 1.363281 -4.640625 1.089844 -4.539062 L 1.089844 -5.390625 C 1.582031 -5.621094 2.011719 -5.902344 2.378906 -6.230469 C 2.746094 -6.558594 3.007812 -6.878906 3.160156 -7.1875 L 3.726562 -7.1875 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-2"> +<path style="stroke:none;" d="M 0.414062 -3.53125 C 0.414062 -4.375 0.503906 -5.058594 0.675781 -5.574219 C 0.851562 -6.089844 1.109375 -6.488281 1.453125 -6.765625 C 1.796875 -7.046875 2.226562 -7.1875 2.75 -7.1875 C 3.132812 -7.1875 3.46875 -7.109375 3.757812 -6.957031 C 4.046875 -6.800781 4.289062 -6.578125 4.476562 -6.285156 C 4.664062 -5.996094 4.8125 -5.640625 4.921875 -5.222656 C 5.03125 -4.804688 5.082031 -4.238281 5.082031 -3.53125 C 5.082031 -2.691406 4.996094 -2.011719 4.824219 -1.496094 C 4.652344 -0.980469 4.394531 -0.582031 4.050781 -0.300781 C 3.707031 -0.0195312 3.273438 0.121094 2.75 0.121094 C 2.058594 0.121094 1.515625 -0.125 1.125 -0.621094 C 0.652344 -1.214844 0.414062 -2.1875 0.414062 -3.53125 Z M 1.320312 -3.53125 C 1.320312 -2.355469 1.457031 -1.574219 1.730469 -1.183594 C 2.007812 -0.796875 2.34375 -0.601562 2.75 -0.601562 C 3.152344 -0.601562 3.492188 -0.796875 3.765625 -1.1875 C 4.042969 -1.578125 4.179688 -2.359375 4.179688 -3.53125 C 4.179688 -4.710938 4.042969 -5.492188 3.765625 -5.878906 C 3.492188 -6.265625 3.148438 -6.460938 2.738281 -6.460938 C 2.335938 -6.460938 2.011719 -6.289062 1.773438 -5.945312 C 1.46875 -5.511719 1.320312 -4.707031 1.320312 -3.53125 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-3"> +<path style="stroke:none;" d="M 5.035156 -0.84375 L 5.035156 0 L 0.304688 0 C 0.296875 -0.210938 0.332031 -0.414062 0.40625 -0.609375 C 0.527344 -0.933594 0.71875 -1.25 0.984375 -1.5625 C 1.25 -1.875 1.632812 -2.234375 2.132812 -2.648438 C 2.910156 -3.285156 3.4375 -3.789062 3.710938 -4.164062 C 3.984375 -4.535156 4.121094 -4.886719 4.121094 -5.21875 C 4.121094 -5.566406 3.996094 -5.863281 3.746094 -6.101562 C 3.5 -6.339844 3.171875 -6.460938 2.773438 -6.460938 C 2.351562 -6.460938 2.011719 -6.332031 1.757812 -6.078125 C 1.503906 -5.824219 1.375 -5.472656 1.371094 -5.023438 L 0.46875 -5.117188 C 0.53125 -5.789062 0.761719 -6.304688 1.167969 -6.65625 C 1.570312 -7.011719 2.113281 -7.1875 2.792969 -7.1875 C 3.480469 -7.1875 4.023438 -6.996094 4.421875 -6.617188 C 4.824219 -6.234375 5.023438 -5.761719 5.023438 -5.199219 C 5.023438 -4.914062 4.964844 -4.632812 4.847656 -4.355469 C 4.730469 -4.078125 4.535156 -3.789062 4.265625 -3.480469 C 3.992188 -3.175781 3.542969 -2.753906 2.910156 -2.222656 C 2.382812 -1.78125 2.042969 -1.480469 1.894531 -1.320312 C 1.746094 -1.164062 1.621094 -1.003906 1.523438 -0.84375 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-4"> +<path style="stroke:none;" d="M 0.414062 -1.875 L 1.335938 -1.953125 C 1.40625 -1.503906 1.566406 -1.167969 1.8125 -0.941406 C 2.0625 -0.714844 2.363281 -0.601562 2.714844 -0.601562 C 3.136719 -0.601562 3.496094 -0.761719 3.789062 -1.078125 C 4.082031 -1.398438 4.226562 -1.820312 4.226562 -2.347656 C 4.226562 -2.851562 4.085938 -3.246094 3.804688 -3.535156 C 3.523438 -3.824219 3.15625 -3.96875 2.699219 -3.96875 C 2.417969 -3.96875 2.160156 -3.90625 1.933594 -3.777344 C 1.707031 -3.648438 1.527344 -3.480469 1.398438 -3.277344 L 0.570312 -3.382812 L 1.265625 -7.0625 L 4.824219 -7.0625 L 4.824219 -6.21875 L 1.96875 -6.21875 L 1.582031 -4.296875 C 2.011719 -4.597656 2.460938 -4.746094 2.933594 -4.746094 C 3.558594 -4.746094 4.085938 -4.53125 4.515625 -4.097656 C 4.945312 -3.664062 5.160156 -3.105469 5.160156 -2.425781 C 5.160156 -1.777344 4.972656 -1.21875 4.59375 -0.746094 C 4.136719 -0.167969 3.507812 0.121094 2.714844 0.121094 C 2.0625 0.121094 1.53125 -0.0585938 1.121094 -0.425781 C 0.710938 -0.789062 0.472656 -1.273438 0.414062 -1.875 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-5"> +<path style="stroke:none;" d="M 0.820312 0 L 0.820312 -7.15625 L 5.648438 -7.15625 L 5.648438 -6.3125 L 1.765625 -6.3125 L 1.765625 -4.097656 L 5.125 -4.097656 L 5.125 -3.25 L 1.765625 -3.25 L 1.765625 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-6"> +<path style="stroke:none;" d="M 4.058594 0 L 4.058594 -0.761719 C 3.65625 -0.175781 3.105469 0.117188 2.414062 0.117188 C 2.105469 0.117188 1.820312 0.0585938 1.554688 -0.0585938 C 1.289062 -0.175781 1.09375 -0.324219 0.964844 -0.5 C 0.835938 -0.679688 0.746094 -0.894531 0.695312 -1.152344 C 0.65625 -1.324219 0.640625 -1.597656 0.640625 -1.972656 L 0.640625 -5.1875 L 1.519531 -5.1875 L 1.519531 -2.308594 C 1.519531 -1.851562 1.535156 -1.542969 1.570312 -1.382812 C 1.625 -1.152344 1.746094 -0.96875 1.921875 -0.835938 C 2.101562 -0.703125 2.324219 -0.640625 2.585938 -0.640625 C 2.851562 -0.640625 3.097656 -0.707031 3.328125 -0.84375 C 3.5625 -0.976562 3.726562 -1.160156 3.820312 -1.394531 C 3.917969 -1.625 3.964844 -1.964844 3.964844 -2.40625 L 3.964844 -5.1875 L 4.84375 -5.1875 L 4.84375 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-7"> +<path style="stroke:none;" d="M 0.660156 0 L 0.660156 -5.1875 L 1.449219 -5.1875 L 1.449219 -4.449219 C 1.832031 -5.019531 2.382812 -5.304688 3.101562 -5.304688 C 3.414062 -5.304688 3.699219 -5.246094 3.960938 -5.132812 C 4.222656 -5.023438 4.421875 -4.875 4.550781 -4.691406 C 4.679688 -4.507812 4.773438 -4.292969 4.824219 -4.042969 C 4.855469 -3.878906 4.875 -3.59375 4.875 -3.1875 L 4.875 0 L 3.992188 0 L 3.992188 -3.15625 C 3.992188 -3.511719 3.960938 -3.78125 3.890625 -3.957031 C 3.824219 -4.132812 3.703125 -4.277344 3.527344 -4.382812 C 3.351562 -4.488281 3.148438 -4.539062 2.914062 -4.539062 C 2.539062 -4.539062 2.21875 -4.421875 1.945312 -4.183594 C 1.671875 -3.945312 1.539062 -3.496094 1.539062 -2.832031 L 1.539062 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-8"> +<path style="stroke:none;" d="M 4.042969 -1.898438 L 4.90625 -1.789062 C 4.8125 -1.191406 4.570312 -0.726562 4.183594 -0.386719 C 3.792969 -0.0507812 3.316406 0.117188 2.75 0.117188 C 2.039062 0.117188 1.46875 -0.113281 1.039062 -0.578125 C 0.605469 -1.042969 0.390625 -1.707031 0.390625 -2.574219 C 0.390625 -3.132812 0.484375 -3.625 0.667969 -4.042969 C 0.855469 -4.460938 1.136719 -4.777344 1.515625 -4.988281 C 1.894531 -5.199219 2.308594 -5.304688 2.753906 -5.304688 C 3.316406 -5.304688 3.777344 -5.160156 4.136719 -4.875 C 4.492188 -4.589844 4.722656 -4.1875 4.824219 -3.664062 L 3.96875 -3.53125 C 3.886719 -3.878906 3.746094 -4.140625 3.539062 -4.316406 C 3.332031 -4.492188 3.082031 -4.578125 2.789062 -4.578125 C 2.34375 -4.578125 1.984375 -4.421875 1.710938 -4.105469 C 1.433594 -3.789062 1.292969 -3.285156 1.292969 -2.597656 C 1.292969 -1.902344 1.425781 -1.394531 1.695312 -1.078125 C 1.960938 -0.761719 2.308594 -0.605469 2.738281 -0.605469 C 3.085938 -0.605469 3.371094 -0.710938 3.601562 -0.921875 C 3.835938 -1.132812 3.980469 -1.460938 4.042969 -1.898438 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-9"> +<path style="stroke:none;" d="M 2.578125 -0.785156 L 2.703125 -0.0078125 C 2.457031 0.0429688 2.234375 0.0703125 2.039062 0.0703125 C 1.722656 0.0703125 1.476562 0.0195312 1.296875 -0.0820312 C 1.121094 -0.183594 1 -0.316406 0.929688 -0.480469 C 0.855469 -0.644531 0.820312 -0.992188 0.820312 -1.519531 L 0.820312 -4.5 L 0.175781 -4.5 L 0.175781 -5.1875 L 0.820312 -5.1875 L 0.820312 -6.46875 L 1.695312 -6.996094 L 1.695312 -5.1875 L 2.578125 -5.1875 L 2.578125 -4.5 L 1.695312 -4.5 L 1.695312 -1.46875 C 1.695312 -1.21875 1.710938 -1.058594 1.742188 -0.984375 C 1.773438 -0.914062 1.820312 -0.859375 1.890625 -0.816406 C 1.960938 -0.773438 2.0625 -0.75 2.191406 -0.75 C 2.289062 -0.75 2.417969 -0.761719 2.578125 -0.785156 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-10"> +<path style="stroke:none;" d="M 0.664062 -6.148438 L 0.664062 -7.15625 L 1.542969 -7.15625 L 1.542969 -6.148438 Z M 0.664062 0 L 0.664062 -5.1875 L 1.542969 -5.1875 L 1.542969 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-11"> +<path style="stroke:none;" d="M 0.332031 -2.59375 C 0.332031 -3.554688 0.597656 -4.265625 1.132812 -4.726562 C 1.578125 -5.109375 2.121094 -5.304688 2.765625 -5.304688 C 3.476562 -5.304688 4.058594 -5.070312 4.511719 -4.601562 C 4.964844 -4.132812 5.191406 -3.488281 5.191406 -2.664062 C 5.191406 -2 5.089844 -1.472656 4.890625 -1.089844 C 4.691406 -0.707031 4.398438 -0.410156 4.015625 -0.199219 C 3.632812 0.0117188 3.214844 0.117188 2.765625 0.117188 C 2.039062 0.117188 1.449219 -0.117188 1.003906 -0.582031 C 0.554688 -1.046875 0.332031 -1.71875 0.332031 -2.59375 Z M 1.234375 -2.59375 C 1.234375 -1.929688 1.378906 -1.429688 1.671875 -1.101562 C 1.960938 -0.769531 2.324219 -0.605469 2.765625 -0.605469 C 3.199219 -0.605469 3.5625 -0.773438 3.851562 -1.101562 C 4.140625 -1.433594 4.289062 -1.941406 4.289062 -2.621094 C 4.289062 -3.261719 4.140625 -3.75 3.851562 -4.078125 C 3.558594 -4.410156 3.195312 -4.574219 2.765625 -4.574219 C 2.324219 -4.574219 1.960938 -4.410156 1.671875 -4.082031 C 1.382812 -3.753906 1.234375 -3.257812 1.234375 -2.59375 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-12"> +<path style="stroke:none;" d="M 0.308594 -1.546875 L 1.175781 -1.683594 C 1.226562 -1.335938 1.363281 -1.070312 1.585938 -0.882812 C 1.808594 -0.699219 2.117188 -0.605469 2.519531 -0.605469 C 2.921875 -0.605469 3.222656 -0.6875 3.417969 -0.851562 C 3.613281 -1.015625 3.710938 -1.210938 3.710938 -1.429688 C 3.710938 -1.628906 3.625 -1.785156 3.453125 -1.898438 C 3.332031 -1.976562 3.03125 -2.078125 2.554688 -2.195312 C 1.910156 -2.359375 1.460938 -2.5 1.214844 -2.621094 C 0.964844 -2.738281 0.777344 -2.902344 0.648438 -3.113281 C 0.519531 -3.324219 0.453125 -3.554688 0.453125 -3.808594 C 0.453125 -4.039062 0.507812 -4.253906 0.613281 -4.449219 C 0.71875 -4.648438 0.863281 -4.8125 1.046875 -4.941406 C 1.183594 -5.042969 1.367188 -5.128906 1.605469 -5.199219 C 1.839844 -5.269531 2.09375 -5.304688 2.363281 -5.304688 C 2.769531 -5.304688 3.128906 -5.242188 3.433594 -5.125 C 3.742188 -5.007812 3.96875 -4.851562 4.117188 -4.652344 C 4.261719 -4.453125 4.363281 -4.183594 4.417969 -3.847656 L 3.558594 -3.730469 C 3.519531 -3.996094 3.40625 -4.207031 3.21875 -4.355469 C 3.03125 -4.503906 2.769531 -4.578125 2.425781 -4.578125 C 2.023438 -4.578125 1.734375 -4.511719 1.5625 -4.378906 C 1.390625 -4.246094 1.304688 -4.089844 1.304688 -3.910156 C 1.304688 -3.796875 1.339844 -3.695312 1.410156 -3.601562 C 1.484375 -3.507812 1.59375 -3.429688 1.75 -3.367188 C 1.835938 -3.335938 2.09375 -3.261719 2.523438 -3.144531 C 3.144531 -2.976562 3.578125 -2.84375 3.824219 -2.738281 C 4.070312 -2.632812 4.265625 -2.476562 4.40625 -2.273438 C 4.546875 -2.074219 4.613281 -1.824219 4.613281 -1.523438 C 4.613281 -1.230469 4.527344 -0.953125 4.359375 -0.695312 C 4.1875 -0.4375 3.941406 -0.238281 3.617188 -0.09375 C 3.296875 0.046875 2.929688 0.117188 2.523438 0.117188 C 1.851562 0.117188 1.335938 -0.0234375 0.984375 -0.304688 C 0.632812 -0.582031 0.40625 -0.996094 0.308594 -1.546875 Z "/> +</symbol> +<symbol overflow="visible" id="glyph1-0"> +<path style="stroke:none;" d=""/> +</symbol> +<symbol overflow="visible" id="glyph1-1"> +<path style="stroke:none;" d="M -2.300781 -0.449219 L -2.378906 -1.34375 C -2.019531 -1.386719 -1.726562 -1.484375 -1.496094 -1.636719 C -1.265625 -1.792969 -1.082031 -2.03125 -0.941406 -2.359375 C -0.796875 -2.683594 -0.726562 -3.050781 -0.726562 -3.457031 C -0.726562 -3.820312 -0.78125 -4.136719 -0.890625 -4.414062 C -0.996094 -4.691406 -1.144531 -4.898438 -1.332031 -5.03125 C -1.519531 -5.167969 -1.722656 -5.234375 -1.945312 -5.234375 C -2.167969 -5.234375 -2.363281 -5.167969 -2.53125 -5.039062 C -2.699219 -4.910156 -2.839844 -4.695312 -2.953125 -4.394531 C -3.027344 -4.203125 -3.144531 -3.777344 -3.304688 -3.121094 C -3.460938 -2.460938 -3.609375 -2 -3.75 -1.738281 C -3.929688 -1.398438 -4.152344 -1.140625 -4.417969 -0.972656 C -4.683594 -0.804688 -4.980469 -0.722656 -5.308594 -0.722656 C -5.667969 -0.722656 -6.007812 -0.824219 -6.320312 -1.03125 C -6.632812 -1.234375 -6.875 -1.535156 -7.035156 -1.929688 C -7.199219 -2.324219 -7.28125 -2.761719 -7.28125 -3.242188 C -7.28125 -3.773438 -7.195312 -4.242188 -7.023438 -4.644531 C -6.851562 -5.050781 -6.601562 -5.363281 -6.269531 -5.582031 C -5.9375 -5.800781 -5.5625 -5.917969 -5.140625 -5.933594 L -5.074219 -5.023438 C -5.527344 -4.976562 -5.867188 -4.808594 -6.097656 -4.527344 C -6.328125 -4.246094 -6.445312 -3.832031 -6.445312 -3.28125 C -6.445312 -2.707031 -6.339844 -2.289062 -6.128906 -2.027344 C -5.921875 -1.765625 -5.667969 -1.636719 -5.371094 -1.636719 C -5.113281 -1.636719 -4.902344 -1.726562 -4.734375 -1.914062 C -4.570312 -2.097656 -4.398438 -2.574219 -4.226562 -3.34375 C -4.050781 -4.113281 -3.898438 -4.640625 -3.769531 -4.925781 C -3.578125 -5.34375 -3.335938 -5.652344 -3.039062 -5.851562 C -2.746094 -6.046875 -2.40625 -6.148438 -2.023438 -6.148438 C -1.640625 -6.148438 -1.28125 -6.039062 -0.945312 -5.820312 C -0.609375 -5.601562 -0.347656 -5.289062 -0.160156 -4.878906 C 0.0273438 -4.472656 0.121094 -4.011719 0.121094 -3.5 C 0.121094 -2.851562 0.0273438 -2.308594 -0.160156 -1.871094 C -0.351562 -1.433594 -0.632812 -1.089844 -1.011719 -0.84375 C -1.390625 -0.59375 -1.820312 -0.460938 -2.300781 -0.449219 Z "/> +</symbol> +<symbol overflow="visible" id="glyph1-2"> +<path style="stroke:none;" d="M -1.671875 -4.210938 L -1.558594 -5.117188 C -1.027344 -4.972656 -0.617188 -4.707031 -0.320312 -4.320312 C -0.0273438 -3.933594 0.117188 -3.4375 0.117188 -2.835938 C 0.117188 -2.078125 -0.117188 -1.476562 -0.582031 -1.03125 C -1.050781 -0.585938 -1.707031 -0.367188 -2.546875 -0.367188 C -3.421875 -0.367188 -4.097656 -0.589844 -4.578125 -1.039062 C -5.0625 -1.488281 -5.304688 -2.070312 -5.304688 -2.789062 C -5.304688 -3.480469 -5.066406 -4.046875 -4.59375 -4.488281 C -4.121094 -4.925781 -3.457031 -5.148438 -2.601562 -5.148438 C -2.550781 -5.148438 -2.472656 -5.144531 -2.367188 -5.140625 L -2.367188 -1.273438 C -1.796875 -1.304688 -1.363281 -1.46875 -1.058594 -1.757812 C -0.757812 -2.046875 -0.605469 -2.410156 -0.605469 -2.84375 C -0.605469 -3.164062 -0.691406 -3.4375 -0.859375 -3.667969 C -1.027344 -3.894531 -1.296875 -4.074219 -1.671875 -4.210938 Z M -3.089844 -1.324219 L -3.089844 -4.21875 C -3.527344 -4.179688 -3.855469 -4.070312 -4.070312 -3.886719 C -4.410156 -3.605469 -4.578125 -3.242188 -4.578125 -2.796875 C -4.578125 -2.394531 -4.445312 -2.054688 -4.175781 -1.78125 C -3.90625 -1.503906 -3.542969 -1.351562 -3.089844 -1.324219 Z "/> +</symbol> +<symbol overflow="visible" id="glyph1-3"> +<path style="stroke:none;" d="M -1.898438 -4.042969 L -1.789062 -4.90625 C -1.191406 -4.8125 -0.726562 -4.570312 -0.386719 -4.183594 C -0.0507812 -3.792969 0.117188 -3.316406 0.117188 -2.75 C 0.117188 -2.039062 -0.113281 -1.46875 -0.578125 -1.039062 C -1.042969 -0.605469 -1.707031 -0.390625 -2.574219 -0.390625 C -3.132812 -0.390625 -3.625 -0.484375 -4.042969 -0.667969 C -4.460938 -0.855469 -4.777344 -1.136719 -4.988281 -1.515625 C -5.199219 -1.894531 -5.304688 -2.308594 -5.304688 -2.753906 C -5.304688 -3.316406 -5.160156 -3.777344 -4.875 -4.136719 C -4.589844 -4.492188 -4.1875 -4.722656 -3.664062 -4.824219 L -3.53125 -3.96875 C -3.878906 -3.886719 -4.140625 -3.746094 -4.316406 -3.539062 C -4.492188 -3.332031 -4.578125 -3.082031 -4.578125 -2.789062 C -4.578125 -2.34375 -4.421875 -1.984375 -4.105469 -1.710938 C -3.789062 -1.433594 -3.285156 -1.292969 -2.597656 -1.292969 C -1.902344 -1.292969 -1.394531 -1.425781 -1.078125 -1.695312 C -0.761719 -1.960938 -0.605469 -2.308594 -0.605469 -2.738281 C -0.605469 -3.085938 -0.710938 -3.371094 -0.921875 -3.601562 C -1.132812 -3.835938 -1.460938 -3.980469 -1.898438 -4.042969 Z "/> +</symbol> +<symbol overflow="visible" id="glyph1-4"> +<path style="stroke:none;" d="M -2.59375 -0.332031 C -3.554688 -0.332031 -4.265625 -0.597656 -4.726562 -1.132812 C -5.109375 -1.578125 -5.304688 -2.121094 -5.304688 -2.765625 C -5.304688 -3.476562 -5.070312 -4.058594 -4.601562 -4.511719 C -4.132812 -4.964844 -3.488281 -5.191406 -2.664062 -5.191406 C -2 -5.191406 -1.472656 -5.089844 -1.089844 -4.890625 C -0.707031 -4.691406 -0.410156 -4.398438 -0.199219 -4.015625 C 0.0117188 -3.632812 0.117188 -3.214844 0.117188 -2.765625 C 0.117188 -2.039062 -0.117188 -1.449219 -0.582031 -1.003906 C -1.046875 -0.554688 -1.71875 -0.332031 -2.59375 -0.332031 Z M -2.59375 -1.234375 C -1.929688 -1.234375 -1.429688 -1.378906 -1.101562 -1.671875 C -0.769531 -1.960938 -0.605469 -2.324219 -0.605469 -2.765625 C -0.605469 -3.199219 -0.773438 -3.5625 -1.101562 -3.851562 C -1.433594 -4.140625 -1.941406 -4.289062 -2.621094 -4.289062 C -3.261719 -4.289062 -3.75 -4.140625 -4.078125 -3.851562 C -4.410156 -3.558594 -4.574219 -3.195312 -4.574219 -2.765625 C -4.574219 -2.324219 -4.410156 -1.960938 -4.082031 -1.671875 C -3.753906 -1.382812 -3.257812 -1.234375 -2.59375 -1.234375 Z "/> +</symbol> +<symbol overflow="visible" id="glyph1-5"> +<path style="stroke:none;" d="M 0 -0.660156 L -5.1875 -0.660156 L -5.1875 -1.449219 L -4.449219 -1.449219 C -5.019531 -1.832031 -5.304688 -2.382812 -5.304688 -3.101562 C -5.304688 -3.414062 -5.246094 -3.699219 -5.132812 -3.960938 C -5.023438 -4.222656 -4.875 -4.421875 -4.691406 -4.550781 C -4.507812 -4.679688 -4.292969 -4.773438 -4.042969 -4.824219 C -3.878906 -4.855469 -3.59375 -4.875 -3.1875 -4.875 L 0 -4.875 L 0 -3.992188 L -3.15625 -3.992188 C -3.511719 -3.992188 -3.78125 -3.960938 -3.957031 -3.890625 C -4.132812 -3.824219 -4.277344 -3.703125 -4.382812 -3.527344 C -4.488281 -3.351562 -4.539062 -3.148438 -4.539062 -2.914062 C -4.539062 -2.539062 -4.421875 -2.21875 -4.183594 -1.945312 C -3.945312 -1.671875 -3.496094 -1.539062 -2.832031 -1.539062 L 0 -1.539062 Z "/> +</symbol> +<symbol overflow="visible" id="glyph1-6"> +<path style="stroke:none;" d="M 0 -4.023438 L -0.65625 -4.023438 C -0.140625 -3.695312 0.117188 -3.210938 0.117188 -2.574219 C 0.117188 -2.160156 0.00390625 -1.78125 -0.226562 -1.433594 C -0.453125 -1.085938 -0.769531 -0.816406 -1.179688 -0.628906 C -1.585938 -0.4375 -2.058594 -0.34375 -2.585938 -0.34375 C -3.105469 -0.34375 -3.574219 -0.429688 -3.996094 -0.601562 C -4.417969 -0.773438 -4.742188 -1.03125 -4.964844 -1.375 C -5.191406 -1.722656 -5.304688 -2.109375 -5.304688 -2.535156 C -5.304688 -2.847656 -5.238281 -3.125 -5.105469 -3.367188 C -4.972656 -3.613281 -4.800781 -3.8125 -4.589844 -3.964844 L -7.15625 -3.964844 L -7.15625 -4.839844 L 0 -4.839844 Z M -2.585938 -1.246094 C -1.921875 -1.246094 -1.425781 -1.386719 -1.097656 -1.664062 C -0.769531 -1.945312 -0.605469 -2.273438 -0.605469 -2.65625 C -0.605469 -3.039062 -0.761719 -3.367188 -1.078125 -3.636719 C -1.390625 -3.90625 -1.871094 -4.039062 -2.515625 -4.039062 C -3.226562 -4.039062 -3.746094 -3.902344 -4.078125 -3.628906 C -4.410156 -3.355469 -4.574219 -3.015625 -4.574219 -2.617188 C -4.574219 -2.226562 -4.414062 -1.898438 -4.097656 -1.636719 C -3.777344 -1.375 -3.273438 -1.246094 -2.585938 -1.246094 Z "/> +</symbol> +<symbol overflow="visible" id="glyph1-7"> +<path style="stroke:none;" d="M -1.546875 -0.308594 L -1.683594 -1.175781 C -1.335938 -1.226562 -1.070312 -1.363281 -0.882812 -1.585938 C -0.699219 -1.808594 -0.605469 -2.117188 -0.605469 -2.519531 C -0.605469 -2.921875 -0.6875 -3.222656 -0.851562 -3.417969 C -1.015625 -3.613281 -1.210938 -3.710938 -1.429688 -3.710938 C -1.628906 -3.710938 -1.785156 -3.625 -1.898438 -3.453125 C -1.976562 -3.332031 -2.078125 -3.03125 -2.195312 -2.554688 C -2.359375 -1.910156 -2.5 -1.460938 -2.621094 -1.214844 C -2.738281 -0.964844 -2.902344 -0.777344 -3.113281 -0.648438 C -3.324219 -0.519531 -3.554688 -0.453125 -3.808594 -0.453125 C -4.039062 -0.453125 -4.253906 -0.507812 -4.449219 -0.613281 C -4.648438 -0.71875 -4.8125 -0.863281 -4.941406 -1.046875 C -5.042969 -1.183594 -5.128906 -1.367188 -5.199219 -1.605469 C -5.269531 -1.839844 -5.304688 -2.09375 -5.304688 -2.363281 C -5.304688 -2.769531 -5.242188 -3.128906 -5.125 -3.433594 C -5.007812 -3.742188 -4.851562 -3.96875 -4.652344 -4.117188 C -4.453125 -4.261719 -4.183594 -4.363281 -3.847656 -4.417969 L -3.730469 -3.558594 C -3.996094 -3.519531 -4.207031 -3.40625 -4.355469 -3.21875 C -4.503906 -3.03125 -4.578125 -2.769531 -4.578125 -2.425781 C -4.578125 -2.023438 -4.511719 -1.734375 -4.378906 -1.5625 C -4.246094 -1.390625 -4.089844 -1.304688 -3.910156 -1.304688 C -3.796875 -1.304688 -3.695312 -1.339844 -3.601562 -1.410156 C -3.507812 -1.484375 -3.429688 -1.59375 -3.367188 -1.75 C -3.335938 -1.835938 -3.261719 -2.09375 -3.144531 -2.523438 C -2.976562 -3.144531 -2.84375 -3.578125 -2.738281 -3.824219 C -2.632812 -4.070312 -2.476562 -4.265625 -2.273438 -4.40625 C -2.074219 -4.546875 -1.824219 -4.613281 -1.523438 -4.613281 C -1.230469 -4.613281 -0.953125 -4.527344 -0.695312 -4.359375 C -0.4375 -4.1875 -0.238281 -3.941406 -0.09375 -3.617188 C 0.046875 -3.296875 0.117188 -2.929688 0.117188 -2.523438 C 0.117188 -1.851562 -0.0234375 -1.335938 -0.304688 -0.984375 C -0.582031 -0.632812 -0.996094 -0.40625 -1.546875 -0.308594 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-0"> +<path style="stroke:none;" d=""/> +</symbol> +<symbol overflow="visible" id="glyph2-1"> +<path style="stroke:none;" d="M 7.054688 -3.011719 L 8.191406 -2.726562 C 7.953125 -1.792969 7.523438 -1.078125 6.90625 -0.589844 C 6.285156 -0.0976562 5.53125 0.148438 4.632812 0.148438 C 3.707031 0.148438 2.957031 -0.0429688 2.375 -0.417969 C 1.796875 -0.796875 1.355469 -1.34375 1.050781 -2.054688 C 0.75 -2.769531 0.597656 -3.539062 0.597656 -4.359375 C 0.597656 -5.253906 0.769531 -6.035156 1.109375 -6.699219 C 1.453125 -7.367188 1.9375 -7.871094 2.570312 -8.21875 C 3.199219 -8.5625 3.894531 -8.734375 4.652344 -8.734375 C 5.511719 -8.734375 6.234375 -8.515625 6.820312 -8.078125 C 7.40625 -7.640625 7.8125 -7.027344 8.046875 -6.234375 L 6.925781 -5.96875 C 6.726562 -6.59375 6.4375 -7.050781 6.058594 -7.335938 C 5.679688 -7.621094 5.203125 -7.765625 4.628906 -7.765625 C 3.96875 -7.765625 3.417969 -7.605469 2.972656 -7.289062 C 2.53125 -6.972656 2.21875 -6.546875 2.039062 -6.015625 C 1.859375 -5.480469 1.769531 -4.929688 1.769531 -4.367188 C 1.769531 -3.636719 1.875 -2.996094 2.089844 -2.453125 C 2.300781 -1.90625 2.632812 -1.5 3.082031 -1.230469 C 3.53125 -0.960938 4.015625 -0.828125 4.539062 -0.828125 C 5.175781 -0.828125 5.71875 -1.007812 6.15625 -1.375 C 6.597656 -1.742188 6.898438 -2.289062 7.054688 -3.011719 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-2"> +<path style="stroke:none;" d="M 0.398438 -3.109375 C 0.398438 -4.261719 0.71875 -5.117188 1.359375 -5.671875 C 1.894531 -6.132812 2.546875 -6.363281 3.316406 -6.363281 C 4.171875 -6.363281 4.871094 -6.082031 5.414062 -5.523438 C 5.957031 -4.960938 6.226562 -4.1875 6.226562 -3.199219 C 6.226562 -2.398438 6.109375 -1.769531 5.867188 -1.308594 C 5.628906 -0.851562 5.277344 -0.492188 4.820312 -0.242188 C 4.359375 0.0117188 3.859375 0.140625 3.316406 0.140625 C 2.445312 0.140625 1.742188 -0.140625 1.203125 -0.695312 C 0.667969 -1.253906 0.398438 -2.0625 0.398438 -3.109375 Z M 1.484375 -3.109375 C 1.484375 -2.3125 1.65625 -1.71875 2.003906 -1.320312 C 2.351562 -0.925781 2.789062 -0.726562 3.316406 -0.726562 C 3.839844 -0.726562 4.273438 -0.925781 4.625 -1.324219 C 4.972656 -1.722656 5.144531 -2.328125 5.144531 -3.148438 C 5.144531 -3.917969 4.96875 -4.5 4.621094 -4.894531 C 4.269531 -5.292969 3.835938 -5.492188 3.316406 -5.492188 C 2.789062 -5.492188 2.351562 -5.292969 2.003906 -4.898438 C 1.65625 -4.503906 1.484375 -3.90625 1.484375 -3.109375 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-3"> +<path style="stroke:none;" d="M 0.789062 0 L 0.789062 -6.222656 L 1.734375 -6.222656 L 1.734375 -5.351562 C 1.929688 -5.65625 2.1875 -5.898438 2.515625 -6.085938 C 2.839844 -6.269531 3.207031 -6.363281 3.621094 -6.363281 C 4.082031 -6.363281 4.460938 -6.265625 4.753906 -6.078125 C 5.050781 -5.886719 5.257812 -5.617188 5.378906 -5.273438 C 5.871094 -6 6.511719 -6.363281 7.300781 -6.363281 C 7.917969 -6.363281 8.390625 -6.191406 8.726562 -5.851562 C 9.058594 -5.507812 9.222656 -4.984375 9.222656 -4.273438 L 9.222656 0 L 8.171875 0 L 8.171875 -3.921875 C 8.171875 -4.34375 8.140625 -4.644531 8.070312 -4.832031 C 8.003906 -5.015625 7.878906 -5.164062 7.699219 -5.28125 C 7.519531 -5.394531 7.308594 -5.449219 7.066406 -5.449219 C 6.628906 -5.449219 6.265625 -5.304688 5.976562 -5.011719 C 5.6875 -4.722656 5.542969 -4.257812 5.542969 -3.617188 L 5.542969 0 L 4.488281 0 L 4.488281 -4.042969 C 4.488281 -4.511719 4.402344 -4.863281 4.230469 -5.097656 C 4.058594 -5.332031 3.777344 -5.449219 3.386719 -5.449219 C 3.089844 -5.449219 2.816406 -5.371094 2.5625 -5.214844 C 2.3125 -5.058594 2.128906 -4.828125 2.015625 -4.53125 C 1.902344 -4.230469 1.84375 -3.796875 1.84375 -3.226562 L 1.84375 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-4"> +<path style="stroke:none;" d="M 0.789062 2.382812 L 0.789062 -6.222656 L 1.75 -6.222656 L 1.75 -5.414062 C 1.976562 -5.730469 2.234375 -5.96875 2.519531 -6.125 C 2.804688 -6.285156 3.148438 -6.363281 3.554688 -6.363281 C 4.085938 -6.363281 4.554688 -6.226562 4.960938 -5.953125 C 5.367188 -5.679688 5.675781 -5.292969 5.882812 -4.796875 C 6.089844 -4.296875 6.195312 -3.75 6.195312 -3.15625 C 6.195312 -2.519531 6.078125 -1.949219 5.851562 -1.4375 C 5.621094 -0.929688 5.289062 -0.539062 4.855469 -0.265625 C 4.417969 0.00390625 3.960938 0.140625 3.480469 0.140625 C 3.128906 0.140625 2.8125 0.0664062 2.535156 -0.0820312 C 2.253906 -0.230469 2.023438 -0.417969 1.84375 -0.644531 L 1.84375 2.382812 Z M 1.746094 -3.078125 C 1.746094 -2.277344 1.90625 -1.683594 2.234375 -1.300781 C 2.558594 -0.917969 2.949219 -0.726562 3.410156 -0.726562 C 3.878906 -0.726562 4.28125 -0.925781 4.613281 -1.320312 C 4.949219 -1.71875 5.117188 -2.332031 5.117188 -3.164062 C 5.117188 -3.957031 4.953125 -4.550781 4.625 -4.945312 C 4.300781 -5.339844 3.910156 -5.539062 3.457031 -5.539062 C 3.007812 -5.539062 2.609375 -5.328125 2.265625 -4.90625 C 1.917969 -4.488281 1.746094 -3.875 1.746094 -3.078125 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-5"> +<path style="stroke:none;" d="M 0.796875 -7.375 L 0.796875 -8.589844 L 1.851562 -8.589844 L 1.851562 -7.375 Z M 0.796875 0 L 0.796875 -6.222656 L 1.851562 -6.222656 L 1.851562 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-6"> +<path style="stroke:none;" d="M 0.765625 0 L 0.765625 -8.589844 L 1.820312 -8.589844 L 1.820312 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-7"> +<path style="stroke:none;" d="M 4.851562 -0.765625 C 4.460938 -0.433594 4.085938 -0.203125 3.722656 -0.0625 C 3.363281 0.0742188 2.976562 0.140625 2.5625 0.140625 C 1.878906 0.140625 1.351562 -0.0273438 0.984375 -0.359375 C 0.617188 -0.695312 0.433594 -1.121094 0.433594 -1.640625 C 0.433594 -1.945312 0.503906 -2.222656 0.640625 -2.476562 C 0.78125 -2.726562 0.960938 -2.929688 1.1875 -3.082031 C 1.410156 -3.234375 1.664062 -3.351562 1.945312 -3.429688 C 2.152344 -3.484375 2.464844 -3.535156 2.882812 -3.585938 C 3.734375 -3.6875 4.359375 -3.808594 4.765625 -3.949219 C 4.769531 -4.09375 4.769531 -4.1875 4.769531 -4.226562 C 4.769531 -4.65625 4.671875 -4.957031 4.46875 -5.132812 C 4.199219 -5.371094 3.800781 -5.492188 3.269531 -5.492188 C 2.773438 -5.492188 2.40625 -5.402344 2.171875 -5.230469 C 1.933594 -5.054688 1.757812 -4.75 1.648438 -4.304688 L 0.617188 -4.445312 C 0.710938 -4.886719 0.863281 -5.246094 1.078125 -5.515625 C 1.292969 -5.789062 1.601562 -5.996094 2.007812 -6.144531 C 2.414062 -6.289062 2.886719 -6.363281 3.421875 -6.363281 C 3.953125 -6.363281 4.382812 -6.300781 4.71875 -6.175781 C 5.050781 -6.050781 5.292969 -5.894531 5.449219 -5.703125 C 5.605469 -5.515625 5.714844 -5.273438 5.777344 -4.984375 C 5.8125 -4.804688 5.828125 -4.484375 5.828125 -4.015625 L 5.828125 -2.609375 C 5.828125 -1.628906 5.851562 -1.007812 5.898438 -0.746094 C 5.941406 -0.488281 6.03125 -0.238281 6.164062 0 L 5.0625 0 C 4.953125 -0.21875 4.882812 -0.476562 4.851562 -0.765625 Z M 4.765625 -3.125 C 4.382812 -2.96875 3.804688 -2.835938 3.039062 -2.726562 C 2.605469 -2.664062 2.300781 -2.59375 2.121094 -2.515625 C 1.941406 -2.4375 1.804688 -2.320312 1.703125 -2.171875 C 1.605469 -2.019531 1.558594 -1.851562 1.558594 -1.671875 C 1.558594 -1.390625 1.664062 -1.15625 1.878906 -0.96875 C 2.089844 -0.78125 2.402344 -0.6875 2.8125 -0.6875 C 3.21875 -0.6875 3.578125 -0.773438 3.898438 -0.953125 C 4.214844 -1.128906 4.445312 -1.375 4.59375 -1.679688 C 4.707031 -1.917969 4.765625 -2.273438 4.765625 -2.734375 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-8"> +<path style="stroke:none;" d="M 3.09375 -0.945312 L 3.246094 -0.0117188 C 2.949219 0.0507812 2.683594 0.0820312 2.449219 0.0820312 C 2.066406 0.0820312 1.769531 0.0234375 1.558594 -0.101562 C 1.347656 -0.222656 1.199219 -0.378906 1.113281 -0.578125 C 1.027344 -0.773438 0.984375 -1.1875 0.984375 -1.820312 L 0.984375 -5.402344 L 0.210938 -5.402344 L 0.210938 -6.222656 L 0.984375 -6.222656 L 0.984375 -7.765625 L 2.03125 -8.398438 L 2.03125 -6.222656 L 3.09375 -6.222656 L 3.09375 -5.402344 L 2.03125 -5.402344 L 2.03125 -1.765625 C 2.03125 -1.464844 2.050781 -1.269531 2.089844 -1.183594 C 2.125 -1.097656 2.1875 -1.03125 2.269531 -0.976562 C 2.355469 -0.925781 2.476562 -0.902344 2.632812 -0.902344 C 2.75 -0.902344 2.902344 -0.914062 3.09375 -0.945312 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-9"> +<path style="stroke:none;" d="M 0.789062 0 L 0.789062 -6.222656 L 1.742188 -6.222656 L 1.742188 -5.335938 C 2.199219 -6.019531 2.859375 -6.363281 3.71875 -6.363281 C 4.09375 -6.363281 4.441406 -6.296875 4.753906 -6.160156 C 5.070312 -6.027344 5.304688 -5.851562 5.460938 -5.632812 C 5.617188 -5.414062 5.726562 -5.152344 5.789062 -4.851562 C 5.828125 -4.65625 5.847656 -4.3125 5.847656 -3.828125 L 5.847656 0 L 4.792969 0 L 4.792969 -3.785156 C 4.792969 -4.214844 4.75 -4.535156 4.671875 -4.75 C 4.589844 -4.960938 4.441406 -5.132812 4.234375 -5.257812 C 4.023438 -5.386719 3.78125 -5.449219 3.5 -5.449219 C 3.050781 -5.449219 2.660156 -5.304688 2.335938 -5.023438 C 2.007812 -4.738281 1.84375 -4.195312 1.84375 -3.398438 L 1.84375 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-10"> +<path style="stroke:none;" d="M 5.050781 -2.003906 L 6.140625 -1.867188 C 5.96875 -1.230469 5.648438 -0.738281 5.1875 -0.386719 C 4.722656 -0.0351562 4.125 0.140625 3.40625 0.140625 C 2.496094 0.140625 1.773438 -0.140625 1.238281 -0.699219 C 0.707031 -1.261719 0.4375 -2.046875 0.4375 -3.058594 C 0.4375 -4.105469 0.710938 -4.917969 1.25 -5.496094 C 1.789062 -6.074219 2.484375 -6.363281 3.34375 -6.363281 C 4.175781 -6.363281 4.859375 -6.078125 5.382812 -5.515625 C 5.910156 -4.949219 6.175781 -4.148438 6.175781 -3.125 C 6.175781 -3.0625 6.171875 -2.96875 6.171875 -2.84375 L 1.53125 -2.84375 C 1.570312 -2.160156 1.761719 -1.632812 2.109375 -1.273438 C 2.457031 -0.910156 2.890625 -0.726562 3.410156 -0.726562 C 3.796875 -0.726562 4.125 -0.828125 4.398438 -1.03125 C 4.671875 -1.234375 4.890625 -1.558594 5.050781 -2.003906 Z M 1.585938 -3.710938 L 5.0625 -3.710938 C 5.015625 -4.234375 4.882812 -4.625 4.664062 -4.886719 C 4.328125 -5.292969 3.890625 -5.496094 3.359375 -5.496094 C 2.875 -5.496094 2.464844 -5.335938 2.136719 -5.007812 C 1.804688 -4.683594 1.625 -4.25 1.585938 -3.710938 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-11"> +<path style="stroke:none;" d="M 1.042969 0 L 1.042969 -5.402344 L 0.109375 -5.402344 L 0.109375 -6.222656 L 1.042969 -6.222656 L 1.042969 -6.882812 C 1.042969 -7.300781 1.078125 -7.613281 1.15625 -7.816406 C 1.257812 -8.089844 1.433594 -8.3125 1.691406 -8.480469 C 1.945312 -8.652344 2.304688 -8.734375 2.765625 -8.734375 C 3.0625 -8.734375 3.390625 -8.703125 3.75 -8.632812 L 3.59375 -7.710938 C 3.375 -7.75 3.164062 -7.769531 2.96875 -7.769531 C 2.648438 -7.769531 2.421875 -7.703125 2.289062 -7.5625 C 2.15625 -7.425781 2.09375 -7.171875 2.09375 -6.796875 L 2.09375 -6.222656 L 3.304688 -6.222656 L 3.304688 -5.402344 L 2.09375 -5.402344 L 2.09375 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-12"> +<path style="stroke:none;" d="M 4.828125 0 L 4.828125 -0.785156 C 4.433594 -0.167969 3.851562 0.140625 3.085938 0.140625 C 2.589844 0.140625 2.136719 0.00390625 1.71875 -0.269531 C 1.304688 -0.542969 0.980469 -0.925781 0.753906 -1.414062 C 0.523438 -1.90625 0.410156 -2.46875 0.410156 -3.105469 C 0.410156 -3.726562 0.515625 -4.289062 0.71875 -4.796875 C 0.925781 -5.300781 1.238281 -5.6875 1.652344 -5.960938 C 2.066406 -6.230469 2.53125 -6.363281 3.039062 -6.363281 C 3.414062 -6.363281 3.75 -6.285156 4.042969 -6.125 C 4.335938 -5.96875 4.574219 -5.761719 4.757812 -5.507812 L 4.757812 -8.589844 L 5.804688 -8.589844 L 5.804688 0 Z M 1.492188 -3.105469 C 1.492188 -2.308594 1.664062 -1.710938 2 -1.320312 C 2.335938 -0.925781 2.730469 -0.726562 3.1875 -0.726562 C 3.648438 -0.726562 4.039062 -0.914062 4.363281 -1.292969 C 4.683594 -1.667969 4.84375 -2.242188 4.84375 -3.015625 C 4.84375 -3.867188 4.679688 -4.492188 4.351562 -4.890625 C 4.023438 -5.289062 3.621094 -5.492188 3.140625 -5.492188 C 2.671875 -5.492188 2.28125 -5.296875 1.964844 -4.914062 C 1.652344 -4.53125 1.492188 -3.929688 1.492188 -3.105469 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-13"> +<path style="stroke:none;" d="M 4.867188 0 L 4.867188 -0.914062 C 4.382812 -0.210938 3.726562 0.140625 2.894531 0.140625 C 2.527344 0.140625 2.183594 0.0703125 1.867188 -0.0703125 C 1.546875 -0.210938 1.3125 -0.386719 1.15625 -0.601562 C 1.003906 -0.8125 0.894531 -1.074219 0.832031 -1.382812 C 0.789062 -1.589844 0.765625 -1.917969 0.765625 -2.367188 L 0.765625 -6.222656 L 1.820312 -6.222656 L 1.820312 -2.773438 C 1.820312 -2.222656 1.84375 -1.851562 1.886719 -1.65625 C 1.953125 -1.378906 2.09375 -1.164062 2.308594 -1.003906 C 2.523438 -0.847656 2.789062 -0.765625 3.105469 -0.765625 C 3.421875 -0.765625 3.71875 -0.847656 3.996094 -1.011719 C 4.273438 -1.171875 4.46875 -1.394531 4.585938 -1.671875 C 4.699219 -1.953125 4.757812 -2.359375 4.757812 -2.890625 L 4.757812 -6.222656 L 5.8125 -6.222656 L 5.8125 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-0"> +<path style="stroke:none;" d=""/> +</symbol> +<symbol overflow="visible" id="glyph3-1"> +<path style="stroke:none;" d="M 0.953125 0 L 0.953125 -9.304688 L 4.445312 -9.304688 C 5.15625 -9.304688 5.722656 -9.210938 6.152344 -9.023438 C 6.582031 -8.835938 6.921875 -8.546875 7.164062 -8.152344 C 7.40625 -7.761719 7.527344 -7.351562 7.527344 -6.925781 C 7.527344 -6.527344 7.421875 -6.152344 7.203125 -5.800781 C 6.988281 -5.449219 6.664062 -5.167969 6.226562 -4.953125 C 6.789062 -4.785156 7.222656 -4.503906 7.523438 -4.105469 C 7.828125 -3.707031 7.980469 -3.238281 7.980469 -2.699219 C 7.980469 -2.261719 7.886719 -1.855469 7.703125 -1.480469 C 7.519531 -1.105469 7.292969 -0.820312 7.019531 -0.617188 C 6.75 -0.414062 6.410156 -0.257812 6 -0.15625 C 5.59375 -0.0507812 5.09375 0 4.5 0 Z M 2.183594 -5.394531 L 4.195312 -5.394531 C 4.742188 -5.394531 5.132812 -5.429688 5.371094 -5.503906 C 5.683594 -5.597656 5.917969 -5.75 6.078125 -5.96875 C 6.238281 -6.183594 6.316406 -6.453125 6.316406 -6.78125 C 6.316406 -7.089844 6.242188 -7.359375 6.09375 -7.59375 C 5.945312 -7.828125 5.734375 -7.992188 5.460938 -8.078125 C 5.183594 -8.164062 4.710938 -8.207031 4.042969 -8.207031 L 2.183594 -8.207031 Z M 2.183594 -1.097656 L 4.5 -1.097656 C 4.898438 -1.097656 5.175781 -1.113281 5.339844 -1.140625 C 5.621094 -1.191406 5.859375 -1.277344 6.050781 -1.398438 C 6.242188 -1.515625 6.394531 -1.6875 6.519531 -1.914062 C 6.640625 -2.140625 6.703125 -2.402344 6.703125 -2.699219 C 6.703125 -3.046875 6.613281 -3.347656 6.4375 -3.601562 C 6.257812 -3.859375 6.011719 -4.039062 5.695312 -4.140625 C 5.382812 -4.246094 4.929688 -4.296875 4.335938 -4.296875 L 2.183594 -4.296875 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-2"> +<path style="stroke:none;" d="M 0.429688 -3.371094 C 0.429688 -4.617188 0.777344 -5.542969 1.472656 -6.144531 C 2.050781 -6.644531 2.757812 -6.894531 3.59375 -6.894531 C 4.519531 -6.894531 5.277344 -6.589844 5.867188 -5.984375 C 6.453125 -5.375 6.746094 -4.535156 6.746094 -3.464844 C 6.746094 -2.597656 6.617188 -1.914062 6.355469 -1.417969 C 6.097656 -0.921875 5.71875 -0.535156 5.222656 -0.261719 C 4.722656 0.015625 4.179688 0.152344 3.59375 0.152344 C 2.648438 0.152344 1.886719 -0.148438 1.304688 -0.753906 C 0.722656 -1.359375 0.429688 -2.230469 0.429688 -3.371094 Z M 1.605469 -3.371094 C 1.605469 -2.507812 1.792969 -1.859375 2.171875 -1.429688 C 2.546875 -1 3.023438 -0.789062 3.59375 -0.789062 C 4.160156 -0.789062 4.632812 -1.003906 5.007812 -1.433594 C 5.382812 -1.867188 5.574219 -2.523438 5.574219 -3.410156 C 5.574219 -4.242188 5.382812 -4.875 5.003906 -5.304688 C 4.625 -5.734375 4.15625 -5.949219 3.59375 -5.949219 C 3.023438 -5.949219 2.546875 -5.734375 2.171875 -5.304688 C 1.792969 -4.878906 1.605469 -4.234375 1.605469 -3.371094 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-3"> +<path style="stroke:none;" d="M 0.398438 -2.011719 L 1.53125 -2.191406 C 1.59375 -1.738281 1.769531 -1.390625 2.058594 -1.148438 C 2.347656 -0.90625 2.753906 -0.789062 3.273438 -0.789062 C 3.800781 -0.789062 4.1875 -0.894531 4.445312 -1.109375 C 4.699219 -1.320312 4.824219 -1.570312 4.824219 -1.859375 C 4.824219 -2.117188 4.710938 -2.320312 4.488281 -2.46875 C 4.332031 -2.570312 3.941406 -2.699219 3.320312 -2.855469 C 2.480469 -3.066406 1.902344 -3.25 1.578125 -3.40625 C 1.253906 -3.558594 1.007812 -3.773438 0.839844 -4.046875 C 0.671875 -4.320312 0.589844 -4.621094 0.589844 -4.953125 C 0.589844 -5.253906 0.660156 -5.53125 0.796875 -5.785156 C 0.933594 -6.042969 1.121094 -6.253906 1.359375 -6.421875 C 1.535156 -6.554688 1.777344 -6.667969 2.085938 -6.757812 C 2.390625 -6.847656 2.722656 -6.894531 3.070312 -6.894531 C 3.601562 -6.894531 4.066406 -6.816406 4.464844 -6.664062 C 4.867188 -6.511719 5.160156 -6.304688 5.351562 -6.046875 C 5.542969 -5.785156 5.671875 -5.4375 5.746094 -5 L 4.628906 -4.851562 C 4.578125 -5.195312 4.429688 -5.46875 4.1875 -5.664062 C 3.945312 -5.859375 3.597656 -5.953125 3.15625 -5.953125 C 2.628906 -5.953125 2.253906 -5.867188 2.03125 -5.695312 C 1.808594 -5.519531 1.695312 -5.316406 1.695312 -5.085938 C 1.695312 -4.9375 1.742188 -4.804688 1.835938 -4.683594 C 1.929688 -4.5625 2.074219 -4.460938 2.273438 -4.378906 C 2.386719 -4.335938 2.722656 -4.242188 3.28125 -4.085938 C 4.089844 -3.871094 4.652344 -3.695312 4.972656 -3.558594 C 5.292969 -3.421875 5.542969 -3.21875 5.726562 -2.957031 C 5.90625 -2.695312 6 -2.371094 6 -1.980469 C 6 -1.601562 5.886719 -1.242188 5.664062 -0.90625 C 5.441406 -0.570312 5.121094 -0.308594 4.703125 -0.125 C 4.285156 0.0585938 3.8125 0.152344 3.28125 0.152344 C 2.40625 0.152344 1.738281 -0.03125 1.277344 -0.394531 C 0.820312 -0.757812 0.527344 -1.296875 0.398438 -2.011719 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-4"> +<path style="stroke:none;" d="M 3.351562 -1.023438 L 3.515625 -0.0117188 C 3.195312 0.0546875 2.90625 0.0898438 2.652344 0.0898438 C 2.238281 0.0898438 1.917969 0.0234375 1.6875 -0.109375 C 1.460938 -0.238281 1.300781 -0.410156 1.207031 -0.625 C 1.113281 -0.839844 1.066406 -1.289062 1.066406 -1.972656 L 1.066406 -5.851562 L 0.226562 -5.851562 L 0.226562 -6.742188 L 1.066406 -6.742188 L 1.066406 -8.410156 L 2.203125 -9.097656 L 2.203125 -6.742188 L 3.351562 -6.742188 L 3.351562 -5.851562 L 2.203125 -5.851562 L 2.203125 -1.910156 C 2.203125 -1.585938 2.222656 -1.375 2.261719 -1.28125 C 2.304688 -1.1875 2.367188 -1.113281 2.460938 -1.058594 C 2.550781 -1.003906 2.679688 -0.976562 2.851562 -0.976562 C 2.976562 -0.976562 3.144531 -0.992188 3.351562 -1.023438 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-5"> +<path style="stroke:none;" d="M 1.179688 0 L 1.179688 -1.300781 L 2.480469 -1.300781 L 2.480469 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-6"> +<path style="stroke:none;" d="M 1.003906 0 L 1.003906 -9.304688 L 4.511719 -9.304688 C 5.128906 -9.304688 5.601562 -9.277344 5.929688 -9.21875 C 6.386719 -9.140625 6.769531 -8.996094 7.078125 -8.78125 C 7.386719 -8.566406 7.636719 -8.269531 7.824219 -7.882812 C 8.011719 -7.5 8.105469 -7.074219 8.105469 -6.613281 C 8.105469 -5.824219 7.855469 -5.152344 7.351562 -4.605469 C 6.847656 -4.058594 5.9375 -3.78125 4.621094 -3.78125 L 2.234375 -3.78125 L 2.234375 0 Z M 2.234375 -4.882812 L 4.640625 -4.882812 C 5.4375 -4.882812 6 -5.03125 6.335938 -5.324219 C 6.667969 -5.621094 6.835938 -6.039062 6.835938 -6.578125 C 6.835938 -6.964844 6.738281 -7.296875 6.542969 -7.574219 C 6.34375 -7.851562 6.085938 -8.035156 5.765625 -8.125 C 5.558594 -8.179688 5.171875 -8.207031 4.613281 -8.207031 L 2.234375 -8.207031 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-7"> +<path style="stroke:none;" d="M 0.804688 2.597656 L 0.679688 1.523438 C 0.929688 1.589844 1.148438 1.625 1.332031 1.625 C 1.585938 1.625 1.789062 1.582031 1.941406 1.5 C 2.09375 1.414062 2.21875 1.296875 2.316406 1.140625 C 2.390625 1.027344 2.503906 0.746094 2.664062 0.292969 C 2.6875 0.230469 2.722656 0.136719 2.765625 0.0117188 L 0.210938 -6.742188 L 1.441406 -6.742188 L 2.84375 -2.835938 C 3.027344 -2.34375 3.1875 -1.820312 3.332031 -1.277344 C 3.464844 -1.800781 3.621094 -2.3125 3.800781 -2.8125 L 5.242188 -6.742188 L 6.386719 -6.742188 L 3.820312 0.113281 C 3.546875 0.855469 3.332031 1.363281 3.179688 1.644531 C 2.976562 2.019531 2.746094 2.296875 2.480469 2.472656 C 2.21875 2.648438 1.90625 2.734375 1.542969 2.734375 C 1.324219 2.734375 1.078125 2.6875 0.804688 2.597656 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-8"> +<path style="stroke:none;" d="M 0.855469 0 L 0.855469 -9.304688 L 2 -9.304688 L 2 -5.96875 C 2.53125 -6.585938 3.207031 -6.894531 4.019531 -6.894531 C 4.519531 -6.894531 4.953125 -6.796875 5.320312 -6.597656 C 5.6875 -6.402344 5.949219 -6.128906 6.109375 -5.78125 C 6.269531 -5.433594 6.347656 -4.933594 6.347656 -4.273438 L 6.347656 0 L 5.203125 0 L 5.203125 -4.273438 C 5.203125 -4.84375 5.082031 -5.257812 4.832031 -5.519531 C 4.585938 -5.78125 4.234375 -5.910156 3.78125 -5.910156 C 3.445312 -5.910156 3.125 -5.820312 2.828125 -5.644531 C 2.53125 -5.46875 2.316406 -5.234375 2.191406 -4.933594 C 2.0625 -4.632812 2 -4.21875 2 -3.6875 L 2 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-9"> +<path style="stroke:none;" d="M 0.855469 0 L 0.855469 -6.742188 L 1.886719 -6.742188 L 1.886719 -5.78125 C 2.382812 -6.523438 3.09375 -6.894531 4.03125 -6.894531 C 4.4375 -6.894531 4.808594 -6.820312 5.152344 -6.675781 C 5.492188 -6.527344 5.746094 -6.335938 5.914062 -6.101562 C 6.085938 -5.863281 6.203125 -5.582031 6.273438 -5.257812 C 6.3125 -5.046875 6.335938 -4.675781 6.335938 -4.144531 L 6.335938 0 L 5.191406 0 L 5.191406 -4.101562 C 5.191406 -4.566406 5.148438 -4.914062 5.058594 -5.144531 C 4.96875 -5.375 4.8125 -5.558594 4.585938 -5.695312 C 4.359375 -5.835938 4.09375 -5.902344 3.789062 -5.902344 C 3.304688 -5.902344 2.882812 -5.75 2.53125 -5.441406 C 2.175781 -5.132812 2 -4.546875 2 -3.679688 L 2 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-10"> +<path style="stroke:none;" d="M 0.855469 2.582031 L 0.855469 -6.742188 L 1.898438 -6.742188 L 1.898438 -5.867188 C 2.144531 -6.207031 2.421875 -6.464844 2.730469 -6.636719 C 3.039062 -6.808594 3.414062 -6.894531 3.851562 -6.894531 C 4.429688 -6.894531 4.9375 -6.746094 5.375 -6.449219 C 5.816406 -6.152344 6.148438 -5.734375 6.375 -5.195312 C 6.597656 -4.65625 6.710938 -4.066406 6.710938 -3.421875 C 6.710938 -2.730469 6.585938 -2.109375 6.339844 -1.558594 C 6.089844 -1.007812 5.730469 -0.582031 5.257812 -0.289062 C 4.785156 0.00390625 4.289062 0.152344 3.769531 0.152344 C 3.390625 0.152344 3.046875 0.0703125 2.746094 -0.0898438 C 2.441406 -0.25 2.195312 -0.453125 2 -0.699219 L 2 2.582031 Z M 1.890625 -3.332031 C 1.890625 -2.464844 2.066406 -1.824219 2.417969 -1.410156 C 2.769531 -0.996094 3.195312 -0.789062 3.695312 -0.789062 C 4.203125 -0.789062 4.636719 -1 5 -1.429688 C 5.359375 -1.859375 5.542969 -2.527344 5.542969 -3.429688 C 5.542969 -4.289062 5.363281 -4.929688 5.011719 -5.359375 C 4.65625 -5.785156 4.234375 -6 3.746094 -6 C 3.257812 -6 2.828125 -5.769531 2.453125 -5.316406 C 2.078125 -4.859375 1.890625 -4.199219 1.890625 -3.332031 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-11"> +<path style="stroke:none;" d="M 1.910156 0 L 0.851562 0 L 0.851562 -9.304688 L 1.992188 -9.304688 L 1.992188 -5.984375 C 2.476562 -6.589844 3.089844 -6.894531 3.839844 -6.894531 C 4.253906 -6.894531 4.648438 -6.808594 5.019531 -6.644531 C 5.390625 -6.476562 5.691406 -6.242188 5.933594 -5.9375 C 6.171875 -5.636719 6.359375 -5.269531 6.492188 -4.84375 C 6.628906 -4.414062 6.695312 -3.957031 6.695312 -3.472656 C 6.695312 -2.316406 6.410156 -1.425781 5.839844 -0.792969 C 5.269531 -0.164062 4.582031 0.152344 3.78125 0.152344 C 2.988281 0.152344 2.363281 -0.179688 1.910156 -0.84375 Z M 1.898438 -3.421875 C 1.898438 -2.613281 2.007812 -2.027344 2.226562 -1.667969 C 2.585938 -1.082031 3.074219 -0.789062 3.6875 -0.789062 C 4.1875 -0.789062 4.617188 -1.003906 4.984375 -1.4375 C 5.347656 -1.871094 5.527344 -2.519531 5.527344 -3.375 C 5.527344 -4.257812 5.355469 -4.90625 5.003906 -5.324219 C 4.65625 -5.742188 4.234375 -5.953125 3.738281 -5.953125 C 3.238281 -5.953125 2.808594 -5.738281 2.445312 -5.304688 C 2.082031 -4.871094 1.898438 -4.242188 1.898438 -3.421875 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-12"> +<path style="stroke:none;" d="M 0.863281 -7.992188 L 0.863281 -9.304688 L 2.007812 -9.304688 L 2.007812 -7.992188 Z M 0.863281 0 L 0.863281 -6.742188 L 2.007812 -6.742188 L 2.007812 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-13"> +<path style="stroke:none;" d="M 5.230469 0 L 5.230469 -0.851562 C 4.804688 -0.183594 4.175781 0.152344 3.34375 0.152344 C 2.808594 0.152344 2.3125 0.00390625 1.863281 -0.292969 C 1.414062 -0.589844 1.0625 -1 0.816406 -1.53125 C 0.570312 -2.0625 0.445312 -2.675781 0.445312 -3.363281 C 0.445312 -4.035156 0.554688 -4.648438 0.78125 -5.195312 C 1.003906 -5.742188 1.339844 -6.164062 1.789062 -6.457031 C 2.238281 -6.75 2.738281 -6.894531 3.292969 -6.894531 C 3.699219 -6.894531 4.0625 -6.808594 4.378906 -6.636719 C 4.695312 -6.464844 4.957031 -6.242188 5.15625 -5.96875 L 5.15625 -9.304688 L 6.289062 -9.304688 L 6.289062 0 Z M 1.617188 -3.363281 C 1.617188 -2.5 1.800781 -1.855469 2.164062 -1.429688 C 2.527344 -1 2.957031 -0.789062 3.453125 -0.789062 C 3.953125 -0.789062 4.375 -0.992188 4.726562 -1.398438 C 5.074219 -1.808594 5.25 -2.429688 5.25 -3.269531 C 5.25 -4.191406 5.070312 -4.867188 4.714844 -5.300781 C 4.359375 -5.730469 3.921875 -5.949219 3.402344 -5.949219 C 2.894531 -5.949219 2.46875 -5.742188 2.128906 -5.324219 C 1.789062 -4.910156 1.617188 -4.257812 1.617188 -3.363281 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-14"> +<path style="stroke:none;" d="M 4.84375 0 L 3.699219 0 L 3.699219 -7.28125 C 3.425781 -7.019531 3.066406 -6.757812 2.617188 -6.492188 C 2.171875 -6.230469 1.769531 -6.035156 1.414062 -5.902344 L 1.414062 -7.007812 C 2.054688 -7.308594 2.613281 -7.671875 3.089844 -8.101562 C 3.570312 -8.527344 3.90625 -8.941406 4.105469 -9.34375 L 4.84375 -9.34375 Z "/> +</symbol> +</g> +<clipPath id="clip1"> + <path d="M 89 21 L 91 21 L 91 221 L 89 221 Z "/> +</clipPath> +<clipPath id="clip2"> + <path d="M 201 21 L 203 21 L 203 221 L 201 221 Z "/> +</clipPath> +<clipPath id="clip3"> + <path d="M 313 21 L 315 21 L 315 221 L 313 221 Z "/> +</clipPath> +<clipPath id="clip4"> + <path d="M 33 180 L 355 180 L 355 182 L 33 182 Z "/> +</clipPath> +<clipPath id="clip5"> + <path d="M 33 146 L 355 146 L 355 148 L 33 148 Z "/> +</clipPath> +<clipPath id="clip6"> + <path d="M 33 120 L 355 120 L 355 122 L 33 122 Z "/> +</clipPath> +<clipPath id="clip7"> + <path d="M 33 95 L 355 95 L 355 97 L 33 97 Z "/> +</clipPath> +<clipPath id="clip8"> + <path d="M 33 61 L 355 61 L 355 63 L 33 63 Z "/> +</clipPath> +</defs> +<g id="surface11"> +<g clip-path="url(#clip1)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 90.226562 220.007812 L 90.226562 21 "/> +</g> +<g clip-path="url(#clip2)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 201.996094 220.007812 L 201.996094 21 "/> +</g> +<g clip-path="url(#clip3)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 313.761719 220.007812 L 313.761719 21 "/> +</g> +<g clip-path="url(#clip4)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 33 180.734375 L 355 180.734375 "/> +</g> +<g clip-path="url(#clip5)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 33 146.960938 L 355 146.960938 "/> +</g> +<g clip-path="url(#clip6)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 33 121.410156 L 355 121.410156 "/> +</g> +<g clip-path="url(#clip7)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 33 95.859375 L 355 95.859375 "/> +</g> +<g clip-path="url(#clip8)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 33 62.082031 L 355 62.082031 "/> +</g> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 49.128906 169 C 49.128906 168.167969 48.800781 167.375 48.214844 166.785156 C 47.625 166.199219 46.832031 165.871094 46 165.871094 C 45.167969 165.871094 44.375 166.199219 43.785156 166.785156 C 43.199219 167.375 42.871094 168.167969 42.871094 169 C 42.871094 169.832031 43.199219 170.625 43.785156 171.214844 C 44.375 171.800781 45.167969 172.128906 46 172.128906 C 46.832031 172.128906 47.625 171.800781 48.214844 171.214844 C 48.800781 170.625 49.128906 169.832031 49.128906 169 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 82.128906 169 C 82.128906 168.167969 81.800781 167.375 81.214844 166.785156 C 80.625 166.199219 79.832031 165.871094 79 165.871094 C 78.167969 165.871094 77.375 166.199219 76.785156 166.785156 C 76.199219 167.375 75.871094 168.167969 75.871094 169 C 75.871094 169.832031 76.199219 170.625 76.785156 171.214844 C 77.375 171.800781 78.167969 172.128906 79 172.128906 C 79.832031 172.128906 80.625 171.800781 81.214844 171.214844 C 81.800781 170.625 82.128906 169.832031 82.128906 169 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 116.128906 167 C 116.128906 166.167969 115.800781 165.375 115.214844 164.785156 C 114.625 164.199219 113.832031 163.871094 113 163.871094 C 112.167969 163.871094 111.375 164.199219 110.785156 164.785156 C 110.199219 165.375 109.871094 166.167969 109.871094 167 C 109.871094 167.832031 110.199219 168.625 110.785156 169.214844 C 111.375 169.800781 112.167969 170.128906 113 170.128906 C 113.832031 170.128906 114.625 169.800781 115.214844 169.214844 C 115.800781 168.625 116.128906 167.832031 116.128906 167 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 150.128906 159 C 150.128906 158.167969 149.800781 157.375 149.214844 156.785156 C 148.625 156.199219 147.832031 155.871094 147 155.871094 C 146.167969 155.871094 145.375 156.199219 144.785156 156.785156 C 144.199219 157.375 143.871094 158.167969 143.871094 159 C 143.871094 159.832031 144.199219 160.625 144.785156 161.214844 C 145.375 161.800781 146.167969 162.128906 147 162.128906 C 147.832031 162.128906 148.625 161.800781 149.214844 161.214844 C 149.800781 160.625 150.128906 159.832031 150.128906 159 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 183.128906 146 C 183.128906 145.167969 182.800781 144.375 182.214844 143.785156 C 181.625 143.199219 180.832031 142.871094 180 142.871094 C 179.167969 142.871094 178.375 143.199219 177.785156 143.785156 C 177.199219 144.375 176.871094 145.167969 176.871094 146 C 176.871094 146.832031 177.199219 147.625 177.785156 148.214844 C 178.375 148.800781 179.167969 149.128906 180 149.128906 C 180.832031 149.128906 181.625 148.800781 182.214844 148.214844 C 182.800781 147.625 183.128906 146.832031 183.128906 146 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 217.128906 128 C 217.128906 127.167969 216.800781 126.375 216.214844 125.785156 C 215.625 125.199219 214.832031 124.871094 214 124.871094 C 213.167969 124.871094 212.375 125.199219 211.785156 125.785156 C 211.199219 126.375 210.871094 127.167969 210.871094 128 C 210.871094 128.832031 211.199219 129.625 211.785156 130.214844 C 212.375 130.800781 213.167969 131.128906 214 131.128906 C 214.832031 131.128906 215.625 130.800781 216.214844 130.214844 C 216.800781 129.625 217.128906 128.832031 217.128906 128 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 251.128906 108 C 251.128906 107.167969 250.800781 106.375 250.214844 105.785156 C 249.625 105.199219 248.832031 104.871094 248 104.871094 C 247.167969 104.871094 246.375 105.199219 245.785156 105.785156 C 245.199219 106.375 244.871094 107.167969 244.871094 108 C 244.871094 108.832031 245.199219 109.625 245.785156 110.214844 C 246.375 110.800781 247.167969 111.128906 248 111.128906 C 248.832031 111.128906 249.625 110.800781 250.214844 110.214844 C 250.800781 109.625 251.128906 108.832031 251.128906 108 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 284.128906 85 C 284.128906 84.167969 283.800781 83.375 283.214844 82.785156 C 282.625 82.199219 281.832031 81.871094 281 81.871094 C 280.167969 81.871094 279.375 82.199219 278.785156 82.785156 C 278.199219 83.375 277.871094 84.167969 277.871094 85 C 277.871094 85.832031 278.199219 86.625 278.785156 87.214844 C 279.375 87.800781 280.167969 88.128906 281 88.128906 C 281.832031 88.128906 282.625 87.800781 283.214844 87.214844 C 283.800781 86.625 284.128906 85.832031 284.128906 85 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 318.128906 59 C 318.128906 58.167969 317.800781 57.375 317.214844 56.785156 C 316.625 56.199219 315.832031 55.871094 315 55.871094 C 314.167969 55.871094 313.375 56.199219 312.785156 56.785156 C 312.199219 57.375 311.871094 58.167969 311.871094 59 C 311.871094 59.832031 312.199219 60.625 312.785156 61.214844 C 313.375 61.800781 314.167969 62.128906 315 62.128906 C 315.832031 62.128906 316.625 61.800781 317.214844 61.214844 C 317.800781 60.625 318.128906 59.832031 318.128906 59 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 352.128906 31 C 352.128906 30.167969 351.800781 29.375 351.214844 28.785156 C 350.625 28.199219 349.832031 27.871094 349 27.871094 C 348.167969 27.871094 347.375 28.199219 346.785156 28.785156 C 346.199219 29.375 345.871094 30.167969 345.871094 31 C 345.871094 31.832031 346.199219 32.625 346.785156 33.214844 C 347.375 33.800781 348.167969 34.128906 349 34.128906 C 349.832031 34.128906 350.625 33.800781 351.214844 33.214844 C 351.800781 32.625 352.128906 31.832031 352.128906 31 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 49.128906 205 C 49.128906 204.167969 48.800781 203.375 48.214844 202.785156 C 47.625 202.199219 46.832031 201.871094 46 201.871094 C 45.167969 201.871094 44.375 202.199219 43.785156 202.785156 C 43.199219 203.375 42.871094 204.167969 42.871094 205 C 42.871094 205.832031 43.199219 206.625 43.785156 207.214844 C 44.375 207.800781 45.167969 208.128906 46 208.128906 C 46.832031 208.128906 47.625 207.800781 48.214844 207.214844 C 48.800781 206.625 49.128906 205.832031 49.128906 205 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 82.128906 199 C 82.128906 198.167969 81.800781 197.375 81.214844 196.785156 C 80.625 196.199219 79.832031 195.871094 79 195.871094 C 78.167969 195.871094 77.375 196.199219 76.785156 196.785156 C 76.199219 197.375 75.871094 198.167969 75.871094 199 C 75.871094 199.832031 76.199219 200.625 76.785156 201.214844 C 77.375 201.800781 78.167969 202.128906 79 202.128906 C 79.832031 202.128906 80.625 201.800781 81.214844 201.214844 C 81.800781 200.625 82.128906 199.832031 82.128906 199 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 116.128906 190 C 116.128906 189.167969 115.800781 188.375 115.214844 187.785156 C 114.625 187.199219 113.832031 186.871094 113 186.871094 C 112.167969 186.871094 111.375 187.199219 110.785156 187.785156 C 110.199219 188.375 109.871094 189.167969 109.871094 190 C 109.871094 190.832031 110.199219 191.625 110.785156 192.214844 C 111.375 192.800781 112.167969 193.128906 113 193.128906 C 113.832031 193.128906 114.625 192.800781 115.214844 192.214844 C 115.800781 191.625 116.128906 190.832031 116.128906 190 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 150.128906 177 C 150.128906 176.167969 149.800781 175.375 149.214844 174.785156 C 148.625 174.199219 147.832031 173.871094 147 173.871094 C 146.167969 173.871094 145.375 174.199219 144.785156 174.785156 C 144.199219 175.375 143.871094 176.167969 143.871094 177 C 143.871094 177.832031 144.199219 178.625 144.785156 179.214844 C 145.375 179.800781 146.167969 180.128906 147 180.128906 C 147.832031 180.128906 148.625 179.800781 149.214844 179.214844 C 149.800781 178.625 150.128906 177.832031 150.128906 177 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 183.128906 159 C 183.128906 158.167969 182.800781 157.375 182.214844 156.785156 C 181.625 156.199219 180.832031 155.871094 180 155.871094 C 179.167969 155.871094 178.375 156.199219 177.785156 156.785156 C 177.199219 157.375 176.871094 158.167969 176.871094 159 C 176.871094 159.832031 177.199219 160.625 177.785156 161.214844 C 178.375 161.800781 179.167969 162.128906 180 162.128906 C 180.832031 162.128906 181.625 161.800781 182.214844 161.214844 C 182.800781 160.625 183.128906 159.832031 183.128906 159 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 217.128906 138 C 217.128906 137.167969 216.800781 136.375 216.214844 135.785156 C 215.625 135.199219 214.832031 134.871094 214 134.871094 C 213.167969 134.871094 212.375 135.199219 211.785156 135.785156 C 211.199219 136.375 210.871094 137.167969 210.871094 138 C 210.871094 138.832031 211.199219 139.625 211.785156 140.214844 C 212.375 140.800781 213.167969 141.128906 214 141.128906 C 214.832031 141.128906 215.625 140.800781 216.214844 140.214844 C 216.800781 139.625 217.128906 138.832031 217.128906 138 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 251.128906 115 C 251.128906 114.167969 250.800781 113.375 250.214844 112.785156 C 249.625 112.199219 248.832031 111.871094 248 111.871094 C 247.167969 111.871094 246.375 112.199219 245.785156 112.785156 C 245.199219 113.375 244.871094 114.167969 244.871094 115 C 244.871094 115.832031 245.199219 116.625 245.785156 117.214844 C 246.375 117.800781 247.167969 118.128906 248 118.128906 C 248.832031 118.128906 249.625 117.800781 250.214844 117.214844 C 250.800781 116.625 251.128906 115.832031 251.128906 115 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 284.128906 91 C 284.128906 90.167969 283.800781 89.375 283.214844 88.785156 C 282.625 88.199219 281.832031 87.871094 281 87.871094 C 280.167969 87.871094 279.375 88.199219 278.785156 88.785156 C 278.199219 89.375 277.871094 90.167969 277.871094 91 C 277.871094 91.832031 278.199219 92.625 278.785156 93.214844 C 279.375 93.800781 280.167969 94.128906 281 94.128906 C 281.832031 94.128906 282.625 93.800781 283.214844 93.214844 C 283.800781 92.625 284.128906 91.832031 284.128906 91 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 318.128906 65 C 318.128906 64.167969 317.800781 63.375 317.214844 62.785156 C 316.625 62.199219 315.832031 61.871094 315 61.871094 C 314.167969 61.871094 313.375 62.199219 312.785156 62.785156 C 312.199219 63.375 311.871094 64.167969 311.871094 65 C 311.871094 65.832031 312.199219 66.625 312.785156 67.214844 C 313.375 67.800781 314.167969 68.128906 315 68.128906 C 315.832031 68.128906 316.625 67.800781 317.214844 67.214844 C 317.800781 66.625 318.128906 65.832031 318.128906 65 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 352.128906 38 C 352.128906 37.167969 351.800781 36.375 351.214844 35.785156 C 350.625 35.199219 349.832031 34.871094 349 34.871094 C 348.167969 34.871094 347.375 35.199219 346.785156 35.785156 C 346.199219 36.375 345.871094 37.167969 345.871094 38 C 345.871094 38.832031 346.199219 39.625 346.785156 40.214844 C 347.375 40.800781 348.167969 41.128906 349 41.128906 C 349.832031 41.128906 350.625 40.800781 351.214844 40.214844 C 351.800781 39.625 352.128906 38.832031 352.128906 38 Z "/> +<path style="fill:none;stroke-width:0.5;stroke-linecap:square;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 220.007812 L 33 220.007812 "/> +<path style="fill:none;stroke-width:0.5;stroke-linecap:square;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 220.007812 L 33 21 "/> +<path style="fill:none;stroke-width:0.5;stroke-linecap:square;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 21 L 355 21 "/> +<path style="fill:none;stroke-width:0.5;stroke-linecap:square;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 21 L 355 220.007812 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 90.226562 220.007812 L 90.226562 216.785156 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-1" x="84.725786" y="232.006944"/> + <use xlink:href="#glyph0-2" x="90.28731" y="232.006944"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 201.996094 220.007812 L 201.996094 216.785156 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-1" x="193.49443" y="232.006944"/> + <use xlink:href="#glyph0-2" x="199.055953" y="232.006944"/> + <use xlink:href="#glyph0-2" x="204.617477" y="232.006944"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 313.761719 220.007812 L 313.761719 216.785156 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-1" x="302.763074" y="232.006944"/> + <use xlink:href="#glyph0-2" x="308.324597" y="232.006944"/> + <use xlink:href="#glyph0-2" x="313.88612" y="232.006944"/> + <use xlink:href="#glyph0-2" x="319.447644" y="232.006944"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 45.75 220.007812 L 45.75 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 56.578125 220.007812 L 56.578125 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 65.429688 220.007812 L 65.429688 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 72.914062 220.007812 L 72.914062 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 79.394531 220.007812 L 79.394531 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 85.113281 220.007812 L 85.113281 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 123.871094 220.007812 L 123.871094 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 143.554688 220.007812 L 143.554688 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 157.515625 220.007812 L 157.515625 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 168.347656 220.007812 L 168.347656 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 177.199219 220.007812 L 177.199219 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 184.679688 220.007812 L 184.679688 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 191.164062 220.007812 L 191.164062 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 196.878906 220.007812 L 196.878906 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 235.640625 220.007812 L 235.640625 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 255.320312 220.007812 L 255.320312 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 269.285156 220.007812 L 269.285156 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 280.117188 220.007812 L 280.117188 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 288.96875 220.007812 L 288.96875 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 296.449219 220.007812 L 296.449219 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 302.929688 220.007812 L 302.929688 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 308.648438 220.007812 L 308.648438 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 347.410156 220.007812 L 347.410156 218.398438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 180.734375 L 36.21875 180.734375 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-3" x="24" y="183.235493"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 146.960938 L 36.21875 146.960938 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-4" x="24" y="149.45964"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 121.410156 L 36.21875 121.410156 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-1" x="19" y="123.909193"/> + <use xlink:href="#glyph0-2" x="24.561523" y="123.909193"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 95.859375 L 36.21875 95.859375 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-3" x="19" y="98.358747"/> + <use xlink:href="#glyph0-2" x="24.561523" y="98.358747"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 62.082031 L 36.21875 62.082031 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-4" x="19" y="64.582894"/> + <use xlink:href="#glyph0-2" x="24.561523" y="64.582894"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 206.285156 L 34.609375 206.285156 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 165.789062 L 34.609375 165.789062 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 155.183594 L 34.609375 155.183594 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 140.238281 L 34.609375 140.238281 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 134.558594 L 34.609375 134.558594 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 129.632812 L 34.609375 129.632812 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 125.292969 L 34.609375 125.292969 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 80.914062 L 34.609375 80.914062 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 70.308594 L 34.609375 70.308594 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 33 36.53125 L 34.609375 36.53125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 90.226562 21 L 90.226562 24.21875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 201.996094 21 L 201.996094 24.21875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 313.761719 21 L 313.761719 24.21875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 45.75 21 L 45.75 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 56.578125 21 L 56.578125 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 65.429688 21 L 65.429688 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 72.914062 21 L 72.914062 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 79.394531 21 L 79.394531 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 85.113281 21 L 85.113281 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 123.871094 21 L 123.871094 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 143.554688 21 L 143.554688 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 157.515625 21 L 157.515625 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 168.347656 21 L 168.347656 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 177.199219 21 L 177.199219 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 184.679688 21 L 184.679688 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 191.164062 21 L 191.164062 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 196.878906 21 L 196.878906 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 235.640625 21 L 235.640625 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 255.320312 21 L 255.320312 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 269.285156 21 L 269.285156 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 280.117188 21 L 280.117188 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 288.96875 21 L 288.96875 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 296.449219 21 L 296.449219 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 302.929688 21 L 302.929688 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 308.648438 21 L 308.648438 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 347.410156 21 L 347.410156 22.609375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 180.734375 L 351.78125 180.734375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 146.960938 L 351.78125 146.960938 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 121.410156 L 351.78125 121.410156 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 95.859375 L 351.78125 95.859375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 62.082031 L 351.78125 62.082031 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 206.285156 L 353.390625 206.285156 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 165.789062 L 353.390625 165.789062 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 155.183594 L 353.390625 155.183594 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 140.238281 L 353.390625 140.238281 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 134.558594 L 353.390625 134.558594 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 129.632812 L 353.390625 129.632812 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 125.292969 L 353.390625 125.292969 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 80.914062 L 353.390625 80.914062 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 70.308594 L 353.390625 70.308594 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 36.53125 L 353.390625 36.53125 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-5" x="172.5" y="251.006944"/> + <use xlink:href="#glyph0-6" x="178.608398" y="251.006944"/> + <use xlink:href="#glyph0-7" x="184.169922" y="251.006944"/> + <use xlink:href="#glyph0-8" x="189.731445" y="251.006944"/> + <use xlink:href="#glyph0-9" x="194.731445" y="251.006944"/> + <use xlink:href="#glyph0-10" x="197.509766" y="251.006944"/> + <use xlink:href="#glyph0-11" x="199.731445" y="251.006944"/> + <use xlink:href="#glyph0-7" x="205.292969" y="251.006944"/> + <use xlink:href="#glyph0-12" x="210.854492" y="251.006944"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph1-1" x="9" y="140.003472"/> + <use xlink:href="#glyph1-2" x="9" y="133.33355"/> + <use xlink:href="#glyph1-3" x="9" y="127.772027"/> + <use xlink:href="#glyph1-4" x="9" y="122.772027"/> + <use xlink:href="#glyph1-5" x="9" y="117.210503"/> + <use xlink:href="#glyph1-6" x="9" y="111.64898"/> + <use xlink:href="#glyph1-7" x="9" y="106.087457"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph2-1" x="122" y="12"/> + <use xlink:href="#glyph2-2" x="130.666016" y="12"/> + <use xlink:href="#glyph2-3" x="137.339844" y="12"/> + <use xlink:href="#glyph2-4" x="147.335938" y="12"/> + <use xlink:href="#glyph2-5" x="154.009766" y="12"/> + <use xlink:href="#glyph2-6" x="156.675781" y="12"/> + <use xlink:href="#glyph2-7" x="159.341797" y="12"/> + <use xlink:href="#glyph2-8" x="166.015625" y="12"/> + <use xlink:href="#glyph2-5" x="169.349609" y="12"/> + <use xlink:href="#glyph2-2" x="172.015625" y="12"/> + <use xlink:href="#glyph2-9" x="178.689453" y="12"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph2-8" x="188" y="12"/> + <use xlink:href="#glyph2-5" x="191.333984" y="12"/> + <use xlink:href="#glyph2-3" x="194" y="12"/> + <use xlink:href="#glyph2-10" x="203.996094" y="12"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph2-2" x="214" y="12"/> + <use xlink:href="#glyph2-11" x="220.673828" y="12"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph2-3" x="227" y="12"/> + <use xlink:href="#glyph2-2" x="236.996094" y="12"/> + <use xlink:href="#glyph2-12" x="243.669922" y="12"/> + <use xlink:href="#glyph2-13" x="250.34375" y="12"/> + <use xlink:href="#glyph2-6" x="257.017578" y="12"/> + <use xlink:href="#glyph2-10" x="259.683594" y="12"/> +</g> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 382.148438 116 C 382.148438 115.164062 381.816406 114.363281 381.226562 113.773438 C 380.636719 113.183594 379.835938 112.851562 379 112.851562 C 378.164062 112.851562 377.363281 113.183594 376.773438 113.773438 C 376.183594 114.363281 375.851562 115.164062 375.851562 116 C 375.851562 116.835938 376.183594 117.636719 376.773438 118.226562 C 377.363281 118.816406 378.164062 119.148438 379 119.148438 C 379.835938 119.148438 380.636719 118.816406 381.226562 118.226562 C 381.816406 117.636719 382.148438 116.835938 382.148438 116 Z "/> +<g style="fill:rgb(0%,0%,0%);fill-opacity:1;"> + <use xlink:href="#glyph3-1" x="391" y="120.28418"/> + <use xlink:href="#glyph3-2" x="399.670898" y="120.28418"/> + <use xlink:href="#glyph3-2" x="406.901367" y="120.28418"/> + <use xlink:href="#glyph3-3" x="414.131836" y="120.28418"/> + <use xlink:href="#glyph3-4" x="420.631836" y="120.28418"/> +</g> +<g style="fill:rgb(0%,0%,0%);fill-opacity:1;"> + <use xlink:href="#glyph3-5" x="424" y="120.28418"/> +</g> +<g style="fill:rgb(0%,0%,0%);fill-opacity:1;"> + <use xlink:href="#glyph3-6" x="428" y="120.28418"/> + <use xlink:href="#glyph3-7" x="436.670898" y="120.28418"/> + <use xlink:href="#glyph3-4" x="443.170898" y="120.28418"/> + <use xlink:href="#glyph3-8" x="446.783203" y="120.28418"/> + <use xlink:href="#glyph3-2" x="454.013672" y="120.28418"/> + <use xlink:href="#glyph3-9" x="461.244141" y="120.28418"/> +</g> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 382.148438 139 C 382.148438 138.164062 381.816406 137.363281 381.226562 136.773438 C 380.636719 136.183594 379.835938 135.851562 379 135.851562 C 378.164062 135.851562 377.363281 136.183594 376.773438 136.773438 C 376.183594 137.363281 375.851562 138.164062 375.851562 139 C 375.851562 139.835938 376.183594 140.636719 376.773438 141.226562 C 377.363281 141.816406 378.164062 142.148438 379 142.148438 C 379.835938 142.148438 380.636719 141.816406 381.226562 141.226562 C 381.816406 140.636719 382.148438 139.835938 382.148438 139 Z "/> +<g style="fill:rgb(0%,0%,0%);fill-opacity:1;"> + <use xlink:href="#glyph3-10" x="391" y="143.28418"/> + <use xlink:href="#glyph3-7" x="398.230469" y="143.28418"/> + <use xlink:href="#glyph3-11" x="404.730469" y="143.28418"/> + <use xlink:href="#glyph3-12" x="411.960938" y="143.28418"/> + <use xlink:href="#glyph3-9" x="414.849609" y="143.28418"/> + <use xlink:href="#glyph3-13" x="422.080078" y="143.28418"/> + <use xlink:href="#glyph3-14" x="429.310547" y="143.28418"/> + <use xlink:href="#glyph3-14" x="436.541016" y="143.28418"/> +</g> +</g> +</svg> diff --git a/pybind11/docs/pybind11_vs_boost_python2.png b/pybind11/docs/pybind11_vs_boost_python2.png new file mode 100644 index 0000000000000000000000000000000000000000..9f17272c50663957d6ae6d8e23fdd5a15757e71f Binary files /dev/null and b/pybind11/docs/pybind11_vs_boost_python2.png differ diff --git a/pybind11/docs/pybind11_vs_boost_python2.svg b/pybind11/docs/pybind11_vs_boost_python2.svg new file mode 100644 index 0000000000000000000000000000000000000000..5ed6530ca112cbe643d5dd6d6fde385c4edea6b5 --- /dev/null +++ b/pybind11/docs/pybind11_vs_boost_python2.svg @@ -0,0 +1,427 @@ +<?xml version="1.0" encoding="UTF-8"?> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="468pt" height="246pt" viewBox="0 0 468 246" version="1.1"> +<defs> +<g> +<symbol overflow="visible" id="glyph0-0"> +<path style="stroke:none;" d=""/> +</symbol> +<symbol overflow="visible" id="glyph0-1"> +<path style="stroke:none;" d="M 3.726562 0 L 2.847656 0 L 2.847656 -5.601562 C 2.636719 -5.398438 2.359375 -5.195312 2.015625 -4.996094 C 1.671875 -4.792969 1.363281 -4.640625 1.089844 -4.539062 L 1.089844 -5.390625 C 1.582031 -5.621094 2.011719 -5.902344 2.378906 -6.230469 C 2.746094 -6.558594 3.007812 -6.878906 3.160156 -7.1875 L 3.726562 -7.1875 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-2"> +<path style="stroke:none;" d="M 0.414062 -3.53125 C 0.414062 -4.375 0.503906 -5.058594 0.675781 -5.574219 C 0.851562 -6.089844 1.109375 -6.488281 1.453125 -6.765625 C 1.796875 -7.046875 2.226562 -7.1875 2.75 -7.1875 C 3.132812 -7.1875 3.46875 -7.109375 3.757812 -6.957031 C 4.046875 -6.800781 4.289062 -6.578125 4.476562 -6.285156 C 4.664062 -5.996094 4.8125 -5.640625 4.921875 -5.222656 C 5.03125 -4.804688 5.082031 -4.238281 5.082031 -3.53125 C 5.082031 -2.691406 4.996094 -2.011719 4.824219 -1.496094 C 4.652344 -0.980469 4.394531 -0.582031 4.050781 -0.300781 C 3.707031 -0.0195312 3.273438 0.121094 2.75 0.121094 C 2.058594 0.121094 1.515625 -0.125 1.125 -0.621094 C 0.652344 -1.214844 0.414062 -2.1875 0.414062 -3.53125 Z M 1.320312 -3.53125 C 1.320312 -2.355469 1.457031 -1.574219 1.730469 -1.183594 C 2.007812 -0.796875 2.34375 -0.601562 2.75 -0.601562 C 3.152344 -0.601562 3.492188 -0.796875 3.765625 -1.1875 C 4.042969 -1.578125 4.179688 -2.359375 4.179688 -3.53125 C 4.179688 -4.710938 4.042969 -5.492188 3.765625 -5.878906 C 3.492188 -6.265625 3.148438 -6.460938 2.738281 -6.460938 C 2.335938 -6.460938 2.011719 -6.289062 1.773438 -5.945312 C 1.46875 -5.511719 1.320312 -4.707031 1.320312 -3.53125 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-3"> +<path style="stroke:none;" d="M 0.820312 0 L 0.820312 -7.15625 L 5.648438 -7.15625 L 5.648438 -6.3125 L 1.765625 -6.3125 L 1.765625 -4.097656 L 5.125 -4.097656 L 5.125 -3.25 L 1.765625 -3.25 L 1.765625 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-4"> +<path style="stroke:none;" d="M 4.058594 0 L 4.058594 -0.761719 C 3.65625 -0.175781 3.105469 0.117188 2.414062 0.117188 C 2.105469 0.117188 1.820312 0.0585938 1.554688 -0.0585938 C 1.289062 -0.175781 1.09375 -0.324219 0.964844 -0.5 C 0.835938 -0.679688 0.746094 -0.894531 0.695312 -1.152344 C 0.65625 -1.324219 0.640625 -1.597656 0.640625 -1.972656 L 0.640625 -5.1875 L 1.519531 -5.1875 L 1.519531 -2.308594 C 1.519531 -1.851562 1.535156 -1.542969 1.570312 -1.382812 C 1.625 -1.152344 1.746094 -0.96875 1.921875 -0.835938 C 2.101562 -0.703125 2.324219 -0.640625 2.585938 -0.640625 C 2.851562 -0.640625 3.097656 -0.707031 3.328125 -0.84375 C 3.5625 -0.976562 3.726562 -1.160156 3.820312 -1.394531 C 3.917969 -1.625 3.964844 -1.964844 3.964844 -2.40625 L 3.964844 -5.1875 L 4.84375 -5.1875 L 4.84375 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-5"> +<path style="stroke:none;" d="M 0.660156 0 L 0.660156 -5.1875 L 1.449219 -5.1875 L 1.449219 -4.449219 C 1.832031 -5.019531 2.382812 -5.304688 3.101562 -5.304688 C 3.414062 -5.304688 3.699219 -5.246094 3.960938 -5.132812 C 4.222656 -5.023438 4.421875 -4.875 4.550781 -4.691406 C 4.679688 -4.507812 4.773438 -4.292969 4.824219 -4.042969 C 4.855469 -3.878906 4.875 -3.59375 4.875 -3.1875 L 4.875 0 L 3.992188 0 L 3.992188 -3.15625 C 3.992188 -3.511719 3.960938 -3.78125 3.890625 -3.957031 C 3.824219 -4.132812 3.703125 -4.277344 3.527344 -4.382812 C 3.351562 -4.488281 3.148438 -4.539062 2.914062 -4.539062 C 2.539062 -4.539062 2.21875 -4.421875 1.945312 -4.183594 C 1.671875 -3.945312 1.539062 -3.496094 1.539062 -2.832031 L 1.539062 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-6"> +<path style="stroke:none;" d="M 4.042969 -1.898438 L 4.90625 -1.789062 C 4.8125 -1.191406 4.570312 -0.726562 4.183594 -0.386719 C 3.792969 -0.0507812 3.316406 0.117188 2.75 0.117188 C 2.039062 0.117188 1.46875 -0.113281 1.039062 -0.578125 C 0.605469 -1.042969 0.390625 -1.707031 0.390625 -2.574219 C 0.390625 -3.132812 0.484375 -3.625 0.667969 -4.042969 C 0.855469 -4.460938 1.136719 -4.777344 1.515625 -4.988281 C 1.894531 -5.199219 2.308594 -5.304688 2.753906 -5.304688 C 3.316406 -5.304688 3.777344 -5.160156 4.136719 -4.875 C 4.492188 -4.589844 4.722656 -4.1875 4.824219 -3.664062 L 3.96875 -3.53125 C 3.886719 -3.878906 3.746094 -4.140625 3.539062 -4.316406 C 3.332031 -4.492188 3.082031 -4.578125 2.789062 -4.578125 C 2.34375 -4.578125 1.984375 -4.421875 1.710938 -4.105469 C 1.433594 -3.789062 1.292969 -3.285156 1.292969 -2.597656 C 1.292969 -1.902344 1.425781 -1.394531 1.695312 -1.078125 C 1.960938 -0.761719 2.308594 -0.605469 2.738281 -0.605469 C 3.085938 -0.605469 3.371094 -0.710938 3.601562 -0.921875 C 3.835938 -1.132812 3.980469 -1.460938 4.042969 -1.898438 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-7"> +<path style="stroke:none;" d="M 2.578125 -0.785156 L 2.703125 -0.0078125 C 2.457031 0.0429688 2.234375 0.0703125 2.039062 0.0703125 C 1.722656 0.0703125 1.476562 0.0195312 1.296875 -0.0820312 C 1.121094 -0.183594 1 -0.316406 0.929688 -0.480469 C 0.855469 -0.644531 0.820312 -0.992188 0.820312 -1.519531 L 0.820312 -4.5 L 0.175781 -4.5 L 0.175781 -5.1875 L 0.820312 -5.1875 L 0.820312 -6.46875 L 1.695312 -6.996094 L 1.695312 -5.1875 L 2.578125 -5.1875 L 2.578125 -4.5 L 1.695312 -4.5 L 1.695312 -1.46875 C 1.695312 -1.21875 1.710938 -1.058594 1.742188 -0.984375 C 1.773438 -0.914062 1.820312 -0.859375 1.890625 -0.816406 C 1.960938 -0.773438 2.0625 -0.75 2.191406 -0.75 C 2.289062 -0.75 2.417969 -0.761719 2.578125 -0.785156 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-8"> +<path style="stroke:none;" d="M 0.664062 -6.148438 L 0.664062 -7.15625 L 1.542969 -7.15625 L 1.542969 -6.148438 Z M 0.664062 0 L 0.664062 -5.1875 L 1.542969 -5.1875 L 1.542969 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-9"> +<path style="stroke:none;" d="M 0.332031 -2.59375 C 0.332031 -3.554688 0.597656 -4.265625 1.132812 -4.726562 C 1.578125 -5.109375 2.121094 -5.304688 2.765625 -5.304688 C 3.476562 -5.304688 4.058594 -5.070312 4.511719 -4.601562 C 4.964844 -4.132812 5.191406 -3.488281 5.191406 -2.664062 C 5.191406 -2 5.089844 -1.472656 4.890625 -1.089844 C 4.691406 -0.707031 4.398438 -0.410156 4.015625 -0.199219 C 3.632812 0.0117188 3.214844 0.117188 2.765625 0.117188 C 2.039062 0.117188 1.449219 -0.117188 1.003906 -0.582031 C 0.554688 -1.046875 0.332031 -1.71875 0.332031 -2.59375 Z M 1.234375 -2.59375 C 1.234375 -1.929688 1.378906 -1.429688 1.671875 -1.101562 C 1.960938 -0.769531 2.324219 -0.605469 2.765625 -0.605469 C 3.199219 -0.605469 3.5625 -0.773438 3.851562 -1.101562 C 4.140625 -1.433594 4.289062 -1.941406 4.289062 -2.621094 C 4.289062 -3.261719 4.140625 -3.75 3.851562 -4.078125 C 3.558594 -4.410156 3.195312 -4.574219 2.765625 -4.574219 C 2.324219 -4.574219 1.960938 -4.410156 1.671875 -4.082031 C 1.382812 -3.753906 1.234375 -3.257812 1.234375 -2.59375 Z "/> +</symbol> +<symbol overflow="visible" id="glyph0-10"> +<path style="stroke:none;" d="M 0.308594 -1.546875 L 1.175781 -1.683594 C 1.226562 -1.335938 1.363281 -1.070312 1.585938 -0.882812 C 1.808594 -0.699219 2.117188 -0.605469 2.519531 -0.605469 C 2.921875 -0.605469 3.222656 -0.6875 3.417969 -0.851562 C 3.613281 -1.015625 3.710938 -1.210938 3.710938 -1.429688 C 3.710938 -1.628906 3.625 -1.785156 3.453125 -1.898438 C 3.332031 -1.976562 3.03125 -2.078125 2.554688 -2.195312 C 1.910156 -2.359375 1.460938 -2.5 1.214844 -2.621094 C 0.964844 -2.738281 0.777344 -2.902344 0.648438 -3.113281 C 0.519531 -3.324219 0.453125 -3.554688 0.453125 -3.808594 C 0.453125 -4.039062 0.507812 -4.253906 0.613281 -4.449219 C 0.71875 -4.648438 0.863281 -4.8125 1.046875 -4.941406 C 1.183594 -5.042969 1.367188 -5.128906 1.605469 -5.199219 C 1.839844 -5.269531 2.09375 -5.304688 2.363281 -5.304688 C 2.769531 -5.304688 3.128906 -5.242188 3.433594 -5.125 C 3.742188 -5.007812 3.96875 -4.851562 4.117188 -4.652344 C 4.261719 -4.453125 4.363281 -4.183594 4.417969 -3.847656 L 3.558594 -3.730469 C 3.519531 -3.996094 3.40625 -4.207031 3.21875 -4.355469 C 3.03125 -4.503906 2.769531 -4.578125 2.425781 -4.578125 C 2.023438 -4.578125 1.734375 -4.511719 1.5625 -4.378906 C 1.390625 -4.246094 1.304688 -4.089844 1.304688 -3.910156 C 1.304688 -3.796875 1.339844 -3.695312 1.410156 -3.601562 C 1.484375 -3.507812 1.59375 -3.429688 1.75 -3.367188 C 1.835938 -3.335938 2.09375 -3.261719 2.523438 -3.144531 C 3.144531 -2.976562 3.578125 -2.84375 3.824219 -2.738281 C 4.070312 -2.632812 4.265625 -2.476562 4.40625 -2.273438 C 4.546875 -2.074219 4.613281 -1.824219 4.613281 -1.523438 C 4.613281 -1.230469 4.527344 -0.953125 4.359375 -0.695312 C 4.1875 -0.4375 3.941406 -0.238281 3.617188 -0.09375 C 3.296875 0.046875 2.929688 0.117188 2.523438 0.117188 C 1.851562 0.117188 1.335938 -0.0234375 0.984375 -0.304688 C 0.632812 -0.582031 0.40625 -0.996094 0.308594 -1.546875 Z "/> +</symbol> +<symbol overflow="visible" id="glyph1-0"> +<path style="stroke:none;" d=""/> +</symbol> +<symbol overflow="visible" id="glyph1-1"> +<path style="stroke:none;" d="M 0.375 -1.6875 L 1.203125 -1.757812 C 1.265625 -1.351562 1.410156 -1.050781 1.632812 -0.847656 C 1.855469 -0.644531 2.125 -0.539062 2.445312 -0.539062 C 2.824219 -0.539062 3.148438 -0.683594 3.410156 -0.972656 C 3.671875 -1.257812 3.804688 -1.640625 3.804688 -2.113281 C 3.804688 -2.566406 3.679688 -2.921875 3.425781 -3.179688 C 3.171875 -3.441406 2.839844 -3.574219 2.429688 -3.574219 C 2.175781 -3.574219 1.945312 -3.515625 1.742188 -3.398438 C 1.535156 -3.28125 1.375 -3.132812 1.257812 -2.949219 L 0.515625 -3.046875 L 1.136719 -6.355469 L 4.34375 -6.355469 L 4.34375 -5.597656 L 1.769531 -5.597656 L 1.421875 -3.867188 C 1.808594 -4.136719 2.214844 -4.273438 2.640625 -4.273438 C 3.203125 -4.273438 3.679688 -4.078125 4.066406 -3.6875 C 4.453125 -3.296875 4.644531 -2.796875 4.644531 -2.183594 C 4.644531 -1.601562 4.476562 -1.097656 4.136719 -0.671875 C 3.722656 -0.152344 3.15625 0.109375 2.445312 0.109375 C 1.859375 0.109375 1.378906 -0.0546875 1.007812 -0.382812 C 0.636719 -0.710938 0.425781 -1.144531 0.375 -1.6875 Z "/> +</symbol> +<symbol overflow="visible" id="glyph1-2"> +<path style="stroke:none;" d="M 4.476562 -4.863281 L 3.691406 -4.804688 C 3.621094 -5.113281 3.523438 -5.339844 3.390625 -5.480469 C 3.179688 -5.707031 2.914062 -5.820312 2.601562 -5.820312 C 2.351562 -5.820312 2.128906 -5.75 1.9375 -5.609375 C 1.6875 -5.425781 1.492188 -5.160156 1.347656 -4.8125 C 1.203125 -4.464844 1.132812 -3.96875 1.125 -3.320312 C 1.316406 -3.613281 1.546875 -3.828125 1.824219 -3.96875 C 2.097656 -4.109375 2.386719 -4.179688 2.6875 -4.179688 C 3.214844 -4.179688 3.664062 -3.984375 4.035156 -3.597656 C 4.40625 -3.210938 4.59375 -2.707031 4.59375 -2.09375 C 4.59375 -1.6875 4.503906 -1.3125 4.332031 -0.964844 C 4.15625 -0.617188 3.917969 -0.351562 3.613281 -0.167969 C 3.308594 0.015625 2.960938 0.109375 2.574219 0.109375 C 1.914062 0.109375 1.378906 -0.132812 0.960938 -0.617188 C 0.546875 -1.101562 0.339844 -1.902344 0.339844 -3.015625 C 0.339844 -4.261719 0.570312 -5.164062 1.027344 -5.730469 C 1.429688 -6.222656 1.96875 -6.46875 2.648438 -6.46875 C 3.15625 -6.46875 3.570312 -6.328125 3.894531 -6.042969 C 4.21875 -5.757812 4.414062 -5.367188 4.476562 -4.863281 Z M 1.25 -2.085938 C 1.25 -1.8125 1.304688 -1.554688 1.421875 -1.304688 C 1.539062 -1.054688 1.699219 -0.867188 1.90625 -0.734375 C 2.113281 -0.605469 2.332031 -0.539062 2.5625 -0.539062 C 2.894531 -0.539062 3.183594 -0.675781 3.421875 -0.945312 C 3.664062 -1.214844 3.785156 -1.582031 3.785156 -2.042969 C 3.785156 -2.488281 3.664062 -2.839844 3.429688 -3.097656 C 3.191406 -3.351562 2.890625 -3.480469 2.53125 -3.480469 C 2.171875 -3.480469 1.871094 -3.351562 1.621094 -3.097656 C 1.371094 -2.839844 1.25 -2.503906 1.25 -2.085938 Z "/> +</symbol> +<symbol overflow="visible" id="glyph1-3"> +<path style="stroke:none;" d="M 0.425781 -5.597656 L 0.425781 -6.359375 L 4.597656 -6.359375 L 4.597656 -5.742188 C 4.1875 -5.304688 3.78125 -4.726562 3.378906 -4.003906 C 2.976562 -3.28125 2.664062 -2.535156 2.445312 -1.769531 C 2.285156 -1.230469 2.183594 -0.640625 2.140625 0 L 1.328125 0 C 1.335938 -0.507812 1.4375 -1.117188 1.625 -1.835938 C 1.816406 -2.554688 2.089844 -3.246094 2.445312 -3.914062 C 2.800781 -4.578125 3.179688 -5.140625 3.582031 -5.597656 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-0"> +<path style="stroke:none;" d=""/> +</symbol> +<symbol overflow="visible" id="glyph2-1"> +<path style="stroke:none;" d="M 0 -0.734375 L -7.15625 -0.734375 L -7.15625 -3.417969 C -7.15625 -3.964844 -7.085938 -4.402344 -6.941406 -4.734375 C -6.796875 -5.0625 -6.574219 -5.324219 -6.273438 -5.511719 C -5.972656 -5.699219 -5.65625 -5.789062 -5.328125 -5.789062 C -5.023438 -5.789062 -4.734375 -5.707031 -4.460938 -5.542969 C -4.191406 -5.375 -3.976562 -5.125 -3.808594 -4.789062 C -3.679688 -5.222656 -3.464844 -5.554688 -3.160156 -5.789062 C -2.851562 -6.023438 -2.492188 -6.136719 -2.074219 -6.136719 C -1.738281 -6.136719 -1.429688 -6.066406 -1.140625 -5.925781 C -0.851562 -5.785156 -0.628906 -5.609375 -0.472656 -5.398438 C -0.316406 -5.191406 -0.199219 -4.929688 -0.121094 -4.617188 C -0.0390625 -4.304688 0 -3.917969 0 -3.460938 Z M -4.148438 -1.679688 L -4.148438 -3.226562 C -4.148438 -3.648438 -4.179688 -3.949219 -4.234375 -4.132812 C -4.304688 -4.371094 -4.421875 -4.554688 -4.589844 -4.675781 C -4.757812 -4.796875 -4.964844 -4.859375 -5.214844 -4.859375 C -5.453125 -4.859375 -5.660156 -4.800781 -5.84375 -4.6875 C -6.023438 -4.574219 -6.148438 -4.410156 -6.214844 -4.199219 C -6.28125 -3.988281 -6.3125 -3.625 -6.3125 -3.109375 L -6.3125 -1.679688 Z M -0.84375 -1.679688 L -0.84375 -3.460938 C -0.84375 -3.765625 -0.855469 -3.984375 -0.878906 -4.105469 C -0.917969 -4.324219 -0.984375 -4.507812 -1.074219 -4.652344 C -1.164062 -4.800781 -1.296875 -4.921875 -1.472656 -5.015625 C -1.648438 -5.109375 -1.847656 -5.15625 -2.074219 -5.15625 C -2.34375 -5.15625 -2.574219 -5.085938 -2.769531 -4.953125 C -2.96875 -4.816406 -3.105469 -4.625 -3.1875 -4.382812 C -3.265625 -4.140625 -3.304688 -3.789062 -3.304688 -3.335938 L -3.304688 -1.679688 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-2"> +<path style="stroke:none;" d="M 1.996094 -0.621094 L 1.171875 -0.523438 C 1.222656 -0.714844 1.25 -0.882812 1.25 -1.023438 C 1.25 -1.21875 1.21875 -1.375 1.152344 -1.492188 C 1.085938 -1.609375 0.996094 -1.707031 0.878906 -1.78125 C 0.789062 -1.835938 0.574219 -1.925781 0.226562 -2.050781 C 0.175781 -2.066406 0.105469 -2.09375 0.0078125 -2.128906 L -5.1875 -0.160156 L -5.1875 -1.109375 L -2.183594 -2.1875 C -1.800781 -2.328125 -1.402344 -2.453125 -0.980469 -2.5625 C -1.382812 -2.664062 -1.777344 -2.785156 -2.164062 -2.925781 L -5.1875 -4.03125 L -5.1875 -4.914062 L 0.0859375 -2.9375 C 0.65625 -2.726562 1.050781 -2.5625 1.265625 -2.445312 C 1.554688 -2.289062 1.765625 -2.109375 1.902344 -1.910156 C 2.039062 -1.707031 2.105469 -1.464844 2.105469 -1.1875 C 2.105469 -1.015625 2.070312 -0.828125 1.996094 -0.621094 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-3"> +<path style="stroke:none;" d="M -0.785156 -2.578125 L -0.0078125 -2.703125 C 0.0429688 -2.457031 0.0703125 -2.234375 0.0703125 -2.039062 C 0.0703125 -1.722656 0.0195312 -1.476562 -0.0820312 -1.296875 C -0.183594 -1.121094 -0.316406 -1 -0.480469 -0.929688 C -0.644531 -0.855469 -0.992188 -0.820312 -1.519531 -0.820312 L -4.5 -0.820312 L -4.5 -0.175781 L -5.1875 -0.175781 L -5.1875 -0.820312 L -6.46875 -0.820312 L -6.996094 -1.695312 L -5.1875 -1.695312 L -5.1875 -2.578125 L -4.5 -2.578125 L -4.5 -1.695312 L -1.46875 -1.695312 C -1.21875 -1.695312 -1.058594 -1.710938 -0.984375 -1.742188 C -0.914062 -1.773438 -0.859375 -1.820312 -0.816406 -1.890625 C -0.773438 -1.960938 -0.75 -2.0625 -0.75 -2.191406 C -0.75 -2.289062 -0.761719 -2.417969 -0.785156 -2.578125 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-4"> +<path style="stroke:none;" d="M -1.671875 -4.210938 L -1.558594 -5.117188 C -1.027344 -4.972656 -0.617188 -4.707031 -0.320312 -4.320312 C -0.0273438 -3.933594 0.117188 -3.4375 0.117188 -2.835938 C 0.117188 -2.078125 -0.117188 -1.476562 -0.582031 -1.03125 C -1.050781 -0.585938 -1.707031 -0.367188 -2.546875 -0.367188 C -3.421875 -0.367188 -4.097656 -0.589844 -4.578125 -1.039062 C -5.0625 -1.488281 -5.304688 -2.070312 -5.304688 -2.789062 C -5.304688 -3.480469 -5.066406 -4.046875 -4.59375 -4.488281 C -4.121094 -4.925781 -3.457031 -5.148438 -2.601562 -5.148438 C -2.550781 -5.148438 -2.472656 -5.144531 -2.367188 -5.140625 L -2.367188 -1.273438 C -1.796875 -1.304688 -1.363281 -1.46875 -1.058594 -1.757812 C -0.757812 -2.046875 -0.605469 -2.410156 -0.605469 -2.84375 C -0.605469 -3.164062 -0.691406 -3.4375 -0.859375 -3.667969 C -1.027344 -3.894531 -1.296875 -4.074219 -1.671875 -4.210938 Z M -3.089844 -1.324219 L -3.089844 -4.21875 C -3.527344 -4.179688 -3.855469 -4.070312 -4.070312 -3.886719 C -4.410156 -3.605469 -4.578125 -3.242188 -4.578125 -2.796875 C -4.578125 -2.394531 -4.445312 -2.054688 -4.175781 -1.78125 C -3.90625 -1.503906 -3.542969 -1.351562 -3.089844 -1.324219 Z "/> +</symbol> +<symbol overflow="visible" id="glyph2-5"> +<path style="stroke:none;" d="M -1.546875 -0.308594 L -1.683594 -1.175781 C -1.335938 -1.226562 -1.070312 -1.363281 -0.882812 -1.585938 C -0.699219 -1.808594 -0.605469 -2.117188 -0.605469 -2.519531 C -0.605469 -2.921875 -0.6875 -3.222656 -0.851562 -3.417969 C -1.015625 -3.613281 -1.210938 -3.710938 -1.429688 -3.710938 C -1.628906 -3.710938 -1.785156 -3.625 -1.898438 -3.453125 C -1.976562 -3.332031 -2.078125 -3.03125 -2.195312 -2.554688 C -2.359375 -1.910156 -2.5 -1.460938 -2.621094 -1.214844 C -2.738281 -0.964844 -2.902344 -0.777344 -3.113281 -0.648438 C -3.324219 -0.519531 -3.554688 -0.453125 -3.808594 -0.453125 C -4.039062 -0.453125 -4.253906 -0.507812 -4.449219 -0.613281 C -4.648438 -0.71875 -4.8125 -0.863281 -4.941406 -1.046875 C -5.042969 -1.183594 -5.128906 -1.367188 -5.199219 -1.605469 C -5.269531 -1.839844 -5.304688 -2.09375 -5.304688 -2.363281 C -5.304688 -2.769531 -5.242188 -3.128906 -5.125 -3.433594 C -5.007812 -3.742188 -4.851562 -3.96875 -4.652344 -4.117188 C -4.453125 -4.261719 -4.183594 -4.363281 -3.847656 -4.417969 L -3.730469 -3.558594 C -3.996094 -3.519531 -4.207031 -3.40625 -4.355469 -3.21875 C -4.503906 -3.03125 -4.578125 -2.769531 -4.578125 -2.425781 C -4.578125 -2.023438 -4.511719 -1.734375 -4.378906 -1.5625 C -4.246094 -1.390625 -4.089844 -1.304688 -3.910156 -1.304688 C -3.796875 -1.304688 -3.695312 -1.339844 -3.601562 -1.410156 C -3.507812 -1.484375 -3.429688 -1.59375 -3.367188 -1.75 C -3.335938 -1.835938 -3.261719 -2.09375 -3.144531 -2.523438 C -2.976562 -3.144531 -2.84375 -3.578125 -2.738281 -3.824219 C -2.632812 -4.070312 -2.476562 -4.265625 -2.273438 -4.40625 C -2.074219 -4.546875 -1.824219 -4.613281 -1.523438 -4.613281 C -1.230469 -4.613281 -0.953125 -4.527344 -0.695312 -4.359375 C -0.4375 -4.1875 -0.238281 -3.941406 -0.09375 -3.617188 C 0.046875 -3.296875 0.117188 -2.929688 0.117188 -2.523438 C 0.117188 -1.851562 -0.0234375 -1.335938 -0.304688 -0.984375 C -0.582031 -0.632812 -0.996094 -0.40625 -1.546875 -0.308594 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-0"> +<path style="stroke:none;" d=""/> +</symbol> +<symbol overflow="visible" id="glyph3-1"> +<path style="stroke:none;" d="M 0.984375 0 L 0.984375 -8.589844 L 6.78125 -8.589844 L 6.78125 -7.578125 L 2.121094 -7.578125 L 2.121094 -4.914062 L 6.152344 -4.914062 L 6.152344 -3.902344 L 2.121094 -3.902344 L 2.121094 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-2"> +<path style="stroke:none;" d="M 0.796875 -7.375 L 0.796875 -8.589844 L 1.851562 -8.589844 L 1.851562 -7.375 Z M 0.796875 0 L 0.796875 -6.222656 L 1.851562 -6.222656 L 1.851562 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-3"> +<path style="stroke:none;" d="M 0.765625 0 L 0.765625 -8.589844 L 1.820312 -8.589844 L 1.820312 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-4"> +<path style="stroke:none;" d="M 5.050781 -2.003906 L 6.140625 -1.867188 C 5.96875 -1.230469 5.648438 -0.738281 5.1875 -0.386719 C 4.722656 -0.0351562 4.125 0.140625 3.40625 0.140625 C 2.496094 0.140625 1.773438 -0.140625 1.238281 -0.699219 C 0.707031 -1.261719 0.4375 -2.046875 0.4375 -3.058594 C 0.4375 -4.105469 0.710938 -4.917969 1.25 -5.496094 C 1.789062 -6.074219 2.484375 -6.363281 3.34375 -6.363281 C 4.175781 -6.363281 4.859375 -6.078125 5.382812 -5.515625 C 5.910156 -4.949219 6.175781 -4.148438 6.175781 -3.125 C 6.175781 -3.0625 6.171875 -2.96875 6.171875 -2.84375 L 1.53125 -2.84375 C 1.570312 -2.160156 1.761719 -1.632812 2.109375 -1.273438 C 2.457031 -0.910156 2.890625 -0.726562 3.410156 -0.726562 C 3.796875 -0.726562 4.125 -0.828125 4.398438 -1.03125 C 4.671875 -1.234375 4.890625 -1.558594 5.050781 -2.003906 Z M 1.585938 -3.710938 L 5.0625 -3.710938 C 5.015625 -4.234375 4.882812 -4.625 4.664062 -4.886719 C 4.328125 -5.292969 3.890625 -5.496094 3.359375 -5.496094 C 2.875 -5.496094 2.464844 -5.335938 2.136719 -5.007812 C 1.804688 -4.683594 1.625 -4.25 1.585938 -3.710938 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-5"> +<path style="stroke:none;" d="M 0.367188 -1.859375 L 1.414062 -2.023438 C 1.472656 -1.605469 1.632812 -1.28125 1.902344 -1.0625 C 2.167969 -0.839844 2.542969 -0.726562 3.023438 -0.726562 C 3.507812 -0.726562 3.867188 -0.824219 4.101562 -1.023438 C 4.335938 -1.21875 4.453125 -1.453125 4.453125 -1.71875 C 4.453125 -1.957031 4.351562 -2.140625 4.140625 -2.28125 C 3.996094 -2.375 3.640625 -2.492188 3.0625 -2.636719 C 2.289062 -2.832031 1.753906 -3 1.457031 -3.144531 C 1.15625 -3.285156 0.929688 -3.484375 0.777344 -3.734375 C 0.621094 -3.988281 0.546875 -4.265625 0.546875 -4.570312 C 0.546875 -4.847656 0.609375 -5.105469 0.734375 -5.339844 C 0.863281 -5.578125 1.035156 -5.773438 1.253906 -5.929688 C 1.417969 -6.050781 1.640625 -6.152344 1.925781 -6.238281 C 2.207031 -6.320312 2.511719 -6.363281 2.835938 -6.363281 C 3.324219 -6.363281 3.753906 -6.292969 4.121094 -6.152344 C 4.492188 -6.011719 4.765625 -5.820312 4.9375 -5.582031 C 5.113281 -5.339844 5.234375 -5.019531 5.304688 -4.617188 L 4.273438 -4.476562 C 4.226562 -4.796875 4.089844 -5.046875 3.863281 -5.226562 C 3.640625 -5.40625 3.320312 -5.496094 2.914062 -5.496094 C 2.429688 -5.496094 2.082031 -5.414062 1.875 -5.257812 C 1.667969 -5.097656 1.5625 -4.90625 1.5625 -4.695312 C 1.5625 -4.558594 1.609375 -4.433594 1.695312 -4.324219 C 1.78125 -4.210938 1.914062 -4.117188 2.097656 -4.042969 C 2.203125 -4.003906 2.515625 -3.914062 3.03125 -3.773438 C 3.777344 -3.574219 4.296875 -3.410156 4.589844 -3.285156 C 4.886719 -3.15625 5.117188 -2.972656 5.285156 -2.730469 C 5.453125 -2.488281 5.539062 -2.1875 5.539062 -1.828125 C 5.539062 -1.476562 5.433594 -1.144531 5.230469 -0.835938 C 5.023438 -0.523438 4.726562 -0.285156 4.34375 -0.113281 C 3.957031 0.0546875 3.515625 0.140625 3.03125 0.140625 C 2.222656 0.140625 1.605469 -0.0273438 1.179688 -0.363281 C 0.757812 -0.699219 0.484375 -1.195312 0.367188 -1.859375 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-6"> +<path style="stroke:none;" d="M 0.234375 0 L 0.234375 -0.855469 L 4.195312 -5.402344 C 3.746094 -5.378906 3.351562 -5.367188 3.007812 -5.367188 L 0.46875 -5.367188 L 0.46875 -6.222656 L 5.554688 -6.222656 L 5.554688 -5.523438 L 2.1875 -1.578125 L 1.535156 -0.855469 C 2.007812 -0.890625 2.453125 -0.90625 2.867188 -0.90625 L 5.742188 -0.90625 L 5.742188 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-7"> +<path style="stroke:none;" d="M 0.398438 -3.109375 C 0.398438 -4.261719 0.71875 -5.117188 1.359375 -5.671875 C 1.894531 -6.132812 2.546875 -6.363281 3.316406 -6.363281 C 4.171875 -6.363281 4.871094 -6.082031 5.414062 -5.523438 C 5.957031 -4.960938 6.226562 -4.1875 6.226562 -3.199219 C 6.226562 -2.398438 6.109375 -1.769531 5.867188 -1.308594 C 5.628906 -0.851562 5.277344 -0.492188 4.820312 -0.242188 C 4.359375 0.0117188 3.859375 0.140625 3.316406 0.140625 C 2.445312 0.140625 1.742188 -0.140625 1.203125 -0.695312 C 0.667969 -1.253906 0.398438 -2.0625 0.398438 -3.109375 Z M 1.484375 -3.109375 C 1.484375 -2.3125 1.65625 -1.71875 2.003906 -1.320312 C 2.351562 -0.925781 2.789062 -0.726562 3.316406 -0.726562 C 3.839844 -0.726562 4.273438 -0.925781 4.625 -1.324219 C 4.972656 -1.722656 5.144531 -2.328125 5.144531 -3.148438 C 5.144531 -3.917969 4.96875 -4.5 4.621094 -4.894531 C 4.269531 -5.292969 3.835938 -5.492188 3.316406 -5.492188 C 2.789062 -5.492188 2.351562 -5.292969 2.003906 -4.898438 C 1.65625 -4.503906 1.484375 -3.90625 1.484375 -3.109375 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-8"> +<path style="stroke:none;" d="M 1.042969 0 L 1.042969 -5.402344 L 0.109375 -5.402344 L 0.109375 -6.222656 L 1.042969 -6.222656 L 1.042969 -6.882812 C 1.042969 -7.300781 1.078125 -7.613281 1.15625 -7.816406 C 1.257812 -8.089844 1.433594 -8.3125 1.691406 -8.480469 C 1.945312 -8.652344 2.304688 -8.734375 2.765625 -8.734375 C 3.0625 -8.734375 3.390625 -8.703125 3.75 -8.632812 L 3.59375 -7.710938 C 3.375 -7.75 3.164062 -7.769531 2.96875 -7.769531 C 2.648438 -7.769531 2.421875 -7.703125 2.289062 -7.5625 C 2.15625 -7.425781 2.09375 -7.171875 2.09375 -6.796875 L 2.09375 -6.222656 L 3.304688 -6.222656 L 3.304688 -5.402344 L 2.09375 -5.402344 L 2.09375 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-9"> +<path style="stroke:none;" d="M 0.789062 0 L 0.789062 -6.222656 L 1.734375 -6.222656 L 1.734375 -5.351562 C 1.929688 -5.65625 2.1875 -5.898438 2.515625 -6.085938 C 2.839844 -6.269531 3.207031 -6.363281 3.621094 -6.363281 C 4.082031 -6.363281 4.460938 -6.265625 4.753906 -6.078125 C 5.050781 -5.886719 5.257812 -5.617188 5.378906 -5.273438 C 5.871094 -6 6.511719 -6.363281 7.300781 -6.363281 C 7.917969 -6.363281 8.390625 -6.191406 8.726562 -5.851562 C 9.058594 -5.507812 9.222656 -4.984375 9.222656 -4.273438 L 9.222656 0 L 8.171875 0 L 8.171875 -3.921875 C 8.171875 -4.34375 8.140625 -4.644531 8.070312 -4.832031 C 8.003906 -5.015625 7.878906 -5.164062 7.699219 -5.28125 C 7.519531 -5.394531 7.308594 -5.449219 7.066406 -5.449219 C 6.628906 -5.449219 6.265625 -5.304688 5.976562 -5.011719 C 5.6875 -4.722656 5.542969 -4.257812 5.542969 -3.617188 L 5.542969 0 L 4.488281 0 L 4.488281 -4.042969 C 4.488281 -4.511719 4.402344 -4.863281 4.230469 -5.097656 C 4.058594 -5.332031 3.777344 -5.449219 3.386719 -5.449219 C 3.089844 -5.449219 2.816406 -5.371094 2.5625 -5.214844 C 2.3125 -5.058594 2.128906 -4.828125 2.015625 -4.53125 C 1.902344 -4.230469 1.84375 -3.796875 1.84375 -3.226562 L 1.84375 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-10"> +<path style="stroke:none;" d="M 4.828125 0 L 4.828125 -0.785156 C 4.433594 -0.167969 3.851562 0.140625 3.085938 0.140625 C 2.589844 0.140625 2.136719 0.00390625 1.71875 -0.269531 C 1.304688 -0.542969 0.980469 -0.925781 0.753906 -1.414062 C 0.523438 -1.90625 0.410156 -2.46875 0.410156 -3.105469 C 0.410156 -3.726562 0.515625 -4.289062 0.71875 -4.796875 C 0.925781 -5.300781 1.238281 -5.6875 1.652344 -5.960938 C 2.066406 -6.230469 2.53125 -6.363281 3.039062 -6.363281 C 3.414062 -6.363281 3.75 -6.285156 4.042969 -6.125 C 4.335938 -5.96875 4.574219 -5.761719 4.757812 -5.507812 L 4.757812 -8.589844 L 5.804688 -8.589844 L 5.804688 0 Z M 1.492188 -3.105469 C 1.492188 -2.308594 1.664062 -1.710938 2 -1.320312 C 2.335938 -0.925781 2.730469 -0.726562 3.1875 -0.726562 C 3.648438 -0.726562 4.039062 -0.914062 4.363281 -1.292969 C 4.683594 -1.667969 4.84375 -2.242188 4.84375 -3.015625 C 4.84375 -3.867188 4.679688 -4.492188 4.351562 -4.890625 C 4.023438 -5.289062 3.621094 -5.492188 3.140625 -5.492188 C 2.671875 -5.492188 2.28125 -5.296875 1.964844 -4.914062 C 1.652344 -4.53125 1.492188 -3.929688 1.492188 -3.105469 Z "/> +</symbol> +<symbol overflow="visible" id="glyph3-11"> +<path style="stroke:none;" d="M 4.867188 0 L 4.867188 -0.914062 C 4.382812 -0.210938 3.726562 0.140625 2.894531 0.140625 C 2.527344 0.140625 2.183594 0.0703125 1.867188 -0.0703125 C 1.546875 -0.210938 1.3125 -0.386719 1.15625 -0.601562 C 1.003906 -0.8125 0.894531 -1.074219 0.832031 -1.382812 C 0.789062 -1.589844 0.765625 -1.917969 0.765625 -2.367188 L 0.765625 -6.222656 L 1.820312 -6.222656 L 1.820312 -2.773438 C 1.820312 -2.222656 1.84375 -1.851562 1.886719 -1.65625 C 1.953125 -1.378906 2.09375 -1.164062 2.308594 -1.003906 C 2.523438 -0.847656 2.789062 -0.765625 3.105469 -0.765625 C 3.421875 -0.765625 3.71875 -0.847656 3.996094 -1.011719 C 4.273438 -1.171875 4.46875 -1.394531 4.585938 -1.671875 C 4.699219 -1.953125 4.757812 -2.359375 4.757812 -2.890625 L 4.757812 -6.222656 L 5.8125 -6.222656 L 5.8125 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-0"> +<path style="stroke:none;" d=""/> +</symbol> +<symbol overflow="visible" id="glyph4-1"> +<path style="stroke:none;" d="M 0.953125 0 L 0.953125 -9.304688 L 4.445312 -9.304688 C 5.15625 -9.304688 5.722656 -9.210938 6.152344 -9.023438 C 6.582031 -8.835938 6.921875 -8.546875 7.164062 -8.152344 C 7.40625 -7.761719 7.527344 -7.351562 7.527344 -6.925781 C 7.527344 -6.527344 7.421875 -6.152344 7.203125 -5.800781 C 6.988281 -5.449219 6.664062 -5.167969 6.226562 -4.953125 C 6.789062 -4.785156 7.222656 -4.503906 7.523438 -4.105469 C 7.828125 -3.707031 7.980469 -3.238281 7.980469 -2.699219 C 7.980469 -2.261719 7.886719 -1.855469 7.703125 -1.480469 C 7.519531 -1.105469 7.292969 -0.820312 7.019531 -0.617188 C 6.75 -0.414062 6.410156 -0.257812 6 -0.15625 C 5.59375 -0.0507812 5.09375 0 4.5 0 Z M 2.183594 -5.394531 L 4.195312 -5.394531 C 4.742188 -5.394531 5.132812 -5.429688 5.371094 -5.503906 C 5.683594 -5.597656 5.917969 -5.75 6.078125 -5.96875 C 6.238281 -6.183594 6.316406 -6.453125 6.316406 -6.78125 C 6.316406 -7.089844 6.242188 -7.359375 6.09375 -7.59375 C 5.945312 -7.828125 5.734375 -7.992188 5.460938 -8.078125 C 5.183594 -8.164062 4.710938 -8.207031 4.042969 -8.207031 L 2.183594 -8.207031 Z M 2.183594 -1.097656 L 4.5 -1.097656 C 4.898438 -1.097656 5.175781 -1.113281 5.339844 -1.140625 C 5.621094 -1.191406 5.859375 -1.277344 6.050781 -1.398438 C 6.242188 -1.515625 6.394531 -1.6875 6.519531 -1.914062 C 6.640625 -2.140625 6.703125 -2.402344 6.703125 -2.699219 C 6.703125 -3.046875 6.613281 -3.347656 6.4375 -3.601562 C 6.257812 -3.859375 6.011719 -4.039062 5.695312 -4.140625 C 5.382812 -4.246094 4.929688 -4.296875 4.335938 -4.296875 L 2.183594 -4.296875 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-2"> +<path style="stroke:none;" d="M 0.429688 -3.371094 C 0.429688 -4.617188 0.777344 -5.542969 1.472656 -6.144531 C 2.050781 -6.644531 2.757812 -6.894531 3.59375 -6.894531 C 4.519531 -6.894531 5.277344 -6.589844 5.867188 -5.984375 C 6.453125 -5.375 6.746094 -4.535156 6.746094 -3.464844 C 6.746094 -2.597656 6.617188 -1.914062 6.355469 -1.417969 C 6.097656 -0.921875 5.71875 -0.535156 5.222656 -0.261719 C 4.722656 0.015625 4.179688 0.152344 3.59375 0.152344 C 2.648438 0.152344 1.886719 -0.148438 1.304688 -0.753906 C 0.722656 -1.359375 0.429688 -2.230469 0.429688 -3.371094 Z M 1.605469 -3.371094 C 1.605469 -2.507812 1.792969 -1.859375 2.171875 -1.429688 C 2.546875 -1 3.023438 -0.789062 3.59375 -0.789062 C 4.160156 -0.789062 4.632812 -1.003906 5.007812 -1.433594 C 5.382812 -1.867188 5.574219 -2.523438 5.574219 -3.410156 C 5.574219 -4.242188 5.382812 -4.875 5.003906 -5.304688 C 4.625 -5.734375 4.15625 -5.949219 3.59375 -5.949219 C 3.023438 -5.949219 2.546875 -5.734375 2.171875 -5.304688 C 1.792969 -4.878906 1.605469 -4.234375 1.605469 -3.371094 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-3"> +<path style="stroke:none;" d="M 0.398438 -2.011719 L 1.53125 -2.191406 C 1.59375 -1.738281 1.769531 -1.390625 2.058594 -1.148438 C 2.347656 -0.90625 2.753906 -0.789062 3.273438 -0.789062 C 3.800781 -0.789062 4.1875 -0.894531 4.445312 -1.109375 C 4.699219 -1.320312 4.824219 -1.570312 4.824219 -1.859375 C 4.824219 -2.117188 4.710938 -2.320312 4.488281 -2.46875 C 4.332031 -2.570312 3.941406 -2.699219 3.320312 -2.855469 C 2.480469 -3.066406 1.902344 -3.25 1.578125 -3.40625 C 1.253906 -3.558594 1.007812 -3.773438 0.839844 -4.046875 C 0.671875 -4.320312 0.589844 -4.621094 0.589844 -4.953125 C 0.589844 -5.253906 0.660156 -5.53125 0.796875 -5.785156 C 0.933594 -6.042969 1.121094 -6.253906 1.359375 -6.421875 C 1.535156 -6.554688 1.777344 -6.667969 2.085938 -6.757812 C 2.390625 -6.847656 2.722656 -6.894531 3.070312 -6.894531 C 3.601562 -6.894531 4.066406 -6.816406 4.464844 -6.664062 C 4.867188 -6.511719 5.160156 -6.304688 5.351562 -6.046875 C 5.542969 -5.785156 5.671875 -5.4375 5.746094 -5 L 4.628906 -4.851562 C 4.578125 -5.195312 4.429688 -5.46875 4.1875 -5.664062 C 3.945312 -5.859375 3.597656 -5.953125 3.15625 -5.953125 C 2.628906 -5.953125 2.253906 -5.867188 2.03125 -5.695312 C 1.808594 -5.519531 1.695312 -5.316406 1.695312 -5.085938 C 1.695312 -4.9375 1.742188 -4.804688 1.835938 -4.683594 C 1.929688 -4.5625 2.074219 -4.460938 2.273438 -4.378906 C 2.386719 -4.335938 2.722656 -4.242188 3.28125 -4.085938 C 4.089844 -3.871094 4.652344 -3.695312 4.972656 -3.558594 C 5.292969 -3.421875 5.542969 -3.21875 5.726562 -2.957031 C 5.90625 -2.695312 6 -2.371094 6 -1.980469 C 6 -1.601562 5.886719 -1.242188 5.664062 -0.90625 C 5.441406 -0.570312 5.121094 -0.308594 4.703125 -0.125 C 4.285156 0.0585938 3.8125 0.152344 3.28125 0.152344 C 2.40625 0.152344 1.738281 -0.03125 1.277344 -0.394531 C 0.820312 -0.757812 0.527344 -1.296875 0.398438 -2.011719 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-4"> +<path style="stroke:none;" d="M 3.351562 -1.023438 L 3.515625 -0.0117188 C 3.195312 0.0546875 2.90625 0.0898438 2.652344 0.0898438 C 2.238281 0.0898438 1.917969 0.0234375 1.6875 -0.109375 C 1.460938 -0.238281 1.300781 -0.410156 1.207031 -0.625 C 1.113281 -0.839844 1.066406 -1.289062 1.066406 -1.972656 L 1.066406 -5.851562 L 0.226562 -5.851562 L 0.226562 -6.742188 L 1.066406 -6.742188 L 1.066406 -8.410156 L 2.203125 -9.097656 L 2.203125 -6.742188 L 3.351562 -6.742188 L 3.351562 -5.851562 L 2.203125 -5.851562 L 2.203125 -1.910156 C 2.203125 -1.585938 2.222656 -1.375 2.261719 -1.28125 C 2.304688 -1.1875 2.367188 -1.113281 2.460938 -1.058594 C 2.550781 -1.003906 2.679688 -0.976562 2.851562 -0.976562 C 2.976562 -0.976562 3.144531 -0.992188 3.351562 -1.023438 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-5"> +<path style="stroke:none;" d="M 1.179688 0 L 1.179688 -1.300781 L 2.480469 -1.300781 L 2.480469 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-6"> +<path style="stroke:none;" d="M 1.003906 0 L 1.003906 -9.304688 L 4.511719 -9.304688 C 5.128906 -9.304688 5.601562 -9.277344 5.929688 -9.21875 C 6.386719 -9.140625 6.769531 -8.996094 7.078125 -8.78125 C 7.386719 -8.566406 7.636719 -8.269531 7.824219 -7.882812 C 8.011719 -7.5 8.105469 -7.074219 8.105469 -6.613281 C 8.105469 -5.824219 7.855469 -5.152344 7.351562 -4.605469 C 6.847656 -4.058594 5.9375 -3.78125 4.621094 -3.78125 L 2.234375 -3.78125 L 2.234375 0 Z M 2.234375 -4.882812 L 4.640625 -4.882812 C 5.4375 -4.882812 6 -5.03125 6.335938 -5.324219 C 6.667969 -5.621094 6.835938 -6.039062 6.835938 -6.578125 C 6.835938 -6.964844 6.738281 -7.296875 6.542969 -7.574219 C 6.34375 -7.851562 6.085938 -8.035156 5.765625 -8.125 C 5.558594 -8.179688 5.171875 -8.207031 4.613281 -8.207031 L 2.234375 -8.207031 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-7"> +<path style="stroke:none;" d="M 0.804688 2.597656 L 0.679688 1.523438 C 0.929688 1.589844 1.148438 1.625 1.332031 1.625 C 1.585938 1.625 1.789062 1.582031 1.941406 1.5 C 2.09375 1.414062 2.21875 1.296875 2.316406 1.140625 C 2.390625 1.027344 2.503906 0.746094 2.664062 0.292969 C 2.6875 0.230469 2.722656 0.136719 2.765625 0.0117188 L 0.210938 -6.742188 L 1.441406 -6.742188 L 2.84375 -2.835938 C 3.027344 -2.34375 3.1875 -1.820312 3.332031 -1.277344 C 3.464844 -1.800781 3.621094 -2.3125 3.800781 -2.8125 L 5.242188 -6.742188 L 6.386719 -6.742188 L 3.820312 0.113281 C 3.546875 0.855469 3.332031 1.363281 3.179688 1.644531 C 2.976562 2.019531 2.746094 2.296875 2.480469 2.472656 C 2.21875 2.648438 1.90625 2.734375 1.542969 2.734375 C 1.324219 2.734375 1.078125 2.6875 0.804688 2.597656 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-8"> +<path style="stroke:none;" d="M 0.855469 0 L 0.855469 -9.304688 L 2 -9.304688 L 2 -5.96875 C 2.53125 -6.585938 3.207031 -6.894531 4.019531 -6.894531 C 4.519531 -6.894531 4.953125 -6.796875 5.320312 -6.597656 C 5.6875 -6.402344 5.949219 -6.128906 6.109375 -5.78125 C 6.269531 -5.433594 6.347656 -4.933594 6.347656 -4.273438 L 6.347656 0 L 5.203125 0 L 5.203125 -4.273438 C 5.203125 -4.84375 5.082031 -5.257812 4.832031 -5.519531 C 4.585938 -5.78125 4.234375 -5.910156 3.78125 -5.910156 C 3.445312 -5.910156 3.125 -5.820312 2.828125 -5.644531 C 2.53125 -5.46875 2.316406 -5.234375 2.191406 -4.933594 C 2.0625 -4.632812 2 -4.21875 2 -3.6875 L 2 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-9"> +<path style="stroke:none;" d="M 0.855469 0 L 0.855469 -6.742188 L 1.886719 -6.742188 L 1.886719 -5.78125 C 2.382812 -6.523438 3.09375 -6.894531 4.03125 -6.894531 C 4.4375 -6.894531 4.808594 -6.820312 5.152344 -6.675781 C 5.492188 -6.527344 5.746094 -6.335938 5.914062 -6.101562 C 6.085938 -5.863281 6.203125 -5.582031 6.273438 -5.257812 C 6.3125 -5.046875 6.335938 -4.675781 6.335938 -4.144531 L 6.335938 0 L 5.191406 0 L 5.191406 -4.101562 C 5.191406 -4.566406 5.148438 -4.914062 5.058594 -5.144531 C 4.96875 -5.375 4.8125 -5.558594 4.585938 -5.695312 C 4.359375 -5.835938 4.09375 -5.902344 3.789062 -5.902344 C 3.304688 -5.902344 2.882812 -5.75 2.53125 -5.441406 C 2.175781 -5.132812 2 -4.546875 2 -3.679688 L 2 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-10"> +<path style="stroke:none;" d="M 0.855469 2.582031 L 0.855469 -6.742188 L 1.898438 -6.742188 L 1.898438 -5.867188 C 2.144531 -6.207031 2.421875 -6.464844 2.730469 -6.636719 C 3.039062 -6.808594 3.414062 -6.894531 3.851562 -6.894531 C 4.429688 -6.894531 4.9375 -6.746094 5.375 -6.449219 C 5.816406 -6.152344 6.148438 -5.734375 6.375 -5.195312 C 6.597656 -4.65625 6.710938 -4.066406 6.710938 -3.421875 C 6.710938 -2.730469 6.585938 -2.109375 6.339844 -1.558594 C 6.089844 -1.007812 5.730469 -0.582031 5.257812 -0.289062 C 4.785156 0.00390625 4.289062 0.152344 3.769531 0.152344 C 3.390625 0.152344 3.046875 0.0703125 2.746094 -0.0898438 C 2.441406 -0.25 2.195312 -0.453125 2 -0.699219 L 2 2.582031 Z M 1.890625 -3.332031 C 1.890625 -2.464844 2.066406 -1.824219 2.417969 -1.410156 C 2.769531 -0.996094 3.195312 -0.789062 3.695312 -0.789062 C 4.203125 -0.789062 4.636719 -1 5 -1.429688 C 5.359375 -1.859375 5.542969 -2.527344 5.542969 -3.429688 C 5.542969 -4.289062 5.363281 -4.929688 5.011719 -5.359375 C 4.65625 -5.785156 4.234375 -6 3.746094 -6 C 3.257812 -6 2.828125 -5.769531 2.453125 -5.316406 C 2.078125 -4.859375 1.890625 -4.199219 1.890625 -3.332031 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-11"> +<path style="stroke:none;" d="M 1.910156 0 L 0.851562 0 L 0.851562 -9.304688 L 1.992188 -9.304688 L 1.992188 -5.984375 C 2.476562 -6.589844 3.089844 -6.894531 3.839844 -6.894531 C 4.253906 -6.894531 4.648438 -6.808594 5.019531 -6.644531 C 5.390625 -6.476562 5.691406 -6.242188 5.933594 -5.9375 C 6.171875 -5.636719 6.359375 -5.269531 6.492188 -4.84375 C 6.628906 -4.414062 6.695312 -3.957031 6.695312 -3.472656 C 6.695312 -2.316406 6.410156 -1.425781 5.839844 -0.792969 C 5.269531 -0.164062 4.582031 0.152344 3.78125 0.152344 C 2.988281 0.152344 2.363281 -0.179688 1.910156 -0.84375 Z M 1.898438 -3.421875 C 1.898438 -2.613281 2.007812 -2.027344 2.226562 -1.667969 C 2.585938 -1.082031 3.074219 -0.789062 3.6875 -0.789062 C 4.1875 -0.789062 4.617188 -1.003906 4.984375 -1.4375 C 5.347656 -1.871094 5.527344 -2.519531 5.527344 -3.375 C 5.527344 -4.257812 5.355469 -4.90625 5.003906 -5.324219 C 4.65625 -5.742188 4.234375 -5.953125 3.738281 -5.953125 C 3.238281 -5.953125 2.808594 -5.738281 2.445312 -5.304688 C 2.082031 -4.871094 1.898438 -4.242188 1.898438 -3.421875 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-12"> +<path style="stroke:none;" d="M 0.863281 -7.992188 L 0.863281 -9.304688 L 2.007812 -9.304688 L 2.007812 -7.992188 Z M 0.863281 0 L 0.863281 -6.742188 L 2.007812 -6.742188 L 2.007812 0 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-13"> +<path style="stroke:none;" d="M 5.230469 0 L 5.230469 -0.851562 C 4.804688 -0.183594 4.175781 0.152344 3.34375 0.152344 C 2.808594 0.152344 2.3125 0.00390625 1.863281 -0.292969 C 1.414062 -0.589844 1.0625 -1 0.816406 -1.53125 C 0.570312 -2.0625 0.445312 -2.675781 0.445312 -3.363281 C 0.445312 -4.035156 0.554688 -4.648438 0.78125 -5.195312 C 1.003906 -5.742188 1.339844 -6.164062 1.789062 -6.457031 C 2.238281 -6.75 2.738281 -6.894531 3.292969 -6.894531 C 3.699219 -6.894531 4.0625 -6.808594 4.378906 -6.636719 C 4.695312 -6.464844 4.957031 -6.242188 5.15625 -5.96875 L 5.15625 -9.304688 L 6.289062 -9.304688 L 6.289062 0 Z M 1.617188 -3.363281 C 1.617188 -2.5 1.800781 -1.855469 2.164062 -1.429688 C 2.527344 -1 2.957031 -0.789062 3.453125 -0.789062 C 3.953125 -0.789062 4.375 -0.992188 4.726562 -1.398438 C 5.074219 -1.808594 5.25 -2.429688 5.25 -3.269531 C 5.25 -4.191406 5.070312 -4.867188 4.714844 -5.300781 C 4.359375 -5.730469 3.921875 -5.949219 3.402344 -5.949219 C 2.894531 -5.949219 2.46875 -5.742188 2.128906 -5.324219 C 1.789062 -4.910156 1.617188 -4.257812 1.617188 -3.363281 Z "/> +</symbol> +<symbol overflow="visible" id="glyph4-14"> +<path style="stroke:none;" d="M 4.84375 0 L 3.699219 0 L 3.699219 -7.28125 C 3.425781 -7.019531 3.066406 -6.757812 2.617188 -6.492188 C 2.171875 -6.230469 1.769531 -6.035156 1.414062 -5.902344 L 1.414062 -7.007812 C 2.054688 -7.308594 2.613281 -7.671875 3.089844 -8.101562 C 3.570312 -8.527344 3.90625 -8.941406 4.105469 -9.34375 L 4.84375 -9.34375 Z "/> +</symbol> +</g> +<clipPath id="clip1"> + <path d="M 94 19 L 96 19 L 96 215 L 94 215 Z "/> +</clipPath> +<clipPath id="clip2"> + <path d="M 204 19 L 206 19 L 206 215 L 204 215 Z "/> +</clipPath> +<clipPath id="clip3"> + <path d="M 314 19 L 316 19 L 316 215 L 314 215 Z "/> +</clipPath> +<clipPath id="clip4"> + <path d="M 39 171 L 355 171 L 355 173 L 39 173 Z "/> +</clipPath> +<clipPath id="clip5"> + <path d="M 39 107 L 355 107 L 355 109 L 39 109 Z "/> +</clipPath> +<clipPath id="clip6"> + <path d="M 39 44 L 355 44 L 355 46 L 39 46 Z "/> +</clipPath> +</defs> +<g id="surface18"> +<g clip-path="url(#clip1)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 95.160156 214.296875 L 95.160156 19 "/> +</g> +<g clip-path="url(#clip2)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 204.84375 214.296875 L 204.84375 19 "/> +</g> +<g clip-path="url(#clip3)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 314.53125 214.296875 L 314.53125 19 "/> +</g> +<g clip-path="url(#clip4)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 39 171.960938 L 355 171.960938 "/> +</g> +<g clip-path="url(#clip5)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 39 108.234375 L 355 108.234375 "/> +</g> +<g clip-path="url(#clip6)" clip-rule="nonzero"> +<path style="fill:none;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:0.5;stroke-dasharray:1,2;stroke-miterlimit:3.25;" d="M 39 44.511719 L 355 44.511719 "/> +</g> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 55.070312 201 C 55.070312 200.183594 54.75 199.402344 54.171875 198.828125 C 53.597656 198.25 52.816406 197.929688 52 197.929688 C 51.183594 197.929688 50.402344 198.25 49.828125 198.828125 C 49.25 199.402344 48.929688 200.183594 48.929688 201 C 48.929688 201.816406 49.25 202.597656 49.828125 203.171875 C 50.402344 203.75 51.183594 204.070312 52 204.070312 C 52.816406 204.070312 53.597656 203.75 54.171875 203.171875 C 54.75 202.597656 55.070312 201.816406 55.070312 201 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 88.070312 176 C 88.070312 175.183594 87.75 174.402344 87.171875 173.828125 C 86.597656 173.25 85.816406 172.929688 85 172.929688 C 84.183594 172.929688 83.402344 173.25 82.828125 173.828125 C 82.25 174.402344 81.929688 175.183594 81.929688 176 C 81.929688 176.816406 82.25 177.597656 82.828125 178.171875 C 83.402344 178.75 84.183594 179.070312 85 179.070312 C 85.816406 179.070312 86.597656 178.75 87.171875 178.171875 C 87.75 177.597656 88.070312 176.816406 88.070312 176 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 121.070312 160 C 121.070312 159.183594 120.75 158.402344 120.171875 157.828125 C 119.597656 157.25 118.816406 156.929688 118 156.929688 C 117.183594 156.929688 116.402344 157.25 115.828125 157.828125 C 115.25 158.402344 114.929688 159.183594 114.929688 160 C 114.929688 160.816406 115.25 161.597656 115.828125 162.171875 C 116.402344 162.75 117.183594 163.070312 118 163.070312 C 118.816406 163.070312 119.597656 162.75 120.171875 162.171875 C 120.75 161.597656 121.070312 160.816406 121.070312 160 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 154.070312 142 C 154.070312 141.183594 153.75 140.402344 153.171875 139.828125 C 152.597656 139.25 151.816406 138.929688 151 138.929688 C 150.183594 138.929688 149.402344 139.25 148.828125 139.828125 C 148.25 140.402344 147.929688 141.183594 147.929688 142 C 147.929688 142.816406 148.25 143.597656 148.828125 144.171875 C 149.402344 144.75 150.183594 145.070312 151 145.070312 C 151.816406 145.070312 152.597656 144.75 153.171875 144.171875 C 153.75 143.597656 154.070312 142.816406 154.070312 142 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 187.070312 124 C 187.070312 123.183594 186.75 122.402344 186.171875 121.828125 C 185.597656 121.25 184.816406 120.929688 184 120.929688 C 183.183594 120.929688 182.402344 121.25 181.828125 121.828125 C 181.25 122.402344 180.929688 123.183594 180.929688 124 C 180.929688 124.816406 181.25 125.597656 181.828125 126.171875 C 182.402344 126.75 183.183594 127.070312 184 127.070312 C 184.816406 127.070312 185.597656 126.75 186.171875 126.171875 C 186.75 125.597656 187.070312 124.816406 187.070312 124 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 220.070312 105 C 220.070312 104.183594 219.75 103.402344 219.171875 102.828125 C 218.597656 102.25 217.816406 101.929688 217 101.929688 C 216.183594 101.929688 215.402344 102.25 214.828125 102.828125 C 214.25 103.402344 213.929688 104.183594 213.929688 105 C 213.929688 105.816406 214.25 106.597656 214.828125 107.171875 C 215.402344 107.75 216.183594 108.070312 217 108.070312 C 217.816406 108.070312 218.597656 107.75 219.171875 107.171875 C 219.75 106.597656 220.070312 105.816406 220.070312 105 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 253.070312 86 C 253.070312 85.183594 252.75 84.402344 252.171875 83.828125 C 251.597656 83.25 250.816406 82.929688 250 82.929688 C 249.183594 82.929688 248.402344 83.25 247.828125 83.828125 C 247.25 84.402344 246.929688 85.183594 246.929688 86 C 246.929688 86.816406 247.25 87.597656 247.828125 88.171875 C 248.402344 88.75 249.183594 89.070312 250 89.070312 C 250.816406 89.070312 251.597656 88.75 252.171875 88.171875 C 252.75 87.597656 253.070312 86.816406 253.070312 86 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 286.070312 67 C 286.070312 66.183594 285.75 65.402344 285.171875 64.828125 C 284.597656 64.25 283.816406 63.929688 283 63.929688 C 282.183594 63.929688 281.402344 64.25 280.828125 64.828125 C 280.25 65.402344 279.929688 66.183594 279.929688 67 C 279.929688 67.816406 280.25 68.597656 280.828125 69.171875 C 281.402344 69.75 282.183594 70.070312 283 70.070312 C 283.816406 70.070312 284.597656 69.75 285.171875 69.171875 C 285.75 68.597656 286.070312 67.816406 286.070312 67 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 319.070312 48 C 319.070312 47.183594 318.75 46.402344 318.171875 45.828125 C 317.597656 45.25 316.816406 44.929688 316 44.929688 C 315.183594 44.929688 314.402344 45.25 313.828125 45.828125 C 313.25 46.402344 312.929688 47.183594 312.929688 48 C 312.929688 48.816406 313.25 49.597656 313.828125 50.171875 C 314.402344 50.75 315.183594 51.070312 316 51.070312 C 316.816406 51.070312 317.597656 50.75 318.171875 50.171875 C 318.75 49.597656 319.070312 48.816406 319.070312 48 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 352.070312 29 C 352.070312 28.183594 351.75 27.402344 351.171875 26.828125 C 350.597656 26.25 349.816406 25.929688 349 25.929688 C 348.183594 25.929688 347.402344 26.25 346.828125 26.828125 C 346.25 27.402344 345.929688 28.183594 345.929688 29 C 345.929688 29.816406 346.25 30.597656 346.828125 31.171875 C 347.402344 31.75 348.183594 32.070312 349 32.070312 C 349.816406 32.070312 350.597656 31.75 351.171875 31.171875 C 351.75 30.597656 352.070312 29.816406 352.070312 29 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 55.070312 191 C 55.070312 190.183594 54.75 189.402344 54.171875 188.828125 C 53.597656 188.25 52.816406 187.929688 52 187.929688 C 51.183594 187.929688 50.402344 188.25 49.828125 188.828125 C 49.25 189.402344 48.929688 190.183594 48.929688 191 C 48.929688 191.816406 49.25 192.597656 49.828125 193.171875 C 50.402344 193.75 51.183594 194.070312 52 194.070312 C 52.816406 194.070312 53.597656 193.75 54.171875 193.171875 C 54.75 192.597656 55.070312 191.816406 55.070312 191 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 88.070312 181 C 88.070312 180.183594 87.75 179.402344 87.171875 178.828125 C 86.597656 178.25 85.816406 177.929688 85 177.929688 C 84.183594 177.929688 83.402344 178.25 82.828125 178.828125 C 82.25 179.402344 81.929688 180.183594 81.929688 181 C 81.929688 181.816406 82.25 182.597656 82.828125 183.171875 C 83.402344 183.75 84.183594 184.070312 85 184.070312 C 85.816406 184.070312 86.597656 183.75 87.171875 183.171875 C 87.75 182.597656 88.070312 181.816406 88.070312 181 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 121.070312 170 C 121.070312 169.183594 120.75 168.402344 120.171875 167.828125 C 119.597656 167.25 118.816406 166.929688 118 166.929688 C 117.183594 166.929688 116.402344 167.25 115.828125 167.828125 C 115.25 168.402344 114.929688 169.183594 114.929688 170 C 114.929688 170.816406 115.25 171.597656 115.828125 172.171875 C 116.402344 172.75 117.183594 173.070312 118 173.070312 C 118.816406 173.070312 119.597656 172.75 120.171875 172.171875 C 120.75 171.597656 121.070312 170.816406 121.070312 170 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 154.070312 157 C 154.070312 156.183594 153.75 155.402344 153.171875 154.828125 C 152.597656 154.25 151.816406 153.929688 151 153.929688 C 150.183594 153.929688 149.402344 154.25 148.828125 154.828125 C 148.25 155.402344 147.929688 156.183594 147.929688 157 C 147.929688 157.816406 148.25 158.597656 148.828125 159.171875 C 149.402344 159.75 150.183594 160.070312 151 160.070312 C 151.816406 160.070312 152.597656 159.75 153.171875 159.171875 C 153.75 158.597656 154.070312 157.816406 154.070312 157 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 187.070312 142 C 187.070312 141.183594 186.75 140.402344 186.171875 139.828125 C 185.597656 139.25 184.816406 138.929688 184 138.929688 C 183.183594 138.929688 182.402344 139.25 181.828125 139.828125 C 181.25 140.402344 180.929688 141.183594 180.929688 142 C 180.929688 142.816406 181.25 143.597656 181.828125 144.171875 C 182.402344 144.75 183.183594 145.070312 184 145.070312 C 184.816406 145.070312 185.597656 144.75 186.171875 144.171875 C 186.75 143.597656 187.070312 142.816406 187.070312 142 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 220.070312 125 C 220.070312 124.183594 219.75 123.402344 219.171875 122.828125 C 218.597656 122.25 217.816406 121.929688 217 121.929688 C 216.183594 121.929688 215.402344 122.25 214.828125 122.828125 C 214.25 123.402344 213.929688 124.183594 213.929688 125 C 213.929688 125.816406 214.25 126.597656 214.828125 127.171875 C 215.402344 127.75 216.183594 128.070312 217 128.070312 C 217.816406 128.070312 218.597656 127.75 219.171875 127.171875 C 219.75 126.597656 220.070312 125.816406 220.070312 125 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 253.070312 107 C 253.070312 106.183594 252.75 105.402344 252.171875 104.828125 C 251.597656 104.25 250.816406 103.929688 250 103.929688 C 249.183594 103.929688 248.402344 104.25 247.828125 104.828125 C 247.25 105.402344 246.929688 106.183594 246.929688 107 C 246.929688 107.816406 247.25 108.597656 247.828125 109.171875 C 248.402344 109.75 249.183594 110.070312 250 110.070312 C 250.816406 110.070312 251.597656 109.75 252.171875 109.171875 C 252.75 108.597656 253.070312 107.816406 253.070312 107 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 286.070312 88 C 286.070312 87.183594 285.75 86.402344 285.171875 85.828125 C 284.597656 85.25 283.816406 84.929688 283 84.929688 C 282.183594 84.929688 281.402344 85.25 280.828125 85.828125 C 280.25 86.402344 279.929688 87.183594 279.929688 88 C 279.929688 88.816406 280.25 89.597656 280.828125 90.171875 C 281.402344 90.75 282.183594 91.070312 283 91.070312 C 283.816406 91.070312 284.597656 90.75 285.171875 90.171875 C 285.75 89.597656 286.070312 88.816406 286.070312 88 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 319.070312 69 C 319.070312 68.183594 318.75 67.402344 318.171875 66.828125 C 317.597656 66.25 316.816406 65.929688 316 65.929688 C 315.183594 65.929688 314.402344 66.25 313.828125 66.828125 C 313.25 67.402344 312.929688 68.183594 312.929688 69 C 312.929688 69.816406 313.25 70.597656 313.828125 71.171875 C 314.402344 71.75 315.183594 72.070312 316 72.070312 C 316.816406 72.070312 317.597656 71.75 318.171875 71.171875 C 318.75 70.597656 319.070312 69.816406 319.070312 69 Z "/> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 352.070312 50 C 352.070312 49.183594 351.75 48.402344 351.171875 47.828125 C 350.597656 47.25 349.816406 46.929688 349 46.929688 C 348.183594 46.929688 347.402344 47.25 346.828125 47.828125 C 346.25 48.402344 345.929688 49.183594 345.929688 50 C 345.929688 50.816406 346.25 51.597656 346.828125 52.171875 C 347.402344 52.75 348.183594 53.070312 349 53.070312 C 349.816406 53.070312 350.597656 52.75 351.171875 52.171875 C 351.75 51.597656 352.070312 50.816406 352.070312 50 Z "/> +<path style="fill:none;stroke-width:0.5;stroke-linecap:square;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 214.296875 L 39 214.296875 "/> +<path style="fill:none;stroke-width:0.5;stroke-linecap:square;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 214.296875 L 39 19 "/> +<path style="fill:none;stroke-width:0.5;stroke-linecap:square;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 19 L 355 19 "/> +<path style="fill:none;stroke-width:0.5;stroke-linecap:square;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 19 L 355 214.296875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 95.160156 214.296875 L 95.160156 211.140625 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-1" x="89.659467" y="226.29874"/> + <use xlink:href="#glyph0-2" x="95.220991" y="226.29874"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 204.84375 214.296875 L 204.84375 211.140625 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-1" x="196.345465" y="226.29874"/> + <use xlink:href="#glyph0-2" x="201.906989" y="226.29874"/> + <use xlink:href="#glyph0-2" x="207.468512" y="226.29874"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 314.53125 214.296875 L 314.53125 211.140625 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-1" x="303.531463" y="226.29874"/> + <use xlink:href="#glyph0-2" x="309.092987" y="226.29874"/> + <use xlink:href="#glyph0-2" x="314.65451" y="226.29874"/> + <use xlink:href="#glyph0-2" x="320.216034" y="226.29874"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 51.511719 214.296875 L 51.511719 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 62.140625 214.296875 L 62.140625 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 70.824219 214.296875 L 70.824219 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 78.167969 214.296875 L 78.167969 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 84.53125 214.296875 L 84.53125 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 90.140625 214.296875 L 90.140625 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 128.179688 214.296875 L 128.179688 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 147.492188 214.296875 L 147.492188 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 161.195312 214.296875 L 161.195312 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 171.828125 214.296875 L 171.828125 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 180.511719 214.296875 L 180.511719 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 187.855469 214.296875 L 187.855469 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 194.214844 214.296875 L 194.214844 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 199.828125 214.296875 L 199.828125 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 237.863281 214.296875 L 237.863281 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 257.179688 214.296875 L 257.179688 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 270.882812 214.296875 L 270.882812 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 281.511719 214.296875 L 281.511719 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 290.199219 214.296875 L 290.199219 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 297.539062 214.296875 L 297.539062 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 303.902344 214.296875 L 303.902344 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 309.511719 214.296875 L 309.511719 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 347.550781 214.296875 L 347.550781 212.71875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 171.960938 L 42.160156 171.960938 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-1" x="19" y="176.961688"/> + <use xlink:href="#glyph0-2" x="24.561523" y="176.961688"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph1-1" x="30" y="172.81325"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 108.234375 L 42.160156 108.234375 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-1" x="19" y="113.23603"/> + <use xlink:href="#glyph0-2" x="24.561523" y="113.23603"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph1-2" x="30" y="109.087593"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 44.511719 L 42.160156 44.511719 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-1" x="19" y="49.510373"/> + <use xlink:href="#glyph0-2" x="24.561523" y="49.510373"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph1-3" x="30" y="45.361936"/> +</g> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 205.28125 L 40.578125 205.28125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 197.320312 L 40.578125 197.320312 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 191.144531 L 40.578125 191.144531 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 186.097656 L 40.578125 186.097656 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 181.832031 L 40.578125 181.832031 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 178.136719 L 40.578125 178.136719 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 174.878906 L 40.578125 174.878906 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 152.777344 L 40.578125 152.777344 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 141.558594 L 40.578125 141.558594 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 133.59375 L 40.578125 133.59375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 127.417969 L 40.578125 127.417969 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 122.375 L 40.578125 122.375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 118.105469 L 40.578125 118.105469 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 114.410156 L 40.578125 114.410156 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 111.152344 L 40.578125 111.152344 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 89.050781 L 40.578125 89.050781 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 77.832031 L 40.578125 77.832031 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 69.871094 L 40.578125 69.871094 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 63.695312 L 40.578125 63.695312 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 58.648438 L 40.578125 58.648438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 54.382812 L 40.578125 54.382812 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 50.6875 L 40.578125 50.6875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 47.425781 L 40.578125 47.425781 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 39 25.328125 L 40.578125 25.328125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 95.160156 19 L 95.160156 22.160156 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 204.84375 19 L 204.84375 22.160156 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 314.53125 19 L 314.53125 22.160156 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 51.511719 19 L 51.511719 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 62.140625 19 L 62.140625 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 70.824219 19 L 70.824219 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 78.167969 19 L 78.167969 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 84.53125 19 L 84.53125 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 90.140625 19 L 90.140625 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 128.179688 19 L 128.179688 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 147.492188 19 L 147.492188 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 161.195312 19 L 161.195312 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 171.828125 19 L 171.828125 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 180.511719 19 L 180.511719 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 187.855469 19 L 187.855469 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 194.214844 19 L 194.214844 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 199.828125 19 L 199.828125 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 237.863281 19 L 237.863281 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 257.179688 19 L 257.179688 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 270.882812 19 L 270.882812 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 281.511719 19 L 281.511719 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 290.199219 19 L 290.199219 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 297.539062 19 L 297.539062 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 303.902344 19 L 303.902344 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 309.511719 19 L 309.511719 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 347.550781 19 L 347.550781 20.578125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 171.960938 L 351.839844 171.960938 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 108.234375 L 351.839844 108.234375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 44.511719 L 351.839844 44.511719 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 205.28125 L 353.421875 205.28125 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 197.320312 L 353.421875 197.320312 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 191.144531 L 353.421875 191.144531 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 186.097656 L 353.421875 186.097656 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 181.832031 L 353.421875 181.832031 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 178.136719 L 353.421875 178.136719 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 174.878906 L 353.421875 174.878906 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 152.777344 L 353.421875 152.777344 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 141.558594 L 353.421875 141.558594 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 133.59375 L 353.421875 133.59375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 127.417969 L 353.421875 127.417969 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 122.375 L 353.421875 122.375 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 118.105469 L 353.421875 118.105469 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 114.410156 L 353.421875 114.410156 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 111.152344 L 353.421875 111.152344 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 89.050781 L 353.421875 89.050781 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 77.832031 L 353.421875 77.832031 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 69.871094 L 353.421875 69.871094 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 63.695312 L 353.421875 63.695312 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 58.648438 L 353.421875 58.648438 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 54.382812 L 353.421875 54.382812 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 50.6875 L 353.421875 50.6875 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 47.425781 L 353.421875 47.425781 "/> +<path style="fill:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(39.99939%,39.99939%,39.99939%);stroke-opacity:1;stroke-miterlimit:3.25;" d="M 355 25.328125 L 353.421875 25.328125 "/> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph0-3" x="175.5" y="245.29874"/> + <use xlink:href="#glyph0-4" x="181.608398" y="245.29874"/> + <use xlink:href="#glyph0-5" x="187.169922" y="245.29874"/> + <use xlink:href="#glyph0-6" x="192.731445" y="245.29874"/> + <use xlink:href="#glyph0-7" x="197.731445" y="245.29874"/> + <use xlink:href="#glyph0-8" x="200.509766" y="245.29874"/> + <use xlink:href="#glyph0-9" x="202.731445" y="245.29874"/> + <use xlink:href="#glyph0-5" x="208.292969" y="245.29874"/> + <use xlink:href="#glyph0-10" x="213.854492" y="245.29874"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph2-1" x="9" y="129.14937"/> + <use xlink:href="#glyph2-2" x="9" y="122.479448"/> + <use xlink:href="#glyph2-3" x="9" y="117.479448"/> + <use xlink:href="#glyph2-4" x="9" y="114.701128"/> + <use xlink:href="#glyph2-5" x="9" y="109.139605"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph3-1" x="148" y="12"/> + <use xlink:href="#glyph3-2" x="155.330078" y="12"/> + <use xlink:href="#glyph3-3" x="157.996094" y="12"/> + <use xlink:href="#glyph3-4" x="160.662109" y="12"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph3-5" x="170" y="12"/> + <use xlink:href="#glyph3-2" x="176" y="12"/> + <use xlink:href="#glyph3-6" x="178.666016" y="12"/> + <use xlink:href="#glyph3-4" x="184.666016" y="12"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph3-7" x="194" y="12"/> + <use xlink:href="#glyph3-8" x="200.673828" y="12"/> +</g> +<g style="fill:rgb(39.99939%,39.99939%,39.99939%);fill-opacity:1;"> + <use xlink:href="#glyph3-9" x="207" y="12"/> + <use xlink:href="#glyph3-7" x="216.996094" y="12"/> + <use xlink:href="#glyph3-10" x="223.669922" y="12"/> + <use xlink:href="#glyph3-11" x="230.34375" y="12"/> + <use xlink:href="#glyph3-3" x="237.017578" y="12"/> + <use xlink:href="#glyph3-4" x="239.683594" y="12"/> +</g> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(36.84082%,50.67749%,70.979309%);fill-opacity:1;" d="M 382.148438 113 C 382.148438 112.164062 381.816406 111.363281 381.226562 110.773438 C 380.636719 110.183594 379.835938 109.851562 379 109.851562 C 378.164062 109.851562 377.363281 110.183594 376.773438 110.773438 C 376.183594 111.363281 375.851562 112.164062 375.851562 113 C 375.851562 113.835938 376.183594 114.636719 376.773438 115.226562 C 377.363281 115.816406 378.164062 116.148438 379 116.148438 C 379.835938 116.148438 380.636719 115.816406 381.226562 115.226562 C 381.816406 114.636719 382.148438 113.835938 382.148438 113 Z "/> +<g style="fill:rgb(0%,0%,0%);fill-opacity:1;"> + <use xlink:href="#glyph4-1" x="391" y="117.28418"/> + <use xlink:href="#glyph4-2" x="399.670898" y="117.28418"/> + <use xlink:href="#glyph4-2" x="406.901367" y="117.28418"/> + <use xlink:href="#glyph4-3" x="414.131836" y="117.28418"/> + <use xlink:href="#glyph4-4" x="420.631836" y="117.28418"/> +</g> +<g style="fill:rgb(0%,0%,0%);fill-opacity:1;"> + <use xlink:href="#glyph4-5" x="424" y="117.28418"/> +</g> +<g style="fill:rgb(0%,0%,0%);fill-opacity:1;"> + <use xlink:href="#glyph4-6" x="428" y="117.28418"/> + <use xlink:href="#glyph4-7" x="436.670898" y="117.28418"/> + <use xlink:href="#glyph4-4" x="443.170898" y="117.28418"/> + <use xlink:href="#glyph4-8" x="446.783203" y="117.28418"/> + <use xlink:href="#glyph4-2" x="454.013672" y="117.28418"/> + <use xlink:href="#glyph4-9" x="461.244141" y="117.28418"/> +</g> +<path style=" stroke:none;fill-rule:evenodd;fill:rgb(88.070679%,61.103821%,14.204407%);fill-opacity:1;" d="M 382.148438 136 C 382.148438 135.164062 381.816406 134.363281 381.226562 133.773438 C 380.636719 133.183594 379.835938 132.851562 379 132.851562 C 378.164062 132.851562 377.363281 133.183594 376.773438 133.773438 C 376.183594 134.363281 375.851562 135.164062 375.851562 136 C 375.851562 136.835938 376.183594 137.636719 376.773438 138.226562 C 377.363281 138.816406 378.164062 139.148438 379 139.148438 C 379.835938 139.148438 380.636719 138.816406 381.226562 138.226562 C 381.816406 137.636719 382.148438 136.835938 382.148438 136 Z "/> +<g style="fill:rgb(0%,0%,0%);fill-opacity:1;"> + <use xlink:href="#glyph4-10" x="391" y="140.28418"/> + <use xlink:href="#glyph4-7" x="398.230469" y="140.28418"/> + <use xlink:href="#glyph4-11" x="404.730469" y="140.28418"/> + <use xlink:href="#glyph4-12" x="411.960938" y="140.28418"/> + <use xlink:href="#glyph4-9" x="414.849609" y="140.28418"/> + <use xlink:href="#glyph4-13" x="422.080078" y="140.28418"/> + <use xlink:href="#glyph4-14" x="429.310547" y="140.28418"/> + <use xlink:href="#glyph4-14" x="436.541016" y="140.28418"/> +</g> +</g> +</svg> diff --git a/pybind11/docs/reference.rst b/pybind11/docs/reference.rst new file mode 100644 index 0000000000000000000000000000000000000000..a9fbe60015ca466e71a37f6f9cd9866bfa7adfe5 --- /dev/null +++ b/pybind11/docs/reference.rst @@ -0,0 +1,117 @@ +.. _reference: + +.. warning:: + + Please be advised that the reference documentation discussing pybind11 + internals is currently incomplete. Please refer to the previous sections + and the pybind11 header files for the nitty gritty details. + +Reference +######### + +.. _macros: + +Macros +====== + +.. doxygendefine:: PYBIND11_MODULE + +.. _core_types: + +Convenience classes for arbitrary Python types +============================================== + +Common member functions +----------------------- + +.. doxygenclass:: object_api + :members: + +Without reference counting +-------------------------- + +.. doxygenclass:: handle + :members: + +With reference counting +----------------------- + +.. doxygenclass:: object + :members: + +.. doxygenfunction:: reinterpret_borrow + +.. doxygenfunction:: reinterpret_steal + +Convenience classes for specific Python types +============================================= + +.. doxygenclass:: module + :members: + +.. doxygengroup:: pytypes + :members: + +.. _extras: + +Passing extra arguments to ``def`` or ``class_`` +================================================ + +.. doxygengroup:: annotations + :members: + +Embedding the interpreter +========================= + +.. doxygendefine:: PYBIND11_EMBEDDED_MODULE + +.. doxygenfunction:: initialize_interpreter + +.. doxygenfunction:: finalize_interpreter + +.. doxygenclass:: scoped_interpreter + +Redirecting C++ streams +======================= + +.. doxygenclass:: scoped_ostream_redirect + +.. doxygenclass:: scoped_estream_redirect + +.. doxygenfunction:: add_ostream_redirect + +Python built-in functions +========================= + +.. doxygengroup:: python_builtins + :members: + +Inheritance +=========== + +See :doc:`/classes` and :doc:`/advanced/classes` for more detail. + +.. doxygendefine:: PYBIND11_OVERLOAD + +.. doxygendefine:: PYBIND11_OVERLOAD_PURE + +.. doxygendefine:: PYBIND11_OVERLOAD_NAME + +.. doxygendefine:: PYBIND11_OVERLOAD_PURE_NAME + +.. doxygenfunction:: get_overload + +Exceptions +========== + +.. doxygenclass:: error_already_set + :members: + +.. doxygenclass:: builtin_exception + :members: + + +Literals +======== + +.. doxygennamespace:: literals diff --git a/pybind11/docs/release.rst b/pybind11/docs/release.rst new file mode 100644 index 0000000000000000000000000000000000000000..b31bbe97ebbcb72b327ff14b2fce818494e6331e --- /dev/null +++ b/pybind11/docs/release.rst @@ -0,0 +1,25 @@ +To release a new version of pybind11: + +- Update the version number and push to pypi + - Update ``pybind11/_version.py`` (set release version, remove 'dev'). + - Update ``PYBIND11_VERSION_MAJOR`` etc. in ``include/pybind11/detail/common.h``. + - Ensure that all the information in ``setup.py`` is up-to-date. + - Update version in ``docs/conf.py``. + - Tag release date in ``docs/changelog.rst``. + - ``git add`` and ``git commit``. + - if new minor version: ``git checkout -b vX.Y``, ``git push -u origin vX.Y`` + - ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``. + - ``git push`` + - ``git push --tags``. + - ``python setup.py sdist upload``. + - ``python setup.py bdist_wheel upload``. +- Update conda-forge (https://github.com/conda-forge/pybind11-feedstock) via PR + - download release package from Github: ``wget https://github.com/pybind/pybind11/archive/vX.Y.Z.tar.gz`` + - compute checksum: ``shasum -a 256 vX.Y.Z.tar.gz`` + - change version number and checksum in ``recipe/meta.yml`` +- Get back to work + - Update ``_version.py`` (add 'dev' and increment minor). + - Update version in ``docs/conf.py`` + - Update version macros in ``include/pybind11/common.h`` + - ``git add`` and ``git commit``. + ``git push`` diff --git a/pybind11/docs/requirements.txt b/pybind11/docs/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..3818fe80eecc9e91b3a164885d94dffda28d8d35 --- /dev/null +++ b/pybind11/docs/requirements.txt @@ -0,0 +1 @@ +breathe == 4.5.0 diff --git a/pybind11/docs/upgrade.rst b/pybind11/docs/upgrade.rst new file mode 100644 index 0000000000000000000000000000000000000000..3f5697391b7e1062115494087c1fcddab8f79c5a --- /dev/null +++ b/pybind11/docs/upgrade.rst @@ -0,0 +1,404 @@ +Upgrade guide +############# + +This is a companion guide to the :doc:`changelog`. While the changelog briefly +lists all of the new features, improvements and bug fixes, this upgrade guide +focuses only the subset which directly impacts your experience when upgrading +to a new version. But it goes into more detail. This includes things like +deprecated APIs and their replacements, build system changes, general code +modernization and other useful information. + + +v2.2 +==== + +Deprecation of the ``PYBIND11_PLUGIN`` macro +-------------------------------------------- + +``PYBIND11_MODULE`` is now the preferred way to create module entry points. +The old macro emits a compile-time deprecation warning. + +.. code-block:: cpp + + // old + PYBIND11_PLUGIN(example) { + py::module m("example", "documentation string"); + + m.def("add", [](int a, int b) { return a + b; }); + + return m.ptr(); + } + + // new + PYBIND11_MODULE(example, m) { + m.doc() = "documentation string"; // optional + + m.def("add", [](int a, int b) { return a + b; }); + } + + +New API for defining custom constructors and pickling functions +--------------------------------------------------------------- + +The old placement-new custom constructors have been deprecated. The new approach +uses ``py::init()`` and factory functions to greatly improve type safety. + +Placement-new can be called accidentally with an incompatible type (without any +compiler errors or warnings), or it can initialize the same object multiple times +if not careful with the Python-side ``__init__`` calls. The new-style custom +constructors prevent such mistakes. See :ref:`custom_constructors` for details. + +.. code-block:: cpp + + // old -- deprecated (runtime warning shown only in debug mode) + py::class<Foo>(m, "Foo") + .def("__init__", [](Foo &self, ...) { + new (&self) Foo(...); // uses placement-new + }); + + // new + py::class<Foo>(m, "Foo") + .def(py::init([](...) { // Note: no `self` argument + return new Foo(...); // return by raw pointer + // or: return std::make_unique<Foo>(...); // return by holder + // or: return Foo(...); // return by value (move constructor) + })); + +Mirroring the custom constructor changes, ``py::pickle()`` is now the preferred +way to get and set object state. See :ref:`pickling` for details. + +.. code-block:: cpp + + // old -- deprecated (runtime warning shown only in debug mode) + py::class<Foo>(m, "Foo") + ... + .def("__getstate__", [](const Foo &self) { + return py::make_tuple(self.value1(), self.value2(), ...); + }) + .def("__setstate__", [](Foo &self, py::tuple t) { + new (&self) Foo(t[0].cast<std::string>(), ...); + }); + + // new + py::class<Foo>(m, "Foo") + ... + .def(py::pickle( + [](const Foo &self) { // __getstate__ + return py::make_tuple(f.value1(), f.value2(), ...); // unchanged + }, + [](py::tuple t) { // __setstate__, note: no `self` argument + return new Foo(t[0].cast<std::string>(), ...); + // or: return std::make_unique<Foo>(...); // return by holder + // or: return Foo(...); // return by value (move constructor) + } + )); + +For both the constructors and pickling, warnings are shown at module +initialization time (on import, not when the functions are called). +They're only visible when compiled in debug mode. Sample warning: + +.. code-block:: none + + pybind11-bound class 'mymodule.Foo' is using an old-style placement-new '__init__' + which has been deprecated. See the upgrade guide in pybind11's docs. + + +Stricter enforcement of hidden symbol visibility for pybind11 modules +--------------------------------------------------------------------- + +pybind11 now tries to actively enforce hidden symbol visibility for modules. +If you're using either one of pybind11's :doc:`CMake or Python build systems +<compiling>` (the two example repositories) and you haven't been exporting any +symbols, there's nothing to be concerned about. All the changes have been done +transparently in the background. If you were building manually or relied on +specific default visibility, read on. + +Setting default symbol visibility to *hidden* has always been recommended for +pybind11 (see :ref:`faq:symhidden`). On Linux and macOS, hidden symbol +visibility (in conjunction with the ``strip`` utility) yields much smaller +module binaries. `CPython's extension docs`_ also recommend hiding symbols +by default, with the goal of avoiding symbol name clashes between modules. +Starting with v2.2, pybind11 enforces this more strictly: (1) by declaring +all symbols inside the ``pybind11`` namespace as hidden and (2) by including +the ``-fvisibility=hidden`` flag on Linux and macOS (only for extension +modules, not for embedding the interpreter). + +.. _CPython's extension docs: https://docs.python.org/3/extending/extending.html#providing-a-c-api-for-an-extension-module + +The namespace-scope hidden visibility is done automatically in pybind11's +headers and it's generally transparent to users. It ensures that: + +* Modules compiled with different pybind11 versions don't clash with each other. + +* Some new features, like ``py::module_local`` bindings, can work as intended. + +The ``-fvisibility=hidden`` flag applies the same visibility to user bindings +outside of the ``pybind11`` namespace. It's now set automatic by pybind11's +CMake and Python build systems, but this needs to be done manually by users +of other build systems. Adding this flag: + +* Minimizes the chances of symbol conflicts between modules. E.g. if two + unrelated modules were statically linked to different (ABI-incompatible) + versions of the same third-party library, a symbol clash would be likely + (and would end with unpredictable results). + +* Produces smaller binaries on Linux and macOS, as pointed out previously. + +Within pybind11's CMake build system, ``pybind11_add_module`` has always been +setting the ``-fvisibility=hidden`` flag in release mode. From now on, it's +being applied unconditionally, even in debug mode and it can no longer be opted +out of with the ``NO_EXTRAS`` option. The ``pybind11::module`` target now also +adds this flag to it's interface. The ``pybind11::embed`` target is unchanged. + +The most significant change here is for the ``pybind11::module`` target. If you +were previously relying on default visibility, i.e. if your Python module was +doubling as a shared library with dependents, you'll need to either export +symbols manually (recommended for cross-platform libraries) or factor out the +shared library (and have the Python module link to it like the other +dependents). As a temporary workaround, you can also restore default visibility +using the CMake code below, but this is not recommended in the long run: + +.. code-block:: cmake + + target_link_libraries(mymodule PRIVATE pybind11::module) + + add_library(restore_default_visibility INTERFACE) + target_compile_options(restore_default_visibility INTERFACE -fvisibility=default) + target_link_libraries(mymodule PRIVATE restore_default_visibility) + + +Local STL container bindings +---------------------------- + +Previous pybind11 versions could only bind types globally -- all pybind11 +modules, even unrelated ones, would have access to the same exported types. +However, this would also result in a conflict if two modules exported the +same C++ type, which is especially problematic for very common types, e.g. +``std::vector<int>``. :ref:`module_local` were added to resolve this (see +that section for a complete usage guide). + +``py::class_`` still defaults to global bindings (because these types are +usually unique across modules), however in order to avoid clashes of opaque +types, ``py::bind_vector`` and ``py::bind_map`` will now bind STL containers +as ``py::module_local`` if their elements are: builtins (``int``, ``float``, +etc.), not bound using ``py::class_``, or bound as ``py::module_local``. For +example, this change allows multiple modules to bind ``std::vector<int>`` +without causing conflicts. See :ref:`stl_bind` for more details. + +When upgrading to this version, if you have multiple modules which depend on +a single global binding of an STL container, note that all modules can still +accept foreign ``py::module_local`` types in the direction of Python-to-C++. +The locality only affects the C++-to-Python direction. If this is needed in +multiple modules, you'll need to either: + +* Add a copy of the same STL binding to all of the modules which need it. + +* Restore the global status of that single binding by marking it + ``py::module_local(false)``. + +The latter is an easy workaround, but in the long run it would be best to +localize all common type bindings in order to avoid conflicts with +third-party modules. + + +Negative strides for Python buffer objects and numpy arrays +----------------------------------------------------------- + +Support for negative strides required changing the integer type from unsigned +to signed in the interfaces of ``py::buffer_info`` and ``py::array``. If you +have compiler warnings enabled, you may notice some new conversion warnings +after upgrading. These can be resolved using ``static_cast``. + + +Deprecation of some ``py::object`` APIs +--------------------------------------- + +To compare ``py::object`` instances by pointer, you should now use +``obj1.is(obj2)`` which is equivalent to ``obj1 is obj2`` in Python. +Previously, pybind11 used ``operator==`` for this (``obj1 == obj2``), but +that could be confusing and is now deprecated (so that it can eventually +be replaced with proper rich object comparison in a future release). + +For classes which inherit from ``py::object``, ``borrowed`` and ``stolen`` +were previously available as protected constructor tags. Now the types +should be used directly instead: ``borrowed_t{}`` and ``stolen_t{}`` +(`#771 <https://github.com/pybind/pybind11/pull/771>`_). + + +Stricter compile-time error checking +------------------------------------ + +Some error checks have been moved from run time to compile time. Notably, +automatic conversion of ``std::shared_ptr<T>`` is not possible when ``T`` is +not directly registered with ``py::class_<T>`` (e.g. ``std::shared_ptr<int>`` +or ``std::shared_ptr<std::vector<T>>`` are not automatically convertible). +Attempting to bind a function with such arguments now results in a compile-time +error instead of waiting to fail at run time. + +``py::init<...>()`` constructor definitions are also stricter and now prevent +bindings which could cause unexpected behavior: + +.. code-block:: cpp + + struct Example { + Example(int &); + }; + + py::class_<Example>(m, "Example") + .def(py::init<int &>()); // OK, exact match + // .def(py::init<int>()); // compile-time error, mismatch + +A non-``const`` lvalue reference is not allowed to bind to an rvalue. However, +note that a constructor taking ``const T &`` can still be registered using +``py::init<T>()`` because a ``const`` lvalue reference can bind to an rvalue. + +v2.1 +==== + +Minimum compiler versions are enforced at compile time +------------------------------------------------------ + +The minimums also apply to v2.0 but the check is now explicit and a compile-time +error is raised if the compiler does not meet the requirements: + +* GCC >= 4.8 +* clang >= 3.3 (appleclang >= 5.0) +* MSVC >= 2015u3 +* Intel C++ >= 15.0 + + +The ``py::metaclass`` attribute is not required for static properties +--------------------------------------------------------------------- + +Binding classes with static properties is now possible by default. The +zero-parameter version of ``py::metaclass()`` is deprecated. However, a new +one-parameter ``py::metaclass(python_type)`` version was added for rare +cases when a custom metaclass is needed to override pybind11's default. + +.. code-block:: cpp + + // old -- emits a deprecation warning + py::class_<Foo>(m, "Foo", py::metaclass()) + .def_property_readonly_static("foo", ...); + + // new -- static properties work without the attribute + py::class_<Foo>(m, "Foo") + .def_property_readonly_static("foo", ...); + + // new -- advanced feature, override pybind11's default metaclass + py::class_<Bar>(m, "Bar", py::metaclass(custom_python_type)) + ... + + +v2.0 +==== + +Breaking changes in ``py::class_`` +---------------------------------- + +These changes were necessary to make type definitions in pybind11 +future-proof, to support PyPy via its ``cpyext`` mechanism (`#527 +<https://github.com/pybind/pybind11/pull/527>`_), and to improve efficiency +(`rev. 86d825 <https://github.com/pybind/pybind11/commit/86d825>`_). + +1. Declarations of types that provide access via the buffer protocol must + now include the ``py::buffer_protocol()`` annotation as an argument to + the ``py::class_`` constructor. + + .. code-block:: cpp + + py::class_<Matrix>("Matrix", py::buffer_protocol()) + .def(py::init<...>()) + .def_buffer(...); + +2. Classes which include static properties (e.g. ``def_readwrite_static()``) + must now include the ``py::metaclass()`` attribute. Note: this requirement + has since been removed in v2.1. If you're upgrading from 1.x, it's + recommended to skip directly to v2.1 or newer. + +3. This version of pybind11 uses a redesigned mechanism for instantiating + trampoline classes that are used to override virtual methods from within + Python. This led to the following user-visible syntax change: + + .. code-block:: cpp + + // old v1.x syntax + py::class_<TrampolineClass>("MyClass") + .alias<MyClass>() + ... + + // new v2.x syntax + py::class_<MyClass, TrampolineClass>("MyClass") + ... + + Importantly, both the original and the trampoline class are now specified + as arguments to the ``py::class_`` template, and the ``alias<..>()`` call + is gone. The new scheme has zero overhead in cases when Python doesn't + override any functions of the underlying C++ class. + `rev. 86d825 <https://github.com/pybind/pybind11/commit/86d825>`_. + + The class type must be the first template argument given to ``py::class_`` + while the trampoline can be mixed in arbitrary order with other arguments + (see the following section). + + +Deprecation of the ``py::base<T>()`` attribute +---------------------------------------------- + +``py::base<T>()`` was deprecated in favor of specifying ``T`` as a template +argument to ``py::class_``. This new syntax also supports multiple inheritance. +Note that, while the type being exported must be the first argument in the +``py::class_<Class, ...>`` template, the order of the following types (bases, +holder and/or trampoline) is not important. + +.. code-block:: cpp + + // old v1.x + py::class_<Derived>("Derived", py::base<Base>()); + + // new v2.x + py::class_<Derived, Base>("Derived"); + + // new -- multiple inheritance + py::class_<Derived, Base1, Base2>("Derived"); + + // new -- apart from `Derived` the argument order can be arbitrary + py::class_<Derived, Base1, Holder, Base2, Trampoline>("Derived"); + + +Out-of-the-box support for ``std::shared_ptr`` +---------------------------------------------- + +The relevant type caster is now built in, so it's no longer necessary to +include a declaration of the form: + +.. code-block:: cpp + + PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr<T>) + +Continuing to do so won’t cause an error or even a deprecation warning, +but it's completely redundant. + + +Deprecation of a few ``py::object`` APIs +---------------------------------------- + +All of the old-style calls emit deprecation warnings. + ++---------------------------------------+---------------------------------------------+ +| Old syntax | New syntax | ++=======================================+=============================================+ +| ``obj.call(args...)`` | ``obj(args...)`` | ++---------------------------------------+---------------------------------------------+ +| ``obj.str()`` | ``py::str(obj)`` | ++---------------------------------------+---------------------------------------------+ +| ``auto l = py::list(obj); l.check()`` | ``py::isinstance<py::list>(obj)`` | ++---------------------------------------+---------------------------------------------+ +| ``py::object(ptr, true)`` | ``py::reinterpret_borrow<py::object>(ptr)`` | ++---------------------------------------+---------------------------------------------+ +| ``py::object(ptr, false)`` | ``py::reinterpret_steal<py::object>(ptr)`` | ++---------------------------------------+---------------------------------------------+ +| ``if (obj.attr("foo"))`` | ``if (py::hasattr(obj, "foo"))`` | ++---------------------------------------+---------------------------------------------+ +| ``if (obj["bar"])`` | ``if (obj.contains("bar"))`` | ++---------------------------------------+---------------------------------------------+ diff --git a/pybind11/include/pybind11/attr.h b/pybind11/include/pybind11/attr.h new file mode 100644 index 0000000000000000000000000000000000000000..378b7a804495def3b89e23bae88f11a119848567 --- /dev/null +++ b/pybind11/include/pybind11/attr.h @@ -0,0 +1,678 @@ +/* + pybind11/attr.h: Infrastructure for processing custom + type and function attributes + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "cast.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/// \addtogroup annotations +/// @{ + +/// Annotation for methods +struct is_method +{ + handle class_; + is_method(const handle& c) + : class_(c) + {} +}; + +/// Annotation for operators +struct is_operator +{}; + +/// Annotation for parent scope +struct scope +{ + handle value; + scope(const handle& s) + : value(s) + {} +}; + +/// Annotation for documentation +struct doc +{ + const char* value; + doc(const char* value) + : value(value) + {} +}; + +/// Annotation for function names +struct name +{ + const char* value; + name(const char* value) + : value(value) + {} +}; + +/// Annotation indicating that a function is an overload associated with a given "sibling" +struct sibling +{ + handle value; + sibling(const handle& value) + : value(value.ptr()) + {} +}; + +/// Annotation indicating that a class derives from another given type +template <typename T> +struct base +{ + PYBIND11_DEPRECATED("base<T>() was deprecated in favor of specifying 'T' as a template argument to class_") + base() {} +}; + +/// Keep patient alive while nurse lives +template <size_t Nurse, size_t Patient> +struct keep_alive +{}; + +/// Annotation indicating that a class is involved in a multiple inheritance relationship +struct multiple_inheritance +{}; + +/// Annotation which enables dynamic attributes, i.e. adds `__dict__` to a class +struct dynamic_attr +{}; + +/// Annotation which enables the buffer protocol for a type +struct buffer_protocol +{}; + +/// Annotation which requests that a special metaclass is created for a type +struct metaclass +{ + handle value; + + PYBIND11_DEPRECATED("py::metaclass() is no longer required. It's turned on by default now.") + metaclass() {} + + /// Override pybind11's default metaclass + explicit metaclass(handle value) + : value(value) + {} +}; + +/// Annotation that marks a class as local to the module: +struct module_local +{ + const bool value; + constexpr module_local(bool v = true) + : value(v) + {} +}; + +/// Annotation to mark enums as an arithmetic type +struct arithmetic +{}; + +/** \rst + A call policy which places one or more guard variables (``Ts...``) around the function call. + + For example, this definition: + + .. code-block:: cpp + + m.def("foo", foo, py::call_guard<T>()); + + is equivalent to the following pseudocode: + + .. code-block:: cpp + + m.def("foo", [](args...) { + T scope_guard; + return foo(args...); // forwarded arguments + }); + \endrst */ +template <typename... Ts> +struct call_guard; + +template <> +struct call_guard<> +{ + using type = detail::void_type; +}; + +template <typename T> +struct call_guard<T> +{ + static_assert(std::is_default_constructible<T>::value, "The guard type must be default constructible"); + + using type = T; +}; + +template <typename T, typename... Ts> +struct call_guard<T, Ts...> +{ + struct type + { + T guard{}; // Compose multiple guard types with left-to-right default-constructor order + typename call_guard<Ts...>::type next{}; + }; +}; + +/// @} annotations + +NAMESPACE_BEGIN(detail) +/* Forward declarations */ +enum op_id : int; +enum op_type : int; +struct undefined_t; +template <op_id id, op_type ot, typename L = undefined_t, typename R = undefined_t> +struct op_; +inline void keep_alive_impl(size_t Nurse, size_t Patient, function_call& call, handle ret); + +/// Internal data structure which holds metadata about a keyword argument +struct argument_record +{ + const char* name; ///< Argument name + const char* descr; ///< Human-readable version of the argument value + handle value; ///< Associated Python object + bool convert : 1; ///< True if the argument is allowed to convert when loading + bool none : 1; ///< True if None is allowed when loading + + argument_record(const char* name, const char* descr, handle value, bool convert, bool none) + : name(name) + , descr(descr) + , value(value) + , convert(convert) + , none(none) + {} +}; + +/// Internal data structure which holds metadata about a bound function (signature, overloads, etc.) +struct function_record +{ + function_record() + : is_constructor(false) + , is_new_style_constructor(false) + , is_stateless(false) + , is_operator(false) + , has_args(false) + , has_kwargs(false) + , is_method(false) + {} + + /// Function name + char* name = nullptr; /* why no C++ strings? They generate heavier code.. */ + + // User-specified documentation string + char* doc = nullptr; + + /// Human-readable version of the function signature + char* signature = nullptr; + + /// List of registered keyword arguments + std::vector<argument_record> args; + + /// Pointer to lambda function which converts arguments and performs the actual call + handle (*impl)(function_call&) = nullptr; + + /// Storage for the wrapped function pointer and captured data, if any + void* data[3] = {}; + + /// Pointer to custom destructor for 'data' (if needed) + void (*free_data)(function_record* ptr) = nullptr; + + /// Return value policy associated with this function + return_value_policy policy = return_value_policy::automatic; + + /// True if name == '__init__' + bool is_constructor : 1; + + /// True if this is a new-style `__init__` defined in `detail/init.h` + bool is_new_style_constructor : 1; + + /// True if this is a stateless function pointer + bool is_stateless : 1; + + /// True if this is an operator (__add__), etc. + bool is_operator : 1; + + /// True if the function has a '*args' argument + bool has_args : 1; + + /// True if the function has a '**kwargs' argument + bool has_kwargs : 1; + + /// True if this is a method + bool is_method : 1; + + /// Number of arguments (including py::args and/or py::kwargs, if present) + std::uint16_t nargs; + + /// Python method object + PyMethodDef* def = nullptr; + + /// Python handle to the parent scope (a class or a module) + handle scope; + + /// Python handle to the sibling function representing an overload chain + handle sibling; + + /// Pointer to next overload + function_record* next = nullptr; +}; + +/// Special data structure which (temporarily) holds metadata about a bound class +struct type_record +{ + PYBIND11_NOINLINE type_record() + : multiple_inheritance(false) + , dynamic_attr(false) + , buffer_protocol(false) + , default_holder(true) + , module_local(false) + {} + + /// Handle to the parent scope + handle scope; + + /// Name of the class + const char* name = nullptr; + + // Pointer to RTTI type_info data structure + const std::type_info* type = nullptr; + + /// How large is the underlying C++ type? + size_t type_size = 0; + + /// What is the alignment of the underlying C++ type? + size_t type_align = 0; + + /// How large is the type's holder? + size_t holder_size = 0; + + /// The global operator new can be overridden with a class-specific variant + void* (*operator_new)(size_t) = nullptr; + + /// Function pointer to class_<..>::init_instance + void (*init_instance)(instance*, const void*) = nullptr; + + /// Function pointer to class_<..>::dealloc + void (*dealloc)(detail::value_and_holder&) = nullptr; + + /// List of base classes of the newly created type + list bases; + + /// Optional docstring + const char* doc = nullptr; + + /// Custom metaclass (optional) + handle metaclass; + + /// Multiple inheritance marker + bool multiple_inheritance : 1; + + /// Does the class manage a __dict__? + bool dynamic_attr : 1; + + /// Does the class implement the buffer protocol? + bool buffer_protocol : 1; + + /// Is the default (unique_ptr) holder type used? + bool default_holder : 1; + + /// Is the class definition local to the module shared object? + bool module_local : 1; + + PYBIND11_NOINLINE void add_base(const std::type_info& base, void* (*caster)(void*)) + { + auto base_info = detail::get_type_info(base, false); + if (!base_info) { + std::string tname(base.name()); + detail::clean_type_id(tname); + pybind11_fail("generic_type: type \"" + std::string(name) + "\" referenced unknown base type \"" + tname + "\""); + } + + if (default_holder != base_info->default_holder) { + std::string tname(base.name()); + detail::clean_type_id(tname); + pybind11_fail("generic_type: type \"" + std::string(name) + "\" " + (default_holder ? "does not have" : "has") + + " a non-default holder type while its base \"" + tname + "\" " + + (base_info->default_holder ? "does not" : "does")); + } + + bases.append((PyObject*)base_info->type); + + if (base_info->type->tp_dictoffset != 0) + dynamic_attr = true; + + if (caster) + base_info->implicit_casts.emplace_back(type, caster); + } +}; + +inline function_call::function_call(const function_record& f, handle p) + : func(f) + , parent(p) +{ + args.reserve(f.nargs); + args_convert.reserve(f.nargs); +} + +/// Tag for a new-style `__init__` defined in `detail/init.h` +struct is_new_style_constructor +{}; + +/** + * Partial template specializations to process custom attributes provided to + * cpp_function_ and class_. These are either used to initialize the respective + * fields in the type_record and function_record data structures or executed at + * runtime to deal with custom call policies (e.g. keep_alive). + */ +template <typename T, typename SFINAE = void> +struct process_attribute; + +template <typename T> +struct process_attribute_default +{ + /// Default implementation: do nothing + static void init(const T&, function_record*) {} + static void init(const T&, type_record*) {} + static void precall(function_call&) {} + static void postcall(function_call&, handle) {} +}; + +/// Process an attribute specifying the function's name +template <> +struct process_attribute<name> : process_attribute_default<name> +{ + static void init(const name& n, function_record* r) + { + r->name = const_cast<char*>(n.value); + } +}; + +/// Process an attribute specifying the function's docstring +template <> +struct process_attribute<doc> : process_attribute_default<doc> +{ + static void init(const doc& n, function_record* r) + { + r->doc = const_cast<char*>(n.value); + } +}; + +/// Process an attribute specifying the function's docstring (provided as a C-style string) +template <> +struct process_attribute<const char*> : process_attribute_default<const char*> +{ + static void init(const char* d, function_record* r) + { + r->doc = const_cast<char*>(d); + } + static void init(const char* d, type_record* r) + { + r->doc = const_cast<char*>(d); + } +}; +template <> +struct process_attribute<char*> : process_attribute<const char*> +{}; + +/// Process an attribute indicating the function's return value policy +template <> +struct process_attribute<return_value_policy> : process_attribute_default<return_value_policy> +{ + static void init(const return_value_policy& p, function_record* r) + { + r->policy = p; + } +}; + +/// Process an attribute which indicates that this is an overloaded function associated with a given sibling +template <> +struct process_attribute<sibling> : process_attribute_default<sibling> +{ + static void init(const sibling& s, function_record* r) + { + r->sibling = s.value; + } +}; + +/// Process an attribute which indicates that this function is a method +template <> +struct process_attribute<is_method> : process_attribute_default<is_method> +{ + static void init(const is_method& s, function_record* r) + { + r->is_method = true; + r->scope = s.class_; + } +}; + +/// Process an attribute which indicates the parent scope of a method +template <> +struct process_attribute<scope> : process_attribute_default<scope> +{ + static void init(const scope& s, function_record* r) + { + r->scope = s.value; + } +}; + +/// Process an attribute which indicates that this function is an operator +template <> +struct process_attribute<is_operator> : process_attribute_default<is_operator> +{ + static void init(const is_operator&, function_record* r) + { + r->is_operator = true; + } +}; + +template <> +struct process_attribute<is_new_style_constructor> : process_attribute_default<is_new_style_constructor> +{ + static void init(const is_new_style_constructor&, function_record* r) + { + r->is_new_style_constructor = true; + } +}; + +/// Process a keyword argument attribute (*without* a default value) +template <> +struct process_attribute<arg> : process_attribute_default<arg> +{ + static void init(const arg& a, function_record* r) + { + if (r->is_method && r->args.empty()) + r->args.emplace_back("self", nullptr, handle(), true /*convert*/, false /*none not allowed*/); + r->args.emplace_back(a.name, nullptr, handle(), !a.flag_noconvert, a.flag_none); + } +}; + +/// Process a keyword argument attribute (*with* a default value) +template <> +struct process_attribute<arg_v> : process_attribute_default<arg_v> +{ + static void init(const arg_v& a, function_record* r) + { + if (r->is_method && r->args.empty()) + r->args.emplace_back( + "self", nullptr /*descr*/, handle() /*parent*/, true /*convert*/, false /*none not allowed*/); + + if (!a.value) { +#if !defined(NDEBUG) + std::string descr("'"); + if (a.name) + descr += std::string(a.name) + ": "; + descr += a.type + "'"; + if (r->is_method) { + if (r->name) + descr += " in method '" + (std::string)str(r->scope) + "." + (std::string)r->name + "'"; + else + descr += " in method of '" + (std::string)str(r->scope) + "'"; + } else if (r->name) { + descr += " in function '" + (std::string)r->name + "'"; + } + pybind11_fail("arg(): could not convert default argument " + descr + + " into a Python object (type not registered yet?)"); +#else + pybind11_fail("arg(): could not convert default argument " + "into a Python object (type not registered yet?). " + "Compile in debug mode for more information."); +#endif + } + r->args.emplace_back(a.name, a.descr, a.value.inc_ref(), !a.flag_noconvert, a.flag_none); + } +}; + +/// Process a parent class attribute. Single inheritance only (class_ itself already guarantees that) +template <typename T> +struct process_attribute<T, enable_if_t<is_pyobject<T>::value>> : process_attribute_default<handle> +{ + static void init(const handle& h, type_record* r) + { + r->bases.append(h); + } +}; + +/// Process a parent class attribute (deprecated, does not support multiple inheritance) +template <typename T> +struct process_attribute<base<T>> : process_attribute_default<base<T>> +{ + static void init(const base<T>&, type_record* r) + { + r->add_base(typeid(T), nullptr); + } +}; + +/// Process a multiple inheritance attribute +template <> +struct process_attribute<multiple_inheritance> : process_attribute_default<multiple_inheritance> +{ + static void init(const multiple_inheritance&, type_record* r) + { + r->multiple_inheritance = true; + } +}; + +template <> +struct process_attribute<dynamic_attr> : process_attribute_default<dynamic_attr> +{ + static void init(const dynamic_attr&, type_record* r) + { + r->dynamic_attr = true; + } +}; + +template <> +struct process_attribute<buffer_protocol> : process_attribute_default<buffer_protocol> +{ + static void init(const buffer_protocol&, type_record* r) + { + r->buffer_protocol = true; + } +}; + +template <> +struct process_attribute<metaclass> : process_attribute_default<metaclass> +{ + static void init(const metaclass& m, type_record* r) + { + r->metaclass = m.value; + } +}; + +template <> +struct process_attribute<module_local> : process_attribute_default<module_local> +{ + static void init(const module_local& l, type_record* r) + { + r->module_local = l.value; + } +}; + +/// Process an 'arithmetic' attribute for enums (does nothing here) +template <> +struct process_attribute<arithmetic> : process_attribute_default<arithmetic> +{}; + +template <typename... Ts> +struct process_attribute<call_guard<Ts...>> : process_attribute_default<call_guard<Ts...>> +{}; + +/** + * Process a keep_alive call policy -- invokes keep_alive_impl during the + * pre-call handler if both Nurse, Patient != 0 and use the post-call handler + * otherwise + */ +template <size_t Nurse, size_t Patient> +struct process_attribute<keep_alive<Nurse, Patient>> : public process_attribute_default<keep_alive<Nurse, Patient>> +{ + template <size_t N = Nurse, size_t P = Patient, enable_if_t<N != 0 && P != 0, int> = 0> + static void precall(function_call& call) + { + keep_alive_impl(Nurse, Patient, call, handle()); + } + template <size_t N = Nurse, size_t P = Patient, enable_if_t<N != 0 && P != 0, int> = 0> + static void postcall(function_call&, handle) + {} + template <size_t N = Nurse, size_t P = Patient, enable_if_t<N == 0 || P == 0, int> = 0> + static void precall(function_call&) + {} + template <size_t N = Nurse, size_t P = Patient, enable_if_t<N == 0 || P == 0, int> = 0> + static void postcall(function_call& call, handle ret) + { + keep_alive_impl(Nurse, Patient, call, ret); + } +}; + +/// Recursively iterate over variadic template arguments +template <typename... Args> +struct process_attributes +{ + static void init(const Args&... args, function_record* r) + { + int unused[] = {0, (process_attribute<typename std::decay<Args>::type>::init(args, r), 0)...}; + ignore_unused(unused); + } + static void init(const Args&... args, type_record* r) + { + int unused[] = {0, (process_attribute<typename std::decay<Args>::type>::init(args, r), 0)...}; + ignore_unused(unused); + } + static void precall(function_call& call) + { + int unused[] = {0, (process_attribute<typename std::decay<Args>::type>::precall(call), 0)...}; + ignore_unused(unused); + } + static void postcall(function_call& call, handle fn_ret) + { + int unused[] = {0, (process_attribute<typename std::decay<Args>::type>::postcall(call, fn_ret), 0)...}; + ignore_unused(unused); + } +}; + +template <typename T> +using is_call_guard = is_instantiation<call_guard, T>; + +/// Extract the ``type`` from the first `call_guard` in `Extras...` (or `void_type` if none found) +template <typename... Extra> +using extract_guard_t = typename exactly_one_t<is_call_guard, call_guard<>, Extra...>::type; + +/// Check the number of named arguments at compile time +template <typename... Extra, + size_t named = constexpr_sum(std::is_base_of<arg, Extra>::value...), + size_t self = constexpr_sum(std::is_same<is_method, Extra>::value...)> +constexpr bool expected_num_args(size_t nargs, bool has_args, bool has_kwargs) +{ + return named == 0 || (self + named + has_args + has_kwargs) == nargs; +} + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/buffer_info.h b/pybind11/include/pybind11/buffer_info.h new file mode 100644 index 0000000000000000000000000000000000000000..ef29e97227748db277269df3da66e990f653805b --- /dev/null +++ b/pybind11/include/pybind11/buffer_info.h @@ -0,0 +1,153 @@ +/* + pybind11/buffer_info.h: Python buffer object interface + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/// Information record describing a Python buffer object +struct buffer_info +{ + void* ptr = nullptr; // Pointer to the underlying storage + ssize_t itemsize = 0; // Size of individual items in bytes + ssize_t size = 0; // Total number of entries + std::string format; // For homogeneous buffers, this should be set to format_descriptor<T>::format() + ssize_t ndim = 0; // Number of dimensions + std::vector<ssize_t> shape; // Shape of the tensor (1 entry per dimension) + std::vector<ssize_t> strides; // Number of entries between adjacent entries (for each per dimension) + + buffer_info() {} + + buffer_info(void* ptr, + ssize_t itemsize, + const std::string& format, + ssize_t ndim, + detail::any_container<ssize_t> shape_in, + detail::any_container<ssize_t> strides_in) + : ptr(ptr) + , itemsize(itemsize) + , size(1) + , format(format) + , ndim(ndim) + , shape(std::move(shape_in)) + , strides(std::move(strides_in)) + { + if (ndim != (ssize_t)shape.size() || ndim != (ssize_t)strides.size()) + pybind11_fail("buffer_info: ndim doesn't match shape and/or strides length"); + for (size_t i = 0; i < (size_t)ndim; ++i) + size *= shape[i]; + } + + template <typename T> + buffer_info(T* ptr, detail::any_container<ssize_t> shape_in, detail::any_container<ssize_t> strides_in) + : buffer_info(private_ctr_tag(), + ptr, + sizeof(T), + format_descriptor<T>::format(), + static_cast<ssize_t>(shape_in->size()), + std::move(shape_in), + std::move(strides_in)) + {} + + buffer_info(void* ptr, ssize_t itemsize, const std::string& format, ssize_t size) + : buffer_info(ptr, itemsize, format, 1, {size}, {itemsize}) + {} + + template <typename T> + buffer_info(T* ptr, ssize_t size) + : buffer_info(ptr, sizeof(T), format_descriptor<T>::format(), size) + {} + + explicit buffer_info(Py_buffer* view, bool ownview = true) + : buffer_info(view->buf, + view->itemsize, + view->format, + view->ndim, + {view->shape, view->shape + view->ndim}, + {view->strides, view->strides + view->ndim}) + { + this->view = view; + this->ownview = ownview; + } + + buffer_info(const buffer_info&) = delete; + buffer_info& operator=(const buffer_info&) = delete; + + buffer_info(buffer_info&& other) + { + (*this) = std::move(other); + } + + buffer_info& operator=(buffer_info&& rhs) + { + ptr = rhs.ptr; + itemsize = rhs.itemsize; + size = rhs.size; + format = std::move(rhs.format); + ndim = rhs.ndim; + shape = std::move(rhs.shape); + strides = std::move(rhs.strides); + std::swap(view, rhs.view); + std::swap(ownview, rhs.ownview); + return *this; + } + + ~buffer_info() + { + if (view && ownview) { + PyBuffer_Release(view); + delete view; + } + } + +private: + struct private_ctr_tag + {}; + + buffer_info(private_ctr_tag, + void* ptr, + ssize_t itemsize, + const std::string& format, + ssize_t ndim, + detail::any_container<ssize_t>&& shape_in, + detail::any_container<ssize_t>&& strides_in) + : buffer_info(ptr, itemsize, format, ndim, std::move(shape_in), std::move(strides_in)) + {} + + Py_buffer* view = nullptr; + bool ownview = false; +}; + +NAMESPACE_BEGIN(detail) + +template <typename T, typename SFINAE = void> +struct compare_buffer_info +{ + static bool compare(const buffer_info& b) + { + return b.format == format_descriptor<T>::format() && b.itemsize == (ssize_t)sizeof(T); + } +}; + +template <typename T> +struct compare_buffer_info<T, detail::enable_if_t<std::is_integral<T>::value>> +{ + static bool compare(const buffer_info& b) + { + return (size_t)b.itemsize == sizeof(T) + && (b.format == format_descriptor<T>::value + || ((sizeof(T) == sizeof(long)) && b.format == (std::is_unsigned<T>::value ? "L" : "l")) + || ((sizeof(T) == sizeof(size_t)) && b.format == (std::is_unsigned<T>::value ? "N" : "n"))); + } +}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/cast.h b/pybind11/include/pybind11/cast.h new file mode 100644 index 0000000000000000000000000000000000000000..17b40f63576a1c6ea580a82082b669fdf94f40e6 --- /dev/null +++ b/pybind11/include/pybind11/cast.h @@ -0,0 +1,2601 @@ +/* + pybind11/cast.h: Partial template specializations to cast between + C++ and Python types + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pytypes.h" +#include "detail/typeid.h" +#include "detail/descr.h" +#include "detail/internals.h" +#include <array> +#include <limits> +#include <tuple> +#include <type_traits> + +#if defined(PYBIND11_CPP17) +# if defined(__has_include) +# if __has_include(<string_view>) +# define PYBIND11_HAS_STRING_VIEW +# endif +# elif defined(_MSC_VER) +# define PYBIND11_HAS_STRING_VIEW +# endif +#endif +#ifdef PYBIND11_HAS_STRING_VIEW +# include <string_view> +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// A life support system for temporary objects created by `type_caster::load()`. +/// Adding a patient will keep it alive up until the enclosing function returns. +class loader_life_support +{ +public: + /// A new patient frame is created when a function is entered + loader_life_support() + { + get_internals().loader_patient_stack.push_back(nullptr); + } + + /// ... and destroyed after it returns + ~loader_life_support() + { + auto& stack = get_internals().loader_patient_stack; + if (stack.empty()) + pybind11_fail("loader_life_support: internal error"); + + auto ptr = stack.back(); + stack.pop_back(); + Py_CLEAR(ptr); + + // A heuristic to reduce the stack's capacity (e.g. after long recursive calls) + if (stack.capacity() > 16 && stack.size() != 0 && stack.capacity() / stack.size() > 2) + stack.shrink_to_fit(); + } + + /// This can only be used inside a pybind11-bound function, either by `argument_loader` + /// at argument preparation time or by `py::cast()` at execution time. + PYBIND11_NOINLINE static void add_patient(handle h) + { + auto& stack = get_internals().loader_patient_stack; + if (stack.empty()) + throw cast_error("When called outside a bound function, py::cast() cannot " + "do Python -> C++ conversions which require the creation " + "of temporary values"); + + auto& list_ptr = stack.back(); + if (list_ptr == nullptr) { + list_ptr = PyList_New(1); + if (!list_ptr) + pybind11_fail("loader_life_support: error allocating list"); + PyList_SET_ITEM(list_ptr, 0, h.inc_ref().ptr()); + } else { + auto result = PyList_Append(list_ptr, h.ptr()); + if (result == -1) + pybind11_fail("loader_life_support: error adding patient"); + } + } +}; + +// Gets the cache entry for the given type, creating it if necessary. The return value is the pair +// returned by emplace, i.e. an iterator for the entry and a bool set to `true` if the entry was +// just created. +inline std::pair<decltype(internals::registered_types_py)::iterator, bool> all_type_info_get_cache(PyTypeObject* type); + +// Populates a just-created cache entry. +PYBIND11_NOINLINE inline void all_type_info_populate(PyTypeObject* t, std::vector<type_info*>& bases) +{ + std::vector<PyTypeObject*> check; + for (handle parent : reinterpret_borrow<tuple>(t->tp_bases)) + check.push_back((PyTypeObject*)parent.ptr()); + + auto const& type_dict = get_internals().registered_types_py; + for (size_t i = 0; i < check.size(); i++) { + auto type = check[i]; + // Ignore Python2 old-style class super type: + if (!PyType_Check((PyObject*)type)) + continue; + + // Check `type` in the current set of registered python types: + auto it = type_dict.find(type); + if (it != type_dict.end()) { + // We found a cache entry for it, so it's either pybind-registered or has pre-computed + // pybind bases, but we have to make sure we haven't already seen the type(s) before: we + // want to follow Python/virtual C++ rules that there should only be one instance of a + // common base. + for (auto* tinfo : it->second) { + // NB: Could use a second set here, rather than doing a linear search, but since + // having a large number of immediate pybind11-registered types seems fairly + // unlikely, that probably isn't worthwhile. + bool found = false; + for (auto* known : bases) { + if (known == tinfo) { + found = true; + break; + } + } + if (!found) + bases.push_back(tinfo); + } + } else if (type->tp_bases) { + // It's some python type, so keep follow its bases classes to look for one or more + // registered types + if (i + 1 == check.size()) { + // When we're at the end, we can pop off the current element to avoid growing + // `check` when adding just one base (which is typical--i.e. when there is no + // multiple inheritance) + check.pop_back(); + i--; + } + for (handle parent : reinterpret_borrow<tuple>(type->tp_bases)) + check.push_back((PyTypeObject*)parent.ptr()); + } + } +} + +/** + * Extracts vector of type_info pointers of pybind-registered roots of the given Python type. Will + * be just 1 pybind type for the Python type of a pybind-registered class, or for any Python-side + * derived class that uses single inheritance. Will contain as many types as required for a Python + * class that uses multiple inheritance to inherit (directly or indirectly) from multiple + * pybind-registered classes. Will be empty if neither the type nor any base classes are + * pybind-registered. + * + * The value is cached for the lifetime of the Python type. + */ +inline const std::vector<detail::type_info*>& all_type_info(PyTypeObject* type) +{ + auto ins = all_type_info_get_cache(type); + if (ins.second) + // New cache entry: populate it + all_type_info_populate(type, ins.first->second); + + return ins.first->second; +} + +/** + * Gets a single pybind11 type info for a python type. Returns nullptr if neither the type nor any + * ancestors are pybind11-registered. Throws an exception if there are multiple bases--use + * `all_type_info` instead if you want to support multiple bases. + */ +PYBIND11_NOINLINE inline detail::type_info* get_type_info(PyTypeObject* type) +{ + auto& bases = all_type_info(type); + if (bases.size() == 0) + return nullptr; + if (bases.size() > 1) + pybind11_fail("pybind11::detail::get_type_info: type has multiple pybind11-registered bases"); + return bases.front(); +} + +inline detail::type_info* get_local_type_info(const std::type_index& tp) +{ + auto& locals = registered_local_types_cpp(); + auto it = locals.find(tp); + if (it != locals.end()) + return it->second; + return nullptr; +} + +inline detail::type_info* get_global_type_info(const std::type_index& tp) +{ + auto& types = get_internals().registered_types_cpp; + auto it = types.find(tp); + if (it != types.end()) + return it->second; + return nullptr; +} + +/// Return the type info for a given C++ type; on lookup failure can either throw or return nullptr. +PYBIND11_NOINLINE inline detail::type_info* get_type_info(const std::type_index& tp, bool throw_if_missing = false) +{ + if (auto ltype = get_local_type_info(tp)) + return ltype; + if (auto gtype = get_global_type_info(tp)) + return gtype; + + if (throw_if_missing) { + std::string tname = tp.name(); + detail::clean_type_id(tname); + pybind11_fail("pybind11::detail::get_type_info: unable to find type info for \"" + tname + "\""); + } + return nullptr; +} + +PYBIND11_NOINLINE inline handle get_type_handle(const std::type_info& tp, bool throw_if_missing) +{ + detail::type_info* type_info = get_type_info(tp, throw_if_missing); + return handle(type_info ? ((PyObject*)type_info->type) : nullptr); +} + +struct value_and_holder +{ + instance* inst = nullptr; + size_t index = 0u; + const detail::type_info* type = nullptr; + void** vh = nullptr; + + // Main constructor for a found value/holder: + value_and_holder(instance* i, const detail::type_info* type, size_t vpos, size_t index) + : inst{i} + , index{index} + , type{type} + , vh{inst->simple_layout ? inst->simple_value_holder : &inst->nonsimple.values_and_holders[vpos]} + {} + + // Default constructor (used to signal a value-and-holder not found by get_value_and_holder()) + value_and_holder() {} + + // Used for past-the-end iterator + value_and_holder(size_t index) + : index{index} + {} + + template <typename V = void> + V*& value_ptr() const + { + return reinterpret_cast<V*&>(vh[0]); + } + // True if this `value_and_holder` has a non-null value pointer + explicit operator bool() const + { + return value_ptr(); + } + + template <typename H> + H& holder() const + { + return reinterpret_cast<H&>(vh[1]); + } + bool holder_constructed() const + { + return inst->simple_layout ? inst->simple_holder_constructed + : inst->nonsimple.status[index] & instance::status_holder_constructed; + } + void set_holder_constructed(bool v = true) + { + if (inst->simple_layout) + inst->simple_holder_constructed = v; + else if (v) + inst->nonsimple.status[index] |= instance::status_holder_constructed; + else + inst->nonsimple.status[index] &= (uint8_t)~instance::status_holder_constructed; + } + bool instance_registered() const + { + return inst->simple_layout ? inst->simple_instance_registered + : inst->nonsimple.status[index] & instance::status_instance_registered; + } + void set_instance_registered(bool v = true) + { + if (inst->simple_layout) + inst->simple_instance_registered = v; + else if (v) + inst->nonsimple.status[index] |= instance::status_instance_registered; + else + inst->nonsimple.status[index] &= (uint8_t)~instance::status_instance_registered; + } +}; + +// Container for accessing and iterating over an instance's values/holders +struct values_and_holders +{ +private: + instance* inst; + using type_vec = std::vector<detail::type_info*>; + const type_vec& tinfo; + +public: + values_and_holders(instance* inst) + : inst{inst} + , tinfo(all_type_info(Py_TYPE(inst))) + {} + + struct iterator + { + private: + instance* inst = nullptr; + const type_vec* types = nullptr; + value_and_holder curr; + friend struct values_and_holders; + iterator(instance* inst, const type_vec* tinfo) + : inst{inst} + , types{tinfo} + , curr(inst /* instance */, + types->empty() ? nullptr : (*types)[0] /* type info */, + 0, /* vpos: (non-simple types only): the first vptr comes first */ + 0 /* index */) + {} + // Past-the-end iterator: + iterator(size_t end) + : curr(end) + {} + + public: + bool operator==(const iterator& other) + { + return curr.index == other.curr.index; + } + bool operator!=(const iterator& other) + { + return curr.index != other.curr.index; + } + iterator& operator++() + { + if (!inst->simple_layout) + curr.vh += 1 + (*types)[curr.index]->holder_size_in_ptrs; + ++curr.index; + curr.type = curr.index < types->size() ? (*types)[curr.index] : nullptr; + return *this; + } + value_and_holder& operator*() + { + return curr; + } + value_and_holder* operator->() + { + return &curr; + } + }; + + iterator begin() + { + return iterator(inst, &tinfo); + } + iterator end() + { + return iterator(tinfo.size()); + } + + iterator find(const type_info* find_type) + { + auto it = begin(), endit = end(); + while (it != endit && it->type != find_type) + ++it; + return it; + } + + size_t size() + { + return tinfo.size(); + } +}; + +/** + * Extracts C++ value and holder pointer references from an instance (which may contain multiple + * values/holders for python-side multiple inheritance) that match the given type. Throws an error + * if the given type (or ValueType, if omitted) is not a pybind11 base of the given instance. If + * `find_type` is omitted (or explicitly specified as nullptr) the first value/holder are returned, + * regardless of type (and the resulting .type will be nullptr). + * + * The returned object should be short-lived: in particular, it must not outlive the called-upon + * instance. + */ +PYBIND11_NOINLINE inline value_and_holder +instance::get_value_and_holder(const type_info* find_type /*= nullptr default in common.h*/, + bool throw_if_missing /*= true in common.h*/) +{ + // Optimize common case: + if (!find_type || Py_TYPE(this) == find_type->type) + return value_and_holder(this, find_type, 0, 0); + + detail::values_and_holders vhs(this); + auto it = vhs.find(find_type); + if (it != vhs.end()) + return *it; + + if (!throw_if_missing) + return value_and_holder(); + +#if defined(NDEBUG) + pybind11_fail("pybind11::detail::instance::get_value_and_holder: " + "type is not a pybind11 base of the given instance " + "(compile in debug mode for type details)"); +#else + pybind11_fail("pybind11::detail::instance::get_value_and_holder: `" + std::string(find_type->type->tp_name) + + "' is not a pybind11 base of the given `" + std::string(Py_TYPE(this)->tp_name) + "' instance"); +#endif +} + +PYBIND11_NOINLINE inline void instance::allocate_layout() +{ + auto& tinfo = all_type_info(Py_TYPE(this)); + + const size_t n_types = tinfo.size(); + + if (n_types == 0) + pybind11_fail("instance allocation failed: new instance has no pybind11-registered base types"); + + simple_layout = n_types == 1 && tinfo.front()->holder_size_in_ptrs <= instance_simple_holder_in_ptrs(); + + // Simple path: no python-side multiple inheritance, and a small-enough holder + if (simple_layout) { + simple_value_holder[0] = nullptr; + simple_holder_constructed = false; + simple_instance_registered = false; + } else { // multiple base types or a too-large holder + // Allocate space to hold: [v1*][h1][v2*][h2]...[bb...] where [vN*] is a value pointer, + // [hN] is the (uninitialized) holder instance for value N, and [bb...] is a set of bool + // values that tracks whether each associated holder has been initialized. Each [block] is + // padded, if necessary, to an integer multiple of sizeof(void *). + size_t space = 0; + for (auto t : tinfo) { + space += 1; // value pointer + space += t->holder_size_in_ptrs; // holder instance + } + size_t flags_at = space; + space += size_in_ptrs(n_types); // status bytes (holder_constructed and instance_registered) + + // Allocate space for flags, values, and holders, and initialize it to 0 (flags and values, + // in particular, need to be 0). Use Python's memory allocation functions: in Python 3.6 + // they default to using pymalloc, which is designed to be efficient for small allocations + // like the one we're doing here; in earlier versions (and for larger allocations) they are + // just wrappers around malloc. +#if PY_VERSION_HEX >= 0x03050000 + nonsimple.values_and_holders = (void**)PyMem_Calloc(space, sizeof(void*)); + if (!nonsimple.values_and_holders) + throw std::bad_alloc(); +#else + nonsimple.values_and_holders = (void**)PyMem_New(void*, space); + if (!nonsimple.values_and_holders) + throw std::bad_alloc(); + std::memset(nonsimple.values_and_holders, 0, space * sizeof(void*)); +#endif + nonsimple.status = reinterpret_cast<uint8_t*>(&nonsimple.values_and_holders[flags_at]); + } + owned = true; +} + +PYBIND11_NOINLINE inline void instance::deallocate_layout() +{ + if (!simple_layout) + PyMem_Free(nonsimple.values_and_holders); +} + +PYBIND11_NOINLINE inline bool isinstance_generic(handle obj, const std::type_info& tp) +{ + handle type = detail::get_type_handle(tp, false); + if (!type) + return false; + return isinstance(obj, type); +} + +PYBIND11_NOINLINE inline std::string error_string() +{ + if (!PyErr_Occurred()) { + PyErr_SetString(PyExc_RuntimeError, "Unknown internal error occurred"); + return "Unknown internal error occurred"; + } + + error_scope scope; // Preserve error state + + std::string errorString; + if (scope.type) { + errorString += handle(scope.type).attr("__name__").cast<std::string>(); + errorString += ": "; + } + if (scope.value) + errorString += (std::string)str(scope.value); + + PyErr_NormalizeException(&scope.type, &scope.value, &scope.trace); + +#if PY_MAJOR_VERSION >= 3 + if (scope.trace != nullptr) + PyException_SetTraceback(scope.value, scope.trace); +#endif + +#if !defined(PYPY_VERSION) + if (scope.trace) { + PyTracebackObject* trace = (PyTracebackObject*)scope.trace; + + /* Get the deepest trace possible */ + while (trace->tb_next) + trace = trace->tb_next; + + PyFrameObject* frame = trace->tb_frame; + errorString += "\n\nAt:\n"; + while (frame) { + int lineno = PyFrame_GetLineNumber(frame); + errorString += " " + handle(frame->f_code->co_filename).cast<std::string>() + "(" + std::to_string(lineno) + + "): " + handle(frame->f_code->co_name).cast<std::string>() + "\n"; + frame = frame->f_back; + } + } +#endif + + return errorString; +} + +PYBIND11_NOINLINE inline handle get_object_handle(const void* ptr, const detail::type_info* type) +{ + auto& instances = get_internals().registered_instances; + auto range = instances.equal_range(ptr); + for (auto it = range.first; it != range.second; ++it) { + for (auto vh : values_and_holders(it->second)) { + if (vh.type == type) + return handle((PyObject*)it->second); + } + } + return handle(); +} + +inline PyThreadState* get_thread_state_unchecked() +{ +#if defined(PYPY_VERSION) + return PyThreadState_GET(); +#elif PY_VERSION_HEX < 0x03000000 + return _PyThreadState_Current; +#elif PY_VERSION_HEX < 0x03050000 + return (PyThreadState*)_Py_atomic_load_relaxed(&_PyThreadState_Current); +#elif PY_VERSION_HEX < 0x03050200 + return (PyThreadState*)_PyThreadState_Current.value; +#else + return _PyThreadState_UncheckedGet(); +#endif +} + +// Forward declarations +inline void keep_alive_impl(handle nurse, handle patient); +inline PyObject* make_new_instance(PyTypeObject* type); + +class type_caster_generic +{ +public: + PYBIND11_NOINLINE type_caster_generic(const std::type_info& type_info) + : typeinfo(get_type_info(type_info)) + , cpptype(&type_info) + {} + + type_caster_generic(const type_info* typeinfo) + : typeinfo(typeinfo) + , cpptype(typeinfo ? typeinfo->cpptype : nullptr) + {} + + bool load(handle src, bool convert) + { + return load_impl<type_caster_generic>(src, convert); + } + + PYBIND11_NOINLINE static handle cast(const void* _src, + return_value_policy policy, + handle parent, + const detail::type_info* tinfo, + void* (*copy_constructor)(const void*), + void* (*move_constructor)(const void*), + const void* existing_holder = nullptr) + { + if (!tinfo) // no type info: error will be set already + return handle(); + + void* src = const_cast<void*>(_src); + if (src == nullptr) + return none().release(); + + auto it_instances = get_internals().registered_instances.equal_range(src); + for (auto it_i = it_instances.first; it_i != it_instances.second; ++it_i) { + for (auto instance_type : detail::all_type_info(Py_TYPE(it_i->second))) { + if (instance_type && same_type(*instance_type->cpptype, *tinfo->cpptype)) + return handle((PyObject*)it_i->second).inc_ref(); + } + } + + auto inst = reinterpret_steal<object>(make_new_instance(tinfo->type)); + auto wrapper = reinterpret_cast<instance*>(inst.ptr()); + wrapper->owned = false; + void*& valueptr = values_and_holders(wrapper).begin()->value_ptr(); + + switch (policy) { + case return_value_policy::automatic: + case return_value_policy::take_ownership: + valueptr = src; + wrapper->owned = true; + break; + + case return_value_policy::automatic_reference: + case return_value_policy::reference: + valueptr = src; + wrapper->owned = false; + break; + + case return_value_policy::copy: + if (copy_constructor) + valueptr = copy_constructor(src); + else + throw cast_error("return_value_policy = copy, but the " + "object is non-copyable!"); + wrapper->owned = true; + break; + + case return_value_policy::move: + if (move_constructor) + valueptr = move_constructor(src); + else if (copy_constructor) + valueptr = copy_constructor(src); + else + throw cast_error("return_value_policy = move, but the " + "object is neither movable nor copyable!"); + wrapper->owned = true; + break; + + case return_value_policy::reference_internal: + valueptr = src; + wrapper->owned = false; + keep_alive_impl(inst, parent); + break; + + default: + throw cast_error("unhandled return_value_policy: should not happen!"); + } + + tinfo->init_instance(wrapper, existing_holder); + + return inst.release(); + } + + // Base methods for generic caster; there are overridden in copyable_holder_caster + void load_value(value_and_holder&& v_h) + { + auto*& vptr = v_h.value_ptr(); + // Lazy allocation for unallocated values: + if (vptr == nullptr) { + auto* type = v_h.type ? v_h.type : typeinfo; + if (type->operator_new) { + vptr = type->operator_new(type->type_size); + } else { +#if defined(PYBIND11_CPP17) + if (type->type_align > __STDCPP_DEFAULT_NEW_ALIGNMENT__) + vptr = ::operator new(type->type_size, (std::align_val_t)type->type_align); + else +#endif + vptr = ::operator new(type->type_size); + } + } + value = vptr; + } + bool try_implicit_casts(handle src, bool convert) + { + for (auto& cast : typeinfo->implicit_casts) { + type_caster_generic sub_caster(*cast.first); + if (sub_caster.load(src, convert)) { + value = cast.second(sub_caster.value); + return true; + } + } + return false; + } + bool try_direct_conversions(handle src) + { + for (auto& converter : *typeinfo->direct_conversions) { + if (converter(src.ptr(), value)) + return true; + } + return false; + } + void check_holder_compat() {} + + PYBIND11_NOINLINE static void* local_load(PyObject* src, const type_info* ti) + { + auto caster = type_caster_generic(ti); + if (caster.load(src, false)) + return caster.value; + return nullptr; + } + + /// Try to load with foreign typeinfo, if available. Used when there is no + /// native typeinfo, or when the native one wasn't able to produce a value. + PYBIND11_NOINLINE bool try_load_foreign_module_local(handle src) + { + constexpr auto* local_key = PYBIND11_MODULE_LOCAL_ID; + const auto pytype = src.get_type(); + if (!hasattr(pytype, local_key)) + return false; + + type_info* foreign_typeinfo = reinterpret_borrow<capsule>(getattr(pytype, local_key)); + // Only consider this foreign loader if actually foreign and is a loader of the correct cpp type + if (foreign_typeinfo->module_local_load == &local_load + || (cpptype && !same_type(*cpptype, *foreign_typeinfo->cpptype))) + return false; + + if (auto result = foreign_typeinfo->module_local_load(src.ptr(), foreign_typeinfo)) { + value = result; + return true; + } + return false; + } + + // Implementation of `load`; this takes the type of `this` so that it can dispatch the relevant + // bits of code between here and copyable_holder_caster where the two classes need different + // logic (without having to resort to virtual inheritance). + template <typename ThisT> + PYBIND11_NOINLINE bool load_impl(handle src, bool convert) + { + if (!src) + return false; + if (!typeinfo) + return try_load_foreign_module_local(src); + if (src.is_none()) { + // Defer accepting None to other overloads (if we aren't in convert mode): + if (!convert) + return false; + value = nullptr; + return true; + } + + auto& this_ = static_cast<ThisT&>(*this); + this_.check_holder_compat(); + + PyTypeObject* srctype = Py_TYPE(src.ptr()); + + // Case 1: If src is an exact type match for the target type then we can reinterpret_cast + // the instance's value pointer to the target type: + if (srctype == typeinfo->type) { + this_.load_value(reinterpret_cast<instance*>(src.ptr())->get_value_and_holder()); + return true; + } + // Case 2: We have a derived class + else if (PyType_IsSubtype(srctype, typeinfo->type)) { + auto& bases = all_type_info(srctype); + bool no_cpp_mi = typeinfo->simple_type; + + // Case 2a: the python type is a Python-inherited derived class that inherits from just + // one simple (no MI) pybind11 class, or is an exact match, so the C++ instance is of + // the right type and we can use reinterpret_cast. + // (This is essentially the same as case 2b, but because not using multiple inheritance + // is extremely common, we handle it specially to avoid the loop iterator and type + // pointer lookup overhead) + if (bases.size() == 1 && (no_cpp_mi || bases.front()->type == typeinfo->type)) { + this_.load_value(reinterpret_cast<instance*>(src.ptr())->get_value_and_holder()); + return true; + } + // Case 2b: the python type inherits from multiple C++ bases. Check the bases to see if + // we can find an exact match (or, for a simple C++ type, an inherited match); if so, we + // can safely reinterpret_cast to the relevant pointer. + else if (bases.size() > 1) { + for (auto base : bases) { + if (no_cpp_mi ? PyType_IsSubtype(base->type, typeinfo->type) : base->type == typeinfo->type) { + this_.load_value(reinterpret_cast<instance*>(src.ptr())->get_value_and_holder(base)); + return true; + } + } + } + + // Case 2c: C++ multiple inheritance is involved and we couldn't find an exact type match + // in the registered bases, above, so try implicit casting (needed for proper C++ casting + // when MI is involved). + if (this_.try_implicit_casts(src, convert)) + return true; + } + + // Perform an implicit conversion + if (convert) { + for (auto& converter : typeinfo->implicit_conversions) { + auto temp = reinterpret_steal<object>(converter(src.ptr(), typeinfo->type)); + if (load_impl<ThisT>(temp, false)) { + loader_life_support::add_patient(temp); + return true; + } + } + if (this_.try_direct_conversions(src)) + return true; + } + + // Failed to match local typeinfo. Try again with global. + if (typeinfo->module_local) { + if (auto gtype = get_global_type_info(*typeinfo->cpptype)) { + typeinfo = gtype; + return load(src, false); + } + } + + // Global typeinfo has precedence over foreign module_local + return try_load_foreign_module_local(src); + } + + + // Called to do type lookup and wrap the pointer and type in a pair when a dynamic_cast + // isn't needed or can't be used. If the type is unknown, sets the error and returns a pair + // with .second = nullptr. (p.first = nullptr is not an error: it becomes None). + PYBIND11_NOINLINE static std::pair<const void*, const type_info*> + src_and_type(const void* src, const std::type_info& cast_type, const std::type_info* rtti_type = nullptr) + { + if (auto* tpi = get_type_info(cast_type)) + return {src, const_cast<const type_info*>(tpi)}; + + // Not found, set error: + std::string tname = rtti_type ? rtti_type->name() : cast_type.name(); + detail::clean_type_id(tname); + std::string msg = "Unregistered type : " + tname; + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return {nullptr, nullptr}; + } + + const type_info* typeinfo = nullptr; + const std::type_info* cpptype = nullptr; + void* value = nullptr; +}; + +/** + * Determine suitable casting operator for pointer-or-lvalue-casting type casters. The type caster + * needs to provide `operator T*()` and `operator T&()` operators. + * + * If the type supports moving the value away via an `operator T&&() &&` method, it should use + * `movable_cast_op_type` instead. + */ +template <typename T> +using cast_op_type = conditional_t<std::is_pointer<remove_reference_t<T>>::value, + typename std::add_pointer<intrinsic_t<T>>::type, + typename std::add_lvalue_reference<intrinsic_t<T>>::type>; + +/** + * Determine suitable casting operator for a type caster with a movable value. Such a type caster + * needs to provide `operator T*()`, `operator T&()`, and `operator T&&() &&`. The latter will be + * called in appropriate contexts where the value can be moved rather than copied. + * + * These operator are automatically provided when using the PYBIND11_TYPE_CASTER macro. + */ +template <typename T> +using movable_cast_op_type = conditional_t<std::is_pointer<typename std::remove_reference<T>::type>::value, + typename std::add_pointer<intrinsic_t<T>>::type, + conditional_t<std::is_rvalue_reference<T>::value, + typename std::add_rvalue_reference<intrinsic_t<T>>::type, + typename std::add_lvalue_reference<intrinsic_t<T>>::type>>; + +// std::is_copy_constructible isn't quite enough: it lets std::vector<T> (and similar) through when +// T is non-copyable, but code containing such a copy constructor fails to actually compile. +template <typename T, typename SFINAE = void> +struct is_copy_constructible : std::is_copy_constructible<T> +{}; + +// Specialization for types that appear to be copy constructible but also look like stl containers +// (we specifically check for: has `value_type` and `reference` with `reference = value_type&`): if +// so, copy constructability depends on whether the value_type is copy constructible. +template <typename Container> +struct is_copy_constructible< + Container, + enable_if_t<all_of<std::is_copy_constructible<Container>, + std::is_same<typename Container::value_type&, typename Container::reference>>::value>> + : is_copy_constructible<typename Container::value_type> +{}; + +#if !defined(PYBIND11_CPP17) +// Likewise for std::pair before C++17 (which mandates that the copy constructor not exist when the +// two types aren't themselves copy constructible). +template <typename T1, typename T2> +struct is_copy_constructible<std::pair<T1, T2>> : all_of<is_copy_constructible<T1>, is_copy_constructible<T2>> +{}; +#endif + +NAMESPACE_END(detail) + +// polymorphic_type_hook<itype>::get(src, tinfo) determines whether the object pointed +// to by `src` actually is an instance of some class derived from `itype`. +// If so, it sets `tinfo` to point to the std::type_info representing that derived +// type, and returns a pointer to the start of the most-derived object of that type +// (in which `src` is a subobject; this will be the same address as `src` in most +// single inheritance cases). If not, or if `src` is nullptr, it simply returns `src` +// and leaves `tinfo` at its default value of nullptr. +// +// The default polymorphic_type_hook just returns src. A specialization for polymorphic +// types determines the runtime type of the passed object and adjusts the this-pointer +// appropriately via dynamic_cast<void*>. This is what enables a C++ Animal* to appear +// to Python as a Dog (if Dog inherits from Animal, Animal is polymorphic, Dog is +// registered with pybind11, and this Animal is in fact a Dog). +// +// You may specialize polymorphic_type_hook yourself for types that want to appear +// polymorphic to Python but do not use C++ RTTI. (This is a not uncommon pattern +// in performance-sensitive applications, used most notably in LLVM.) +template <typename itype, typename SFINAE = void> +struct polymorphic_type_hook +{ + static const void* get(const itype* src, const std::type_info*&) + { + return src; + } +}; +template <typename itype> +struct polymorphic_type_hook<itype, detail::enable_if_t<std::is_polymorphic<itype>::value>> +{ + static const void* get(const itype* src, const std::type_info*& type) + { + type = src ? &typeid(*src) : nullptr; + return dynamic_cast<const void*>(src); + } +}; + +NAMESPACE_BEGIN(detail) + +/// Generic type caster for objects stored on the heap +template <typename type> +class type_caster_base : public type_caster_generic +{ + using itype = intrinsic_t<type>; + +public: + static constexpr auto name = _<type>(); + + type_caster_base() + : type_caster_base(typeid(type)) + {} + explicit type_caster_base(const std::type_info& info) + : type_caster_generic(info) + {} + + static handle cast(const itype& src, return_value_policy policy, handle parent) + { + if (policy == return_value_policy::automatic || policy == return_value_policy::automatic_reference) + policy = return_value_policy::copy; + return cast(&src, policy, parent); + } + + static handle cast(itype&& src, return_value_policy, handle parent) + { + return cast(&src, return_value_policy::move, parent); + } + + // Returns a (pointer, type_info) pair taking care of necessary type lookup for a + // polymorphic type (using RTTI by default, but can be overridden by specializing + // polymorphic_type_hook). If the instance isn't derived, returns the base version. + static std::pair<const void*, const type_info*> src_and_type(const itype* src) + { + auto& cast_type = typeid(itype); + const std::type_info* instance_type = nullptr; + const void* vsrc = polymorphic_type_hook<itype>::get(src, instance_type); + if (instance_type && !same_type(cast_type, *instance_type)) { + // This is a base pointer to a derived type. If the derived type is registered + // with pybind11, we want to make the full derived object available. + // In the typical case where itype is polymorphic, we get the correct + // derived pointer (which may be != base pointer) by a dynamic_cast to + // most derived type. If itype is not polymorphic, we won't get here + // except via a user-provided specialization of polymorphic_type_hook, + // and the user has promised that no this-pointer adjustment is + // required in that case, so it's OK to use static_cast. + if (const auto* tpi = get_type_info(*instance_type)) + return {vsrc, tpi}; + } + // Otherwise we have either a nullptr, an `itype` pointer, or an unknown derived pointer, so + // don't do a cast + return type_caster_generic::src_and_type(src, cast_type, instance_type); + } + + static handle cast(const itype* src, return_value_policy policy, handle parent) + { + auto st = src_and_type(src); + return type_caster_generic::cast( + st.first, policy, parent, st.second, make_copy_constructor(src), make_move_constructor(src)); + } + + static handle cast_holder(const itype* src, const void* holder) + { + auto st = src_and_type(src); + return type_caster_generic::cast( + st.first, return_value_policy::take_ownership, {}, st.second, nullptr, nullptr, holder); + } + + template <typename T> + using cast_op_type = detail::cast_op_type<T>; + + operator itype*() + { + return (type*)value; + } + operator itype&() + { + if (!value) + throw reference_cast_error(); + return *((itype*)value); + } + +protected: + using Constructor = void* (*)(const void*); + + /* Only enabled when the types are {copy,move}-constructible *and* when the type + does not have a private operator new implementation. */ + template <typename T, typename = enable_if_t<is_copy_constructible<T>::value>> + static auto make_copy_constructor(const T* x) -> decltype(new T(*x), Constructor{}) + { + return [](const void* arg) -> void* { return new T(*reinterpret_cast<const T*>(arg)); }; + } + + template <typename T, typename = enable_if_t<std::is_move_constructible<T>::value>> + static auto make_move_constructor(const T* x) -> decltype(new T(std::move(*const_cast<T*>(x))), Constructor{}) + { + return [](const void* arg) -> void* { return new T(std::move(*const_cast<T*>(reinterpret_cast<const T*>(arg)))); }; + } + + static Constructor make_copy_constructor(...) + { + return nullptr; + } + static Constructor make_move_constructor(...) + { + return nullptr; + } +}; + +template <typename type, typename SFINAE = void> +class type_caster : public type_caster_base<type> +{}; +template <typename type> +using make_caster = type_caster<intrinsic_t<type>>; + +// Shortcut for calling a caster's `cast_op_type` cast operator for casting a type_caster to a T +template <typename T> +typename make_caster<T>::template cast_op_type<T> cast_op(make_caster<T>& caster) +{ + return caster.operator typename make_caster<T>::template cast_op_type<T>(); +} +template <typename T> +typename make_caster<T>::template cast_op_type<typename std::add_rvalue_reference<T>::type> +cast_op(make_caster<T>&& caster) +{ + return std::move(caster). + operator typename make_caster<T>::template cast_op_type<typename std::add_rvalue_reference<T>::type>(); +} + +template <typename type> +class type_caster<std::reference_wrapper<type>> +{ +private: + using caster_t = make_caster<type>; + caster_t subcaster; + using subcaster_cast_op_type = typename caster_t::template cast_op_type<type>; + static_assert(std::is_same<typename std::remove_const<type>::type&, subcaster_cast_op_type>::value, + "std::reference_wrapper<T> caster requires T to have a caster with an `T &` operator"); + +public: + bool load(handle src, bool convert) + { + return subcaster.load(src, convert); + } + static constexpr auto name = caster_t::name; + static handle cast(const std::reference_wrapper<type>& src, return_value_policy policy, handle parent) + { + // It is definitely wrong to take ownership of this pointer, so mask that rvp + if (policy == return_value_policy::take_ownership || policy == return_value_policy::automatic) + policy = return_value_policy::automatic_reference; + return caster_t::cast(&src.get(), policy, parent); + } + template <typename T> + using cast_op_type = std::reference_wrapper<type>; + operator std::reference_wrapper<type>() + { + return subcaster.operator subcaster_cast_op_type&(); + } +}; + +#define PYBIND11_TYPE_CASTER(type, py_name) \ +protected: \ + type value; \ + \ +public: \ + static constexpr auto name = py_name; \ + template <typename T_, enable_if_t<std::is_same<type, remove_cv_t<T_>>::value, int> = 0> \ + static handle cast(T_* src, return_value_policy policy, handle parent) \ + { \ + if (!src) \ + return none().release(); \ + if (policy == return_value_policy::take_ownership) { \ + auto h = cast(std::move(*src), policy, parent); \ + delete src; \ + return h; \ + } else { \ + return cast(*src, policy, parent); \ + } \ + } \ + operator type*() \ + { \ + return &value; \ + } \ + operator type&() \ + { \ + return value; \ + } \ + operator type &&()&& \ + { \ + return std::move(value); \ + } \ + template <typename T_> \ + using cast_op_type = pybind11::detail::movable_cast_op_type<T_> + + +template <typename CharT> +using is_std_char_type = any_of<std::is_same<CharT, char>, /* std::string */ + std::is_same<CharT, char16_t>, /* std::u16string */ + std::is_same<CharT, char32_t>, /* std::u32string */ + std::is_same<CharT, wchar_t> /* std::wstring */ + >; + +template <typename T> +struct type_caster<T, enable_if_t<std::is_arithmetic<T>::value && !is_std_char_type<T>::value>> +{ + using _py_type_0 = conditional_t<sizeof(T) <= sizeof(long), long, long long>; + using _py_type_1 = conditional_t<std::is_signed<T>::value, _py_type_0, typename std::make_unsigned<_py_type_0>::type>; + using py_type = conditional_t<std::is_floating_point<T>::value, double, _py_type_1>; + +public: + bool load(handle src, bool convert) + { + py_type py_value; + + if (!src) + return false; + + if (std::is_floating_point<T>::value) { + if (convert || PyFloat_Check(src.ptr())) + py_value = (py_type)PyFloat_AsDouble(src.ptr()); + else + return false; + } else if (PyFloat_Check(src.ptr())) { + return false; + } else if (std::is_unsigned<py_type>::value) { + py_value = as_unsigned<py_type>(src.ptr()); + } else { // signed integer: + py_value = + sizeof(T) <= sizeof(long) ? (py_type)PyLong_AsLong(src.ptr()) : (py_type)PYBIND11_LONG_AS_LONGLONG(src.ptr()); + } + + bool py_err = py_value == (py_type)-1 && PyErr_Occurred(); + if (py_err + || (std::is_integral<T>::value && sizeof(py_type) != sizeof(T) + && (py_value < (py_type)std::numeric_limits<T>::min() + || py_value > (py_type)std::numeric_limits<T>::max()))) { + bool type_error = py_err + && PyErr_ExceptionMatches( +#if PY_VERSION_HEX < 0x03000000 && !defined(PYPY_VERSION) + PyExc_SystemError +#else + PyExc_TypeError +#endif + ); + PyErr_Clear(); + if (type_error && convert && PyNumber_Check(src.ptr())) { + auto tmp = reinterpret_steal<object>(std::is_floating_point<T>::value ? PyNumber_Float(src.ptr()) + : PyNumber_Long(src.ptr())); + PyErr_Clear(); + return load(tmp, false); + } + return false; + } + + value = (T)py_value; + return true; + } + + template <typename U = T> + static typename std::enable_if<std::is_floating_point<U>::value, handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) + { + return PyFloat_FromDouble((double)src); + } + + template <typename U = T> + static typename std::enable_if<!std::is_floating_point<U>::value && std::is_signed<U>::value + && (sizeof(U) <= sizeof(long)), + handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) + { + return PYBIND11_LONG_FROM_SIGNED((long)src); + } + + template <typename U = T> + static typename std::enable_if<!std::is_floating_point<U>::value && std::is_unsigned<U>::value + && (sizeof(U) <= sizeof(unsigned long)), + handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) + { + return PYBIND11_LONG_FROM_UNSIGNED((unsigned long)src); + } + + template <typename U = T> + static typename std::enable_if<!std::is_floating_point<U>::value && std::is_signed<U>::value + && (sizeof(U) > sizeof(long)), + handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) + { + return PyLong_FromLongLong((long long)src); + } + + template <typename U = T> + static typename std::enable_if<!std::is_floating_point<U>::value && std::is_unsigned<U>::value + && (sizeof(U) > sizeof(unsigned long)), + handle>::type + cast(U src, return_value_policy /* policy */, handle /* parent */) + { + return PyLong_FromUnsignedLongLong((unsigned long long)src); + } + + PYBIND11_TYPE_CASTER(T, _<std::is_integral<T>::value>("int", "float")); +}; + +template <typename T> +struct void_caster +{ +public: + bool load(handle src, bool) + { + if (src && src.is_none()) + return true; + return false; + } + static handle cast(T, return_value_policy /* policy */, handle /* parent */) + { + return none().inc_ref(); + } + PYBIND11_TYPE_CASTER(T, _("None")); +}; + +template <> +class type_caster<void_type> : public void_caster<void_type> +{}; + +template <> +class type_caster<void> : public type_caster<void_type> +{ +public: + using type_caster<void_type>::cast; + + bool load(handle h, bool) + { + if (!h) { + return false; + } else if (h.is_none()) { + value = nullptr; + return true; + } + + /* Check if this is a capsule */ + if (isinstance<capsule>(h)) { + value = reinterpret_borrow<capsule>(h); + return true; + } + + /* Check if this is a C++ type */ + auto& bases = all_type_info((PyTypeObject*)h.get_type().ptr()); + if (bases.size() == 1) { // Only allowing loading from a single-value type + value = values_and_holders(reinterpret_cast<instance*>(h.ptr())).begin()->value_ptr(); + return true; + } + + /* Fail */ + return false; + } + + static handle cast(const void* ptr, return_value_policy /* policy */, handle /* parent */) + { + if (ptr) + return capsule(ptr).release(); + else + return none().inc_ref(); + } + + template <typename T> + using cast_op_type = void*&; + operator void*&() + { + return value; + } + static constexpr auto name = _("capsule"); + +private: + void* value = nullptr; +}; + +template <> +class type_caster<std::nullptr_t> : public void_caster<std::nullptr_t> +{}; + +template <> +class type_caster<bool> +{ +public: + bool load(handle src, bool convert) + { + if (!src) + return false; + else if (src.ptr() == Py_True) { + value = true; + return true; + } else if (src.ptr() == Py_False) { + value = false; + return true; + } else if (convert || !strcmp("numpy.bool_", Py_TYPE(src.ptr())->tp_name)) { + // (allow non-implicit conversion for numpy booleans) + + Py_ssize_t res = -1; + if (src.is_none()) { + res = 0; // None is implicitly converted to False + } +#if defined(PYPY_VERSION) + // On PyPy, check that "__bool__" (or "__nonzero__" on Python 2.7) attr exists + else if (hasattr(src, PYBIND11_BOOL_ATTR)) { + res = PyObject_IsTrue(src.ptr()); + } +#else + // Alternate approach for CPython: this does the same as the above, but optimized + // using the CPython API so as to avoid an unneeded attribute lookup. + else if (auto tp_as_number = src.ptr()->ob_type->tp_as_number) { + if (PYBIND11_NB_BOOL(tp_as_number)) { + res = (*PYBIND11_NB_BOOL(tp_as_number))(src.ptr()); + } + } +#endif + if (res == 0 || res == 1) { + value = (bool)res; + return true; + } + } + return false; + } + static handle cast(bool src, return_value_policy /* policy */, handle /* parent */) + { + return handle(src ? Py_True : Py_False).inc_ref(); + } + PYBIND11_TYPE_CASTER(bool, _("bool")); +}; + +// Helper class for UTF-{8,16,32} C++ stl strings: +template <typename StringType, bool IsView = false> +struct string_caster +{ + using CharT = typename StringType::value_type; + + // Simplify life by being able to assume standard char sizes (the standard only guarantees + // minimums, but Python requires exact sizes) + static_assert(!std::is_same<CharT, char>::value || sizeof(CharT) == 1, "Unsupported char size != 1"); + static_assert(!std::is_same<CharT, char16_t>::value || sizeof(CharT) == 2, "Unsupported char16_t size != 2"); + static_assert(!std::is_same<CharT, char32_t>::value || sizeof(CharT) == 4, "Unsupported char32_t size != 4"); + // wchar_t can be either 16 bits (Windows) or 32 (everywhere else) + static_assert(!std::is_same<CharT, wchar_t>::value || sizeof(CharT) == 2 || sizeof(CharT) == 4, + "Unsupported wchar_t size != 2/4"); + static constexpr size_t UTF_N = 8 * sizeof(CharT); + + bool load(handle src, bool) + { +#if PY_MAJOR_VERSION < 3 + object temp; +#endif + handle load_src = src; + if (!src) { + return false; + } else if (!PyUnicode_Check(load_src.ptr())) { +#if PY_MAJOR_VERSION >= 3 + return load_bytes(load_src); +#else + if (sizeof(CharT) == 1) { + return load_bytes(load_src); + } + + // The below is a guaranteed failure in Python 3 when PyUnicode_Check returns false + if (!PYBIND11_BYTES_CHECK(load_src.ptr())) + return false; + + temp = reinterpret_steal<object>(PyUnicode_FromObject(load_src.ptr())); + if (!temp) { + PyErr_Clear(); + return false; + } + load_src = temp; +#endif + } + + object utfNbytes = reinterpret_steal<object>( + PyUnicode_AsEncodedString(load_src.ptr(), UTF_N == 8 ? "utf-8" : UTF_N == 16 ? "utf-16" : "utf-32", nullptr)); + if (!utfNbytes) { + PyErr_Clear(); + return false; + } + + const CharT* buffer = reinterpret_cast<const CharT*>(PYBIND11_BYTES_AS_STRING(utfNbytes.ptr())); + size_t length = (size_t)PYBIND11_BYTES_SIZE(utfNbytes.ptr()) / sizeof(CharT); + if (UTF_N > 8) { + buffer++; + length--; + } // Skip BOM for UTF-16/32 + value = StringType(buffer, length); + + // If we're loading a string_view we need to keep the encoded Python object alive: + if (IsView) + loader_life_support::add_patient(utfNbytes); + + return true; + } + + static handle cast(const StringType& src, return_value_policy /* policy */, handle /* parent */) + { + const char* buffer = reinterpret_cast<const char*>(src.data()); + ssize_t nbytes = ssize_t(src.size() * sizeof(CharT)); + handle s = decode_utfN(buffer, nbytes); + if (!s) + throw error_already_set(); + return s; + } + + PYBIND11_TYPE_CASTER(StringType, _(PYBIND11_STRING_NAME)); + +private: + static handle decode_utfN(const char* buffer, ssize_t nbytes) + { +#if !defined(PYPY_VERSION) + return UTF_N == 8 ? PyUnicode_DecodeUTF8(buffer, nbytes, nullptr) + : UTF_N == 16 ? PyUnicode_DecodeUTF16(buffer, nbytes, nullptr, nullptr) + : PyUnicode_DecodeUTF32(buffer, nbytes, nullptr, nullptr); +#else + // PyPy seems to have multiple problems related to PyUnicode_UTF*: the UTF8 version + // sometimes segfaults for unknown reasons, while the UTF16 and 32 versions require a + // non-const char * arguments, which is also a nuisance, so bypass the whole thing by just + // passing the encoding as a string value, which works properly: + return PyUnicode_Decode(buffer, nbytes, UTF_N == 8 ? "utf-8" : UTF_N == 16 ? "utf-16" : "utf-32", nullptr); +#endif + } + + // When loading into a std::string or char*, accept a bytes object as-is (i.e. + // without any encoding/decoding attempt). For other C++ char sizes this is a no-op. + // which supports loading a unicode from a str, doesn't take this path. + template <typename C = CharT> + bool load_bytes(enable_if_t<sizeof(C) == 1, handle> src) + { + if (PYBIND11_BYTES_CHECK(src.ptr())) { + // We were passed a Python 3 raw bytes; accept it into a std::string or char* + // without any encoding attempt. + const char* bytes = PYBIND11_BYTES_AS_STRING(src.ptr()); + if (bytes) { + value = StringType(bytes, (size_t)PYBIND11_BYTES_SIZE(src.ptr())); + return true; + } + } + + return false; + } + + template <typename C = CharT> + bool load_bytes(enable_if_t<sizeof(C) != 1, handle>) + { + return false; + } +}; + +template <typename CharT, class Traits, class Allocator> +struct type_caster<std::basic_string<CharT, Traits, Allocator>, enable_if_t<is_std_char_type<CharT>::value>> + : string_caster<std::basic_string<CharT, Traits, Allocator>> +{}; + +#ifdef PYBIND11_HAS_STRING_VIEW +template <typename CharT, class Traits> +struct type_caster<std::basic_string_view<CharT, Traits>, enable_if_t<is_std_char_type<CharT>::value>> + : string_caster<std::basic_string_view<CharT, Traits>, true> +{}; +#endif + +// Type caster for C-style strings. We basically use a std::string type caster, but also add the +// ability to use None as a nullptr char* (which the string caster doesn't allow). +template <typename CharT> +struct type_caster<CharT, enable_if_t<is_std_char_type<CharT>::value>> +{ + using StringType = std::basic_string<CharT>; + using StringCaster = type_caster<StringType>; + StringCaster str_caster; + bool none = false; + CharT one_char = 0; + +public: + bool load(handle src, bool convert) + { + if (!src) + return false; + if (src.is_none()) { + // Defer accepting None to other overloads (if we aren't in convert mode): + if (!convert) + return false; + none = true; + return true; + } + return str_caster.load(src, convert); + } + + static handle cast(const CharT* src, return_value_policy policy, handle parent) + { + if (src == nullptr) + return pybind11::none().inc_ref(); + return StringCaster::cast(StringType(src), policy, parent); + } + + static handle cast(CharT src, return_value_policy policy, handle parent) + { + if (std::is_same<char, CharT>::value) { + handle s = PyUnicode_DecodeLatin1((const char*)&src, 1, nullptr); + if (!s) + throw error_already_set(); + return s; + } + return StringCaster::cast(StringType(1, src), policy, parent); + } + + operator CharT*() + { + return none ? nullptr : const_cast<CharT*>(static_cast<StringType&>(str_caster).c_str()); + } + operator CharT&() + { + if (none) + throw value_error("Cannot convert None to a character"); + + auto& value = static_cast<StringType&>(str_caster); + size_t str_len = value.size(); + if (str_len == 0) + throw value_error("Cannot convert empty string to a character"); + + // If we're in UTF-8 mode, we have two possible failures: one for a unicode character that + // is too high, and one for multiple unicode characters (caught later), so we need to figure + // out how long the first encoded character is in bytes to distinguish between these two + // errors. We also allow want to allow unicode characters U+0080 through U+00FF, as those + // can fit into a single char value. + if (StringCaster::UTF_N == 8 && str_len > 1 && str_len <= 4) { + unsigned char v0 = static_cast<unsigned char>(value[0]); + size_t char0_bytes = !(v0 & 0x80) ? 1 : // low bits only: 0-127 + (v0 & 0xE0) == 0xC0 ? 2 : // 0b110xxxxx - start of 2-byte sequence + (v0 & 0xF0) == 0xE0 ? 3 : // 0b1110xxxx - start of 3-byte sequence + 4; // 0b11110xxx - start of 4-byte sequence + + if (char0_bytes == str_len) { + // If we have a 128-255 value, we can decode it into a single char: + if (char0_bytes == 2 && (v0 & 0xFC) == 0xC0) { // 0x110000xx 0x10xxxxxx + one_char = static_cast<CharT>(((v0 & 3) << 6) + (static_cast<unsigned char>(value[1]) & 0x3F)); + return one_char; + } + // Otherwise we have a single character, but it's > U+00FF + throw value_error("Character code point not in range(0x100)"); + } + } + + // UTF-16 is much easier: we can only have a surrogate pair for values above U+FFFF, thus a + // surrogate pair with total length 2 instantly indicates a range error (but not a "your + // string was too long" error). + else if (StringCaster::UTF_N == 16 && str_len == 2) { + one_char = static_cast<CharT>(value[0]); + if (one_char >= 0xD800 && one_char < 0xE000) + throw value_error("Character code point not in range(0x10000)"); + } + + if (str_len != 1) + throw value_error("Expected a character, but multi-character string found"); + + one_char = value[0]; + return one_char; + } + + static constexpr auto name = _(PYBIND11_STRING_NAME); + template <typename _T> + using cast_op_type = pybind11::detail::cast_op_type<_T>; +}; + +// Base implementation for std::tuple and std::pair +template <template <typename...> class Tuple, typename... Ts> +class tuple_caster +{ + using type = Tuple<Ts...>; + static constexpr auto size = sizeof...(Ts); + using indices = make_index_sequence<size>; + +public: + bool load(handle src, bool convert) + { + if (!isinstance<sequence>(src)) + return false; + const auto seq = reinterpret_borrow<sequence>(src); + if (seq.size() != size) + return false; + return load_impl(seq, convert, indices{}); + } + + template <typename T> + static handle cast(T&& src, return_value_policy policy, handle parent) + { + return cast_impl(std::forward<T>(src), policy, parent, indices{}); + } + + static constexpr auto name = _("Tuple[") + concat(make_caster<Ts>::name...) + _("]"); + + template <typename T> + using cast_op_type = type; + + operator type() & + { + return implicit_cast(indices{}); + } + operator type() && + { + return std::move(*this).implicit_cast(indices{}); + } + +protected: + template <size_t... Is> + type implicit_cast(index_sequence<Is...>) & + { + return type(cast_op<Ts>(std::get<Is>(subcasters))...); + } + template <size_t... Is> + type implicit_cast(index_sequence<Is...>) && + { + return type(cast_op<Ts>(std::move(std::get<Is>(subcasters)))...); + } + + static constexpr bool load_impl(const sequence&, bool, index_sequence<>) + { + return true; + } + + template <size_t... Is> + bool load_impl(const sequence& seq, bool convert, index_sequence<Is...>) + { + for (bool r : {std::get<Is>(subcasters).load(seq[Is], convert)...}) + if (!r) + return false; + return true; + } + + /* Implementation: Convert a C++ tuple into a Python tuple */ + template <typename T, size_t... Is> + static handle cast_impl(T&& src, return_value_policy policy, handle parent, index_sequence<Is...>) + { + std::array<object, size> entries{ + {reinterpret_steal<object>(make_caster<Ts>::cast(std::get<Is>(std::forward<T>(src)), policy, parent))...}}; + for (const auto& entry : entries) + if (!entry) + return handle(); + tuple result(size); + int counter = 0; + for (auto& entry : entries) + PyTuple_SET_ITEM(result.ptr(), counter++, entry.release().ptr()); + return result.release(); + } + + Tuple<make_caster<Ts>...> subcasters; +}; + +template <typename T1, typename T2> +class type_caster<std::pair<T1, T2>> : public tuple_caster<std::pair, T1, T2> +{}; + +template <typename... Ts> +class type_caster<std::tuple<Ts...>> : public tuple_caster<std::tuple, Ts...> +{}; + +/// Helper class which abstracts away certain actions. Users can provide specializations for +/// custom holders, but it's only necessary if the type has a non-standard interface. +template <typename T> +struct holder_helper +{ + static auto get(const T& p) -> decltype(p.get()) + { + return p.get(); + } +}; + +/// Type caster for holder types like std::shared_ptr, etc. +template <typename type, typename holder_type> +struct copyable_holder_caster : public type_caster_base<type> +{ +public: + using base = type_caster_base<type>; + static_assert(std::is_base_of<base, type_caster<type>>::value, "Holder classes are only supported for custom types"); + using base::base; + using base::cast; + using base::typeinfo; + using base::value; + + bool load(handle src, bool convert) + { + return base::template load_impl<copyable_holder_caster<type, holder_type>>(src, convert); + } + + explicit operator type*() + { + return this->value; + } + explicit operator type&() + { + return *(this->value); + } + explicit operator holder_type*() + { + return std::addressof(holder); + } + +// Workaround for Intel compiler bug +// see pybind11 issue 94 +#if defined(__ICC) || defined(__INTEL_COMPILER) + operator holder_type&() + { + return holder; + } +#else + explicit operator holder_type&() + { + return holder; + } +#endif + + static handle cast(const holder_type& src, return_value_policy, handle) + { + const auto* ptr = holder_helper<holder_type>::get(src); + return type_caster_base<type>::cast_holder(ptr, &src); + } + +protected: + friend class type_caster_generic; + void check_holder_compat() + { + if (typeinfo->default_holder) + throw cast_error("Unable to load a custom holder type from a default-holder instance"); + } + + bool load_value(value_and_holder&& v_h) + { + if (v_h.holder_constructed()) { + value = v_h.value_ptr(); + holder = v_h.template holder<holder_type>(); + return true; + } else { + throw cast_error("Unable to cast from non-held to held instance (T& to Holder<T>) " +#if defined(NDEBUG) + "(compile in debug mode for type information)"); +#else + "of type '" + + type_id<holder_type>() + "''"); +#endif + } + } + + template <typename T = holder_type, detail::enable_if_t<!std::is_constructible<T, const T&, type*>::value, int> = 0> + bool try_implicit_casts(handle, bool) + { + return false; + } + + template <typename T = holder_type, detail::enable_if_t<std::is_constructible<T, const T&, type*>::value, int> = 0> + bool try_implicit_casts(handle src, bool convert) + { + for (auto& cast : typeinfo->implicit_casts) { + copyable_holder_caster sub_caster(*cast.first); + if (sub_caster.load(src, convert)) { + value = cast.second(sub_caster.value); + holder = holder_type(sub_caster.holder, (type*)value); + return true; + } + } + return false; + } + + static bool try_direct_conversions(handle) + { + return false; + } + + + holder_type holder; +}; + +/// Specialize for the common std::shared_ptr, so users don't need to +template <typename T> +class type_caster<std::shared_ptr<T>> : public copyable_holder_caster<T, std::shared_ptr<T>> +{}; + +template <typename type, typename holder_type> +struct move_only_holder_caster +{ + static_assert(std::is_base_of<type_caster_base<type>, type_caster<type>>::value, + "Holder classes are only supported for custom types"); + + static handle cast(holder_type&& src, return_value_policy, handle) + { + auto* ptr = holder_helper<holder_type>::get(src); + return type_caster_base<type>::cast_holder(ptr, std::addressof(src)); + } + static constexpr auto name = type_caster_base<type>::name; +}; + +template <typename type, typename deleter> +class type_caster<std::unique_ptr<type, deleter>> : public move_only_holder_caster<type, std::unique_ptr<type, deleter>> +{}; + +template <typename type, typename holder_type> +using type_caster_holder = conditional_t<is_copy_constructible<holder_type>::value, + copyable_holder_caster<type, holder_type>, + move_only_holder_caster<type, holder_type>>; + +template <typename T, bool Value = false> +struct always_construct_holder +{ + static constexpr bool value = Value; +}; + +/// Create a specialization for custom holder types (silently ignores std::shared_ptr) +#define PYBIND11_DECLARE_HOLDER_TYPE(type, holder_type, ...) \ + namespace pybind11 { \ + namespace detail { \ + template <typename type> \ + struct always_construct_holder<holder_type> : always_construct_holder<void, ##__VA_ARGS__> \ + {}; \ + template <typename type> \ + class type_caster<holder_type, enable_if_t<!is_shared_ptr<holder_type>::value>> \ + : public type_caster_holder<type, holder_type> \ + {}; \ + } \ + } + +// PYBIND11_DECLARE_HOLDER_TYPE holder types: +template <typename base, typename holder> +struct is_holder_type : std::is_base_of<detail::type_caster_holder<base, holder>, detail::type_caster<holder>> +{}; +// Specialization for always-supported unique_ptr holders: +template <typename base, typename deleter> +struct is_holder_type<base, std::unique_ptr<base, deleter>> : std::true_type +{}; + +template <typename T> +struct handle_type_name +{ + static constexpr auto name = _<T>(); +}; +template <> +struct handle_type_name<bytes> +{ + static constexpr auto name = _(PYBIND11_BYTES_NAME); +}; +template <> +struct handle_type_name<args> +{ + static constexpr auto name = _("*args"); +}; +template <> +struct handle_type_name<kwargs> +{ + static constexpr auto name = _("**kwargs"); +}; + +template <typename type> +struct pyobject_caster +{ + template <typename T = type, enable_if_t<std::is_same<T, handle>::value, int> = 0> + bool load(handle src, bool /* convert */) + { + value = src; + return static_cast<bool>(value); + } + + template <typename T = type, enable_if_t<std::is_base_of<object, T>::value, int> = 0> + bool load(handle src, bool /* convert */) + { + if (!isinstance<type>(src)) + return false; + value = reinterpret_borrow<type>(src); + return true; + } + + static handle cast(const handle& src, return_value_policy /* policy */, handle /* parent */) + { + return src.inc_ref(); + } + PYBIND11_TYPE_CASTER(type, handle_type_name<type>::name); +}; + +template <typename T> +class type_caster<T, enable_if_t<is_pyobject<T>::value>> : public pyobject_caster<T> +{}; + +// Our conditions for enabling moving are quite restrictive: +// At compile time: +// - T needs to be a non-const, non-pointer, non-reference type +// - type_caster<T>::operator T&() must exist +// - the type must be move constructible (obviously) +// At run-time: +// - if the type is non-copy-constructible, the object must be the sole owner of the type (i.e. it +// must have ref_count() == 1)h +// If any of the above are not satisfied, we fall back to copying. +template <typename T> +using move_is_plain_type = satisfies_none_of<T, std::is_void, std::is_pointer, std::is_reference, std::is_const>; +template <typename T, typename SFINAE = void> +struct move_always : std::false_type +{}; +template <typename T> +struct move_always<T, + enable_if_t<all_of<move_is_plain_type<T>, + negation<is_copy_constructible<T>>, + std::is_move_constructible<T>, + std::is_same<decltype(std::declval<make_caster<T>>().operator T&()), T&>>::value>> + : std::true_type +{}; +template <typename T, typename SFINAE = void> +struct move_if_unreferenced : std::false_type +{}; +template <typename T> +struct move_if_unreferenced< + T, + enable_if_t<all_of<move_is_plain_type<T>, + negation<move_always<T>>, + std::is_move_constructible<T>, + std::is_same<decltype(std::declval<make_caster<T>>().operator T&()), T&>>::value>> + : std::true_type +{}; +template <typename T> +using move_never = none_of<move_always<T>, move_if_unreferenced<T>>; + +// Detect whether returning a `type` from a cast on type's type_caster is going to result in a +// reference or pointer to a local variable of the type_caster. Basically, only +// non-reference/pointer `type`s and reference/pointers from a type_caster_generic are safe; +// everything else returns a reference/pointer to a local variable. +template <typename type> +using cast_is_temporary_value_reference = + bool_constant<(std::is_reference<type>::value || std::is_pointer<type>::value) + && !std::is_base_of<type_caster_generic, make_caster<type>>::value + && !std::is_same<intrinsic_t<type>, void>::value>; + +// When a value returned from a C++ function is being cast back to Python, we almost always want to +// force `policy = move`, regardless of the return value policy the function/method was declared +// with. +template <typename Return, typename SFINAE = void> +struct return_value_policy_override +{ + static return_value_policy policy(return_value_policy p) + { + return p; + } +}; + +template <typename Return> +struct return_value_policy_override< + Return, + detail::enable_if_t<std::is_base_of<type_caster_generic, make_caster<Return>>::value, void>> +{ + static return_value_policy policy(return_value_policy p) + { + return !std::is_lvalue_reference<Return>::value && !std::is_pointer<Return>::value ? return_value_policy::move : p; + } +}; + +// Basic python -> C++ casting; throws if casting fails +template <typename T, typename SFINAE> +type_caster<T, SFINAE>& load_type(type_caster<T, SFINAE>& conv, const handle& handle) +{ + if (!conv.load(handle, true)) { +#if defined(NDEBUG) + throw cast_error("Unable to cast Python instance to C++ type (compile in debug mode for details)"); +#else + throw cast_error("Unable to cast Python instance of type " + (std::string)str(handle.get_type()) + " to C++ type '" + + type_id<T>() + "'"); +#endif + } + return conv; +} +// Wrapper around the above that also constructs and returns a type_caster +template <typename T> +make_caster<T> load_type(const handle& handle) +{ + make_caster<T> conv; + load_type(conv, handle); + return conv; +} + +NAMESPACE_END(detail) + +// pytype -> C++ type +template <typename T, detail::enable_if_t<!detail::is_pyobject<T>::value, int> = 0> +T cast(const handle& handle) +{ + using namespace detail; + static_assert(!cast_is_temporary_value_reference<T>::value, + "Unable to cast type to reference: value is local to type caster"); + return cast_op<T>(load_type<T>(handle)); +} + +// pytype -> pytype (calls converting constructor) +template <typename T, detail::enable_if_t<detail::is_pyobject<T>::value, int> = 0> +T cast(const handle& handle) +{ + return T(reinterpret_borrow<object>(handle)); +} + +// C++ type -> py::object +template <typename T, detail::enable_if_t<!detail::is_pyobject<T>::value, int> = 0> +object +cast(const T& value, return_value_policy policy = return_value_policy::automatic_reference, handle parent = handle()) +{ + if (policy == return_value_policy::automatic) + policy = std::is_pointer<T>::value ? return_value_policy::take_ownership : return_value_policy::copy; + else if (policy == return_value_policy::automatic_reference) + policy = std::is_pointer<T>::value ? return_value_policy::reference : return_value_policy::copy; + return reinterpret_steal<object>(detail::make_caster<T>::cast(value, policy, parent)); +} + +template <typename T> +T handle::cast() const +{ + return pybind11::cast<T>(*this); +} +template <> +inline void handle::cast() const +{ + return; +} + +template <typename T> +detail::enable_if_t<!detail::move_never<T>::value, T> move(object&& obj) +{ + if (obj.ref_count() > 1) +#if defined(NDEBUG) + throw cast_error("Unable to cast Python instance to C++ rvalue: instance has multiple references" + " (compile in debug mode for details)"); +#else + throw cast_error("Unable to move from Python " + (std::string)str(obj.get_type()) + " instance to C++ " + + type_id<T>() + " instance: instance has multiple references"); +#endif + + // Move into a temporary and return that, because the reference may be a local value of `conv` + T ret = std::move(detail::load_type<T>(obj).operator T&()); + return ret; +} + +// Calling cast() on an rvalue calls pybind::cast with the object rvalue, which does: +// - If we have to move (because T has no copy constructor), do it. This will fail if the moved +// object has multiple references, but trying to copy will fail to compile. +// - If both movable and copyable, check ref count: if 1, move; otherwise copy +// - Otherwise (not movable), copy. +template <typename T> +detail::enable_if_t<detail::move_always<T>::value, T> cast(object&& object) +{ + return move<T>(std::move(object)); +} +template <typename T> +detail::enable_if_t<detail::move_if_unreferenced<T>::value, T> cast(object&& object) +{ + if (object.ref_count() > 1) + return cast<T>(object); + else + return move<T>(std::move(object)); +} +template <typename T> +detail::enable_if_t<detail::move_never<T>::value, T> cast(object&& object) +{ + return cast<T>(object); +} + +template <typename T> +T object::cast() const& +{ + return pybind11::cast<T>(*this); +} +template <typename T> +T object::cast() && +{ + return pybind11::cast<T>(std::move(*this)); +} +template <> +inline void object::cast() const& +{ + return; +} +template <> +inline void object::cast() && +{ + return; +} + +NAMESPACE_BEGIN(detail) + +// Declared in pytypes.h: +template <typename T, enable_if_t<!is_pyobject<T>::value, int>> +object object_or_cast(T&& o) +{ + return pybind11::cast(std::forward<T>(o)); +} + +struct overload_unused +{}; // Placeholder type for the unneeded (and dead code) static variable in the OVERLOAD_INT macro +template <typename ret_type> +using overload_caster_t = + conditional_t<cast_is_temporary_value_reference<ret_type>::value, make_caster<ret_type>, overload_unused>; + +// Trampoline use: for reference/pointer types to value-converted values, we do a value cast, then +// store the result in the given variable. For other types, this is a no-op. +template <typename T> +enable_if_t<cast_is_temporary_value_reference<T>::value, T> cast_ref(object&& o, make_caster<T>& caster) +{ + return cast_op<T>(load_type(caster, o)); +} +template <typename T> +enable_if_t<!cast_is_temporary_value_reference<T>::value, T> cast_ref(object&&, overload_unused&) +{ + pybind11_fail("Internal error: cast_ref fallback invoked"); +} + +// Trampoline use: Having a pybind11::cast with an invalid reference type is going to static_assert, even +// though if it's in dead code, so we provide a "trampoline" to pybind11::cast that only does anything in +// cases where pybind11::cast is valid. +template <typename T> +enable_if_t<!cast_is_temporary_value_reference<T>::value, T> cast_safe(object&& o) +{ + return pybind11::cast<T>(std::move(o)); +} +template <typename T> +enable_if_t<cast_is_temporary_value_reference<T>::value, T> cast_safe(object&&) +{ + pybind11_fail("Internal error: cast_safe fallback invoked"); +} +template <> +inline void cast_safe<void>(object&&) +{} + +NAMESPACE_END(detail) + +template <return_value_policy policy = return_value_policy::automatic_reference> +tuple make_tuple() +{ + return tuple(0); +} + +template <return_value_policy policy = return_value_policy::automatic_reference, typename... Args> +tuple make_tuple(Args&&... args_) +{ + constexpr size_t size = sizeof...(Args); + std::array<object, size> args{ + {reinterpret_steal<object>(detail::make_caster<Args>::cast(std::forward<Args>(args_), policy, nullptr))...}}; + for (size_t i = 0; i < args.size(); i++) { + if (!args[i]) { +#if defined(NDEBUG) + throw cast_error( + "make_tuple(): unable to convert arguments to Python object (compile in debug mode for details)"); +#else + std::array<std::string, size> argtypes{{type_id<Args>()...}}; + throw cast_error("make_tuple(): unable to convert argument of type '" + argtypes[i] + "' to Python object"); +#endif + } + } + tuple result(size); + int counter = 0; + for (auto& arg_value : args) + PyTuple_SET_ITEM(result.ptr(), counter++, arg_value.release().ptr()); + return result; +} + +/// \ingroup annotations +/// Annotation for arguments +struct arg +{ + /// Constructs an argument with the name of the argument; if null or omitted, this is a positional argument. + constexpr explicit arg(const char* name = nullptr) + : name(name) + , flag_noconvert(false) + , flag_none(true) + {} + /// Assign a value to this argument + template <typename T> + arg_v operator=(T&& value) const; + /// Indicate that the type should not be converted in the type caster + arg& noconvert(bool flag = true) + { + flag_noconvert = flag; + return *this; + } + /// Indicates that the argument should/shouldn't allow None (e.g. for nullable pointer args) + arg& none(bool flag = true) + { + flag_none = flag; + return *this; + } + + const char* name; ///< If non-null, this is a named kwargs argument + bool flag_noconvert : 1; ///< If set, do not allow conversion (requires a supporting type caster!) + bool flag_none : 1; ///< If set (the default), allow None to be passed to this argument +}; + +/// \ingroup annotations +/// Annotation for arguments with values +struct arg_v : arg +{ +private: + template <typename T> + arg_v(arg&& base, T&& x, const char* descr = nullptr) + : arg(base) + , value(reinterpret_steal<object>(detail::make_caster<T>::cast(x, return_value_policy::automatic, {}))) + , descr(descr) +#if !defined(NDEBUG) + , type(type_id<T>()) +#endif + {} + +public: + /// Direct construction with name, default, and description + template <typename T> + arg_v(const char* name, T&& x, const char* descr = nullptr) + : arg_v(arg(name), std::forward<T>(x), descr) + {} + + /// Called internally when invoking `py::arg("a") = value` + template <typename T> + arg_v(const arg& base, T&& x, const char* descr = nullptr) + : arg_v(arg(base), std::forward<T>(x), descr) + {} + + /// Same as `arg::noconvert()`, but returns *this as arg_v&, not arg& + arg_v& noconvert(bool flag = true) + { + arg::noconvert(flag); + return *this; + } + + /// Same as `arg::nonone()`, but returns *this as arg_v&, not arg& + arg_v& none(bool flag = true) + { + arg::none(flag); + return *this; + } + + /// The default value + object value; + /// The (optional) description of the default value + const char* descr; +#if !defined(NDEBUG) + /// The C++ type name of the default value (only available when compiled in debug mode) + std::string type; +#endif +}; + +template <typename T> +arg_v arg::operator=(T&& value) const +{ + return {std::move(*this), std::forward<T>(value)}; +} + +/// Alias for backward compatibility -- to be removed in version 2.0 +template <typename /*unused*/> +using arg_t = arg_v; + +inline namespace literals { +/** \rst + String literal version of `arg` + \endrst */ +constexpr arg operator"" _a(const char* name, size_t) +{ + return arg(name); +} +} // namespace literals + +NAMESPACE_BEGIN(detail) + +// forward declaration (definition in attr.h) +struct function_record; + +/// Internal data associated with a single function call +struct function_call +{ + function_call(const function_record& f, handle p); // Implementation in attr.h + + /// The function data: + const function_record& func; + + /// Arguments passed to the function: + std::vector<handle> args; + + /// The `convert` value the arguments should be loaded with + std::vector<bool> args_convert; + + /// Extra references for the optional `py::args` and/or `py::kwargs` arguments (which, if + /// present, are also in `args` but without a reference). + object args_ref, kwargs_ref; + + /// The parent, if any + handle parent; + + /// If this is a call to an initializer, this argument contains `self` + handle init_self; +}; + + +/// Helper class which loads arguments for C++ functions called from Python +template <typename... Args> +class argument_loader +{ + using indices = make_index_sequence<sizeof...(Args)>; + + template <typename Arg> + using argument_is_args = std::is_same<intrinsic_t<Arg>, args>; + template <typename Arg> + using argument_is_kwargs = std::is_same<intrinsic_t<Arg>, kwargs>; + // Get args/kwargs argument positions relative to the end of the argument list: + static constexpr auto args_pos = constexpr_first<argument_is_args, Args...>() - (int)sizeof...(Args), + kwargs_pos = constexpr_first<argument_is_kwargs, Args...>() - (int)sizeof...(Args); + + static constexpr bool args_kwargs_are_last = kwargs_pos >= -1 && args_pos >= kwargs_pos - 1; + + static_assert(args_kwargs_are_last, "py::args/py::kwargs are only permitted as the last argument(s) of a function"); + +public: + static constexpr bool has_kwargs = kwargs_pos < 0; + static constexpr bool has_args = args_pos < 0; + + static constexpr auto arg_names = concat(type_descr(make_caster<Args>::name)...); + + bool load_args(function_call& call) + { + return load_impl_sequence(call, indices{}); + } + + template <typename Return, typename Guard, typename Func> + enable_if_t<!std::is_void<Return>::value, Return> call(Func&& f) && + { + return std::move(*this).template call_impl<Return>(std::forward<Func>(f), indices{}, Guard{}); + } + + template <typename Return, typename Guard, typename Func> + enable_if_t<std::is_void<Return>::value, void_type> call(Func&& f) && + { + std::move(*this).template call_impl<Return>(std::forward<Func>(f), indices{}, Guard{}); + return void_type(); + } + +private: + static bool load_impl_sequence(function_call&, index_sequence<>) + { + return true; + } + + template <size_t... Is> + bool load_impl_sequence(function_call& call, index_sequence<Is...>) + { + for (bool r : {std::get<Is>(argcasters).load(call.args[Is], call.args_convert[Is])...}) + if (!r) + return false; + return true; + } + + template <typename Return, typename Func, size_t... Is, typename Guard> + Return call_impl(Func&& f, index_sequence<Is...>, Guard&&) + { + return std::forward<Func>(f)(cast_op<Args>(std::move(std::get<Is>(argcasters)))...); + } + + std::tuple<make_caster<Args>...> argcasters; +}; + +/// Helper class which collects only positional arguments for a Python function call. +/// A fancier version below can collect any argument, but this one is optimal for simple calls. +template <return_value_policy policy> +class simple_collector +{ +public: + template <typename... Ts> + explicit simple_collector(Ts&&... values) + : m_args(pybind11::make_tuple<policy>(std::forward<Ts>(values)...)) + {} + + const tuple& args() const& + { + return m_args; + } + dict kwargs() const + { + return {}; + } + + tuple args() && + { + return std::move(m_args); + } + + /// Call a Python function and pass the collected arguments + object call(PyObject* ptr) const + { + PyObject* result = PyObject_CallObject(ptr, m_args.ptr()); + if (!result) + throw error_already_set(); + return reinterpret_steal<object>(result); + } + +private: + tuple m_args; +}; + +/// Helper class which collects positional, keyword, * and ** arguments for a Python function call +template <return_value_policy policy> +class unpacking_collector +{ +public: + template <typename... Ts> + explicit unpacking_collector(Ts&&... values) + { + // Tuples aren't (easily) resizable so a list is needed for collection, + // but the actual function call strictly requires a tuple. + auto args_list = list(); + int _[] = {0, (process(args_list, std::forward<Ts>(values)), 0)...}; + ignore_unused(_); + + m_args = std::move(args_list); + } + + const tuple& args() const& + { + return m_args; + } + const dict& kwargs() const& + { + return m_kwargs; + } + + tuple args() && + { + return std::move(m_args); + } + dict kwargs() && + { + return std::move(m_kwargs); + } + + /// Call a Python function and pass the collected arguments + object call(PyObject* ptr) const + { + PyObject* result = PyObject_Call(ptr, m_args.ptr(), m_kwargs.ptr()); + if (!result) + throw error_already_set(); + return reinterpret_steal<object>(result); + } + +private: + template <typename T> + void process(list& args_list, T&& x) + { + auto o = reinterpret_steal<object>(detail::make_caster<T>::cast(std::forward<T>(x), policy, {})); + if (!o) { +#if defined(NDEBUG) + argument_cast_error(); +#else + argument_cast_error(std::to_string(args_list.size()), type_id<T>()); +#endif + } + args_list.append(o); + } + + void process(list& args_list, detail::args_proxy ap) + { + for (const auto& a : ap) + args_list.append(a); + } + + void process(list& /*args_list*/, arg_v a) + { + if (!a.name) +#if defined(NDEBUG) + nameless_argument_error(); +#else + nameless_argument_error(a.type); +#endif + + if (m_kwargs.contains(a.name)) { +#if defined(NDEBUG) + multiple_values_error(); +#else + multiple_values_error(a.name); +#endif + } + if (!a.value) { +#if defined(NDEBUG) + argument_cast_error(); +#else + argument_cast_error(a.name, a.type); +#endif + } + m_kwargs[a.name] = a.value; + } + + void process(list& /*args_list*/, detail::kwargs_proxy kp) + { + if (!kp) + return; + for (const auto& k : reinterpret_borrow<dict>(kp)) { + if (m_kwargs.contains(k.first)) { +#if defined(NDEBUG) + multiple_values_error(); +#else + multiple_values_error(str(k.first)); +#endif + } + m_kwargs[k.first] = k.second; + } + } + + [[noreturn]] static void nameless_argument_error() + { + throw type_error("Got kwargs without a name; only named arguments " + "may be passed via py::arg() to a python function call. " + "(compile in debug mode for details)"); + } + [[noreturn]] static void nameless_argument_error(std::string type) + { + throw type_error("Got kwargs without a name of type '" + type + + "'; only named " + "arguments may be passed via py::arg() to a python function call. "); + } + [[noreturn]] static void multiple_values_error() + { + throw type_error("Got multiple values for keyword argument " + "(compile in debug mode for details)"); + } + + [[noreturn]] static void multiple_values_error(std::string name) + { + throw type_error("Got multiple values for keyword argument '" + name + "'"); + } + + [[noreturn]] static void argument_cast_error() + { + throw cast_error("Unable to convert call argument to Python object " + "(compile in debug mode for details)"); + } + + [[noreturn]] static void argument_cast_error(std::string name, std::string type) + { + throw cast_error("Unable to convert call argument '" + name + "' of type '" + type + "' to Python object"); + } + +private: + tuple m_args; + dict m_kwargs; +}; + +/// Collect only positional arguments for a Python function call +template <return_value_policy policy, typename... Args, typename = enable_if_t<all_of<is_positional<Args>...>::value>> +simple_collector<policy> collect_arguments(Args&&... args) +{ + return simple_collector<policy>(std::forward<Args>(args)...); +} + +/// Collect all arguments, including keywords and unpacking (only instantiated when needed) +template <return_value_policy policy, typename... Args, typename = enable_if_t<!all_of<is_positional<Args>...>::value>> +unpacking_collector<policy> collect_arguments(Args&&... args) +{ + // Following argument order rules for generalized unpacking according to PEP 448 + static_assert(constexpr_last<is_positional, Args...>() < constexpr_first<is_keyword_or_ds, Args...>() + && constexpr_last<is_s_unpacking, Args...>() < constexpr_first<is_ds_unpacking, Args...>(), + "Invalid function call: positional args must precede keywords and ** unpacking; " + "* unpacking must precede ** unpacking"); + return unpacking_collector<policy>(std::forward<Args>(args)...); +} + +template <typename Derived> +template <return_value_policy policy, typename... Args> +object object_api<Derived>::operator()(Args&&... args) const +{ + return detail::collect_arguments<policy>(std::forward<Args>(args)...).call(derived().ptr()); +} + +template <typename Derived> +template <return_value_policy policy, typename... Args> +object object_api<Derived>::call(Args&&... args) const +{ + return operator()<policy>(std::forward<Args>(args)...); +} + +NAMESPACE_END(detail) + +#define PYBIND11_MAKE_OPAQUE(...) \ + namespace pybind11 { \ + namespace detail { \ + template <> \ + class type_caster<__VA_ARGS__> : public type_caster_base<__VA_ARGS__> \ + {}; \ + } \ + } + +/// Lets you pass a type containing a `,` through a macro parameter without needing a separate +/// typedef, e.g.: `PYBIND11_OVERLOAD(PYBIND11_TYPE(ReturnType<A, B>), PYBIND11_TYPE(Parent<C, D>), f, arg)` +#define PYBIND11_TYPE(...) __VA_ARGS__ + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/chrono.h b/pybind11/include/pybind11/chrono.h new file mode 100644 index 0000000000000000000000000000000000000000..81d9b55504f6d4f0f88b954e36f74a48e7f7a717 --- /dev/null +++ b/pybind11/include/pybind11/chrono.h @@ -0,0 +1,186 @@ +/* + pybind11/chrono.h: Transparent conversion between std::chrono and python's datetime + + Copyright (c) 2016 Trent Houliston <trent@houliston.me> and + Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include <cmath> +#include <ctime> +#include <chrono> +#include <datetime.h> + +// Backport the PyDateTime_DELTA functions from Python3.3 if required +#ifndef PyDateTime_DELTA_GET_DAYS +# define PyDateTime_DELTA_GET_DAYS(o) (((PyDateTime_Delta*)o)->days) +#endif +#ifndef PyDateTime_DELTA_GET_SECONDS +# define PyDateTime_DELTA_GET_SECONDS(o) (((PyDateTime_Delta*)o)->seconds) +#endif +#ifndef PyDateTime_DELTA_GET_MICROSECONDS +# define PyDateTime_DELTA_GET_MICROSECONDS(o) (((PyDateTime_Delta*)o)->microseconds) +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +template <typename type> +class duration_caster +{ +public: + typedef typename type::rep rep; + typedef typename type::period period; + + typedef std::chrono::duration<uint_fast32_t, std::ratio<86400>> days; + + bool load(handle src, bool) + { + using namespace std::chrono; + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { + PyDateTime_IMPORT; + } + + if (!src) + return false; + // If invoked with datetime.delta object + if (PyDelta_Check(src.ptr())) { + value = type(duration_cast<duration<rep, period>>(days(PyDateTime_DELTA_GET_DAYS(src.ptr())) + + seconds(PyDateTime_DELTA_GET_SECONDS(src.ptr())) + + microseconds(PyDateTime_DELTA_GET_MICROSECONDS(src.ptr())))); + return true; + } + // If invoked with a float we assume it is seconds and convert + else if (PyFloat_Check(src.ptr())) { + value = type(duration_cast<duration<rep, period>>(duration<double>(PyFloat_AsDouble(src.ptr())))); + return true; + } else + return false; + } + + // If this is a duration just return it back + static const std::chrono::duration<rep, period>& get_duration(const std::chrono::duration<rep, period>& src) + { + return src; + } + + // If this is a time_point get the time_since_epoch + template <typename Clock> + static std::chrono::duration<rep, period> + get_duration(const std::chrono::time_point<Clock, std::chrono::duration<rep, period>>& src) + { + return src.time_since_epoch(); + } + + static handle cast(const type& src, return_value_policy /* policy */, handle /* parent */) + { + using namespace std::chrono; + + // Use overloaded function to get our duration from our source + // Works out if it is a duration or time_point and get the duration + auto d = get_duration(src); + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { + PyDateTime_IMPORT; + } + + // Declare these special duration types so the conversions happen with the correct primitive types (int) + using dd_t = duration<int, std::ratio<86400>>; + using ss_t = duration<int, std::ratio<1>>; + using us_t = duration<int, std::micro>; + + auto dd = duration_cast<dd_t>(d); + auto subd = d - dd; + auto ss = duration_cast<ss_t>(subd); + auto us = duration_cast<us_t>(subd - ss); + return PyDelta_FromDSU(dd.count(), ss.count(), us.count()); + } + + PYBIND11_TYPE_CASTER(type, _("datetime.timedelta")); +}; + +// This is for casting times on the system clock into datetime.datetime instances +template <typename Duration> +class type_caster<std::chrono::time_point<std::chrono::system_clock, Duration>> +{ +public: + typedef std::chrono::time_point<std::chrono::system_clock, Duration> type; + bool load(handle src, bool) + { + using namespace std::chrono; + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { + PyDateTime_IMPORT; + } + + if (!src) + return false; + if (PyDateTime_Check(src.ptr())) { + std::tm cal; + cal.tm_sec = PyDateTime_DATE_GET_SECOND(src.ptr()); + cal.tm_min = PyDateTime_DATE_GET_MINUTE(src.ptr()); + cal.tm_hour = PyDateTime_DATE_GET_HOUR(src.ptr()); + cal.tm_mday = PyDateTime_GET_DAY(src.ptr()); + cal.tm_mon = PyDateTime_GET_MONTH(src.ptr()) - 1; + cal.tm_year = PyDateTime_GET_YEAR(src.ptr()) - 1900; + cal.tm_isdst = -1; + + value = system_clock::from_time_t(std::mktime(&cal)) + microseconds(PyDateTime_DATE_GET_MICROSECOND(src.ptr())); + return true; + } else + return false; + } + + static handle cast(const std::chrono::time_point<std::chrono::system_clock, Duration>& src, + return_value_policy /* policy */, + handle /* parent */) + { + using namespace std::chrono; + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { + PyDateTime_IMPORT; + } + + std::time_t tt = system_clock::to_time_t(time_point_cast<system_clock::duration>(src)); + // this function uses static memory so it's best to copy it out asap just in case + // otherwise other code that is using localtime may break this (not just python code) + std::tm localtime = *std::localtime(&tt); + + // Declare these special duration types so the conversions happen with the correct primitive types (int) + using us_t = duration<int, std::micro>; + + return PyDateTime_FromDateAndTime(localtime.tm_year + 1900, + localtime.tm_mon + 1, + localtime.tm_mday, + localtime.tm_hour, + localtime.tm_min, + localtime.tm_sec, + (duration_cast<us_t>(src.time_since_epoch() % seconds(1))).count()); + } + PYBIND11_TYPE_CASTER(type, _("datetime.datetime")); +}; + +// Other clocks that are not the system clock are not measured as datetime.datetime objects +// since they are not measured on calendar time. So instead we just make them timedeltas +// Or if they have passed us a time as a float we convert that +template <typename Clock, typename Duration> +class type_caster<std::chrono::time_point<Clock, Duration>> + : public duration_caster<std::chrono::time_point<Clock, Duration>> +{}; + +template <typename Rep, typename Period> +class type_caster<std::chrono::duration<Rep, Period>> : public duration_caster<std::chrono::duration<Rep, Period>> +{}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/common.h b/pybind11/include/pybind11/common.h new file mode 100644 index 0000000000000000000000000000000000000000..6c8a4f1e88e493ee08d24e668639c8d495fd49b1 --- /dev/null +++ b/pybind11/include/pybind11/common.h @@ -0,0 +1,2 @@ +#include "detail/common.h" +#warning "Including 'common.h' is deprecated. It will be removed in v3.0. Use 'pybind11.h'." diff --git a/pybind11/include/pybind11/complex.h b/pybind11/include/pybind11/complex.h new file mode 100644 index 0000000000000000000000000000000000000000..cd496ccfd8262361bae0d14b9544ba85766f82bd --- /dev/null +++ b/pybind11/include/pybind11/complex.h @@ -0,0 +1,77 @@ +/* + pybind11/complex.h: Complex number support + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include <complex> + +/// glibc defines I as a macro which breaks things, e.g., boost template names +#ifdef I +# undef I +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +template <typename T> +struct format_descriptor<std::complex<T>, detail::enable_if_t<std::is_floating_point<T>::value>> +{ + static constexpr const char c = format_descriptor<T>::c; + static constexpr const char value[3] = {'Z', c, '\0'}; + static std::string format() + { + return std::string(value); + } +}; + +#ifndef PYBIND11_CPP17 + +template <typename T> +constexpr const char + format_descriptor<std::complex<T>, detail::enable_if_t<std::is_floating_point<T>::value>>::value[3]; + +#endif + +NAMESPACE_BEGIN(detail) + +template <typename T> +struct is_fmt_numeric<std::complex<T>, detail::enable_if_t<std::is_floating_point<T>::value>> +{ + static constexpr bool value = true; + static constexpr int index = is_fmt_numeric<T>::index + 3; +}; + +template <typename T> +class type_caster<std::complex<T>> +{ +public: + bool load(handle src, bool convert) + { + if (!src) + return false; + if (!convert && !PyComplex_Check(src.ptr())) + return false; + Py_complex result = PyComplex_AsCComplex(src.ptr()); + if (result.real == -1.0 && PyErr_Occurred()) { + PyErr_Clear(); + return false; + } + value = std::complex<T>((T)result.real, (T)result.imag); + return true; + } + + static handle cast(const std::complex<T>& src, return_value_policy /* policy */, handle /* parent */) + { + return PyComplex_FromDoubles((double)src.real(), (double)src.imag()); + } + + PYBIND11_TYPE_CASTER(std::complex<T>, _("complex")); +}; +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/detail/class.h b/pybind11/include/pybind11/detail/class.h new file mode 100644 index 0000000000000000000000000000000000000000..c1005d5bce918990a3eda7f1302b2f9c633e908e --- /dev/null +++ b/pybind11/include/pybind11/detail/class.h @@ -0,0 +1,652 @@ +/* + pybind11/detail/class.h: Python C API implementation details for py::class_ + + Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "../attr.h" +#include "../options.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +#if PY_VERSION_HEX >= 0x03030000 +# define PYBIND11_BUILTIN_QUALNAME +# define PYBIND11_SET_OLDPY_QUALNAME(obj, nameobj) +#else +// In pre-3.3 Python, we still set __qualname__ so that we can produce reliable function type +// signatures; in 3.3+ this macro expands to nothing: +# define PYBIND11_SET_OLDPY_QUALNAME(obj, nameobj) setattr((PyObject*)obj, "__qualname__", nameobj) +#endif + +inline PyTypeObject* type_incref(PyTypeObject* type) +{ + Py_INCREF(type); + return type; +} + +#if !defined(PYPY_VERSION) + +/// `pybind11_static_property.__get__()`: Always pass the class instead of the instance. +extern "C" inline PyObject* pybind11_static_get(PyObject* self, PyObject* /*ob*/, PyObject* cls) +{ + return PyProperty_Type.tp_descr_get(self, cls, cls); +} + +/// `pybind11_static_property.__set__()`: Just like the above `__get__()`. +extern "C" inline int pybind11_static_set(PyObject* self, PyObject* obj, PyObject* value) +{ + PyObject* cls = PyType_Check(obj) ? obj : (PyObject*)Py_TYPE(obj); + return PyProperty_Type.tp_descr_set(self, cls, value); +} + +/** A `static_property` is the same as a `property` but the `__get__()` and `__set__()` + methods are modified to always use the object type instead of a concrete instance. + Return value: New reference. */ +inline PyTypeObject* make_static_property_type() +{ + constexpr auto* name = "pybind11_static_property"; + auto name_obj = reinterpret_steal<object>(PYBIND11_FROM_STRING(name)); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto heap_type = (PyHeapTypeObject*)PyType_Type.tp_alloc(&PyType_Type, 0); + if (!heap_type) + pybind11_fail("make_static_property_type(): error allocating type!"); + + heap_type->ht_name = name_obj.inc_ref().ptr(); +# ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = name_obj.inc_ref().ptr(); +# endif + + auto type = &heap_type->ht_type; + type->tp_name = name; + type->tp_base = type_incref(&PyProperty_Type); + type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; + type->tp_descr_get = pybind11_static_get; + type->tp_descr_set = pybind11_static_set; + + if (PyType_Ready(type) < 0) + pybind11_fail("make_static_property_type(): failure in PyType_Ready()!"); + + setattr((PyObject*)type, "__module__", str("pybind11_builtins")); + PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); + + return type; +} + +#else // PYPY + +/** PyPy has some issues with the above C API, so we evaluate Python code instead. + This function will only be called once so performance isn't really a concern. + Return value: New reference. */ +inline PyTypeObject* make_static_property_type() +{ + auto d = dict(); + PyObject* result = PyRun_String(R"(\ + class pybind11_static_property(property): + def __get__(self, obj, cls): + return property.__get__(self, cls, cls) + + def __set__(self, obj, value): + cls = obj if isinstance(obj, type) else type(obj) + property.__set__(self, cls, value) + )", + Py_file_input, + d.ptr(), + d.ptr()); + if (result == nullptr) + throw error_already_set(); + Py_DECREF(result); + return (PyTypeObject*)d["pybind11_static_property"].cast<object>().release().ptr(); +} + +#endif // PYPY + +/** Types with static properties need to handle `Type.static_prop = x` in a specific way. + By default, Python replaces the `static_property` itself, but for wrapped C++ types + we need to call `static_property.__set__()` in order to propagate the new value to + the underlying C++ data structure. */ +extern "C" inline int pybind11_meta_setattro(PyObject* obj, PyObject* name, PyObject* value) +{ + // Use `_PyType_Lookup()` instead of `PyObject_GetAttr()` in order to get the raw + // descriptor (`property`) instead of calling `tp_descr_get` (`property.__get__()`). + PyObject* descr = _PyType_Lookup((PyTypeObject*)obj, name); + + // The following assignment combinations are possible: + // 1. `Type.static_prop = value` --> descr_set: `Type.static_prop.__set__(value)` + // 2. `Type.static_prop = other_static_prop` --> setattro: replace existing `static_prop` + // 3. `Type.regular_attribute = value` --> setattro: regular attribute assignment + const auto static_prop = (PyObject*)get_internals().static_property_type; + const auto call_descr_set = + descr && PyObject_IsInstance(descr, static_prop) && !PyObject_IsInstance(value, static_prop); + if (call_descr_set) { + // Call `static_property.__set__()` instead of replacing the `static_property`. +#if !defined(PYPY_VERSION) + return Py_TYPE(descr)->tp_descr_set(descr, obj, value); +#else + if (PyObject* result = PyObject_CallMethod(descr, "__set__", "OO", obj, value)) { + Py_DECREF(result); + return 0; + } else { + return -1; + } +#endif + } else { + // Replace existing attribute. + return PyType_Type.tp_setattro(obj, name, value); + } +} + +#if PY_MAJOR_VERSION >= 3 +/** + * Python 3's PyInstanceMethod_Type hides itself via its tp_descr_get, which prevents aliasing + * methods via cls.attr("m2") = cls.attr("m1"): instead the tp_descr_get returns a plain function, + * when called on a class, or a PyMethod, when called on an instance. Override that behaviour here + * to do a special case bypass for PyInstanceMethod_Types. + */ +extern "C" inline PyObject* pybind11_meta_getattro(PyObject* obj, PyObject* name) +{ + PyObject* descr = _PyType_Lookup((PyTypeObject*)obj, name); + if (descr && PyInstanceMethod_Check(descr)) { + Py_INCREF(descr); + return descr; + } else { + return PyType_Type.tp_getattro(obj, name); + } +} +#endif + +/** This metaclass is assigned by default to all pybind11 types and is required in order + for static properties to function correctly. Users may override this using `py::metaclass`. + Return value: New reference. */ +inline PyTypeObject* make_default_metaclass() +{ + constexpr auto* name = "pybind11_type"; + auto name_obj = reinterpret_steal<object>(PYBIND11_FROM_STRING(name)); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto heap_type = (PyHeapTypeObject*)PyType_Type.tp_alloc(&PyType_Type, 0); + if (!heap_type) + pybind11_fail("make_default_metaclass(): error allocating metaclass!"); + + heap_type->ht_name = name_obj.inc_ref().ptr(); +#ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = name_obj.inc_ref().ptr(); +#endif + + auto type = &heap_type->ht_type; + type->tp_name = name; + type->tp_base = type_incref(&PyType_Type); + type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; + + type->tp_setattro = pybind11_meta_setattro; +#if PY_MAJOR_VERSION >= 3 + type->tp_getattro = pybind11_meta_getattro; +#endif + + if (PyType_Ready(type) < 0) + pybind11_fail("make_default_metaclass(): failure in PyType_Ready()!"); + + setattr((PyObject*)type, "__module__", str("pybind11_builtins")); + PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); + + return type; +} + +/// For multiple inheritance types we need to recursively register/deregister base pointers for any +/// base classes with pointers that are difference from the instance value pointer so that we can +/// correctly recognize an offset base class pointer. This calls a function with any offset base ptrs. +inline void traverse_offset_bases(void* valueptr, + const detail::type_info* tinfo, + instance* self, + bool (*f)(void* /*parentptr*/, instance* /*self*/)) +{ + for (handle h : reinterpret_borrow<tuple>(tinfo->type->tp_bases)) { + if (auto parent_tinfo = get_type_info((PyTypeObject*)h.ptr())) { + for (auto& c : parent_tinfo->implicit_casts) { + if (c.first == tinfo->cpptype) { + auto* parentptr = c.second(valueptr); + if (parentptr != valueptr) + f(parentptr, self); + traverse_offset_bases(parentptr, parent_tinfo, self, f); + break; + } + } + } + } +} + +inline bool register_instance_impl(void* ptr, instance* self) +{ + get_internals().registered_instances.emplace(ptr, self); + return true; // unused, but gives the same signature as the deregister func +} +inline bool deregister_instance_impl(void* ptr, instance* self) +{ + auto& registered_instances = get_internals().registered_instances; + auto range = registered_instances.equal_range(ptr); + for (auto it = range.first; it != range.second; ++it) { + if (Py_TYPE(self) == Py_TYPE(it->second)) { + registered_instances.erase(it); + return true; + } + } + return false; +} + +inline void register_instance(instance* self, void* valptr, const type_info* tinfo) +{ + register_instance_impl(valptr, self); + if (!tinfo->simple_ancestors) + traverse_offset_bases(valptr, tinfo, self, register_instance_impl); +} + +inline bool deregister_instance(instance* self, void* valptr, const type_info* tinfo) +{ + bool ret = deregister_instance_impl(valptr, self); + if (!tinfo->simple_ancestors) + traverse_offset_bases(valptr, tinfo, self, deregister_instance_impl); + return ret; +} + +/// Instance creation function for all pybind11 types. It allocates the internal instance layout for +/// holding C++ objects and holders. Allocation is done lazily (the first time the instance is cast +/// to a reference or pointer), and initialization is done by an `__init__` function. +inline PyObject* make_new_instance(PyTypeObject* type) +{ +#if defined(PYPY_VERSION) + // PyPy gets tp_basicsize wrong (issue 2482) under multiple inheritance when the first inherited + // object is a a plain Python type (i.e. not derived from an extension type). Fix it. + ssize_t instance_size = static_cast<ssize_t>(sizeof(instance)); + if (type->tp_basicsize < instance_size) { + type->tp_basicsize = instance_size; + } +#endif + PyObject* self = type->tp_alloc(type, 0); + auto inst = reinterpret_cast<instance*>(self); + // Allocate the value/holder internals: + inst->allocate_layout(); + + inst->owned = true; + + return self; +} + +/// Instance creation function for all pybind11 types. It only allocates space for the +/// C++ object, but doesn't call the constructor -- an `__init__` function must do that. +extern "C" inline PyObject* pybind11_object_new(PyTypeObject* type, PyObject*, PyObject*) +{ + return make_new_instance(type); +} + +/// An `__init__` function constructs the C++ object. Users should provide at least one +/// of these using `py::init` or directly with `.def(__init__, ...)`. Otherwise, the +/// following default function will be used which simply throws an exception. +extern "C" inline int pybind11_object_init(PyObject* self, PyObject*, PyObject*) +{ + PyTypeObject* type = Py_TYPE(self); + std::string msg; +#if defined(PYPY_VERSION) + msg += handle((PyObject*)type).attr("__module__").cast<std::string>() + "."; +#endif + msg += type->tp_name; + msg += ": No constructor defined!"; + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return -1; +} + +inline void add_patient(PyObject* nurse, PyObject* patient) +{ + auto& internals = get_internals(); + auto instance = reinterpret_cast<detail::instance*>(nurse); + instance->has_patients = true; + Py_INCREF(patient); + internals.patients[nurse].push_back(patient); +} + +inline void clear_patients(PyObject* self) +{ + auto instance = reinterpret_cast<detail::instance*>(self); + auto& internals = get_internals(); + auto pos = internals.patients.find(self); + assert(pos != internals.patients.end()); + // Clearing the patients can cause more Python code to run, which + // can invalidate the iterator. Extract the vector of patients + // from the unordered_map first. + auto patients = std::move(pos->second); + internals.patients.erase(pos); + instance->has_patients = false; + for (PyObject*& patient : patients) + Py_CLEAR(patient); +} + +/// Clears all internal data from the instance and removes it from registered instances in +/// preparation for deallocation. +inline void clear_instance(PyObject* self) +{ + auto instance = reinterpret_cast<detail::instance*>(self); + + // Deallocate any values/holders, if present: + for (auto& v_h : values_and_holders(instance)) { + if (v_h) { + + // We have to deregister before we call dealloc because, for virtual MI types, we still + // need to be able to get the parent pointers. + if (v_h.instance_registered() && !deregister_instance(instance, v_h.value_ptr(), v_h.type)) + pybind11_fail("pybind11_object_dealloc(): Tried to deallocate unregistered instance!"); + + if (instance->owned || v_h.holder_constructed()) + v_h.type->dealloc(v_h); + } + } + // Deallocate the value/holder layout internals: + instance->deallocate_layout(); + + if (instance->weakrefs) + PyObject_ClearWeakRefs(self); + + PyObject** dict_ptr = _PyObject_GetDictPtr(self); + if (dict_ptr) + Py_CLEAR(*dict_ptr); + + if (instance->has_patients) + clear_patients(self); +} + +/// Instance destructor function for all pybind11 types. It calls `type_info.dealloc` +/// to destroy the C++ object itself, while the rest is Python bookkeeping. +extern "C" inline void pybind11_object_dealloc(PyObject* self) +{ + clear_instance(self); + + auto type = Py_TYPE(self); + type->tp_free(self); + + // `type->tp_dealloc != pybind11_object_dealloc` means that we're being called + // as part of a derived type's dealloc, in which case we're not allowed to decref + // the type here. For cross-module compatibility, we shouldn't compare directly + // with `pybind11_object_dealloc`, but with the common one stashed in internals. + auto pybind11_object_type = (PyTypeObject*)get_internals().instance_base; + if (type->tp_dealloc == pybind11_object_type->tp_dealloc) + Py_DECREF(type); +} + +/** Create the type which can be used as a common base for all classes. This is + needed in order to satisfy Python's requirements for multiple inheritance. + Return value: New reference. */ +inline PyObject* make_object_base_type(PyTypeObject* metaclass) +{ + constexpr auto* name = "pybind11_object"; + auto name_obj = reinterpret_steal<object>(PYBIND11_FROM_STRING(name)); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto heap_type = (PyHeapTypeObject*)metaclass->tp_alloc(metaclass, 0); + if (!heap_type) + pybind11_fail("make_object_base_type(): error allocating type!"); + + heap_type->ht_name = name_obj.inc_ref().ptr(); +#ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = name_obj.inc_ref().ptr(); +#endif + + auto type = &heap_type->ht_type; + type->tp_name = name; + type->tp_base = type_incref(&PyBaseObject_Type); + type->tp_basicsize = static_cast<ssize_t>(sizeof(instance)); + type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; + + type->tp_new = pybind11_object_new; + type->tp_init = pybind11_object_init; + type->tp_dealloc = pybind11_object_dealloc; + + /* Support weak references (needed for the keep_alive feature) */ + type->tp_weaklistoffset = offsetof(instance, weakrefs); + + if (PyType_Ready(type) < 0) + pybind11_fail("PyType_Ready failed in make_object_base_type():" + error_string()); + + setattr((PyObject*)type, "__module__", str("pybind11_builtins")); + PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); + + assert(!PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC)); + return (PyObject*)heap_type; +} + +/// dynamic_attr: Support for `d = instance.__dict__`. +extern "C" inline PyObject* pybind11_get_dict(PyObject* self, void*) +{ + PyObject*& dict = *_PyObject_GetDictPtr(self); + if (!dict) + dict = PyDict_New(); + Py_XINCREF(dict); + return dict; +} + +/// dynamic_attr: Support for `instance.__dict__ = dict()`. +extern "C" inline int pybind11_set_dict(PyObject* self, PyObject* new_dict, void*) +{ + if (!PyDict_Check(new_dict)) { + PyErr_Format(PyExc_TypeError, "__dict__ must be set to a dictionary, not a '%.200s'", Py_TYPE(new_dict)->tp_name); + return -1; + } + PyObject*& dict = *_PyObject_GetDictPtr(self); + Py_INCREF(new_dict); + Py_CLEAR(dict); + dict = new_dict; + return 0; +} + +/// dynamic_attr: Allow the garbage collector to traverse the internal instance `__dict__`. +extern "C" inline int pybind11_traverse(PyObject* self, visitproc visit, void* arg) +{ + PyObject*& dict = *_PyObject_GetDictPtr(self); + Py_VISIT(dict); + return 0; +} + +/// dynamic_attr: Allow the GC to clear the dictionary. +extern "C" inline int pybind11_clear(PyObject* self) +{ + PyObject*& dict = *_PyObject_GetDictPtr(self); + Py_CLEAR(dict); + return 0; +} + +/// Give instances of this type a `__dict__` and opt into garbage collection. +inline void enable_dynamic_attributes(PyHeapTypeObject* heap_type) +{ + auto type = &heap_type->ht_type; +#if defined(PYPY_VERSION) + pybind11_fail(std::string(type->tp_name) + + ": dynamic attributes are " + "currently not supported in " + "conjunction with PyPy!"); +#endif + type->tp_flags |= Py_TPFLAGS_HAVE_GC; + type->tp_dictoffset = type->tp_basicsize; // place dict at the end + type->tp_basicsize += (ssize_t)sizeof(PyObject*); // and allocate enough space for it + type->tp_traverse = pybind11_traverse; + type->tp_clear = pybind11_clear; + + static PyGetSetDef getset[] = { + {const_cast<char*>("__dict__"), pybind11_get_dict, pybind11_set_dict, nullptr, nullptr}, + {nullptr, nullptr, nullptr, nullptr, nullptr}}; + type->tp_getset = getset; +} + +/// buffer_protocol: Fill in the view as specified by flags. +extern "C" inline int pybind11_getbuffer(PyObject* obj, Py_buffer* view, int flags) +{ + // Look for a `get_buffer` implementation in this type's info or any bases (following MRO). + type_info* tinfo = nullptr; + for (auto type : reinterpret_borrow<tuple>(Py_TYPE(obj)->tp_mro)) { + tinfo = get_type_info((PyTypeObject*)type.ptr()); + if (tinfo && tinfo->get_buffer) + break; + } + if (view == nullptr || !tinfo || !tinfo->get_buffer) { + if (view) + view->obj = nullptr; + PyErr_SetString(PyExc_BufferError, "pybind11_getbuffer(): Internal error"); + return -1; + } + std::memset(view, 0, sizeof(Py_buffer)); + buffer_info* info = tinfo->get_buffer(obj, tinfo->get_buffer_data); + view->obj = obj; + view->ndim = 1; + view->internal = info; + view->buf = info->ptr; + view->itemsize = info->itemsize; + view->len = view->itemsize; + for (auto s : info->shape) + view->len *= s; + if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT) + view->format = const_cast<char*>(info->format.c_str()); + if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES) { + view->ndim = (int)info->ndim; + view->strides = &info->strides[0]; + view->shape = &info->shape[0]; + } + Py_INCREF(view->obj); + return 0; +} + +/// buffer_protocol: Release the resources of the buffer. +extern "C" inline void pybind11_releasebuffer(PyObject*, Py_buffer* view) +{ + delete (buffer_info*)view->internal; +} + +/// Give this type a buffer interface. +inline void enable_buffer_protocol(PyHeapTypeObject* heap_type) +{ + heap_type->ht_type.tp_as_buffer = &heap_type->as_buffer; +#if PY_MAJOR_VERSION < 3 + heap_type->ht_type.tp_flags |= Py_TPFLAGS_HAVE_NEWBUFFER; +#endif + + heap_type->as_buffer.bf_getbuffer = pybind11_getbuffer; + heap_type->as_buffer.bf_releasebuffer = pybind11_releasebuffer; +} + +/** Create a brand new Python type according to the `type_record` specification. + Return value: New reference. */ +inline PyObject* make_new_python_type(const type_record& rec) +{ + auto name = reinterpret_steal<object>(PYBIND11_FROM_STRING(rec.name)); + + auto qualname = name; + if (rec.scope && !PyModule_Check(rec.scope.ptr()) && hasattr(rec.scope, "__qualname__")) { +#if PY_MAJOR_VERSION >= 3 + qualname = + reinterpret_steal<object>(PyUnicode_FromFormat("%U.%U", rec.scope.attr("__qualname__").ptr(), name.ptr())); +#else + qualname = str(rec.scope.attr("__qualname__").cast<std::string>() + "." + rec.name); +#endif + } + + object module; + if (rec.scope) { + if (hasattr(rec.scope, "__module__")) + module = rec.scope.attr("__module__"); + else if (hasattr(rec.scope, "__name__")) + module = rec.scope.attr("__name__"); + } + + auto full_name = c_str( +#if !defined(PYPY_VERSION) + module ? str(module).cast<std::string>() + "." + rec.name : +#endif + rec.name); + + char* tp_doc = nullptr; + if (rec.doc && options::show_user_defined_docstrings()) { + /* Allocate memory for docstring (using PyObject_MALLOC, since + Python will free this later on) */ + size_t size = strlen(rec.doc) + 1; + tp_doc = (char*)PyObject_MALLOC(size); + memcpy((void*)tp_doc, rec.doc, size); + } + + auto& internals = get_internals(); + auto bases = tuple(rec.bases); + auto base = (bases.size() == 0) ? internals.instance_base : bases[0].ptr(); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto metaclass = rec.metaclass.ptr() ? (PyTypeObject*)rec.metaclass.ptr() : internals.default_metaclass; + + auto heap_type = (PyHeapTypeObject*)metaclass->tp_alloc(metaclass, 0); + if (!heap_type) + pybind11_fail(std::string(rec.name) + ": Unable to create type object!"); + + heap_type->ht_name = name.release().ptr(); +#ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = qualname.inc_ref().ptr(); +#endif + + auto type = &heap_type->ht_type; + type->tp_name = full_name; + type->tp_doc = tp_doc; + type->tp_base = type_incref((PyTypeObject*)base); + type->tp_basicsize = static_cast<ssize_t>(sizeof(instance)); + if (bases.size() > 0) + type->tp_bases = bases.release().ptr(); + + /* Don't inherit base __init__ */ + type->tp_init = pybind11_object_init; + + /* Supported protocols */ + type->tp_as_number = &heap_type->as_number; + type->tp_as_sequence = &heap_type->as_sequence; + type->tp_as_mapping = &heap_type->as_mapping; + + /* Flags */ + type->tp_flags |= Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; +#if PY_MAJOR_VERSION < 3 + type->tp_flags |= Py_TPFLAGS_CHECKTYPES; +#endif + + if (rec.dynamic_attr) + enable_dynamic_attributes(heap_type); + + if (rec.buffer_protocol) + enable_buffer_protocol(heap_type); + + if (PyType_Ready(type) < 0) + pybind11_fail(std::string(rec.name) + ": PyType_Ready failed (" + error_string() + ")!"); + + assert(rec.dynamic_attr ? PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC) : !PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC)); + + /* Register type with the parent scope */ + if (rec.scope) + setattr(rec.scope, rec.name, (PyObject*)type); + else + Py_INCREF(type); // Keep it alive forever (reference leak) + + if (module) // Needed by pydoc + setattr((PyObject*)type, "__module__", module); + + PYBIND11_SET_OLDPY_QUALNAME(type, qualname); + + return (PyObject*)type; +} + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/detail/common.h b/pybind11/include/pybind11/detail/common.h new file mode 100644 index 0000000000000000000000000000000000000000..bf15f79e0e9b65844985a9ed03971da17f2ac79a --- /dev/null +++ b/pybind11/include/pybind11/detail/common.h @@ -0,0 +1,1044 @@ +/* + pybind11/detail/common.h -- Basic macros + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#if !defined(NAMESPACE_BEGIN) +# define NAMESPACE_BEGIN(name) namespace name { +#endif +#if !defined(NAMESPACE_END) +# define NAMESPACE_END(name) } +#endif + +// Robust support for some features and loading modules compiled against different pybind versions +// requires forcing hidden visibility on pybind code, so we enforce this by setting the attribute on +// the main `pybind11` namespace. +#if !defined(PYBIND11_NAMESPACE) +# ifdef __GNUG__ +# define PYBIND11_NAMESPACE pybind11 __attribute__((visibility("hidden"))) +# else +# define PYBIND11_NAMESPACE pybind11 +# endif +#endif + +#if !(defined(_MSC_VER) && __cplusplus == 199711L) && !defined(__INTEL_COMPILER) +# if __cplusplus >= 201402L +# define PYBIND11_CPP14 +# if __cplusplus >= 201703L +# define PYBIND11_CPP17 +# endif +# endif +#elif defined(_MSC_VER) && __cplusplus == 199711L +// MSVC sets _MSVC_LANG rather than __cplusplus (supposedly until the standard is fully implemented) +// Unless you use the /Zc:__cplusplus flag on Visual Studio 2017 15.7 Preview 3 or newer +# if _MSVC_LANG >= 201402L +# define PYBIND11_CPP14 +# if _MSVC_LANG > 201402L && _MSC_VER >= 1910 +# define PYBIND11_CPP17 +# endif +# endif +#endif + +// Compiler version assertions +#if defined(__INTEL_COMPILER) +# if __INTEL_COMPILER < 1700 +# error pybind11 requires Intel C++ compiler v17 or newer +# endif +#elif defined(__clang__) && !defined(__apple_build_version__) +# if __clang_major__ < 3 || (__clang_major__ == 3 && __clang_minor__ < 3) +# error pybind11 requires clang 3.3 or newer +# endif +#elif defined(__clang__) +// Apple changes clang version macros to its Xcode version; the first Xcode release based on +// (upstream) clang 3.3 was Xcode 5: +# if __clang_major__ < 5 +# error pybind11 requires Xcode/clang 5.0 or newer +# endif +#elif defined(__GNUG__) +# if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 8) +# error pybind11 requires gcc 4.8 or newer +# endif +#elif defined(_MSC_VER) +// Pybind hits various compiler bugs in 2015u2 and earlier, and also makes use of some stl features +// (e.g. std::negation) added in 2015u3: +# if _MSC_FULL_VER < 190024210 +# error pybind11 requires MSVC 2015 update 3 or newer +# endif +#endif + +#if !defined(PYBIND11_EXPORT) +# if defined(WIN32) || defined(_WIN32) +# define PYBIND11_EXPORT __declspec(dllexport) +# else +# define PYBIND11_EXPORT __attribute__((visibility("default"))) +# endif +#endif + +#if defined(_MSC_VER) +# define PYBIND11_NOINLINE __declspec(noinline) +#else +# define PYBIND11_NOINLINE __attribute__((noinline)) +#endif + +#if defined(PYBIND11_CPP14) +# define PYBIND11_DEPRECATED(reason) [[deprecated(reason)]] +#else +# define PYBIND11_DEPRECATED(reason) __attribute__((deprecated(reason))) +#endif + +#define PYBIND11_VERSION_MAJOR 2 +#define PYBIND11_VERSION_MINOR 3 +#define PYBIND11_VERSION_PATCH dev1 + +/// Include Python header, disable linking to pythonX_d.lib on Windows in debug mode +#if defined(_MSC_VER) +# if (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION < 4) +# define HAVE_ROUND 1 +# endif +# pragma warning(push) +# pragma warning(disable : 4510 4610 4512 4005) +# if defined(_DEBUG) +# define PYBIND11_DEBUG_MARKER +# undef _DEBUG +# endif +#endif + +#include <Python.h> +#include <frameobject.h> +#include <pythread.h> + +#if defined(_WIN32) && (defined(min) || defined(max)) +# error Macro clash with min and max -- define NOMINMAX when compiling your program on Windows +#endif + +#if defined(isalnum) +# undef isalnum +# undef isalpha +# undef islower +# undef isspace +# undef isupper +# undef tolower +# undef toupper +#endif + +#if defined(_MSC_VER) +# if defined(PYBIND11_DEBUG_MARKER) +# define _DEBUG +# undef PYBIND11_DEBUG_MARKER +# endif +# pragma warning(pop) +#endif + +#include <cstddef> +#include <cstring> +#include <forward_list> +#include <vector> +#include <string> +#include <stdexcept> +#include <unordered_set> +#include <unordered_map> +#include <memory> +#include <typeindex> +#include <type_traits> + +#if PY_MAJOR_VERSION >= 3 /// Compatibility macros for various Python versions +# define PYBIND11_INSTANCE_METHOD_NEW(ptr, class_) PyInstanceMethod_New(ptr) +# define PYBIND11_INSTANCE_METHOD_CHECK PyInstanceMethod_Check +# define PYBIND11_INSTANCE_METHOD_GET_FUNCTION PyInstanceMethod_GET_FUNCTION +# define PYBIND11_BYTES_CHECK PyBytes_Check +# define PYBIND11_BYTES_FROM_STRING PyBytes_FromString +# define PYBIND11_BYTES_FROM_STRING_AND_SIZE PyBytes_FromStringAndSize +# define PYBIND11_BYTES_AS_STRING_AND_SIZE PyBytes_AsStringAndSize +# define PYBIND11_BYTES_AS_STRING PyBytes_AsString +# define PYBIND11_BYTES_SIZE PyBytes_Size +# define PYBIND11_LONG_CHECK(o) PyLong_Check(o) +# define PYBIND11_LONG_AS_LONGLONG(o) PyLong_AsLongLong(o) +# define PYBIND11_LONG_FROM_SIGNED(o) PyLong_FromSsize_t((ssize_t)o) +# define PYBIND11_LONG_FROM_UNSIGNED(o) PyLong_FromSize_t((size_t)o) +# define PYBIND11_BYTES_NAME "bytes" +# define PYBIND11_STRING_NAME "str" +# define PYBIND11_SLICE_OBJECT PyObject +# define PYBIND11_FROM_STRING PyUnicode_FromString +# define PYBIND11_STR_TYPE ::pybind11::str +# define PYBIND11_BOOL_ATTR "__bool__" +# define PYBIND11_NB_BOOL(ptr) ((ptr)->nb_bool) +# define PYBIND11_PLUGIN_IMPL(name) extern "C" PYBIND11_EXPORT PyObject* PyInit_##name() + +#else +# define PYBIND11_INSTANCE_METHOD_NEW(ptr, class_) PyMethod_New(ptr, nullptr, class_) +# define PYBIND11_INSTANCE_METHOD_CHECK PyMethod_Check +# define PYBIND11_INSTANCE_METHOD_GET_FUNCTION PyMethod_GET_FUNCTION +# define PYBIND11_BYTES_CHECK PyString_Check +# define PYBIND11_BYTES_FROM_STRING PyString_FromString +# define PYBIND11_BYTES_FROM_STRING_AND_SIZE PyString_FromStringAndSize +# define PYBIND11_BYTES_AS_STRING_AND_SIZE PyString_AsStringAndSize +# define PYBIND11_BYTES_AS_STRING PyString_AsString +# define PYBIND11_BYTES_SIZE PyString_Size +# define PYBIND11_LONG_CHECK(o) (PyInt_Check(o) || PyLong_Check(o)) +# define PYBIND11_LONG_AS_LONGLONG(o) (PyInt_Check(o) ? (long long)PyLong_AsLong(o) : PyLong_AsLongLong(o)) +# define PYBIND11_LONG_FROM_SIGNED(o) PyInt_FromSsize_t((ssize_t)o) // Returns long if needed. +# define PYBIND11_LONG_FROM_UNSIGNED(o) PyInt_FromSize_t((size_t)o) // Returns long if needed. +# define PYBIND11_BYTES_NAME "str" +# define PYBIND11_STRING_NAME "unicode" +# define PYBIND11_SLICE_OBJECT PySliceObject +# define PYBIND11_FROM_STRING PyString_FromString +# define PYBIND11_STR_TYPE ::pybind11::bytes +# define PYBIND11_BOOL_ATTR "__nonzero__" +# define PYBIND11_NB_BOOL(ptr) ((ptr)->nb_nonzero) +# define PYBIND11_PLUGIN_IMPL(name) \ + static PyObject* pybind11_init_wrapper(); \ + extern "C" PYBIND11_EXPORT void init##name() \ + { \ + (void)pybind11_init_wrapper(); \ + } \ + PyObject* pybind11_init_wrapper() +#endif + +#if PY_VERSION_HEX >= 0x03050000 && PY_VERSION_HEX < 0x03050200 +extern "C" +{ + struct _Py_atomic_address + { + void* value; + }; + PyAPI_DATA(_Py_atomic_address) _PyThreadState_Current; +} +#endif + +#define PYBIND11_TRY_NEXT_OVERLOAD ((PyObject*)1) // special failure return code +#define PYBIND11_STRINGIFY(x) #x +#define PYBIND11_TOSTRING(x) PYBIND11_STRINGIFY(x) +#define PYBIND11_CONCAT(first, second) first##second + +#define PYBIND11_CHECK_PYTHON_VERSION \ + { \ + const char* compiled_ver = PYBIND11_TOSTRING(PY_MAJOR_VERSION) "." PYBIND11_TOSTRING(PY_MINOR_VERSION); \ + const char* runtime_ver = Py_GetVersion(); \ + size_t len = std::strlen(compiled_ver); \ + if (std::strncmp(runtime_ver, compiled_ver, len) != 0 || (runtime_ver[len] >= '0' && runtime_ver[len] <= '9')) { \ + PyErr_Format(PyExc_ImportError, \ + "Python version mismatch: module was compiled for Python %s, " \ + "but the interpreter version is incompatible: %s.", \ + compiled_ver, \ + runtime_ver); \ + return nullptr; \ + } \ + } + +#define PYBIND11_CATCH_INIT_EXCEPTIONS \ + catch (pybind11::error_already_set & e) \ + { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } \ + catch (const std::exception& e) \ + { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } + +/** \rst + ***Deprecated in favor of PYBIND11_MODULE*** + + This macro creates the entry point that will be invoked when the Python interpreter + imports a plugin library. Please create a `module` in the function body and return + the pointer to its underlying Python object at the end. + + .. code-block:: cpp + + PYBIND11_PLUGIN(example) { + pybind11::module m("example", "pybind11 example plugin"); + /// Set up bindings here + return m.ptr(); + } +\endrst */ +#define PYBIND11_PLUGIN(name) \ + PYBIND11_DEPRECATED("PYBIND11_PLUGIN is deprecated, use PYBIND11_MODULE") \ + static PyObject* pybind11_init(); \ + PYBIND11_PLUGIN_IMPL(name) \ + { \ + PYBIND11_CHECK_PYTHON_VERSION \ + try { \ + return pybind11_init(); \ + } \ + PYBIND11_CATCH_INIT_EXCEPTIONS \ + } \ + PyObject* pybind11_init() + +/** \rst + This macro creates the entry point that will be invoked when the Python interpreter + imports an extension module. The module name is given as the fist argument and it + should not be in quotes. The second macro argument defines a variable of type + `py::module` which can be used to initialize the module. + + .. code-block:: cpp + + PYBIND11_MODULE(example, m) { + m.doc() = "pybind11 example module"; + + // Add bindings here + m.def("foo", []() { + return "Hello, World!"; + }); + } +\endrst */ +#define PYBIND11_MODULE(name, variable) \ + static void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module&); \ + PYBIND11_PLUGIN_IMPL(name) \ + { \ + PYBIND11_CHECK_PYTHON_VERSION \ + auto m = pybind11::module(PYBIND11_TOSTRING(name)); \ + try { \ + PYBIND11_CONCAT(pybind11_init_, name)(m); \ + return m.ptr(); \ + } \ + PYBIND11_CATCH_INIT_EXCEPTIONS \ + } \ + void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module & variable) + + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +using ssize_t = Py_ssize_t; +using size_t = std::size_t; + +/// Approach used to cast a previously unknown C++ instance into a Python object +enum class return_value_policy : uint8_t +{ + /** This is the default return value policy, which falls back to the policy + return_value_policy::take_ownership when the return value is a pointer. + Otherwise, it uses return_value::move or return_value::copy for rvalue + and lvalue references, respectively. See below for a description of what + all of these different policies do. */ + automatic = 0, + + /** As above, but use policy return_value_policy::reference when the return + value is a pointer. This is the default conversion policy for function + arguments when calling Python functions manually from C++ code (i.e. via + handle::operator()). You probably won't need to use this. */ + automatic_reference, + + /** Reference an existing object (i.e. do not create a new copy) and take + ownership. Python will call the destructor and delete operator when the + object’s reference count reaches zero. Undefined behavior ensues when + the C++ side does the same.. */ + take_ownership, + + /** Create a new copy of the returned object, which will be owned by + Python. This policy is comparably safe because the lifetimes of the two + instances are decoupled. */ + copy, + + /** Use std::move to move the return value contents into a new instance + that will be owned by Python. This policy is comparably safe because the + lifetimes of the two instances (move source and destination) are + decoupled. */ + move, + + /** Reference an existing object, but do not take ownership. The C++ side + is responsible for managing the object’s lifetime and deallocating it + when it is no longer used. Warning: undefined behavior will ensue when + the C++ side deletes an object that is still referenced and used by + Python. */ + reference, + + /** This policy only applies to methods and properties. It references the + object without taking ownership similar to the above + return_value_policy::reference policy. In contrast to that policy, the + function or property’s implicit this argument (called the parent) is + considered to be the the owner of the return value (the child). + pybind11 then couples the lifetime of the parent to the child via a + reference relationship that ensures that the parent cannot be garbage + collected while Python is still using the child. More advanced + variations of this scheme are also possible using combinations of + return_value_policy::reference and the keep_alive call policy */ + reference_internal +}; + +NAMESPACE_BEGIN(detail) + +inline static constexpr int log2(size_t n, int k = 0) +{ + return (n <= 1) ? k : log2(n >> 1, k + 1); +} + +// Returns the size as a multiple of sizeof(void *), rounded up. +inline static constexpr size_t size_in_ptrs(size_t s) +{ + return 1 + ((s - 1) >> log2(sizeof(void*))); +} + +/** + * The space to allocate for simple layout instance holders (see below) in multiple of the size of + * a pointer (e.g. 2 means 16 bytes on 64-bit architectures). The default is the minimum required + * to holder either a std::unique_ptr or std::shared_ptr (which is almost always + * sizeof(std::shared_ptr<T>)). + */ +constexpr size_t instance_simple_holder_in_ptrs() +{ + static_assert(sizeof(std::shared_ptr<int>) >= sizeof(std::unique_ptr<int>), + "pybind assumes std::shared_ptrs are at least as big as std::unique_ptrs"); + return size_in_ptrs(sizeof(std::shared_ptr<int>)); +} + +// Forward declarations +struct type_info; +struct value_and_holder; + +struct nonsimple_values_and_holders +{ + void** values_and_holders; + uint8_t* status; +}; + +/// The 'instance' type which needs to be standard layout (need to be able to use 'offsetof') +struct instance +{ + PyObject_HEAD + /// Storage for pointers and holder; see simple_layout, below, for a description + union + { + void* simple_value_holder[1 + instance_simple_holder_in_ptrs()]; + nonsimple_values_and_holders nonsimple; + }; + /// Weak references + PyObject* weakrefs; + /// If true, the pointer is owned which means we're free to manage it with a holder. + bool owned : 1; + /** + * An instance has two possible value/holder layouts. + * + * Simple layout (when this flag is true), means the `simple_value_holder` is set with a pointer + * and the holder object governing that pointer, i.e. [val1*][holder]. This layout is applied + * whenever there is no python-side multiple inheritance of bound C++ types *and* the type's + * holder will fit in the default space (which is large enough to hold either a std::unique_ptr + * or std::shared_ptr). + * + * Non-simple layout applies when using custom holders that require more space than `shared_ptr` + * (which is typically the size of two pointers), or when multiple inheritance is used on the + * python side. Non-simple layout allocates the required amount of memory to have multiple + * bound C++ classes as parents. Under this layout, `nonsimple.values_and_holders` is set to a + * pointer to allocated space of the required space to hold a sequence of value pointers and + * holders followed `status`, a set of bit flags (1 byte each), i.e. + * [val1*][holder1][val2*][holder2]...[bb...] where each [block] is rounded up to a multiple of + * `sizeof(void *)`. `nonsimple.status` is, for convenience, a pointer to the + * beginning of the [bb...] block (but not independently allocated). + * + * Status bits indicate whether the associated holder is constructed (& + * status_holder_constructed) and whether the value pointer is registered (& + * status_instance_registered) in `registered_instances`. + */ + bool simple_layout : 1; + /// For simple layout, tracks whether the holder has been constructed + bool simple_holder_constructed : 1; + /// For simple layout, tracks whether the instance is registered in `registered_instances` + bool simple_instance_registered : 1; + /// If true, get_internals().patients has an entry for this object + bool has_patients : 1; + + /// Initializes all of the above type/values/holders data (but not the instance values themselves) + void allocate_layout(); + + /// Destroys/deallocates all of the above + void deallocate_layout(); + + /// Returns the value_and_holder wrapper for the given type (or the first, if `find_type` + /// omitted). Returns a default-constructed (with `.inst = nullptr`) object on failure if + /// `throw_if_missing` is false. + value_and_holder get_value_and_holder(const type_info* find_type = nullptr, bool throw_if_missing = true); + + /// Bit values for the non-simple status flags + static constexpr uint8_t status_holder_constructed = 1; + static constexpr uint8_t status_instance_registered = 2; +}; + +static_assert(std::is_standard_layout<instance>::value, + "Internal error: `pybind11::detail::instance` is not standard layout!"); + +/// from __cpp_future__ import (convenient aliases from C++14/17) +#if defined(PYBIND11_CPP14) && (!defined(_MSC_VER) || _MSC_VER >= 1910) +using std::conditional_t; +using std::enable_if_t; +using std::remove_cv_t; +using std::remove_reference_t; +#else +template <bool B, typename T = void> +using enable_if_t = typename std::enable_if<B, T>::type; +template <bool B, typename T, typename F> +using conditional_t = typename std::conditional<B, T, F>::type; +template <typename T> +using remove_cv_t = typename std::remove_cv<T>::type; +template <typename T> +using remove_reference_t = typename std::remove_reference<T>::type; +#endif + +/// Index sequences +#if defined(PYBIND11_CPP14) +using std::index_sequence; +using std::make_index_sequence; +#else +template <size_t...> +struct index_sequence +{}; +template <size_t N, size_t... S> +struct make_index_sequence_impl : make_index_sequence_impl<N - 1, N - 1, S...> +{}; +template <size_t... S> +struct make_index_sequence_impl<0, S...> +{ + typedef index_sequence<S...> type; +}; +template <size_t N> +using make_index_sequence = typename make_index_sequence_impl<N>::type; +#endif + +/// Make an index sequence of the indices of true arguments +template <typename ISeq, size_t, bool...> +struct select_indices_impl +{ + using type = ISeq; +}; +template <size_t... IPrev, size_t I, bool B, bool... Bs> +struct select_indices_impl<index_sequence<IPrev...>, I, B, Bs...> + : select_indices_impl<conditional_t<B, index_sequence<IPrev..., I>, index_sequence<IPrev...>>, I + 1, Bs...> +{}; +template <bool... Bs> +using select_indices = typename select_indices_impl<index_sequence<>, 0, Bs...>::type; + +/// Backports of std::bool_constant and std::negation to accommodate older compilers +template <bool B> +using bool_constant = std::integral_constant<bool, B>; +template <typename T> +struct negation : bool_constant<!T::value> +{}; + +template <typename...> +struct void_t_impl +{ + using type = void; +}; +template <typename... Ts> +using void_t = typename void_t_impl<Ts...>::type; + +/// Compile-time all/any/none of that check the boolean value of all template types +#if defined(__cpp_fold_expressions) && !(defined(_MSC_VER) && (_MSC_VER < 1916)) +template <class... Ts> +using all_of = bool_constant<(Ts::value && ...)>; +template <class... Ts> +using any_of = bool_constant<(Ts::value || ...)>; +#elif !defined(_MSC_VER) +template <bool...> +struct bools +{}; +template <class... Ts> +using all_of = std::is_same<bools<Ts::value..., true>, bools<true, Ts::value...>>; +template <class... Ts> +using any_of = negation<all_of<negation<Ts>...>>; +#else +// MSVC has trouble with the above, but supports std::conjunction, which we can use instead (albeit +// at a slight loss of compilation efficiency). +template <class... Ts> +using all_of = std::conjunction<Ts...>; +template <class... Ts> +using any_of = std::disjunction<Ts...>; +#endif +template <class... Ts> +using none_of = negation<any_of<Ts...>>; + +template <class T, template <class> class... Predicates> +using satisfies_all_of = all_of<Predicates<T>...>; +template <class T, template <class> class... Predicates> +using satisfies_any_of = any_of<Predicates<T>...>; +template <class T, template <class> class... Predicates> +using satisfies_none_of = none_of<Predicates<T>...>; + +/// Strip the class from a method type +template <typename T> +struct remove_class +{}; +template <typename C, typename R, typename... A> +struct remove_class<R (C::*)(A...)> +{ + typedef R type(A...); +}; +template <typename C, typename R, typename... A> +struct remove_class<R (C::*)(A...) const> +{ + typedef R type(A...); +}; + +/// Helper template to strip away type modifiers +template <typename T> +struct intrinsic_type +{ + typedef T type; +}; +template <typename T> +struct intrinsic_type<const T> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T> +struct intrinsic_type<T*> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T> +struct intrinsic_type<T&> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T> +struct intrinsic_type<T&&> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T, size_t N> +struct intrinsic_type<const T[N]> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T, size_t N> +struct intrinsic_type<T[N]> +{ + typedef typename intrinsic_type<T>::type type; +}; +template <typename T> +using intrinsic_t = typename intrinsic_type<T>::type; + +/// Helper type to replace 'void' in some expressions +struct void_type +{}; + +/// Helper template which holds a list of types +template <typename...> +struct type_list +{}; + +/// Compile-time integer sum +#ifdef __cpp_fold_expressions +template <typename... Ts> +constexpr size_t constexpr_sum(Ts... ns) +{ + return (0 + ... + size_t{ns}); +} +#else +constexpr size_t constexpr_sum() +{ + return 0; +} +template <typename T, typename... Ts> +constexpr size_t constexpr_sum(T n, Ts... ns) +{ + return size_t{n} + constexpr_sum(ns...); +} +#endif + +NAMESPACE_BEGIN(constexpr_impl) +/// Implementation details for constexpr functions +constexpr int first(int i) +{ + return i; +} +template <typename T, typename... Ts> +constexpr int first(int i, T v, Ts... vs) +{ + return v ? i : first(i + 1, vs...); +} + +constexpr int last(int /*i*/, int result) +{ + return result; +} +template <typename T, typename... Ts> +constexpr int last(int i, int result, T v, Ts... vs) +{ + return last(i + 1, v ? i : result, vs...); +} +NAMESPACE_END(constexpr_impl) + +/// Return the index of the first type in Ts which satisfies Predicate<T>. Returns sizeof...(Ts) if +/// none match. +template <template <typename> class Predicate, typename... Ts> +constexpr int constexpr_first() +{ + return constexpr_impl::first(0, Predicate<Ts>::value...); +} + +/// Return the index of the last type in Ts which satisfies Predicate<T>, or -1 if none match. +template <template <typename> class Predicate, typename... Ts> +constexpr int constexpr_last() +{ + return constexpr_impl::last(0, -1, Predicate<Ts>::value...); +} + +/// Return the Nth element from the parameter pack +template <size_t N, typename T, typename... Ts> +struct pack_element +{ + using type = typename pack_element<N - 1, Ts...>::type; +}; +template <typename T, typename... Ts> +struct pack_element<0, T, Ts...> +{ + using type = T; +}; + +/// Return the one and only type which matches the predicate, or Default if none match. +/// If more than one type matches the predicate, fail at compile-time. +template <template <typename> class Predicate, typename Default, typename... Ts> +struct exactly_one +{ + static constexpr auto found = constexpr_sum(Predicate<Ts>::value...); + static_assert(found <= 1, "Found more than one type matching the predicate"); + + static constexpr auto index = found ? constexpr_first<Predicate, Ts...>() : 0; + using type = conditional_t<found, typename pack_element<index, Ts...>::type, Default>; +}; +template <template <typename> class P, typename Default> +struct exactly_one<P, Default> +{ + using type = Default; +}; + +template <template <typename> class Predicate, typename Default, typename... Ts> +using exactly_one_t = typename exactly_one<Predicate, Default, Ts...>::type; + +/// Defer the evaluation of type T until types Us are instantiated +template <typename T, typename... /*Us*/> +struct deferred_type +{ + using type = T; +}; +template <typename T, typename... Us> +using deferred_t = typename deferred_type<T, Us...>::type; + +/// Like is_base_of, but requires a strict base (i.e. `is_strict_base_of<T, T>::value == false`, +/// unlike `std::is_base_of`) +template <typename Base, typename Derived> +using is_strict_base_of = bool_constant<std::is_base_of<Base, Derived>::value && !std::is_same<Base, Derived>::value>; + +/// Like is_base_of, but also requires that the base type is accessible (i.e. that a Derived pointer +/// can be converted to a Base pointer) +template <typename Base, typename Derived> +using is_accessible_base_of = + bool_constant<std::is_base_of<Base, Derived>::value && std::is_convertible<Derived*, Base*>::value>; + +template <template <typename...> class Base> +struct is_template_base_of_impl +{ + template <typename... Us> + static std::true_type check(Base<Us...>*); + static std::false_type check(...); +}; + +/// Check if a template is the base of a type. For example: +/// `is_template_base_of<Base, T>` is true if `struct T : Base<U> {}` where U can be anything +template <template <typename...> class Base, typename T> +#if !defined(_MSC_VER) +using is_template_base_of = decltype(is_template_base_of_impl<Base>::check((intrinsic_t<T>*)nullptr)); +#else // MSVC2015 has trouble with decltype in template aliases +struct is_template_base_of : decltype(is_template_base_of_impl<Base>::check((intrinsic_t<T>*)nullptr)) +{}; +#endif + +/// Check if T is an instantiation of the template `Class`. For example: +/// `is_instantiation<shared_ptr, T>` is true if `T == shared_ptr<U>` where U can be anything. +template <template <typename...> class Class, typename T> +struct is_instantiation : std::false_type +{}; +template <template <typename...> class Class, typename... Us> +struct is_instantiation<Class, Class<Us...>> : std::true_type +{}; + +/// Check if T is std::shared_ptr<U> where U can be anything +template <typename T> +using is_shared_ptr = is_instantiation<std::shared_ptr, T>; + +/// Check if T looks like an input iterator +template <typename T, typename = void> +struct is_input_iterator : std::false_type +{}; +template <typename T> +struct is_input_iterator<T, void_t<decltype(*std::declval<T&>()), decltype(++std::declval<T&>())>> : std::true_type +{}; + +template <typename T> +using is_function_pointer = + bool_constant<std::is_pointer<T>::value && std::is_function<typename std::remove_pointer<T>::type>::value>; + +template <typename F> +struct strip_function_object +{ + using type = typename remove_class<decltype(&F::operator())>::type; +}; + +// Extracts the function signature from a function, function pointer or lambda. +template <typename Function, typename F = remove_reference_t<Function>> +using function_signature_t = + conditional_t<std::is_function<F>::value, + F, + typename conditional_t<std::is_pointer<F>::value || std::is_member_pointer<F>::value, + std::remove_pointer<F>, + strip_function_object<F>>::type>; + +/// Returns true if the type looks like a lambda: that is, isn't a function, pointer or member +/// pointer. Note that this can catch all sorts of other things, too; this is intended to be used +/// in a place where passing a lambda makes sense. +template <typename T> +using is_lambda = satisfies_none_of<remove_reference_t<T>, std::is_function, std::is_pointer, std::is_member_pointer>; + +/// Ignore that a variable is unused in compiler warnings +inline void ignore_unused(const int*) {} + +/// Apply a function over each element of a parameter pack +#ifdef __cpp_fold_expressions +# define PYBIND11_EXPAND_SIDE_EFFECTS(PATTERN) (((PATTERN), void()), ...) +#else +using expand_side_effects = bool[]; +# define PYBIND11_EXPAND_SIDE_EFFECTS(PATTERN) \ + pybind11::detail::expand_side_effects \ + { \ + ((PATTERN), void(), false)..., false \ + } +#endif + +NAMESPACE_END(detail) + +/// C++ bindings of builtin Python exceptions +class builtin_exception : public std::runtime_error +{ +public: + using std::runtime_error::runtime_error; + /// Set the error using the Python C API + virtual void set_error() const = 0; +}; + +#define PYBIND11_RUNTIME_EXCEPTION(name, type) \ + class name : public builtin_exception \ + { \ + public: \ + using builtin_exception::builtin_exception; \ + name() \ + : name("") \ + {} \ + void set_error() const override \ + { \ + PyErr_SetString(type, what()); \ + } \ + }; + +PYBIND11_RUNTIME_EXCEPTION(stop_iteration, PyExc_StopIteration) +PYBIND11_RUNTIME_EXCEPTION(index_error, PyExc_IndexError) +PYBIND11_RUNTIME_EXCEPTION(key_error, PyExc_KeyError) +PYBIND11_RUNTIME_EXCEPTION(value_error, PyExc_ValueError) +PYBIND11_RUNTIME_EXCEPTION(type_error, PyExc_TypeError) +PYBIND11_RUNTIME_EXCEPTION(cast_error, PyExc_RuntimeError) /// Thrown when pybind11::cast or handle::call fail due to a + /// type casting error +PYBIND11_RUNTIME_EXCEPTION(reference_cast_error, PyExc_RuntimeError) /// Used internally + +[[noreturn]] PYBIND11_NOINLINE inline void pybind11_fail(const char* reason) +{ + throw std::runtime_error(reason); +} +[[noreturn]] PYBIND11_NOINLINE inline void pybind11_fail(const std::string& reason) +{ + throw std::runtime_error(reason); +} + +template <typename T, typename SFINAE = void> +struct format_descriptor +{}; + +NAMESPACE_BEGIN(detail) +// Returns the index of the given type in the type char array below, and in the list in numpy.h +// The order here is: bool; 8 ints ((signed,unsigned)x(8,16,32,64)bits); float,double,long double; +// complex float,double,long double. Note that the long double types only participate when long +// double is actually longer than double (it isn't under MSVC). +// NB: not only the string below but also complex.h and numpy.h rely on this order. +template <typename T, typename SFINAE = void> +struct is_fmt_numeric +{ + static constexpr bool value = false; +}; +template <typename T> +struct is_fmt_numeric<T, enable_if_t<std::is_arithmetic<T>::value>> +{ + static constexpr bool value = true; + static constexpr int index = + std::is_same<T, bool>::value + ? 0 + : 1 + + (std::is_integral<T>::value + ? detail::log2(sizeof(T)) * 2 + std::is_unsigned<T>::value + : 8 + (std::is_same<T, double>::value ? 1 : std::is_same<T, long double>::value ? 2 : 0)); +}; +NAMESPACE_END(detail) + +template <typename T> +struct format_descriptor<T, detail::enable_if_t<std::is_arithmetic<T>::value>> +{ + static constexpr const char c = "?bBhHiIqQfdg"[detail::is_fmt_numeric<T>::index]; + static constexpr const char value[2] = {c, '\0'}; + static std::string format() + { + return std::string(1, c); + } +}; + +#if !defined(PYBIND11_CPP17) + +template <typename T> +constexpr const char format_descriptor<T, detail::enable_if_t<std::is_arithmetic<T>::value>>::value[2]; + +#endif + +/// RAII wrapper that temporarily clears any Python error state +struct error_scope +{ + PyObject *type, *value, *trace; + error_scope() + { + PyErr_Fetch(&type, &value, &trace); + } + ~error_scope() + { + PyErr_Restore(type, value, trace); + } +}; + +/// Dummy destructor wrapper that can be used to expose classes with a private destructor +struct nodelete +{ + template <typename T> + void operator()(T*) + {} +}; + +// overload_cast requires variable templates: C++14 +#if defined(PYBIND11_CPP14) +# define PYBIND11_OVERLOAD_CAST 1 + +NAMESPACE_BEGIN(detail) +template <typename... Args> +struct overload_cast_impl +{ + constexpr overload_cast_impl() {} // MSVC 2015 needs this + + template <typename Return> + constexpr auto operator()(Return (*pf)(Args...)) const noexcept -> decltype(pf) + { + return pf; + } + + template <typename Return, typename Class> + constexpr auto operator()(Return (Class::*pmf)(Args...), std::false_type = {}) const noexcept -> decltype(pmf) + { + return pmf; + } + + template <typename Return, typename Class> + constexpr auto operator()(Return (Class::*pmf)(Args...) const, std::true_type) const noexcept -> decltype(pmf) + { + return pmf; + } +}; +NAMESPACE_END(detail) + +/// Syntax sugar for resolving overloaded function pointers: +/// - regular: static_cast<Return (Class::*)(Arg0, Arg1, Arg2)>(&Class::func) +/// - sweet: overload_cast<Arg0, Arg1, Arg2>(&Class::func) +template <typename... Args> +static constexpr detail::overload_cast_impl<Args...> overload_cast = {}; +// MSVC 2015 only accepts this particular initialization syntax for this variable template. + +/// Const member function selector for overload_cast +/// - regular: static_cast<Return (Class::*)(Arg) const>(&Class::func) +/// - sweet: overload_cast<Arg>(&Class::func, const_) +static constexpr auto const_ = std::true_type{}; + +#else // no overload_cast: providing something that static_assert-fails: +template <typename... Args> +struct overload_cast +{ + static_assert(detail::deferred_t<std::false_type, Args...>::value, + "pybind11::overload_cast<...> requires compiling in C++14 mode"); +}; +#endif // overload_cast + +NAMESPACE_BEGIN(detail) + +// Adaptor for converting arbitrary container arguments into a vector; implicitly convertible from +// any standard container (or C-style array) supporting std::begin/std::end, any singleton +// arithmetic type (if T is arithmetic), or explicitly constructible from an iterator pair. +template <typename T> +class any_container +{ + std::vector<T> v; + +public: + any_container() = default; + + // Can construct from a pair of iterators + template <typename It, typename = enable_if_t<is_input_iterator<It>::value>> + any_container(It first, It last) + : v(first, last) + {} + + // Implicit conversion constructor from any arbitrary container type with values convertible to T + template < + typename Container, + typename = enable_if_t<std::is_convertible<decltype(*std::begin(std::declval<const Container&>())), T>::value>> + any_container(const Container& c) + : any_container(std::begin(c), std::end(c)) + {} + + // initializer_list's aren't deducible, so don't get matched by the above template; we need this + // to explicitly allow implicit conversion from one: + template <typename TIn, typename = enable_if_t<std::is_convertible<TIn, T>::value>> + any_container(const std::initializer_list<TIn>& c) + : any_container(c.begin(), c.end()) + {} + + // Avoid copying if given an rvalue vector of the correct type. + any_container(std::vector<T>&& v) + : v(std::move(v)) + {} + + // Moves the vector out of an rvalue any_container + operator std::vector<T> &&() && + { + return std::move(v); + } + + // Dereferencing obtains a reference to the underlying vector + std::vector<T>& operator*() + { + return v; + } + const std::vector<T>& operator*() const + { + return v; + } + + // -> lets you call methods on the underlying vector + std::vector<T>* operator->() + { + return &v; + } + const std::vector<T>* operator->() const + { + return &v; + } +}; + +NAMESPACE_END(detail) + + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/detail/descr.h b/pybind11/include/pybind11/detail/descr.h new file mode 100644 index 0000000000000000000000000000000000000000..630e937a23363366f0e989470d291e220611ddee --- /dev/null +++ b/pybind11/include/pybind11/detail/descr.h @@ -0,0 +1,144 @@ +/* + pybind11/detail/descr.h: Helper type for concatenating type signatures at compile time + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "common.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +#if !defined(_MSC_VER) +# define PYBIND11_DESCR_CONSTEXPR static constexpr +#else +# define PYBIND11_DESCR_CONSTEXPR const +#endif + +/* Concatenate type signatures at compile time */ +template <size_t N, typename... Ts> +struct descr +{ + char text[N + 1]; + + constexpr descr() + : text{'\0'} + {} + constexpr descr(char const (&s)[N + 1]) + : descr(s, make_index_sequence<N>()) + {} + + template <size_t... Is> + constexpr descr(char const (&s)[N + 1], index_sequence<Is...>) + : text{s[Is]..., '\0'} + {} + + template <typename... Chars> + constexpr descr(char c, Chars... cs) + : text{c, static_cast<char>(cs)..., '\0'} + {} + + static constexpr std::array<const std::type_info*, sizeof...(Ts) + 1> types() + { + return {{&typeid(Ts)..., nullptr}}; + } +}; + +template <size_t N1, size_t N2, typename... Ts1, typename... Ts2, size_t... Is1, size_t... Is2> +constexpr descr<N1 + N2, Ts1..., Ts2...> +plus_impl(const descr<N1, Ts1...>& a, const descr<N2, Ts2...>& b, index_sequence<Is1...>, index_sequence<Is2...>) +{ + return {a.text[Is1]..., b.text[Is2]...}; +} + +template <size_t N1, size_t N2, typename... Ts1, typename... Ts2> +constexpr descr<N1 + N2, Ts1..., Ts2...> operator+(const descr<N1, Ts1...>& a, const descr<N2, Ts2...>& b) +{ + return plus_impl(a, b, make_index_sequence<N1>(), make_index_sequence<N2>()); +} + +template <size_t N> +constexpr descr<N - 1> _(char const (&text)[N]) +{ + return descr<N - 1>(text); +} +constexpr descr<0> _(char const (&)[1]) +{ + return {}; +} + +template <size_t Rem, size_t... Digits> +struct int_to_str : int_to_str<Rem / 10, Rem % 10, Digits...> +{}; +template <size_t... Digits> +struct int_to_str<0, Digits...> +{ + static constexpr auto digits = descr<sizeof...(Digits)>(('0' + Digits)...); +}; + +// Ternary description (like std::conditional) +template <bool B, size_t N1, size_t N2> +constexpr enable_if_t<B, descr<N1 - 1>> _(char const (&text1)[N1], char const (&)[N2]) +{ + return _(text1); +} +template <bool B, size_t N1, size_t N2> +constexpr enable_if_t<!B, descr<N2 - 1>> _(char const (&)[N1], char const (&text2)[N2]) +{ + return _(text2); +} + +template <bool B, typename T1, typename T2> +constexpr enable_if_t<B, T1> _(const T1& d, const T2&) +{ + return d; +} +template <bool B, typename T1, typename T2> +constexpr enable_if_t<!B, T2> _(const T1&, const T2& d) +{ + return d; +} + +template <size_t Size> +auto constexpr _() -> decltype(int_to_str<Size / 10, Size % 10>::digits) +{ + return int_to_str<Size / 10, Size % 10>::digits; +} + +template <typename Type> +constexpr descr<1, Type> _() +{ + return {'%'}; +} + +constexpr descr<0> concat() +{ + return {}; +} + +template <size_t N, typename... Ts> +constexpr descr<N, Ts...> concat(const descr<N, Ts...>& descr) +{ + return descr; +} + +template <size_t N, typename... Ts, typename... Args> +constexpr auto concat(const descr<N, Ts...>& d, const Args&... args) + -> decltype(std::declval<descr<N + 2, Ts...>>() + concat(args...)) +{ + return d + _(", ") + concat(args...); +} + +template <size_t N, typename... Ts> +constexpr descr<N + 2, Ts...> type_descr(const descr<N, Ts...>& descr) +{ + return _("{") + descr + _("}"); +} + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/detail/init.h b/pybind11/include/pybind11/detail/init.h new file mode 100644 index 0000000000000000000000000000000000000000..398e8fd42d0e23d67563f1c447f8b4ed17480bea --- /dev/null +++ b/pybind11/include/pybind11/detail/init.h @@ -0,0 +1,406 @@ +/* + pybind11/detail/init.h: init factory function implementation and support code. + + Copyright (c) 2017 Jason Rhinelander <jason@imaginary.ca> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "class.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +template <> +class type_caster<value_and_holder> +{ +public: + bool load(handle h, bool) + { + value = reinterpret_cast<value_and_holder*>(h.ptr()); + return true; + } + + template <typename> + using cast_op_type = value_and_holder&; + operator value_and_holder&() + { + return *value; + } + static constexpr auto name = _<value_and_holder>(); + +private: + value_and_holder* value = nullptr; +}; + +NAMESPACE_BEGIN(initimpl) + +inline void no_nullptr(void* ptr) +{ + if (!ptr) + throw type_error("pybind11::init(): factory function returned nullptr"); +} + +// Implementing functions for all forms of py::init<...> and py::init(...) +template <typename Class> +using Cpp = typename Class::type; +template <typename Class> +using Alias = typename Class::type_alias; +template <typename Class> +using Holder = typename Class::holder_type; + +template <typename Class> +using is_alias_constructible = std::is_constructible<Alias<Class>, Cpp<Class>&&>; + +// Takes a Cpp pointer and returns true if it actually is a polymorphic Alias instance. +template <typename Class, enable_if_t<Class::has_alias, int> = 0> +bool is_alias(Cpp<Class>* ptr) +{ + return dynamic_cast<Alias<Class>*>(ptr) != nullptr; +} +// Failing fallback version of the above for a no-alias class (always returns false) +template <typename /*Class*/> +constexpr bool is_alias(void*) +{ + return false; +} + +// Constructs and returns a new object; if the given arguments don't map to a constructor, we fall +// back to brace aggregate initiailization so that for aggregate initialization can be used with +// py::init, e.g. `py::init<int, int>` to initialize a `struct T { int a; int b; }`. For +// non-aggregate types, we need to use an ordinary T(...) constructor (invoking as `T{...}` usually +// works, but will not do the expected thing when `T` has an `initializer_list<T>` constructor). +template <typename Class, typename... Args, detail::enable_if_t<std::is_constructible<Class, Args...>::value, int> = 0> +inline Class* construct_or_initialize(Args&&... args) +{ + return new Class(std::forward<Args>(args)...); +} +template <typename Class, typename... Args, detail::enable_if_t<!std::is_constructible<Class, Args...>::value, int> = 0> +inline Class* construct_or_initialize(Args&&... args) +{ + return new Class{std::forward<Args>(args)...}; +} + +// Attempts to constructs an alias using a `Alias(Cpp &&)` constructor. This allows types with +// an alias to provide only a single Cpp factory function as long as the Alias can be +// constructed from an rvalue reference of the base Cpp type. This means that Alias classes +// can, when appropriate, simply define a `Alias(Cpp &&)` constructor rather than needing to +// inherit all the base class constructors. +template <typename Class> +void construct_alias_from_cpp(std::true_type /*is_alias_constructible*/, value_and_holder& v_h, Cpp<Class>&& base) +{ + v_h.value_ptr() = new Alias<Class>(std::move(base)); +} +template <typename Class> +[[noreturn]] void +construct_alias_from_cpp(std::false_type /*!is_alias_constructible*/, value_and_holder&, Cpp<Class>&&) { + throw type_error("pybind11::init(): unable to convert returned instance to required " + "alias class: no `Alias<Class>(Class &&)` constructor available"); +} + +// Error-generating fallback for factories that don't match one of the below construction +// mechanisms. +template <typename Class> +void construct(...) +{ + static_assert(!std::is_same<Class, Class>::value /* always false */, + "pybind11::init(): init function must return a compatible pointer, " + "holder, or value"); +} + +// Pointer return v1: the factory function returns a class pointer for a registered class. +// If we don't need an alias (because this class doesn't have one, or because the final type is +// inherited on the Python side) we can simply take over ownership. Otherwise we need to try to +// construct an Alias from the returned base instance. +template <typename Class> +void construct(value_and_holder& v_h, Cpp<Class>* ptr, bool need_alias) +{ + no_nullptr(ptr); + if (Class::has_alias && need_alias && !is_alias<Class>(ptr)) { + // We're going to try to construct an alias by moving the cpp type. Whether or not + // that succeeds, we still need to destroy the original cpp pointer (either the + // moved away leftover, if the alias construction works, or the value itself if we + // throw an error), but we can't just call `delete ptr`: it might have a special + // deleter, or might be shared_from_this. So we construct a holder around it as if + // it was a normal instance, then steal the holder away into a local variable; thus + // the holder and destruction happens when we leave the C++ scope, and the holder + // class gets to handle the destruction however it likes. + v_h.value_ptr() = ptr; + v_h.set_instance_registered(true); // To prevent init_instance from registering it + v_h.type->init_instance(v_h.inst, nullptr); // Set up the holder + Holder<Class> temp_holder(std::move(v_h.holder<Holder<Class>>())); // Steal the holder + v_h.type->dealloc(v_h); // Destroys the moved-out holder remains, resets value ptr to null + v_h.set_instance_registered(false); + + construct_alias_from_cpp<Class>(is_alias_constructible<Class>{}, v_h, std::move(*ptr)); + } else { + // Otherwise the type isn't inherited, so we don't need an Alias + v_h.value_ptr() = ptr; + } +} + +// Pointer return v2: a factory that always returns an alias instance ptr. We simply take over +// ownership of the pointer. +template <typename Class, enable_if_t<Class::has_alias, int> = 0> +void construct(value_and_holder& v_h, Alias<Class>* alias_ptr, bool) +{ + no_nullptr(alias_ptr); + v_h.value_ptr() = static_cast<Cpp<Class>*>(alias_ptr); +} + +// Holder return: copy its pointer, and move or copy the returned holder into the new instance's +// holder. This also handles types like std::shared_ptr<T> and std::unique_ptr<T> where T is a +// derived type (through those holder's implicit conversion from derived class holder constructors). +template <typename Class> +void construct(value_and_holder& v_h, Holder<Class> holder, bool need_alias) +{ + auto* ptr = holder_helper<Holder<Class>>::get(holder); + // If we need an alias, check that the held pointer is actually an alias instance + if (Class::has_alias && need_alias && !is_alias<Class>(ptr)) + throw type_error("pybind11::init(): construction failed: returned holder-wrapped instance " + "is not an alias instance"); + + v_h.value_ptr() = ptr; + v_h.type->init_instance(v_h.inst, &holder); +} + +// return-by-value version 1: returning a cpp class by value. If the class has an alias and an +// alias is required the alias must have an `Alias(Cpp &&)` constructor so that we can construct +// the alias from the base when needed (i.e. because of Python-side inheritance). When we don't +// need it, we simply move-construct the cpp value into a new instance. +template <typename Class> +void construct(value_and_holder& v_h, Cpp<Class>&& result, bool need_alias) +{ + static_assert(std::is_move_constructible<Cpp<Class>>::value, + "pybind11::init() return-by-value factory function requires a movable class"); + if (Class::has_alias && need_alias) + construct_alias_from_cpp<Class>(is_alias_constructible<Class>{}, v_h, std::move(result)); + else + v_h.value_ptr() = new Cpp<Class>(std::move(result)); +} + +// return-by-value version 2: returning a value of the alias type itself. We move-construct an +// Alias instance (even if no the python-side inheritance is involved). The is intended for +// cases where Alias initialization is always desired. +template <typename Class> +void construct(value_and_holder& v_h, Alias<Class>&& result, bool) +{ + static_assert(std::is_move_constructible<Alias<Class>>::value, + "pybind11::init() return-by-alias-value factory function requires a movable alias class"); + v_h.value_ptr() = new Alias<Class>(std::move(result)); +} + +// Implementing class for py::init<...>() +template <typename... Args> +struct constructor +{ + template <typename Class, typename... Extra, enable_if_t<!Class::has_alias, int> = 0> + static void execute(Class& cl, const Extra&... extra) + { + cl.def("__init__", + [](value_and_holder& v_h, Args... args) { + v_h.value_ptr() = construct_or_initialize<Cpp<Class>>(std::forward<Args>(args)...); + }, + is_new_style_constructor(), + extra...); + } + + template <typename Class, + typename... Extra, + enable_if_t<Class::has_alias && std::is_constructible<Cpp<Class>, Args...>::value, int> = 0> + static void execute(Class& cl, const Extra&... extra) + { + cl.def("__init__", + [](value_and_holder& v_h, Args... args) { + if (Py_TYPE(v_h.inst) == v_h.type->type) + v_h.value_ptr() = construct_or_initialize<Cpp<Class>>(std::forward<Args>(args)...); + else + v_h.value_ptr() = construct_or_initialize<Alias<Class>>(std::forward<Args>(args)...); + }, + is_new_style_constructor(), + extra...); + } + + template <typename Class, + typename... Extra, + enable_if_t<Class::has_alias && !std::is_constructible<Cpp<Class>, Args...>::value, int> = 0> + static void execute(Class& cl, const Extra&... extra) + { + cl.def("__init__", + [](value_and_holder& v_h, Args... args) { + v_h.value_ptr() = construct_or_initialize<Alias<Class>>(std::forward<Args>(args)...); + }, + is_new_style_constructor(), + extra...); + } +}; + +// Implementing class for py::init_alias<...>() +template <typename... Args> +struct alias_constructor +{ + template <typename Class, + typename... Extra, + enable_if_t<Class::has_alias && std::is_constructible<Alias<Class>, Args...>::value, int> = 0> + static void execute(Class& cl, const Extra&... extra) + { + cl.def("__init__", + [](value_and_holder& v_h, Args... args) { + v_h.value_ptr() = construct_or_initialize<Alias<Class>>(std::forward<Args>(args)...); + }, + is_new_style_constructor(), + extra...); + } +}; + +// Implementation class for py::init(Func) and py::init(Func, AliasFunc) +template <typename CFunc, + typename AFunc = void_type (*)(), + typename = function_signature_t<CFunc>, + typename = function_signature_t<AFunc>> +struct factory; + +// Specialization for py::init(Func) +template <typename Func, typename Return, typename... Args> +struct factory<Func, void_type (*)(), Return(Args...)> +{ + remove_reference_t<Func> class_factory; + + factory(Func&& f) + : class_factory(std::forward<Func>(f)) + {} + + // The given class either has no alias or has no separate alias factory; + // this always constructs the class itself. If the class is registered with an alias + // type and an alias instance is needed (i.e. because the final type is a Python class + // inheriting from the C++ type) the returned value needs to either already be an alias + // instance, or the alias needs to be constructible from a `Class &&` argument. + template <typename Class, typename... Extra> + void execute(Class& cl, const Extra&... extra) && + { +#if defined(PYBIND11_CPP14) + cl.def("__init__", + [func = std::move(class_factory)] +#else + auto& func = class_factory; + cl.def("__init__", + [func] +#endif + (value_and_holder& v_h, Args... args) { + construct<Class>(v_h, func(std::forward<Args>(args)...), Py_TYPE(v_h.inst) != v_h.type->type); + }, + is_new_style_constructor(), + extra...); + } +}; + +// Specialization for py::init(Func, AliasFunc) +template <typename CFunc, typename AFunc, typename CReturn, typename... CArgs, typename AReturn, typename... AArgs> +struct factory<CFunc, AFunc, CReturn(CArgs...), AReturn(AArgs...)> +{ + static_assert(sizeof...(CArgs) == sizeof...(AArgs), + "pybind11::init(class_factory, alias_factory): class and alias factories " + "must have identical argument signatures"); + static_assert(all_of<std::is_same<CArgs, AArgs>...>::value, + "pybind11::init(class_factory, alias_factory): class and alias factories " + "must have identical argument signatures"); + + remove_reference_t<CFunc> class_factory; + remove_reference_t<AFunc> alias_factory; + + factory(CFunc&& c, AFunc&& a) + : class_factory(std::forward<CFunc>(c)) + , alias_factory(std::forward<AFunc>(a)) + {} + + // The class factory is called when the `self` type passed to `__init__` is the direct + // class (i.e. not inherited), the alias factory when `self` is a Python-side subtype. + template <typename Class, typename... Extra> + void execute(Class& cl, const Extra&... extra) && + { + static_assert(Class::has_alias, + "The two-argument version of `py::init()` can " + "only be used if the class has an alias"); +#if defined(PYBIND11_CPP14) + cl.def("__init__", + [class_func = std::move(class_factory), alias_func = std::move(alias_factory)] +#else + auto& class_func = class_factory; + auto& alias_func = alias_factory; + cl.def("__init__", + [class_func, alias_func] +#endif + (value_and_holder& v_h, CArgs... args) { + if (Py_TYPE(v_h.inst) == v_h.type->type) + // If the instance type equals the registered type we don't have inheritance, so + // don't need the alias and can construct using the class function: + construct<Class>(v_h, class_func(std::forward<CArgs>(args)...), false); + else + construct<Class>(v_h, alias_func(std::forward<CArgs>(args)...), true); + }, + is_new_style_constructor(), + extra...); + } +}; + +/// Set just the C++ state. Same as `__init__`. +template <typename Class, typename T> +void setstate(value_and_holder& v_h, T&& result, bool need_alias) +{ + construct<Class>(v_h, std::forward<T>(result), need_alias); +} + +/// Set both the C++ and Python states +template <typename Class, typename T, typename O, enable_if_t<std::is_convertible<O, handle>::value, int> = 0> +void setstate(value_and_holder& v_h, std::pair<T, O>&& result, bool need_alias) +{ + construct<Class>(v_h, std::move(result.first), need_alias); + setattr((PyObject*)v_h.inst, "__dict__", result.second); +} + +/// Implementation for py::pickle(GetState, SetState) +template <typename Get, typename Set, typename = function_signature_t<Get>, typename = function_signature_t<Set>> +struct pickle_factory; + +template <typename Get, typename Set, typename RetState, typename Self, typename NewInstance, typename ArgState> +struct pickle_factory<Get, Set, RetState(Self), NewInstance(ArgState)> +{ + static_assert(std::is_same<intrinsic_t<RetState>, intrinsic_t<ArgState>>::value, + "The type returned by `__getstate__` must be the same " + "as the argument accepted by `__setstate__`"); + + remove_reference_t<Get> get; + remove_reference_t<Set> set; + + pickle_factory(Get get, Set set) + : get(std::forward<Get>(get)) + , set(std::forward<Set>(set)) + {} + + template <typename Class, typename... Extra> + void execute(Class& cl, const Extra&... extra) && + { + cl.def("__getstate__", std::move(get)); + +#if defined(PYBIND11_CPP14) + cl.def("__setstate__", + [func = std::move(set)] +#else + auto& func = set; + cl.def("__setstate__", + [func] +#endif + (value_and_holder& v_h, ArgState state) { + setstate<Class>(v_h, func(std::forward<ArgState>(state)), Py_TYPE(v_h.inst) != v_h.type->type); + }, + is_new_style_constructor(), + extra...); + } +}; + +NAMESPACE_END(initimpl) +NAMESPACE_END(detail) +NAMESPACE_END(pybind11) diff --git a/pybind11/include/pybind11/detail/internals.h b/pybind11/include/pybind11/detail/internals.h new file mode 100644 index 0000000000000000000000000000000000000000..808ac979b9bcafcc80d1aa6e7c7ab425e308cc4b --- /dev/null +++ b/pybind11/include/pybind11/detail/internals.h @@ -0,0 +1,330 @@ +/* + pybind11/detail/internals.h: Internal data structure and related functions + + Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "../pytypes.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) +// Forward declarations +inline PyTypeObject* make_static_property_type(); +inline PyTypeObject* make_default_metaclass(); +inline PyObject* make_object_base_type(PyTypeObject* metaclass); + +// The old Python Thread Local Storage (TLS) API is deprecated in Python 3.7 in favor of the new +// Thread Specific Storage (TSS) API. +#if PY_VERSION_HEX >= 0x03070000 +# define PYBIND11_TLS_KEY_INIT(var) Py_tss_t* var = nullptr +# define PYBIND11_TLS_GET_VALUE(key) PyThread_tss_get((key)) +# define PYBIND11_TLS_REPLACE_VALUE(key, value) PyThread_tss_set((key), (value)) +# define PYBIND11_TLS_DELETE_VALUE(key) PyThread_tss_set((key), nullptr) +#else +// Usually an int but a long on Cygwin64 with Python 3.x +# define PYBIND11_TLS_KEY_INIT(var) decltype(PyThread_create_key()) var = 0 +# define PYBIND11_TLS_GET_VALUE(key) PyThread_get_key_value((key)) +# if PY_MAJOR_VERSION < 3 +# define PYBIND11_TLS_DELETE_VALUE(key) PyThread_delete_key_value(key) +# define PYBIND11_TLS_REPLACE_VALUE(key, value) \ + do { \ + PyThread_delete_key_value((key)); \ + PyThread_set_key_value((key), (value)); \ + } while (false) +# else +# define PYBIND11_TLS_DELETE_VALUE(key) PyThread_set_key_value((key), nullptr) +# define PYBIND11_TLS_REPLACE_VALUE(key, value) PyThread_set_key_value((key), (value)) +# endif +#endif + +// Python loads modules by default with dlopen with the RTLD_LOCAL flag; under libc++ and possibly +// other STLs, this means `typeid(A)` from one module won't equal `typeid(A)` from another module +// even when `A` is the same, non-hidden-visibility type (e.g. from a common include). Under +// libstdc++, this doesn't happen: equality and the type_index hash are based on the type name, +// which works. If not under a known-good stl, provide our own name-based hash and equality +// functions that use the type name. +#if defined(__GLIBCXX__) +inline bool same_type(const std::type_info& lhs, const std::type_info& rhs) +{ + return lhs == rhs; +} +using type_hash = std::hash<std::type_index>; +using type_equal_to = std::equal_to<std::type_index>; +#else +inline bool same_type(const std::type_info& lhs, const std::type_info& rhs) +{ + return lhs.name() == rhs.name() || std::strcmp(lhs.name(), rhs.name()) == 0; +} + +struct type_hash +{ + size_t operator()(const std::type_index& t) const + { + size_t hash = 5381; + const char* ptr = t.name(); + while (auto c = static_cast<unsigned char>(*ptr++)) + hash = (hash * 33) ^ c; + return hash; + } +}; + +struct type_equal_to +{ + bool operator()(const std::type_index& lhs, const std::type_index& rhs) const + { + return lhs.name() == rhs.name() || std::strcmp(lhs.name(), rhs.name()) == 0; + } +}; +#endif + +template <typename value_type> +using type_map = std::unordered_map<std::type_index, value_type, type_hash, type_equal_to>; + +struct overload_hash +{ + inline size_t operator()(const std::pair<const PyObject*, const char*>& v) const + { + size_t value = std::hash<const void*>()(v.first); + value ^= std::hash<const void*>()(v.second) + 0x9e3779b9 + (value << 6) + (value >> 2); + return value; + } +}; + +/// Internal data structure used to track registered instances and types. +/// Whenever binary incompatible changes are made to this structure, +/// `PYBIND11_INTERNALS_VERSION` must be incremented. +struct internals +{ + type_map<type_info*> registered_types_cpp; // std::type_index -> pybind11's type information + std::unordered_map<PyTypeObject*, std::vector<type_info*>> registered_types_py; // PyTypeObject* -> base type_info(s) + std::unordered_multimap<const void*, instance*> registered_instances; // void * -> instance* + std::unordered_set<std::pair<const PyObject*, const char*>, overload_hash> inactive_overload_cache; + type_map<std::vector<bool (*)(PyObject*, void*&)>> direct_conversions; + std::unordered_map<const PyObject*, std::vector<PyObject*>> patients; + std::forward_list<void (*)(std::exception_ptr)> registered_exception_translators; + std::unordered_map<std::string, void*> shared_data; // Custom data to be shared across extensions + std::vector<PyObject*> loader_patient_stack; // Used by `loader_life_support` + std::forward_list<std::string> static_strings; // Stores the std::strings backing detail::c_str() + PyTypeObject* static_property_type; + PyTypeObject* default_metaclass; + PyObject* instance_base; +#if defined(WITH_THREAD) + PYBIND11_TLS_KEY_INIT(tstate); + PyInterpreterState* istate = nullptr; +#endif +}; + +/// Additional type information which does not fit into the PyTypeObject. +/// Changes to this struct also require bumping `PYBIND11_INTERNALS_VERSION`. +struct type_info +{ + PyTypeObject* type; + const std::type_info* cpptype; + size_t type_size, type_align, holder_size_in_ptrs; + void* (*operator_new)(size_t); + void (*init_instance)(instance*, const void*); + void (*dealloc)(value_and_holder& v_h); + std::vector<PyObject* (*)(PyObject*, PyTypeObject*)> implicit_conversions; + std::vector<std::pair<const std::type_info*, void* (*)(void*)>> implicit_casts; + std::vector<bool (*)(PyObject*, void*&)>* direct_conversions; + buffer_info* (*get_buffer)(PyObject*, void*) = nullptr; + void* get_buffer_data = nullptr; + void* (*module_local_load)(PyObject*, const type_info*) = nullptr; + /* A simple type never occurs as a (direct or indirect) parent + * of a class that makes use of multiple inheritance */ + bool simple_type : 1; + /* True if there is no multiple inheritance in this type's inheritance tree */ + bool simple_ancestors : 1; + /* for base vs derived holder_type checks */ + bool default_holder : 1; + /* true if this is a type registered with py::module_local */ + bool module_local : 1; +}; + +/// Tracks the `internals` and `type_info` ABI version independent of the main library version +#define PYBIND11_INTERNALS_VERSION 3 + +#if defined(_DEBUG) +# define PYBIND11_BUILD_TYPE "_debug" +#else +# define PYBIND11_BUILD_TYPE "" +#endif + +#if defined(WITH_THREAD) +# define PYBIND11_INTERNALS_KIND "" +#else +# define PYBIND11_INTERNALS_KIND "_without_thread" +#endif + +#define PYBIND11_INTERNALS_ID \ + "__pybind11_internals_v" PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) PYBIND11_INTERNALS_KIND PYBIND11_BUILD_TYPE \ + "__" + +#define PYBIND11_MODULE_LOCAL_ID \ + "__pybind11_module_local_v" PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) \ + PYBIND11_INTERNALS_KIND PYBIND11_BUILD_TYPE "__" + +/// Each module locally stores a pointer to the `internals` data. The data +/// itself is shared among modules with the same `PYBIND11_INTERNALS_ID`. +inline internals**& get_internals_pp() +{ + static internals** internals_pp = nullptr; + return internals_pp; +} + +/// Return a reference to the current `internals` data +PYBIND11_NOINLINE inline internals& get_internals() +{ + auto**& internals_pp = get_internals_pp(); + if (internals_pp && *internals_pp) + return **internals_pp; + + constexpr auto* id = PYBIND11_INTERNALS_ID; + auto builtins = handle(PyEval_GetBuiltins()); + if (builtins.contains(id) && isinstance<capsule>(builtins[id])) { + internals_pp = static_cast<internals**>(capsule(builtins[id])); + + // We loaded builtins through python's builtins, which means that our `error_already_set` + // and `builtin_exception` may be different local classes than the ones set up in the + // initial exception translator, below, so add another for our local exception classes. + // + // libstdc++ doesn't require this (types there are identified only by name) +#if !defined(__GLIBCXX__) + (*internals_pp)->registered_exception_translators.push_front([](std::exception_ptr p) -> void { + try { + if (p) + std::rethrow_exception(p); + } catch (error_already_set& e) { + e.restore(); + return; + } catch (const builtin_exception& e) { + e.set_error(); + return; + } + }); +#endif + } else { + if (!internals_pp) + internals_pp = new internals*(); + auto*& internals_ptr = *internals_pp; + internals_ptr = new internals(); +#if defined(WITH_THREAD) + PyEval_InitThreads(); + PyThreadState* tstate = PyThreadState_Get(); +# if PY_VERSION_HEX >= 0x03070000 + internals_ptr->tstate = PyThread_tss_alloc(); + if (!internals_ptr->tstate || PyThread_tss_create(internals_ptr->tstate)) + pybind11_fail("get_internals: could not successfully initialize the TSS key!"); + PyThread_tss_set(internals_ptr->tstate, tstate); +# else + internals_ptr->tstate = PyThread_create_key(); + if (internals_ptr->tstate == -1) + pybind11_fail("get_internals: could not successfully initialize the TLS key!"); + PyThread_set_key_value(internals_ptr->tstate, tstate); +# endif + internals_ptr->istate = tstate->interp; +#endif + builtins[id] = capsule(internals_pp); + internals_ptr->registered_exception_translators.push_front([](std::exception_ptr p) -> void { + try { + if (p) + std::rethrow_exception(p); + } catch (error_already_set& e) { + e.restore(); + return; + } catch (const builtin_exception& e) { + e.set_error(); + return; + } catch (const std::bad_alloc& e) { + PyErr_SetString(PyExc_MemoryError, e.what()); + return; + } catch (const std::domain_error& e) { + PyErr_SetString(PyExc_ValueError, e.what()); + return; + } catch (const std::invalid_argument& e) { + PyErr_SetString(PyExc_ValueError, e.what()); + return; + } catch (const std::length_error& e) { + PyErr_SetString(PyExc_ValueError, e.what()); + return; + } catch (const std::out_of_range& e) { + PyErr_SetString(PyExc_IndexError, e.what()); + return; + } catch (const std::range_error& e) { + PyErr_SetString(PyExc_ValueError, e.what()); + return; + } catch (const std::exception& e) { + PyErr_SetString(PyExc_RuntimeError, e.what()); + return; + } catch (...) { + PyErr_SetString(PyExc_RuntimeError, "Caught an unknown exception!"); + return; + } + }); + internals_ptr->static_property_type = make_static_property_type(); + internals_ptr->default_metaclass = make_default_metaclass(); + internals_ptr->instance_base = make_object_base_type(internals_ptr->default_metaclass); + } + return **internals_pp; +} + +/// Works like `internals.registered_types_cpp`, but for module-local registered types: +inline type_map<type_info*>& registered_local_types_cpp() +{ + static type_map<type_info*> locals{}; + return locals; +} + +/// Constructs a std::string with the given arguments, stores it in `internals`, and returns its +/// `c_str()`. Such strings objects have a long storage duration -- the internal strings are only +/// cleared when the program exits or after interpreter shutdown (when embedding), and so are +/// suitable for c-style strings needed by Python internals (such as PyTypeObject's tp_name). +template <typename... Args> +const char* c_str(Args&&... args) +{ + auto& strings = get_internals().static_strings; + strings.emplace_front(std::forward<Args>(args)...); + return strings.front().c_str(); +} + +NAMESPACE_END(detail) + +/// Returns a named pointer that is shared among all extension modules (using the same +/// pybind11 version) running in the current interpreter. Names starting with underscores +/// are reserved for internal usage. Returns `nullptr` if no matching entry was found. +inline PYBIND11_NOINLINE void* get_shared_data(const std::string& name) +{ + auto& internals = detail::get_internals(); + auto it = internals.shared_data.find(name); + return it != internals.shared_data.end() ? it->second : nullptr; +} + +/// Set the shared data that can be later recovered by `get_shared_data()`. +inline PYBIND11_NOINLINE void* set_shared_data(const std::string& name, void* data) +{ + detail::get_internals().shared_data[name] = data; + return data; +} + +/// Returns a typed reference to a shared data entry (by using `get_shared_data()`) if +/// such entry exists. Otherwise, a new object of default-constructible type `T` is +/// added to the shared data under the given name and a reference to it is returned. +template <typename T> +T& get_or_create_shared_data(const std::string& name) +{ + auto& internals = detail::get_internals(); + auto it = internals.shared_data.find(name); + T* ptr = (T*)(it != internals.shared_data.end() ? it->second : nullptr); + if (!ptr) { + ptr = new T(); + internals.shared_data[name] = ptr; + } + return *ptr; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/detail/typeid.h b/pybind11/include/pybind11/detail/typeid.h new file mode 100644 index 0000000000000000000000000000000000000000..010d0e22c8011b88ae2bfded22e875af878ce31a --- /dev/null +++ b/pybind11/include/pybind11/detail/typeid.h @@ -0,0 +1,59 @@ +/* + pybind11/detail/typeid.h: Compiler-independent access to type identifiers + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include <cstdio> +#include <cstdlib> + +#if defined(__GNUG__) +# include <cxxabi.h> +#endif + +#include "common.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) +/// Erase all occurrences of a substring +inline void erase_all(std::string& string, const std::string& search) +{ + for (size_t pos = 0;;) { + pos = string.find(search, pos); + if (pos == std::string::npos) + break; + string.erase(pos, search.length()); + } +} + +PYBIND11_NOINLINE inline void clean_type_id(std::string& name) +{ +#if defined(__GNUG__) + int status = 0; + std::unique_ptr<char, void (*)(void*)> res{abi::__cxa_demangle(name.c_str(), nullptr, nullptr, &status), std::free}; + if (status == 0) + name = res.get(); +#else + detail::erase_all(name, "class "); + detail::erase_all(name, "struct "); + detail::erase_all(name, "enum "); +#endif + detail::erase_all(name, "pybind11::"); +} +NAMESPACE_END(detail) + +/// Return a string representation of a C++ type +template <typename T> +static std::string type_id() +{ + std::string name(typeid(T).name()); + detail::clean_type_id(name); + return name; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/eigen.h b/pybind11/include/pybind11/eigen.h new file mode 100644 index 0000000000000000000000000000000000000000..78066c629274d4e2380d40c2d61aae096715386a --- /dev/null +++ b/pybind11/include/pybind11/eigen.h @@ -0,0 +1,702 @@ +/* + pybind11/eigen.h: Transparent conversion for dense and sparse Eigen matrices + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "numpy.h" + +#if defined(__INTEL_COMPILER) +# pragma warning(disable : 1682) // implicit conversion of a 64-bit integral type to a smaller integral type (potential + // portability problem) +#elif defined(__GNUG__) || defined(__clang__) +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wconversion" +# pragma GCC diagnostic ignored "-Wdeprecated-declarations" +# ifdef __clang__ +// Eigen generates a bunch of implicit-copy-constructor-is-deprecated warnings with -Wdeprecated +// under Clang, so disable that warning here: +# pragma GCC diagnostic ignored "-Wdeprecated" +# endif +# if __GNUC__ >= 7 +# pragma GCC diagnostic ignored "-Wint-in-bool-context" +# endif +#endif + +#if defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable : 4127) // warning C4127: Conditional expression is constant +# pragma warning(disable : 4996) // warning C4996: std::unary_negate is deprecated in C++17 +#endif + +#include <Eigen/Core> +#include <Eigen/SparseCore> + +// Eigen prior to 3.2.7 doesn't have proper move constructors--but worse, some classes get implicit +// move constructors that break things. We could detect this an explicitly copy, but an extra copy +// of matrices seems highly undesirable. +static_assert(EIGEN_VERSION_AT_LEAST(3, 2, 7), "Eigen support in pybind11 requires Eigen >= 3.2.7"); + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +// Provide a convenience alias for easier pass-by-ref usage with fully dynamic strides: +using EigenDStride = Eigen::Stride<Eigen::Dynamic, Eigen::Dynamic>; +template <typename MatrixType> +using EigenDRef = Eigen::Ref<MatrixType, 0, EigenDStride>; +template <typename MatrixType> +using EigenDMap = Eigen::Map<MatrixType, 0, EigenDStride>; + +NAMESPACE_BEGIN(detail) + +#if EIGEN_VERSION_AT_LEAST(3, 3, 0) +using EigenIndex = Eigen::Index; +#else +using EigenIndex = EIGEN_DEFAULT_DENSE_INDEX_TYPE; +#endif + +// Matches Eigen::Map, Eigen::Ref, blocks, etc: +template <typename T> +using is_eigen_dense_map = + all_of<is_template_base_of<Eigen::DenseBase, T>, std::is_base_of<Eigen::MapBase<T, Eigen::ReadOnlyAccessors>, T>>; +template <typename T> +using is_eigen_mutable_map = std::is_base_of<Eigen::MapBase<T, Eigen::WriteAccessors>, T>; +template <typename T> +using is_eigen_dense_plain = all_of<negation<is_eigen_dense_map<T>>, is_template_base_of<Eigen::PlainObjectBase, T>>; +template <typename T> +using is_eigen_sparse = is_template_base_of<Eigen::SparseMatrixBase, T>; +// Test for objects inheriting from EigenBase<Derived> that aren't captured by the above. This +// basically covers anything that can be assigned to a dense matrix but that don't have a typical +// matrix data layout that can be copied from their .data(). For example, DiagonalMatrix and +// SelfAdjointView fall into this category. +template <typename T> +using is_eigen_other = all_of<is_template_base_of<Eigen::EigenBase, T>, + negation<any_of<is_eigen_dense_map<T>, is_eigen_dense_plain<T>, is_eigen_sparse<T>>>>; + +// Captures numpy/eigen conformability status (returned by EigenProps::conformable()): +template <bool EigenRowMajor> +struct EigenConformable +{ + bool conformable = false; + EigenIndex rows = 0, cols = 0; + EigenDStride stride{0, 0}; // Only valid if negativestrides is false! + bool negativestrides = false; // If true, do not use stride! + + EigenConformable(bool fits = false) + : conformable{fits} + {} + // Matrix type: + EigenConformable(EigenIndex r, EigenIndex c, EigenIndex rstride, EigenIndex cstride) + : conformable{true} + , rows{r} + , cols{c} + { + // TODO: when Eigen bug #747 is fixed, remove the tests for non-negativity. + // http://eigen.tuxfamily.org/bz/show_bug.cgi?id=747 + if (rstride < 0 || cstride < 0) { + negativestrides = true; + } else { + stride = {EigenRowMajor ? rstride : cstride /* outer stride */, + EigenRowMajor ? cstride : rstride /* inner stride */}; + } + } + // Vector type: + EigenConformable(EigenIndex r, EigenIndex c, EigenIndex stride) + : EigenConformable(r, c, r == 1 ? c * stride : stride, c == 1 ? r : r * stride) + {} + + template <typename props> + bool stride_compatible() const + { + // To have compatible strides, we need (on both dimensions) one of fully dynamic strides, + // matching strides, or a dimension size of 1 (in which case the stride value is irrelevant) + return !negativestrides + && (props::inner_stride == Eigen::Dynamic || props::inner_stride == stride.inner() + || (EigenRowMajor ? cols : rows) == 1) + && (props::outer_stride == Eigen::Dynamic || props::outer_stride == stride.outer() + || (EigenRowMajor ? rows : cols) == 1); + } + operator bool() const + { + return conformable; + } +}; + +template <typename Type> +struct eigen_extract_stride +{ + using type = Type; +}; +template <typename PlainObjectType, int MapOptions, typename StrideType> +struct eigen_extract_stride<Eigen::Map<PlainObjectType, MapOptions, StrideType>> +{ + using type = StrideType; +}; +template <typename PlainObjectType, int Options, typename StrideType> +struct eigen_extract_stride<Eigen::Ref<PlainObjectType, Options, StrideType>> +{ + using type = StrideType; +}; + +// Helper struct for extracting information from an Eigen type +template <typename Type_> +struct EigenProps +{ + using Type = Type_; + using Scalar = typename Type::Scalar; + using StrideType = typename eigen_extract_stride<Type>::type; + static constexpr EigenIndex rows = Type::RowsAtCompileTime, cols = Type::ColsAtCompileTime, + size = Type::SizeAtCompileTime; + static constexpr bool row_major = Type::IsRowMajor, + vector = Type::IsVectorAtCompileTime, // At least one dimension has fixed size 1 + fixed_rows = rows != Eigen::Dynamic, fixed_cols = cols != Eigen::Dynamic, + fixed = size != Eigen::Dynamic, // Fully-fixed size + dynamic = !fixed_rows && !fixed_cols; // Fully-dynamic size + + template <EigenIndex i, EigenIndex ifzero> + using if_zero = std::integral_constant<EigenIndex, i == 0 ? ifzero : i>; + static constexpr EigenIndex inner_stride = if_zero<StrideType::InnerStrideAtCompileTime, 1>::value, + outer_stride = if_zero < StrideType::OuterStrideAtCompileTime, + vector ? size : row_major ? cols : rows > ::value; + static constexpr bool dynamic_stride = inner_stride == Eigen::Dynamic && outer_stride == Eigen::Dynamic; + static constexpr bool requires_row_major = + !dynamic_stride && !vector && (row_major ? inner_stride : outer_stride) == 1; + static constexpr bool requires_col_major = + !dynamic_stride && !vector && (row_major ? outer_stride : inner_stride) == 1; + + // Takes an input array and determines whether we can make it fit into the Eigen type. If + // the array is a vector, we attempt to fit it into either an Eigen 1xN or Nx1 vector + // (preferring the latter if it will fit in either, i.e. for a fully dynamic matrix type). + static EigenConformable<row_major> conformable(const array& a) + { + const auto dims = a.ndim(); + if (dims < 1 || dims > 2) + return false; + + if (dims == 2) { // Matrix type: require exact match (or dynamic) + + EigenIndex np_rows = a.shape(0), np_cols = a.shape(1), + np_rstride = a.strides(0) / static_cast<ssize_t>(sizeof(Scalar)), + np_cstride = a.strides(1) / static_cast<ssize_t>(sizeof(Scalar)); + if ((fixed_rows && np_rows != rows) || (fixed_cols && np_cols != cols)) + return false; + + return {np_rows, np_cols, np_rstride, np_cstride}; + } + + // Otherwise we're storing an n-vector. Only one of the strides will be used, but whichever + // is used, we want the (single) numpy stride value. + const EigenIndex n = a.shape(0), stride = a.strides(0) / static_cast<ssize_t>(sizeof(Scalar)); + + if (vector) { // Eigen type is a compile-time vector + if (fixed && size != n) + return false; // Vector size mismatch + return {rows == 1 ? 1 : n, cols == 1 ? 1 : n, stride}; + } else if (fixed) { + // The type has a fixed size, but is not a vector: abort + return false; + } else if (fixed_cols) { + // Since this isn't a vector, cols must be != 1. We allow this only if it exactly + // equals the number of elements (rows is Dynamic, and so 1 row is allowed). + if (cols != n) + return false; + return {1, n, stride}; + } else { + // Otherwise it's either fully dynamic, or column dynamic; both become a column vector + if (fixed_rows && rows != n) + return false; + return {n, 1, stride}; + } + } + + static constexpr bool show_writeable = is_eigen_dense_map<Type>::value && is_eigen_mutable_map<Type>::value; + static constexpr bool show_order = is_eigen_dense_map<Type>::value; + static constexpr bool show_c_contiguous = show_order && requires_row_major; + static constexpr bool show_f_contiguous = !show_c_contiguous && show_order && requires_col_major; + + static constexpr auto descriptor = + _("numpy.ndarray[") + npy_format_descriptor<Scalar>::name + _("[") + _<fixed_rows>(_<(size_t)rows>(), _("m")) + + _(", ") + _<fixed_cols>(_<(size_t)cols>(), _("n")) + _("]") + + // For a reference type (e.g. Ref<MatrixXd>) we have other constraints that might need to be + // satisfied: writeable=True (for a mutable reference), and, depending on the map's stride + // options, possibly f_contiguous or c_contiguous. We include them in the descriptor output + // to provide some hint as to why a TypeError is occurring (otherwise it can be confusing to + // see that a function accepts a 'numpy.ndarray[float64[3,2]]' and an error message that you + // *gave* a numpy.ndarray of the right type and dimensions. + _<show_writeable>(", flags.writeable", "") + _<show_c_contiguous>(", flags.c_contiguous", "") + + _<show_f_contiguous>(", flags.f_contiguous", "") + _("]"); +}; + +// Casts an Eigen type to numpy array. If given a base, the numpy array references the src data, +// otherwise it'll make a copy. writeable lets you turn off the writeable flag for the array. +template <typename props> +handle eigen_array_cast(typename props::Type const& src, handle base = handle(), bool writeable = true) +{ + constexpr ssize_t elem_size = sizeof(typename props::Scalar); + array a; + if (props::vector) + a = array({src.size()}, {elem_size * src.innerStride()}, src.data(), base); + else + a = array({src.rows(), src.cols()}, {elem_size * src.rowStride(), elem_size * src.colStride()}, src.data(), base); + + if (!writeable) + array_proxy(a.ptr())->flags &= ~detail::npy_api::NPY_ARRAY_WRITEABLE_; + + return a.release(); +} + +// Takes an lvalue ref to some Eigen type and a (python) base object, creating a numpy array that +// reference the Eigen object's data with `base` as the python-registered base class (if omitted, +// the base will be set to None, and lifetime management is up to the caller). The numpy array is +// non-writeable if the given type is const. +template <typename props, typename Type> +handle eigen_ref_array(Type& src, handle parent = none()) +{ + // none here is to get past array's should-we-copy detection, which currently always + // copies when there is no base. Setting the base to None should be harmless. + return eigen_array_cast<props>(src, parent, !std::is_const<Type>::value); +} + +// Takes a pointer to some dense, plain Eigen type, builds a capsule around it, then returns a numpy +// array that references the encapsulated data with a python-side reference to the capsule to tie +// its destruction to that of any dependent python objects. Const-ness is determined by whether or +// not the Type of the pointer given is const. +template <typename props, typename Type, typename = enable_if_t<is_eigen_dense_plain<Type>::value>> +handle eigen_encapsulate(Type* src) +{ + capsule base(src, [](void* o) { delete static_cast<Type*>(o); }); + return eigen_ref_array<props>(*src, base); +} + +// Type caster for regular, dense matrix types (e.g. MatrixXd), but not maps/refs/etc. of dense +// types. +template <typename Type> +struct type_caster<Type, enable_if_t<is_eigen_dense_plain<Type>::value>> +{ + using Scalar = typename Type::Scalar; + using props = EigenProps<Type>; + + bool load(handle src, bool convert) + { + // If we're in no-convert mode, only load if given an array of the correct type + if (!convert && !isinstance<array_t<Scalar>>(src)) + return false; + + // Coerce into an array, but don't do type conversion yet; the copy below handles it. + auto buf = array::ensure(src); + + if (!buf) + return false; + + auto dims = buf.ndim(); + if (dims < 1 || dims > 2) + return false; + + auto fits = props::conformable(buf); + if (!fits) + return false; + + // Allocate the new type, then build a numpy reference into it + value = Type(fits.rows, fits.cols); + auto ref = reinterpret_steal<array>(eigen_ref_array<props>(value)); + if (dims == 1) + ref = ref.squeeze(); + else if (ref.ndim() == 1) + buf = buf.squeeze(); + + int result = detail::npy_api::get().PyArray_CopyInto_(ref.ptr(), buf.ptr()); + + if (result < 0) { // Copy failed! + PyErr_Clear(); + return false; + } + + return true; + } + +private: + // Cast implementation + template <typename CType> + static handle cast_impl(CType* src, return_value_policy policy, handle parent) + { + switch (policy) { + case return_value_policy::take_ownership: + case return_value_policy::automatic: + return eigen_encapsulate<props>(src); + case return_value_policy::move: + return eigen_encapsulate<props>(new CType(std::move(*src))); + case return_value_policy::copy: + return eigen_array_cast<props>(*src); + case return_value_policy::reference: + case return_value_policy::automatic_reference: + return eigen_ref_array<props>(*src); + case return_value_policy::reference_internal: + return eigen_ref_array<props>(*src, parent); + default: + throw cast_error("unhandled return_value_policy: should not happen!"); + }; + } + +public: + // Normal returned non-reference, non-const value: + static handle cast(Type&& src, return_value_policy /* policy */, handle parent) + { + return cast_impl(&src, return_value_policy::move, parent); + } + // If you return a non-reference const, we mark the numpy array readonly: + static handle cast(const Type&& src, return_value_policy /* policy */, handle parent) + { + return cast_impl(&src, return_value_policy::move, parent); + } + // lvalue reference return; default (automatic) becomes copy + static handle cast(Type& src, return_value_policy policy, handle parent) + { + if (policy == return_value_policy::automatic || policy == return_value_policy::automatic_reference) + policy = return_value_policy::copy; + return cast_impl(&src, policy, parent); + } + // const lvalue reference return; default (automatic) becomes copy + static handle cast(const Type& src, return_value_policy policy, handle parent) + { + if (policy == return_value_policy::automatic || policy == return_value_policy::automatic_reference) + policy = return_value_policy::copy; + return cast(&src, policy, parent); + } + // non-const pointer return + static handle cast(Type* src, return_value_policy policy, handle parent) + { + return cast_impl(src, policy, parent); + } + // const pointer return + static handle cast(const Type* src, return_value_policy policy, handle parent) + { + return cast_impl(src, policy, parent); + } + + static constexpr auto name = props::descriptor; + + operator Type*() + { + return &value; + } + operator Type&() + { + return value; + } + operator Type &&() && + { + return std::move(value); + } + template <typename T> + using cast_op_type = movable_cast_op_type<T>; + +private: + Type value; +}; + +// Base class for casting reference/map/block/etc. objects back to python. +template <typename MapType> +struct eigen_map_caster +{ +private: + using props = EigenProps<MapType>; + +public: + // Directly referencing a ref/map's data is a bit dangerous (whatever the map/ref points to has + // to stay around), but we'll allow it under the assumption that you know what you're doing (and + // have an appropriate keep_alive in place). We return a numpy array pointing directly at the + // ref's data (The numpy array ends up read-only if the ref was to a const matrix type.) Note + // that this means you need to ensure you don't destroy the object in some other way (e.g. with + // an appropriate keep_alive, or with a reference to a statically allocated matrix). + static handle cast(const MapType& src, return_value_policy policy, handle parent) + { + switch (policy) { + case return_value_policy::copy: + return eigen_array_cast<props>(src); + case return_value_policy::reference_internal: + return eigen_array_cast<props>(src, parent, is_eigen_mutable_map<MapType>::value); + case return_value_policy::reference: + case return_value_policy::automatic: + case return_value_policy::automatic_reference: + return eigen_array_cast<props>(src, none(), is_eigen_mutable_map<MapType>::value); + default: + // move, take_ownership don't make any sense for a ref/map: + pybind11_fail("Invalid return_value_policy for Eigen Map/Ref/Block type"); + } + } + + static constexpr auto name = props::descriptor; + + // Explicitly delete these: support python -> C++ conversion on these (i.e. these can be return + // types but not bound arguments). We still provide them (with an explicitly delete) so that + // you end up here if you try anyway. + bool load(handle, bool) = delete; + operator MapType() = delete; + template <typename> + using cast_op_type = MapType; +}; + +// We can return any map-like object (but can only load Refs, specialized next): +template <typename Type> +struct type_caster<Type, enable_if_t<is_eigen_dense_map<Type>::value>> : eigen_map_caster<Type> +{}; + +// Loader for Ref<...> arguments. See the documentation for info on how to make this work without +// copying (it requires some extra effort in many cases). +template <typename PlainObjectType, typename StrideType> +struct type_caster<Eigen::Ref<PlainObjectType, 0, StrideType>, + enable_if_t<is_eigen_dense_map<Eigen::Ref<PlainObjectType, 0, StrideType>>::value>> + : public eigen_map_caster<Eigen::Ref<PlainObjectType, 0, StrideType>> +{ +private: + using Type = Eigen::Ref<PlainObjectType, 0, StrideType>; + using props = EigenProps<Type>; + using Scalar = typename props::Scalar; + using MapType = Eigen::Map<PlainObjectType, 0, StrideType>; + using Array = + array_t<Scalar, + array::forcecast + | ((props::row_major ? props::inner_stride : props::outer_stride) == 1 + ? array::c_style + : (props::row_major ? props::outer_stride : props::inner_stride) == 1 ? array::f_style : 0)>; + static constexpr bool need_writeable = is_eigen_mutable_map<Type>::value; + // Delay construction (these have no default constructor) + std::unique_ptr<MapType> map; + std::unique_ptr<Type> ref; + // Our array. When possible, this is just a numpy array pointing to the source data, but + // sometimes we can't avoid copying (e.g. input is not a numpy array at all, has an incompatible + // layout, or is an array of a type that needs to be converted). Using a numpy temporary + // (rather than an Eigen temporary) saves an extra copy when we need both type conversion and + // storage order conversion. (Note that we refuse to use this temporary copy when loading an + // argument for a Ref<M> with M non-const, i.e. a read-write reference). + Array copy_or_ref; + +public: + bool load(handle src, bool convert) + { + // First check whether what we have is already an array of the right type. If not, we can't + // avoid a copy (because the copy is also going to do type conversion). + bool need_copy = !isinstance<Array>(src); + + EigenConformable<props::row_major> fits; + if (!need_copy) { + // We don't need a converting copy, but we also need to check whether the strides are + // compatible with the Ref's stride requirements + Array aref = reinterpret_borrow<Array>(src); + + if (aref && (!need_writeable || aref.writeable())) { + fits = props::conformable(aref); + if (!fits) + return false; // Incompatible dimensions + if (!fits.template stride_compatible<props>()) + need_copy = true; + else + copy_or_ref = std::move(aref); + } else { + need_copy = true; + } + } + + if (need_copy) { + // We need to copy: If we need a mutable reference, or we're not supposed to convert + // (either because we're in the no-convert overload pass, or because we're explicitly + // instructed not to copy (via `py::arg().noconvert()`) we have to fail loading. + if (!convert || need_writeable) + return false; + + Array copy = Array::ensure(src); + if (!copy) + return false; + fits = props::conformable(copy); + if (!fits || !fits.template stride_compatible<props>()) + return false; + copy_or_ref = std::move(copy); + loader_life_support::add_patient(copy_or_ref); + } + + ref.reset(); + map.reset( + new MapType(data(copy_or_ref), fits.rows, fits.cols, make_stride(fits.stride.outer(), fits.stride.inner()))); + ref.reset(new Type(*map)); + + return true; + } + + operator Type*() + { + return ref.get(); + } + operator Type&() + { + return *ref; + } + template <typename _T> + using cast_op_type = pybind11::detail::cast_op_type<_T>; + +private: + template <typename T = Type, enable_if_t<is_eigen_mutable_map<T>::value, int> = 0> + Scalar* data(Array& a) + { + return a.mutable_data(); + } + + template <typename T = Type, enable_if_t<!is_eigen_mutable_map<T>::value, int> = 0> + const Scalar* data(Array& a) + { + return a.data(); + } + + // Attempt to figure out a constructor of `Stride` that will work. + // If both strides are fixed, use a default constructor: + template <typename S> + using stride_ctor_default = + bool_constant<S::InnerStrideAtCompileTime != Eigen::Dynamic && S::OuterStrideAtCompileTime != Eigen::Dynamic + && std::is_default_constructible<S>::value>; + // Otherwise, if there is a two-index constructor, assume it is (outer,inner) like + // Eigen::Stride, and use it: + template <typename S> + using stride_ctor_dual = + bool_constant<!stride_ctor_default<S>::value && std::is_constructible<S, EigenIndex, EigenIndex>::value>; + // Otherwise, if there is a one-index constructor, and just one of the strides is dynamic, use + // it (passing whichever stride is dynamic). + template <typename S> + using stride_ctor_outer = + bool_constant<!any_of<stride_ctor_default<S>, stride_ctor_dual<S>>::value + && S::OuterStrideAtCompileTime == Eigen::Dynamic && S::InnerStrideAtCompileTime != Eigen::Dynamic + && std::is_constructible<S, EigenIndex>::value>; + template <typename S> + using stride_ctor_inner = + bool_constant<!any_of<stride_ctor_default<S>, stride_ctor_dual<S>>::value + && S::InnerStrideAtCompileTime == Eigen::Dynamic && S::OuterStrideAtCompileTime != Eigen::Dynamic + && std::is_constructible<S, EigenIndex>::value>; + + template <typename S = StrideType, enable_if_t<stride_ctor_default<S>::value, int> = 0> + static S make_stride(EigenIndex, EigenIndex) + { + return S(); + } + template <typename S = StrideType, enable_if_t<stride_ctor_dual<S>::value, int> = 0> + static S make_stride(EigenIndex outer, EigenIndex inner) + { + return S(outer, inner); + } + template <typename S = StrideType, enable_if_t<stride_ctor_outer<S>::value, int> = 0> + static S make_stride(EigenIndex outer, EigenIndex) + { + return S(outer); + } + template <typename S = StrideType, enable_if_t<stride_ctor_inner<S>::value, int> = 0> + static S make_stride(EigenIndex, EigenIndex inner) + { + return S(inner); + } +}; + +// type_caster for special matrix types (e.g. DiagonalMatrix), which are EigenBase, but not +// EigenDense (i.e. they don't have a data(), at least not with the usual matrix layout). +// load() is not supported, but we can cast them into the python domain by first copying to a +// regular Eigen::Matrix, then casting that. +template <typename Type> +struct type_caster<Type, enable_if_t<is_eigen_other<Type>::value>> +{ +protected: + using Matrix = Eigen::Matrix<typename Type::Scalar, Type::RowsAtCompileTime, Type::ColsAtCompileTime>; + using props = EigenProps<Matrix>; + +public: + static handle cast(const Type& src, return_value_policy /* policy */, handle /* parent */) + { + handle h = eigen_encapsulate<props>(new Matrix(src)); + return h; + } + static handle cast(const Type* src, return_value_policy policy, handle parent) + { + return cast(*src, policy, parent); + } + + static constexpr auto name = props::descriptor; + + // Explicitly delete these: support python -> C++ conversion on these (i.e. these can be return + // types but not bound arguments). We still provide them (with an explicitly delete) so that + // you end up here if you try anyway. + bool load(handle, bool) = delete; + operator Type() = delete; + template <typename> + using cast_op_type = Type; +}; + +template <typename Type> +struct type_caster<Type, enable_if_t<is_eigen_sparse<Type>::value>> +{ + typedef typename Type::Scalar Scalar; + typedef remove_reference_t<decltype(*std::declval<Type>().outerIndexPtr())> StorageIndex; + typedef typename Type::Index Index; + static constexpr bool rowMajor = Type::IsRowMajor; + + bool load(handle src, bool) + { + if (!src) + return false; + + auto obj = reinterpret_borrow<object>(src); + object sparse_module = module::import("scipy.sparse"); + object matrix_type = sparse_module.attr(rowMajor ? "csr_matrix" : "csc_matrix"); + + if (!obj.get_type().is(matrix_type)) { + try { + obj = matrix_type(obj); + } catch (const error_already_set&) { + return false; + } + } + + auto values = array_t<Scalar>((object)obj.attr("data")); + auto innerIndices = array_t<StorageIndex>((object)obj.attr("indices")); + auto outerIndices = array_t<StorageIndex>((object)obj.attr("indptr")); + auto shape = pybind11::tuple((pybind11::object)obj.attr("shape")); + auto nnz = obj.attr("nnz").cast<Index>(); + + if (!values || !innerIndices || !outerIndices) + return false; + + value = Eigen::MappedSparseMatrix<Scalar, Type::Flags, StorageIndex>(shape[0].cast<Index>(), + shape[1].cast<Index>(), + nnz, + outerIndices.mutable_data(), + innerIndices.mutable_data(), + values.mutable_data()); + + return true; + } + + static handle cast(const Type& src, return_value_policy /* policy */, handle /* parent */) + { + const_cast<Type&>(src).makeCompressed(); + + object matrix_type = module::import("scipy.sparse").attr(rowMajor ? "csr_matrix" : "csc_matrix"); + + array data(src.nonZeros(), src.valuePtr()); + array outerIndices((rowMajor ? src.rows() : src.cols()) + 1, src.outerIndexPtr()); + array innerIndices(src.nonZeros(), src.innerIndexPtr()); + + return matrix_type(std::make_tuple(data, innerIndices, outerIndices), std::make_pair(src.rows(), src.cols())) + .release(); + } + + PYBIND11_TYPE_CASTER(Type, + _<(Type::IsRowMajor) != 0>("scipy.sparse.csr_matrix[", "scipy.sparse.csc_matrix[") + + npy_format_descriptor<Scalar>::name + _("]")); +}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(__GNUG__) || defined(__clang__) +# pragma GCC diagnostic pop +#elif defined(_MSC_VER) +# pragma warning(pop) +#endif diff --git a/pybind11/include/pybind11/embed.h b/pybind11/include/pybind11/embed.h new file mode 100644 index 0000000000000000000000000000000000000000..5e47f76dea252abd24436ef1a40695c7cc0f4c94 --- /dev/null +++ b/pybind11/include/pybind11/embed.h @@ -0,0 +1,212 @@ +/* + pybind11/embed.h: Support for embedding the interpreter + + Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include "eval.h" + +#if defined(PYPY_VERSION) +# error Embedding the interpreter is not supported with PyPy +#endif + +#if PY_MAJOR_VERSION >= 3 +# define PYBIND11_EMBEDDED_MODULE_IMPL(name) \ + extern "C" PyObject* pybind11_init_impl_##name() \ + { \ + return pybind11_init_wrapper_##name(); \ + } +#else +# define PYBIND11_EMBEDDED_MODULE_IMPL(name) \ + extern "C" void pybind11_init_impl_##name() \ + { \ + pybind11_init_wrapper_##name(); \ + } +#endif + +/** \rst + Add a new module to the table of builtins for the interpreter. Must be + defined in global scope. The first macro parameter is the name of the + module (without quotes). The second parameter is the variable which will + be used as the interface to add functions and classes to the module. + + .. code-block:: cpp + + PYBIND11_EMBEDDED_MODULE(example, m) { + // ... initialize functions and classes here + m.def("foo", []() { + return "Hello, World!"; + }); + } + \endrst */ +#define PYBIND11_EMBEDDED_MODULE(name, variable) \ + static void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module&); \ + static PyObject PYBIND11_CONCAT(*pybind11_init_wrapper_, name)() \ + { \ + auto m = pybind11::module(PYBIND11_TOSTRING(name)); \ + try { \ + PYBIND11_CONCAT(pybind11_init_, name)(m); \ + return m.ptr(); \ + } catch (pybind11::error_already_set & e) { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } catch (const std::exception& e) { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } \ + } \ + PYBIND11_EMBEDDED_MODULE_IMPL(name) \ + pybind11::detail::embedded_module name(PYBIND11_TOSTRING(name), PYBIND11_CONCAT(pybind11_init_impl_, name)); \ + void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module & variable) + + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// Python 2.7/3.x compatible version of `PyImport_AppendInittab` and error checks. +struct embedded_module +{ +#if PY_MAJOR_VERSION >= 3 + using init_t = PyObject* (*)(); +#else + using init_t = void (*)(); +#endif + embedded_module(const char* name, init_t init) + { + if (Py_IsInitialized()) + pybind11_fail("Can't add new modules after the interpreter has been initialized"); + + auto result = PyImport_AppendInittab(name, init); + if (result == -1) + pybind11_fail("Insufficient memory to add a new module"); + } +}; + +NAMESPACE_END(detail) + +/** \rst + Initialize the Python interpreter. No other pybind11 or CPython API functions can be + called before this is done; with the exception of `PYBIND11_EMBEDDED_MODULE`. The + optional parameter can be used to skip the registration of signal handlers (see the + `Python documentation`_ for details). Calling this function again after the interpreter + has already been initialized is a fatal error. + + If initializing the Python interpreter fails, then the program is terminated. (This + is controlled by the CPython runtime and is an exception to pybind11's normal behavior + of throwing exceptions on errors.) + + .. _Python documentation: https://docs.python.org/3/c-api/init.html#c.Py_InitializeEx + \endrst */ +inline void initialize_interpreter(bool init_signal_handlers = true) +{ + if (Py_IsInitialized()) + pybind11_fail("The interpreter is already running"); + + Py_InitializeEx(init_signal_handlers ? 1 : 0); + + // Make .py files in the working directory available by default + module::import("sys").attr("path").cast<list>().append("."); +} + +/** \rst + Shut down the Python interpreter. No pybind11 or CPython API functions can be called + after this. In addition, pybind11 objects must not outlive the interpreter: + + .. code-block:: cpp + + { // BAD + py::initialize_interpreter(); + auto hello = py::str("Hello, World!"); + py::finalize_interpreter(); + } // <-- BOOM, hello's destructor is called after interpreter shutdown + + { // GOOD + py::initialize_interpreter(); + { // scoped + auto hello = py::str("Hello, World!"); + } // <-- OK, hello is cleaned up properly + py::finalize_interpreter(); + } + + { // BETTER + py::scoped_interpreter guard{}; + auto hello = py::str("Hello, World!"); + } + + .. warning:: + + The interpreter can be restarted by calling `initialize_interpreter` again. + Modules created using pybind11 can be safely re-initialized. However, Python + itself cannot completely unload binary extension modules and there are several + caveats with regard to interpreter restarting. All the details can be found + in the CPython documentation. In short, not all interpreter memory may be + freed, either due to reference cycles or user-created global data. + + \endrst */ +inline void finalize_interpreter() +{ + handle builtins(PyEval_GetBuiltins()); + const char* id = PYBIND11_INTERNALS_ID; + + // Get the internals pointer (without creating it if it doesn't exist). It's possible for the + // internals to be created during Py_Finalize() (e.g. if a py::capsule calls `get_internals()` + // during destruction), so we get the pointer-pointer here and check it after Py_Finalize(). + detail::internals** internals_ptr_ptr = detail::get_internals_pp(); + // It could also be stashed in builtins, so look there too: + if (builtins.contains(id) && isinstance<capsule>(builtins[id])) + internals_ptr_ptr = capsule(builtins[id]); + + Py_Finalize(); + + if (internals_ptr_ptr) { + delete *internals_ptr_ptr; + *internals_ptr_ptr = nullptr; + } +} + +/** \rst + Scope guard version of `initialize_interpreter` and `finalize_interpreter`. + This a move-only guard and only a single instance can exist. + + .. code-block:: cpp + + #include <pybind11/embed.h> + + int main() { + py::scoped_interpreter guard{}; + py::print(Hello, World!); + } // <-- interpreter shutdown + \endrst */ +class scoped_interpreter +{ +public: + scoped_interpreter(bool init_signal_handlers = true) + { + initialize_interpreter(init_signal_handlers); + } + + scoped_interpreter(const scoped_interpreter&) = delete; + scoped_interpreter(scoped_interpreter&& other) noexcept + { + other.is_valid = false; + } + scoped_interpreter& operator=(const scoped_interpreter&) = delete; + scoped_interpreter& operator=(scoped_interpreter&&) = delete; + + ~scoped_interpreter() + { + if (is_valid) + finalize_interpreter(); + } + +private: + bool is_valid = true; +}; + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/eval.h b/pybind11/include/pybind11/eval.h new file mode 100644 index 0000000000000000000000000000000000000000..e58f6c7af1adee0ca54acda452c7336d8929acc0 --- /dev/null +++ b/pybind11/include/pybind11/eval.h @@ -0,0 +1,133 @@ +/* + pybind11/exec.h: Support for evaluating Python expressions and statements + from strings and files + + Copyright (c) 2016 Klemens Morgenstern <klemens.morgenstern@ed-chemnitz.de> and + Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +enum eval_mode +{ + /// Evaluate a string containing an isolated expression + eval_expr, + + /// Evaluate a string containing a single statement. Returns \c none + eval_single_statement, + + /// Evaluate a string containing a sequence of statement. Returns \c none + eval_statements +}; + +template <eval_mode mode = eval_expr> +object eval(str expr, object global = globals(), object local = object()) +{ + if (!local) + local = global; + + /* PyRun_String does not accept a PyObject / encoding specifier, + this seems to be the only alternative */ + std::string buffer = "# -*- coding: utf-8 -*-\n" + (std::string)expr; + + int start; + switch (mode) { + case eval_expr: + start = Py_eval_input; + break; + case eval_single_statement: + start = Py_single_input; + break; + case eval_statements: + start = Py_file_input; + break; + default: + pybind11_fail("invalid evaluation mode"); + } + + PyObject* result = PyRun_String(buffer.c_str(), start, global.ptr(), local.ptr()); + if (!result) + throw error_already_set(); + return reinterpret_steal<object>(result); +} + +template <eval_mode mode = eval_expr, size_t N> +object eval(const char (&s)[N], object global = globals(), object local = object()) +{ + /* Support raw string literals by removing common leading whitespace */ + auto expr = (s[0] == '\n') ? str(module::import("textwrap").attr("dedent")(s)) : str(s); + return eval<mode>(expr, global, local); +} + +inline void exec(str expr, object global = globals(), object local = object()) +{ + eval<eval_statements>(expr, global, local); +} + +template <size_t N> +void exec(const char (&s)[N], object global = globals(), object local = object()) +{ + eval<eval_statements>(s, global, local); +} + +template <eval_mode mode = eval_statements> +object eval_file(str fname, object global = globals(), object local = object()) +{ + if (!local) + local = global; + + int start; + switch (mode) { + case eval_expr: + start = Py_eval_input; + break; + case eval_single_statement: + start = Py_single_input; + break; + case eval_statements: + start = Py_file_input; + break; + default: + pybind11_fail("invalid evaluation mode"); + } + + int closeFile = 1; + std::string fname_str = (std::string)fname; +#if PY_VERSION_HEX >= 0x03040000 + FILE* f = _Py_fopen_obj(fname.ptr(), "r"); +#elif PY_VERSION_HEX >= 0x03000000 + FILE* f = _Py_fopen(fname.ptr(), "r"); +#else + /* No unicode support in open() :( */ + auto fobj = + reinterpret_steal<object>(PyFile_FromString(const_cast<char*>(fname_str.c_str()), const_cast<char*>("r"))); + FILE* f = nullptr; + if (fobj) + f = PyFile_AsFile(fobj.ptr()); + closeFile = 0; +#endif + if (!f) { + PyErr_Clear(); + pybind11_fail("File \"" + fname_str + "\" could not be opened!"); + } + +#if PY_VERSION_HEX < 0x03000000 && defined(PYPY_VERSION) + PyObject* result = PyRun_File(f, fname_str.c_str(), start, global.ptr(), local.ptr()); + (void)closeFile; +#else + PyObject* result = PyRun_FileEx(f, fname_str.c_str(), start, global.ptr(), local.ptr(), closeFile); +#endif + + if (!result) + throw error_already_set(); + return reinterpret_steal<object>(result); +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/functional.h b/pybind11/include/pybind11/functional.h new file mode 100644 index 0000000000000000000000000000000000000000..d2a61cf67f1353fa5e8678159c6fd076211df69d --- /dev/null +++ b/pybind11/include/pybind11/functional.h @@ -0,0 +1,106 @@ +/* + pybind11/functional.h: std::function<> support + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include <functional> + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +template <typename Return, typename... Args> +struct type_caster<std::function<Return(Args...)>> +{ + using type = std::function<Return(Args...)>; + using retval_type = conditional_t<std::is_same<Return, void>::value, void_type, Return>; + using function_type = Return (*)(Args...); + +public: + bool load(handle src, bool convert) + { + if (src.is_none()) { + // Defer accepting None to other overloads (if we aren't in convert mode): + if (!convert) + return false; + return true; + } + + if (!isinstance<function>(src)) + return false; + + auto func = reinterpret_borrow<function>(src); + + /* + When passing a C++ function as an argument to another C++ + function via Python, every function call would normally involve + a full C++ -> Python -> C++ roundtrip, which can be prohibitive. + Here, we try to at least detect the case where the function is + stateless (i.e. function pointer or lambda function without + captured variables), in which case the roundtrip can be avoided. + */ + if (auto cfunc = func.cpp_function()) { + auto c = reinterpret_borrow<capsule>(PyCFunction_GET_SELF(cfunc.ptr())); + auto rec = (function_record*)c; + + if (rec && rec->is_stateless + && same_type(typeid(function_type), *reinterpret_cast<const std::type_info*>(rec->data[1]))) { + struct capture + { + function_type f; + }; + value = ((capture*)&rec->data)->f; + return true; + } + } + + // ensure GIL is held during functor destruction + struct func_handle + { + function f; + func_handle(function&& f_) + : f(std::move(f_)) + {} + func_handle(const func_handle&) = default; + ~func_handle() + { + gil_scoped_acquire acq; + function kill_f(std::move(f)); + } + }; + + value = [hfunc = func_handle(std::move(func))](Args... args) -> Return { + gil_scoped_acquire acq; + object retval(hfunc.f(std::forward<Args>(args)...)); + /* Visual studio 2015 parser issue: need parentheses around this expression */ + return (retval.template cast<Return>()); + }; + return true; + } + + template <typename Func> + static handle cast(Func&& f_, return_value_policy policy, handle /* parent */) + { + if (!f_) + return none().inc_ref(); + + auto result = f_.template target<function_type>(); + if (result) + return cpp_function(*result, policy).release(); + else + return cpp_function(std::forward<Func>(f_), policy).release(); + } + + PYBIND11_TYPE_CASTER(type, + _("Callable[[") + concat(make_caster<Args>::name...) + _("], ") + make_caster<retval_type>::name + + _("]")); +}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/iostream.h b/pybind11/include/pybind11/iostream.h new file mode 100644 index 0000000000000000000000000000000000000000..3a975a61bbe8d2a274308c0d8ec64873af775c7d --- /dev/null +++ b/pybind11/include/pybind11/iostream.h @@ -0,0 +1,219 @@ +/* + pybind11/iostream.h -- Tools to assist with redirecting cout and cerr to Python + + Copyright (c) 2017 Henry F. Schreiner + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" + +#include <streambuf> +#include <ostream> +#include <string> +#include <memory> +#include <iostream> + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +// Buffer that writes to Python instead of C++ +class pythonbuf : public std::streambuf +{ +private: + using traits_type = std::streambuf::traits_type; + + const size_t buf_size; + std::unique_ptr<char[]> d_buffer; + object pywrite; + object pyflush; + + int overflow(int c) + { + if (!traits_type::eq_int_type(c, traits_type::eof())) { + *pptr() = traits_type::to_char_type(c); + pbump(1); + } + return sync() == 0 ? traits_type::not_eof(c) : traits_type::eof(); + } + + int sync() + { + if (pbase() != pptr()) { + // This subtraction cannot be negative, so dropping the sign + str line(pbase(), static_cast<size_t>(pptr() - pbase())); + + { + gil_scoped_acquire tmp; + pywrite(line); + pyflush(); + } + + setp(pbase(), epptr()); + } + return 0; + } + +public: + pythonbuf(object pyostream, size_t buffer_size = 1024) + : buf_size(buffer_size) + , d_buffer(new char[buf_size]) + , pywrite(pyostream.attr("write")) + , pyflush(pyostream.attr("flush")) + { + setp(d_buffer.get(), d_buffer.get() + buf_size - 1); + } + + /// Sync before destroy + ~pythonbuf() + { + sync(); + } +}; + +NAMESPACE_END(detail) + + +/** \rst + This a move-only guard that redirects output. + + .. code-block:: cpp + + #include <pybind11/iostream.h> + + ... + + { + py::scoped_ostream_redirect output; + std::cout << "Hello, World!"; // Python stdout + } // <-- return std::cout to normal + + You can explicitly pass the c++ stream and the python object, + for example to guard stderr instead. + + .. code-block:: cpp + + { + py::scoped_ostream_redirect output{std::cerr, py::module::import("sys").attr("stderr")}; + std::cerr << "Hello, World!"; + } + \endrst */ +class scoped_ostream_redirect +{ +protected: + std::streambuf* old; + std::ostream& costream; + detail::pythonbuf buffer; + +public: + scoped_ostream_redirect(std::ostream& costream = std::cout, object pyostream = module::import("sys").attr("stdout")) + : costream(costream) + , buffer(pyostream) + { + old = costream.rdbuf(&buffer); + } + + ~scoped_ostream_redirect() + { + costream.rdbuf(old); + } + + scoped_ostream_redirect(const scoped_ostream_redirect&) = delete; + scoped_ostream_redirect(scoped_ostream_redirect&& other) = default; + scoped_ostream_redirect& operator=(const scoped_ostream_redirect&) = delete; + scoped_ostream_redirect& operator=(scoped_ostream_redirect&&) = delete; +}; + + +/** \rst + Like `scoped_ostream_redirect`, but redirects cerr by default. This class + is provided primary to make ``py::call_guard`` easier to make. + + .. code-block:: cpp + + m.def("noisy_func", &noisy_func, + py::call_guard<scoped_ostream_redirect, + scoped_estream_redirect>()); + +\endrst */ +class scoped_estream_redirect : public scoped_ostream_redirect +{ +public: + scoped_estream_redirect(std::ostream& costream = std::cerr, object pyostream = module::import("sys").attr("stderr")) + : scoped_ostream_redirect(costream, pyostream) + {} +}; + + +NAMESPACE_BEGIN(detail) + +// Class to redirect output as a context manager. C++ backend. +class OstreamRedirect +{ + bool do_stdout_; + bool do_stderr_; + std::unique_ptr<scoped_ostream_redirect> redirect_stdout; + std::unique_ptr<scoped_estream_redirect> redirect_stderr; + +public: + OstreamRedirect(bool do_stdout = true, bool do_stderr = true) + : do_stdout_(do_stdout) + , do_stderr_(do_stderr) + {} + + void enter() + { + if (do_stdout_) + redirect_stdout.reset(new scoped_ostream_redirect()); + if (do_stderr_) + redirect_stderr.reset(new scoped_estream_redirect()); + } + + void exit() + { + redirect_stdout.reset(); + redirect_stderr.reset(); + } +}; + +NAMESPACE_END(detail) + +/** \rst + This is a helper function to add a C++ redirect context manager to Python + instead of using a C++ guard. To use it, add the following to your binding code: + + .. code-block:: cpp + + #include <pybind11/iostream.h> + + ... + + py::add_ostream_redirect(m, "ostream_redirect"); + + You now have a Python context manager that redirects your output: + + .. code-block:: python + + with m.ostream_redirect(): + m.print_to_cout_function() + + This manager can optionally be told which streams to operate on: + + .. code-block:: python + + with m.ostream_redirect(stdout=true, stderr=true): + m.noisy_function_with_error_printing() + + \endrst */ +inline class_<detail::OstreamRedirect> add_ostream_redirect(module m, std::string name = "ostream_redirect") +{ + return class_<detail::OstreamRedirect>(m, name.c_str(), module_local()) + .def(init<bool, bool>(), arg("stdout") = true, arg("stderr") = true) + .def("__enter__", &detail::OstreamRedirect::enter) + .def("__exit__", [](detail::OstreamRedirect& self_, args) { self_.exit(); }); +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/numpy.h b/pybind11/include/pybind11/numpy.h new file mode 100644 index 0000000000000000000000000000000000000000..22adb739c699f0bf6f368888f1e2a8afcd899eea --- /dev/null +++ b/pybind11/include/pybind11/numpy.h @@ -0,0 +1,1928 @@ +/* + pybind11/numpy.h: Basic NumPy support, vectorize() wrapper + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include "complex.h" +#include <numeric> +#include <algorithm> +#include <array> +#include <cstdlib> +#include <cstring> +#include <sstream> +#include <string> +#include <functional> +#include <utility> +#include <vector> +#include <typeindex> + +#if defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable : 4127) // warning C4127: Conditional expression is constant +#endif + +/* This will be true on all flat address space platforms and allows us to reduce the + whole npy_intp / ssize_t / Py_intptr_t business down to just ssize_t for all size + and dimension types (e.g. shape, strides, indexing), instead of inflicting this + upon the library user. */ +static_assert(sizeof(ssize_t) == sizeof(Py_intptr_t), "ssize_t != Py_intptr_t"); + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +class array; // Forward declaration + +NAMESPACE_BEGIN(detail) +template <typename type, typename SFINAE = void> +struct npy_format_descriptor; + +struct PyArrayDescr_Proxy +{ + PyObject_HEAD PyObject* typeobj; + char kind; + char type; + char byteorder; + char flags; + int type_num; + int elsize; + int alignment; + char* subarray; + PyObject* fields; + PyObject* names; +}; + +struct PyArray_Proxy +{ + PyObject_HEAD char* data; + int nd; + ssize_t* dimensions; + ssize_t* strides; + PyObject* base; + PyObject* descr; + int flags; +}; + +struct PyVoidScalarObject_Proxy +{ + PyObject_VAR_HEAD char* obval; + PyArrayDescr_Proxy* descr; + int flags; + PyObject* base; +}; + +struct numpy_type_info +{ + PyObject* dtype_ptr; + std::string format_str; +}; + +struct numpy_internals +{ + std::unordered_map<std::type_index, numpy_type_info> registered_dtypes; + + numpy_type_info* get_type_info(const std::type_info& tinfo, bool throw_if_missing = true) + { + auto it = registered_dtypes.find(std::type_index(tinfo)); + if (it != registered_dtypes.end()) + return &(it->second); + if (throw_if_missing) + pybind11_fail(std::string("NumPy type info missing for ") + tinfo.name()); + return nullptr; + } + + template <typename T> + numpy_type_info* get_type_info(bool throw_if_missing = true) + { + return get_type_info(typeid(typename std::remove_cv<T>::type), throw_if_missing); + } +}; + +inline PYBIND11_NOINLINE void load_numpy_internals(numpy_internals*& ptr) +{ + ptr = &get_or_create_shared_data<numpy_internals>("_numpy_internals"); +} + +inline numpy_internals& get_numpy_internals() +{ + static numpy_internals* ptr = nullptr; + if (!ptr) + load_numpy_internals(ptr); + return *ptr; +} + +struct npy_api +{ + enum constants + { + NPY_ARRAY_C_CONTIGUOUS_ = 0x0001, + NPY_ARRAY_F_CONTIGUOUS_ = 0x0002, + NPY_ARRAY_OWNDATA_ = 0x0004, + NPY_ARRAY_FORCECAST_ = 0x0010, + NPY_ARRAY_ENSUREARRAY_ = 0x0040, + NPY_ARRAY_ALIGNED_ = 0x0100, + NPY_ARRAY_WRITEABLE_ = 0x0400, + NPY_BOOL_ = 0, + NPY_BYTE_, + NPY_UBYTE_, + NPY_SHORT_, + NPY_USHORT_, + NPY_INT_, + NPY_UINT_, + NPY_LONG_, + NPY_ULONG_, + NPY_LONGLONG_, + NPY_ULONGLONG_, + NPY_FLOAT_, + NPY_DOUBLE_, + NPY_LONGDOUBLE_, + NPY_CFLOAT_, + NPY_CDOUBLE_, + NPY_CLONGDOUBLE_, + NPY_OBJECT_ = 17, + NPY_STRING_, + NPY_UNICODE_, + NPY_VOID_ + }; + + typedef struct + { + Py_intptr_t* ptr; + int len; + } PyArray_Dims; + + static npy_api& get() + { + static npy_api api = lookup(); + return api; + } + + bool PyArray_Check_(PyObject* obj) const + { + return (bool)PyObject_TypeCheck(obj, PyArray_Type_); + } + bool PyArrayDescr_Check_(PyObject* obj) const + { + return (bool)PyObject_TypeCheck(obj, PyArrayDescr_Type_); + } + + unsigned int (*PyArray_GetNDArrayCFeatureVersion_)(); + PyObject* (*PyArray_DescrFromType_)(int); + PyObject* (*PyArray_NewFromDescr_)(PyTypeObject*, PyObject*, int, Py_intptr_t*, Py_intptr_t*, void*, int, PyObject*); + PyObject* (*PyArray_DescrNewFromType_)(int); + int (*PyArray_CopyInto_)(PyObject*, PyObject*); + PyObject* (*PyArray_NewCopy_)(PyObject*, int); + PyTypeObject* PyArray_Type_; + PyTypeObject* PyVoidArrType_Type_; + PyTypeObject* PyArrayDescr_Type_; + PyObject* (*PyArray_DescrFromScalar_)(PyObject*); + PyObject* (*PyArray_FromAny_)(PyObject*, PyObject*, int, int, int, PyObject*); + int (*PyArray_DescrConverter_)(PyObject*, PyObject**); + bool (*PyArray_EquivTypes_)(PyObject*, PyObject*); + int (*PyArray_GetArrayParamsFromObject_)( + PyObject*, PyObject*, char, PyObject**, int*, Py_ssize_t*, PyObject**, PyObject*); + PyObject* (*PyArray_Squeeze_)(PyObject*); + int (*PyArray_SetBaseObject_)(PyObject*, PyObject*); + PyObject* (*PyArray_Resize_)(PyObject*, PyArray_Dims*, int, int); + +private: + enum functions + { + API_PyArray_GetNDArrayCFeatureVersion = 211, + API_PyArray_Type = 2, + API_PyArrayDescr_Type = 3, + API_PyVoidArrType_Type = 39, + API_PyArray_DescrFromType = 45, + API_PyArray_DescrFromScalar = 57, + API_PyArray_FromAny = 69, + API_PyArray_Resize = 80, + API_PyArray_CopyInto = 82, + API_PyArray_NewCopy = 85, + API_PyArray_NewFromDescr = 94, + API_PyArray_DescrNewFromType = 9, + API_PyArray_DescrConverter = 174, + API_PyArray_EquivTypes = 182, + API_PyArray_GetArrayParamsFromObject = 278, + API_PyArray_Squeeze = 136, + API_PyArray_SetBaseObject = 282 + }; + + static npy_api lookup() + { + module m = module::import("numpy.core.multiarray"); + auto c = m.attr("_ARRAY_API"); +#if PY_MAJOR_VERSION >= 3 + void** api_ptr = (void**)PyCapsule_GetPointer(c.ptr(), NULL); +#else + void** api_ptr = (void**)PyCObject_AsVoidPtr(c.ptr()); +#endif + npy_api api; +#define DECL_NPY_API(Func) api.Func##_ = (decltype(api.Func##_))api_ptr[API_##Func]; + DECL_NPY_API(PyArray_GetNDArrayCFeatureVersion); + if (api.PyArray_GetNDArrayCFeatureVersion_() < 0x7) + pybind11_fail("pybind11 numpy support requires numpy >= 1.7.0"); + DECL_NPY_API(PyArray_Type); + DECL_NPY_API(PyVoidArrType_Type); + DECL_NPY_API(PyArrayDescr_Type); + DECL_NPY_API(PyArray_DescrFromType); + DECL_NPY_API(PyArray_DescrFromScalar); + DECL_NPY_API(PyArray_FromAny); + DECL_NPY_API(PyArray_Resize); + DECL_NPY_API(PyArray_CopyInto); + DECL_NPY_API(PyArray_NewCopy); + DECL_NPY_API(PyArray_NewFromDescr); + DECL_NPY_API(PyArray_DescrNewFromType); + DECL_NPY_API(PyArray_DescrConverter); + DECL_NPY_API(PyArray_EquivTypes); + DECL_NPY_API(PyArray_GetArrayParamsFromObject); + DECL_NPY_API(PyArray_Squeeze); + DECL_NPY_API(PyArray_SetBaseObject); +#undef DECL_NPY_API + return api; + } +}; + +inline PyArray_Proxy* array_proxy(void* ptr) +{ + return reinterpret_cast<PyArray_Proxy*>(ptr); +} + +inline const PyArray_Proxy* array_proxy(const void* ptr) +{ + return reinterpret_cast<const PyArray_Proxy*>(ptr); +} + +inline PyArrayDescr_Proxy* array_descriptor_proxy(PyObject* ptr) +{ + return reinterpret_cast<PyArrayDescr_Proxy*>(ptr); +} + +inline const PyArrayDescr_Proxy* array_descriptor_proxy(const PyObject* ptr) +{ + return reinterpret_cast<const PyArrayDescr_Proxy*>(ptr); +} + +inline bool check_flags(const void* ptr, int flag) +{ + return (flag == (array_proxy(ptr)->flags & flag)); +} + +template <typename T> +struct is_std_array : std::false_type +{}; +template <typename T, size_t N> +struct is_std_array<std::array<T, N>> : std::true_type +{}; +template <typename T> +struct is_complex : std::false_type +{}; +template <typename T> +struct is_complex<std::complex<T>> : std::true_type +{}; + +template <typename T> +struct array_info_scalar +{ + typedef T type; + static constexpr bool is_array = false; + static constexpr bool is_empty = false; + static constexpr auto extents = _(""); + static void append_extents(list& /* shape */) {} +}; +// Computes underlying type and a comma-separated list of extents for array +// types (any mix of std::array and built-in arrays). An array of char is +// treated as scalar because it gets special handling. +template <typename T> +struct array_info : array_info_scalar<T> +{}; +template <typename T, size_t N> +struct array_info<std::array<T, N>> +{ + using type = typename array_info<T>::type; + static constexpr bool is_array = true; + static constexpr bool is_empty = (N == 0) || array_info<T>::is_empty; + static constexpr size_t extent = N; + + // appends the extents to shape + static void append_extents(list& shape) + { + shape.append(N); + array_info<T>::append_extents(shape); + } + + static constexpr auto extents = _<array_info<T>::is_array>(concat(_<N>(), array_info<T>::extents), _<N>()); +}; +// For numpy we have special handling for arrays of characters, so we don't include +// the size in the array extents. +template <size_t N> +struct array_info<char[N]> : array_info_scalar<char[N]> +{}; +template <size_t N> +struct array_info<std::array<char, N>> : array_info_scalar<std::array<char, N>> +{}; +template <typename T, size_t N> +struct array_info<T[N]> : array_info<std::array<T, N>> +{}; +template <typename T> +using remove_all_extents_t = typename array_info<T>::type; + +template <typename T> +using is_pod_struct = all_of< + std::is_standard_layout<T>, // since we're accessing directly in memory we need a standard layout type +#if !defined(__GNUG__) || defined(_LIBCPP_VERSION) || defined(_GLIBCXX_USE_CXX11_ABI) + // _GLIBCXX_USE_CXX11_ABI indicates that we're using libstdc++ from GCC 5 or newer, independent + // of the actual compiler (Clang can also use libstdc++, but it always defines __GNUC__ == 4). + std::is_trivially_copyable<T>, +#else + // GCC 4 doesn't implement is_trivially_copyable, so approximate it + std::is_trivially_destructible<T>, + satisfies_any_of<T, std::has_trivial_copy_constructor, std::has_trivial_copy_assign>, +#endif + satisfies_none_of<T, std::is_reference, std::is_array, is_std_array, std::is_arithmetic, is_complex, std::is_enum>>; + +template <ssize_t Dim = 0, typename Strides> +ssize_t byte_offset_unsafe(const Strides&) +{ + return 0; +} +template <ssize_t Dim = 0, typename Strides, typename... Ix> +ssize_t byte_offset_unsafe(const Strides& strides, ssize_t i, Ix... index) +{ + return i * strides[Dim] + byte_offset_unsafe<Dim + 1>(strides, index...); +} + +/** + * Proxy class providing unsafe, unchecked const access to array data. This is constructed through + * the `unchecked<T, N>()` method of `array` or the `unchecked<N>()` method of `array_t<T>`. `Dims` + * will be -1 for dimensions determined at runtime. + */ +template <typename T, ssize_t Dims> +class unchecked_reference +{ +protected: + static constexpr bool Dynamic = Dims < 0; + const unsigned char* data_; + // Storing the shape & strides in local variables (i.e. these arrays) allows the compiler to + // make large performance gains on big, nested loops, but requires compile-time dimensions + conditional_t<Dynamic, const ssize_t*, std::array<ssize_t, (size_t)Dims>> shape_, strides_; + const ssize_t dims_; + + friend class pybind11::array; + // Constructor for compile-time dimensions: + template <bool Dyn = Dynamic> + unchecked_reference(const void* data, const ssize_t* shape, const ssize_t* strides, enable_if_t<!Dyn, ssize_t>) + : data_{reinterpret_cast<const unsigned char*>(data)} + , dims_{Dims} + { + for (size_t i = 0; i < (size_t)dims_; i++) { + shape_[i] = shape[i]; + strides_[i] = strides[i]; + } + } + // Constructor for runtime dimensions: + template <bool Dyn = Dynamic> + unchecked_reference(const void* data, const ssize_t* shape, const ssize_t* strides, enable_if_t<Dyn, ssize_t> dims) + : data_{reinterpret_cast<const unsigned char*>(data)} + , shape_{shape} + , strides_{strides} + , dims_{dims} + {} + +public: + /** + * Unchecked const reference access to data at the given indices. For a compile-time known + * number of dimensions, this requires the correct number of arguments; for run-time + * dimensionality, this is not checked (and so is up to the caller to use safely). + */ + template <typename... Ix> + const T& operator()(Ix... index) const + { + static_assert(ssize_t{sizeof...(Ix)} == Dims || Dynamic, "Invalid number of indices for unchecked array reference"); + return *reinterpret_cast<const T*>(data_ + byte_offset_unsafe(strides_, ssize_t(index)...)); + } + /** + * Unchecked const reference access to data; this operator only participates if the reference + * is to a 1-dimensional array. When present, this is exactly equivalent to `obj(index)`. + */ + template <ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>> + const T& operator[](ssize_t index) const + { + return operator()(index); + } + + /// Pointer access to the data at the given indices. + template <typename... Ix> + const T* data(Ix... ix) const + { + return &operator()(ssize_t(ix)...); + } + + /// Returns the item size, i.e. sizeof(T) + constexpr static ssize_t itemsize() + { + return sizeof(T); + } + + /// Returns the shape (i.e. size) of dimension `dim` + ssize_t shape(ssize_t dim) const + { + return shape_[(size_t)dim]; + } + + /// Returns the number of dimensions of the array + ssize_t ndim() const + { + return dims_; + } + + /// Returns the total number of elements in the referenced array, i.e. the product of the shapes + template <bool Dyn = Dynamic> + enable_if_t<!Dyn, ssize_t> size() const + { + return std::accumulate(shape_.begin(), shape_.end(), (ssize_t)1, std::multiplies<ssize_t>()); + } + template <bool Dyn = Dynamic> + enable_if_t<Dyn, ssize_t> size() const + { + return std::accumulate(shape_, shape_ + ndim(), (ssize_t)1, std::multiplies<ssize_t>()); + } + + /// Returns the total number of bytes used by the referenced data. Note that the actual span in + /// memory may be larger if the referenced array has non-contiguous strides (e.g. for a slice). + ssize_t nbytes() const + { + return size() * itemsize(); + } +}; + +template <typename T, ssize_t Dims> +class unchecked_mutable_reference : public unchecked_reference<T, Dims> +{ + friend class pybind11::array; + using ConstBase = unchecked_reference<T, Dims>; + using ConstBase::ConstBase; + using ConstBase::Dynamic; + +public: + /// Mutable, unchecked access to data at the given indices. + template <typename... Ix> + T& operator()(Ix... index) + { + static_assert(ssize_t{sizeof...(Ix)} == Dims || Dynamic, "Invalid number of indices for unchecked array reference"); + return const_cast<T&>(ConstBase::operator()(index...)); + } + /** + * Mutable, unchecked access data at the given index; this operator only participates if the + * reference is to a 1-dimensional array (or has runtime dimensions). When present, this is + * exactly equivalent to `obj(index)`. + */ + template <ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>> + T& operator[](ssize_t index) + { + return operator()(index); + } + + /// Mutable pointer access to the data at the given indices. + template <typename... Ix> + T* mutable_data(Ix... ix) + { + return &operator()(ssize_t(ix)...); + } +}; + +template <typename T, ssize_t Dim> +struct type_caster<unchecked_reference<T, Dim>> +{ + static_assert(Dim == 0 && Dim > 0 /* always fail */, "unchecked array proxy object is not castable"); +}; +template <typename T, ssize_t Dim> +struct type_caster<unchecked_mutable_reference<T, Dim>> : type_caster<unchecked_reference<T, Dim>> +{}; + +NAMESPACE_END(detail) + +class dtype : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(dtype, object, detail::npy_api::get().PyArrayDescr_Check_); + + explicit dtype(const buffer_info& info) + { + dtype descr(_dtype_from_pep3118()(PYBIND11_STR_TYPE(info.format))); + // If info.itemsize == 0, use the value calculated from the format string + m_ptr = descr.strip_padding(info.itemsize ? info.itemsize : descr.itemsize()).release().ptr(); + } + + explicit dtype(const std::string& format) + { + m_ptr = from_args(pybind11::str(format)).release().ptr(); + } + + dtype(const char* format) + : dtype(std::string(format)) + {} + + dtype(list names, list formats, list offsets, ssize_t itemsize) + { + dict args; + args["names"] = names; + args["formats"] = formats; + args["offsets"] = offsets; + args["itemsize"] = pybind11::int_(itemsize); + m_ptr = from_args(args).release().ptr(); + } + + /// This is essentially the same as calling numpy.dtype(args) in Python. + static dtype from_args(object args) + { + PyObject* ptr = nullptr; + if (!detail::npy_api::get().PyArray_DescrConverter_(args.ptr(), &ptr) || !ptr) + throw error_already_set(); + return reinterpret_steal<dtype>(ptr); + } + + /// Return dtype associated with a C++ type. + template <typename T> + static dtype of() + { + return detail::npy_format_descriptor<typename std::remove_cv<T>::type>::dtype(); + } + + /// Size of the data type in bytes. + ssize_t itemsize() const + { + return detail::array_descriptor_proxy(m_ptr)->elsize; + } + + /// Returns true for structured data types. + bool has_fields() const + { + return detail::array_descriptor_proxy(m_ptr)->names != nullptr; + } + + /// Single-character type code. + char kind() const + { + return detail::array_descriptor_proxy(m_ptr)->kind; + } + +private: + static object _dtype_from_pep3118() + { + static PyObject* obj = + module::import("numpy.core._internal").attr("_dtype_from_pep3118").cast<object>().release().ptr(); + return reinterpret_borrow<object>(obj); + } + + dtype strip_padding(ssize_t itemsize) + { + // Recursively strip all void fields with empty names that are generated for + // padding fields (as of NumPy v1.11). + if (!has_fields()) + return *this; + + struct field_descr + { + PYBIND11_STR_TYPE name; + object format; + pybind11::int_ offset; + }; + std::vector<field_descr> field_descriptors; + + for (auto field : attr("fields").attr("items")()) { + auto spec = field.cast<tuple>(); + auto name = spec[0].cast<pybind11::str>(); + auto format = spec[1].cast<tuple>()[0].cast<dtype>(); + auto offset = spec[1].cast<tuple>()[1].cast<pybind11::int_>(); + if (!len(name) && format.kind() == 'V') + continue; + field_descriptors.push_back({(PYBIND11_STR_TYPE)name, format.strip_padding(format.itemsize()), offset}); + } + + std::sort(field_descriptors.begin(), field_descriptors.end(), [](const field_descr& a, const field_descr& b) { + return a.offset.cast<int>() < b.offset.cast<int>(); + }); + + list names, formats, offsets; + for (auto& descr : field_descriptors) { + names.append(descr.name); + formats.append(descr.format); + offsets.append(descr.offset); + } + return dtype(names, formats, offsets, itemsize); + } +}; + +class array : public buffer +{ +public: + PYBIND11_OBJECT_CVT(array, buffer, detail::npy_api::get().PyArray_Check_, raw_array) + + enum + { + c_style = detail::npy_api::NPY_ARRAY_C_CONTIGUOUS_, + f_style = detail::npy_api::NPY_ARRAY_F_CONTIGUOUS_, + forcecast = detail::npy_api::NPY_ARRAY_FORCECAST_ + }; + + array() + : array({{0}}, static_cast<const double*>(nullptr)) + {} + + using ShapeContainer = detail::any_container<ssize_t>; + using StridesContainer = detail::any_container<ssize_t>; + + // Constructs an array taking shape/strides from arbitrary container types + array(const pybind11::dtype& dt, + ShapeContainer shape, + StridesContainer strides, + const void* ptr = nullptr, + handle base = handle()) + { + + if (strides->empty()) + *strides = c_strides(*shape, dt.itemsize()); + + auto ndim = shape->size(); + if (ndim != strides->size()) + pybind11_fail("NumPy: shape ndim doesn't match strides ndim"); + auto descr = dt; + + int flags = 0; + if (base && ptr) { + if (isinstance<array>(base)) + /* Copy flags from base (except ownership bit) */ + flags = reinterpret_borrow<array>(base).flags() & ~detail::npy_api::NPY_ARRAY_OWNDATA_; + else + /* Writable by default, easy to downgrade later on if needed */ + flags = detail::npy_api::NPY_ARRAY_WRITEABLE_; + } + + auto& api = detail::npy_api::get(); + auto tmp = reinterpret_steal<object>(api.PyArray_NewFromDescr_(api.PyArray_Type_, + descr.release().ptr(), + (int)ndim, + shape->data(), + strides->data(), + const_cast<void*>(ptr), + flags, + nullptr)); + if (!tmp) + throw error_already_set(); + if (ptr) { + if (base) { + api.PyArray_SetBaseObject_(tmp.ptr(), base.inc_ref().ptr()); + } else { + tmp = reinterpret_steal<object>(api.PyArray_NewCopy_(tmp.ptr(), -1 /* any order */)); + } + } + m_ptr = tmp.release().ptr(); + } + + array(const pybind11::dtype& dt, ShapeContainer shape, const void* ptr = nullptr, handle base = handle()) + : array(dt, std::move(shape), {}, ptr, base) + {} + + template <typename T, typename = detail::enable_if_t<std::is_integral<T>::value && !std::is_same<bool, T>::value>> + array(const pybind11::dtype& dt, T count, const void* ptr = nullptr, handle base = handle()) + : array(dt, {{count}}, ptr, base) + {} + + template <typename T> + array(ShapeContainer shape, StridesContainer strides, const T* ptr, handle base = handle()) + : array(pybind11::dtype::of<T>(), std::move(shape), std::move(strides), ptr, base) + {} + + template <typename T> + array(ShapeContainer shape, const T* ptr, handle base = handle()) + : array(std::move(shape), {}, ptr, base) + {} + + template <typename T> + explicit array(ssize_t count, const T* ptr, handle base = handle()) + : array({count}, {}, ptr, base) + {} + + explicit array(const buffer_info& info) + : array(pybind11::dtype(info), info.shape, info.strides, info.ptr) + {} + + /// Array descriptor (dtype) + pybind11::dtype dtype() const + { + return reinterpret_borrow<pybind11::dtype>(detail::array_proxy(m_ptr)->descr); + } + + /// Total number of elements + ssize_t size() const + { + return std::accumulate(shape(), shape() + ndim(), (ssize_t)1, std::multiplies<ssize_t>()); + } + + /// Byte size of a single element + ssize_t itemsize() const + { + return detail::array_descriptor_proxy(detail::array_proxy(m_ptr)->descr)->elsize; + } + + /// Total number of bytes + ssize_t nbytes() const + { + return size() * itemsize(); + } + + /// Number of dimensions + ssize_t ndim() const + { + return detail::array_proxy(m_ptr)->nd; + } + + /// Base object + object base() const + { + return reinterpret_borrow<object>(detail::array_proxy(m_ptr)->base); + } + + /// Dimensions of the array + const ssize_t* shape() const + { + return detail::array_proxy(m_ptr)->dimensions; + } + + /// Dimension along a given axis + ssize_t shape(ssize_t dim) const + { + if (dim >= ndim()) + fail_dim_check(dim, "invalid axis"); + return shape()[dim]; + } + + /// Strides of the array + const ssize_t* strides() const + { + return detail::array_proxy(m_ptr)->strides; + } + + /// Stride along a given axis + ssize_t strides(ssize_t dim) const + { + if (dim >= ndim()) + fail_dim_check(dim, "invalid axis"); + return strides()[dim]; + } + + /// Return the NumPy array flags + int flags() const + { + return detail::array_proxy(m_ptr)->flags; + } + + /// If set, the array is writeable (otherwise the buffer is read-only) + bool writeable() const + { + return detail::check_flags(m_ptr, detail::npy_api::NPY_ARRAY_WRITEABLE_); + } + + /// If set, the array owns the data (will be freed when the array is deleted) + bool owndata() const + { + return detail::check_flags(m_ptr, detail::npy_api::NPY_ARRAY_OWNDATA_); + } + + /// Pointer to the contained data. If index is not provided, points to the + /// beginning of the buffer. May throw if the index would lead to out of bounds access. + template <typename... Ix> + const void* data(Ix... index) const + { + return static_cast<const void*>(detail::array_proxy(m_ptr)->data + offset_at(index...)); + } + + /// Mutable pointer to the contained data. If index is not provided, points to the + /// beginning of the buffer. May throw if the index would lead to out of bounds access. + /// May throw if the array is not writeable. + template <typename... Ix> + void* mutable_data(Ix... index) + { + check_writeable(); + return static_cast<void*>(detail::array_proxy(m_ptr)->data + offset_at(index...)); + } + + /// Byte offset from beginning of the array to a given index (full or partial). + /// May throw if the index would lead to out of bounds access. + template <typename... Ix> + ssize_t offset_at(Ix... index) const + { + if ((ssize_t)sizeof...(index) > ndim()) + fail_dim_check(sizeof...(index), "too many indices for an array"); + return byte_offset(ssize_t(index)...); + } + + ssize_t offset_at() const + { + return 0; + } + + /// Item count from beginning of the array to a given index (full or partial). + /// May throw if the index would lead to out of bounds access. + template <typename... Ix> + ssize_t index_at(Ix... index) const + { + return offset_at(index...) / itemsize(); + } + + /** + * Returns a proxy object that provides access to the array's data without bounds or + * dimensionality checking. Will throw if the array is missing the `writeable` flag. Use with + * care: the array must not be destroyed or reshaped for the duration of the returned object, + * and the caller must take care not to access invalid dimensions or dimension indices. + */ + template <typename T, ssize_t Dims = -1> + detail::unchecked_mutable_reference<T, Dims> mutable_unchecked() & + { + if (Dims >= 0 && ndim() != Dims) + throw std::domain_error("array has incorrect number of dimensions: " + std::to_string(ndim()) + "; expected " + + std::to_string(Dims)); + return detail::unchecked_mutable_reference<T, Dims>(mutable_data(), shape(), strides(), ndim()); + } + + /** + * Returns a proxy object that provides const access to the array's data without bounds or + * dimensionality checking. Unlike `mutable_unchecked()`, this does not require that the + * underlying array have the `writable` flag. Use with care: the array must not be destroyed or + * reshaped for the duration of the returned object, and the caller must take care not to access + * invalid dimensions or dimension indices. + */ + template <typename T, ssize_t Dims = -1> + detail::unchecked_reference<T, Dims> unchecked() const& + { + if (Dims >= 0 && ndim() != Dims) + throw std::domain_error("array has incorrect number of dimensions: " + std::to_string(ndim()) + "; expected " + + std::to_string(Dims)); + return detail::unchecked_reference<T, Dims>(data(), shape(), strides(), ndim()); + } + + /// Return a new view with all of the dimensions of length 1 removed + array squeeze() + { + auto& api = detail::npy_api::get(); + return reinterpret_steal<array>(api.PyArray_Squeeze_(m_ptr)); + } + + /// Resize array to given shape + /// If refcheck is true and more that one reference exist to this array + /// then resize will succeed only if it makes a reshape, i.e. original size doesn't change + void resize(ShapeContainer new_shape, bool refcheck = true) + { + detail::npy_api::PyArray_Dims d = {new_shape->data(), int(new_shape->size())}; + // try to resize, set ordering param to -1 cause it's not used anyway + object new_array = reinterpret_steal<object>(detail::npy_api::get().PyArray_Resize_(m_ptr, &d, int(refcheck), -1)); + if (!new_array) + throw error_already_set(); + if (isinstance<array>(new_array)) { + *this = std::move(new_array); + } + } + + /// Ensure that the argument is a NumPy array + /// In case of an error, nullptr is returned and the Python error is cleared. + static array ensure(handle h, int ExtraFlags = 0) + { + auto result = reinterpret_steal<array>(raw_array(h.ptr(), ExtraFlags)); + if (!result) + PyErr_Clear(); + return result; + } + +protected: + template <typename, typename> + friend struct detail::npy_format_descriptor; + + void fail_dim_check(ssize_t dim, const std::string& msg) const + { + throw index_error(msg + ": " + std::to_string(dim) + " (ndim = " + std::to_string(ndim()) + ")"); + } + + template <typename... Ix> + ssize_t byte_offset(Ix... index) const + { + check_dimensions(index...); + return detail::byte_offset_unsafe(strides(), ssize_t(index)...); + } + + void check_writeable() const + { + if (!writeable()) + throw std::domain_error("array is not writeable"); + } + + // Default, C-style strides + static std::vector<ssize_t> c_strides(const std::vector<ssize_t>& shape, ssize_t itemsize) + { + auto ndim = shape.size(); + std::vector<ssize_t> strides(ndim, itemsize); + if (ndim > 0) + for (size_t i = ndim - 1; i > 0; --i) + strides[i - 1] = strides[i] * shape[i]; + return strides; + } + + // F-style strides; default when constructing an array_t with `ExtraFlags & f_style` + static std::vector<ssize_t> f_strides(const std::vector<ssize_t>& shape, ssize_t itemsize) + { + auto ndim = shape.size(); + std::vector<ssize_t> strides(ndim, itemsize); + for (size_t i = 1; i < ndim; ++i) + strides[i] = strides[i - 1] * shape[i - 1]; + return strides; + } + + template <typename... Ix> + void check_dimensions(Ix... index) const + { + check_dimensions_impl(ssize_t(0), shape(), ssize_t(index)...); + } + + void check_dimensions_impl(ssize_t, const ssize_t*) const {} + + template <typename... Ix> + void check_dimensions_impl(ssize_t axis, const ssize_t* shape, ssize_t i, Ix... index) const + { + if (i >= *shape) { + throw index_error(std::string("index ") + std::to_string(i) + " is out of bounds for axis " + std::to_string(axis) + + " with size " + std::to_string(*shape)); + } + check_dimensions_impl(axis + 1, shape + 1, index...); + } + + /// Create array from any object -- always returns a new reference + static PyObject* raw_array(PyObject* ptr, int ExtraFlags = 0) + { + if (ptr == nullptr) { + PyErr_SetString(PyExc_ValueError, "cannot create a pybind11::array from a nullptr"); + return nullptr; + } + return detail::npy_api::get().PyArray_FromAny_( + ptr, nullptr, 0, 0, detail::npy_api::NPY_ARRAY_ENSUREARRAY_ | ExtraFlags, nullptr); + } +}; + +template <typename T, int ExtraFlags = array::forcecast> +class array_t : public array +{ +private: + struct private_ctor + {}; + // Delegating constructor needed when both moving and accessing in the same constructor + array_t(private_ctor, ShapeContainer&& shape, StridesContainer&& strides, const T* ptr, handle base) + : array(std::move(shape), std::move(strides), ptr, base) + {} + +public: + static_assert(!detail::array_info<T>::is_array, "Array types cannot be used with array_t"); + + using value_type = T; + + array_t() + : array(0, static_cast<const T*>(nullptr)) + {} + array_t(handle h, borrowed_t) + : array(h, borrowed_t{}) + {} + array_t(handle h, stolen_t) + : array(h, stolen_t{}) + {} + + PYBIND11_DEPRECATED("Use array_t<T>::ensure() instead") + array_t(handle h, bool is_borrowed) + : array(raw_array_t(h.ptr()), stolen_t{}) + { + if (!m_ptr) + PyErr_Clear(); + if (!is_borrowed) + Py_XDECREF(h.ptr()); + } + + array_t(const object& o) + : array(raw_array_t(o.ptr()), stolen_t{}) + { + if (!m_ptr) + throw error_already_set(); + } + + explicit array_t(const buffer_info& info) + : array(info) + {} + + array_t(ShapeContainer shape, StridesContainer strides, const T* ptr = nullptr, handle base = handle()) + : array(std::move(shape), std::move(strides), ptr, base) + {} + + explicit array_t(ShapeContainer shape, const T* ptr = nullptr, handle base = handle()) + : array_t(private_ctor{}, + std::move(shape), + ExtraFlags & f_style ? f_strides(*shape, itemsize()) : c_strides(*shape, itemsize()), + ptr, + base) + {} + + explicit array_t(size_t count, const T* ptr = nullptr, handle base = handle()) + : array({count}, {}, ptr, base) + {} + + constexpr ssize_t itemsize() const + { + return sizeof(T); + } + + template <typename... Ix> + ssize_t index_at(Ix... index) const + { + return offset_at(index...) / itemsize(); + } + + template <typename... Ix> + const T* data(Ix... index) const + { + return static_cast<const T*>(array::data(index...)); + } + + template <typename... Ix> + T* mutable_data(Ix... index) + { + return static_cast<T*>(array::mutable_data(index...)); + } + + // Reference to element at a given index + template <typename... Ix> + const T& at(Ix... index) const + { + if ((ssize_t)sizeof...(index) != ndim()) + fail_dim_check(sizeof...(index), "index dimension mismatch"); + return *(static_cast<const T*>(array::data()) + byte_offset(ssize_t(index)...) / itemsize()); + } + + // Mutable reference to element at a given index + template <typename... Ix> + T& mutable_at(Ix... index) + { + if ((ssize_t)sizeof...(index) != ndim()) + fail_dim_check(sizeof...(index), "index dimension mismatch"); + return *(static_cast<T*>(array::mutable_data()) + byte_offset(ssize_t(index)...) / itemsize()); + } + + /** + * Returns a proxy object that provides access to the array's data without bounds or + * dimensionality checking. Will throw if the array is missing the `writeable` flag. Use with + * care: the array must not be destroyed or reshaped for the duration of the returned object, + * and the caller must take care not to access invalid dimensions or dimension indices. + */ + template <ssize_t Dims = -1> + detail::unchecked_mutable_reference<T, Dims> mutable_unchecked() & + { + return array::mutable_unchecked<T, Dims>(); + } + + /** + * Returns a proxy object that provides const access to the array's data without bounds or + * dimensionality checking. Unlike `unchecked()`, this does not require that the underlying + * array have the `writable` flag. Use with care: the array must not be destroyed or reshaped + * for the duration of the returned object, and the caller must take care not to access invalid + * dimensions or dimension indices. + */ + template <ssize_t Dims = -1> + detail::unchecked_reference<T, Dims> unchecked() const& + { + return array::unchecked<T, Dims>(); + } + + /// Ensure that the argument is a NumPy array of the correct dtype (and if not, try to convert + /// it). In case of an error, nullptr is returned and the Python error is cleared. + static array_t ensure(handle h) + { + auto result = reinterpret_steal<array_t>(raw_array_t(h.ptr())); + if (!result) + PyErr_Clear(); + return result; + } + + static bool check_(handle h) + { + const auto& api = detail::npy_api::get(); + return api.PyArray_Check_(h.ptr()) + && api.PyArray_EquivTypes_(detail::array_proxy(h.ptr())->descr, dtype::of<T>().ptr()); + } + +protected: + /// Create array from any object -- always returns a new reference + static PyObject* raw_array_t(PyObject* ptr) + { + if (ptr == nullptr) { + PyErr_SetString(PyExc_ValueError, "cannot create a pybind11::array_t from a nullptr"); + return nullptr; + } + return detail::npy_api::get().PyArray_FromAny_( + ptr, dtype::of<T>().release().ptr(), 0, 0, detail::npy_api::NPY_ARRAY_ENSUREARRAY_ | ExtraFlags, nullptr); + } +}; + +template <typename T> +struct format_descriptor<T, detail::enable_if_t<detail::is_pod_struct<T>::value>> +{ + static std::string format() + { + return detail::npy_format_descriptor<typename std::remove_cv<T>::type>::format(); + } +}; + +template <size_t N> +struct format_descriptor<char[N]> +{ + static std::string format() + { + return std::to_string(N) + "s"; + } +}; +template <size_t N> +struct format_descriptor<std::array<char, N>> +{ + static std::string format() + { + return std::to_string(N) + "s"; + } +}; + +template <typename T> +struct format_descriptor<T, detail::enable_if_t<std::is_enum<T>::value>> +{ + static std::string format() + { + return format_descriptor<typename std::remove_cv<typename std::underlying_type<T>::type>::type>::format(); + } +}; + +template <typename T> +struct format_descriptor<T, detail::enable_if_t<detail::array_info<T>::is_array>> +{ + static std::string format() + { + using namespace detail; + static constexpr auto extents = _("(") + array_info<T>::extents + _(")"); + return extents.text + format_descriptor<remove_all_extents_t<T>>::format(); + } +}; + +NAMESPACE_BEGIN(detail) +template <typename T, int ExtraFlags> +struct pyobject_caster<array_t<T, ExtraFlags>> +{ + using type = array_t<T, ExtraFlags>; + + bool load(handle src, bool convert) + { + if (!convert && !type::check_(src)) + return false; + value = type::ensure(src); + return static_cast<bool>(value); + } + + static handle cast(const handle& src, return_value_policy /* policy */, handle /* parent */) + { + return src.inc_ref(); + } + PYBIND11_TYPE_CASTER(type, handle_type_name<type>::name); +}; + +template <typename T> +struct compare_buffer_info<T, detail::enable_if_t<detail::is_pod_struct<T>::value>> +{ + static bool compare(const buffer_info& b) + { + return npy_api::get().PyArray_EquivTypes_(dtype::of<T>().ptr(), dtype(b).ptr()); + } +}; + +template <typename T, typename = void> +struct npy_format_descriptor_name; + +template <typename T> +struct npy_format_descriptor_name<T, enable_if_t<std::is_integral<T>::value>> +{ + static constexpr auto name = + _<std::is_same<T, bool>::value>(_("bool"), _<std::is_signed<T>::value>("int", "uint") + _<sizeof(T) * 8>()); +}; + +template <typename T> +struct npy_format_descriptor_name<T, enable_if_t<std::is_floating_point<T>::value>> +{ + static constexpr auto name = _ < std::is_same<T, float>::value + || std::is_same<T, double>::value > (_("float") + _<sizeof(T) * 8>(), _("longdouble")); +}; + +template <typename T> +struct npy_format_descriptor_name<T, enable_if_t<is_complex<T>::value>> +{ + static constexpr auto name = _ < std::is_same<typename T::value_type, float>::value + || std::is_same<typename T::value_type, double>::value + > (_("complex") + _<sizeof(typename T::value_type) * 16>(), _("longcomplex")); +}; + +template <typename T> +struct npy_format_descriptor<T, enable_if_t<satisfies_any_of<T, std::is_arithmetic, is_complex>::value>> + : npy_format_descriptor_name<T> +{ +private: + // NB: the order here must match the one in common.h + constexpr static const int values[15] = {npy_api::NPY_BOOL_, + npy_api::NPY_BYTE_, + npy_api::NPY_UBYTE_, + npy_api::NPY_SHORT_, + npy_api::NPY_USHORT_, + npy_api::NPY_INT_, + npy_api::NPY_UINT_, + npy_api::NPY_LONGLONG_, + npy_api::NPY_ULONGLONG_, + npy_api::NPY_FLOAT_, + npy_api::NPY_DOUBLE_, + npy_api::NPY_LONGDOUBLE_, + npy_api::NPY_CFLOAT_, + npy_api::NPY_CDOUBLE_, + npy_api::NPY_CLONGDOUBLE_}; + +public: + static constexpr int value = values[detail::is_fmt_numeric<T>::index]; + + static pybind11::dtype dtype() + { + if (auto ptr = npy_api::get().PyArray_DescrFromType_(value)) + return reinterpret_borrow<pybind11::dtype>(ptr); + pybind11_fail("Unsupported buffer format!"); + } +}; + +#define PYBIND11_DECL_CHAR_FMT \ + static constexpr auto name = _("S") + _<N>(); \ + static pybind11::dtype dtype() \ + { \ + return pybind11::dtype(std::string("S") + std::to_string(N)); \ + } +template <size_t N> +struct npy_format_descriptor<char[N]> +{ + PYBIND11_DECL_CHAR_FMT +}; +template <size_t N> +struct npy_format_descriptor<std::array<char, N>> +{ + PYBIND11_DECL_CHAR_FMT +}; +#undef PYBIND11_DECL_CHAR_FMT + +template <typename T> +struct npy_format_descriptor<T, enable_if_t<array_info<T>::is_array>> +{ +private: + using base_descr = npy_format_descriptor<typename array_info<T>::type>; + +public: + static_assert(!array_info<T>::is_empty, "Zero-sized arrays are not supported"); + + static constexpr auto name = _("(") + array_info<T>::extents + _(")") + base_descr::name; + static pybind11::dtype dtype() + { + list shape; + array_info<T>::append_extents(shape); + return pybind11::dtype::from_args(pybind11::make_tuple(base_descr::dtype(), shape)); + } +}; + +template <typename T> +struct npy_format_descriptor<T, enable_if_t<std::is_enum<T>::value>> +{ +private: + using base_descr = npy_format_descriptor<typename std::underlying_type<T>::type>; + +public: + static constexpr auto name = base_descr::name; + static pybind11::dtype dtype() + { + return base_descr::dtype(); + } +}; + +struct field_descriptor +{ + const char* name; + ssize_t offset; + ssize_t size; + std::string format; + dtype descr; +}; + +inline PYBIND11_NOINLINE void register_structured_dtype(any_container<field_descriptor> fields, + const std::type_info& tinfo, + ssize_t itemsize, + bool (*direct_converter)(PyObject*, void*&)) +{ + + auto& numpy_internals = get_numpy_internals(); + if (numpy_internals.get_type_info(tinfo, false)) + pybind11_fail("NumPy: dtype is already registered"); + + list names, formats, offsets; + for (auto field : *fields) { + if (!field.descr) + pybind11_fail(std::string("NumPy: unsupported field dtype: `") + field.name + "` @ " + tinfo.name()); + names.append(PYBIND11_STR_TYPE(field.name)); + formats.append(field.descr); + offsets.append(pybind11::int_(field.offset)); + } + auto dtype_ptr = pybind11::dtype(names, formats, offsets, itemsize).release().ptr(); + + // There is an existing bug in NumPy (as of v1.11): trailing bytes are + // not encoded explicitly into the format string. This will supposedly + // get fixed in v1.12; for further details, see these: + // - https://github.com/numpy/numpy/issues/7797 + // - https://github.com/numpy/numpy/pull/7798 + // Because of this, we won't use numpy's logic to generate buffer format + // strings and will just do it ourselves. + std::vector<field_descriptor> ordered_fields(std::move(fields)); + std::sort(ordered_fields.begin(), ordered_fields.end(), [](const field_descriptor& a, const field_descriptor& b) { + return a.offset < b.offset; + }); + ssize_t offset = 0; + std::ostringstream oss; + // mark the structure as unaligned with '^', because numpy and C++ don't + // always agree about alignment (particularly for complex), and we're + // explicitly listing all our padding. This depends on none of the fields + // overriding the endianness. Putting the ^ in front of individual fields + // isn't guaranteed to work due to https://github.com/numpy/numpy/issues/9049 + oss << "^T{"; + for (auto& field : ordered_fields) { + if (field.offset > offset) + oss << (field.offset - offset) << 'x'; + oss << field.format << ':' << field.name << ':'; + offset = field.offset + field.size; + } + if (itemsize > offset) + oss << (itemsize - offset) << 'x'; + oss << '}'; + auto format_str = oss.str(); + + // Sanity check: verify that NumPy properly parses our buffer format string + auto& api = npy_api::get(); + auto arr = array(buffer_info(nullptr, itemsize, format_str, 1)); + if (!api.PyArray_EquivTypes_(dtype_ptr, arr.dtype().ptr())) + pybind11_fail("NumPy: invalid buffer descriptor!"); + + auto tindex = std::type_index(tinfo); + numpy_internals.registered_dtypes[tindex] = {dtype_ptr, format_str}; + get_internals().direct_conversions[tindex].push_back(direct_converter); +} + +template <typename T, typename SFINAE> +struct npy_format_descriptor +{ + static_assert(is_pod_struct<T>::value, "Attempt to use a non-POD or unimplemented POD type as a numpy dtype"); + + static constexpr auto name = make_caster<T>::name; + + static pybind11::dtype dtype() + { + return reinterpret_borrow<pybind11::dtype>(dtype_ptr()); + } + + static std::string format() + { + static auto format_str = get_numpy_internals().get_type_info<T>(true)->format_str; + return format_str; + } + + static void register_dtype(any_container<field_descriptor> fields) + { + register_structured_dtype( + std::move(fields), typeid(typename std::remove_cv<T>::type), sizeof(T), &direct_converter); + } + +private: + static PyObject* dtype_ptr() + { + static PyObject* ptr = get_numpy_internals().get_type_info<T>(true)->dtype_ptr; + return ptr; + } + + static bool direct_converter(PyObject* obj, void*& value) + { + auto& api = npy_api::get(); + if (!PyObject_TypeCheck(obj, api.PyVoidArrType_Type_)) + return false; + if (auto descr = reinterpret_steal<object>(api.PyArray_DescrFromScalar_(obj))) { + if (api.PyArray_EquivTypes_(dtype_ptr(), descr.ptr())) { + value = ((PyVoidScalarObject_Proxy*)obj)->obval; + return true; + } + } + return false; + } +}; + +#ifdef __CLION_IDE__ // replace heavy macro with dummy code for the IDE (doesn't affect code) +# define PYBIND11_NUMPY_DTYPE(Type, ...) ((void)0) +# define PYBIND11_NUMPY_DTYPE_EX(Type, ...) ((void)0) +#else + +# define PYBIND11_FIELD_DESCRIPTOR_EX(T, Field, Name) \ + ::pybind11::detail::field_descriptor \ + { \ + Name, offsetof(T, Field), sizeof(decltype(std::declval<T>().Field)), \ + ::pybind11::format_descriptor<decltype(std::declval<T>().Field)>::format(), \ + ::pybind11::detail::npy_format_descriptor<decltype(std::declval<T>().Field)>::dtype() \ + } + +// Extract name, offset and format descriptor for a struct field +# define PYBIND11_FIELD_DESCRIPTOR(T, Field) PYBIND11_FIELD_DESCRIPTOR_EX(T, Field, # Field) + +// The main idea of this macro is borrowed from https://github.com/swansontec/map-macro +// (C) William Swanson, Paul Fultz +# define PYBIND11_EVAL0(...) __VA_ARGS__ +# define PYBIND11_EVAL1(...) PYBIND11_EVAL0(PYBIND11_EVAL0(PYBIND11_EVAL0(__VA_ARGS__))) +# define PYBIND11_EVAL2(...) PYBIND11_EVAL1(PYBIND11_EVAL1(PYBIND11_EVAL1(__VA_ARGS__))) +# define PYBIND11_EVAL3(...) PYBIND11_EVAL2(PYBIND11_EVAL2(PYBIND11_EVAL2(__VA_ARGS__))) +# define PYBIND11_EVAL4(...) PYBIND11_EVAL3(PYBIND11_EVAL3(PYBIND11_EVAL3(__VA_ARGS__))) +# define PYBIND11_EVAL(...) PYBIND11_EVAL4(PYBIND11_EVAL4(PYBIND11_EVAL4(__VA_ARGS__))) +# define PYBIND11_MAP_END(...) +# define PYBIND11_MAP_OUT +# define PYBIND11_MAP_COMMA , +# define PYBIND11_MAP_GET_END() 0, PYBIND11_MAP_END +# define PYBIND11_MAP_NEXT0(test, next, ...) next PYBIND11_MAP_OUT +# define PYBIND11_MAP_NEXT1(test, next) PYBIND11_MAP_NEXT0(test, next, 0) +# define PYBIND11_MAP_NEXT(test, next) PYBIND11_MAP_NEXT1(PYBIND11_MAP_GET_END test, next) +# ifdef _MSC_VER // MSVC is not as eager to expand macros, hence this workaround +# define PYBIND11_MAP_LIST_NEXT1(test, next) PYBIND11_EVAL0(PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0)) +# else +# define PYBIND11_MAP_LIST_NEXT1(test, next) PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0) +# endif +# define PYBIND11_MAP_LIST_NEXT(test, next) PYBIND11_MAP_LIST_NEXT1(PYBIND11_MAP_GET_END test, next) +# define PYBIND11_MAP_LIST0(f, t, x, peek, ...) \ + f(t, x) PYBIND11_MAP_LIST_NEXT(peek, PYBIND11_MAP_LIST1)(f, t, peek, __VA_ARGS__) +# define PYBIND11_MAP_LIST1(f, t, x, peek, ...) \ + f(t, x) PYBIND11_MAP_LIST_NEXT(peek, PYBIND11_MAP_LIST0)(f, t, peek, __VA_ARGS__) +// PYBIND11_MAP_LIST(f, t, a1, a2, ...) expands to f(t, a1), f(t, a2), ... +# define PYBIND11_MAP_LIST(f, t, ...) PYBIND11_EVAL(PYBIND11_MAP_LIST1(f, t, __VA_ARGS__, (), 0)) + +# define PYBIND11_NUMPY_DTYPE(Type, ...) \ + ::pybind11::detail::npy_format_descriptor<Type>::register_dtype( \ + ::std::vector<::pybind11::detail::field_descriptor>{ \ + PYBIND11_MAP_LIST(PYBIND11_FIELD_DESCRIPTOR, Type, __VA_ARGS__)}) + +# ifdef _MSC_VER +# define PYBIND11_MAP2_LIST_NEXT1(test, next) PYBIND11_EVAL0(PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0)) +# else +# define PYBIND11_MAP2_LIST_NEXT1(test, next) PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0) +# endif +# define PYBIND11_MAP2_LIST_NEXT(test, next) PYBIND11_MAP2_LIST_NEXT1(PYBIND11_MAP_GET_END test, next) +# define PYBIND11_MAP2_LIST0(f, t, x1, x2, peek, ...) \ + f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT(peek, PYBIND11_MAP2_LIST1)(f, t, peek, __VA_ARGS__) +# define PYBIND11_MAP2_LIST1(f, t, x1, x2, peek, ...) \ + f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT(peek, PYBIND11_MAP2_LIST0)(f, t, peek, __VA_ARGS__) +// PYBIND11_MAP2_LIST(f, t, a1, a2, ...) expands to f(t, a1, a2), f(t, a3, a4), ... +# define PYBIND11_MAP2_LIST(f, t, ...) PYBIND11_EVAL(PYBIND11_MAP2_LIST1(f, t, __VA_ARGS__, (), 0)) + +# define PYBIND11_NUMPY_DTYPE_EX(Type, ...) \ + ::pybind11::detail::npy_format_descriptor<Type>::register_dtype( \ + ::std::vector<::pybind11::detail::field_descriptor>{ \ + PYBIND11_MAP2_LIST(PYBIND11_FIELD_DESCRIPTOR_EX, Type, __VA_ARGS__)}) + +#endif // __CLION_IDE__ + +template <class T> +using array_iterator = typename std::add_pointer<T>::type; + +template <class T> +array_iterator<T> array_begin(const buffer_info& buffer) +{ + return array_iterator<T>(reinterpret_cast<T*>(buffer.ptr)); +} + +template <class T> +array_iterator<T> array_end(const buffer_info& buffer) +{ + return array_iterator<T>(reinterpret_cast<T*>(buffer.ptr) + buffer.size); +} + +class common_iterator +{ +public: + using container_type = std::vector<ssize_t>; + using value_type = container_type::value_type; + using size_type = container_type::size_type; + + common_iterator() + : p_ptr(0) + , m_strides() + {} + + common_iterator(void* ptr, const container_type& strides, const container_type& shape) + : p_ptr(reinterpret_cast<char*>(ptr)) + , m_strides(strides.size()) + { + m_strides.back() = static_cast<value_type>(strides.back()); + for (size_type i = m_strides.size() - 1; i != 0; --i) { + size_type j = i - 1; + value_type s = static_cast<value_type>(shape[i]); + m_strides[j] = strides[j] + m_strides[i] - strides[i] * s; + } + } + + void increment(size_type dim) + { + p_ptr += m_strides[dim]; + } + + void* data() const + { + return p_ptr; + } + +private: + char* p_ptr; + container_type m_strides; +}; + +template <size_t N> +class multi_array_iterator +{ +public: + using container_type = std::vector<ssize_t>; + + multi_array_iterator(const std::array<buffer_info, N>& buffers, const container_type& shape) + : m_shape(shape.size()) + , m_index(shape.size(), 0) + , m_common_iterator() + { + + // Manual copy to avoid conversion warning if using std::copy + for (size_t i = 0; i < shape.size(); ++i) + m_shape[i] = shape[i]; + + container_type strides(shape.size()); + for (size_t i = 0; i < N; ++i) + init_common_iterator(buffers[i], shape, m_common_iterator[i], strides); + } + + multi_array_iterator& operator++() + { + for (size_t j = m_index.size(); j != 0; --j) { + size_t i = j - 1; + if (++m_index[i] != m_shape[i]) { + increment_common_iterator(i); + break; + } else { + m_index[i] = 0; + } + } + return *this; + } + + template <size_t K, class T = void> + T* data() const + { + return reinterpret_cast<T*>(m_common_iterator[K].data()); + } + +private: + using common_iter = common_iterator; + + void init_common_iterator(const buffer_info& buffer, + const container_type& shape, + common_iter& iterator, + container_type& strides) + { + auto buffer_shape_iter = buffer.shape.rbegin(); + auto buffer_strides_iter = buffer.strides.rbegin(); + auto shape_iter = shape.rbegin(); + auto strides_iter = strides.rbegin(); + + while (buffer_shape_iter != buffer.shape.rend()) { + if (*shape_iter == *buffer_shape_iter) + *strides_iter = *buffer_strides_iter; + else + *strides_iter = 0; + + ++buffer_shape_iter; + ++buffer_strides_iter; + ++shape_iter; + ++strides_iter; + } + + std::fill(strides_iter, strides.rend(), 0); + iterator = common_iter(buffer.ptr, strides, shape); + } + + void increment_common_iterator(size_t dim) + { + for (auto& iter : m_common_iterator) + iter.increment(dim); + } + + container_type m_shape; + container_type m_index; + std::array<common_iter, N> m_common_iterator; +}; + +enum class broadcast_trivial +{ + non_trivial, + c_trivial, + f_trivial +}; + +// Populates the shape and number of dimensions for the set of buffers. Returns a broadcast_trivial +// enum value indicating whether the broadcast is "trivial"--that is, has each buffer being either a +// singleton or a full-size, C-contiguous (`c_trivial`) or Fortran-contiguous (`f_trivial`) storage +// buffer; returns `non_trivial` otherwise. +template <size_t N> +broadcast_trivial broadcast(const std::array<buffer_info, N>& buffers, ssize_t& ndim, std::vector<ssize_t>& shape) +{ + ndim = std::accumulate(buffers.begin(), buffers.end(), ssize_t(0), [](ssize_t res, const buffer_info& buf) { + return std::max(res, buf.ndim); + }); + + shape.clear(); + shape.resize((size_t)ndim, 1); + + // Figure out the output size, and make sure all input arrays conform (i.e. are either size 1 or + // the full size). + for (size_t i = 0; i < N; ++i) { + auto res_iter = shape.rbegin(); + auto end = buffers[i].shape.rend(); + for (auto shape_iter = buffers[i].shape.rbegin(); shape_iter != end; ++shape_iter, ++res_iter) { + const auto& dim_size_in = *shape_iter; + auto& dim_size_out = *res_iter; + + // Each input dimension can either be 1 or `n`, but `n` values must match across buffers + if (dim_size_out == 1) + dim_size_out = dim_size_in; + else if (dim_size_in != 1 && dim_size_in != dim_size_out) + pybind11_fail("pybind11::vectorize: incompatible size/dimension of inputs!"); + } + } + + bool trivial_broadcast_c = true; + bool trivial_broadcast_f = true; + for (size_t i = 0; i < N && (trivial_broadcast_c || trivial_broadcast_f); ++i) { + if (buffers[i].size == 1) + continue; + + // Require the same number of dimensions: + if (buffers[i].ndim != ndim) + return broadcast_trivial::non_trivial; + + // Require all dimensions be full-size: + if (!std::equal(buffers[i].shape.cbegin(), buffers[i].shape.cend(), shape.cbegin())) + return broadcast_trivial::non_trivial; + + // Check for C contiguity (but only if previous inputs were also C contiguous) + if (trivial_broadcast_c) { + ssize_t expect_stride = buffers[i].itemsize; + auto end = buffers[i].shape.crend(); + for (auto shape_iter = buffers[i].shape.crbegin(), stride_iter = buffers[i].strides.crbegin(); + trivial_broadcast_c && shape_iter != end; + ++shape_iter, ++stride_iter) { + if (expect_stride == *stride_iter) + expect_stride *= *shape_iter; + else + trivial_broadcast_c = false; + } + } + + // Check for Fortran contiguity (if previous inputs were also F contiguous) + if (trivial_broadcast_f) { + ssize_t expect_stride = buffers[i].itemsize; + auto end = buffers[i].shape.cend(); + for (auto shape_iter = buffers[i].shape.cbegin(), stride_iter = buffers[i].strides.cbegin(); + trivial_broadcast_f && shape_iter != end; + ++shape_iter, ++stride_iter) { + if (expect_stride == *stride_iter) + expect_stride *= *shape_iter; + else + trivial_broadcast_f = false; + } + } + } + + return trivial_broadcast_c ? broadcast_trivial::c_trivial + : trivial_broadcast_f ? broadcast_trivial::f_trivial : broadcast_trivial::non_trivial; +} + +template <typename T> +struct vectorize_arg +{ + static_assert(!std::is_rvalue_reference<T>::value, "Functions with rvalue reference arguments cannot be vectorized"); + // The wrapped function gets called with this type: + using call_type = remove_reference_t<T>; + // Is this a vectorized argument? + static constexpr bool vectorize = + satisfies_any_of<call_type, std::is_arithmetic, is_complex, std::is_pod>::value + && satisfies_none_of<call_type, std::is_pointer, std::is_array, is_std_array, std::is_enum>::value + && (!std::is_reference<T>::value || (std::is_lvalue_reference<T>::value && std::is_const<call_type>::value)); + // Accept this type: an array for vectorized types, otherwise the type as-is: + using type = conditional_t<vectorize, array_t<remove_cv_t<call_type>, array::forcecast>, T>; +}; + +template <typename Func, typename Return, typename... Args> +struct vectorize_helper +{ +private: + static constexpr size_t N = sizeof...(Args); + static constexpr size_t NVectorized = constexpr_sum(vectorize_arg<Args>::vectorize...); + static_assert(NVectorized >= 1, + "pybind11::vectorize(...) requires a function with at least one vectorizable argument"); + +public: + template <typename T> + explicit vectorize_helper(T&& f) + : f(std::forward<T>(f)) + {} + + object operator()(typename vectorize_arg<Args>::type... args) + { + return run(args..., + make_index_sequence<N>(), + select_indices<vectorize_arg<Args>::vectorize...>(), + make_index_sequence<NVectorized>()); + } + +private: + remove_reference_t<Func> f; + + // Internal compiler error in MSVC 19.16.27025.1 (Visual Studio 2017 15.9.4), when compiling with "/permissive-" flag + // when arg_call_types is manually inlined. + using arg_call_types = std::tuple<typename vectorize_arg<Args>::call_type...>; + template <size_t Index> + using param_n_t = typename std::tuple_element<Index, arg_call_types>::type; + + // Runs a vectorized function given arguments tuple and three index sequences: + // - Index is the full set of 0 ... (N-1) argument indices; + // - VIndex is the subset of argument indices with vectorized parameters, letting us access + // vectorized arguments (anything not in this sequence is passed through) + // - BIndex is a incremental sequence (beginning at 0) of the same size as VIndex, so that + // we can store vectorized buffer_infos in an array (argument VIndex has its buffer at + // index BIndex in the array). + template <size_t... Index, size_t... VIndex, size_t... BIndex> + object run(typename vectorize_arg<Args>::type&... args, + index_sequence<Index...> i_seq, + index_sequence<VIndex...> vi_seq, + index_sequence<BIndex...> bi_seq) + { + + // Pointers to values the function was called with; the vectorized ones set here will start + // out as array_t<T> pointers, but they will be changed them to T pointers before we make + // call the wrapped function. Non-vectorized pointers are left as-is. + std::array<void*, N> params{{&args...}}; + + // The array of `buffer_info`s of vectorized arguments: + std::array<buffer_info, NVectorized> buffers{{reinterpret_cast<array*>(params[VIndex])->request()...}}; + + /* Determine dimensions parameters of output array */ + ssize_t nd = 0; + std::vector<ssize_t> shape(0); + auto trivial = broadcast(buffers, nd, shape); + size_t ndim = (size_t)nd; + + size_t size = std::accumulate(shape.begin(), shape.end(), (size_t)1, std::multiplies<size_t>()); + + // If all arguments are 0-dimension arrays (i.e. single values) return a plain value (i.e. + // not wrapped in an array). + if (size == 1 && ndim == 0) { + PYBIND11_EXPAND_SIDE_EFFECTS(params[VIndex] = buffers[BIndex].ptr); + return cast(f(*reinterpret_cast<param_n_t<Index>*>(params[Index])...)); + } + + array_t<Return> result; + if (trivial == broadcast_trivial::f_trivial) + result = array_t<Return, array::f_style>(shape); + else + result = array_t<Return>(shape); + + if (size == 0) + return std::move(result); + + /* Call the function */ + if (trivial == broadcast_trivial::non_trivial) + apply_broadcast(buffers, params, result, i_seq, vi_seq, bi_seq); + else + apply_trivial(buffers, params, result.mutable_data(), size, i_seq, vi_seq, bi_seq); + + return std::move(result); + } + + template <size_t... Index, size_t... VIndex, size_t... BIndex> + void apply_trivial(std::array<buffer_info, NVectorized>& buffers, + std::array<void*, N>& params, + Return* out, + size_t size, + index_sequence<Index...>, + index_sequence<VIndex...>, + index_sequence<BIndex...>) + { + + // Initialize an array of mutable byte references and sizes with references set to the + // appropriate pointer in `params`; as we iterate, we'll increment each pointer by its size + // (except for singletons, which get an increment of 0). + std::array<std::pair<unsigned char*&, const size_t>, NVectorized> vecparams{ + {std::pair<unsigned char*&, const size_t>( + reinterpret_cast<unsigned char*&>(params[VIndex] = buffers[BIndex].ptr), + buffers[BIndex].size == 1 ? 0 : sizeof(param_n_t<VIndex>))...}}; + + for (size_t i = 0; i < size; ++i) { + out[i] = f(*reinterpret_cast<param_n_t<Index>*>(params[Index])...); + for (auto& x : vecparams) + x.first += x.second; + } + } + + template <size_t... Index, size_t... VIndex, size_t... BIndex> + void apply_broadcast(std::array<buffer_info, NVectorized>& buffers, + std::array<void*, N>& params, + array_t<Return>& output_array, + index_sequence<Index...>, + index_sequence<VIndex...>, + index_sequence<BIndex...>) + { + + buffer_info output = output_array.request(); + multi_array_iterator<NVectorized> input_iter(buffers, output.shape); + + for (array_iterator<Return> iter = array_begin<Return>(output), end = array_end<Return>(output); iter != end; + ++iter, ++input_iter) { + PYBIND11_EXPAND_SIDE_EFFECTS((params[VIndex] = input_iter.template data<BIndex>())); + *iter = f(*reinterpret_cast<param_n_t<Index>*>(std::get<Index>(params))...); + } + } +}; + +template <typename Func, typename Return, typename... Args> +vectorize_helper<Func, Return, Args...> vectorize_extractor(const Func& f, Return (*)(Args...)) +{ + return detail::vectorize_helper<Func, Return, Args...>(f); +} + +template <typename T, int Flags> +struct handle_type_name<array_t<T, Flags>> +{ + static constexpr auto name = _("numpy.ndarray[") + npy_format_descriptor<T>::name + _("]"); +}; + +NAMESPACE_END(detail) + +// Vanilla pointer vectorizer: +template <typename Return, typename... Args> +detail::vectorize_helper<Return (*)(Args...), Return, Args...> vectorize(Return (*f)(Args...)) +{ + return detail::vectorize_helper<Return (*)(Args...), Return, Args...>(f); +} + +// lambda vectorizer: +template <typename Func, detail::enable_if_t<detail::is_lambda<Func>::value, int> = 0> +auto vectorize(Func&& f) + -> decltype(detail::vectorize_extractor(std::forward<Func>(f), (detail::function_signature_t<Func>*)nullptr)) +{ + return detail::vectorize_extractor(std::forward<Func>(f), (detail::function_signature_t<Func>*)nullptr); +} + +// Vectorize a class method (non-const): +template < + typename Return, + typename Class, + typename... Args, + typename Helper = detail:: + vectorize_helper<decltype(std::mem_fn(std::declval<Return (Class::*)(Args...)>())), Return, Class*, Args...>> +Helper vectorize(Return (Class::*f)(Args...)) +{ + return Helper(std::mem_fn(f)); +} + +// Vectorize a class method (const): +template < + typename Return, + typename Class, + typename... Args, + typename Helper = detail::vectorize_helper<decltype(std::mem_fn(std::declval<Return (Class::*)(Args...) const>())), + Return, + const Class*, + Args...>> +Helper vectorize(Return (Class::*f)(Args...) const) +{ + return Helper(std::mem_fn(f)); +} + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) +# pragma warning(pop) +#endif diff --git a/pybind11/include/pybind11/operators.h b/pybind11/include/pybind11/operators.h new file mode 100644 index 0000000000000000000000000000000000000000..3c1848de39a782ae376255ce949f86f45810a1b4 --- /dev/null +++ b/pybind11/include/pybind11/operators.h @@ -0,0 +1,274 @@ +/* + pybind11/operator.h: Metatemplates for operator overloading + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" + +#if defined(__clang__) && !defined(__INTEL_COMPILER) +# pragma clang diagnostic ignored \ + "-Wunsequenced" // multiple unsequenced modifications to 'self' (when using def(py::self OP Type())) +#elif defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable : 4127) // warning C4127: Conditional expression is constant +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// Enumeration with all supported operator types +enum op_id : int +{ + op_add, + op_sub, + op_mul, + op_div, + op_mod, + op_divmod, + op_pow, + op_lshift, + op_rshift, + op_and, + op_xor, + op_or, + op_neg, + op_pos, + op_abs, + op_invert, + op_int, + op_long, + op_float, + op_str, + op_cmp, + op_gt, + op_ge, + op_lt, + op_le, + op_eq, + op_ne, + op_iadd, + op_isub, + op_imul, + op_idiv, + op_imod, + op_ilshift, + op_irshift, + op_iand, + op_ixor, + op_ior, + op_complex, + op_bool, + op_nonzero, + op_repr, + op_truediv, + op_itruediv, + op_hash +}; + +enum op_type : int +{ + op_l, /* base type on left */ + op_r, /* base type on right */ + op_u /* unary operator */ +}; + +struct self_t +{}; +static const self_t self = self_t(); + +/// Type for an unused type slot +struct undefined_t +{}; + +/// Don't warn about an unused variable +inline self_t __self() +{ + return self; +} + +/// base template of operator implementations +template <op_id, op_type, typename B, typename L, typename R> +struct op_impl +{}; + +/// Operator implementation generator +template <op_id id, op_type ot, typename L, typename R> +struct op_ +{ + template <typename Class, typename... Extra> + void execute(Class& cl, const Extra&... extra) const + { + using Base = typename Class::type; + using L_type = conditional_t<std::is_same<L, self_t>::value, Base, L>; + using R_type = conditional_t<std::is_same<R, self_t>::value, Base, R>; + using op = op_impl<id, ot, Base, L_type, R_type>; + cl.def(op::name(), &op::execute, is_operator(), extra...); +#if PY_MAJOR_VERSION < 3 + if (id == op_truediv || id == op_itruediv) + cl.def( + id == op_itruediv ? "__idiv__" : ot == op_l ? "__div__" : "__rdiv__", &op::execute, is_operator(), extra...); +#endif + } + template <typename Class, typename... Extra> + void execute_cast(Class& cl, const Extra&... extra) const + { + using Base = typename Class::type; + using L_type = conditional_t<std::is_same<L, self_t>::value, Base, L>; + using R_type = conditional_t<std::is_same<R, self_t>::value, Base, R>; + using op = op_impl<id, ot, Base, L_type, R_type>; + cl.def(op::name(), &op::execute_cast, is_operator(), extra...); +#if PY_MAJOR_VERSION < 3 + if (id == op_truediv || id == op_itruediv) + cl.def( + id == op_itruediv ? "__idiv__" : ot == op_l ? "__div__" : "__rdiv__", &op::execute, is_operator(), extra...); +#endif + } +}; + +#define PYBIND11_BINARY_OPERATOR(id, rid, op, expr) \ + template <typename B, typename L, typename R> \ + struct op_impl<op_##id, op_l, B, L, R> \ + { \ + static char const* name() \ + { \ + return "__" #id "__"; \ + } \ + static auto execute(const L& l, const R& r) -> decltype(expr) \ + { \ + return (expr); \ + } \ + static B execute_cast(const L& l, const R& r) \ + { \ + return B(expr); \ + } \ + }; \ + template <typename B, typename L, typename R> \ + struct op_impl<op_##id, op_r, B, L, R> \ + { \ + static char const* name() \ + { \ + return "__" #rid "__"; \ + } \ + static auto execute(const R& r, const L& l) -> decltype(expr) \ + { \ + return (expr); \ + } \ + static B execute_cast(const R& r, const L& l) \ + { \ + return B(expr); \ + } \ + }; \ + inline op_<op_##id, op_l, self_t, self_t> op(const self_t&, const self_t&) \ + { \ + return op_<op_##id, op_l, self_t, self_t>(); \ + } \ + template <typename T> \ + op_<op_##id, op_l, self_t, T> op(const self_t&, const T&) \ + { \ + return op_<op_##id, op_l, self_t, T>(); \ + } \ + template <typename T> \ + op_<op_##id, op_r, T, self_t> op(const T&, const self_t&) \ + { \ + return op_<op_##id, op_r, T, self_t>(); \ + } + +#define PYBIND11_INPLACE_OPERATOR(id, op, expr) \ + template <typename B, typename L, typename R> \ + struct op_impl<op_##id, op_l, B, L, R> \ + { \ + static char const* name() \ + { \ + return "__" #id "__"; \ + } \ + static auto execute(L& l, const R& r) -> decltype(expr) \ + { \ + return expr; \ + } \ + static B execute_cast(L& l, const R& r) \ + { \ + return B(expr); \ + } \ + }; \ + template <typename T> \ + op_<op_##id, op_l, self_t, T> op(const self_t&, const T&) \ + { \ + return op_<op_##id, op_l, self_t, T>(); \ + } + +#define PYBIND11_UNARY_OPERATOR(id, op, expr) \ + template <typename B, typename L> \ + struct op_impl<op_##id, op_u, B, L, undefined_t> \ + { \ + static char const* name() \ + { \ + return "__" #id "__"; \ + } \ + static auto execute(const L& l) -> decltype(expr) \ + { \ + return expr; \ + } \ + static B execute_cast(const L& l) \ + { \ + return B(expr); \ + } \ + }; \ + inline op_<op_##id, op_u, self_t, undefined_t> op(const self_t&) \ + { \ + return op_<op_##id, op_u, self_t, undefined_t>(); \ + } + +PYBIND11_BINARY_OPERATOR(sub, rsub, operator-, l - r) +PYBIND11_BINARY_OPERATOR(add, radd, operator+, l + r) +PYBIND11_BINARY_OPERATOR(mul, rmul, operator*, l* r) +PYBIND11_BINARY_OPERATOR(truediv, rtruediv, operator/, l / r) +PYBIND11_BINARY_OPERATOR(mod, rmod, operator%, l % r) +PYBIND11_BINARY_OPERATOR(lshift, rlshift, operator<<, l << r) +PYBIND11_BINARY_OPERATOR(rshift, rrshift, operator>>, l>> r) +PYBIND11_BINARY_OPERATOR(and, rand, operator&, l& r) +PYBIND11_BINARY_OPERATOR (xor, rxor, operator^, l ^ r) +PYBIND11_BINARY_OPERATOR(eq, eq, operator==, l == r) +PYBIND11_BINARY_OPERATOR(ne, ne, operator!=, l != r) +PYBIND11_BINARY_OPERATOR(or, ror, operator|, l | r) +PYBIND11_BINARY_OPERATOR(gt, lt, operator>, l> r) +PYBIND11_BINARY_OPERATOR(ge, le, operator>=, l >= r) +PYBIND11_BINARY_OPERATOR(lt, gt, operator<, l<r) +PYBIND11_BINARY_OPERATOR(le, ge, operator<=, l <= r) +// PYBIND11_BINARY_OPERATOR(pow, rpow, pow, std::pow(l, r)) +PYBIND11_INPLACE_OPERATOR(iadd, operator+=, l += r) +PYBIND11_INPLACE_OPERATOR(isub, operator-=, l -= r) +PYBIND11_INPLACE_OPERATOR(imul, operator*=, l *= r) +PYBIND11_INPLACE_OPERATOR(itruediv, operator/=, l /= r) +PYBIND11_INPLACE_OPERATOR(imod, operator%=, l %= r) +PYBIND11_INPLACE_OPERATOR(ilshift, operator<<=, l <<= r) +PYBIND11_INPLACE_OPERATOR(irshift, operator>>=, l >>= r) +PYBIND11_INPLACE_OPERATOR(iand, operator&=, l &= r) +PYBIND11_INPLACE_OPERATOR(ixor, operator^=, l ^= r) +PYBIND11_INPLACE_OPERATOR(ior, operator|=, l |= r) +PYBIND11_UNARY_OPERATOR(neg, operator-, - l) +PYBIND11_UNARY_OPERATOR(pos, operator+, + l) +PYBIND11_UNARY_OPERATOR(abs, abs, std::abs(l)) +PYBIND11_UNARY_OPERATOR(hash, hash, std::hash<L>()(l)) +PYBIND11_UNARY_OPERATOR(invert, operator~,(~l)) +PYBIND11_UNARY_OPERATOR(bool, operator!, !!l) +PYBIND11_UNARY_OPERATOR(int, int_, (int)l) +PYBIND11_UNARY_OPERATOR(float, float_, (double)l) + +#undef PYBIND11_BINARY_OPERATOR +#undef PYBIND11_INPLACE_OPERATOR +#undef PYBIND11_UNARY_OPERATOR +NAMESPACE_END(detail) + +using detail::self; + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) +# pragma warning(pop) +#endif diff --git a/pybind11/include/pybind11/options.h b/pybind11/include/pybind11/options.h new file mode 100644 index 0000000000000000000000000000000000000000..055d6dfc03d9a834fe507148ecc0bd8fc1e1183f --- /dev/null +++ b/pybind11/include/pybind11/options.h @@ -0,0 +1,91 @@ +/* + pybind11/options.h: global settings that are configurable at runtime. + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +class options +{ +public: + // Default RAII constructor, which leaves settings as they currently are. + options() + : previous_state(global_state()) + {} + + // Class is non-copyable. + options(const options&) = delete; + options& operator=(const options&) = delete; + + // Destructor, which restores settings that were in effect before. + ~options() + { + global_state() = previous_state; + } + + // Setter methods (affect the global state): + + options& disable_user_defined_docstrings() & + { + global_state().show_user_defined_docstrings = false; + return *this; + } + + options& enable_user_defined_docstrings() & + { + global_state().show_user_defined_docstrings = true; + return *this; + } + + options& disable_function_signatures() & + { + global_state().show_function_signatures = false; + return *this; + } + + options& enable_function_signatures() & + { + global_state().show_function_signatures = true; + return *this; + } + + // Getter methods (return the global state): + + static bool show_user_defined_docstrings() + { + return global_state().show_user_defined_docstrings; + } + + static bool show_function_signatures() + { + return global_state().show_function_signatures; + } + + // This type is not meant to be allocated on the heap. + void* operator new(size_t) = delete; + +private: + struct state + { + bool show_user_defined_docstrings = true; //< Include user-supplied texts in docstrings. + bool show_function_signatures = true; //< Include auto-generated function signatures in docstrings. + }; + + static state& global_state() + { + static state instance; + return instance; + } + + state previous_state; +}; + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/pybind11.h b/pybind11/include/pybind11/pybind11.h new file mode 100644 index 0000000000000000000000000000000000000000..adfe60c956dfba7cdaddea7ed2e73c8b395f14da --- /dev/null +++ b/pybind11/include/pybind11/pybind11.h @@ -0,0 +1,2370 @@ +/* + pybind11/pybind11.h: Main header file of the C++11 python + binding generator library + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#if defined(__INTEL_COMPILER) +# pragma warning push +# pragma warning disable 68 // integer conversion resulted in a change of sign +# pragma warning disable 186 // pointless comparison of unsigned integer with zero +# pragma warning disable 878 // incompatible exception specifications +# pragma warning disable 1334 // the "template" keyword used for syntactic disambiguation may only be used within a + // template +# pragma warning disable 1682 // implicit conversion of a 64-bit integral type to a smaller integral type (potential + // portability problem) +# pragma warning disable 1786 // function "strdup" was declared deprecated +# pragma warning disable 1875 // offsetof applied to non-POD (Plain Old Data) types is nonstandard +# pragma warning disable 2196 // warning #2196: routine is both "inline" and "noinline" +#elif defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable : 4100) // warning C4100: Unreferenced formal parameter +# pragma warning(disable : 4127) // warning C4127: Conditional expression is constant +# pragma warning(disable : 4512) // warning C4512: Assignment operator was implicitly defined as deleted +# pragma warning(disable : 4800) // warning C4800: 'int': forcing value to bool 'true' or 'false' (performance warning) +# pragma warning(disable : 4996) // warning C4996: The POSIX name for this item is deprecated. Instead, use the ISO C + // and C++ conformant name +# pragma warning(disable : 4702) // warning C4702: unreachable code +# pragma warning(disable : 4522) // warning C4522: multiple assignment operators specified +#elif defined(__GNUG__) && !defined(__clang__) +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wunused-but-set-parameter" +# pragma GCC diagnostic ignored "-Wunused-but-set-variable" +# pragma GCC diagnostic ignored "-Wmissing-field-initializers" +# pragma GCC diagnostic ignored "-Wstrict-aliasing" +# pragma GCC diagnostic ignored "-Wattributes" +# if __GNUC__ >= 7 +# pragma GCC diagnostic ignored "-Wnoexcept-type" +# endif +#endif + +#include "attr.h" +#include "options.h" +#include "detail/class.h" +#include "detail/init.h" + +#if defined(__GNUG__) && !defined(__clang__) +# include <cxxabi.h> +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/// Wraps an arbitrary C++ function/method/lambda function/.. into a callable Python object +class cpp_function : public function +{ +public: + cpp_function() {} + cpp_function(std::nullptr_t) {} + + /// Construct a cpp_function from a vanilla function pointer + template <typename Return, typename... Args, typename... Extra> + cpp_function(Return (*f)(Args...), const Extra&... extra) + { + initialize(f, f, extra...); + } + + /// Construct a cpp_function from a lambda function (possibly with internal state) + template <typename Func, typename... Extra, typename = detail::enable_if_t<detail::is_lambda<Func>::value>> + cpp_function(Func&& f, const Extra&... extra) + { + initialize(std::forward<Func>(f), (detail::function_signature_t<Func>*)nullptr, extra...); + } + + /// Construct a cpp_function from a class method (non-const) + template <typename Return, typename Class, typename... Arg, typename... Extra> + cpp_function(Return (Class::*f)(Arg...), const Extra&... extra) + { + initialize([f](Class* c, Arg... args) -> Return { return (c->*f)(args...); }, + (Return(*)(Class*, Arg...)) nullptr, + extra...); + } + + /// Construct a cpp_function from a class method (const) + template <typename Return, typename Class, typename... Arg, typename... Extra> + cpp_function(Return (Class::*f)(Arg...) const, const Extra&... extra) + { + initialize([f](const Class* c, Arg... args) -> Return { return (c->*f)(args...); }, + (Return(*)(const Class*, Arg...)) nullptr, + extra...); + } + + /// Return the function name + object name() const + { + return attr("__name__"); + } + +protected: + /// Space optimization: don't inline this frequently instantiated fragment + PYBIND11_NOINLINE detail::function_record* make_function_record() + { + return new detail::function_record(); + } + + /// Special internal constructor for functors, lambda functions, etc. + template <typename Func, typename Return, typename... Args, typename... Extra> + void initialize(Func&& f, Return (*)(Args...), const Extra&... extra) + { + using namespace detail; + struct capture + { + remove_reference_t<Func> f; + }; + + /* Store the function including any extra state it might have (e.g. a lambda capture object) */ + auto rec = make_function_record(); + + /* Store the capture object directly in the function record if there is enough space */ + if (sizeof(capture) <= sizeof(rec->data)) { + /* Without these pragmas, GCC warns that there might not be + enough space to use the placement new operator. However, the + 'if' statement above ensures that this is the case. */ +#if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6 +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wplacement-new" +#endif + new ((capture*)&rec->data) capture{std::forward<Func>(f)}; +#if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6 +# pragma GCC diagnostic pop +#endif + if (!std::is_trivially_destructible<Func>::value) + rec->free_data = [](function_record* r) { ((capture*)&r->data)->~capture(); }; + } else { + rec->data[0] = new capture{std::forward<Func>(f)}; + rec->free_data = [](function_record* r) { delete ((capture*)r->data[0]); }; + } + + /* Type casters for the function arguments and return value */ + using cast_in = argument_loader<Args...>; + using cast_out = make_caster<conditional_t<std::is_void<Return>::value, void_type, Return>>; + + static_assert(expected_num_args<Extra...>(sizeof...(Args), cast_in::has_args, cast_in::has_kwargs), + "The number of argument annotations does not match the number of function arguments"); + + /* Dispatch code which converts function arguments and performs the actual function call */ + rec->impl = [](function_call& call) -> handle { + cast_in args_converter; + + /* Try to cast the function arguments into the C++ domain */ + if (!args_converter.load_args(call)) + return PYBIND11_TRY_NEXT_OVERLOAD; + + /* Invoke call policy pre-call hook */ + process_attributes<Extra...>::precall(call); + + /* Get a pointer to the capture object */ + auto data = (sizeof(capture) <= sizeof(call.func.data) ? &call.func.data : call.func.data[0]); + capture* cap = const_cast<capture*>(reinterpret_cast<const capture*>(data)); + + /* Override policy for rvalues -- usually to enforce rvp::move on an rvalue */ + return_value_policy policy = return_value_policy_override<Return>::policy(call.func.policy); + + /* Function scope guard -- defaults to the compile-to-nothing `void_type` */ + using Guard = extract_guard_t<Extra...>; + + /* Perform the function call */ + handle result = + cast_out::cast(std::move(args_converter).template call<Return, Guard>(cap->f), policy, call.parent); + + /* Invoke call policy post-call hook */ + process_attributes<Extra...>::postcall(call, result); + + return result; + }; + + /* Process any user-provided function attributes */ + process_attributes<Extra...>::init(extra..., rec); + + /* Generate a readable signature describing the function's arguments and return value types */ + static constexpr auto signature = _("(") + cast_in::arg_names + _(") -> ") + cast_out::name; + PYBIND11_DESCR_CONSTEXPR auto types = decltype(signature)::types(); + + /* Register the function with Python from generic (non-templated) code */ + initialize_generic(rec, signature.text, types.data(), sizeof...(Args)); + + if (cast_in::has_args) + rec->has_args = true; + if (cast_in::has_kwargs) + rec->has_kwargs = true; + + /* Stash some additional information used by an important optimization in 'functional.h' */ + using FunctionType = Return (*)(Args...); + constexpr bool is_function_ptr = std::is_convertible<Func, FunctionType>::value && sizeof(capture) == sizeof(void*); + if (is_function_ptr) { + rec->is_stateless = true; + rec->data[1] = const_cast<void*>(reinterpret_cast<const void*>(&typeid(FunctionType))); + } + } + + /// Register a function call with Python (generic non-templated code goes here) + void + initialize_generic(detail::function_record* rec, const char* text, const std::type_info* const* types, size_t args) + { + + /* Create copies of all referenced C-style strings */ + rec->name = strdup(rec->name ? rec->name : ""); + if (rec->doc) + rec->doc = strdup(rec->doc); + for (auto& a : rec->args) { + if (a.name) + a.name = strdup(a.name); + if (a.descr) + a.descr = strdup(a.descr); + else if (a.value) + a.descr = strdup(a.value.attr("__repr__")().cast<std::string>().c_str()); + } + + rec->is_constructor = !strcmp(rec->name, "__init__") || !strcmp(rec->name, "__setstate__"); + +#if !defined(NDEBUG) && !defined(PYBIND11_DISABLE_NEW_STYLE_INIT_WARNING) + if (rec->is_constructor && !rec->is_new_style_constructor) { + const auto class_name = std::string(((PyTypeObject*)rec->scope.ptr())->tp_name); + const auto func_name = std::string(rec->name); + PyErr_WarnEx(PyExc_FutureWarning, + ("pybind11-bound class '" + class_name + + "' is using an old-style " + "placement-new '" + + func_name + + "' which has been deprecated. See " + "the upgrade guide in pybind11's docs. This message is only visible " + "when compiled in debug mode.") + .c_str(), + 0); + } +#endif + + /* Generate a proper function signature */ + std::string signature; + size_t type_index = 0, arg_index = 0; + for (auto* pc = text; *pc != '\0'; ++pc) { + const auto c = *pc; + + if (c == '{') { + // Write arg name for everything except *args and **kwargs. + if (*(pc + 1) == '*') + continue; + + if (arg_index < rec->args.size() && rec->args[arg_index].name) { + signature += rec->args[arg_index].name; + } else if (arg_index == 0 && rec->is_method) { + signature += "self"; + } else { + signature += "arg" + std::to_string(arg_index - (rec->is_method ? 1 : 0)); + } + signature += ": "; + } else if (c == '}') { + // Write default value if available. + if (arg_index < rec->args.size() && rec->args[arg_index].descr) { + signature += " = "; + signature += rec->args[arg_index].descr; + } + arg_index++; + } else if (c == '%') { + const std::type_info* t = types[type_index++]; + if (!t) + pybind11_fail("Internal error while parsing type signature (1)"); + if (auto tinfo = detail::get_type_info(*t)) { + handle th((PyObject*)tinfo->type); + signature += + th.attr("__module__").cast<std::string>() + "." + + th.attr("__qualname__").cast<std::string>(); // Python 3.3+, but we backport it to earlier versions + } else if (rec->is_new_style_constructor && arg_index == 0) { + // A new-style `__init__` takes `self` as `value_and_holder`. + // Rewrite it to the proper class type. + signature += rec->scope.attr("__module__").cast<std::string>() + "." + + rec->scope.attr("__qualname__").cast<std::string>(); + } else { + std::string tname(t->name()); + detail::clean_type_id(tname); + signature += tname; + } + } else { + signature += c; + } + } + if (arg_index != args || types[type_index] != nullptr) + pybind11_fail("Internal error while parsing type signature (2)"); + +#if PY_MAJOR_VERSION < 3 + if (strcmp(rec->name, "__next__") == 0) { + std::free(rec->name); + rec->name = strdup("next"); + } else if (strcmp(rec->name, "__bool__") == 0) { + std::free(rec->name); + rec->name = strdup("__nonzero__"); + } +#endif + rec->signature = strdup(signature.c_str()); + rec->args.shrink_to_fit(); + rec->nargs = (std::uint16_t)args; + + if (rec->sibling && PYBIND11_INSTANCE_METHOD_CHECK(rec->sibling.ptr())) + rec->sibling = PYBIND11_INSTANCE_METHOD_GET_FUNCTION(rec->sibling.ptr()); + + detail::function_record *chain = nullptr, *chain_start = rec; + if (rec->sibling) { + if (PyCFunction_Check(rec->sibling.ptr())) { + auto rec_capsule = reinterpret_borrow<capsule>(PyCFunction_GET_SELF(rec->sibling.ptr())); + chain = (detail::function_record*)rec_capsule; + /* Never append a method to an overload chain of a parent class; + instead, hide the parent's overloads in this case */ + if (!chain->scope.is(rec->scope)) + chain = nullptr; + } + // Don't trigger for things like the default __init__, which are wrapper_descriptors that we are intentionally + // replacing + else if (!rec->sibling.is_none() && rec->name[0] != '_') + pybind11_fail("Cannot overload existing non-function object \"" + std::string(rec->name) + + "\" with a function of the same name"); + } + + if (!chain) { + /* No existing overload was found, create a new function object */ + rec->def = new PyMethodDef(); + std::memset(rec->def, 0, sizeof(PyMethodDef)); + rec->def->ml_name = rec->name; + rec->def->ml_meth = reinterpret_cast<PyCFunction>(reinterpret_cast<void (*)(void)>(*dispatcher)); + rec->def->ml_flags = METH_VARARGS | METH_KEYWORDS; + + capsule rec_capsule(rec, [](void* ptr) { destruct((detail::function_record*)ptr); }); + + object scope_module; + if (rec->scope) { + if (hasattr(rec->scope, "__module__")) { + scope_module = rec->scope.attr("__module__"); + } else if (hasattr(rec->scope, "__name__")) { + scope_module = rec->scope.attr("__name__"); + } + } + + m_ptr = PyCFunction_NewEx(rec->def, rec_capsule.ptr(), scope_module.ptr()); + if (!m_ptr) + pybind11_fail("cpp_function::cpp_function(): Could not allocate function object"); + } else { + /* Append at the end of the overload chain */ + m_ptr = rec->sibling.ptr(); + inc_ref(); + chain_start = chain; + if (chain->is_method != rec->is_method) + pybind11_fail("overloading a method with both static and instance methods is not supported; " +#if defined(NDEBUG) + "compile in debug mode for more details" +#else + "error while attempting to bind " + + std::string(rec->is_method ? "instance" : "static") + " method " + + std::string(pybind11::str(rec->scope.attr("__name__"))) + "." + std::string(rec->name) + + signature +#endif + ); + while (chain->next) + chain = chain->next; + chain->next = rec; + } + + std::string signatures; + int index = 0; + /* Create a nice pydoc rec including all signatures and + docstrings of the functions in the overload chain */ + if (chain && options::show_function_signatures()) { + // First a generic signature + signatures += rec->name; + signatures += "(*args, **kwargs)\n"; + signatures += "Overloaded function.\n\n"; + } + // Then specific overload signatures + bool first_user_def = true; + for (auto it = chain_start; it != nullptr; it = it->next) { + if (options::show_function_signatures()) { + if (index > 0) + signatures += "\n"; + if (chain) + signatures += std::to_string(++index) + ". "; + signatures += rec->name; + signatures += it->signature; + signatures += "\n"; + } + if (it->doc && strlen(it->doc) > 0 && options::show_user_defined_docstrings()) { + // If we're appending another docstring, and aren't printing function signatures, we + // need to append a newline first: + if (!options::show_function_signatures()) { + if (first_user_def) + first_user_def = false; + else + signatures += "\n"; + } + if (options::show_function_signatures()) + signatures += "\n"; + signatures += it->doc; + if (options::show_function_signatures()) + signatures += "\n"; + } + } + + /* Install docstring */ + PyCFunctionObject* func = (PyCFunctionObject*)m_ptr; + if (func->m_ml->ml_doc) + std::free(const_cast<char*>(func->m_ml->ml_doc)); + func->m_ml->ml_doc = strdup(signatures.c_str()); + + if (rec->is_method) { + m_ptr = PYBIND11_INSTANCE_METHOD_NEW(m_ptr, rec->scope.ptr()); + if (!m_ptr) + pybind11_fail("cpp_function::cpp_function(): Could not allocate instance method object"); + Py_DECREF(func); + } + } + + /// When a cpp_function is GCed, release any memory allocated by pybind11 + static void destruct(detail::function_record* rec) + { + while (rec) { + detail::function_record* next = rec->next; + if (rec->free_data) + rec->free_data(rec); + std::free((char*)rec->name); + std::free((char*)rec->doc); + std::free((char*)rec->signature); + for (auto& arg : rec->args) { + std::free(const_cast<char*>(arg.name)); + std::free(const_cast<char*>(arg.descr)); + arg.value.dec_ref(); + } + if (rec->def) { + std::free(const_cast<char*>(rec->def->ml_doc)); + delete rec->def; + } + delete rec; + rec = next; + } + } + + /// Main dispatch logic for calls to functions bound using pybind11 + static PyObject* dispatcher(PyObject* self, PyObject* args_in, PyObject* kwargs_in) + { + using namespace detail; + + /* Iterator over the list of potentially admissible overloads */ + const function_record *overloads = (function_record*)PyCapsule_GetPointer(self, nullptr), *it = overloads; + + /* Need to know how many arguments + keyword arguments there are to pick the right overload */ + const size_t n_args_in = (size_t)PyTuple_GET_SIZE(args_in); + + handle parent = n_args_in > 0 ? PyTuple_GET_ITEM(args_in, 0) : nullptr, result = PYBIND11_TRY_NEXT_OVERLOAD; + + auto self_value_and_holder = value_and_holder(); + if (overloads->is_constructor) { + const auto tinfo = get_type_info((PyTypeObject*)overloads->scope.ptr()); + const auto pi = reinterpret_cast<instance*>(parent.ptr()); + self_value_and_holder = pi->get_value_and_holder(tinfo, false); + + if (!self_value_and_holder.type || !self_value_and_holder.inst) { + PyErr_SetString(PyExc_TypeError, "__init__(self, ...) called with invalid `self` argument"); + return nullptr; + } + + // If this value is already registered it must mean __init__ is invoked multiple times; + // we really can't support that in C++, so just ignore the second __init__. + if (self_value_and_holder.instance_registered()) + return none().release().ptr(); + } + + try { + // We do this in two passes: in the first pass, we load arguments with `convert=false`; + // in the second, we allow conversion (except for arguments with an explicit + // py::arg().noconvert()). This lets us prefer calls without conversion, with + // conversion as a fallback. + std::vector<function_call> second_pass; + + // However, if there are no overloads, we can just skip the no-convert pass entirely + const bool overloaded = it != nullptr && it->next != nullptr; + + for (; it != nullptr; it = it->next) { + + /* For each overload: + 1. Copy all positional arguments we were given, also checking to make sure that + named positional arguments weren't *also* specified via kwarg. + 2. If we weren't given enough, try to make up the omitted ones by checking + whether they were provided by a kwarg matching the `py::arg("name")` name. If + so, use it (and remove it from kwargs; if not, see if the function binding + provided a default that we can use. + 3. Ensure that either all keyword arguments were "consumed", or that the function + takes a kwargs argument to accept unconsumed kwargs. + 4. Any positional arguments still left get put into a tuple (for args), and any + leftover kwargs get put into a dict. + 5. Pack everything into a vector; if we have py::args or py::kwargs, they are an + extra tuple or dict at the end of the positional arguments. + 6. Call the function call dispatcher (function_record::impl) + + If one of these fail, move on to the next overload and keep trying until we get a + result other than PYBIND11_TRY_NEXT_OVERLOAD. + */ + + const function_record& func = *it; + size_t pos_args = func.nargs; // Number of positional arguments that we need + if (func.has_args) + --pos_args; // (but don't count py::args + if (func.has_kwargs) + --pos_args; // or py::kwargs) + + if (!func.has_args && n_args_in > pos_args) + continue; // Too many arguments for this overload + + if (n_args_in < pos_args && func.args.size() < pos_args) + continue; // Not enough arguments given, and not enough defaults to fill in the blanks + + function_call call(func, parent); + + size_t args_to_copy = std::min(pos_args, n_args_in); + size_t args_copied = 0; + + // 0. Inject new-style `self` argument + if (func.is_new_style_constructor) { + // The `value` may have been preallocated by an old-style `__init__` + // if it was a preceding candidate for overload resolution. + if (self_value_and_holder) + self_value_and_holder.type->dealloc(self_value_and_holder); + + call.init_self = PyTuple_GET_ITEM(args_in, 0); + call.args.push_back(reinterpret_cast<PyObject*>(&self_value_and_holder)); + call.args_convert.push_back(false); + ++args_copied; + } + + // 1. Copy any position arguments given. + bool bad_arg = false; + for (; args_copied < args_to_copy; ++args_copied) { + const argument_record* arg_rec = args_copied < func.args.size() ? &func.args[args_copied] : nullptr; + if (kwargs_in && arg_rec && arg_rec->name && PyDict_GetItemString(kwargs_in, arg_rec->name)) { + bad_arg = true; + break; + } + + handle arg(PyTuple_GET_ITEM(args_in, args_copied)); + if (arg_rec && !arg_rec->none && arg.is_none()) { + bad_arg = true; + break; + } + call.args.push_back(arg); + call.args_convert.push_back(arg_rec ? arg_rec->convert : true); + } + if (bad_arg) + continue; // Maybe it was meant for another overload (issue #688) + + // We'll need to copy this if we steal some kwargs for defaults + dict kwargs = reinterpret_borrow<dict>(kwargs_in); + + // 2. Check kwargs and, failing that, defaults that may help complete the list + if (args_copied < pos_args) { + bool copied_kwargs = false; + + for (; args_copied < pos_args; ++args_copied) { + const auto& arg = func.args[args_copied]; + + handle value; + if (kwargs_in && arg.name) + value = PyDict_GetItemString(kwargs.ptr(), arg.name); + + if (value) { + // Consume a kwargs value + if (!copied_kwargs) { + kwargs = reinterpret_steal<dict>(PyDict_Copy(kwargs.ptr())); + copied_kwargs = true; + } + PyDict_DelItemString(kwargs.ptr(), arg.name); + } else if (arg.value) { + value = arg.value; + } + + if (value) { + call.args.push_back(value); + call.args_convert.push_back(arg.convert); + } else + break; + } + + if (args_copied < pos_args) + continue; // Not enough arguments, defaults, or kwargs to fill the positional arguments + } + + // 3. Check everything was consumed (unless we have a kwargs arg) + if (kwargs && kwargs.size() > 0 && !func.has_kwargs) + continue; // Unconsumed kwargs, but no py::kwargs argument to accept them + + // 4a. If we have a py::args argument, create a new tuple with leftovers + if (func.has_args) { + tuple extra_args; + if (args_to_copy == 0) { + // We didn't copy out any position arguments from the args_in tuple, so we + // can reuse it directly without copying: + extra_args = reinterpret_borrow<tuple>(args_in); + } else if (args_copied >= n_args_in) { + extra_args = tuple(0); + } else { + size_t args_size = n_args_in - args_copied; + extra_args = tuple(args_size); + for (size_t i = 0; i < args_size; ++i) { + extra_args[i] = PyTuple_GET_ITEM(args_in, args_copied + i); + } + } + call.args.push_back(extra_args); + call.args_convert.push_back(false); + call.args_ref = std::move(extra_args); + } + + // 4b. If we have a py::kwargs, pass on any remaining kwargs + if (func.has_kwargs) { + if (!kwargs.ptr()) + kwargs = dict(); // If we didn't get one, send an empty one + call.args.push_back(kwargs); + call.args_convert.push_back(false); + call.kwargs_ref = std::move(kwargs); + } + +// 5. Put everything in a vector. Not technically step 5, we've been building it +// in `call.args` all along. +#if !defined(NDEBUG) + if (call.args.size() != func.nargs || call.args_convert.size() != func.nargs) + pybind11_fail("Internal error: function call dispatcher inserted wrong number of arguments!"); +#endif + + std::vector<bool> second_pass_convert; + if (overloaded) { + // We're in the first no-convert pass, so swap out the conversion flags for a + // set of all-false flags. If the call fails, we'll swap the flags back in for + // the conversion-allowed call below. + second_pass_convert.resize(func.nargs, false); + call.args_convert.swap(second_pass_convert); + } + + // 6. Call the function. + try { + loader_life_support guard{}; + result = func.impl(call); + } catch (reference_cast_error&) { + result = PYBIND11_TRY_NEXT_OVERLOAD; + } + + if (result.ptr() != PYBIND11_TRY_NEXT_OVERLOAD) + break; + + if (overloaded) { + // The (overloaded) call failed; if the call has at least one argument that + // permits conversion (i.e. it hasn't been explicitly specified `.noconvert()`) + // then add this call to the list of second pass overloads to try. + for (size_t i = func.is_method ? 1 : 0; i < pos_args; i++) { + if (second_pass_convert[i]) { + // Found one: swap the converting flags back in and store the call for + // the second pass. + call.args_convert.swap(second_pass_convert); + second_pass.push_back(std::move(call)); + break; + } + } + } + } + + if (overloaded && !second_pass.empty() && result.ptr() == PYBIND11_TRY_NEXT_OVERLOAD) { + // The no-conversion pass finished without success, try again with conversion allowed + for (auto& call : second_pass) { + try { + loader_life_support guard{}; + result = call.func.impl(call); + } catch (reference_cast_error&) { + result = PYBIND11_TRY_NEXT_OVERLOAD; + } + + if (result.ptr() != PYBIND11_TRY_NEXT_OVERLOAD) { + // The error reporting logic below expects 'it' to be valid, as it would be + // if we'd encountered this failure in the first-pass loop. + if (!result) + it = &call.func; + break; + } + } + } + } catch (error_already_set& e) { + e.restore(); + return nullptr; +#if defined(__GNUG__) && !defined(__clang__) + } catch (abi::__forced_unwind&) { + throw; +#endif + } catch (...) { + /* When an exception is caught, give each registered exception + translator a chance to translate it to a Python exception + in reverse order of registration. + + A translator may choose to do one of the following: + + - catch the exception and call PyErr_SetString or PyErr_SetObject + to set a standard (or custom) Python exception, or + - do nothing and let the exception fall through to the next translator, or + - delegate translation to the next translator by throwing a new type of exception. */ + + auto last_exception = std::current_exception(); + auto& registered_exception_translators = get_internals().registered_exception_translators; + for (auto& translator : registered_exception_translators) { + try { + translator(last_exception); + } catch (...) { + last_exception = std::current_exception(); + continue; + } + return nullptr; + } + PyErr_SetString(PyExc_SystemError, "Exception escaped from default exception translator!"); + return nullptr; + } + + auto append_note_if_missing_header_is_suspected = [](std::string& msg) { + if (msg.find("std::") != std::string::npos) { + msg += "\n\n" + "Did you forget to `#include <pybind11/stl.h>`? Or <pybind11/complex.h>,\n" + "<pybind11/functional.h>, <pybind11/chrono.h>, etc. Some automatic\n" + "conversions are optional and require extra headers to be included\n" + "when compiling your pybind11 module."; + } + }; + + if (result.ptr() == PYBIND11_TRY_NEXT_OVERLOAD) { + if (overloads->is_operator) + return handle(Py_NotImplemented).inc_ref().ptr(); + + std::string msg = std::string(overloads->name) + "(): incompatible " + + std::string(overloads->is_constructor ? "constructor" : "function") + + " arguments. The following argument types are supported:\n"; + + int ctr = 0; + for (const function_record* it2 = overloads; it2 != nullptr; it2 = it2->next) { + msg += " " + std::to_string(++ctr) + ". "; + + bool wrote_sig = false; + if (overloads->is_constructor) { + // For a constructor, rewrite `(self: Object, arg0, ...) -> NoneType` as `Object(arg0, ...)` + std::string sig = it2->signature; + size_t start = sig.find('(') + 7; // skip "(self: " + if (start < sig.size()) { + // End at the , for the next argument + size_t end = sig.find(", "), next = end + 2; + size_t ret = sig.rfind(" -> "); + // Or the ), if there is no comma: + if (end >= sig.size()) + next = end = sig.find(')'); + if (start < end && next < sig.size()) { + msg.append(sig, start, end - start); + msg += '('; + msg.append(sig, next, ret - next); + wrote_sig = true; + } + } + } + if (!wrote_sig) + msg += it2->signature; + + msg += "\n"; + } + msg += "\nInvoked with: "; + auto args_ = reinterpret_borrow<tuple>(args_in); + bool some_args = false; + for (size_t ti = overloads->is_constructor ? 1 : 0; ti < args_.size(); ++ti) { + if (!some_args) + some_args = true; + else + msg += ", "; + msg += pybind11::repr(args_[ti]); + } + if (kwargs_in) { + auto kwargs = reinterpret_borrow<dict>(kwargs_in); + if (kwargs.size() > 0) { + if (some_args) + msg += "; "; + msg += "kwargs: "; + bool first = true; + for (auto kwarg : kwargs) { + if (first) + first = false; + else + msg += ", "; + msg += pybind11::str("{}={!r}").format(kwarg.first, kwarg.second); + } + } + } + + append_note_if_missing_header_is_suspected(msg); + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return nullptr; + } else if (!result) { + std::string msg = "Unable to convert function return value to a " + "Python type! The signature was\n\t"; + msg += it->signature; + append_note_if_missing_header_is_suspected(msg); + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return nullptr; + } else { + if (overloads->is_constructor && !self_value_and_holder.holder_constructed()) { + auto* pi = reinterpret_cast<instance*>(parent.ptr()); + self_value_and_holder.type->init_instance(pi, nullptr); + } + return result.ptr(); + } + } +}; + +/// Wrapper for Python extension modules +class module : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(module, object, PyModule_Check) + + /// Create a new top-level Python module with the given name and docstring + explicit module(const char* name, const char* doc = nullptr) + { + if (!options::show_user_defined_docstrings()) + doc = nullptr; +#if PY_MAJOR_VERSION >= 3 + PyModuleDef* def = new PyModuleDef(); + std::memset(def, 0, sizeof(PyModuleDef)); + def->m_name = name; + def->m_doc = doc; + def->m_size = -1; + Py_INCREF(def); + m_ptr = PyModule_Create(def); +#else + m_ptr = Py_InitModule3(name, nullptr, doc); +#endif + if (m_ptr == nullptr) + pybind11_fail("Internal error in module::module()"); + inc_ref(); + } + + /** \rst + Create Python binding for a new function within the module scope. ``Func`` + can be a plain C++ function, a function pointer, or a lambda function. For + details on the ``Extra&& ... extra`` argument, see section :ref:`extras`. + \endrst */ + template <typename Func, typename... Extra> + module& def(const char* name_, Func&& f, const Extra&... extra) + { + cpp_function func( + std::forward<Func>(f), name(name_), scope(*this), sibling(getattr(*this, name_, none())), extra...); + // NB: allow overwriting here because cpp_function sets up a chain with the intention of + // overwriting (and has already checked internally that it isn't overwriting non-functions). + add_object(name_, func, true /* overwrite */); + return *this; + } + + /** \rst + Create and return a new Python submodule with the given name and docstring. + This also works recursively, i.e. + + .. code-block:: cpp + + py::module m("example", "pybind11 example plugin"); + py::module m2 = m.def_submodule("sub", "A submodule of 'example'"); + py::module m3 = m2.def_submodule("subsub", "A submodule of 'example.sub'"); + \endrst */ + module def_submodule(const char* name, const char* doc = nullptr) + { + std::string full_name = std::string(PyModule_GetName(m_ptr)) + std::string(".") + std::string(name); + auto result = reinterpret_borrow<module>(PyImport_AddModule(full_name.c_str())); + if (doc && options::show_user_defined_docstrings()) + result.attr("__doc__") = pybind11::str(doc); + attr(name) = result; + return result; + } + + /// Import and return a module or throws `error_already_set`. + static module import(const char* name) + { + PyObject* obj = PyImport_ImportModule(name); + if (!obj) + throw error_already_set(); + return reinterpret_steal<module>(obj); + } + + /// Reload the module or throws `error_already_set`. + void reload() + { + PyObject* obj = PyImport_ReloadModule(ptr()); + if (!obj) + throw error_already_set(); + *this = reinterpret_steal<module>(obj); + } + + // Adds an object to the module using the given name. Throws if an object with the given name + // already exists. + // + // overwrite should almost always be false: attempting to overwrite objects that pybind11 has + // established will, in most cases, break things. + PYBIND11_NOINLINE void add_object(const char* name, handle obj, bool overwrite = false) + { + if (!overwrite && hasattr(*this, name)) + pybind11_fail("Error during initialization: multiple incompatible definitions with name \"" + std::string(name) + + "\""); + + PyModule_AddObject(ptr(), name, obj.inc_ref().ptr() /* steals a reference */); + } +}; + +/// \ingroup python_builtins +/// Return a dictionary representing the global variables in the current execution frame, +/// or ``__main__.__dict__`` if there is no frame (usually when the interpreter is embedded). +inline dict globals() +{ + PyObject* p = PyEval_GetGlobals(); + return reinterpret_borrow<dict>(p ? p : module::import("__main__").attr("__dict__").ptr()); +} + +NAMESPACE_BEGIN(detail) +/// Generic support for creating new Python heap types +class generic_type : public object +{ + template <typename...> + friend class class_; + +public: + PYBIND11_OBJECT_DEFAULT(generic_type, object, PyType_Check) +protected: + void initialize(const type_record& rec) + { + if (rec.scope && hasattr(rec.scope, rec.name)) + pybind11_fail("generic_type: cannot initialize type \"" + std::string(rec.name) + + "\": an object with that name is already defined"); + + if (rec.module_local ? get_local_type_info(*rec.type) : get_global_type_info(*rec.type)) + pybind11_fail("generic_type: type \"" + std::string(rec.name) + "\" is already registered!"); + + m_ptr = make_new_python_type(rec); + + /* Register supplemental type information in C++ dict */ + auto* tinfo = new detail::type_info(); + tinfo->type = (PyTypeObject*)m_ptr; + tinfo->cpptype = rec.type; + tinfo->type_size = rec.type_size; + tinfo->type_align = rec.type_align; + tinfo->operator_new = rec.operator_new; + tinfo->holder_size_in_ptrs = size_in_ptrs(rec.holder_size); + tinfo->init_instance = rec.init_instance; + tinfo->dealloc = rec.dealloc; + tinfo->simple_type = true; + tinfo->simple_ancestors = true; + tinfo->default_holder = rec.default_holder; + tinfo->module_local = rec.module_local; + + auto& internals = get_internals(); + auto tindex = std::type_index(*rec.type); + tinfo->direct_conversions = &internals.direct_conversions[tindex]; + if (rec.module_local) + registered_local_types_cpp()[tindex] = tinfo; + else + internals.registered_types_cpp[tindex] = tinfo; + internals.registered_types_py[(PyTypeObject*)m_ptr] = {tinfo}; + + if (rec.bases.size() > 1 || rec.multiple_inheritance) { + mark_parents_nonsimple(tinfo->type); + tinfo->simple_ancestors = false; + } else if (rec.bases.size() == 1) { + auto parent_tinfo = get_type_info((PyTypeObject*)rec.bases[0].ptr()); + tinfo->simple_ancestors = parent_tinfo->simple_ancestors; + } + + if (rec.module_local) { + // Stash the local typeinfo and loader so that external modules can access it. + tinfo->module_local_load = &type_caster_generic::local_load; + setattr(m_ptr, PYBIND11_MODULE_LOCAL_ID, capsule(tinfo)); + } + } + + /// Helper function which tags all parents of a type using mult. inheritance + void mark_parents_nonsimple(PyTypeObject* value) + { + auto t = reinterpret_borrow<tuple>(value->tp_bases); + for (handle h : t) { + auto tinfo2 = get_type_info((PyTypeObject*)h.ptr()); + if (tinfo2) + tinfo2->simple_type = false; + mark_parents_nonsimple((PyTypeObject*)h.ptr()); + } + } + + void install_buffer_funcs(buffer_info* (*get_buffer)(PyObject*, void*), void* get_buffer_data) + { + PyHeapTypeObject* type = (PyHeapTypeObject*)m_ptr; + auto tinfo = detail::get_type_info(&type->ht_type); + + if (!type->ht_type.tp_as_buffer) + pybind11_fail("To be able to register buffer protocol support for the type '" + std::string(tinfo->type->tp_name) + + "' the associated class<>(..) invocation must " + "include the pybind11::buffer_protocol() annotation!"); + + tinfo->get_buffer = get_buffer; + tinfo->get_buffer_data = get_buffer_data; + } + + // rec_func must be set for either fget or fset. + void def_property_static_impl(const char* name, handle fget, handle fset, detail::function_record* rec_func) + { + const auto is_static = rec_func && !(rec_func->is_method && rec_func->scope); + const auto has_doc = rec_func && rec_func->doc && pybind11::options::show_user_defined_docstrings(); + auto property = handle((PyObject*)(is_static ? get_internals().static_property_type : &PyProperty_Type)); + attr(name) = property(fget.ptr() ? fget : none(), + fset.ptr() ? fset : none(), + /*deleter*/ none(), + pybind11::str(has_doc ? rec_func->doc : "")); + } +}; + +/// Set the pointer to operator new if it exists. The cast is needed because it can be overloaded. +template <typename T, typename = void_t<decltype(static_cast<void* (*)(size_t)>(T::operator new))>> +void set_operator_new(type_record* r) +{ + r->operator_new = &T::operator new; +} + +template <typename> +void set_operator_new(...) +{} + +template <typename T, typename SFINAE = void> +struct has_operator_delete : std::false_type +{}; +template <typename T> +struct has_operator_delete<T, void_t<decltype(static_cast<void (*)(void*)>(T::operator delete))>> : std::true_type +{}; +template <typename T, typename SFINAE = void> +struct has_operator_delete_size : std::false_type +{}; +template <typename T> +struct has_operator_delete_size<T, void_t<decltype(static_cast<void (*)(void*, size_t)>(T::operator delete))>> + : std::true_type +{}; +/// Call class-specific delete if it exists or global otherwise. Can also be an overload set. +template <typename T, enable_if_t<has_operator_delete<T>::value, int> = 0> +void call_operator_delete(T* p, size_t, size_t) +{ + T::operator delete(p); +} +template <typename T, enable_if_t<!has_operator_delete<T>::value && has_operator_delete_size<T>::value, int> = 0> +void call_operator_delete(T* p, size_t s, size_t) +{ + T::operator delete(p, s); +} + +inline void call_operator_delete(void* p, size_t s, size_t a) +{ + (void)s; + (void)a; +#if defined(PYBIND11_CPP17) + if (a > __STDCPP_DEFAULT_NEW_ALIGNMENT__) + ::operator delete(p, s, std::align_val_t(a)); + else + ::operator delete(p, s); +#else + ::operator delete(p); +#endif +} + +NAMESPACE_END(detail) + +/// Given a pointer to a member function, cast it to its `Derived` version. +/// Forward everything else unchanged. +template <typename /*Derived*/, typename F> +auto method_adaptor(F&& f) -> decltype(std::forward<F>(f)) +{ + return std::forward<F>(f); +} + +template <typename Derived, typename Return, typename Class, typename... Args> +auto method_adaptor(Return (Class::*pmf)(Args...)) -> Return (Derived::*)(Args...) +{ + static_assert(detail::is_accessible_base_of<Class, Derived>::value, + "Cannot bind an inaccessible base class method; use a lambda definition instead"); + return pmf; +} + +template <typename Derived, typename Return, typename Class, typename... Args> +auto method_adaptor(Return (Class::*pmf)(Args...) const) -> Return (Derived::*)(Args...) const +{ + static_assert(detail::is_accessible_base_of<Class, Derived>::value, + "Cannot bind an inaccessible base class method; use a lambda definition instead"); + return pmf; +} + +template <typename type_, typename... options> +class class_ : public detail::generic_type +{ + template <typename T> + using is_holder = detail::is_holder_type<type_, T>; + template <typename T> + using is_subtype = detail::is_strict_base_of<type_, T>; + template <typename T> + using is_base = detail::is_strict_base_of<T, type_>; + // struct instead of using here to help MSVC: + template <typename T> + struct is_valid_class_option : detail::any_of<is_holder<T>, is_subtype<T>, is_base<T>> + {}; + +public: + using type = type_; + using type_alias = detail::exactly_one_t<is_subtype, void, options...>; + constexpr static bool has_alias = !std::is_void<type_alias>::value; + using holder_type = detail::exactly_one_t<is_holder, std::unique_ptr<type>, options...>; + + static_assert(detail::all_of<is_valid_class_option<options>...>::value, + "Unknown/invalid class_ template parameters provided"); + + static_assert(!has_alias || std::is_polymorphic<type>::value, + "Cannot use an alias class with a non-polymorphic type"); + + PYBIND11_OBJECT(class_, generic_type, PyType_Check) + + template <typename... Extra> + class_(handle scope, const char* name, const Extra&... extra) + { + using namespace detail; + + // MI can only be specified via class_ template options, not constructor parameters + static_assert(none_of<is_pyobject<Extra>...>::value || // no base class arguments, or: + (constexpr_sum(is_pyobject<Extra>::value...) == 1 && // Exactly one base + constexpr_sum(is_base<options>::value...) == 0 && // no template option bases + none_of<std::is_same<multiple_inheritance, Extra>...>::value), // no multiple_inheritance attr + "Error: multiple inheritance bases must be specified via class_ template options"); + + type_record record; + record.scope = scope; + record.name = name; + record.type = &typeid(type); + record.type_size = sizeof(conditional_t<has_alias, type_alias, type>); + record.type_align = alignof(conditional_t<has_alias, type_alias, type>&); + record.holder_size = sizeof(holder_type); + record.init_instance = init_instance; + record.dealloc = dealloc; + record.default_holder = detail::is_instantiation<std::unique_ptr, holder_type>::value; + + set_operator_new<type>(&record); + + /* Register base classes specified via template arguments to class_, if any */ + PYBIND11_EXPAND_SIDE_EFFECTS(add_base<options>(record)); + + /* Process optional arguments, if any */ + process_attributes<Extra...>::init(extra..., &record); + + generic_type::initialize(record); + + if (has_alias) { + auto& instances = record.module_local ? registered_local_types_cpp() : get_internals().registered_types_cpp; + instances[std::type_index(typeid(type_alias))] = instances[std::type_index(typeid(type))]; + } + } + + template <typename Base, detail::enable_if_t<is_base<Base>::value, int> = 0> + static void add_base(detail::type_record& rec) + { + rec.add_base(typeid(Base), [](void* src) -> void* { return static_cast<Base*>(reinterpret_cast<type*>(src)); }); + } + + template <typename Base, detail::enable_if_t<!is_base<Base>::value, int> = 0> + static void add_base(detail::type_record&) + {} + + template <typename Func, typename... Extra> + class_& def(const char* name_, Func&& f, const Extra&... extra) + { + cpp_function cf(method_adaptor<type>(std::forward<Func>(f)), + name(name_), + is_method(*this), + sibling(getattr(*this, name_, none())), + extra...); + attr(cf.name()) = cf; + return *this; + } + + template <typename Func, typename... Extra> + class_& def_static(const char* name_, Func&& f, const Extra&... extra) + { + static_assert(!std::is_member_function_pointer<Func>::value, + "def_static(...) called with a non-static member function pointer"); + cpp_function cf(std::forward<Func>(f), name(name_), scope(*this), sibling(getattr(*this, name_, none())), extra...); + attr(cf.name()) = staticmethod(cf); + return *this; + } + + template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra> + class_& def(const detail::op_<id, ot, L, R>& op, const Extra&... extra) + { + op.execute(*this, extra...); + return *this; + } + + template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra> + class_& def_cast(const detail::op_<id, ot, L, R>& op, const Extra&... extra) + { + op.execute_cast(*this, extra...); + return *this; + } + + template <typename... Args, typename... Extra> + class_& def(const detail::initimpl::constructor<Args...>& init, const Extra&... extra) + { + init.execute(*this, extra...); + return *this; + } + + template <typename... Args, typename... Extra> + class_& def(const detail::initimpl::alias_constructor<Args...>& init, const Extra&... extra) + { + init.execute(*this, extra...); + return *this; + } + + template <typename... Args, typename... Extra> + class_& def(detail::initimpl::factory<Args...>&& init, const Extra&... extra) + { + std::move(init).execute(*this, extra...); + return *this; + } + + template <typename... Args, typename... Extra> + class_& def(detail::initimpl::pickle_factory<Args...>&& pf, const Extra&... extra) + { + std::move(pf).execute(*this, extra...); + return *this; + } + + template <typename Func> + class_& def_buffer(Func&& func) + { + struct capture + { + Func func; + }; + capture* ptr = new capture{std::forward<Func>(func)}; + install_buffer_funcs( + [](PyObject* obj, void* ptr) -> buffer_info* { + detail::make_caster<type> caster; + if (!caster.load(obj, false)) + return nullptr; + return new buffer_info(((capture*)ptr)->func(caster)); + }, + ptr); + return *this; + } + + template <typename Return, typename Class, typename... Args> + class_& def_buffer(Return (Class::*func)(Args...)) + { + return def_buffer([func](type& obj) { return (obj.*func)(); }); + } + + template <typename Return, typename Class, typename... Args> + class_& def_buffer(Return (Class::*func)(Args...) const) + { + return def_buffer([func](const type& obj) { return (obj.*func)(); }); + } + + template <typename C, typename D, typename... Extra> + class_& def_readwrite(const char* name, D C::*pm, const Extra&... extra) + { + static_assert(std::is_same<C, type>::value || std::is_base_of<C, type>::value, + "def_readwrite() requires a class member (or base class member)"); + cpp_function fget([pm](const type&c) -> const D& { return c.*pm; }, is_method(*this)), + fset([pm](type&c, const D&value) { c.*pm = value; }, is_method(*this)); + def_property(name, fget, fset, return_value_policy::reference_internal, extra...); + return *this; + } + + template <typename C, typename D, typename... Extra> + class_& def_readonly(const char* name, const D C::*pm, const Extra&... extra) + { + static_assert(std::is_same<C, type>::value || std::is_base_of<C, type>::value, + "def_readonly() requires a class member (or base class member)"); + cpp_function fget([pm](const type& c) -> const D& { return c.*pm; }, is_method(*this)); + def_property_readonly(name, fget, return_value_policy::reference_internal, extra...); + return *this; + } + + template <typename D, typename... Extra> + class_& def_readwrite_static(const char* name, D* pm, const Extra&... extra) + { + cpp_function fget([pm](object) -> const D& { return *pm; }, scope(*this)), + fset([pm](object, const D&value) { *pm = value; }, scope(*this)); + def_property_static(name, fget, fset, return_value_policy::reference, extra...); + return *this; + } + + template <typename D, typename... Extra> + class_& def_readonly_static(const char* name, const D* pm, const Extra&... extra) + { + cpp_function fget([pm](object) -> const D& { return *pm; }, scope(*this)); + def_property_readonly_static(name, fget, return_value_policy::reference, extra...); + return *this; + } + + /// Uses return_value_policy::reference_internal by default + template <typename Getter, typename... Extra> + class_& def_property_readonly(const char* name, const Getter& fget, const Extra&... extra) + { + return def_property_readonly( + name, cpp_function(method_adaptor<type>(fget)), return_value_policy::reference_internal, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template <typename... Extra> + class_& def_property_readonly(const char* name, const cpp_function& fget, const Extra&... extra) + { + return def_property(name, fget, nullptr, extra...); + } + + /// Uses return_value_policy::reference by default + template <typename Getter, typename... Extra> + class_& def_property_readonly_static(const char* name, const Getter& fget, const Extra&... extra) + { + return def_property_readonly_static(name, cpp_function(fget), return_value_policy::reference, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template <typename... Extra> + class_& def_property_readonly_static(const char* name, const cpp_function& fget, const Extra&... extra) + { + return def_property_static(name, fget, nullptr, extra...); + } + + /// Uses return_value_policy::reference_internal by default + template <typename Getter, typename Setter, typename... Extra> + class_& def_property(const char* name, const Getter& fget, const Setter& fset, const Extra&... extra) + { + return def_property(name, fget, cpp_function(method_adaptor<type>(fset)), extra...); + } + template <typename Getter, typename... Extra> + class_& def_property(const char* name, const Getter& fget, const cpp_function& fset, const Extra&... extra) + { + return def_property( + name, cpp_function(method_adaptor<type>(fget)), fset, return_value_policy::reference_internal, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template <typename... Extra> + class_& def_property(const char* name, const cpp_function& fget, const cpp_function& fset, const Extra&... extra) + { + return def_property_static(name, fget, fset, is_method(*this), extra...); + } + + /// Uses return_value_policy::reference by default + template <typename Getter, typename... Extra> + class_& def_property_static(const char* name, const Getter& fget, const cpp_function& fset, const Extra&... extra) + { + return def_property_static(name, cpp_function(fget), fset, return_value_policy::reference, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template <typename... Extra> + class_& + def_property_static(const char* name, const cpp_function& fget, const cpp_function& fset, const Extra&... extra) + { + static_assert(0 == detail::constexpr_sum(std::is_base_of<arg, Extra>::value...), + "Argument annotations are not allowed for properties"); + auto rec_fget = get_function_record(fget), rec_fset = get_function_record(fset); + auto* rec_active = rec_fget; + if (rec_fget) { + char* doc_prev = rec_fget->doc; /* 'extra' field may include a property-specific documentation string */ + detail::process_attributes<Extra...>::init(extra..., rec_fget); + if (rec_fget->doc && rec_fget->doc != doc_prev) { + free(doc_prev); + rec_fget->doc = strdup(rec_fget->doc); + } + } + if (rec_fset) { + char* doc_prev = rec_fset->doc; + detail::process_attributes<Extra...>::init(extra..., rec_fset); + if (rec_fset->doc && rec_fset->doc != doc_prev) { + free(doc_prev); + rec_fset->doc = strdup(rec_fset->doc); + } + if (!rec_active) + rec_active = rec_fset; + } + def_property_static_impl(name, fget, fset, rec_active); + return *this; + } + +private: + /// Initialize holder object, variant 1: object derives from enable_shared_from_this + template <typename T> + static void init_holder(detail::instance* inst, + detail::value_and_holder& v_h, + const holder_type* /* unused */, + const std::enable_shared_from_this<T>* /* dummy */) + { + try { + auto sh = + std::dynamic_pointer_cast<typename holder_type::element_type>(v_h.value_ptr<type>()->shared_from_this()); + if (sh) { + new (std::addressof(v_h.holder<holder_type>())) holder_type(std::move(sh)); + v_h.set_holder_constructed(); + } + } catch (const std::bad_weak_ptr&) { + } + + if (!v_h.holder_constructed() && inst->owned) { + new (std::addressof(v_h.holder<holder_type>())) holder_type(v_h.value_ptr<type>()); + v_h.set_holder_constructed(); + } + } + + static void init_holder_from_existing(const detail::value_and_holder& v_h, + const holder_type* holder_ptr, + std::true_type /*is_copy_constructible*/) + { + new (std::addressof(v_h.holder<holder_type>())) holder_type(*reinterpret_cast<const holder_type*>(holder_ptr)); + } + + static void init_holder_from_existing(const detail::value_and_holder& v_h, + const holder_type* holder_ptr, + std::false_type /*is_copy_constructible*/) + { + new (std::addressof(v_h.holder<holder_type>())) holder_type(std::move(*const_cast<holder_type*>(holder_ptr))); + } + + /// Initialize holder object, variant 2: try to construct from existing holder object, if possible + static void init_holder(detail::instance* inst, + detail::value_and_holder& v_h, + const holder_type* holder_ptr, + const void* /* dummy -- not enable_shared_from_this<T>) */) + { + if (holder_ptr) { + init_holder_from_existing(v_h, holder_ptr, std::is_copy_constructible<holder_type>()); + v_h.set_holder_constructed(); + } else if (inst->owned || detail::always_construct_holder<holder_type>::value) { + new (std::addressof(v_h.holder<holder_type>())) holder_type(v_h.value_ptr<type>()); + v_h.set_holder_constructed(); + } + } + + /// Performs instance initialization including constructing a holder and registering the known + /// instance. Should be called as soon as the `type` value_ptr is set for an instance. Takes an + /// optional pointer to an existing holder to use; if not specified and the instance is + /// `.owned`, a new holder will be constructed to manage the value pointer. + static void init_instance(detail::instance* inst, const void* holder_ptr) + { + auto v_h = inst->get_value_and_holder(detail::get_type_info(typeid(type))); + if (!v_h.instance_registered()) { + register_instance(inst, v_h.value_ptr(), v_h.type); + v_h.set_instance_registered(); + } + init_holder(inst, v_h, (const holder_type*)holder_ptr, v_h.value_ptr<type>()); + } + + /// Deallocates an instance; via holder, if constructed; otherwise via operator delete. + static void dealloc(detail::value_and_holder& v_h) + { + if (v_h.holder_constructed()) { + v_h.holder<holder_type>().~holder_type(); + v_h.set_holder_constructed(false); + } else { + detail::call_operator_delete(v_h.value_ptr<type>(), v_h.type->type_size, v_h.type->type_align); + } + v_h.value_ptr() = nullptr; + } + + static detail::function_record* get_function_record(handle h) + { + h = detail::get_function(h); + return h ? (detail::function_record*)reinterpret_borrow<capsule>(PyCFunction_GET_SELF(h.ptr())) : nullptr; + } +}; + +/// Binds an existing constructor taking arguments Args... +template <typename... Args> +detail::initimpl::constructor<Args...> init() +{ + return {}; +} +/// Like `init<Args...>()`, but the instance is always constructed through the alias class (even +/// when not inheriting on the Python side). +template <typename... Args> +detail::initimpl::alias_constructor<Args...> init_alias() +{ + return {}; +} + +/// Binds a factory function as a constructor +template <typename Func, typename Ret = detail::initimpl::factory<Func>> +Ret init(Func&& f) +{ + return {std::forward<Func>(f)}; +} + +/// Dual-argument factory function: the first function is called when no alias is needed, the second +/// when an alias is needed (i.e. due to python-side inheritance). Arguments must be identical. +template <typename CFunc, typename AFunc, typename Ret = detail::initimpl::factory<CFunc, AFunc>> +Ret init(CFunc&& c, AFunc&& a) +{ + return {std::forward<CFunc>(c), std::forward<AFunc>(a)}; +} + +/// Binds pickling functions `__getstate__` and `__setstate__` and ensures that the type +/// returned by `__getstate__` is the same as the argument accepted by `__setstate__`. +template <typename GetState, typename SetState> +detail::initimpl::pickle_factory<GetState, SetState> pickle(GetState&& g, SetState&& s) +{ + return {std::forward<GetState>(g), std::forward<SetState>(s)}; +} + +NAMESPACE_BEGIN(detail) +struct enum_base +{ + enum_base(handle base, handle parent) + : m_base(base) + , m_parent(parent) + {} + + PYBIND11_NOINLINE void init(bool is_arithmetic, bool is_convertible) + { + m_base.attr("__entries") = dict(); + auto property = handle((PyObject*)&PyProperty_Type); + auto static_property = handle((PyObject*)get_internals().static_property_type); + + m_base.attr("__repr__") = cpp_function( + [](handle arg) -> str { + handle type = arg.get_type(); + object type_name = type.attr("__name__"); + dict entries = type.attr("__entries"); + for (const auto& kv : entries) { + object other = kv.second[int_(0)]; + if (other.equal(arg)) + return pybind11::str("{}.{}").format(type_name, kv.first); + } + return pybind11::str("{}.???").format(type_name); + }, + is_method(m_base)); + + m_base.attr("name") = property(cpp_function( + [](handle arg) -> str { + dict entries = arg.get_type().attr("__entries"); + for (const auto& kv : entries) { + if (handle(kv.second[int_(0)]).equal(arg)) + return pybind11::str(kv.first); + } + return "???"; + }, + is_method(m_base))); + + m_base.attr("__doc__") = static_property(cpp_function([](handle arg) -> std::string { + std::string docstring; + dict entries = arg.attr("__entries"); + if (((PyTypeObject*)arg.ptr())->tp_doc) + docstring += std::string(((PyTypeObject*)arg.ptr())->tp_doc) + "\n\n"; + docstring += "Members:"; + for (const auto& kv : entries) { + auto key = std::string(pybind11::str(kv.first)); + auto comment = kv.second[int_(1)]; + docstring += "\n\n " + key; + if (!comment.is_none()) + docstring += " : " + (std::string)pybind11::str(comment); + } + return docstring; + }), + none(), + none(), + ""); + + m_base.attr("__members__") = static_property(cpp_function([](handle arg) -> dict { + dict entries = arg.attr("__entries"), m; + for (const auto& kv : entries) + m[kv.first] = kv.second[int_(0)]; + return m; + }), + none(), + none(), + ""); + +#define PYBIND11_ENUM_OP_STRICT(op, expr, strict_behavior) \ + m_base.attr(op) = cpp_function( \ + [](object a, object b) { \ + if (!a.get_type().is(b.get_type())) \ + strict_behavior; \ + return expr; \ + }, \ + is_method(m_base)) + +#define PYBIND11_ENUM_OP_CONV(op, expr) \ + m_base.attr(op) = cpp_function( \ + [](object a_, object b_) { \ + int_ a(a_), b(b_); \ + return expr; \ + }, \ + is_method(m_base)) + + if (is_convertible) { + PYBIND11_ENUM_OP_CONV("__eq__", !b.is_none() && a.equal(b)); + PYBIND11_ENUM_OP_CONV("__ne__", b.is_none() || !a.equal(b)); + + if (is_arithmetic) { + PYBIND11_ENUM_OP_CONV("__lt__", a < b); + PYBIND11_ENUM_OP_CONV("__gt__", a > b); + PYBIND11_ENUM_OP_CONV("__le__", a <= b); + PYBIND11_ENUM_OP_CONV("__ge__", a >= b); + PYBIND11_ENUM_OP_CONV("__and__", a & b); + PYBIND11_ENUM_OP_CONV("__rand__", a & b); + PYBIND11_ENUM_OP_CONV("__or__", a | b); + PYBIND11_ENUM_OP_CONV("__ror__", a | b); + PYBIND11_ENUM_OP_CONV("__xor__", a ^ b); + PYBIND11_ENUM_OP_CONV("__rxor__", a ^ b); + } + } else { + PYBIND11_ENUM_OP_STRICT("__eq__", int_(a).equal(int_(b)), return false); + PYBIND11_ENUM_OP_STRICT("__ne__", !int_(a).equal(int_(b)), return true); + + if (is_arithmetic) { +#define PYBIND11_THROW throw type_error("Expected an enumeration of matching type!"); + PYBIND11_ENUM_OP_STRICT("__lt__", int_(a) < int_(b), PYBIND11_THROW); + PYBIND11_ENUM_OP_STRICT("__gt__", int_(a) > int_(b), PYBIND11_THROW); + PYBIND11_ENUM_OP_STRICT("__le__", int_(a) <= int_(b), PYBIND11_THROW); + PYBIND11_ENUM_OP_STRICT("__ge__", int_(a) >= int_(b), PYBIND11_THROW); +#undef PYBIND11_THROW + } + } + +#undef PYBIND11_ENUM_OP_CONV +#undef PYBIND11_ENUM_OP_STRICT + + object getstate = cpp_function([](object arg) { return int_(arg); }, is_method(m_base)); + + m_base.attr("__getstate__") = getstate; + m_base.attr("__hash__") = getstate; + } + + PYBIND11_NOINLINE void value(char const* name_, object value, const char* doc = nullptr) + { + dict entries = m_base.attr("__entries"); + str name(name_); + if (entries.contains(name)) { + std::string type_name = (std::string)str(m_base.attr("__name__")); + throw value_error(type_name + ": element \"" + std::string(name_) + "\" already exists!"); + } + + entries[name] = std::make_pair(value, doc); + m_base.attr(name) = value; + } + + PYBIND11_NOINLINE void export_values() + { + dict entries = m_base.attr("__entries"); + for (const auto& kv : entries) + m_parent.attr(kv.first) = kv.second[int_(0)]; + } + + handle m_base; + handle m_parent; +}; + +NAMESPACE_END(detail) + +/// Binds C++ enumerations and enumeration classes to Python +template <typename Type> +class enum_ : public class_<Type> +{ +public: + using Base = class_<Type>; + using Base::attr; + using Base::def; + using Base::def_property_readonly; + using Base::def_property_readonly_static; + using Scalar = typename std::underlying_type<Type>::type; + + template <typename... Extra> + enum_(const handle& scope, const char* name, const Extra&... extra) + : class_<Type>(scope, name, extra...) + , m_base(*this, scope) + { + constexpr bool is_arithmetic = detail::any_of<std::is_same<arithmetic, Extra>...>::value; + constexpr bool is_convertible = std::is_convertible<Type, Scalar>::value; + m_base.init(is_arithmetic, is_convertible); + + def(init([](Scalar i) { return static_cast<Type>(i); })); + def("__int__", [](Type value) { return (Scalar)value; }); +#if PY_MAJOR_VERSION < 3 + def("__long__", [](Type value) { return (Scalar)value; }); +#endif + cpp_function setstate([](Type& value, Scalar arg) { value = static_cast<Type>(arg); }, is_method(*this)); + attr("__setstate__") = setstate; + } + + /// Export enumeration entries into the parent scope + enum_& export_values() + { + m_base.export_values(); + return *this; + } + + /// Add an enumeration entry + enum_& value(char const* name, Type value, const char* doc = nullptr) + { + m_base.value(name, pybind11::cast(value, return_value_policy::copy), doc); + return *this; + } + +private: + detail::enum_base m_base; +}; + +NAMESPACE_BEGIN(detail) + + +inline void keep_alive_impl(handle nurse, handle patient) +{ + if (!nurse || !patient) + pybind11_fail("Could not activate keep_alive!"); + + if (patient.is_none() || nurse.is_none()) + return; /* Nothing to keep alive or nothing to be kept alive by */ + + auto tinfo = all_type_info(Py_TYPE(nurse.ptr())); + if (!tinfo.empty()) { + /* It's a pybind-registered type, so we can store the patient in the + * internal list. */ + add_patient(nurse.ptr(), patient.ptr()); + } else { + /* Fall back to clever approach based on weak references taken from + * Boost.Python. This is not used for pybind-registered types because + * the objects can be destroyed out-of-order in a GC pass. */ + cpp_function disable_lifesupport([patient](handle weakref) { + patient.dec_ref(); + weakref.dec_ref(); + }); + + weakref wr(nurse, disable_lifesupport); + + patient.inc_ref(); /* reference patient and leak the weak reference */ + (void)wr.release(); + } +} + +PYBIND11_NOINLINE inline void keep_alive_impl(size_t Nurse, size_t Patient, function_call& call, handle ret) +{ + auto get_arg = [&](size_t n) { + if (n == 0) + return ret; + else if (n == 1 && call.init_self) + return call.init_self; + else if (n <= call.args.size()) + return call.args[n - 1]; + return handle(); + }; + + keep_alive_impl(get_arg(Nurse), get_arg(Patient)); +} + +inline std::pair<decltype(internals::registered_types_py)::iterator, bool> all_type_info_get_cache(PyTypeObject* type) +{ + auto res = get_internals() + .registered_types_py +#ifdef __cpp_lib_unordered_map_try_emplace + .try_emplace(type); +#else + .emplace(type, std::vector<detail::type_info*>()); +#endif + if (res.second) { + // New cache entry created; set up a weak reference to automatically remove it if the type + // gets destroyed: + weakref((PyObject*)type, cpp_function([type](handle wr) { + get_internals().registered_types_py.erase(type); + wr.dec_ref(); + })) + .release(); + } + + return res; +} + +template <typename Iterator, typename Sentinel, bool KeyIterator, return_value_policy Policy> +struct iterator_state +{ + Iterator it; + Sentinel end; + bool first_or_done; +}; + +NAMESPACE_END(detail) + +/// Makes a python iterator from a first and past-the-end C++ InputIterator. +template <return_value_policy Policy = return_value_policy::reference_internal, + typename Iterator, + typename Sentinel, + typename ValueType = decltype(*std::declval<Iterator>()), + typename... Extra> +iterator make_iterator(Iterator first, Sentinel last, Extra&&... extra) +{ + typedef detail::iterator_state<Iterator, Sentinel, false, Policy> state; + + if (!detail::get_type_info(typeid(state), false)) { + class_<state>(handle(), "iterator", pybind11::module_local()) + .def("__iter__", [](state& s) -> state& { return s; }) + .def("__next__", + [](state& s) -> ValueType { + if (!s.first_or_done) + ++s.it; + else + s.first_or_done = false; + if (s.it == s.end) { + s.first_or_done = true; + throw stop_iteration(); + } + return *s.it; + }, + std::forward<Extra>(extra)..., + Policy); + } + + return cast(state{first, last, true}); +} + +/// Makes an python iterator over the keys (`.first`) of a iterator over pairs from a +/// first and past-the-end InputIterator. +template <return_value_policy Policy = return_value_policy::reference_internal, + typename Iterator, + typename Sentinel, + typename KeyType = decltype((*std::declval<Iterator>()).first), + typename... Extra> +iterator make_key_iterator(Iterator first, Sentinel last, Extra&&... extra) +{ + typedef detail::iterator_state<Iterator, Sentinel, true, Policy> state; + + if (!detail::get_type_info(typeid(state), false)) { + class_<state>(handle(), "iterator", pybind11::module_local()) + .def("__iter__", [](state& s) -> state& { return s; }) + .def("__next__", + [](state& s) -> KeyType { + if (!s.first_or_done) + ++s.it; + else + s.first_or_done = false; + if (s.it == s.end) { + s.first_or_done = true; + throw stop_iteration(); + } + return (*s.it).first; + }, + std::forward<Extra>(extra)..., + Policy); + } + + return cast(state{first, last, true}); +} + +/// Makes an iterator over values of an stl container or other container supporting +/// `std::begin()`/`std::end()` +template <return_value_policy Policy = return_value_policy::reference_internal, typename Type, typename... Extra> +iterator make_iterator(Type& value, Extra&&... extra) +{ + return make_iterator<Policy>(std::begin(value), std::end(value), extra...); +} + +/// Makes an iterator over the keys (`.first`) of a stl map-like container supporting +/// `std::begin()`/`std::end()` +template <return_value_policy Policy = return_value_policy::reference_internal, typename Type, typename... Extra> +iterator make_key_iterator(Type& value, Extra&&... extra) +{ + return make_key_iterator<Policy>(std::begin(value), std::end(value), extra...); +} + +template <typename InputType, typename OutputType> +void implicitly_convertible() +{ + struct set_flag + { + bool& flag; + set_flag(bool& flag) + : flag(flag) + { + flag = true; + } + ~set_flag() + { + flag = false; + } + }; + auto implicit_caster = [](PyObject* obj, PyTypeObject* type) -> PyObject* { + static bool currently_used = false; + if (currently_used) // implicit conversions are non-reentrant + return nullptr; + set_flag flag_helper(currently_used); + if (!detail::make_caster<InputType>().load(obj, false)) + return nullptr; + tuple args(1); + args[0] = obj; + PyObject* result = PyObject_Call((PyObject*)type, args.ptr(), nullptr); + if (result == nullptr) + PyErr_Clear(); + return result; + }; + + if (auto tinfo = detail::get_type_info(typeid(OutputType))) + tinfo->implicit_conversions.push_back(implicit_caster); + else + pybind11_fail("implicitly_convertible: Unable to find type " + type_id<OutputType>()); +} + +template <typename ExceptionTranslator> +void register_exception_translator(ExceptionTranslator&& translator) +{ + detail::get_internals().registered_exception_translators.push_front(std::forward<ExceptionTranslator>(translator)); +} + +/** + * Wrapper to generate a new Python exception type. + * + * This should only be used with PyErr_SetString for now. + * It is not (yet) possible to use as a py::base. + * Template type argument is reserved for future use. + */ +template <typename type> +class exception : public object +{ +public: + exception() = default; + exception(handle scope, const char* name, PyObject* base = PyExc_Exception) + { + std::string full_name = scope.attr("__name__").cast<std::string>() + std::string(".") + name; + m_ptr = PyErr_NewException(const_cast<char*>(full_name.c_str()), base, NULL); + if (hasattr(scope, name)) + pybind11_fail("Error during initialization: multiple incompatible " + "definitions with name \"" + + std::string(name) + "\""); + scope.attr(name) = *this; + } + + // Sets the current python exception to this exception object with the given message + void operator()(const char* message) + { + PyErr_SetString(m_ptr, message); + } +}; + +NAMESPACE_BEGIN(detail) +// Returns a reference to a function-local static exception object used in the simple +// register_exception approach below. (It would be simpler to have the static local variable +// directly in register_exception, but that makes clang <3.5 segfault - issue #1349). +template <typename CppException> +exception<CppException>& get_exception_object() +{ + static exception<CppException> ex; + return ex; +} +NAMESPACE_END(detail) + +/** + * Registers a Python exception in `m` of the given `name` and installs an exception translator to + * translate the C++ exception to the created Python exception using the exceptions what() method. + * This is intended for simple exception translations; for more complex translation, register the + * exception object and translator directly. + */ +template <typename CppException> +exception<CppException>& register_exception(handle scope, const char* name, PyObject* base = PyExc_Exception) +{ + auto& ex = detail::get_exception_object<CppException>(); + if (!ex) + ex = exception<CppException>(scope, name, base); + + register_exception_translator([](std::exception_ptr p) { + if (!p) + return; + try { + std::rethrow_exception(p); + } catch (const CppException& e) { + detail::get_exception_object<CppException>()(e.what()); + } + }); + return ex; +} + +NAMESPACE_BEGIN(detail) +PYBIND11_NOINLINE inline void print(tuple args, dict kwargs) +{ + auto strings = tuple(args.size()); + for (size_t i = 0; i < args.size(); ++i) { + strings[i] = str(args[i]); + } + auto sep = kwargs.contains("sep") ? kwargs["sep"] : cast(" "); + auto line = sep.attr("join")(strings); + + object file; + if (kwargs.contains("file")) { + file = kwargs["file"].cast<object>(); + } else { + try { + file = module::import("sys").attr("stdout"); + } catch (const error_already_set&) { + /* If print() is called from code that is executed as + part of garbage collection during interpreter shutdown, + importing 'sys' can fail. Give up rather than crashing the + interpreter in this case. */ + return; + } + } + + auto write = file.attr("write"); + write(line); + write(kwargs.contains("end") ? kwargs["end"] : cast("\n")); + + if (kwargs.contains("flush") && kwargs["flush"].cast<bool>()) + file.attr("flush")(); +} +NAMESPACE_END(detail) + +template <return_value_policy policy = return_value_policy::automatic_reference, typename... Args> +void print(Args&&... args) +{ + auto c = detail::collect_arguments<policy>(std::forward<Args>(args)...); + detail::print(c.args(), c.kwargs()); +} + +#if defined(WITH_THREAD) && !defined(PYPY_VERSION) + +/* The functions below essentially reproduce the PyGILState_* API using a RAII + * pattern, but there are a few important differences: + * + * 1. When acquiring the GIL from an non-main thread during the finalization + * phase, the GILState API blindly terminates the calling thread, which + * is often not what is wanted. This API does not do this. + * + * 2. The gil_scoped_release function can optionally cut the relationship + * of a PyThreadState and its associated thread, which allows moving it to + * another thread (this is a fairly rare/advanced use case). + * + * 3. The reference count of an acquired thread state can be controlled. This + * can be handy to prevent cases where callbacks issued from an external + * thread would otherwise constantly construct and destroy thread state data + * structures. + * + * See the Python bindings of NanoGUI (http://github.com/wjakob/nanogui) for an + * example which uses features 2 and 3 to migrate the Python thread of + * execution to another thread (to run the event loop on the original thread, + * in this case). + */ + +class gil_scoped_acquire +{ +public: + PYBIND11_NOINLINE gil_scoped_acquire() + { + auto const& internals = detail::get_internals(); + tstate = (PyThreadState*)PYBIND11_TLS_GET_VALUE(internals.tstate); + + if (!tstate) { + /* Check if the GIL was acquired using the PyGILState_* API instead (e.g. if + calling from a Python thread). Since we use a different key, this ensures + we don't create a new thread state and deadlock in PyEval_AcquireThread + below. Note we don't save this state with internals.tstate, since we don't + create it we would fail to clear it (its reference count should be > 0). */ + tstate = PyGILState_GetThisThreadState(); + } + + if (!tstate) { + tstate = PyThreadState_New(internals.istate); +# if !defined(NDEBUG) + if (!tstate) + pybind11_fail("scoped_acquire: could not create thread state!"); +# endif + tstate->gilstate_counter = 0; + PYBIND11_TLS_REPLACE_VALUE(internals.tstate, tstate); + } else { + release = detail::get_thread_state_unchecked() != tstate; + } + + if (release) { +/* Work around an annoying assertion in PyThreadState_Swap */ +# if defined(Py_DEBUG) + PyInterpreterState* interp = tstate->interp; + tstate->interp = nullptr; +# endif + PyEval_AcquireThread(tstate); +# if defined(Py_DEBUG) + tstate->interp = interp; +# endif + } + + inc_ref(); + } + + void inc_ref() + { + ++tstate->gilstate_counter; + } + + PYBIND11_NOINLINE void dec_ref() + { + --tstate->gilstate_counter; +# if !defined(NDEBUG) + if (detail::get_thread_state_unchecked() != tstate) + pybind11_fail("scoped_acquire::dec_ref(): thread state must be current!"); + if (tstate->gilstate_counter < 0) + pybind11_fail("scoped_acquire::dec_ref(): reference count underflow!"); +# endif + if (tstate->gilstate_counter == 0) { +# if !defined(NDEBUG) + if (!release) + pybind11_fail("scoped_acquire::dec_ref(): internal error!"); +# endif + PyThreadState_Clear(tstate); + PyThreadState_DeleteCurrent(); + PYBIND11_TLS_DELETE_VALUE(detail::get_internals().tstate); + release = false; + } + } + + PYBIND11_NOINLINE ~gil_scoped_acquire() + { + dec_ref(); + if (release) + PyEval_SaveThread(); + } + +private: + PyThreadState* tstate = nullptr; + bool release = true; +}; + +class gil_scoped_release +{ +public: + explicit gil_scoped_release(bool disassoc = false) + : disassoc(disassoc) + { + // `get_internals()` must be called here unconditionally in order to initialize + // `internals.tstate` for subsequent `gil_scoped_acquire` calls. Otherwise, an + // initialization race could occur as multiple threads try `gil_scoped_acquire`. + const auto& internals = detail::get_internals(); + tstate = PyEval_SaveThread(); + if (disassoc) { + auto key = internals.tstate; + PYBIND11_TLS_DELETE_VALUE(key); + } + } + ~gil_scoped_release() + { + if (!tstate) + return; + PyEval_RestoreThread(tstate); + if (disassoc) { + auto key = detail::get_internals().tstate; + PYBIND11_TLS_REPLACE_VALUE(key, tstate); + } + } + +private: + PyThreadState* tstate; + bool disassoc; +}; +#elif defined(PYPY_VERSION) +class gil_scoped_acquire +{ + PyGILState_STATE state; + +public: + gil_scoped_acquire() + { + state = PyGILState_Ensure(); + } + ~gil_scoped_acquire() + { + PyGILState_Release(state); + } +}; + +class gil_scoped_release +{ + PyThreadState* state; + +public: + gil_scoped_release() + { + state = PyEval_SaveThread(); + } + ~gil_scoped_release() + { + PyEval_RestoreThread(state); + } +}; +#else +class gil_scoped_acquire +{}; +class gil_scoped_release +{}; +#endif + +error_already_set::~error_already_set() +{ + if (m_type) { + error_scope scope; + gil_scoped_acquire gil; + m_type.release().dec_ref(); + m_value.release().dec_ref(); + m_trace.release().dec_ref(); + } +} + +inline function get_type_overload(const void* this_ptr, const detail::type_info* this_type, const char* name) +{ + handle self = detail::get_object_handle(this_ptr, this_type); + if (!self) + return function(); + handle type = self.get_type(); + auto key = std::make_pair(type.ptr(), name); + + /* Cache functions that aren't overloaded in Python to avoid + many costly Python dictionary lookups below */ + auto& cache = detail::get_internals().inactive_overload_cache; + if (cache.find(key) != cache.end()) + return function(); + + function overload = getattr(self, name, function()); + if (overload.is_cpp_function()) { + cache.insert(key); + return function(); + } + + /* Don't call dispatch code if invoked from overridden function. + Unfortunately this doesn't work on PyPy. */ +#if !defined(PYPY_VERSION) + PyFrameObject* frame = PyThreadState_Get()->frame; + if (frame && (std::string)str(frame->f_code->co_name) == name && frame->f_code->co_argcount > 0) { + PyFrame_FastToLocals(frame); + PyObject* self_caller = PyDict_GetItem(frame->f_locals, PyTuple_GET_ITEM(frame->f_code->co_varnames, 0)); + if (self_caller == self.ptr()) + return function(); + } +#else + /* PyPy currently doesn't provide a detailed cpyext emulation of + frame objects, so we have to emulate this using Python. This + is going to be slow..*/ + dict d; + d["self"] = self; + d["name"] = pybind11::str(name); + PyObject* result = PyRun_String("import inspect\n" + "frame = inspect.currentframe()\n" + "if frame is not None:\n" + " frame = frame.f_back\n" + " if frame is not None and str(frame.f_code.co_name) == name and " + "frame.f_code.co_argcount > 0:\n" + " self_caller = frame.f_locals[frame.f_code.co_varnames[0]]\n" + " if self_caller == self:\n" + " self = None\n", + Py_file_input, + d.ptr(), + d.ptr()); + if (result == nullptr) + throw error_already_set(); + if (d["self"].is_none()) + return function(); + Py_DECREF(result); +#endif + + return overload; +} + +/** \rst + Try to retrieve a python method by the provided name from the instance pointed to by the this_ptr. + + :this_ptr: The pointer to the object the overload should be retrieved for. This should be the first + non-trampoline class encountered in the inheritance chain. + :name: The name of the overloaded Python method to retrieve. + :return: The Python method by this name from the object or an empty function wrapper. + \endrst */ +template <class T> +function get_overload(const T* this_ptr, const char* name) +{ + auto tinfo = detail::get_type_info(typeid(T)); + return tinfo ? get_type_overload(this_ptr, tinfo, name) : function(); +} + +#define PYBIND11_OVERLOAD_INT(ret_type, cname, name, ...) \ + { \ + pybind11::gil_scoped_acquire gil; \ + pybind11::function overload = pybind11::get_overload(static_cast<const cname*>(this), name); \ + if (overload) { \ + auto o = overload(__VA_ARGS__); \ + if (pybind11::detail::cast_is_temporary_value_reference<ret_type>::value) { \ + static pybind11::detail::overload_caster_t<ret_type> caster; \ + return pybind11::detail::cast_ref<ret_type>(std::move(o), caster); \ + } else \ + return pybind11::detail::cast_safe<ret_type>(std::move(o)); \ + } \ + } + +/** \rst + Macro to populate the virtual method in the trampoline class. This macro tries to look up a method named 'fn' + from the Python side, deals with the :ref:`gil` and necessary argument conversions to call this method and return + the appropriate type. See :ref:`overriding_virtuals` for more information. This macro should be used when the method + name in C is not the same as the method name in Python. For example with `__str__`. + + .. code-block:: cpp + + std::string toString() override { + PYBIND11_OVERLOAD_NAME( + std::string, // Return type (ret_type) + Animal, // Parent class (cname) + toString, // Name of function in C++ (name) + "__str__", // Name of method in Python (fn) + ); + } +\endrst */ +#define PYBIND11_OVERLOAD_NAME(ret_type, cname, name, fn, ...) \ + PYBIND11_OVERLOAD_INT(PYBIND11_TYPE(ret_type), PYBIND11_TYPE(cname), name, __VA_ARGS__) \ + return cname::fn(__VA_ARGS__) + +/** \rst + Macro for pure virtual functions, this function is identical to :c:macro:`PYBIND11_OVERLOAD_NAME`, except that it + throws if no overload can be found. +\endrst */ +#define PYBIND11_OVERLOAD_PURE_NAME(ret_type, cname, name, fn, ...) \ + PYBIND11_OVERLOAD_INT(PYBIND11_TYPE(ret_type), PYBIND11_TYPE(cname), name, __VA_ARGS__) \ + pybind11::pybind11_fail("Tried to call pure virtual function \"" PYBIND11_STRINGIFY(cname) "::" name "\""); + +/** \rst + Macro to populate the virtual method in the trampoline class. This macro tries to look up the method + from the Python side, deals with the :ref:`gil` and necessary argument conversions to call this method and return + the appropriate type. This macro should be used if the method name in C and in Python are identical. + See :ref:`overriding_virtuals` for more information. + + .. code-block:: cpp + + class PyAnimal : public Animal { + public: + // Inherit the constructors + using Animal::Animal; + + // Trampoline (need one for each virtual function) + std::string go(int n_times) override { + PYBIND11_OVERLOAD_PURE( + std::string, // Return type (ret_type) + Animal, // Parent class (cname) + go, // Name of function in C++ (must match Python name) (fn) + n_times // Argument(s) (...) + ); + } + }; +\endrst */ +#define PYBIND11_OVERLOAD(ret_type, cname, fn, ...) \ + PYBIND11_OVERLOAD_NAME(PYBIND11_TYPE(ret_type), PYBIND11_TYPE(cname), #fn, fn, __VA_ARGS__) + +/** \rst + Macro for pure virtual functions, this function is identical to :c:macro:`PYBIND11_OVERLOAD`, except that it throws + if no overload can be found. +\endrst */ +#define PYBIND11_OVERLOAD_PURE(ret_type, cname, fn, ...) \ + PYBIND11_OVERLOAD_PURE_NAME(PYBIND11_TYPE(ret_type), PYBIND11_TYPE(cname), #fn, fn, __VA_ARGS__) + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) && !defined(__INTEL_COMPILER) +# pragma warning(pop) +#elif defined(__GNUG__) && !defined(__clang__) +# pragma GCC diagnostic pop +#endif diff --git a/pybind11/include/pybind11/pytypes.h b/pybind11/include/pybind11/pytypes.h new file mode 100644 index 0000000000000000000000000000000000000000..f90bc11d42178be0f38de54562c25334efcbe82f --- /dev/null +++ b/pybind11/include/pybind11/pytypes.h @@ -0,0 +1,2146 @@ +/* + pybind11/pytypes.h: Convenience wrapper classes for basic Python types + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" +#include "buffer_info.h" +#include <utility> +#include <type_traits> + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/* A few forward declarations */ +class handle; +class object; +class str; +class iterator; +struct arg; +struct arg_v; + +NAMESPACE_BEGIN(detail) +class args_proxy; +inline bool isinstance_generic(handle obj, const std::type_info& tp); + +// Accessor forward declarations +template <typename Policy> +class accessor; +namespace accessor_policies { +struct obj_attr; +struct str_attr; +struct generic_item; +struct sequence_item; +struct list_item; +struct tuple_item; +} // namespace accessor_policies +using obj_attr_accessor = accessor<accessor_policies::obj_attr>; +using str_attr_accessor = accessor<accessor_policies::str_attr>; +using item_accessor = accessor<accessor_policies::generic_item>; +using sequence_accessor = accessor<accessor_policies::sequence_item>; +using list_accessor = accessor<accessor_policies::list_item>; +using tuple_accessor = accessor<accessor_policies::tuple_item>; + +/// Tag and check to identify a class which implements the Python object API +class pyobject_tag +{}; +template <typename T> +using is_pyobject = std::is_base_of<pyobject_tag, remove_reference_t<T>>; + +/** \rst + A mixin class which adds common functions to `handle`, `object` and various accessors. + The only requirement for `Derived` is to implement ``PyObject *Derived::ptr() const``. +\endrst */ +template <typename Derived> +class object_api : public pyobject_tag +{ + const Derived& derived() const + { + return static_cast<const Derived&>(*this); + } + +public: + /** \rst + Return an iterator equivalent to calling ``iter()`` in Python. The object + must be a collection which supports the iteration protocol. + \endrst */ + iterator begin() const; + /// Return a sentinel which ends iteration. + iterator end() const; + + /** \rst + Return an internal functor to invoke the object's sequence protocol. Casting + the returned ``detail::item_accessor`` instance to a `handle` or `object` + subclass causes a corresponding call to ``__getitem__``. Assigning a `handle` + or `object` subclass causes a call to ``__setitem__``. + \endrst */ + item_accessor operator[](handle key) const; + /// See above (the only difference is that they key is provided as a string literal) + item_accessor operator[](const char* key) const; + + /** \rst + Return an internal functor to access the object's attributes. Casting the + returned ``detail::obj_attr_accessor`` instance to a `handle` or `object` + subclass causes a corresponding call to ``getattr``. Assigning a `handle` + or `object` subclass causes a call to ``setattr``. + \endrst */ + obj_attr_accessor attr(handle key) const; + /// See above (the only difference is that they key is provided as a string literal) + str_attr_accessor attr(const char* key) const; + + /** \rst + Matches * unpacking in Python, e.g. to unpack arguments out of a ``tuple`` + or ``list`` for a function call. Applying another * to the result yields + ** unpacking, e.g. to unpack a dict as function keyword arguments. + See :ref:`calling_python_functions`. + \endrst */ + args_proxy operator*() const; + + /// Check if the given item is contained within this object, i.e. ``item in obj``. + template <typename T> + bool contains(T&& item) const; + + /** \rst + Assuming the Python object is a function or implements the ``__call__`` + protocol, ``operator()`` invokes the underlying function, passing an + arbitrary set of parameters. The result is returned as a `object` and + may need to be converted back into a Python object using `handle::cast()`. + + When some of the arguments cannot be converted to Python objects, the + function will throw a `cast_error` exception. When the Python function + call fails, a `error_already_set` exception is thrown. + \endrst */ + template <return_value_policy policy = return_value_policy::automatic_reference, typename... Args> + object operator()(Args&&... args) const; + template <return_value_policy policy = return_value_policy::automatic_reference, typename... Args> + PYBIND11_DEPRECATED("call(...) was deprecated in favor of operator()(...)") + object call(Args&&... args) const; + + /// Equivalent to ``obj is other`` in Python. + bool is(object_api const& other) const + { + return derived().ptr() == other.derived().ptr(); + } + /// Equivalent to ``obj is None`` in Python. + bool is_none() const + { + return derived().ptr() == Py_None; + } + /// Equivalent to obj == other in Python + bool equal(object_api const& other) const + { + return rich_compare(other, Py_EQ); + } + bool not_equal(object_api const& other) const + { + return rich_compare(other, Py_NE); + } + bool operator<(object_api const& other) const + { + return rich_compare(other, Py_LT); + } + bool operator<=(object_api const& other) const + { + return rich_compare(other, Py_LE); + } + bool operator>(object_api const& other) const + { + return rich_compare(other, Py_GT); + } + bool operator>=(object_api const& other) const + { + return rich_compare(other, Py_GE); + } + + object operator-() const; + object operator~() const; + object operator+(object_api const& other) const; + object operator+=(object_api const& other) const; + object operator-(object_api const& other) const; + object operator-=(object_api const& other) const; + object operator*(object_api const& other) const; + object operator*=(object_api const& other) const; + object operator/(object_api const& other) const; + object operator/=(object_api const& other) const; + object operator|(object_api const& other) const; + object operator|=(object_api const& other) const; + object operator&(object_api const& other) const; + object operator&=(object_api const& other) const; + object operator^(object_api const& other) const; + object operator^=(object_api const& other) const; + object operator<<(object_api const& other) const; + object operator<<=(object_api const& other) const; + object operator>>(object_api const& other) const; + object operator>>=(object_api const& other) const; + + PYBIND11_DEPRECATED("Use py::str(obj) instead") + pybind11::str str() const; + + /// Get or set the object's docstring, i.e. ``obj.__doc__``. + str_attr_accessor doc() const; + + /// Return the object's current reference count + int ref_count() const + { + return static_cast<int>(Py_REFCNT(derived().ptr())); + } + /// Return a handle to the Python type object underlying the instance + handle get_type() const; + +private: + bool rich_compare(object_api const& other, int value) const; +}; + +NAMESPACE_END(detail) + +/** \rst + Holds a reference to a Python object (no reference counting) + + The `handle` class is a thin wrapper around an arbitrary Python object (i.e. a + ``PyObject *`` in Python's C API). It does not perform any automatic reference + counting and merely provides a basic C++ interface to various Python API functions. + + .. seealso:: + The `object` class inherits from `handle` and adds automatic reference + counting features. +\endrst */ +class handle : public detail::object_api<handle> +{ +public: + /// The default constructor creates a handle with a ``nullptr``-valued pointer + handle() = default; + /// Creates a ``handle`` from the given raw Python object pointer + handle(PyObject* ptr) + : m_ptr(ptr) + {} // Allow implicit conversion from PyObject* + + /// Return the underlying ``PyObject *`` pointer + PyObject* ptr() const + { + return m_ptr; + } + PyObject*& ptr() + { + return m_ptr; + } + + /** \rst + Manually increase the reference count of the Python object. Usually, it is + preferable to use the `object` class which derives from `handle` and calls + this function automatically. Returns a reference to itself. + \endrst */ + const handle& inc_ref() const& + { + Py_XINCREF(m_ptr); + return *this; + } + + /** \rst + Manually decrease the reference count of the Python object. Usually, it is + preferable to use the `object` class which derives from `handle` and calls + this function automatically. Returns a reference to itself. + \endrst */ + const handle& dec_ref() const& + { + Py_XDECREF(m_ptr); + return *this; + } + + /** \rst + Attempt to cast the Python object into the given C++ type. A `cast_error` + will be throw upon failure. + \endrst */ + template <typename T> + T cast() const; + /// Return ``true`` when the `handle` wraps a valid Python object + explicit operator bool() const + { + return m_ptr != nullptr; + } + /** \rst + Deprecated: Check that the underlying pointers are the same. + Equivalent to ``obj1 is obj2`` in Python. + \endrst */ + PYBIND11_DEPRECATED("Use obj1.is(obj2) instead") + bool operator==(const handle& h) const + { + return m_ptr == h.m_ptr; + } + PYBIND11_DEPRECATED("Use !obj1.is(obj2) instead") + bool operator!=(const handle& h) const + { + return m_ptr != h.m_ptr; + } + PYBIND11_DEPRECATED("Use handle::operator bool() instead") + bool check() const + { + return m_ptr != nullptr; + } + +protected: + PyObject* m_ptr = nullptr; +}; + +/** \rst + Holds a reference to a Python object (with reference counting) + + Like `handle`, the `object` class is a thin wrapper around an arbitrary Python + object (i.e. a ``PyObject *`` in Python's C API). In contrast to `handle`, it + optionally increases the object's reference count upon construction, and it + *always* decreases the reference count when the `object` instance goes out of + scope and is destructed. When using `object` instances consistently, it is much + easier to get reference counting right at the first attempt. +\endrst */ +class object : public handle +{ +public: + object() = default; + PYBIND11_DEPRECATED("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") + object(handle h, bool is_borrowed) + : handle(h) + { + if (is_borrowed) + inc_ref(); + } + /// Copy constructor; always increases the reference count + object(const object& o) + : handle(o) + { + inc_ref(); + } + /// Move constructor; steals the object from ``other`` and preserves its reference count + object(object&& other) noexcept + { + m_ptr = other.m_ptr; + other.m_ptr = nullptr; + } + /// Destructor; automatically calls `handle::dec_ref()` + ~object() + { + dec_ref(); + } + + /** \rst + Resets the internal pointer to ``nullptr`` without without decreasing the + object's reference count. The function returns a raw handle to the original + Python object. + \endrst */ + handle release() + { + PyObject* tmp = m_ptr; + m_ptr = nullptr; + return handle(tmp); + } + + object& operator=(const object& other) + { + other.inc_ref(); + dec_ref(); + m_ptr = other.m_ptr; + return *this; + } + + object& operator=(object&& other) noexcept + { + if (this != &other) { + handle temp(m_ptr); + m_ptr = other.m_ptr; + other.m_ptr = nullptr; + temp.dec_ref(); + } + return *this; + } + + // Calling cast() on an object lvalue just copies (via handle::cast) + template <typename T> + T cast() const&; + // Calling on an object rvalue does a move, if needed and/or possible + template <typename T> + T cast() &&; + +protected: + // Tags for choosing constructors from raw PyObject * + struct borrowed_t + {}; + struct stolen_t + {}; + + template <typename T> + friend T reinterpret_borrow(handle); + template <typename T> + friend T reinterpret_steal(handle); + +public: + // Only accessible from derived classes and the reinterpret_* functions + object(handle h, borrowed_t) + : handle(h) + { + inc_ref(); + } + object(handle h, stolen_t) + : handle(h) + {} +}; + +/** \rst + Declare that a `handle` or ``PyObject *`` is a certain type and borrow the reference. + The target type ``T`` must be `object` or one of its derived classes. The function + doesn't do any conversions or checks. It's up to the user to make sure that the + target type is correct. + + .. code-block:: cpp + + PyObject *p = PyList_GetItem(obj, index); + py::object o = reinterpret_borrow<py::object>(p); + // or + py::tuple t = reinterpret_borrow<py::tuple>(p); // <-- `p` must be already be a `tuple` +\endrst */ +template <typename T> +T reinterpret_borrow(handle h) +{ + return {h, object::borrowed_t{}}; +} + +/** \rst + Like `reinterpret_borrow`, but steals the reference. + + .. code-block:: cpp + + PyObject *p = PyObject_Str(obj); + py::str s = reinterpret_steal<py::str>(p); // <-- `p` must be already be a `str` +\endrst */ +template <typename T> +T reinterpret_steal(handle h) +{ + return {h, object::stolen_t{}}; +} + +NAMESPACE_BEGIN(detail) +inline std::string error_string(); +NAMESPACE_END(detail) + +/// Fetch and hold an error which was already set in Python. An instance of this is typically +/// thrown to propagate python-side errors back through C++ which can either be caught manually or +/// else falls back to the function dispatcher (which then raises the captured error back to +/// python). +class error_already_set : public std::runtime_error +{ +public: + /// Constructs a new exception from the current Python error indicator, if any. The current + /// Python error indicator will be cleared. + error_already_set() + : std::runtime_error(detail::error_string()) + { + PyErr_Fetch(&m_type.ptr(), &m_value.ptr(), &m_trace.ptr()); + } + + error_already_set(const error_already_set&) = default; + error_already_set(error_already_set&&) = default; + + inline ~error_already_set(); + + /// Give the currently-held error back to Python, if any. If there is currently a Python error + /// already set it is cleared first. After this call, the current object no longer stores the + /// error variables (but the `.what()` string is still available). + void restore() + { + PyErr_Restore(m_type.release().ptr(), m_value.release().ptr(), m_trace.release().ptr()); + } + + // Does nothing; provided for backwards compatibility. + PYBIND11_DEPRECATED("Use of error_already_set.clear() is deprecated") + void clear() {} + + /// Check if the currently trapped error type matches the given Python exception class (or a + /// subclass thereof). May also be passed a tuple to search for any exception class matches in + /// the given tuple. + bool matches(handle exc) const + { + return PyErr_GivenExceptionMatches(m_type.ptr(), exc.ptr()); + } + + const object& type() const + { + return m_type; + } + const object& value() const + { + return m_value; + } + const object& trace() const + { + return m_trace; + } + +private: + object m_type, m_value, m_trace; +}; + +/** \defgroup python_builtins _ + Unless stated otherwise, the following C++ functions behave the same + as their Python counterparts. + */ + +/** \ingroup python_builtins + \rst + Return true if ``obj`` is an instance of ``T``. Type ``T`` must be a subclass of + `object` or a class which was exposed to Python as ``py::class_<T>``. +\endrst */ +template <typename T, detail::enable_if_t<std::is_base_of<object, T>::value, int> = 0> +bool isinstance(handle obj) +{ + return T::check_(obj); +} + +template <typename T, detail::enable_if_t<!std::is_base_of<object, T>::value, int> = 0> +bool isinstance(handle obj) +{ + return detail::isinstance_generic(obj, typeid(T)); +} + +template <> +inline bool isinstance<handle>(handle obj) = delete; +template <> +inline bool isinstance<object>(handle obj) +{ + return obj.ptr() != nullptr; +} + +/// \ingroup python_builtins +/// Return true if ``obj`` is an instance of the ``type``. +inline bool isinstance(handle obj, handle type) +{ + const auto result = PyObject_IsInstance(obj.ptr(), type.ptr()); + if (result == -1) + throw error_already_set(); + return result != 0; +} + +/// \addtogroup python_builtins +/// @{ +inline bool hasattr(handle obj, handle name) +{ + return PyObject_HasAttr(obj.ptr(), name.ptr()) == 1; +} + +inline bool hasattr(handle obj, const char* name) +{ + return PyObject_HasAttrString(obj.ptr(), name) == 1; +} + +inline void delattr(handle obj, handle name) +{ + if (PyObject_DelAttr(obj.ptr(), name.ptr()) != 0) { + throw error_already_set(); + } +} + +inline void delattr(handle obj, const char* name) +{ + if (PyObject_DelAttrString(obj.ptr(), name) != 0) { + throw error_already_set(); + } +} + +inline object getattr(handle obj, handle name) +{ + PyObject* result = PyObject_GetAttr(obj.ptr(), name.ptr()); + if (!result) { + throw error_already_set(); + } + return reinterpret_steal<object>(result); +} + +inline object getattr(handle obj, const char* name) +{ + PyObject* result = PyObject_GetAttrString(obj.ptr(), name); + if (!result) { + throw error_already_set(); + } + return reinterpret_steal<object>(result); +} + +inline object getattr(handle obj, handle name, handle default_) +{ + if (PyObject* result = PyObject_GetAttr(obj.ptr(), name.ptr())) { + return reinterpret_steal<object>(result); + } else { + PyErr_Clear(); + return reinterpret_borrow<object>(default_); + } +} + +inline object getattr(handle obj, const char* name, handle default_) +{ + if (PyObject* result = PyObject_GetAttrString(obj.ptr(), name)) { + return reinterpret_steal<object>(result); + } else { + PyErr_Clear(); + return reinterpret_borrow<object>(default_); + } +} + +inline void setattr(handle obj, handle name, handle value) +{ + if (PyObject_SetAttr(obj.ptr(), name.ptr(), value.ptr()) != 0) { + throw error_already_set(); + } +} + +inline void setattr(handle obj, const char* name, handle value) +{ + if (PyObject_SetAttrString(obj.ptr(), name, value.ptr()) != 0) { + throw error_already_set(); + } +} + +inline ssize_t hash(handle obj) +{ + auto h = PyObject_Hash(obj.ptr()); + if (h == -1) { + throw error_already_set(); + } + return h; +} + +/// @} python_builtins + +NAMESPACE_BEGIN(detail) +inline handle get_function(handle value) +{ + if (value) { +#if PY_MAJOR_VERSION >= 3 + if (PyInstanceMethod_Check(value.ptr())) + value = PyInstanceMethod_GET_FUNCTION(value.ptr()); + else +#endif + if (PyMethod_Check(value.ptr())) + value = PyMethod_GET_FUNCTION(value.ptr()); + } + return value; +} + +// Helper aliases/functions to support implicit casting of values given to python accessors/methods. +// When given a pyobject, this simply returns the pyobject as-is; for other C++ type, the value goes +// through pybind11::cast(obj) to convert it to an `object`. +template <typename T, enable_if_t<is_pyobject<T>::value, int> = 0> +auto object_or_cast(T&& o) -> decltype(std::forward<T>(o)) +{ + return std::forward<T>(o); +} +// The following casting version is implemented in cast.h: +template <typename T, enable_if_t<!is_pyobject<T>::value, int> = 0> +object object_or_cast(T&& o); +// Match a PyObject*, which we want to convert directly to handle via its converting constructor +inline handle object_or_cast(PyObject* ptr) +{ + return ptr; +} + +template <typename Policy> +class accessor : public object_api<accessor<Policy>> +{ + using key_type = typename Policy::key_type; + +public: + accessor(handle obj, key_type key) + : obj(obj) + , key(std::move(key)) + {} + accessor(const accessor&) = default; + accessor(accessor&&) = default; + + // accessor overload required to override default assignment operator (templates are not allowed + // to replace default compiler-generated assignments). + void operator=(const accessor& a) && + { + std::move(*this).operator=(handle(a)); + } + void operator=(const accessor& a) & + { + operator=(handle(a)); + } + + template <typename T> + void operator=(T&& value) && + { + Policy::set(obj, key, object_or_cast(std::forward<T>(value))); + } + template <typename T> + void operator=(T&& value) & + { + get_cache() = reinterpret_borrow<object>(object_or_cast(std::forward<T>(value))); + } + + template <typename T = Policy> + PYBIND11_DEPRECATED("Use of obj.attr(...) as bool is deprecated in favor of pybind11::hasattr(obj, ...)") + explicit operator enable_if_t<std::is_same<T, accessor_policies::str_attr>::value + || std::is_same<T, accessor_policies::obj_attr>::value, + bool>() const + { + return hasattr(obj, key); + } + template <typename T = Policy> + PYBIND11_DEPRECATED("Use of obj[key] as bool is deprecated in favor of obj.contains(key)") + explicit operator enable_if_t<std::is_same<T, accessor_policies::generic_item>::value, bool>() const + { + return obj.contains(key); + } + + operator object() const + { + return get_cache(); + } + PyObject* ptr() const + { + return get_cache().ptr(); + } + template <typename T> + T cast() const + { + return get_cache().template cast<T>(); + } + +private: + object& get_cache() const + { + if (!cache) { + cache = Policy::get(obj, key); + } + return cache; + } + +private: + handle obj; + key_type key; + mutable object cache; +}; + +NAMESPACE_BEGIN(accessor_policies) +struct obj_attr +{ + using key_type = object; + static object get(handle obj, handle key) + { + return getattr(obj, key); + } + static void set(handle obj, handle key, handle val) + { + setattr(obj, key, val); + } +}; + +struct str_attr +{ + using key_type = const char*; + static object get(handle obj, const char* key) + { + return getattr(obj, key); + } + static void set(handle obj, const char* key, handle val) + { + setattr(obj, key, val); + } +}; + +struct generic_item +{ + using key_type = object; + + static object get(handle obj, handle key) + { + PyObject* result = PyObject_GetItem(obj.ptr(), key.ptr()); + if (!result) { + throw error_already_set(); + } + return reinterpret_steal<object>(result); + } + + static void set(handle obj, handle key, handle val) + { + if (PyObject_SetItem(obj.ptr(), key.ptr(), val.ptr()) != 0) { + throw error_already_set(); + } + } +}; + +struct sequence_item +{ + using key_type = size_t; + + static object get(handle obj, size_t index) + { + PyObject* result = PySequence_GetItem(obj.ptr(), static_cast<ssize_t>(index)); + if (!result) { + throw error_already_set(); + } + return reinterpret_steal<object>(result); + } + + static void set(handle obj, size_t index, handle val) + { + // PySequence_SetItem does not steal a reference to 'val' + if (PySequence_SetItem(obj.ptr(), static_cast<ssize_t>(index), val.ptr()) != 0) { + throw error_already_set(); + } + } +}; + +struct list_item +{ + using key_type = size_t; + + static object get(handle obj, size_t index) + { + PyObject* result = PyList_GetItem(obj.ptr(), static_cast<ssize_t>(index)); + if (!result) { + throw error_already_set(); + } + return reinterpret_borrow<object>(result); + } + + static void set(handle obj, size_t index, handle val) + { + // PyList_SetItem steals a reference to 'val' + if (PyList_SetItem(obj.ptr(), static_cast<ssize_t>(index), val.inc_ref().ptr()) != 0) { + throw error_already_set(); + } + } +}; + +struct tuple_item +{ + using key_type = size_t; + + static object get(handle obj, size_t index) + { + PyObject* result = PyTuple_GetItem(obj.ptr(), static_cast<ssize_t>(index)); + if (!result) { + throw error_already_set(); + } + return reinterpret_borrow<object>(result); + } + + static void set(handle obj, size_t index, handle val) + { + // PyTuple_SetItem steals a reference to 'val' + if (PyTuple_SetItem(obj.ptr(), static_cast<ssize_t>(index), val.inc_ref().ptr()) != 0) { + throw error_already_set(); + } + } +}; +NAMESPACE_END(accessor_policies) + +/// STL iterator template used for tuple, list, sequence and dict +template <typename Policy> +class generic_iterator : public Policy +{ + using It = generic_iterator; + +public: + using difference_type = ssize_t; + using iterator_category = typename Policy::iterator_category; + using value_type = typename Policy::value_type; + using reference = typename Policy::reference; + using pointer = typename Policy::pointer; + + generic_iterator() = default; + generic_iterator(handle seq, ssize_t index) + : Policy(seq, index) + {} + + reference operator*() const + { + return Policy::dereference(); + } + reference operator[](difference_type n) const + { + return *(*this + n); + } + pointer operator->() const + { + return **this; + } + + It& operator++() + { + Policy::increment(); + return *this; + } + It operator++(int) + { + auto copy = *this; + Policy::increment(); + return copy; + } + It& operator--() + { + Policy::decrement(); + return *this; + } + It operator--(int) + { + auto copy = *this; + Policy::decrement(); + return copy; + } + It& operator+=(difference_type n) + { + Policy::advance(n); + return *this; + } + It& operator-=(difference_type n) + { + Policy::advance(-n); + return *this; + } + + friend It operator+(const It& a, difference_type n) + { + auto copy = a; + return copy += n; + } + friend It operator+(difference_type n, const It& b) + { + return b + n; + } + friend It operator-(const It& a, difference_type n) + { + auto copy = a; + return copy -= n; + } + friend difference_type operator-(const It& a, const It& b) + { + return a.distance_to(b); + } + + friend bool operator==(const It& a, const It& b) + { + return a.equal(b); + } + friend bool operator!=(const It& a, const It& b) + { + return !(a == b); + } + friend bool operator<(const It& a, const It& b) + { + return b - a > 0; + } + friend bool operator>(const It& a, const It& b) + { + return b < a; + } + friend bool operator>=(const It& a, const It& b) + { + return !(a < b); + } + friend bool operator<=(const It& a, const It& b) + { + return !(a > b); + } +}; + +NAMESPACE_BEGIN(iterator_policies) +/// Quick proxy class needed to implement ``operator->`` for iterators which can't return pointers +template <typename T> +struct arrow_proxy +{ + T value; + + arrow_proxy(T&& value) + : value(std::move(value)) + {} + T* operator->() const + { + return &value; + } +}; + +/// Lightweight iterator policy using just a simple pointer: see ``PySequence_Fast_ITEMS`` +class sequence_fast_readonly +{ +protected: + using iterator_category = std::random_access_iterator_tag; + using value_type = handle; + using reference = const handle; + using pointer = arrow_proxy<const handle>; + + sequence_fast_readonly(handle obj, ssize_t n) + : ptr(PySequence_Fast_ITEMS(obj.ptr()) + n) + {} + + reference dereference() const + { + return *ptr; + } + void increment() + { + ++ptr; + } + void decrement() + { + --ptr; + } + void advance(ssize_t n) + { + ptr += n; + } + bool equal(const sequence_fast_readonly& b) const + { + return ptr == b.ptr; + } + ssize_t distance_to(const sequence_fast_readonly& b) const + { + return ptr - b.ptr; + } + +private: + PyObject** ptr; +}; + +/// Full read and write access using the sequence protocol: see ``detail::sequence_accessor`` +class sequence_slow_readwrite +{ +protected: + using iterator_category = std::random_access_iterator_tag; + using value_type = object; + using reference = sequence_accessor; + using pointer = arrow_proxy<const sequence_accessor>; + + sequence_slow_readwrite(handle obj, ssize_t index) + : obj(obj) + , index(index) + {} + + reference dereference() const + { + return {obj, static_cast<size_t>(index)}; + } + void increment() + { + ++index; + } + void decrement() + { + --index; + } + void advance(ssize_t n) + { + index += n; + } + bool equal(const sequence_slow_readwrite& b) const + { + return index == b.index; + } + ssize_t distance_to(const sequence_slow_readwrite& b) const + { + return index - b.index; + } + +private: + handle obj; + ssize_t index; +}; + +/// Python's dictionary protocol permits this to be a forward iterator +class dict_readonly +{ +protected: + using iterator_category = std::forward_iterator_tag; + using value_type = std::pair<handle, handle>; + using reference = const value_type; + using pointer = arrow_proxy<const value_type>; + + dict_readonly() = default; + dict_readonly(handle obj, ssize_t pos) + : obj(obj) + , pos(pos) + { + increment(); + } + + reference dereference() const + { + return {key, value}; + } + void increment() + { + if (!PyDict_Next(obj.ptr(), &pos, &key, &value)) { + pos = -1; + } + } + bool equal(const dict_readonly& b) const + { + return pos == b.pos; + } + +private: + handle obj; + PyObject *key = nullptr, *value = nullptr; + ssize_t pos = -1; +}; +NAMESPACE_END(iterator_policies) + +#if !defined(PYPY_VERSION) +using tuple_iterator = generic_iterator<iterator_policies::sequence_fast_readonly>; +using list_iterator = generic_iterator<iterator_policies::sequence_fast_readonly>; +#else +using tuple_iterator = generic_iterator<iterator_policies::sequence_slow_readwrite>; +using list_iterator = generic_iterator<iterator_policies::sequence_slow_readwrite>; +#endif + +using sequence_iterator = generic_iterator<iterator_policies::sequence_slow_readwrite>; +using dict_iterator = generic_iterator<iterator_policies::dict_readonly>; + +inline bool PyIterable_Check(PyObject* obj) +{ + PyObject* iter = PyObject_GetIter(obj); + if (iter) { + Py_DECREF(iter); + return true; + } else { + PyErr_Clear(); + return false; + } +} + +inline bool PyNone_Check(PyObject* o) +{ + return o == Py_None; +} +#if PY_MAJOR_VERSION >= 3 +inline bool PyEllipsis_Check(PyObject* o) +{ + return o == Py_Ellipsis; +} +#endif + +inline bool PyUnicode_Check_Permissive(PyObject* o) +{ + return PyUnicode_Check(o) || PYBIND11_BYTES_CHECK(o); +} + +inline bool PyStaticMethod_Check(PyObject* o) +{ + return o->ob_type == &PyStaticMethod_Type; +} + +class kwargs_proxy : public handle +{ +public: + explicit kwargs_proxy(handle h) + : handle(h) + {} +}; + +class args_proxy : public handle +{ +public: + explicit args_proxy(handle h) + : handle(h) + {} + kwargs_proxy operator*() const + { + return kwargs_proxy(*this); + } +}; + +/// Python argument categories (using PEP 448 terms) +template <typename T> +using is_keyword = std::is_base_of<arg, T>; +template <typename T> +using is_s_unpacking = std::is_same<args_proxy, T>; // * unpacking +template <typename T> +using is_ds_unpacking = std::is_same<kwargs_proxy, T>; // ** unpacking +template <typename T> +using is_positional = satisfies_none_of<T, is_keyword, is_s_unpacking, is_ds_unpacking>; +template <typename T> +using is_keyword_or_ds = satisfies_any_of<T, is_keyword, is_ds_unpacking>; + +// Call argument collector forward declarations +template <return_value_policy policy = return_value_policy::automatic_reference> +class simple_collector; +template <return_value_policy policy = return_value_policy::automatic_reference> +class unpacking_collector; + +NAMESPACE_END(detail) + +// TODO: After the deprecated constructors are removed, this macro can be simplified by +// inheriting ctors: `using Parent::Parent`. It's not an option right now because +// the `using` statement triggers the parent deprecation warning even if the ctor +// isn't even used. +#define PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) \ +public: \ + PYBIND11_DEPRECATED("Use reinterpret_borrow<" #Name ">() or reinterpret_steal<" #Name ">()") \ + Name(handle h, bool is_borrowed) \ + : Parent(is_borrowed ? Parent(h, borrowed_t{}) : Parent(h, stolen_t{})) \ + {} \ + Name(handle h, borrowed_t) \ + : Parent(h, borrowed_t{}) \ + {} \ + Name(handle h, stolen_t) \ + : Parent(h, stolen_t{}) \ + {} \ + PYBIND11_DEPRECATED("Use py::isinstance<py::python_type>(obj) instead") \ + bool check() const \ + { \ + return m_ptr != nullptr && (bool)CheckFun(m_ptr); \ + } \ + static bool check_(handle h) \ + { \ + return h.ptr() != nullptr && CheckFun(h.ptr()); \ + } + +#define PYBIND11_OBJECT_CVT(Name, Parent, CheckFun, ConvertFun) \ + PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) \ + /* This is deliberately not 'explicit' to allow implicit conversion from object: */ \ + Name(const object& o) \ + : Parent(check_(o) ? o.inc_ref().ptr() : ConvertFun(o.ptr()), stolen_t{}) \ + { \ + if (!m_ptr) \ + throw error_already_set(); \ + } \ + Name(object&& o) \ + : Parent(check_(o) ? o.release().ptr() : ConvertFun(o.ptr()), stolen_t{}) \ + { \ + if (!m_ptr) \ + throw error_already_set(); \ + } \ + template <typename Policy_> \ + Name(const ::pybind11::detail::accessor<Policy_>& a) \ + : Name(object(a)) \ + {} + +#define PYBIND11_OBJECT(Name, Parent, CheckFun) \ + PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) \ + /* This is deliberately not 'explicit' to allow implicit conversion from object: */ \ + Name(const object& o) \ + : Parent(o) \ + {} \ + Name(object&& o) \ + : Parent(std::move(o)) \ + {} + +#define PYBIND11_OBJECT_DEFAULT(Name, Parent, CheckFun) \ + PYBIND11_OBJECT(Name, Parent, CheckFun) \ + Name() \ + : Parent() \ + {} + +/// \addtogroup pytypes +/// @{ + +/** \rst + Wraps a Python iterator so that it can also be used as a C++ input iterator + + Caveat: copying an iterator does not (and cannot) clone the internal + state of the Python iterable. This also applies to the post-increment + operator. This iterator should only be used to retrieve the current + value using ``operator*()``. +\endrst */ +class iterator : public object +{ +public: + using iterator_category = std::input_iterator_tag; + using difference_type = ssize_t; + using value_type = handle; + using reference = const handle; + using pointer = const handle*; + + PYBIND11_OBJECT_DEFAULT(iterator, object, PyIter_Check) + + iterator& operator++() + { + advance(); + return *this; + } + + iterator operator++(int) + { + auto rv = *this; + advance(); + return rv; + } + + reference operator*() const + { + if (m_ptr && !value.ptr()) { + auto& self = const_cast<iterator&>(*this); + self.advance(); + } + return value; + } + + pointer operator->() const + { + operator*(); + return &value; + } + + /** \rst + The value which marks the end of the iteration. ``it == iterator::sentinel()`` + is equivalent to catching ``StopIteration`` in Python. + + .. code-block:: cpp + + void foo(py::iterator it) { + while (it != py::iterator::sentinel()) { + // use `*it` + ++it; + } + } + \endrst */ + static iterator sentinel() + { + return {}; + } + + friend bool operator==(const iterator& a, const iterator& b) + { + return a->ptr() == b->ptr(); + } + friend bool operator!=(const iterator& a, const iterator& b) + { + return a->ptr() != b->ptr(); + } + +private: + void advance() + { + value = reinterpret_steal<object>(PyIter_Next(m_ptr)); + if (PyErr_Occurred()) { + throw error_already_set(); + } + } + +private: + object value = {}; +}; + +class iterable : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(iterable, object, detail::PyIterable_Check) +}; + +class bytes; + +class str : public object +{ +public: + PYBIND11_OBJECT_CVT(str, object, detail::PyUnicode_Check_Permissive, raw_str) + + str(const char* c, size_t n) + : object(PyUnicode_FromStringAndSize(c, (ssize_t)n), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate string object!"); + } + + // 'explicit' is explicitly omitted from the following constructors to allow implicit conversion to py::str from C++ + // string-like objects + str(const char* c = "") + : object(PyUnicode_FromString(c), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate string object!"); + } + + str(const std::string& s) + : str(s.data(), s.size()) + {} + + explicit str(const bytes& b); + + /** \rst + Return a string representation of the object. This is analogous to + the ``str()`` function in Python. + \endrst */ + explicit str(handle h) + : object(raw_str(h.ptr()), stolen_t{}) + {} + + operator std::string() const + { + object temp = *this; + if (PyUnicode_Check(m_ptr)) { + temp = reinterpret_steal<object>(PyUnicode_AsUTF8String(m_ptr)); + if (!temp) + pybind11_fail("Unable to extract string contents! (encoding issue)"); + } + char* buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(temp.ptr(), &buffer, &length)) + pybind11_fail("Unable to extract string contents! (invalid type)"); + return std::string(buffer, (size_t)length); + } + + template <typename... Args> + str format(Args&&... args) const + { + return attr("format")(std::forward<Args>(args)...); + } + +private: + /// Return string representation -- always returns a new reference, even if already a str + static PyObject* raw_str(PyObject* op) + { + PyObject* str_value = PyObject_Str(op); +#if PY_MAJOR_VERSION < 3 + if (!str_value) + throw error_already_set(); + PyObject* unicode = PyUnicode_FromEncodedObject(str_value, "utf-8", nullptr); + Py_XDECREF(str_value); + str_value = unicode; +#endif + return str_value; + } +}; +/// @} pytypes + +inline namespace literals { +/** \rst + String literal version of `str` + \endrst */ +inline str operator"" _s(const char* s, size_t size) +{ + return {s, size}; +} +} // namespace literals + +/// \addtogroup pytypes +/// @{ +class bytes : public object +{ +public: + PYBIND11_OBJECT(bytes, object, PYBIND11_BYTES_CHECK) + + // Allow implicit conversion: + bytes(const char* c = "") + : object(PYBIND11_BYTES_FROM_STRING(c), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate bytes object!"); + } + + bytes(const char* c, size_t n) + : object(PYBIND11_BYTES_FROM_STRING_AND_SIZE(c, (ssize_t)n), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate bytes object!"); + } + + // Allow implicit conversion: + bytes(const std::string& s) + : bytes(s.data(), s.size()) + {} + + explicit bytes(const pybind11::str& s); + + operator std::string() const + { + char* buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(m_ptr, &buffer, &length)) + pybind11_fail("Unable to extract bytes contents!"); + return std::string(buffer, (size_t)length); + } +}; + +inline bytes::bytes(const pybind11::str& s) +{ + object temp = s; + if (PyUnicode_Check(s.ptr())) { + temp = reinterpret_steal<object>(PyUnicode_AsUTF8String(s.ptr())); + if (!temp) + pybind11_fail("Unable to extract string contents! (encoding issue)"); + } + char* buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(temp.ptr(), &buffer, &length)) + pybind11_fail("Unable to extract string contents! (invalid type)"); + auto obj = reinterpret_steal<object>(PYBIND11_BYTES_FROM_STRING_AND_SIZE(buffer, length)); + if (!obj) + pybind11_fail("Could not allocate bytes object!"); + m_ptr = obj.release().ptr(); +} + +inline str::str(const bytes& b) +{ + char* buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(b.ptr(), &buffer, &length)) + pybind11_fail("Unable to extract bytes contents!"); + auto obj = reinterpret_steal<object>(PyUnicode_FromStringAndSize(buffer, (ssize_t)length)); + if (!obj) + pybind11_fail("Could not allocate string object!"); + m_ptr = obj.release().ptr(); +} + +class none : public object +{ +public: + PYBIND11_OBJECT(none, object, detail::PyNone_Check) + none() + : object(Py_None, borrowed_t{}) + {} +}; + +#if PY_MAJOR_VERSION >= 3 +class ellipsis : public object +{ +public: + PYBIND11_OBJECT(ellipsis, object, detail::PyEllipsis_Check) + ellipsis() + : object(Py_Ellipsis, borrowed_t{}) + {} +}; +#endif + +class bool_ : public object +{ +public: + PYBIND11_OBJECT_CVT(bool_, object, PyBool_Check, raw_bool) + bool_() + : object(Py_False, borrowed_t{}) + {} + // Allow implicit conversion from and to `bool`: + bool_(bool value) + : object(value ? Py_True : Py_False, borrowed_t{}) + {} + operator bool() const + { + return m_ptr && PyLong_AsLong(m_ptr) != 0; + } + +private: + /// Return the truth value of an object -- always returns a new reference + static PyObject* raw_bool(PyObject* op) + { + const auto value = PyObject_IsTrue(op); + if (value == -1) + return nullptr; + return handle(value ? Py_True : Py_False).inc_ref().ptr(); + } +}; + +NAMESPACE_BEGIN(detail) +// Converts a value to the given unsigned type. If an error occurs, you get back (Unsigned) -1; +// otherwise you get back the unsigned long or unsigned long long value cast to (Unsigned). +// (The distinction is critically important when casting a returned -1 error value to some other +// unsigned type: (A)-1 != (B)-1 when A and B are unsigned types of different sizes). +template <typename Unsigned> +Unsigned as_unsigned(PyObject* o) +{ + if (sizeof(Unsigned) <= sizeof(unsigned long) +#if PY_VERSION_HEX < 0x03000000 + || PyInt_Check(o) +#endif + ) { + unsigned long v = PyLong_AsUnsignedLong(o); + return v == (unsigned long)-1 && PyErr_Occurred() ? (Unsigned)-1 : (Unsigned)v; + } else { + unsigned long long v = PyLong_AsUnsignedLongLong(o); + return v == (unsigned long long)-1 && PyErr_Occurred() ? (Unsigned)-1 : (Unsigned)v; + } +} +NAMESPACE_END(detail) + +class int_ : public object +{ +public: + PYBIND11_OBJECT_CVT(int_, object, PYBIND11_LONG_CHECK, PyNumber_Long) + int_() + : object(PyLong_FromLong(0), stolen_t{}) + {} + // Allow implicit conversion from C++ integral types: + template <typename T, detail::enable_if_t<std::is_integral<T>::value, int> = 0> + int_(T value) + { + if (sizeof(T) <= sizeof(long)) { + if (std::is_signed<T>::value) + m_ptr = PyLong_FromLong((long)value); + else + m_ptr = PyLong_FromUnsignedLong((unsigned long)value); + } else { + if (std::is_signed<T>::value) + m_ptr = PyLong_FromLongLong((long long)value); + else + m_ptr = PyLong_FromUnsignedLongLong((unsigned long long)value); + } + if (!m_ptr) + pybind11_fail("Could not allocate int object!"); + } + + template <typename T, detail::enable_if_t<std::is_integral<T>::value, int> = 0> + operator T() const + { + return std::is_unsigned<T>::value + ? detail::as_unsigned<T>(m_ptr) + : sizeof(T) <= sizeof(long) ? (T)PyLong_AsLong(m_ptr) : (T)PYBIND11_LONG_AS_LONGLONG(m_ptr); + } +}; + +class float_ : public object +{ +public: + PYBIND11_OBJECT_CVT(float_, object, PyFloat_Check, PyNumber_Float) + // Allow implicit conversion from float/double: + float_(float value) + : object(PyFloat_FromDouble((double)value), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate float object!"); + } + float_(double value = .0) + : object(PyFloat_FromDouble((double)value), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate float object!"); + } + operator float() const + { + return (float)PyFloat_AsDouble(m_ptr); + } + operator double() const + { + return (double)PyFloat_AsDouble(m_ptr); + } +}; + +class weakref : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(weakref, object, PyWeakref_Check) + explicit weakref(handle obj, handle callback = {}) + : object(PyWeakref_NewRef(obj.ptr(), callback.ptr()), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate weak reference!"); + } +}; + +class slice : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(slice, object, PySlice_Check) + slice(ssize_t start_, ssize_t stop_, ssize_t step_) + { + int_ start(start_), stop(stop_), step(step_); + m_ptr = PySlice_New(start.ptr(), stop.ptr(), step.ptr()); + if (!m_ptr) + pybind11_fail("Could not allocate slice object!"); + } + bool compute(size_t length, size_t* start, size_t* stop, size_t* step, size_t* slicelength) const + { + return PySlice_GetIndicesEx((PYBIND11_SLICE_OBJECT*)m_ptr, + (ssize_t)length, + (ssize_t*)start, + (ssize_t*)stop, + (ssize_t*)step, + (ssize_t*)slicelength) + == 0; + } + bool compute(ssize_t length, ssize_t* start, ssize_t* stop, ssize_t* step, ssize_t* slicelength) const + { + return PySlice_GetIndicesEx((PYBIND11_SLICE_OBJECT*)m_ptr, length, start, stop, step, slicelength) == 0; + } +}; + +class capsule : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(capsule, object, PyCapsule_CheckExact) + PYBIND11_DEPRECATED("Use reinterpret_borrow<capsule>() or reinterpret_steal<capsule>()") + capsule(PyObject* ptr, bool is_borrowed) + : object(is_borrowed ? object(ptr, borrowed_t{}) : object(ptr, stolen_t{})) + {} + + explicit capsule(const void* value, const char* name = nullptr, void (*destructor)(PyObject*) = nullptr) + : object(PyCapsule_New(const_cast<void*>(value), name, destructor), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + } + + PYBIND11_DEPRECATED("Please pass a destructor that takes a void pointer as input") + capsule(const void* value, void (*destruct)(PyObject*)) + : object(PyCapsule_New(const_cast<void*>(value), nullptr, destruct), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + } + + capsule(const void* value, void (*destructor)(void*)) + { + m_ptr = PyCapsule_New(const_cast<void*>(value), nullptr, [](PyObject* o) { + auto destructor = reinterpret_cast<void (*)(void*)>(PyCapsule_GetContext(o)); + void* ptr = PyCapsule_GetPointer(o, nullptr); + destructor(ptr); + }); + + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + + if (PyCapsule_SetContext(m_ptr, (void*)destructor) != 0) + pybind11_fail("Could not set capsule context!"); + } + + capsule(void (*destructor)()) + { + m_ptr = PyCapsule_New(reinterpret_cast<void*>(destructor), nullptr, [](PyObject* o) { + auto destructor = reinterpret_cast<void (*)()>(PyCapsule_GetPointer(o, nullptr)); + destructor(); + }); + + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + } + + template <typename T> + operator T*() const + { + auto name = this->name(); + T* result = static_cast<T*>(PyCapsule_GetPointer(m_ptr, name)); + if (!result) + pybind11_fail("Unable to extract capsule contents!"); + return result; + } + + const char* name() const + { + return PyCapsule_GetName(m_ptr); + } +}; + +class tuple : public object +{ +public: + PYBIND11_OBJECT_CVT(tuple, object, PyTuple_Check, PySequence_Tuple) + explicit tuple(size_t size = 0) + : object(PyTuple_New((ssize_t)size), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate tuple object!"); + } + size_t size() const + { + return (size_t)PyTuple_Size(m_ptr); + } + detail::tuple_accessor operator[](size_t index) const + { + return {*this, index}; + } + detail::item_accessor operator[](handle h) const + { + return object::operator[](h); + } + detail::tuple_iterator begin() const + { + return {*this, 0}; + } + detail::tuple_iterator end() const + { + return {*this, PyTuple_GET_SIZE(m_ptr)}; + } +}; + +class dict : public object +{ +public: + PYBIND11_OBJECT_CVT(dict, object, PyDict_Check, raw_dict) + dict() + : object(PyDict_New(), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate dict object!"); + } + template <typename... Args, + typename = detail::enable_if_t<detail::all_of<detail::is_keyword_or_ds<Args>...>::value>, + // MSVC workaround: it can't compile an out-of-line definition, so defer the collector + typename collector = detail::deferred_t<detail::unpacking_collector<>, Args...>> + explicit dict(Args&&... args) + : dict(collector(std::forward<Args>(args)...).kwargs()) + {} + + size_t size() const + { + return (size_t)PyDict_Size(m_ptr); + } + detail::dict_iterator begin() const + { + return {*this, 0}; + } + detail::dict_iterator end() const + { + return {}; + } + void clear() const + { + PyDict_Clear(ptr()); + } + bool contains(handle key) const + { + return PyDict_Contains(ptr(), key.ptr()) == 1; + } + bool contains(const char* key) const + { + return PyDict_Contains(ptr(), pybind11::str(key).ptr()) == 1; + } + +private: + /// Call the `dict` Python type -- always returns a new reference + static PyObject* raw_dict(PyObject* op) + { + if (PyDict_Check(op)) + return handle(op).inc_ref().ptr(); + return PyObject_CallFunctionObjArgs((PyObject*)&PyDict_Type, op, nullptr); + } +}; + +class sequence : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(sequence, object, PySequence_Check) + size_t size() const + { + return (size_t)PySequence_Size(m_ptr); + } + detail::sequence_accessor operator[](size_t index) const + { + return {*this, index}; + } + detail::item_accessor operator[](handle h) const + { + return object::operator[](h); + } + detail::sequence_iterator begin() const + { + return {*this, 0}; + } + detail::sequence_iterator end() const + { + return {*this, PySequence_Size(m_ptr)}; + } +}; + +class list : public object +{ +public: + PYBIND11_OBJECT_CVT(list, object, PyList_Check, PySequence_List) + explicit list(size_t size = 0) + : object(PyList_New((ssize_t)size), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate list object!"); + } + size_t size() const + { + return (size_t)PyList_Size(m_ptr); + } + detail::list_accessor operator[](size_t index) const + { + return {*this, index}; + } + detail::item_accessor operator[](handle h) const + { + return object::operator[](h); + } + detail::list_iterator begin() const + { + return {*this, 0}; + } + detail::list_iterator end() const + { + return {*this, PyList_GET_SIZE(m_ptr)}; + } + template <typename T> + void append(T&& val) const + { + PyList_Append(m_ptr, detail::object_or_cast(std::forward<T>(val)).ptr()); + } +}; + +class args : public tuple +{ + PYBIND11_OBJECT_DEFAULT(args, tuple, PyTuple_Check) +}; +class kwargs : public dict +{ + PYBIND11_OBJECT_DEFAULT(kwargs, dict, PyDict_Check) +}; + +class set : public object +{ +public: + PYBIND11_OBJECT_CVT(set, object, PySet_Check, PySet_New) + set() + : object(PySet_New(nullptr), stolen_t{}) + { + if (!m_ptr) + pybind11_fail("Could not allocate set object!"); + } + size_t size() const + { + return (size_t)PySet_Size(m_ptr); + } + template <typename T> + bool add(T&& val) const + { + return PySet_Add(m_ptr, detail::object_or_cast(std::forward<T>(val)).ptr()) == 0; + } + void clear() const + { + PySet_Clear(m_ptr); + } +}; + +class function : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(function, object, PyCallable_Check) + handle cpp_function() const + { + handle fun = detail::get_function(m_ptr); + if (fun && PyCFunction_Check(fun.ptr())) + return fun; + return handle(); + } + bool is_cpp_function() const + { + return (bool)cpp_function(); + } +}; + +class staticmethod : public object +{ +public: + PYBIND11_OBJECT_CVT(staticmethod, object, detail::PyStaticMethod_Check, PyStaticMethod_New) +}; + +class buffer : public object +{ +public: + PYBIND11_OBJECT_DEFAULT(buffer, object, PyObject_CheckBuffer) + + buffer_info request(bool writable = false) + { + int flags = PyBUF_STRIDES | PyBUF_FORMAT; + if (writable) + flags |= PyBUF_WRITABLE; + Py_buffer* view = new Py_buffer(); + if (PyObject_GetBuffer(m_ptr, view, flags) != 0) { + delete view; + throw error_already_set(); + } + return buffer_info(view); + } +}; + +class memoryview : public object +{ +public: + explicit memoryview(const buffer_info& info) + { + static Py_buffer buf{}; + // Py_buffer uses signed sizes, strides and shape!.. + static std::vector<Py_ssize_t> py_strides{}; + static std::vector<Py_ssize_t> py_shape{}; + buf.buf = info.ptr; + buf.itemsize = info.itemsize; + buf.format = const_cast<char*>(info.format.c_str()); + buf.ndim = (int)info.ndim; + buf.len = info.size; + py_strides.clear(); + py_shape.clear(); + for (size_t i = 0; i < (size_t)info.ndim; ++i) { + py_strides.push_back(info.strides[i]); + py_shape.push_back(info.shape[i]); + } + buf.strides = py_strides.data(); + buf.shape = py_shape.data(); + buf.suboffsets = nullptr; + buf.readonly = false; + buf.internal = nullptr; + + m_ptr = PyMemoryView_FromBuffer(&buf); + if (!m_ptr) + pybind11_fail("Unable to create memoryview from buffer descriptor"); + } + + PYBIND11_OBJECT_CVT(memoryview, object, PyMemoryView_Check, PyMemoryView_FromObject) +}; +/// @} pytypes + +/// \addtogroup python_builtins +/// @{ +inline size_t len(handle h) +{ + ssize_t result = PyObject_Length(h.ptr()); + if (result < 0) + pybind11_fail("Unable to compute length of object"); + return (size_t)result; +} + +inline size_t len_hint(handle h) +{ +#if PY_VERSION_HEX >= 0x03040000 + ssize_t result = PyObject_LengthHint(h.ptr(), 0); +#else + ssize_t result = PyObject_Length(h.ptr()); +#endif + if (result < 0) { + // Sometimes a length can't be determined at all (eg generators) + // In which case simply return 0 + PyErr_Clear(); + return 0; + } + return (size_t)result; +} + +inline str repr(handle h) +{ + PyObject* str_value = PyObject_Repr(h.ptr()); + if (!str_value) + throw error_already_set(); +#if PY_MAJOR_VERSION < 3 + PyObject* unicode = PyUnicode_FromEncodedObject(str_value, "utf-8", nullptr); + Py_XDECREF(str_value); + str_value = unicode; + if (!str_value) + throw error_already_set(); +#endif + return reinterpret_steal<str>(str_value); +} + +inline iterator iter(handle obj) +{ + PyObject* result = PyObject_GetIter(obj.ptr()); + if (!result) { + throw error_already_set(); + } + return reinterpret_steal<iterator>(result); +} +/// @} python_builtins + +NAMESPACE_BEGIN(detail) +template <typename D> +iterator object_api<D>::begin() const +{ + return iter(derived()); +} +template <typename D> +iterator object_api<D>::end() const +{ + return iterator::sentinel(); +} +template <typename D> +item_accessor object_api<D>::operator[](handle key) const +{ + return {derived(), reinterpret_borrow<object>(key)}; +} +template <typename D> +item_accessor object_api<D>::operator[](const char* key) const +{ + return {derived(), pybind11::str(key)}; +} +template <typename D> +obj_attr_accessor object_api<D>::attr(handle key) const +{ + return {derived(), reinterpret_borrow<object>(key)}; +} +template <typename D> +str_attr_accessor object_api<D>::attr(const char* key) const +{ + return {derived(), key}; +} +template <typename D> +args_proxy object_api<D>::operator*() const +{ + return args_proxy(derived().ptr()); +} +template <typename D> +template <typename T> +bool object_api<D>::contains(T&& item) const +{ + return attr("__contains__")(std::forward<T>(item)).template cast<bool>(); +} + +template <typename D> +pybind11::str object_api<D>::str() const +{ + return pybind11::str(derived()); +} + +template <typename D> +str_attr_accessor object_api<D>::doc() const +{ + return attr("__doc__"); +} + +template <typename D> +handle object_api<D>::get_type() const +{ + return (PyObject*)Py_TYPE(derived().ptr()); +} + +template <typename D> +bool object_api<D>::rich_compare(object_api const& other, int value) const +{ + int rv = PyObject_RichCompareBool(derived().ptr(), other.derived().ptr(), value); + if (rv == -1) + throw error_already_set(); + return rv == 1; +} + +#define PYBIND11_MATH_OPERATOR_UNARY(op, fn) \ + template <typename D> \ + object object_api<D>::op() const \ + { \ + object result = reinterpret_steal<object>(fn(derived().ptr())); \ + if (!result.ptr()) \ + throw error_already_set(); \ + return result; \ + } + +#define PYBIND11_MATH_OPERATOR_BINARY(op, fn) \ + template <typename D> \ + object object_api<D>::op(object_api const& other) const \ + { \ + object result = reinterpret_steal<object>(fn(derived().ptr(), other.derived().ptr())); \ + if (!result.ptr()) \ + throw error_already_set(); \ + return result; \ + } + +PYBIND11_MATH_OPERATOR_UNARY(operator~, PyNumber_Invert) +PYBIND11_MATH_OPERATOR_UNARY(operator-, PyNumber_Negative) +PYBIND11_MATH_OPERATOR_BINARY(operator+, PyNumber_Add) +PYBIND11_MATH_OPERATOR_BINARY(operator+=, PyNumber_InPlaceAdd) +PYBIND11_MATH_OPERATOR_BINARY(operator-, PyNumber_Subtract) +PYBIND11_MATH_OPERATOR_BINARY(operator-=, PyNumber_InPlaceSubtract) +PYBIND11_MATH_OPERATOR_BINARY(operator*, PyNumber_Multiply) +PYBIND11_MATH_OPERATOR_BINARY(operator*=, PyNumber_InPlaceMultiply) +PYBIND11_MATH_OPERATOR_BINARY(operator/, PyNumber_TrueDivide) +PYBIND11_MATH_OPERATOR_BINARY(operator/=, PyNumber_InPlaceTrueDivide) +PYBIND11_MATH_OPERATOR_BINARY(operator|, PyNumber_Or) +PYBIND11_MATH_OPERATOR_BINARY(operator|=, PyNumber_InPlaceOr) +PYBIND11_MATH_OPERATOR_BINARY(operator&, PyNumber_And) +PYBIND11_MATH_OPERATOR_BINARY(operator&=, PyNumber_InPlaceAnd) +PYBIND11_MATH_OPERATOR_BINARY(operator^, PyNumber_Xor) +PYBIND11_MATH_OPERATOR_BINARY(operator^=, PyNumber_InPlaceXor) +PYBIND11_MATH_OPERATOR_BINARY(operator<<, PyNumber_Lshift) +PYBIND11_MATH_OPERATOR_BINARY(operator<<=, PyNumber_InPlaceLshift) +PYBIND11_MATH_OPERATOR_BINARY(operator>>, PyNumber_Rshift) +PYBIND11_MATH_OPERATOR_BINARY(operator>>=, PyNumber_InPlaceRshift) + +#undef PYBIND11_MATH_OPERATOR_UNARY +#undef PYBIND11_MATH_OPERATOR_BINARY + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/include/pybind11/stl.h b/pybind11/include/pybind11/stl.h new file mode 100644 index 0000000000000000000000000000000000000000..a11e756447b91c6dadfd3e7e5e04fda5ee4a1ea9 --- /dev/null +++ b/pybind11/include/pybind11/stl.h @@ -0,0 +1,439 @@ +/* + pybind11/stl.h: Transparent conversion for STL data types + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include <set> +#include <unordered_set> +#include <map> +#include <unordered_map> +#include <iostream> +#include <list> +#include <deque> +#include <valarray> + +#if defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable : 4127) // warning C4127: Conditional expression is constant +#endif + +#ifdef __has_include +// std::optional (but including it in c++14 mode isn't allowed) +# if defined(PYBIND11_CPP17) && __has_include(<optional>) +# include <optional> +# define PYBIND11_HAS_OPTIONAL 1 +# endif +// std::experimental::optional (but not allowed in c++11 mode) +# if defined(PYBIND11_CPP14) && (__has_include(<experimental/optional>) && \ + !__has_include(<optional>)) +# include <experimental/optional> +# define PYBIND11_HAS_EXP_OPTIONAL 1 +# endif +// std::variant +# if defined(PYBIND11_CPP17) && __has_include(<variant>) +# include <variant> +# define PYBIND11_HAS_VARIANT 1 +# endif +#elif defined(_MSC_VER) && defined(PYBIND11_CPP17) +# include <optional> +# include <variant> +# define PYBIND11_HAS_OPTIONAL 1 +# define PYBIND11_HAS_VARIANT 1 +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// Extracts an const lvalue reference or rvalue reference for U based on the type of T (e.g. for +/// forwarding a container element). Typically used indirect via forwarded_type(), below. +template <typename T, typename U> +using forwarded_type = + conditional_t<std::is_lvalue_reference<T>::value, remove_reference_t<U>&, remove_reference_t<U>&&>; + +/// Forwards a value U as rvalue or lvalue according to whether T is rvalue or lvalue; typically +/// used for forwarding a container's elements. +template <typename T, typename U> +forwarded_type<T, U> forward_like(U&& u) +{ + return std::forward<detail::forwarded_type<T, U>>(std::forward<U>(u)); +} + +template <typename Type, typename Key> +struct set_caster +{ + using type = Type; + using key_conv = make_caster<Key>; + + bool load(handle src, bool convert) + { + if (!isinstance<pybind11::set>(src)) + return false; + auto s = reinterpret_borrow<pybind11::set>(src); + value.clear(); + for (auto entry : s) { + key_conv conv; + if (!conv.load(entry, convert)) + return false; + value.insert(cast_op<Key&&>(std::move(conv))); + } + return true; + } + + template <typename T> + static handle cast(T&& src, return_value_policy policy, handle parent) + { + if (!std::is_lvalue_reference<T>::value) + policy = return_value_policy_override<Key>::policy(policy); + pybind11::set s; + for (auto&& value : src) { + auto value_ = reinterpret_steal<object>(key_conv::cast(forward_like<T>(value), policy, parent)); + if (!value_ || !s.add(value_)) + return handle(); + } + return s.release(); + } + + PYBIND11_TYPE_CASTER(type, _("Set[") + key_conv::name + _("]")); +}; + +template <typename Type, typename Key, typename Value> +struct map_caster +{ + using key_conv = make_caster<Key>; + using value_conv = make_caster<Value>; + + bool load(handle src, bool convert) + { + if (!isinstance<dict>(src)) + return false; + auto d = reinterpret_borrow<dict>(src); + value.clear(); + for (auto it : d) { + key_conv kconv; + value_conv vconv; + if (!kconv.load(it.first.ptr(), convert) || !vconv.load(it.second.ptr(), convert)) + return false; + value.emplace(cast_op<Key&&>(std::move(kconv)), cast_op<Value&&>(std::move(vconv))); + } + return true; + } + + template <typename T> + static handle cast(T&& src, return_value_policy policy, handle parent) + { + dict d; + return_value_policy policy_key = policy; + return_value_policy policy_value = policy; + if (!std::is_lvalue_reference<T>::value) { + policy_key = return_value_policy_override<Key>::policy(policy_key); + policy_value = return_value_policy_override<Value>::policy(policy_value); + } + for (auto&& kv : src) { + auto key = reinterpret_steal<object>(key_conv::cast(forward_like<T>(kv.first), policy_key, parent)); + auto value = reinterpret_steal<object>(value_conv::cast(forward_like<T>(kv.second), policy_value, parent)); + if (!key || !value) + return handle(); + d[key] = value; + } + return d.release(); + } + + PYBIND11_TYPE_CASTER(Type, _("Dict[") + key_conv::name + _(", ") + value_conv::name + _("]")); +}; + +template <typename Type, typename Value> +struct list_caster +{ + using value_conv = make_caster<Value>; + + bool load(handle src, bool convert) + { + if (!isinstance<sequence>(src) || isinstance<str>(src)) + return false; + auto s = reinterpret_borrow<sequence>(src); + value.clear(); + reserve_maybe(s, &value); + for (auto it : s) { + value_conv conv; + if (!conv.load(it, convert)) + return false; + value.push_back(cast_op<Value&&>(std::move(conv))); + } + return true; + } + +private: + template <typename T = Type, enable_if_t<std::is_same<decltype(std::declval<T>().reserve(0)), void>::value, int> = 0> + void reserve_maybe(sequence s, Type*) + { + value.reserve(s.size()); + } + void reserve_maybe(sequence, void*) {} + +public: + template <typename T> + static handle cast(T&& src, return_value_policy policy, handle parent) + { + if (!std::is_lvalue_reference<T>::value) + policy = return_value_policy_override<Value>::policy(policy); + list l(src.size()); + size_t index = 0; + for (auto&& value : src) { + auto value_ = reinterpret_steal<object>(value_conv::cast(forward_like<T>(value), policy, parent)); + if (!value_) + return handle(); + PyList_SET_ITEM(l.ptr(), (ssize_t)index++, value_.release().ptr()); // steals a reference + } + return l.release(); + } + + PYBIND11_TYPE_CASTER(Type, _("List[") + value_conv::name + _("]")); +}; + +template <typename Type, typename Alloc> +struct type_caster<std::vector<Type, Alloc>> : list_caster<std::vector<Type, Alloc>, Type> +{}; + +template <typename Type, typename Alloc> +struct type_caster<std::deque<Type, Alloc>> : list_caster<std::deque<Type, Alloc>, Type> +{}; + +template <typename Type, typename Alloc> +struct type_caster<std::list<Type, Alloc>> : list_caster<std::list<Type, Alloc>, Type> +{}; + +template <typename ArrayType, typename Value, bool Resizable, size_t Size = 0> +struct array_caster +{ + using value_conv = make_caster<Value>; + +private: + template <bool R = Resizable> + bool require_size(enable_if_t<R, size_t> size) + { + if (value.size() != size) + value.resize(size); + return true; + } + template <bool R = Resizable> + bool require_size(enable_if_t<!R, size_t> size) + { + return size == Size; + } + +public: + bool load(handle src, bool convert) + { + if (!isinstance<sequence>(src)) + return false; + auto l = reinterpret_borrow<sequence>(src); + if (!require_size(l.size())) + return false; + size_t ctr = 0; + for (auto it : l) { + value_conv conv; + if (!conv.load(it, convert)) + return false; + value[ctr++] = cast_op<Value&&>(std::move(conv)); + } + return true; + } + + template <typename T> + static handle cast(T&& src, return_value_policy policy, handle parent) + { + list l(src.size()); + size_t index = 0; + for (auto&& value : src) { + auto value_ = reinterpret_steal<object>(value_conv::cast(forward_like<T>(value), policy, parent)); + if (!value_) + return handle(); + PyList_SET_ITEM(l.ptr(), (ssize_t)index++, value_.release().ptr()); // steals a reference + } + return l.release(); + } + + PYBIND11_TYPE_CASTER(ArrayType, + _("List[") + value_conv::name + _<Resizable>(_(""), _("[") + _<Size>() + _("]")) + _("]")); +}; + +template <typename Type, size_t Size> +struct type_caster<std::array<Type, Size>> : array_caster<std::array<Type, Size>, Type, false, Size> +{}; + +template <typename Type> +struct type_caster<std::valarray<Type>> : array_caster<std::valarray<Type>, Type, true> +{}; + +template <typename Key, typename Compare, typename Alloc> +struct type_caster<std::set<Key, Compare, Alloc>> : set_caster<std::set<Key, Compare, Alloc>, Key> +{}; + +template <typename Key, typename Hash, typename Equal, typename Alloc> +struct type_caster<std::unordered_set<Key, Hash, Equal, Alloc>> + : set_caster<std::unordered_set<Key, Hash, Equal, Alloc>, Key> +{}; + +template <typename Key, typename Value, typename Compare, typename Alloc> +struct type_caster<std::map<Key, Value, Compare, Alloc>> : map_caster<std::map<Key, Value, Compare, Alloc>, Key, Value> +{}; + +template <typename Key, typename Value, typename Hash, typename Equal, typename Alloc> +struct type_caster<std::unordered_map<Key, Value, Hash, Equal, Alloc>> + : map_caster<std::unordered_map<Key, Value, Hash, Equal, Alloc>, Key, Value> +{}; + +// This type caster is intended to be used for std::optional and std::experimental::optional +template <typename T> +struct optional_caster +{ + using value_conv = make_caster<typename T::value_type>; + + template <typename T_> + static handle cast(T_&& src, return_value_policy policy, handle parent) + { + if (!src) + return none().inc_ref(); + policy = return_value_policy_override<typename T::value_type>::policy(policy); + return value_conv::cast(*std::forward<T_>(src), policy, parent); + } + + bool load(handle src, bool convert) + { + if (!src) { + return false; + } else if (src.is_none()) { + return true; // default-constructed value is already empty + } + value_conv inner_caster; + if (!inner_caster.load(src, convert)) + return false; + + value.emplace(cast_op<typename T::value_type&&>(std::move(inner_caster))); + return true; + } + + PYBIND11_TYPE_CASTER(T, _("Optional[") + value_conv::name + _("]")); +}; + +#if PYBIND11_HAS_OPTIONAL +template <typename T> +struct type_caster<std::optional<T>> : public optional_caster<std::optional<T>> +{}; + +template <> +struct type_caster<std::nullopt_t> : public void_caster<std::nullopt_t> +{}; +#endif + +#if PYBIND11_HAS_EXP_OPTIONAL +template <typename T> +struct type_caster<std::experimental::optional<T>> : public optional_caster<std::experimental::optional<T>> +{}; + +template <> +struct type_caster<std::experimental::nullopt_t> : public void_caster<std::experimental::nullopt_t> +{}; +#endif + +/// Visit a variant and cast any found type to Python +struct variant_caster_visitor +{ + return_value_policy policy; + handle parent; + + using result_type = handle; // required by boost::variant in C++11 + + template <typename T> + result_type operator()(T&& src) const + { + return make_caster<T>::cast(std::forward<T>(src), policy, parent); + } +}; + +/// Helper class which abstracts away variant's `visit` function. `std::variant` and similar +/// `namespace::variant` types which provide a `namespace::visit()` function are handled here +/// automatically using argument-dependent lookup. Users can provide specializations for other +/// variant-like classes, e.g. `boost::variant` and `boost::apply_visitor`. +template <template <typename...> class Variant> +struct visit_helper +{ + template <typename... Args> + static auto call(Args&&... args) -> decltype(visit(std::forward<Args>(args)...)) + { + return visit(std::forward<Args>(args)...); + } +}; + +/// Generic variant caster +template <typename Variant> +struct variant_caster; + +template <template <typename...> class V, typename... Ts> +struct variant_caster<V<Ts...>> +{ + static_assert(sizeof...(Ts) > 0, "Variant must consist of at least one alternative."); + + template <typename U, typename... Us> + bool load_alternative(handle src, bool convert, type_list<U, Us...>) + { + auto caster = make_caster<U>(); + if (caster.load(src, convert)) { + value = cast_op<U>(caster); + return true; + } + return load_alternative(src, convert, type_list<Us...>{}); + } + + bool load_alternative(handle, bool, type_list<>) + { + return false; + } + + bool load(handle src, bool convert) + { + // Do a first pass without conversions to improve constructor resolution. + // E.g. `py::int_(1).cast<variant<double, int>>()` needs to fill the `int` + // slot of the variant. Without two-pass loading `double` would be filled + // because it appears first and a conversion is possible. + if (convert && load_alternative(src, false, type_list<Ts...>{})) + return true; + return load_alternative(src, convert, type_list<Ts...>{}); + } + + template <typename Variant> + static handle cast(Variant&& src, return_value_policy policy, handle parent) + { + return visit_helper<V>::call(variant_caster_visitor{policy, parent}, std::forward<Variant>(src)); + } + + using Type = V<Ts...>; + PYBIND11_TYPE_CASTER(Type, _("Union[") + detail::concat(make_caster<Ts>::name...) + _("]")); +}; + +#if PYBIND11_HAS_VARIANT +template <typename... Ts> +struct type_caster<std::variant<Ts...>> : variant_caster<std::variant<Ts...>> +{}; +#endif + +NAMESPACE_END(detail) + +inline std::ostream& operator<<(std::ostream& os, const handle& obj) +{ + os << (std::string)str(obj); + return os; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) +# pragma warning(pop) +#endif diff --git a/pybind11/include/pybind11/stl_bind.h b/pybind11/include/pybind11/stl_bind.h new file mode 100644 index 0000000000000000000000000000000000000000..5c2e5c765f2338c4fbef54388d8346449b216205 --- /dev/null +++ b/pybind11/include/pybind11/stl_bind.h @@ -0,0 +1,629 @@ +/* + pybind11/std_bind.h: Binding generators for STL data types + + Copyright (c) 2016 Sergey Lyskov and Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" +#include "operators.h" + +#include <algorithm> +#include <sstream> + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/* SFINAE helper class used by 'is_comparable */ +template <typename T> +struct container_traits +{ + template <typename T2> + static std::true_type test_comparable(decltype(std::declval<const T2&>() == std::declval<const T2&>())*); + template <typename T2> + static std::false_type test_comparable(...); + template <typename T2> + static std::true_type test_value(typename T2::value_type*); + template <typename T2> + static std::false_type test_value(...); + template <typename T2> + static std::true_type test_pair(typename T2::first_type*, typename T2::second_type*); + template <typename T2> + static std::false_type test_pair(...); + + static constexpr const bool is_comparable = + std::is_same<std::true_type, decltype(test_comparable<T>(nullptr))>::value; + static constexpr const bool is_pair = std::is_same<std::true_type, decltype(test_pair<T>(nullptr, nullptr))>::value; + static constexpr const bool is_vector = std::is_same<std::true_type, decltype(test_value<T>(nullptr))>::value; + static constexpr const bool is_element = !is_pair && !is_vector; +}; + +/* Default: is_comparable -> std::false_type */ +template <typename T, typename SFINAE = void> +struct is_comparable : std::false_type +{}; + +/* For non-map data structures, check whether operator== can be instantiated */ +template <typename T> +struct is_comparable<T, enable_if_t<container_traits<T>::is_element && container_traits<T>::is_comparable>> + : std::true_type +{}; + +/* For a vector/map data structure, recursively check the value type (which is std::pair for maps) */ +template <typename T> +struct is_comparable<T, enable_if_t<container_traits<T>::is_vector>> +{ + static constexpr const bool value = is_comparable<typename T::value_type>::value; +}; + +/* For pairs, recursively check the two data types */ +template <typename T> +struct is_comparable<T, enable_if_t<container_traits<T>::is_pair>> +{ + static constexpr const bool value = + is_comparable<typename T::first_type>::value && is_comparable<typename T::second_type>::value; +}; + +/* Fallback functions */ +template <typename, typename, typename... Args> +void vector_if_copy_constructible(const Args&...) +{} +template <typename, typename, typename... Args> +void vector_if_equal_operator(const Args&...) +{} +template <typename, typename, typename... Args> +void vector_if_insertion_operator(const Args&...) +{} +template <typename, typename, typename... Args> +void vector_modifiers(const Args&...) +{} + +template <typename Vector, typename Class_> +void vector_if_copy_constructible(enable_if_t<is_copy_constructible<Vector>::value, Class_>& cl) +{ + cl.def(init<const Vector&>(), "Copy constructor"); +} + +template <typename Vector, typename Class_> +void vector_if_equal_operator(enable_if_t<is_comparable<Vector>::value, Class_>& cl) +{ + using T = typename Vector::value_type; + + cl.def(self == self); + cl.def(self != self); + + cl.def("count", + [](const Vector& v, const T& x) { return std::count(v.begin(), v.end(), x); }, + arg("x"), + "Return the number of times ``x`` appears in the list"); + + cl.def("remove", + [](Vector& v, const T& x) { + auto p = std::find(v.begin(), v.end(), x); + if (p != v.end()) + v.erase(p); + else + throw value_error(); + }, + arg("x"), + "Remove the first item from the list whose value is x. " + "It is an error if there is no such item."); + + cl.def("__contains__", + [](const Vector& v, const T& x) { return std::find(v.begin(), v.end(), x) != v.end(); }, + arg("x"), + "Return true the container contains ``x``"); +} + +// Vector modifiers -- requires a copyable vector_type: +// (Technically, some of these (pop and __delitem__) don't actually require copyability, but it seems +// silly to allow deletion but not insertion, so include them here too.) +template <typename Vector, typename Class_> +void vector_modifiers(enable_if_t<is_copy_constructible<typename Vector::value_type>::value, Class_>& cl) +{ + using T = typename Vector::value_type; + using SizeType = typename Vector::size_type; + using DiffType = typename Vector::difference_type; + + cl.def( + "append", [](Vector& v, const T& value) { v.push_back(value); }, arg("x"), "Add an item to the end of the list"); + + cl.def(init([](iterable it) { + auto v = std::unique_ptr<Vector>(new Vector()); + v->reserve(len_hint(it)); + for (handle h : it) + v->push_back(h.cast<T>()); + return v.release(); + })); + + cl.def("extend", + [](Vector& v, const Vector& src) { v.insert(v.end(), src.begin(), src.end()); }, + arg("L"), + "Extend the list by appending all the items in the given list"); + + cl.def("extend", + [](Vector& v, iterable it) { + const size_t old_size = v.size(); + v.reserve(old_size + len_hint(it)); + try { + for (handle h : it) { + v.push_back(h.cast<T>()); + } + } catch (const cast_error&) { + v.erase(v.begin() + static_cast<typename Vector::difference_type>(old_size), v.end()); + try { + v.shrink_to_fit(); + } catch (const std::exception&) { + // Do nothing + } + throw; + } + }, + arg("L"), + "Extend the list by appending all the items in the given list"); + + cl.def("insert", + [](Vector& v, SizeType i, const T& x) { + if (i > v.size()) + throw index_error(); + v.insert(v.begin() + (DiffType)i, x); + }, + arg("i"), + arg("x"), + "Insert an item at a given position."); + + cl.def("pop", + [](Vector& v) { + if (v.empty()) + throw index_error(); + T t = v.back(); + v.pop_back(); + return t; + }, + "Remove and return the last item"); + + cl.def("pop", + [](Vector& v, SizeType i) { + if (i >= v.size()) + throw index_error(); + T t = v[i]; + v.erase(v.begin() + (DiffType)i); + return t; + }, + arg("i"), + "Remove and return the item at index ``i``"); + + cl.def("__setitem__", [](Vector& v, SizeType i, const T& t) { + if (i >= v.size()) + throw index_error(); + v[i] = t; + }); + + /// Slicing protocol + cl.def("__getitem__", + [](const Vector& v, slice slice) -> Vector* { + size_t start, stop, step, slicelength; + + if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) + throw error_already_set(); + + Vector* seq = new Vector(); + seq->reserve((size_t)slicelength); + + for (size_t i = 0; i < slicelength; ++i) { + seq->push_back(v[start]); + start += step; + } + return seq; + }, + arg("s"), + "Retrieve list elements using a slice object"); + + cl.def("__setitem__", + [](Vector& v, slice slice, const Vector& value) { + size_t start, stop, step, slicelength; + if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) + throw error_already_set(); + + if (slicelength != value.size()) + throw std::runtime_error("Left and right hand size of slice assignment have different sizes!"); + + for (size_t i = 0; i < slicelength; ++i) { + v[start] = value[i]; + start += step; + } + }, + "Assign list elements using a slice object"); + + cl.def("__delitem__", + [](Vector& v, SizeType i) { + if (i >= v.size()) + throw index_error(); + v.erase(v.begin() + DiffType(i)); + }, + "Delete the list elements at index ``i``"); + + cl.def("__delitem__", + [](Vector& v, slice slice) { + size_t start, stop, step, slicelength; + + if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) + throw error_already_set(); + + if (step == 1 && false) { + v.erase(v.begin() + (DiffType)start, v.begin() + DiffType(start + slicelength)); + } else { + for (size_t i = 0; i < slicelength; ++i) { + v.erase(v.begin() + DiffType(start)); + start += step - 1; + } + } + }, + "Delete list elements using a slice object"); +} + +// If the type has an operator[] that doesn't return a reference (most notably std::vector<bool>), +// we have to access by copying; otherwise we return by reference. +template <typename Vector> +using vector_needs_copy = negation< + std::is_same<decltype(std::declval<Vector>()[typename Vector::size_type()]), typename Vector::value_type&>>; + +// The usual case: access and iterate by reference +template <typename Vector, typename Class_> +void vector_accessor(enable_if_t<!vector_needs_copy<Vector>::value, Class_>& cl) +{ + using T = typename Vector::value_type; + using SizeType = typename Vector::size_type; + using ItType = typename Vector::iterator; + + cl.def("__getitem__", + [](Vector& v, SizeType i) -> T& { + if (i >= v.size()) + throw index_error(); + return v[i]; + }, + return_value_policy::reference_internal // ref + keepalive + ); + + cl.def("__iter__", + [](Vector& v) { + return make_iterator<return_value_policy::reference_internal, ItType, ItType, T&>(v.begin(), v.end()); + }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); +} + +// The case for special objects, like std::vector<bool>, that have to be returned-by-copy: +template <typename Vector, typename Class_> +void vector_accessor(enable_if_t<vector_needs_copy<Vector>::value, Class_>& cl) +{ + using T = typename Vector::value_type; + using SizeType = typename Vector::size_type; + using ItType = typename Vector::iterator; + cl.def("__getitem__", [](const Vector& v, SizeType i) -> T { + if (i >= v.size()) + throw index_error(); + return v[i]; + }); + + cl.def("__iter__", + [](Vector& v) { return make_iterator<return_value_policy::copy, ItType, ItType, T>(v.begin(), v.end()); }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); +} + +template <typename Vector, typename Class_> +auto vector_if_insertion_operator(Class_& cl, std::string const& name) + -> decltype(std::declval<std::ostream&>() << std::declval<typename Vector::value_type>(), void()) +{ + using size_type = typename Vector::size_type; + + cl.def("__repr__", + [name](Vector& v) { + std::ostringstream s; + s << name << '['; + for (size_type i = 0; i < v.size(); ++i) { + s << v[i]; + if (i != v.size() - 1) + s << ", "; + } + s << ']'; + return s.str(); + }, + "Return the canonical string representation of this list."); +} + +// Provide the buffer interface for vectors if we have data() and we have a format for it +// GCC seems to have "void std::vector<bool>::data()" - doing SFINAE on the existence of data() is insufficient, we need +// to check it returns an appropriate pointer +template <typename Vector, typename = void> +struct vector_has_data_and_format : std::false_type +{}; +template <typename Vector> +struct vector_has_data_and_format< + Vector, + enable_if_t< + std::is_same<decltype(format_descriptor<typename Vector::value_type>::format(), std::declval<Vector>().data()), + typename Vector::value_type*>::value>> : std::true_type +{}; + +// Add the buffer interface to a vector +template <typename Vector, typename Class_, typename... Args> +enable_if_t<detail::any_of<std::is_same<Args, buffer_protocol>...>::value> vector_buffer(Class_& cl) +{ + using T = typename Vector::value_type; + + static_assert(vector_has_data_and_format<Vector>::value, + "There is not an appropriate format descriptor for this vector"); + + // numpy.h declares this for arbitrary types, but it may raise an exception and crash hard at runtime if + // PYBIND11_NUMPY_DTYPE hasn't been called, so check here + format_descriptor<T>::format(); + + cl.def_buffer([](Vector& v) -> buffer_info { + return buffer_info( + v.data(), static_cast<ssize_t>(sizeof(T)), format_descriptor<T>::format(), 1, {v.size()}, {sizeof(T)}); + }); + + cl.def(init([](buffer buf) { + auto info = buf.request(); + if (info.ndim != 1 || info.strides[0] % static_cast<ssize_t>(sizeof(T))) + throw type_error("Only valid 1D buffers can be copied to a vector"); + if (!detail::compare_buffer_info<T>::compare(info) || (ssize_t)sizeof(T) != info.itemsize) + throw type_error("Format mismatch (Python: " + info.format + " C++: " + format_descriptor<T>::format() + ")"); + + auto vec = std::unique_ptr<Vector>(new Vector()); + vec->reserve((size_t)info.shape[0]); + T* p = static_cast<T*>(info.ptr); + ssize_t step = info.strides[0] / static_cast<ssize_t>(sizeof(T)); + T* end = p + info.shape[0] * step; + for (; p != end; p += step) + vec->push_back(*p); + return vec.release(); + })); + + return; +} + +template <typename Vector, typename Class_, typename... Args> +enable_if_t<!detail::any_of<std::is_same<Args, buffer_protocol>...>::value> vector_buffer(Class_&) +{} + +NAMESPACE_END(detail) + +// +// std::vector +// +template <typename Vector, typename holder_type = std::unique_ptr<Vector>, typename... Args> +class_<Vector, holder_type> bind_vector(handle scope, std::string const& name, Args&&... args) +{ + using Class_ = class_<Vector, holder_type>; + + // If the value_type is unregistered (e.g. a converting type) or is itself registered + // module-local then make the vector binding module-local as well: + using vtype = typename Vector::value_type; + auto vtype_info = detail::get_type_info(typeid(vtype)); + bool local = !vtype_info || vtype_info->module_local; + + Class_ cl(scope, name.c_str(), pybind11::module_local(local), std::forward<Args>(args)...); + + // Declare the buffer interface if a buffer_protocol() is passed in + detail::vector_buffer<Vector, Class_, Args...>(cl); + + cl.def(init<>()); + + // Register copy constructor (if possible) + detail::vector_if_copy_constructible<Vector, Class_>(cl); + + // Register comparison-related operators and functions (if possible) + detail::vector_if_equal_operator<Vector, Class_>(cl); + + // Register stream insertion operator (if possible) + detail::vector_if_insertion_operator<Vector, Class_>(cl, name); + + // Modifiers require copyable vector value type + detail::vector_modifiers<Vector, Class_>(cl); + + // Accessor and iterator; return by value if copyable, otherwise we return by ref + keep-alive + detail::vector_accessor<Vector, Class_>(cl); + + cl.def("__bool__", [](const Vector& v) -> bool { return !v.empty(); }, "Check whether the list is nonempty"); + + cl.def("__len__", &Vector::size); + + +#if 0 + // C++ style functions deprecated, leaving it here as an example + cl.def(init<size_type>()); + + cl.def("resize", + (void (Vector::*) (size_type count)) & Vector::resize, + "changes the number of elements stored"); + + cl.def("erase", + [](Vector &v, SizeType i) { + if (i >= v.size()) + throw index_error(); + v.erase(v.begin() + i); + }, "erases element at index ``i``"); + + cl.def("empty", &Vector::empty, "checks whether the container is empty"); + cl.def("size", &Vector::size, "returns the number of elements"); + cl.def("push_back", (void (Vector::*)(const T&)) &Vector::push_back, "adds an element to the end"); + cl.def("pop_back", &Vector::pop_back, "removes the last element"); + + cl.def("max_size", &Vector::max_size, "returns the maximum possible number of elements"); + cl.def("reserve", &Vector::reserve, "reserves storage"); + cl.def("capacity", &Vector::capacity, "returns the number of elements that can be held in currently allocated storage"); + cl.def("shrink_to_fit", &Vector::shrink_to_fit, "reduces memory usage by freeing unused memory"); + + cl.def("clear", &Vector::clear, "clears the contents"); + cl.def("swap", &Vector::swap, "swaps the contents"); + + cl.def("front", [](Vector &v) { + if (v.size()) return v.front(); + else throw index_error(); + }, "access the first element"); + + cl.def("back", [](Vector &v) { + if (v.size()) return v.back(); + else throw index_error(); + }, "access the last element "); + +#endif + + return cl; +} + + +// +// std::map, std::unordered_map +// + +NAMESPACE_BEGIN(detail) + +/* Fallback functions */ +template <typename, typename, typename... Args> +void map_if_insertion_operator(const Args&...) +{} +template <typename, typename, typename... Args> +void map_assignment(const Args&...) +{} + +// Map assignment when copy-assignable: just copy the value +template <typename Map, typename Class_> +void map_assignment(enable_if_t<std::is_copy_assignable<typename Map::mapped_type>::value, Class_>& cl) +{ + using KeyType = typename Map::key_type; + using MappedType = typename Map::mapped_type; + + cl.def("__setitem__", [](Map& m, const KeyType& k, const MappedType& v) { + auto it = m.find(k); + if (it != m.end()) + it->second = v; + else + m.emplace(k, v); + }); +} + +// Not copy-assignable, but still copy-constructible: we can update the value by erasing and reinserting +template <typename Map, typename Class_> +void map_assignment(enable_if_t<!std::is_copy_assignable<typename Map::mapped_type>::value + && is_copy_constructible<typename Map::mapped_type>::value, + Class_>& cl) +{ + using KeyType = typename Map::key_type; + using MappedType = typename Map::mapped_type; + + cl.def("__setitem__", [](Map& m, const KeyType& k, const MappedType& v) { + // We can't use m[k] = v; because value type might not be default constructable + auto r = m.emplace(k, v); + if (!r.second) { + // value type is not copy assignable so the only way to insert it is to erase it first... + m.erase(r.first); + m.emplace(k, v); + } + }); +} + + +template <typename Map, typename Class_> +auto map_if_insertion_operator(Class_& cl, std::string const& name) + -> decltype(std::declval<std::ostream&>() + << std::declval<typename Map::key_type>() << std::declval<typename Map::mapped_type>(), + void()) +{ + + cl.def("__repr__", + [name](Map& m) { + std::ostringstream s; + s << name << '{'; + bool f = false; + for (auto const& kv : m) { + if (f) + s << ", "; + s << kv.first << ": " << kv.second; + f = true; + } + s << '}'; + return s.str(); + }, + "Return the canonical string representation of this map."); +} + + +NAMESPACE_END(detail) + +template <typename Map, typename holder_type = std::unique_ptr<Map>, typename... Args> +class_<Map, holder_type> bind_map(handle scope, const std::string& name, Args&&... args) +{ + using KeyType = typename Map::key_type; + using MappedType = typename Map::mapped_type; + using Class_ = class_<Map, holder_type>; + + // If either type is a non-module-local bound type then make the map binding non-local as well; + // otherwise (e.g. both types are either module-local or converting) the map will be + // module-local. + auto tinfo = detail::get_type_info(typeid(MappedType)); + bool local = !tinfo || tinfo->module_local; + if (local) { + tinfo = detail::get_type_info(typeid(KeyType)); + local = !tinfo || tinfo->module_local; + } + + Class_ cl(scope, name.c_str(), pybind11::module_local(local), std::forward<Args>(args)...); + + cl.def(init<>()); + + // Register stream insertion operator (if possible) + detail::map_if_insertion_operator<Map, Class_>(cl, name); + + cl.def("__bool__", [](const Map& m) -> bool { return !m.empty(); }, "Check whether the map is nonempty"); + + cl.def("__iter__", + [](Map& m) { return make_key_iterator(m.begin(), m.end()); }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); + + cl.def("items", + [](Map& m) { return make_iterator(m.begin(), m.end()); }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); + + cl.def("__getitem__", + [](Map& m, const KeyType& k) -> MappedType& { + auto it = m.find(k); + if (it == m.end()) + throw key_error(); + return it->second; + }, + return_value_policy::reference_internal // ref + keepalive + ); + + cl.def("__contains__", [](Map& m, const KeyType& k) -> bool { + auto it = m.find(k); + if (it == m.end()) + return false; + return true; + }); + + // Assignment provided only if the type is copyable + detail::map_assignment<Map, Class_>(cl); + + cl.def("__delitem__", [](Map& m, const KeyType& k) { + auto it = m.find(k); + if (it == m.end()) + throw key_error(); + m.erase(it); + }); + + cl.def("__len__", &Map::size); + + return cl; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/pybind11/pybind11/__init__.py b/pybind11/pybind11/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..4859689de2911f4563a37bc188f7910b55fa13d9 --- /dev/null +++ b/pybind11/pybind11/__init__.py @@ -0,0 +1,27 @@ +from ._version import version_info, __version__ # noqa: F401 imported but unused + + +def get_include(user=False): + from distutils.dist import Distribution + import os + import sys + + # Are we running in a virtual environment? + virtualenv = hasattr(sys, 'real_prefix') or \ + sys.prefix != getattr(sys, "base_prefix", sys.prefix) + + if virtualenv: + return os.path.join(sys.prefix, 'include', 'site', 'python' + sys.version[:3]) + else: + dist = Distribution({'name': 'pybind11'}) + dist.parse_config_files() + + dist_cobj = dist.get_command_obj('install', create=True) + + # Search for packages in user's home directory? + if user: + dist_cobj.user = user + dist_cobj.prefix = "" + dist_cobj.finalize_options() + + return os.path.dirname(dist_cobj.install_headers) diff --git a/pybind11/pybind11/__main__.py b/pybind11/pybind11/__main__.py new file mode 100644 index 0000000000000000000000000000000000000000..e73ed781530db8c2fa5a7ce9c8c030bcdbcb500e --- /dev/null +++ b/pybind11/pybind11/__main__.py @@ -0,0 +1,33 @@ +from __future__ import print_function + +import argparse +import sys +import sysconfig + +from . import get_include + + +def print_includes(): + dirs = [sysconfig.get_path('include'), sysconfig.get_path('platinclude'), get_include(), get_include(True)] + + # Make unique but preserve order + unique_dirs = [] + for d in dirs: + if d not in unique_dirs: + unique_dirs.append(d) + + print(' '.join('-I' + d for d in unique_dirs)) + + +def main(): + parser = argparse.ArgumentParser(prog='python -m pybind11') + parser.add_argument('--includes', action='store_true', help='Include flags for both pybind11 and Python headers.') + args = parser.parse_args() + if not sys.argv[1:]: + parser.print_help() + if args.includes: + print_includes() + + +if __name__ == '__main__': + main() diff --git a/pybind11/pybind11/_version.py b/pybind11/pybind11/_version.py new file mode 100644 index 0000000000000000000000000000000000000000..fef541bdbc7d5d4f8f417290ed564486005eb6e9 --- /dev/null +++ b/pybind11/pybind11/_version.py @@ -0,0 +1,2 @@ +version_info = (2, 3, 'dev1') +__version__ = '.'.join(map(str, version_info)) diff --git a/pybind11/setup.cfg b/pybind11/setup.cfg new file mode 100644 index 0000000000000000000000000000000000000000..002f38d10e46472657ff8228139e0f92b0d5bc10 --- /dev/null +++ b/pybind11/setup.cfg @@ -0,0 +1,12 @@ +[bdist_wheel] +universal=1 + +[flake8] +max-line-length = 99 +show_source = True +exclude = .git, __pycache__, build, dist, docs, tools, venv +ignore = + # required for pretty matrix formatting: multiple spaces after `,` and `[` + E201, E241, W504, + # camelcase 'cPickle' imported as lowercase 'pickle' + N813 diff --git a/pybind11/setup.py b/pybind11/setup.py new file mode 100644 index 0000000000000000000000000000000000000000..1ac6931d87fdb96a14e58036f86683225b0fb836 --- /dev/null +++ b/pybind11/setup.py @@ -0,0 +1,102 @@ +#!/usr/bin/env python + +# Setup script for PyPI; use CMakeFile.txt to build extension modules + +from setuptools import setup +from distutils.command.install_headers import install_headers +from pybind11 import __version__ +import os + +# Prevent installation of pybind11 headers by setting +# PYBIND11_USE_CMAKE. +if os.environ.get('PYBIND11_USE_CMAKE'): + headers = [] +else: + headers = [ + 'include/pybind11/detail/class.h', + 'include/pybind11/detail/common.h', + 'include/pybind11/detail/descr.h', + 'include/pybind11/detail/init.h', + 'include/pybind11/detail/internals.h', + 'include/pybind11/detail/typeid.h', + 'include/pybind11/attr.h', + 'include/pybind11/buffer_info.h', + 'include/pybind11/cast.h', + 'include/pybind11/chrono.h', + 'include/pybind11/common.h', + 'include/pybind11/complex.h', + 'include/pybind11/eigen.h', + 'include/pybind11/embed.h', + 'include/pybind11/eval.h', + 'include/pybind11/functional.h', + 'include/pybind11/iostream.h', + 'include/pybind11/numpy.h', + 'include/pybind11/operators.h', + 'include/pybind11/options.h', + 'include/pybind11/pybind11.h', + 'include/pybind11/pytypes.h', + 'include/pybind11/stl.h', + 'include/pybind11/stl_bind.h', + ] + + +class InstallHeaders(install_headers): + """Use custom header installer because the default one flattens subdirectories""" + + def run(self): + if not self.distribution.headers: + return + + for header in self.distribution.headers: + subdir = os.path.dirname(os.path.relpath(header, 'include/pybind11')) + install_dir = os.path.join(self.install_dir, subdir) + self.mkpath(install_dir) + + (out, _) = self.copy_file(header, install_dir) + self.outfiles.append(out) + + +setup( + name='pybind11', + version=__version__, + description='Seamless operability between C++11 and Python', + author='Wenzel Jakob', + author_email='wenzel.jakob@epfl.ch', + url='https://github.com/pybind/pybind11', + download_url='https://github.com/pybind/pybind11/tarball/v' + __version__, + packages=['pybind11'], + license='BSD', + headers=headers, + cmdclass=dict(install_headers=InstallHeaders), + classifiers=[ + 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', + 'Topic :: Software Development :: Libraries :: Python Modules', 'Topic :: Utilities', + 'Programming Language :: C++', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.2', 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', 'License :: OSI Approved :: BSD License' + ], + keywords='C++11, Python bindings', + long_description="""pybind11 is a lightweight header-only library that +exposes C++ types in Python and vice versa, mainly to create Python bindings of +existing C++ code. Its goals and syntax are similar to the excellent +Boost.Python by David Abrahams: to minimize boilerplate code in traditional +extension modules by inferring type information using compile-time +introspection. + +The main issue with Boost.Python-and the reason for creating such a similar +project-is Boost. Boost is an enormously large and complex suite of utility +libraries that works with almost every C++ compiler in existence. This +compatibility has its cost: arcane template tricks and workarounds are +necessary to support the oldest and buggiest of compiler specimens. Now that +C++11-compatible compilers are widely available, this heavy machinery has +become an excessively large and unnecessary dependency. + +Think of this library as a tiny self-contained version of Boost.Python with +everything stripped away that isn't relevant for binding generation. Without +comments, the core header files only require ~4K lines of code and depend on +Python (2.7 or 3.x, or PyPy2.7 >= 5.7) and the C++ standard library. This +compact implementation was possible thanks to some of the new C++11 language +features (specifically: tuples, lambda functions and variadic templates). Since +its creation, this library has grown beyond Boost.Python in many ways, leading +to dramatically simpler binding code in many common situations.""") diff --git a/pybind11/tests/CMakeLists.txt b/pybind11/tests/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..bc72a4bdb7bc778d7255d96e5865947f0d263313 --- /dev/null +++ b/pybind11/tests/CMakeLists.txt @@ -0,0 +1,243 @@ +# CMakeLists.txt -- Build system for the pybind11 test suite +# +# Copyright (c) 2015 Wenzel Jakob <wenzel@inf.ethz.ch> +# +# All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE +# file. + +cmake_minimum_required(VERSION 2.8.12) + +option(PYBIND11_WERROR "Report all warnings as errors" OFF) + +if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) + # We're being loaded directly, i.e. not via add_subdirectory, so make this work as its own project and load the + # pybind11Config to get the tools we need + project(pybind11_tests CXX) + + find_package(pybind11 REQUIRED CONFIG) +endif() + +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + message(STATUS "Setting tests build type to MinSizeRel as none was specified") + set(CMAKE_BUILD_TYPE MinSizeRel CACHE STRING "Choose the type of build." FORCE) + set_property(CACHE CMAKE_BUILD_TYPE + PROPERTY STRINGS + "Debug" + "Release" + "MinSizeRel" + "RelWithDebInfo") +endif() + +# Full set of test files (you can override these; see below) +set(PYBIND11_TEST_FILES + test_buffers.cpp + test_builtin_casters.cpp + test_call_policies.cpp + test_callbacks.cpp + test_chrono.cpp + test_class.cpp + test_constants_and_functions.cpp + test_copy_move.cpp + test_docstring_options.cpp + test_eigen.cpp + test_enum.cpp + test_eval.cpp + test_exceptions.cpp + test_factory_constructors.cpp + test_gil_scoped.cpp + test_iostream.cpp + test_kwargs_and_defaults.cpp + test_local_bindings.cpp + test_methods_and_attributes.cpp + test_modules.cpp + test_multiple_inheritance.cpp + test_numpy_array.cpp + test_numpy_dtypes.cpp + test_numpy_vectorize.cpp + test_opaque_types.cpp + test_operator_overloading.cpp + test_pickling.cpp + test_pytypes.cpp + test_sequences_and_iterators.cpp + test_smart_ptr.cpp + test_stl.cpp + test_stl_binders.cpp + test_tagbased_polymorphic.cpp + test_union.cpp + test_virtual_functions.cpp) + +# Invoking cmake with something like: cmake -DPYBIND11_TEST_OVERRIDE="test_callbacks.cpp;test_picking.cpp" .. lets you +# override the tests that get compiled and run. You can restore to all tests with: cmake -DPYBIND11_TEST_OVERRIDE= .. +if(PYBIND11_TEST_OVERRIDE) + set(PYBIND11_TEST_FILES ${PYBIND11_TEST_OVERRIDE}) +endif() + +string(REPLACE ".cpp" + ".py" + PYBIND11_PYTEST_FILES + "${PYBIND11_TEST_FILES}") + +# Contains the set of test files that require pybind11_cross_module_tests to be built; if none of these are built (i.e. +# because TEST_OVERRIDE is used and doesn't include them) the second module doesn't get built. +set(PYBIND11_CROSS_MODULE_TESTS test_exceptions.py test_local_bindings.py test_stl.py test_stl_binders.py) + +# Check if Eigen is available; if not, remove from PYBIND11_TEST_FILES (but keep it in PYBIND11_PYTEST_FILES, so that +# we get the "eigen is not installed" skip message). +list(FIND PYBIND11_TEST_FILES test_eigen.cpp PYBIND11_TEST_FILES_EIGEN_I) +if(PYBIND11_TEST_FILES_EIGEN_I GREATER -1) + # Try loading via newer Eigen's Eigen3Config first (bypassing tools/FindEigen3.cmake). Eigen 3.3.1+ exports a cmake + # 3.0+ target for handling dependency requirements, but also produces a fatal error if loaded from a pre-3.0 cmake. + if(NOT CMAKE_VERSION VERSION_LESS 3.0) + find_package(Eigen3 3.2.7 QUIET CONFIG) + if(EIGEN3_FOUND) + if(EIGEN3_VERSION_STRING AND NOT EIGEN3_VERSION_STRING VERSION_LESS 3.3.1) + set(PYBIND11_EIGEN_VIA_TARGET 1) + endif() + endif() + endif() + if(NOT EIGEN3_FOUND) + # Couldn't load via target, so fall back to allowing module mode finding, which will pick up tools/FindEigen3.cmake + find_package(Eigen3 3.2.7 QUIET) + endif() + + if(EIGEN3_FOUND) + # Eigen 3.3.1+ cmake sets EIGEN3_VERSION_STRING (and hard codes the version when installed rather than looking it + # up in the cmake script); older versions, and the tools/FindEigen3.cmake, set EIGEN3_VERSION instead. + if(NOT EIGEN3_VERSION AND EIGEN3_VERSION_STRING) + set(EIGEN3_VERSION ${EIGEN3_VERSION_STRING}) + endif() + message(STATUS "Building tests with Eigen v${EIGEN3_VERSION}") + else() + list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_EIGEN_I}) + message(STATUS "Building tests WITHOUT Eigen") + endif() +endif() + +# Optional dependency for some tests (boost::variant is only supported with version >= 1.56) +find_package(Boost 1.56) + +# Compile with compiler warnings turned on +function(pybind11_enable_warnings target_name) + if(MSVC) + target_compile_options(${target_name} PRIVATE /W4) + elseif(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Intel|Clang)") + target_compile_options(${target_name} + PRIVATE -Wall + -Wextra + -Wconversion + -Wcast-qual + -Wdeprecated) + endif() + + if(PYBIND11_WERROR) + if(MSVC) + target_compile_options(${target_name} PRIVATE /WX) + elseif(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Intel|Clang)") + target_compile_options(${target_name} PRIVATE -Werror) + endif() + endif() +endfunction() + +set(test_targets pybind11_tests) + +# Build pybind11_cross_module_tests if any test_whatever.py are being built that require it +foreach(t ${PYBIND11_CROSS_MODULE_TESTS}) + list(FIND PYBIND11_PYTEST_FILES ${t} i) + if(i GREATER -1) + list(APPEND test_targets pybind11_cross_module_tests) + break() + endif() +endforeach() + +set(testdir ${CMAKE_CURRENT_SOURCE_DIR}) +foreach(target ${test_targets}) + set(test_files ${PYBIND11_TEST_FILES}) + if(NOT target STREQUAL "pybind11_tests") + set(test_files "") + endif() + + # Create the binding library + pybind11_add_module(${target} THIN_LTO ${target}.cpp ${test_files} ${PYBIND11_HEADERS}) + pybind11_enable_warnings(${target}) + + if(MSVC) + target_compile_options(${target} PRIVATE /utf-8) + endif() + + if(EIGEN3_FOUND) + if(PYBIND11_EIGEN_VIA_TARGET) + target_link_libraries(${target} PRIVATE Eigen3::Eigen) + else() + target_include_directories(${target} PRIVATE ${EIGEN3_INCLUDE_DIR}) + endif() + target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_EIGEN) + endif() + + if(Boost_FOUND) + target_include_directories(${target} PRIVATE ${Boost_INCLUDE_DIRS}) + target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_BOOST) + endif() + + # Always write the output file directly into the 'tests' directory (even on MSVC) + if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY) + set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${testdir}) + foreach(config ${CMAKE_CONFIGURATION_TYPES}) + string(TOUPPER ${config} config) + set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY_${config} ${testdir}) + endforeach() + endif() +endforeach() + +# Make sure pytest is found or produce a fatal error +if(NOT PYBIND11_PYTEST_FOUND) + execute_process(COMMAND ${PYTHON_EXECUTABLE} -c "import pytest; print(pytest.__version__)" + RESULT_VARIABLE pytest_not_found + OUTPUT_VARIABLE pytest_version + ERROR_QUIET) + if(pytest_not_found) + message(FATAL_ERROR "Running the tests requires pytest. Please install it manually" + " (try: ${PYTHON_EXECUTABLE} -m pip install pytest)") + elseif(pytest_version VERSION_LESS 3.0) + message(FATAL_ERROR "Running the tests requires pytest >= 3.0. Found: ${pytest_version}" + "Please update it (try: ${PYTHON_EXECUTABLE} -m pip install -U pytest)") + endif() + set(PYBIND11_PYTEST_FOUND TRUE CACHE INTERNAL "") +endif() + +if(CMAKE_VERSION VERSION_LESS 3.2) + set(PYBIND11_USES_TERMINAL "") +else() + set(PYBIND11_USES_TERMINAL "USES_TERMINAL") +endif() + +# A single command to compile and run the tests +add_custom_target(pytest + COMMAND ${PYTHON_EXECUTABLE} -m pytest ${PYBIND11_PYTEST_FILES} + DEPENDS ${test_targets} + WORKING_DIRECTORY ${testdir} + ${PYBIND11_USES_TERMINAL}) + +if(PYBIND11_TEST_OVERRIDE) + add_custom_command(TARGET pytest POST_BUILD + COMMAND ${CMAKE_COMMAND} -E echo "Note: not all tests run: -DPYBIND11_TEST_OVERRIDE is in effect") +endif() + +# Add a check target to run all the tests, starting with pytest (we add dependencies to this below) +add_custom_target(check DEPENDS pytest) + +# The remaining tests only apply when being built as part of the pybind11 project, but not if the tests are being built +# independently. +if(NOT PROJECT_NAME STREQUAL "pybind11") + return() +endif() + +# Add a post-build comment to show the primary test suite .so size and, if a previous size, compare it: +add_custom_command(TARGET pybind11_tests POST_BUILD + COMMAND ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/libsize.py $<TARGET_FILE:pybind11_tests> + ${CMAKE_CURRENT_BINARY_DIR}/sosize-$<TARGET_FILE_NAME:pybind11_tests>.txt) + +# Test embedding the interpreter. Provides the `cpptest` target. +add_subdirectory(test_embed) + +# Test CMake build using functions and targets from subdirectory or installed location +add_subdirectory(test_cmake_build) diff --git a/pybind11/tests/conftest.py b/pybind11/tests/conftest.py new file mode 100644 index 0000000000000000000000000000000000000000..57f7f9aca919dfa03bb0dd751c8f4a5e8015f7ee --- /dev/null +++ b/pybind11/tests/conftest.py @@ -0,0 +1,241 @@ +"""pytest configuration + +Extends output capture as needed by pybind11: ignore constructors, optional unordered lines. +Adds docstring and exceptions message sanitizers: ignore Python 2 vs 3 differences. +""" + +import pytest +import textwrap +import difflib +import re +import sys +import contextlib +import platform +import gc + +_unicode_marker = re.compile(r'u(\'[^\']*\')') +_long_marker = re.compile(r'([0-9])L') +_hexadecimal = re.compile(r'0x[0-9a-fA-F]+') + + +def _strip_and_dedent(s): + """For triple-quote strings""" + return textwrap.dedent(s.lstrip('\n').rstrip()) + + +def _split_and_sort(s): + """For output which does not require specific line order""" + return sorted(_strip_and_dedent(s).splitlines()) + + +def _make_explanation(a, b): + """Explanation for a failed assert -- the a and b arguments are List[str]""" + return ["--- actual / +++ expected"] + [line.strip('\n') for line in difflib.ndiff(a, b)] + + +class Output(object): + """Basic output post-processing and comparison""" + + def __init__(self, string): + self.string = string + self.explanation = [] + + def __str__(self): + return self.string + + def __eq__(self, other): + # Ignore constructor/destructor output which is prefixed with "###" + a = [line for line in self.string.strip().splitlines() if not line.startswith("###")] + b = _strip_and_dedent(other).splitlines() + if a == b: + return True + else: + self.explanation = _make_explanation(a, b) + return False + + +class Unordered(Output): + """Custom comparison for output without strict line ordering""" + + def __eq__(self, other): + a = _split_and_sort(self.string) + b = _split_and_sort(other) + if a == b: + return True + else: + self.explanation = _make_explanation(a, b) + return False + + +class Capture(object): + + def __init__(self, capfd): + self.capfd = capfd + self.out = "" + self.err = "" + + def __enter__(self): + self.capfd.readouterr() + return self + + def __exit__(self, *args): + self.out, self.err = self.capfd.readouterr() + + def __eq__(self, other): + a = Output(self.out) + b = other + if a == b: + return True + else: + self.explanation = a.explanation + return False + + def __str__(self): + return self.out + + def __contains__(self, item): + return item in self.out + + @property + def unordered(self): + return Unordered(self.out) + + @property + def stderr(self): + return Output(self.err) + + +@pytest.fixture +def capture(capsys): + """Extended `capsys` with context manager and custom equality operators""" + return Capture(capsys) + + +class SanitizedString(object): + + def __init__(self, sanitizer): + self.sanitizer = sanitizer + self.string = "" + self.explanation = [] + + def __call__(self, thing): + self.string = self.sanitizer(thing) + return self + + def __eq__(self, other): + a = self.string + b = _strip_and_dedent(other) + if a == b: + return True + else: + self.explanation = _make_explanation(a.splitlines(), b.splitlines()) + return False + + +def _sanitize_general(s): + s = s.strip() + s = s.replace("pybind11_tests.", "m.") + s = s.replace("unicode", "str") + s = _long_marker.sub(r"\1", s) + s = _unicode_marker.sub(r"\1", s) + return s + + +def _sanitize_docstring(thing): + s = thing.__doc__ + s = _sanitize_general(s) + return s + + +@pytest.fixture +def doc(): + """Sanitize docstrings and add custom failure explanation""" + return SanitizedString(_sanitize_docstring) + + +def _sanitize_message(thing): + s = str(thing) + s = _sanitize_general(s) + s = _hexadecimal.sub("0", s) + return s + + +@pytest.fixture +def msg(): + """Sanitize messages and add custom failure explanation""" + return SanitizedString(_sanitize_message) + + +# noinspection PyUnusedLocal +def pytest_assertrepr_compare(op, left, right): + """Hook to insert custom failure explanation""" + if hasattr(left, 'explanation'): + return left.explanation + + +@contextlib.contextmanager +def suppress(exception): + """Suppress the desired exception""" + try: + yield + except exception: + pass + + +def gc_collect(): + ''' Run the garbage collector twice (needed when running + reference counting tests with PyPy) ''' + gc.collect() + gc.collect() + + +def pytest_configure(): + """Add import suppression and test requirements to `pytest` namespace""" + try: + import numpy as np + except ImportError: + np = None + try: + import scipy + except ImportError: + scipy = None + try: + from pybind11_tests.eigen import have_eigen + except ImportError: + have_eigen = False + pypy = platform.python_implementation() == "PyPy" + + skipif = pytest.mark.skipif + pytest.suppress = suppress + pytest.requires_numpy = skipif(not np, reason="numpy is not installed") + pytest.requires_scipy = skipif(not np, reason="scipy is not installed") + pytest.requires_eigen_and_numpy = skipif(not have_eigen or not np, reason="eigen and/or numpy are not installed") + pytest.requires_eigen_and_scipy = skipif( + not have_eigen or not scipy, reason="eigen and/or scipy are not installed") + pytest.unsupported_on_pypy = skipif(pypy, reason="unsupported on PyPy") + pytest.unsupported_on_py2 = skipif(sys.version_info.major < 3, reason="unsupported on Python 2.x") + pytest.gc_collect = gc_collect + + +def _test_import_pybind11(): + """Early diagnostic for test module initialization errors + + When there is an error during initialization, the first import will report the + real error while all subsequent imports will report nonsense. This import test + is done early (in the pytest configuration file, before any tests) in order to + avoid the noise of having all tests fail with identical error messages. + + Any possible exception is caught here and reported manually *without* the stack + trace. This further reduces noise since the trace would only show pytest internals + which are not useful for debugging pybind11 module issues. + """ + # noinspection PyBroadException + try: + import pybind11_tests # noqa: F401 imported but unused + except Exception as e: + print("Failed to import pybind11_tests from pytest:") + print(" {}: {}".format(type(e).__name__, e)) + sys.exit(1) + + +_test_import_pybind11() diff --git a/pybind11/tests/constructor_stats.h b/pybind11/tests/constructor_stats.h new file mode 100644 index 0000000000000000000000000000000000000000..f2cacf86f5dbf210a8a2f11c64930ee1824b9349 --- /dev/null +++ b/pybind11/tests/constructor_stats.h @@ -0,0 +1,342 @@ +#pragma once +/* + tests/constructor_stats.h -- framework for printing and tracking object + instance lifetimes in example/test code. + + Copyright (c) 2016 Jason Rhinelander <jason@imaginary.ca> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. + +This header provides a few useful tools for writing examples or tests that want to check and/or +display object instance lifetimes. It requires that you include this header and add the following +function calls to constructors: + + class MyClass { + MyClass() { ...; print_default_created(this); } + ~MyClass() { ...; print_destroyed(this); } + MyClass(const MyClass &c) { ...; print_copy_created(this); } + MyClass(MyClass &&c) { ...; print_move_created(this); } + MyClass(int a, int b) { ...; print_created(this, a, b); } + MyClass &operator=(const MyClass &c) { ...; print_copy_assigned(this); } + MyClass &operator=(MyClass &&c) { ...; print_move_assigned(this); } + + ... + } + +You can find various examples of these in several of the existing testing .cpp files. (Of course +you don't need to add any of the above constructors/operators that you don't actually have, except +for the destructor). + +Each of these will print an appropriate message such as: + + ### MyClass @ 0x2801910 created via default constructor + ### MyClass @ 0x27fa780 created 100 200 + ### MyClass @ 0x2801910 destroyed + ### MyClass @ 0x27fa780 destroyed + +You can also include extra arguments (such as the 100, 200 in the output above, coming from the +value constructor) for all of the above methods which will be included in the output. + +For testing, each of these also keeps track the created instances and allows you to check how many +of the various constructors have been invoked from the Python side via code such as: + + from pybind11_tests import ConstructorStats + cstats = ConstructorStats.get(MyClass) + print(cstats.alive()) + print(cstats.default_constructions) + +Note that `.alive()` should usually be the first thing you call as it invokes Python's garbage +collector to actually destroy objects that aren't yet referenced. + +For everything except copy and move constructors and destructors, any extra values given to the +print_...() function is stored in a class-specific values list which you can retrieve and inspect +from the ConstructorStats instance `.values()` method. + +In some cases, when you need to track instances of a C++ class not registered with pybind11, you +need to add a function returning the ConstructorStats for the C++ class; this can be done with: + + m.def("get_special_cstats", &ConstructorStats::get<SpecialClass>, py::return_value_policy::reference) + +Finally, you can suppress the output messages, but keep the constructor tracking (for +inspection/testing in python) by using the functions with `print_` replaced with `track_` (e.g. +`track_copy_created(this)`). + +*/ + +#include "pybind11_tests.h" +#include <unordered_map> +#include <list> +#include <typeindex> +#include <sstream> + +class ConstructorStats +{ +protected: + std::unordered_map<void*, int> _instances; // Need a map rather than set because members can shared address with + // parents + std::list<std::string> _values; // Used to track values (e.g. of value constructors) +public: + int default_constructions = 0; + int copy_constructions = 0; + int move_constructions = 0; + int copy_assignments = 0; + int move_assignments = 0; + + void copy_created(void* inst) + { + created(inst); + copy_constructions++; + } + + void move_created(void* inst) + { + created(inst); + move_constructions++; + } + + void default_created(void* inst) + { + created(inst); + default_constructions++; + } + + void created(void* inst) + { + ++_instances[inst]; + } + + void destroyed(void* inst) + { + if (--_instances[inst] < 0) + throw std::runtime_error("cstats.destroyed() called with unknown " + "instance; potential double-destruction " + "or a missing cstats.created()"); + } + + static void gc() + { + // Force garbage collection to ensure any pending destructors are invoked: +#if defined(PYPY_VERSION) + PyObject* globals = PyEval_GetGlobals(); + PyObject* result = PyRun_String("import gc\n" + "for i in range(2):" + " gc.collect()\n", + Py_file_input, + globals, + globals); + if (result == nullptr) + throw py::error_already_set(); + Py_DECREF(result); +#else + py::module::import("gc").attr("collect")(); +#endif + } + + int alive() + { + gc(); + int total = 0; + for (const auto& p : _instances) + if (p.second > 0) + total += p.second; + return total; + } + + void value() {} // Recursion terminator + // Takes one or more values, converts them to strings, then stores them. + template <typename T, typename... Tmore> + void value(const T& v, Tmore&&... args) + { + std::ostringstream oss; + oss << v; + _values.push_back(oss.str()); + value(std::forward<Tmore>(args)...); + } + + // Move out stored values + py::list values() + { + py::list l; + for (const auto& v : _values) + l.append(py::cast(v)); + _values.clear(); + return l; + } + + // Gets constructor stats from a C++ type index + static ConstructorStats& get(std::type_index type) + { + static std::unordered_map<std::type_index, ConstructorStats> all_cstats; + return all_cstats[type]; + } + + // Gets constructor stats from a C++ type + template <typename T> + static ConstructorStats& get() + { +#if defined(PYPY_VERSION) + gc(); +#endif + return get(typeid(T)); + } + + // Gets constructor stats from a Python class + static ConstructorStats& get(py::object class_) + { + auto& internals = py::detail::get_internals(); + const std::type_index *t1 = nullptr, *t2 = nullptr; + try { + auto* type_info = internals.registered_types_py.at((PyTypeObject*)class_.ptr()).at(0); + for (auto& p : internals.registered_types_cpp) { + if (p.second == type_info) { + if (t1) { + t2 = &p.first; + break; + } + t1 = &p.first; + } + } + } catch (const std::out_of_range&) { + } + if (!t1) + throw std::runtime_error("Unknown class passed to ConstructorStats::get()"); + auto& cs1 = get(*t1); + // If we have both a t1 and t2 match, one is probably the trampoline class; return whichever + // has more constructions (typically one or the other will be 0) + if (t2) { + auto& cs2 = get(*t2); + int cs1_total = + cs1.default_constructions + cs1.copy_constructions + cs1.move_constructions + (int)cs1._values.size(); + int cs2_total = + cs2.default_constructions + cs2.copy_constructions + cs2.move_constructions + (int)cs2._values.size(); + if (cs2_total > cs1_total) + return cs2; + } + return cs1; + } +}; + +// To track construction/destruction, you need to call these methods from the various +// constructors/operators. The ones that take extra values record the given values in the +// constructor stats values for later inspection. +template <class T> +void track_copy_created(T* inst) +{ + ConstructorStats::get<T>().copy_created(inst); +} +template <class T> +void track_move_created(T* inst) +{ + ConstructorStats::get<T>().move_created(inst); +} +template <class T, typename... Values> +void track_copy_assigned(T*, Values&&... values) +{ + auto& cst = ConstructorStats::get<T>(); + cst.copy_assignments++; + cst.value(std::forward<Values>(values)...); +} +template <class T, typename... Values> +void track_move_assigned(T*, Values&&... values) +{ + auto& cst = ConstructorStats::get<T>(); + cst.move_assignments++; + cst.value(std::forward<Values>(values)...); +} +template <class T, typename... Values> +void track_default_created(T* inst, Values&&... values) +{ + auto& cst = ConstructorStats::get<T>(); + cst.default_created(inst); + cst.value(std::forward<Values>(values)...); +} +template <class T, typename... Values> +void track_created(T* inst, Values&&... values) +{ + auto& cst = ConstructorStats::get<T>(); + cst.created(inst); + cst.value(std::forward<Values>(values)...); +} +template <class T, typename... Values> +void track_destroyed(T* inst) +{ + ConstructorStats::get<T>().destroyed(inst); +} +template <class T, typename... Values> +void track_values(T*, Values&&... values) +{ + ConstructorStats::get<T>().value(std::forward<Values>(values)...); +} + +/// Don't cast pointers to Python, print them as strings +inline const char* format_ptrs(const char* p) +{ + return p; +} +template <typename T> +py::str format_ptrs(T* p) +{ + return "{:#x}"_s.format(reinterpret_cast<std::uintptr_t>(p)); +} +template <typename T> +auto format_ptrs(T&& x) -> decltype(std::forward<T>(x)) +{ + return std::forward<T>(x); +} + +template <class T, typename... Output> +void print_constr_details(T* inst, const std::string& action, Output&&... output) +{ + py::print("###", py::type_id<T>(), "@", format_ptrs(inst), action, format_ptrs(std::forward<Output>(output))...); +} + +// Verbose versions of the above: +template <class T, typename... Values> +void print_copy_created(T* inst, Values&&... values) +{ // NB: this prints, but doesn't store, given values + print_constr_details(inst, "created via copy constructor", values...); + track_copy_created(inst); +} +template <class T, typename... Values> +void print_move_created(T* inst, Values&&... values) +{ // NB: this prints, but doesn't store, given values + print_constr_details(inst, "created via move constructor", values...); + track_move_created(inst); +} +template <class T, typename... Values> +void print_copy_assigned(T* inst, Values&&... values) +{ + print_constr_details(inst, "assigned via copy assignment", values...); + track_copy_assigned(inst, values...); +} +template <class T, typename... Values> +void print_move_assigned(T* inst, Values&&... values) +{ + print_constr_details(inst, "assigned via move assignment", values...); + track_move_assigned(inst, values...); +} +template <class T, typename... Values> +void print_default_created(T* inst, Values&&... values) +{ + print_constr_details(inst, "created via default constructor", values...); + track_default_created(inst, values...); +} +template <class T, typename... Values> +void print_created(T* inst, Values&&... values) +{ + print_constr_details(inst, "created", values...); + track_created(inst, values...); +} +template <class T, typename... Values> +void print_destroyed(T* inst, Values&&... values) +{ // Prints but doesn't store given values + print_constr_details(inst, "destroyed", values...); + track_destroyed(inst); +} +template <class T, typename... Values> +void print_values(T* inst, Values&&... values) +{ + print_constr_details(inst, ":", values...); + track_values(inst, values...); +} diff --git a/pybind11/tests/local_bindings.h b/pybind11/tests/local_bindings.h new file mode 100644 index 0000000000000000000000000000000000000000..8e0930b6ffb55d6d68e214e5a35aebb1e0549407 --- /dev/null +++ b/pybind11/tests/local_bindings.h @@ -0,0 +1,85 @@ +#pragma once +#include "pybind11_tests.h" + +/// Simple class used to test py::local: +template <int> +class LocalBase +{ +public: + LocalBase(int i) + : i(i) + {} + int i = -1; +}; + +/// Registered with py::module_local in both main and secondary modules: +using LocalType = LocalBase<0>; +/// Registered without py::module_local in both modules: +using NonLocalType = LocalBase<1>; +/// A second non-local type (for stl_bind tests): +using NonLocal2 = LocalBase<2>; +/// Tests within-module, different-compilation-unit local definition conflict: +using LocalExternal = LocalBase<3>; +/// Mixed: registered local first, then global +using MixedLocalGlobal = LocalBase<4>; +/// Mixed: global first, then local +using MixedGlobalLocal = LocalBase<5>; + +/// Registered with py::module_local only in the secondary module: +using ExternalType1 = LocalBase<6>; +using ExternalType2 = LocalBase<7>; + +using LocalVec = std::vector<LocalType>; +using LocalVec2 = std::vector<NonLocal2>; +using LocalMap = std::unordered_map<std::string, LocalType>; +using NonLocalVec = std::vector<NonLocalType>; +using NonLocalVec2 = std::vector<NonLocal2>; +using NonLocalMap = std::unordered_map<std::string, NonLocalType>; +using NonLocalMap2 = std::unordered_map<std::string, uint8_t>; + +PYBIND11_MAKE_OPAQUE(LocalVec); +PYBIND11_MAKE_OPAQUE(LocalVec2); +PYBIND11_MAKE_OPAQUE(LocalMap); +PYBIND11_MAKE_OPAQUE(NonLocalVec); +// PYBIND11_MAKE_OPAQUE(NonLocalVec2); // same type as LocalVec2 +PYBIND11_MAKE_OPAQUE(NonLocalMap); +PYBIND11_MAKE_OPAQUE(NonLocalMap2); + + +// Simple bindings (used with the above): +template <typename T, int Adjust = 0, typename... Args> +py::class_<T> bind_local(Args&&... args) +{ + return py::class_<T>(std::forward<Args>(args)...).def(py::init<int>()).def("get", [](T& i) { return i.i + Adjust; }); +}; + +// Simulate a foreign library base class (to match the example in the docs): +namespace pets { +class Pet +{ +public: + Pet(std::string name) + : name_(name) + {} + std::string name_; + const std::string& name() + { + return name_; + } +}; +} // namespace pets + +struct MixGL +{ + int i; + MixGL(int i) + : i{i} + {} +}; +struct MixGL2 +{ + int i; + MixGL2(int i) + : i{i} + {} +}; diff --git a/pybind11/tests/object.h b/pybind11/tests/object.h new file mode 100644 index 0000000000000000000000000000000000000000..fdfadb24b74841af88d445e77386a5dcc71e838f --- /dev/null +++ b/pybind11/tests/object.h @@ -0,0 +1,254 @@ +#if !defined(__OBJECT_H) +# define __OBJECT_H + +# include <atomic> +# include "constructor_stats.h" + +/// Reference counted object base class +class Object +{ +public: + /// Default constructor + Object() + { + print_default_created(this); + } + + /// Copy constructor + Object(const Object&) + : m_refCount(0) + { + print_copy_created(this); + } + + /// Return the current reference count + int getRefCount() const + { + return m_refCount; + }; + + /// Increase the object's reference count by one + void incRef() const + { + ++m_refCount; + } + + /** \brief Decrease the reference count of + * the object and possibly deallocate it. + * + * The object will automatically be deallocated once + * the reference count reaches zero. + */ + void decRef(bool dealloc = true) const + { + --m_refCount; + if (m_refCount == 0 && dealloc) + delete this; + else if (m_refCount < 0) + throw std::runtime_error("Internal error: reference count < 0!"); + } + + virtual std::string toString() const = 0; + +protected: + /** \brief Virtual protected deconstructor. + * (Will only be called by \ref ref) + */ + virtual ~Object() + { + print_destroyed(this); + } + +private: + mutable std::atomic<int> m_refCount{0}; +}; + +// Tag class used to track constructions of ref objects. When we track constructors, below, we +// track and print out the actual class (e.g. ref<MyObject>), and *also* add a fake tracker for +// ref_tag. This lets us check that the total number of ref<Anything> constructors/destructors is +// correct without having to check each individual ref<Whatever> type individually. +class ref_tag +{}; + +/** + * \brief Reference counting helper + * + * The \a ref refeference template is a simple wrapper to store a + * pointer to an object. It takes care of increasing and decreasing + * the reference count of the object. When the last reference goes + * out of scope, the associated object will be deallocated. + * + * \ingroup libcore + */ +template <typename T> +class ref +{ +public: + /// Create a nullptr reference + ref() + : m_ptr(nullptr) + { + print_default_created(this); + track_default_created((ref_tag*)this); + } + + /// Construct a reference from a pointer + ref(T* ptr) + : m_ptr(ptr) + { + if (m_ptr) + ((Object*)m_ptr)->incRef(); + + print_created(this, "from pointer", m_ptr); + track_created((ref_tag*)this, "from pointer"); + } + + /// Copy constructor + ref(const ref& r) + : m_ptr(r.m_ptr) + { + if (m_ptr) + ((Object*)m_ptr)->incRef(); + + print_copy_created(this, "with pointer", m_ptr); + track_copy_created((ref_tag*)this); + } + + /// Move constructor + ref(ref&& r) + : m_ptr(r.m_ptr) + { + r.m_ptr = nullptr; + + print_move_created(this, "with pointer", m_ptr); + track_move_created((ref_tag*)this); + } + + /// Destroy this reference + ~ref() + { + if (m_ptr) + ((Object*)m_ptr)->decRef(); + + print_destroyed(this); + track_destroyed((ref_tag*)this); + } + + /// Move another reference into the current one + ref& operator=(ref&& r) + { + print_move_assigned(this, "pointer", r.m_ptr); + track_move_assigned((ref_tag*)this); + + if (*this == r) + return *this; + if (m_ptr) + ((Object*)m_ptr)->decRef(); + m_ptr = r.m_ptr; + r.m_ptr = nullptr; + return *this; + } + + /// Overwrite this reference with another reference + ref& operator=(const ref& r) + { + print_copy_assigned(this, "pointer", r.m_ptr); + track_copy_assigned((ref_tag*)this); + + if (m_ptr == r.m_ptr) + return *this; + if (m_ptr) + ((Object*)m_ptr)->decRef(); + m_ptr = r.m_ptr; + if (m_ptr) + ((Object*)m_ptr)->incRef(); + return *this; + } + + /// Overwrite this reference with a pointer to another object + ref& operator=(T* ptr) + { + print_values(this, "assigned pointer"); + track_values((ref_tag*)this, "assigned pointer"); + + if (m_ptr == ptr) + return *this; + if (m_ptr) + ((Object*)m_ptr)->decRef(); + m_ptr = ptr; + if (m_ptr) + ((Object*)m_ptr)->incRef(); + return *this; + } + + /// Compare this reference with another reference + bool operator==(const ref& r) const + { + return m_ptr == r.m_ptr; + } + + /// Compare this reference with another reference + bool operator!=(const ref& r) const + { + return m_ptr != r.m_ptr; + } + + /// Compare this reference with a pointer + bool operator==(const T* ptr) const + { + return m_ptr == ptr; + } + + /// Compare this reference with a pointer + bool operator!=(const T* ptr) const + { + return m_ptr != ptr; + } + + /// Access the object referenced by this reference + T* operator->() + { + return m_ptr; + } + + /// Access the object referenced by this reference + const T* operator->() const + { + return m_ptr; + } + + /// Return a C++ reference to the referenced object + T& operator*() + { + return *m_ptr; + } + + /// Return a const C++ reference to the referenced object + const T& operator*() const + { + return *m_ptr; + } + + /// Return a pointer to the referenced object + operator T*() + { + return m_ptr; + } + + /// Return a const pointer to the referenced object + T* get_ptr() + { + return m_ptr; + } + + /// Return a pointer to the referenced object + const T* get_ptr() const + { + return m_ptr; + } + +private: + T* m_ptr; +}; + +#endif /* __OBJECT_H */ diff --git a/pybind11/tests/pybind11_cross_module_tests.cpp b/pybind11/tests/pybind11_cross_module_tests.cpp new file mode 100644 index 0000000000000000000000000000000000000000..97a354fede2eef225bf239927500238bfde620c6 --- /dev/null +++ b/pybind11/tests/pybind11_cross_module_tests.cpp @@ -0,0 +1,119 @@ +/* + tests/pybind11_cross_module_tests.cpp -- contains tests that require multiple modules + + Copyright (c) 2017 Jason Rhinelander <jason@imaginary.ca> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "local_bindings.h" +#include <pybind11/stl_bind.h> +#include <numeric> + +PYBIND11_MODULE(pybind11_cross_module_tests, m) +{ + m.doc() = "pybind11 cross-module test module"; + + // test_local_bindings.py tests: + // + // Definitions here are tested by importing both this module and the + // relevant pybind11_tests submodule from a test_whatever.py + + // test_load_external + bind_local<ExternalType1>(m, "ExternalType1", py::module_local()); + bind_local<ExternalType2>(m, "ExternalType2", py::module_local()); + + // test_exceptions.py + m.def("raise_runtime_error", []() { + PyErr_SetString(PyExc_RuntimeError, "My runtime error"); + throw py::error_already_set(); + }); + m.def("raise_value_error", []() { + PyErr_SetString(PyExc_ValueError, "My value error"); + throw py::error_already_set(); + }); + m.def("throw_pybind_value_error", []() { throw py::value_error("pybind11 value error"); }); + m.def("throw_pybind_type_error", []() { throw py::type_error("pybind11 type error"); }); + m.def("throw_stop_iteration", []() { throw py::stop_iteration(); }); + + // test_local_bindings.py + // Local to both: + bind_local<LocalType, 1>(m, "LocalType", py::module_local()).def("get2", [](LocalType& t) { return t.i + 2; }); + + // Can only be called with our python type: + m.def("local_value", [](LocalType& l) { return l.i; }); + + // test_nonlocal_failure + // This registration will fail (global registration when LocalFail is already registered + // globally in the main test module): + m.def("register_nonlocal", [m]() { bind_local<NonLocalType, 0>(m, "NonLocalType"); }); + + // test_stl_bind_local + // stl_bind.h binders defaults to py::module_local if the types are local or converting: + py::bind_vector<LocalVec>(m, "LocalVec"); + py::bind_map<LocalMap>(m, "LocalMap"); + + // test_stl_bind_global + // and global if the type (or one of the types, for the map) is global (so these will fail, + // assuming pybind11_tests is already loaded): + m.def("register_nonlocal_vec", [m]() { py::bind_vector<NonLocalVec>(m, "NonLocalVec"); }); + m.def("register_nonlocal_map", [m]() { py::bind_map<NonLocalMap>(m, "NonLocalMap"); }); + // The default can, however, be overridden to global using `py::module_local()` or + // `py::module_local(false)`. + // Explicitly made local: + py::bind_vector<NonLocalVec2>(m, "NonLocalVec2", py::module_local()); + // Explicitly made global (and so will fail to bind): + m.def("register_nonlocal_map2", [m]() { py::bind_map<NonLocalMap2>(m, "NonLocalMap2", py::module_local(false)); }); + + // test_mixed_local_global + // We try this both with the global type registered first and vice versa (the order shouldn't + // matter). + m.def("register_mixed_global_local", + [m]() { bind_local<MixedGlobalLocal, 200>(m, "MixedGlobalLocal", py::module_local()); }); + m.def("register_mixed_local_global", + [m]() { bind_local<MixedLocalGlobal, 2000>(m, "MixedLocalGlobal", py::module_local(false)); }); + m.def("get_mixed_gl", [](int i) { return MixedGlobalLocal(i); }); + m.def("get_mixed_lg", [](int i) { return MixedLocalGlobal(i); }); + + // test_internal_locals_differ + m.def("local_cpp_types_addr", []() { return (uintptr_t)&py::detail::registered_local_types_cpp(); }); + + // test_stl_caster_vs_stl_bind + py::bind_vector<std::vector<int>>(m, "VectorInt"); + + m.def("load_vector_via_binding", [](std::vector<int>& v) { return std::accumulate(v.begin(), v.end(), 0); }); + + // test_cross_module_calls + m.def("return_self", [](LocalVec* v) { return v; }); + m.def("return_copy", [](const LocalVec& v) { return LocalVec(v); }); + + class Dog : public pets::Pet + { + public: + Dog(std::string name) + : Pet(name){}; + }; + py::class_<pets::Pet>(m, "Pet", py::module_local()).def("name", &pets::Pet::name); + // Binding for local extending class: + py::class_<Dog, pets::Pet>(m, "Dog").def(py::init<std::string>()); + m.def("pet_name", [](pets::Pet& p) { return p.name(); }); + + py::class_<MixGL>(m, "MixGL", py::module_local()).def(py::init<int>()); + m.def("get_gl_value", [](MixGL& o) { return o.i + 100; }); + + py::class_<MixGL2>(m, "MixGL2", py::module_local()).def(py::init<int>()); + + // test_vector_bool + // We can't test both stl.h and stl_bind.h conversions of `std::vector<bool>` within + // the same module (it would be an ODR violation). Therefore `bind_vector` of `bool` + // is defined here and tested in `test_stl_binders.py`. + py::bind_vector<std::vector<bool>>(m, "VectorBool"); + + // test_missing_header_message + // The main module already includes stl.h, but we need to test the error message + // which appears when this header is missing. + m.def("missing_header_arg", [](std::vector<float>) {}); + m.def("missing_header_return", []() { return std::vector<float>(); }); +} diff --git a/pybind11/tests/pybind11_tests.cpp b/pybind11/tests/pybind11_tests.cpp new file mode 100644 index 0000000000000000000000000000000000000000..1602a57d47995ae97e4aa03e1d35a9a782d2a852 --- /dev/null +++ b/pybind11/tests/pybind11_tests.cpp @@ -0,0 +1,100 @@ +/* + tests/pybind11_tests.cpp -- pybind example plugin + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" + +#include <functional> +#include <list> + +/* +For testing purposes, we define a static global variable here in a function that each individual +test .cpp calls with its initialization lambda. It's convenient here because we can just not +compile some test files to disable/ignore some of the test code. + +It is NOT recommended as a way to use pybind11 in practice, however: the initialization order will +be essentially random, which is okay for our test scripts (there are no dependencies between the +individual pybind11 test .cpp files), but most likely not what you want when using pybind11 +productively. + +Instead, see the "How can I reduce the build time?" question in the "Frequently asked questions" +section of the documentation for good practice on splitting binding code over multiple files. +*/ +std::list<std::function<void(py::module&)>>& initializers() +{ + static std::list<std::function<void(py::module&)>> inits; + return inits; +} + +test_initializer::test_initializer(Initializer init) +{ + initializers().push_back(init); +} + +test_initializer::test_initializer(const char* submodule_name, Initializer init) +{ + initializers().push_back([=](py::module& parent) { + auto m = parent.def_submodule(submodule_name); + init(m); + }); +} + +void bind_ConstructorStats(py::module& m) +{ + py::class_<ConstructorStats>(m, "ConstructorStats") + .def("alive", &ConstructorStats::alive) + .def("values", &ConstructorStats::values) + .def_readwrite("default_constructions", &ConstructorStats::default_constructions) + .def_readwrite("copy_assignments", &ConstructorStats::copy_assignments) + .def_readwrite("move_assignments", &ConstructorStats::move_assignments) + .def_readwrite("copy_constructions", &ConstructorStats::copy_constructions) + .def_readwrite("move_constructions", &ConstructorStats::move_constructions) + .def_static("get", + (ConstructorStats & (*)(py::object)) & ConstructorStats::get, + py::return_value_policy::reference_internal) + + // Not exactly ConstructorStats, but related: expose the internal pybind number of registered instances + // to allow instance cleanup checks (invokes a GC first) + .def_static("detail_reg_inst", []() { + ConstructorStats::gc(); + return py::detail::get_internals().registered_instances.size(); + }); +} + +PYBIND11_MODULE(pybind11_tests, m) +{ + m.doc() = "pybind11 test module"; + + bind_ConstructorStats(m); + +#if !defined(NDEBUG) + m.attr("debug_enabled") = true; +#else + m.attr("debug_enabled") = false; +#endif + + py::class_<UserType>(m, "UserType", "A `py::class_` type for testing") + .def(py::init<>()) + .def(py::init<int>()) + .def("get_value", &UserType::value, "Get value using a method") + .def("set_value", &UserType::set, "Set value using a method") + .def_property("value", &UserType::value, &UserType::set, "Get/set value using a property") + .def("__repr__", [](const UserType& u) { return "UserType({})"_s.format(u.value()); }); + + py::class_<IncType, UserType>(m, "IncType") + .def(py::init<>()) + .def(py::init<int>()) + .def("__repr__", [](const IncType& u) { return "IncType({})"_s.format(u.value()); }); + + for (const auto& initializer : initializers()) + initializer(m); + + if (!py::hasattr(m, "have_eigen")) + m.attr("have_eigen") = false; +} diff --git a/pybind11/tests/pybind11_tests.h b/pybind11/tests/pybind11_tests.h new file mode 100644 index 0000000000000000000000000000000000000000..4e7278ff455e8dc0b7e91c3ea45db2e3603d92be --- /dev/null +++ b/pybind11/tests/pybind11_tests.h @@ -0,0 +1,88 @@ +#pragma once +#include <pybind11/pybind11.h> + +#if defined(_MSC_VER) && _MSC_VER < 1910 +// We get some really long type names here which causes MSVC 2015 to emit warnings +# pragma warning(disable : 4503) // warning C4503: decorated name length exceeded, name was truncated +#endif + +namespace py = pybind11; +using namespace pybind11::literals; + +class test_initializer +{ + using Initializer = void (*)(py::module&); + +public: + test_initializer(Initializer init); + test_initializer(const char* submodule_name, Initializer init); +}; + +#define TEST_SUBMODULE(name, variable) \ + void test_submodule_##name(py::module&); \ + test_initializer name(#name, test_submodule_##name); \ + void test_submodule_##name(py::module& variable) + + +/// Dummy type which is not exported anywhere -- something to trigger a conversion error +struct UnregisteredType +{}; + +/// A user-defined type which is exported and can be used by any test +class UserType +{ +public: + UserType() = default; + UserType(int i) + : i(i) + {} + + int value() const + { + return i; + } + void set(int set) + { + i = set; + } + +private: + int i = -1; +}; + +/// Like UserType, but increments `value` on copy for quick reference vs. copy tests +class IncType : public UserType +{ +public: + using UserType::UserType; + IncType() = default; + IncType(const IncType& other) + : IncType(other.value() + 1) + {} + IncType(IncType&&) = delete; + IncType& operator=(const IncType&) = delete; + IncType& operator=(IncType&&) = delete; +}; + +/// Custom cast-only type that casts to a string "rvalue" or "lvalue" depending on the cast context. +/// Used to test recursive casters (e.g. std::tuple, stl containers). +struct RValueCaster +{}; +NAMESPACE_BEGIN(pybind11) +NAMESPACE_BEGIN(detail) +template <> +class type_caster<RValueCaster> +{ +public: + PYBIND11_TYPE_CASTER(RValueCaster, _("RValueCaster")); + static handle cast(RValueCaster&&, return_value_policy, handle) + { + return py::str("rvalue").release(); + } + static handle cast(const RValueCaster&, return_value_policy, handle) + { + return py::str("lvalue").release(); + } +}; +NAMESPACE_END(detail) +NAMESPACE_END(pybind11) diff --git a/pybind11/tests/pytest.ini b/pybind11/tests/pytest.ini new file mode 100644 index 0000000000000000000000000000000000000000..f209964a477cc7bb5695c46e188545aaf36919ef --- /dev/null +++ b/pybind11/tests/pytest.ini @@ -0,0 +1,16 @@ +[pytest] +minversion = 3.0 +norecursedirs = test_cmake_build test_embed +addopts = + # show summary of skipped tests + -rs + # capture only Python print and C++ py::print, but not C output (low-level Python errors) + --capture=sys +filterwarnings = + # make warnings into errors but ignore certain third-party extension issues + error + # importing scipy submodules on some version of Python + ignore::ImportWarning + # bogus numpy ABI warning (see numpy/#432) + ignore:.*numpy.dtype size changed.*:RuntimeWarning + ignore:.*numpy.ufunc size changed.*:RuntimeWarning diff --git a/pybind11/tests/test_buffers.cpp b/pybind11/tests/test_buffers.cpp new file mode 100644 index 0000000000000000000000000000000000000000..c129cc8c7e7c360cd2fc0fdde597f0b64b64ad49 --- /dev/null +++ b/pybind11/tests/test_buffers.cpp @@ -0,0 +1,210 @@ +/* + tests/test_buffers.cpp -- supporting Pythons' buffer protocol + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" + +TEST_SUBMODULE(buffers, m) +{ + // test_from_python / test_to_python: + class Matrix + { + public: + Matrix(ssize_t rows, ssize_t cols) + : m_rows(rows) + , m_cols(cols) + { + print_created(this, std::to_string(m_rows) + "x" + std::to_string(m_cols) + " matrix"); + m_data = new float[(size_t)(rows * cols)]; + memset(m_data, 0, sizeof(float) * (size_t)(rows * cols)); + } + + Matrix(const Matrix& s) + : m_rows(s.m_rows) + , m_cols(s.m_cols) + { + print_copy_created(this, std::to_string(m_rows) + "x" + std::to_string(m_cols) + " matrix"); + m_data = new float[(size_t)(m_rows * m_cols)]; + memcpy(m_data, s.m_data, sizeof(float) * (size_t)(m_rows * m_cols)); + } + + Matrix(Matrix&& s) + : m_rows(s.m_rows) + , m_cols(s.m_cols) + , m_data(s.m_data) + { + print_move_created(this); + s.m_rows = 0; + s.m_cols = 0; + s.m_data = nullptr; + } + + ~Matrix() + { + print_destroyed(this, std::to_string(m_rows) + "x" + std::to_string(m_cols) + " matrix"); + delete[] m_data; + } + + Matrix& operator=(const Matrix& s) + { + print_copy_assigned(this, std::to_string(m_rows) + "x" + std::to_string(m_cols) + " matrix"); + delete[] m_data; + m_rows = s.m_rows; + m_cols = s.m_cols; + m_data = new float[(size_t)(m_rows * m_cols)]; + memcpy(m_data, s.m_data, sizeof(float) * (size_t)(m_rows * m_cols)); + return *this; + } + + Matrix& operator=(Matrix&& s) + { + print_move_assigned(this, std::to_string(m_rows) + "x" + std::to_string(m_cols) + " matrix"); + if (&s != this) { + delete[] m_data; + m_rows = s.m_rows; + m_cols = s.m_cols; + m_data = s.m_data; + s.m_rows = 0; + s.m_cols = 0; + s.m_data = nullptr; + } + return *this; + } + + float operator()(ssize_t i, ssize_t j) const + { + return m_data[(size_t)(i * m_cols + j)]; + } + + float& operator()(ssize_t i, ssize_t j) + { + return m_data[(size_t)(i * m_cols + j)]; + } + + float* data() + { + return m_data; + } + + ssize_t rows() const + { + return m_rows; + } + ssize_t cols() const + { + return m_cols; + } + + private: + ssize_t m_rows; + ssize_t m_cols; + float* m_data; + }; + py::class_<Matrix>(m, "Matrix", py::buffer_protocol()) + .def(py::init<ssize_t, ssize_t>()) + /// Construct from a buffer + .def(py::init([](py::buffer b) { + py::buffer_info info = b.request(); + if (info.format != py::format_descriptor<float>::format() || info.ndim != 2) + throw std::runtime_error("Incompatible buffer format!"); + + auto v = new Matrix(info.shape[0], info.shape[1]); + memcpy(v->data(), info.ptr, sizeof(float) * (size_t)(v->rows() * v->cols())); + return v; + })) + + .def("rows", &Matrix::rows) + .def("cols", &Matrix::cols) + + /// Bare bones interface + .def("__getitem__", + [](const Matrix& m, std::pair<ssize_t, ssize_t> i) { + if (i.first >= m.rows() || i.second >= m.cols()) + throw py::index_error(); + return m(i.first, i.second); + }) + .def("__setitem__", + [](Matrix& m, std::pair<ssize_t, ssize_t> i, float v) { + if (i.first >= m.rows() || i.second >= m.cols()) + throw py::index_error(); + m(i.first, i.second) = v; + }) + /// Provide buffer access + .def_buffer([](Matrix& m) -> py::buffer_info { + return py::buffer_info(m.data(), /* Pointer to buffer */ + {m.rows(), m.cols()}, /* Buffer dimensions */ + {sizeof(float) * size_t(m.cols()), /* Strides (in bytes) for each index */ + sizeof(float)}); + }); + + + // test_inherited_protocol + class SquareMatrix : public Matrix + { + public: + SquareMatrix(ssize_t n) + : Matrix(n, n) + {} + }; + // Derived classes inherit the buffer protocol and the buffer access function + py::class_<SquareMatrix, Matrix>(m, "SquareMatrix").def(py::init<ssize_t>()); + + + // test_pointer_to_member_fn + // Tests that passing a pointer to member to the base class works in + // the derived class. + struct Buffer + { + int32_t value = 0; + + py::buffer_info get_buffer_info() + { + return py::buffer_info(&value, sizeof(value), py::format_descriptor<int32_t>::format(), 1); + } + }; + py::class_<Buffer>(m, "Buffer", py::buffer_protocol()) + .def(py::init<>()) + .def_readwrite("value", &Buffer::value) + .def_buffer(&Buffer::get_buffer_info); + + + class ConstBuffer + { + std::unique_ptr<int32_t> value; + + public: + int32_t get_value() const + { + return *value; + } + void set_value(int32_t v) + { + *value = v; + } + + py::buffer_info get_buffer_info() const + { + return py::buffer_info(value.get(), sizeof(*value), py::format_descriptor<int32_t>::format(), 1); + } + + ConstBuffer() + : value(new int32_t{0}){}; + }; + py::class_<ConstBuffer>(m, "ConstBuffer", py::buffer_protocol()) + .def(py::init<>()) + .def_property("value", &ConstBuffer::get_value, &ConstBuffer::set_value) + .def_buffer(&ConstBuffer::get_buffer_info); + + struct DerivedBuffer : public Buffer + {}; + py::class_<DerivedBuffer>(m, "DerivedBuffer", py::buffer_protocol()) + .def(py::init<>()) + .def_readwrite("value", (int32_t DerivedBuffer::*)&DerivedBuffer::value) + .def_buffer(&DerivedBuffer::get_buffer_info); +} diff --git a/pybind11/tests/test_buffers.py b/pybind11/tests/test_buffers.py new file mode 100644 index 0000000000000000000000000000000000000000..9352ecf526a5201082203b630b68bf76168c4d3f --- /dev/null +++ b/pybind11/tests/test_buffers.py @@ -0,0 +1,87 @@ +import struct +import pytest +from pybind11_tests import buffers as m +from pybind11_tests import ConstructorStats + +pytestmark = pytest.requires_numpy + +with pytest.suppress(ImportError): + import numpy as np + + +def test_from_python(): + with pytest.raises(RuntimeError) as excinfo: + m.Matrix(np.array([1, 2, 3])) # trying to assign a 1D array + assert str(excinfo.value) == "Incompatible buffer format!" + + m3 = np.array([[1, 2, 3], [4, 5, 6]]).astype(np.float32) + m4 = m.Matrix(m3) + + for i in range(m4.rows()): + for j in range(m4.cols()): + assert m3[i, j] == m4[i, j] + + cstats = ConstructorStats.get(m.Matrix) + assert cstats.alive() == 1 + del m3, m4 + assert cstats.alive() == 0 + assert cstats.values() == ["2x3 matrix"] + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Don't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + +# PyPy: Memory leak in the "np.array(m, copy=False)" call +# https://bitbucket.org/pypy/pypy/issues/2444 +@pytest.unsupported_on_pypy +def test_to_python(): + mat = m.Matrix(5, 4) + assert memoryview(mat).shape == (5, 4) + + assert mat[2, 3] == 0 + mat[2, 3] = 4.0 + mat[3, 2] = 7.0 + assert mat[2, 3] == 4 + assert mat[3, 2] == 7 + assert struct.unpack_from('f', mat, (3 * 4 + 2) * 4) == (7,) + assert struct.unpack_from('f', mat, (2 * 4 + 3) * 4) == (4,) + + mat2 = np.array(mat, copy=False) + assert mat2.shape == (5, 4) + assert abs(mat2).sum() == 11 + assert mat2[2, 3] == 4 and mat2[3, 2] == 7 + mat2[2, 3] = 5 + assert mat2[2, 3] == 5 + + cstats = ConstructorStats.get(m.Matrix) + assert cstats.alive() == 1 + del mat + pytest.gc_collect() + assert cstats.alive() == 1 + del mat2 # holds a mat reference + pytest.gc_collect() + assert cstats.alive() == 0 + assert cstats.values() == ["5x4 matrix"] + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Don't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + +@pytest.unsupported_on_pypy +def test_inherited_protocol(): + """SquareMatrix is derived from Matrix and inherits the buffer protocol""" + + matrix = m.SquareMatrix(5) + assert memoryview(matrix).shape == (5, 5) + assert np.asarray(matrix).shape == (5, 5) + + +@pytest.unsupported_on_pypy +def test_pointer_to_member_fn(): + for cls in [m.Buffer, m.ConstBuffer, m.DerivedBuffer]: + buf = cls() + buf.value = 0x12345678 + value = struct.unpack('i', bytearray(buf))[0] + assert value == 0x12345678 diff --git a/pybind11/tests/test_builtin_casters.cpp b/pybind11/tests/test_builtin_casters.cpp new file mode 100644 index 0000000000000000000000000000000000000000..17486f9a18d58064b537b384940495b994784040 --- /dev/null +++ b/pybind11/tests/test_builtin_casters.cpp @@ -0,0 +1,202 @@ +/* + tests/test_builtin_casters.cpp -- Casters available without any additional headers + + Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include <pybind11/complex.h> + +#if defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable : 4127) // warning C4127: Conditional expression is constant +#endif + +TEST_SUBMODULE(builtin_casters, m) +{ + // test_simple_string + m.def("string_roundtrip", [](const char* s) { return s; }); + + // test_unicode_conversion + // Some test characters in utf16 and utf32 encodings. The last one (the ð€) contains a null byte + char32_t a32 = 0x61 /*a*/, z32 = 0x7a /*z*/, ib32 = 0x203d /*‽*/, cake32 = 0x1f382 /*🎂*/, mathbfA32 = 0x1d400 /*ð€*/; + char16_t b16 = 0x62 /*b*/, z16 = 0x7a, ib16 = 0x203d, cake16_1 = 0xd83c, cake16_2 = 0xdf82, mathbfA16_1 = 0xd835, + mathbfA16_2 = 0xdc00; + std::wstring wstr; + wstr.push_back(0x61); // a + wstr.push_back(0x2e18); // ⸘ + if (sizeof(wchar_t) == 2) { + wstr.push_back(mathbfA16_1); + wstr.push_back(mathbfA16_2); + } // ð€, utf16 + else { + wstr.push_back((wchar_t)mathbfA32); + } // ð€, utf32 + wstr.push_back(0x7a); // z + + m.def("good_utf8_string", []() { return std::string(u8"Say utf8\u203d \U0001f382 \U0001d400"); }); // Say utf8‽ 🎂 ð€ + m.def("good_utf16_string", [=]() { + return std::u16string({b16, ib16, cake16_1, cake16_2, mathbfA16_1, mathbfA16_2, z16}); + }); // b‽🎂ð€z + m.def("good_utf32_string", [=]() { return std::u32string({a32, mathbfA32, cake32, ib32, z32}); }); // að€ðŸŽ‚‽z + m.def("good_wchar_string", [=]() { return wstr; }); // a‽ð€z + m.def("bad_utf8_string", []() { + return std::string("abc\xd0" + "def"); + }); + m.def("bad_utf16_string", [=]() { return std::u16string({b16, char16_t(0xd800), z16}); }); + // Under Python 2.7, invalid unicode UTF-32 characters don't appear to trigger UnicodeDecodeError + if (PY_MAJOR_VERSION >= 3) + m.def("bad_utf32_string", [=]() { return std::u32string({a32, char32_t(0xd800), z32}); }); + if (PY_MAJOR_VERSION >= 3 || sizeof(wchar_t) == 2) + m.def("bad_wchar_string", [=]() { return std::wstring({wchar_t(0x61), wchar_t(0xd800)}); }); + m.def("u8_Z", []() -> char { return 'Z'; }); + m.def("u8_eacute", []() -> char { return '\xe9'; }); + m.def("u16_ibang", [=]() -> char16_t { return ib16; }); + m.def("u32_mathbfA", [=]() -> char32_t { return mathbfA32; }); + m.def("wchar_heart", []() -> wchar_t { return 0x2665; }); + + // test_single_char_arguments + m.attr("wchar_size") = py::cast(sizeof(wchar_t)); + m.def("ord_char", [](char c) -> int { return static_cast<unsigned char>(c); }); + m.def("ord_char_lv", [](char& c) -> int { return static_cast<unsigned char>(c); }); + m.def("ord_char16", [](char16_t c) -> uint16_t { return c; }); + m.def("ord_char16_lv", [](char16_t& c) -> uint16_t { return c; }); + m.def("ord_char32", [](char32_t c) -> uint32_t { return c; }); + m.def("ord_wchar", [](wchar_t c) -> int { return c; }); + + // test_bytes_to_string + m.def("strlen", [](char* s) { return strlen(s); }); + m.def("string_length", [](std::string s) { return s.length(); }); + + // test_string_view +#ifdef PYBIND11_HAS_STRING_VIEW + m.attr("has_string_view") = true; + m.def("string_view_print", [](std::string_view s) { py::print(s, s.size()); }); + m.def("string_view16_print", [](std::u16string_view s) { py::print(s, s.size()); }); + m.def("string_view32_print", [](std::u32string_view s) { py::print(s, s.size()); }); + m.def("string_view_chars", [](std::string_view s) { + py::list l; + for (auto c : s) + l.append((std::uint8_t)c); + return l; + }); + m.def("string_view16_chars", [](std::u16string_view s) { + py::list l; + for (auto c : s) + l.append((int)c); + return l; + }); + m.def("string_view32_chars", [](std::u32string_view s) { + py::list l; + for (auto c : s) + l.append((int)c); + return l; + }); + m.def("string_view_return", []() { return std::string_view(u8"utf8 secret \U0001f382"); }); + m.def("string_view16_return", []() { return std::u16string_view(u"utf16 secret \U0001f382"); }); + m.def("string_view32_return", []() { return std::u32string_view(U"utf32 secret \U0001f382"); }); +#endif + + // test_integer_casting + m.def("i32_str", [](std::int32_t v) { return std::to_string(v); }); + m.def("u32_str", [](std::uint32_t v) { return std::to_string(v); }); + m.def("i64_str", [](std::int64_t v) { return std::to_string(v); }); + m.def("u64_str", [](std::uint64_t v) { return std::to_string(v); }); + + // test_tuple + m.def("pair_passthrough", + [](std::pair<bool, std::string> input) { return std::make_pair(input.second, input.first); }, + "Return a pair in reversed order"); + m.def("tuple_passthrough", + [](std::tuple<bool, std::string, int> input) { + return std::make_tuple(std::get<2>(input), std::get<1>(input), std::get<0>(input)); + }, + "Return a triple in reversed order"); + m.def("empty_tuple", []() { return std::tuple<>(); }); + static std::pair<RValueCaster, RValueCaster> lvpair; + static std::tuple<RValueCaster, RValueCaster, RValueCaster> lvtuple; + static std::pair<RValueCaster, std::tuple<RValueCaster, std::pair<RValueCaster, RValueCaster>>> lvnested; + m.def("rvalue_pair", []() { return std::make_pair(RValueCaster{}, RValueCaster{}); }); + m.def("lvalue_pair", []() -> const decltype(lvpair)& { return lvpair; }); + m.def("rvalue_tuple", []() { return std::make_tuple(RValueCaster{}, RValueCaster{}, RValueCaster{}); }); + m.def("lvalue_tuple", []() -> const decltype(lvtuple)& { return lvtuple; }); + m.def("rvalue_nested", []() { + return std::make_pair(RValueCaster{}, + std::make_tuple(RValueCaster{}, std::make_pair(RValueCaster{}, RValueCaster{}))); + }); + m.def("lvalue_nested", []() -> const decltype(lvnested)& { return lvnested; }); + + // test_builtins_cast_return_none + m.def("return_none_string", []() -> std::string* { return nullptr; }); + m.def("return_none_char", []() -> const char* { return nullptr; }); + m.def("return_none_bool", []() -> bool* { return nullptr; }); + m.def("return_none_int", []() -> int* { return nullptr; }); + m.def("return_none_float", []() -> float* { return nullptr; }); + + // test_none_deferred + m.def("defer_none_cstring", [](char*) { return false; }); + m.def("defer_none_cstring", [](py::none) { return true; }); + m.def("defer_none_custom", [](UserType*) { return false; }); + m.def("defer_none_custom", [](py::none) { return true; }); + m.def("nodefer_none_void", [](void*) { return true; }); + m.def("nodefer_none_void", [](py::none) { return false; }); + + // test_void_caster + m.def("load_nullptr_t", [](std::nullptr_t) {}); // not useful, but it should still compile + m.def("cast_nullptr_t", []() { return std::nullptr_t{}; }); + + // test_bool_caster + m.def("bool_passthrough", [](bool arg) { return arg; }); + m.def("bool_passthrough_noconvert", [](bool arg) { return arg; }, py::arg().noconvert()); + + // test_reference_wrapper + m.def("refwrap_builtin", [](std::reference_wrapper<int> p) { return 10 * p.get(); }); + m.def("refwrap_usertype", [](std::reference_wrapper<UserType> p) { return p.get().value(); }); + // Not currently supported (std::pair caster has return-by-value cast operator); + // triggers static_assert failure. + // m.def("refwrap_pair", [](std::reference_wrapper<std::pair<int, int>>) { }); + + m.def("refwrap_list", + [](bool copy) { + static IncType x1(1), x2(2); + py::list l; + for (auto& f : {std::ref(x1), std::ref(x2)}) { + l.append(py::cast(f, copy ? py::return_value_policy::copy : py::return_value_policy::reference)); + } + return l; + }, + "copy"_a); + + m.def("refwrap_iiw", [](const IncType& w) { return w.value(); }); + m.def("refwrap_call_iiw", [](IncType& w, py::function f) { + py::list l; + l.append(f(std::ref(w))); + l.append(f(std::cref(w))); + IncType x(w.value()); + l.append(f(std::ref(x))); + IncType y(w.value()); + auto r3 = std::ref(y); + l.append(f(r3)); + return l; + }); + + // test_complex + m.def("complex_cast", [](float x) { return "{}"_s.format(x); }); + m.def("complex_cast", [](std::complex<float> x) { return "({}, {})"_s.format(x.real(), x.imag()); }); + + // test int vs. long (Python 2) + m.def("int_cast", []() { return (int)42; }); + m.def("long_cast", []() { return (long)42; }); + m.def("longlong_cast", []() { return ULLONG_MAX; }); + + /// test void* cast operator + m.def("test_void_caster", []() -> bool { + void* v = (void*)0xabcd; + py::object o = py::cast(v); + return py::cast<void*>(o) == v; + }); +} diff --git a/pybind11/tests/test_builtin_casters.py b/pybind11/tests/test_builtin_casters.py new file mode 100644 index 0000000000000000000000000000000000000000..91725256979c7e84c6d3d53ce774d734f26f6a3b --- /dev/null +++ b/pybind11/tests/test_builtin_casters.py @@ -0,0 +1,345 @@ +# Python < 3 needs this: coding=utf-8 +import pytest + +from pybind11_tests import builtin_casters as m +from pybind11_tests import UserType, IncType + + +def test_simple_string(): + assert m.string_roundtrip("const char *") == "const char *" + + +def test_unicode_conversion(): + """Tests unicode conversion and error reporting.""" + assert m.good_utf8_string() == u"Say utf8‽ 🎂 ð€" + assert m.good_utf16_string() == u"b‽🎂ð€z" + assert m.good_utf32_string() == u"að€ðŸŽ‚‽z" + assert m.good_wchar_string() == u"a⸘ð€z" + + with pytest.raises(UnicodeDecodeError): + m.bad_utf8_string() + + with pytest.raises(UnicodeDecodeError): + m.bad_utf16_string() + + # These are provided only if they actually fail (they don't when 32-bit and under Python 2.7) + if hasattr(m, "bad_utf32_string"): + with pytest.raises(UnicodeDecodeError): + m.bad_utf32_string() + if hasattr(m, "bad_wchar_string"): + with pytest.raises(UnicodeDecodeError): + m.bad_wchar_string() + + assert m.u8_Z() == 'Z' + assert m.u8_eacute() == u'é' + assert m.u16_ibang() == u'‽' + assert m.u32_mathbfA() == u'ð€' + assert m.wchar_heart() == u'♥' + + +def test_single_char_arguments(): + """Tests failures for passing invalid inputs to char-accepting functions""" + + def toobig_message(r): + return "Character code point not in range({0:#x})".format(r) + + toolong_message = "Expected a character, but multi-character string found" + + assert m.ord_char(u'a') == 0x61 # simple ASCII + assert m.ord_char_lv(u'b') == 0x62 + assert m.ord_char(u'é') == 0xE9 # requires 2 bytes in utf-8, but can be stuffed in a char + with pytest.raises(ValueError) as excinfo: + assert m.ord_char(u'Ä€') == 0x100 # requires 2 bytes, doesn't fit in a char + assert str(excinfo.value) == toobig_message(0x100) + with pytest.raises(ValueError) as excinfo: + assert m.ord_char(u'ab') + assert str(excinfo.value) == toolong_message + + assert m.ord_char16(u'a') == 0x61 + assert m.ord_char16(u'é') == 0xE9 + assert m.ord_char16_lv(u'ê') == 0xEA + assert m.ord_char16(u'Ä€') == 0x100 + assert m.ord_char16(u'‽') == 0x203d + assert m.ord_char16(u'♥') == 0x2665 + assert m.ord_char16_lv(u'♡') == 0x2661 + with pytest.raises(ValueError) as excinfo: + assert m.ord_char16(u'🎂') == 0x1F382 # requires surrogate pair + assert str(excinfo.value) == toobig_message(0x10000) + with pytest.raises(ValueError) as excinfo: + assert m.ord_char16(u'aa') + assert str(excinfo.value) == toolong_message + + assert m.ord_char32(u'a') == 0x61 + assert m.ord_char32(u'é') == 0xE9 + assert m.ord_char32(u'Ä€') == 0x100 + assert m.ord_char32(u'‽') == 0x203d + assert m.ord_char32(u'♥') == 0x2665 + assert m.ord_char32(u'🎂') == 0x1F382 + with pytest.raises(ValueError) as excinfo: + assert m.ord_char32(u'aa') + assert str(excinfo.value) == toolong_message + + assert m.ord_wchar(u'a') == 0x61 + assert m.ord_wchar(u'é') == 0xE9 + assert m.ord_wchar(u'Ä€') == 0x100 + assert m.ord_wchar(u'‽') == 0x203d + assert m.ord_wchar(u'♥') == 0x2665 + if m.wchar_size == 2: + with pytest.raises(ValueError) as excinfo: + assert m.ord_wchar(u'🎂') == 0x1F382 # requires surrogate pair + assert str(excinfo.value) == toobig_message(0x10000) + else: + assert m.ord_wchar(u'🎂') == 0x1F382 + with pytest.raises(ValueError) as excinfo: + assert m.ord_wchar(u'aa') + assert str(excinfo.value) == toolong_message + + +def test_bytes_to_string(): + """Tests the ability to pass bytes to C++ string-accepting functions. Note that this is + one-way: the only way to return bytes to Python is via the pybind11::bytes class.""" + # Issue #816 + import sys + byte = bytes if sys.version_info[0] < 3 else str + + assert m.strlen(byte("hi")) == 2 + assert m.string_length(byte("world")) == 5 + assert m.string_length(byte("a\x00b")) == 3 + assert m.strlen(byte("a\x00b")) == 1 # C-string limitation + + # passing in a utf8 encoded string should work + assert m.string_length(u'💩'.encode("utf8")) == 4 + + +@pytest.mark.skipif(not hasattr(m, "has_string_view"), reason="no <string_view>") +def test_string_view(capture): + """Tests support for C++17 string_view arguments and return values""" + assert m.string_view_chars("Hi") == [72, 105] + assert m.string_view_chars("Hi 🎂") == [72, 105, 32, 0xf0, 0x9f, 0x8e, 0x82] + assert m.string_view16_chars("Hi 🎂") == [72, 105, 32, 0xd83c, 0xdf82] + assert m.string_view32_chars("Hi 🎂") == [72, 105, 32, 127874] + + assert m.string_view_return() == "utf8 secret 🎂" + assert m.string_view16_return() == "utf16 secret 🎂" + assert m.string_view32_return() == "utf32 secret 🎂" + + with capture: + m.string_view_print("Hi") + m.string_view_print("utf8 🎂") + m.string_view16_print("utf16 🎂") + m.string_view32_print("utf32 🎂") + assert capture == """ + Hi 2 + utf8 🎂 9 + utf16 🎂 8 + utf32 🎂 7 + """ + + with capture: + m.string_view_print("Hi, ascii") + m.string_view_print("Hi, utf8 🎂") + m.string_view16_print("Hi, utf16 🎂") + m.string_view32_print("Hi, utf32 🎂") + assert capture == """ + Hi, ascii 9 + Hi, utf8 🎂 13 + Hi, utf16 🎂 12 + Hi, utf32 🎂 11 + """ + + +def test_integer_casting(): + """Issue #929 - out-of-range integer values shouldn't be accepted""" + import sys + assert m.i32_str(-1) == "-1" + assert m.i64_str(-1) == "-1" + assert m.i32_str(2000000000) == "2000000000" + assert m.u32_str(2000000000) == "2000000000" + if sys.version_info < (3,): + assert m.i32_str(long(-1)) == "-1" # noqa: F821 undefined name 'long' + assert m.i64_str(long(-1)) == "-1" # noqa: F821 undefined name 'long' + assert m.i64_str(long(-999999999999)) == "-999999999999" # noqa: F821 undefined name + assert m.u64_str(long(999999999999)) == "999999999999" # noqa: F821 undefined name 'long' + else: + assert m.i64_str(-999999999999) == "-999999999999" + assert m.u64_str(999999999999) == "999999999999" + + with pytest.raises(TypeError) as excinfo: + m.u32_str(-1) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.u64_str(-1) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.i32_str(-3000000000) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.i32_str(3000000000) + assert "incompatible function arguments" in str(excinfo.value) + + if sys.version_info < (3,): + with pytest.raises(TypeError) as excinfo: + m.u32_str(long(-1)) # noqa: F821 undefined name 'long' + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.u64_str(long(-1)) # noqa: F821 undefined name 'long' + assert "incompatible function arguments" in str(excinfo.value) + + +def test_tuple(doc): + """std::pair <-> tuple & std::tuple <-> tuple""" + assert m.pair_passthrough((True, "test")) == ("test", True) + assert m.tuple_passthrough((True, "test", 5)) == (5, "test", True) + # Any sequence can be cast to a std::pair or std::tuple + assert m.pair_passthrough([True, "test"]) == ("test", True) + assert m.tuple_passthrough([True, "test", 5]) == (5, "test", True) + assert m.empty_tuple() == () + + assert doc(m.pair_passthrough) == """ + pair_passthrough(arg0: Tuple[bool, str]) -> Tuple[str, bool] + + Return a pair in reversed order + """ + assert doc(m.tuple_passthrough) == """ + tuple_passthrough(arg0: Tuple[bool, str, int]) -> Tuple[int, str, bool] + + Return a triple in reversed order + """ + + assert m.rvalue_pair() == ("rvalue", "rvalue") + assert m.lvalue_pair() == ("lvalue", "lvalue") + assert m.rvalue_tuple() == ("rvalue", "rvalue", "rvalue") + assert m.lvalue_tuple() == ("lvalue", "lvalue", "lvalue") + assert m.rvalue_nested() == ("rvalue", ("rvalue", ("rvalue", "rvalue"))) + assert m.lvalue_nested() == ("lvalue", ("lvalue", ("lvalue", "lvalue"))) + + +def test_builtins_cast_return_none(): + """Casters produced with PYBIND11_TYPE_CASTER() should convert nullptr to None""" + assert m.return_none_string() is None + assert m.return_none_char() is None + assert m.return_none_bool() is None + assert m.return_none_int() is None + assert m.return_none_float() is None + + +def test_none_deferred(): + """None passed as various argument types should defer to other overloads""" + assert not m.defer_none_cstring("abc") + assert m.defer_none_cstring(None) + assert not m.defer_none_custom(UserType()) + assert m.defer_none_custom(None) + assert m.nodefer_none_void(None) + + +def test_void_caster(): + assert m.load_nullptr_t(None) is None + assert m.cast_nullptr_t() is None + + +def test_reference_wrapper(): + """std::reference_wrapper for builtin and user types""" + assert m.refwrap_builtin(42) == 420 + assert m.refwrap_usertype(UserType(42)) == 42 + + with pytest.raises(TypeError) as excinfo: + m.refwrap_builtin(None) + assert "incompatible function arguments" in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + m.refwrap_usertype(None) + assert "incompatible function arguments" in str(excinfo.value) + + a1 = m.refwrap_list(copy=True) + a2 = m.refwrap_list(copy=True) + assert [x.value for x in a1] == [2, 3] + assert [x.value for x in a2] == [2, 3] + assert not a1[0] is a2[0] and not a1[1] is a2[1] + + b1 = m.refwrap_list(copy=False) + b2 = m.refwrap_list(copy=False) + assert [x.value for x in b1] == [1, 2] + assert [x.value for x in b2] == [1, 2] + assert b1[0] is b2[0] and b1[1] is b2[1] + + assert m.refwrap_iiw(IncType(5)) == 5 + assert m.refwrap_call_iiw(IncType(10), m.refwrap_iiw) == [10, 10, 10, 10] + + +def test_complex_cast(): + """std::complex casts""" + assert m.complex_cast(1) == "1.0" + assert m.complex_cast(2j) == "(0.0, 2.0)" + + +def test_bool_caster(): + """Test bool caster implicit conversions.""" + convert, noconvert = m.bool_passthrough, m.bool_passthrough_noconvert + + def require_implicit(v): + pytest.raises(TypeError, noconvert, v) + + def cant_convert(v): + pytest.raises(TypeError, convert, v) + + # straight up bool + assert convert(True) is True + assert convert(False) is False + assert noconvert(True) is True + assert noconvert(False) is False + + # None requires implicit conversion + require_implicit(None) + assert convert(None) is False + + class A(object): + + def __init__(self, x): + self.x = x + + def __nonzero__(self): + return self.x + + def __bool__(self): + return self.x + + class B(object): + pass + + # Arbitrary objects are not accepted + cant_convert(object()) + cant_convert(B()) + + # Objects with __nonzero__ / __bool__ defined can be converted + require_implicit(A(True)) + assert convert(A(True)) is True + assert convert(A(False)) is False + + +@pytest.requires_numpy +def test_numpy_bool(): + import numpy as np + convert, noconvert = m.bool_passthrough, m.bool_passthrough_noconvert + + # np.bool_ is not considered implicit + assert convert(np.bool_(True)) is True + assert convert(np.bool_(False)) is False + assert noconvert(np.bool_(True)) is True + assert noconvert(np.bool_(False)) is False + + +def test_int_long(): + """In Python 2, a C++ int should return a Python int rather than long + if possible: longs are not always accepted where ints are used (such + as the argument to sys.exit()). A C++ long long is always a Python + long.""" + + import sys + must_be_long = type(getattr(sys, 'maxint', 1) + 1) + assert isinstance(m.int_cast(), int) + assert isinstance(m.long_cast(), int) + assert isinstance(m.longlong_cast(), must_be_long) + + +def test_void_caster_2(): + assert m.test_void_caster() diff --git a/pybind11/tests/test_call_policies.cpp b/pybind11/tests/test_call_policies.cpp new file mode 100644 index 0000000000000000000000000000000000000000..5cb00f2ca4fc5d04727d26b23c05326a53ee02ce --- /dev/null +++ b/pybind11/tests/test_call_policies.cpp @@ -0,0 +1,140 @@ +/* + tests/test_call_policies.cpp -- keep_alive and call_guard + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +struct CustomGuard +{ + static bool enabled; + + CustomGuard() + { + enabled = true; + } + ~CustomGuard() + { + enabled = false; + } + + static const char* report_status() + { + return enabled ? "guarded" : "unguarded"; + } +}; +bool CustomGuard::enabled = false; + +struct DependentGuard +{ + static bool enabled; + + DependentGuard() + { + enabled = CustomGuard::enabled; + } + ~DependentGuard() + { + enabled = false; + } + + static const char* report_status() + { + return enabled ? "guarded" : "unguarded"; + } +}; +bool DependentGuard::enabled = false; + +TEST_SUBMODULE(call_policies, m) +{ + // Parent/Child are used in: + // test_keep_alive_argument, test_keep_alive_return_value, test_alive_gc_derived, + // test_alive_gc_multi_derived, test_return_none, test_keep_alive_constructor + class Child + { + public: + Child() + { + py::print("Allocating child."); + } + Child(const Child&) = default; + Child(Child&&) = default; + ~Child() + { + py::print("Releasing child."); + } + }; + py::class_<Child>(m, "Child").def(py::init<>()); + + class Parent + { + public: + Parent() + { + py::print("Allocating parent."); + } + ~Parent() + { + py::print("Releasing parent."); + } + void addChild(Child*) {} + Child* returnChild() + { + return new Child(); + } + Child* returnNullChild() + { + return nullptr; + } + }; + py::class_<Parent>(m, "Parent") + .def(py::init<>()) + .def(py::init([](Child*) { return new Parent(); }), py::keep_alive<1, 2>()) + .def("addChild", &Parent::addChild) + .def("addChildKeepAlive", &Parent::addChild, py::keep_alive<1, 2>()) + .def("returnChild", &Parent::returnChild) + .def("returnChildKeepAlive", &Parent::returnChild, py::keep_alive<1, 0>()) + .def("returnNullChildKeepAliveChild", &Parent::returnNullChild, py::keep_alive<1, 0>()) + .def("returnNullChildKeepAliveParent", &Parent::returnNullChild, py::keep_alive<0, 1>()); + +#if !defined(PYPY_VERSION) + // test_alive_gc + class ParentGC : public Parent + { + public: + using Parent::Parent; + }; + py::class_<ParentGC, Parent>(m, "ParentGC", py::dynamic_attr()).def(py::init<>()); +#endif + + // test_call_guard + m.def("unguarded_call", &CustomGuard::report_status); + m.def("guarded_call", &CustomGuard::report_status, py::call_guard<CustomGuard>()); + + m.def("multiple_guards_correct_order", + []() { return CustomGuard::report_status() + std::string(" & ") + DependentGuard::report_status(); }, + py::call_guard<CustomGuard, DependentGuard>()); + + m.def("multiple_guards_wrong_order", + []() { return DependentGuard::report_status() + std::string(" & ") + CustomGuard::report_status(); }, + py::call_guard<DependentGuard, CustomGuard>()); + +#if defined(WITH_THREAD) && !defined(PYPY_VERSION) + // `py::call_guard<py::gil_scoped_release>()` should work in PyPy as well, + // but it's unclear how to test it without `PyGILState_GetThisThreadState`. + auto report_gil_status = []() { + auto is_gil_held = false; + if (auto tstate = py::detail::get_thread_state_unchecked()) + is_gil_held = (tstate == PyGILState_GetThisThreadState()); + + return is_gil_held ? "GIL held" : "GIL released"; + }; + + m.def("with_gil", report_gil_status); + m.def("without_gil", report_gil_status, py::call_guard<py::gil_scoped_release>()); +#endif +} diff --git a/pybind11/tests/test_call_policies.py b/pybind11/tests/test_call_policies.py new file mode 100644 index 0000000000000000000000000000000000000000..e518ac4b0315ee147b641355f92228068f58c56d --- /dev/null +++ b/pybind11/tests/test_call_policies.py @@ -0,0 +1,190 @@ +import pytest +from pybind11_tests import call_policies as m +from pybind11_tests import ConstructorStats + + +def test_keep_alive_argument(capture): + n_inst = ConstructorStats.detail_reg_inst() + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.addChild(m.Child()) + assert ConstructorStats.detail_reg_inst() == n_inst + 1 + assert capture == """ + Allocating child. + Releasing child. + """ + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == "Releasing parent." + + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.addChildKeepAlive(m.Child()) + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + assert capture == "Allocating child." + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + """ + + +def test_keep_alive_return_value(capture): + n_inst = ConstructorStats.detail_reg_inst() + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.returnChild() + assert ConstructorStats.detail_reg_inst() == n_inst + 1 + assert capture == """ + Allocating child. + Releasing child. + """ + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == "Releasing parent." + + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.returnChildKeepAlive() + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + assert capture == "Allocating child." + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + """ + + +# https://bitbucket.org/pypy/pypy/issues/2447 +@pytest.unsupported_on_pypy +def test_alive_gc(capture): + n_inst = ConstructorStats.detail_reg_inst() + p = m.ParentGC() + p.addChildKeepAlive(m.Child()) + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + lst = [p] + lst.append(lst) # creates a circular reference + with capture: + del p, lst + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + """ + + +def test_alive_gc_derived(capture): + + class Derived(m.Parent): + pass + + n_inst = ConstructorStats.detail_reg_inst() + p = Derived() + p.addChildKeepAlive(m.Child()) + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + lst = [p] + lst.append(lst) # creates a circular reference + with capture: + del p, lst + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + """ + + +def test_alive_gc_multi_derived(capture): + + class Derived(m.Parent, m.Child): + + def __init__(self): + m.Parent.__init__(self) + m.Child.__init__(self) + + n_inst = ConstructorStats.detail_reg_inst() + p = Derived() + p.addChildKeepAlive(m.Child()) + # +3 rather than +2 because Derived corresponds to two registered instances + assert ConstructorStats.detail_reg_inst() == n_inst + 3 + lst = [p] + lst.append(lst) # creates a circular reference + with capture: + del p, lst + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + Releasing child. + """ + + +def test_return_none(capture): + n_inst = ConstructorStats.detail_reg_inst() + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.returnNullChildKeepAliveChild() + assert ConstructorStats.detail_reg_inst() == n_inst + 1 + assert capture == "" + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == "Releasing parent." + + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.returnNullChildKeepAliveParent() + assert ConstructorStats.detail_reg_inst() == n_inst + 1 + assert capture == "" + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == "Releasing parent." + + +def test_keep_alive_constructor(capture): + n_inst = ConstructorStats.detail_reg_inst() + + with capture: + p = m.Parent(m.Child()) + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + assert capture == """ + Allocating child. + Allocating parent. + """ + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + """ + + +def test_call_guard(): + assert m.unguarded_call() == "unguarded" + assert m.guarded_call() == "guarded" + + assert m.multiple_guards_correct_order() == "guarded & guarded" + assert m.multiple_guards_wrong_order() == "unguarded & guarded" + + if hasattr(m, "with_gil"): + assert m.with_gil() == "GIL held" + assert m.without_gil() == "GIL released" diff --git a/pybind11/tests/test_callbacks.cpp b/pybind11/tests/test_callbacks.cpp new file mode 100644 index 0000000000000000000000000000000000000000..65fd9c992b1fb10ee87007cf4bd7c92eb07fb87a --- /dev/null +++ b/pybind11/tests/test_callbacks.cpp @@ -0,0 +1,199 @@ +/* + tests/test_callbacks.cpp -- callbacks + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include <pybind11/functional.h> +#include <thread> + + +int dummy_function(int i) +{ + return i + 1; +} + +TEST_SUBMODULE(callbacks, m) +{ + // test_callbacks, test_function_signatures + m.def("test_callback1", [](py::object func) { return func(); }); + m.def("test_callback2", [](py::object func) { return func("Hello", 'x', true, 5); }); + m.def("test_callback3", [](const std::function<int(int)>& func) { return "func(43) = " + std::to_string(func(43)); }); + m.def("test_callback4", []() -> std::function<int(int)> { return [](int i) { return i + 1; }; }); + m.def("test_callback5", []() { return py::cpp_function([](int i) { return i + 1; }, py::arg("number")); }); + + // test_keyword_args_and_generalized_unpacking + m.def("test_tuple_unpacking", [](py::function f) { + auto t1 = py::make_tuple(2, 3); + auto t2 = py::make_tuple(5, 6); + return f("positional", 1, *t1, 4, *t2); + }); + + m.def("test_dict_unpacking", [](py::function f) { + auto d1 = py::dict("key"_a = "value", "a"_a = 1); + auto d2 = py::dict(); + auto d3 = py::dict("b"_a = 2); + return f("positional", 1, **d1, **d2, **d3); + }); + + m.def("test_keyword_args", [](py::function f) { return f("x"_a = 10, "y"_a = 20); }); + + m.def("test_unpacking_and_keywords1", [](py::function f) { + auto args = py::make_tuple(2); + auto kwargs = py::dict("d"_a = 4); + return f(1, *args, "c"_a = 3, **kwargs); + }); + + m.def("test_unpacking_and_keywords2", [](py::function f) { + auto kwargs1 = py::dict("a"_a = 1); + auto kwargs2 = py::dict("c"_a = 3, "d"_a = 4); + return f("positional", + *py::make_tuple(1), + 2, + *py::make_tuple(3, 4), + 5, + "key"_a = "value", + **kwargs1, + "b"_a = 2, + **kwargs2, + "e"_a = 5); + }); + + m.def("test_unpacking_error1", [](py::function f) { + auto kwargs = py::dict("x"_a = 3); + return f("x"_a = 1, "y"_a = 2, **kwargs); // duplicate ** after keyword + }); + + m.def("test_unpacking_error2", [](py::function f) { + auto kwargs = py::dict("x"_a = 3); + return f(**kwargs, "x"_a = 1); // duplicate keyword after ** + }); + + m.def("test_arg_conversion_error1", [](py::function f) { f(234, UnregisteredType(), "kw"_a = 567); }); + + m.def("test_arg_conversion_error2", + [](py::function f) { f(234, "expected_name"_a = UnregisteredType(), "kw"_a = 567); }); + + // test_lambda_closure_cleanup + struct Payload + { + Payload() + { + print_default_created(this); + } + ~Payload() + { + print_destroyed(this); + } + Payload(const Payload&) + { + print_copy_created(this); + } + Payload(Payload&&) + { + print_move_created(this); + } + }; + // Export the payload constructor statistics for testing purposes: + m.def("payload_cstats", &ConstructorStats::get<Payload>); + /* Test cleanup of lambda closure */ + m.def("test_cleanup", []() -> std::function<void(void)> { + Payload p; + + return [p]() { + /* p should be cleaned up when the returned function is garbage collected */ + (void)p; + }; + }); + + // test_cpp_function_roundtrip + /* Test if passing a function pointer from C++ -> Python -> C++ yields the original pointer */ + m.def("dummy_function", &dummy_function); + m.def("dummy_function2", [](int i, int j) { return i + j; }); + m.def("roundtrip", + [](std::function<int(int)> f, bool expect_none = false) { + if (expect_none && f) + throw std::runtime_error("Expected None to be converted to empty std::function"); + return f; + }, + py::arg("f"), + py::arg("expect_none") = false); + m.def("test_dummy_function", [](const std::function<int(int)>& f) -> std::string { + using fn_type = int (*)(int); + auto result = f.target<fn_type>(); + if (!result) { + auto r = f(1); + return "can't convert to function pointer: eval(1) = " + std::to_string(r); + } else if (*result == dummy_function) { + auto r = (*result)(1); + return "matches dummy_function: eval(1) = " + std::to_string(r); + } else { + return "argument does NOT match dummy_function. This should never happen!"; + } + }); + + class AbstractBase + { + public: + virtual unsigned int func() = 0; + }; + m.def("func_accepting_func_accepting_base", [](std::function<double(AbstractBase&)>) {}); + + struct MovableObject + { + bool valid = true; + + MovableObject() = default; + MovableObject(const MovableObject&) = default; + MovableObject& operator=(const MovableObject&) = default; + MovableObject(MovableObject&& o) + : valid(o.valid) + { + o.valid = false; + } + MovableObject& operator=(MovableObject&& o) + { + valid = o.valid; + o.valid = false; + return *this; + } + }; + py::class_<MovableObject>(m, "MovableObject"); + + // test_movable_object + m.def("callback_with_movable", [](std::function<void(MovableObject&)> f) { + auto x = MovableObject(); + f(x); // lvalue reference shouldn't move out object + return x.valid; // must still return `true` + }); + + // test_bound_method_callback + struct CppBoundMethodTest + {}; + py::class_<CppBoundMethodTest>(m, "CppBoundMethodTest") + .def(py::init<>()) + .def("triple", [](CppBoundMethodTest&, int val) { return 3 * val; }); + + // test async Python callbacks + using callback_f = std::function<void(int)>; + m.def("test_async_callback", [](callback_f f, py::list work) { + // make detached thread that calls `f` with piece of work after a little delay + auto start_f = [f](int j) { + auto invoke_f = [f, j] { + std::this_thread::sleep_for(std::chrono::milliseconds(50)); + f(j); + }; + auto t = std::thread(std::move(invoke_f)); + t.detach(); + }; + + // spawn worker threads + for (auto i : work) + start_f(py::cast<int>(i)); + }); +} diff --git a/pybind11/tests/test_callbacks.py b/pybind11/tests/test_callbacks.py new file mode 100644 index 0000000000000000000000000000000000000000..58941b1abe692518325295c4a2e06cf2e2ff0d11 --- /dev/null +++ b/pybind11/tests/test_callbacks.py @@ -0,0 +1,140 @@ +import pytest +from pybind11_tests import callbacks as m +from threading import Thread + + +def test_callbacks(): + from functools import partial + + def func1(): + return "func1" + + def func2(a, b, c, d): + return "func2", a, b, c, d + + def func3(a): + return "func3({})".format(a) + + assert m.test_callback1(func1) == "func1" + assert m.test_callback2(func2) == ("func2", "Hello", "x", True, 5) + assert m.test_callback1(partial(func2, 1, 2, 3, 4)) == ("func2", 1, 2, 3, 4) + assert m.test_callback1(partial(func3, "partial")) == "func3(partial)" + assert m.test_callback3(lambda i: i + 1) == "func(43) = 44" + + f = m.test_callback4() + assert f(43) == 44 + f = m.test_callback5() + assert f(number=43) == 44 + + +def test_bound_method_callback(): + # Bound Python method: + class MyClass: + + def double(self, val): + return 2 * val + + z = MyClass() + assert m.test_callback3(z.double) == "func(43) = 86" + + z = m.CppBoundMethodTest() + assert m.test_callback3(z.triple) == "func(43) = 129" + + +def test_keyword_args_and_generalized_unpacking(): + + def f(*args, **kwargs): + return args, kwargs + + assert m.test_tuple_unpacking(f) == (("positional", 1, 2, 3, 4, 5, 6), {}) + assert m.test_dict_unpacking(f) == (("positional", 1), {"key": "value", "a": 1, "b": 2}) + assert m.test_keyword_args(f) == ((), {"x": 10, "y": 20}) + assert m.test_unpacking_and_keywords1(f) == ((1, 2), {"c": 3, "d": 4}) + assert m.test_unpacking_and_keywords2(f) == (("positional", 1, 2, 3, 4, 5), { + "key": "value", + "a": 1, + "b": 2, + "c": 3, + "d": 4, + "e": 5 + }) + + with pytest.raises(TypeError) as excinfo: + m.test_unpacking_error1(f) + assert "Got multiple values for keyword argument" in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + m.test_unpacking_error2(f) + assert "Got multiple values for keyword argument" in str(excinfo.value) + + with pytest.raises(RuntimeError) as excinfo: + m.test_arg_conversion_error1(f) + assert "Unable to convert call argument" in str(excinfo.value) + + with pytest.raises(RuntimeError) as excinfo: + m.test_arg_conversion_error2(f) + assert "Unable to convert call argument" in str(excinfo.value) + + +def test_lambda_closure_cleanup(): + m.test_cleanup() + cstats = m.payload_cstats() + assert cstats.alive() == 0 + assert cstats.copy_constructions == 1 + assert cstats.move_constructions >= 1 + + +def test_cpp_function_roundtrip(): + """Test if passing a function pointer from C++ -> Python -> C++ yields the original pointer""" + + assert m.test_dummy_function(m.dummy_function) == "matches dummy_function: eval(1) = 2" + assert (m.test_dummy_function(m.roundtrip(m.dummy_function)) == "matches dummy_function: eval(1) = 2") + assert m.roundtrip(None, expect_none=True) is None + assert (m.test_dummy_function(lambda x: x + 2) == "can't convert to function pointer: eval(1) = 3") + + with pytest.raises(TypeError) as excinfo: + m.test_dummy_function(m.dummy_function2) + assert "incompatible function arguments" in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + m.test_dummy_function(lambda x, y: x + y) + assert any( + s in str(excinfo.value) for s in ("missing 1 required positional argument", "takes exactly 2 arguments")) + + +def test_function_signatures(doc): + assert doc(m.test_callback3) == "test_callback3(arg0: Callable[[int], int]) -> str" + assert doc(m.test_callback4) == "test_callback4() -> Callable[[int], int]" + + +def test_movable_object(): + assert m.callback_with_movable(lambda _: None) is True + + +def test_async_callbacks(): + # serves as state for async callback + class Item: + + def __init__(self, value): + self.value = value + + res = [] + + # generate stateful lambda that will store result in `res` + def gen_f(): + s = Item(3) + return lambda j: res.append(s.value + j) + + # do some work async + work = [1, 2, 3, 4] + m.test_async_callback(gen_f(), work) + # wait until work is done + from time import sleep + sleep(0.5) + assert sum(res) == sum([x + 3 for x in work]) + + +def test_async_async_callbacks(): + t = Thread(target=test_async_callbacks) + t.start() + t.join() diff --git a/pybind11/tests/test_chrono.cpp b/pybind11/tests/test_chrono.cpp new file mode 100644 index 0000000000000000000000000000000000000000..ad501098ea889e73b8b5a9760259652c59fd63f7 --- /dev/null +++ b/pybind11/tests/test_chrono.cpp @@ -0,0 +1,53 @@ +/* + tests/test_chrono.cpp -- test conversions to/from std::chrono types + + Copyright (c) 2016 Trent Houliston <trent@houliston.me> and + Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include <pybind11/chrono.h> + +TEST_SUBMODULE(chrono, m) +{ + using system_time = std::chrono::system_clock::time_point; + using steady_time = std::chrono::steady_clock::time_point; + + using timespan = std::chrono::duration<int64_t, std::nano>; + using timestamp = std::chrono::time_point<std::chrono::system_clock, timespan>; + + // test_chrono_system_clock + // Return the current time off the wall clock + m.def("test_chrono1", []() { return std::chrono::system_clock::now(); }); + + // test_chrono_system_clock_roundtrip + // Round trip the passed in system clock time + m.def("test_chrono2", [](system_time t) { return t; }); + + // test_chrono_duration_roundtrip + // Round trip the passed in duration + m.def("test_chrono3", [](std::chrono::system_clock::duration d) { return d; }); + + // test_chrono_duration_subtraction_equivalence + // Difference between two passed in time_points + m.def("test_chrono4", [](system_time a, system_time b) { return a - b; }); + + // test_chrono_steady_clock + // Return the current time off the steady_clock + m.def("test_chrono5", []() { return std::chrono::steady_clock::now(); }); + + // test_chrono_steady_clock_roundtrip + // Round trip a steady clock timepoint + m.def("test_chrono6", [](steady_time t) { return t; }); + + // test_floating_point_duration + // Roundtrip a duration in microseconds from a float argument + m.def("test_chrono7", [](std::chrono::microseconds t) { return t; }); + // Float durations (issue #719) + m.def("test_chrono_float_diff", [](std::chrono::duration<float> a, std::chrono::duration<float> b) { return a - b; }); + + m.def("test_nano_timepoint", [](timestamp start, timespan delta) -> timestamp { return start + delta; }); +} diff --git a/pybind11/tests/test_chrono.py b/pybind11/tests/test_chrono.py new file mode 100644 index 0000000000000000000000000000000000000000..3a629c1af4d7fb73cac7a7f7cef139c179d7c223 --- /dev/null +++ b/pybind11/tests/test_chrono.py @@ -0,0 +1,107 @@ +from pybind11_tests import chrono as m +import datetime + + +def test_chrono_system_clock(): + + # Get the time from both c++ and datetime + date1 = m.test_chrono1() + date2 = datetime.datetime.today() + + # The returned value should be a datetime + assert isinstance(date1, datetime.datetime) + + # The numbers should vary by a very small amount (time it took to execute) + diff = abs(date1 - date2) + + # There should never be a days/seconds difference + assert diff.days == 0 + assert diff.seconds == 0 + + # We test that no more than about 0.5 seconds passes here + # This makes sure that the dates created are very close to the same + # but if the testing system is incredibly overloaded this should still pass + assert diff.microseconds < 500000 + + +def test_chrono_system_clock_roundtrip(): + date1 = datetime.datetime.today() + + # Roundtrip the time + date2 = m.test_chrono2(date1) + + # The returned value should be a datetime + assert isinstance(date2, datetime.datetime) + + # They should be identical (no information lost on roundtrip) + diff = abs(date1 - date2) + assert diff.days == 0 + assert diff.seconds == 0 + assert diff.microseconds == 0 + + +def test_chrono_duration_roundtrip(): + + # Get the difference between two times (a timedelta) + date1 = datetime.datetime.today() + date2 = datetime.datetime.today() + diff = date2 - date1 + + # Make sure this is a timedelta + assert isinstance(diff, datetime.timedelta) + + cpp_diff = m.test_chrono3(diff) + + assert cpp_diff.days == diff.days + assert cpp_diff.seconds == diff.seconds + assert cpp_diff.microseconds == diff.microseconds + + +def test_chrono_duration_subtraction_equivalence(): + + date1 = datetime.datetime.today() + date2 = datetime.datetime.today() + + diff = date2 - date1 + cpp_diff = m.test_chrono4(date2, date1) + + assert cpp_diff.days == diff.days + assert cpp_diff.seconds == diff.seconds + assert cpp_diff.microseconds == diff.microseconds + + +def test_chrono_steady_clock(): + time1 = m.test_chrono5() + assert isinstance(time1, datetime.timedelta) + + +def test_chrono_steady_clock_roundtrip(): + time1 = datetime.timedelta(days=10, seconds=10, microseconds=100) + time2 = m.test_chrono6(time1) + + assert isinstance(time2, datetime.timedelta) + + # They should be identical (no information lost on roundtrip) + assert time1.days == time2.days + assert time1.seconds == time2.seconds + assert time1.microseconds == time2.microseconds + + +def test_floating_point_duration(): + # Test using a floating point number in seconds + time = m.test_chrono7(35.525123) + + assert isinstance(time, datetime.timedelta) + + assert time.seconds == 35 + assert 525122 <= time.microseconds <= 525123 + + diff = m.test_chrono_float_diff(43.789012, 1.123456) + assert diff.seconds == 42 + assert 665556 <= diff.microseconds <= 665557 + + +def test_nano_timepoint(): + time = datetime.datetime.now() + time1 = m.test_nano_timepoint(time, datetime.timedelta(seconds=60)) + assert (time1 == time + datetime.timedelta(seconds=60)) diff --git a/pybind11/tests/test_class.cpp b/pybind11/tests/test_class.cpp new file mode 100644 index 0000000000000000000000000000000000000000..37fb9f7e71aec8bd8119e829e7814de839e44261 --- /dev/null +++ b/pybind11/tests/test_class.cpp @@ -0,0 +1,571 @@ +/* + tests/test_class.cpp -- test py::class_ definitions and basic functionality + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include "local_bindings.h" +#include <pybind11/stl.h> + +#if defined(_MSC_VER) +# pragma warning(disable : 4324) // warning C4324: structure was padded due to alignment specifier +#endif + +// test_brace_initialization +struct NoBraceInitialization +{ + NoBraceInitialization(std::vector<int> v) + : vec{std::move(v)} + {} + template <typename T> + NoBraceInitialization(std::initializer_list<T> l) + : vec(l) + {} + + std::vector<int> vec; +}; + +TEST_SUBMODULE(class_, m) +{ + // test_instance + struct NoConstructor + { + NoConstructor() = default; + NoConstructor(const NoConstructor&) = default; + NoConstructor(NoConstructor&&) = default; + static NoConstructor* new_instance() + { + auto* ptr = new NoConstructor(); + print_created(ptr, "via new_instance"); + return ptr; + } + ~NoConstructor() + { + print_destroyed(this); + } + }; + + py::class_<NoConstructor>(m, "NoConstructor") + .def_static("new_instance", &NoConstructor::new_instance, "Return an instance"); + + // test_inheritance + class Pet + { + public: + Pet(const std::string& name, const std::string& species) + : m_name(name) + , m_species(species) + {} + std::string name() const + { + return m_name; + } + std::string species() const + { + return m_species; + } + + private: + std::string m_name; + std::string m_species; + }; + + class Dog : public Pet + { + public: + Dog(const std::string& name) + : Pet(name, "dog") + {} + std::string bark() const + { + return "Woof!"; + } + }; + + class Rabbit : public Pet + { + public: + Rabbit(const std::string& name) + : Pet(name, "parrot") + {} + }; + + class Hamster : public Pet + { + public: + Hamster(const std::string& name) + : Pet(name, "rodent") + {} + }; + + class Chimera : public Pet + { + Chimera() + : Pet("Kimmy", "chimera") + {} + }; + + py::class_<Pet> pet_class(m, "Pet"); + pet_class.def(py::init<std::string, std::string>()).def("name", &Pet::name).def("species", &Pet::species); + + /* One way of declaring a subclass relationship: reference parent's class_ object */ + py::class_<Dog>(m, "Dog", pet_class).def(py::init<std::string>()); + + /* Another way of declaring a subclass relationship: reference parent's C++ type */ + py::class_<Rabbit, Pet>(m, "Rabbit").def(py::init<std::string>()); + + /* And another: list parent in class template arguments */ + py::class_<Hamster, Pet>(m, "Hamster").def(py::init<std::string>()); + + /* Constructors are not inherited by default */ + py::class_<Chimera, Pet>(m, "Chimera"); + + m.def("pet_name_species", [](const Pet& pet) { return pet.name() + " is a " + pet.species(); }); + m.def("dog_bark", [](const Dog& dog) { return dog.bark(); }); + + // test_automatic_upcasting + struct BaseClass + { + BaseClass() = default; + BaseClass(const BaseClass&) = default; + BaseClass(BaseClass&&) = default; + virtual ~BaseClass() {} + }; + struct DerivedClass1 : BaseClass + {}; + struct DerivedClass2 : BaseClass + {}; + + py::class_<BaseClass>(m, "BaseClass").def(py::init<>()); + py::class_<DerivedClass1>(m, "DerivedClass1").def(py::init<>()); + py::class_<DerivedClass2>(m, "DerivedClass2").def(py::init<>()); + + m.def("return_class_1", []() -> BaseClass* { return new DerivedClass1(); }); + m.def("return_class_2", []() -> BaseClass* { return new DerivedClass2(); }); + m.def("return_class_n", [](int n) -> BaseClass* { + if (n == 1) + return new DerivedClass1(); + if (n == 2) + return new DerivedClass2(); + return new BaseClass(); + }); + m.def("return_none", []() -> BaseClass* { return nullptr; }); + + // test_isinstance + m.def("check_instances", [](py::list l) { + return py::make_tuple(py::isinstance<py::tuple>(l[0]), + py::isinstance<py::dict>(l[1]), + py::isinstance<Pet>(l[2]), + py::isinstance<Pet>(l[3]), + py::isinstance<Dog>(l[4]), + py::isinstance<Rabbit>(l[5]), + py::isinstance<UnregisteredType>(l[6])); + }); + + // test_mismatched_holder + struct MismatchBase1 + {}; + struct MismatchDerived1 : MismatchBase1 + {}; + + struct MismatchBase2 + {}; + struct MismatchDerived2 : MismatchBase2 + {}; + + m.def("mismatched_holder_1", []() { + auto mod = py::module::import("__main__"); + py::class_<MismatchBase1, std::shared_ptr<MismatchBase1>>(mod, "MismatchBase1"); + py::class_<MismatchDerived1, MismatchBase1>(mod, "MismatchDerived1"); + }); + m.def("mismatched_holder_2", []() { + auto mod = py::module::import("__main__"); + py::class_<MismatchBase2>(mod, "MismatchBase2"); + py::class_<MismatchDerived2, std::shared_ptr<MismatchDerived2>, MismatchBase2>(mod, "MismatchDerived2"); + }); + + // test_override_static + // #511: problem with inheritance + overwritten def_static + struct MyBase + { + static std::unique_ptr<MyBase> make() + { + return std::unique_ptr<MyBase>(new MyBase()); + } + }; + + struct MyDerived : MyBase + { + static std::unique_ptr<MyDerived> make() + { + return std::unique_ptr<MyDerived>(new MyDerived()); + } + }; + + py::class_<MyBase>(m, "MyBase").def_static("make", &MyBase::make); + + py::class_<MyDerived, MyBase>(m, "MyDerived") + .def_static("make", &MyDerived::make) + .def_static("make2", &MyDerived::make); + + // test_implicit_conversion_life_support + struct ConvertibleFromUserType + { + int i; + + ConvertibleFromUserType(UserType u) + : i(u.value()) + {} + }; + + py::class_<ConvertibleFromUserType>(m, "AcceptsUserType").def(py::init<UserType>()); + py::implicitly_convertible<UserType, ConvertibleFromUserType>(); + + m.def("implicitly_convert_argument", [](const ConvertibleFromUserType& r) { return r.i; }); + m.def("implicitly_convert_variable", [](py::object o) { + // `o` is `UserType` and `r` is a reference to a temporary created by implicit + // conversion. This is valid when called inside a bound function because the temp + // object is attached to the same life support system as the arguments. + const auto& r = o.cast<const ConvertibleFromUserType&>(); + return r.i; + }); + m.add_object("implicitly_convert_variable_fail", [&] { + auto f = [](PyObject*, PyObject* args) -> PyObject* { + auto o = py::reinterpret_borrow<py::tuple>(args)[0]; + try { // It should fail here because there is no life support. + o.cast<const ConvertibleFromUserType&>(); + } catch (const py::cast_error& e) { + return py::str(e.what()).release().ptr(); + } + return py::str().release().ptr(); + }; + + auto def = new PyMethodDef{"f", f, METH_VARARGS, nullptr}; + return py::reinterpret_steal<py::object>(PyCFunction_NewEx(def, nullptr, m.ptr())); + }()); + + // test_operator_new_delete + struct HasOpNewDel + { + std::uint64_t i; + static void* operator new(size_t s) + { + py::print("A new", s); + return ::operator new(s); + } + static void* operator new(size_t s, void* ptr) + { + py::print("A placement-new", s); + return ptr; + } + static void operator delete(void* p) + { + py::print("A delete"); + return ::operator delete(p); + } + }; + struct HasOpNewDelSize + { + std::uint32_t i; + static void* operator new(size_t s) + { + py::print("B new", s); + return ::operator new(s); + } + static void* operator new(size_t s, void* ptr) + { + py::print("B placement-new", s); + return ptr; + } + static void operator delete(void* p, size_t s) + { + py::print("B delete", s); + return ::operator delete(p); + } + }; + struct AliasedHasOpNewDelSize + { + std::uint64_t i; + static void* operator new(size_t s) + { + py::print("C new", s); + return ::operator new(s); + } + static void* operator new(size_t s, void* ptr) + { + py::print("C placement-new", s); + return ptr; + } + static void operator delete(void* p, size_t s) + { + py::print("C delete", s); + return ::operator delete(p); + } + virtual ~AliasedHasOpNewDelSize() = default; + }; + struct PyAliasedHasOpNewDelSize : AliasedHasOpNewDelSize + { + PyAliasedHasOpNewDelSize() = default; + PyAliasedHasOpNewDelSize(int) {} + std::uint64_t j; + }; + struct HasOpNewDelBoth + { + std::uint32_t i[8]; + static void* operator new(size_t s) + { + py::print("D new", s); + return ::operator new(s); + } + static void* operator new(size_t s, void* ptr) + { + py::print("D placement-new", s); + return ptr; + } + static void operator delete(void* p) + { + py::print("D delete"); + return ::operator delete(p); + } + static void operator delete(void* p, size_t s) + { + py::print("D wrong delete", s); + return ::operator delete(p); + } + }; + py::class_<HasOpNewDel>(m, "HasOpNewDel").def(py::init<>()); + py::class_<HasOpNewDelSize>(m, "HasOpNewDelSize").def(py::init<>()); + py::class_<HasOpNewDelBoth>(m, "HasOpNewDelBoth").def(py::init<>()); + py::class_<AliasedHasOpNewDelSize, PyAliasedHasOpNewDelSize> aliased(m, "AliasedHasOpNewDelSize"); + aliased.def(py::init<>()); + aliased.attr("size_noalias") = py::int_(sizeof(AliasedHasOpNewDelSize)); + aliased.attr("size_alias") = py::int_(sizeof(PyAliasedHasOpNewDelSize)); + + // This test is actually part of test_local_bindings (test_duplicate_local), but we need a + // definition in a different compilation unit within the same module: + bind_local<LocalExternal, 17>(m, "LocalExternal", py::module_local()); + + // test_bind_protected_functions + class ProtectedA + { + protected: + int foo() const + { + return value; + } + + private: + int value = 42; + }; + + class PublicistA : public ProtectedA + { + public: + using ProtectedA::foo; + }; + + py::class_<ProtectedA>(m, "ProtectedA") + .def(py::init<>()) +#if !defined(_MSC_VER) || _MSC_VER >= 1910 + .def("foo", &PublicistA::foo); +#else + .def("foo", static_cast<int (ProtectedA::*)() const>(&PublicistA::foo)); +#endif + + class ProtectedB + { + public: + virtual ~ProtectedB() = default; + + protected: + virtual int foo() const + { + return value; + } + + private: + int value = 42; + }; + + class TrampolineB : public ProtectedB + { + public: + int foo() const override + { + PYBIND11_OVERLOAD(int, ProtectedB, foo, ); + } + }; + + class PublicistB : public ProtectedB + { + public: + using ProtectedB::foo; + }; + + py::class_<ProtectedB, TrampolineB>(m, "ProtectedB") + .def(py::init<>()) +#if !defined(_MSC_VER) || _MSC_VER >= 1910 + .def("foo", &PublicistB::foo); +#else + .def("foo", static_cast<int (ProtectedB::*)() const>(&PublicistB::foo)); +#endif + + // test_brace_initialization + struct BraceInitialization + { + int field1; + std::string field2; + }; + + py::class_<BraceInitialization>(m, "BraceInitialization") + .def(py::init<int, const std::string&>()) + .def_readwrite("field1", &BraceInitialization::field1) + .def_readwrite("field2", &BraceInitialization::field2); + // We *don't* want to construct using braces when the given constructor argument maps to a + // constructor, because brace initialization could go to the wrong place (in particular when + // there is also an `initializer_list<T>`-accept constructor): + py::class_<NoBraceInitialization>(m, "NoBraceInitialization") + .def(py::init<std::vector<int>>()) + .def_readonly("vec", &NoBraceInitialization::vec); + + // test_reentrant_implicit_conversion_failure + // #1035: issue with runaway reentrant implicit conversion + struct BogusImplicitConversion + { + BogusImplicitConversion(const BogusImplicitConversion&) {} + }; + + py::class_<BogusImplicitConversion>(m, "BogusImplicitConversion").def(py::init<const BogusImplicitConversion&>()); + + py::implicitly_convertible<int, BogusImplicitConversion>(); + + // test_qualname + // #1166: nested class docstring doesn't show nested name + // Also related: tests that __qualname__ is set properly + struct NestBase + {}; + struct Nested + {}; + py::class_<NestBase> base(m, "NestBase"); + base.def(py::init<>()); + py::class_<Nested>(base, "Nested") + .def(py::init<>()) + .def("fn", [](Nested&, int, NestBase&, Nested&) {}) + .def("fa", [](Nested&, int, NestBase&, Nested&) {}, "a"_a, "b"_a, "c"_a); + base.def("g", [](NestBase&, Nested&) {}); + base.def("h", []() { return NestBase(); }); + + // test_error_after_conversion + // The second-pass path through dispatcher() previously didn't + // remember which overload was used, and would crash trying to + // generate a useful error message + + struct NotRegistered + {}; + struct StringWrapper + { + std::string str; + }; + m.def("test_error_after_conversions", [](int) {}); + m.def("test_error_after_conversions", [](StringWrapper) -> NotRegistered { return {}; }); + py::class_<StringWrapper>(m, "StringWrapper").def(py::init<std::string>()); + py::implicitly_convertible<std::string, StringWrapper>(); + +#if defined(PYBIND11_CPP17) + struct alignas(1024) Aligned + { + std::uintptr_t ptr() const + { + return (uintptr_t)this; + } + }; + py::class_<Aligned>(m, "Aligned").def(py::init<>()).def("ptr", &Aligned::ptr); +#endif +} + +template <int N> +class BreaksBase +{ +public: + virtual ~BreaksBase() = default; +}; +template <int N> +class BreaksTramp : public BreaksBase<N> +{}; +// These should all compile just fine: +typedef py::class_<BreaksBase<1>, std::unique_ptr<BreaksBase<1>>, BreaksTramp<1>> DoesntBreak1; +typedef py::class_<BreaksBase<2>, BreaksTramp<2>, std::unique_ptr<BreaksBase<2>>> DoesntBreak2; +typedef py::class_<BreaksBase<3>, std::unique_ptr<BreaksBase<3>>> DoesntBreak3; +typedef py::class_<BreaksBase<4>, BreaksTramp<4>> DoesntBreak4; +typedef py::class_<BreaksBase<5>> DoesntBreak5; +typedef py::class_<BreaksBase<6>, std::shared_ptr<BreaksBase<6>>, BreaksTramp<6>> DoesntBreak6; +typedef py::class_<BreaksBase<7>, BreaksTramp<7>, std::shared_ptr<BreaksBase<7>>> DoesntBreak7; +typedef py::class_<BreaksBase<8>, std::shared_ptr<BreaksBase<8>>> DoesntBreak8; +#define CHECK_BASE(N) \ + static_assert(std::is_same<typename DoesntBreak##N::type, BreaksBase<N>>::value, "DoesntBreak" #N " has wrong type!") +CHECK_BASE(1); +CHECK_BASE(2); +CHECK_BASE(3); +CHECK_BASE(4); +CHECK_BASE(5); +CHECK_BASE(6); +CHECK_BASE(7); +CHECK_BASE(8); +#define CHECK_ALIAS(N) \ + static_assert(DoesntBreak##N::has_alias && std::is_same<typename DoesntBreak##N::type_alias, BreaksTramp<N>>::value, \ + "DoesntBreak" #N " has wrong type_alias!") +#define CHECK_NOALIAS(N) \ + static_assert(!DoesntBreak##N::has_alias && std::is_void<typename DoesntBreak##N::type_alias>::value, \ + "DoesntBreak" #N " has type alias, but shouldn't!") +CHECK_ALIAS(1); +CHECK_ALIAS(2); +CHECK_NOALIAS(3); +CHECK_ALIAS(4); +CHECK_NOALIAS(5); +CHECK_ALIAS(6); +CHECK_ALIAS(7); +CHECK_NOALIAS(8); +#define CHECK_HOLDER(N, TYPE) \ + static_assert(std::is_same<typename DoesntBreak##N::holder_type, std::TYPE##_ptr<BreaksBase<N>>>::value, \ + "DoesntBreak" #N " has wrong holder_type!") +CHECK_HOLDER(1, unique); +CHECK_HOLDER(2, unique); +CHECK_HOLDER(3, unique); +CHECK_HOLDER(4, unique); +CHECK_HOLDER(5, unique); +CHECK_HOLDER(6, shared); +CHECK_HOLDER(7, shared); +CHECK_HOLDER(8, shared); + +// There's no nice way to test that these fail because they fail to compile; leave them here, +// though, so that they can be manually tested by uncommenting them (and seeing that compilation +// failures occurs). + +// We have to actually look into the type: the typedef alone isn't enough to instantiate the type: +#define CHECK_BROKEN(N) \ + static_assert(std::is_same<typename Breaks##N::type, BreaksBase<-N>>::value, "Breaks1 has wrong type!"); + +//// Two holder classes: +// typedef py::class_<BreaksBase<-1>, std::unique_ptr<BreaksBase<-1>>, std::unique_ptr<BreaksBase<-1>>> Breaks1; +// CHECK_BROKEN(1); +//// Two aliases: +// typedef py::class_<BreaksBase<-2>, BreaksTramp<-2>, BreaksTramp<-2>> Breaks2; +// CHECK_BROKEN(2); +//// Holder + 2 aliases +// typedef py::class_<BreaksBase<-3>, std::unique_ptr<BreaksBase<-3>>, BreaksTramp<-3>, BreaksTramp<-3>> Breaks3; +// CHECK_BROKEN(3); +//// Alias + 2 holders +// typedef py::class_<BreaksBase<-4>, std::unique_ptr<BreaksBase<-4>>, BreaksTramp<-4>, std::shared_ptr<BreaksBase<-4>>> +// Breaks4; CHECK_BROKEN(4); +//// Invalid option (not a subclass or holder) +// typedef py::class_<BreaksBase<-5>, BreaksTramp<-4>> Breaks5; +// CHECK_BROKEN(5); +//// Invalid option: multiple inheritance not supported: +// template <> struct BreaksBase<-8> : BreaksBase<-6>, BreaksBase<-7> {}; +// typedef py::class_<BreaksBase<-8>, BreaksBase<-6>, BreaksBase<-7>> Breaks8; +// CHECK_BROKEN(8); diff --git a/pybind11/tests/test_class.py b/pybind11/tests/test_class.py new file mode 100644 index 0000000000000000000000000000000000000000..d325ff3a1224daddd9035329f6059f7ec3fe1edf --- /dev/null +++ b/pybind11/tests/test_class.py @@ -0,0 +1,277 @@ +import pytest + +from pybind11_tests import class_ as m +from pybind11_tests import UserType, ConstructorStats + + +def test_repr(): + # In Python 3.3+, repr() accesses __qualname__ + assert "pybind11_type" in repr(type(UserType)) + assert "UserType" in repr(UserType) + + +def test_instance(msg): + with pytest.raises(TypeError) as excinfo: + m.NoConstructor() + assert msg(excinfo.value) == "m.class_.NoConstructor: No constructor defined!" + + instance = m.NoConstructor.new_instance() + + cstats = ConstructorStats.get(m.NoConstructor) + assert cstats.alive() == 1 + del instance + assert cstats.alive() == 0 + + +def test_docstrings(doc): + assert doc(UserType) == "A `py::class_` type for testing" + assert UserType.__name__ == "UserType" + assert UserType.__module__ == "pybind11_tests" + assert UserType.get_value.__name__ == "get_value" + assert UserType.get_value.__module__ == "pybind11_tests" + + assert doc(UserType.get_value) == """ + get_value(self: m.UserType) -> int + + Get value using a method + """ + assert doc(UserType.value) == "Get/set value using a property" + + assert doc(m.NoConstructor.new_instance) == """ + new_instance() -> m.class_.NoConstructor + + Return an instance + """ + + +def test_qualname(doc): + """Tests that a properly qualified name is set in __qualname__ (even in pre-3.3, where we + backport the attribute) and that generated docstrings properly use it and the module name""" + assert m.NestBase.__qualname__ == "NestBase" + assert m.NestBase.Nested.__qualname__ == "NestBase.Nested" + + assert doc(m.NestBase.__init__) == """ + __init__(self: m.class_.NestBase) -> None + """ + assert doc(m.NestBase.g) == """ + g(self: m.class_.NestBase, arg0: m.class_.NestBase.Nested) -> None + """ + assert doc(m.NestBase.Nested.__init__) == """ + __init__(self: m.class_.NestBase.Nested) -> None + """ + assert doc(m.NestBase.Nested.fn) == """ + fn(self: m.class_.NestBase.Nested, arg0: int, arg1: m.class_.NestBase, arg2: m.class_.NestBase.Nested) -> None + """ # noqa: E501 line too long + assert doc(m.NestBase.Nested.fa) == """ + fa(self: m.class_.NestBase.Nested, a: int, b: m.class_.NestBase, c: m.class_.NestBase.Nested) -> None + """ # noqa: E501 line too long + assert m.NestBase.__module__ == "pybind11_tests.class_" + assert m.NestBase.Nested.__module__ == "pybind11_tests.class_" + + +def test_inheritance(msg): + roger = m.Rabbit('Rabbit') + assert roger.name() + " is a " + roger.species() == "Rabbit is a parrot" + assert m.pet_name_species(roger) == "Rabbit is a parrot" + + polly = m.Pet('Polly', 'parrot') + assert polly.name() + " is a " + polly.species() == "Polly is a parrot" + assert m.pet_name_species(polly) == "Polly is a parrot" + + molly = m.Dog('Molly') + assert molly.name() + " is a " + molly.species() == "Molly is a dog" + assert m.pet_name_species(molly) == "Molly is a dog" + + fred = m.Hamster('Fred') + assert fred.name() + " is a " + fred.species() == "Fred is a rodent" + + assert m.dog_bark(molly) == "Woof!" + + with pytest.raises(TypeError) as excinfo: + m.dog_bark(polly) + assert msg(excinfo.value) == """ + dog_bark(): incompatible function arguments. The following argument types are supported: + 1. (arg0: m.class_.Dog) -> str + + Invoked with: <m.class_.Pet object at 0> + """ + + with pytest.raises(TypeError) as excinfo: + m.Chimera("lion", "goat") + assert "No constructor defined!" in str(excinfo.value) + + +def test_automatic_upcasting(): + assert type(m.return_class_1()).__name__ == "DerivedClass1" + assert type(m.return_class_2()).__name__ == "DerivedClass2" + assert type(m.return_none()).__name__ == "NoneType" + # Repeat these a few times in a random order to ensure no invalid caching is applied + assert type(m.return_class_n(1)).__name__ == "DerivedClass1" + assert type(m.return_class_n(2)).__name__ == "DerivedClass2" + assert type(m.return_class_n(0)).__name__ == "BaseClass" + assert type(m.return_class_n(2)).__name__ == "DerivedClass2" + assert type(m.return_class_n(2)).__name__ == "DerivedClass2" + assert type(m.return_class_n(0)).__name__ == "BaseClass" + assert type(m.return_class_n(1)).__name__ == "DerivedClass1" + + +def test_isinstance(): + objects = [tuple(), dict(), m.Pet("Polly", "parrot")] + [m.Dog("Molly")] * 4 + expected = (True, True, True, True, True, False, False) + assert m.check_instances(objects) == expected + + +def test_mismatched_holder(): + import re + + with pytest.raises(RuntimeError) as excinfo: + m.mismatched_holder_1() + assert re.match( + 'generic_type: type ".*MismatchDerived1" does not have a non-default ' + 'holder type while its base ".*MismatchBase1" does', str(excinfo.value)) + + with pytest.raises(RuntimeError) as excinfo: + m.mismatched_holder_2() + assert re.match( + 'generic_type: type ".*MismatchDerived2" has a non-default holder type ' + 'while its base ".*MismatchBase2" does not', str(excinfo.value)) + + +def test_override_static(): + """#511: problem with inheritance + overwritten def_static""" + b = m.MyBase.make() + d1 = m.MyDerived.make2() + d2 = m.MyDerived.make() + + assert isinstance(b, m.MyBase) + assert isinstance(d1, m.MyDerived) + assert isinstance(d2, m.MyDerived) + + +def test_implicit_conversion_life_support(): + """Ensure the lifetime of temporary objects created for implicit conversions""" + assert m.implicitly_convert_argument(UserType(5)) == 5 + assert m.implicitly_convert_variable(UserType(5)) == 5 + + assert "outside a bound function" in m.implicitly_convert_variable_fail(UserType(5)) + + +def test_operator_new_delete(capture): + """Tests that class-specific operator new/delete functions are invoked""" + + class SubAliased(m.AliasedHasOpNewDelSize): + pass + + with capture: + a = m.HasOpNewDel() + b = m.HasOpNewDelSize() + d = m.HasOpNewDelBoth() + assert capture == """ + A new 8 + B new 4 + D new 32 + """ + sz_alias = str(m.AliasedHasOpNewDelSize.size_alias) + sz_noalias = str(m.AliasedHasOpNewDelSize.size_noalias) + with capture: + c = m.AliasedHasOpNewDelSize() + c2 = SubAliased() + assert capture == ("C new " + sz_noalias + "\n" + "C new " + sz_alias + "\n") + + with capture: + del a + pytest.gc_collect() + del b + pytest.gc_collect() + del d + pytest.gc_collect() + assert capture == """ + A delete + B delete 4 + D delete + """ + + with capture: + del c + pytest.gc_collect() + del c2 + pytest.gc_collect() + assert capture == ("C delete " + sz_noalias + "\n" + "C delete " + sz_alias + "\n") + + +def test_bind_protected_functions(): + """Expose protected member functions to Python using a helper class""" + a = m.ProtectedA() + assert a.foo() == 42 + + b = m.ProtectedB() + assert b.foo() == 42 + + class C(m.ProtectedB): + + def __init__(self): + m.ProtectedB.__init__(self) + + def foo(self): + return 0 + + c = C() + assert c.foo() == 0 + + +def test_brace_initialization(): + """ Tests that simple POD classes can be constructed using C++11 brace initialization """ + a = m.BraceInitialization(123, "test") + assert a.field1 == 123 + assert a.field2 == "test" + + # Tests that a non-simple class doesn't get brace initialization (if the + # class defines an initializer_list constructor, in particular, it would + # win over the expected constructor). + b = m.NoBraceInitialization([123, 456]) + assert b.vec == [123, 456] + + +@pytest.unsupported_on_pypy +def test_class_refcount(): + """Instances must correctly increase/decrease the reference count of their types (#1029)""" + from sys import getrefcount + + class PyDog(m.Dog): + pass + + for cls in m.Dog, PyDog: + refcount_1 = getrefcount(cls) + molly = [cls("Molly") for _ in range(10)] + refcount_2 = getrefcount(cls) + + del molly + pytest.gc_collect() + refcount_3 = getrefcount(cls) + + assert refcount_1 == refcount_3 + assert refcount_2 > refcount_1 + + +def test_reentrant_implicit_conversion_failure(msg): + # ensure that there is no runaway reentrant implicit conversion (#1035) + with pytest.raises(TypeError) as excinfo: + m.BogusImplicitConversion(0) + assert msg(excinfo.value) == ''' + __init__(): incompatible constructor arguments. The following argument types are supported: + 1. m.class_.BogusImplicitConversion(arg0: m.class_.BogusImplicitConversion) + + Invoked with: 0 + ''' + + +def test_error_after_conversions(): + with pytest.raises(TypeError) as exc_info: + m.test_error_after_conversions("hello") + assert str(exc_info.value).startswith("Unable to convert function return value to a Python type!") + + +def test_aligned(): + if hasattr(m, "Aligned"): + p = m.Aligned().ptr() + assert p % 1024 == 0 diff --git a/pybind11/tests/test_cmake_build/CMakeLists.txt b/pybind11/tests/test_cmake_build/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..06f37b4c482967ac86238e0691ca45e9eae0a7a8 --- /dev/null +++ b/pybind11/tests/test_cmake_build/CMakeLists.txt @@ -0,0 +1,68 @@ +add_custom_target(test_cmake_build) + +if(CMAKE_VERSION VERSION_LESS 3.1) + # 3.0 needed for interface library for subdirectory_target/installed_target 3.1 needed for cmake -E env for testing + return() +endif() + +include(CMakeParseArguments) +function(pybind11_add_build_test name) + cmake_parse_arguments(ARG "INSTALL" "" "" ${ARGN}) + + set(build_options + "-DCMAKE_PREFIX_PATH=${PROJECT_BINARY_DIR}/mock_install" + "-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}" + "-DPYTHON_EXECUTABLE:FILEPATH=${PYTHON_EXECUTABLE}" + "-DPYBIND11_CPP_STANDARD=${PYBIND11_CPP_STANDARD}") + if(NOT ARG_INSTALL) + list(APPEND build_options "-DPYBIND11_PROJECT_DIR=${PROJECT_SOURCE_DIR}") + endif() + + add_custom_target(test_${name} + ${CMAKE_CTEST_COMMAND} + --quiet + --output-log + ${name}.log + --build-and-test + "${CMAKE_CURRENT_SOURCE_DIR}/${name}" + "${CMAKE_CURRENT_BINARY_DIR}/${name}" + --build-config + Release + --build-noclean + --build-generator + ${CMAKE_GENERATOR} + $<$<BOOL:${CMAKE_GENERATOR_PLATFORM}>:--build-generator-platform> + ${CMAKE_GENERATOR_PLATFORM} + --build-makeprogram + ${CMAKE_MAKE_PROGRAM} + --build-target + check + --build-options + ${build_options}) + if(ARG_INSTALL) + add_dependencies(test_${name} mock_install) + endif() + add_dependencies(test_cmake_build test_${name}) +endfunction() + +pybind11_add_build_test(subdirectory_function) +pybind11_add_build_test(subdirectory_target) +if(NOT ${PYTHON_MODULE_EXTENSION} MATCHES "pypy") + pybind11_add_build_test(subdirectory_embed) +endif() + +if(PYBIND11_INSTALL) + add_custom_target(mock_install + ${CMAKE_COMMAND} + "-DCMAKE_INSTALL_PREFIX=${PROJECT_BINARY_DIR}/mock_install" + -P + "${PROJECT_BINARY_DIR}/cmake_install.cmake") + + pybind11_add_build_test(installed_function INSTALL) + pybind11_add_build_test(installed_target INSTALL) + if(NOT ${PYTHON_MODULE_EXTENSION} MATCHES "pypy") + pybind11_add_build_test(installed_embed INSTALL) + endif() +endif() + +add_dependencies(check test_cmake_build) diff --git a/pybind11/tests/test_cmake_build/embed.cpp b/pybind11/tests/test_cmake_build/embed.cpp new file mode 100644 index 0000000000000000000000000000000000000000..a10fdcf56698a8e9743b62fc3a676f1de885775e --- /dev/null +++ b/pybind11/tests/test_cmake_build/embed.cpp @@ -0,0 +1,23 @@ +#include <pybind11/embed.h> +namespace py = pybind11; + +PYBIND11_EMBEDDED_MODULE(test_cmake_build, m) +{ + m.def("add", [](int i, int j) { return i + j; }); +} + +int main(int argc, char* argv[]) +{ + if (argc != 2) + throw std::runtime_error("Expected test.py file as the first argument"); + auto test_py_file = argv[1]; + + py::scoped_interpreter guard{}; + + auto m = py::module::import("test_cmake_build"); + if (m.attr("add")(1, 2).cast<int>() != 3) + throw std::runtime_error("embed.cpp failed"); + + py::module::import("sys").attr("argv") = py::make_tuple("test.py", "embed.cpp"); + py::eval_file(test_py_file, py::globals()); +} diff --git a/pybind11/tests/test_cmake_build/installed_embed/CMakeLists.txt b/pybind11/tests/test_cmake_build/installed_embed/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..82db633a47f6e4c05e1e941911f2bde8ee644077 --- /dev/null +++ b/pybind11/tests/test_cmake_build/installed_embed/CMakeLists.txt @@ -0,0 +1,15 @@ +cmake_minimum_required(VERSION 3.0) +project(test_installed_embed CXX) + +set(CMAKE_MODULE_PATH "") +find_package(pybind11 CONFIG REQUIRED) +message(STATUS "Found pybind11 v${pybind11_VERSION}: ${pybind11_INCLUDE_DIRS}") + +add_executable(test_cmake_build ../embed.cpp) +target_link_libraries(test_cmake_build PRIVATE pybind11::embed) + +# Do not treat includes from IMPORTED target as SYSTEM (Python headers in pybind11::embed). This may be needed to +# resolve header conflicts, e.g. between Python release and debug headers. +set_target_properties(test_cmake_build PROPERTIES NO_SYSTEM_FROM_IMPORTED ON) + +add_custom_target(check $<TARGET_FILE:test_cmake_build> ${PROJECT_SOURCE_DIR}/../test.py) diff --git a/pybind11/tests/test_cmake_build/installed_function/CMakeLists.txt b/pybind11/tests/test_cmake_build/installed_function/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..3daf9a2c376f470dcf297114b96d1787052e78ac --- /dev/null +++ b/pybind11/tests/test_cmake_build/installed_function/CMakeLists.txt @@ -0,0 +1,18 @@ +cmake_minimum_required(VERSION 2.8.12) +project(test_installed_module CXX) + +set(CMAKE_MODULE_PATH "") + +find_package(pybind11 CONFIG REQUIRED) +message(STATUS "Found pybind11 v${pybind11_VERSION}: ${pybind11_INCLUDE_DIRS}") + +pybind11_add_module(test_cmake_build SHARED NO_EXTRAS ../main.cpp) + +add_custom_target(check + ${CMAKE_COMMAND} + -E + env + PYTHONPATH=$<TARGET_FILE_DIR:test_cmake_build> + ${PYTHON_EXECUTABLE} + ${PROJECT_SOURCE_DIR}/../test.py + ${PROJECT_NAME}) diff --git a/pybind11/tests/test_cmake_build/installed_target/CMakeLists.txt b/pybind11/tests/test_cmake_build/installed_target/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..f95aedc7215034c555ee38c0a881c8a6027c4d51 --- /dev/null +++ b/pybind11/tests/test_cmake_build/installed_target/CMakeLists.txt @@ -0,0 +1,31 @@ +cmake_minimum_required(VERSION 3.0) +project(test_installed_target CXX) + +set(CMAKE_MODULE_PATH "") + +find_package(pybind11 CONFIG REQUIRED) +message(STATUS "Found pybind11 v${pybind11_VERSION}: ${pybind11_INCLUDE_DIRS}") + +add_library(test_cmake_build MODULE ../main.cpp) + +target_link_libraries(test_cmake_build PRIVATE pybind11::module) + +# make sure result is, for example, test_installed_target.so, not libtest_installed_target.dylib +set_target_properties(test_cmake_build + PROPERTIES PREFIX + "${PYTHON_MODULE_PREFIX}" + SUFFIX + "${PYTHON_MODULE_EXTENSION}") + +# Do not treat includes from IMPORTED target as SYSTEM (Python headers in pybind11::module). This may be needed to +# resolve header conflicts, e.g. between Python release and debug headers. +set_target_properties(test_cmake_build PROPERTIES NO_SYSTEM_FROM_IMPORTED ON) + +add_custom_target(check + ${CMAKE_COMMAND} + -E + env + PYTHONPATH=$<TARGET_FILE_DIR:test_cmake_build> + ${PYTHON_EXECUTABLE} + ${PROJECT_SOURCE_DIR}/../test.py + ${PROJECT_NAME}) diff --git a/pybind11/tests/test_cmake_build/main.cpp b/pybind11/tests/test_cmake_build/main.cpp new file mode 100644 index 0000000000000000000000000000000000000000..c43ae7b7f613fe8e06d1f82c8cf56f45381e558c --- /dev/null +++ b/pybind11/tests/test_cmake_build/main.cpp @@ -0,0 +1,7 @@ +#include <pybind11/pybind11.h> +namespace py = pybind11; + +PYBIND11_MODULE(test_cmake_build, m) +{ + m.def("add", [](int i, int j) { return i + j; }); +} diff --git a/pybind11/tests/test_cmake_build/subdirectory_embed/CMakeLists.txt b/pybind11/tests/test_cmake_build/subdirectory_embed/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..e6a10711428e10d8d0af77e822d5daa124598bb8 --- /dev/null +++ b/pybind11/tests/test_cmake_build/subdirectory_embed/CMakeLists.txt @@ -0,0 +1,24 @@ +cmake_minimum_required(VERSION 3.0) +project(test_subdirectory_embed CXX) + +set(PYBIND11_INSTALL ON CACHE BOOL "") +set(PYBIND11_EXPORT_NAME test_export) + +add_subdirectory(${PYBIND11_PROJECT_DIR} pybind11) + +# Test basic target functionality +add_executable(test_cmake_build ../embed.cpp) +target_link_libraries(test_cmake_build PRIVATE pybind11::embed) + +add_custom_target(check $<TARGET_FILE:test_cmake_build> ${PROJECT_SOURCE_DIR}/../test.py) + +# Test custom export group -- PYBIND11_EXPORT_NAME +add_library(test_embed_lib ../embed.cpp) +target_link_libraries(test_embed_lib PRIVATE pybind11::embed) + +install(TARGETS test_embed_lib + EXPORT test_export + ARCHIVE DESTINATION bin + LIBRARY DESTINATION lib + RUNTIME DESTINATION lib) +install(EXPORT test_export DESTINATION lib/cmake/test_export/test_export-Targets.cmake) diff --git a/pybind11/tests/test_cmake_build/subdirectory_function/CMakeLists.txt b/pybind11/tests/test_cmake_build/subdirectory_function/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..c97e6c30c980d7df847dbe66017c2bab2f9636b7 --- /dev/null +++ b/pybind11/tests/test_cmake_build/subdirectory_function/CMakeLists.txt @@ -0,0 +1,14 @@ +cmake_minimum_required(VERSION 2.8.12) +project(test_subdirectory_module CXX) + +add_subdirectory(${PYBIND11_PROJECT_DIR} pybind11) +pybind11_add_module(test_cmake_build THIN_LTO ../main.cpp) + +add_custom_target(check + ${CMAKE_COMMAND} + -E + env + PYTHONPATH=$<TARGET_FILE_DIR:test_cmake_build> + ${PYTHON_EXECUTABLE} + ${PROJECT_SOURCE_DIR}/../test.py + ${PROJECT_NAME}) diff --git a/pybind11/tests/test_cmake_build/subdirectory_target/CMakeLists.txt b/pybind11/tests/test_cmake_build/subdirectory_target/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..5762c9709fded799b190a3cd9042a1cd5f42db58 --- /dev/null +++ b/pybind11/tests/test_cmake_build/subdirectory_target/CMakeLists.txt @@ -0,0 +1,24 @@ +cmake_minimum_required(VERSION 3.0) +project(test_subdirectory_target CXX) + +add_subdirectory(${PYBIND11_PROJECT_DIR} pybind11) + +add_library(test_cmake_build MODULE ../main.cpp) + +target_link_libraries(test_cmake_build PRIVATE pybind11::module) + +# make sure result is, for example, test_installed_target.so, not libtest_installed_target.dylib +set_target_properties(test_cmake_build + PROPERTIES PREFIX + "${PYTHON_MODULE_PREFIX}" + SUFFIX + "${PYTHON_MODULE_EXTENSION}") + +add_custom_target(check + ${CMAKE_COMMAND} + -E + env + PYTHONPATH=$<TARGET_FILE_DIR:test_cmake_build> + ${PYTHON_EXECUTABLE} + ${PROJECT_SOURCE_DIR}/../test.py + ${PROJECT_NAME}) diff --git a/pybind11/tests/test_cmake_build/test.py b/pybind11/tests/test_cmake_build/test.py new file mode 100644 index 0000000000000000000000000000000000000000..1467a61dc0e75c05c8a91ce3b8bc6c2338ff8c3e --- /dev/null +++ b/pybind11/tests/test_cmake_build/test.py @@ -0,0 +1,5 @@ +import sys +import test_cmake_build + +assert test_cmake_build.add(1, 2) == 3 +print("{} imports, runs, and adds: 1 + 2 = 3".format(sys.argv[1])) diff --git a/pybind11/tests/test_constants_and_functions.cpp b/pybind11/tests/test_constants_and_functions.cpp new file mode 100644 index 0000000000000000000000000000000000000000..09ba8253404fdd99e547019040ceb6dc923d875e --- /dev/null +++ b/pybind11/tests/test_constants_and_functions.cpp @@ -0,0 +1,182 @@ +/* + tests/test_constants_and_functions.cpp -- global constants and functions, enumerations, raw byte strings + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +enum MyEnum +{ + EFirstEntry = 1, + ESecondEntry +}; + +std::string test_function1() +{ + return "test_function()"; +} + +std::string test_function2(MyEnum k) +{ + return "test_function(enum=" + std::to_string(k) + ")"; +} + +std::string test_function3(int i) +{ + return "test_function(" + std::to_string(i) + ")"; +} + +py::str test_function4() +{ + return "test_function()"; +} +py::str test_function4(char*) +{ + return "test_function(char *)"; +} +py::str test_function4(int, float) +{ + return "test_function(int, float)"; +} +py::str test_function4(float, int) +{ + return "test_function(float, int)"; +} + +py::bytes return_bytes() +{ + const char* data = "\x01\x00\x02\x00"; + return std::string(data, 4); +} + +std::string print_bytes(py::bytes bytes) +{ + std::string ret = "bytes["; + const auto value = static_cast<std::string>(bytes); + for (size_t i = 0; i < value.length(); ++i) { + ret += std::to_string(static_cast<int>(value[i])) + " "; + } + ret.back() = ']'; + return ret; +} + +// Test that we properly handle C++17 exception specifiers (which are part of the function signature +// in C++17). These should all still work before C++17, but don't affect the function signature. +namespace test_exc_sp { +int f1(int x) noexcept +{ + return x + 1; +} +int f2(int x) noexcept(true) +{ + return x + 2; +} +int f3(int x) noexcept(false) +{ + return x + 3; +} +#if defined(__GNUG__) +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wdeprecated" +#endif +int f4(int x) throw() +{ + return x + 4; +} // Deprecated equivalent to noexcept(true) +#if defined(__GNUG__) +# pragma GCC diagnostic pop +#endif +struct C +{ + int m1(int x) noexcept + { + return x - 1; + } + int m2(int x) const noexcept + { + return x - 2; + } + int m3(int x) noexcept(true) + { + return x - 3; + } + int m4(int x) const noexcept(true) + { + return x - 4; + } + int m5(int x) noexcept(false) + { + return x - 5; + } + int m6(int x) const noexcept(false) + { + return x - 6; + } +#if defined(__GNUG__) +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wdeprecated" +#endif + int m7(int x) throw() + { + return x - 7; + } + int m8(int x) const throw() + { + return x - 8; + } +#if defined(__GNUG__) +# pragma GCC diagnostic pop +#endif +}; +} // namespace test_exc_sp + + +TEST_SUBMODULE(constants_and_functions, m) +{ + // test_constants + m.attr("some_constant") = py::int_(14); + + // test_function_overloading + m.def("test_function", &test_function1); + m.def("test_function", &test_function2); + m.def("test_function", &test_function3); + +#if defined(PYBIND11_OVERLOAD_CAST) + m.def("test_function", py::overload_cast<>(&test_function4)); + m.def("test_function", py::overload_cast<char*>(&test_function4)); + m.def("test_function", py::overload_cast<int, float>(&test_function4)); + m.def("test_function", py::overload_cast<float, int>(&test_function4)); +#else + m.def("test_function", static_cast<py::str (*)()>(&test_function4)); + m.def("test_function", static_cast<py::str (*)(char*)>(&test_function4)); + m.def("test_function", static_cast<py::str (*)(int, float)>(&test_function4)); + m.def("test_function", static_cast<py::str (*)(float, int)>(&test_function4)); +#endif + + py::enum_<MyEnum>(m, "MyEnum").value("EFirstEntry", EFirstEntry).value("ESecondEntry", ESecondEntry).export_values(); + + // test_bytes + m.def("return_bytes", &return_bytes); + m.def("print_bytes", &print_bytes); + + // test_exception_specifiers + using namespace test_exc_sp; + py::class_<C>(m, "C") + .def(py::init<>()) + .def("m1", &C::m1) + .def("m2", &C::m2) + .def("m3", &C::m3) + .def("m4", &C::m4) + .def("m5", &C::m5) + .def("m6", &C::m6) + .def("m7", &C::m7) + .def("m8", &C::m8); + m.def("f1", f1); + m.def("f2", f2); + m.def("f3", f3); + m.def("f4", f4); +} diff --git a/pybind11/tests/test_constants_and_functions.py b/pybind11/tests/test_constants_and_functions.py new file mode 100644 index 0000000000000000000000000000000000000000..472682d619db83c4f87cc645ecbf81a751d38936 --- /dev/null +++ b/pybind11/tests/test_constants_and_functions.py @@ -0,0 +1,39 @@ +from pybind11_tests import constants_and_functions as m + + +def test_constants(): + assert m.some_constant == 14 + + +def test_function_overloading(): + assert m.test_function() == "test_function()" + assert m.test_function(7) == "test_function(7)" + assert m.test_function(m.MyEnum.EFirstEntry) == "test_function(enum=1)" + assert m.test_function(m.MyEnum.ESecondEntry) == "test_function(enum=2)" + + assert m.test_function() == "test_function()" + assert m.test_function("abcd") == "test_function(char *)" + assert m.test_function(1, 1.0) == "test_function(int, float)" + assert m.test_function(1, 1.0) == "test_function(int, float)" + assert m.test_function(2.0, 2) == "test_function(float, int)" + + +def test_bytes(): + assert m.print_bytes(m.return_bytes()) == "bytes[1 0 2 0]" + + +def test_exception_specifiers(): + c = m.C() + assert c.m1(2) == 1 + assert c.m2(3) == 1 + assert c.m3(5) == 2 + assert c.m4(7) == 3 + assert c.m5(10) == 5 + assert c.m6(14) == 8 + assert c.m7(20) == 13 + assert c.m8(29) == 21 + + assert m.f1(33) == 34 + assert m.f2(53) == 55 + assert m.f3(86) == 89 + assert m.f4(140) == 144 diff --git a/pybind11/tests/test_copy_move.cpp b/pybind11/tests/test_copy_move.cpp new file mode 100644 index 0000000000000000000000000000000000000000..7a209660bb6fafddc86be121d538d07eab4f081a --- /dev/null +++ b/pybind11/tests/test_copy_move.cpp @@ -0,0 +1,329 @@ +/* + tests/test_copy_move_policies.cpp -- 'copy' and 'move' return value policies + and related tests + + Copyright (c) 2016 Ben North <ben@redfrontdoor.org> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include <pybind11/stl.h> + +template <typename derived> +struct empty +{ + static const derived& get_one() + { + return instance_; + } + static derived instance_; +}; + +struct lacking_copy_ctor : public empty<lacking_copy_ctor> +{ + lacking_copy_ctor() {} + lacking_copy_ctor(const lacking_copy_ctor& other) = delete; +}; + +template <> +lacking_copy_ctor empty<lacking_copy_ctor>::instance_ = {}; + +struct lacking_move_ctor : public empty<lacking_move_ctor> +{ + lacking_move_ctor() {} + lacking_move_ctor(const lacking_move_ctor& other) = delete; + lacking_move_ctor(lacking_move_ctor&& other) = delete; +}; + +template <> +lacking_move_ctor empty<lacking_move_ctor>::instance_ = {}; + +/* Custom type caster move/copy test classes */ +class MoveOnlyInt +{ +public: + MoveOnlyInt() + { + print_default_created(this); + } + MoveOnlyInt(int v) + : value{std::move(v)} + { + print_created(this, value); + } + MoveOnlyInt(MoveOnlyInt&& m) + { + print_move_created(this, m.value); + std::swap(value, m.value); + } + MoveOnlyInt& operator=(MoveOnlyInt&& m) + { + print_move_assigned(this, m.value); + std::swap(value, m.value); + return *this; + } + MoveOnlyInt(const MoveOnlyInt&) = delete; + MoveOnlyInt& operator=(const MoveOnlyInt&) = delete; + ~MoveOnlyInt() + { + print_destroyed(this); + } + + int value; +}; +class MoveOrCopyInt +{ +public: + MoveOrCopyInt() + { + print_default_created(this); + } + MoveOrCopyInt(int v) + : value{std::move(v)} + { + print_created(this, value); + } + MoveOrCopyInt(MoveOrCopyInt&& m) + { + print_move_created(this, m.value); + std::swap(value, m.value); + } + MoveOrCopyInt& operator=(MoveOrCopyInt&& m) + { + print_move_assigned(this, m.value); + std::swap(value, m.value); + return *this; + } + MoveOrCopyInt(const MoveOrCopyInt& c) + { + print_copy_created(this, c.value); + value = c.value; + } + MoveOrCopyInt& operator=(const MoveOrCopyInt& c) + { + print_copy_assigned(this, c.value); + value = c.value; + return *this; + } + ~MoveOrCopyInt() + { + print_destroyed(this); + } + + int value; +}; +class CopyOnlyInt +{ +public: + CopyOnlyInt() + { + print_default_created(this); + } + CopyOnlyInt(int v) + : value{std::move(v)} + { + print_created(this, value); + } + CopyOnlyInt(const CopyOnlyInt& c) + { + print_copy_created(this, c.value); + value = c.value; + } + CopyOnlyInt& operator=(const CopyOnlyInt& c) + { + print_copy_assigned(this, c.value); + value = c.value; + return *this; + } + ~CopyOnlyInt() + { + print_destroyed(this); + } + + int value; +}; +NAMESPACE_BEGIN(pybind11) +NAMESPACE_BEGIN(detail) +template <> +struct type_caster<MoveOnlyInt> +{ + PYBIND11_TYPE_CASTER(MoveOnlyInt, _("MoveOnlyInt")); + bool load(handle src, bool) + { + value = MoveOnlyInt(src.cast<int>()); + return true; + } + static handle cast(const MoveOnlyInt& m, return_value_policy r, handle p) + { + return pybind11::cast(m.value, r, p); + } +}; + +template <> +struct type_caster<MoveOrCopyInt> +{ + PYBIND11_TYPE_CASTER(MoveOrCopyInt, _("MoveOrCopyInt")); + bool load(handle src, bool) + { + value = MoveOrCopyInt(src.cast<int>()); + return true; + } + static handle cast(const MoveOrCopyInt& m, return_value_policy r, handle p) + { + return pybind11::cast(m.value, r, p); + } +}; + +template <> +struct type_caster<CopyOnlyInt> +{ +protected: + CopyOnlyInt value; + +public: + static constexpr auto name = _("CopyOnlyInt"); + bool load(handle src, bool) + { + value = CopyOnlyInt(src.cast<int>()); + return true; + } + static handle cast(const CopyOnlyInt& m, return_value_policy r, handle p) + { + return pybind11::cast(m.value, r, p); + } + static handle cast(const CopyOnlyInt* src, return_value_policy policy, handle parent) + { + if (!src) + return none().release(); + return cast(*src, policy, parent); + } + operator CopyOnlyInt*() + { + return &value; + } + operator CopyOnlyInt&() + { + return value; + } + template <typename T> + using cast_op_type = pybind11::detail::cast_op_type<T>; +}; +NAMESPACE_END(detail) +NAMESPACE_END(pybind11) + +TEST_SUBMODULE(copy_move_policies, m) +{ + // test_lacking_copy_ctor + py::class_<lacking_copy_ctor>(m, "lacking_copy_ctor") + .def_static("get_one", &lacking_copy_ctor::get_one, py::return_value_policy::copy); + // test_lacking_move_ctor + py::class_<lacking_move_ctor>(m, "lacking_move_ctor") + .def_static("get_one", &lacking_move_ctor::get_one, py::return_value_policy::move); + + // test_move_and_copy_casts + m.def("move_and_copy_casts", [](py::object o) { + int r = 0; + r += py::cast<MoveOrCopyInt>(o).value; /* moves */ + r += py::cast<MoveOnlyInt>(o).value; /* moves */ + r += py::cast<CopyOnlyInt>(o).value; /* copies */ + MoveOrCopyInt m1(py::cast<MoveOrCopyInt>(o)); /* moves */ + MoveOnlyInt m2(py::cast<MoveOnlyInt>(o)); /* moves */ + CopyOnlyInt m3(py::cast<CopyOnlyInt>(o)); /* copies */ + r += m1.value + m2.value + m3.value; + + return r; + }); + + // test_move_and_copy_loads + m.def("move_only", [](MoveOnlyInt m) { return m.value; }); + m.def("move_or_copy", [](MoveOrCopyInt m) { return m.value; }); + m.def("copy_only", [](CopyOnlyInt m) { return m.value; }); + m.def("move_pair", [](std::pair<MoveOnlyInt, MoveOrCopyInt> p) { return p.first.value + p.second.value; }); + m.def("move_tuple", [](std::tuple<MoveOnlyInt, MoveOrCopyInt, MoveOnlyInt> t) { + return std::get<0>(t).value + std::get<1>(t).value + std::get<2>(t).value; + }); + m.def("copy_tuple", + [](std::tuple<CopyOnlyInt, CopyOnlyInt> t) { return std::get<0>(t).value + std::get<1>(t).value; }); + m.def("move_copy_nested", + [](std::pair<MoveOnlyInt, + std::pair<std::tuple<MoveOrCopyInt, CopyOnlyInt, std::tuple<MoveOnlyInt>>, MoveOrCopyInt>> x) { + return x.first.value + std::get<0>(x.second.first).value + std::get<1>(x.second.first).value + + std::get<0>(std::get<2>(x.second.first)).value + x.second.second.value; + }); + m.def("move_and_copy_cstats", []() { + ConstructorStats::gc(); + // Reset counts to 0 so that previous tests don't affect later ones: + auto& mc = ConstructorStats::get<MoveOrCopyInt>(); + mc.move_assignments = mc.move_constructions = mc.copy_assignments = mc.copy_constructions = 0; + auto& mo = ConstructorStats::get<MoveOnlyInt>(); + mo.move_assignments = mo.move_constructions = mo.copy_assignments = mo.copy_constructions = 0; + auto& co = ConstructorStats::get<CopyOnlyInt>(); + co.move_assignments = co.move_constructions = co.copy_assignments = co.copy_constructions = 0; + py::dict d; + d["MoveOrCopyInt"] = py::cast(mc, py::return_value_policy::reference); + d["MoveOnlyInt"] = py::cast(mo, py::return_value_policy::reference); + d["CopyOnlyInt"] = py::cast(co, py::return_value_policy::reference); + return d; + }); +#ifdef PYBIND11_HAS_OPTIONAL + // test_move_and_copy_load_optional + m.attr("has_optional") = true; + m.def("move_optional", [](std::optional<MoveOnlyInt> o) { return o->value; }); + m.def("move_or_copy_optional", [](std::optional<MoveOrCopyInt> o) { return o->value; }); + m.def("copy_optional", [](std::optional<CopyOnlyInt> o) { return o->value; }); + m.def("move_optional_tuple", [](std::optional<std::tuple<MoveOrCopyInt, MoveOnlyInt, CopyOnlyInt>> x) { + return std::get<0>(*x).value + std::get<1>(*x).value + std::get<2>(*x).value; + }); +#else + m.attr("has_optional") = false; +#endif + + // #70 compilation issue if operator new is not public + struct PrivateOpNew + { + int value = 1; + + private: +#if defined(_MSC_VER) +# pragma warning(disable : 4822) // warning C4822: local class member function does not have a body +#endif + void* operator new(size_t bytes); + }; + py::class_<PrivateOpNew>(m, "PrivateOpNew").def_readonly("value", &PrivateOpNew::value); + m.def("private_op_new_value", []() { return PrivateOpNew(); }); + m.def("private_op_new_reference", + []() -> const PrivateOpNew& { + static PrivateOpNew x{}; + return x; + }, + py::return_value_policy::reference); + + // test_move_fallback + // #389: rvp::move should fall-through to copy on non-movable objects + struct MoveIssue1 + { + int v; + MoveIssue1(int v) + : v{v} + {} + MoveIssue1(const MoveIssue1& c) = default; + MoveIssue1(MoveIssue1&&) = delete; + }; + py::class_<MoveIssue1>(m, "MoveIssue1").def(py::init<int>()).def_readwrite("value", &MoveIssue1::v); + + struct MoveIssue2 + { + int v; + MoveIssue2(int v) + : v{v} + {} + MoveIssue2(MoveIssue2&&) = default; + }; + py::class_<MoveIssue2>(m, "MoveIssue2").def(py::init<int>()).def_readwrite("value", &MoveIssue2::v); + + m.def("get_moveissue1", [](int i) { return new MoveIssue1(i); }, py::return_value_policy::move); + m.def("get_moveissue2", [](int i) { return MoveIssue2(i); }, py::return_value_policy::move); +} diff --git a/pybind11/tests/test_copy_move.py b/pybind11/tests/test_copy_move.py new file mode 100644 index 0000000000000000000000000000000000000000..1cd1066c410a6bdfdb07402d3eec3636f020df82 --- /dev/null +++ b/pybind11/tests/test_copy_move.py @@ -0,0 +1,112 @@ +import pytest +from pybind11_tests import copy_move_policies as m + + +def test_lacking_copy_ctor(): + with pytest.raises(RuntimeError) as excinfo: + m.lacking_copy_ctor.get_one() + assert "the object is non-copyable!" in str(excinfo.value) + + +def test_lacking_move_ctor(): + with pytest.raises(RuntimeError) as excinfo: + m.lacking_move_ctor.get_one() + assert "the object is neither movable nor copyable!" in str(excinfo.value) + + +def test_move_and_copy_casts(): + """Cast some values in C++ via custom type casters and count the number of moves/copies.""" + + cstats = m.move_and_copy_cstats() + c_m, c_mc, c_c = cstats["MoveOnlyInt"], cstats["MoveOrCopyInt"], cstats["CopyOnlyInt"] + + # The type move constructions/assignments below each get incremented: the move assignment comes + # from the type_caster load; the move construction happens when extracting that via a cast or + # loading into an argument. + assert m.move_and_copy_casts(3) == 18 + assert c_m.copy_assignments + c_m.copy_constructions == 0 + assert c_m.move_assignments == 2 + assert c_m.move_constructions >= 2 + assert c_mc.alive() == 0 + assert c_mc.copy_assignments + c_mc.copy_constructions == 0 + assert c_mc.move_assignments == 2 + assert c_mc.move_constructions >= 2 + assert c_c.alive() == 0 + assert c_c.copy_assignments == 2 + assert c_c.copy_constructions >= 2 + assert c_m.alive() + c_mc.alive() + c_c.alive() == 0 + + +def test_move_and_copy_loads(): + """Call some functions that load arguments via custom type casters and count the number of + moves/copies.""" + + cstats = m.move_and_copy_cstats() + c_m, c_mc, c_c = cstats["MoveOnlyInt"], cstats["MoveOrCopyInt"], cstats["CopyOnlyInt"] + + assert m.move_only(10) == 10 # 1 move, c_m + assert m.move_or_copy(11) == 11 # 1 move, c_mc + assert m.copy_only(12) == 12 # 1 copy, c_c + assert m.move_pair((13, 14)) == 27 # 1 c_m move, 1 c_mc move + assert m.move_tuple((15, 16, 17)) == 48 # 2 c_m moves, 1 c_mc move + assert m.copy_tuple((18, 19)) == 37 # 2 c_c copies + # Direct constructions: 2 c_m moves, 2 c_mc moves, 1 c_c copy + # Extra moves/copies when moving pairs/tuples: 3 c_m, 3 c_mc, 2 c_c + assert m.move_copy_nested((1, ((2, 3, (4,)), 5))) == 15 + + assert c_m.copy_assignments + c_m.copy_constructions == 0 + assert c_m.move_assignments == 6 + assert c_m.move_constructions == 9 + assert c_mc.copy_assignments + c_mc.copy_constructions == 0 + assert c_mc.move_assignments == 5 + assert c_mc.move_constructions == 8 + assert c_c.copy_assignments == 4 + assert c_c.copy_constructions == 6 + assert c_m.alive() + c_mc.alive() + c_c.alive() == 0 + + +@pytest.mark.skipif(not m.has_optional, reason='no <optional>') +def test_move_and_copy_load_optional(): + """Tests move/copy loads of std::optional arguments""" + + cstats = m.move_and_copy_cstats() + c_m, c_mc, c_c = cstats["MoveOnlyInt"], cstats["MoveOrCopyInt"], cstats["CopyOnlyInt"] + + # The extra move/copy constructions below come from the std::optional move (which has to move + # its arguments): + assert m.move_optional(10) == 10 # c_m: 1 move assign, 2 move construct + assert m.move_or_copy_optional(11) == 11 # c_mc: 1 move assign, 2 move construct + assert m.copy_optional(12) == 12 # c_c: 1 copy assign, 2 copy construct + # 1 move assign + move construct moves each of c_m, c_mc, 1 c_c copy + # +1 move/copy construct each from moving the tuple + # +1 move/copy construct each from moving the optional (which moves the tuple again) + assert m.move_optional_tuple((3, 4, 5)) == 12 + + assert c_m.copy_assignments + c_m.copy_constructions == 0 + assert c_m.move_assignments == 2 + assert c_m.move_constructions == 5 + assert c_mc.copy_assignments + c_mc.copy_constructions == 0 + assert c_mc.move_assignments == 2 + assert c_mc.move_constructions == 5 + assert c_c.copy_assignments == 2 + assert c_c.copy_constructions == 5 + assert c_m.alive() + c_mc.alive() + c_c.alive() == 0 + + +def test_private_op_new(): + """An object with a private `operator new` cannot be returned by value""" + + with pytest.raises(RuntimeError) as excinfo: + m.private_op_new_value() + assert "the object is neither movable nor copyable" in str(excinfo.value) + + assert m.private_op_new_reference().value == 1 + + +def test_move_fallback(): + """#389: rvp::move should fall-through to copy on non-movable objects""" + + m2 = m.get_moveissue2(2) + assert m2.value == 2 + m1 = m.get_moveissue1(1) + assert m1.value == 1 diff --git a/pybind11/tests/test_docstring_options.cpp b/pybind11/tests/test_docstring_options.cpp new file mode 100644 index 0000000000000000000000000000000000000000..352ed34a9fc0644f1ac8c258bce85a297d8de371 --- /dev/null +++ b/pybind11/tests/test_docstring_options.cpp @@ -0,0 +1,69 @@ +/* + tests/test_docstring_options.cpp -- generation of docstrings and signatures + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +TEST_SUBMODULE(docstring_options, m) +{ + // test_docstring_options + { + py::options options; + options.disable_function_signatures(); + + m.def("test_function1", [](int, int) {}, py::arg("a"), py::arg("b")); + m.def("test_function2", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); + + m.def("test_overloaded1", [](int) {}, py::arg("i"), "Overload docstring"); + m.def("test_overloaded1", [](double) {}, py::arg("d")); + + m.def("test_overloaded2", [](int) {}, py::arg("i"), "overload docstring 1"); + m.def("test_overloaded2", [](double) {}, py::arg("d"), "overload docstring 2"); + + m.def("test_overloaded3", [](int) {}, py::arg("i")); + m.def("test_overloaded3", [](double) {}, py::arg("d"), "Overload docstr"); + + options.enable_function_signatures(); + + m.def("test_function3", [](int, int) {}, py::arg("a"), py::arg("b")); + m.def("test_function4", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); + + options.disable_function_signatures().disable_user_defined_docstrings(); + + m.def("test_function5", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); + + { + py::options nested_options; + nested_options.enable_user_defined_docstrings(); + m.def("test_function6", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); + } + } + + m.def("test_function7", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); + + { + py::options options; + options.disable_user_defined_docstrings(); + + struct DocstringTestFoo + { + int value; + void setValue(int v) + { + value = v; + } + int getValue() const + { + return value; + } + }; + py::class_<DocstringTestFoo>(m, "DocstringTestFoo", "This is a class docstring") + .def_property( + "value_prop", &DocstringTestFoo::getValue, &DocstringTestFoo::setValue, "This is a property docstring"); + } +} diff --git a/pybind11/tests/test_docstring_options.py b/pybind11/tests/test_docstring_options.py new file mode 100644 index 0000000000000000000000000000000000000000..eabd00b6f61f31effb6e3b5ed9b0c36ff3081bc7 --- /dev/null +++ b/pybind11/tests/test_docstring_options.py @@ -0,0 +1,38 @@ +from pybind11_tests import docstring_options as m + + +def test_docstring_options(): + # options.disable_function_signatures() + assert not m.test_function1.__doc__ + + assert m.test_function2.__doc__ == "A custom docstring" + + # docstring specified on just the first overload definition: + assert m.test_overloaded1.__doc__ == "Overload docstring" + + # docstring on both overloads: + assert m.test_overloaded2.__doc__ == "overload docstring 1\noverload docstring 2" + + # docstring on only second overload: + assert m.test_overloaded3.__doc__ == "Overload docstr" + + # options.enable_function_signatures() + assert m.test_function3.__doc__.startswith("test_function3(a: int, b: int) -> None") + + assert m.test_function4.__doc__.startswith("test_function4(a: int, b: int) -> None") + assert m.test_function4.__doc__.endswith("A custom docstring\n") + + # options.disable_function_signatures() + # options.disable_user_defined_docstrings() + assert not m.test_function5.__doc__ + + # nested options.enable_user_defined_docstrings() + assert m.test_function6.__doc__ == "A custom docstring" + + # RAII destructor + assert m.test_function7.__doc__.startswith("test_function7(a: int, b: int) -> None") + assert m.test_function7.__doc__.endswith("A custom docstring\n") + + # Suppression of user-defined docstrings for non-function objects + assert not m.DocstringTestFoo.__doc__ + assert not m.DocstringTestFoo.value_prop.__doc__ diff --git a/pybind11/tests/test_eigen.cpp b/pybind11/tests/test_eigen.cpp new file mode 100644 index 0000000000000000000000000000000000000000..fd1561c4fb0a9ec93306e102e2d13e9e559719cc --- /dev/null +++ b/pybind11/tests/test_eigen.cpp @@ -0,0 +1,395 @@ +/* + tests/eigen.cpp -- automatic conversion of Eigen types + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include <pybind11/eigen.h> +#include <pybind11/stl.h> + +#if defined(_MSC_VER) +# pragma warning(disable : 4996) // C4996: std::unary_negation is deprecated +#endif + +#include <Eigen/Cholesky> + +using MatrixXdR = Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>; + + +// Sets/resets a testing reference matrix to have values of 10*r + c, where r and c are the +// (1-based) row/column number. +template <typename M> +void reset_ref(M& x) +{ + for (int i = 0; i < x.rows(); i++) + for (int j = 0; j < x.cols(); j++) + x(i, j) = 11 + 10 * i + j; +} + +// Returns a static, column-major matrix +Eigen::MatrixXd& get_cm() +{ + static Eigen::MatrixXd* x; + if (!x) { + x = new Eigen::MatrixXd(3, 3); + reset_ref(*x); + } + return *x; +} +// Likewise, but row-major +MatrixXdR& get_rm() +{ + static MatrixXdR* x; + if (!x) { + x = new MatrixXdR(3, 3); + reset_ref(*x); + } + return *x; +} +// Resets the values of the static matrices returned by get_cm()/get_rm() +void reset_refs() +{ + reset_ref(get_cm()); + reset_ref(get_rm()); +} + +// Returns element 2,1 from a matrix (used to test copy/nocopy) +double get_elem(Eigen::Ref<const Eigen::MatrixXd> m) +{ + return m(2, 1); +}; + + +// Returns a matrix with 10*r + 100*c added to each matrix element (to help test that the matrix +// reference is referencing rows/columns correctly). +template <typename MatrixArgType> +Eigen::MatrixXd adjust_matrix(MatrixArgType m) +{ + Eigen::MatrixXd ret(m); + for (int c = 0; c < m.cols(); c++) + for (int r = 0; r < m.rows(); r++) + ret(r, c) += 10 * r + 100 * c; + return ret; +} + +struct CustomOperatorNew +{ + CustomOperatorNew() = default; + + Eigen::Matrix4d a = Eigen::Matrix4d::Zero(); + Eigen::Matrix4d b = Eigen::Matrix4d::Identity(); + + EIGEN_MAKE_ALIGNED_OPERATOR_NEW; +}; + +TEST_SUBMODULE(eigen, m) +{ + using FixedMatrixR = Eigen::Matrix<float, 5, 6, Eigen::RowMajor>; + using FixedMatrixC = Eigen::Matrix<float, 5, 6>; + using DenseMatrixR = Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>; + using DenseMatrixC = Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic>; + using FourRowMatrixC = Eigen::Matrix<float, 4, Eigen::Dynamic>; + using FourColMatrixC = Eigen::Matrix<float, Eigen::Dynamic, 4>; + using FourRowMatrixR = Eigen::Matrix<float, 4, Eigen::Dynamic>; + using FourColMatrixR = Eigen::Matrix<float, Eigen::Dynamic, 4>; + using SparseMatrixR = Eigen::SparseMatrix<float, Eigen::RowMajor>; + using SparseMatrixC = Eigen::SparseMatrix<float>; + + m.attr("have_eigen") = true; + + // various tests + m.def("double_col", [](const Eigen::VectorXf& x) -> Eigen::VectorXf { return 2.0f * x; }); + m.def("double_row", [](const Eigen::RowVectorXf& x) -> Eigen::RowVectorXf { return 2.0f * x; }); + m.def("double_complex", [](const Eigen::VectorXcf& x) -> Eigen::VectorXcf { return 2.0f * x; }); + m.def("double_threec", [](py::EigenDRef<Eigen::Vector3f> x) { x *= 2; }); + m.def("double_threer", [](py::EigenDRef<Eigen::RowVector3f> x) { x *= 2; }); + m.def("double_mat_cm", [](Eigen::MatrixXf x) -> Eigen::MatrixXf { return 2.0f * x; }); + m.def("double_mat_rm", [](DenseMatrixR x) -> DenseMatrixR { return 2.0f * x; }); + + // test_eigen_ref_to_python + // Different ways of passing via Eigen::Ref; the first and second are the Eigen-recommended + m.def("cholesky1", [](Eigen::Ref<MatrixXdR> x) -> Eigen::MatrixXd { return x.llt().matrixL(); }); + m.def("cholesky2", [](const Eigen::Ref<const MatrixXdR>& x) -> Eigen::MatrixXd { return x.llt().matrixL(); }); + m.def("cholesky3", [](const Eigen::Ref<MatrixXdR>& x) -> Eigen::MatrixXd { return x.llt().matrixL(); }); + m.def("cholesky4", [](Eigen::Ref<const MatrixXdR> x) -> Eigen::MatrixXd { return x.llt().matrixL(); }); + + // test_eigen_ref_mutators + // Mutators: these add some value to the given element using Eigen, but Eigen should be mapping into + // the numpy array data and so the result should show up there. There are three versions: one that + // works on a contiguous-row matrix (numpy's default), one for a contiguous-column matrix, and one + // for any matrix. + auto add_rm = [](Eigen::Ref<MatrixXdR> x, int r, int c, double v) { x(r, c) += v; }; + auto add_cm = [](Eigen::Ref<Eigen::MatrixXd> x, int r, int c, double v) { x(r, c) += v; }; + + // Mutators (Eigen maps into numpy variables): + m.def("add_rm", add_rm); // Only takes row-contiguous + m.def("add_cm", add_cm); // Only takes column-contiguous + // Overloaded versions that will accept either row or column contiguous: + m.def("add1", add_rm); + m.def("add1", add_cm); + m.def("add2", add_cm); + m.def("add2", add_rm); + // This one accepts a matrix of any stride: + m.def("add_any", [](py::EigenDRef<Eigen::MatrixXd> x, int r, int c, double v) { x(r, c) += v; }); + + // Return mutable references (numpy maps into eigen variables) + m.def("get_cm_ref", []() { return Eigen::Ref<Eigen::MatrixXd>(get_cm()); }); + m.def("get_rm_ref", []() { return Eigen::Ref<MatrixXdR>(get_rm()); }); + // The same references, but non-mutable (numpy maps into eigen variables, but is !writeable) + m.def("get_cm_const_ref", []() { return Eigen::Ref<const Eigen::MatrixXd>(get_cm()); }); + m.def("get_rm_const_ref", []() { return Eigen::Ref<const MatrixXdR>(get_rm()); }); + + m.def("reset_refs", reset_refs); // Restores get_{cm,rm}_ref to original values + + // Increments and returns ref to (same) matrix + m.def("incr_matrix", + [](Eigen::Ref<Eigen::MatrixXd> m, double v) { + m += Eigen::MatrixXd::Constant(m.rows(), m.cols(), v); + return m; + }, + py::return_value_policy::reference); + + // Same, but accepts a matrix of any strides + m.def("incr_matrix_any", + [](py::EigenDRef<Eigen::MatrixXd> m, double v) { + m += Eigen::MatrixXd::Constant(m.rows(), m.cols(), v); + return m; + }, + py::return_value_policy::reference); + + // Returns an eigen slice of even rows + m.def("even_rows", + [](py::EigenDRef<Eigen::MatrixXd> m) { + return py::EigenDMap<Eigen::MatrixXd>( + m.data(), (m.rows() + 1) / 2, m.cols(), py::EigenDStride(m.outerStride(), 2 * m.innerStride())); + }, + py::return_value_policy::reference); + + // Returns an eigen slice of even columns + m.def("even_cols", + [](py::EigenDRef<Eigen::MatrixXd> m) { + return py::EigenDMap<Eigen::MatrixXd>( + m.data(), m.rows(), (m.cols() + 1) / 2, py::EigenDStride(2 * m.outerStride(), m.innerStride())); + }, + py::return_value_policy::reference); + + // Returns diagonals: a vector-like object with an inner stride != 1 + m.def("diagonal", [](const Eigen::Ref<const Eigen::MatrixXd>& x) { return x.diagonal(); }); + m.def("diagonal_1", [](const Eigen::Ref<const Eigen::MatrixXd>& x) { return x.diagonal<1>(); }); + m.def("diagonal_n", [](const Eigen::Ref<const Eigen::MatrixXd>& x, int index) { return x.diagonal(index); }); + + // Return a block of a matrix (gives non-standard strides) + m.def("block", + [](const Eigen::Ref<const Eigen::MatrixXd>& x, int start_row, int start_col, int block_rows, int block_cols) { + return x.block(start_row, start_col, block_rows, block_cols); + }); + + // test_eigen_return_references, test_eigen_keepalive + // return value referencing/copying tests: + class ReturnTester + { + Eigen::MatrixXd mat = create(); + + public: + ReturnTester() + { + print_created(this); + } + ~ReturnTester() + { + print_destroyed(this); + } + static Eigen::MatrixXd create() + { + return Eigen::MatrixXd::Ones(10, 10); + } + static const Eigen::MatrixXd createConst() + { + return Eigen::MatrixXd::Ones(10, 10); + } + Eigen::MatrixXd& get() + { + return mat; + } + Eigen::MatrixXd* getPtr() + { + return &mat; + } + const Eigen::MatrixXd& view() + { + return mat; + } + const Eigen::MatrixXd* viewPtr() + { + return &mat; + } + Eigen::Ref<Eigen::MatrixXd> ref() + { + return mat; + } + Eigen::Ref<const Eigen::MatrixXd> refConst() + { + return mat; + } + Eigen::Block<Eigen::MatrixXd> block(int r, int c, int nrow, int ncol) + { + return mat.block(r, c, nrow, ncol); + } + Eigen::Block<const Eigen::MatrixXd> blockConst(int r, int c, int nrow, int ncol) const + { + return mat.block(r, c, nrow, ncol); + } + py::EigenDMap<Eigen::Matrix2d> corners() + { + return py::EigenDMap<Eigen::Matrix2d>( + mat.data(), + py::EigenDStride(mat.outerStride() * (mat.outerSize() - 1), mat.innerStride() * (mat.innerSize() - 1))); + } + py::EigenDMap<const Eigen::Matrix2d> cornersConst() const + { + return py::EigenDMap<const Eigen::Matrix2d>( + mat.data(), + py::EigenDStride(mat.outerStride() * (mat.outerSize() - 1), mat.innerStride() * (mat.innerSize() - 1))); + } + }; + using rvp = py::return_value_policy; + py::class_<ReturnTester>(m, "ReturnTester") + .def(py::init<>()) + .def_static("create", &ReturnTester::create) + .def_static("create_const", &ReturnTester::createConst) + .def("get", &ReturnTester::get, rvp::reference_internal) + .def("get_ptr", &ReturnTester::getPtr, rvp::reference_internal) + .def("view", &ReturnTester::view, rvp::reference_internal) + .def("view_ptr", &ReturnTester::view, rvp::reference_internal) + .def("copy_get", &ReturnTester::get) // Default rvp: copy + .def("copy_view", &ReturnTester::view) // " + .def("ref", &ReturnTester::ref) // Default for Ref is to reference + .def("ref_const", &ReturnTester::refConst) // Likewise, but const + .def("ref_safe", &ReturnTester::ref, rvp::reference_internal) + .def("ref_const_safe", &ReturnTester::refConst, rvp::reference_internal) + .def("copy_ref", &ReturnTester::ref, rvp::copy) + .def("copy_ref_const", &ReturnTester::refConst, rvp::copy) + .def("block", &ReturnTester::block) + .def("block_safe", &ReturnTester::block, rvp::reference_internal) + .def("block_const", &ReturnTester::blockConst, rvp::reference_internal) + .def("copy_block", &ReturnTester::block, rvp::copy) + .def("corners", &ReturnTester::corners, rvp::reference_internal) + .def("corners_const", &ReturnTester::cornersConst, rvp::reference_internal); + + // test_special_matrix_objects + // Returns a DiagonalMatrix with diagonal (1,2,3,...) + m.def("incr_diag", [](int k) { + Eigen::DiagonalMatrix<int, Eigen::Dynamic> m(k); + for (int i = 0; i < k; i++) + m.diagonal()[i] = i + 1; + return m; + }); + + // Returns a SelfAdjointView referencing the lower triangle of m + m.def("symmetric_lower", [](const Eigen::MatrixXi& m) { return m.selfadjointView<Eigen::Lower>(); }); + // Returns a SelfAdjointView referencing the lower triangle of m + m.def("symmetric_upper", [](const Eigen::MatrixXi& m) { return m.selfadjointView<Eigen::Upper>(); }); + + // Test matrix for various functions below. + Eigen::MatrixXf mat(5, 6); + mat << 0, 3, 0, 0, 0, 11, 22, 0, 0, 0, 17, 11, 7, 5, 0, 1, 0, 11, 0, 0, 0, 0, 0, 11, 0, 0, 14, 0, 8, 11; + + // test_fixed, and various other tests + m.def("fixed_r", [mat]() -> FixedMatrixR { return FixedMatrixR(mat); }); + m.def("fixed_r_const", [mat]() -> const FixedMatrixR { return FixedMatrixR(mat); }); + m.def("fixed_c", [mat]() -> FixedMatrixC { return FixedMatrixC(mat); }); + m.def("fixed_copy_r", [](const FixedMatrixR& m) -> FixedMatrixR { return m; }); + m.def("fixed_copy_c", [](const FixedMatrixC& m) -> FixedMatrixC { return m; }); + // test_mutator_descriptors + m.def("fixed_mutator_r", [](Eigen::Ref<FixedMatrixR>) {}); + m.def("fixed_mutator_c", [](Eigen::Ref<FixedMatrixC>) {}); + m.def("fixed_mutator_a", [](py::EigenDRef<FixedMatrixC>) {}); + // test_dense + m.def("dense_r", [mat]() -> DenseMatrixR { return DenseMatrixR(mat); }); + m.def("dense_c", [mat]() -> DenseMatrixC { return DenseMatrixC(mat); }); + m.def("dense_copy_r", [](const DenseMatrixR& m) -> DenseMatrixR { return m; }); + m.def("dense_copy_c", [](const DenseMatrixC& m) -> DenseMatrixC { return m; }); + // test_sparse, test_sparse_signature + m.def("sparse_r", [mat]() -> SparseMatrixR { return Eigen::SparseView<Eigen::MatrixXf>(mat); }); + m.def("sparse_c", [mat]() -> SparseMatrixC { return Eigen::SparseView<Eigen::MatrixXf>(mat); }); + m.def("sparse_copy_r", [](const SparseMatrixR& m) -> SparseMatrixR { return m; }); + m.def("sparse_copy_c", [](const SparseMatrixC& m) -> SparseMatrixC { return m; }); + // test_partially_fixed + m.def("partial_copy_four_rm_r", [](const FourRowMatrixR& m) -> FourRowMatrixR { return m; }); + m.def("partial_copy_four_rm_c", [](const FourColMatrixR& m) -> FourColMatrixR { return m; }); + m.def("partial_copy_four_cm_r", [](const FourRowMatrixC& m) -> FourRowMatrixC { return m; }); + m.def("partial_copy_four_cm_c", [](const FourColMatrixC& m) -> FourColMatrixC { return m; }); + + // test_cpp_casting + // Test that we can cast a numpy object to a Eigen::MatrixXd explicitly + m.def("cpp_copy", [](py::handle m) { return m.cast<Eigen::MatrixXd>()(1, 0); }); + m.def("cpp_ref_c", [](py::handle m) { return m.cast<Eigen::Ref<Eigen::MatrixXd>>()(1, 0); }); + m.def("cpp_ref_r", [](py::handle m) { return m.cast<Eigen::Ref<MatrixXdR>>()(1, 0); }); + m.def("cpp_ref_any", [](py::handle m) { return m.cast<py::EigenDRef<Eigen::MatrixXd>>()(1, 0); }); + + + // test_nocopy_wrapper + // Test that we can prevent copying into an argument that would normally copy: First a version + // that would allow copying (if types or strides don't match) for comparison: + m.def("get_elem", &get_elem); + // Now this alternative that calls the tells pybind to fail rather than copy: + m.def("get_elem_nocopy", + [](Eigen::Ref<const Eigen::MatrixXd> m) -> double { return get_elem(m); }, + py::arg().noconvert()); + // Also test a row-major-only no-copy const ref: + m.def("get_elem_rm_nocopy", + [](Eigen::Ref<const Eigen::Matrix<long, -1, -1, Eigen::RowMajor>>& m) -> long { return m(2, 1); }, + py::arg().noconvert()); + + // test_issue738 + // Issue #738: 1xN or Nx1 2D matrices were neither accepted nor properly copied with an + // incompatible stride value on the length-1 dimension--but that should be allowed (without + // requiring a copy!) because the stride value can be safely ignored on a size-1 dimension. + m.def("iss738_f1", &adjust_matrix<const Eigen::Ref<const Eigen::MatrixXd>&>, py::arg().noconvert()); + m.def("iss738_f2", + &adjust_matrix<const Eigen::Ref<const Eigen::Matrix<double, -1, -1, Eigen::RowMajor>>&>, + py::arg().noconvert()); + + // test_issue1105 + // Issue #1105: when converting from a numpy two-dimensional (Nx1) or (1xN) value into a dense + // eigen Vector or RowVector, the argument would fail to load because the numpy copy would fail: + // numpy won't broadcast a Nx1 into a 1-dimensional vector. + m.def("iss1105_col", [](Eigen::VectorXd) { return true; }); + m.def("iss1105_row", [](Eigen::RowVectorXd) { return true; }); + + // test_named_arguments + // Make sure named arguments are working properly: + m.def("matrix_multiply", + [](const py::EigenDRef<const Eigen::MatrixXd> A, + const py::EigenDRef<const Eigen::MatrixXd> B) -> Eigen::MatrixXd { + if (A.cols() != B.rows()) + throw std::domain_error("Nonconformable matrices!"); + return A * B; + }, + py::arg("A"), + py::arg("B")); + + // test_custom_operator_new + py::class_<CustomOperatorNew>(m, "CustomOperatorNew") + .def(py::init<>()) + .def_readonly("a", &CustomOperatorNew::a) + .def_readonly("b", &CustomOperatorNew::b); + + // test_eigen_ref_life_support + // In case of a failure (the caster's temp array does not live long enough), creating + // a new array (np.ones(10)) increases the chances that the temp array will be garbage + // collected and/or that its memory will be overridden with different values. + m.def("get_elem_direct", [](Eigen::Ref<const Eigen::VectorXd> v) { + py::module::import("numpy").attr("ones")(10); + return v(5); + }); + m.def("get_elem_indirect", [](std::vector<Eigen::Ref<const Eigen::VectorXd>> v) { + py::module::import("numpy").attr("ones")(10); + return v[0](5); + }); +} diff --git a/pybind11/tests/test_eigen.py b/pybind11/tests/test_eigen.py new file mode 100644 index 0000000000000000000000000000000000000000..286c5f711d81b3d746997e65c4cae0380b2a2952 --- /dev/null +++ b/pybind11/tests/test_eigen.py @@ -0,0 +1,684 @@ +import pytest +from pybind11_tests import ConstructorStats + +pytestmark = pytest.requires_eigen_and_numpy + +with pytest.suppress(ImportError): + from pybind11_tests import eigen as m + import numpy as np + + ref = np.array([[0., 3, 0, 0, 0, 11], [22, 0, 0, 0, 17, 11], [7, 5, 0, 1, 0, 11], [0, 0, 0, 0, 0, 11], + [0, 0, 14, 0, 8, 11]]) + + +def assert_equal_ref(mat): + np.testing.assert_array_equal(mat, ref) + + +def assert_sparse_equal_ref(sparse_mat): + assert_equal_ref(sparse_mat.toarray()) + + +def test_fixed(): + assert_equal_ref(m.fixed_c()) + assert_equal_ref(m.fixed_r()) + assert_equal_ref(m.fixed_copy_r(m.fixed_r())) + assert_equal_ref(m.fixed_copy_c(m.fixed_c())) + assert_equal_ref(m.fixed_copy_r(m.fixed_c())) + assert_equal_ref(m.fixed_copy_c(m.fixed_r())) + + +def test_dense(): + assert_equal_ref(m.dense_r()) + assert_equal_ref(m.dense_c()) + assert_equal_ref(m.dense_copy_r(m.dense_r())) + assert_equal_ref(m.dense_copy_c(m.dense_c())) + assert_equal_ref(m.dense_copy_r(m.dense_c())) + assert_equal_ref(m.dense_copy_c(m.dense_r())) + + +def test_partially_fixed(): + ref2 = np.array([[0., 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11], [12, 13, 14, 15]]) + np.testing.assert_array_equal(m.partial_copy_four_rm_r(ref2), ref2) + np.testing.assert_array_equal(m.partial_copy_four_rm_c(ref2), ref2) + np.testing.assert_array_equal(m.partial_copy_four_rm_r(ref2[:, 1]), ref2[:, [1]]) + np.testing.assert_array_equal(m.partial_copy_four_rm_c(ref2[0, :]), ref2[[0], :]) + np.testing.assert_array_equal(m.partial_copy_four_rm_r(ref2[:, (0, 2)]), ref2[:, (0, 2)]) + np.testing.assert_array_equal(m.partial_copy_four_rm_c(ref2[(3, 1, 2), :]), ref2[(3, 1, 2), :]) + + np.testing.assert_array_equal(m.partial_copy_four_cm_r(ref2), ref2) + np.testing.assert_array_equal(m.partial_copy_four_cm_c(ref2), ref2) + np.testing.assert_array_equal(m.partial_copy_four_cm_r(ref2[:, 1]), ref2[:, [1]]) + np.testing.assert_array_equal(m.partial_copy_four_cm_c(ref2[0, :]), ref2[[0], :]) + np.testing.assert_array_equal(m.partial_copy_four_cm_r(ref2[:, (0, 2)]), ref2[:, (0, 2)]) + np.testing.assert_array_equal(m.partial_copy_four_cm_c(ref2[(3, 1, 2), :]), ref2[(3, 1, 2), :]) + + # TypeError should be raise for a shape mismatch + functions = [ + m.partial_copy_four_rm_r, m.partial_copy_four_rm_c, m.partial_copy_four_cm_r, m.partial_copy_four_cm_c + ] + matrix_with_wrong_shape = [[1, 2], [3, 4]] + for f in functions: + with pytest.raises(TypeError) as excinfo: + f(matrix_with_wrong_shape) + assert "incompatible function arguments" in str(excinfo.value) + + +def test_mutator_descriptors(): + zr = np.arange(30, dtype='float32').reshape(5, 6) # row-major + zc = zr.reshape(6, 5).transpose() # column-major + + m.fixed_mutator_r(zr) + m.fixed_mutator_c(zc) + m.fixed_mutator_a(zr) + m.fixed_mutator_a(zc) + with pytest.raises(TypeError) as excinfo: + m.fixed_mutator_r(zc) + assert ('(arg0: numpy.ndarray[float32[5, 6], flags.writeable, flags.c_contiguous]) -> None' in str(excinfo.value)) + with pytest.raises(TypeError) as excinfo: + m.fixed_mutator_c(zr) + assert ('(arg0: numpy.ndarray[float32[5, 6], flags.writeable, flags.f_contiguous]) -> None' in str(excinfo.value)) + with pytest.raises(TypeError) as excinfo: + m.fixed_mutator_a(np.array([[1, 2], [3, 4]], dtype='float32')) + assert ('(arg0: numpy.ndarray[float32[5, 6], flags.writeable]) -> None' in str(excinfo.value)) + zr.flags.writeable = False + with pytest.raises(TypeError): + m.fixed_mutator_r(zr) + with pytest.raises(TypeError): + m.fixed_mutator_a(zr) + + +def test_cpp_casting(): + assert m.cpp_copy(m.fixed_r()) == 22. + assert m.cpp_copy(m.fixed_c()) == 22. + z = np.array([[5., 6], [7, 8]]) + assert m.cpp_copy(z) == 7. + assert m.cpp_copy(m.get_cm_ref()) == 21. + assert m.cpp_copy(m.get_rm_ref()) == 21. + assert m.cpp_ref_c(m.get_cm_ref()) == 21. + assert m.cpp_ref_r(m.get_rm_ref()) == 21. + with pytest.raises(RuntimeError) as excinfo: + # Can't reference m.fixed_c: it contains floats, m.cpp_ref_any wants doubles + m.cpp_ref_any(m.fixed_c()) + assert 'Unable to cast Python instance' in str(excinfo.value) + with pytest.raises(RuntimeError) as excinfo: + # Can't reference m.fixed_r: it contains floats, m.cpp_ref_any wants doubles + m.cpp_ref_any(m.fixed_r()) + assert 'Unable to cast Python instance' in str(excinfo.value) + assert m.cpp_ref_any(m.ReturnTester.create()) == 1. + + assert m.cpp_ref_any(m.get_cm_ref()) == 21. + assert m.cpp_ref_any(m.get_cm_ref()) == 21. + + +def test_pass_readonly_array(): + z = np.full((5, 6), 42.0) + z.flags.writeable = False + np.testing.assert_array_equal(z, m.fixed_copy_r(z)) + np.testing.assert_array_equal(m.fixed_r_const(), m.fixed_r()) + assert not m.fixed_r_const().flags.writeable + np.testing.assert_array_equal(m.fixed_copy_r(m.fixed_r_const()), m.fixed_r_const()) + + +def test_nonunit_stride_from_python(): + counting_mat = np.arange(9.0, dtype=np.float32).reshape((3, 3)) + second_row = counting_mat[1, :] + second_col = counting_mat[:, 1] + np.testing.assert_array_equal(m.double_row(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_col(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_complex(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_row(second_col), 2.0 * second_col) + np.testing.assert_array_equal(m.double_col(second_col), 2.0 * second_col) + np.testing.assert_array_equal(m.double_complex(second_col), 2.0 * second_col) + + counting_3d = np.arange(27.0, dtype=np.float32).reshape((3, 3, 3)) + slices = [counting_3d[0, :, :], counting_3d[:, 0, :], counting_3d[:, :, 0]] + for slice_idx, ref_mat in enumerate(slices): + np.testing.assert_array_equal(m.double_mat_cm(ref_mat), 2.0 * ref_mat) + np.testing.assert_array_equal(m.double_mat_rm(ref_mat), 2.0 * ref_mat) + + # Mutator: + m.double_threer(second_row) + m.double_threec(second_col) + np.testing.assert_array_equal(counting_mat, [[0., 2, 2], [6, 16, 10], [6, 14, 8]]) + + +def test_negative_stride_from_python(msg): + """Eigen doesn't support (as of yet) negative strides. When a function takes an Eigen matrix by + copy or const reference, we can pass a numpy array that has negative strides. Otherwise, an + exception will be thrown as Eigen will not be able to map the numpy array.""" + + counting_mat = np.arange(9.0, dtype=np.float32).reshape((3, 3)) + counting_mat = counting_mat[::-1, ::-1] + second_row = counting_mat[1, :] + second_col = counting_mat[:, 1] + np.testing.assert_array_equal(m.double_row(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_col(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_complex(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_row(second_col), 2.0 * second_col) + np.testing.assert_array_equal(m.double_col(second_col), 2.0 * second_col) + np.testing.assert_array_equal(m.double_complex(second_col), 2.0 * second_col) + + counting_3d = np.arange(27.0, dtype=np.float32).reshape((3, 3, 3)) + counting_3d = counting_3d[::-1, ::-1, ::-1] + slices = [counting_3d[0, :, :], counting_3d[:, 0, :], counting_3d[:, :, 0]] + for slice_idx, ref_mat in enumerate(slices): + np.testing.assert_array_equal(m.double_mat_cm(ref_mat), 2.0 * ref_mat) + np.testing.assert_array_equal(m.double_mat_rm(ref_mat), 2.0 * ref_mat) + + # Mutator: + with pytest.raises(TypeError) as excinfo: + m.double_threer(second_row) + assert msg(excinfo.value) == """ + double_threer(): incompatible function arguments. The following argument types are supported: + 1. (arg0: numpy.ndarray[float32[1, 3], flags.writeable]) -> None + + Invoked with: """ + repr(np.array([5., 4., 3.], dtype='float32')) # noqa: E501 line too long + + with pytest.raises(TypeError) as excinfo: + m.double_threec(second_col) + assert msg(excinfo.value) == """ + double_threec(): incompatible function arguments. The following argument types are supported: + 1. (arg0: numpy.ndarray[float32[3, 1], flags.writeable]) -> None + + Invoked with: """ + repr(np.array([7., 4., 1.], dtype='float32')) # noqa: E501 line too long + + +def test_nonunit_stride_to_python(): + assert np.all(m.diagonal(ref) == ref.diagonal()) + assert np.all(m.diagonal_1(ref) == ref.diagonal(1)) + for i in range(-5, 7): + assert np.all(m.diagonal_n(ref, i) == ref.diagonal(i)), "m.diagonal_n({})".format(i) + + assert np.all(m.block(ref, 2, 1, 3, 3) == ref[2:5, 1:4]) + assert np.all(m.block(ref, 1, 4, 4, 2) == ref[1:, 4:]) + assert np.all(m.block(ref, 1, 4, 3, 2) == ref[1:4, 4:]) + + +def test_eigen_ref_to_python(): + chols = [m.cholesky1, m.cholesky2, m.cholesky3, m.cholesky4] + for i, chol in enumerate(chols, start=1): + mymat = chol(np.array([[1., 2, 4], [2, 13, 23], [4, 23, 77]])) + assert np.all(mymat == np.array([[1, 0, 0], [2, 3, 0], [4, 5, 6]])), "cholesky{}".format(i) + + +def assign_both(a1, a2, r, c, v): + a1[r, c] = v + a2[r, c] = v + + +def array_copy_but_one(a, r, c, v): + z = np.array(a, copy=True) + z[r, c] = v + return z + + +def test_eigen_return_references(): + """Tests various ways of returning references and non-referencing copies""" + + master = np.ones((10, 10)) + a = m.ReturnTester() + a_get1 = a.get() + assert not a_get1.flags.owndata and a_get1.flags.writeable + assign_both(a_get1, master, 3, 3, 5) + a_get2 = a.get_ptr() + assert not a_get2.flags.owndata and a_get2.flags.writeable + assign_both(a_get1, master, 2, 3, 6) + + a_view1 = a.view() + assert not a_view1.flags.owndata and not a_view1.flags.writeable + with pytest.raises(ValueError): + a_view1[2, 3] = 4 + a_view2 = a.view_ptr() + assert not a_view2.flags.owndata and not a_view2.flags.writeable + with pytest.raises(ValueError): + a_view2[2, 3] = 4 + + a_copy1 = a.copy_get() + assert a_copy1.flags.owndata and a_copy1.flags.writeable + np.testing.assert_array_equal(a_copy1, master) + a_copy1[7, 7] = -44 # Shouldn't affect anything else + c1want = array_copy_but_one(master, 7, 7, -44) + a_copy2 = a.copy_view() + assert a_copy2.flags.owndata and a_copy2.flags.writeable + np.testing.assert_array_equal(a_copy2, master) + a_copy2[4, 4] = -22 # Shouldn't affect anything else + c2want = array_copy_but_one(master, 4, 4, -22) + + a_ref1 = a.ref() + assert not a_ref1.flags.owndata and a_ref1.flags.writeable + assign_both(a_ref1, master, 1, 1, 15) + a_ref2 = a.ref_const() + assert not a_ref2.flags.owndata and not a_ref2.flags.writeable + with pytest.raises(ValueError): + a_ref2[5, 5] = 33 + a_ref3 = a.ref_safe() + assert not a_ref3.flags.owndata and a_ref3.flags.writeable + assign_both(a_ref3, master, 0, 7, 99) + a_ref4 = a.ref_const_safe() + assert not a_ref4.flags.owndata and not a_ref4.flags.writeable + with pytest.raises(ValueError): + a_ref4[7, 0] = 987654321 + + a_copy3 = a.copy_ref() + assert a_copy3.flags.owndata and a_copy3.flags.writeable + np.testing.assert_array_equal(a_copy3, master) + a_copy3[8, 1] = 11 + c3want = array_copy_but_one(master, 8, 1, 11) + a_copy4 = a.copy_ref_const() + assert a_copy4.flags.owndata and a_copy4.flags.writeable + np.testing.assert_array_equal(a_copy4, master) + a_copy4[8, 4] = 88 + c4want = array_copy_but_one(master, 8, 4, 88) + + a_block1 = a.block(3, 3, 2, 2) + assert not a_block1.flags.owndata and a_block1.flags.writeable + a_block1[0, 0] = 55 + master[3, 3] = 55 + a_block2 = a.block_safe(2, 2, 3, 2) + assert not a_block2.flags.owndata and a_block2.flags.writeable + a_block2[2, 1] = -123 + master[4, 3] = -123 + a_block3 = a.block_const(6, 7, 4, 3) + assert not a_block3.flags.owndata and not a_block3.flags.writeable + with pytest.raises(ValueError): + a_block3[2, 2] = -44444 + + a_copy5 = a.copy_block(2, 2, 2, 3) + assert a_copy5.flags.owndata and a_copy5.flags.writeable + np.testing.assert_array_equal(a_copy5, master[2:4, 2:5]) + a_copy5[1, 1] = 777 + c5want = array_copy_but_one(master[2:4, 2:5], 1, 1, 777) + + a_corn1 = a.corners() + assert not a_corn1.flags.owndata and a_corn1.flags.writeable + a_corn1 *= 50 + a_corn1[1, 1] = 999 + master[0, 0] = 50 + master[0, 9] = 50 + master[9, 0] = 50 + master[9, 9] = 999 + a_corn2 = a.corners_const() + assert not a_corn2.flags.owndata and not a_corn2.flags.writeable + with pytest.raises(ValueError): + a_corn2[1, 0] = 51 + + # All of the changes made all the way along should be visible everywhere + # now (except for the copies, of course) + np.testing.assert_array_equal(a_get1, master) + np.testing.assert_array_equal(a_get2, master) + np.testing.assert_array_equal(a_view1, master) + np.testing.assert_array_equal(a_view2, master) + np.testing.assert_array_equal(a_ref1, master) + np.testing.assert_array_equal(a_ref2, master) + np.testing.assert_array_equal(a_ref3, master) + np.testing.assert_array_equal(a_ref4, master) + np.testing.assert_array_equal(a_block1, master[3:5, 3:5]) + np.testing.assert_array_equal(a_block2, master[2:5, 2:4]) + np.testing.assert_array_equal(a_block3, master[6:10, 7:10]) + np.testing.assert_array_equal(a_corn1, master[0::master.shape[0] - 1, 0::master.shape[1] - 1]) + np.testing.assert_array_equal(a_corn2, master[0::master.shape[0] - 1, 0::master.shape[1] - 1]) + + np.testing.assert_array_equal(a_copy1, c1want) + np.testing.assert_array_equal(a_copy2, c2want) + np.testing.assert_array_equal(a_copy3, c3want) + np.testing.assert_array_equal(a_copy4, c4want) + np.testing.assert_array_equal(a_copy5, c5want) + + +def assert_keeps_alive(cl, method, *args): + cstats = ConstructorStats.get(cl) + start_with = cstats.alive() + a = cl() + assert cstats.alive() == start_with + 1 + z = method(a, *args) + assert cstats.alive() == start_with + 1 + del a + # Here's the keep alive in action: + assert cstats.alive() == start_with + 1 + del z + # Keep alive should have expired: + assert cstats.alive() == start_with + + +def test_eigen_keepalive(): + a = m.ReturnTester() + cstats = ConstructorStats.get(m.ReturnTester) + assert cstats.alive() == 1 + unsafe = [a.ref(), a.ref_const(), a.block(1, 2, 3, 4)] + copies = [a.copy_get(), a.copy_view(), a.copy_ref(), a.copy_ref_const(), a.copy_block(4, 3, 2, 1)] + del a + assert cstats.alive() == 0 + del unsafe + del copies + + for meth in [ + m.ReturnTester.get, m.ReturnTester.get_ptr, m.ReturnTester.view, m.ReturnTester.view_ptr, + m.ReturnTester.ref_safe, m.ReturnTester.ref_const_safe, m.ReturnTester.corners, + m.ReturnTester.corners_const + ]: + assert_keeps_alive(m.ReturnTester, meth) + + for meth in [m.ReturnTester.block_safe, m.ReturnTester.block_const]: + assert_keeps_alive(m.ReturnTester, meth, 4, 3, 2, 1) + + +def test_eigen_ref_mutators(): + """Tests Eigen's ability to mutate numpy values""" + + orig = np.array([[1., 2, 3], [4, 5, 6], [7, 8, 9]]) + zr = np.array(orig) + zc = np.array(orig, order='F') + m.add_rm(zr, 1, 0, 100) + assert np.all(zr == np.array([[1., 2, 3], [104, 5, 6], [7, 8, 9]])) + m.add_cm(zc, 1, 0, 200) + assert np.all(zc == np.array([[1., 2, 3], [204, 5, 6], [7, 8, 9]])) + + m.add_any(zr, 1, 0, 20) + assert np.all(zr == np.array([[1., 2, 3], [124, 5, 6], [7, 8, 9]])) + m.add_any(zc, 1, 0, 10) + assert np.all(zc == np.array([[1., 2, 3], [214, 5, 6], [7, 8, 9]])) + + # Can't reference a col-major array with a row-major Ref, and vice versa: + with pytest.raises(TypeError): + m.add_rm(zc, 1, 0, 1) + with pytest.raises(TypeError): + m.add_cm(zr, 1, 0, 1) + + # Overloads: + m.add1(zr, 1, 0, -100) + m.add2(zr, 1, 0, -20) + assert np.all(zr == orig) + m.add1(zc, 1, 0, -200) + m.add2(zc, 1, 0, -10) + assert np.all(zc == orig) + + # a non-contiguous slice (this won't work on either the row- or + # column-contiguous refs, but should work for the any) + cornersr = zr[0::2, 0::2] + cornersc = zc[0::2, 0::2] + + assert np.all(cornersr == np.array([[1., 3], [7, 9]])) + assert np.all(cornersc == np.array([[1., 3], [7, 9]])) + + with pytest.raises(TypeError): + m.add_rm(cornersr, 0, 1, 25) + with pytest.raises(TypeError): + m.add_cm(cornersr, 0, 1, 25) + with pytest.raises(TypeError): + m.add_rm(cornersc, 0, 1, 25) + with pytest.raises(TypeError): + m.add_cm(cornersc, 0, 1, 25) + m.add_any(cornersr, 0, 1, 25) + m.add_any(cornersc, 0, 1, 44) + assert np.all(zr == np.array([[1., 2, 28], [4, 5, 6], [7, 8, 9]])) + assert np.all(zc == np.array([[1., 2, 47], [4, 5, 6], [7, 8, 9]])) + + # You shouldn't be allowed to pass a non-writeable array to a mutating Eigen method: + zro = zr[0:4, 0:4] + zro.flags.writeable = False + with pytest.raises(TypeError): + m.add_rm(zro, 0, 0, 0) + with pytest.raises(TypeError): + m.add_any(zro, 0, 0, 0) + with pytest.raises(TypeError): + m.add1(zro, 0, 0, 0) + with pytest.raises(TypeError): + m.add2(zro, 0, 0, 0) + + # integer array shouldn't be passable to a double-matrix-accepting mutating func: + zi = np.array([[1, 2], [3, 4]]) + with pytest.raises(TypeError): + m.add_rm(zi) + + +def test_numpy_ref_mutators(): + """Tests numpy mutating Eigen matrices (for returned Eigen::Ref<...>s)""" + + m.reset_refs() # In case another test already changed it + + zc = m.get_cm_ref() + zcro = m.get_cm_const_ref() + zr = m.get_rm_ref() + zrro = m.get_rm_const_ref() + + assert [zc[1, 2], zcro[1, 2], zr[1, 2], zrro[1, 2]] == [23] * 4 + + assert not zc.flags.owndata and zc.flags.writeable + assert not zr.flags.owndata and zr.flags.writeable + assert not zcro.flags.owndata and not zcro.flags.writeable + assert not zrro.flags.owndata and not zrro.flags.writeable + + zc[1, 2] = 99 + expect = np.array([[11., 12, 13], [21, 22, 99], [31, 32, 33]]) + # We should have just changed zc, of course, but also zcro and the original eigen matrix + assert np.all(zc == expect) + assert np.all(zcro == expect) + assert np.all(m.get_cm_ref() == expect) + + zr[1, 2] = 99 + assert np.all(zr == expect) + assert np.all(zrro == expect) + assert np.all(m.get_rm_ref() == expect) + + # Make sure the readonly ones are numpy-readonly: + with pytest.raises(ValueError): + zcro[1, 2] = 6 + with pytest.raises(ValueError): + zrro[1, 2] = 6 + + # We should be able to explicitly copy like this (and since we're copying, + # the const should drop away) + y1 = np.array(m.get_cm_const_ref()) + + assert y1.flags.owndata and y1.flags.writeable + # We should get copies of the eigen data, which was modified above: + assert y1[1, 2] == 99 + y1[1, 2] += 12 + assert y1[1, 2] == 111 + assert zc[1, 2] == 99 # Make sure we aren't referencing the original + + +def test_both_ref_mutators(): + """Tests a complex chain of nested eigen/numpy references""" + + m.reset_refs() # In case another test already changed it + + z = m.get_cm_ref() # numpy -> eigen + z[0, 2] -= 3 + z2 = m.incr_matrix(z, 1) # numpy -> eigen -> numpy -> eigen + z2[1, 1] += 6 + z3 = m.incr_matrix(z, 2) # (numpy -> eigen)^3 + z3[2, 2] += -5 + z4 = m.incr_matrix(z, 3) # (numpy -> eigen)^4 + z4[1, 1] -= 1 + z5 = m.incr_matrix(z, 4) # (numpy -> eigen)^5 + z5[0, 0] = 0 + assert np.all(z == z2) + assert np.all(z == z3) + assert np.all(z == z4) + assert np.all(z == z5) + expect = np.array([[0., 22, 20], [31, 37, 33], [41, 42, 38]]) + assert np.all(z == expect) + + y = np.array(range(100), dtype='float64').reshape(10, 10) + y2 = m.incr_matrix_any(y, 10) # np -> eigen -> np + y3 = m.incr_matrix_any(y2[0::2, 0::2], -33) # np -> eigen -> np slice -> np -> eigen -> np + y4 = m.even_rows(y3) # numpy -> eigen slice -> (... y3) + y5 = m.even_cols(y4) # numpy -> eigen slice -> (... y4) + y6 = m.incr_matrix_any(y5, 1000) # numpy -> eigen -> (... y5) + + # Apply same mutations using just numpy: + yexpect = np.array(range(100), dtype='float64').reshape(10, 10) + yexpect += 10 + yexpect[0::2, 0::2] -= 33 + yexpect[0::4, 0::4] += 1000 + assert np.all(y6 == yexpect[0::4, 0::4]) + assert np.all(y5 == yexpect[0::4, 0::4]) + assert np.all(y4 == yexpect[0::4, 0::2]) + assert np.all(y3 == yexpect[0::2, 0::2]) + assert np.all(y2 == yexpect) + assert np.all(y == yexpect) + + +def test_nocopy_wrapper(): + # get_elem requires a column-contiguous matrix reference, but should be + # callable with other types of matrix (via copying): + int_matrix_colmajor = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]], order='F') + dbl_matrix_colmajor = np.array(int_matrix_colmajor, dtype='double', order='F', copy=True) + int_matrix_rowmajor = np.array(int_matrix_colmajor, order='C', copy=True) + dbl_matrix_rowmajor = np.array(int_matrix_rowmajor, dtype='double', order='C', copy=True) + + # All should be callable via get_elem: + assert m.get_elem(int_matrix_colmajor) == 8 + assert m.get_elem(dbl_matrix_colmajor) == 8 + assert m.get_elem(int_matrix_rowmajor) == 8 + assert m.get_elem(dbl_matrix_rowmajor) == 8 + + # All but the second should fail with m.get_elem_nocopy: + with pytest.raises(TypeError) as excinfo: + m.get_elem_nocopy(int_matrix_colmajor) + assert ('get_elem_nocopy(): incompatible function arguments.' in str(excinfo.value) + and ', flags.f_contiguous' in str(excinfo.value)) + assert m.get_elem_nocopy(dbl_matrix_colmajor) == 8 + with pytest.raises(TypeError) as excinfo: + m.get_elem_nocopy(int_matrix_rowmajor) + assert ('get_elem_nocopy(): incompatible function arguments.' in str(excinfo.value) + and ', flags.f_contiguous' in str(excinfo.value)) + with pytest.raises(TypeError) as excinfo: + m.get_elem_nocopy(dbl_matrix_rowmajor) + assert ('get_elem_nocopy(): incompatible function arguments.' in str(excinfo.value) + and ', flags.f_contiguous' in str(excinfo.value)) + + # For the row-major test, we take a long matrix in row-major, so only the third is allowed: + with pytest.raises(TypeError) as excinfo: + m.get_elem_rm_nocopy(int_matrix_colmajor) + assert ('get_elem_rm_nocopy(): incompatible function arguments.' in str(excinfo.value) + and ', flags.c_contiguous' in str(excinfo.value)) + with pytest.raises(TypeError) as excinfo: + m.get_elem_rm_nocopy(dbl_matrix_colmajor) + assert ('get_elem_rm_nocopy(): incompatible function arguments.' in str(excinfo.value) + and ', flags.c_contiguous' in str(excinfo.value)) + assert m.get_elem_rm_nocopy(int_matrix_rowmajor) == 8 + with pytest.raises(TypeError) as excinfo: + m.get_elem_rm_nocopy(dbl_matrix_rowmajor) + assert ('get_elem_rm_nocopy(): incompatible function arguments.' in str(excinfo.value) + and ', flags.c_contiguous' in str(excinfo.value)) + + +def test_eigen_ref_life_support(): + """Ensure the lifetime of temporary arrays created by the `Ref` caster + + The `Ref` caster sometimes creates a copy which needs to stay alive. This needs to + happen both for directs casts (just the array) or indirectly (e.g. list of arrays). + """ + + a = np.full(shape=10, fill_value=8, dtype=np.int8) + assert m.get_elem_direct(a) == 8 + + list_of_a = [a] + assert m.get_elem_indirect(list_of_a) == 8 + + +def test_special_matrix_objects(): + assert np.all(m.incr_diag(7) == np.diag([1., 2, 3, 4, 5, 6, 7])) + + asymm = np.array([[1., 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12], [13, 14, 15, 16]]) + symm_lower = np.array(asymm) + symm_upper = np.array(asymm) + for i in range(4): + for j in range(i + 1, 4): + symm_lower[i, j] = symm_lower[j, i] + symm_upper[j, i] = symm_upper[i, j] + + assert np.all(m.symmetric_lower(asymm) == symm_lower) + assert np.all(m.symmetric_upper(asymm) == symm_upper) + + +def test_dense_signature(doc): + assert doc(m.double_col) == """ + double_col(arg0: numpy.ndarray[float32[m, 1]]) -> numpy.ndarray[float32[m, 1]] + """ + assert doc(m.double_row) == """ + double_row(arg0: numpy.ndarray[float32[1, n]]) -> numpy.ndarray[float32[1, n]] + """ + assert doc(m.double_complex) == """ + double_complex(arg0: numpy.ndarray[complex64[m, 1]]) -> numpy.ndarray[complex64[m, 1]] + """ + assert doc(m.double_mat_rm) == """ + double_mat_rm(arg0: numpy.ndarray[float32[m, n]]) -> numpy.ndarray[float32[m, n]] + """ + + +def test_named_arguments(): + a = np.array([[1.0, 2], [3, 4], [5, 6]]) + b = np.ones((2, 1)) + + assert np.all(m.matrix_multiply(a, b) == np.array([[3.], [7], [11]])) + assert np.all(m.matrix_multiply(A=a, B=b) == np.array([[3.], [7], [11]])) + assert np.all(m.matrix_multiply(B=b, A=a) == np.array([[3.], [7], [11]])) + + with pytest.raises(ValueError) as excinfo: + m.matrix_multiply(b, a) + assert str(excinfo.value) == 'Nonconformable matrices!' + + with pytest.raises(ValueError) as excinfo: + m.matrix_multiply(A=b, B=a) + assert str(excinfo.value) == 'Nonconformable matrices!' + + with pytest.raises(ValueError) as excinfo: + m.matrix_multiply(B=a, A=b) + assert str(excinfo.value) == 'Nonconformable matrices!' + + +@pytest.requires_eigen_and_scipy +def test_sparse(): + assert_sparse_equal_ref(m.sparse_r()) + assert_sparse_equal_ref(m.sparse_c()) + assert_sparse_equal_ref(m.sparse_copy_r(m.sparse_r())) + assert_sparse_equal_ref(m.sparse_copy_c(m.sparse_c())) + assert_sparse_equal_ref(m.sparse_copy_r(m.sparse_c())) + assert_sparse_equal_ref(m.sparse_copy_c(m.sparse_r())) + + +@pytest.requires_eigen_and_scipy +def test_sparse_signature(doc): + assert doc(m.sparse_copy_r) == """ + sparse_copy_r(arg0: scipy.sparse.csr_matrix[float32]) -> scipy.sparse.csr_matrix[float32] + """ # noqa: E501 line too long + assert doc(m.sparse_copy_c) == """ + sparse_copy_c(arg0: scipy.sparse.csc_matrix[float32]) -> scipy.sparse.csc_matrix[float32] + """ # noqa: E501 line too long + + +def test_issue738(): + """Ignore strides on a length-1 dimension (even if they would be incompatible length > 1)""" + assert np.all(m.iss738_f1(np.array([[1., 2, 3]])) == np.array([[1., 102, 203]])) + assert np.all(m.iss738_f1(np.array([[1.], [2], [3]])) == np.array([[1.], [12], [23]])) + + assert np.all(m.iss738_f2(np.array([[1., 2, 3]])) == np.array([[1., 102, 203]])) + assert np.all(m.iss738_f2(np.array([[1.], [2], [3]])) == np.array([[1.], [12], [23]])) + + +def test_issue1105(): + """Issue 1105: 1xN or Nx1 input arrays weren't accepted for eigen + compile-time row vectors or column vector""" + assert m.iss1105_row(np.ones((1, 7))) + assert m.iss1105_col(np.ones((7, 1))) + + # These should still fail (incompatible dimensions): + with pytest.raises(TypeError) as excinfo: + m.iss1105_row(np.ones((7, 1))) + assert "incompatible function arguments" in str(excinfo) + with pytest.raises(TypeError) as excinfo: + m.iss1105_col(np.ones((1, 7))) + assert "incompatible function arguments" in str(excinfo) + + +def test_custom_operator_new(): + """Using Eigen types as member variables requires a class-specific + operator new with proper alignment""" + + o = m.CustomOperatorNew() + np.testing.assert_allclose(o.a, 0.0) + np.testing.assert_allclose(o.b.diagonal(), 1.0) diff --git a/pybind11/tests/test_embed/CMakeLists.txt b/pybind11/tests/test_embed/CMakeLists.txt new file mode 100644 index 0000000000000000000000000000000000000000..7f48cf8ef7177e421cad314ba4ea8b1824916322 --- /dev/null +++ b/pybind11/tests/test_embed/CMakeLists.txt @@ -0,0 +1,37 @@ +if(${PYTHON_MODULE_EXTENSION} MATCHES "pypy") + add_custom_target(cpptest) # Dummy target on PyPy. Embedding is not supported. + set(_suppress_unused_variable_warning "${DOWNLOAD_CATCH}") + return() +endif() + +find_package(Catch 1.9.3) +if(CATCH_FOUND) + message(STATUS "Building interpreter tests using Catch v${CATCH_VERSION}") +else() + message(STATUS "Catch not detected. Interpreter tests will be skipped. Install Catch headers" + " manually or use `cmake -DDOWNLOAD_CATCH=1` to fetch them automatically.") + return() +endif() + +add_executable(test_embed catch.cpp test_interpreter.cpp) +target_include_directories(test_embed PRIVATE ${CATCH_INCLUDE_DIR}) +pybind11_enable_warnings(test_embed) + +if(NOT CMAKE_VERSION VERSION_LESS 3.0) + target_link_libraries(test_embed PRIVATE pybind11::embed) +else() + target_include_directories(test_embed PRIVATE ${PYBIND11_INCLUDE_DIR} ${PYTHON_INCLUDE_DIRS}) + target_compile_options(test_embed PRIVATE ${PYBIND11_CPP_STANDARD}) + target_link_libraries(test_embed PRIVATE ${PYTHON_LIBRARIES}) +endif() + +find_package(Threads REQUIRED) +target_link_libraries(test_embed PUBLIC ${CMAKE_THREAD_LIBS_INIT}) + +add_custom_target(cpptest COMMAND $<TARGET_FILE:test_embed> WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + +pybind11_add_module(external_module THIN_LTO external_module.cpp) +set_target_properties(external_module PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) +add_dependencies(cpptest external_module) + +add_dependencies(check cpptest) diff --git a/pybind11/tests/test_embed/catch.cpp b/pybind11/tests/test_embed/catch.cpp new file mode 100644 index 0000000000000000000000000000000000000000..245c2d8f1bc0b6a4b1c6107071600ec8c8a9d913 --- /dev/null +++ b/pybind11/tests/test_embed/catch.cpp @@ -0,0 +1,23 @@ +// The Catch implementation is compiled here. This is a standalone +// translation unit to avoid recompiling it for every test change. + +#include <pybind11/embed.h> + +#ifdef _MSC_VER +// Silence MSVC C++17 deprecation warning from Catch regarding std::uncaught_exceptions (up to catch +// 2.0.1; this should be fixed in the next catch release after 2.0.1). +# pragma warning(disable : 4996) +#endif + +#define CATCH_CONFIG_RUNNER +#include <catch.hpp> + +namespace py = pybind11; + +int main(int argc, char* argv[]) +{ + py::scoped_interpreter guard{}; + auto result = Catch::Session().run(argc, argv); + + return result < 0xff ? result : 0xff; +} diff --git a/pybind11/tests/test_embed/external_module.cpp b/pybind11/tests/test_embed/external_module.cpp new file mode 100644 index 0000000000000000000000000000000000000000..18f03c284ea394c9fa4190a627dc63a029ef7c47 --- /dev/null +++ b/pybind11/tests/test_embed/external_module.cpp @@ -0,0 +1,22 @@ +#include <pybind11/pybind11.h> + +namespace py = pybind11; + +/* Simple test module/test class to check that the referenced internals data of external pybind11 + * modules aren't preserved over a finalize/initialize. + */ + +PYBIND11_MODULE(external_module, m) +{ + class A + { + public: + A(int value) + : v{value} {}; + int v; + }; + + py::class_<A>(m, "A").def(py::init<int>()).def_readwrite("value", &A::v); + + m.def("internals_at", []() { return reinterpret_cast<uintptr_t>(&py::detail::get_internals()); }); +} diff --git a/pybind11/tests/test_embed/test_interpreter.cpp b/pybind11/tests/test_embed/test_interpreter.cpp new file mode 100644 index 0000000000000000000000000000000000000000..1947044fa3aea7fc468ff27a16c1efd70d50e7ff --- /dev/null +++ b/pybind11/tests/test_embed/test_interpreter.cpp @@ -0,0 +1,312 @@ +#include <pybind11/embed.h> + +#ifdef _MSC_VER +// Silence MSVC C++17 deprecation warning from Catch regarding std::uncaught_exceptions (up to catch +// 2.0.1; this should be fixed in the next catch release after 2.0.1). +# pragma warning(disable : 4996) +#endif + +#include <catch.hpp> + +#include <thread> +#include <fstream> +#include <functional> + +namespace py = pybind11; +using namespace py::literals; + +class Widget +{ +public: + Widget(std::string message) + : message(message) + {} + virtual ~Widget() = default; + + std::string the_message() const + { + return message; + } + virtual int the_answer() const = 0; + +private: + std::string message; +}; + +class PyWidget final : public Widget +{ + using Widget::Widget; + + int the_answer() const override + { + PYBIND11_OVERLOAD_PURE(int, Widget, the_answer); + } +}; + +PYBIND11_EMBEDDED_MODULE(widget_module, m) +{ + py::class_<Widget, PyWidget>(m, "Widget") + .def(py::init<std::string>()) + .def_property_readonly("the_message", &Widget::the_message); + + m.def("add", [](int i, int j) { return i + j; }); +} + +PYBIND11_EMBEDDED_MODULE(throw_exception, ) +{ + throw std::runtime_error("C++ Error"); +} + +PYBIND11_EMBEDDED_MODULE(throw_error_already_set, ) +{ + auto d = py::dict(); + d["missing"].cast<py::object>(); +} + +TEST_CASE("Pass classes and data between modules defined in C++ and Python") +{ + auto module = py::module::import("test_interpreter"); + REQUIRE(py::hasattr(module, "DerivedWidget")); + + auto locals = py::dict("hello"_a = "Hello, World!", "x"_a = 5, **module.attr("__dict__")); + py::exec(R"( + widget = DerivedWidget("{} - {}".format(hello, x)) + message = widget.the_message + )", + py::globals(), + locals); + REQUIRE(locals["message"].cast<std::string>() == "Hello, World! - 5"); + + auto py_widget = module.attr("DerivedWidget")("The question"); + auto message = py_widget.attr("the_message"); + REQUIRE(message.cast<std::string>() == "The question"); + + const auto& cpp_widget = py_widget.cast<const Widget&>(); + REQUIRE(cpp_widget.the_answer() == 42); +} + +TEST_CASE("Import error handling") +{ + REQUIRE_NOTHROW(py::module::import("widget_module")); + REQUIRE_THROWS_WITH(py::module::import("throw_exception"), "ImportError: C++ Error"); + REQUIRE_THROWS_WITH(py::module::import("throw_error_already_set"), Catch::Contains("ImportError: KeyError")); +} + +TEST_CASE("There can be only one interpreter") +{ + static_assert(std::is_move_constructible<py::scoped_interpreter>::value, ""); + static_assert(!std::is_move_assignable<py::scoped_interpreter>::value, ""); + static_assert(!std::is_copy_constructible<py::scoped_interpreter>::value, ""); + static_assert(!std::is_copy_assignable<py::scoped_interpreter>::value, ""); + + REQUIRE_THROWS_WITH(py::initialize_interpreter(), "The interpreter is already running"); + REQUIRE_THROWS_WITH(py::scoped_interpreter(), "The interpreter is already running"); + + py::finalize_interpreter(); + REQUIRE_NOTHROW(py::scoped_interpreter()); + { + auto pyi1 = py::scoped_interpreter(); + auto pyi2 = std::move(pyi1); + } + py::initialize_interpreter(); +} + +bool has_pybind11_internals_builtin() +{ + auto builtins = py::handle(PyEval_GetBuiltins()); + return builtins.contains(PYBIND11_INTERNALS_ID); +}; + +bool has_pybind11_internals_static() +{ + auto**& ipp = py::detail::get_internals_pp(); + return ipp && *ipp; +} + +TEST_CASE("Restart the interpreter") +{ + // Verify pre-restart state. + REQUIRE(py::module::import("widget_module").attr("add")(1, 2).cast<int>() == 3); + REQUIRE(has_pybind11_internals_builtin()); + REQUIRE(has_pybind11_internals_static()); + REQUIRE(py::module::import("external_module").attr("A")(123).attr("value").cast<int>() == 123); + + // local and foreign module internals should point to the same internals: + REQUIRE(reinterpret_cast<uintptr_t>(*py::detail::get_internals_pp()) + == py::module::import("external_module").attr("internals_at")().cast<uintptr_t>()); + + // Restart the interpreter. + py::finalize_interpreter(); + REQUIRE(Py_IsInitialized() == 0); + + py::initialize_interpreter(); + REQUIRE(Py_IsInitialized() == 1); + + // Internals are deleted after a restart. + REQUIRE_FALSE(has_pybind11_internals_builtin()); + REQUIRE_FALSE(has_pybind11_internals_static()); + pybind11::detail::get_internals(); + REQUIRE(has_pybind11_internals_builtin()); + REQUIRE(has_pybind11_internals_static()); + REQUIRE(reinterpret_cast<uintptr_t>(*py::detail::get_internals_pp()) + == py::module::import("external_module").attr("internals_at")().cast<uintptr_t>()); + + // Make sure that an interpreter with no get_internals() created until finalize still gets the + // internals destroyed + py::finalize_interpreter(); + py::initialize_interpreter(); + bool ran = false; + py::module::import("__main__").attr("internals_destroy_test") = py::capsule(&ran, [](void* ran) { + py::detail::get_internals(); + *static_cast<bool*>(ran) = true; + }); + REQUIRE_FALSE(has_pybind11_internals_builtin()); + REQUIRE_FALSE(has_pybind11_internals_static()); + REQUIRE_FALSE(ran); + py::finalize_interpreter(); + REQUIRE(ran); + py::initialize_interpreter(); + REQUIRE_FALSE(has_pybind11_internals_builtin()); + REQUIRE_FALSE(has_pybind11_internals_static()); + + // C++ modules can be reloaded. + auto cpp_module = py::module::import("widget_module"); + REQUIRE(cpp_module.attr("add")(1, 2).cast<int>() == 3); + + // C++ type information is reloaded and can be used in python modules. + auto py_module = py::module::import("test_interpreter"); + auto py_widget = py_module.attr("DerivedWidget")("Hello after restart"); + REQUIRE(py_widget.attr("the_message").cast<std::string>() == "Hello after restart"); +} + +TEST_CASE("Subinterpreter") +{ + // Add tags to the modules in the main interpreter and test the basics. + py::module::import("__main__").attr("main_tag") = "main interpreter"; + { + auto m = py::module::import("widget_module"); + m.attr("extension_module_tag") = "added to module in main interpreter"; + + REQUIRE(m.attr("add")(1, 2).cast<int>() == 3); + } + REQUIRE(has_pybind11_internals_builtin()); + REQUIRE(has_pybind11_internals_static()); + + /// Create and switch to a subinterpreter. + auto main_tstate = PyThreadState_Get(); + auto sub_tstate = Py_NewInterpreter(); + + // Subinterpreters get their own copy of builtins. detail::get_internals() still + // works by returning from the static variable, i.e. all interpreters share a single + // global pybind11::internals; + REQUIRE_FALSE(has_pybind11_internals_builtin()); + REQUIRE(has_pybind11_internals_static()); + + // Modules tags should be gone. + REQUIRE_FALSE(py::hasattr(py::module::import("__main__"), "tag")); + { + auto m = py::module::import("widget_module"); + REQUIRE_FALSE(py::hasattr(m, "extension_module_tag")); + + // Function bindings should still work. + REQUIRE(m.attr("add")(1, 2).cast<int>() == 3); + } + + // Restore main interpreter. + Py_EndInterpreter(sub_tstate); + PyThreadState_Swap(main_tstate); + + REQUIRE(py::hasattr(py::module::import("__main__"), "main_tag")); + REQUIRE(py::hasattr(py::module::import("widget_module"), "extension_module_tag")); +} + +TEST_CASE("Execution frame") +{ + // When the interpreter is embedded, there is no execution frame, but `py::exec` + // should still function by using reasonable globals: `__main__.__dict__`. + py::exec("var = dict(number=42)"); + REQUIRE(py::globals()["var"]["number"].cast<int>() == 42); +} + +TEST_CASE("Threads") +{ + // Restart interpreter to ensure threads are not initialized + py::finalize_interpreter(); + py::initialize_interpreter(); + REQUIRE_FALSE(has_pybind11_internals_static()); + + constexpr auto num_threads = 10; + auto locals = py::dict("count"_a = 0); + + { + py::gil_scoped_release gil_release{}; + REQUIRE(has_pybind11_internals_static()); + + auto threads = std::vector<std::thread>(); + for (auto i = 0; i < num_threads; ++i) { + threads.emplace_back([&]() { + py::gil_scoped_acquire gil{}; + locals["count"] = locals["count"].cast<int>() + 1; + }); + } + + for (auto& thread : threads) { + thread.join(); + } + } + + REQUIRE(locals["count"].cast<int>() == num_threads); +} + +// Scope exit utility https://stackoverflow.com/a/36644501/7255855 +struct scope_exit +{ + std::function<void()> f_; + explicit scope_exit(std::function<void()> f) noexcept + : f_(std::move(f)) + {} + ~scope_exit() + { + if (f_) + f_(); + } +}; + +TEST_CASE("Reload module from file") +{ + // Disable generation of cached bytecode (.pyc files) for this test, otherwise + // Python might pick up an old version from the cache instead of the new versions + // of the .py files generated below + auto sys = py::module::import("sys"); + bool dont_write_bytecode = sys.attr("dont_write_bytecode").cast<bool>(); + sys.attr("dont_write_bytecode") = true; + // Reset the value at scope exit + scope_exit reset_dont_write_bytecode([&]() { sys.attr("dont_write_bytecode") = dont_write_bytecode; }); + + std::string module_name = "test_module_reload"; + std::string module_file = module_name + ".py"; + + // Create the module .py file + std::ofstream test_module(module_file); + test_module << "def test():\n"; + test_module << " return 1\n"; + test_module.close(); + // Delete the file at scope exit + scope_exit delete_module_file([&]() { std::remove(module_file.c_str()); }); + + // Import the module from file + auto module = py::module::import(module_name.c_str()); + int result = module.attr("test")().cast<int>(); + REQUIRE(result == 1); + + // Update the module .py file with a small change + test_module.open(module_file); + test_module << "def test():\n"; + test_module << " return 2\n"; + test_module.close(); + + // Reload the module + module.reload(); + result = module.attr("test")().cast<int>(); + REQUIRE(result == 2); +} diff --git a/pybind11/tests/test_embed/test_interpreter.py b/pybind11/tests/test_embed/test_interpreter.py new file mode 100644 index 0000000000000000000000000000000000000000..191b19495bf0b06d414f3f319e0bd781f9b6166d --- /dev/null +++ b/pybind11/tests/test_embed/test_interpreter.py @@ -0,0 +1,10 @@ +from widget_module import Widget + + +class DerivedWidget(Widget): + + def __init__(self, message): + super(DerivedWidget, self).__init__(message) + + def the_answer(self): + return 42 diff --git a/pybind11/tests/test_enum.cpp b/pybind11/tests/test_enum.cpp new file mode 100644 index 0000000000000000000000000000000000000000..f93114beeb767711ba72ab0290ef55507191111f --- /dev/null +++ b/pybind11/tests/test_enum.cpp @@ -0,0 +1,93 @@ +/* + tests/test_enums.cpp -- enumerations + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +TEST_SUBMODULE(enums, m) +{ + // test_unscoped_enum + enum UnscopedEnum + { + EOne = 1, + ETwo + }; + py::enum_<UnscopedEnum>(m, "UnscopedEnum", py::arithmetic(), "An unscoped enumeration") + .value("EOne", EOne, "Docstring for EOne") + .value("ETwo", ETwo, "Docstring for ETwo") + .export_values(); + + // test_scoped_enum + enum class ScopedEnum + { + Two = 2, + Three + }; + py::enum_<ScopedEnum>(m, "ScopedEnum", py::arithmetic()) + .value("Two", ScopedEnum::Two) + .value("Three", ScopedEnum::Three); + + m.def("test_scoped_enum", + [](ScopedEnum z) { return "ScopedEnum::" + std::string(z == ScopedEnum::Two ? "Two" : "Three"); }); + + // test_binary_operators + enum Flags + { + Read = 4, + Write = 2, + Execute = 1 + }; + py::enum_<Flags>(m, "Flags", py::arithmetic()) + .value("Read", Flags::Read) + .value("Write", Flags::Write) + .value("Execute", Flags::Execute) + .export_values(); + + // test_implicit_conversion + class ClassWithUnscopedEnum + { + public: + enum EMode + { + EFirstMode = 1, + ESecondMode + }; + + static EMode test_function(EMode mode) + { + return mode; + } + }; + py::class_<ClassWithUnscopedEnum> exenum_class(m, "ClassWithUnscopedEnum"); + exenum_class.def_static("test_function", &ClassWithUnscopedEnum::test_function); + py::enum_<ClassWithUnscopedEnum::EMode>(exenum_class, "EMode") + .value("EFirstMode", ClassWithUnscopedEnum::EFirstMode) + .value("ESecondMode", ClassWithUnscopedEnum::ESecondMode) + .export_values(); + + // test_enum_to_int + m.def("test_enum_to_int", [](int) {}); + m.def("test_enum_to_uint", [](uint32_t) {}); + m.def("test_enum_to_long_long", [](long long) {}); + + // test_duplicate_enum_name + enum SimpleEnum + { + ONE, + TWO, + THREE + }; + + m.def("register_bad_enum", [m]() { + py::enum_<SimpleEnum>(m, "SimpleEnum") + .value("ONE", SimpleEnum::ONE) // NOTE: all value function calls are called with the same first parameter value + .value("ONE", SimpleEnum::TWO) + .value("ONE", SimpleEnum::THREE) + .export_values(); + }); +} diff --git a/pybind11/tests/test_enum.py b/pybind11/tests/test_enum.py new file mode 100644 index 0000000000000000000000000000000000000000..d0989adcdbcc04f626babd9c9d96636099404b06 --- /dev/null +++ b/pybind11/tests/test_enum.py @@ -0,0 +1,167 @@ +import pytest +from pybind11_tests import enums as m + + +def test_unscoped_enum(): + assert str(m.UnscopedEnum.EOne) == "UnscopedEnum.EOne" + assert str(m.UnscopedEnum.ETwo) == "UnscopedEnum.ETwo" + assert str(m.EOne) == "UnscopedEnum.EOne" + + # name property + assert m.UnscopedEnum.EOne.name == "EOne" + assert m.UnscopedEnum.ETwo.name == "ETwo" + assert m.EOne.name == "EOne" + # name readonly + with pytest.raises(AttributeError): + m.UnscopedEnum.EOne.name = "" + # name returns a copy + foo = m.UnscopedEnum.EOne.name + foo = "bar" + assert m.UnscopedEnum.EOne.name == "EOne" + + # __members__ property + assert m.UnscopedEnum.__members__ == \ + {"EOne": m.UnscopedEnum.EOne, "ETwo": m.UnscopedEnum.ETwo} + # __members__ readonly + with pytest.raises(AttributeError): + m.UnscopedEnum.__members__ = {} + # __members__ returns a copy + foo = m.UnscopedEnum.__members__ + foo["bar"] = "baz" + assert m.UnscopedEnum.__members__ == \ + {"EOne": m.UnscopedEnum.EOne, "ETwo": m.UnscopedEnum.ETwo} + + assert m.UnscopedEnum.__doc__ == \ + '''An unscoped enumeration + +Members: + + EOne : Docstring for EOne + + ETwo : Docstring for ETwo''' or m.UnscopedEnum.__doc__ == \ + '''An unscoped enumeration + +Members: + + ETwo : Docstring for ETwo + + EOne : Docstring for EOne''' + + # Unscoped enums will accept ==/!= int comparisons + y = m.UnscopedEnum.ETwo + assert y == 2 + assert 2 == y + assert y != 3 + assert 3 != y + + assert int(m.UnscopedEnum.ETwo) == 2 + assert str(m.UnscopedEnum(2)) == "UnscopedEnum.ETwo" + + # order + assert m.UnscopedEnum.EOne < m.UnscopedEnum.ETwo + assert m.UnscopedEnum.EOne < 2 + assert m.UnscopedEnum.ETwo > m.UnscopedEnum.EOne + assert m.UnscopedEnum.ETwo > 1 + assert m.UnscopedEnum.ETwo <= 2 + assert m.UnscopedEnum.ETwo >= 2 + assert m.UnscopedEnum.EOne <= m.UnscopedEnum.ETwo + assert m.UnscopedEnum.EOne <= 2 + assert m.UnscopedEnum.ETwo >= m.UnscopedEnum.EOne + assert m.UnscopedEnum.ETwo >= 1 + assert not (m.UnscopedEnum.ETwo < m.UnscopedEnum.EOne) + assert not (2 < m.UnscopedEnum.EOne) + + +def test_scoped_enum(): + assert m.test_scoped_enum(m.ScopedEnum.Three) == "ScopedEnum::Three" + z = m.ScopedEnum.Two + assert m.test_scoped_enum(z) == "ScopedEnum::Two" + + # Scoped enums will *NOT* accept ==/!= int comparisons (Will always return False) + assert not z == 3 + assert not 3 == z + assert z != 3 + assert 3 != z + # Scoped enums will *NOT* accept >, <, >= and <= int comparisons (Will throw exceptions) + with pytest.raises(TypeError): + z > 3 + with pytest.raises(TypeError): + z < 3 + with pytest.raises(TypeError): + z >= 3 + with pytest.raises(TypeError): + z <= 3 + + # order + assert m.ScopedEnum.Two < m.ScopedEnum.Three + assert m.ScopedEnum.Three > m.ScopedEnum.Two + assert m.ScopedEnum.Two <= m.ScopedEnum.Three + assert m.ScopedEnum.Two <= m.ScopedEnum.Two + assert m.ScopedEnum.Two >= m.ScopedEnum.Two + assert m.ScopedEnum.Three >= m.ScopedEnum.Two + + +def test_implicit_conversion(): + assert str(m.ClassWithUnscopedEnum.EMode.EFirstMode) == "EMode.EFirstMode" + assert str(m.ClassWithUnscopedEnum.EFirstMode) == "EMode.EFirstMode" + + f = m.ClassWithUnscopedEnum.test_function + first = m.ClassWithUnscopedEnum.EFirstMode + second = m.ClassWithUnscopedEnum.ESecondMode + + assert f(first) == 1 + + assert f(first) == f(first) + assert not f(first) != f(first) + + assert f(first) != f(second) + assert not f(first) == f(second) + + assert f(first) == int(f(first)) + assert not f(first) != int(f(first)) + + assert f(first) != int(f(second)) + assert not f(first) == int(f(second)) + + # noinspection PyDictCreation + x = {f(first): 1, f(second): 2} + x[f(first)] = 3 + x[f(second)] = 4 + # Hashing test + assert str(x) == "{EMode.EFirstMode: 3, EMode.ESecondMode: 4}" + + +def test_binary_operators(): + assert int(m.Flags.Read) == 4 + assert int(m.Flags.Write) == 2 + assert int(m.Flags.Execute) == 1 + assert int(m.Flags.Read | m.Flags.Write | m.Flags.Execute) == 7 + assert int(m.Flags.Read | m.Flags.Write) == 6 + assert int(m.Flags.Read | m.Flags.Execute) == 5 + assert int(m.Flags.Write | m.Flags.Execute) == 3 + assert int(m.Flags.Write | 1) == 3 + + state = m.Flags.Read | m.Flags.Write + assert (state & m.Flags.Read) != 0 + assert (state & m.Flags.Write) != 0 + assert (state & m.Flags.Execute) == 0 + assert (state & 1) == 0 + + state2 = ~state + assert state2 == -7 + assert int(state ^ state2) == -1 + + +def test_enum_to_int(): + m.test_enum_to_int(m.Flags.Read) + m.test_enum_to_int(m.ClassWithUnscopedEnum.EMode.EFirstMode) + m.test_enum_to_uint(m.Flags.Read) + m.test_enum_to_uint(m.ClassWithUnscopedEnum.EMode.EFirstMode) + m.test_enum_to_long_long(m.Flags.Read) + m.test_enum_to_long_long(m.ClassWithUnscopedEnum.EMode.EFirstMode) + + +def test_duplicate_enum_name(): + with pytest.raises(ValueError) as excinfo: + m.register_bad_enum() + assert str(excinfo.value) == 'SimpleEnum: element "ONE" already exists!' diff --git a/pybind11/tests/test_eval.cpp b/pybind11/tests/test_eval.cpp new file mode 100644 index 0000000000000000000000000000000000000000..1f8585f5da11baac82a279cd6038ed1f17aaf700 --- /dev/null +++ b/pybind11/tests/test_eval.cpp @@ -0,0 +1,88 @@ +/* + tests/test_eval.cpp -- Usage of eval() and eval_file() + + Copyright (c) 2016 Klemens D. Morgenstern + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + + +#include <pybind11/eval.h> +#include "pybind11_tests.h" + +TEST_SUBMODULE(eval_, m) +{ + // test_evals + + auto global = py::dict(py::module::import("__main__").attr("__dict__")); + + m.def("test_eval_statements", [global]() { + auto local = py::dict(); + local["call_test"] = py::cpp_function([&]() -> int { return 42; }); + + // Regular string literal + py::exec("message = 'Hello World!'\n" + "x = call_test()", + global, + local); + + // Multi-line raw string literal + py::exec(R"( + if x == 42: + print(message) + else: + raise RuntimeError + )", + global, + local); + auto x = local["x"].cast<int>(); + + return x == 42; + }); + + m.def("test_eval", [global]() { + auto local = py::dict(); + local["x"] = py::int_(42); + auto x = py::eval("x", global, local); + return x.cast<int>() == 42; + }); + + m.def("test_eval_single_statement", []() { + auto local = py::dict(); + local["call_test"] = py::cpp_function([&]() -> int { return 42; }); + + auto result = py::eval<py::eval_single_statement>("x = call_test()", py::dict(), local); + auto x = local["x"].cast<int>(); + return result.is_none() && x == 42; + }); + + m.def("test_eval_file", [global](py::str filename) { + auto local = py::dict(); + local["y"] = py::int_(43); + + int val_out; + local["call_test2"] = py::cpp_function([&](int value) { val_out = value; }); + + auto result = py::eval_file(filename, global, local); + return val_out == 43 && result.is_none(); + }); + + m.def("test_eval_failure", []() { + try { + py::eval("nonsense code ..."); + } catch (py::error_already_set&) { + return true; + } + return false; + }); + + m.def("test_eval_file_failure", []() { + try { + py::eval_file("non-existing file"); + } catch (std::exception&) { + return true; + } + return false; + }); +} diff --git a/pybind11/tests/test_eval.py b/pybind11/tests/test_eval.py new file mode 100644 index 0000000000000000000000000000000000000000..bda4ef6bf6aef3054cd28aeca79504f07a8f814e --- /dev/null +++ b/pybind11/tests/test_eval.py @@ -0,0 +1,17 @@ +import os +from pybind11_tests import eval_ as m + + +def test_evals(capture): + with capture: + assert m.test_eval_statements() + assert capture == "Hello World!" + + assert m.test_eval() + assert m.test_eval_single_statement() + + filename = os.path.join(os.path.dirname(__file__), "test_eval_call.py") + assert m.test_eval_file(filename) + + assert m.test_eval_failure() + assert m.test_eval_file_failure() diff --git a/pybind11/tests/test_eval_call.py b/pybind11/tests/test_eval_call.py new file mode 100644 index 0000000000000000000000000000000000000000..fef36a3f159d9625f78266f5159a69fa0710a61b --- /dev/null +++ b/pybind11/tests/test_eval_call.py @@ -0,0 +1,4 @@ +# This file is called from 'test_eval.py' + +if 'call_test2' in locals(): + call_test2(y) # noqa: F821 undefined name diff --git a/pybind11/tests/test_exceptions.cpp b/pybind11/tests/test_exceptions.cpp new file mode 100644 index 0000000000000000000000000000000000000000..690fcf66706150605fbf6ff3626de75c5aadbf4b --- /dev/null +++ b/pybind11/tests/test_exceptions.cpp @@ -0,0 +1,236 @@ +/* + tests/test_custom-exceptions.cpp -- exception translation + + Copyright (c) 2016 Pim Schellart <P.Schellart@princeton.edu> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +// A type that should be raised as an exception in Python +class MyException : public std::exception +{ +public: + explicit MyException(const char* m) + : message{m} + {} + virtual const char* what() const noexcept override + { + return message.c_str(); + } + +private: + std::string message = ""; +}; + +// A type that should be translated to a standard Python exception +class MyException2 : public std::exception +{ +public: + explicit MyException2(const char* m) + : message{m} + {} + virtual const char* what() const noexcept override + { + return message.c_str(); + } + +private: + std::string message = ""; +}; + +// A type that is not derived from std::exception (and is thus unknown) +class MyException3 +{ +public: + explicit MyException3(const char* m) + : message{m} + {} + virtual const char* what() const noexcept + { + return message.c_str(); + } + +private: + std::string message = ""; +}; + +// A type that should be translated to MyException +// and delegated to its exception translator +class MyException4 : public std::exception +{ +public: + explicit MyException4(const char* m) + : message{m} + {} + virtual const char* what() const noexcept override + { + return message.c_str(); + } + +private: + std::string message = ""; +}; + + +// Like the above, but declared via the helper function +class MyException5 : public std::logic_error +{ +public: + explicit MyException5(const std::string& what) + : std::logic_error(what) + {} +}; + +// Inherits from MyException5 +class MyException5_1 : public MyException5 +{ + using MyException5::MyException5; +}; + +struct PythonCallInDestructor +{ + PythonCallInDestructor(const py::dict& d) + : d(d) + {} + ~PythonCallInDestructor() + { + d["good"] = true; + } + + py::dict d; +}; + +TEST_SUBMODULE(exceptions, m) +{ + m.def("throw_std_exception", []() { throw std::runtime_error("This exception was intentionally thrown."); }); + + // make a new custom exception and use it as a translation target + static py::exception<MyException> ex(m, "MyException"); + py::register_exception_translator([](std::exception_ptr p) { + try { + if (p) + std::rethrow_exception(p); + } catch (const MyException& e) { + // Set MyException as the active python error + ex(e.what()); + } + }); + + // register new translator for MyException2 + // no need to store anything here because this type will + // never by visible from Python + py::register_exception_translator([](std::exception_ptr p) { + try { + if (p) + std::rethrow_exception(p); + } catch (const MyException2& e) { + // Translate this exception to a standard RuntimeError + PyErr_SetString(PyExc_RuntimeError, e.what()); + } + }); + + // register new translator for MyException4 + // which will catch it and delegate to the previously registered + // translator for MyException by throwing a new exception + py::register_exception_translator([](std::exception_ptr p) { + try { + if (p) + std::rethrow_exception(p); + } catch (const MyException4& e) { + throw MyException(e.what()); + } + }); + + // A simple exception translation: + auto ex5 = py::register_exception<MyException5>(m, "MyException5"); + // A slightly more complicated one that declares MyException5_1 as a subclass of MyException5 + py::register_exception<MyException5_1>(m, "MyException5_1", ex5.ptr()); + + m.def("throws1", []() { throw MyException("this error should go to a custom type"); }); + m.def("throws2", []() { throw MyException2("this error should go to a standard Python exception"); }); + m.def("throws3", []() { throw MyException3("this error cannot be translated"); }); + m.def("throws4", []() { throw MyException4("this error is rethrown"); }); + m.def("throws5", []() { throw MyException5("this is a helper-defined translated exception"); }); + m.def("throws5_1", []() { throw MyException5_1("MyException5 subclass"); }); + m.def("throws_logic_error", + []() { throw std::logic_error("this error should fall through to the standard handler"); }); + m.def("exception_matches", []() { + py::dict foo; + try { + // Assign to a py::object to force read access of nonexistent dict entry + py::object o = foo["bar"]; + } catch (py::error_already_set& ex) { + if (!ex.matches(PyExc_KeyError)) + throw; + return true; + } + return false; + }); + m.def("exception_matches_base", []() { + py::dict foo; + try { + // Assign to a py::object to force read access of nonexistent dict entry + py::object o = foo["bar"]; + } catch (py::error_already_set& ex) { + if (!ex.matches(PyExc_Exception)) + throw; + return true; + } + return false; + }); + m.def("modulenotfound_exception_matches_base", []() { + try { + // On Python >= 3.6, this raises a ModuleNotFoundError, a subclass of ImportError + py::module::import("nonexistent"); + } catch (py::error_already_set& ex) { + if (!ex.matches(PyExc_ImportError)) + throw; + return true; + } + return false; + }); + + m.def("throw_already_set", [](bool err) { + if (err) + PyErr_SetString(PyExc_ValueError, "foo"); + try { + throw py::error_already_set(); + } catch (const std::runtime_error& e) { + if ((err && e.what() != std::string("ValueError: foo")) + || (!err && e.what() != std::string("Unknown internal error occurred"))) { + PyErr_Clear(); + throw std::runtime_error("error message mismatch"); + } + } + PyErr_Clear(); + if (err) + PyErr_SetString(PyExc_ValueError, "foo"); + throw py::error_already_set(); + }); + + m.def("python_call_in_destructor", [](py::dict d) { + try { + PythonCallInDestructor set_dict_in_destructor(d); + PyErr_SetString(PyExc_ValueError, "foo"); + throw py::error_already_set(); + } catch (const py::error_already_set&) { + return true; + } + return false; + }); + + // test_nested_throws + m.def("try_catch", [m](py::object exc_type, py::function f, py::args args) { + try { + f(*args); + } catch (py::error_already_set& ex) { + if (ex.matches(exc_type)) + py::print(ex.what()); + else + throw; + } + }); +} diff --git a/pybind11/tests/test_exceptions.py b/pybind11/tests/test_exceptions.py new file mode 100644 index 0000000000000000000000000000000000000000..e61cab7bea3bb7cec4801515e1f4eb96ef7ed5d3 --- /dev/null +++ b/pybind11/tests/test_exceptions.py @@ -0,0 +1,145 @@ +import pytest + +from pybind11_tests import exceptions as m +import pybind11_cross_module_tests as cm + + +def test_std_exception(msg): + with pytest.raises(RuntimeError) as excinfo: + m.throw_std_exception() + assert msg(excinfo.value) == "This exception was intentionally thrown." + + +def test_error_already_set(msg): + with pytest.raises(RuntimeError) as excinfo: + m.throw_already_set(False) + assert msg(excinfo.value) == "Unknown internal error occurred" + + with pytest.raises(ValueError) as excinfo: + m.throw_already_set(True) + assert msg(excinfo.value) == "foo" + + +def test_cross_module_exceptions(): + with pytest.raises(RuntimeError) as excinfo: + cm.raise_runtime_error() + assert str(excinfo.value) == "My runtime error" + + with pytest.raises(ValueError) as excinfo: + cm.raise_value_error() + assert str(excinfo.value) == "My value error" + + with pytest.raises(ValueError) as excinfo: + cm.throw_pybind_value_error() + assert str(excinfo.value) == "pybind11 value error" + + with pytest.raises(TypeError) as excinfo: + cm.throw_pybind_type_error() + assert str(excinfo.value) == "pybind11 type error" + + with pytest.raises(StopIteration) as excinfo: + cm.throw_stop_iteration() + + +def test_python_call_in_catch(): + d = {} + assert m.python_call_in_destructor(d) is True + assert d["good"] is True + + +def test_exception_matches(): + assert m.exception_matches() + assert m.exception_matches_base() + assert m.modulenotfound_exception_matches_base() + + +def test_custom(msg): + # Can we catch a MyException? + with pytest.raises(m.MyException) as excinfo: + m.throws1() + assert msg(excinfo.value) == "this error should go to a custom type" + + # Can we translate to standard Python exceptions? + with pytest.raises(RuntimeError) as excinfo: + m.throws2() + assert msg(excinfo.value) == "this error should go to a standard Python exception" + + # Can we handle unknown exceptions? + with pytest.raises(RuntimeError) as excinfo: + m.throws3() + assert msg(excinfo.value) == "Caught an unknown exception!" + + # Can we delegate to another handler by rethrowing? + with pytest.raises(m.MyException) as excinfo: + m.throws4() + assert msg(excinfo.value) == "this error is rethrown" + + # Can we fall-through to the default handler? + with pytest.raises(RuntimeError) as excinfo: + m.throws_logic_error() + assert msg(excinfo.value) == "this error should fall through to the standard handler" + + # Can we handle a helper-declared exception? + with pytest.raises(m.MyException5) as excinfo: + m.throws5() + assert msg(excinfo.value) == "this is a helper-defined translated exception" + + # Exception subclassing: + with pytest.raises(m.MyException5) as excinfo: + m.throws5_1() + assert msg(excinfo.value) == "MyException5 subclass" + assert isinstance(excinfo.value, m.MyException5_1) + + with pytest.raises(m.MyException5_1) as excinfo: + m.throws5_1() + assert msg(excinfo.value) == "MyException5 subclass" + + with pytest.raises(m.MyException5) as excinfo: + try: + m.throws5() + except m.MyException5_1: + raise RuntimeError("Exception error: caught child from parent") + assert msg(excinfo.value) == "this is a helper-defined translated exception" + + +def test_nested_throws(capture): + """Tests nested (e.g. C++ -> Python -> C++) exception handling""" + + def throw_myex(): + raise m.MyException("nested error") + + def throw_myex5(): + raise m.MyException5("nested error 5") + + # In the comments below, the exception is caught in the first step, thrown in the last step + + # C++ -> Python + with capture: + m.try_catch(m.MyException5, throw_myex5) + assert str(capture).startswith("MyException5: nested error 5") + + # Python -> C++ -> Python + with pytest.raises(m.MyException) as excinfo: + m.try_catch(m.MyException5, throw_myex) + assert str(excinfo.value) == "nested error" + + def pycatch(exctype, f, *args): + try: + f(*args) + except m.MyException as e: + print(e) + + # C++ -> Python -> C++ -> Python + with capture: + m.try_catch(m.MyException5, pycatch, m.MyException, m.try_catch, m.MyException, throw_myex5) + assert str(capture).startswith("MyException5: nested error 5") + + # C++ -> Python -> C++ + with capture: + m.try_catch(m.MyException, pycatch, m.MyException5, m.throws4) + assert capture == "this error is rethrown" + + # Python -> C++ -> Python -> C++ + with pytest.raises(m.MyException5) as excinfo: + m.try_catch(m.MyException, pycatch, m.MyException, m.throws5) + assert str(excinfo.value) == "this is a helper-defined translated exception" diff --git a/pybind11/tests/test_factory_constructors.cpp b/pybind11/tests/test_factory_constructors.cpp new file mode 100644 index 0000000000000000000000000000000000000000..f386faec21e733ccf3fbe2288ad79c32d407b786 --- /dev/null +++ b/pybind11/tests/test_factory_constructors.cpp @@ -0,0 +1,577 @@ +/* + tests/test_factory_constructors.cpp -- tests construction from a factory function + via py::init_factory() + + Copyright (c) 2017 Jason Rhinelander <jason@imaginary.ca> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include <cmath> + +// Classes for testing python construction via C++ factory function: +// Not publicly constructible, copyable, or movable: +class TestFactory1 +{ + friend class TestFactoryHelper; + TestFactory1() + : value("(empty)") + { + print_default_created(this); + } + TestFactory1(int v) + : value(std::to_string(v)) + { + print_created(this, value); + } + TestFactory1(std::string v) + : value(std::move(v)) + { + print_created(this, value); + } + TestFactory1(TestFactory1&&) = delete; + TestFactory1(const TestFactory1&) = delete; + TestFactory1& operator=(TestFactory1&&) = delete; + TestFactory1& operator=(const TestFactory1&) = delete; + +public: + std::string value; + ~TestFactory1() + { + print_destroyed(this); + } +}; +// Non-public construction, but moveable: +class TestFactory2 +{ + friend class TestFactoryHelper; + TestFactory2() + : value("(empty2)") + { + print_default_created(this); + } + TestFactory2(int v) + : value(std::to_string(v)) + { + print_created(this, value); + } + TestFactory2(std::string v) + : value(std::move(v)) + { + print_created(this, value); + } + +public: + TestFactory2(TestFactory2&& m) + { + value = std::move(m.value); + print_move_created(this); + } + TestFactory2& operator=(TestFactory2&& m) + { + value = std::move(m.value); + print_move_assigned(this); + return *this; + } + std::string value; + ~TestFactory2() + { + print_destroyed(this); + } +}; +// Mixed direct/factory construction: +class TestFactory3 +{ +protected: + friend class TestFactoryHelper; + TestFactory3() + : value("(empty3)") + { + print_default_created(this); + } + TestFactory3(int v) + : value(std::to_string(v)) + { + print_created(this, value); + } + +public: + TestFactory3(std::string v) + : value(std::move(v)) + { + print_created(this, value); + } + TestFactory3(TestFactory3&& m) + { + value = std::move(m.value); + print_move_created(this); + } + TestFactory3& operator=(TestFactory3&& m) + { + value = std::move(m.value); + print_move_assigned(this); + return *this; + } + std::string value; + virtual ~TestFactory3() + { + print_destroyed(this); + } +}; +// Inheritance test +class TestFactory4 : public TestFactory3 +{ +public: + TestFactory4() + : TestFactory3() + { + print_default_created(this); + } + TestFactory4(int v) + : TestFactory3(v) + { + print_created(this, v); + } + virtual ~TestFactory4() + { + print_destroyed(this); + } +}; +// Another class for an invalid downcast test +class TestFactory5 : public TestFactory3 +{ +public: + TestFactory5(int i) + : TestFactory3(i) + { + print_created(this, i); + } + virtual ~TestFactory5() + { + print_destroyed(this); + } +}; + +class TestFactory6 +{ +protected: + int value; + bool alias = false; + +public: + TestFactory6(int i) + : value{i} + { + print_created(this, i); + } + TestFactory6(TestFactory6&& f) + { + print_move_created(this); + value = f.value; + alias = f.alias; + } + TestFactory6(const TestFactory6& f) + { + print_copy_created(this); + value = f.value; + alias = f.alias; + } + virtual ~TestFactory6() + { + print_destroyed(this); + } + virtual int get() + { + return value; + } + bool has_alias() + { + return alias; + } +}; +class PyTF6 : public TestFactory6 +{ +public: + // Special constructor that allows the factory to construct a PyTF6 from a TestFactory6 only + // when an alias is needed: + PyTF6(TestFactory6&& base) + : TestFactory6(std::move(base)) + { + alias = true; + print_created(this, "move", value); + } + PyTF6(int i) + : TestFactory6(i) + { + alias = true; + print_created(this, i); + } + PyTF6(PyTF6&& f) + : TestFactory6(std::move(f)) + { + print_move_created(this); + } + PyTF6(const PyTF6& f) + : TestFactory6(f) + { + print_copy_created(this); + } + PyTF6(std::string s) + : TestFactory6((int)s.size()) + { + alias = true; + print_created(this, s); + } + virtual ~PyTF6() + { + print_destroyed(this); + } + int get() override + { + PYBIND11_OVERLOAD(int, TestFactory6, get, /*no args*/); + } +}; + +class TestFactory7 +{ +protected: + int value; + bool alias = false; + +public: + TestFactory7(int i) + : value{i} + { + print_created(this, i); + } + TestFactory7(TestFactory7&& f) + { + print_move_created(this); + value = f.value; + alias = f.alias; + } + TestFactory7(const TestFactory7& f) + { + print_copy_created(this); + value = f.value; + alias = f.alias; + } + virtual ~TestFactory7() + { + print_destroyed(this); + } + virtual int get() + { + return value; + } + bool has_alias() + { + return alias; + } +}; +class PyTF7 : public TestFactory7 +{ +public: + PyTF7(int i) + : TestFactory7(i) + { + alias = true; + print_created(this, i); + } + PyTF7(PyTF7&& f) + : TestFactory7(std::move(f)) + { + print_move_created(this); + } + PyTF7(const PyTF7& f) + : TestFactory7(f) + { + print_copy_created(this); + } + virtual ~PyTF7() + { + print_destroyed(this); + } + int get() override + { + PYBIND11_OVERLOAD(int, TestFactory7, get, /*no args*/); + } +}; + + +class TestFactoryHelper +{ +public: + // Non-movable, non-copyable type: + // Return via pointer: + static TestFactory1* construct1() + { + return new TestFactory1(); + } + // Holder: + static std::unique_ptr<TestFactory1> construct1(int a) + { + return std::unique_ptr<TestFactory1>(new TestFactory1(a)); + } + // pointer again + static TestFactory1* construct1_string(std::string a) + { + return new TestFactory1(a); + } + + // Moveable type: + // pointer: + static TestFactory2* construct2() + { + return new TestFactory2(); + } + // holder: + static std::unique_ptr<TestFactory2> construct2(int a) + { + return std::unique_ptr<TestFactory2>(new TestFactory2(a)); + } + // by value moving: + static TestFactory2 construct2(std::string a) + { + return TestFactory2(a); + } + + // shared_ptr holder type: + // pointer: + static TestFactory3* construct3() + { + return new TestFactory3(); + } + // holder: + static std::shared_ptr<TestFactory3> construct3(int a) + { + return std::shared_ptr<TestFactory3>(new TestFactory3(a)); + } +}; + +TEST_SUBMODULE(factory_constructors, m) +{ + + // Define various trivial types to allow simpler overload resolution: + py::module m_tag = m.def_submodule("tag"); +#define MAKE_TAG_TYPE(Name) \ + struct Name##_tag \ + {}; \ + py::class_<Name##_tag>(m_tag, #Name "_tag").def(py::init<>()); \ + m_tag.attr(#Name) = py::cast(Name##_tag{}) + MAKE_TAG_TYPE(pointer); + MAKE_TAG_TYPE(unique_ptr); + MAKE_TAG_TYPE(move); + MAKE_TAG_TYPE(shared_ptr); + MAKE_TAG_TYPE(derived); + MAKE_TAG_TYPE(TF4); + MAKE_TAG_TYPE(TF5); + MAKE_TAG_TYPE(null_ptr); + MAKE_TAG_TYPE(base); + MAKE_TAG_TYPE(invalid_base); + MAKE_TAG_TYPE(alias); + MAKE_TAG_TYPE(unaliasable); + MAKE_TAG_TYPE(mixed); + + // test_init_factory_basic, test_bad_type + py::class_<TestFactory1>(m, "TestFactory1") + .def(py::init([](unique_ptr_tag, int v) { return TestFactoryHelper::construct1(v); })) + .def(py::init(&TestFactoryHelper::construct1_string)) // raw function pointer + .def(py::init([](pointer_tag) { return TestFactoryHelper::construct1(); })) + .def(py::init([](py::handle, int v, py::handle) { return TestFactoryHelper::construct1(v); })) + .def_readwrite("value", &TestFactory1::value); + py::class_<TestFactory2>(m, "TestFactory2") + .def(py::init([](pointer_tag, int v) { return TestFactoryHelper::construct2(v); })) + .def(py::init([](unique_ptr_tag, std::string v) { return TestFactoryHelper::construct2(v); })) + .def(py::init([](move_tag) { return TestFactoryHelper::construct2(); })) + .def_readwrite("value", &TestFactory2::value); + + // Stateful & reused: + int c = 1; + auto c4a = [c](pointer_tag, TF4_tag, int a) { + (void)c; + return new TestFactory4(a); + }; + + // test_init_factory_basic, test_init_factory_casting + py::class_<TestFactory3, std::shared_ptr<TestFactory3>>(m, "TestFactory3") + .def(py::init([](pointer_tag, int v) { return TestFactoryHelper::construct3(v); })) + .def(py::init([](shared_ptr_tag) { return TestFactoryHelper::construct3(); })) + .def("__init__", [](TestFactory3& self, std::string v) { new (&self) TestFactory3(v); }) // placement-new ctor + + // factories returning a derived type: + .def(py::init(c4a)) // derived ptr + .def(py::init([](pointer_tag, TF5_tag, int a) { return new TestFactory5(a); })) + // derived shared ptr: + .def(py::init([](shared_ptr_tag, TF4_tag, int a) { return std::make_shared<TestFactory4>(a); })) + .def(py::init([](shared_ptr_tag, TF5_tag, int a) { return std::make_shared<TestFactory5>(a); })) + + // Returns nullptr: + .def(py::init([](null_ptr_tag) { return (TestFactory3*)nullptr; })) + + .def_readwrite("value", &TestFactory3::value); + + // test_init_factory_casting + py::class_<TestFactory4, TestFactory3, std::shared_ptr<TestFactory4>>(m, "TestFactory4").def(py::init(c4a)) // pointer + ; + + // Doesn't need to be registered, but registering makes getting ConstructorStats easier: + py::class_<TestFactory5, TestFactory3, std::shared_ptr<TestFactory5>>(m, "TestFactory5"); + + // test_init_factory_alias + // Alias testing + py::class_<TestFactory6, PyTF6>(m, "TestFactory6") + .def(py::init([](base_tag, int i) { return TestFactory6(i); })) + .def(py::init([](alias_tag, int i) { return PyTF6(i); })) + .def(py::init([](alias_tag, std::string s) { return PyTF6(s); })) + .def(py::init([](alias_tag, pointer_tag, int i) { return new PyTF6(i); })) + .def(py::init([](base_tag, pointer_tag, int i) { return new TestFactory6(i); })) + .def(py::init([](base_tag, alias_tag, pointer_tag, int i) { return (TestFactory6*)new PyTF6(i); })) + + .def("get", &TestFactory6::get) + .def("has_alias", &TestFactory6::has_alias) + + .def_static("get_cstats", &ConstructorStats::get<TestFactory6>, py::return_value_policy::reference) + .def_static("get_alias_cstats", &ConstructorStats::get<PyTF6>, py::return_value_policy::reference); + + // test_init_factory_dual + // Separate alias constructor testing + py::class_<TestFactory7, PyTF7, std::shared_ptr<TestFactory7>>(m, "TestFactory7") + .def(py::init([](int i) { return TestFactory7(i); }, [](int i) { return PyTF7(i); })) + .def(py::init([](pointer_tag, int i) { return new TestFactory7(i); }, + [](pointer_tag, int i) { return new PyTF7(i); })) + .def(py::init([](mixed_tag, int i) { return new TestFactory7(i); }, [](mixed_tag, int i) { return PyTF7(i); })) + .def(py::init([](mixed_tag, std::string s) { return TestFactory7((int)s.size()); }, + [](mixed_tag, std::string s) { return new PyTF7((int)s.size()); })) + .def(py::init([](base_tag, pointer_tag, int i) { return new TestFactory7(i); }, + [](base_tag, pointer_tag, int i) { return (TestFactory7*)new PyTF7(i); })) + .def(py::init([](alias_tag, pointer_tag, int i) { return new PyTF7(i); }, + [](alias_tag, pointer_tag, int i) { return new PyTF7(10 * i); })) + .def(py::init([](shared_ptr_tag, base_tag, int i) { return std::make_shared<TestFactory7>(i); }, + [](shared_ptr_tag, base_tag, int i) { + auto* p = new PyTF7(i); + return std::shared_ptr<TestFactory7>(p); + })) + .def(py::init([](shared_ptr_tag, invalid_base_tag, int i) { return std::make_shared<TestFactory7>(i); }, + [](shared_ptr_tag, invalid_base_tag, int i) { + return std::make_shared<TestFactory7>(i); + })) // <-- invalid alias factory + + .def("get", &TestFactory7::get) + .def("has_alias", &TestFactory7::has_alias) + + .def_static("get_cstats", &ConstructorStats::get<TestFactory7>, py::return_value_policy::reference) + .def_static("get_alias_cstats", &ConstructorStats::get<PyTF7>, py::return_value_policy::reference); + + // test_placement_new_alternative + // Class with a custom new operator but *without* a placement new operator (issue #948) + class NoPlacementNew + { + public: + NoPlacementNew(int i) + : i(i) + {} + static void* operator new(std::size_t s) + { + auto* p = ::operator new(s); + py::print("operator new called, returning", reinterpret_cast<uintptr_t>(p)); + return p; + } + static void operator delete(void* p) + { + py::print("operator delete called on", reinterpret_cast<uintptr_t>(p)); + ::operator delete(p); + } + int i; + }; + // As of 2.2, `py::init<args>` no longer requires placement new + py::class_<NoPlacementNew>(m, "NoPlacementNew") + .def(py::init<int>()) + .def(py::init([]() { return new NoPlacementNew(100); })) + .def_readwrite("i", &NoPlacementNew::i); + + + // test_reallocations + // Class that has verbose operator_new/operator_delete calls + struct NoisyAlloc + { + NoisyAlloc(const NoisyAlloc&) = default; + NoisyAlloc(int i) + { + py::print(py::str("NoisyAlloc(int {})").format(i)); + } + NoisyAlloc(double d) + { + py::print(py::str("NoisyAlloc(double {})").format(d)); + } + ~NoisyAlloc() + { + py::print("~NoisyAlloc()"); + } + + static void* operator new(size_t s) + { + py::print("noisy new"); + return ::operator new(s); + } + static void* operator new(size_t, void* p) + { + py::print("noisy placement new"); + return p; + } + static void operator delete(void* p, size_t) + { + py::print("noisy delete"); + ::operator delete(p); + } + static void operator delete(void*, void*) + { + py::print("noisy placement delete"); + } +#if defined(_MSC_VER) && _MSC_VER < 1910 + // MSVC 2015 bug: the above "noisy delete" isn't invoked (fixed in MSVC 2017) + static void operator delete(void* p) + { + py::print("noisy delete"); + ::operator delete(p); + } +#endif + }; + py::class_<NoisyAlloc>(m, "NoisyAlloc") + // Since these overloads have the same number of arguments, the dispatcher will try each of + // them until the arguments convert. Thus we can get a pre-allocation here when passing a + // single non-integer: + .def("__init__", [](NoisyAlloc* a, int i) { new (a) NoisyAlloc(i); }) // Regular constructor, runs first, requires + // preallocation + .def(py::init([](double d) { return new NoisyAlloc(d); })) + + // The two-argument version: first the factory pointer overload. + .def(py::init([](int i, int) { return new NoisyAlloc(i); })) + // Return-by-value: + .def(py::init([](double d, int) { return NoisyAlloc(d); })) + // Old-style placement new init; requires preallocation + .def("__init__", [](NoisyAlloc& a, double d, double) { new (&a) NoisyAlloc(d); }) + // Requires deallocation of previous overload preallocated value: + .def(py::init([](int i, double) { return new NoisyAlloc(i); })) + // Regular again: requires yet another preallocation + .def("__init__", [](NoisyAlloc& a, int i, std::string) { new (&a) NoisyAlloc(i); }); + + + // static_assert testing (the following def's should all fail with appropriate compilation errors): +#if 0 + struct BadF1Base {}; + struct BadF1 : BadF1Base {}; + struct PyBadF1 : BadF1 {}; + py::class_<BadF1, PyBadF1, std::shared_ptr<BadF1>> bf1(m, "BadF1"); + // wrapped factory function must return a compatible pointer, holder, or value + bf1.def(py::init([]() { return 3; })); + // incompatible factory function pointer return type + bf1.def(py::init([]() { static int three = 3; return &three; })); + // incompatible factory function std::shared_ptr<T> return type: cannot convert shared_ptr<T> to holder + // (non-polymorphic base) + bf1.def(py::init([]() { return std::shared_ptr<BadF1Base>(new BadF1()); })); +#endif +} diff --git a/pybind11/tests/test_factory_constructors.py b/pybind11/tests/test_factory_constructors.py new file mode 100644 index 0000000000000000000000000000000000000000..f155af354d04d96da2d9404216dfd1d95ea7ad9d --- /dev/null +++ b/pybind11/tests/test_factory_constructors.py @@ -0,0 +1,454 @@ +import pytest +import re + +from pybind11_tests import factory_constructors as m +from pybind11_tests.factory_constructors import tag +from pybind11_tests import ConstructorStats + + +def test_init_factory_basic(): + """Tests py::init_factory() wrapper around various ways of returning the object""" + + cstats = [ConstructorStats.get(c) for c in [m.TestFactory1, m.TestFactory2, m.TestFactory3]] + cstats[0].alive() # force gc + n_inst = ConstructorStats.detail_reg_inst() + + x1 = m.TestFactory1(tag.unique_ptr, 3) + assert x1.value == "3" + y1 = m.TestFactory1(tag.pointer) + assert y1.value == "(empty)" + z1 = m.TestFactory1("hi!") + assert z1.value == "hi!" + + assert ConstructorStats.detail_reg_inst() == n_inst + 3 + + x2 = m.TestFactory2(tag.move) + assert x2.value == "(empty2)" + y2 = m.TestFactory2(tag.pointer, 7) + assert y2.value == "7" + z2 = m.TestFactory2(tag.unique_ptr, "hi again") + assert z2.value == "hi again" + + assert ConstructorStats.detail_reg_inst() == n_inst + 6 + + x3 = m.TestFactory3(tag.shared_ptr) + assert x3.value == "(empty3)" + y3 = m.TestFactory3(tag.pointer, 42) + assert y3.value == "42" + z3 = m.TestFactory3("bye") + assert z3.value == "bye" + + with pytest.raises(TypeError) as excinfo: + m.TestFactory3(tag.null_ptr) + assert str(excinfo.value) == "pybind11::init(): factory function returned nullptr" + + assert [i.alive() for i in cstats] == [3, 3, 3] + assert ConstructorStats.detail_reg_inst() == n_inst + 9 + + del x1, y2, y3, z3 + assert [i.alive() for i in cstats] == [2, 2, 1] + assert ConstructorStats.detail_reg_inst() == n_inst + 5 + del x2, x3, y1, z1, z2 + assert [i.alive() for i in cstats] == [0, 0, 0] + assert ConstructorStats.detail_reg_inst() == n_inst + + assert [i.values() for i in cstats] == [["3", "hi!"], ["7", "hi again"], ["42", "bye"]] + assert [i.default_constructions for i in cstats] == [1, 1, 1] + + +def test_init_factory_signature(msg): + with pytest.raises(TypeError) as excinfo: + m.TestFactory1("invalid", "constructor", "arguments") + assert msg(excinfo.value) == """ + __init__(): incompatible constructor arguments. The following argument types are supported: + 1. m.factory_constructors.TestFactory1(arg0: m.factory_constructors.tag.unique_ptr_tag, arg1: int) + 2. m.factory_constructors.TestFactory1(arg0: str) + 3. m.factory_constructors.TestFactory1(arg0: m.factory_constructors.tag.pointer_tag) + 4. m.factory_constructors.TestFactory1(arg0: handle, arg1: int, arg2: handle) + + Invoked with: 'invalid', 'constructor', 'arguments' + """ # noqa: E501 line too long + + assert msg(m.TestFactory1.__init__.__doc__) == """ + __init__(*args, **kwargs) + Overloaded function. + + 1. __init__(self: m.factory_constructors.TestFactory1, arg0: m.factory_constructors.tag.unique_ptr_tag, arg1: int) -> None + + 2. __init__(self: m.factory_constructors.TestFactory1, arg0: str) -> None + + 3. __init__(self: m.factory_constructors.TestFactory1, arg0: m.factory_constructors.tag.pointer_tag) -> None + + 4. __init__(self: m.factory_constructors.TestFactory1, arg0: handle, arg1: int, arg2: handle) -> None + """ # noqa: E501 line too long + + +def test_init_factory_casting(): + """Tests py::init_factory() wrapper with various upcasting and downcasting returns""" + + cstats = [ConstructorStats.get(c) for c in [m.TestFactory3, m.TestFactory4, m.TestFactory5]] + cstats[0].alive() # force gc + n_inst = ConstructorStats.detail_reg_inst() + + # Construction from derived references: + a = m.TestFactory3(tag.pointer, tag.TF4, 4) + assert a.value == "4" + b = m.TestFactory3(tag.shared_ptr, tag.TF4, 5) + assert b.value == "5" + c = m.TestFactory3(tag.pointer, tag.TF5, 6) + assert c.value == "6" + d = m.TestFactory3(tag.shared_ptr, tag.TF5, 7) + assert d.value == "7" + + assert ConstructorStats.detail_reg_inst() == n_inst + 4 + + # Shared a lambda with TF3: + e = m.TestFactory4(tag.pointer, tag.TF4, 8) + assert e.value == "8" + + assert ConstructorStats.detail_reg_inst() == n_inst + 5 + assert [i.alive() for i in cstats] == [5, 3, 2] + + del a + assert [i.alive() for i in cstats] == [4, 2, 2] + assert ConstructorStats.detail_reg_inst() == n_inst + 4 + + del b, c, e + assert [i.alive() for i in cstats] == [1, 0, 1] + assert ConstructorStats.detail_reg_inst() == n_inst + 1 + + del d + assert [i.alive() for i in cstats] == [0, 0, 0] + assert ConstructorStats.detail_reg_inst() == n_inst + + assert [i.values() for i in cstats] == [["4", "5", "6", "7", "8"], ["4", "5", "8"], ["6", "7"]] + + +def test_init_factory_alias(): + """Tests py::init_factory() wrapper with value conversions and alias types""" + + cstats = [m.TestFactory6.get_cstats(), m.TestFactory6.get_alias_cstats()] + cstats[0].alive() # force gc + n_inst = ConstructorStats.detail_reg_inst() + + a = m.TestFactory6(tag.base, 1) + assert a.get() == 1 + assert not a.has_alias() + b = m.TestFactory6(tag.alias, "hi there") + assert b.get() == 8 + assert b.has_alias() + c = m.TestFactory6(tag.alias, 3) + assert c.get() == 3 + assert c.has_alias() + d = m.TestFactory6(tag.alias, tag.pointer, 4) + assert d.get() == 4 + assert d.has_alias() + e = m.TestFactory6(tag.base, tag.pointer, 5) + assert e.get() == 5 + assert not e.has_alias() + f = m.TestFactory6(tag.base, tag.alias, tag.pointer, 6) + assert f.get() == 6 + assert f.has_alias() + + assert ConstructorStats.detail_reg_inst() == n_inst + 6 + assert [i.alive() for i in cstats] == [6, 4] + + del a, b, e + assert [i.alive() for i in cstats] == [3, 3] + assert ConstructorStats.detail_reg_inst() == n_inst + 3 + del f, c, d + assert [i.alive() for i in cstats] == [0, 0] + assert ConstructorStats.detail_reg_inst() == n_inst + + class MyTest(m.TestFactory6): + + def __init__(self, *args): + m.TestFactory6.__init__(self, *args) + + def get(self): + return -5 + m.TestFactory6.get(self) + + # Return Class by value, moved into new alias: + z = MyTest(tag.base, 123) + assert z.get() == 118 + assert z.has_alias() + + # Return alias by value, moved into new alias: + y = MyTest(tag.alias, "why hello!") + assert y.get() == 5 + assert y.has_alias() + + # Return Class by pointer, moved into new alias then original destroyed: + x = MyTest(tag.base, tag.pointer, 47) + assert x.get() == 42 + assert x.has_alias() + + assert ConstructorStats.detail_reg_inst() == n_inst + 3 + assert [i.alive() for i in cstats] == [3, 3] + del x, y, z + assert [i.alive() for i in cstats] == [0, 0] + assert ConstructorStats.detail_reg_inst() == n_inst + + assert [i.values() for i in cstats] == [["1", "8", "3", "4", "5", "6", "123", "10", "47"], + ["hi there", "3", "4", "6", "move", "123", "why hello!", "move", "47"]] + + +def test_init_factory_dual(): + """Tests init factory functions with dual main/alias factory functions""" + from pybind11_tests.factory_constructors import TestFactory7 + + cstats = [TestFactory7.get_cstats(), TestFactory7.get_alias_cstats()] + cstats[0].alive() # force gc + n_inst = ConstructorStats.detail_reg_inst() + + class PythFactory7(TestFactory7): + + def get(self): + return 100 + TestFactory7.get(self) + + a1 = TestFactory7(1) + a2 = PythFactory7(2) + assert a1.get() == 1 + assert a2.get() == 102 + assert not a1.has_alias() + assert a2.has_alias() + + b1 = TestFactory7(tag.pointer, 3) + b2 = PythFactory7(tag.pointer, 4) + assert b1.get() == 3 + assert b2.get() == 104 + assert not b1.has_alias() + assert b2.has_alias() + + c1 = TestFactory7(tag.mixed, 5) + c2 = PythFactory7(tag.mixed, 6) + assert c1.get() == 5 + assert c2.get() == 106 + assert not c1.has_alias() + assert c2.has_alias() + + d1 = TestFactory7(tag.base, tag.pointer, 7) + d2 = PythFactory7(tag.base, tag.pointer, 8) + assert d1.get() == 7 + assert d2.get() == 108 + assert not d1.has_alias() + assert d2.has_alias() + + # Both return an alias; the second multiplies the value by 10: + e1 = TestFactory7(tag.alias, tag.pointer, 9) + e2 = PythFactory7(tag.alias, tag.pointer, 10) + assert e1.get() == 9 + assert e2.get() == 200 + assert e1.has_alias() + assert e2.has_alias() + + f1 = TestFactory7(tag.shared_ptr, tag.base, 11) + f2 = PythFactory7(tag.shared_ptr, tag.base, 12) + assert f1.get() == 11 + assert f2.get() == 112 + assert not f1.has_alias() + assert f2.has_alias() + + g1 = TestFactory7(tag.shared_ptr, tag.invalid_base, 13) + assert g1.get() == 13 + assert not g1.has_alias() + with pytest.raises(TypeError) as excinfo: + PythFactory7(tag.shared_ptr, tag.invalid_base, 14) + assert (str(excinfo.value) == "pybind11::init(): construction failed: returned holder-wrapped instance is not an " + "alias instance") + + assert [i.alive() for i in cstats] == [13, 7] + assert ConstructorStats.detail_reg_inst() == n_inst + 13 + + del a1, a2, b1, d1, e1, e2 + assert [i.alive() for i in cstats] == [7, 4] + assert ConstructorStats.detail_reg_inst() == n_inst + 7 + del b2, c1, c2, d2, f1, f2, g1 + assert [i.alive() for i in cstats] == [0, 0] + assert ConstructorStats.detail_reg_inst() == n_inst + + assert [i.values() for i in cstats] == [[ + "1", "2", "3", "4", "5", "6", "7", "8", "9", "100", "11", "12", "13", "14" + ], ["2", "4", "6", "8", "9", "100", "12"]] + + +def test_no_placement_new(capture): + """Prior to 2.2, `py::init<...>` relied on the type supporting placement + new; this tests a class without placement new support.""" + with capture: + a = m.NoPlacementNew(123) + + found = re.search(r'^operator new called, returning (\d+)\n$', str(capture)) + assert found + assert a.i == 123 + with capture: + del a + pytest.gc_collect() + assert capture == "operator delete called on " + found.group(1) + + with capture: + b = m.NoPlacementNew() + + found = re.search(r'^operator new called, returning (\d+)\n$', str(capture)) + assert found + assert b.i == 100 + with capture: + del b + pytest.gc_collect() + assert capture == "operator delete called on " + found.group(1) + + +def test_multiple_inheritance(): + + class MITest(m.TestFactory1, m.TestFactory2): + + def __init__(self): + m.TestFactory1.__init__(self, tag.unique_ptr, 33) + m.TestFactory2.__init__(self, tag.move) + + a = MITest() + assert m.TestFactory1.value.fget(a) == "33" + assert m.TestFactory2.value.fget(a) == "(empty2)" + + +def create_and_destroy(*args): + a = m.NoisyAlloc(*args) + print("---") + del a + pytest.gc_collect() + + +def strip_comments(s): + return re.sub(r'\s+#.*', '', s) + + +def test_reallocations(capture, msg): + """When the constructor is overloaded, previous overloads can require a preallocated value. + This test makes sure that such preallocated values only happen when they might be necessary, + and that they are deallocated properly""" + + pytest.gc_collect() + + with capture: + create_and_destroy(1) + assert msg(capture) == """ + noisy new + noisy placement new + NoisyAlloc(int 1) + --- + ~NoisyAlloc() + noisy delete + """ + with capture: + create_and_destroy(1.5) + assert msg(capture) == strip_comments(""" + noisy new # allocation required to attempt first overload + noisy delete # have to dealloc before considering factory init overload + noisy new # pointer factory calling "new", part 1: allocation + NoisyAlloc(double 1.5) # ... part two, invoking constructor + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + with capture: + create_and_destroy(2, 3) + assert msg(capture) == strip_comments(""" + noisy new # pointer factory calling "new", allocation + NoisyAlloc(int 2) # constructor + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + with capture: + create_and_destroy(2.5, 3) + assert msg(capture) == strip_comments(""" + NoisyAlloc(double 2.5) # construction (local func variable: operator_new not called) + noisy new # return-by-value "new" part 1: allocation + ~NoisyAlloc() # moved-away local func variable destruction + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + with capture: + create_and_destroy(3.5, 4.5) + assert msg(capture) == strip_comments(""" + noisy new # preallocation needed before invoking placement-new overload + noisy placement new # Placement new + NoisyAlloc(double 3.5) # construction + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + with capture: + create_and_destroy(4, 0.5) + assert msg(capture) == strip_comments(""" + noisy new # preallocation needed before invoking placement-new overload + noisy delete # deallocation of preallocated storage + noisy new # Factory pointer allocation + NoisyAlloc(int 4) # factory pointer construction + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + with capture: + create_and_destroy(5, "hi") + assert msg(capture) == strip_comments(""" + noisy new # preallocation needed before invoking first placement new + noisy delete # delete before considering new-style constructor + noisy new # preallocation for second placement new + noisy placement new # Placement new in the second placement new overload + NoisyAlloc(int 5) # construction + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + +@pytest.unsupported_on_py2 +def test_invalid_self(): + """Tests invocation of the pybind-registered base class with an invalid `self` argument. You + can only actually do this on Python 3: Python 2 raises an exception itself if you try.""" + + class NotPybindDerived(object): + pass + + # Attempts to initialize with an invalid type passed as `self`: + class BrokenTF1(m.TestFactory1): + + def __init__(self, bad): + if bad == 1: + a = m.TestFactory2(tag.pointer, 1) + m.TestFactory1.__init__(a, tag.pointer) + elif bad == 2: + a = NotPybindDerived() + m.TestFactory1.__init__(a, tag.pointer) + + # Same as above, but for a class with an alias: + class BrokenTF6(m.TestFactory6): + + def __init__(self, bad): + if bad == 1: + a = m.TestFactory2(tag.pointer, 1) + m.TestFactory6.__init__(a, tag.base, 1) + elif bad == 2: + a = m.TestFactory2(tag.pointer, 1) + m.TestFactory6.__init__(a, tag.alias, 1) + elif bad == 3: + m.TestFactory6.__init__(NotPybindDerived.__new__(NotPybindDerived), tag.base, 1) + elif bad == 4: + m.TestFactory6.__init__(NotPybindDerived.__new__(NotPybindDerived), tag.alias, 1) + + for arg in (1, 2): + with pytest.raises(TypeError) as excinfo: + BrokenTF1(arg) + assert str(excinfo.value) == "__init__(self, ...) called with invalid `self` argument" + + for arg in (1, 2, 3, 4): + with pytest.raises(TypeError) as excinfo: + BrokenTF6(arg) + assert str(excinfo.value) == "__init__(self, ...) called with invalid `self` argument" diff --git a/pybind11/tests/test_gil_scoped.cpp b/pybind11/tests/test_gil_scoped.cpp new file mode 100644 index 0000000000000000000000000000000000000000..21824ac8532fc260a50e9900bd3e843862bf7c1b --- /dev/null +++ b/pybind11/tests/test_gil_scoped.cpp @@ -0,0 +1,45 @@ +/* + tests/test_gil_scoped.cpp -- acquire and release gil + + Copyright (c) 2017 Borja Zarco (Google LLC) <bzarco@google.com> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include <pybind11/functional.h> + + +class VirtClass +{ +public: + virtual ~VirtClass() {} + virtual void virtual_func() {} + virtual void pure_virtual_func() = 0; +}; + +class PyVirtClass : public VirtClass +{ + void virtual_func() override + { + PYBIND11_OVERLOAD(void, VirtClass, virtual_func, ); + } + void pure_virtual_func() override + { + PYBIND11_OVERLOAD_PURE(void, VirtClass, pure_virtual_func, ); + } +}; + +TEST_SUBMODULE(gil_scoped, m) +{ + py::class_<VirtClass, PyVirtClass>(m, "VirtClass") + .def(py::init<>()) + .def("virtual_func", &VirtClass::virtual_func) + .def("pure_virtual_func", &VirtClass::pure_virtual_func); + + m.def("test_callback_py_obj", [](py::object func) { func(); }); + m.def("test_callback_std_func", [](const std::function<void()>& func) { func(); }); + m.def("test_callback_virtual_func", [](VirtClass& virt) { virt.virtual_func(); }); + m.def("test_callback_pure_virtual_func", [](VirtClass& virt) { virt.pure_virtual_func(); }); +} diff --git a/pybind11/tests/test_gil_scoped.py b/pybind11/tests/test_gil_scoped.py new file mode 100644 index 0000000000000000000000000000000000000000..da6c4a0aa1035a978b8abafe28cc62dd27e962a5 --- /dev/null +++ b/pybind11/tests/test_gil_scoped.py @@ -0,0 +1,82 @@ +import multiprocessing +import threading +from pybind11_tests import gil_scoped as m + + +def _run_in_process(target, *args, **kwargs): + """Runs target in process and returns its exitcode after 10s (None if still alive).""" + process = multiprocessing.Process(target=target, args=args, kwargs=kwargs) + process.daemon = True + try: + process.start() + # Do not need to wait much, 10s should be more than enough. + process.join(timeout=10) + return process.exitcode + finally: + if process.is_alive(): + process.terminate() + + +def _python_to_cpp_to_python(): + """Calls different C++ functions that come back to Python.""" + + class ExtendedVirtClass(m.VirtClass): + + def virtual_func(self): + pass + + def pure_virtual_func(self): + pass + + extended = ExtendedVirtClass() + m.test_callback_py_obj(lambda: None) + m.test_callback_std_func(lambda: None) + m.test_callback_virtual_func(extended) + m.test_callback_pure_virtual_func(extended) + + +def _python_to_cpp_to_python_from_threads(num_threads, parallel=False): + """Calls different C++ functions that come back to Python, from Python threads.""" + threads = [] + for _ in range(num_threads): + thread = threading.Thread(target=_python_to_cpp_to_python) + thread.daemon = True + thread.start() + if parallel: + threads.append(thread) + else: + thread.join() + for thread in threads: + thread.join() + + +def test_python_to_cpp_to_python_from_thread(): + """Makes sure there is no GIL deadlock when running in a thread. + + It runs in a separate process to be able to stop and assert if it deadlocks. + """ + assert _run_in_process(_python_to_cpp_to_python_from_threads, 1) == 0 + + +def test_python_to_cpp_to_python_from_thread_multiple_parallel(): + """Makes sure there is no GIL deadlock when running in a thread multiple times in parallel. + + It runs in a separate process to be able to stop and assert if it deadlocks. + """ + assert _run_in_process(_python_to_cpp_to_python_from_threads, 8, parallel=True) == 0 + + +def test_python_to_cpp_to_python_from_thread_multiple_sequential(): + """Makes sure there is no GIL deadlock when running in a thread multiple times sequentially. + + It runs in a separate process to be able to stop and assert if it deadlocks. + """ + assert _run_in_process(_python_to_cpp_to_python_from_threads, 8, parallel=False) == 0 + + +def test_python_to_cpp_to_python_from_process(): + """Makes sure there is no GIL deadlock when using processes. + + This test is for completion, but it was never an issue. + """ + assert _run_in_process(_python_to_cpp_to_python) == 0 diff --git a/pybind11/tests/test_iostream.cpp b/pybind11/tests/test_iostream.cpp new file mode 100644 index 0000000000000000000000000000000000000000..96d43a231235d0623756481720f74e8d8a9aed9f --- /dev/null +++ b/pybind11/tests/test_iostream.cpp @@ -0,0 +1,76 @@ +/* + tests/test_iostream.cpp -- Usage of scoped_output_redirect + + Copyright (c) 2017 Henry F. Schreiner + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + + +#include <pybind11/iostream.h> +#include "pybind11_tests.h" +#include <iostream> + + +void noisy_function(std::string msg, bool flush) +{ + + std::cout << msg; + if (flush) + std::cout << std::flush; +} + +void noisy_funct_dual(std::string msg, std::string emsg) +{ + std::cout << msg; + std::cerr << emsg; +} + +TEST_SUBMODULE(iostream, m) +{ + + add_ostream_redirect(m); + + // test_evals + + m.def("captured_output_default", [](std::string msg) { + py::scoped_ostream_redirect redir; + std::cout << msg << std::flush; + }); + + m.def("captured_output", [](std::string msg) { + py::scoped_ostream_redirect redir(std::cout, py::module::import("sys").attr("stdout")); + std::cout << msg << std::flush; + }); + + m.def("guard_output", + &noisy_function, + py::call_guard<py::scoped_ostream_redirect>(), + py::arg("msg"), + py::arg("flush") = true); + + m.def("captured_err", [](std::string msg) { + py::scoped_ostream_redirect redir(std::cerr, py::module::import("sys").attr("stderr")); + std::cerr << msg << std::flush; + }); + + m.def("noisy_function", &noisy_function, py::arg("msg"), py::arg("flush") = true); + + m.def("dual_guard", + &noisy_funct_dual, + py::call_guard<py::scoped_ostream_redirect, py::scoped_estream_redirect>(), + py::arg("msg"), + py::arg("emsg")); + + m.def("raw_output", [](std::string msg) { std::cout << msg << std::flush; }); + + m.def("raw_err", [](std::string msg) { std::cerr << msg << std::flush; }); + + m.def("captured_dual", [](std::string msg, std::string emsg) { + py::scoped_ostream_redirect redirout(std::cout, py::module::import("sys").attr("stdout")); + py::scoped_ostream_redirect redirerr(std::cerr, py::module::import("sys").attr("stderr")); + std::cout << msg << std::flush; + std::cerr << emsg << std::flush; + }); +} diff --git a/pybind11/tests/test_iostream.py b/pybind11/tests/test_iostream.py new file mode 100644 index 0000000000000000000000000000000000000000..8a7b631e2f7086b6a4003d0942cbdbbe3bb6f2ec --- /dev/null +++ b/pybind11/tests/test_iostream.py @@ -0,0 +1,217 @@ +from pybind11_tests import iostream as m +import sys + +from contextlib import contextmanager + +try: + # Python 3 + from io import StringIO +except ImportError: + # Python 2 + try: + from cStringIO import StringIO + except ImportError: + from StringIO import StringIO + +try: + # Python 3.4 + from contextlib import redirect_stdout +except ImportError: + + @contextmanager + def redirect_stdout(target): + original = sys.stdout + sys.stdout = target + yield + sys.stdout = original + + +try: + # Python 3.5 + from contextlib import redirect_stderr +except ImportError: + + @contextmanager + def redirect_stderr(target): + original = sys.stderr + sys.stderr = target + yield + sys.stderr = original + + +def test_captured(capsys): + msg = "I've been redirected to Python, I hope!" + m.captured_output(msg) + stdout, stderr = capsys.readouterr() + assert stdout == msg + assert stderr == '' + + m.captured_output_default(msg) + stdout, stderr = capsys.readouterr() + assert stdout == msg + assert stderr == '' + + m.captured_err(msg) + stdout, stderr = capsys.readouterr() + assert stdout == '' + assert stderr == msg + + +def test_captured_large_string(capsys): + # Make this bigger than the buffer used on the C++ side: 1024 chars + msg = "I've been redirected to Python, I hope!" + msg = msg * (1024 // len(msg) + 1) + + m.captured_output_default(msg) + stdout, stderr = capsys.readouterr() + assert stdout == msg + assert stderr == '' + + +def test_guard_capture(capsys): + msg = "I've been redirected to Python, I hope!" + m.guard_output(msg) + stdout, stderr = capsys.readouterr() + assert stdout == msg + assert stderr == '' + + +def test_series_captured(capture): + with capture: + m.captured_output("a") + m.captured_output("b") + assert capture == "ab" + + +def test_flush(capfd): + msg = "(not flushed)" + msg2 = "(flushed)" + + with m.ostream_redirect(): + m.noisy_function(msg, flush=False) + stdout, stderr = capfd.readouterr() + assert stdout == '' + + m.noisy_function(msg2, flush=True) + stdout, stderr = capfd.readouterr() + assert stdout == msg + msg2 + + m.noisy_function(msg, flush=False) + + stdout, stderr = capfd.readouterr() + assert stdout == msg + + +def test_not_captured(capfd): + msg = "Something that should not show up in log" + stream = StringIO() + with redirect_stdout(stream): + m.raw_output(msg) + stdout, stderr = capfd.readouterr() + assert stdout == msg + assert stderr == '' + assert stream.getvalue() == '' + + stream = StringIO() + with redirect_stdout(stream): + m.captured_output(msg) + stdout, stderr = capfd.readouterr() + assert stdout == '' + assert stderr == '' + assert stream.getvalue() == msg + + +def test_err(capfd): + msg = "Something that should not show up in log" + stream = StringIO() + with redirect_stderr(stream): + m.raw_err(msg) + stdout, stderr = capfd.readouterr() + assert stdout == '' + assert stderr == msg + assert stream.getvalue() == '' + + stream = StringIO() + with redirect_stderr(stream): + m.captured_err(msg) + stdout, stderr = capfd.readouterr() + assert stdout == '' + assert stderr == '' + assert stream.getvalue() == msg + + +def test_multi_captured(capfd): + stream = StringIO() + with redirect_stdout(stream): + m.captured_output("a") + m.raw_output("b") + m.captured_output("c") + m.raw_output("d") + stdout, stderr = capfd.readouterr() + assert stdout == 'bd' + assert stream.getvalue() == 'ac' + + +def test_dual(capsys): + m.captured_dual("a", "b") + stdout, stderr = capsys.readouterr() + assert stdout == "a" + assert stderr == "b" + + +def test_redirect(capfd): + msg = "Should not be in log!" + stream = StringIO() + with redirect_stdout(stream): + m.raw_output(msg) + stdout, stderr = capfd.readouterr() + assert stdout == msg + assert stream.getvalue() == '' + + stream = StringIO() + with redirect_stdout(stream): + with m.ostream_redirect(): + m.raw_output(msg) + stdout, stderr = capfd.readouterr() + assert stdout == '' + assert stream.getvalue() == msg + + stream = StringIO() + with redirect_stdout(stream): + m.raw_output(msg) + stdout, stderr = capfd.readouterr() + assert stdout == msg + assert stream.getvalue() == '' + + +def test_redirect_err(capfd): + msg = "StdOut" + msg2 = "StdErr" + + stream = StringIO() + with redirect_stderr(stream): + with m.ostream_redirect(stdout=False): + m.raw_output(msg) + m.raw_err(msg2) + stdout, stderr = capfd.readouterr() + assert stdout == msg + assert stderr == '' + assert stream.getvalue() == msg2 + + +def test_redirect_both(capfd): + msg = "StdOut" + msg2 = "StdErr" + + stream = StringIO() + stream2 = StringIO() + with redirect_stdout(stream): + with redirect_stderr(stream2): + with m.ostream_redirect(): + m.raw_output(msg) + m.raw_err(msg2) + stdout, stderr = capfd.readouterr() + assert stdout == '' + assert stderr == '' + assert stream.getvalue() == msg + assert stream2.getvalue() == msg2 diff --git a/pybind11/tests/test_kwargs_and_defaults.cpp b/pybind11/tests/test_kwargs_and_defaults.cpp new file mode 100644 index 0000000000000000000000000000000000000000..761a82e1cbfa2f3eab8aca2449ce8e4da3d588a7 --- /dev/null +++ b/pybind11/tests/test_kwargs_and_defaults.cpp @@ -0,0 +1,106 @@ +/* + tests/test_kwargs_and_defaults.cpp -- keyword arguments and default values + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include <pybind11/stl.h> + +TEST_SUBMODULE(kwargs_and_defaults, m) +{ + auto kw_func = [](int x, int y) { return "x=" + std::to_string(x) + ", y=" + std::to_string(y); }; + + // test_named_arguments + m.def("kw_func0", kw_func); + m.def("kw_func1", kw_func, py::arg("x"), py::arg("y")); + m.def("kw_func2", kw_func, py::arg("x") = 100, py::arg("y") = 200); + m.def("kw_func3", [](const char*) {}, py::arg("data") = std::string("Hello world!")); + + /* A fancier default argument */ + std::vector<int> list{{13, 17}}; + m.def("kw_func4", + [](const std::vector<int>& entries) { + std::string ret = "{"; + for (int i : entries) + ret += std::to_string(i) + " "; + ret.back() = '}'; + return ret; + }, + py::arg("myList") = list); + + m.def("kw_func_udl", kw_func, "x"_a, "y"_a = 300); + m.def("kw_func_udl_z", kw_func, "x"_a, "y"_a = 0); + + // test_args_and_kwargs + m.def("args_function", [](py::args args) -> py::tuple { return std::move(args); }); + m.def("args_kwargs_function", [](py::args args, py::kwargs kwargs) { return py::make_tuple(args, kwargs); }); + + // test_mixed_args_and_kwargs + m.def("mixed_plus_args", [](int i, double j, py::args args) { return py::make_tuple(i, j, args); }); + m.def("mixed_plus_kwargs", [](int i, double j, py::kwargs kwargs) { return py::make_tuple(i, j, kwargs); }); + auto mixed_plus_both = [](int i, double j, py::args args, py::kwargs kwargs) { + return py::make_tuple(i, j, args, kwargs); + }; + m.def("mixed_plus_args_kwargs", mixed_plus_both); + + m.def("mixed_plus_args_kwargs_defaults", mixed_plus_both, py::arg("i") = 1, py::arg("j") = 3.14159); + +// test_args_refcount +// PyPy needs a garbage collection to get the reference count values to match CPython's behaviour +#ifdef PYPY_VERSION +# define GC_IF_NEEDED ConstructorStats::gc() +#else +# define GC_IF_NEEDED +#endif + m.def("arg_refcount_h", [](py::handle h) { + GC_IF_NEEDED; + return h.ref_count(); + }); + m.def("arg_refcount_h", [](py::handle h, py::handle, py::handle) { + GC_IF_NEEDED; + return h.ref_count(); + }); + m.def("arg_refcount_o", [](py::object o) { + GC_IF_NEEDED; + return o.ref_count(); + }); + m.def("args_refcount", [](py::args a) { + GC_IF_NEEDED; + py::tuple t(a.size()); + for (size_t i = 0; i < a.size(); i++) + // Use raw Python API here to avoid an extra, intermediate incref on the tuple item: + t[i] = (int)Py_REFCNT(PyTuple_GET_ITEM(a.ptr(), static_cast<ssize_t>(i))); + return t; + }); + m.def("mixed_args_refcount", [](py::object o, py::args a) { + GC_IF_NEEDED; + py::tuple t(a.size() + 1); + t[0] = o.ref_count(); + for (size_t i = 0; i < a.size(); i++) + // Use raw Python API here to avoid an extra, intermediate incref on the tuple item: + t[i + 1] = (int)Py_REFCNT(PyTuple_GET_ITEM(a.ptr(), static_cast<ssize_t>(i))); + return t; + }); + + // pybind11 won't allow these to be bound: args and kwargs, if present, must be at the end. + // Uncomment these to test that the static_assert is indeed working: + // m.def("bad_args1", [](py::args, int) {}); + // m.def("bad_args2", [](py::kwargs, int) {}); + // m.def("bad_args3", [](py::kwargs, py::args) {}); + // m.def("bad_args4", [](py::args, int, py::kwargs) {}); + // m.def("bad_args5", [](py::args, py::kwargs, int) {}); + // m.def("bad_args6", [](py::args, py::args) {}); + // m.def("bad_args7", [](py::kwargs, py::kwargs) {}); + + // test_function_signatures (along with most of the above) + struct KWClass + { + void foo(int, float) {} + }; + py::class_<KWClass>(m, "KWClass").def("foo0", &KWClass::foo).def("foo1", &KWClass::foo, "x"_a, "y"_a); +} diff --git a/pybind11/tests/test_kwargs_and_defaults.py b/pybind11/tests/test_kwargs_and_defaults.py new file mode 100644 index 0000000000000000000000000000000000000000..a312e962df052ef5b6fba017bee500d0d4819e43 --- /dev/null +++ b/pybind11/tests/test_kwargs_and_defaults.py @@ -0,0 +1,144 @@ +import pytest +from pybind11_tests import kwargs_and_defaults as m + + +def test_function_signatures(doc): + assert doc(m.kw_func0) == "kw_func0(arg0: int, arg1: int) -> str" + assert doc(m.kw_func1) == "kw_func1(x: int, y: int) -> str" + assert doc(m.kw_func2) == "kw_func2(x: int = 100, y: int = 200) -> str" + assert doc(m.kw_func3) == "kw_func3(data: str = 'Hello world!') -> None" + assert doc(m.kw_func4) == "kw_func4(myList: List[int] = [13, 17]) -> str" + assert doc(m.kw_func_udl) == "kw_func_udl(x: int, y: int = 300) -> str" + assert doc(m.kw_func_udl_z) == "kw_func_udl_z(x: int, y: int = 0) -> str" + assert doc(m.args_function) == "args_function(*args) -> tuple" + assert doc(m.args_kwargs_function) == "args_kwargs_function(*args, **kwargs) -> tuple" + assert doc(m.KWClass.foo0) == \ + "foo0(self: m.kwargs_and_defaults.KWClass, arg0: int, arg1: float) -> None" + assert doc(m.KWClass.foo1) == \ + "foo1(self: m.kwargs_and_defaults.KWClass, x: int, y: float) -> None" + + +def test_named_arguments(msg): + assert m.kw_func0(5, 10) == "x=5, y=10" + + assert m.kw_func1(5, 10) == "x=5, y=10" + assert m.kw_func1(5, y=10) == "x=5, y=10" + assert m.kw_func1(y=10, x=5) == "x=5, y=10" + + assert m.kw_func2() == "x=100, y=200" + assert m.kw_func2(5) == "x=5, y=200" + assert m.kw_func2(x=5) == "x=5, y=200" + assert m.kw_func2(y=10) == "x=100, y=10" + assert m.kw_func2(5, 10) == "x=5, y=10" + assert m.kw_func2(x=5, y=10) == "x=5, y=10" + + with pytest.raises(TypeError) as excinfo: + # noinspection PyArgumentList + m.kw_func2(x=5, y=10, z=12) + assert excinfo.match(r'(?s)^kw_func2\(\): incompatible.*Invoked with: kwargs: ((x=5|y=10|z=12)(, |$))' + '{3}$') + + assert m.kw_func4() == "{13 17}" + assert m.kw_func4(myList=[1, 2, 3]) == "{1 2 3}" + + assert m.kw_func_udl(x=5, y=10) == "x=5, y=10" + assert m.kw_func_udl_z(x=5) == "x=5, y=0" + + +def test_arg_and_kwargs(): + args = 'arg1_value', 'arg2_value', 3 + assert m.args_function(*args) == args + + args = 'a1', 'a2' + kwargs = dict(arg3='a3', arg4=4) + assert m.args_kwargs_function(*args, **kwargs) == (args, kwargs) + + +def test_mixed_args_and_kwargs(msg): + mpa = m.mixed_plus_args + mpk = m.mixed_plus_kwargs + mpak = m.mixed_plus_args_kwargs + mpakd = m.mixed_plus_args_kwargs_defaults + + assert mpa(1, 2.5, 4, 99.5, None) == (1, 2.5, (4, 99.5, None)) + assert mpa(1, 2.5) == (1, 2.5, ()) + with pytest.raises(TypeError) as excinfo: + assert mpa(1) + assert msg(excinfo.value) == """ + mixed_plus_args(): incompatible function arguments. The following argument types are supported: + 1. (arg0: int, arg1: float, *args) -> tuple + + Invoked with: 1 + """ # noqa: E501 line too long + with pytest.raises(TypeError) as excinfo: + assert mpa() + assert msg(excinfo.value) == """ + mixed_plus_args(): incompatible function arguments. The following argument types are supported: + 1. (arg0: int, arg1: float, *args) -> tuple + + Invoked with: + """ # noqa: E501 line too long + + assert mpk(-2, 3.5, pi=3.14159, e=2.71828) == (-2, 3.5, {'e': 2.71828, 'pi': 3.14159}) + assert mpak(7, 7.7, 7.77, 7.777, 7.7777, minusseven=-7) == (7, 7.7, (7.77, 7.777, 7.7777), {'minusseven': -7}) + assert mpakd() == (1, 3.14159, (), {}) + assert mpakd(3) == (3, 3.14159, (), {}) + assert mpakd(j=2.71828) == (1, 2.71828, (), {}) + assert mpakd(k=42) == (1, 3.14159, (), {'k': 42}) + assert mpakd(1, 1, 2, 3, 5, 8, then=13, followedby=21) == (1, 1, (2, 3, 5, 8), {'then': 13, 'followedby': 21}) + # Arguments specified both positionally and via kwargs should fail: + with pytest.raises(TypeError) as excinfo: + assert mpakd(1, i=1) + assert msg(excinfo.value) == """ + mixed_plus_args_kwargs_defaults(): incompatible function arguments. The following argument types are supported: + 1. (i: int = 1, j: float = 3.14159, *args, **kwargs) -> tuple + + Invoked with: 1; kwargs: i=1 + """ # noqa: E501 line too long + with pytest.raises(TypeError) as excinfo: + assert mpakd(1, 2, j=1) + assert msg(excinfo.value) == """ + mixed_plus_args_kwargs_defaults(): incompatible function arguments. The following argument types are supported: + 1. (i: int = 1, j: float = 3.14159, *args, **kwargs) -> tuple + + Invoked with: 1, 2; kwargs: j=1 + """ # noqa: E501 line too long + + +def test_args_refcount(): + """Issue/PR #1216 - py::args elements get double-inc_ref()ed when combined with regular + arguments""" + refcount = m.arg_refcount_h + + myval = 54321 + expected = refcount(myval) + assert m.arg_refcount_h(myval) == expected + assert m.arg_refcount_o(myval) == expected + 1 + assert m.arg_refcount_h(myval) == expected + assert refcount(myval) == expected + + assert m.mixed_plus_args(1, 2.0, "a", myval) == (1, 2.0, ("a", myval)) + assert refcount(myval) == expected + + assert m.mixed_plus_kwargs(3, 4.0, a=1, b=myval) == (3, 4.0, {"a": 1, "b": myval}) + assert refcount(myval) == expected + + assert m.args_function(-1, myval) == (-1, myval) + assert refcount(myval) == expected + + assert m.mixed_plus_args_kwargs(5, 6.0, myval, a=myval) == (5, 6.0, (myval,), {"a": myval}) + assert refcount(myval) == expected + + assert m.args_kwargs_function(7, 8, myval, a=1, b=myval) == \ + ((7, 8, myval), {"a": 1, "b": myval}) + assert refcount(myval) == expected + + exp3 = refcount(myval, myval, myval) + assert m.args_refcount(myval, myval, myval) == (exp3, exp3, exp3) + assert refcount(myval) == expected + + # This function takes the first arg as a `py::object` and the rest as a `py::args`. Unlike the + # previous case, when we have both positional and `py::args` we need to construct a new tuple + # for the `py::args`; in the previous case, we could simply inc_ref and pass on Python's input + # tuple without having to inc_ref the individual elements, but here we can't, hence the extra + # refs. + assert m.mixed_args_refcount(myval, myval, myval) == (exp3 + 3, exp3 + 3, exp3 + 3) diff --git a/pybind11/tests/test_local_bindings.cpp b/pybind11/tests/test_local_bindings.cpp new file mode 100644 index 0000000000000000000000000000000000000000..b7520c31802bfc6cbc3712e0a41f7289102ba3ed --- /dev/null +++ b/pybind11/tests/test_local_bindings.cpp @@ -0,0 +1,96 @@ +/* + tests/test_local_bindings.cpp -- tests the py::module_local class feature which makes a class + binding local to the module in which it is defined. + + Copyright (c) 2017 Jason Rhinelander <jason@imaginary.ca> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "local_bindings.h" +#include <pybind11/stl.h> +#include <pybind11/stl_bind.h> +#include <numeric> + +TEST_SUBMODULE(local_bindings, m) +{ + // test_load_external + m.def("load_external1", [](ExternalType1& e) { return e.i; }); + m.def("load_external2", [](ExternalType2& e) { return e.i; }); + + // test_local_bindings + // Register a class with py::module_local: + bind_local<LocalType, -1>(m, "LocalType", py::module_local()).def("get3", [](LocalType& t) { return t.i + 3; }); + + m.def("local_value", [](LocalType& l) { return l.i; }); + + // test_nonlocal_failure + // The main pybind11 test module is loaded first, so this registration will succeed (the second + // one, in pybind11_cross_module_tests.cpp, is designed to fail): + bind_local<NonLocalType, 0>(m, "NonLocalType").def(py::init<int>()).def("get", [](LocalType& i) { return i.i; }); + + // test_duplicate_local + // py::module_local declarations should be visible across compilation units that get linked together; + // this tries to register a duplicate local. It depends on a definition in test_class.cpp and + // should raise a runtime error from the duplicate definition attempt. If test_class isn't + // available it *also* throws a runtime error (with "test_class not enabled" as value). + m.def("register_local_external", [m]() { + auto main = py::module::import("pybind11_tests"); + if (py::hasattr(main, "class_")) { + bind_local<LocalExternal, 7>(m, "LocalExternal", py::module_local()); + } else + throw std::runtime_error("test_class not enabled"); + }); + + // test_stl_bind_local + // stl_bind.h binders defaults to py::module_local if the types are local or converting: + py::bind_vector<LocalVec>(m, "LocalVec"); + py::bind_map<LocalMap>(m, "LocalMap"); + // and global if the type (or one of the types, for the map) is global: + py::bind_vector<NonLocalVec>(m, "NonLocalVec"); + py::bind_map<NonLocalMap>(m, "NonLocalMap"); + + // test_stl_bind_global + // They can, however, be overridden to global using `py::module_local(false)`: + bind_local<NonLocal2, 10>(m, "NonLocal2"); + py::bind_vector<LocalVec2>(m, "LocalVec2", py::module_local()); + py::bind_map<NonLocalMap2>(m, "NonLocalMap2", py::module_local(false)); + + // test_mixed_local_global + // We try this both with the global type registered first and vice versa (the order shouldn't + // matter). + m.def("register_mixed_global", + [m]() { bind_local<MixedGlobalLocal, 100>(m, "MixedGlobalLocal", py::module_local(false)); }); + m.def("register_mixed_local", + [m]() { bind_local<MixedLocalGlobal, 1000>(m, "MixedLocalGlobal", py::module_local()); }); + m.def("get_mixed_gl", [](int i) { return MixedGlobalLocal(i); }); + m.def("get_mixed_lg", [](int i) { return MixedLocalGlobal(i); }); + + // test_internal_locals_differ + m.def("local_cpp_types_addr", []() { return (uintptr_t)&py::detail::registered_local_types_cpp(); }); + + // test_stl_caster_vs_stl_bind + m.def("load_vector_via_caster", [](std::vector<int> v) { return std::accumulate(v.begin(), v.end(), 0); }); + + // test_cross_module_calls + m.def("return_self", [](LocalVec* v) { return v; }); + m.def("return_copy", [](const LocalVec& v) { return LocalVec(v); }); + + class Cat : public pets::Pet + { + public: + Cat(std::string name) + : Pet(name){}; + }; + py::class_<pets::Pet>(m, "Pet", py::module_local()).def("get_name", &pets::Pet::name); + // Binding for local extending class: + py::class_<Cat, pets::Pet>(m, "Cat").def(py::init<std::string>()); + m.def("pet_name", [](pets::Pet& p) { return p.name(); }); + + py::class_<MixGL>(m, "MixGL").def(py::init<int>()); + m.def("get_gl_value", [](MixGL& o) { return o.i + 10; }); + + py::class_<MixGL2>(m, "MixGL2").def(py::init<int>()); +} diff --git a/pybind11/tests/test_local_bindings.py b/pybind11/tests/test_local_bindings.py new file mode 100644 index 0000000000000000000000000000000000000000..c48b6dea399d5711a10dd56ab0cd3f67ce1900f8 --- /dev/null +++ b/pybind11/tests/test_local_bindings.py @@ -0,0 +1,225 @@ +import pytest + +from pybind11_tests import local_bindings as m + + +def test_load_external(): + """Load a `py::module_local` type that's only registered in an external module""" + import pybind11_cross_module_tests as cm + + assert m.load_external1(cm.ExternalType1(11)) == 11 + assert m.load_external2(cm.ExternalType2(22)) == 22 + + with pytest.raises(TypeError) as excinfo: + assert m.load_external2(cm.ExternalType1(21)) == 21 + assert "incompatible function arguments" in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + assert m.load_external1(cm.ExternalType2(12)) == 12 + assert "incompatible function arguments" in str(excinfo.value) + + +def test_local_bindings(): + """Tests that duplicate `py::module_local` class bindings work across modules""" + + # Make sure we can load the second module with the conflicting (but local) definition: + import pybind11_cross_module_tests as cm + + i1 = m.LocalType(5) + assert i1.get() == 4 + assert i1.get3() == 8 + + i2 = cm.LocalType(10) + assert i2.get() == 11 + assert i2.get2() == 12 + + assert not hasattr(i1, 'get2') + assert not hasattr(i2, 'get3') + + # Loading within the local module + assert m.local_value(i1) == 5 + assert cm.local_value(i2) == 10 + + # Cross-module loading works as well (on failure, the type loader looks for + # external module-local converters): + assert m.local_value(i2) == 10 + assert cm.local_value(i1) == 5 + + +def test_nonlocal_failure(): + """Tests that attempting to register a non-local type in multiple modules fails""" + import pybind11_cross_module_tests as cm + + with pytest.raises(RuntimeError) as excinfo: + cm.register_nonlocal() + assert str(excinfo.value) == 'generic_type: type "NonLocalType" is already registered!' + + +def test_duplicate_local(): + """Tests expected failure when registering a class twice with py::local in the same module""" + with pytest.raises(RuntimeError) as excinfo: + m.register_local_external() + import pybind11_tests + assert str(excinfo.value) == ('generic_type: type "LocalExternal" is already registered!' if hasattr( + pybind11_tests, 'class_') else 'test_class not enabled') + + +def test_stl_bind_local(): + import pybind11_cross_module_tests as cm + + v1, v2 = m.LocalVec(), cm.LocalVec() + v1.append(m.LocalType(1)) + v1.append(m.LocalType(2)) + v2.append(cm.LocalType(1)) + v2.append(cm.LocalType(2)) + + # Cross module value loading: + v1.append(cm.LocalType(3)) + v2.append(m.LocalType(3)) + + assert [i.get() for i in v1] == [0, 1, 2] + assert [i.get() for i in v2] == [2, 3, 4] + + v3, v4 = m.NonLocalVec(), cm.NonLocalVec2() + v3.append(m.NonLocalType(1)) + v3.append(m.NonLocalType(2)) + v4.append(m.NonLocal2(3)) + v4.append(m.NonLocal2(4)) + + assert [i.get() for i in v3] == [1, 2] + assert [i.get() for i in v4] == [13, 14] + + d1, d2 = m.LocalMap(), cm.LocalMap() + d1["a"] = v1[0] + d1["b"] = v1[1] + d2["c"] = v2[0] + d2["d"] = v2[1] + assert {i: d1[i].get() for i in d1} == {'a': 0, 'b': 1} + assert {i: d2[i].get() for i in d2} == {'c': 2, 'd': 3} + + +def test_stl_bind_global(): + import pybind11_cross_module_tests as cm + + with pytest.raises(RuntimeError) as excinfo: + cm.register_nonlocal_map() + assert str(excinfo.value) == 'generic_type: type "NonLocalMap" is already registered!' + + with pytest.raises(RuntimeError) as excinfo: + cm.register_nonlocal_vec() + assert str(excinfo.value) == 'generic_type: type "NonLocalVec" is already registered!' + + with pytest.raises(RuntimeError) as excinfo: + cm.register_nonlocal_map2() + assert str(excinfo.value) == 'generic_type: type "NonLocalMap2" is already registered!' + + +def test_mixed_local_global(): + """Local types take precedence over globally registered types: a module with a `module_local` + type can be registered even if the type is already registered globally. With the module, + casting will go to the local type; outside the module casting goes to the global type.""" + import pybind11_cross_module_tests as cm + m.register_mixed_global() + m.register_mixed_local() + + a = [] + a.append(m.MixedGlobalLocal(1)) + a.append(m.MixedLocalGlobal(2)) + a.append(m.get_mixed_gl(3)) + a.append(m.get_mixed_lg(4)) + + assert [x.get() for x in a] == [101, 1002, 103, 1004] + + cm.register_mixed_global_local() + cm.register_mixed_local_global() + a.append(m.MixedGlobalLocal(5)) + a.append(m.MixedLocalGlobal(6)) + a.append(cm.MixedGlobalLocal(7)) + a.append(cm.MixedLocalGlobal(8)) + a.append(m.get_mixed_gl(9)) + a.append(m.get_mixed_lg(10)) + a.append(cm.get_mixed_gl(11)) + a.append(cm.get_mixed_lg(12)) + + assert [x.get() for x in a] == \ + [101, 1002, 103, 1004, 105, 1006, 207, 2008, 109, 1010, 211, 2012] + + +def test_internal_locals_differ(): + """Makes sure the internal local type map differs across the two modules""" + import pybind11_cross_module_tests as cm + assert m.local_cpp_types_addr() != cm.local_cpp_types_addr() + + +def test_stl_caster_vs_stl_bind(msg): + """One module uses a generic vector caster from `<pybind11/stl.h>` while the other + exports `std::vector<int>` via `py:bind_vector` and `py::module_local`""" + import pybind11_cross_module_tests as cm + + v1 = cm.VectorInt([1, 2, 3]) + assert m.load_vector_via_caster(v1) == 6 + assert cm.load_vector_via_binding(v1) == 6 + + v2 = [1, 2, 3] + assert m.load_vector_via_caster(v2) == 6 + with pytest.raises(TypeError) as excinfo: + cm.load_vector_via_binding(v2) == 6 + assert msg(excinfo.value) == """ + load_vector_via_binding(): incompatible function arguments. The following argument types are supported: + 1. (arg0: pybind11_cross_module_tests.VectorInt) -> int + + Invoked with: [1, 2, 3] + """ # noqa: E501 line too long + + +def test_cross_module_calls(): + import pybind11_cross_module_tests as cm + + v1 = m.LocalVec() + v1.append(m.LocalType(1)) + v2 = cm.LocalVec() + v2.append(cm.LocalType(2)) + + # Returning the self pointer should get picked up as returning an existing + # instance (even when that instance is of a foreign, non-local type). + assert m.return_self(v1) is v1 + assert cm.return_self(v2) is v2 + assert m.return_self(v2) is v2 + assert cm.return_self(v1) is v1 + + assert m.LocalVec is not cm.LocalVec + # Returning a copy, on the other hand, always goes to the local type, + # regardless of where the source type came from. + assert type(m.return_copy(v1)) is m.LocalVec + assert type(m.return_copy(v2)) is m.LocalVec + assert type(cm.return_copy(v1)) is cm.LocalVec + assert type(cm.return_copy(v2)) is cm.LocalVec + + # Test the example given in the documentation (which also tests inheritance casting): + mycat = m.Cat("Fluffy") + mydog = cm.Dog("Rover") + assert mycat.get_name() == "Fluffy" + assert mydog.name() == "Rover" + assert m.Cat.__base__.__name__ == "Pet" + assert cm.Dog.__base__.__name__ == "Pet" + assert m.Cat.__base__ is not cm.Dog.__base__ + assert m.pet_name(mycat) == "Fluffy" + assert m.pet_name(mydog) == "Rover" + assert cm.pet_name(mycat) == "Fluffy" + assert cm.pet_name(mydog) == "Rover" + + assert m.MixGL is not cm.MixGL + a = m.MixGL(1) + b = cm.MixGL(2) + assert m.get_gl_value(a) == 11 + assert m.get_gl_value(b) == 12 + assert cm.get_gl_value(a) == 101 + assert cm.get_gl_value(b) == 102 + + c, d = m.MixGL2(3), cm.MixGL2(4) + with pytest.raises(TypeError) as excinfo: + m.get_gl_value(c) + assert "incompatible function arguments" in str(excinfo) + with pytest.raises(TypeError) as excinfo: + m.get_gl_value(d) + assert "incompatible function arguments" in str(excinfo) diff --git a/pybind11/tests/test_methods_and_attributes.cpp b/pybind11/tests/test_methods_and_attributes.cpp new file mode 100644 index 0000000000000000000000000000000000000000..4291431ca0defaf57a611ac092eb76702a91e187 --- /dev/null +++ b/pybind11/tests/test_methods_and_attributes.cpp @@ -0,0 +1,729 @@ +/* + tests/test_methods_and_attributes.cpp -- constructors, deconstructors, attribute access, + __str__, argument and return value conventions + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" + +class ExampleMandA +{ +public: + ExampleMandA() + { + print_default_created(this); + } + ExampleMandA(int value) + : value(value) + { + print_created(this, value); + } + ExampleMandA(const ExampleMandA& e) + : value(e.value) + { + print_copy_created(this); + } + ExampleMandA(ExampleMandA&& e) + : value(e.value) + { + print_move_created(this); + } + ~ExampleMandA() + { + print_destroyed(this); + } + + std::string toString() + { + return "ExampleMandA[value=" + std::to_string(value) + "]"; + } + + void operator=(const ExampleMandA& e) + { + print_copy_assigned(this); + value = e.value; + } + void operator=(ExampleMandA&& e) + { + print_move_assigned(this); + value = e.value; + } + + void add1(ExampleMandA other) + { + value += other.value; + } // passing by value + void add2(ExampleMandA& other) + { + value += other.value; + } // passing by reference + void add3(const ExampleMandA& other) + { + value += other.value; + } // passing by const reference + void add4(ExampleMandA* other) + { + value += other->value; + } // passing by pointer + void add5(const ExampleMandA* other) + { + value += other->value; + } // passing by const pointer + + void add6(int other) + { + value += other; + } // passing by value + void add7(int& other) + { + value += other; + } // passing by reference + void add8(const int& other) + { + value += other; + } // passing by const reference + void add9(int* other) + { + value += *other; + } // passing by pointer + void add10(const int* other) + { + value += *other; + } // passing by const pointer + + ExampleMandA self1() + { + return *this; + } // return by value + ExampleMandA& self2() + { + return *this; + } // return by reference + const ExampleMandA& self3() + { + return *this; + } // return by const reference + ExampleMandA* self4() + { + return this; + } // return by pointer + const ExampleMandA* self5() + { + return this; + } // return by const pointer + + int internal1() + { + return value; + } // return by value + int& internal2() + { + return value; + } // return by reference + const int& internal3() + { + return value; + } // return by const reference + int* internal4() + { + return &value; + } // return by pointer + const int* internal5() + { + return &value; + } // return by const pointer + + py::str overloaded() + { + return "()"; + } + py::str overloaded(int) + { + return "(int)"; + } + py::str overloaded(int, float) + { + return "(int, float)"; + } + py::str overloaded(float, int) + { + return "(float, int)"; + } + py::str overloaded(int, int) + { + return "(int, int)"; + } + py::str overloaded(float, float) + { + return "(float, float)"; + } + py::str overloaded(int) const + { + return "(int) const"; + } + py::str overloaded(int, float) const + { + return "(int, float) const"; + } + py::str overloaded(float, int) const + { + return "(float, int) const"; + } + py::str overloaded(int, int) const + { + return "(int, int) const"; + } + py::str overloaded(float, float) const + { + return "(float, float) const"; + } + + static py::str overloaded(float) + { + return "static float"; + } + + int value = 0; +}; + +struct TestProperties +{ + int value = 1; + static int static_value; + + int get() const + { + return value; + } + void set(int v) + { + value = v; + } + + static int static_get() + { + return static_value; + } + static void static_set(int v) + { + static_value = v; + } +}; +int TestProperties::static_value = 1; + +struct TestPropertiesOverride : TestProperties +{ + int value = 99; + static int static_value; +}; +int TestPropertiesOverride::static_value = 99; + +struct TestPropRVP +{ + UserType v1{1}; + UserType v2{1}; + static UserType sv1; + static UserType sv2; + + const UserType& get1() const + { + return v1; + } + const UserType& get2() const + { + return v2; + } + UserType get_rvalue() const + { + return v2; + } + void set1(int v) + { + v1.set(v); + } + void set2(int v) + { + v2.set(v); + } +}; +UserType TestPropRVP::sv1(1); +UserType TestPropRVP::sv2(1); + +// py::arg/py::arg_v testing: these arguments just record their argument when invoked +class ArgInspector1 +{ +public: + std::string arg = "(default arg inspector 1)"; +}; +class ArgInspector2 +{ +public: + std::string arg = "(default arg inspector 2)"; +}; +class ArgAlwaysConverts +{}; +namespace pybind11 { +namespace detail { +template <> +struct type_caster<ArgInspector1> +{ +public: + PYBIND11_TYPE_CASTER(ArgInspector1, _("ArgInspector1")); + + bool load(handle src, bool convert) + { + value.arg = "loading ArgInspector1 argument " + std::string(convert ? "WITH" : "WITHOUT") + + " conversion allowed. " + "Argument value = " + + (std::string)str(src); + return true; + } + + static handle cast(const ArgInspector1& src, return_value_policy, handle) + { + return str(src.arg).release(); + } +}; +template <> +struct type_caster<ArgInspector2> +{ +public: + PYBIND11_TYPE_CASTER(ArgInspector2, _("ArgInspector2")); + + bool load(handle src, bool convert) + { + value.arg = "loading ArgInspector2 argument " + std::string(convert ? "WITH" : "WITHOUT") + + " conversion allowed. " + "Argument value = " + + (std::string)str(src); + return true; + } + + static handle cast(const ArgInspector2& src, return_value_policy, handle) + { + return str(src.arg).release(); + } +}; +template <> +struct type_caster<ArgAlwaysConverts> +{ +public: + PYBIND11_TYPE_CASTER(ArgAlwaysConverts, _("ArgAlwaysConverts")); + + bool load(handle, bool convert) + { + return convert; + } + + static handle cast(const ArgAlwaysConverts&, return_value_policy, handle) + { + return py::none().release(); + } +}; +} // namespace detail +} // namespace pybind11 + +// test_custom_caster_destruction +class DestructionTester +{ +public: + DestructionTester() + { + print_default_created(this); + } + ~DestructionTester() + { + print_destroyed(this); + } + DestructionTester(const DestructionTester&) + { + print_copy_created(this); + } + DestructionTester(DestructionTester&&) + { + print_move_created(this); + } + DestructionTester& operator=(const DestructionTester&) + { + print_copy_assigned(this); + return *this; + } + DestructionTester& operator=(DestructionTester&&) + { + print_move_assigned(this); + return *this; + } +}; +namespace pybind11 { +namespace detail { +template <> +struct type_caster<DestructionTester> +{ + PYBIND11_TYPE_CASTER(DestructionTester, _("DestructionTester")); + bool load(handle, bool) + { + return true; + } + + static handle cast(const DestructionTester&, return_value_policy, handle) + { + return py::bool_(true).release(); + } +}; +} // namespace detail +} // namespace pybind11 + +// Test None-allowed py::arg argument policy +class NoneTester +{ +public: + int answer = 42; +}; +int none1(const NoneTester& obj) +{ + return obj.answer; +} +int none2(NoneTester* obj) +{ + return obj ? obj->answer : -1; +} +int none3(std::shared_ptr<NoneTester>& obj) +{ + return obj ? obj->answer : -1; +} +int none4(std::shared_ptr<NoneTester>* obj) +{ + return obj && *obj ? (*obj)->answer : -1; +} +int none5(std::shared_ptr<NoneTester> obj) +{ + return obj ? obj->answer : -1; +} + +struct StrIssue +{ + int val = -1; + + StrIssue() = default; + StrIssue(int i) + : val{i} + {} +}; + +// Issues #854, #910: incompatible function args when member function/pointer is in unregistered base class +class UnregisteredBase +{ +public: + void do_nothing() const {} + void increase_value() + { + rw_value++; + ro_value += 0.25; + } + void set_int(int v) + { + rw_value = v; + } + int get_int() const + { + return rw_value; + } + double get_double() const + { + return ro_value; + } + int rw_value = 42; + double ro_value = 1.25; +}; +class RegisteredDerived : public UnregisteredBase +{ +public: + using UnregisteredBase::UnregisteredBase; + double sum() const + { + return rw_value + ro_value; + } +}; + +TEST_SUBMODULE(methods_and_attributes, m) +{ + // test_methods_and_attributes + py::class_<ExampleMandA> emna(m, "ExampleMandA"); + emna.def(py::init<>()) + .def(py::init<int>()) + .def(py::init<const ExampleMandA&>()) + .def("add1", &ExampleMandA::add1) + .def("add2", &ExampleMandA::add2) + .def("add3", &ExampleMandA::add3) + .def("add4", &ExampleMandA::add4) + .def("add5", &ExampleMandA::add5) + .def("add6", &ExampleMandA::add6) + .def("add7", &ExampleMandA::add7) + .def("add8", &ExampleMandA::add8) + .def("add9", &ExampleMandA::add9) + .def("add10", &ExampleMandA::add10) + .def("self1", &ExampleMandA::self1) + .def("self2", &ExampleMandA::self2) + .def("self3", &ExampleMandA::self3) + .def("self4", &ExampleMandA::self4) + .def("self5", &ExampleMandA::self5) + .def("internal1", &ExampleMandA::internal1) + .def("internal2", &ExampleMandA::internal2) + .def("internal3", &ExampleMandA::internal3) + .def("internal4", &ExampleMandA::internal4) + .def("internal5", &ExampleMandA::internal5) +#if defined(PYBIND11_OVERLOAD_CAST) + .def("overloaded", py::overload_cast<>(&ExampleMandA::overloaded)) + .def("overloaded", py::overload_cast<int>(&ExampleMandA::overloaded)) + .def("overloaded", py::overload_cast<int, float>(&ExampleMandA::overloaded)) + .def("overloaded", py::overload_cast<float, int>(&ExampleMandA::overloaded)) + .def("overloaded", py::overload_cast<int, int>(&ExampleMandA::overloaded)) + .def("overloaded", py::overload_cast<float, float>(&ExampleMandA::overloaded)) + .def("overloaded_float", py::overload_cast<float, float>(&ExampleMandA::overloaded)) + .def("overloaded_const", py::overload_cast<int>(&ExampleMandA::overloaded, py::const_)) + .def("overloaded_const", py::overload_cast<int, float>(&ExampleMandA::overloaded, py::const_)) + .def("overloaded_const", py::overload_cast<float, int>(&ExampleMandA::overloaded, py::const_)) + .def("overloaded_const", py::overload_cast<int, int>(&ExampleMandA::overloaded, py::const_)) + .def("overloaded_const", py::overload_cast<float, float>(&ExampleMandA::overloaded, py::const_)) +#else + .def("overloaded", static_cast<py::str (ExampleMandA::*)()>(&ExampleMandA::overloaded)) + .def("overloaded", static_cast<py::str (ExampleMandA::*)(int)>(&ExampleMandA::overloaded)) + .def("overloaded", static_cast<py::str (ExampleMandA::*)(int, float)>(&ExampleMandA::overloaded)) + .def("overloaded", static_cast<py::str (ExampleMandA::*)(float, int)>(&ExampleMandA::overloaded)) + .def("overloaded", static_cast<py::str (ExampleMandA::*)(int, int)>(&ExampleMandA::overloaded)) + .def("overloaded", static_cast<py::str (ExampleMandA::*)(float, float)>(&ExampleMandA::overloaded)) + .def("overloaded_float", static_cast<py::str (ExampleMandA::*)(float, float)>(&ExampleMandA::overloaded)) + .def("overloaded_const", static_cast<py::str (ExampleMandA::*)(int) const>(&ExampleMandA::overloaded)) + .def("overloaded_const", static_cast<py::str (ExampleMandA::*)(int, float) const>(&ExampleMandA::overloaded)) + .def("overloaded_const", static_cast<py::str (ExampleMandA::*)(float, int) const>(&ExampleMandA::overloaded)) + .def("overloaded_const", static_cast<py::str (ExampleMandA::*)(int, int) const>(&ExampleMandA::overloaded)) + .def("overloaded_const", static_cast<py::str (ExampleMandA::*)(float, float) const>(&ExampleMandA::overloaded)) +#endif + // test_no_mixed_overloads + // Raise error if trying to mix static/non-static overloads on the same name: + .def_static("add_mixed_overloads1", + []() { + auto emna = py::reinterpret_borrow<py::class_<ExampleMandA>>( + py::module::import("pybind11_tests.methods_and_attributes").attr("ExampleMandA")); + emna.def("overload_mixed1", + static_cast<py::str (ExampleMandA::*)(int, int)>(&ExampleMandA::overloaded)) + .def_static("overload_mixed1", static_cast<py::str (*)(float)>(&ExampleMandA::overloaded)); + }) + .def_static("add_mixed_overloads2", + []() { + auto emna = py::reinterpret_borrow<py::class_<ExampleMandA>>( + py::module::import("pybind11_tests.methods_and_attributes").attr("ExampleMandA")); + emna.def_static("overload_mixed2", static_cast<py::str (*)(float)>(&ExampleMandA::overloaded)) + .def("overload_mixed2", + static_cast<py::str (ExampleMandA::*)(int, int)>(&ExampleMandA::overloaded)); + }) + .def("__str__", &ExampleMandA::toString) + .def_readwrite("value", &ExampleMandA::value); + + // test_copy_method + // Issue #443: can't call copied methods in Python 3 + emna.attr("add2b") = emna.attr("add2"); + + // test_properties, test_static_properties, test_static_cls + py::class_<TestProperties>(m, "TestProperties") + .def(py::init<>()) + .def_readonly("def_readonly", &TestProperties::value) + .def_readwrite("def_readwrite", &TestProperties::value) + .def_property("def_writeonly", nullptr, [](TestProperties& s, int v) { s.value = v; }) + .def_property("def_property_writeonly", nullptr, &TestProperties::set) + .def_property_readonly("def_property_readonly", &TestProperties::get) + .def_property("def_property", &TestProperties::get, &TestProperties::set) + .def_property("def_property_impossible", nullptr, nullptr) + .def_readonly_static("def_readonly_static", &TestProperties::static_value) + .def_readwrite_static("def_readwrite_static", &TestProperties::static_value) + .def_property_static("def_writeonly_static", nullptr, [](py::object, int v) { TestProperties::static_value = v; }) + .def_property_readonly_static("def_property_readonly_static", + [](py::object) { return TestProperties::static_get(); }) + .def_property_static( + "def_property_writeonly_static", nullptr, [](py::object, int v) { return TestProperties::static_set(v); }) + .def_property_static("def_property_static", + [](py::object) { return TestProperties::static_get(); }, + [](py::object, int v) { TestProperties::static_set(v); }) + .def_property_static( + "static_cls", [](py::object cls) { return cls; }, [](py::object cls, py::function f) { f(cls); }); + + py::class_<TestPropertiesOverride, TestProperties>(m, "TestPropertiesOverride") + .def(py::init<>()) + .def_readonly("def_readonly", &TestPropertiesOverride::value) + .def_readonly_static("def_readonly_static", &TestPropertiesOverride::static_value); + + auto static_get1 = [](py::object) -> const UserType& { return TestPropRVP::sv1; }; + auto static_get2 = [](py::object) -> const UserType& { return TestPropRVP::sv2; }; + auto static_set1 = [](py::object, int v) { TestPropRVP::sv1.set(v); }; + auto static_set2 = [](py::object, int v) { TestPropRVP::sv2.set(v); }; + auto rvp_copy = py::return_value_policy::copy; + + // test_property_return_value_policies + py::class_<TestPropRVP>(m, "TestPropRVP") + .def(py::init<>()) + .def_property_readonly("ro_ref", &TestPropRVP::get1) + .def_property_readonly("ro_copy", &TestPropRVP::get2, rvp_copy) + .def_property_readonly("ro_func", py::cpp_function(&TestPropRVP::get2, rvp_copy)) + .def_property("rw_ref", &TestPropRVP::get1, &TestPropRVP::set1) + .def_property("rw_copy", &TestPropRVP::get2, &TestPropRVP::set2, rvp_copy) + .def_property("rw_func", py::cpp_function(&TestPropRVP::get2, rvp_copy), &TestPropRVP::set2) + .def_property_readonly_static("static_ro_ref", static_get1) + .def_property_readonly_static("static_ro_copy", static_get2, rvp_copy) + .def_property_readonly_static("static_ro_func", py::cpp_function(static_get2, rvp_copy)) + .def_property_static("static_rw_ref", static_get1, static_set1) + .def_property_static("static_rw_copy", static_get2, static_set2, rvp_copy) + .def_property_static("static_rw_func", py::cpp_function(static_get2, rvp_copy), static_set2) + // test_property_rvalue_policy + .def_property_readonly("rvalue", &TestPropRVP::get_rvalue) + .def_property_readonly_static("static_rvalue", [](py::object) { return UserType(1); }); + + // test_metaclass_override + struct MetaclassOverride + {}; + py::class_<MetaclassOverride>(m, "MetaclassOverride", py::metaclass((PyObject*)&PyType_Type)) + .def_property_readonly_static("readonly", [](py::object) { return 1; }); + +#if !defined(PYPY_VERSION) + // test_dynamic_attributes + class DynamicClass + { + public: + DynamicClass() + { + print_default_created(this); + } + ~DynamicClass() + { + print_destroyed(this); + } + }; + py::class_<DynamicClass>(m, "DynamicClass", py::dynamic_attr()).def(py::init()); + + class CppDerivedDynamicClass : public DynamicClass + {}; + py::class_<CppDerivedDynamicClass, DynamicClass>(m, "CppDerivedDynamicClass").def(py::init()); +#endif + + // test_noconvert_args + // + // Test converting. The ArgAlwaysConverts is just there to make the first no-conversion pass + // fail so that our call always ends up happening via the second dispatch (the one that allows + // some conversion). + class ArgInspector + { + public: + ArgInspector1 f(ArgInspector1 a, ArgAlwaysConverts) + { + return a; + } + std::string g(ArgInspector1 a, const ArgInspector1& b, int c, ArgInspector2* d, ArgAlwaysConverts) + { + return a.arg + "\n" + b.arg + "\n" + std::to_string(c) + "\n" + d->arg; + } + static ArgInspector2 h(ArgInspector2 a, ArgAlwaysConverts) + { + return a; + } + }; + py::class_<ArgInspector>(m, "ArgInspector") + .def(py::init<>()) + .def("f", &ArgInspector::f, py::arg(), py::arg() = ArgAlwaysConverts()) + .def("g", + &ArgInspector::g, + "a"_a.noconvert(), + "b"_a, + "c"_a.noconvert() = 13, + "d"_a = ArgInspector2(), + py::arg() = ArgAlwaysConverts()) + .def_static("h", &ArgInspector::h, py::arg().noconvert(), py::arg() = ArgAlwaysConverts()); + m.def("arg_inspect_func", + [](ArgInspector2 a, ArgInspector1 b, ArgAlwaysConverts) { return a.arg + "\n" + b.arg; }, + py::arg().noconvert(false), + py::arg_v(nullptr, ArgInspector1()).noconvert(true), + py::arg() = ArgAlwaysConverts()); + + m.def("floats_preferred", [](double f) { return 0.5 * f; }, py::arg("f")); + m.def("floats_only", [](double f) { return 0.5 * f; }, py::arg("f").noconvert()); + m.def("ints_preferred", [](int i) { return i / 2; }, py::arg("i")); + m.def("ints_only", [](int i) { return i / 2; }, py::arg("i").noconvert()); + + // test_bad_arg_default + // Issue/PR #648: bad arg default debugging output +#if !defined(NDEBUG) + m.attr("debug_enabled") = true; +#else + m.attr("debug_enabled") = false; +#endif + m.def("bad_arg_def_named", [] { + auto m = py::module::import("pybind11_tests"); + m.def("should_fail", [](int, UnregisteredType) {}, py::arg(), py::arg("a") = UnregisteredType()); + }); + m.def("bad_arg_def_unnamed", [] { + auto m = py::module::import("pybind11_tests"); + m.def("should_fail", [](int, UnregisteredType) {}, py::arg(), py::arg() = UnregisteredType()); + }); + + // test_accepts_none + py::class_<NoneTester, std::shared_ptr<NoneTester>>(m, "NoneTester").def(py::init<>()); + m.def("no_none1", &none1, py::arg().none(false)); + m.def("no_none2", &none2, py::arg().none(false)); + m.def("no_none3", &none3, py::arg().none(false)); + m.def("no_none4", &none4, py::arg().none(false)); + m.def("no_none5", &none5, py::arg().none(false)); + m.def("ok_none1", &none1); + m.def("ok_none2", &none2, py::arg().none(true)); + m.def("ok_none3", &none3); + m.def("ok_none4", &none4, py::arg().none(true)); + m.def("ok_none5", &none5); + + // test_str_issue + // Issue #283: __str__ called on uninitialized instance when constructor arguments invalid + py::class_<StrIssue>(m, "StrIssue").def(py::init<int>()).def(py::init<>()).def("__str__", [](const StrIssue& si) { + return "StrIssue[" + std::to_string(si.val) + "]"; + }); + + // test_unregistered_base_implementations + // + // Issues #854/910: incompatible function args when member function/pointer is in unregistered + // base class The methods and member pointers below actually resolve to members/pointers in + // UnregisteredBase; before this test/fix they would be registered via lambda with a first + // argument of an unregistered type, and thus uncallable. + py::class_<RegisteredDerived>(m, "RegisteredDerived") + .def(py::init<>()) + .def("do_nothing", &RegisteredDerived::do_nothing) + .def("increase_value", &RegisteredDerived::increase_value) + .def_readwrite("rw_value", &RegisteredDerived::rw_value) + .def_readonly("ro_value", &RegisteredDerived::ro_value) + // These should trigger a static_assert if uncommented + //.def_readwrite("fails", &UserType::value) // should trigger a static_assert if uncommented + //.def_readonly("fails", &UserType::value) // should trigger a static_assert if uncommented + .def_property("rw_value_prop", &RegisteredDerived::get_int, &RegisteredDerived::set_int) + .def_property_readonly("ro_value_prop", &RegisteredDerived::get_double) + // This one is in the registered class: + .def("sum", &RegisteredDerived::sum); + + using Adapted = decltype(py::method_adaptor<RegisteredDerived>(&RegisteredDerived::do_nothing)); + static_assert(std::is_same<Adapted, void (RegisteredDerived::*)() const>::value, ""); + + // test_custom_caster_destruction + // Test that `take_ownership` works on types with a custom type caster when given a pointer + + // default policy: don't take ownership: + m.def("custom_caster_no_destroy", []() { + static auto* dt = new DestructionTester(); + return dt; + }); + + m.def("custom_caster_destroy", + []() { return new DestructionTester(); }, + py::return_value_policy::take_ownership); // Takes ownership: destroy when finished + m.def("custom_caster_destroy_const", + []() -> const DestructionTester* { return new DestructionTester(); }, + py::return_value_policy::take_ownership); // Likewise (const doesn't inhibit destruction) + m.def("destruction_tester_cstats", &ConstructorStats::get<DestructionTester>, py::return_value_policy::reference); +} diff --git a/pybind11/tests/test_methods_and_attributes.py b/pybind11/tests/test_methods_and_attributes.py new file mode 100644 index 0000000000000000000000000000000000000000..60977b7fc266c2b4affbabba9c2d28211d462d97 --- /dev/null +++ b/pybind11/tests/test_methods_and_attributes.py @@ -0,0 +1,503 @@ +import pytest +from pybind11_tests import methods_and_attributes as m +from pybind11_tests import ConstructorStats + + +def test_methods_and_attributes(): + instance1 = m.ExampleMandA() + instance2 = m.ExampleMandA(32) + + instance1.add1(instance2) + instance1.add2(instance2) + instance1.add3(instance2) + instance1.add4(instance2) + instance1.add5(instance2) + instance1.add6(32) + instance1.add7(32) + instance1.add8(32) + instance1.add9(32) + instance1.add10(32) + + assert str(instance1) == "ExampleMandA[value=320]" + assert str(instance2) == "ExampleMandA[value=32]" + assert str(instance1.self1()) == "ExampleMandA[value=320]" + assert str(instance1.self2()) == "ExampleMandA[value=320]" + assert str(instance1.self3()) == "ExampleMandA[value=320]" + assert str(instance1.self4()) == "ExampleMandA[value=320]" + assert str(instance1.self5()) == "ExampleMandA[value=320]" + + assert instance1.internal1() == 320 + assert instance1.internal2() == 320 + assert instance1.internal3() == 320 + assert instance1.internal4() == 320 + assert instance1.internal5() == 320 + + assert instance1.overloaded() == "()" + assert instance1.overloaded(0) == "(int)" + assert instance1.overloaded(1, 1.0) == "(int, float)" + assert instance1.overloaded(2.0, 2) == "(float, int)" + assert instance1.overloaded(3, 3) == "(int, int)" + assert instance1.overloaded(4., 4.) == "(float, float)" + assert instance1.overloaded_const(-3) == "(int) const" + assert instance1.overloaded_const(5, 5.0) == "(int, float) const" + assert instance1.overloaded_const(6.0, 6) == "(float, int) const" + assert instance1.overloaded_const(7, 7) == "(int, int) const" + assert instance1.overloaded_const(8., 8.) == "(float, float) const" + assert instance1.overloaded_float(1, 1) == "(float, float)" + assert instance1.overloaded_float(1, 1.) == "(float, float)" + assert instance1.overloaded_float(1., 1) == "(float, float)" + assert instance1.overloaded_float(1., 1.) == "(float, float)" + + assert instance1.value == 320 + instance1.value = 100 + assert str(instance1) == "ExampleMandA[value=100]" + + cstats = ConstructorStats.get(m.ExampleMandA) + assert cstats.alive() == 2 + del instance1, instance2 + assert cstats.alive() == 0 + assert cstats.values() == ["32"] + assert cstats.default_constructions == 1 + assert cstats.copy_constructions == 3 + assert cstats.move_constructions >= 1 + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + +def test_copy_method(): + """Issue #443: calling copied methods fails in Python 3""" + + m.ExampleMandA.add2c = m.ExampleMandA.add2 + m.ExampleMandA.add2d = m.ExampleMandA.add2b + a = m.ExampleMandA(123) + assert a.value == 123 + a.add2(m.ExampleMandA(-100)) + assert a.value == 23 + a.add2b(m.ExampleMandA(20)) + assert a.value == 43 + a.add2c(m.ExampleMandA(6)) + assert a.value == 49 + a.add2d(m.ExampleMandA(-7)) + assert a.value == 42 + + +def test_properties(): + instance = m.TestProperties() + + assert instance.def_readonly == 1 + with pytest.raises(AttributeError): + instance.def_readonly = 2 + + instance.def_readwrite = 2 + assert instance.def_readwrite == 2 + + assert instance.def_property_readonly == 2 + with pytest.raises(AttributeError): + instance.def_property_readonly = 3 + + instance.def_property = 3 + assert instance.def_property == 3 + + with pytest.raises(AttributeError) as excinfo: + dummy = instance.def_property_writeonly # noqa: F841 unused var + assert "unreadable attribute" in str(excinfo) + + instance.def_property_writeonly = 4 + assert instance.def_property_readonly == 4 + + with pytest.raises(AttributeError) as excinfo: + dummy = instance.def_property_impossible # noqa: F841 unused var + assert "unreadable attribute" in str(excinfo) + + with pytest.raises(AttributeError) as excinfo: + instance.def_property_impossible = 5 + assert "can't set attribute" in str(excinfo) + + +def test_static_properties(): + assert m.TestProperties.def_readonly_static == 1 + with pytest.raises(AttributeError) as excinfo: + m.TestProperties.def_readonly_static = 2 + assert "can't set attribute" in str(excinfo) + + m.TestProperties.def_readwrite_static = 2 + assert m.TestProperties.def_readwrite_static == 2 + + with pytest.raises(AttributeError) as excinfo: + dummy = m.TestProperties.def_writeonly_static # noqa: F841 unused var + assert "unreadable attribute" in str(excinfo) + + m.TestProperties.def_writeonly_static = 3 + assert m.TestProperties.def_readonly_static == 3 + + assert m.TestProperties.def_property_readonly_static == 3 + with pytest.raises(AttributeError) as excinfo: + m.TestProperties.def_property_readonly_static = 99 + assert "can't set attribute" in str(excinfo) + + m.TestProperties.def_property_static = 4 + assert m.TestProperties.def_property_static == 4 + + with pytest.raises(AttributeError) as excinfo: + dummy = m.TestProperties.def_property_writeonly_static + assert "unreadable attribute" in str(excinfo) + + m.TestProperties.def_property_writeonly_static = 5 + assert m.TestProperties.def_property_static == 5 + + # Static property read and write via instance + instance = m.TestProperties() + + m.TestProperties.def_readwrite_static = 0 + assert m.TestProperties.def_readwrite_static == 0 + assert instance.def_readwrite_static == 0 + + instance.def_readwrite_static = 2 + assert m.TestProperties.def_readwrite_static == 2 + assert instance.def_readwrite_static == 2 + + with pytest.raises(AttributeError) as excinfo: + dummy = instance.def_property_writeonly_static # noqa: F841 unused var + assert "unreadable attribute" in str(excinfo) + + instance.def_property_writeonly_static = 4 + assert instance.def_property_static == 4 + + # It should be possible to override properties in derived classes + assert m.TestPropertiesOverride().def_readonly == 99 + assert m.TestPropertiesOverride.def_readonly_static == 99 + + +def test_static_cls(): + """Static property getter and setters expect the type object as the their only argument""" + + instance = m.TestProperties() + assert m.TestProperties.static_cls is m.TestProperties + assert instance.static_cls is m.TestProperties + + def check_self(self): + assert self is m.TestProperties + + m.TestProperties.static_cls = check_self + instance.static_cls = check_self + + +def test_metaclass_override(): + """Overriding pybind11's default metaclass changes the behavior of `static_property`""" + + assert type(m.ExampleMandA).__name__ == "pybind11_type" + assert type(m.MetaclassOverride).__name__ == "type" + + assert m.MetaclassOverride.readonly == 1 + assert type(m.MetaclassOverride.__dict__["readonly"]).__name__ == "pybind11_static_property" + + # Regular `type` replaces the property instead of calling `__set__()` + m.MetaclassOverride.readonly = 2 + assert m.MetaclassOverride.readonly == 2 + assert isinstance(m.MetaclassOverride.__dict__["readonly"], int) + + +def test_no_mixed_overloads(): + from pybind11_tests import debug_enabled + + with pytest.raises(RuntimeError) as excinfo: + m.ExampleMandA.add_mixed_overloads1() + assert (str(excinfo.value) == "overloading a method with both static and instance methods is not supported; " + + ("compile in debug mode for more details" + if not debug_enabled else "error while attempting to bind static method ExampleMandA.overload_mixed1" + "(arg0: float) -> str")) + + with pytest.raises(RuntimeError) as excinfo: + m.ExampleMandA.add_mixed_overloads2() + assert (str(excinfo.value) == "overloading a method with both static and instance methods is not supported; " + + ("compile in debug mode for more details" + if not debug_enabled else "error while attempting to bind instance method ExampleMandA.overload_mixed2" + "(self: pybind11_tests.methods_and_attributes.ExampleMandA, arg0: int, arg1: int)" + " -> str")) + + +@pytest.mark.parametrize("access", ["ro", "rw", "static_ro", "static_rw"]) +def test_property_return_value_policies(access): + if not access.startswith("static"): + obj = m.TestPropRVP() + else: + obj = m.TestPropRVP + + ref = getattr(obj, access + "_ref") + assert ref.value == 1 + ref.value = 2 + assert getattr(obj, access + "_ref").value == 2 + ref.value = 1 # restore original value for static properties + + copy = getattr(obj, access + "_copy") + assert copy.value == 1 + copy.value = 2 + assert getattr(obj, access + "_copy").value == 1 + + copy = getattr(obj, access + "_func") + assert copy.value == 1 + copy.value = 2 + assert getattr(obj, access + "_func").value == 1 + + +def test_property_rvalue_policy(): + """When returning an rvalue, the return value policy is automatically changed from + `reference(_internal)` to `move`. The following would not work otherwise.""" + + instance = m.TestPropRVP() + o = instance.rvalue + assert o.value == 1 + + os = m.TestPropRVP.static_rvalue + assert os.value == 1 + + +# https://bitbucket.org/pypy/pypy/issues/2447 +@pytest.unsupported_on_pypy +def test_dynamic_attributes(): + instance = m.DynamicClass() + assert not hasattr(instance, "foo") + assert "foo" not in dir(instance) + + # Dynamically add attribute + instance.foo = 42 + assert hasattr(instance, "foo") + assert instance.foo == 42 + assert "foo" in dir(instance) + + # __dict__ should be accessible and replaceable + assert "foo" in instance.__dict__ + instance.__dict__ = {"bar": True} + assert not hasattr(instance, "foo") + assert hasattr(instance, "bar") + + with pytest.raises(TypeError) as excinfo: + instance.__dict__ = [] + assert str(excinfo.value) == "__dict__ must be set to a dictionary, not a 'list'" + + cstats = ConstructorStats.get(m.DynamicClass) + assert cstats.alive() == 1 + del instance + assert cstats.alive() == 0 + + # Derived classes should work as well + class PythonDerivedDynamicClass(m.DynamicClass): + pass + + for cls in m.CppDerivedDynamicClass, PythonDerivedDynamicClass: + derived = cls() + derived.foobar = 100 + assert derived.foobar == 100 + + assert cstats.alive() == 1 + del derived + assert cstats.alive() == 0 + + +# https://bitbucket.org/pypy/pypy/issues/2447 +@pytest.unsupported_on_pypy +def test_cyclic_gc(): + # One object references itself + instance = m.DynamicClass() + instance.circular_reference = instance + + cstats = ConstructorStats.get(m.DynamicClass) + assert cstats.alive() == 1 + del instance + assert cstats.alive() == 0 + + # Two object reference each other + i1 = m.DynamicClass() + i2 = m.DynamicClass() + i1.cycle = i2 + i2.cycle = i1 + + assert cstats.alive() == 2 + del i1, i2 + assert cstats.alive() == 0 + + +def test_noconvert_args(msg): + a = m.ArgInspector() + assert msg(a.f("hi")) == """ + loading ArgInspector1 argument WITH conversion allowed. Argument value = hi + """ + assert msg(a.g("this is a", "this is b")) == """ + loading ArgInspector1 argument WITHOUT conversion allowed. Argument value = this is a + loading ArgInspector1 argument WITH conversion allowed. Argument value = this is b + 13 + loading ArgInspector2 argument WITH conversion allowed. Argument value = (default arg inspector 2) + """ # noqa: E501 line too long + assert msg(a.g("this is a", "this is b", 42)) == """ + loading ArgInspector1 argument WITHOUT conversion allowed. Argument value = this is a + loading ArgInspector1 argument WITH conversion allowed. Argument value = this is b + 42 + loading ArgInspector2 argument WITH conversion allowed. Argument value = (default arg inspector 2) + """ # noqa: E501 line too long + assert msg(a.g("this is a", "this is b", 42, "this is d")) == """ + loading ArgInspector1 argument WITHOUT conversion allowed. Argument value = this is a + loading ArgInspector1 argument WITH conversion allowed. Argument value = this is b + 42 + loading ArgInspector2 argument WITH conversion allowed. Argument value = this is d + """ + assert (a.h("arg 1") == "loading ArgInspector2 argument WITHOUT conversion allowed. Argument value = arg 1") + assert msg(m.arg_inspect_func("A1", "A2")) == """ + loading ArgInspector2 argument WITH conversion allowed. Argument value = A1 + loading ArgInspector1 argument WITHOUT conversion allowed. Argument value = A2 + """ + + assert m.floats_preferred(4) == 2.0 + assert m.floats_only(4.0) == 2.0 + with pytest.raises(TypeError) as excinfo: + m.floats_only(4) + assert msg(excinfo.value) == """ + floats_only(): incompatible function arguments. The following argument types are supported: + 1. (f: float) -> float + + Invoked with: 4 + """ + + assert m.ints_preferred(4) == 2 + assert m.ints_preferred(True) == 0 + with pytest.raises(TypeError) as excinfo: + m.ints_preferred(4.0) + assert msg(excinfo.value) == """ + ints_preferred(): incompatible function arguments. The following argument types are supported: + 1. (i: int) -> int + + Invoked with: 4.0 + """ # noqa: E501 line too long + + assert m.ints_only(4) == 2 + with pytest.raises(TypeError) as excinfo: + m.ints_only(4.0) + assert msg(excinfo.value) == """ + ints_only(): incompatible function arguments. The following argument types are supported: + 1. (i: int) -> int + + Invoked with: 4.0 + """ + + +def test_bad_arg_default(msg): + from pybind11_tests import debug_enabled + + with pytest.raises(RuntimeError) as excinfo: + m.bad_arg_def_named() + assert msg( + excinfo.value) == ("arg(): could not convert default argument 'a: UnregisteredType' in function " + "'should_fail' into a Python object (type not registered yet?)" if debug_enabled else + "arg(): could not convert default argument into a Python object (type not registered " + "yet?). Compile in debug mode for more information.") + + with pytest.raises(RuntimeError) as excinfo: + m.bad_arg_def_unnamed() + assert msg( + excinfo.value) == ("arg(): could not convert default argument 'UnregisteredType' in function " + "'should_fail' into a Python object (type not registered yet?)" if debug_enabled else + "arg(): could not convert default argument into a Python object (type not registered " + "yet?). Compile in debug mode for more information.") + + +def test_accepts_none(msg): + a = m.NoneTester() + assert m.no_none1(a) == 42 + assert m.no_none2(a) == 42 + assert m.no_none3(a) == 42 + assert m.no_none4(a) == 42 + assert m.no_none5(a) == 42 + assert m.ok_none1(a) == 42 + assert m.ok_none2(a) == 42 + assert m.ok_none3(a) == 42 + assert m.ok_none4(a) == 42 + assert m.ok_none5(a) == 42 + + with pytest.raises(TypeError) as excinfo: + m.no_none1(None) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.no_none2(None) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.no_none3(None) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.no_none4(None) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.no_none5(None) + assert "incompatible function arguments" in str(excinfo.value) + + # The first one still raises because you can't pass None as a lvalue reference arg: + with pytest.raises(TypeError) as excinfo: + assert m.ok_none1(None) == -1 + assert msg(excinfo.value) == """ + ok_none1(): incompatible function arguments. The following argument types are supported: + 1. (arg0: m.methods_and_attributes.NoneTester) -> int + + Invoked with: None + """ + + # The rest take the argument as pointer or holder, and accept None: + assert m.ok_none2(None) == -1 + assert m.ok_none3(None) == -1 + assert m.ok_none4(None) == -1 + assert m.ok_none5(None) == -1 + + +def test_str_issue(msg): + """#283: __str__ called on uninitialized instance when constructor arguments invalid""" + + assert str(m.StrIssue(3)) == "StrIssue[3]" + + with pytest.raises(TypeError) as excinfo: + str(m.StrIssue("no", "such", "constructor")) + assert msg(excinfo.value) == """ + __init__(): incompatible constructor arguments. The following argument types are supported: + 1. m.methods_and_attributes.StrIssue(arg0: int) + 2. m.methods_and_attributes.StrIssue() + + Invoked with: 'no', 'such', 'constructor' + """ + + +def test_unregistered_base_implementations(): + a = m.RegisteredDerived() + a.do_nothing() + assert a.rw_value == 42 + assert a.ro_value == 1.25 + a.rw_value += 5 + assert a.sum() == 48.25 + a.increase_value() + assert a.rw_value == 48 + assert a.ro_value == 1.5 + assert a.sum() == 49.5 + assert a.rw_value_prop == 48 + a.rw_value_prop += 1 + assert a.rw_value_prop == 49 + a.increase_value() + assert a.ro_value_prop == 1.75 + + +def test_custom_caster_destruction(): + """Tests that returning a pointer to a type that gets converted with a custom type caster gets + destroyed when the function has py::return_value_policy::take_ownership policy applied.""" + + cstats = m.destruction_tester_cstats() + # This one *doesn't* have take_ownership: the pointer should be used but not destroyed: + z = m.custom_caster_no_destroy() + assert cstats.alive() == 1 and cstats.default_constructions == 1 + assert z + + # take_ownership applied: this constructs a new object, casts it, then destroys it: + z = m.custom_caster_destroy() + assert z + assert cstats.default_constructions == 2 + + # Same, but with a const pointer return (which should *not* inhibit destruction): + z = m.custom_caster_destroy_const() + assert z + assert cstats.default_constructions == 3 + + # Make sure we still only have the original object (from ..._no_destroy()) alive: + assert cstats.alive() == 1 diff --git a/pybind11/tests/test_modules.cpp b/pybind11/tests/test_modules.cpp new file mode 100644 index 0000000000000000000000000000000000000000..741af53467d843ad77182a74a3c66c5eca29f93a --- /dev/null +++ b/pybind11/tests/test_modules.cpp @@ -0,0 +1,149 @@ +/* + tests/test_modules.cpp -- nested modules, importing modules, and + internal references + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" + +TEST_SUBMODULE(modules, m) +{ + // test_nested_modules + py::module m_sub = m.def_submodule("subsubmodule"); + m_sub.def("submodule_func", []() { return "submodule_func()"; }); + + // test_reference_internal + class A + { + public: + A(int v) + : v(v) + { + print_created(this, v); + } + ~A() + { + print_destroyed(this); + } + A(const A&) + { + print_copy_created(this); + } + A& operator=(const A& copy) + { + print_copy_assigned(this); + v = copy.v; + return *this; + } + std::string toString() + { + return "A[" + std::to_string(v) + "]"; + } + + private: + int v; + }; + py::class_<A>(m_sub, "A").def(py::init<int>()).def("__repr__", &A::toString); + + class B + { + public: + B() + { + print_default_created(this); + } + ~B() + { + print_destroyed(this); + } + B(const B&) + { + print_copy_created(this); + } + B& operator=(const B& copy) + { + print_copy_assigned(this); + a1 = copy.a1; + a2 = copy.a2; + return *this; + } + A& get_a1() + { + return a1; + } + A& get_a2() + { + return a2; + } + + A a1{1}; + A a2{2}; + }; + py::class_<B>(m_sub, "B") + .def(py::init<>()) + .def("get_a1", &B::get_a1, "Return the internal A 1", py::return_value_policy::reference_internal) + .def("get_a2", &B::get_a2, "Return the internal A 2", py::return_value_policy::reference_internal) + .def_readwrite("a1", &B::a1) // def_readonly uses an internal reference return policy by default + .def_readwrite("a2", &B::a2); + + m.attr("OD") = py::module::import("collections").attr("OrderedDict"); + + // test_duplicate_registration + // Registering two things with the same name + m.def("duplicate_registration", []() { + class Dupe1 + {}; + class Dupe2 + {}; + class Dupe3 + {}; + class DupeException + {}; + + auto dm = py::module("dummy"); + auto failures = py::list(); + + py::class_<Dupe1>(dm, "Dupe1"); + py::class_<Dupe2>(dm, "Dupe2"); + dm.def("dupe1_factory", []() { return Dupe1(); }); + py::exception<DupeException>(dm, "DupeException"); + + try { + py::class_<Dupe1>(dm, "Dupe1"); + failures.append("Dupe1 class"); + } catch (std::runtime_error&) { + } + try { + dm.def("Dupe1", []() { return Dupe1(); }); + failures.append("Dupe1 function"); + } catch (std::runtime_error&) { + } + try { + py::class_<Dupe3>(dm, "dupe1_factory"); + failures.append("dupe1_factory"); + } catch (std::runtime_error&) { + } + try { + py::exception<Dupe3>(dm, "Dupe2"); + failures.append("Dupe2"); + } catch (std::runtime_error&) { + } + try { + dm.def("DupeException", []() { return 30; }); + failures.append("DupeException1"); + } catch (std::runtime_error&) { + } + try { + py::class_<DupeException>(dm, "DupeException"); + failures.append("DupeException2"); + } catch (std::runtime_error&) { + } + + return failures; + }); +} diff --git a/pybind11/tests/test_modules.py b/pybind11/tests/test_modules.py new file mode 100644 index 0000000000000000000000000000000000000000..2552838c2b888809067c6b524301ce972a400892 --- /dev/null +++ b/pybind11/tests/test_modules.py @@ -0,0 +1,72 @@ +from pybind11_tests import modules as m +from pybind11_tests.modules import subsubmodule as ms +from pybind11_tests import ConstructorStats + + +def test_nested_modules(): + import pybind11_tests + assert pybind11_tests.__name__ == "pybind11_tests" + assert pybind11_tests.modules.__name__ == "pybind11_tests.modules" + assert pybind11_tests.modules.subsubmodule.__name__ == "pybind11_tests.modules.subsubmodule" + assert m.__name__ == "pybind11_tests.modules" + assert ms.__name__ == "pybind11_tests.modules.subsubmodule" + + assert ms.submodule_func() == "submodule_func()" + + +def test_reference_internal(): + b = ms.B() + assert str(b.get_a1()) == "A[1]" + assert str(b.a1) == "A[1]" + assert str(b.get_a2()) == "A[2]" + assert str(b.a2) == "A[2]" + + b.a1 = ms.A(42) + b.a2 = ms.A(43) + assert str(b.get_a1()) == "A[42]" + assert str(b.a1) == "A[42]" + assert str(b.get_a2()) == "A[43]" + assert str(b.a2) == "A[43]" + + astats, bstats = ConstructorStats.get(ms.A), ConstructorStats.get(ms.B) + assert astats.alive() == 2 + assert bstats.alive() == 1 + del b + assert astats.alive() == 0 + assert bstats.alive() == 0 + assert astats.values() == ['1', '2', '42', '43'] + assert bstats.values() == [] + assert astats.default_constructions == 0 + assert bstats.default_constructions == 1 + assert astats.copy_constructions == 0 + assert bstats.copy_constructions == 0 + # assert astats.move_constructions >= 0 # Don't invoke any + # assert bstats.move_constructions >= 0 # Don't invoke any + assert astats.copy_assignments == 2 + assert bstats.copy_assignments == 0 + assert astats.move_assignments == 0 + assert bstats.move_assignments == 0 + + +def test_importing(): + from pybind11_tests.modules import OD + from collections import OrderedDict + + assert OD is OrderedDict + assert str(OD([(1, 'a'), (2, 'b')])) == "OrderedDict([(1, 'a'), (2, 'b')])" + + +def test_pydoc(): + """Pydoc needs to be able to provide help() for everything inside a pybind11 module""" + import pybind11_tests + import pydoc + + assert pybind11_tests.__name__ == "pybind11_tests" + assert pybind11_tests.__doc__ == "pybind11 test module" + assert pydoc.text.docmodule(pybind11_tests) + + +def test_duplicate_registration(): + """Registering two things with the same name""" + + assert m.duplicate_registration() == [] diff --git a/pybind11/tests/test_multiple_inheritance.cpp b/pybind11/tests/test_multiple_inheritance.cpp new file mode 100644 index 0000000000000000000000000000000000000000..10376c0d017996a3678b4b8c776f142072ba09c9 --- /dev/null +++ b/pybind11/tests/test_multiple_inheritance.cpp @@ -0,0 +1,334 @@ +/* + tests/test_multiple_inheritance.cpp -- multiple inheritance, + implicit MI casts + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" + +// Many bases for testing that multiple inheritance from many classes (i.e. requiring extra +// space for holder constructed flags) works. +template <int N> +struct BaseN +{ + BaseN(int i) + : i(i) + {} + int i; +}; + +// test_mi_static_properties +struct Vanilla +{ + std::string vanilla() + { + return "Vanilla"; + }; +}; +struct WithStatic1 +{ + static std::string static_func1() + { + return "WithStatic1"; + }; + static int static_value1; +}; +struct WithStatic2 +{ + static std::string static_func2() + { + return "WithStatic2"; + }; + static int static_value2; +}; +struct VanillaStaticMix1 + : Vanilla + , WithStatic1 + , WithStatic2 +{ + static std::string static_func() + { + return "VanillaStaticMix1"; + } + static int static_value; +}; +struct VanillaStaticMix2 + : WithStatic1 + , Vanilla + , WithStatic2 +{ + static std::string static_func() + { + return "VanillaStaticMix2"; + } + static int static_value; +}; +int WithStatic1::static_value1 = 1; +int WithStatic2::static_value2 = 2; +int VanillaStaticMix1::static_value = 12; +int VanillaStaticMix2::static_value = 12; + +TEST_SUBMODULE(multiple_inheritance, m) +{ + + // test_multiple_inheritance_mix1 + // test_multiple_inheritance_mix2 + struct Base1 + { + Base1(int i) + : i(i) + {} + int foo() + { + return i; + } + int i; + }; + py::class_<Base1> b1(m, "Base1"); + b1.def(py::init<int>()).def("foo", &Base1::foo); + + struct Base2 + { + Base2(int i) + : i(i) + {} + int bar() + { + return i; + } + int i; + }; + py::class_<Base2> b2(m, "Base2"); + b2.def(py::init<int>()).def("bar", &Base2::bar); + + + // test_multiple_inheritance_cpp + struct Base12 + : Base1 + , Base2 + { + Base12(int i, int j) + : Base1(i) + , Base2(j) + {} + }; + struct MIType : Base12 + { + MIType(int i, int j) + : Base12(i, j) + {} + }; + py::class_<Base12, Base1, Base2>(m, "Base12"); + py::class_<MIType, Base12>(m, "MIType").def(py::init<int, int>()); + + +// test_multiple_inheritance_python_many_bases +#define PYBIND11_BASEN(N) \ + py::class_<BaseN<N>>(m, "BaseN" #N).def(py::init<int>()).def("f" #N, [](BaseN<N>& b) { return b.i + N; }) + PYBIND11_BASEN(1); + PYBIND11_BASEN(2); + PYBIND11_BASEN(3); + PYBIND11_BASEN(4); + PYBIND11_BASEN(5); + PYBIND11_BASEN(6); + PYBIND11_BASEN(7); + PYBIND11_BASEN(8); + PYBIND11_BASEN(9); + PYBIND11_BASEN(10); + PYBIND11_BASEN(11); + PYBIND11_BASEN(12); + PYBIND11_BASEN(13); + PYBIND11_BASEN(14); + PYBIND11_BASEN(15); + PYBIND11_BASEN(16); + PYBIND11_BASEN(17); + + // Uncommenting this should result in a compile time failure (MI can only be specified via + // template parameters because pybind has to know the types involved; see discussion in #742 for + // details). + // struct Base12v2 : Base1, Base2 { + // Base12v2(int i, int j) : Base1(i), Base2(j) { } + // }; + // py::class_<Base12v2>(m, "Base12v2", b1, b2) + // .def(py::init<int, int>()); + + + // test_multiple_inheritance_virtbase + // Test the case where not all base classes are specified, and where pybind11 requires the + // py::multiple_inheritance flag to perform proper casting between types. + struct Base1a + { + Base1a(int i) + : i(i) + {} + int foo() + { + return i; + } + int i; + }; + py::class_<Base1a, std::shared_ptr<Base1a>>(m, "Base1a").def(py::init<int>()).def("foo", &Base1a::foo); + + struct Base2a + { + Base2a(int i) + : i(i) + {} + int bar() + { + return i; + } + int i; + }; + py::class_<Base2a, std::shared_ptr<Base2a>>(m, "Base2a").def(py::init<int>()).def("bar", &Base2a::bar); + + struct Base12a + : Base1a + , Base2a + { + Base12a(int i, int j) + : Base1a(i) + , Base2a(j) + {} + }; + py::class_<Base12a, /* Base1 missing */ Base2a, std::shared_ptr<Base12a>>(m, "Base12a", py::multiple_inheritance()) + .def(py::init<int, int>()); + + m.def("bar_base2a", [](Base2a* b) { return b->bar(); }); + m.def("bar_base2a_sharedptr", [](std::shared_ptr<Base2a> b) { return b->bar(); }); + + // test_mi_unaligned_base + // test_mi_base_return + // Issue #801: invalid casting to derived type with MI bases + struct I801B1 + { + int a = 1; + I801B1() = default; + I801B1(const I801B1&) = default; + virtual ~I801B1() = default; + }; + struct I801B2 + { + int b = 2; + I801B2() = default; + I801B2(const I801B2&) = default; + virtual ~I801B2() = default; + }; + struct I801C + : I801B1 + , I801B2 + {}; + struct I801D : I801C + {}; // Indirect MI + // Unregistered classes: + struct I801B3 + { + int c = 3; + virtual ~I801B3() = default; + }; + struct I801E + : I801B3 + , I801D + {}; + + py::class_<I801B1, std::shared_ptr<I801B1>>(m, "I801B1").def(py::init<>()).def_readonly("a", &I801B1::a); + py::class_<I801B2, std::shared_ptr<I801B2>>(m, "I801B2").def(py::init<>()).def_readonly("b", &I801B2::b); + py::class_<I801C, I801B1, I801B2, std::shared_ptr<I801C>>(m, "I801C").def(py::init<>()); + py::class_<I801D, I801C, std::shared_ptr<I801D>>(m, "I801D").def(py::init<>()); + + // Two separate issues here: first, we want to recognize a pointer to a base type as being a + // known instance even when the pointer value is unequal (i.e. due to a non-first + // multiple-inheritance base class): + m.def("i801b1_c", [](I801C* c) { return static_cast<I801B1*>(c); }); + m.def("i801b2_c", [](I801C* c) { return static_cast<I801B2*>(c); }); + m.def("i801b1_d", [](I801D* d) { return static_cast<I801B1*>(d); }); + m.def("i801b2_d", [](I801D* d) { return static_cast<I801B2*>(d); }); + + // Second, when returned a base class pointer to a derived instance, we cannot assume that the + // pointer is `reinterpret_cast`able to the derived pointer because, like above, the base class + // pointer could be offset. + m.def("i801c_b1", []() -> I801B1* { return new I801C(); }); + m.def("i801c_b2", []() -> I801B2* { return new I801C(); }); + m.def("i801d_b1", []() -> I801B1* { return new I801D(); }); + m.def("i801d_b2", []() -> I801B2* { return new I801D(); }); + + // Return a base class pointer to a pybind-registered type when the actual derived type + // isn't pybind-registered (and uses multiple-inheritance to offset the pybind base) + m.def("i801e_c", []() -> I801C* { return new I801E(); }); + m.def("i801e_b2", []() -> I801B2* { return new I801E(); }); + + + // test_mi_static_properties + py::class_<Vanilla>(m, "Vanilla").def(py::init<>()).def("vanilla", &Vanilla::vanilla); + + py::class_<WithStatic1>(m, "WithStatic1") + .def(py::init<>()) + .def_static("static_func1", &WithStatic1::static_func1) + .def_readwrite_static("static_value1", &WithStatic1::static_value1); + + py::class_<WithStatic2>(m, "WithStatic2") + .def(py::init<>()) + .def_static("static_func2", &WithStatic2::static_func2) + .def_readwrite_static("static_value2", &WithStatic2::static_value2); + + py::class_<VanillaStaticMix1, Vanilla, WithStatic1, WithStatic2>(m, "VanillaStaticMix1") + .def(py::init<>()) + .def_static("static_func", &VanillaStaticMix1::static_func) + .def_readwrite_static("static_value", &VanillaStaticMix1::static_value); + + py::class_<VanillaStaticMix2, WithStatic1, Vanilla, WithStatic2>(m, "VanillaStaticMix2") + .def(py::init<>()) + .def_static("static_func", &VanillaStaticMix2::static_func) + .def_readwrite_static("static_value", &VanillaStaticMix2::static_value); + + +#if !defined(PYPY_VERSION) + struct WithDict + {}; + struct VanillaDictMix1 + : Vanilla + , WithDict + {}; + struct VanillaDictMix2 + : WithDict + , Vanilla + {}; + py::class_<WithDict>(m, "WithDict", py::dynamic_attr()).def(py::init<>()); + py::class_<VanillaDictMix1, Vanilla, WithDict>(m, "VanillaDictMix1").def(py::init<>()); + py::class_<VanillaDictMix2, WithDict, Vanilla>(m, "VanillaDictMix2").def(py::init<>()); +#endif + + // test_diamond_inheritance + // Issue #959: segfault when constructing diamond inheritance instance + // All of these have int members so that there will be various unequal pointers involved. + struct B + { + int b; + B() = default; + B(const B&) = default; + virtual ~B() = default; + }; + struct C0 : public virtual B + { + int c0; + }; + struct C1 : public virtual B + { + int c1; + }; + struct D + : public C0 + , public C1 + { + int d; + }; + py::class_<B>(m, "B").def("b", [](B* self) { return self; }); + py::class_<C0, B>(m, "C0").def("c0", [](C0* self) { return self; }); + py::class_<C1, B>(m, "C1").def("c1", [](C1* self) { return self; }); + py::class_<D, C0, C1>(m, "D").def(py::init<>()); +} diff --git a/pybind11/tests/test_multiple_inheritance.py b/pybind11/tests/test_multiple_inheritance.py new file mode 100644 index 0000000000000000000000000000000000000000..a7f1bf9c5cd9babf9a47554bf58cb1bba43bfe13 --- /dev/null +++ b/pybind11/tests/test_multiple_inheritance.py @@ -0,0 +1,372 @@ +import pytest +from pybind11_tests import ConstructorStats +from pybind11_tests import multiple_inheritance as m + + +def test_multiple_inheritance_cpp(): + mt = m.MIType(3, 4) + + assert mt.foo() == 3 + assert mt.bar() == 4 + + +def test_multiple_inheritance_mix1(): + + class Base1: + + def __init__(self, i): + self.i = i + + def foo(self): + return self.i + + class MITypePy(Base1, m.Base2): + + def __init__(self, i, j): + Base1.__init__(self, i) + m.Base2.__init__(self, j) + + mt = MITypePy(3, 4) + + assert mt.foo() == 3 + assert mt.bar() == 4 + + +def test_multiple_inheritance_mix2(): + + class Base2: + + def __init__(self, i): + self.i = i + + def bar(self): + return self.i + + class MITypePy(m.Base1, Base2): + + def __init__(self, i, j): + m.Base1.__init__(self, i) + Base2.__init__(self, j) + + mt = MITypePy(3, 4) + + assert mt.foo() == 3 + assert mt.bar() == 4 + + +def test_multiple_inheritance_python(): + + class MI1(m.Base1, m.Base2): + + def __init__(self, i, j): + m.Base1.__init__(self, i) + m.Base2.__init__(self, j) + + class B1(object): + + def v(self): + return 1 + + class MI2(B1, m.Base1, m.Base2): + + def __init__(self, i, j): + B1.__init__(self) + m.Base1.__init__(self, i) + m.Base2.__init__(self, j) + + class MI3(MI2): + + def __init__(self, i, j): + MI2.__init__(self, i, j) + + class MI4(MI3, m.Base2): + + def __init__(self, i, j): + MI3.__init__(self, i, j) + # This should be ignored (Base2 is already initialized via MI2): + m.Base2.__init__(self, i + 100) + + class MI5(m.Base2, B1, m.Base1): + + def __init__(self, i, j): + B1.__init__(self) + m.Base1.__init__(self, i) + m.Base2.__init__(self, j) + + class MI6(m.Base2, B1): + + def __init__(self, i): + m.Base2.__init__(self, i) + B1.__init__(self) + + class B2(B1): + + def v(self): + return 2 + + class B3(object): + + def v(self): + return 3 + + class B4(B3, B2): + + def v(self): + return 4 + + class MI7(B4, MI6): + + def __init__(self, i): + B4.__init__(self) + MI6.__init__(self, i) + + class MI8(MI6, B3): + + def __init__(self, i): + MI6.__init__(self, i) + B3.__init__(self) + + class MI8b(B3, MI6): + + def __init__(self, i): + B3.__init__(self) + MI6.__init__(self, i) + + mi1 = MI1(1, 2) + assert mi1.foo() == 1 + assert mi1.bar() == 2 + + mi2 = MI2(3, 4) + assert mi2.v() == 1 + assert mi2.foo() == 3 + assert mi2.bar() == 4 + + mi3 = MI3(5, 6) + assert mi3.v() == 1 + assert mi3.foo() == 5 + assert mi3.bar() == 6 + + mi4 = MI4(7, 8) + assert mi4.v() == 1 + assert mi4.foo() == 7 + assert mi4.bar() == 8 + + mi5 = MI5(10, 11) + assert mi5.v() == 1 + assert mi5.foo() == 10 + assert mi5.bar() == 11 + + mi6 = MI6(12) + assert mi6.v() == 1 + assert mi6.bar() == 12 + + mi7 = MI7(13) + assert mi7.v() == 4 + assert mi7.bar() == 13 + + mi8 = MI8(14) + assert mi8.v() == 1 + assert mi8.bar() == 14 + + mi8b = MI8b(15) + assert mi8b.v() == 3 + assert mi8b.bar() == 15 + + +def test_multiple_inheritance_python_many_bases(): + + class MIMany14(m.BaseN1, m.BaseN2, m.BaseN3, m.BaseN4): + + def __init__(self): + m.BaseN1.__init__(self, 1) + m.BaseN2.__init__(self, 2) + m.BaseN3.__init__(self, 3) + m.BaseN4.__init__(self, 4) + + class MIMany58(m.BaseN5, m.BaseN6, m.BaseN7, m.BaseN8): + + def __init__(self): + m.BaseN5.__init__(self, 5) + m.BaseN6.__init__(self, 6) + m.BaseN7.__init__(self, 7) + m.BaseN8.__init__(self, 8) + + class MIMany916(m.BaseN9, m.BaseN10, m.BaseN11, m.BaseN12, m.BaseN13, m.BaseN14, m.BaseN15, m.BaseN16): + + def __init__(self): + m.BaseN9.__init__(self, 9) + m.BaseN10.__init__(self, 10) + m.BaseN11.__init__(self, 11) + m.BaseN12.__init__(self, 12) + m.BaseN13.__init__(self, 13) + m.BaseN14.__init__(self, 14) + m.BaseN15.__init__(self, 15) + m.BaseN16.__init__(self, 16) + + class MIMany19(MIMany14, MIMany58, m.BaseN9): + + def __init__(self): + MIMany14.__init__(self) + MIMany58.__init__(self) + m.BaseN9.__init__(self, 9) + + class MIMany117(MIMany14, MIMany58, MIMany916, m.BaseN17): + + def __init__(self): + MIMany14.__init__(self) + MIMany58.__init__(self) + MIMany916.__init__(self) + m.BaseN17.__init__(self, 17) + + # Inherits from 4 registered C++ classes: can fit in one pointer on any modern arch: + a = MIMany14() + for i in range(1, 4): + assert getattr(a, "f" + str(i))() == 2 * i + + # Inherits from 8: requires 1/2 pointers worth of holder flags on 32/64-bit arch: + b = MIMany916() + for i in range(9, 16): + assert getattr(b, "f" + str(i))() == 2 * i + + # Inherits from 9: requires >= 2 pointers worth of holder flags + c = MIMany19() + for i in range(1, 9): + assert getattr(c, "f" + str(i))() == 2 * i + + # Inherits from 17: requires >= 3 pointers worth of holder flags + d = MIMany117() + for i in range(1, 17): + assert getattr(d, "f" + str(i))() == 2 * i + + +def test_multiple_inheritance_virtbase(): + + class MITypePy(m.Base12a): + + def __init__(self, i, j): + m.Base12a.__init__(self, i, j) + + mt = MITypePy(3, 4) + assert mt.bar() == 4 + assert m.bar_base2a(mt) == 4 + assert m.bar_base2a_sharedptr(mt) == 4 + + +def test_mi_static_properties(): + """Mixing bases with and without static properties should be possible + and the result should be independent of base definition order""" + + for d in (m.VanillaStaticMix1(), m.VanillaStaticMix2()): + assert d.vanilla() == "Vanilla" + assert d.static_func1() == "WithStatic1" + assert d.static_func2() == "WithStatic2" + assert d.static_func() == d.__class__.__name__ + + m.WithStatic1.static_value1 = 1 + m.WithStatic2.static_value2 = 2 + assert d.static_value1 == 1 + assert d.static_value2 == 2 + assert d.static_value == 12 + + d.static_value1 = 0 + assert d.static_value1 == 0 + d.static_value2 = 0 + assert d.static_value2 == 0 + d.static_value = 0 + assert d.static_value == 0 + + +@pytest.unsupported_on_pypy +def test_mi_dynamic_attributes(): + """Mixing bases with and without dynamic attribute support""" + + for d in (m.VanillaDictMix1(), m.VanillaDictMix2()): + d.dynamic = 1 + assert d.dynamic == 1 + + +def test_mi_unaligned_base(): + """Returning an offset (non-first MI) base class pointer should recognize the instance""" + + n_inst = ConstructorStats.detail_reg_inst() + + c = m.I801C() + d = m.I801D() + # + 4 below because we have the two instances, and each instance has offset base I801B2 + assert ConstructorStats.detail_reg_inst() == n_inst + 4 + b1c = m.i801b1_c(c) + assert b1c is c + b2c = m.i801b2_c(c) + assert b2c is c + b1d = m.i801b1_d(d) + assert b1d is d + b2d = m.i801b2_d(d) + assert b2d is d + + assert ConstructorStats.detail_reg_inst() == n_inst + 4 # no extra instances + del c, b1c, b2c + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + del d, b1d, b2d + assert ConstructorStats.detail_reg_inst() == n_inst + + +def test_mi_base_return(): + """Tests returning an offset (non-first MI) base class pointer to a derived instance""" + + n_inst = ConstructorStats.detail_reg_inst() + + c1 = m.i801c_b1() + assert type(c1) is m.I801C + assert c1.a == 1 + assert c1.b == 2 + + d1 = m.i801d_b1() + assert type(d1) is m.I801D + assert d1.a == 1 + assert d1.b == 2 + + assert ConstructorStats.detail_reg_inst() == n_inst + 4 + + c2 = m.i801c_b2() + assert type(c2) is m.I801C + assert c2.a == 1 + assert c2.b == 2 + + d2 = m.i801d_b2() + assert type(d2) is m.I801D + assert d2.a == 1 + assert d2.b == 2 + + assert ConstructorStats.detail_reg_inst() == n_inst + 8 + + del c2 + assert ConstructorStats.detail_reg_inst() == n_inst + 6 + del c1, d1, d2 + assert ConstructorStats.detail_reg_inst() == n_inst + + # Returning an unregistered derived type with a registered base; we won't + # pick up the derived type, obviously, but should still work (as an object + # of whatever type was returned). + e1 = m.i801e_c() + assert type(e1) is m.I801C + assert e1.a == 1 + assert e1.b == 2 + + e2 = m.i801e_b2() + assert type(e2) is m.I801B2 + assert e2.b == 2 + + +def test_diamond_inheritance(): + """Tests that diamond inheritance works as expected (issue #959)""" + + # Issue #959: this shouldn't segfault: + d = m.D() + + # Make sure all the various distinct pointers are all recognized as registered instances: + assert d is d.c0() + assert d is d.c1() + assert d is d.b() + assert d is d.c0().b() + assert d is d.c1().b() + assert d is d.c0().c1().b().c0().b() diff --git a/pybind11/tests/test_numpy_array.cpp b/pybind11/tests/test_numpy_array.cpp new file mode 100644 index 0000000000000000000000000000000000000000..1e8c741aa276a0c68e359568c262ed6569dbdf72 --- /dev/null +++ b/pybind11/tests/test_numpy_array.cpp @@ -0,0 +1,347 @@ +/* + tests/test_numpy_array.cpp -- test core array functionality + + Copyright (c) 2016 Ivan Smirnov <i.s.smirnov@gmail.com> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +#include <pybind11/numpy.h> +#include <pybind11/stl.h> + +#include <cstdint> + +using arr = py::array; +using arr_t = py::array_t<uint16_t, 0>; +static_assert(std::is_same<arr_t::value_type, uint16_t>::value, ""); + +template <typename... Ix> +arr data(const arr& a, Ix... index) +{ + return arr(a.nbytes() - a.offset_at(index...), (const uint8_t*)a.data(index...)); +} + +template <typename... Ix> +arr data_t(const arr_t& a, Ix... index) +{ + return arr(a.size() - a.index_at(index...), a.data(index...)); +} + +template <typename... Ix> +arr& mutate_data(arr& a, Ix... index) +{ + auto ptr = (uint8_t*)a.mutable_data(index...); + for (ssize_t i = 0; i < a.nbytes() - a.offset_at(index...); i++) + ptr[i] = (uint8_t)(ptr[i] * 2); + return a; +} + +template <typename... Ix> +arr_t& mutate_data_t(arr_t& a, Ix... index) +{ + auto ptr = a.mutable_data(index...); + for (ssize_t i = 0; i < a.size() - a.index_at(index...); i++) + ptr[i]++; + return a; +} + +template <typename... Ix> +ssize_t index_at(const arr& a, Ix... idx) +{ + return a.index_at(idx...); +} +template <typename... Ix> +ssize_t index_at_t(const arr_t& a, Ix... idx) +{ + return a.index_at(idx...); +} +template <typename... Ix> +ssize_t offset_at(const arr& a, Ix... idx) +{ + return a.offset_at(idx...); +} +template <typename... Ix> +ssize_t offset_at_t(const arr_t& a, Ix... idx) +{ + return a.offset_at(idx...); +} +template <typename... Ix> +ssize_t at_t(const arr_t& a, Ix... idx) +{ + return a.at(idx...); +} +template <typename... Ix> +arr_t& mutate_at_t(arr_t& a, Ix... idx) +{ + a.mutable_at(idx...)++; + return a; +} + +#define def_index_fn(name, type) \ + sm.def(#name, [](type a) { return name(a); }); \ + sm.def(#name, [](type a, int i) { return name(a, i); }); \ + sm.def(#name, [](type a, int i, int j) { return name(a, i, j); }); \ + sm.def(#name, [](type a, int i, int j, int k) { return name(a, i, j, k); }); + +template <typename T, typename T2> +py::handle auxiliaries(T&& r, T2&& r2) +{ + if (r.ndim() != 2) + throw std::domain_error("error: ndim != 2"); + py::list l; + l.append(*r.data(0, 0)); + l.append(*r2.mutable_data(0, 0)); + l.append(r.data(0, 1) == r2.mutable_data(0, 1)); + l.append(r.ndim()); + l.append(r.itemsize()); + l.append(r.shape(0)); + l.append(r.shape(1)); + l.append(r.size()); + l.append(r.nbytes()); + return l.release(); +} + +// note: declaration at local scope would create a dangling reference! +static int data_i = 42; + +TEST_SUBMODULE(numpy_array, sm) +{ + try { + py::module::import("numpy"); + } catch (...) { + return; + } + + // test_array_attributes + sm.def("ndim", [](const arr& a) { return a.ndim(); }); + sm.def("shape", [](const arr& a) { return arr(a.ndim(), a.shape()); }); + sm.def("shape", [](const arr& a, ssize_t dim) { return a.shape(dim); }); + sm.def("strides", [](const arr& a) { return arr(a.ndim(), a.strides()); }); + sm.def("strides", [](const arr& a, ssize_t dim) { return a.strides(dim); }); + sm.def("writeable", [](const arr& a) { return a.writeable(); }); + sm.def("size", [](const arr& a) { return a.size(); }); + sm.def("itemsize", [](const arr& a) { return a.itemsize(); }); + sm.def("nbytes", [](const arr& a) { return a.nbytes(); }); + sm.def("owndata", [](const arr& a) { return a.owndata(); }); + + // test_index_offset + def_index_fn(index_at, const arr&); + def_index_fn(index_at_t, const arr_t&); + def_index_fn(offset_at, const arr&); + def_index_fn(offset_at_t, const arr_t&); + // test_data + def_index_fn(data, const arr&); + def_index_fn(data_t, const arr_t&); + // test_mutate_data, test_mutate_readonly + def_index_fn(mutate_data, arr&); + def_index_fn(mutate_data_t, arr_t&); + def_index_fn(at_t, const arr_t&); + def_index_fn(mutate_at_t, arr_t&); + + // test_make_c_f_array + sm.def("make_f_array", [] { return py::array_t<float>({2, 2}, {4, 8}); }); + sm.def("make_c_array", [] { return py::array_t<float>({2, 2}, {8, 4}); }); + + // test_empty_shaped_array + sm.def("make_empty_shaped_array", [] { return py::array(py::dtype("f"), {}, {}); }); + // test numpy scalars (empty shape, ndim==0) + sm.def("scalar_int", []() { return py::array(py::dtype("i"), {}, {}, &data_i); }); + + // test_wrap + sm.def("wrap", [](py::array a) { + return py::array(a.dtype(), {a.shape(), a.shape() + a.ndim()}, {a.strides(), a.strides() + a.ndim()}, a.data(), a); + }); + + // test_numpy_view + struct ArrayClass + { + int data[2] = {1, 2}; + ArrayClass() + { + py::print("ArrayClass()"); + } + ~ArrayClass() + { + py::print("~ArrayClass()"); + } + }; + py::class_<ArrayClass>(sm, "ArrayClass").def(py::init<>()).def("numpy_view", [](py::object& obj) { + py::print("ArrayClass::numpy_view()"); + ArrayClass& a = obj.cast<ArrayClass&>(); + return py::array_t<int>({2}, {4}, a.data, obj); + }); + + // test_cast_numpy_int64_to_uint64 + sm.def("function_taking_uint64", [](uint64_t) {}); + + // test_isinstance + sm.def("isinstance_untyped", [](py::object yes, py::object no) { + return py::isinstance<py::array>(yes) && !py::isinstance<py::array>(no); + }); + sm.def("isinstance_typed", + [](py::object o) { return py::isinstance<py::array_t<double>>(o) && !py::isinstance<py::array_t<int>>(o); }); + + // test_constructors + sm.def("default_constructors", []() { + return py::dict("array"_a = py::array(), + "array_t<int32>"_a = py::array_t<std::int32_t>(), + "array_t<double>"_a = py::array_t<double>()); + }); + sm.def("converting_constructors", [](py::object o) { + return py::dict("array"_a = py::array(o), + "array_t<int32>"_a = py::array_t<std::int32_t>(o), + "array_t<double>"_a = py::array_t<double>(o)); + }); + + // test_overload_resolution + sm.def("overloaded", [](py::array_t<double>) { return "double"; }); + sm.def("overloaded", [](py::array_t<float>) { return "float"; }); + sm.def("overloaded", [](py::array_t<int>) { return "int"; }); + sm.def("overloaded", [](py::array_t<unsigned short>) { return "unsigned short"; }); + sm.def("overloaded", [](py::array_t<long long>) { return "long long"; }); + sm.def("overloaded", [](py::array_t<std::complex<double>>) { return "double complex"; }); + sm.def("overloaded", [](py::array_t<std::complex<float>>) { return "float complex"; }); + + sm.def("overloaded2", [](py::array_t<std::complex<double>>) { return "double complex"; }); + sm.def("overloaded2", [](py::array_t<double>) { return "double"; }); + sm.def("overloaded2", [](py::array_t<std::complex<float>>) { return "float complex"; }); + sm.def("overloaded2", [](py::array_t<float>) { return "float"; }); + + // Only accept the exact types: + sm.def("overloaded3", [](py::array_t<int>) { return "int"; }, py::arg().noconvert()); + sm.def("overloaded3", [](py::array_t<double>) { return "double"; }, py::arg().noconvert()); + + // Make sure we don't do unsafe coercion (e.g. float to int) when not using forcecast, but + // rather that float gets converted via the safe (conversion to double) overload: + sm.def("overloaded4", [](py::array_t<long long, 0>) { return "long long"; }); + sm.def("overloaded4", [](py::array_t<double, 0>) { return "double"; }); + + // But we do allow conversion to int if forcecast is enabled (but only if no overload matches + // without conversion) + sm.def("overloaded5", [](py::array_t<unsigned int>) { return "unsigned int"; }); + sm.def("overloaded5", [](py::array_t<double>) { return "double"; }); + + // test_greedy_string_overload + // Issue 685: ndarray shouldn't go to std::string overload + sm.def("issue685", [](std::string) { return "string"; }); + sm.def("issue685", [](py::array) { return "array"; }); + sm.def("issue685", [](py::object) { return "other"; }); + + // test_array_unchecked_fixed_dims + sm.def("proxy_add2", + [](py::array_t<double> a, double v) { + auto r = a.mutable_unchecked<2>(); + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + r(i, j) += v; + }, + py::arg().noconvert(), + py::arg()); + + sm.def("proxy_init3", [](double start) { + py::array_t<double, py::array::c_style> a({3, 3, 3}); + auto r = a.mutable_unchecked<3>(); + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + for (ssize_t k = 0; k < r.shape(2); k++) + r(i, j, k) = start++; + return a; + }); + sm.def("proxy_init3F", [](double start) { + py::array_t<double, py::array::f_style> a({3, 3, 3}); + auto r = a.mutable_unchecked<3>(); + for (ssize_t k = 0; k < r.shape(2); k++) + for (ssize_t j = 0; j < r.shape(1); j++) + for (ssize_t i = 0; i < r.shape(0); i++) + r(i, j, k) = start++; + return a; + }); + sm.def("proxy_squared_L2_norm", [](py::array_t<double> a) { + auto r = a.unchecked<1>(); + double sumsq = 0; + for (ssize_t i = 0; i < r.shape(0); i++) + sumsq += r[i] * r(i); // Either notation works for a 1D array + return sumsq; + }); + + sm.def("proxy_auxiliaries2", [](py::array_t<double> a) { + auto r = a.unchecked<2>(); + auto r2 = a.mutable_unchecked<2>(); + return auxiliaries(r, r2); + }); + + // test_array_unchecked_dyn_dims + // Same as the above, but without a compile-time dimensions specification: + sm.def("proxy_add2_dyn", + [](py::array_t<double> a, double v) { + auto r = a.mutable_unchecked(); + if (r.ndim() != 2) + throw std::domain_error("error: ndim != 2"); + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + r(i, j) += v; + }, + py::arg().noconvert(), + py::arg()); + sm.def("proxy_init3_dyn", [](double start) { + py::array_t<double, py::array::c_style> a({3, 3, 3}); + auto r = a.mutable_unchecked(); + if (r.ndim() != 3) + throw std::domain_error("error: ndim != 3"); + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + for (ssize_t k = 0; k < r.shape(2); k++) + r(i, j, k) = start++; + return a; + }); + sm.def("proxy_auxiliaries2_dyn", + [](py::array_t<double> a) { return auxiliaries(a.unchecked(), a.mutable_unchecked()); }); + + sm.def("array_auxiliaries2", [](py::array_t<double> a) { return auxiliaries(a, a); }); + + // test_array_failures + // Issue #785: Uninformative "Unknown internal error" exception when constructing array from empty object: + sm.def("array_fail_test", []() { return py::array(py::object()); }); + sm.def("array_t_fail_test", []() { return py::array_t<double>(py::object()); }); + // Make sure the error from numpy is being passed through: + sm.def("array_fail_test_negative_size", []() { + int c = 0; + return py::array(-1, &c); + }); + + // test_initializer_list + // Issue (unnumbered; reported in #788): regression: initializer lists can be ambiguous + sm.def("array_initializer_list1", + []() { return py::array_t<float>(1); }); // { 1 } also works, but clang warns about it + sm.def("array_initializer_list2", []() { return py::array_t<float>({1, 2}); }); + sm.def("array_initializer_list3", []() { return py::array_t<float>({1, 2, 3}); }); + sm.def("array_initializer_list4", []() { return py::array_t<float>({1, 2, 3, 4}); }); + + // test_array_resize + // reshape array to 2D without changing size + sm.def("array_reshape2", [](py::array_t<double> a) { + const ssize_t dim_sz = (ssize_t)std::sqrt(a.size()); + if (dim_sz * dim_sz != a.size()) + throw std::domain_error("array_reshape2: input array total size is not a squared integer"); + a.resize({dim_sz, dim_sz}); + }); + + // resize to 3D array with each dimension = N + sm.def("array_resize3", [](py::array_t<double> a, size_t N, bool refcheck) { a.resize({N, N, N}, refcheck); }); + + // test_array_create_and_resize + // return 2D array with Nrows = Ncols = N + sm.def("create_and_resize", [](size_t N) { + py::array_t<double> a; + a.resize({N, N}); + std::fill(a.mutable_data(), a.mutable_data() + a.size(), 42.); + return a; + }); + +#if PY_MAJOR_VERSION >= 3 + sm.def("index_using_ellipsis", [](py::array a) { return a[py::make_tuple(0, py::ellipsis(), 0)]; }); +#endif +} diff --git a/pybind11/tests/test_numpy_array.py b/pybind11/tests/test_numpy_array.py new file mode 100644 index 0000000000000000000000000000000000000000..544ede2f1b619bbcb76e13d9e2d46655214ccf52 --- /dev/null +++ b/pybind11/tests/test_numpy_array.py @@ -0,0 +1,418 @@ +import pytest +from pybind11_tests import numpy_array as m + +pytestmark = pytest.requires_numpy + +with pytest.suppress(ImportError): + import numpy as np + + +@pytest.fixture(scope='function') +def arr(): + return np.array([[1, 2, 3], [4, 5, 6]], '=u2') + + +def test_array_attributes(): + a = np.array(0, 'f8') + assert m.ndim(a) == 0 + assert all(m.shape(a) == []) + assert all(m.strides(a) == []) + with pytest.raises(IndexError) as excinfo: + m.shape(a, 0) + assert str(excinfo.value) == 'invalid axis: 0 (ndim = 0)' + with pytest.raises(IndexError) as excinfo: + m.strides(a, 0) + assert str(excinfo.value) == 'invalid axis: 0 (ndim = 0)' + assert m.writeable(a) + assert m.size(a) == 1 + assert m.itemsize(a) == 8 + assert m.nbytes(a) == 8 + assert m.owndata(a) + + a = np.array([[1, 2, 3], [4, 5, 6]], 'u2').view() + a.flags.writeable = False + assert m.ndim(a) == 2 + assert all(m.shape(a) == [2, 3]) + assert m.shape(a, 0) == 2 + assert m.shape(a, 1) == 3 + assert all(m.strides(a) == [6, 2]) + assert m.strides(a, 0) == 6 + assert m.strides(a, 1) == 2 + with pytest.raises(IndexError) as excinfo: + m.shape(a, 2) + assert str(excinfo.value) == 'invalid axis: 2 (ndim = 2)' + with pytest.raises(IndexError) as excinfo: + m.strides(a, 2) + assert str(excinfo.value) == 'invalid axis: 2 (ndim = 2)' + assert not m.writeable(a) + assert m.size(a) == 6 + assert m.itemsize(a) == 2 + assert m.nbytes(a) == 12 + assert not m.owndata(a) + + +@pytest.mark.parametrize('args, ret', [([], 0), ([0], 0), ([1], 3), ([0, 1], 1), ([1, 2], 5)]) +def test_index_offset(arr, args, ret): + assert m.index_at(arr, *args) == ret + assert m.index_at_t(arr, *args) == ret + assert m.offset_at(arr, *args) == ret * arr.dtype.itemsize + assert m.offset_at_t(arr, *args) == ret * arr.dtype.itemsize + + +def test_dim_check_fail(arr): + for func in (m.index_at, m.index_at_t, m.offset_at, m.offset_at_t, m.data, m.data_t, m.mutate_data, + m.mutate_data_t): + with pytest.raises(IndexError) as excinfo: + func(arr, 1, 2, 3) + assert str(excinfo.value) == 'too many indices for an array: 3 (ndim = 2)' + + +@pytest.mark.parametrize('args, ret', [([], [1, 2, 3, 4, 5, 6]), ([1], [4, 5, 6]), ([0, 1], [2, 3, 4, 5, 6]), + ([1, 2], [6])]) +def test_data(arr, args, ret): + from sys import byteorder + assert all(m.data_t(arr, *args) == ret) + assert all(m.data(arr, *args)[(0 if byteorder == 'little' else 1)::2] == ret) + assert all(m.data(arr, *args)[(1 if byteorder == 'little' else 0)::2] == 0) + + +@pytest.mark.parametrize('dim', [0, 1, 3]) +def test_at_fail(arr, dim): + for func in m.at_t, m.mutate_at_t: + with pytest.raises(IndexError) as excinfo: + func(arr, *([0] * dim)) + assert str(excinfo.value) == 'index dimension mismatch: {} (ndim = 2)'.format(dim) + + +def test_at(arr): + assert m.at_t(arr, 0, 2) == 3 + assert m.at_t(arr, 1, 0) == 4 + + assert all(m.mutate_at_t(arr, 0, 2).ravel() == [1, 2, 4, 4, 5, 6]) + assert all(m.mutate_at_t(arr, 1, 0).ravel() == [1, 2, 4, 5, 5, 6]) + + +def test_mutate_readonly(arr): + arr.flags.writeable = False + for func, args in (m.mutate_data, ()), (m.mutate_data_t, ()), (m.mutate_at_t, (0, 0)): + with pytest.raises(ValueError) as excinfo: + func(arr, *args) + assert str(excinfo.value) == 'array is not writeable' + + +def test_mutate_data(arr): + assert all(m.mutate_data(arr).ravel() == [2, 4, 6, 8, 10, 12]) + assert all(m.mutate_data(arr).ravel() == [4, 8, 12, 16, 20, 24]) + assert all(m.mutate_data(arr, 1).ravel() == [4, 8, 12, 32, 40, 48]) + assert all(m.mutate_data(arr, 0, 1).ravel() == [4, 16, 24, 64, 80, 96]) + assert all(m.mutate_data(arr, 1, 2).ravel() == [4, 16, 24, 64, 80, 192]) + + assert all(m.mutate_data_t(arr).ravel() == [5, 17, 25, 65, 81, 193]) + assert all(m.mutate_data_t(arr).ravel() == [6, 18, 26, 66, 82, 194]) + assert all(m.mutate_data_t(arr, 1).ravel() == [6, 18, 26, 67, 83, 195]) + assert all(m.mutate_data_t(arr, 0, 1).ravel() == [6, 19, 27, 68, 84, 196]) + assert all(m.mutate_data_t(arr, 1, 2).ravel() == [6, 19, 27, 68, 84, 197]) + + +def test_bounds_check(arr): + for func in (m.index_at, m.index_at_t, m.data, m.data_t, m.mutate_data, m.mutate_data_t, m.at_t, m.mutate_at_t): + with pytest.raises(IndexError) as excinfo: + func(arr, 2, 0) + assert str(excinfo.value) == 'index 2 is out of bounds for axis 0 with size 2' + with pytest.raises(IndexError) as excinfo: + func(arr, 0, 4) + assert str(excinfo.value) == 'index 4 is out of bounds for axis 1 with size 3' + + +def test_make_c_f_array(): + assert m.make_c_array().flags.c_contiguous + assert not m.make_c_array().flags.f_contiguous + assert m.make_f_array().flags.f_contiguous + assert not m.make_f_array().flags.c_contiguous + + +def test_make_empty_shaped_array(): + m.make_empty_shaped_array() + + # empty shape means numpy scalar, PEP 3118 + assert m.scalar_int().ndim == 0 + assert m.scalar_int().shape == () + assert m.scalar_int() == 42 + + +def test_wrap(): + + def assert_references(a, b, base=None): + from distutils.version import LooseVersion + if base is None: + base = a + assert a is not b + assert a.__array_interface__['data'][0] == b.__array_interface__['data'][0] + assert a.shape == b.shape + assert a.strides == b.strides + assert a.flags.c_contiguous == b.flags.c_contiguous + assert a.flags.f_contiguous == b.flags.f_contiguous + assert a.flags.writeable == b.flags.writeable + assert a.flags.aligned == b.flags.aligned + if LooseVersion(np.__version__) >= LooseVersion("1.14.0"): + assert a.flags.writebackifcopy == b.flags.writebackifcopy + else: + assert a.flags.updateifcopy == b.flags.updateifcopy + assert np.all(a == b) + assert not b.flags.owndata + assert b.base is base + if a.flags.writeable and a.ndim == 2: + a[0, 0] = 1234 + assert b[0, 0] == 1234 + + a1 = np.array([1, 2], dtype=np.int16) + assert a1.flags.owndata and a1.base is None + a2 = m.wrap(a1) + assert_references(a1, a2) + + a1 = np.array([[1, 2], [3, 4]], dtype=np.float32, order='F') + assert a1.flags.owndata and a1.base is None + a2 = m.wrap(a1) + assert_references(a1, a2) + + a1 = np.array([[1, 2], [3, 4]], dtype=np.float32, order='C') + a1.flags.writeable = False + a2 = m.wrap(a1) + assert_references(a1, a2) + + a1 = np.random.random((4, 4, 4)) + a2 = m.wrap(a1) + assert_references(a1, a2) + + a1t = a1.transpose() + a2 = m.wrap(a1t) + assert_references(a1t, a2, a1) + + a1d = a1.diagonal() + a2 = m.wrap(a1d) + assert_references(a1d, a2, a1) + + a1m = a1[::-1, ::-1, ::-1] + a2 = m.wrap(a1m) + assert_references(a1m, a2, a1) + + +def test_numpy_view(capture): + with capture: + ac = m.ArrayClass() + ac_view_1 = ac.numpy_view() + ac_view_2 = ac.numpy_view() + assert np.all(ac_view_1 == np.array([1, 2], dtype=np.int32)) + del ac + pytest.gc_collect() + assert capture == """ + ArrayClass() + ArrayClass::numpy_view() + ArrayClass::numpy_view() + """ + ac_view_1[0] = 4 + ac_view_1[1] = 3 + assert ac_view_2[0] == 4 + assert ac_view_2[1] == 3 + with capture: + del ac_view_1 + del ac_view_2 + pytest.gc_collect() + pytest.gc_collect() + assert capture == """ + ~ArrayClass() + """ + + +@pytest.unsupported_on_pypy +def test_cast_numpy_int64_to_uint64(): + m.function_taking_uint64(123) + m.function_taking_uint64(np.uint64(123)) + + +def test_isinstance(): + assert m.isinstance_untyped(np.array([1, 2, 3]), "not an array") + assert m.isinstance_typed(np.array([1.0, 2.0, 3.0])) + + +def test_constructors(): + defaults = m.default_constructors() + for a in defaults.values(): + assert a.size == 0 + assert defaults["array"].dtype == np.array([]).dtype + assert defaults["array_t<int32>"].dtype == np.int32 + assert defaults["array_t<double>"].dtype == np.float64 + + results = m.converting_constructors([1, 2, 3]) + for a in results.values(): + np.testing.assert_array_equal(a, [1, 2, 3]) + assert results["array"].dtype == np.int_ + assert results["array_t<int32>"].dtype == np.int32 + assert results["array_t<double>"].dtype == np.float64 + + +def test_overload_resolution(msg): + # Exact overload matches: + assert m.overloaded(np.array([1], dtype='float64')) == 'double' + assert m.overloaded(np.array([1], dtype='float32')) == 'float' + assert m.overloaded(np.array([1], dtype='ushort')) == 'unsigned short' + assert m.overloaded(np.array([1], dtype='intc')) == 'int' + assert m.overloaded(np.array([1], dtype='longlong')) == 'long long' + assert m.overloaded(np.array([1], dtype='complex')) == 'double complex' + assert m.overloaded(np.array([1], dtype='csingle')) == 'float complex' + + # No exact match, should call first convertible version: + assert m.overloaded(np.array([1], dtype='uint8')) == 'double' + + with pytest.raises(TypeError) as excinfo: + m.overloaded("not an array") + assert msg(excinfo.value) == """ + overloaded(): incompatible function arguments. The following argument types are supported: + 1. (arg0: numpy.ndarray[float64]) -> str + 2. (arg0: numpy.ndarray[float32]) -> str + 3. (arg0: numpy.ndarray[int32]) -> str + 4. (arg0: numpy.ndarray[uint16]) -> str + 5. (arg0: numpy.ndarray[int64]) -> str + 6. (arg0: numpy.ndarray[complex128]) -> str + 7. (arg0: numpy.ndarray[complex64]) -> str + + Invoked with: 'not an array' + """ + + assert m.overloaded2(np.array([1], dtype='float64')) == 'double' + assert m.overloaded2(np.array([1], dtype='float32')) == 'float' + assert m.overloaded2(np.array([1], dtype='complex64')) == 'float complex' + assert m.overloaded2(np.array([1], dtype='complex128')) == 'double complex' + assert m.overloaded2(np.array([1], dtype='float32')) == 'float' + + assert m.overloaded3(np.array([1], dtype='float64')) == 'double' + assert m.overloaded3(np.array([1], dtype='intc')) == 'int' + expected_exc = """ + overloaded3(): incompatible function arguments. The following argument types are supported: + 1. (arg0: numpy.ndarray[int32]) -> str + 2. (arg0: numpy.ndarray[float64]) -> str + + Invoked with: """ + + with pytest.raises(TypeError) as excinfo: + m.overloaded3(np.array([1], dtype='uintc')) + assert msg(excinfo.value) == expected_exc + repr(np.array([1], dtype='uint32')) + with pytest.raises(TypeError) as excinfo: + m.overloaded3(np.array([1], dtype='float32')) + assert msg(excinfo.value) == expected_exc + repr(np.array([1.], dtype='float32')) + with pytest.raises(TypeError) as excinfo: + m.overloaded3(np.array([1], dtype='complex')) + assert msg(excinfo.value) == expected_exc + repr(np.array([1. + 0.j])) + + # Exact matches: + assert m.overloaded4(np.array([1], dtype='double')) == 'double' + assert m.overloaded4(np.array([1], dtype='longlong')) == 'long long' + # Non-exact matches requiring conversion. Since float to integer isn't a + # save conversion, it should go to the double overload, but short can go to + # either (and so should end up on the first-registered, the long long). + assert m.overloaded4(np.array([1], dtype='float32')) == 'double' + assert m.overloaded4(np.array([1], dtype='short')) == 'long long' + + assert m.overloaded5(np.array([1], dtype='double')) == 'double' + assert m.overloaded5(np.array([1], dtype='uintc')) == 'unsigned int' + assert m.overloaded5(np.array([1], dtype='float32')) == 'unsigned int' + + +def test_greedy_string_overload(): + """Tests fix for #685 - ndarray shouldn't go to std::string overload""" + + assert m.issue685("abc") == "string" + assert m.issue685(np.array([97, 98, 99], dtype='b')) == "array" + assert m.issue685(123) == "other" + + +def test_array_unchecked_fixed_dims(msg): + z1 = np.array([[1, 2], [3, 4]], dtype='float64') + m.proxy_add2(z1, 10) + assert np.all(z1 == [[11, 12], [13, 14]]) + + with pytest.raises(ValueError) as excinfo: + m.proxy_add2(np.array([1., 2, 3]), 5.0) + assert msg(excinfo.value) == "array has incorrect number of dimensions: 1; expected 2" + + expect_c = np.ndarray(shape=(3, 3, 3), buffer=np.array(range(3, 30)), dtype='int') + assert np.all(m.proxy_init3(3.0) == expect_c) + expect_f = np.transpose(expect_c) + assert np.all(m.proxy_init3F(3.0) == expect_f) + + assert m.proxy_squared_L2_norm(np.array(range(6))) == 55 + assert m.proxy_squared_L2_norm(np.array(range(6), dtype="float64")) == 55 + + assert m.proxy_auxiliaries2(z1) == [11, 11, True, 2, 8, 2, 2, 4, 32] + assert m.proxy_auxiliaries2(z1) == m.array_auxiliaries2(z1) + + +def test_array_unchecked_dyn_dims(msg): + z1 = np.array([[1, 2], [3, 4]], dtype='float64') + m.proxy_add2_dyn(z1, 10) + assert np.all(z1 == [[11, 12], [13, 14]]) + + expect_c = np.ndarray(shape=(3, 3, 3), buffer=np.array(range(3, 30)), dtype='int') + assert np.all(m.proxy_init3_dyn(3.0) == expect_c) + + assert m.proxy_auxiliaries2_dyn(z1) == [11, 11, True, 2, 8, 2, 2, 4, 32] + assert m.proxy_auxiliaries2_dyn(z1) == m.array_auxiliaries2(z1) + + +def test_array_failure(): + with pytest.raises(ValueError) as excinfo: + m.array_fail_test() + assert str(excinfo.value) == 'cannot create a pybind11::array from a nullptr' + + with pytest.raises(ValueError) as excinfo: + m.array_t_fail_test() + assert str(excinfo.value) == 'cannot create a pybind11::array_t from a nullptr' + + with pytest.raises(ValueError) as excinfo: + m.array_fail_test_negative_size() + assert str(excinfo.value) == 'negative dimensions are not allowed' + + +def test_initializer_list(): + assert m.array_initializer_list1().shape == (1,) + assert m.array_initializer_list2().shape == (1, 2) + assert m.array_initializer_list3().shape == (1, 2, 3) + assert m.array_initializer_list4().shape == (1, 2, 3, 4) + + +def test_array_resize(msg): + a = np.array([1, 2, 3, 4, 5, 6, 7, 8, 9], dtype='float64') + m.array_reshape2(a) + assert (a.size == 9) + assert (np.all(a == [[1, 2, 3], [4, 5, 6], [7, 8, 9]])) + + # total size change should succced with refcheck off + m.array_resize3(a, 4, False) + assert (a.size == 64) + # ... and fail with refcheck on + try: + m.array_resize3(a, 3, True) + except ValueError as e: + assert (str(e).startswith("cannot resize an array")) + # transposed array doesn't own data + b = a.transpose() + try: + m.array_resize3(b, 3, False) + except ValueError as e: + assert (str(e).startswith("cannot resize this array: it does not own its data")) + # ... but reshape should be fine + m.array_reshape2(b) + assert (b.shape == (8, 8)) + + +@pytest.unsupported_on_pypy +def test_array_create_and_resize(msg): + a = m.create_and_resize(2) + assert (a.size == 4) + assert (np.all(a == 42.)) + + +@pytest.unsupported_on_py2 +def test_index_using_ellipsis(): + a = m.index_using_ellipsis(np.zeros((5, 6, 7))) + assert a.shape == (6,) diff --git a/pybind11/tests/test_numpy_dtypes.cpp b/pybind11/tests/test_numpy_dtypes.cpp new file mode 100644 index 0000000000000000000000000000000000000000..2c7ed541a3b56bb4527976952c891a054f70db76 --- /dev/null +++ b/pybind11/tests/test_numpy_dtypes.cpp @@ -0,0 +1,542 @@ +/* + tests/test_numpy_dtypes.cpp -- Structured and compound NumPy dtypes + + Copyright (c) 2016 Ivan Smirnov + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include <pybind11/numpy.h> + +#ifdef __GNUC__ +# define PYBIND11_PACKED(cls) cls __attribute__((__packed__)) +#else +# define PYBIND11_PACKED(cls) __pragma(pack(push, 1)) cls __pragma(pack(pop)) +#endif + +namespace py = pybind11; + +struct SimpleStruct +{ + bool bool_; + uint32_t uint_; + float float_; + long double ldbl_; +}; + +std::ostream& operator<<(std::ostream& os, const SimpleStruct& v) +{ + return os << "s:" << v.bool_ << "," << v.uint_ << "," << v.float_ << "," << v.ldbl_; +} + +PYBIND11_PACKED(struct PackedStruct { + bool bool_; + uint32_t uint_; + float float_; + long double ldbl_; +}); + +std::ostream& operator<<(std::ostream& os, const PackedStruct& v) +{ + return os << "p:" << v.bool_ << "," << v.uint_ << "," << v.float_ << "," << v.ldbl_; +} + +PYBIND11_PACKED(struct NestedStruct { + SimpleStruct a; + PackedStruct b; +}); + +std::ostream& operator<<(std::ostream& os, const NestedStruct& v) +{ + return os << "n:a=" << v.a << ";b=" << v.b; +} + +struct PartialStruct +{ + bool bool_; + uint32_t uint_; + float float_; + uint64_t dummy2; + long double ldbl_; +}; + +struct PartialNestedStruct +{ + uint64_t dummy1; + PartialStruct a; + uint64_t dummy2; +}; + +struct UnboundStruct +{}; + +struct StringStruct +{ + char a[3]; + std::array<char, 3> b; +}; + +struct ComplexStruct +{ + std::complex<float> cflt; + std::complex<double> cdbl; +}; + +std::ostream& operator<<(std::ostream& os, const ComplexStruct& v) +{ + return os << "c:" << v.cflt << "," << v.cdbl; +} + +struct ArrayStruct +{ + char a[3][4]; + int32_t b[2]; + std::array<uint8_t, 3> c; + std::array<float, 2> d[4]; +}; + +PYBIND11_PACKED(struct StructWithUglyNames { + int8_t __x__; + uint64_t __y__; +}); + +enum class E1 : int64_t +{ + A = -1, + B = 1 +}; +enum E2 : uint8_t +{ + X = 1, + Y = 2 +}; + +PYBIND11_PACKED(struct EnumStruct { + E1 e1; + E2 e2; +}); + +std::ostream& operator<<(std::ostream& os, const StringStruct& v) +{ + os << "a='"; + for (size_t i = 0; i < 3 && v.a[i]; i++) + os << v.a[i]; + os << "',b='"; + for (size_t i = 0; i < 3 && v.b[i]; i++) + os << v.b[i]; + return os << "'"; +} + +std::ostream& operator<<(std::ostream& os, const ArrayStruct& v) +{ + os << "a={"; + for (int i = 0; i < 3; i++) { + if (i > 0) + os << ','; + os << '{'; + for (int j = 0; j < 3; j++) + os << v.a[i][j] << ','; + os << v.a[i][3] << '}'; + } + os << "},b={" << v.b[0] << ',' << v.b[1]; + os << "},c={" << int(v.c[0]) << ',' << int(v.c[1]) << ',' << int(v.c[2]); + os << "},d={"; + for (int i = 0; i < 4; i++) { + if (i > 0) + os << ','; + os << '{' << v.d[i][0] << ',' << v.d[i][1] << '}'; + } + return os << '}'; +} + +std::ostream& operator<<(std::ostream& os, const EnumStruct& v) +{ + return os << "e1=" << (v.e1 == E1::A ? "A" : "B") << ",e2=" << (v.e2 == E2::X ? "X" : "Y"); +} + +template <typename T> +py::array mkarray_via_buffer(size_t n) +{ + return py::array(py::buffer_info(nullptr, sizeof(T), py::format_descriptor<T>::format(), 1, {n}, {sizeof(T)})); +} + +#define SET_TEST_VALS(s, i) \ + do { \ + s.bool_ = (i) % 2 != 0; \ + s.uint_ = (uint32_t)(i); \ + s.float_ = (float)(i)*1.5f; \ + s.ldbl_ = (long double)(i) * -2.5L; \ + } while (0) + +template <typename S> +py::array_t<S, 0> create_recarray(size_t n) +{ + auto arr = mkarray_via_buffer<S>(n); + auto req = arr.request(); + auto ptr = static_cast<S*>(req.ptr); + for (size_t i = 0; i < n; i++) { + SET_TEST_VALS(ptr[i], i); + } + return arr; +} + +template <typename S> +py::list print_recarray(py::array_t<S, 0> arr) +{ + const auto req = arr.request(); + const auto ptr = static_cast<S*>(req.ptr); + auto l = py::list(); + for (ssize_t i = 0; i < req.size; i++) { + std::stringstream ss; + ss << ptr[i]; + l.append(py::str(ss.str())); + } + return l; +} + +py::array_t<int32_t, 0> test_array_ctors(int i) +{ + using arr_t = py::array_t<int32_t, 0>; + + std::vector<int32_t> data{1, 2, 3, 4, 5, 6}; + std::vector<ssize_t> shape{3, 2}; + std::vector<ssize_t> strides{8, 4}; + + auto ptr = data.data(); + auto vptr = (void*)ptr; + auto dtype = py::dtype("int32"); + + py::buffer_info buf_ndim1(vptr, 4, "i", 6); + py::buffer_info buf_ndim1_null(nullptr, 4, "i", 6); + py::buffer_info buf_ndim2(vptr, 4, "i", 2, shape, strides); + py::buffer_info buf_ndim2_null(nullptr, 4, "i", 2, shape, strides); + + auto fill = [](py::array arr) { + auto req = arr.request(); + for (int i = 0; i < 6; i++) + ((int32_t*)req.ptr)[i] = i + 1; + return arr; + }; + + switch (i) { + // shape: (3, 2) + case 10: + return arr_t(shape, strides, ptr); + case 11: + return py::array(shape, strides, ptr); + case 12: + return py::array(dtype, shape, strides, vptr); + case 13: + return arr_t(shape, ptr); + case 14: + return py::array(shape, ptr); + case 15: + return py::array(dtype, shape, vptr); + case 16: + return arr_t(buf_ndim2); + case 17: + return py::array(buf_ndim2); + // shape: (3, 2) - post-fill + case 20: + return fill(arr_t(shape, strides)); + case 21: + return py::array(shape, strides, ptr); // can't have nullptr due to templated ctor + case 22: + return fill(py::array(dtype, shape, strides)); + case 23: + return fill(arr_t(shape)); + case 24: + return py::array(shape, ptr); // can't have nullptr due to templated ctor + case 25: + return fill(py::array(dtype, shape)); + case 26: + return fill(arr_t(buf_ndim2_null)); + case 27: + return fill(py::array(buf_ndim2_null)); + // shape: (6, ) + case 30: + return arr_t(6, ptr); + case 31: + return py::array(6, ptr); + case 32: + return py::array(dtype, 6, vptr); + case 33: + return arr_t(buf_ndim1); + case 34: + return py::array(buf_ndim1); + // shape: (6, ) + case 40: + return fill(arr_t(6)); + case 41: + return py::array(6, ptr); // can't have nullptr due to templated ctor + case 42: + return fill(py::array(dtype, 6)); + case 43: + return fill(arr_t(buf_ndim1_null)); + case 44: + return fill(py::array(buf_ndim1_null)); + } + return arr_t(); +} + +py::list test_dtype_ctors() +{ + py::list list; + list.append(py::dtype("int32")); + list.append(py::dtype(std::string("float64"))); + list.append(py::dtype::from_args(py::str("bool"))); + py::list names, offsets, formats; + py::dict dict; + names.append(py::str("a")); + names.append(py::str("b")); + dict["names"] = names; + offsets.append(py::int_(1)); + offsets.append(py::int_(10)); + dict["offsets"] = offsets; + formats.append(py::dtype("int32")); + formats.append(py::dtype("float64")); + dict["formats"] = formats; + dict["itemsize"] = py::int_(20); + list.append(py::dtype::from_args(dict)); + list.append(py::dtype(names, formats, offsets, 20)); + list.append(py::dtype(py::buffer_info((void*)0, sizeof(unsigned int), "I", 1))); + list.append(py::dtype(py::buffer_info((void*)0, 0, "T{i:a:f:b:}", 1))); + return list; +} + +struct A +{}; +struct B +{}; + +TEST_SUBMODULE(numpy_dtypes, m) +{ + try { + py::module::import("numpy"); + } catch (...) { + return; + } + + // typeinfo may be registered before the dtype descriptor for scalar casts to work... + py::class_<SimpleStruct>(m, "SimpleStruct"); + + PYBIND11_NUMPY_DTYPE(SimpleStruct, bool_, uint_, float_, ldbl_); + PYBIND11_NUMPY_DTYPE(PackedStruct, bool_, uint_, float_, ldbl_); + PYBIND11_NUMPY_DTYPE(NestedStruct, a, b); + PYBIND11_NUMPY_DTYPE(PartialStruct, bool_, uint_, float_, ldbl_); + PYBIND11_NUMPY_DTYPE(PartialNestedStruct, a); + PYBIND11_NUMPY_DTYPE(StringStruct, a, b); + PYBIND11_NUMPY_DTYPE(ArrayStruct, a, b, c, d); + PYBIND11_NUMPY_DTYPE(EnumStruct, e1, e2); + PYBIND11_NUMPY_DTYPE(ComplexStruct, cflt, cdbl); + + // ... or after + py::class_<PackedStruct>(m, "PackedStruct"); + + PYBIND11_NUMPY_DTYPE_EX(StructWithUglyNames, __x__, "x", __y__, "y"); + + // If uncommented, this should produce a static_assert failure telling the user that the struct + // is not a POD type + // struct NotPOD { std::string v; NotPOD() : v("hi") {}; }; + // PYBIND11_NUMPY_DTYPE(NotPOD, v); + + // Check that dtypes can be registered programmatically, both from + // initializer lists of field descriptors and from other containers. + py::detail::npy_format_descriptor<A>::register_dtype({}); + py::detail::npy_format_descriptor<B>::register_dtype(std::vector<py::detail::field_descriptor>{}); + + // test_recarray, test_scalar_conversion + m.def("create_rec_simple", &create_recarray<SimpleStruct>); + m.def("create_rec_packed", &create_recarray<PackedStruct>); + m.def("create_rec_nested", [](size_t n) { // test_signature + py::array_t<NestedStruct, 0> arr = mkarray_via_buffer<NestedStruct>(n); + auto req = arr.request(); + auto ptr = static_cast<NestedStruct*>(req.ptr); + for (size_t i = 0; i < n; i++) { + SET_TEST_VALS(ptr[i].a, i); + SET_TEST_VALS(ptr[i].b, i + 1); + } + return arr; + }); + m.def("create_rec_partial", &create_recarray<PartialStruct>); + m.def("create_rec_partial_nested", [](size_t n) { + py::array_t<PartialNestedStruct, 0> arr = mkarray_via_buffer<PartialNestedStruct>(n); + auto req = arr.request(); + auto ptr = static_cast<PartialNestedStruct*>(req.ptr); + for (size_t i = 0; i < n; i++) { + SET_TEST_VALS(ptr[i].a, i); + } + return arr; + }); + m.def("print_rec_simple", &print_recarray<SimpleStruct>); + m.def("print_rec_packed", &print_recarray<PackedStruct>); + m.def("print_rec_nested", &print_recarray<NestedStruct>); + + // test_format_descriptors + m.def("get_format_unbound", []() { return py::format_descriptor<UnboundStruct>::format(); }); + m.def("print_format_descriptors", []() { + py::list l; + for (const auto& fmt : {py::format_descriptor<SimpleStruct>::format(), + py::format_descriptor<PackedStruct>::format(), + py::format_descriptor<NestedStruct>::format(), + py::format_descriptor<PartialStruct>::format(), + py::format_descriptor<PartialNestedStruct>::format(), + py::format_descriptor<StringStruct>::format(), + py::format_descriptor<ArrayStruct>::format(), + py::format_descriptor<EnumStruct>::format(), + py::format_descriptor<ComplexStruct>::format()}) { + l.append(py::cast(fmt)); + } + return l; + }); + + // test_dtype + m.def("print_dtypes", []() { + py::list l; + for (const py::handle& d : {py::dtype::of<SimpleStruct>(), + py::dtype::of<PackedStruct>(), + py::dtype::of<NestedStruct>(), + py::dtype::of<PartialStruct>(), + py::dtype::of<PartialNestedStruct>(), + py::dtype::of<StringStruct>(), + py::dtype::of<ArrayStruct>(), + py::dtype::of<EnumStruct>(), + py::dtype::of<StructWithUglyNames>(), + py::dtype::of<ComplexStruct>()}) + l.append(py::str(d)); + return l; + }); + m.def("test_dtype_ctors", &test_dtype_ctors); + m.def("test_dtype_methods", []() { + py::list list; + auto dt1 = py::dtype::of<int32_t>(); + auto dt2 = py::dtype::of<SimpleStruct>(); + list.append(dt1); + list.append(dt2); + list.append(py::bool_(dt1.has_fields())); + list.append(py::bool_(dt2.has_fields())); + list.append(py::int_(dt1.itemsize())); + list.append(py::int_(dt2.itemsize())); + return list; + }); + struct TrailingPaddingStruct + { + int32_t a; + char b; + }; + PYBIND11_NUMPY_DTYPE(TrailingPaddingStruct, a, b); + m.def("trailing_padding_dtype", []() { return py::dtype::of<TrailingPaddingStruct>(); }); + + // test_string_array + m.def("create_string_array", [](bool non_empty) { + py::array_t<StringStruct, 0> arr = mkarray_via_buffer<StringStruct>(non_empty ? 4 : 0); + if (non_empty) { + auto req = arr.request(); + auto ptr = static_cast<StringStruct*>(req.ptr); + for (ssize_t i = 0; i < req.size * req.itemsize; i++) + static_cast<char*>(req.ptr)[i] = 0; + ptr[1].a[0] = 'a'; + ptr[1].b[0] = 'a'; + ptr[2].a[0] = 'a'; + ptr[2].b[0] = 'a'; + ptr[3].a[0] = 'a'; + ptr[3].b[0] = 'a'; + + ptr[2].a[1] = 'b'; + ptr[2].b[1] = 'b'; + ptr[3].a[1] = 'b'; + ptr[3].b[1] = 'b'; + + ptr[3].a[2] = 'c'; + ptr[3].b[2] = 'c'; + } + return arr; + }); + m.def("print_string_array", &print_recarray<StringStruct>); + + // test_array_array + m.def("create_array_array", [](size_t n) { + py::array_t<ArrayStruct, 0> arr = mkarray_via_buffer<ArrayStruct>(n); + auto ptr = (ArrayStruct*)arr.mutable_data(); + for (size_t i = 0; i < n; i++) { + for (size_t j = 0; j < 3; j++) + for (size_t k = 0; k < 4; k++) + ptr[i].a[j][k] = char('A' + (i * 100 + j * 10 + k) % 26); + for (size_t j = 0; j < 2; j++) + ptr[i].b[j] = int32_t(i * 1000 + j); + for (size_t j = 0; j < 3; j++) + ptr[i].c[j] = uint8_t(i * 10 + j); + for (size_t j = 0; j < 4; j++) + for (size_t k = 0; k < 2; k++) + ptr[i].d[j][k] = float(i) * 100.0f + float(j) * 10.0f + float(k); + } + return arr; + }); + m.def("print_array_array", &print_recarray<ArrayStruct>); + + // test_enum_array + m.def("create_enum_array", [](size_t n) { + py::array_t<EnumStruct, 0> arr = mkarray_via_buffer<EnumStruct>(n); + auto ptr = (EnumStruct*)arr.mutable_data(); + for (size_t i = 0; i < n; i++) { + ptr[i].e1 = static_cast<E1>(-1 + ((int)i % 2) * 2); + ptr[i].e2 = static_cast<E2>(1 + (i % 2)); + } + return arr; + }); + m.def("print_enum_array", &print_recarray<EnumStruct>); + + // test_complex_array + m.def("create_complex_array", [](size_t n) { + py::array_t<ComplexStruct, 0> arr = mkarray_via_buffer<ComplexStruct>(n); + auto ptr = (ComplexStruct*)arr.mutable_data(); + for (size_t i = 0; i < n; i++) { + ptr[i].cflt.real(float(i)); + ptr[i].cflt.imag(float(i) + 0.25f); + ptr[i].cdbl.real(double(i) + 0.5); + ptr[i].cdbl.imag(double(i) + 0.75); + } + return arr; + }); + m.def("print_complex_array", &print_recarray<ComplexStruct>); + + // test_array_constructors + m.def("test_array_ctors", &test_array_ctors); + + // test_compare_buffer_info + struct CompareStruct + { + bool x; + uint32_t y; + float z; + }; + PYBIND11_NUMPY_DTYPE(CompareStruct, x, y, z); + m.def("compare_buffer_info", []() { + py::list list; + list.append( + py::bool_(py::detail::compare_buffer_info<float>::compare(py::buffer_info(nullptr, sizeof(float), "f", 1)))); + list.append( + py::bool_(py::detail::compare_buffer_info<unsigned>::compare(py::buffer_info(nullptr, sizeof(int), "I", 1)))); + list.append( + py::bool_(py::detail::compare_buffer_info<long>::compare(py::buffer_info(nullptr, sizeof(long), "l", 1)))); + list.append(py::bool_(py::detail::compare_buffer_info<long>::compare( + py::buffer_info(nullptr, sizeof(long), sizeof(long) == sizeof(int) ? "i" : "q", 1)))); + list.append(py::bool_(py::detail::compare_buffer_info<CompareStruct>::compare( + py::buffer_info(nullptr, sizeof(CompareStruct), "T{?:x:3xI:y:f:z:}", 1)))); + return list; + }); + m.def("buffer_to_dtype", [](py::buffer& buf) { return py::dtype(buf.request()); }); + + // test_scalar_conversion + m.def("f_simple", [](SimpleStruct s) { return s.uint_ * 10; }); + m.def("f_packed", [](PackedStruct s) { return s.uint_ * 10; }); + m.def("f_nested", [](NestedStruct s) { return s.a.uint_ * 10; }); + + // test_register_dtype + m.def("register_dtype", []() { PYBIND11_NUMPY_DTYPE(SimpleStruct, bool_, uint_, float_, ldbl_); }); + + // test_str_leak + m.def("dtype_wrapper", [](py::object d) { return py::dtype::from_args(std::move(d)); }); +} diff --git a/pybind11/tests/test_numpy_dtypes.py b/pybind11/tests/test_numpy_dtypes.py new file mode 100644 index 0000000000000000000000000000000000000000..5fc7a033979117460428349b43f70b7edbbd7255 --- /dev/null +++ b/pybind11/tests/test_numpy_dtypes.py @@ -0,0 +1,276 @@ +import re +import pytest +from pybind11_tests import numpy_dtypes as m + +pytestmark = pytest.requires_numpy + +with pytest.suppress(ImportError): + import numpy as np + + +@pytest.fixture(scope='module') +def simple_dtype(): + ld = np.dtype('longdouble') + return np.dtype({ + 'names': ['bool_', 'uint_', 'float_', 'ldbl_'], + 'formats': ['?', 'u4', 'f4', 'f{}'.format(ld.itemsize)], + 'offsets': [0, 4, 8, (16 if ld.alignment > 4 else 12)] + }) + + +@pytest.fixture(scope='module') +def packed_dtype(): + return np.dtype([('bool_', '?'), ('uint_', 'u4'), ('float_', 'f4'), ('ldbl_', 'g')]) + + +def dt_fmt(): + from sys import byteorder + e = '<' if byteorder == 'little' else '>' + return ("{{'names':['bool_','uint_','float_','ldbl_']," + " 'formats':['?','" + e + "u4','" + e + "f4','" + e + "f{}']," + " 'offsets':[0,4,8,{}], 'itemsize':{}}}") + + +def simple_dtype_fmt(): + ld = np.dtype('longdouble') + simple_ld_off = 12 + 4 * (ld.alignment > 4) + return dt_fmt().format(ld.itemsize, simple_ld_off, simple_ld_off + ld.itemsize) + + +def packed_dtype_fmt(): + from sys import byteorder + return "[('bool_', '?'), ('uint_', '{e}u4'), ('float_', '{e}f4'), ('ldbl_', '{e}f{}')]".format( + np.dtype('longdouble').itemsize, e='<' if byteorder == 'little' else '>') + + +def partial_ld_offset(): + return 12 + 4 * (np.dtype('uint64').alignment > 4) + 8 + 8 * (np.dtype('longdouble').alignment > 8) + + +def partial_dtype_fmt(): + ld = np.dtype('longdouble') + partial_ld_off = partial_ld_offset() + return dt_fmt().format(ld.itemsize, partial_ld_off, partial_ld_off + ld.itemsize) + + +def partial_nested_fmt(): + ld = np.dtype('longdouble') + partial_nested_off = 8 + 8 * (ld.alignment > 8) + partial_ld_off = partial_ld_offset() + partial_nested_size = partial_nested_off * 2 + partial_ld_off + ld.itemsize + return "{{'names':['a'], 'formats':[{}], 'offsets':[{}], 'itemsize':{}}}".format( + partial_dtype_fmt(), partial_nested_off, partial_nested_size) + + +def assert_equal(actual, expected_data, expected_dtype): + np.testing.assert_equal(actual, np.array(expected_data, dtype=expected_dtype)) + + +def test_format_descriptors(): + with pytest.raises(RuntimeError) as excinfo: + m.get_format_unbound() + assert re.match('^NumPy type info missing for .*UnboundStruct.*$', str(excinfo.value)) + + ld = np.dtype('longdouble') + ldbl_fmt = ('4x' if ld.alignment > 4 else '') + ld.char + ss_fmt = "^T{?:bool_:3xI:uint_:f:float_:" + ldbl_fmt + ":ldbl_:}" + dbl = np.dtype('double') + partial_fmt = ("^T{?:bool_:3xI:uint_:f:float_:" + + str(4 * (dbl.alignment > 4) + dbl.itemsize + 8 * (ld.alignment > 8)) + "xg:ldbl_:}") + nested_extra = str(max(8, ld.alignment)) + assert m.print_format_descriptors() == [ + ss_fmt, "^T{?:bool_:I:uint_:f:float_:g:ldbl_:}", + "^T{" + ss_fmt + ":a:^T{?:bool_:I:uint_:f:float_:g:ldbl_:}:b:}", partial_fmt, + "^T{" + nested_extra + "x" + partial_fmt + ":a:" + nested_extra + "x}", "^T{3s:a:3s:b:}", + "^T{(3)4s:a:(2)i:b:(3)B:c:1x(4, 2)f:d:}", '^T{q:e1:B:e2:}', '^T{Zf:cflt:Zd:cdbl:}' + ] + + +def test_dtype(simple_dtype): + from sys import byteorder + e = '<' if byteorder == 'little' else '>' + + assert m.print_dtypes() == [ + simple_dtype_fmt(), + packed_dtype_fmt(), "[('a', {}), ('b', {})]".format(simple_dtype_fmt(), packed_dtype_fmt()), + partial_dtype_fmt(), + partial_nested_fmt(), "[('a', 'S3'), ('b', 'S3')]", + ("{{'names':['a','b','c','d'], " + "'formats':[('S4', (3,)),('" + e + "i4', (2,)),('u1', (3,)),('" + e + + "f4', (4, 2))], " + "'offsets':[0,12,20,24], 'itemsize':56}}").format(e=e), + "[('e1', '" + e + "i8'), ('e2', 'u1')]", "[('x', 'i1'), ('y', '" + e + "u8')]", + "[('cflt', '" + e + "c8'), ('cdbl', '" + e + "c16')]" + ] + + d1 = np.dtype({'names': ['a', 'b'], 'formats': ['int32', 'float64'], 'offsets': [1, 10], 'itemsize': 20}) + d2 = np.dtype([('a', 'i4'), ('b', 'f4')]) + assert m.test_dtype_ctors() == [ + np.dtype('int32'), np.dtype('float64'), + np.dtype('bool'), d1, d1, + np.dtype('uint32'), d2 + ] + + assert m.test_dtype_methods() == [ + np.dtype('int32'), simple_dtype, False, True, + np.dtype('int32').itemsize, simple_dtype.itemsize + ] + + assert m.trailing_padding_dtype() == m.buffer_to_dtype(np.zeros(1, m.trailing_padding_dtype())) + + +def test_recarray(simple_dtype, packed_dtype): + elements = [(False, 0, 0.0, -0.0), (True, 1, 1.5, -2.5), (False, 2, 3.0, -5.0)] + + for func, dtype in [(m.create_rec_simple, simple_dtype), (m.create_rec_packed, packed_dtype)]: + arr = func(0) + assert arr.dtype == dtype + assert_equal(arr, [], simple_dtype) + assert_equal(arr, [], packed_dtype) + + arr = func(3) + assert arr.dtype == dtype + assert_equal(arr, elements, simple_dtype) + assert_equal(arr, elements, packed_dtype) + + if dtype == simple_dtype: + assert m.print_rec_simple(arr) == ["s:0,0,0,-0", "s:1,1,1.5,-2.5", "s:0,2,3,-5"] + else: + assert m.print_rec_packed(arr) == ["p:0,0,0,-0", "p:1,1,1.5,-2.5", "p:0,2,3,-5"] + + nested_dtype = np.dtype([('a', simple_dtype), ('b', packed_dtype)]) + + arr = m.create_rec_nested(0) + assert arr.dtype == nested_dtype + assert_equal(arr, [], nested_dtype) + + arr = m.create_rec_nested(3) + assert arr.dtype == nested_dtype + assert_equal(arr, [((False, 0, 0.0, -0.0), (True, 1, 1.5, -2.5)), ((True, 1, 1.5, -2.5), (False, 2, 3.0, -5.0)), + ((False, 2, 3.0, -5.0), (True, 3, 4.5, -7.5))], nested_dtype) + assert m.print_rec_nested(arr) == [ + "n:a=s:0,0,0,-0;b=p:1,1,1.5,-2.5", "n:a=s:1,1,1.5,-2.5;b=p:0,2,3,-5", "n:a=s:0,2,3,-5;b=p:1,3,4.5,-7.5" + ] + + arr = m.create_rec_partial(3) + assert str(arr.dtype) == partial_dtype_fmt() + partial_dtype = arr.dtype + assert '' not in arr.dtype.fields + assert partial_dtype.itemsize > simple_dtype.itemsize + assert_equal(arr, elements, simple_dtype) + assert_equal(arr, elements, packed_dtype) + + arr = m.create_rec_partial_nested(3) + assert str(arr.dtype) == partial_nested_fmt() + assert '' not in arr.dtype.fields + assert '' not in arr.dtype.fields['a'][0].fields + assert arr.dtype.itemsize > partial_dtype.itemsize + np.testing.assert_equal(arr['a'], m.create_rec_partial(3)) + + +def test_array_constructors(): + data = np.arange(1, 7, dtype='int32') + for i in range(8): + np.testing.assert_array_equal(m.test_array_ctors(10 + i), data.reshape((3, 2))) + np.testing.assert_array_equal(m.test_array_ctors(20 + i), data.reshape((3, 2))) + for i in range(5): + np.testing.assert_array_equal(m.test_array_ctors(30 + i), data) + np.testing.assert_array_equal(m.test_array_ctors(40 + i), data) + + +def test_string_array(): + arr = m.create_string_array(True) + assert str(arr.dtype) == "[('a', 'S3'), ('b', 'S3')]" + assert m.print_string_array(arr) == ["a='',b=''", "a='a',b='a'", "a='ab',b='ab'", "a='abc',b='abc'"] + dtype = arr.dtype + assert arr['a'].tolist() == [b'', b'a', b'ab', b'abc'] + assert arr['b'].tolist() == [b'', b'a', b'ab', b'abc'] + arr = m.create_string_array(False) + assert dtype == arr.dtype + + +def test_array_array(): + from sys import byteorder + e = '<' if byteorder == 'little' else '>' + + arr = m.create_array_array(3) + assert str(arr.dtype) == ( + "{{'names':['a','b','c','d'], " + "'formats':[('S4', (3,)),('" + e + + "i4', (2,)),('u1', (3,)),('{e}f4', (4, 2))], " + "'offsets':[0,12,20,24], 'itemsize':56}}").format(e=e) + assert m.print_array_array(arr) == [ + "a={{A,B,C,D},{K,L,M,N},{U,V,W,X}},b={0,1}," + "c={0,1,2},d={{0,1},{10,11},{20,21},{30,31}}", + "a={{W,X,Y,Z},{G,H,I,J},{Q,R,S,T}},b={1000,1001}," + + "c={10,11,12},d={{100,101},{110,111},{120,121},{130,131}}", + "a={{S,T,U,V},{C,D,E,F},{M,N,O,P}},b={2000,2001}," + + "c={20,21,22},d={{200,201},{210,211},{220,221},{230,231}}", + ] + assert arr['a'].tolist() == [[b'ABCD', b'KLMN', b'UVWX'], [b'WXYZ', b'GHIJ', b'QRST'], [b'STUV', b'CDEF', b'MNOP']] + assert arr['b'].tolist() == [[0, 1], [1000, 1001], [2000, 2001]] + assert m.create_array_array(0).dtype == arr.dtype + + +def test_enum_array(): + from sys import byteorder + e = '<' if byteorder == 'little' else '>' + + arr = m.create_enum_array(3) + dtype = arr.dtype + assert dtype == np.dtype([('e1', e + 'i8'), ('e2', 'u1')]) + assert m.print_enum_array(arr) == ["e1=A,e2=X", "e1=B,e2=Y", "e1=A,e2=X"] + assert arr['e1'].tolist() == [-1, 1, -1] + assert arr['e2'].tolist() == [1, 2, 1] + assert m.create_enum_array(0).dtype == dtype + + +def test_complex_array(): + from sys import byteorder + e = '<' if byteorder == 'little' else '>' + + arr = m.create_complex_array(3) + dtype = arr.dtype + assert dtype == np.dtype([('cflt', e + 'c8'), ('cdbl', e + 'c16')]) + assert m.print_complex_array(arr) == ["c:(0,0.25),(0.5,0.75)", "c:(1,1.25),(1.5,1.75)", "c:(2,2.25),(2.5,2.75)"] + assert arr['cflt'].tolist() == [0.0 + 0.25j, 1.0 + 1.25j, 2.0 + 2.25j] + assert arr['cdbl'].tolist() == [0.5 + 0.75j, 1.5 + 1.75j, 2.5 + 2.75j] + assert m.create_complex_array(0).dtype == dtype + + +def test_signature(doc): + assert doc(m.create_rec_nested) == \ + "create_rec_nested(arg0: int) -> numpy.ndarray[NestedStruct]" + + +def test_scalar_conversion(): + n = 3 + arrays = [m.create_rec_simple(n), m.create_rec_packed(n), m.create_rec_nested(n), m.create_enum_array(n)] + funcs = [m.f_simple, m.f_packed, m.f_nested] + + for i, func in enumerate(funcs): + for j, arr in enumerate(arrays): + if i == j and i < 2: + assert [func(arr[k]) for k in range(n)] == [k * 10 for k in range(n)] + else: + with pytest.raises(TypeError) as excinfo: + func(arr[0]) + assert 'incompatible function arguments' in str(excinfo.value) + + +def test_register_dtype(): + with pytest.raises(RuntimeError) as excinfo: + m.register_dtype() + assert 'dtype is already registered' in str(excinfo.value) + + +@pytest.unsupported_on_pypy +def test_str_leak(): + from sys import getrefcount + fmt = "f4" + pytest.gc_collect() + start = getrefcount(fmt) + d = m.dtype_wrapper(fmt) + assert d is np.dtype("f4") + del d + pytest.gc_collect() + assert getrefcount(fmt) == start + + +def test_compare_buffer_info(): + assert all(m.compare_buffer_info()) diff --git a/pybind11/tests/test_numpy_vectorize.cpp b/pybind11/tests/test_numpy_vectorize.cpp new file mode 100644 index 0000000000000000000000000000000000000000..9e7cd5685e755574e6a529937b0049c29d2d9e5e --- /dev/null +++ b/pybind11/tests/test_numpy_vectorize.cpp @@ -0,0 +1,97 @@ +/* + tests/test_numpy_vectorize.cpp -- auto-vectorize functions over NumPy array + arguments + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include <pybind11/numpy.h> + +double my_func(int x, float y, double z) +{ + py::print("my_func(x:int={}, y:float={:.0f}, z:float={:.0f})"_s.format(x, y, z)); + return (float)x * y * z; +} + +TEST_SUBMODULE(numpy_vectorize, m) +{ + try { + py::module::import("numpy"); + } catch (...) { + return; + } + + // test_vectorize, test_docs, test_array_collapse + // Vectorize all arguments of a function (though non-vector arguments are also allowed) + m.def("vectorized_func", py::vectorize(my_func)); + + // Vectorize a lambda function with a capture object (e.g. to exclude some arguments from the vectorization) + m.def("vectorized_func2", [](py::array_t<int> x, py::array_t<float> y, float z) { + return py::vectorize([z](int x, float y) { return my_func(x, y, z); })(x, y); + }); + + // Vectorize a complex-valued function + m.def("vectorized_func3", py::vectorize([](std::complex<double> c) { return c * std::complex<double>(2.f); })); + + // test_type_selection + // Numpy function which only accepts specific data types + m.def("selective_func", [](py::array_t<int, py::array::c_style>) { return "Int branch taken."; }); + m.def("selective_func", [](py::array_t<float, py::array::c_style>) { return "Float branch taken."; }); + m.def("selective_func", + [](py::array_t<std::complex<float>, py::array::c_style>) { return "Complex float branch taken."; }); + + + // test_passthrough_arguments + // Passthrough test: references and non-pod types should be automatically passed through (in the + // function definition below, only `b`, `d`, and `g` are vectorized): + struct NonPODClass + { + NonPODClass(int v) + : value{v} + {} + int value; + }; + py::class_<NonPODClass>(m, "NonPODClass").def(py::init<int>()); + m.def("vec_passthrough", + py::vectorize( + [](double* a, double b, py::array_t<double> c, const int& d, int& e, NonPODClass f, const double g) { + return *a + b + c.at(0) + d + e + f.value + g; + })); + + // test_method_vectorization + struct VectorizeTestClass + { + VectorizeTestClass(int v) + : value{v} {}; + float method(int x, float y) + { + return y + (float)(x + value); + } + int value = 0; + }; + py::class_<VectorizeTestClass> vtc(m, "VectorizeTestClass"); + vtc.def(py::init<int>()).def_readwrite("value", &VectorizeTestClass::value); + + // Automatic vectorizing of methods + vtc.def("method", py::vectorize(&VectorizeTestClass::method)); + + // test_trivial_broadcasting + // Internal optimization test for whether the input is trivially broadcastable: + py::enum_<py::detail::broadcast_trivial>(m, "trivial") + .value("f_trivial", py::detail::broadcast_trivial::f_trivial) + .value("c_trivial", py::detail::broadcast_trivial::c_trivial) + .value("non_trivial", py::detail::broadcast_trivial::non_trivial); + m.def("vectorized_is_trivial", + [](py::array_t<int, py::array::forcecast> arg1, + py::array_t<float, py::array::forcecast> arg2, + py::array_t<double, py::array::forcecast> arg3) { + ssize_t ndim; + std::vector<ssize_t> shape; + std::array<py::buffer_info, 3> buffers{{arg1.request(), arg2.request(), arg3.request()}}; + return py::detail::broadcast(buffers, ndim, shape); + }); +} diff --git a/pybind11/tests/test_numpy_vectorize.py b/pybind11/tests/test_numpy_vectorize.py new file mode 100644 index 0000000000000000000000000000000000000000..ff091f17f375ad3f7463224b7f83c565f3764735 --- /dev/null +++ b/pybind11/tests/test_numpy_vectorize.py @@ -0,0 +1,187 @@ +import pytest +from pybind11_tests import numpy_vectorize as m + +pytestmark = pytest.requires_numpy + +with pytest.suppress(ImportError): + import numpy as np + + +def test_vectorize(capture): + assert np.isclose(m.vectorized_func3(np.array(3 + 7j)), [6 + 14j]) + + for f in [m.vectorized_func, m.vectorized_func2]: + with capture: + assert np.isclose(f(1, 2, 3), 6) + assert capture == "my_func(x:int=1, y:float=2, z:float=3)" + with capture: + assert np.isclose(f(np.array(1), np.array(2), 3), 6) + assert capture == "my_func(x:int=1, y:float=2, z:float=3)" + with capture: + assert np.allclose(f(np.array([1, 3]), np.array([2, 4]), 3), [6, 36]) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=3) + my_func(x:int=3, y:float=4, z:float=3) + """ + with capture: + a = np.array([[1, 2], [3, 4]], order='F') + b = np.array([[10, 20], [30, 40]], order='F') + c = 3 + result = f(a, b, c) + assert np.allclose(result, a * b * c) + assert result.flags.f_contiguous + # All inputs are F order and full or singletons, so we the result is in col-major order: + assert capture == """ + my_func(x:int=1, y:float=10, z:float=3) + my_func(x:int=3, y:float=30, z:float=3) + my_func(x:int=2, y:float=20, z:float=3) + my_func(x:int=4, y:float=40, z:float=3) + """ + with capture: + a, b, c = np.array([[1, 3, 5], [7, 9, 11]]), np.array([[2, 4, 6], [8, 10, 12]]), 3 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=3) + my_func(x:int=3, y:float=4, z:float=3) + my_func(x:int=5, y:float=6, z:float=3) + my_func(x:int=7, y:float=8, z:float=3) + my_func(x:int=9, y:float=10, z:float=3) + my_func(x:int=11, y:float=12, z:float=3) + """ + with capture: + a, b, c = np.array([[1, 2, 3], [4, 5, 6]]), np.array([2, 3, 4]), 2 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=2) + my_func(x:int=2, y:float=3, z:float=2) + my_func(x:int=3, y:float=4, z:float=2) + my_func(x:int=4, y:float=2, z:float=2) + my_func(x:int=5, y:float=3, z:float=2) + my_func(x:int=6, y:float=4, z:float=2) + """ + with capture: + a, b, c = np.array([[1, 2, 3], [4, 5, 6]]), np.array([[2], [3]]), 2 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=2) + my_func(x:int=2, y:float=2, z:float=2) + my_func(x:int=3, y:float=2, z:float=2) + my_func(x:int=4, y:float=3, z:float=2) + my_func(x:int=5, y:float=3, z:float=2) + my_func(x:int=6, y:float=3, z:float=2) + """ + with capture: + a, b, c = np.array([[1, 2, 3], [4, 5, 6]], order='F'), np.array([[2], [3]]), 2 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=2) + my_func(x:int=2, y:float=2, z:float=2) + my_func(x:int=3, y:float=2, z:float=2) + my_func(x:int=4, y:float=3, z:float=2) + my_func(x:int=5, y:float=3, z:float=2) + my_func(x:int=6, y:float=3, z:float=2) + """ + with capture: + a, b, c = np.array([[1, 2, 3], [4, 5, 6]])[::, ::2], np.array([[2], [3]]), 2 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=2) + my_func(x:int=3, y:float=2, z:float=2) + my_func(x:int=4, y:float=3, z:float=2) + my_func(x:int=6, y:float=3, z:float=2) + """ + with capture: + a, b, c = np.array([[1, 2, 3], [4, 5, 6]], order='F')[::, ::2], np.array([[2], [3]]), 2 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=2) + my_func(x:int=3, y:float=2, z:float=2) + my_func(x:int=4, y:float=3, z:float=2) + my_func(x:int=6, y:float=3, z:float=2) + """ + + +def test_type_selection(): + assert m.selective_func(np.array([1], dtype=np.int32)) == "Int branch taken." + assert m.selective_func(np.array([1.0], dtype=np.float32)) == "Float branch taken." + assert m.selective_func(np.array([1.0j], dtype=np.complex64)) == "Complex float branch taken." + + +def test_docs(doc): + assert doc(m.vectorized_func) == """ + vectorized_func(arg0: numpy.ndarray[int32], arg1: numpy.ndarray[float32], arg2: numpy.ndarray[float64]) -> object + """ # noqa: E501 line too long + + +def test_trivial_broadcasting(): + trivial, vectorized_is_trivial = m.trivial, m.vectorized_is_trivial + + assert vectorized_is_trivial(1, 2, 3) == trivial.c_trivial + assert vectorized_is_trivial(np.array(1), np.array(2), 3) == trivial.c_trivial + assert vectorized_is_trivial(np.array([1, 3]), np.array([2, 4]), 3) == trivial.c_trivial + assert trivial.c_trivial == vectorized_is_trivial( + np.array([[1, 3, 5], [7, 9, 11]]), np.array([[2, 4, 6], [8, 10, 12]]), 3) + assert vectorized_is_trivial(np.array([[1, 2, 3], [4, 5, 6]]), np.array([2, 3, 4]), 2) == trivial.non_trivial + assert vectorized_is_trivial(np.array([[1, 2, 3], [4, 5, 6]]), np.array([[2], [3]]), 2) == trivial.non_trivial + z1 = np.array([[1, 2, 3, 4], [5, 6, 7, 8]], dtype='int32') + z2 = np.array(z1, dtype='float32') + z3 = np.array(z1, dtype='float64') + assert vectorized_is_trivial(z1, z2, z3) == trivial.c_trivial + assert vectorized_is_trivial(1, z2, z3) == trivial.c_trivial + assert vectorized_is_trivial(z1, 1, z3) == trivial.c_trivial + assert vectorized_is_trivial(z1, z2, 1) == trivial.c_trivial + assert vectorized_is_trivial(z1[::2, ::2], 1, 1) == trivial.non_trivial + assert vectorized_is_trivial(1, 1, z1[::2, ::2]) == trivial.c_trivial + assert vectorized_is_trivial(1, 1, z3[::2, ::2]) == trivial.non_trivial + assert vectorized_is_trivial(z1, 1, z3[1::4, 1::4]) == trivial.c_trivial + + y1 = np.array(z1, order='F') + y2 = np.array(y1) + y3 = np.array(y1) + assert vectorized_is_trivial(y1, y2, y3) == trivial.f_trivial + assert vectorized_is_trivial(y1, 1, 1) == trivial.f_trivial + assert vectorized_is_trivial(1, y2, 1) == trivial.f_trivial + assert vectorized_is_trivial(1, 1, y3) == trivial.f_trivial + assert vectorized_is_trivial(y1, z2, 1) == trivial.non_trivial + assert vectorized_is_trivial(z1[1::4, 1::4], y2, 1) == trivial.f_trivial + assert vectorized_is_trivial(y1[1::4, 1::4], z2, 1) == trivial.c_trivial + + assert m.vectorized_func(z1, z2, z3).flags.c_contiguous + assert m.vectorized_func(y1, y2, y3).flags.f_contiguous + assert m.vectorized_func(z1, 1, 1).flags.c_contiguous + assert m.vectorized_func(1, y2, 1).flags.f_contiguous + assert m.vectorized_func(z1[1::4, 1::4], y2, 1).flags.f_contiguous + assert m.vectorized_func(y1[1::4, 1::4], z2, 1).flags.c_contiguous + + +def test_passthrough_arguments(doc): + assert doc(m.vec_passthrough) == ("vec_passthrough(" + ", ".join([ + "arg0: float", "arg1: numpy.ndarray[float64]", "arg2: numpy.ndarray[float64]", "arg3: numpy.ndarray[int32]", + "arg4: int", "arg5: m.numpy_vectorize.NonPODClass", "arg6: numpy.ndarray[float64]" + ]) + ") -> object") + + b = np.array([[10, 20, 30]], dtype='float64') + c = np.array([100, 200]) # NOT a vectorized argument + d = np.array([[1000], [2000], [3000]], dtype='int') + g = np.array([[1000000, 2000000, 3000000]], dtype='int') # requires casting + assert np.all( + m.vec_passthrough(1, b, c, d, 10000, m.NonPODClass(100000), g) == np.array( + [[1111111, 2111121, 3111131], [1112111, 2112121, 3112131], [1113111, 2113121, 3113131]])) + + +def test_method_vectorization(): + o = m.VectorizeTestClass(3) + x = np.array([1, 2], dtype='int') + y = np.array([[10], [20]], dtype='float32') + assert np.all(o.method(x, y) == [[14, 15], [24, 25]]) + + +def test_array_collapse(): + assert not isinstance(m.vectorized_func(1, 2, 3), np.ndarray) + assert not isinstance(m.vectorized_func(np.array(1), 2, 3), np.ndarray) + z = m.vectorized_func([1], 2, 3) + assert isinstance(z, np.ndarray) + assert z.shape == (1,) + z = m.vectorized_func(1, [[[2]]], 3) + assert isinstance(z, np.ndarray) + assert z.shape == (1, 1, 1) diff --git a/pybind11/tests/test_opaque_types.cpp b/pybind11/tests/test_opaque_types.cpp new file mode 100644 index 0000000000000000000000000000000000000000..a7c28ac23fd04f65ca326ba60e67cf4186b3a63e --- /dev/null +++ b/pybind11/tests/test_opaque_types.cpp @@ -0,0 +1,67 @@ +/* + tests/test_opaque_types.cpp -- opaque types, passing void pointers + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include <pybind11/stl.h> +#include <vector> + +// IMPORTANT: Disable internal pybind11 translation mechanisms for STL data structures +// +// This also deliberately doesn't use the below StringList type alias to test +// that MAKE_OPAQUE can handle a type containing a `,`. (The `std::allocator` +// bit is just the default `std::vector` allocator). +PYBIND11_MAKE_OPAQUE(std::vector<std::string, std::allocator<std::string>>); + +using StringList = std::vector<std::string, std::allocator<std::string>>; + +TEST_SUBMODULE(opaque_types, m) +{ + // test_string_list + py::class_<StringList>(m, "StringList") + .def(py::init<>()) + .def("pop_back", &StringList::pop_back) + /* There are multiple versions of push_back(), etc. Select the right ones. */ + .def("push_back", (void (StringList::*)(const std::string&)) & StringList::push_back) + .def("back", (std::string & (StringList::*)()) & StringList::back) + .def("__len__", [](const StringList& v) { return v.size(); }) + .def("__iter__", [](StringList& v) { return py::make_iterator(v.begin(), v.end()); }, py::keep_alive<0, 1>()); + + class ClassWithSTLVecProperty + { + public: + StringList stringList; + }; + py::class_<ClassWithSTLVecProperty>(m, "ClassWithSTLVecProperty") + .def(py::init<>()) + .def_readwrite("stringList", &ClassWithSTLVecProperty::stringList); + + m.def("print_opaque_list", [](const StringList& l) { + std::string ret = "Opaque list: ["; + bool first = true; + for (auto entry : l) { + if (!first) + ret += ", "; + ret += entry; + first = false; + } + return ret + "]"; + }); + + // test_pointers + m.def("return_void_ptr", []() { return (void*)0x1234; }); + m.def("get_void_ptr_value", [](void* ptr) { return reinterpret_cast<std::intptr_t>(ptr); }); + m.def("return_null_str", []() { return (char*)nullptr; }); + m.def("get_null_str_value", [](char* ptr) { return reinterpret_cast<std::intptr_t>(ptr); }); + + m.def("return_unique_ptr", []() -> std::unique_ptr<StringList> { + StringList* result = new StringList(); + result->push_back("some value"); + return std::unique_ptr<StringList>(result); + }); +} diff --git a/pybind11/tests/test_opaque_types.py b/pybind11/tests/test_opaque_types.py new file mode 100644 index 0000000000000000000000000000000000000000..724b0ebf313f1556efb844e1dfb91d435df94cc2 --- /dev/null +++ b/pybind11/tests/test_opaque_types.py @@ -0,0 +1,46 @@ +import pytest +from pybind11_tests import opaque_types as m +from pybind11_tests import ConstructorStats, UserType + + +def test_string_list(): + lst = m.StringList() + lst.push_back("Element 1") + lst.push_back("Element 2") + assert m.print_opaque_list(lst) == "Opaque list: [Element 1, Element 2]" + assert lst.back() == "Element 2" + + for i, k in enumerate(lst, start=1): + assert k == "Element {}".format(i) + lst.pop_back() + assert m.print_opaque_list(lst) == "Opaque list: [Element 1]" + + cvp = m.ClassWithSTLVecProperty() + assert m.print_opaque_list(cvp.stringList) == "Opaque list: []" + + cvp.stringList = lst + cvp.stringList.push_back("Element 3") + assert m.print_opaque_list(cvp.stringList) == "Opaque list: [Element 1, Element 3]" + + +def test_pointers(msg): + living_before = ConstructorStats.get(UserType).alive() + assert m.get_void_ptr_value(m.return_void_ptr()) == 0x1234 + assert m.get_void_ptr_value(UserType()) # Should also work for other C++ types + assert ConstructorStats.get(UserType).alive() == living_before + + with pytest.raises(TypeError) as excinfo: + m.get_void_ptr_value([1, 2, 3]) # This should not work + assert msg(excinfo.value) == """ + get_void_ptr_value(): incompatible function arguments. The following argument types are supported: + 1. (arg0: capsule) -> int + + Invoked with: [1, 2, 3] + """ # noqa: E501 line too long + + assert m.return_null_str() is None + assert m.get_null_str_value(m.return_null_str()) is not None + + ptr = m.return_unique_ptr() + assert "StringList" in repr(ptr) + assert m.print_opaque_list(ptr) == "Opaque list: [some value]" diff --git a/pybind11/tests/test_operator_overloading.cpp b/pybind11/tests/test_operator_overloading.cpp new file mode 100644 index 0000000000000000000000000000000000000000..a57e8dd1a84ef1a54189c31f1914fc9ab47eda2b --- /dev/null +++ b/pybind11/tests/test_operator_overloading.cpp @@ -0,0 +1,297 @@ +/* + tests/test_operator_overloading.cpp -- operator overloading + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include <pybind11/operators.h> +#include <functional> + +class Vector2 +{ +public: + Vector2(float x, float y) + : x(x) + , y(y) + { + print_created(this, toString()); + } + Vector2(const Vector2& v) + : x(v.x) + , y(v.y) + { + print_copy_created(this); + } + Vector2(Vector2&& v) + : x(v.x) + , y(v.y) + { + print_move_created(this); + v.x = v.y = 0; + } + Vector2& operator=(const Vector2& v) + { + x = v.x; + y = v.y; + print_copy_assigned(this); + return *this; + } + Vector2& operator=(Vector2&& v) + { + x = v.x; + y = v.y; + v.x = v.y = 0; + print_move_assigned(this); + return *this; + } + ~Vector2() + { + print_destroyed(this); + } + + std::string toString() const + { + return "[" + std::to_string(x) + ", " + std::to_string(y) + "]"; + } + + Vector2 operator+(const Vector2& v) const + { + return Vector2(x + v.x, y + v.y); + } + Vector2 operator-(const Vector2& v) const + { + return Vector2(x - v.x, y - v.y); + } + Vector2 operator-(float value) const + { + return Vector2(x - value, y - value); + } + Vector2 operator+(float value) const + { + return Vector2(x + value, y + value); + } + Vector2 operator*(float value) const + { + return Vector2(x * value, y * value); + } + Vector2 operator/(float value) const + { + return Vector2(x / value, y / value); + } + Vector2 operator*(const Vector2& v) const + { + return Vector2(x * v.x, y * v.y); + } + Vector2 operator/(const Vector2& v) const + { + return Vector2(x / v.x, y / v.y); + } + Vector2& operator+=(const Vector2& v) + { + x += v.x; + y += v.y; + return *this; + } + Vector2& operator-=(const Vector2& v) + { + x -= v.x; + y -= v.y; + return *this; + } + Vector2& operator*=(float v) + { + x *= v; + y *= v; + return *this; + } + Vector2& operator/=(float v) + { + x /= v; + y /= v; + return *this; + } + Vector2& operator*=(const Vector2& v) + { + x *= v.x; + y *= v.y; + return *this; + } + Vector2& operator/=(const Vector2& v) + { + x /= v.x; + y /= v.y; + return *this; + } + + friend Vector2 operator+(float f, const Vector2& v) + { + return Vector2(f + v.x, f + v.y); + } + friend Vector2 operator-(float f, const Vector2& v) + { + return Vector2(f - v.x, f - v.y); + } + friend Vector2 operator*(float f, const Vector2& v) + { + return Vector2(f * v.x, f * v.y); + } + friend Vector2 operator/(float f, const Vector2& v) + { + return Vector2(f / v.x, f / v.y); + } + +private: + float x, y; +}; + +class C1 +{}; +class C2 +{}; + +int operator+(const C1&, const C1&) +{ + return 11; +} +int operator+(const C2&, const C2&) +{ + return 22; +} +int operator+(const C2&, const C1&) +{ + return 21; +} +int operator+(const C1&, const C2&) +{ + return 12; +} + +namespace std { +template <> +struct hash<Vector2> +{ + // Not a good hash function, but easy to test + size_t operator()(const Vector2&) + { + return 4; + } +}; +} // namespace std + +// MSVC warns about unknown pragmas, and warnings are errors. +#ifndef _MSC_VER +# pragma GCC diagnostic push + // clang 7.0.0 and Apple LLVM 10.0.1 introduce `-Wself-assign-overloaded` to +// `-Wall`, which is used here for overloading (e.g. `py::self += py::self `). +// Here, we suppress the warning using `#pragma diagnostic`. +// Taken from: https://github.com/RobotLocomotion/drake/commit/aaf84b46 +// TODO(eric): This could be resolved using a function / functor (e.g. `py::self()`). +# if (__APPLE__) && (__clang__) +# if (__clang_major__ >= 10) && (__clang_minor__ >= 0) && (__clang_patchlevel__ >= 1) +# pragma GCC diagnostic ignored "-Wself-assign-overloaded" +# endif +# elif (__clang__) +# if (__clang_major__ >= 7) +# pragma GCC diagnostic ignored "-Wself-assign-overloaded" +# endif +# endif +#endif + +TEST_SUBMODULE(operators, m) +{ + + // test_operator_overloading + py::class_<Vector2>(m, "Vector2") + .def(py::init<float, float>()) + .def(py::self + py::self) + .def(py::self + float()) + .def(py::self - py::self) + .def(py::self - float()) + .def(py::self * float()) + .def(py::self / float()) + .def(py::self * py::self) + .def(py::self / py::self) + .def(py::self += py::self) + .def(py::self -= py::self) + .def(py::self *= float()) + .def(py::self /= float()) + .def(py::self *= py::self) + .def(py::self /= py::self) + .def(float() + py::self) + .def(float() - py::self) + .def(float() * py::self) + .def(float() / py::self) + .def("__str__", &Vector2::toString) + .def(hash(py::self)); + + m.attr("Vector") = m.attr("Vector2"); + + // test_operators_notimplemented + // #393: need to return NotSupported to ensure correct arithmetic operator behavior + py::class_<C1>(m, "C1").def(py::init<>()).def(py::self + py::self); + + py::class_<C2>(m, "C2") + .def(py::init<>()) + .def(py::self + py::self) + .def("__add__", [](const C2& c2, const C1& c1) { return c2 + c1; }) + .def("__radd__", [](const C2& c2, const C1& c1) { return c1 + c2; }); + + // test_nested + // #328: first member in a class can't be used in operators + struct NestABase + { + int value = -2; + }; + py::class_<NestABase>(m, "NestABase").def(py::init<>()).def_readwrite("value", &NestABase::value); + + struct NestA : NestABase + { + int value = 3; + NestA& operator+=(int i) + { + value += i; + return *this; + } + }; + py::class_<NestA>(m, "NestA") + .def(py::init<>()) + .def(py::self += int()) + .def( + "as_base", [](NestA& a) -> NestABase& { return (NestABase&)a; }, py::return_value_policy::reference_internal); + m.def("get_NestA", [](const NestA& a) { return a.value; }); + + struct NestB + { + NestA a; + int value = 4; + NestB& operator-=(int i) + { + value -= i; + return *this; + } + }; + py::class_<NestB>(m, "NestB").def(py::init<>()).def(py::self -= int()).def_readwrite("a", &NestB::a); + m.def("get_NestB", [](const NestB& b) { return b.value; }); + + struct NestC + { + NestB b; + int value = 5; + NestC& operator*=(int i) + { + value *= i; + return *this; + } + }; + py::class_<NestC>(m, "NestC").def(py::init<>()).def(py::self *= int()).def_readwrite("b", &NestC::b); + m.def("get_NestC", [](const NestC& c) { return c.value; }); +} + +#ifndef _MSC_VER +# pragma GCC diagnostic pop +#endif diff --git a/pybind11/tests/test_operator_overloading.py b/pybind11/tests/test_operator_overloading.py new file mode 100644 index 0000000000000000000000000000000000000000..9726b92dc27450cba0e4a86b0d81b649963ec9a8 --- /dev/null +++ b/pybind11/tests/test_operator_overloading.py @@ -0,0 +1,104 @@ +import pytest +from pybind11_tests import operators as m +from pybind11_tests import ConstructorStats + + +def test_operator_overloading(): + v1 = m.Vector2(1, 2) + v2 = m.Vector(3, -1) + assert str(v1) == "[1.000000, 2.000000]" + assert str(v2) == "[3.000000, -1.000000]" + + assert str(v1 + v2) == "[4.000000, 1.000000]" + assert str(v1 - v2) == "[-2.000000, 3.000000]" + assert str(v1 - 8) == "[-7.000000, -6.000000]" + assert str(v1 + 8) == "[9.000000, 10.000000]" + assert str(v1 * 8) == "[8.000000, 16.000000]" + assert str(v1 / 8) == "[0.125000, 0.250000]" + assert str(8 - v1) == "[7.000000, 6.000000]" + assert str(8 + v1) == "[9.000000, 10.000000]" + assert str(8 * v1) == "[8.000000, 16.000000]" + assert str(8 / v1) == "[8.000000, 4.000000]" + assert str(v1 * v2) == "[3.000000, -2.000000]" + assert str(v2 / v1) == "[3.000000, -0.500000]" + + v1 += 2 * v2 + assert str(v1) == "[7.000000, 0.000000]" + v1 -= v2 + assert str(v1) == "[4.000000, 1.000000]" + v1 *= 2 + assert str(v1) == "[8.000000, 2.000000]" + v1 /= 16 + assert str(v1) == "[0.500000, 0.125000]" + v1 *= v2 + assert str(v1) == "[1.500000, -0.125000]" + v2 /= v1 + assert str(v2) == "[2.000000, 8.000000]" + + assert hash(v1) == 4 + + cstats = ConstructorStats.get(m.Vector2) + assert cstats.alive() == 2 + del v1 + assert cstats.alive() == 1 + del v2 + assert cstats.alive() == 0 + assert cstats.values() == [ + '[1.000000, 2.000000]', '[3.000000, -1.000000]', '[4.000000, 1.000000]', '[-2.000000, 3.000000]', + '[-7.000000, -6.000000]', '[9.000000, 10.000000]', '[8.000000, 16.000000]', '[0.125000, 0.250000]', + '[7.000000, 6.000000]', '[9.000000, 10.000000]', '[8.000000, 16.000000]', '[8.000000, 4.000000]', + '[3.000000, -2.000000]', '[3.000000, -0.500000]', '[6.000000, -2.000000]' + ] + assert cstats.default_constructions == 0 + assert cstats.copy_constructions == 0 + assert cstats.move_constructions >= 10 + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + +def test_operators_notimplemented(): + """#393: need to return NotSupported to ensure correct arithmetic operator behavior""" + + c1, c2 = m.C1(), m.C2() + assert c1 + c1 == 11 + assert c2 + c2 == 22 + assert c2 + c1 == 21 + assert c1 + c2 == 12 + + +def test_nested(): + """#328: first member in a class can't be used in operators""" + + a = m.NestA() + b = m.NestB() + c = m.NestC() + + a += 10 + assert m.get_NestA(a) == 13 + b.a += 100 + assert m.get_NestA(b.a) == 103 + c.b.a += 1000 + assert m.get_NestA(c.b.a) == 1003 + b -= 1 + assert m.get_NestB(b) == 3 + c.b -= 3 + assert m.get_NestB(c.b) == 1 + c *= 7 + assert m.get_NestC(c) == 35 + + abase = a.as_base() + assert abase.value == -2 + a.as_base().value += 44 + assert abase.value == 42 + assert c.b.a.as_base().value == -2 + c.b.a.as_base().value += 44 + assert c.b.a.as_base().value == 42 + + del c + pytest.gc_collect() + del a # Shouldn't delete while abase is still alive + pytest.gc_collect() + + assert abase.value == 42 + del abase, b + pytest.gc_collect() diff --git a/pybind11/tests/test_pickling.cpp b/pybind11/tests/test_pickling.cpp new file mode 100644 index 0000000000000000000000000000000000000000..b5872f889080bb75444f669c681df5db7a03c45a --- /dev/null +++ b/pybind11/tests/test_pickling.cpp @@ -0,0 +1,150 @@ +/* + tests/test_pickling.cpp -- pickle support + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +TEST_SUBMODULE(pickling, m) +{ + // test_roundtrip + class Pickleable + { + public: + Pickleable(const std::string& value) + : m_value(value) + {} + const std::string& value() const + { + return m_value; + } + + void setExtra1(int extra1) + { + m_extra1 = extra1; + } + void setExtra2(int extra2) + { + m_extra2 = extra2; + } + int extra1() const + { + return m_extra1; + } + int extra2() const + { + return m_extra2; + } + + private: + std::string m_value; + int m_extra1 = 0; + int m_extra2 = 0; + }; + + class PickleableNew : public Pickleable + { + public: + using Pickleable::Pickleable; + }; + + py::class_<Pickleable>(m, "Pickleable") + .def(py::init<std::string>()) + .def("value", &Pickleable::value) + .def("extra1", &Pickleable::extra1) + .def("extra2", &Pickleable::extra2) + .def("setExtra1", &Pickleable::setExtra1) + .def("setExtra2", &Pickleable::setExtra2) + // For details on the methods below, refer to + // http://docs.python.org/3/library/pickle.html#pickling-class-instances + .def("__getstate__", + [](const Pickleable& p) { + /* Return a tuple that fully encodes the state of the object */ + return py::make_tuple(p.value(), p.extra1(), p.extra2()); + }) + .def("__setstate__", [](Pickleable& p, py::tuple t) { + if (t.size() != 3) + throw std::runtime_error("Invalid state!"); + /* Invoke the constructor (need to use in-place version) */ + new (&p) Pickleable(t[0].cast<std::string>()); + + /* Assign any additional state */ + p.setExtra1(t[1].cast<int>()); + p.setExtra2(t[2].cast<int>()); + }); + + py::class_<PickleableNew, Pickleable>(m, "PickleableNew") + .def(py::init<std::string>()) + .def(py::pickle([](const PickleableNew& p) { return py::make_tuple(p.value(), p.extra1(), p.extra2()); }, + [](py::tuple t) { + if (t.size() != 3) + throw std::runtime_error("Invalid state!"); + auto p = PickleableNew(t[0].cast<std::string>()); + + p.setExtra1(t[1].cast<int>()); + p.setExtra2(t[2].cast<int>()); + return p; + })); + +#if !defined(PYPY_VERSION) + // test_roundtrip_with_dict + class PickleableWithDict + { + public: + PickleableWithDict(const std::string& value) + : value(value) + {} + + std::string value; + int extra; + }; + + class PickleableWithDictNew : public PickleableWithDict + { + public: + using PickleableWithDict::PickleableWithDict; + }; + + py::class_<PickleableWithDict>(m, "PickleableWithDict", py::dynamic_attr()) + .def(py::init<std::string>()) + .def_readwrite("value", &PickleableWithDict::value) + .def_readwrite("extra", &PickleableWithDict::extra) + .def("__getstate__", + [](py::object self) { + /* Also include __dict__ in state */ + return py::make_tuple(self.attr("value"), self.attr("extra"), self.attr("__dict__")); + }) + .def("__setstate__", [](py::object self, py::tuple t) { + if (t.size() != 3) + throw std::runtime_error("Invalid state!"); + /* Cast and construct */ + auto& p = self.cast<PickleableWithDict&>(); + new (&p) PickleableWithDict(t[0].cast<std::string>()); + + /* Assign C++ state */ + p.extra = t[1].cast<int>(); + + /* Assign Python state */ + self.attr("__dict__") = t[2]; + }); + + py::class_<PickleableWithDictNew, PickleableWithDict>(m, "PickleableWithDictNew") + .def(py::init<std::string>()) + .def(py::pickle( + [](py::object self) { return py::make_tuple(self.attr("value"), self.attr("extra"), self.attr("__dict__")); }, + [](const py::tuple& t) { + if (t.size() != 3) + throw std::runtime_error("Invalid state!"); + + auto cpp_state = PickleableWithDictNew(t[0].cast<std::string>()); + cpp_state.extra = t[1].cast<int>(); + + auto py_state = t[2].cast<py::dict>(); + return std::make_pair(cpp_state, py_state); + })); +#endif +} diff --git a/pybind11/tests/test_pickling.py b/pybind11/tests/test_pickling.py new file mode 100644 index 0000000000000000000000000000000000000000..ce56ded8e9ea0733a497752b17ff6f8eeb5294fc --- /dev/null +++ b/pybind11/tests/test_pickling.py @@ -0,0 +1,42 @@ +import pytest +from pybind11_tests import pickling as m + +try: + import cPickle as pickle # Use cPickle on Python 2.7 +except ImportError: + import pickle + + +@pytest.mark.parametrize("cls_name", ["Pickleable", "PickleableNew"]) +def test_roundtrip(cls_name): + cls = getattr(m, cls_name) + p = cls("test_value") + p.setExtra1(15) + p.setExtra2(48) + + data = pickle.dumps(p, 2) # Must use pickle protocol >= 2 + p2 = pickle.loads(data) + assert p2.value() == p.value() + assert p2.extra1() == p.extra1() + assert p2.extra2() == p.extra2() + + +@pytest.unsupported_on_pypy +@pytest.mark.parametrize("cls_name", ["PickleableWithDict", "PickleableWithDictNew"]) +def test_roundtrip_with_dict(cls_name): + cls = getattr(m, cls_name) + p = cls("test_value") + p.extra = 15 + p.dynamic = "Attribute" + + data = pickle.dumps(p, pickle.HIGHEST_PROTOCOL) + p2 = pickle.loads(data) + assert p2.value == p.value + assert p2.extra == p.extra + assert p2.dynamic == p.dynamic + + +def test_enum_pickle(): + from pybind11_tests import enums as e + data = pickle.dumps(e.EOne, 2) + assert e.EOne == pickle.loads(data) diff --git a/pybind11/tests/test_pytypes.cpp b/pybind11/tests/test_pytypes.cpp new file mode 100644 index 0000000000000000000000000000000000000000..890f8e74146659c31dedd7e0bee2a6ded30caf61 --- /dev/null +++ b/pybind11/tests/test_pytypes.cpp @@ -0,0 +1,280 @@ +/* + tests/test_pytypes.cpp -- Python type casters + + Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + + +TEST_SUBMODULE(pytypes, m) +{ + // test_list + m.def("get_list", []() { + py::list list; + list.append("value"); + py::print("Entry at position 0:", list[0]); + list[0] = py::str("overwritten"); + return list; + }); + m.def("print_list", [](py::list list) { + int index = 0; + for (auto item : list) + py::print("list item {}: {}"_s.format(index++, item)); + }); + + // test_set + m.def("get_set", []() { + py::set set; + set.add(py::str("key1")); + set.add("key2"); + set.add(std::string("key3")); + return set; + }); + m.def("print_set", [](py::set set) { + for (auto item : set) + py::print("key:", item); + }); + + // test_dict + m.def("get_dict", []() { return py::dict("key"_a = "value"); }); + m.def("print_dict", [](py::dict dict) { + for (auto item : dict) + py::print("key: {}, value={}"_s.format(item.first, item.second)); + }); + m.def("dict_keyword_constructor", []() { + auto d1 = py::dict("x"_a = 1, "y"_a = 2); + auto d2 = py::dict("z"_a = 3, **d1); + return d2; + }); + + // test_str + m.def("str_from_string", []() { return py::str(std::string("baz")); }); + m.def("str_from_bytes", []() { return py::str(py::bytes("boo", 3)); }); + m.def("str_from_object", [](const py::object& obj) { return py::str(obj); }); + m.def("repr_from_object", [](const py::object& obj) { return py::repr(obj); }); + + m.def("str_format", []() { + auto s1 = "{} + {} = {}"_s.format(1, 2, 3); + auto s2 = "{a} + {b} = {c}"_s.format("a"_a = 1, "b"_a = 2, "c"_a = 3); + return py::make_tuple(s1, s2); + }); + + // test_bytes + m.def("bytes_from_string", []() { return py::bytes(std::string("foo")); }); + m.def("bytes_from_str", []() { return py::bytes(py::str("bar", 3)); }); + + // test_capsule + m.def("return_capsule_with_destructor", []() { + py::print("creating capsule"); + return py::capsule([]() { py::print("destructing capsule"); }); + }); + + m.def("return_capsule_with_destructor_2", []() { + py::print("creating capsule"); + return py::capsule((void*)1234, [](void* ptr) { py::print("destructing capsule: {}"_s.format((size_t)ptr)); }); + }); + + m.def("return_capsule_with_name_and_destructor", []() { + auto capsule = py::capsule((void*)1234, "pointer type description", [](PyObject* ptr) { + if (ptr) { + auto name = PyCapsule_GetName(ptr); + py::print("destructing capsule ({}, '{}')"_s.format((size_t)PyCapsule_GetPointer(ptr, name), name)); + } + }); + void* contents = capsule; + py::print("created capsule ({}, '{}')"_s.format((size_t)contents, capsule.name())); + return capsule; + }); + + // test_accessors + m.def("accessor_api", [](py::object o) { + auto d = py::dict(); + + d["basic_attr"] = o.attr("basic_attr"); + + auto l = py::list(); + for (const auto& item : o.attr("begin_end")) { + l.append(item); + } + d["begin_end"] = l; + + d["operator[object]"] = o.attr("d")["operator[object]"_s]; + d["operator[char *]"] = o.attr("d")["operator[char *]"]; + + d["attr(object)"] = o.attr("sub").attr("attr_obj"); + d["attr(char *)"] = o.attr("sub").attr("attr_char"); + try { + o.attr("sub").attr("missing").ptr(); + } catch (const py::error_already_set&) { + d["missing_attr_ptr"] = "raised"_s; + } + try { + o.attr("missing").attr("doesn't matter"); + } catch (const py::error_already_set&) { + d["missing_attr_chain"] = "raised"_s; + } + + d["is_none"] = o.attr("basic_attr").is_none(); + + d["operator()"] = o.attr("func")(1); + d["operator*"] = o.attr("func")(*o.attr("begin_end")); + + // Test implicit conversion + py::list implicit_list = o.attr("begin_end"); + d["implicit_list"] = implicit_list; + py::dict implicit_dict = o.attr("__dict__"); + d["implicit_dict"] = implicit_dict; + + return d; + }); + + m.def("tuple_accessor", [](py::tuple existing_t) { + try { + existing_t[0] = 1; + } catch (const py::error_already_set&) { + // --> Python system error + // Only new tuples (refcount == 1) are mutable + auto new_t = py::tuple(3); + for (size_t i = 0; i < new_t.size(); ++i) { + new_t[i] = i; + } + return new_t; + } + return py::tuple(); + }); + + m.def("accessor_assignment", []() { + auto l = py::list(1); + l[0] = 0; + + auto d = py::dict(); + d["get"] = l[0]; + auto var = l[0]; + d["deferred_get"] = var; + l[0] = 1; + d["set"] = l[0]; + var = 99; // this assignment should not overwrite l[0] + d["deferred_set"] = l[0]; + d["var"] = var; + + return d; + }); + + // test_constructors + m.def("default_constructors", []() { + return py::dict("str"_a = py::str(), + "bool"_a = py::bool_(), + "int"_a = py::int_(), + "float"_a = py::float_(), + "tuple"_a = py::tuple(), + "list"_a = py::list(), + "dict"_a = py::dict(), + "set"_a = py::set()); + }); + + m.def("converting_constructors", [](py::dict d) { + return py::dict("str"_a = py::str(d["str"]), + "bool"_a = py::bool_(d["bool"]), + "int"_a = py::int_(d["int"]), + "float"_a = py::float_(d["float"]), + "tuple"_a = py::tuple(d["tuple"]), + "list"_a = py::list(d["list"]), + "dict"_a = py::dict(d["dict"]), + "set"_a = py::set(d["set"]), + "memoryview"_a = py::memoryview(d["memoryview"])); + }); + + m.def("cast_functions", [](py::dict d) { + // When converting between Python types, obj.cast<T>() should be the same as T(obj) + return py::dict("str"_a = d["str"].cast<py::str>(), + "bool"_a = d["bool"].cast<py::bool_>(), + "int"_a = d["int"].cast<py::int_>(), + "float"_a = d["float"].cast<py::float_>(), + "tuple"_a = d["tuple"].cast<py::tuple>(), + "list"_a = d["list"].cast<py::list>(), + "dict"_a = d["dict"].cast<py::dict>(), + "set"_a = d["set"].cast<py::set>(), + "memoryview"_a = d["memoryview"].cast<py::memoryview>()); + }); + + m.def("get_implicit_casting", []() { + py::dict d; + d["char*_i1"] = "abc"; + const char* c2 = "abc"; + d["char*_i2"] = c2; + d["char*_e"] = py::cast(c2); + d["char*_p"] = py::str(c2); + + d["int_i1"] = 42; + int i = 42; + d["int_i2"] = i; + i++; + d["int_e"] = py::cast(i); + i++; + d["int_p"] = py::int_(i); + + d["str_i1"] = std::string("str"); + std::string s2("str1"); + d["str_i2"] = s2; + s2[3] = '2'; + d["str_e"] = py::cast(s2); + s2[3] = '3'; + d["str_p"] = py::str(s2); + + py::list l(2); + l[0] = 3; + l[1] = py::cast(6); + l.append(9); + l.append(py::cast(12)); + l.append(py::int_(15)); + + return py::dict("d"_a = d, "l"_a = l); + }); + + // test_print + m.def("print_function", []() { + py::print("Hello, World!"); + py::print(1, 2.0, "three", true, std::string("-- multiple args")); + auto args = py::make_tuple("and", "a", "custom", "separator"); + py::print("*args", *args, "sep"_a = "-"); + py::print("no new line here", "end"_a = " -- "); + py::print("next print"); + + auto py_stderr = py::module::import("sys").attr("stderr"); + py::print("this goes to stderr", "file"_a = py_stderr); + + py::print("flush", "flush"_a = true); + + py::print("{a} + {b} = {c}"_s.format("a"_a = "py::print", "b"_a = "str.format", "c"_a = "this")); + }); + + m.def("print_failure", []() { py::print(42, UnregisteredType()); }); + + m.def("hash_function", [](py::object obj) { return py::hash(obj); }); + + m.def("test_number_protocol", [](py::object a, py::object b) { + py::list l; + l.append(a.equal(b)); + l.append(a.not_equal(b)); + l.append(a < b); + l.append(a <= b); + l.append(a > b); + l.append(a >= b); + l.append(a + b); + l.append(a - b); + l.append(a * b); + l.append(a / b); + l.append(a | b); + l.append(a & b); + l.append(a ^ b); + l.append(a >> b); + l.append(a << b); + return l; + }); + + m.def("test_list_slicing", [](py::list a) { return a[py::slice(0, -1, 2)]; }); +} diff --git a/pybind11/tests/test_pytypes.py b/pybind11/tests/test_pytypes.py new file mode 100644 index 0000000000000000000000000000000000000000..ed94167dddce6ddaddc42dcdbf7889f55232d351 --- /dev/null +++ b/pybind11/tests/test_pytypes.py @@ -0,0 +1,264 @@ +from __future__ import division +import pytest +import sys + +from pybind11_tests import pytypes as m +from pybind11_tests import debug_enabled + + +def test_list(capture, doc): + with capture: + lst = m.get_list() + assert lst == ["overwritten"] + + lst.append("value2") + m.print_list(lst) + assert capture.unordered == """ + Entry at position 0: value + list item 0: overwritten + list item 1: value2 + """ + + assert doc(m.get_list) == "get_list() -> list" + assert doc(m.print_list) == "print_list(arg0: list) -> None" + + +def test_set(capture, doc): + s = m.get_set() + assert s == {"key1", "key2", "key3"} + + with capture: + s.add("key4") + m.print_set(s) + assert capture.unordered == """ + key: key1 + key: key2 + key: key3 + key: key4 + """ + + assert doc(m.get_list) == "get_list() -> list" + assert doc(m.print_list) == "print_list(arg0: list) -> None" + + +def test_dict(capture, doc): + d = m.get_dict() + assert d == {"key": "value"} + + with capture: + d["key2"] = "value2" + m.print_dict(d) + assert capture.unordered == """ + key: key, value=value + key: key2, value=value2 + """ + + assert doc(m.get_dict) == "get_dict() -> dict" + assert doc(m.print_dict) == "print_dict(arg0: dict) -> None" + + assert m.dict_keyword_constructor() == {"x": 1, "y": 2, "z": 3} + + +def test_str(doc): + assert m.str_from_string().encode().decode() == "baz" + assert m.str_from_bytes().encode().decode() == "boo" + + assert doc(m.str_from_bytes) == "str_from_bytes() -> str" + + class A(object): + + def __str__(self): + return "this is a str" + + def __repr__(self): + return "this is a repr" + + assert m.str_from_object(A()) == "this is a str" + assert m.repr_from_object(A()) == "this is a repr" + + s1, s2 = m.str_format() + assert s1 == "1 + 2 = 3" + assert s1 == s2 + + +def test_bytes(doc): + assert m.bytes_from_string().decode() == "foo" + assert m.bytes_from_str().decode() == "bar" + + assert doc(m.bytes_from_str) == "bytes_from_str() -> {}".format("bytes" if sys.version_info[0] == 3 else "str") + + +def test_capsule(capture): + pytest.gc_collect() + with capture: + a = m.return_capsule_with_destructor() + del a + pytest.gc_collect() + assert capture.unordered == """ + creating capsule + destructing capsule + """ + + with capture: + a = m.return_capsule_with_destructor_2() + del a + pytest.gc_collect() + assert capture.unordered == """ + creating capsule + destructing capsule: 1234 + """ + + with capture: + a = m.return_capsule_with_name_and_destructor() + del a + pytest.gc_collect() + assert capture.unordered == """ + created capsule (1234, 'pointer type description') + destructing capsule (1234, 'pointer type description') + """ + + +def test_accessors(): + + class SubTestObject: + attr_obj = 1 + attr_char = 2 + + class TestObject: + basic_attr = 1 + begin_end = [1, 2, 3] + d = {"operator[object]": 1, "operator[char *]": 2} + sub = SubTestObject() + + def func(self, x, *args): + return self.basic_attr + x + sum(args) + + d = m.accessor_api(TestObject()) + assert d["basic_attr"] == 1 + assert d["begin_end"] == [1, 2, 3] + assert d["operator[object]"] == 1 + assert d["operator[char *]"] == 2 + assert d["attr(object)"] == 1 + assert d["attr(char *)"] == 2 + assert d["missing_attr_ptr"] == "raised" + assert d["missing_attr_chain"] == "raised" + assert d["is_none"] is False + assert d["operator()"] == 2 + assert d["operator*"] == 7 + assert d["implicit_list"] == [1, 2, 3] + assert all(x in TestObject.__dict__ for x in d["implicit_dict"]) + + assert m.tuple_accessor(tuple()) == (0, 1, 2) + + d = m.accessor_assignment() + assert d["get"] == 0 + assert d["deferred_get"] == 0 + assert d["set"] == 1 + assert d["deferred_set"] == 1 + assert d["var"] == 99 + + +def test_constructors(): + """C++ default and converting constructors are equivalent to type calls in Python""" + types = [str, bool, int, float, tuple, list, dict, set] + expected = {t.__name__: t() for t in types} + assert m.default_constructors() == expected + + data = { + str: 42, + bool: "Not empty", + int: "42", + float: "+1e3", + tuple: range(3), + list: range(3), + dict: [("two", 2), ("one", 1), ("three", 3)], + set: [4, 4, 5, 6, 6, 6], + memoryview: b'abc' + } + inputs = {k.__name__: v for k, v in data.items()} + expected = {k.__name__: k(v) for k, v in data.items()} + + assert m.converting_constructors(inputs) == expected + assert m.cast_functions(inputs) == expected + + # Converting constructors and cast functions should just reference rather + # than copy when no conversion is needed: + noconv1 = m.converting_constructors(expected) + for k in noconv1: + assert noconv1[k] is expected[k] + + noconv2 = m.cast_functions(expected) + for k in noconv2: + assert noconv2[k] is expected[k] + + +def test_implicit_casting(): + """Tests implicit casting when assigning or appending to dicts and lists.""" + z = m.get_implicit_casting() + assert z['d'] == { + 'char*_i1': 'abc', + 'char*_i2': 'abc', + 'char*_e': 'abc', + 'char*_p': 'abc', + 'str_i1': 'str', + 'str_i2': 'str1', + 'str_e': 'str2', + 'str_p': 'str3', + 'int_i1': 42, + 'int_i2': 42, + 'int_e': 43, + 'int_p': 44 + } + assert z['l'] == [3, 6, 9, 12, 15] + + +def test_print(capture): + with capture: + m.print_function() + assert capture == """ + Hello, World! + 1 2.0 three True -- multiple args + *args-and-a-custom-separator + no new line here -- next print + flush + py::print + str.format = this + """ + assert capture.stderr == "this goes to stderr" + + with pytest.raises(RuntimeError) as excinfo: + m.print_failure() + assert str(excinfo.value) == "make_tuple(): unable to convert " + ( + "argument of type 'UnregisteredType' to Python object" + if debug_enabled else "arguments to Python object (compile in debug mode for details)") + + +def test_hash(): + + class Hashable(object): + + def __init__(self, value): + self.value = value + + def __hash__(self): + return self.value + + class Unhashable(object): + __hash__ = None + + assert m.hash_function(Hashable(42)) == 42 + with pytest.raises(TypeError): + m.hash_function(Unhashable()) + + +def test_number_protocol(): + for a, b in [(1, 1), (3, 5)]: + li = [ + a == b, a != b, a < b, a <= b, a > b, a >= b, a + b, a - b, a * b, a / b, a | b, a & b, a ^ b, a >> b, + a << b + ] + assert m.test_number_protocol(a, b) == li + + +def test_list_slicing(): + li = list(range(100)) + assert li[::2] == m.test_list_slicing(li) diff --git a/pybind11/tests/test_sequences_and_iterators.cpp b/pybind11/tests/test_sequences_and_iterators.cpp new file mode 100644 index 0000000000000000000000000000000000000000..b90dbc05efb467d2d04d28e4088c4a574e29c358 --- /dev/null +++ b/pybind11/tests/test_sequences_and_iterators.cpp @@ -0,0 +1,448 @@ +/* + tests/test_sequences_and_iterators.cpp -- supporting Pythons' sequence protocol, iterators, + etc. + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include <pybind11/operators.h> +#include <pybind11/stl.h> + +template <typename T> +class NonZeroIterator +{ + const T* ptr_; + +public: + NonZeroIterator(const T* ptr) + : ptr_(ptr) + {} + const T& operator*() const + { + return *ptr_; + } + NonZeroIterator& operator++() + { + ++ptr_; + return *this; + } +}; + +class NonZeroSentinel +{}; + +template <typename A, typename B> +bool operator==(const NonZeroIterator<std::pair<A, B>>& it, const NonZeroSentinel&) +{ + return !(*it).first || !(*it).second; +} + +template <typename PythonType> +py::list test_random_access_iterator(PythonType x) +{ + if (x.size() < 5) + throw py::value_error("Please provide at least 5 elements for testing."); + + auto checks = py::list(); + auto assert_equal = [&checks](py::handle a, py::handle b) { + auto result = PyObject_RichCompareBool(a.ptr(), b.ptr(), Py_EQ); + if (result == -1) { + throw py::error_already_set(); + } + checks.append(result != 0); + }; + + auto it = x.begin(); + assert_equal(x[0], *it); + assert_equal(x[0], it[0]); + assert_equal(x[1], it[1]); + + assert_equal(x[1], *(++it)); + assert_equal(x[1], *(it++)); + assert_equal(x[2], *it); + assert_equal(x[3], *(it += 1)); + assert_equal(x[2], *(--it)); + assert_equal(x[2], *(it--)); + assert_equal(x[1], *it); + assert_equal(x[0], *(it -= 1)); + + assert_equal(it->attr("real"), x[0].attr("real")); + assert_equal((it + 1)->attr("real"), x[1].attr("real")); + + assert_equal(x[1], *(it + 1)); + assert_equal(x[1], *(1 + it)); + it += 3; + assert_equal(x[1], *(it - 2)); + + checks.append(static_cast<std::size_t>(x.end() - x.begin()) == x.size()); + checks.append((x.begin() + static_cast<std::ptrdiff_t>(x.size())) == x.end()); + checks.append(x.begin() < x.end()); + + return checks; +} + +TEST_SUBMODULE(sequences_and_iterators, m) +{ + // test_sliceable + class Sliceable + { + public: + Sliceable(int n) + : size(n) + {} + int start, stop, step; + int size; + }; + py::class_<Sliceable>(m, "Sliceable") + .def(py::init<int>()) + .def("__getitem__", [](const Sliceable& s, py::slice slice) { + ssize_t start, stop, step, slicelength; + if (!slice.compute(s.size, &start, &stop, &step, &slicelength)) + throw py::error_already_set(); + int istart = static_cast<int>(start); + int istop = static_cast<int>(stop); + int istep = static_cast<int>(step); + return std::make_tuple(istart, istop, istep); + }); + + // test_sequence + class Sequence + { + public: + Sequence(size_t size) + : m_size(size) + { + print_created(this, "of size", m_size); + m_data = new float[size]; + memset(m_data, 0, sizeof(float) * size); + } + Sequence(const std::vector<float>& value) + : m_size(value.size()) + { + print_created(this, "of size", m_size, "from std::vector"); + m_data = new float[m_size]; + memcpy(m_data, &value[0], sizeof(float) * m_size); + } + Sequence(const Sequence& s) + : m_size(s.m_size) + { + print_copy_created(this); + m_data = new float[m_size]; + memcpy(m_data, s.m_data, sizeof(float) * m_size); + } + Sequence(Sequence&& s) + : m_size(s.m_size) + , m_data(s.m_data) + { + print_move_created(this); + s.m_size = 0; + s.m_data = nullptr; + } + + ~Sequence() + { + print_destroyed(this); + delete[] m_data; + } + + Sequence& operator=(const Sequence& s) + { + if (&s != this) { + delete[] m_data; + m_size = s.m_size; + m_data = new float[m_size]; + memcpy(m_data, s.m_data, sizeof(float) * m_size); + } + print_copy_assigned(this); + return *this; + } + + Sequence& operator=(Sequence&& s) + { + if (&s != this) { + delete[] m_data; + m_size = s.m_size; + m_data = s.m_data; + s.m_size = 0; + s.m_data = nullptr; + } + print_move_assigned(this); + return *this; + } + + bool operator==(const Sequence& s) const + { + if (m_size != s.size()) + return false; + for (size_t i = 0; i < m_size; ++i) + if (m_data[i] != s[i]) + return false; + return true; + } + bool operator!=(const Sequence& s) const + { + return !operator==(s); + } + + float operator[](size_t index) const + { + return m_data[index]; + } + float& operator[](size_t index) + { + return m_data[index]; + } + + bool contains(float v) const + { + for (size_t i = 0; i < m_size; ++i) + if (v == m_data[i]) + return true; + return false; + } + + Sequence reversed() const + { + Sequence result(m_size); + for (size_t i = 0; i < m_size; ++i) + result[m_size - i - 1] = m_data[i]; + return result; + } + + size_t size() const + { + return m_size; + } + + const float* begin() const + { + return m_data; + } + const float* end() const + { + return m_data + m_size; + } + + private: + size_t m_size; + float* m_data; + }; + py::class_<Sequence>(m, "Sequence") + .def(py::init<size_t>()) + .def(py::init<const std::vector<float>&>()) + /// Bare bones interface + .def("__getitem__", + [](const Sequence& s, size_t i) { + if (i >= s.size()) + throw py::index_error(); + return s[i]; + }) + .def("__setitem__", + [](Sequence& s, size_t i, float v) { + if (i >= s.size()) + throw py::index_error(); + s[i] = v; + }) + .def("__len__", &Sequence::size) + /// Optional sequence protocol operations + .def("__iter__", + [](const Sequence& s) { return py::make_iterator(s.begin(), s.end()); }, + py::keep_alive<0, 1>() /* Essential: keep object alive while iterator exists */) + .def("__contains__", [](const Sequence& s, float v) { return s.contains(v); }) + .def("__reversed__", [](const Sequence& s) -> Sequence { return s.reversed(); }) + /// Slicing protocol (optional) + .def("__getitem__", + [](const Sequence& s, py::slice slice) -> Sequence* { + size_t start, stop, step, slicelength; + if (!slice.compute(s.size(), &start, &stop, &step, &slicelength)) + throw py::error_already_set(); + Sequence* seq = new Sequence(slicelength); + for (size_t i = 0; i < slicelength; ++i) { + (*seq)[i] = s[start]; + start += step; + } + return seq; + }) + .def("__setitem__", + [](Sequence& s, py::slice slice, const Sequence& value) { + size_t start, stop, step, slicelength; + if (!slice.compute(s.size(), &start, &stop, &step, &slicelength)) + throw py::error_already_set(); + if (slicelength != value.size()) + throw std::runtime_error("Left and right hand size of slice assignment have different sizes!"); + for (size_t i = 0; i < slicelength; ++i) { + s[start] = value[i]; + start += step; + } + }) + /// Comparisons + .def(py::self == py::self) + .def(py::self != py::self) + // Could also define py::self + py::self for concatenation, etc. + ; + + // test_map_iterator + // Interface of a map-like object that isn't (directly) an unordered_map, but provides some basic + // map-like functionality. + class StringMap + { + public: + StringMap() = default; + StringMap(std::unordered_map<std::string, std::string> init) + : map(std::move(init)) + {} + + void set(std::string key, std::string val) + { + map[key] = val; + } + std::string get(std::string key) const + { + return map.at(key); + } + size_t size() const + { + return map.size(); + } + + private: + std::unordered_map<std::string, std::string> map; + + public: + decltype(map.cbegin()) begin() const + { + return map.cbegin(); + } + decltype(map.cend()) end() const + { + return map.cend(); + } + }; + py::class_<StringMap>(m, "StringMap") + .def(py::init<>()) + .def(py::init<std::unordered_map<std::string, std::string>>()) + .def("__getitem__", + [](const StringMap& map, std::string key) { + try { + return map.get(key); + } catch (const std::out_of_range&) { + throw py::key_error("key '" + key + "' does not exist"); + } + }) + .def("__setitem__", &StringMap::set) + .def("__len__", &StringMap::size) + .def("__iter__", + [](const StringMap& map) { return py::make_key_iterator(map.begin(), map.end()); }, + py::keep_alive<0, 1>()) + .def("items", + [](const StringMap& map) { return py::make_iterator(map.begin(), map.end()); }, + py::keep_alive<0, 1>()); + + // test_generalized_iterators + class IntPairs + { + public: + IntPairs(std::vector<std::pair<int, int>> data) + : data_(std::move(data)) + {} + const std::pair<int, int>* begin() const + { + return data_.data(); + } + + private: + std::vector<std::pair<int, int>> data_; + }; + py::class_<IntPairs>(m, "IntPairs") + .def(py::init<std::vector<std::pair<int, int>>>()) + .def("nonzero", + [](const IntPairs& s) { + return py::make_iterator(NonZeroIterator<std::pair<int, int>>(s.begin()), NonZeroSentinel()); + }, + py::keep_alive<0, 1>()) + .def("nonzero_keys", + [](const IntPairs& s) { + return py::make_key_iterator(NonZeroIterator<std::pair<int, int>>(s.begin()), NonZeroSentinel()); + }, + py::keep_alive<0, 1>()); + + +#if 0 + // Obsolete: special data structure for exposing custom iterator types to python + // kept here for illustrative purposes because there might be some use cases which + // are not covered by the much simpler py::make_iterator + + struct PySequenceIterator { + PySequenceIterator(const Sequence &seq, py::object ref) : seq(seq), ref(ref) { } + + float next() { + if (index == seq.size()) + throw py::stop_iteration(); + return seq[index++]; + } + + const Sequence &seq; + py::object ref; // keep a reference + size_t index = 0; + }; + + py::class_<PySequenceIterator>(seq, "Iterator") + .def("__iter__", [](PySequenceIterator &it) -> PySequenceIterator& { return it; }) + .def("__next__", &PySequenceIterator::next); + + On the actual Sequence object, the iterator would be constructed as follows: + .def("__iter__", [](py::object s) { return PySequenceIterator(s.cast<const Sequence &>(), s); }) +#endif + + // test_python_iterator_in_cpp + m.def("object_to_list", [](py::object o) { + auto l = py::list(); + for (auto item : o) { + l.append(item); + } + return l; + }); + + m.def("iterator_to_list", [](py::iterator it) { + auto l = py::list(); + while (it != py::iterator::sentinel()) { + l.append(*it); + ++it; + } + return l; + }); + + // Make sure that py::iterator works with std algorithms + m.def("count_none", + [](py::object o) { return std::count_if(o.begin(), o.end(), [](py::handle h) { return h.is_none(); }); }); + + m.def("find_none", [](py::object o) { + auto it = std::find_if(o.begin(), o.end(), [](py::handle h) { return h.is_none(); }); + return it->is_none(); + }); + + m.def("count_nonzeros", [](py::dict d) { + return std::count_if( + d.begin(), d.end(), [](std::pair<py::handle, py::handle> p) { return p.second.cast<int>() != 0; }); + }); + + m.def("tuple_iterator", &test_random_access_iterator<py::tuple>); + m.def("list_iterator", &test_random_access_iterator<py::list>); + m.def("sequence_iterator", &test_random_access_iterator<py::sequence>); + + // test_iterator_passthrough + // #181: iterator passthrough did not compile + m.def("iterator_passthrough", + [](py::iterator s) -> py::iterator { return py::make_iterator(std::begin(s), std::end(s)); }); + + // test_iterator_rvp + // #388: Can't make iterators via make_iterator() with different r/v policies + static std::vector<int> list = {1, 2, 3}; + m.def("make_iterator_1", []() { return py::make_iterator<py::return_value_policy::copy>(list); }); + m.def("make_iterator_2", []() { return py::make_iterator<py::return_value_policy::automatic>(list); }); +} diff --git a/pybind11/tests/test_sequences_and_iterators.py b/pybind11/tests/test_sequences_and_iterators.py new file mode 100644 index 0000000000000000000000000000000000000000..7a54901637fcf5c533701f205595acfb827e0784 --- /dev/null +++ b/pybind11/tests/test_sequences_and_iterators.py @@ -0,0 +1,171 @@ +import pytest +from pybind11_tests import sequences_and_iterators as m +from pybind11_tests import ConstructorStats + + +def isclose(a, b, rel_tol=1e-05, abs_tol=0.0): + """Like math.isclose() from Python 3.5""" + return abs(a - b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol) + + +def allclose(a_list, b_list, rel_tol=1e-05, abs_tol=0.0): + return all(isclose(a, b, rel_tol=rel_tol, abs_tol=abs_tol) for a, b in zip(a_list, b_list)) + + +def test_generalized_iterators(): + assert list(m.IntPairs([(1, 2), (3, 4), (0, 5)]).nonzero()) == [(1, 2), (3, 4)] + assert list(m.IntPairs([(1, 2), (2, 0), (0, 3), (4, 5)]).nonzero()) == [(1, 2)] + assert list(m.IntPairs([(0, 3), (1, 2), (3, 4)]).nonzero()) == [] + + assert list(m.IntPairs([(1, 2), (3, 4), (0, 5)]).nonzero_keys()) == [1, 3] + assert list(m.IntPairs([(1, 2), (2, 0), (0, 3), (4, 5)]).nonzero_keys()) == [1] + assert list(m.IntPairs([(0, 3), (1, 2), (3, 4)]).nonzero_keys()) == [] + + # __next__ must continue to raise StopIteration + it = m.IntPairs([(0, 0)]).nonzero() + for _ in range(3): + with pytest.raises(StopIteration): + next(it) + + it = m.IntPairs([(0, 0)]).nonzero_keys() + for _ in range(3): + with pytest.raises(StopIteration): + next(it) + + +def test_sliceable(): + sliceable = m.Sliceable(100) + assert sliceable[::] == (0, 100, 1) + assert sliceable[10::] == (10, 100, 1) + assert sliceable[:10:] == (0, 10, 1) + assert sliceable[::10] == (0, 100, 10) + assert sliceable[-10::] == (90, 100, 1) + assert sliceable[:-10:] == (0, 90, 1) + assert sliceable[::-10] == (99, -1, -10) + assert sliceable[50:60:1] == (50, 60, 1) + assert sliceable[50:60:-1] == (50, 60, -1) + + +def test_sequence(): + cstats = ConstructorStats.get(m.Sequence) + + s = m.Sequence(5) + assert cstats.values() == ['of size', '5'] + + assert "Sequence" in repr(s) + assert len(s) == 5 + assert s[0] == 0 and s[3] == 0 + assert 12.34 not in s + s[0], s[3] = 12.34, 56.78 + assert 12.34 in s + assert isclose(s[0], 12.34) and isclose(s[3], 56.78) + + rev = reversed(s) + assert cstats.values() == ['of size', '5'] + + rev2 = s[::-1] + assert cstats.values() == ['of size', '5'] + + it = iter(m.Sequence(0)) + for _ in range(3): # __next__ must continue to raise StopIteration + with pytest.raises(StopIteration): + next(it) + assert cstats.values() == ['of size', '0'] + + expected = [0, 56.78, 0, 0, 12.34] + assert allclose(rev, expected) + assert allclose(rev2, expected) + assert rev == rev2 + + rev[0::2] = m.Sequence([2.0, 2.0, 2.0]) + assert cstats.values() == ['of size', '3', 'from std::vector'] + + assert allclose(rev, [2, 56.78, 2, 0, 2]) + + assert cstats.alive() == 4 + del it + assert cstats.alive() == 3 + del s + assert cstats.alive() == 2 + del rev + assert cstats.alive() == 1 + del rev2 + assert cstats.alive() == 0 + + assert cstats.values() == [] + assert cstats.default_constructions == 0 + assert cstats.copy_constructions == 0 + assert cstats.move_constructions >= 1 + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + +def test_map_iterator(): + sm = m.StringMap({'hi': 'bye', 'black': 'white'}) + assert sm['hi'] == 'bye' + assert len(sm) == 2 + assert sm['black'] == 'white' + + with pytest.raises(KeyError): + assert sm['orange'] + sm['orange'] = 'banana' + assert sm['orange'] == 'banana' + + expected = {'hi': 'bye', 'black': 'white', 'orange': 'banana'} + for k in sm: + assert sm[k] == expected[k] + for k, v in sm.items(): + assert v == expected[k] + + it = iter(m.StringMap({})) + for _ in range(3): # __next__ must continue to raise StopIteration + with pytest.raises(StopIteration): + next(it) + + +def test_python_iterator_in_cpp(): + t = (1, 2, 3) + assert m.object_to_list(t) == [1, 2, 3] + assert m.object_to_list(iter(t)) == [1, 2, 3] + assert m.iterator_to_list(iter(t)) == [1, 2, 3] + + with pytest.raises(TypeError) as excinfo: + m.object_to_list(1) + assert "object is not iterable" in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + m.iterator_to_list(1) + assert "incompatible function arguments" in str(excinfo.value) + + def bad_next_call(): + raise RuntimeError("py::iterator::advance() should propagate errors") + + with pytest.raises(RuntimeError) as excinfo: + m.iterator_to_list(iter(bad_next_call, None)) + assert str(excinfo.value) == "py::iterator::advance() should propagate errors" + + lst = [1, None, 0, None] + assert m.count_none(lst) == 2 + assert m.find_none(lst) is True + assert m.count_nonzeros({"a": 0, "b": 1, "c": 2}) == 2 + + r = range(5) + assert all(m.tuple_iterator(tuple(r))) + assert all(m.list_iterator(list(r))) + assert all(m.sequence_iterator(r)) + + +def test_iterator_passthrough(): + """#181: iterator passthrough did not compile""" + from pybind11_tests.sequences_and_iterators import iterator_passthrough + + assert list(iterator_passthrough(iter([3, 5, 7, 9, 11, 13, 15]))) == [3, 5, 7, 9, 11, 13, 15] + + +def test_iterator_rvp(): + """#388: Can't make iterators via make_iterator() with different r/v policies """ + import pybind11_tests.sequences_and_iterators as m + + assert list(m.make_iterator_1()) == [1, 2, 3] + assert list(m.make_iterator_2()) == [1, 2, 3] + assert not isinstance(m.make_iterator_1(), type(m.make_iterator_2())) diff --git a/pybind11/tests/test_smart_ptr.cpp b/pybind11/tests/test_smart_ptr.cpp new file mode 100644 index 0000000000000000000000000000000000000000..1ef6a701bd5e999d7d4a748c4fa29a5599fc6e52 --- /dev/null +++ b/pybind11/tests/test_smart_ptr.cpp @@ -0,0 +1,551 @@ +/* + tests/test_smart_ptr.cpp -- binding classes with custom reference counting, + implicit conversions between types + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#if defined(_MSC_VER) && _MSC_VER < 1910 +# pragma warning(disable : 4702) // unreachable code in system header +#endif + +#include "pybind11_tests.h" +#include "object.h" + +// Make pybind aware of the ref-counted wrapper type (s): + +// ref<T> is a wrapper for 'Object' which uses intrusive reference counting +// It is always possible to construct a ref<T> from an Object* pointer without +// possible inconsistencies, hence the 'true' argument at the end. +PYBIND11_DECLARE_HOLDER_TYPE(T, ref<T>, true); +// Make pybind11 aware of the non-standard getter member function +namespace pybind11 { +namespace detail { +template <typename T> +struct holder_helper<ref<T>> +{ + static const T* get(const ref<T>& p) + { + return p.get_ptr(); + } +}; +} // namespace detail +} // namespace pybind11 + +// The following is not required anymore for std::shared_ptr, but it should compile without error: +PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr<T>); + +// This is just a wrapper around unique_ptr, but with extra fields to deliberately bloat up the +// holder size to trigger the non-simple-layout internal instance layout for single inheritance with +// large holder type: +template <typename T> +class huge_unique_ptr +{ + std::unique_ptr<T> ptr; + uint64_t padding[10]; + +public: + huge_unique_ptr(T* p) + : ptr(p){}; + T* get() + { + return ptr.get(); + } +}; +PYBIND11_DECLARE_HOLDER_TYPE(T, huge_unique_ptr<T>); + +// Simple custom holder that works like unique_ptr +template <typename T> +class custom_unique_ptr +{ + std::unique_ptr<T> impl; + +public: + custom_unique_ptr(T* p) + : impl(p) + {} + T* get() const + { + return impl.get(); + } + T* release_ptr() + { + return impl.release(); + } +}; +PYBIND11_DECLARE_HOLDER_TYPE(T, custom_unique_ptr<T>); + +// Simple custom holder that works like shared_ptr and has operator& overload +// To obtain address of an instance of this holder pybind should use std::addressof +// Attempt to get address via operator& may leads to segmentation fault +template <typename T> +class shared_ptr_with_addressof_operator +{ + std::shared_ptr<T> impl; + +public: + shared_ptr_with_addressof_operator() = default; + shared_ptr_with_addressof_operator(T* p) + : impl(p) + {} + T* get() const + { + return impl.get(); + } + T** operator&() + { + throw std::logic_error("Call of overloaded operator& is not expected"); + } +}; +PYBIND11_DECLARE_HOLDER_TYPE(T, shared_ptr_with_addressof_operator<T>); + +// Simple custom holder that works like unique_ptr and has operator& overload +// To obtain address of an instance of this holder pybind should use std::addressof +// Attempt to get address via operator& may leads to segmentation fault +template <typename T> +class unique_ptr_with_addressof_operator +{ + std::unique_ptr<T> impl; + +public: + unique_ptr_with_addressof_operator() = default; + unique_ptr_with_addressof_operator(T* p) + : impl(p) + {} + T* get() const + { + return impl.get(); + } + T* release_ptr() + { + return impl.release(); + } + T** operator&() + { + throw std::logic_error("Call of overloaded operator& is not expected"); + } +}; +PYBIND11_DECLARE_HOLDER_TYPE(T, unique_ptr_with_addressof_operator<T>); + + +TEST_SUBMODULE(smart_ptr, m) +{ + + // test_smart_ptr + + // Object implementation in `object.h` + py::class_<Object, ref<Object>> obj(m, "Object"); + obj.def("getRefCount", &Object::getRefCount); + + // Custom object with builtin reference counting (see 'object.h' for the implementation) + class MyObject1 : public Object + { + public: + MyObject1(int value) + : value(value) + { + print_created(this, toString()); + } + std::string toString() const + { + return "MyObject1[" + std::to_string(value) + "]"; + } + + protected: + virtual ~MyObject1() + { + print_destroyed(this); + } + + private: + int value; + }; + py::class_<MyObject1, ref<MyObject1>>(m, "MyObject1", obj).def(py::init<int>()); + py::implicitly_convertible<py::int_, MyObject1>(); + + m.def("make_object_1", []() -> Object* { return new MyObject1(1); }); + m.def("make_object_2", []() -> ref<Object> { return new MyObject1(2); }); + m.def("make_myobject1_1", []() -> MyObject1* { return new MyObject1(4); }); + m.def("make_myobject1_2", []() -> ref<MyObject1> { return new MyObject1(5); }); + m.def("print_object_1", [](const Object* obj) { py::print(obj->toString()); }); + m.def("print_object_2", [](ref<Object> obj) { py::print(obj->toString()); }); + m.def("print_object_3", [](const ref<Object>& obj) { py::print(obj->toString()); }); + m.def("print_object_4", [](const ref<Object>* obj) { py::print((*obj)->toString()); }); + m.def("print_myobject1_1", [](const MyObject1* obj) { py::print(obj->toString()); }); + m.def("print_myobject1_2", [](ref<MyObject1> obj) { py::print(obj->toString()); }); + m.def("print_myobject1_3", [](const ref<MyObject1>& obj) { py::print(obj->toString()); }); + m.def("print_myobject1_4", [](const ref<MyObject1>* obj) { py::print((*obj)->toString()); }); + + // Expose constructor stats for the ref type + m.def("cstats_ref", &ConstructorStats::get<ref_tag>); + + + // Object managed by a std::shared_ptr<> + class MyObject2 + { + public: + MyObject2(const MyObject2&) = default; + MyObject2(int value) + : value(value) + { + print_created(this, toString()); + } + std::string toString() const + { + return "MyObject2[" + std::to_string(value) + "]"; + } + virtual ~MyObject2() + { + print_destroyed(this); + } + + private: + int value; + }; + py::class_<MyObject2, std::shared_ptr<MyObject2>>(m, "MyObject2").def(py::init<int>()); + m.def("make_myobject2_1", []() { return new MyObject2(6); }); + m.def("make_myobject2_2", []() { return std::make_shared<MyObject2>(7); }); + m.def("print_myobject2_1", [](const MyObject2* obj) { py::print(obj->toString()); }); + m.def("print_myobject2_2", [](std::shared_ptr<MyObject2> obj) { py::print(obj->toString()); }); + m.def("print_myobject2_3", [](const std::shared_ptr<MyObject2>& obj) { py::print(obj->toString()); }); + m.def("print_myobject2_4", [](const std::shared_ptr<MyObject2>* obj) { py::print((*obj)->toString()); }); + + // Object managed by a std::shared_ptr<>, additionally derives from std::enable_shared_from_this<> + class MyObject3 : public std::enable_shared_from_this<MyObject3> + { + public: + MyObject3(const MyObject3&) = default; + MyObject3(int value) + : value(value) + { + print_created(this, toString()); + } + std::string toString() const + { + return "MyObject3[" + std::to_string(value) + "]"; + } + virtual ~MyObject3() + { + print_destroyed(this); + } + + private: + int value; + }; + py::class_<MyObject3, std::shared_ptr<MyObject3>>(m, "MyObject3").def(py::init<int>()); + m.def("make_myobject3_1", []() { return new MyObject3(8); }); + m.def("make_myobject3_2", []() { return std::make_shared<MyObject3>(9); }); + m.def("print_myobject3_1", [](const MyObject3* obj) { py::print(obj->toString()); }); + m.def("print_myobject3_2", [](std::shared_ptr<MyObject3> obj) { py::print(obj->toString()); }); + m.def("print_myobject3_3", [](const std::shared_ptr<MyObject3>& obj) { py::print(obj->toString()); }); + m.def("print_myobject3_4", [](const std::shared_ptr<MyObject3>* obj) { py::print((*obj)->toString()); }); + + // test_smart_ptr_refcounting + m.def("test_object1_refcounting", []() { + ref<MyObject1> o = new MyObject1(0); + bool good = o->getRefCount() == 1; + py::object o2 = py::cast(o, py::return_value_policy::reference); + // always request (partial) ownership for objects with intrusive + // reference counting even when using the 'reference' RVP + good &= o->getRefCount() == 2; + return good; + }); + + // test_unique_nodelete + // Object with a private destructor + class MyObject4 + { + public: + MyObject4(int value) + : value{value} + { + print_created(this); + } + int value; + + private: + ~MyObject4() + { + print_destroyed(this); + } + }; + py::class_<MyObject4, std::unique_ptr<MyObject4, py::nodelete>>(m, "MyObject4") + .def(py::init<int>()) + .def_readwrite("value", &MyObject4::value); + + // test_unique_deleter + // Object with std::unique_ptr<T, D> where D is not matching the base class + // Object with a protected destructor + class MyObject4a + { + public: + MyObject4a(int i) + { + value = i; + print_created(this); + }; + int value; + + protected: + virtual ~MyObject4a() + { + print_destroyed(this); + } + }; + py::class_<MyObject4a, std::unique_ptr<MyObject4a, py::nodelete>>(m, "MyObject4a") + .def(py::init<int>()) + .def_readwrite("value", &MyObject4a::value); + + // Object derived but with public destructor and no Deleter in default holder + class MyObject4b : public MyObject4a + { + public: + MyObject4b(int i) + : MyObject4a(i) + { + print_created(this); + } + ~MyObject4b() + { + print_destroyed(this); + } + }; + py::class_<MyObject4b, MyObject4a>(m, "MyObject4b").def(py::init<int>()); + + // test_large_holder + class MyObject5 + { // managed by huge_unique_ptr + public: + MyObject5(int value) + : value{value} + { + print_created(this); + } + ~MyObject5() + { + print_destroyed(this); + } + int value; + }; + py::class_<MyObject5, huge_unique_ptr<MyObject5>>(m, "MyObject5") + .def(py::init<int>()) + .def_readwrite("value", &MyObject5::value); + + // test_shared_ptr_and_references + struct SharedPtrRef + { + struct A + { + A() + { + print_created(this); + } + A(const A&) + { + print_copy_created(this); + } + A(A&&) + { + print_move_created(this); + } + ~A() + { + print_destroyed(this); + } + }; + + A value = {}; + std::shared_ptr<A> shared = std::make_shared<A>(); + }; + using A = SharedPtrRef::A; + py::class_<A, std::shared_ptr<A>>(m, "A"); + py::class_<SharedPtrRef>(m, "SharedPtrRef") + .def(py::init<>()) + .def_readonly("ref", &SharedPtrRef::value) + .def_property_readonly("copy", [](const SharedPtrRef& s) { return s.value; }, py::return_value_policy::copy) + .def_readonly("holder_ref", &SharedPtrRef::shared) + .def_property_readonly( + "holder_copy", [](const SharedPtrRef& s) { return s.shared; }, py::return_value_policy::copy) + .def("set_ref", [](SharedPtrRef&, const A&) { return true; }) + .def("set_holder", [](SharedPtrRef&, std::shared_ptr<A>) { return true; }); + + // test_shared_ptr_from_this_and_references + struct SharedFromThisRef + { + struct B : std::enable_shared_from_this<B> + { + B() + { + print_created(this); + } + B(const B&) + : std::enable_shared_from_this<B>() + { + print_copy_created(this); + } + B(B&&) + : std::enable_shared_from_this<B>() + { + print_move_created(this); + } + ~B() + { + print_destroyed(this); + } + }; + + B value = {}; + std::shared_ptr<B> shared = std::make_shared<B>(); + }; + using B = SharedFromThisRef::B; + py::class_<B, std::shared_ptr<B>>(m, "B"); + py::class_<SharedFromThisRef>(m, "SharedFromThisRef") + .def(py::init<>()) + .def_readonly("bad_wp", &SharedFromThisRef::value) + .def_property_readonly("ref", [](const SharedFromThisRef& s) -> const B& { return *s.shared; }) + .def_property_readonly("copy", [](const SharedFromThisRef& s) { return s.value; }, py::return_value_policy::copy) + .def_readonly("holder_ref", &SharedFromThisRef::shared) + .def_property_readonly( + "holder_copy", [](const SharedFromThisRef& s) { return s.shared; }, py::return_value_policy::copy) + .def("set_ref", [](SharedFromThisRef&, const B&) { return true; }) + .def("set_holder", [](SharedFromThisRef&, std::shared_ptr<B>) { return true; }); + + // Issue #865: shared_from_this doesn't work with virtual inheritance + struct SharedFromThisVBase : std::enable_shared_from_this<SharedFromThisVBase> + { + SharedFromThisVBase() = default; + SharedFromThisVBase(const SharedFromThisVBase&) = default; + virtual ~SharedFromThisVBase() = default; + }; + struct SharedFromThisVirt : virtual SharedFromThisVBase + {}; + static std::shared_ptr<SharedFromThisVirt> sft(new SharedFromThisVirt()); + py::class_<SharedFromThisVirt, std::shared_ptr<SharedFromThisVirt>>(m, "SharedFromThisVirt").def_static("get", []() { + return sft.get(); + }); + + // test_move_only_holder + struct C + { + C() + { + print_created(this); + } + ~C() + { + print_destroyed(this); + } + }; + py::class_<C, custom_unique_ptr<C>>(m, "TypeWithMoveOnlyHolder").def_static("make", []() { + return custom_unique_ptr<C>(new C); + }); + + // test_holder_with_addressof_operator + struct TypeForHolderWithAddressOf + { + TypeForHolderWithAddressOf() + { + print_created(this); + } + TypeForHolderWithAddressOf(const TypeForHolderWithAddressOf&) + { + print_copy_created(this); + } + TypeForHolderWithAddressOf(TypeForHolderWithAddressOf&&) + { + print_move_created(this); + } + ~TypeForHolderWithAddressOf() + { + print_destroyed(this); + } + std::string toString() const + { + return "TypeForHolderWithAddressOf[" + std::to_string(value) + "]"; + } + int value = 42; + }; + using HolderWithAddressOf = shared_ptr_with_addressof_operator<TypeForHolderWithAddressOf>; + py::class_<TypeForHolderWithAddressOf, HolderWithAddressOf>(m, "TypeForHolderWithAddressOf") + .def_static("make", []() { return HolderWithAddressOf(new TypeForHolderWithAddressOf); }) + .def("get", [](const HolderWithAddressOf& self) { return self.get(); }) + .def("print_object_1", [](const TypeForHolderWithAddressOf* obj) { py::print(obj->toString()); }) + .def("print_object_2", [](HolderWithAddressOf obj) { py::print(obj.get()->toString()); }) + .def("print_object_3", [](const HolderWithAddressOf& obj) { py::print(obj.get()->toString()); }) + .def("print_object_4", [](const HolderWithAddressOf* obj) { py::print((*obj).get()->toString()); }); + + // test_move_only_holder_with_addressof_operator + struct TypeForMoveOnlyHolderWithAddressOf + { + TypeForMoveOnlyHolderWithAddressOf(int value) + : value{value} + { + print_created(this); + } + ~TypeForMoveOnlyHolderWithAddressOf() + { + print_destroyed(this); + } + std::string toString() const + { + return "MoveOnlyHolderWithAddressOf[" + std::to_string(value) + "]"; + } + int value; + }; + using MoveOnlyHolderWithAddressOf = unique_ptr_with_addressof_operator<TypeForMoveOnlyHolderWithAddressOf>; + py::class_<TypeForMoveOnlyHolderWithAddressOf, MoveOnlyHolderWithAddressOf>(m, "TypeForMoveOnlyHolderWithAddressOf") + .def_static("make", []() { return MoveOnlyHolderWithAddressOf(new TypeForMoveOnlyHolderWithAddressOf(0)); }) + .def_readwrite("value", &TypeForMoveOnlyHolderWithAddressOf::value) + .def("print_object", [](const TypeForMoveOnlyHolderWithAddressOf* obj) { py::print(obj->toString()); }); + + // test_smart_ptr_from_default + struct HeldByDefaultHolder + {}; + py::class_<HeldByDefaultHolder>(m, "HeldByDefaultHolder") + .def(py::init<>()) + .def_static("load_shared_ptr", [](std::shared_ptr<HeldByDefaultHolder>) {}); + + // test_shared_ptr_gc + // #187: issue involving std::shared_ptr<> return value policy & garbage collection + struct ElementBase + { + virtual ~ElementBase() {} /* Force creation of virtual table */ + }; + py::class_<ElementBase, std::shared_ptr<ElementBase>>(m, "ElementBase"); + + struct ElementA : ElementBase + { + ElementA(int v) + : v(v) + {} + int value() + { + return v; + } + int v; + }; + py::class_<ElementA, ElementBase, std::shared_ptr<ElementA>>(m, "ElementA") + .def(py::init<int>()) + .def("value", &ElementA::value); + + struct ElementList + { + void add(std::shared_ptr<ElementBase> e) + { + l.push_back(e); + } + std::vector<std::shared_ptr<ElementBase>> l; + }; + py::class_<ElementList, std::shared_ptr<ElementList>>(m, "ElementList") + .def(py::init<>()) + .def("add", &ElementList::add) + .def("get", [](ElementList& el) { + py::list list; + for (auto& e : el.l) + list.append(py::cast(e)); + return list; + }); +} diff --git a/pybind11/tests/test_smart_ptr.py b/pybind11/tests/test_smart_ptr.py new file mode 100644 index 0000000000000000000000000000000000000000..346835b9bd2325efe548daae089f820fe317c358 --- /dev/null +++ b/pybind11/tests/test_smart_ptr.py @@ -0,0 +1,284 @@ +import pytest +from pybind11_tests import smart_ptr as m +from pybind11_tests import ConstructorStats + + +def test_smart_ptr(capture): + # Object1 + for i, o in enumerate([m.make_object_1(), m.make_object_2(), m.MyObject1(3)], start=1): + assert o.getRefCount() == 1 + with capture: + m.print_object_1(o) + m.print_object_2(o) + m.print_object_3(o) + m.print_object_4(o) + assert capture == "MyObject1[{i}]\n".format(i=i) * 4 + + for i, o in enumerate([m.make_myobject1_1(), m.make_myobject1_2(), m.MyObject1(6), 7], start=4): + print(o) + with capture: + if not isinstance(o, int): + m.print_object_1(o) + m.print_object_2(o) + m.print_object_3(o) + m.print_object_4(o) + m.print_myobject1_1(o) + m.print_myobject1_2(o) + m.print_myobject1_3(o) + m.print_myobject1_4(o) + assert capture == "MyObject1[{i}]\n".format(i=i) * (4 if isinstance(o, int) else 8) + + cstats = ConstructorStats.get(m.MyObject1) + assert cstats.alive() == 0 + expected_values = ['MyObject1[{}]'.format(i) for i in range(1, 7)] + ['MyObject1[7]'] * 4 + assert cstats.values() == expected_values + assert cstats.default_constructions == 0 + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Doesn't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + # Object2 + for i, o in zip([8, 6, 7], [m.MyObject2(8), m.make_myobject2_1(), m.make_myobject2_2()]): + print(o) + with capture: + m.print_myobject2_1(o) + m.print_myobject2_2(o) + m.print_myobject2_3(o) + m.print_myobject2_4(o) + assert capture == "MyObject2[{i}]\n".format(i=i) * 4 + + cstats = ConstructorStats.get(m.MyObject2) + assert cstats.alive() == 1 + o = None + assert cstats.alive() == 0 + assert cstats.values() == ['MyObject2[8]', 'MyObject2[6]', 'MyObject2[7]'] + assert cstats.default_constructions == 0 + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Doesn't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + # Object3 + for i, o in zip([9, 8, 9], [m.MyObject3(9), m.make_myobject3_1(), m.make_myobject3_2()]): + print(o) + with capture: + m.print_myobject3_1(o) + m.print_myobject3_2(o) + m.print_myobject3_3(o) + m.print_myobject3_4(o) + assert capture == "MyObject3[{i}]\n".format(i=i) * 4 + + cstats = ConstructorStats.get(m.MyObject3) + assert cstats.alive() == 1 + o = None + assert cstats.alive() == 0 + assert cstats.values() == ['MyObject3[9]', 'MyObject3[8]', 'MyObject3[9]'] + assert cstats.default_constructions == 0 + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Doesn't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + # Object + cstats = ConstructorStats.get(m.Object) + assert cstats.alive() == 0 + assert cstats.values() == [] + assert cstats.default_constructions == 10 + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Doesn't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + # ref<> + cstats = m.cstats_ref() + assert cstats.alive() == 0 + assert cstats.values() == ['from pointer'] * 10 + assert cstats.default_constructions == 30 + assert cstats.copy_constructions == 12 + # assert cstats.move_constructions >= 0 # Doesn't invoke any + assert cstats.copy_assignments == 30 + assert cstats.move_assignments == 0 + + +def test_smart_ptr_refcounting(): + assert m.test_object1_refcounting() + + +def test_unique_nodelete(): + o = m.MyObject4(23) + assert o.value == 23 + cstats = ConstructorStats.get(m.MyObject4) + assert cstats.alive() == 1 + del o + assert cstats.alive() == 1 # Leak, but that's intentional + + +def test_unique_nodelete4a(): + o = m.MyObject4a(23) + assert o.value == 23 + cstats = ConstructorStats.get(m.MyObject4a) + assert cstats.alive() == 1 + del o + assert cstats.alive() == 1 # Leak, but that's intentional + + +def test_unique_deleter(): + o = m.MyObject4b(23) + assert o.value == 23 + cstats4a = ConstructorStats.get(m.MyObject4a) + assert cstats4a.alive() == 2 # Two because of previous test + cstats4b = ConstructorStats.get(m.MyObject4b) + assert cstats4b.alive() == 1 + del o + assert cstats4a.alive() == 1 # Should now only be one leftover from previous test + assert cstats4b.alive() == 0 # Should be deleted + + +def test_large_holder(): + o = m.MyObject5(5) + assert o.value == 5 + cstats = ConstructorStats.get(m.MyObject5) + assert cstats.alive() == 1 + del o + assert cstats.alive() == 0 + + +def test_shared_ptr_and_references(): + s = m.SharedPtrRef() + stats = ConstructorStats.get(m.A) + assert stats.alive() == 2 + + ref = s.ref # init_holder_helper(holder_ptr=false, owned=false) + assert stats.alive() == 2 + assert s.set_ref(ref) + with pytest.raises(RuntimeError) as excinfo: + assert s.set_holder(ref) + assert "Unable to cast from non-held to held instance" in str(excinfo.value) + + copy = s.copy # init_holder_helper(holder_ptr=false, owned=true) + assert stats.alive() == 3 + assert s.set_ref(copy) + assert s.set_holder(copy) + + holder_ref = s.holder_ref # init_holder_helper(holder_ptr=true, owned=false) + assert stats.alive() == 3 + assert s.set_ref(holder_ref) + assert s.set_holder(holder_ref) + + holder_copy = s.holder_copy # init_holder_helper(holder_ptr=true, owned=true) + assert stats.alive() == 3 + assert s.set_ref(holder_copy) + assert s.set_holder(holder_copy) + + del ref, copy, holder_ref, holder_copy, s + assert stats.alive() == 0 + + +def test_shared_ptr_from_this_and_references(): + s = m.SharedFromThisRef() + stats = ConstructorStats.get(m.B) + assert stats.alive() == 2 + + ref = s.ref # init_holder_helper(holder_ptr=false, owned=false, bad_wp=false) + assert stats.alive() == 2 + assert s.set_ref(ref) + assert s.set_holder(ref) # std::enable_shared_from_this can create a holder from a reference + + bad_wp = s.bad_wp # init_holder_helper(holder_ptr=false, owned=false, bad_wp=true) + assert stats.alive() == 2 + assert s.set_ref(bad_wp) + with pytest.raises(RuntimeError) as excinfo: + assert s.set_holder(bad_wp) + assert "Unable to cast from non-held to held instance" in str(excinfo.value) + + copy = s.copy # init_holder_helper(holder_ptr=false, owned=true, bad_wp=false) + assert stats.alive() == 3 + assert s.set_ref(copy) + assert s.set_holder(copy) + + holder_ref = s.holder_ref # init_holder_helper(holder_ptr=true, owned=false, bad_wp=false) + assert stats.alive() == 3 + assert s.set_ref(holder_ref) + assert s.set_holder(holder_ref) + + holder_copy = s.holder_copy # init_holder_helper(holder_ptr=true, owned=true, bad_wp=false) + assert stats.alive() == 3 + assert s.set_ref(holder_copy) + assert s.set_holder(holder_copy) + + del ref, bad_wp, copy, holder_ref, holder_copy, s + assert stats.alive() == 0 + + z = m.SharedFromThisVirt.get() + y = m.SharedFromThisVirt.get() + assert y is z + + +def test_move_only_holder(): + a = m.TypeWithMoveOnlyHolder.make() + stats = ConstructorStats.get(m.TypeWithMoveOnlyHolder) + assert stats.alive() == 1 + del a + assert stats.alive() == 0 + + +def test_holder_with_addressof_operator(): + # this test must not throw exception from c++ + a = m.TypeForHolderWithAddressOf.make() + a.print_object_1() + a.print_object_2() + a.print_object_3() + a.print_object_4() + + stats = ConstructorStats.get(m.TypeForHolderWithAddressOf) + assert stats.alive() == 1 + + np = m.TypeForHolderWithAddressOf.make() + assert stats.alive() == 2 + del a + assert stats.alive() == 1 + del np + assert stats.alive() == 0 + + b = m.TypeForHolderWithAddressOf.make() + c = b + assert b.get() is c.get() + assert stats.alive() == 1 + + del b + assert stats.alive() == 1 + + del c + assert stats.alive() == 0 + + +def test_move_only_holder_with_addressof_operator(): + a = m.TypeForMoveOnlyHolderWithAddressOf.make() + a.print_object() + + stats = ConstructorStats.get(m.TypeForMoveOnlyHolderWithAddressOf) + assert stats.alive() == 1 + + a.value = 42 + assert a.value == 42 + + del a + assert stats.alive() == 0 + + +def test_smart_ptr_from_default(): + instance = m.HeldByDefaultHolder() + with pytest.raises(RuntimeError) as excinfo: + m.HeldByDefaultHolder.load_shared_ptr(instance) + assert "Unable to load a custom holder type from a default-holder instance" in str(excinfo) + + +def test_shared_ptr_gc(): + """#187: issue involving std::shared_ptr<> return value policy & garbage collection""" + el = m.ElementList() + for i in range(10): + el.add(m.ElementA(i)) + pytest.gc_collect() + for i, v in enumerate(el.get()): + assert i == v.value() diff --git a/pybind11/tests/test_stl.cpp b/pybind11/tests/test_stl.cpp new file mode 100644 index 0000000000000000000000000000000000000000..018d7300729a1e55604198d2408983077a4faabe --- /dev/null +++ b/pybind11/tests/test_stl.cpp @@ -0,0 +1,316 @@ +/* + tests/test_stl.cpp -- STL type casters + + Copyright (c) 2017 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include <pybind11/stl.h> + +#include <vector> +#include <string> + +// Test with `std::variant` in C++17 mode, or with `boost::variant` in C++11/14 +#if PYBIND11_HAS_VARIANT +using std::variant; +#elif defined(PYBIND11_TEST_BOOST) && (!defined(_MSC_VER) || _MSC_VER >= 1910) +# include <boost/variant.hpp> +# define PYBIND11_HAS_VARIANT 1 +using boost::variant; + +namespace pybind11 { +namespace detail { +template <typename... Ts> +struct type_caster<boost::variant<Ts...>> : variant_caster<boost::variant<Ts...>> +{}; + +template <> +struct visit_helper<boost::variant> +{ + template <typename... Args> + static auto call(Args&&... args) -> decltype(boost::apply_visitor(args...)) + { + return boost::apply_visitor(args...); + } +}; +} // namespace detail +} // namespace pybind11 +#endif + +PYBIND11_MAKE_OPAQUE(std::vector<std::string, std::allocator<std::string>>); + +/// Issue #528: templated constructor +struct TplCtorClass +{ + template <typename T> + TplCtorClass(const T&) + {} + bool operator==(const TplCtorClass&) const + { + return true; + } +}; + +namespace std { +template <> +struct hash<TplCtorClass> +{ + size_t operator()(const TplCtorClass&) const + { + return 0; + } +}; +} // namespace std + + +TEST_SUBMODULE(stl, m) +{ + // test_vector + m.def("cast_vector", []() { return std::vector<int>{1}; }); + m.def("load_vector", [](const std::vector<int>& v) { return v.at(0) == 1 && v.at(1) == 2; }); + // `std::vector<bool>` is special because it returns proxy objects instead of references + m.def("cast_bool_vector", []() { return std::vector<bool>{true, false}; }); + m.def("load_bool_vector", [](const std::vector<bool>& v) { return v.at(0) == true && v.at(1) == false; }); + // Unnumbered regression (caused by #936): pointers to stl containers aren't castable + static std::vector<RValueCaster> lvv{2}; + m.def("cast_ptr_vector", []() { return &lvv; }); + + // test_deque + m.def("cast_deque", []() { return std::deque<int>{1}; }); + m.def("load_deque", [](const std::deque<int>& v) { return v.at(0) == 1 && v.at(1) == 2; }); + + // test_array + m.def("cast_array", []() { return std::array<int, 2>{{1, 2}}; }); + m.def("load_array", [](const std::array<int, 2>& a) { return a[0] == 1 && a[1] == 2; }); + + // test_valarray + m.def("cast_valarray", []() { return std::valarray<int>{1, 4, 9}; }); + m.def("load_valarray", + [](const std::valarray<int>& v) { return v.size() == 3 && v[0] == 1 && v[1] == 4 && v[2] == 9; }); + + // test_map + m.def("cast_map", []() { return std::map<std::string, std::string>{{"key", "value"}}; }); + m.def("load_map", [](const std::map<std::string, std::string>& map) { + return map.at("key") == "value" && map.at("key2") == "value2"; + }); + + // test_set + m.def("cast_set", []() { return std::set<std::string>{"key1", "key2"}; }); + m.def("load_set", + [](const std::set<std::string>& set) { return set.count("key1") && set.count("key2") && set.count("key3"); }); + + // test_recursive_casting + m.def("cast_rv_vector", []() { return std::vector<RValueCaster>{2}; }); + m.def("cast_rv_array", []() { return std::array<RValueCaster, 3>(); }); + // NB: map and set keys are `const`, so while we technically do move them (as `const Type &&`), + // casters don't typically do anything with that, which means they fall to the `const Type &` + // caster. + m.def("cast_rv_map", []() { return std::unordered_map<std::string, RValueCaster>{{"a", RValueCaster{}}}; }); + m.def("cast_rv_nested", []() { + std::vector<std::array<std::list<std::unordered_map<std::string, RValueCaster>>, 2>> v; + v.emplace_back(); // add an array + v.back()[0].emplace_back(); // add a map to the array + v.back()[0].back().emplace("b", RValueCaster{}); + v.back()[0].back().emplace("c", RValueCaster{}); + v.back()[1].emplace_back(); // add a map to the array + v.back()[1].back().emplace("a", RValueCaster{}); + return v; + }); + static std::array<RValueCaster, 2> lva; + static std::unordered_map<std::string, RValueCaster> lvm{{"a", RValueCaster{}}, {"b", RValueCaster{}}}; + static std::unordered_map<std::string, std::vector<std::list<std::array<RValueCaster, 2>>>> lvn; + lvn["a"].emplace_back(); // add a list + lvn["a"].back().emplace_back(); // add an array + lvn["a"].emplace_back(); // another list + lvn["a"].back().emplace_back(); // add an array + lvn["b"].emplace_back(); // add a list + lvn["b"].back().emplace_back(); // add an array + lvn["b"].back().emplace_back(); // add another array + m.def("cast_lv_vector", []() -> const decltype(lvv)& { return lvv; }); + m.def("cast_lv_array", []() -> const decltype(lva)& { return lva; }); + m.def("cast_lv_map", []() -> const decltype(lvm)& { return lvm; }); + m.def("cast_lv_nested", []() -> const decltype(lvn)& { return lvn; }); + // #853: + m.def("cast_unique_ptr_vector", []() { + std::vector<std::unique_ptr<UserType>> v; + v.emplace_back(new UserType{7}); + v.emplace_back(new UserType{42}); + return v; + }); + + // test_move_out_container + struct MoveOutContainer + { + struct Value + { + int value; + }; + std::list<Value> move_list() const + { + return {{0}, {1}, {2}}; + } + }; + py::class_<MoveOutContainer::Value>(m, "MoveOutContainerValue") + .def_readonly("value", &MoveOutContainer::Value::value); + py::class_<MoveOutContainer>(m, "MoveOutContainer") + .def(py::init<>()) + .def_property_readonly("move_list", &MoveOutContainer::move_list); + + // Class that can be move- and copy-constructed, but not assigned + struct NoAssign + { + int value; + + explicit NoAssign(int value = 0) + : value(value) + {} + NoAssign(const NoAssign&) = default; + NoAssign(NoAssign&&) = default; + + NoAssign& operator=(const NoAssign&) = delete; + NoAssign& operator=(NoAssign&&) = delete; + }; + py::class_<NoAssign>(m, "NoAssign", "Class with no C++ assignment operators").def(py::init<>()).def(py::init<int>()); + +#ifdef PYBIND11_HAS_OPTIONAL + // test_optional + m.attr("has_optional") = true; + + using opt_int = std::optional<int>; + using opt_no_assign = std::optional<NoAssign>; + m.def("double_or_zero", [](const opt_int& x) -> int { return x.value_or(0) * 2; }); + m.def("half_or_none", [](int x) -> opt_int { return x ? opt_int(x / 2) : opt_int(); }); + m.def("test_nullopt", [](opt_int x) { return x.value_or(42); }, py::arg_v("x", std::nullopt, "None")); + m.def( + "test_no_assign", [](const opt_no_assign& x) { return x ? x->value : 42; }, py::arg_v("x", std::nullopt, "None")); + + m.def("nodefer_none_optional", [](std::optional<int>) { return true; }); + m.def("nodefer_none_optional", [](py::none) { return false; }); +#endif + +#ifdef PYBIND11_HAS_EXP_OPTIONAL + // test_exp_optional + m.attr("has_exp_optional") = true; + + using exp_opt_int = std::experimental::optional<int>; + using exp_opt_no_assign = std::experimental::optional<NoAssign>; + m.def("double_or_zero_exp", [](const exp_opt_int& x) -> int { return x.value_or(0) * 2; }); + m.def("half_or_none_exp", [](int x) -> exp_opt_int { return x ? exp_opt_int(x / 2) : exp_opt_int(); }); + m.def("test_nullopt_exp", + [](exp_opt_int x) { return x.value_or(42); }, + py::arg_v("x", std::experimental::nullopt, "None")); + m.def("test_no_assign_exp", + [](const exp_opt_no_assign& x) { return x ? x->value : 42; }, + py::arg_v("x", std::experimental::nullopt, "None")); +#endif + +#ifdef PYBIND11_HAS_VARIANT + static_assert(std::is_same<py::detail::variant_caster_visitor::result_type, py::handle>::value, + "visitor::result_type is required by boost::variant in C++11 mode"); + + struct visitor + { + using result_type = const char*; + + result_type operator()(int) + { + return "int"; + } + result_type operator()(std::string) + { + return "std::string"; + } + result_type operator()(double) + { + return "double"; + } + result_type operator()(std::nullptr_t) + { + return "std::nullptr_t"; + } + }; + + // test_variant + m.def("load_variant", [](variant<int, std::string, double, std::nullptr_t> v) { + return py::detail::visit_helper<variant>::call(visitor(), v); + }); + m.def("load_variant_2pass", + [](variant<double, int> v) { return py::detail::visit_helper<variant>::call(visitor(), v); }); + m.def("cast_variant", []() { + using V = variant<int, std::string>; + return py::make_tuple(V(5), V("Hello")); + }); +#endif + + // #528: templated constructor + // (no python tests: the test here is that this compiles) + m.def("tpl_ctor_vector", [](std::vector<TplCtorClass>&) {}); + m.def("tpl_ctor_map", [](std::unordered_map<TplCtorClass, TplCtorClass>&) {}); + m.def("tpl_ctor_set", [](std::unordered_set<TplCtorClass>&) {}); +#if defined(PYBIND11_HAS_OPTIONAL) + m.def("tpl_constr_optional", [](std::optional<TplCtorClass>&) {}); +#elif defined(PYBIND11_HAS_EXP_OPTIONAL) + m.def("tpl_constr_optional", [](std::experimental::optional<TplCtorClass>&) {}); +#endif + + // test_vec_of_reference_wrapper + // #171: Can't return STL structures containing reference wrapper + m.def("return_vec_of_reference_wrapper", [](std::reference_wrapper<UserType> p4) { + static UserType p1{1}, p2{2}, p3{3}; + return std::vector<std::reference_wrapper<UserType>>{std::ref(p1), std::ref(p2), std::ref(p3), p4}; + }); + + // test_stl_pass_by_pointer + m.def("stl_pass_by_pointer", [](std::vector<int>* v) { return *v; }, "v"_a = nullptr); + + // #1258: pybind11/stl.h converts string to vector<string> + m.def("func_with_string_or_vector_string_arg_overload", [](std::vector<std::string>) { return 1; }); + m.def("func_with_string_or_vector_string_arg_overload", [](std::list<std::string>) { return 2; }); + m.def("func_with_string_or_vector_string_arg_overload", [](std::string) { return 3; }); + + class Placeholder + { + public: + Placeholder() + { + print_created(this); + } + Placeholder(const Placeholder&) = delete; + ~Placeholder() + { + print_destroyed(this); + } + }; + py::class_<Placeholder>(m, "Placeholder"); + + /// test_stl_vector_ownership + m.def("test_stl_ownership", + []() { + std::vector<Placeholder*> result; + result.push_back(new Placeholder()); + return result; + }, + py::return_value_policy::take_ownership); + + m.def("array_cast_sequence", [](std::array<int, 3> x) { return x; }); + + /// test_issue_1561 + struct Issue1561Inner + { + std::string data; + }; + struct Issue1561Outer + { + std::vector<Issue1561Inner> list; + }; + + py::class_<Issue1561Inner>(m, "Issue1561Inner") + .def(py::init<std::string>()) + .def_readwrite("data", &Issue1561Inner::data); + + py::class_<Issue1561Outer>(m, "Issue1561Outer").def(py::init<>()).def_readwrite("list", &Issue1561Outer::list); +} diff --git a/pybind11/tests/test_stl.py b/pybind11/tests/test_stl.py new file mode 100644 index 0000000000000000000000000000000000000000..68d5396291e8fb2b9463003cdf90155733258cd4 --- /dev/null +++ b/pybind11/tests/test_stl.py @@ -0,0 +1,244 @@ +import pytest + +from pybind11_tests import stl as m +from pybind11_tests import UserType +from pybind11_tests import ConstructorStats + + +def test_vector(doc): + """std::vector <-> list""" + lst = m.cast_vector() + assert lst == [1] + lst.append(2) + assert m.load_vector(lst) + assert m.load_vector(tuple(lst)) + + assert m.cast_bool_vector() == [True, False] + assert m.load_bool_vector([True, False]) + + assert doc(m.cast_vector) == "cast_vector() -> List[int]" + assert doc(m.load_vector) == "load_vector(arg0: List[int]) -> bool" + + # Test regression caused by 936: pointers to stl containers weren't castable + assert m.cast_ptr_vector() == ["lvalue", "lvalue"] + + +def test_deque(doc): + """std::deque <-> list""" + lst = m.cast_deque() + assert lst == [1] + lst.append(2) + assert m.load_deque(lst) + assert m.load_deque(tuple(lst)) + + +def test_array(doc): + """std::array <-> list""" + lst = m.cast_array() + assert lst == [1, 2] + assert m.load_array(lst) + + assert doc(m.cast_array) == "cast_array() -> List[int[2]]" + assert doc(m.load_array) == "load_array(arg0: List[int[2]]) -> bool" + + +def test_valarray(doc): + """std::valarray <-> list""" + lst = m.cast_valarray() + assert lst == [1, 4, 9] + assert m.load_valarray(lst) + + assert doc(m.cast_valarray) == "cast_valarray() -> List[int]" + assert doc(m.load_valarray) == "load_valarray(arg0: List[int]) -> bool" + + +def test_map(doc): + """std::map <-> dict""" + d = m.cast_map() + assert d == {"key": "value"} + assert "key" in d + d["key2"] = "value2" + assert "key2" in d + assert m.load_map(d) + + assert doc(m.cast_map) == "cast_map() -> Dict[str, str]" + assert doc(m.load_map) == "load_map(arg0: Dict[str, str]) -> bool" + + +def test_set(doc): + """std::set <-> set""" + s = m.cast_set() + assert s == {"key1", "key2"} + s.add("key3") + assert m.load_set(s) + + assert doc(m.cast_set) == "cast_set() -> Set[str]" + assert doc(m.load_set) == "load_set(arg0: Set[str]) -> bool" + + +def test_recursive_casting(): + """Tests that stl casters preserve lvalue/rvalue context for container values""" + assert m.cast_rv_vector() == ["rvalue", "rvalue"] + assert m.cast_lv_vector() == ["lvalue", "lvalue"] + assert m.cast_rv_array() == ["rvalue", "rvalue", "rvalue"] + assert m.cast_lv_array() == ["lvalue", "lvalue"] + assert m.cast_rv_map() == {"a": "rvalue"} + assert m.cast_lv_map() == {"a": "lvalue", "b": "lvalue"} + assert m.cast_rv_nested() == [[[{"b": "rvalue", "c": "rvalue"}], [{"a": "rvalue"}]]] + assert m.cast_lv_nested() == { + "a": [[["lvalue", "lvalue"]], [["lvalue", "lvalue"]]], + "b": [[["lvalue", "lvalue"], ["lvalue", "lvalue"]]] + } + + # Issue #853 test case: + z = m.cast_unique_ptr_vector() + assert z[0].value == 7 and z[1].value == 42 + + +def test_move_out_container(): + """Properties use the `reference_internal` policy by default. If the underlying function + returns an rvalue, the policy is automatically changed to `move` to avoid referencing + a temporary. In case the return value is a container of user-defined types, the policy + also needs to be applied to the elements, not just the container.""" + c = m.MoveOutContainer() + moved_out_list = c.move_list + assert [x.value for x in moved_out_list] == [0, 1, 2] + + +@pytest.mark.skipif(not hasattr(m, "has_optional"), reason='no <optional>') +def test_optional(): + assert m.double_or_zero(None) == 0 + assert m.double_or_zero(42) == 84 + pytest.raises(TypeError, m.double_or_zero, 'foo') + + assert m.half_or_none(0) is None + assert m.half_or_none(42) == 21 + pytest.raises(TypeError, m.half_or_none, 'foo') + + assert m.test_nullopt() == 42 + assert m.test_nullopt(None) == 42 + assert m.test_nullopt(42) == 42 + assert m.test_nullopt(43) == 43 + + assert m.test_no_assign() == 42 + assert m.test_no_assign(None) == 42 + assert m.test_no_assign(m.NoAssign(43)) == 43 + pytest.raises(TypeError, m.test_no_assign, 43) + + assert m.nodefer_none_optional(None) + + +@pytest.mark.skipif(not hasattr(m, "has_exp_optional"), reason='no <experimental/optional>') +def test_exp_optional(): + assert m.double_or_zero_exp(None) == 0 + assert m.double_or_zero_exp(42) == 84 + pytest.raises(TypeError, m.double_or_zero_exp, 'foo') + + assert m.half_or_none_exp(0) is None + assert m.half_or_none_exp(42) == 21 + pytest.raises(TypeError, m.half_or_none_exp, 'foo') + + assert m.test_nullopt_exp() == 42 + assert m.test_nullopt_exp(None) == 42 + assert m.test_nullopt_exp(42) == 42 + assert m.test_nullopt_exp(43) == 43 + + assert m.test_no_assign_exp() == 42 + assert m.test_no_assign_exp(None) == 42 + assert m.test_no_assign_exp(m.NoAssign(43)) == 43 + pytest.raises(TypeError, m.test_no_assign_exp, 43) + + +@pytest.mark.skipif(not hasattr(m, "load_variant"), reason='no <variant>') +def test_variant(doc): + assert m.load_variant(1) == "int" + assert m.load_variant("1") == "std::string" + assert m.load_variant(1.0) == "double" + assert m.load_variant(None) == "std::nullptr_t" + + assert m.load_variant_2pass(1) == "int" + assert m.load_variant_2pass(1.0) == "double" + + assert m.cast_variant() == (5, "Hello") + + assert doc(m.load_variant) == "load_variant(arg0: Union[int, str, float, None]) -> str" + + +def test_vec_of_reference_wrapper(): + """#171: Can't return reference wrappers (or STL structures containing them)""" + assert str(m.return_vec_of_reference_wrapper(UserType(4))) == \ + "[UserType(1), UserType(2), UserType(3), UserType(4)]" + + +def test_stl_pass_by_pointer(msg): + """Passing nullptr or None to an STL container pointer is not expected to work""" + with pytest.raises(TypeError) as excinfo: + m.stl_pass_by_pointer() # default value is `nullptr` + assert msg(excinfo.value) == """ + stl_pass_by_pointer(): incompatible function arguments. The following argument types are supported: + 1. (v: List[int] = None) -> List[int] + + Invoked with: + """ # noqa: E501 line too long + + with pytest.raises(TypeError) as excinfo: + m.stl_pass_by_pointer(None) + assert msg(excinfo.value) == """ + stl_pass_by_pointer(): incompatible function arguments. The following argument types are supported: + 1. (v: List[int] = None) -> List[int] + + Invoked with: None + """ # noqa: E501 line too long + + assert m.stl_pass_by_pointer([1, 2, 3]) == [1, 2, 3] + + +def test_missing_header_message(): + """Trying convert `list` to a `std::vector`, or vice versa, without including + <pybind11/stl.h> should result in a helpful suggestion in the error message""" + import pybind11_cross_module_tests as cm + + expected_message = ("Did you forget to `#include <pybind11/stl.h>`? Or <pybind11/complex.h>,\n" + "<pybind11/functional.h>, <pybind11/chrono.h>, etc. Some automatic\n" + "conversions are optional and require extra headers to be included\n" + "when compiling your pybind11 module.") + + with pytest.raises(TypeError) as excinfo: + cm.missing_header_arg([1.0, 2.0, 3.0]) + assert expected_message in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + cm.missing_header_return() + assert expected_message in str(excinfo.value) + + +def test_function_with_string_and_vector_string_arg(): + """Check if a string is NOT implicitly converted to a list, which was the + behavior before fix of issue #1258""" + assert m.func_with_string_or_vector_string_arg_overload(( + 'A', + 'B', + )) == 2 + assert m.func_with_string_or_vector_string_arg_overload(['A', 'B']) == 2 + assert m.func_with_string_or_vector_string_arg_overload('A') == 3 + + +def test_stl_ownership(): + cstats = ConstructorStats.get(m.Placeholder) + assert cstats.alive() == 0 + r = m.test_stl_ownership() + assert len(r) == 1 + del r + assert cstats.alive() == 0 + + +def test_array_cast_sequence(): + assert m.array_cast_sequence((1, 2, 3)) == [1, 2, 3] + + +def test_issue_1561(): + """ check fix for issue #1561 """ + bar = m.Issue1561Outer() + bar.list = [m.Issue1561Inner('bar')] + bar.list + assert bar.list[0].data == 'bar' diff --git a/pybind11/tests/test_stl_binders.cpp b/pybind11/tests/test_stl_binders.cpp new file mode 100644 index 0000000000000000000000000000000000000000..69620d1bf5a3560a9e0f497bfb6eb81fa3b7082c --- /dev/null +++ b/pybind11/tests/test_stl_binders.cpp @@ -0,0 +1,130 @@ +/* + tests/test_stl_binders.cpp -- Usage of stl_binders functions + + Copyright (c) 2016 Sergey Lyskov + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +#include <pybind11/stl_bind.h> +#include <pybind11/numpy.h> +#include <map> +#include <deque> +#include <unordered_map> + +class El +{ +public: + El() = delete; + El(int v) + : a(v) + {} + + int a; +}; + +std::ostream& operator<<(std::ostream& s, El const& v) +{ + s << "El{" << v.a << '}'; + return s; +} + +/// Issue #487: binding std::vector<E> with E non-copyable +class E_nc +{ +public: + explicit E_nc(int i) + : value{i} + {} + E_nc(const E_nc&) = delete; + E_nc& operator=(const E_nc&) = delete; + E_nc(E_nc&&) = default; + E_nc& operator=(E_nc&&) = default; + + int value; +}; + +template <class Container> +Container* one_to_n(int n) +{ + auto v = new Container(); + for (int i = 1; i <= n; i++) + v->emplace_back(i); + return v; +} + +template <class Map> +Map* times_ten(int n) +{ + auto m = new Map(); + for (int i = 1; i <= n; i++) + m->emplace(int(i), E_nc(10 * i)); + return m; +} + +TEST_SUBMODULE(stl_binders, m) +{ + // test_vector_int + py::bind_vector<std::vector<unsigned int>>(m, "VectorInt", py::buffer_protocol()); + + // test_vector_custom + py::class_<El>(m, "El").def(py::init<int>()); + py::bind_vector<std::vector<El>>(m, "VectorEl"); + py::bind_vector<std::vector<std::vector<El>>>(m, "VectorVectorEl"); + + // test_map_string_double + py::bind_map<std::map<std::string, double>>(m, "MapStringDouble"); + py::bind_map<std::unordered_map<std::string, double>>(m, "UnorderedMapStringDouble"); + + // test_map_string_double_const + py::bind_map<std::map<std::string, double const>>(m, "MapStringDoubleConst"); + py::bind_map<std::unordered_map<std::string, double const>>(m, "UnorderedMapStringDoubleConst"); + + py::class_<E_nc>(m, "ENC").def(py::init<int>()).def_readwrite("value", &E_nc::value); + + // test_noncopyable_containers + py::bind_vector<std::vector<E_nc>>(m, "VectorENC"); + m.def("get_vnc", &one_to_n<std::vector<E_nc>>, py::return_value_policy::reference); + py::bind_vector<std::deque<E_nc>>(m, "DequeENC"); + m.def("get_dnc", &one_to_n<std::deque<E_nc>>, py::return_value_policy::reference); + py::bind_map<std::map<int, E_nc>>(m, "MapENC"); + m.def("get_mnc", ×_ten<std::map<int, E_nc>>, py::return_value_policy::reference); + py::bind_map<std::unordered_map<int, E_nc>>(m, "UmapENC"); + m.def("get_umnc", ×_ten<std::unordered_map<int, E_nc>>, py::return_value_policy::reference); + + // test_vector_buffer + py::bind_vector<std::vector<unsigned char>>(m, "VectorUChar", py::buffer_protocol()); + // no dtype declared for this version: + struct VUndeclStruct + { + bool w; + uint32_t x; + double y; + bool z; + }; + m.def("create_undeclstruct", + [m]() mutable { py::bind_vector<std::vector<VUndeclStruct>>(m, "VectorUndeclStruct", py::buffer_protocol()); }); + + // The rest depends on numpy: + try { + py::module::import("numpy"); + } catch (...) { + return; + } + + // test_vector_buffer_numpy + struct VStruct + { + bool w; + uint32_t x; + double y; + bool z; + }; + PYBIND11_NUMPY_DTYPE(VStruct, w, x, y, z); + py::class_<VStruct>(m, "VStruct").def_readwrite("x", &VStruct::x); + py::bind_vector<std::vector<VStruct>>(m, "VectorStruct", py::buffer_protocol()); + m.def("get_vectorstruct", [] { return std::vector<VStruct>{{0, 5, 3.0, 1}, {1, 30, -1e4, 0}}; }); +} diff --git a/pybind11/tests/test_stl_binders.py b/pybind11/tests/test_stl_binders.py new file mode 100644 index 0000000000000000000000000000000000000000..e368e668608df21a332ad423a6f178bbbb4084df --- /dev/null +++ b/pybind11/tests/test_stl_binders.py @@ -0,0 +1,225 @@ +import pytest +import sys +from pybind11_tests import stl_binders as m + +with pytest.suppress(ImportError): + import numpy as np + + +def test_vector_int(): + v_int = m.VectorInt([0, 0]) + assert len(v_int) == 2 + assert bool(v_int) is True + + # test construction from a generator + v_int1 = m.VectorInt(x for x in range(5)) + assert v_int1 == m.VectorInt([0, 1, 2, 3, 4]) + + v_int2 = m.VectorInt([0, 0]) + assert v_int == v_int2 + v_int2[1] = 1 + assert v_int != v_int2 + + v_int2.append(2) + v_int2.insert(0, 1) + v_int2.insert(0, 2) + v_int2.insert(0, 3) + v_int2.insert(6, 3) + assert str(v_int2) == "VectorInt[3, 2, 1, 0, 1, 2, 3]" + with pytest.raises(IndexError): + v_int2.insert(8, 4) + + v_int.append(99) + v_int2[2:-2] = v_int + assert v_int2 == m.VectorInt([3, 2, 0, 0, 99, 2, 3]) + del v_int2[1:3] + assert v_int2 == m.VectorInt([3, 0, 99, 2, 3]) + del v_int2[0] + assert v_int2 == m.VectorInt([0, 99, 2, 3]) + + v_int2.extend(m.VectorInt([4, 5])) + assert v_int2 == m.VectorInt([0, 99, 2, 3, 4, 5]) + + v_int2.extend([6, 7]) + assert v_int2 == m.VectorInt([0, 99, 2, 3, 4, 5, 6, 7]) + + # test error handling, and that the vector is unchanged + with pytest.raises(RuntimeError): + v_int2.extend([8, 'a']) + + assert v_int2 == m.VectorInt([0, 99, 2, 3, 4, 5, 6, 7]) + + # test extending from a generator + v_int2.extend(x for x in range(5)) + assert v_int2 == m.VectorInt([0, 99, 2, 3, 4, 5, 6, 7, 0, 1, 2, 3, 4]) + + +# related to the PyPy's buffer protocol. +@pytest.unsupported_on_pypy +def test_vector_buffer(): + b = bytearray([1, 2, 3, 4]) + v = m.VectorUChar(b) + assert v[1] == 2 + v[2] = 5 + mv = memoryview(v) # We expose the buffer interface + if sys.version_info.major > 2: + assert mv[2] == 5 + mv[2] = 6 + else: + assert mv[2] == '\x05' + mv[2] = '\x06' + assert v[2] == 6 + + with pytest.raises(RuntimeError) as excinfo: + m.create_undeclstruct() # Undeclared struct contents, no buffer interface + assert "NumPy type info missing for " in str(excinfo.value) + + +@pytest.unsupported_on_pypy +@pytest.requires_numpy +def test_vector_buffer_numpy(): + a = np.array([1, 2, 3, 4], dtype=np.int32) + with pytest.raises(TypeError): + m.VectorInt(a) + + a = np.array([[1, 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12]], dtype=np.uintc) + v = m.VectorInt(a[0, :]) + assert len(v) == 4 + assert v[2] == 3 + ma = np.asarray(v) + ma[2] = 5 + assert v[2] == 5 + + v = m.VectorInt(a[:, 1]) + assert len(v) == 3 + assert v[2] == 10 + + v = m.get_vectorstruct() + assert v[0].x == 5 + ma = np.asarray(v) + ma[1]['x'] = 99 + assert v[1].x == 99 + + v = m.VectorStruct( + np.zeros(3, dtype=np.dtype([('w', 'bool'), ('x', 'I'), ('y', 'float64'), ('z', 'bool')], align=True))) + assert len(v) == 3 + + +def test_vector_bool(): + import pybind11_cross_module_tests as cm + + vv_c = cm.VectorBool() + for i in range(10): + vv_c.append(i % 2 == 0) + for i in range(10): + assert vv_c[i] == (i % 2 == 0) + assert str(vv_c) == "VectorBool[1, 0, 1, 0, 1, 0, 1, 0, 1, 0]" + + +def test_vector_custom(): + v_a = m.VectorEl() + v_a.append(m.El(1)) + v_a.append(m.El(2)) + assert str(v_a) == "VectorEl[El{1}, El{2}]" + + vv_a = m.VectorVectorEl() + vv_a.append(v_a) + vv_b = vv_a[0] + assert str(vv_b) == "VectorEl[El{1}, El{2}]" + + +def test_map_string_double(): + mm = m.MapStringDouble() + mm['a'] = 1 + mm['b'] = 2.5 + + assert list(mm) == ['a', 'b'] + assert list(mm.items()) == [('a', 1), ('b', 2.5)] + assert str(mm) == "MapStringDouble{a: 1, b: 2.5}" + + um = m.UnorderedMapStringDouble() + um['ua'] = 1.1 + um['ub'] = 2.6 + + assert sorted(list(um)) == ['ua', 'ub'] + assert sorted(list(um.items())) == [('ua', 1.1), ('ub', 2.6)] + assert "UnorderedMapStringDouble" in str(um) + + +def test_map_string_double_const(): + mc = m.MapStringDoubleConst() + mc['a'] = 10 + mc['b'] = 20.5 + assert str(mc) == "MapStringDoubleConst{a: 10, b: 20.5}" + + umc = m.UnorderedMapStringDoubleConst() + umc['a'] = 11 + umc['b'] = 21.5 + + str(umc) + + +def test_noncopyable_containers(): + # std::vector + vnc = m.get_vnc(5) + for i in range(0, 5): + assert vnc[i].value == i + 1 + + for i, j in enumerate(vnc, start=1): + assert j.value == i + + # std::deque + dnc = m.get_dnc(5) + for i in range(0, 5): + assert dnc[i].value == i + 1 + + i = 1 + for j in dnc: + assert (j.value == i) + i += 1 + + # std::map + mnc = m.get_mnc(5) + for i in range(1, 6): + assert mnc[i].value == 10 * i + + vsum = 0 + for k, v in mnc.items(): + assert v.value == 10 * k + vsum += v.value + + assert vsum == 150 + + # std::unordered_map + mnc = m.get_umnc(5) + for i in range(1, 6): + assert mnc[i].value == 10 * i + + vsum = 0 + for k, v in mnc.items(): + assert v.value == 10 * k + vsum += v.value + + assert vsum == 150 + + +def test_map_delitem(): + mm = m.MapStringDouble() + mm['a'] = 1 + mm['b'] = 2.5 + + assert list(mm) == ['a', 'b'] + assert list(mm.items()) == [('a', 1), ('b', 2.5)] + del mm['a'] + assert list(mm) == ['b'] + assert list(mm.items()) == [('b', 2.5)] + + um = m.UnorderedMapStringDouble() + um['ua'] = 1.1 + um['ub'] = 2.6 + + assert sorted(list(um)) == ['ua', 'ub'] + assert sorted(list(um.items())) == [('ua', 1.1), ('ub', 2.6)] + del um['ua'] + assert sorted(list(um)) == ['ub'] + assert sorted(list(um.items())) == [('ub', 2.6)] diff --git a/pybind11/tests/test_tagbased_polymorphic.cpp b/pybind11/tests/test_tagbased_polymorphic.cpp new file mode 100644 index 0000000000000000000000000000000000000000..09698f8e4c5813a64df79ecd5af806380a8fd8ae --- /dev/null +++ b/pybind11/tests/test_tagbased_polymorphic.cpp @@ -0,0 +1,174 @@ +/* + tests/test_tagbased_polymorphic.cpp -- test of polymorphic_type_hook + + Copyright (c) 2018 Hudson River Trading LLC <opensource@hudson-trading.com> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include <pybind11/stl.h> + +struct Animal +{ + enum class Kind + { + Unknown = 0, + Dog = 100, + Labrador, + Chihuahua, + LastDog = 199, + Cat = 200, + Panther, + LastCat = 299 + }; + static const std::type_info* type_of_kind(Kind kind); + static std::string name_of_kind(Kind kind); + + const Kind kind; + const std::string name; + +protected: + Animal(const std::string& _name, Kind _kind) + : kind(_kind) + , name(_name) + {} +}; + +struct Dog : Animal +{ + Dog(const std::string& _name, Kind _kind = Kind::Dog) + : Animal(_name, _kind) + {} + std::string bark() const + { + return name_of_kind(kind) + " " + name + " goes " + sound; + } + std::string sound = "WOOF!"; +}; + +struct Labrador : Dog +{ + Labrador(const std::string& _name, int _excitement = 9001) + : Dog(_name, Kind::Labrador) + , excitement(_excitement) + {} + int excitement; +}; + +struct Chihuahua : Dog +{ + Chihuahua(const std::string& _name) + : Dog(_name, Kind::Chihuahua) + { + sound = "iyiyiyiyiyi"; + } + std::string bark() const + { + return Dog::bark() + " and runs in circles"; + } +}; + +struct Cat : Animal +{ + Cat(const std::string& _name, Kind _kind = Kind::Cat) + : Animal(_name, _kind) + {} + std::string purr() const + { + return "mrowr"; + } +}; + +struct Panther : Cat +{ + Panther(const std::string& _name) + : Cat(_name, Kind::Panther) + {} + std::string purr() const + { + return "mrrrRRRRRR"; + } +}; + +std::vector<std::unique_ptr<Animal>> create_zoo() +{ + std::vector<std::unique_ptr<Animal>> ret; + ret.emplace_back(new Labrador("Fido", 15000)); + + // simulate some new type of Dog that the Python bindings + // haven't been updated for; it should still be considered + // a Dog, not just an Animal. + ret.emplace_back(new Dog("Ginger", Dog::Kind(150))); + + ret.emplace_back(new Chihuahua("Hertzl")); + ret.emplace_back(new Cat("Tiger", Cat::Kind::Cat)); + ret.emplace_back(new Panther("Leo")); + return ret; +} + +const std::type_info* Animal::type_of_kind(Kind kind) +{ + switch (kind) { + case Kind::Unknown: + break; + + case Kind::Dog: + break; + case Kind::Labrador: + return &typeid(Labrador); + case Kind::Chihuahua: + return &typeid(Chihuahua); + case Kind::LastDog: + break; + + case Kind::Cat: + break; + case Kind::Panther: + return &typeid(Panther); + case Kind::LastCat: + break; + } + + if (kind >= Kind::Dog && kind <= Kind::LastDog) + return &typeid(Dog); + if (kind >= Kind::Cat && kind <= Kind::LastCat) + return &typeid(Cat); + return nullptr; +} + +std::string Animal::name_of_kind(Kind kind) +{ + std::string raw_name = type_of_kind(kind)->name(); + py::detail::clean_type_id(raw_name); + return raw_name; +} + +namespace pybind11 { +template <typename itype> +struct polymorphic_type_hook<itype, detail::enable_if_t<std::is_base_of<Animal, itype>::value>> +{ + static const void* get(const itype* src, const std::type_info*& type) + { + type = src ? Animal::type_of_kind(src->kind) : nullptr; + return src; + } +}; +} // namespace pybind11 + +TEST_SUBMODULE(tagbased_polymorphic, m) +{ + py::class_<Animal>(m, "Animal").def_readonly("name", &Animal::name); + py::class_<Dog, Animal>(m, "Dog") + .def(py::init<std::string>()) + .def_readwrite("sound", &Dog::sound) + .def("bark", &Dog::bark); + py::class_<Labrador, Dog>(m, "Labrador") + .def(py::init<std::string, int>(), "name"_a, "excitement"_a = 9001) + .def_readwrite("excitement", &Labrador::excitement); + py::class_<Chihuahua, Dog>(m, "Chihuahua").def(py::init<std::string>()).def("bark", &Chihuahua::bark); + py::class_<Cat, Animal>(m, "Cat").def(py::init<std::string>()).def("purr", &Cat::purr); + py::class_<Panther, Cat>(m, "Panther").def(py::init<std::string>()).def("purr", &Panther::purr); + m.def("create_zoo", &create_zoo); +}; diff --git a/pybind11/tests/test_tagbased_polymorphic.py b/pybind11/tests/test_tagbased_polymorphic.py new file mode 100644 index 0000000000000000000000000000000000000000..349a1101d0e85ba096086ab253593bd0ebdade99 --- /dev/null +++ b/pybind11/tests/test_tagbased_polymorphic.py @@ -0,0 +1,14 @@ +from pybind11_tests import tagbased_polymorphic as m + + +def test_downcast(): + zoo = m.create_zoo() + assert [type(animal) for animal in zoo] == [m.Labrador, m.Dog, m.Chihuahua, m.Cat, m.Panther] + assert [animal.name for animal in zoo] == ["Fido", "Ginger", "Hertzl", "Tiger", "Leo"] + zoo[1].sound = "woooooo" + assert [dog.bark() for dog in zoo[:3]] == [ + "Labrador Fido goes WOOF!", "Dog Ginger goes woooooo", "Chihuahua Hertzl goes iyiyiyiyiyi and runs in circles" + ] + assert [cat.purr() for cat in zoo[3:]] == ["mrowr", "mrrrRRRRRR"] + zoo[0].excitement -= 1000 + assert zoo[0].excitement == 14000 diff --git a/pybind11/tests/test_union.cpp b/pybind11/tests/test_union.cpp new file mode 100644 index 0000000000000000000000000000000000000000..b013f3209e6b93931f536dfc491fe58ff9c142ea --- /dev/null +++ b/pybind11/tests/test_union.cpp @@ -0,0 +1,24 @@ +/* + tests/test_class.cpp -- test py::class_ definitions and basic functionality + + Copyright (c) 2019 Roland Dreier <roland.dreier@gmail.com> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +TEST_SUBMODULE(union_, m) +{ + union TestUnion + { + int value_int; + unsigned value_uint; + }; + + py::class_<TestUnion>(m, "TestUnion") + .def(py::init<>()) + .def_readonly("as_int", &TestUnion::value_int) + .def_readwrite("as_uint", &TestUnion::value_uint); +} diff --git a/pybind11/tests/test_union.py b/pybind11/tests/test_union.py new file mode 100644 index 0000000000000000000000000000000000000000..e1866e701dec2085f9b38b862fc197b008ea9096 --- /dev/null +++ b/pybind11/tests/test_union.py @@ -0,0 +1,8 @@ +from pybind11_tests import union_ as m + + +def test_union(): + instance = m.TestUnion() + + instance.as_uint = 10 + assert instance.as_int == 10 diff --git a/pybind11/tests/test_virtual_functions.cpp b/pybind11/tests/test_virtual_functions.cpp new file mode 100644 index 0000000000000000000000000000000000000000..4ebdec81703c963d06ba7467a202d1c69077b604 --- /dev/null +++ b/pybind11/tests/test_virtual_functions.cpp @@ -0,0 +1,687 @@ +/* + tests/test_virtual_functions.cpp -- overriding virtual functions from Python + + Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include <pybind11/functional.h> +#include <thread> + +/* This is an example class that we'll want to be able to extend from Python */ +class ExampleVirt +{ +public: + ExampleVirt(int state) + : state(state) + { + print_created(this, state); + } + ExampleVirt(const ExampleVirt& e) + : state(e.state) + { + print_copy_created(this); + } + ExampleVirt(ExampleVirt&& e) + : state(e.state) + { + print_move_created(this); + e.state = 0; + } + virtual ~ExampleVirt() + { + print_destroyed(this); + } + + virtual int run(int value) + { + py::print( + "Original implementation of " + "ExampleVirt::run(state={}, value={}, str1={}, str2={})"_s.format(state, value, get_string1(), *get_string2())); + return state + value; + } + + virtual bool run_bool() = 0; + virtual void pure_virtual() = 0; + + // Returning a reference/pointer to a type converted from python (numbers, strings, etc.) is a + // bit trickier, because the actual int& or std::string& or whatever only exists temporarily, so + // we have to handle it specially in the trampoline class (see below). + virtual const std::string& get_string1() + { + return str1; + } + virtual const std::string* get_string2() + { + return &str2; + } + +private: + int state; + const std::string str1{"default1"}, str2{"default2"}; +}; + +/* This is a wrapper class that must be generated */ +class PyExampleVirt : public ExampleVirt +{ +public: + using ExampleVirt::ExampleVirt; /* Inherit constructors */ + + int run(int value) override + { + /* Generate wrapping code that enables native function overloading */ + PYBIND11_OVERLOAD(int, /* Return type */ + ExampleVirt, /* Parent class */ + run, /* Name of function */ + value /* Argument(s) */ + ); + } + + bool run_bool() override + { + PYBIND11_OVERLOAD_PURE(bool, /* Return type */ + ExampleVirt, /* Parent class */ + run_bool, /* Name of function */ + /* This function has no arguments. The trailing comma + in the previous line is needed for some compilers */ + ); + } + + void pure_virtual() override + { + PYBIND11_OVERLOAD_PURE(void, /* Return type */ + ExampleVirt, /* Parent class */ + pure_virtual, /* Name of function */ + /* This function has no arguments. The trailing comma + in the previous line is needed for some compilers */ + ); + } + + // We can return reference types for compatibility with C++ virtual interfaces that do so, but + // note they have some significant limitations (see the documentation). + const std::string& get_string1() override + { + PYBIND11_OVERLOAD(const std::string&, /* Return type */ + ExampleVirt, /* Parent class */ + get_string1, /* Name of function */ + /* (no arguments) */ + ); + } + + const std::string* get_string2() override + { + PYBIND11_OVERLOAD(const std::string*, /* Return type */ + ExampleVirt, /* Parent class */ + get_string2, /* Name of function */ + /* (no arguments) */ + ); + } +}; + +class NonCopyable +{ +public: + NonCopyable(int a, int b) + : value{new int(a * b)} + { + print_created(this, a, b); + } + NonCopyable(NonCopyable&& o) + { + value = std::move(o.value); + print_move_created(this); + } + NonCopyable(const NonCopyable&) = delete; + NonCopyable() = delete; + void operator=(const NonCopyable&) = delete; + void operator=(NonCopyable&&) = delete; + std::string get_value() const + { + if (value) + return std::to_string(*value); + else + return "(null)"; + } + ~NonCopyable() + { + print_destroyed(this); + } + +private: + std::unique_ptr<int> value; +}; + +// This is like the above, but is both copy and movable. In effect this means it should get moved +// when it is not referenced elsewhere, but copied if it is still referenced. +class Movable +{ +public: + Movable(int a, int b) + : value{a + b} + { + print_created(this, a, b); + } + Movable(const Movable& m) + { + value = m.value; + print_copy_created(this); + } + Movable(Movable&& m) + { + value = std::move(m.value); + print_move_created(this); + } + std::string get_value() const + { + return std::to_string(value); + } + ~Movable() + { + print_destroyed(this); + } + +private: + int value; +}; + +class NCVirt +{ +public: + virtual ~NCVirt() {} + virtual NonCopyable get_noncopyable(int a, int b) + { + return NonCopyable(a, b); + } + virtual Movable get_movable(int a, int b) = 0; + + std::string print_nc(int a, int b) + { + return get_noncopyable(a, b).get_value(); + } + std::string print_movable(int a, int b) + { + return get_movable(a, b).get_value(); + } +}; +class NCVirtTrampoline : public NCVirt +{ +#if !defined(__INTEL_COMPILER) + NonCopyable get_noncopyable(int a, int b) override + { + PYBIND11_OVERLOAD(NonCopyable, NCVirt, get_noncopyable, a, b); + } +#endif + Movable get_movable(int a, int b) override + { + PYBIND11_OVERLOAD_PURE(Movable, NCVirt, get_movable, a, b); + } +}; + +struct Base +{ + /* for some reason MSVC2015 can't compile this if the function is pure virtual */ + virtual std::string dispatch() const + { + return {}; + }; + virtual ~Base() = default; +}; + +struct DispatchIssue : Base +{ + virtual std::string dispatch() const + { + PYBIND11_OVERLOAD_PURE(std::string, Base, dispatch, /* no arguments */); + } +}; + +static void test_gil() +{ + { + py::gil_scoped_acquire lock; + py::print("1st lock acquired"); + } + + { + py::gil_scoped_acquire lock; + py::print("2nd lock acquired"); + } +} + +static void test_gil_from_thread() +{ + py::gil_scoped_release release; + + std::thread t(test_gil); + t.join(); +} + + +// Forward declaration (so that we can put the main tests here; the inherited virtual approaches are +// rather long). +void initialize_inherited_virtuals(py::module& m); + +TEST_SUBMODULE(virtual_functions, m) +{ + // test_override + py::class_<ExampleVirt, PyExampleVirt>(m, "ExampleVirt") + .def(py::init<int>()) + /* Reference original class in function definitions */ + .def("run", &ExampleVirt::run) + .def("run_bool", &ExampleVirt::run_bool) + .def("pure_virtual", &ExampleVirt::pure_virtual); + + py::class_<NonCopyable>(m, "NonCopyable").def(py::init<int, int>()); + + py::class_<Movable>(m, "Movable").def(py::init<int, int>()); + + // test_move_support +#if !defined(__INTEL_COMPILER) + py::class_<NCVirt, NCVirtTrampoline>(m, "NCVirt") + .def(py::init<>()) + .def("get_noncopyable", &NCVirt::get_noncopyable) + .def("get_movable", &NCVirt::get_movable) + .def("print_nc", &NCVirt::print_nc) + .def("print_movable", &NCVirt::print_movable); +#endif + + m.def("runExampleVirt", [](ExampleVirt* ex, int value) { return ex->run(value); }); + m.def("runExampleVirtBool", [](ExampleVirt* ex) { return ex->run_bool(); }); + m.def("runExampleVirtVirtual", [](ExampleVirt* ex) { ex->pure_virtual(); }); + + m.def("cstats_debug", &ConstructorStats::get<ExampleVirt>); + initialize_inherited_virtuals(m); + + // test_alias_delay_initialization1 + // don't invoke Python dispatch classes by default when instantiating C++ classes + // that were not extended on the Python side + struct A + { + virtual ~A() {} + virtual void f() + { + py::print("A.f()"); + } + }; + + struct PyA : A + { + PyA() + { + py::print("PyA.PyA()"); + } + ~PyA() + { + py::print("PyA.~PyA()"); + } + + void f() override + { + py::print("PyA.f()"); + // This convolution just gives a `void`, but tests that PYBIND11_TYPE() works to protect + // a type containing a , + PYBIND11_OVERLOAD(PYBIND11_TYPE(typename std::enable_if<true, void>::type), A, f); + } + }; + + py::class_<A, PyA>(m, "A").def(py::init<>()).def("f", &A::f); + + m.def("call_f", [](A* a) { a->f(); }); + + // test_alias_delay_initialization2 + // ... unless we explicitly request it, as in this example: + struct A2 + { + virtual ~A2() {} + virtual void f() + { + py::print("A2.f()"); + } + }; + + struct PyA2 : A2 + { + PyA2() + { + py::print("PyA2.PyA2()"); + } + ~PyA2() + { + py::print("PyA2.~PyA2()"); + } + void f() override + { + py::print("PyA2.f()"); + PYBIND11_OVERLOAD(void, A2, f); + } + }; + + py::class_<A2, PyA2>(m, "A2").def(py::init_alias<>()).def(py::init([](int) { return new PyA2(); })).def("f", &A2::f); + + m.def("call_f", [](A2* a2) { a2->f(); }); + + // test_dispatch_issue + // #159: virtual function dispatch has problems with similar-named functions + py::class_<Base, DispatchIssue>(m, "DispatchIssue").def(py::init<>()).def("dispatch", &Base::dispatch); + + m.def("dispatch_issue_go", [](const Base* b) { return b->dispatch(); }); + + // test_override_ref + // #392/397: overriding reference-returning functions + class OverrideTest + { + public: + struct A + { + std::string value = "hi"; + }; + std::string v; + A a; + explicit OverrideTest(const std::string& v) + : v{v} + {} + virtual std::string str_value() + { + return v; + } + virtual std::string& str_ref() + { + return v; + } + virtual A A_value() + { + return a; + } + virtual A& A_ref() + { + return a; + } + virtual ~OverrideTest() = default; + }; + + class PyOverrideTest : public OverrideTest + { + public: + using OverrideTest::OverrideTest; + std::string str_value() override + { + PYBIND11_OVERLOAD(std::string, OverrideTest, str_value); + } + // Not allowed (uncommenting should hit a static_assert failure): we can't get a reference + // to a python numeric value, since we only copy values in the numeric type caster: + // std::string &str_ref() override { PYBIND11_OVERLOAD(std::string &, OverrideTest, str_ref); } + // But we can work around it like this: + private: + std::string _tmp; + std::string str_ref_helper() + { + PYBIND11_OVERLOAD(std::string, OverrideTest, str_ref); + } + + public: + std::string& str_ref() override + { + return _tmp = str_ref_helper(); + } + + A A_value() override + { + PYBIND11_OVERLOAD(A, OverrideTest, A_value); + } + A& A_ref() override + { + PYBIND11_OVERLOAD(A&, OverrideTest, A_ref); + } + }; + + py::class_<OverrideTest::A>(m, "OverrideTest_A").def_readwrite("value", &OverrideTest::A::value); + py::class_<OverrideTest, PyOverrideTest>(m, "OverrideTest") + .def(py::init<const std::string&>()) + .def("str_value", &OverrideTest::str_value) + // .def("str_ref", &OverrideTest::str_ref) + .def("A_value", &OverrideTest::A_value) + .def("A_ref", &OverrideTest::A_ref); +} + + +// Inheriting virtual methods. We do two versions here: the repeat-everything version and the +// templated trampoline versions mentioned in docs/advanced.rst. +// +// These base classes are exactly the same, but we technically need distinct +// classes for this example code because we need to be able to bind them +// properly (pybind11, sensibly, doesn't allow us to bind the same C++ class to +// multiple python classes). +class A_Repeat +{ +#define A_METHODS \ +public: \ + virtual int unlucky_number() = 0; \ + virtual std::string say_something(unsigned times) \ + { \ + std::string s = ""; \ + for (unsigned i = 0; i < times; ++i) \ + s += "hi"; \ + return s; \ + } \ + std::string say_everything() \ + { \ + return say_something(1) + " " + std::to_string(unlucky_number()); \ + } + A_METHODS + virtual ~A_Repeat() = default; +}; +class B_Repeat : public A_Repeat +{ +#define B_METHODS \ +public: \ + int unlucky_number() override \ + { \ + return 13; \ + } \ + std::string say_something(unsigned times) override \ + { \ + return "B says hi " + std::to_string(times) + " times"; \ + } \ + virtual double lucky_number() \ + { \ + return 7.0; \ + } + B_METHODS +}; +class C_Repeat : public B_Repeat +{ +#define C_METHODS \ +public: \ + int unlucky_number() override \ + { \ + return 4444; \ + } \ + double lucky_number() override \ + { \ + return 888; \ + } + C_METHODS +}; +class D_Repeat : public C_Repeat +{ +#define D_METHODS // Nothing overridden. + D_METHODS +}; + +// Base classes for templated inheritance trampolines. Identical to the repeat-everything version: +class A_Tpl +{ + A_METHODS; + virtual ~A_Tpl() = default; +}; +class B_Tpl : public A_Tpl +{ + B_METHODS +}; +class C_Tpl : public B_Tpl +{ + C_METHODS +}; +class D_Tpl : public C_Tpl +{ + D_METHODS +}; + + +// Inheritance approach 1: each trampoline gets every virtual method (11 in total) +class PyA_Repeat : public A_Repeat +{ +public: + using A_Repeat::A_Repeat; + int unlucky_number() override + { + PYBIND11_OVERLOAD_PURE(int, A_Repeat, unlucky_number, ); + } + std::string say_something(unsigned times) override + { + PYBIND11_OVERLOAD(std::string, A_Repeat, say_something, times); + } +}; +class PyB_Repeat : public B_Repeat +{ +public: + using B_Repeat::B_Repeat; + int unlucky_number() override + { + PYBIND11_OVERLOAD(int, B_Repeat, unlucky_number, ); + } + std::string say_something(unsigned times) override + { + PYBIND11_OVERLOAD(std::string, B_Repeat, say_something, times); + } + double lucky_number() override + { + PYBIND11_OVERLOAD(double, B_Repeat, lucky_number, ); + } +}; +class PyC_Repeat : public C_Repeat +{ +public: + using C_Repeat::C_Repeat; + int unlucky_number() override + { + PYBIND11_OVERLOAD(int, C_Repeat, unlucky_number, ); + } + std::string say_something(unsigned times) override + { + PYBIND11_OVERLOAD(std::string, C_Repeat, say_something, times); + } + double lucky_number() override + { + PYBIND11_OVERLOAD(double, C_Repeat, lucky_number, ); + } +}; +class PyD_Repeat : public D_Repeat +{ +public: + using D_Repeat::D_Repeat; + int unlucky_number() override + { + PYBIND11_OVERLOAD(int, D_Repeat, unlucky_number, ); + } + std::string say_something(unsigned times) override + { + PYBIND11_OVERLOAD(std::string, D_Repeat, say_something, times); + } + double lucky_number() override + { + PYBIND11_OVERLOAD(double, D_Repeat, lucky_number, ); + } +}; + +// Inheritance approach 2: templated trampoline classes. +// +// Advantages: +// - we have only 2 (template) class and 4 method declarations (one per virtual method, plus one for +// any override of a pure virtual method), versus 4 classes and 6 methods (MI) or 4 classes and 11 +// methods (repeat). +// - Compared to MI, we also don't have to change the non-trampoline inheritance to virtual, and can +// properly inherit constructors. +// +// Disadvantage: +// - the compiler must still generate and compile 14 different methods (more, even, than the 11 +// required for the repeat approach) instead of the 6 required for MI. (If there was no pure +// method (or no pure method override), the number would drop down to the same 11 as the repeat +// approach). +template <class Base = A_Tpl> +class PyA_Tpl : public Base +{ +public: + using Base::Base; // Inherit constructors + int unlucky_number() override + { + PYBIND11_OVERLOAD_PURE(int, Base, unlucky_number, ); + } + std::string say_something(unsigned times) override + { + PYBIND11_OVERLOAD(std::string, Base, say_something, times); + } +}; +template <class Base = B_Tpl> +class PyB_Tpl : public PyA_Tpl<Base> +{ +public: + using PyA_Tpl<Base>::PyA_Tpl; // Inherit constructors (via PyA_Tpl's inherited constructors) + int unlucky_number() override + { + PYBIND11_OVERLOAD(int, Base, unlucky_number, ); + } + double lucky_number() override + { + PYBIND11_OVERLOAD(double, Base, lucky_number, ); + } +}; +// Since C_Tpl and D_Tpl don't declare any new virtual methods, we don't actually need these (we can +// use PyB_Tpl<C_Tpl> and PyB_Tpl<D_Tpl> for the trampoline classes instead): +/* +template <class Base = C_Tpl> class PyC_Tpl : public PyB_Tpl<Base> { +public: + using PyB_Tpl<Base>::PyB_Tpl; +}; +template <class Base = D_Tpl> class PyD_Tpl : public PyC_Tpl<Base> { +public: + using PyC_Tpl<Base>::PyC_Tpl; +}; +*/ + +void initialize_inherited_virtuals(py::module& m) +{ + // test_inherited_virtuals + + // Method 1: repeat + py::class_<A_Repeat, PyA_Repeat>(m, "A_Repeat") + .def(py::init<>()) + .def("unlucky_number", &A_Repeat::unlucky_number) + .def("say_something", &A_Repeat::say_something) + .def("say_everything", &A_Repeat::say_everything); + py::class_<B_Repeat, A_Repeat, PyB_Repeat>(m, "B_Repeat") + .def(py::init<>()) + .def("lucky_number", &B_Repeat::lucky_number); + py::class_<C_Repeat, B_Repeat, PyC_Repeat>(m, "C_Repeat").def(py::init<>()); + py::class_<D_Repeat, C_Repeat, PyD_Repeat>(m, "D_Repeat").def(py::init<>()); + + // test_ + // Method 2: Templated trampolines + py::class_<A_Tpl, PyA_Tpl<>>(m, "A_Tpl") + .def(py::init<>()) + .def("unlucky_number", &A_Tpl::unlucky_number) + .def("say_something", &A_Tpl::say_something) + .def("say_everything", &A_Tpl::say_everything); + py::class_<B_Tpl, A_Tpl, PyB_Tpl<>>(m, "B_Tpl").def(py::init<>()).def("lucky_number", &B_Tpl::lucky_number); + py::class_<C_Tpl, B_Tpl, PyB_Tpl<C_Tpl>>(m, "C_Tpl").def(py::init<>()); + py::class_<D_Tpl, C_Tpl, PyB_Tpl<D_Tpl>>(m, "D_Tpl").def(py::init<>()); + + + // Fix issue #1454 (crash when acquiring/releasing GIL on another thread in Python 2.7) + m.def("test_gil", &test_gil); + m.def("test_gil_from_thread", &test_gil_from_thread); +}; diff --git a/pybind11/tests/test_virtual_functions.py b/pybind11/tests/test_virtual_functions.py new file mode 100644 index 0000000000000000000000000000000000000000..beb74be605af1ae7b0dfb5fbc27f012b32a0e2d7 --- /dev/null +++ b/pybind11/tests/test_virtual_functions.py @@ -0,0 +1,400 @@ +import pytest + +from pybind11_tests import virtual_functions as m +from pybind11_tests import ConstructorStats + + +def test_override(capture, msg): + + class ExtendedExampleVirt(m.ExampleVirt): + + def __init__(self, state): + super(ExtendedExampleVirt, self).__init__(state + 1) + self.data = "Hello world" + + def run(self, value): + print('ExtendedExampleVirt::run(%i), calling parent..' % value) + return super(ExtendedExampleVirt, self).run(value + 1) + + def run_bool(self): + print('ExtendedExampleVirt::run_bool()') + return False + + def get_string1(self): + return "override1" + + def pure_virtual(self): + print('ExtendedExampleVirt::pure_virtual(): %s' % self.data) + + class ExtendedExampleVirt2(ExtendedExampleVirt): + + def __init__(self, state): + super(ExtendedExampleVirt2, self).__init__(state + 1) + + def get_string2(self): + return "override2" + + ex12 = m.ExampleVirt(10) + with capture: + assert m.runExampleVirt(ex12, 20) == 30 + assert capture == """ + Original implementation of ExampleVirt::run(state=10, value=20, str1=default1, str2=default2) + """ # noqa: E501 line too long + + with pytest.raises(RuntimeError) as excinfo: + m.runExampleVirtVirtual(ex12) + assert msg(excinfo.value) == 'Tried to call pure virtual function "ExampleVirt::pure_virtual"' + + ex12p = ExtendedExampleVirt(10) + with capture: + assert m.runExampleVirt(ex12p, 20) == 32 + assert capture == """ + ExtendedExampleVirt::run(20), calling parent.. + Original implementation of ExampleVirt::run(state=11, value=21, str1=override1, str2=default2) + """ # noqa: E501 line too long + with capture: + assert m.runExampleVirtBool(ex12p) is False + assert capture == "ExtendedExampleVirt::run_bool()" + with capture: + m.runExampleVirtVirtual(ex12p) + assert capture == "ExtendedExampleVirt::pure_virtual(): Hello world" + + ex12p2 = ExtendedExampleVirt2(15) + with capture: + assert m.runExampleVirt(ex12p2, 50) == 68 + assert capture == """ + ExtendedExampleVirt::run(50), calling parent.. + Original implementation of ExampleVirt::run(state=17, value=51, str1=override1, str2=override2) + """ # noqa: E501 line too long + + cstats = ConstructorStats.get(m.ExampleVirt) + assert cstats.alive() == 3 + del ex12, ex12p, ex12p2 + assert cstats.alive() == 0 + assert cstats.values() == ['10', '11', '17'] + assert cstats.copy_constructions == 0 + assert cstats.move_constructions >= 0 + + +def test_alias_delay_initialization1(capture): + """`A` only initializes its trampoline class when we inherit from it + + If we just create and use an A instance directly, the trampoline initialization is + bypassed and we only initialize an A() instead (for performance reasons). + """ + + class B(m.A): + + def __init__(self): + super(B, self).__init__() + + def f(self): + print("In python f()") + + # C++ version + with capture: + a = m.A() + m.call_f(a) + del a + pytest.gc_collect() + assert capture == "A.f()" + + # Python version + with capture: + b = B() + m.call_f(b) + del b + pytest.gc_collect() + assert capture == """ + PyA.PyA() + PyA.f() + In python f() + PyA.~PyA() + """ + + +def test_alias_delay_initialization2(capture): + """`A2`, unlike the above, is configured to always initialize the alias + + While the extra initialization and extra class layer has small virtual dispatch + performance penalty, it also allows us to do more things with the trampoline + class such as defining local variables and performing construction/destruction. + """ + + class B2(m.A2): + + def __init__(self): + super(B2, self).__init__() + + def f(self): + print("In python B2.f()") + + # No python subclass version + with capture: + a2 = m.A2() + m.call_f(a2) + del a2 + pytest.gc_collect() + a3 = m.A2(1) + m.call_f(a3) + del a3 + pytest.gc_collect() + assert capture == """ + PyA2.PyA2() + PyA2.f() + A2.f() + PyA2.~PyA2() + PyA2.PyA2() + PyA2.f() + A2.f() + PyA2.~PyA2() + """ + + # Python subclass version + with capture: + b2 = B2() + m.call_f(b2) + del b2 + pytest.gc_collect() + assert capture == """ + PyA2.PyA2() + PyA2.f() + In python B2.f() + PyA2.~PyA2() + """ + + +# PyPy: Reference count > 1 causes call with noncopyable instance +# to fail in ncv1.print_nc() +@pytest.unsupported_on_pypy +@pytest.mark.skipif(not hasattr(m, "NCVirt"), reason="NCVirt test broken on ICPC") +def test_move_support(): + + class NCVirtExt(m.NCVirt): + + def get_noncopyable(self, a, b): + # Constructs and returns a new instance: + nc = m.NonCopyable(a * a, b * b) + return nc + + def get_movable(self, a, b): + # Return a referenced copy + self.movable = m.Movable(a, b) + return self.movable + + class NCVirtExt2(m.NCVirt): + + def get_noncopyable(self, a, b): + # Keep a reference: this is going to throw an exception + self.nc = m.NonCopyable(a, b) + return self.nc + + def get_movable(self, a, b): + # Return a new instance without storing it + return m.Movable(a, b) + + ncv1 = NCVirtExt() + assert ncv1.print_nc(2, 3) == "36" + assert ncv1.print_movable(4, 5) == "9" + ncv2 = NCVirtExt2() + assert ncv2.print_movable(7, 7) == "14" + # Don't check the exception message here because it differs under debug/non-debug mode + with pytest.raises(RuntimeError): + ncv2.print_nc(9, 9) + + nc_stats = ConstructorStats.get(m.NonCopyable) + mv_stats = ConstructorStats.get(m.Movable) + assert nc_stats.alive() == 1 + assert mv_stats.alive() == 1 + del ncv1, ncv2 + assert nc_stats.alive() == 0 + assert mv_stats.alive() == 0 + assert nc_stats.values() == ['4', '9', '9', '9'] + assert mv_stats.values() == ['4', '5', '7', '7'] + assert nc_stats.copy_constructions == 0 + assert mv_stats.copy_constructions == 1 + assert nc_stats.move_constructions >= 0 + assert mv_stats.move_constructions >= 0 + + +def test_dispatch_issue(msg): + """#159: virtual function dispatch has problems with similar-named functions""" + + class PyClass1(m.DispatchIssue): + + def dispatch(self): + return "Yay.." + + class PyClass2(m.DispatchIssue): + + def dispatch(self): + with pytest.raises(RuntimeError) as excinfo: + super(PyClass2, self).dispatch() + assert msg(excinfo.value) == 'Tried to call pure virtual function "Base::dispatch"' + + p = PyClass1() + return m.dispatch_issue_go(p) + + b = PyClass2() + assert m.dispatch_issue_go(b) == "Yay.." + + +def test_override_ref(): + """#392/397: overriding reference-returning functions""" + o = m.OverrideTest("asdf") + + # Not allowed (see associated .cpp comment) + # i = o.str_ref() + # assert o.str_ref() == "asdf" + assert o.str_value() == "asdf" + + assert o.A_value().value == "hi" + a = o.A_ref() + assert a.value == "hi" + a.value = "bye" + assert a.value == "bye" + + +def test_inherited_virtuals(): + + class AR(m.A_Repeat): + + def unlucky_number(self): + return 99 + + class AT(m.A_Tpl): + + def unlucky_number(self): + return 999 + + obj = AR() + assert obj.say_something(3) == "hihihi" + assert obj.unlucky_number() == 99 + assert obj.say_everything() == "hi 99" + + obj = AT() + assert obj.say_something(3) == "hihihi" + assert obj.unlucky_number() == 999 + assert obj.say_everything() == "hi 999" + + for obj in [m.B_Repeat(), m.B_Tpl()]: + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 13 + assert obj.lucky_number() == 7.0 + assert obj.say_everything() == "B says hi 1 times 13" + + for obj in [m.C_Repeat(), m.C_Tpl()]: + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 888.0 + assert obj.say_everything() == "B says hi 1 times 4444" + + class CR(m.C_Repeat): + + def lucky_number(self): + return m.C_Repeat.lucky_number(self) + 1.25 + + obj = CR() + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 889.25 + assert obj.say_everything() == "B says hi 1 times 4444" + + class CT(m.C_Tpl): + pass + + obj = CT() + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 888.0 + assert obj.say_everything() == "B says hi 1 times 4444" + + class CCR(CR): + + def lucky_number(self): + return CR.lucky_number(self) * 10 + + obj = CCR() + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 8892.5 + assert obj.say_everything() == "B says hi 1 times 4444" + + class CCT(CT): + + def lucky_number(self): + return CT.lucky_number(self) * 1000 + + obj = CCT() + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 888000.0 + assert obj.say_everything() == "B says hi 1 times 4444" + + class DR(m.D_Repeat): + + def unlucky_number(self): + return 123 + + def lucky_number(self): + return 42.0 + + for obj in [m.D_Repeat(), m.D_Tpl()]: + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 888.0 + assert obj.say_everything() == "B says hi 1 times 4444" + + obj = DR() + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 123 + assert obj.lucky_number() == 42.0 + assert obj.say_everything() == "B says hi 1 times 123" + + class DT(m.D_Tpl): + + def say_something(self, times): + return "DT says:" + (' quack' * times) + + def unlucky_number(self): + return 1234 + + def lucky_number(self): + return -4.25 + + obj = DT() + assert obj.say_something(3) == "DT says: quack quack quack" + assert obj.unlucky_number() == 1234 + assert obj.lucky_number() == -4.25 + assert obj.say_everything() == "DT says: quack 1234" + + class DT2(DT): + + def say_something(self, times): + return "DT2: " + ('QUACK' * times) + + def unlucky_number(self): + return -3 + + class BT(m.B_Tpl): + + def say_something(self, times): + return "BT" * times + + def unlucky_number(self): + return -7 + + def lucky_number(self): + return -1.375 + + obj = BT() + assert obj.say_something(3) == "BTBTBT" + assert obj.unlucky_number() == -7 + assert obj.lucky_number() == -1.375 + assert obj.say_everything() == "BT -7" + + +def test_issue_1454(): + # Fix issue #1454 (crash when acquiring/releasing GIL on another thread in Python 2.7) + m.test_gil() + m.test_gil_from_thread() diff --git a/pybind11/tools/FindCatch.cmake b/pybind11/tools/FindCatch.cmake new file mode 100644 index 0000000000000000000000000000000000000000..9911a307419d8e51fbb484a2f6dc10bf2be101bc --- /dev/null +++ b/pybind11/tools/FindCatch.cmake @@ -0,0 +1,55 @@ +# * Find the Catch test framework or download it (single header) +# +# This is a quick module for internal use. It assumes that Catch is REQUIRED and that a minimum version is provided +# (not EXACT). If a suitable version isn't found locally, the single header file will be downloaded and placed in the +# build dir: PROJECT_BINARY_DIR. +# +# This code sets the following variables: CATCH_INCLUDE_DIR - path to catch.hpp CATCH_VERSION - version +# number + +if(NOT Catch_FIND_VERSION) + message(FATAL_ERROR "A version number must be specified.") +elseif(Catch_FIND_REQUIRED) + message(FATAL_ERROR "This module assumes Catch is not required.") +elseif(Catch_FIND_VERSION_EXACT) + message(FATAL_ERROR "Exact version numbers are not supported, only minimum.") +endif() + +# Extract the version number from catch.hpp +function(_get_catch_version) + file(STRINGS "${CATCH_INCLUDE_DIR}/catch.hpp" version_line REGEX "Catch v.*" LIMIT_COUNT 1) + if(version_line MATCHES "Catch v([0-9]+)\\.([0-9]+)\\.([0-9]+)") + set(CATCH_VERSION "${CMAKE_MATCH_1}.${CMAKE_MATCH_2}.${CMAKE_MATCH_3}" PARENT_SCOPE) + endif() +endfunction() + +# Download the single-header version of Catch +function(_download_catch version destination_dir) + message(STATUS "Downloading catch v${version}...") + set(url https://github.com/philsquared/Catch/releases/download/v${version}/catch.hpp) + file(DOWNLOAD ${url} "${destination_dir}/catch.hpp" STATUS status) + list(GET status 0 error) + if(error) + message(FATAL_ERROR "Could not download ${url}") + endif() + set(CATCH_INCLUDE_DIR "${destination_dir}" CACHE INTERNAL "") +endfunction() + +# Look for catch locally +find_path(CATCH_INCLUDE_DIR NAMES catch.hpp PATH_SUFFIXES catch) +if(CATCH_INCLUDE_DIR) + _get_catch_version() +endif() + +# Download the header if it wasn't found or if it's outdated +if(NOT CATCH_VERSION OR CATCH_VERSION VERSION_LESS ${Catch_FIND_VERSION}) + if(DOWNLOAD_CATCH) + _download_catch(${Catch_FIND_VERSION} "${PROJECT_BINARY_DIR}/catch/") + _get_catch_version() + else() + set(CATCH_FOUND FALSE) + return() + endif() +endif() + +set(CATCH_FOUND TRUE) diff --git a/pybind11/tools/FindEigen3.cmake b/pybind11/tools/FindEigen3.cmake new file mode 100644 index 0000000000000000000000000000000000000000..d29c08731a137897797b0c5d3cddc56ba3355471 --- /dev/null +++ b/pybind11/tools/FindEigen3.cmake @@ -0,0 +1,84 @@ +# * 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, <montel@kde.org> Copyright (c) 2008, 2009 Gael Guennebaud, <g.gael@free.fr> +# Copyright (c) 2009 Benoit Jacob <jacob.benoit.1@gmail.com> 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) + + find_path(EIGEN3_INCLUDE_DIR + NAMES signature_of_eigen3_matrix_library + PATHS ${CMAKE_INSTALL_PREFIX}/include ${KDE4_INCLUDE_DIR} + PATH_SUFFIXES eigen3 eigen) + + if(EIGEN3_INCLUDE_DIR) + _eigen3_check_version() + endif(EIGEN3_INCLUDE_DIR) + + include(FindPackageHandleStandardArgs) + find_package_handle_standard_args(Eigen3 DEFAULT_MSG EIGEN3_INCLUDE_DIR EIGEN3_VERSION_OK) + + mark_as_advanced(EIGEN3_INCLUDE_DIR) + +endif(EIGEN3_INCLUDE_DIR) diff --git a/pybind11/tools/FindPythonLibsNew.cmake b/pybind11/tools/FindPythonLibsNew.cmake new file mode 100644 index 0000000000000000000000000000000000000000..bb542b7e26c99f604aa7d0e5a3e51aff67b78026 --- /dev/null +++ b/pybind11/tools/FindPythonLibsNew.cmake @@ -0,0 +1,194 @@ +# * Find python libraries This module finds the libraries corresponding to the Python interpreter FindPythonInterp +# provides. This code sets the following variables: +# +# PYTHONLIBS_FOUND - have the Python libs been found PYTHON_PREFIX - path to the Python +# installation PYTHON_LIBRARIES - path to the python library PYTHON_INCLUDE_DIRS - path to where +# Python.h is found PYTHON_MODULE_EXTENSION - lib extension, e.g. '.so' or '.pyd' PYTHON_MODULE_PREFIX - lib +# name prefix: usually an empty string PYTHON_SITE_PACKAGES - path to installation site-packages PYTHON_IS_DEBUG +# - whether the Python interpreter is a debug build +# +# Thanks to talljimbo for the patch adding the 'LDVERSION' config variable usage. + +# ============================================================================= +# Copyright 2001-2009 Kitware, Inc. Copyright 2012 Continuum Analytics, Inc. +# +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the +# following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions and the following +# disclaimer. +# +# * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following +# disclaimer in the documentation and/or other materials provided with the distribution. +# +# * Neither the names of Kitware, Inc., the Insight Software Consortium, nor the names of their contributors may be +# used to endorse or promote products derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, +# INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# ============================================================================= + +# Checking for the extension makes sure that `LibsNew` was found and not just `Libs`. +if(PYTHONLIBS_FOUND AND PYTHON_MODULE_EXTENSION) + return() +endif() + +# Use the Python interpreter to find the libs. +if(PythonLibsNew_FIND_REQUIRED) + find_package(PythonInterp ${PythonLibsNew_FIND_VERSION} REQUIRED) +else() + find_package(PythonInterp ${PythonLibsNew_FIND_VERSION}) +endif() + +if(NOT PYTHONINTERP_FOUND) + set(PYTHONLIBS_FOUND FALSE) + set(PythonLibsNew_FOUND FALSE) + return() +endif() + +# According to http://stackoverflow.com/questions/646518/python-how-to-detect-debug-interpreter testing whether sys has +# the gettotalrefcount function is a reliable, cross-platform way to detect a CPython debug interpreter. +# +# The library suffix is from the config var LDVERSION sometimes, otherwise VERSION. VERSION will typically be like +# "2.7" on unix, and "27" on windows. +execute_process(COMMAND "${PYTHON_EXECUTABLE}" "-c" "from distutils import sysconfig as s;import sys;import struct; +print('.'.join(str(v) for v in sys.version_info)); +print(sys.prefix); +print(s.get_python_inc(plat_specific=True)); +print(s.get_python_lib(plat_specific=True)); +print(s.get_config_var('SO')); +print(hasattr(sys, 'gettotalrefcount')+0); +print(struct.calcsize('@P')); +print(s.get_config_var('LDVERSION') or s.get_config_var('VERSION')); +print(s.get_config_var('LIBDIR') or ''); +print(s.get_config_var('MULTIARCH') or ''); +" RESULT_VARIABLE _PYTHON_SUCCESS OUTPUT_VARIABLE _PYTHON_VALUES ERROR_VARIABLE _PYTHON_ERROR_VALUE) + +if(NOT _PYTHON_SUCCESS MATCHES 0) + if(PythonLibsNew_FIND_REQUIRED) + message(FATAL_ERROR "Python config failure:\n${_PYTHON_ERROR_VALUE}") + endif() + set(PYTHONLIBS_FOUND FALSE) + set(PythonLibsNew_FOUND FALSE) + return() +endif() + +# Convert the process output into a list +if(WIN32) + string(REGEX + REPLACE "\\\\" + "/" + _PYTHON_VALUES + ${_PYTHON_VALUES}) +endif() +string(REGEX + REPLACE ";" + "\\\\;" + _PYTHON_VALUES + ${_PYTHON_VALUES}) +string(REGEX + REPLACE "\n" + ";" + _PYTHON_VALUES + ${_PYTHON_VALUES}) +list(GET _PYTHON_VALUES 0 _PYTHON_VERSION_LIST) +list(GET _PYTHON_VALUES 1 PYTHON_PREFIX) +list(GET _PYTHON_VALUES 2 PYTHON_INCLUDE_DIR) +list(GET _PYTHON_VALUES 3 PYTHON_SITE_PACKAGES) +list(GET _PYTHON_VALUES 4 PYTHON_MODULE_EXTENSION) +list(GET _PYTHON_VALUES 5 PYTHON_IS_DEBUG) +list(GET _PYTHON_VALUES 6 PYTHON_SIZEOF_VOID_P) +list(GET _PYTHON_VALUES 7 PYTHON_LIBRARY_SUFFIX) +list(GET _PYTHON_VALUES 8 PYTHON_LIBDIR) +list(GET _PYTHON_VALUES 9 PYTHON_MULTIARCH) + +# Make sure the Python has the same pointer-size as the chosen compiler Skip if CMAKE_SIZEOF_VOID_P is not defined +if(CMAKE_SIZEOF_VOID_P AND (NOT "${PYTHON_SIZEOF_VOID_P}" STREQUAL "${CMAKE_SIZEOF_VOID_P}")) + if(PythonLibsNew_FIND_REQUIRED) + math(EXPR _PYTHON_BITS "${PYTHON_SIZEOF_VOID_P} * 8") + math(EXPR _CMAKE_BITS "${CMAKE_SIZEOF_VOID_P} * 8") + message(FATAL_ERROR "Python config failure: Python is ${_PYTHON_BITS}-bit, " + "chosen compiler is ${_CMAKE_BITS}-bit") + endif() + set(PYTHONLIBS_FOUND FALSE) + set(PythonLibsNew_FOUND FALSE) + return() +endif() + +# The built-in FindPython didn't always give the version numbers +string(REGEX + REPLACE "\\." + ";" + _PYTHON_VERSION_LIST + ${_PYTHON_VERSION_LIST}) +list(GET _PYTHON_VERSION_LIST 0 PYTHON_VERSION_MAJOR) +list(GET _PYTHON_VERSION_LIST 1 PYTHON_VERSION_MINOR) +list(GET _PYTHON_VERSION_LIST 2 PYTHON_VERSION_PATCH) + +# Make sure all directory separators are '/' +string(REGEX + REPLACE "\\\\" + "/" + PYTHON_PREFIX + ${PYTHON_PREFIX}) +string(REGEX + REPLACE "\\\\" + "/" + PYTHON_INCLUDE_DIR + ${PYTHON_INCLUDE_DIR}) +string(REGEX + REPLACE "\\\\" + "/" + PYTHON_SITE_PACKAGES + ${PYTHON_SITE_PACKAGES}) + +if(CMAKE_HOST_WIN32) + set(PYTHON_LIBRARY "${PYTHON_PREFIX}/libs/Python${PYTHON_LIBRARY_SUFFIX}.lib") + + # when run in a venv, PYTHON_PREFIX points to it. But the libraries remain in the original python installation. They + # may be found relative to PYTHON_INCLUDE_DIR. + if(NOT EXISTS "${PYTHON_LIBRARY}") + get_filename_component(_PYTHON_ROOT ${PYTHON_INCLUDE_DIR} DIRECTORY) + set(PYTHON_LIBRARY "${_PYTHON_ROOT}/libs/Python${PYTHON_LIBRARY_SUFFIX}.lib") + endif() + + # raise an error if the python libs are still not found. + if(NOT EXISTS "${PYTHON_LIBRARY}") + message(FATAL_ERROR "Python libraries not found") + endif() + +else() + if(PYTHON_MULTIARCH) + set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}/${PYTHON_MULTIARCH}" "${PYTHON_LIBDIR}") + else() + set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}") + endif() + # message(STATUS "Searching for Python libs in ${_PYTHON_LIBS_SEARCH}") Probably this needs to be more involved. It + # would be nice if the config information the python interpreter itself gave us were more complete. + find_library(PYTHON_LIBRARY NAMES "python${PYTHON_LIBRARY_SUFFIX}" PATHS ${_PYTHON_LIBS_SEARCH} NO_DEFAULT_PATH) + + # If all else fails, just set the name/version and let the linker figure out the path. + if(NOT PYTHON_LIBRARY) + set(PYTHON_LIBRARY python${PYTHON_LIBRARY_SUFFIX}) + endif() +endif() + +mark_as_advanced(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_LIBRARIES "${PYTHON_LIBRARY}") +set(PYTHON_DEBUG_LIBRARIES "${PYTHON_DEBUG_LIBRARY}") + +find_package_message(PYTHON "Found PythonLibs: ${PYTHON_LIBRARY}" "${PYTHON_EXECUTABLE}${PYTHON_VERSION}") + +set(PYTHONLIBS_FOUND TRUE) +set(PythonLibsNew_FOUND TRUE) diff --git a/pybind11/tools/check-style.sh b/pybind11/tools/check-style.sh new file mode 100755 index 0000000000000000000000000000000000000000..0a9f7d24fcbf5ef4a86dab0bccceb9b331bdb4e7 --- /dev/null +++ b/pybind11/tools/check-style.sh @@ -0,0 +1,70 @@ +#!/bin/bash +# +# Script to check include/test code for common pybind11 code style errors. +# +# This script currently checks for +# +# 1. use of tabs instead of spaces +# 2. MSDOS-style CRLF endings +# 3. trailing spaces +# 4. missing space between keyword and parenthesis, e.g.: for(, if(, while( +# 5. Missing space between right parenthesis and brace, e.g. 'for (...){' +# 6. opening brace on its own line. It should always be on the same line as the +# if/while/for/do statement. +# +# Invoke as: tools/check-style.sh +# + +check_style_errors=0 +IFS=$'\n' + +found="$( GREP_COLORS='mt=41' GREP_COLOR='41' grep $'\t' include tests/*.{cpp,py,h} docs/*.rst -rn --color=always )" +if [ -n "$found" ]; then + # The mt=41 sets a red background for matched tabs: + echo -e '\033[31;01mError: found tab characters in the following files:\033[0m' + check_style_errors=1 + echo "$found" | sed -e 's/^/ /' +fi + + +found="$( grep -IUlr $'\r' include tests/*.{cpp,py,h} docs/*.rst --color=always )" +if [ -n "$found" ]; then + echo -e '\033[31;01mError: found CRLF characters in the following files:\033[0m' + check_style_errors=1 + echo "$found" | sed -e 's/^/ /' +fi + +found="$(GREP_COLORS='mt=41' GREP_COLOR='41' grep '[[:blank:]]\+$' include tests/*.{cpp,py,h} docs/*.rst -rn --color=always )" +if [ -n "$found" ]; then + # The mt=41 sets a red background for matched trailing spaces + echo -e '\033[31;01mError: found trailing spaces in the following files:\033[0m' + check_style_errors=1 + echo "$found" | sed -e 's/^/ /' +fi + +found="$(grep '\<\(if\|for\|while\|catch\)(\|){' include tests/*.{cpp,h} -rn --color=always)" +if [ -n "$found" ]; then + echo -e '\033[31;01mError: found the following coding style problems:\033[0m' + check_style_errors=1 + echo "$found" | sed -e 's/^/ /' +fi + +found="$(awk ' +function prefix(filename, lineno) { + return " \033[35m" filename "\033[36m:\033[32m" lineno "\033[36m:\033[0m" +} +function mark(pattern, string) { sub(pattern, "\033[01;31m&\033[0m", string); return string } +last && /^\s*{/ { + print prefix(FILENAME, FNR-1) mark("\\)\\s*$", last) + print prefix(FILENAME, FNR) mark("^\\s*{", $0) + last="" +} +{ last = /(if|for|while|catch|switch)\s*\(.*\)\s*$/ ? $0 : "" } +' $(find include -type f) tests/*.{cpp,h} docs/*.rst)" +if [ -n "$found" ]; then + check_style_errors=1 + echo -e '\033[31;01mError: braces should occur on the same line as the if/while/.. statement. Found issues in the following files:\033[0m' + echo "$found" +fi + +exit $check_style_errors diff --git a/pybind11/tools/libsize.py b/pybind11/tools/libsize.py new file mode 100644 index 0000000000000000000000000000000000000000..92f433a412357081d69a0e1237c9792cb0485be6 --- /dev/null +++ b/pybind11/tools/libsize.py @@ -0,0 +1,37 @@ +from __future__ import print_function, division +import os +import sys + +# Internal build script for generating debugging test .so size. +# Usage: +# python libsize.py file.so save.txt -- displays the size of file.so and, if save.txt exists, compares it to the +# size in it, then overwrites save.txt with the new size for future runs. + +if len(sys.argv) != 3: + sys.exit("Invalid arguments: usage: python libsize.py file.so save.txt") + +lib = sys.argv[1] +save = sys.argv[2] + +if not os.path.exists(lib): + sys.exit("Error: requested file ({}) does not exist".format(lib)) + +libsize = os.path.getsize(lib) + +print("------", os.path.basename(lib), "file size:", libsize, end='') + +if os.path.exists(save): + with open(save) as sf: + oldsize = int(sf.readline()) + + if oldsize > 0: + change = libsize - oldsize + if change == 0: + print(" (no change)") + else: + print(" (change of {:+} bytes = {:+.2%})".format(change, change / oldsize)) +else: + print() + +with open(save, 'w') as sf: + sf.write(str(libsize)) diff --git a/pybind11/tools/mkdoc.py b/pybind11/tools/mkdoc.py new file mode 100755 index 0000000000000000000000000000000000000000..8100920f2facc13409f7d2d418529da2d6dbb8c1 --- /dev/null +++ b/pybind11/tools/mkdoc.py @@ -0,0 +1,388 @@ +#!/usr/bin/env python3 +# +# Syntax: mkdoc.py [-I<path> ..] [.. a list of header files ..] +# +# Extract documentation from C++ header files to use it in Python bindings +# + +import os +import sys +import platform +import re +import textwrap + +from clang import cindex +from clang.cindex import CursorKind +from collections import OrderedDict +from glob import glob +from threading import Thread, Semaphore +from multiprocessing import cpu_count + +RECURSE_LIST = [ + CursorKind.TRANSLATION_UNIT, CursorKind.NAMESPACE, CursorKind.CLASS_DECL, CursorKind.STRUCT_DECL, + CursorKind.ENUM_DECL, CursorKind.CLASS_TEMPLATE +] + +PRINT_LIST = [ + CursorKind.CLASS_DECL, CursorKind.STRUCT_DECL, CursorKind.ENUM_DECL, CursorKind.ENUM_CONSTANT_DECL, + CursorKind.CLASS_TEMPLATE, CursorKind.FUNCTION_DECL, CursorKind.FUNCTION_TEMPLATE, CursorKind.CONVERSION_FUNCTION, + CursorKind.CXX_METHOD, CursorKind.CONSTRUCTOR, CursorKind.FIELD_DECL +] + +PREFIX_BLACKLIST = [CursorKind.TRANSLATION_UNIT] + +CPP_OPERATORS = { + '<=': 'le', + '>=': 'ge', + '==': 'eq', + '!=': 'ne', + '[]': 'array', + '+=': 'iadd', + '-=': 'isub', + '*=': 'imul', + '/=': 'idiv', + '%=': 'imod', + '&=': 'iand', + '|=': 'ior', + '^=': 'ixor', + '<<=': 'ilshift', + '>>=': 'irshift', + '++': 'inc', + '--': 'dec', + '<<': 'lshift', + '>>': 'rshift', + '&&': 'land', + '||': 'lor', + '!': 'lnot', + '~': 'bnot', + '&': 'band', + '|': 'bor', + '+': 'add', + '-': 'sub', + '*': 'mul', + '/': 'div', + '%': 'mod', + '<': 'lt', + '>': 'gt', + '=': 'assign', + '()': 'call' +} + +CPP_OPERATORS = OrderedDict(sorted(CPP_OPERATORS.items(), key=lambda t: -len(t[0]))) + +job_count = cpu_count() +job_semaphore = Semaphore(job_count) + + +class NoFilenamesError(ValueError): + pass + + +def d(s): + return s if isinstance(s, str) else s.decode('utf8') + + +def sanitize_name(name): + name = re.sub(r'type-parameter-0-([0-9]+)', r'T\1', name) + for k, v in CPP_OPERATORS.items(): + name = name.replace('operator%s' % k, 'operator_%s' % v) + name = re.sub('<.*>', '', name) + name = ''.join([ch if ch.isalnum() else '_' for ch in name]) + name = re.sub('_$', '', re.sub('_+', '_', name)) + return '__doc_' + name + + +def process_comment(comment): + result = '' + + # Remove C++ comment syntax + leading_spaces = float('inf') + for s in comment.expandtabs(tabsize=4).splitlines(): + s = s.strip() + if s.startswith('/*'): + s = s[2:].lstrip('*') + elif s.endswith('*/'): + s = s[:-2].rstrip('*') + elif s.startswith('///'): + s = s[3:] + if s.startswith('*'): + s = s[1:] + if len(s) > 0: + leading_spaces = min(leading_spaces, len(s) - len(s.lstrip())) + result += s + '\n' + + if leading_spaces != float('inf'): + result2 = "" + for s in result.splitlines(): + result2 += s[leading_spaces:] + '\n' + result = result2 + + # Doxygen tags + cpp_group = '([\w:]+)' + param_group = '([\[\w:\]]+)' + + s = result + s = re.sub(r'\\c\s+%s' % cpp_group, r'``\1``', s) + s = re.sub(r'\\a\s+%s' % cpp_group, r'*\1*', s) + s = re.sub(r'\\e\s+%s' % cpp_group, r'*\1*', s) + s = re.sub(r'\\em\s+%s' % cpp_group, r'*\1*', s) + s = re.sub(r'\\b\s+%s' % cpp_group, r'**\1**', s) + s = re.sub(r'\\ingroup\s+%s' % cpp_group, r'', s) + s = re.sub(r'\\param%s?\s+%s' % (param_group, cpp_group), r'\n\n$Parameter ``\2``:\n\n', s) + s = re.sub(r'\\tparam%s?\s+%s' % (param_group, cpp_group), r'\n\n$Template parameter ``\2``:\n\n', s) + + for in_, out_ in { + 'return': 'Returns', + 'author': 'Author', + 'authors': 'Authors', + 'copyright': 'Copyright', + 'date': 'Date', + 'remark': 'Remark', + 'sa': 'See also', + 'see': 'See also', + 'extends': 'Extends', + 'throw': 'Throws', + 'throws': 'Throws' + }.items(): + s = re.sub(r'\\%s\s*' % in_, r'\n\n$%s:\n\n' % out_, s) + + s = re.sub(r'\\details\s*', r'\n\n', s) + s = re.sub(r'\\brief\s*', r'', s) + s = re.sub(r'\\short\s*', r'', s) + s = re.sub(r'\\ref\s*', r'', s) + + s = re.sub(r'\\code\s?(.*?)\s?\\endcode', r"```\n\1\n```\n", s, flags=re.DOTALL) + + # HTML/TeX tags + s = re.sub(r'<tt>(.*?)</tt>', r'``\1``', s, flags=re.DOTALL) + s = re.sub(r'<pre>(.*?)</pre>', r"```\n\1\n```\n", s, flags=re.DOTALL) + s = re.sub(r'<em>(.*?)</em>', r'*\1*', s, flags=re.DOTALL) + s = re.sub(r'<b>(.*?)</b>', r'**\1**', s, flags=re.DOTALL) + s = re.sub(r'\\f\$(.*?)\\f\$', r'$\1$', s, flags=re.DOTALL) + s = re.sub(r'<li>', r'\n\n* ', s) + s = re.sub(r'</?ul>', r'', s) + s = re.sub(r'</li>', r'\n\n', s) + + s = s.replace('``true``', '``True``') + s = s.replace('``false``', '``False``') + + # Re-flow text + wrapper = textwrap.TextWrapper() + wrapper.expand_tabs = True + wrapper.replace_whitespace = True + wrapper.drop_whitespace = True + wrapper.width = 70 + wrapper.initial_indent = wrapper.subsequent_indent = '' + + result = '' + in_code_segment = False + for x in re.split(r'(```)', s): + if x == '```': + if not in_code_segment: + result += '```\n' + else: + result += '\n```\n\n' + in_code_segment = not in_code_segment + elif in_code_segment: + result += x.strip() + else: + for y in re.split(r'(?: *\n *){2,}', x): + wrapped = wrapper.fill(re.sub(r'\s+', ' ', y).strip()) + if len(wrapped) > 0 and wrapped[0] == '$': + result += wrapped[1:] + '\n' + wrapper.initial_indent = \ + wrapper.subsequent_indent = ' ' * 4 + else: + if len(wrapped) > 0: + result += wrapped + '\n\n' + wrapper.initial_indent = wrapper.subsequent_indent = '' + return result.rstrip().lstrip('\n') + + +def extract(filename, node, prefix, output): + if not (node.location.file is None or os.path.samefile(d(node.location.file.name), filename)): + return 0 + if node.kind in RECURSE_LIST: + sub_prefix = prefix + if node.kind not in PREFIX_BLACKLIST: + if len(sub_prefix) > 0: + sub_prefix += '_' + sub_prefix += d(node.spelling) + for i in node.get_children(): + extract(filename, i, sub_prefix, output) + if node.kind in PRINT_LIST: + comment = d(node.raw_comment) if node.raw_comment is not None else '' + comment = process_comment(comment) + sub_prefix = prefix + if len(sub_prefix) > 0: + sub_prefix += '_' + if len(node.spelling) > 0: + name = sanitize_name(sub_prefix + d(node.spelling)) + output.append((name, filename, comment)) + + +class ExtractionThread(Thread): + + def __init__(self, filename, parameters, output): + Thread.__init__(self) + self.filename = filename + self.parameters = parameters + self.output = output + job_semaphore.acquire() + + def run(self): + print('Processing "%s" ..' % self.filename, file=sys.stderr) + try: + index = cindex.Index(cindex.conf.lib.clang_createIndex(False, True)) + tu = index.parse(self.filename, self.parameters) + extract(self.filename, tu.cursor, '', self.output) + finally: + job_semaphore.release() + + +def read_args(args): + parameters = [] + filenames = [] + if "-x" not in args: + parameters.extend(['-x', 'c++']) + if not any(it.startswith("-std=") for it in args): + parameters.append('-std=c++11') + + if platform.system() == 'Darwin': + dev_path = '/Applications/Xcode.app/Contents/Developer/' + lib_dir = dev_path + 'Toolchains/XcodeDefault.xctoolchain/usr/lib/' + sdk_dir = dev_path + 'Platforms/MacOSX.platform/Developer/SDKs' + libclang = lib_dir + 'libclang.dylib' + + if os.path.exists(libclang): + cindex.Config.set_library_path(os.path.dirname(libclang)) + + if os.path.exists(sdk_dir): + sysroot_dir = os.path.join(sdk_dir, next(os.walk(sdk_dir))[1][0]) + parameters.append('-isysroot') + parameters.append(sysroot_dir) + elif platform.system() == 'Linux': + # clang doesn't find its own base includes by default on Linux, + # but different distros install them in different paths. + # Try to autodetect, preferring the highest numbered version. + def clang_folder_version(d): + return [int(ver) for ver in re.findall(r'(?<!lib)(?<!\d)\d+', d)] + + clang_include_dir = max((path for libdir in ['lib64', 'lib', 'lib32'] + for path in glob('/usr/%s/clang/*/include' % libdir) if os.path.isdir(path)), + default=None, + key=clang_folder_version) + if clang_include_dir: + parameters.extend(['-isystem', clang_include_dir]) + + for item in args: + if item.startswith('-'): + parameters.append(item) + else: + filenames.append(item) + + if len(filenames) == 0: + raise NoFilenamesError("args parameter did not contain any filenames") + + return parameters, filenames + + +def extract_all(args): + parameters, filenames = read_args(args) + output = [] + for filename in filenames: + thr = ExtractionThread(filename, parameters, output) + thr.start() + + print('Waiting for jobs to finish ..', file=sys.stderr) + for i in range(job_count): + job_semaphore.acquire() + + return output + + +def write_header(comments, out_file=sys.stdout): + print( + '''/* + This file contains docstrings for the Python bindings. + Do not edit! These were automatically extracted by mkdoc.py + */ + +#define __EXPAND(x) x +#define __COUNT(_1, _2, _3, _4, _5, _6, _7, COUNT, ...) COUNT +#define __VA_SIZE(...) __EXPAND(__COUNT(__VA_ARGS__, 7, 6, 5, 4, 3, 2, 1)) +#define __CAT1(a, b) a ## b +#define __CAT2(a, b) __CAT1(a, b) +#define __DOC1(n1) __doc_##n1 +#define __DOC2(n1, n2) __doc_##n1##_##n2 +#define __DOC3(n1, n2, n3) __doc_##n1##_##n2##_##n3 +#define __DOC4(n1, n2, n3, n4) __doc_##n1##_##n2##_##n3##_##n4 +#define __DOC5(n1, n2, n3, n4, n5) __doc_##n1##_##n2##_##n3##_##n4##_##n5 +#define __DOC6(n1, n2, n3, n4, n5, n6) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6 +#define __DOC7(n1, n2, n3, n4, n5, n6, n7) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7 +#define DOC(...) __EXPAND(__EXPAND(__CAT2(__DOC, __VA_SIZE(__VA_ARGS__)))(__VA_ARGS__)) + +#if defined(__GNUG__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wunused-variable" +#endif +''', + file=out_file) + + name_ctr = 1 + name_prev = None + for name, _, comment in list(sorted(comments, key=lambda x: (x[0], x[1]))): + if name == name_prev: + name_ctr += 1 + name = name + "_%i" % name_ctr + else: + name_prev = name + name_ctr = 1 + print( + '\nstatic const char *%s =%sR"doc(%s)doc";' % (name, '\n' if '\n' in comment else ' ', comment), + file=out_file) + + print(''' +#if defined(__GNUG__) +#pragma GCC diagnostic pop +#endif +''', file=out_file) + + +def mkdoc(args): + args = list(args) + out_path = None + for idx, arg in enumerate(args): + if arg.startswith("-o"): + args.remove(arg) + try: + out_path = arg[2:] or args.pop(idx) + except IndexError: + print("-o flag requires an argument") + exit(-1) + break + + comments = extract_all(args) + + if out_path: + try: + with open(out_path, 'w') as out_file: + write_header(comments, out_file) + except: + # In the event of an error, don't leave a partially-written + # output file. + try: + os.unlink(out_path) + except: + pass + raise + else: + write_header(comments) + + +if __name__ == '__main__': + try: + mkdoc(sys.argv[1:]) + except NoFilenamesError: + print('Syntax: %s [.. a list of header files ..]' % sys.argv[0]) + exit(-1) diff --git a/pybind11/tools/pybind11Config.cmake.in b/pybind11/tools/pybind11Config.cmake.in new file mode 100644 index 0000000000000000000000000000000000000000..8a7272ff96b6ff3554b933e2db442ff671ca72fc --- /dev/null +++ b/pybind11/tools/pybind11Config.cmake.in @@ -0,0 +1,104 @@ +# pybind11Config.cmake +# -------------------- +# +# PYBIND11 cmake module. +# This module sets the following variables in your project:: +# +# pybind11_FOUND - true if pybind11 and all required components found on the system +# pybind11_VERSION - pybind11 version in format Major.Minor.Release +# pybind11_INCLUDE_DIRS - Directories where pybind11 and python headers are located. +# pybind11_INCLUDE_DIR - Directory where pybind11 headers are located. +# pybind11_DEFINITIONS - Definitions necessary to use pybind11, namely USING_pybind11. +# pybind11_LIBRARIES - compile flags and python libraries (as needed) to link against. +# pybind11_LIBRARY - empty. +# CMAKE_MODULE_PATH - appends location of accompanying FindPythonLibsNew.cmake and +# pybind11Tools.cmake modules. +# +# +# Available components: None +# +# +# Exported targets:: +# +# If pybind11 is found, this module defines the following :prop_tgt:`IMPORTED` +# interface library targets:: +# +# pybind11::module - for extension modules +# pybind11::embed - for embedding the Python interpreter +# +# Python headers, libraries (as needed by platform), and the C++ standard +# are attached to the target. Set PythonLibsNew variables to influence +# python detection and PYBIND11_CPP_STANDARD (-std=c++11 or -std=c++14) to +# influence standard setting. :: +# +# find_package(pybind11 CONFIG REQUIRED) +# message(STATUS "Found pybind11 v${pybind11_VERSION}: ${pybind11_INCLUDE_DIRS}") +# +# # Create an extension module +# add_library(mylib MODULE main.cpp) +# target_link_libraries(mylib pybind11::module) +# +# # Or embed the Python interpreter into an executable +# add_executable(myexe main.cpp) +# target_link_libraries(myexe pybind11::embed) +# +# Suggested usage:: +# +# find_package with version info is not recommended except for release versions. :: +# +# find_package(pybind11 CONFIG) +# find_package(pybind11 2.0 EXACT CONFIG REQUIRED) +# +# +# The following variables can be set to guide the search for this package:: +# +# pybind11_DIR - CMake variable, set to directory containing this Config file +# CMAKE_PREFIX_PATH - CMake variable, set to root directory of this package +# PATH - environment variable, set to bin directory of this package +# CMAKE_DISABLE_FIND_PACKAGE_pybind11 - CMake variable, disables +# find_package(pybind11) when not REQUIRED, perhaps to force internal build + +@PACKAGE_INIT@ + +set(PN pybind11) + +# location of pybind11/pybind11.h +set(${PN}_INCLUDE_DIR "${PACKAGE_PREFIX_DIR}/@CMAKE_INSTALL_INCLUDEDIR@") + +set(${PN}_LIBRARY "") +set(${PN}_DEFINITIONS USING_${PN}) + +check_required_components(${PN}) + +# make detectable the FindPythonLibsNew.cmake module +list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}) + +include(pybind11Tools) + +if(NOT (CMAKE_VERSION VERSION_LESS 3.0)) +#----------------------------------------------------------------------------- +# Don't include targets if this file is being picked up by another +# project which has already built this as a subproject +#----------------------------------------------------------------------------- +if(NOT TARGET ${PN}::pybind11) + include("${CMAKE_CURRENT_LIST_DIR}/${PN}Targets.cmake") + + find_package(PythonLibsNew ${PYBIND11_PYTHON_VERSION} MODULE REQUIRED) + set_property(TARGET ${PN}::pybind11 APPEND PROPERTY INTERFACE_INCLUDE_DIRECTORIES ${PYTHON_INCLUDE_DIRS}) + set_property(TARGET ${PN}::embed APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${PYTHON_LIBRARIES}) + if(WIN32 OR CYGWIN) + set_property(TARGET ${PN}::module APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${PYTHON_LIBRARIES}) + endif() + + if(CMAKE_VERSION VERSION_LESS 3.3) + set_property(TARGET ${PN}::pybind11 APPEND PROPERTY INTERFACE_COMPILE_OPTIONS "${PYBIND11_CPP_STANDARD}") + else() + set_property(TARGET ${PN}::pybind11 APPEND PROPERTY INTERFACE_COMPILE_OPTIONS $<$<COMPILE_LANGUAGE:CXX>:${PYBIND11_CPP_STANDARD}>) + endif() + + get_property(_iid TARGET ${PN}::pybind11 PROPERTY INTERFACE_INCLUDE_DIRECTORIES) + get_property(_ill TARGET ${PN}::module PROPERTY INTERFACE_LINK_LIBRARIES) + set(${PN}_INCLUDE_DIRS ${_iid}) + set(${PN}_LIBRARIES ${_ico} ${_ill}) +endif() +endif() diff --git a/pybind11/tools/pybind11Tools.cmake b/pybind11/tools/pybind11Tools.cmake new file mode 100644 index 0000000000000000000000000000000000000000..bfba23bc2917128fb0c8f31ffaf48286574d2d88 --- /dev/null +++ b/pybind11/tools/pybind11Tools.cmake @@ -0,0 +1,228 @@ +# tools/pybind11Tools.cmake -- Build system for the pybind11 modules +# +# Copyright (c) 2015 Wenzel Jakob <wenzel@inf.ethz.ch> +# +# All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE +# file. + +cmake_minimum_required(VERSION 2.8.12) + +# Add a CMake parameter for choosing a desired Python version +if(NOT PYBIND11_PYTHON_VERSION) + set(PYBIND11_PYTHON_VERSION "" CACHE STRING "Python version to use for compiling modules") +endif() + +set(Python_ADDITIONAL_VERSIONS 3.7 3.6 3.5 3.4) +find_package(PythonLibsNew ${PYBIND11_PYTHON_VERSION} REQUIRED) + +include(CheckCXXCompilerFlag) +include(CMakeParseArguments) + +if(NOT PYBIND11_CPP_STANDARD AND NOT CMAKE_CXX_STANDARD) + if(NOT MSVC) + check_cxx_compiler_flag("-std=c++14" HAS_CPP14_FLAG) + + if(HAS_CPP14_FLAG) + set(PYBIND11_CPP_STANDARD -std=c++14) + else() + check_cxx_compiler_flag("-std=c++11" HAS_CPP11_FLAG) + if(HAS_CPP11_FLAG) + set(PYBIND11_CPP_STANDARD -std=c++11) + else() + message(FATAL_ERROR "Unsupported compiler -- pybind11 requires C++11 support!") + endif() + endif() + elseif(MSVC) + set(PYBIND11_CPP_STANDARD /std:c++14) + endif() + + set(PYBIND11_CPP_STANDARD ${PYBIND11_CPP_STANDARD} + CACHE STRING "C++ standard flag, e.g. -std=c++11, -std=c++14, /std:c++14. Defaults to C++14 mode." + FORCE) +endif() + +# Checks whether the given CXX/linker flags can compile and link a cxx file. cxxflags and linkerflags are lists of +# flags to use. The result variable is a unique variable name for each set of flags: the compilation result will be +# cached base on the result variable. If the flags work, sets them in cxxflags_out/linkerflags_out internal cache +# variables (in addition to ${result}). +function(_pybind11_return_if_cxx_and_linker_flags_work result cxxflags linkerflags cxxflags_out linkerflags_out) + set(CMAKE_REQUIRED_LIBRARIES ${linkerflags}) + check_cxx_compiler_flag("${cxxflags}" ${result}) + if(${result}) + set(${cxxflags_out} "${cxxflags}" CACHE INTERNAL "" FORCE) + set(${linkerflags_out} "${linkerflags}" CACHE INTERNAL "" FORCE) + endif() +endfunction() + +# Internal: find the appropriate link time optimization flags for this compiler +function(_pybind11_add_lto_flags target_name prefer_thin_lto) + if(NOT DEFINED PYBIND11_LTO_CXX_FLAGS) + set(PYBIND11_LTO_CXX_FLAGS "" CACHE INTERNAL "") + set(PYBIND11_LTO_LINKER_FLAGS "" CACHE INTERNAL "") + + if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang") + set(cxx_append "") + set(linker_append "") + if(CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND NOT APPLE) + # Clang Gold plugin does not support -Os; append -O3 to MinSizeRel builds to override it + set(linker_append ";$<$<CONFIG:MinSizeRel>:-O3>") + elseif(CMAKE_CXX_COMPILER_ID MATCHES "GNU") + set(cxx_append ";-fno-fat-lto-objects") + endif() + + if(CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND prefer_thin_lto) + _pybind11_return_if_cxx_and_linker_flags_work(HAS_FLTO_THIN + "-flto=thin${cxx_append}" + "-flto=thin${linker_append}" + PYBIND11_LTO_CXX_FLAGS + PYBIND11_LTO_LINKER_FLAGS) + endif() + + if(NOT HAS_FLTO_THIN) + _pybind11_return_if_cxx_and_linker_flags_work(HAS_FLTO + "-flto${cxx_append}" + "-flto${linker_append}" + PYBIND11_LTO_CXX_FLAGS + PYBIND11_LTO_LINKER_FLAGS) + endif() + elseif(CMAKE_CXX_COMPILER_ID MATCHES "Intel") + # Intel equivalent to LTO is called IPO + _pybind11_return_if_cxx_and_linker_flags_work(HAS_INTEL_IPO + "-ipo" + "-ipo" + PYBIND11_LTO_CXX_FLAGS + PYBIND11_LTO_LINKER_FLAGS) + elseif(MSVC) + # cmake only interprets libraries as linker flags when they start with a - (otherwise it converts /LTCG to \LTCG + # as if it was a Windows path). Luckily MSVC supports passing flags with - instead of /, even if it is a bit + # non-standard: + _pybind11_return_if_cxx_and_linker_flags_work(HAS_MSVC_GL_LTCG + "/GL" + "-LTCG" + PYBIND11_LTO_CXX_FLAGS + PYBIND11_LTO_LINKER_FLAGS) + endif() + + if(PYBIND11_LTO_CXX_FLAGS) + message(STATUS "LTO enabled") + else() + message(STATUS "LTO disabled (not supported by the compiler and/or linker)") + endif() + endif() + + # Enable LTO flags if found, except for Debug builds + if(PYBIND11_LTO_CXX_FLAGS) + target_compile_options(${target_name} PRIVATE "$<$<NOT:$<CONFIG:Debug>>:${PYBIND11_LTO_CXX_FLAGS}>") + endif() + if(PYBIND11_LTO_LINKER_FLAGS) + target_link_libraries(${target_name} PRIVATE "$<$<NOT:$<CONFIG:Debug>>:${PYBIND11_LTO_LINKER_FLAGS}>") + endif() +endfunction() + +# Build a Python extension module: pybind11_add_module(<name> [MODULE | SHARED] [EXCLUDE_FROM_ALL] [NO_EXTRAS] [SYSTEM] +# [THIN_LTO] source1 [source2 ...]) +# +function(pybind11_add_module target_name) + set(options MODULE SHARED EXCLUDE_FROM_ALL NO_EXTRAS SYSTEM THIN_LTO) + cmake_parse_arguments(ARG "${options}" "" "" ${ARGN}) + + if(ARG_MODULE AND ARG_SHARED) + message(FATAL_ERROR "Can't be both MODULE and SHARED") + elseif(ARG_SHARED) + set(lib_type SHARED) + else() + set(lib_type MODULE) + endif() + + if(ARG_EXCLUDE_FROM_ALL) + set(exclude_from_all EXCLUDE_FROM_ALL) + endif() + + add_library(${target_name} ${lib_type} ${exclude_from_all} ${ARG_UNPARSED_ARGUMENTS}) + + if(ARG_SYSTEM) + set(inc_isystem SYSTEM) + endif() + + target_include_directories(${target_name} ${inc_isystem} + PRIVATE ${PYBIND11_INCLUDE_DIR} # from project CMakeLists.txt + PRIVATE ${pybind11_INCLUDE_DIR} # from pybind11Config + PRIVATE ${PYTHON_INCLUDE_DIRS}) + + # Python debug libraries expose slightly different objects https://docs.python.org/3.6/c-api/intro.html#debugging- + # builds https://stackoverflow.com/questions/39161202/how-to-work-around-missing-pymodule-create2-in-amd64-win- + # python35-d-lib + if(PYTHON_IS_DEBUG) + target_compile_definitions(${target_name} PRIVATE Py_DEBUG) + endif() + + # The prefix and extension are provided by FindPythonLibsNew.cmake + set_target_properties(${target_name} PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}") + set_target_properties(${target_name} PROPERTIES SUFFIX "${PYTHON_MODULE_EXTENSION}") + + # -fvisibility=hidden is required to allow multiple modules compiled against different pybind versions to work + # properly, and for some features (e.g. py::module_local). We force it on everything inside the `pybind11` + # namespace; also turning it on for a pybind module compilation here avoids potential warnings or issues from having + # mixed hidden/non-hidden types. + set_target_properties(${target_name} PROPERTIES CXX_VISIBILITY_PRESET "hidden") + set_target_properties(${target_name} PROPERTIES CUDA_VISIBILITY_PRESET "hidden") + + if(WIN32 OR CYGWIN) + # Link against the Python shared library on Windows + target_link_libraries(${target_name} PRIVATE ${PYTHON_LIBRARIES}) + elseif(APPLE) + # It's quite common to have multiple copies of the same Python version installed on one's system. E.g.: one copy + # from the OS and another copy that's statically linked into an application like Blender or Maya. If we link our + # plugin library against the OS Python here and import it into Blender or Maya later on, this will cause segfaults + # when multiple conflicting Python instances are active at the same time (even when they are of the same version). + + # Windows is not affected by this issue since it handles DLL imports differently. The solution for Linux and Mac OS + # is simple: we just don't link against the Python library. The resulting shared library will have missing symbols, + # but that's perfectly fine -- they will be resolved at import time. + + target_link_libraries(${target_name} PRIVATE "-undefined dynamic_lookup") + + if(ARG_SHARED) + # Suppress CMake >= 3.0 warning for shared libraries + set_target_properties(${target_name} PROPERTIES MACOSX_RPATH ON) + endif() + endif() + + # Make sure C++11/14 are enabled + if(CMAKE_VERSION VERSION_LESS 3.3) + target_compile_options(${target_name} PUBLIC ${PYBIND11_CPP_STANDARD}) + else() + target_compile_options(${target_name} PUBLIC $<$<COMPILE_LANGUAGE:CXX>:${PYBIND11_CPP_STANDARD}>) + endif() + + if(ARG_NO_EXTRAS) + return() + endif() + + _pybind11_add_lto_flags(${target_name} ${ARG_THIN_LTO}) + + if(NOT MSVC AND NOT ${CMAKE_BUILD_TYPE} MATCHES Debug) + # Strip unnecessary sections of the binary on Linux/Mac OS + if(CMAKE_STRIP) + if(APPLE) + add_custom_command(TARGET ${target_name} POST_BUILD COMMAND ${CMAKE_STRIP} -x $<TARGET_FILE:${target_name}>) + else() + add_custom_command(TARGET ${target_name} POST_BUILD COMMAND ${CMAKE_STRIP} $<TARGET_FILE:${target_name}>) + endif() + endif() + endif() + + if(MSVC) + # /MP enables multithreaded builds (relevant when there are many files), /bigobj is needed for bigger binding + # projects due to the limit to 64k addressable sections + target_compile_options(${target_name} PRIVATE /bigobj) + if(CMAKE_VERSION VERSION_LESS 3.11) + target_compile_options(${target_name} PRIVATE $<$<NOT:$<CONFIG:Debug>>:/MP>) + else() + # Only set these options for C++ files. This is important so that, for instance, projects that include other + # types of source files like CUDA .cu files don't get these options propagated to nvcc since that would cause the + # build to fail. + target_compile_options(${target_name} PRIVATE $<$<NOT:$<CONFIG:Debug>>:$<$<COMPILE_LANGUAGE:CXX>:/MP>>) + endif() + endif() +endfunction() diff --git a/python/.gitignore b/python/.gitignore index 58e6ca4a8c3af60480b758823c97633a401e401f..048c38c51d43cc3a431713f51a571b059605f26d 100644 --- a/python/.gitignore +++ b/python/.gitignore @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2016, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ build/ diff --git a/python/CMakeLists.txt b/python/CMakeLists.txt index c0521162ec97a214e66e2f9c864d9abe98983e69..9b3209225507644b91ba2d117beb56b8fde9c7ff 100644 --- a/python/CMakeLists.txt +++ b/python/CMakeLists.txt @@ -1,16 +1,20 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2019) # René Fritze (2018 - 2019) -# Tobias Leibner (2018) +# Tobias Leibner (2018, 2020) # ~~~ +# Currently, the python libraries do not have access to the config.h variables, see +# https://github.com/dune-community/dune-xt-common/issues/120 +# The following silences all the resulting -Wundef warnings in this directory +add_compile_options(-Wno-undef) add_subdirectory(dune) add_subdirectory(scripts) add_subdirectory(wrapper) diff --git a/python/LICENSE.txt b/python/LICENSE.txt index 0b777d181e2fb1afbaf7a8d01371003bda8e90b8..4ef3baa5dc897f948b0ccb138dbdf099f71d6a29 100644 --- a/python/LICENSE.txt +++ b/python/LICENSE.txt @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2013 - 2014, 2016 - 2017) # René Fritze (2015 - 2016, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ BSD 2-Clause License @@ -36,7 +37,7 @@ GNU GENERAL PUBLIC LICENSE Version 2, June 1991 -Copyright (C) 1989, 1991 Free Software Foundation, Inc. +Copyright (C) 1989, 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies @@ -123,7 +124,7 @@ END OF TERMS AND CONDITIONS Runtime Exception ----------------- -As a special exception, you may use the dune-xt-common library without +As a special exception, you may use the dune-xt library without restriction. Specifically, if other files instantiate templates or use macros or inline functions from one or more of the DUNE source files, or you compile one or more of the DUNE source files and link diff --git a/python/README.md b/python/README.md index 04f9cdab39a83d9b4d9f7d095c74c0b30a2af10b..456cf7c890c2ebb2a5bd1039c02810fb24d5b44c 100644 --- a/python/README.md +++ b/python/README.md @@ -1,12 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2016, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ diff --git a/python/dune/CMakeLists.txt b/python/dune/CMakeLists.txt index 4507de8468a257b952b9f997520b6b283d55ff5d..009379f89722e1c8cc03ac99881367f78d3d9a61 100644 --- a/python/dune/CMakeLists.txt +++ b/python/dune/CMakeLists.txt @@ -1,12 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: -# René Fritze (2018 - 2019) +# René Fritze (2018 - 2019) +# Tobias Leibner (2020) # ~~~ add_subdirectory(xt) diff --git a/python/dune/__init__.py b/python/dune/__init__.py index e4d7370bd127a57248d86d3fa10f133f42a98e4a..cfa24733bf4cb781897b711882d517265bfd1103 100644 --- a/python/dune/__init__.py +++ b/python/dune/__init__.py @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2014, 2016 - 2017) # René Fritze (2012, 2015 - 2016, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ __import__('pkg_resources').declare_namespace(__name__) diff --git a/python/dune/pybindxi/__init__.py b/python/dune/pybindxi/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..896830e5473034799da5a50a8f8db0f695c7c243 --- /dev/null +++ b/python/dune/pybindxi/__init__.py @@ -0,0 +1,11 @@ +# ~~~ +# This file is part of the dune-pybindxi project: +# https://github.com/dune-community/dune-pybindxi +# Copyright 2009-2018 dune-pybindxi developers and contributors. All rights reserved. +# License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) +# Authors: +# Rene Milk (2018) +# +# or GPL-2.0+ (http://opensource.org/licenses/gpl-license) +# with "runtime exception" (http://www.dune-project.org/license.html) +# ~~~ diff --git a/python/dune/xt/CMakeLists.txt b/python/dune/xt/CMakeLists.txt index 25fa424b0499298cc26e7ef6644f69d61d12187c..6abc63429c63af22da36ab960d6a6991171b0363 100644 --- a/python/dune/xt/CMakeLists.txt +++ b/python/dune/xt/CMakeLists.txt @@ -1,7 +1,7 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ # Felix Schindler (2019) # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ dune_pybindxi_add_module(userbindings EXCLUDE_FROM_ALL userbindings.cc) diff --git a/python/dune/xt/__init__.py b/python/dune/xt/__init__.py index b4f59a84d0caf6cef97785648060caca85beb7b3..13b368a5aa30ecf71533065983f2c88e5bee8f4d 100644 --- a/python/dune/xt/__init__.py +++ b/python/dune/xt/__init__.py @@ -1,7 +1,7 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) @@ -9,7 +9,7 @@ # Felix Schindler (2014, 2016 - 2017, 2019) # René Fritze (2012, 2015 - 2016, 2018 - 2019) # Tim Keil (2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ # Note: This import makes sure that metis is imported before python bindings from dune-xt. Importing dune-xt python diff --git a/python/dune/xt/cmake.py b/python/dune/xt/cmake.py index 360a64f09e63f254c4ebfc977bc1dda22f59cb97..875449d06a457966bf17cd56bbc3e6441af55544 100644 --- a/python/dune/xt/cmake.py +++ b/python/dune/xt/cmake.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017, 2019) # René Fritze (2017 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ import os diff --git a/python/dune/xt/codegen.py b/python/dune/xt/codegen.py index 6fe3bba505168fa5f6fa3f29009ef67e1d2ab2cf..89dd16bcca875ba9a6940070f06bf62ac74ac327 100644 --- a/python/dune/xt/codegen.py +++ b/python/dune/xt/codegen.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017, 2019) # René Fritze (2017 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ diff --git a/python/dune/xt/common/CMakeLists.txt b/python/dune/xt/common/CMakeLists.txt index f5de0609545b4849ffee65e57432490390dc9638..2e38bfe3e0fbcf1c4a5771b14db36a20a42f3aeb 100644 --- a/python/dune/xt/common/CMakeLists.txt +++ b/python/dune/xt/common/CMakeLists.txt @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2019) # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ dune_pybindxi_add_module(logging EXCLUDE_FROM_ALL logging.cc) diff --git a/python/dune/xt/common/__init__.py b/python/dune/xt/common/__init__.py index 43751faaf74f0fa51d92a1296e04ce5f31faf85d..9c7f9f978344ca0e0fa9941b0b787eb33bc2d551 100644 --- a/python/dune/xt/common/__init__.py +++ b/python/dune/xt/common/__init__.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017, 2019) # René Fritze (2018 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ from dune.xt import guarded_import diff --git a/python/dune/xt/common/bindings.hh b/python/dune/xt/common/bindings.hh index d04a5ba90252bcc4c05b5f2cfe36907a0ef25585..ee132f7087bf045c5712e68a8f5bcdcef0385c30 100644 --- a/python/dune/xt/common/bindings.hh +++ b/python/dune/xt/common/bindings.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017, 2019) // René Fritze (2018 - 2019) -// Tobias Leibner (2017) +// Tobias Leibner (2017, 2020) #ifndef DUNE_XT_COMMON_BINDINGS_HH #define DUNE_XT_COMMON_BINDINGS_HH diff --git a/python/dune/xt/common/configuration.hh b/python/dune/xt/common/configuration.hh index bcf4035ac35f01f7245b69967ecd5bebd0a220dd..a5cc6ad78c763ccad75d2ca3474efddca6b9969b 100644 --- a/python/dune/xt/common/configuration.hh +++ b/python/dune/xt/common/configuration.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) // René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_CONFIGURATION_PBH #define DUNE_XT_COMMON_CONFIGURATION_PBH diff --git a/python/dune/xt/common/empty.cc b/python/dune/xt/common/empty.cc index 67de967c644a24530aa65b6ce2bdcce202617b69..0460a92220b02587d2df18d22a6b5d830ea33cb5 100644 --- a/python/dune/xt/common/empty.cc +++ b/python/dune/xt/common/empty.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) // René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include "config.h" diff --git a/python/dune/xt/common/exceptions.bindings.hh b/python/dune/xt/common/exceptions.bindings.hh index d20052e4ba91d0434b8a9c28c6fba608103d2284..52412af174702f4ca84c824d6485c9eb56284192 100644 --- a/python/dune/xt/common/exceptions.bindings.hh +++ b/python/dune/xt/common/exceptions.bindings.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) // René Fritze (2018 - 2019) -// Tobias Leibner (2017) +// Tobias Leibner (2017, 2020) #ifndef DUNE_XT_COMMON_EXCEPTIONS_BINDINGS_HH #define DUNE_XT_COMMON_EXCEPTIONS_BINDINGS_HH diff --git a/python/dune/xt/common/exceptions.cc b/python/dune/xt/common/exceptions.cc index 195fc031dafceb9b886b69bd72bcfd14b07a3499..6894b96d265c08ab94fdd401ad62647c486b8cfc 100644 --- a/python/dune/xt/common/exceptions.cc +++ b/python/dune/xt/common/exceptions.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) // René Fritze (2019) +// Tobias Leibner (2020) #include "config.h" diff --git a/python/dune/xt/common/fmatrix.hh b/python/dune/xt/common/fmatrix.hh index e78c0419a95a3a9e374b908b29ddecb6d9e3d7bd..7dc3b0138aa0cc9563d19d1a9dfd9893cb232429 100644 --- a/python/dune/xt/common/fmatrix.hh +++ b/python/dune/xt/common/fmatrix.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,6 +8,7 @@ // Felix Schindler (2016 - 2017) // René Fritze (2018 - 2019) // Tim Keil (2018) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_FMATRIX_PBH #define DUNE_XT_COMMON_FMATRIX_PBH diff --git a/python/dune/xt/common/fvector.hh b/python/dune/xt/common/fvector.hh index eb128f61be2ce23413866e28b11b1741bfc20915..c356bd211a59bb3560264caa905fdbc0f469a4f3 100644 --- a/python/dune/xt/common/fvector.hh +++ b/python/dune/xt/common/fvector.hh @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,6 +8,7 @@ // Felix Schindler (2016 - 2017) // René Fritze (2018 - 2019) // Tim Keil (2018) +// Tobias Leibner (2020) #ifndef DUNE_XT_COMMON_FVECTOR_PBH #define DUNE_XT_COMMON_FVECTOR_PBH diff --git a/python/dune/xt/common/logging.cc b/python/dune/xt/common/logging.cc index ec59e299a4ee1f2f54aeeba858b7b499759f4ee1..ec318b43420b0d3eb4f8fd879504a6d03fa5be12 100644 --- a/python/dune/xt/common/logging.cc +++ b/python/dune/xt/common/logging.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) // René Fritze (2018 - 2019) +// Tobias Leibner (2020) #include "config.h" diff --git a/python/dune/xt/common/mpi.cc b/python/dune/xt/common/mpi.cc index f46f78ff0678d1ee29dd5dc1eeffbd78453ac9b3..8f423e3ebc8f2d7db6a9541d4b72ecef20bc747f 100644 --- a/python/dune/xt/common/mpi.cc +++ b/python/dune/xt/common/mpi.cc @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2016 - 2019) // René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #include "config.h" diff --git a/python/dune/xt/common/test.py b/python/dune/xt/common/test.py index 5d1e13af1e49360f1bc130e2408d079609cbac08..9477207f6a3cd4008cf3fb0df4e0f5fb53ff777c 100644 --- a/python/dune/xt/common/test.py +++ b/python/dune/xt/common/test.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ from pkg_resources import resource_filename, resource_stream diff --git a/python/dune/xt/common/timedlogging.cc b/python/dune/xt/common/timedlogging.cc index 897e510d4f77ae676ce20be3ac45c95225cc9b8c..4aa24a50f262e65e05c892e29c1385e6530222f3 100644 --- a/python/dune/xt/common/timedlogging.cc +++ b/python/dune/xt/common/timedlogging.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) // René Fritze (2019) +// Tobias Leibner (2020) #include "config.h" diff --git a/python/dune/xt/common/timings.cc b/python/dune/xt/common/timings.cc index 22bae4f4b85194f846303c8f2ff4ca297db0c2f5..d5078ea80dd9f1e3daadc36f29de42fd8b773acd 100644 --- a/python/dune/xt/common/timings.cc +++ b/python/dune/xt/common/timings.cc @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) // René Fritze (2018 - 2019) +// Tobias Leibner (2019 - 2020) #include "config.h" diff --git a/python/dune/xt/common/timings.py b/python/dune/xt/common/timings.py index 836066f6f3fd16b1449afd7c7bd1e6744e0702d2..0c8c9fce2588e186cdfc80320bf36e406dfd3701 100644 --- a/python/dune/xt/common/timings.py +++ b/python/dune/xt/common/timings.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2019) # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ from dune.xt import guarded_import diff --git a/python/dune/xt/functions/CMakeLists.txt b/python/dune/xt/functions/CMakeLists.txt index 0c5298b4989743c7226ffe574b8afb911e71ad34..980de39f8406b80e0b091f1d2df111077b96cdcf 100644 --- a/python/dune/xt/functions/CMakeLists.txt +++ b/python/dune/xt/functions/CMakeLists.txt @@ -1,15 +1,15 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2019) -# René Fritze (2018) +# René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ dune_pybindxi_add_module(_functions_function_interface_1d EXCLUDE_FROM_ALL function-interface-1d.cc) diff --git a/python/dune/xt/functions/ESV2007.bindings.hh b/python/dune/xt/functions/ESV2007.bindings.hh index b5d3fdd0574a1eea4907c100a6312f80e3ae810e..f4b7ef6fc4b425fbc36796b80e220fd1b07047ae 100644 --- a/python/dune/xt/functions/ESV2007.bindings.hh +++ b/python/dune/xt/functions/ESV2007.bindings.hh @@ -1,13 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017, 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) +// Tobias Leibner (2020) #ifndef DUNE_XT_FUNCTIONS_ESV2007_BINDINGS_HH #define DUNE_XT_FUNCTIONS_ESV2007_BINDINGS_HH diff --git a/python/dune/xt/functions/__init__.py b/python/dune/xt/functions/__init__.py index 1900bc3cc4b8284b4421d4360e91dc61e7b8ee15..e34ea6dc5c7e375c144d1f1bd330dc2c192da56a 100644 --- a/python/dune/xt/functions/__init__.py +++ b/python/dune/xt/functions/__init__.py @@ -1,15 +1,15 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017, 2019) -# René Fritze (2018) +# René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ from dune.xt import guarded_import diff --git a/python/dune/xt/functions/bindings.cc b/python/dune/xt/functions/bindings.cc index 6fa38bc118e3e88993d2f052865879d3d035c259..7a7ac6793afd7df7df56044e5b7d3457557dd590 100644 --- a/python/dune/xt/functions/bindings.cc +++ b/python/dune/xt/functions/bindings.cc @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #include "config.h" diff --git a/python/dune/xt/functions/checkerboard.cc b/python/dune/xt/functions/checkerboard.cc index 42fdbad618a470824aefb5a0053c1112e463650b..b393013e6ad242b06652a7b43c5300de8b20e39c 100644 --- a/python/dune/xt/functions/checkerboard.cc +++ b/python/dune/xt/functions/checkerboard.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #include "config.h" diff --git a/python/dune/xt/functions/checkerboard.hh b/python/dune/xt/functions/checkerboard.hh index 640753e5ec4902e3798e645ea609eb0d862e3fbd..1b1df6c9f932193dea66143f970537fc209f6f8f 100644 --- a/python/dune/xt/functions/checkerboard.hh +++ b/python/dune/xt/functions/checkerboard.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017, 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #ifndef PYTHON_DUNE_XT_FUNCTIONS_CHECKERBOARD_HH #define PYTHON_DUNE_XT_FUNCTIONS_CHECKERBOARD_HH @@ -41,7 +41,8 @@ static const constexpr size_t d = G::dimension; template <class G, size_t d, size_t r, size_t rC> typename std::enable_if< Grid::is_grid<G>::value, - pybind11::class_<CheckerboardFunction<typename G::template Codim<0>::Entity, r, rC, double>>>::type + pybind11::class_<CheckerboardFunction<typename G::template Codim<0>::Entity, r, rC, double>, + GridFunctionInterface<typename G::template Codim<0>::Entity, r, rC, double>>>::type bind_CheckerboardFunction(pybind11::module& m, const std::string& grid_id) { namespace py = pybind11; diff --git a/python/dune/xt/functions/constant.cc b/python/dune/xt/functions/constant.cc index 0325c2b8ba6ad6e9032b56aaca99011a771b4e62..4d0162cb473ad4c8aed95116510d703b47323d71 100644 --- a/python/dune/xt/functions/constant.cc +++ b/python/dune/xt/functions/constant.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2020) #include "config.h" diff --git a/python/dune/xt/functions/expression.cc b/python/dune/xt/functions/expression.cc index 0b44fe9aa0844e9e2164b76626d89b98b4b45d8f..6938bdd87502b6fd25ecad836e660f5aa0f89472 100644 --- a/python/dune/xt/functions/expression.cc +++ b/python/dune/xt/functions/expression.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2020) #include "config.h" diff --git a/python/dune/xt/functions/expression.hh b/python/dune/xt/functions/expression.hh index d5665bda2fc4a46baa337b0074ccd229a44f65ce..9fb741bf714cc839dcc19cd0d02f1d5df9e182a2 100644 --- a/python/dune/xt/functions/expression.hh +++ b/python/dune/xt/functions/expression.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017, 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #ifndef PYTHON_DUNE_XT_FUNCTIONS_EXPRESSION_HH #define PYTHON_DUNE_XT_FUNCTIONS_EXPRESSION_HH @@ -79,8 +79,8 @@ static const constexpr size_t d = G::dimension; * everywhere: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=59937 */ template <size_t d, size_t r> -pybind11::class_<ExpressionFunction<d, r, 3, double>> bind_ExpressionFunction(pybind11::module& m, - std::integral_constant<int, 3>) +pybind11::class_<ExpressionFunction<d, r, 3, double>, FunctionInterface<d, r, 3, double>> +bind_ExpressionFunction(pybind11::module& m, std::integral_constant<int, 3>) { namespace py = pybind11; using namespace pybind11::literals; @@ -141,8 +141,8 @@ pybind11::class_<ExpressionFunction<d, r, 3, double>> bind_ExpressionFunction(py } // ... bind_ExpressionFunction(...) template <size_t d, size_t r> -pybind11::class_<ExpressionFunction<d, r, 2, double>> bind_ExpressionFunction(pybind11::module& m, - std::integral_constant<int, 2>) +pybind11::class_<ExpressionFunction<d, r, 2, double>, FunctionInterface<d, r, 2, double>> +bind_ExpressionFunction(pybind11::module& m, std::integral_constant<int, 2>) { namespace py = pybind11; using namespace pybind11::literals; @@ -204,8 +204,8 @@ pybind11::class_<ExpressionFunction<d, r, 2, double>> bind_ExpressionFunction(py } // ... bind_ExpressionFunction(...) template <size_t d, size_t r> -pybind11::class_<ExpressionFunction<d, r, 1, double>> bind_ExpressionFunction(pybind11::module& m, - std::integral_constant<int, 1>) +pybind11::class_<ExpressionFunction<d, r, 1, double>, FunctionInterface<d, r, 1, double>> +bind_ExpressionFunction(pybind11::module& m, std::integral_constant<int, 1>) { namespace py = pybind11; using namespace pybind11::literals; diff --git a/python/dune/xt/functions/function-as-grid-function.cc b/python/dune/xt/functions/function-as-grid-function.cc index a976bda4b8aead000eeaafa2305125a94586f15c..68ee9187284544b9e36fdbcedae5e73dc623132c 100644 --- a/python/dune/xt/functions/function-as-grid-function.cc +++ b/python/dune/xt/functions/function-as-grid-function.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #include "config.h" diff --git a/python/dune/xt/functions/function-as-grid-function.hh b/python/dune/xt/functions/function-as-grid-function.hh index 1fe6989efff14b53f6d6d2b637ae6d89fd9cfcc9..156d7abadc89f89204ada16faafc0644452ab0c2 100644 --- a/python/dune/xt/functions/function-as-grid-function.hh +++ b/python/dune/xt/functions/function-as-grid-function.hh @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #ifndef PYTHON_DUNE_XT_FUNCTIONS_FUNCTION_AS_GRID_FUNCTION_HH #define PYTHON_DUNE_XT_FUNCTIONS_FUNCTION_AS_GRID_FUNCTION_HH @@ -27,7 +29,8 @@ namespace bindings { template <class G, size_t d, size_t r, size_t rC> typename std::enable_if< Grid::is_grid<G>::value, - pybind11::class_<FunctionAsGridFunctionWrapper<typename G::template Codim<0>::Entity, r, rC, double>>>::type + pybind11::class_<FunctionAsGridFunctionWrapper<typename G::template Codim<0>::Entity, r, rC, double>, + GridFunctionInterface<typename G::template Codim<0>::Entity, r, rC, double>>>::type bind_FunctionAsGridFunctionWrapper(pybind11::module& m, const std::string& grid_id) { namespace py = pybind11; diff --git a/python/dune/xt/functions/function-interface-1d.cc b/python/dune/xt/functions/function-interface-1d.cc index a0a84547ed84976830677d450342dd30d8ad0b4a..55a48b8fe73da3c9ce9c89f12ba303fda3921ec2 100644 --- a/python/dune/xt/functions/function-interface-1d.cc +++ b/python/dune/xt/functions/function-interface-1d.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2020) #include "config.h" diff --git a/python/dune/xt/functions/function-interface-2d.cc b/python/dune/xt/functions/function-interface-2d.cc index 3e44773ccafc3ee49bbb8d926625698ac71aaa7e..8342ff43d426eb521d086ad58877f36b966a2331 100644 --- a/python/dune/xt/functions/function-interface-2d.cc +++ b/python/dune/xt/functions/function-interface-2d.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2020) #include "config.h" diff --git a/python/dune/xt/functions/function-interface-3d.cc b/python/dune/xt/functions/function-interface-3d.cc index 5bc2c6fc531d66d3782020453275ea394a0d67e8..ff1fe0f6581fe9c34aa62b81744f46074fa63370 100644 --- a/python/dune/xt/functions/function-interface-3d.cc +++ b/python/dune/xt/functions/function-interface-3d.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2020) #include "config.h" diff --git a/python/dune/xt/functions/function-interface.cc b/python/dune/xt/functions/function-interface.cc index 4c024c62af44c6dbd334944864a06a4a9cd41a77..75a7e592105a94ddfe1d1905e097b88019fc75c6 100644 --- a/python/dune/xt/functions/function-interface.cc +++ b/python/dune/xt/functions/function-interface.cc @@ -1,6 +1,6 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) @@ -8,7 +8,7 @@ // Felix Schindler (2016 - 2017, 2019) // René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #include "config.h" diff --git a/python/dune/xt/functions/function-interface.hh b/python/dune/xt/functions/function-interface.hh index 5b09b17f831775b23ec740ad936e41f086f5ea5d..ddfcac249cb032161ffe246d4ef761a7ff8d8754 100644 --- a/python/dune/xt/functions/function-interface.hh +++ b/python/dune/xt/functions/function-interface.hh @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2020) #ifndef PYTHON_DUNE_XT_FUNCTIONS_FUNCTION_INTERFACE_HH #define PYTHON_DUNE_XT_FUNCTIONS_FUNCTION_INTERFACE_HH @@ -111,10 +113,15 @@ struct get_combined<L, R, CombinationType::product> } // namespace internal -template <size_t d, CombinationType comb, size_t lr, size_t lrC, size_t rr, size_t rrC> -pybind11::class_<typename internal::get_combined<FunctionInterface<d, lr, lrC, double>, - FunctionInterface<d, rr, rrC, double>, - comb>::type> +template <size_t d, + CombinationType comb, + size_t lr, + size_t lrC, + size_t rr, + size_t rrC, + class C = typename internal:: + get_combined<FunctionInterface<d, lr, lrC, double>, FunctionInterface<d, rr, rrC, double>, comb>::type> +pybind11::class_<C, FunctionInterface<d, C::range_dim, C::range_dim_cols, double>> bind_combined_Function(pybind11::module& m) { namespace py = pybind11; @@ -122,7 +129,6 @@ bind_combined_Function(pybind11::module& m) typedef double R; typedef FunctionInterface<d, lr, lrC, R> Left; typedef FunctionInterface<d, rr, rrC, R> Right; - typedef typename internal::get_combined<Left, Right, comb>::type C; static const size_t r = C::range_dim; static const size_t rC = C::range_dim_cols; const std::string id = internal::get_combined<Left, Right, comb>::id(); diff --git a/python/dune/xt/functions/gridfunction-interface-1d.cc b/python/dune/xt/functions/gridfunction-interface-1d.cc index 7c6b4a8e24816d7dc3eb5079518e45d91b8f6201..342ccc44169647247b9adf9f8d0e72a4f53876ec 100644 --- a/python/dune/xt/functions/gridfunction-interface-1d.cc +++ b/python/dune/xt/functions/gridfunction-interface-1d.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #include "config.h" diff --git a/python/dune/xt/functions/gridfunction-interface-2d.cc b/python/dune/xt/functions/gridfunction-interface-2d.cc index 05c0397bc5344018c7ace45555535dd2f3bd2ca6..0d003986e08d1d1ace735b8a62d49e187bd61b82 100644 --- a/python/dune/xt/functions/gridfunction-interface-2d.cc +++ b/python/dune/xt/functions/gridfunction-interface-2d.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #include "config.h" diff --git a/python/dune/xt/functions/gridfunction-interface-3d.cc b/python/dune/xt/functions/gridfunction-interface-3d.cc index 217f5ec41f5ef6e6308048d537fee4f99f3257b5..db8793bba427a1606733ade8a007b8466eefde55 100644 --- a/python/dune/xt/functions/gridfunction-interface-3d.cc +++ b/python/dune/xt/functions/gridfunction-interface-3d.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #include "config.h" diff --git a/python/dune/xt/functions/gridfunction-interface.hh b/python/dune/xt/functions/gridfunction-interface.hh index 9a3baf04d930d7fd0f39f0601c76adcacd142591..3ec90b15ca5d469ae113f5eba539a2eb2d7f27ce 100644 --- a/python/dune/xt/functions/gridfunction-interface.hh +++ b/python/dune/xt/functions/gridfunction-interface.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_FUNCTIONS_INTERFACE_PBH #define DUNE_XT_FUNCTIONS_INTERFACE_PBH @@ -261,11 +261,19 @@ static const constexpr size_t d = G::dimension; \endcode * but this triggers a bug in gcc-4.9, see e.g.: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=59937 */ -template <class G, size_t d, CombinationType comb, size_t lr, size_t lrC, size_t rr, size_t rrC> -pybind11::class_< - typename internal::get_grid_combined<GridFunctionInterface<typename G::template Codim<0>::Entity, lr, lrC, double>, - GridFunctionInterface<typename G::template Codim<0>::Entity, rr, rrC, double>, - comb>::type> +template <class G, + size_t d, + CombinationType comb, + size_t lr, + size_t lrC, + size_t rr, + size_t rrC, + class C = typename internal::get_grid_combined< + GridFunctionInterface<typename G::template Codim<0>::Entity, lr, lrC, double>, + GridFunctionInterface<typename G::template Codim<0>::Entity, rr, rrC, double>, + comb>::type> +pybind11::class_<C, + GridFunctionInterface<typename G::template Codim<0>::Entity, C::range_dim, C::range_dim_cols, double>> bind_combined_GridFunction(pybind11::module& m, const std::string& grid_id) { namespace py = pybind11; @@ -274,7 +282,6 @@ bind_combined_GridFunction(pybind11::module& m, const std::string& grid_id) typedef double R; typedef GridFunctionInterface<E, lr, lrC, R> Left; typedef GridFunctionInterface<E, rr, rrC, R> Right; - typedef typename internal::get_grid_combined<Left, Right, comb>::type C; static const size_t r = C::range_dim; static const size_t rC = C::range_dim_cols; const std::string id = internal::get_grid_combined<Left, Right, comb>::id(); diff --git a/python/dune/xt/functions/indicator.cc b/python/dune/xt/functions/indicator.cc index a9e06be818be1973bdd89ca237fcd0282cab6f36..96699edf1d4d69e26891ed6eaac0a0194e271965 100644 --- a/python/dune/xt/functions/indicator.cc +++ b/python/dune/xt/functions/indicator.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #include "config.h" diff --git a/python/dune/xt/functions/indicator.hh b/python/dune/xt/functions/indicator.hh index 0c4c43c1a3e15d1e44a032bd745e82a58aacddf2..3d6e155d99b3c2313c62da72452a688dc6b41d19 100644 --- a/python/dune/xt/functions/indicator.hh +++ b/python/dune/xt/functions/indicator.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2018 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018 - 2019) +// Tobias Leibner (2018 - 2020) #ifndef PYTHON_DUNE_XT_FUNCTIONS_INDICATOR_HH #define PYTHON_DUNE_XT_FUNCTIONS_INDICATOR_HH @@ -32,7 +32,8 @@ namespace Functions { template <class G, size_t d, size_t r, size_t rC> typename std::enable_if< Grid::is_grid<G>::value, - pybind11::class_<IndicatorGridFunction<typename G::template Codim<0>::Entity, r, rC, double>>>::type + pybind11::class_<IndicatorGridFunction<typename G::template Codim<0>::Entity, r, rC, double>, + GridFunctionInterface<typename G::template Codim<0>::Entity, r, rC, double>>>::type bind_IndicatorGridFunction(pybind11::module& m, const std::string& grid_id) { namespace py = pybind11; @@ -76,7 +77,8 @@ bind_IndicatorGridFunction(pybind11::module& m, const std::string& grid_id) template <size_t d, size_t r, size_t rC> -typename pybind11::class_<IndicatorFunction<d, r, rC, double>> bind_IndicatorFunction(pybind11::module& m) +typename pybind11::class_<IndicatorFunction<d, r, rC, double>, FunctionInterface<d, r, rC, double>> +bind_IndicatorFunction(pybind11::module& m) { namespace py = pybind11; using namespace pybind11::literals; diff --git a/python/dune/xt/functions/spe10.cc b/python/dune/xt/functions/spe10.cc index 7a518b7ee4461ccf7bb2de5c90a9182b79ee921a..e451c4881bb7368356a84267ee67a8ab51b27429 100644 --- a/python/dune/xt/functions/spe10.cc +++ b/python/dune/xt/functions/spe10.cc @@ -1,11 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) +// René Fritze (2019) +// Tobias Leibner (2019 - 2020) #include "config.h" diff --git a/python/dune/xt/functions/spe10.hh b/python/dune/xt/functions/spe10.hh index baeebbe38cc273934ba48a078f87879ea883a038..447d1af7250fbf080f4b86bcf646e4fcdea5f191 100644 --- a/python/dune/xt/functions/spe10.hh +++ b/python/dune/xt/functions/spe10.hh @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017, 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #ifndef PYTHON_DUNE_XT_FUNCTIONS_SPE10_HH #define PYTHON_DUNE_XT_FUNCTIONS_SPE10_HH @@ -46,7 +46,8 @@ static const constexpr size_t d = G::dimension; template <class G, size_t d, size_t r, size_t rC> typename std::enable_if< Grid::is_grid<G>::value && d == 2, - pybind11::class_<Spe10::Model1Function<typename G::template Codim<0>::Entity, r, rC, double>>>::type + pybind11::class_<Spe10::Model1Function<typename G::template Codim<0>::Entity, r, rC, double>, + GridFunctionInterface<typename G::template Codim<0>::Entity, r, rC, double>>>::type bind_Spe10Model1Function(pybind11::module& m, const std::string& grid_id) { namespace py = pybind11; diff --git a/python/dune/xt/grid/CMakeLists.txt b/python/dune/xt/grid/CMakeLists.txt index 0e0722c5268533e60fb228f11cda660a2f1a6d3e..13c8bc8590b09b4bb3db2b0eb405ee7ad8d1ead4 100644 --- a/python/dune/xt/grid/CMakeLists.txt +++ b/python/dune/xt/grid/CMakeLists.txt @@ -1,15 +1,15 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2019) -# René Fritze (2018) +# René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ dune_pybindxi_add_module(_grid_boundaryinfo_alldirichlet EXCLUDE_FROM_ALL boundaryinfo/alldirichlet.cc) diff --git a/python/dune/xt/grid/__init__.py b/python/dune/xt/grid/__init__.py index d3d67ec31ed38d5cd4028570c1a3331f6eddd0fe..6a380c1f9892481f4c45bd1193e2880f93c5741f 100644 --- a/python/dune/xt/grid/__init__.py +++ b/python/dune/xt/grid/__init__.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017, 2019) -# René Fritze (2018) -# Tobias Leibner (2019) +# René Fritze (2018 - 2019) +# Tobias Leibner (2019 - 2020) # ~~~ from numbers import Number diff --git a/python/dune/xt/grid/available_types.hh b/python/dune/xt/grid/available_types.hh index e79a869654c77f56c5f60fe44039b415edce9428..09b909c72a2307b8c52c828cc7fb93e4a53099d0 100644 --- a/python/dune/xt/grid/available_types.hh +++ b/python/dune/xt/grid/available_types.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) // // reserved. License: Dual licensed as BSD 2-Clause License // (http://opensource.org/licenses/BSD-2-Clause) diff --git a/python/dune/xt/grid/gridprovider.hh b/python/dune/xt/grid/gridprovider.hh index 7b33546abe41a0ab9afc300a7a3f731db3065e0e..c69fb60152835e31e1ee917df5417fa29878b52f 100644 --- a/python/dune/xt/grid/gridprovider.hh +++ b/python/dune/xt/grid/gridprovider.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017, 2019) -// René Fritze (2018) -// Tobias Leibner (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2018, 2020) #ifndef PYTHON_DUNE_XT_GRID_GRIDPROVIDER_HH #define PYTHON_DUNE_XT_GRID_GRIDPROVIDER_HH diff --git a/python/dune/xt/grid/grids.bindings.hh b/python/dune/xt/grid/grids.bindings.hh index 05dcbe7378a491c98af2e1dba46ba5b89fb32bff..2e30b8d0d44d0cf3ca23cad2d71dda990a4162e1 100644 --- a/python/dune/xt/grid/grids.bindings.hh +++ b/python/dune/xt/grid/grids.bindings.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) // René Fritze (2017 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_GRIDS_BINDINGS_HH #define DUNE_XT_GRID_GRIDS_BINDINGS_HH diff --git a/python/dune/xt/grid/layers.bindings.hh b/python/dune/xt/grid/layers.bindings.hh index d005457bcc84f2596c026395cf3b15e78763a589..729b6d99554b745aaa61630aecb50edaf20f09d2 100644 --- a/python/dune/xt/grid/layers.bindings.hh +++ b/python/dune/xt/grid/layers.bindings.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_GRID_LAYERS_BINDINGS_HH #define DUNE_XT_GRID_LAYERS_BINDINGS_HH diff --git a/python/dune/xt/grid/types.cc b/python/dune/xt/grid/types.cc index 7f43c3c6d0f162dd93ba6e61e54f335f47889691..6e26b480a3c4cf76e09a91c3dd726c6de5aea831 100644 --- a/python/dune/xt/grid/types.cc +++ b/python/dune/xt/grid/types.cc @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2019) -// René Fritze (2018) -// Tobias Leibner (2019) +// René Fritze (2018 - 2019) +// Tobias Leibner (2019 - 2020) #include "config.h" diff --git a/python/dune/xt/grid/types.py b/python/dune/xt/grid/types.py index f636bb08963a8cb729fe77e4b2a6599a5e6af9e5..4cf5f8e1e68ca5186dbb516ff8bcfd96b9ae32cf 100644 --- a/python/dune/xt/grid/types.py +++ b/python/dune/xt/grid/types.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ try: diff --git a/python/dune/xt/grid/walker.cc b/python/dune/xt/grid/walker.cc index b965a944adfb57516bc304cbf1c9cab4c7a62f51..2b675efbae74a2404ea04a8118979bf51c640cf3 100644 --- a/python/dune/xt/grid/walker.cc +++ b/python/dune/xt/grid/walker.cc @@ -1,11 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: -// Felix Schindler (2020) +// Felix Schindler (2016 - 2017, 2019) +// René Fritze (2018 - 2019) +// Tim Keil (2018) +// Tobias Leibner (2018 - 2020) #include "config.h" diff --git a/python/dune/xt/grid/walker/apply-on.bindings.hh b/python/dune/xt/grid/walker/apply-on.bindings.hh index c10f861c80a351e4c3f63bf2e0d35b5a8483c9ba..f36abafd86093175a9978db26b1bb9a77a6db529 100644 --- a/python/dune/xt/grid/walker/apply-on.bindings.hh +++ b/python/dune/xt/grid/walker/apply-on.bindings.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017, 2019) -// René Fritze (2018) -// Tobias Leibner (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_GRID_WALKER_APPLYON_BINDGINS_HH #define DUNE_XT_GRID_WALKER_APPLYON_BINDGINS_HH diff --git a/python/dune/xt/la/CMakeLists.txt b/python/dune/xt/la/CMakeLists.txt index cdb3854c8f3950383e8bf1c77cfaeab3c77a48ba..d794db2f0e3b4eb3fe5cc60f4104fe7f3fd429bd 100644 --- a/python/dune/xt/la/CMakeLists.txt +++ b/python/dune/xt/la/CMakeLists.txt @@ -1,14 +1,15 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2019) -# René Fritze (2018) +# René Fritze (2018 - 2019) # Tim Keil (2018) +# Tobias Leibner (2020) # ~~~ dune_pybindxi_add_module(_la EXCLUDE_FROM_ALL bindings.cc) diff --git a/python/dune/xt/la/__init__.py b/python/dune/xt/la/__init__.py index 71f28811bd013007ff8fa24cd1c04d10ce39b1a6..2a42841727e96d27da1d13e5be962378f1d42c14 100644 --- a/python/dune/xt/la/__init__.py +++ b/python/dune/xt/la/__init__.py @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017, 2019) -# René Fritze (2018) +# René Fritze (2018 - 2019) +# Tobias Leibner (2020) # ~~~ from dune.xt import guarded_import diff --git a/python/dune/xt/la/bindings.cc b/python/dune/xt/la/bindings.cc index e3d6cfee1240553b7ec76b8f25d59320a7165425..9c67f18ec2c07026e46449fd37414d4d17cc0866 100644 --- a/python/dune/xt/la/bindings.cc +++ b/python/dune/xt/la/bindings.cc @@ -1,14 +1,14 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) // Tim Keil (2018) -// Tobias Leibner (2018) +// Tobias Leibner (2018, 2020) #include "config.h" diff --git a/python/dune/xt/la/container.bindings.hh b/python/dune/xt/la/container.bindings.hh index c50b1ce9546f4524b25fc634619287f9b4acc7d3..d14f2ea0c843042de5fefac6ba52cf7137bdeee6 100644 --- a/python/dune/xt/la/container.bindings.hh +++ b/python/dune/xt/la/container.bindings.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2017 - 2019) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_LA_CONTAINER_BINDINGS_HH #define DUNE_XT_LA_CONTAINER_BINDINGS_HH diff --git a/python/dune/xt/la/container/container-interface.hh b/python/dune/xt/la/container/container-interface.hh index 287ab0030f9f40ac0e253b637bb606902d9fba57..1004eb25292d0f1eb56929cd7082f273e7f0ed20 100644 --- a/python/dune/xt/la/container/container-interface.hh +++ b/python/dune/xt/la/container/container-interface.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_LA_CONTAINER_INTERFACE_PBH #define DUNE_XT_LA_CONTAINER_INTERFACE_PBH diff --git a/python/dune/xt/la/container/matrix-interface.hh b/python/dune/xt/la/container/matrix-interface.hh index e49371692f3ec72a635d8f4f477869dafe745718..abee229961b2af85907a5403fc3a65d5cbcca1b0 100644 --- a/python/dune/xt/la/container/matrix-interface.hh +++ b/python/dune/xt/la/container/matrix-interface.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_LA_CONTAINER_MATRIX_INTERFACE_PBH #define DUNE_XT_LA_CONTAINER_MATRIX_INTERFACE_PBH diff --git a/python/dune/xt/la/container/pattern.hh b/python/dune/xt/la/container/pattern.hh index f066ea45375a28ef1ed94cdc8c2b38fbe483251c..0568c9fe65309ec524ba8d647f043b50d78caa41 100644 --- a/python/dune/xt/la/container/pattern.hh +++ b/python/dune/xt/la/container/pattern.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_LA_CONTAINER_PATTERN_PBH #define DUNE_XT_LA_CONTAINER_PATTERN_PBH diff --git a/python/dune/xt/la/container/vector-interface.hh b/python/dune/xt/la/container/vector-interface.hh index 516f16e158e17839c12798a7d7c804a9b87e0917..428a3e766d3c1983bcc46129e7c3b412ede83c67 100644 --- a/python/dune/xt/la/container/vector-interface.hh +++ b/python/dune/xt/la/container/vector-interface.hh @@ -1,13 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) -// René Fritze (2018) -// Tobias Leibner (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2018, 2020) #ifndef DUNE_XT_LA_CONTAINER_VECTOR_INTERFACE_PBH #define DUNE_XT_LA_CONTAINER_VECTOR_INTERFACE_PBH diff --git a/python/dune/xt/la/solver.hh b/python/dune/xt/la/solver.hh index 4a959734af5769477f544b63f1829f1104dd05a3..c09148732fb89430720d55ee750dc7236411c006 100644 --- a/python/dune/xt/la/solver.hh +++ b/python/dune/xt/la/solver.hh @@ -1,12 +1,13 @@ // This file is part of the dune-xt project: // https://github.com/dune-community/dune-xt -// Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +// Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. // License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) // or GPL-2.0+ (http://opensource.org/licenses/gpl-license) // with "runtime exception" (http://www.dune-project.org/license.html) // Authors: // Felix Schindler (2016 - 2017) -// René Fritze (2018) +// René Fritze (2018 - 2019) +// Tobias Leibner (2020) #ifndef DUNE_XT_LA_SOLVER_PBH #define DUNE_XT_LA_SOLVER_PBH diff --git a/python/scripts/CMakeLists.txt b/python/scripts/CMakeLists.txt index 3c012718ae5ad9ec5354d048af66af05fe78a8d3..34c73f5dd5c24b30490ad1558decdd181a2ca9c8 100644 --- a/python/scripts/CMakeLists.txt +++ b/python/scripts/CMakeLists.txt @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # # do not delete # ~~~ diff --git a/python/scripts/__init__.py b/python/scripts/__init__.py index ecaff4f02f8e66981900cf534fd0769d04048f32..0ab502bfee829bf8a2f09e6530ce111de1b0d741 100644 --- a/python/scripts/__init__.py +++ b/python/scripts/__init__.py @@ -1,12 +1,12 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2016, 2018 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ diff --git a/python/scripts/distribute_testing.py b/python/scripts/distribute_testing.py index 6bb1421fd0f1d19650ecb5cf09758d73356dd0e5..d001a55fe4dad58c13f3fba9a1adb8df8a5b6690 100644 --- a/python/scripts/distribute_testing.py +++ b/python/scripts/distribute_testing.py @@ -3,14 +3,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2016 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import logging diff --git a/python/scripts/dxt_code_generation.py b/python/scripts/dxt_code_generation.py index 2cae78854d90ba5a70d74f694c5f54a28ee190d2..704c9bb508d1fad407460af651ba57c6df6171a4 100644 --- a/python/scripts/dxt_code_generation.py +++ b/python/scripts/dxt_code_generation.py @@ -3,14 +3,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2017 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import os diff --git a/python/scripts/generate_compare_functions.py b/python/scripts/generate_compare_functions.py index b358f771e7b529c1cd14c811bab5d2d3a93efb59..2234d0aeda1a9d5ab5b59179be2086c58295eef1 100755 --- a/python/scripts/generate_compare_functions.py +++ b/python/scripts/generate_compare_functions.py @@ -3,13 +3,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2016, 2018 - 2019) +# Tobias Leibner (2020) # ~~~ import sys diff --git a/python/scripts/numa_speedup.py b/python/scripts/numa_speedup.py index 15c7c56949a76fa8d5cb52893930969fdc3ecb2b..4defd11d7d7934c6760701efeddd49a04158651c 100644 --- a/python/scripts/numa_speedup.py +++ b/python/scripts/numa_speedup.py @@ -3,14 +3,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2017 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ """Run a speedup series benchmark of a given executable on a node with libnuma diff --git a/python/setup.cfg b/python/setup.cfg index 9c3ec49a0008e59ae33e0c96af2ed6920b5dbc9b..4870ff028f128710f5c64834ee7bd22d2a4b9577 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: -# Rene Fritze (2018 - 2019) -# Tim Keil (2018) +# René Fritze (2018 - 2019) +# Tim Keil (2018) +# Tobias Leibner (2020) # ~~~ [aliases] diff --git a/python/setup.py.in b/python/setup.py.in index 5fe3361fbbdf67575f9ea057acb44a4f188e16cb..e9385df2df05b7db4f92fb269cafb73990c79d0a 100644 --- a/python/setup.py.in +++ b/python/setup.py.in @@ -3,13 +3,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2019 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: -# Felix Schindler (2017) -# Rene Milk (2016 - 2018) +# Felix Schindler (2017 - 2018) +# René Fritze (2016 - 2019) # ~~~ import sys diff --git a/python/test/base.py b/python/test/base.py index 362b3c87e7c613c2d46727672dbbf8d12856bf37..1fdff6f21485513b65bfbe1508eb7d9b8ce40e70 100644 --- a/python/test/base.py +++ b/python/test/base.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2019) # René Fritze (2018 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import pytest diff --git a/python/test/constant.py b/python/test/constant.py index 87770e92c3efae5fef82bdb034a0998c372c1461..ff33788b7023038f13c2fa57d8f25698d1e1e722 100644 --- a/python/test/constant.py +++ b/python/test/constant.py @@ -1,14 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) # Tim Keil (2018) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ import pytest diff --git a/python/test/grid_provider_cube.py b/python/test/grid_provider_cube.py index 126c091191c011dd4fc15ef811a4ed90e56a167f..9426fbdf073bfa8e752bcf02bfc97d2dfa30951c 100644 --- a/python/test/grid_provider_cube.py +++ b/python/test/grid_provider_cube.py @@ -1,13 +1,15 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: -# René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Felix Schindler (2016 - 2017) +# René Fritze (2018 - 2019) +# Tim Keil (2018) +# Tobias Leibner (2018 - 2020) # ~~~ import pytest diff --git a/python/test/grid_traits.py b/python/test/grid_traits.py index 975b0ed2e0efa385e1f30d648cc290d27a53d383..c17245e9d051318577f7c589c71211e111e6a587 100644 --- a/python/test/grid_traits.py +++ b/python/test/grid_traits.py @@ -1,13 +1,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: -# René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Felix Schindler (2014 - 2017) +# René Fritze (2012 - 2016, 2018 - 2019) +# Tobias Leibner (2015 - 2016, 2020) # ~~~ import pytest diff --git a/python/test/mpi.py b/python/test/mpi.py index 70b10607f5ffaf38c57dfbdcd321223e89eb75b3..6a75dc33cf80283704b2f570c643f858a47f1426 100644 --- a/python/test/mpi.py +++ b/python/test/mpi.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ import pytest diff --git a/python/test/walker.py b/python/test/walker.py index 6d4ea22b784dbf9f72a9adef6f71cfd826f24fab..ce7d64494d60bddd192bde4d37f61e45ef43cb09 100644 --- a/python/test/walker.py +++ b/python/test/walker.py @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # ~~~ import functools diff --git a/python/wrapper/CMakeLists.txt b/python/wrapper/CMakeLists.txt index 3c012718ae5ad9ec5354d048af66af05fe78a8d3..34c73f5dd5c24b30490ad1558decdd181a2ca9c8 100644 --- a/python/wrapper/CMakeLists.txt +++ b/python/wrapper/CMakeLists.txt @@ -1,13 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # René Fritze (2018 - 2019) -# Tobias Leibner (2018 - 2019) +# Tobias Leibner (2018 - 2020) # # do not delete # ~~~ diff --git a/python/wrapper/__init__.py b/python/wrapper/__init__.py index ecaff4f02f8e66981900cf534fd0769d04048f32..0ab502bfee829bf8a2f09e6530ce111de1b0d741 100644 --- a/python/wrapper/__init__.py +++ b/python/wrapper/__init__.py @@ -1,12 +1,12 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2017) # René Fritze (2016, 2018 - 2019) -# Tobias Leibner (2019) +# Tobias Leibner (2019 - 2020) # ~~~ diff --git a/python/wrapper/dune_xt_execute.py b/python/wrapper/dune_xt_execute.py index 57fe71ba8f794f277d9f3a89d7d47c91722d0156..6841b2f6d92110314591280a68f09500e30638bc 100755 --- a/python/wrapper/dune_xt_execute.py +++ b/python/wrapper/dune_xt_execute.py @@ -3,14 +3,14 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2016 - 2017) # René Fritze (2016, 2018 - 2019) -# Tobias Leibner (2015, 2019) +# Tobias Leibner (2015, 2019 - 2020) # # This is a modified version of dune_execute.py from dune-testtools. # It adds the --gtest_output option to the call. diff --git a/stamp-vc b/stamp-vc index c248c516ee5bfe03a6a3a135d5113c71a3c809c1..3175a773c8b34ce139aa000c6e61dcb708f40345 100644 --- a/stamp-vc +++ b/stamp-vc @@ -1,12 +1,13 @@ # ~~~ # This file is part of the dune-xt project: # https://github.com/dune-community/dune-xt -# Copyright 2009-2018 dune-xt developers and contributors. All rights reserved. +# Copyright 2009-2020 dune-xt developers and contributors. All rights reserved. # License: Dual licensed as BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause) # or GPL-2.0+ (http://opensource.org/licenses/gpl-license) # with "runtime exception" (http://www.dune-project.org/license.html) # Authors: # Felix Schindler (2014, 2016 - 2017) # René Fritze (2012, 2015, 2018 - 2019) +# Tobias Leibner (2020) # ~~~