diff --git a/.github/matrix.json b/.github/matrix.json index c32dc4d71..e2bd77df1 100644 --- a/.github/matrix.json +++ b/.github/matrix.json @@ -1,29 +1,29 @@ { "config": [ { - "name": "Linux GCC 11", + "name": "Linux GCC 13", "compiler": "gcc", - "version": "11", + "version": "13", "os": "ubuntu-22.04" }, { - "name": "Linux Clang 14", + "name": "Linux Clang 15", "compiler": "clang", - "version": "14", + "version": "15", "os": "ubuntu-22.04" }, { - "name": "macOS apple-clang 13.0.0", + "name": "macOS apple-clang 15.1.0", "compiler": "apple-clang", - "version": "13.0.0", - "os": "macos-11" + "version": "15.1.0", + "os": "macos-13" }, { - "name": "Windows VS2019", + "name": "Windows VS2022", "compiler": "Visual Studio", - "version": "16", - "os": "windows-2019", - "cmake_toolset": "Visual Studio 16 2019" + "version": "17", + "os": "windows-2022", + "cmake_toolset": "Visual Studio 17 2022" }, { "name": "Linux Webassembly", diff --git a/.github/workflows/jekyll.yml b/.github/workflows/jekyll.yml new file mode 100644 index 000000000..bd08a2660 --- /dev/null +++ b/.github/workflows/jekyll.yml @@ -0,0 +1,67 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +# Sample workflow for building and deploying a Jekyll site to GitHub Pages +name: Deploy Jekyll site to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: [$default-branch] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Ruby + uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0 + with: + # ruby-version: '3.1' # Not needed with a .ruby-version file + bundler-cache: true # runs 'bundle install' and caches installed gems automatically + cache-version: 0 # Increment this number if you need to re-download cached gems + - name: Setup Pages + id: pages + uses: actions/configure-pages@v4 + - name: Build with Jekyll + # Outputs to the './_site' directory by default + # run: cd ./docs + run: cd ./docs && bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" + env: + JEKYLL_ENV: production + - name: Upload artifact + # Automatically uploads an artifact from the './_site' directory by default + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs/_site + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/stlab.yml b/.github/workflows/stlab.yml index 26d31c957..e4aa655dd 100644 --- a/.github/workflows/stlab.yml +++ b/.github/workflows/stlab.yml @@ -21,6 +21,7 @@ jobs: run: echo "::set-output name=matrix::$(cat .github/matrix.json | scripts/flatten_json.py)" builds: + # installed tools and runners can be found here: https://github.com/actions/runner-images needs: generate-matrix runs-on: ${{ matrix.config.os }} strategy: @@ -106,7 +107,7 @@ jobs: shell: bash run: | mkdir ../build - cmake -S. -B../build -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=23 + cmake -S. -B../build -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=20 - name: Configure // Linux Emscripten if: ${{ startsWith(matrix.config.compiler, 'emscripten') }} @@ -120,7 +121,7 @@ jobs: if: ${{ startsWith(matrix.config.os, 'windows') }} shell: cmd run: | - call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64 + call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64 mkdir ..\build cmake -S. -B../build -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=20 -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake @@ -134,7 +135,7 @@ jobs: if: ${{ startsWith(matrix.config.os, 'windows') }} shell: cmd run: | - call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64 + call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64 cmake --build ../build/ - name: Test diff --git a/README.md b/README.md index 4c06bacc9..8481322c8 100644 --- a/README.md +++ b/README.md @@ -113,9 +113,7 @@ STLab uses [hyde](https://github.com/adobe/hyde) to generate documentation boile When adding a new public API, you should invoke ``` -docker run --platform linux/x86_64 --mount type=bind,source="$(pwd)/..",target=/mnt/host \ - --tty --interactive \ - hyde bash +docker run --platform linux/x86_64 --mount type=bind,source="$(pwd)/..",target=/mnt/host --tty --interactive hyde bash ``` ``` diff --git a/docs/.ruby-version b/docs/.ruby-version index a4dd9dba4..be94e6f53 100644 --- a/docs/.ruby-version +++ b/docs/.ruby-version @@ -1 +1 @@ -2.7.4 +3.2.2 diff --git a/docs/Gemfile b/docs/Gemfile index 37f5eaa42..a7e9c457e 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -1,2 +1,8 @@ source 'https://rubygems.org' -gem 'github-pages', group: :jekyll_plugins +gem 'jekyll' +gem 'jekyll-redirect-from', group: [:jekyll_plugins] +gem 'jekyll-compose', group: [:jekyll_plugins] +gem "jekyll-remote-theme", group: [:jekyll_plugins] +# don't submit this line to the upstream repo +## Enable this line for local theme development +# gem 'jekyll-theme-adobe-hyde', path: '../../themes' diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 1493eb4ad..5e7e16fb8 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,261 +1,129 @@ GEM remote: https://rubygems.org/ specs: - activesupport (6.0.5.1) - concurrent-ruby (~> 1.0, >= 1.0.2) - i18n (>= 0.7, < 2) - minitest (~> 5.1) - tzinfo (~> 1.1) - zeitwerk (~> 2.2, >= 2.2.2) - addressable (2.8.0) - public_suffix (>= 2.0.2, < 5.0) - coffee-script (2.4.1) - coffee-script-source - execjs - coffee-script-source (1.11.1) + addressable (2.8.6) + public_suffix (>= 2.0.2, < 6.0) colorator (1.1.0) - commonmarker (0.23.5) - concurrent-ruby (1.1.10) - dnsruby (1.61.9) - simpleidn (~> 0.1) + concurrent-ruby (1.2.2) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) - ethon (0.15.0) - ffi (>= 1.15.0) eventmachine (1.2.7) - execjs (2.8.1) - faraday (2.5.1) - faraday-net_http (>= 2.0, < 3.1) - ruby2_keywords (>= 0.0.4) - faraday-net_http (3.0.0) - ffi (1.15.5) + ffi (1.16.3) forwardable-extended (2.6.0) - gemoji (3.0.1) - github-pages (227) - github-pages-health-check (= 1.17.9) - jekyll (= 3.9.2) - jekyll-avatar (= 0.7.0) - jekyll-coffeescript (= 1.1.1) - jekyll-commonmark-ghpages (= 0.2.0) - jekyll-default-layout (= 0.1.4) - jekyll-feed (= 0.15.1) - jekyll-gist (= 1.5.0) - jekyll-github-metadata (= 2.13.0) - jekyll-include-cache (= 0.2.1) - jekyll-mentions (= 1.6.0) - jekyll-optional-front-matter (= 0.3.2) - jekyll-paginate (= 1.1.0) - jekyll-readme-index (= 0.3.0) - jekyll-redirect-from (= 0.16.0) - jekyll-relative-links (= 0.6.1) - jekyll-remote-theme (= 0.4.3) - jekyll-sass-converter (= 1.5.2) - jekyll-seo-tag (= 2.8.0) - jekyll-sitemap (= 1.4.0) - jekyll-swiss (= 1.0.0) - jekyll-theme-architect (= 0.2.0) - jekyll-theme-cayman (= 0.2.0) - jekyll-theme-dinky (= 0.2.0) - jekyll-theme-hacker (= 0.2.0) - jekyll-theme-leap-day (= 0.2.0) - jekyll-theme-merlot (= 0.2.0) - jekyll-theme-midnight (= 0.2.0) - jekyll-theme-minimal (= 0.2.0) - jekyll-theme-modernist (= 0.2.0) - jekyll-theme-primer (= 0.6.0) - jekyll-theme-slate (= 0.2.0) - jekyll-theme-tactile (= 0.2.0) - jekyll-theme-time-machine (= 0.2.0) - jekyll-titles-from-headings (= 0.5.3) - jemoji (= 0.12.0) - kramdown (= 2.3.2) - kramdown-parser-gfm (= 1.1.0) - liquid (= 4.0.3) - mercenary (~> 0.3) - minima (= 2.5.1) - nokogiri (>= 1.13.6, < 2.0) - rouge (= 3.26.0) - terminal-table (~> 1.4) - github-pages-health-check (1.17.9) - addressable (~> 2.3) - dnsruby (~> 1.60) - octokit (~> 4.0) - public_suffix (>= 3.0, < 5.0) - typhoeus (~> 1.3) - html-pipeline (2.14.2) - activesupport (>= 2) - nokogiri (>= 1.4) + google-protobuf (3.25.2) + google-protobuf (3.25.2-aarch64-linux) + google-protobuf (3.25.2-arm64-darwin) + google-protobuf (3.25.2-x86-linux) + google-protobuf (3.25.2-x86_64-darwin) + google-protobuf (3.25.2-x86_64-linux) http_parser.rb (0.8.0) - i18n (0.9.5) + i18n (1.14.1) concurrent-ruby (~> 1.0) - jekyll (3.9.2) + jekyll (4.3.3) addressable (~> 2.4) colorator (~> 1.0) em-websocket (~> 0.5) - i18n (~> 0.7) - jekyll-sass-converter (~> 1.0) + i18n (~> 1.0) + jekyll-sass-converter (>= 2.0, < 4.0) jekyll-watch (~> 2.0) - kramdown (>= 1.17, < 3) + kramdown (~> 2.3, >= 2.3.1) + kramdown-parser-gfm (~> 1.0) liquid (~> 4.0) - mercenary (~> 0.3.3) + mercenary (>= 0.3.6, < 0.5) pathutil (~> 0.9) - rouge (>= 1.7, < 4) + rouge (>= 3.0, < 5.0) safe_yaml (~> 1.0) - jekyll-avatar (0.7.0) - jekyll (>= 3.0, < 5.0) - jekyll-coffeescript (1.1.1) - coffee-script (~> 2.2) - coffee-script-source (~> 1.11.1) - jekyll-commonmark (1.4.0) - commonmarker (~> 0.22) - jekyll-commonmark-ghpages (0.2.0) - commonmarker (~> 0.23.4) - jekyll (~> 3.9.0) - jekyll-commonmark (~> 1.4.0) - rouge (>= 2.0, < 4.0) - jekyll-default-layout (0.1.4) - jekyll (~> 3.0) - jekyll-feed (0.15.1) + terminal-table (>= 1.8, < 4.0) + webrick (~> 1.7) + jekyll-compose (0.12.0) jekyll (>= 3.7, < 5.0) - jekyll-gist (1.5.0) - octokit (~> 4.2) - jekyll-github-metadata (2.13.0) - jekyll (>= 3.4, < 5.0) - octokit (~> 4.0, != 4.4.0) - jekyll-include-cache (0.2.1) - jekyll (>= 3.7, < 5.0) - jekyll-mentions (1.6.0) - html-pipeline (~> 2.3) - jekyll (>= 3.7, < 5.0) - jekyll-optional-front-matter (0.3.2) - jekyll (>= 3.0, < 5.0) - jekyll-paginate (1.1.0) - jekyll-readme-index (0.3.0) - jekyll (>= 3.0, < 5.0) jekyll-redirect-from (0.16.0) jekyll (>= 3.3, < 5.0) - jekyll-relative-links (0.6.1) - jekyll (>= 3.3, < 5.0) jekyll-remote-theme (0.4.3) addressable (~> 2.0) jekyll (>= 3.5, < 5.0) jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) rubyzip (>= 1.3.0, < 3.0) - jekyll-sass-converter (1.5.2) - sass (~> 3.4) - jekyll-seo-tag (2.8.0) - jekyll (>= 3.8, < 5.0) - jekyll-sitemap (1.4.0) - jekyll (>= 3.7, < 5.0) - jekyll-swiss (1.0.0) - jekyll-theme-architect (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.6.0) - jekyll (> 3.5, < 5.0) - jekyll-github-metadata (~> 2.9) - jekyll-seo-tag (~> 2.0) - jekyll-theme-slate (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.2.0) - jekyll (> 3.5, < 5.0) - jekyll-seo-tag (~> 2.0) - jekyll-titles-from-headings (0.5.3) - jekyll (>= 3.3, < 5.0) + jekyll-sass-converter (3.0.0) + sass-embedded (~> 1.54) jekyll-watch (2.2.1) listen (~> 3.0) - jemoji (0.12.0) - gemoji (~> 3.0) - html-pipeline (~> 2.2) - jekyll (>= 3.0, < 5.0) - kramdown (2.3.2) + kramdown (2.4.0) rexml kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) - liquid (4.0.3) - listen (3.7.1) + liquid (4.0.4) + listen (3.8.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.3.6) - minima (2.5.1) - jekyll (>= 3.5, < 5.0) - jekyll-feed (~> 0.9) - jekyll-seo-tag (~> 2.1) - minitest (5.16.2) - nokogiri (1.13.8-aarch64-linux) - racc (~> 1.4) - octokit (4.25.1) - faraday (>= 1, < 3) - sawyer (~> 0.9) + mercenary (0.4.0) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (4.0.7) - racc (1.6.0) - rb-fsevent (0.11.1) + public_suffix (5.0.4) + rb-fsevent (0.11.2) rb-inotify (0.10.1) ffi (~> 1.0) - rexml (3.2.5) - rouge (3.26.0) - ruby2_keywords (0.0.5) + rexml (3.2.6) + rouge (4.2.0) rubyzip (2.3.2) safe_yaml (1.0.5) - sass (3.7.4) - sass-listen (~> 4.0.0) - sass-listen (4.0.0) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) - sawyer (0.9.2) - addressable (>= 2.3.5) - faraday (>= 0.17.3, < 3) - simpleidn (0.2.1) - unf (~> 0.1.4) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) - thread_safe (0.3.6) - typhoeus (1.4.0) - ethon (>= 0.9.0) - tzinfo (1.2.10) - thread_safe (~> 0.1) - unf (0.1.4) - unf_ext - unf_ext (0.0.8.2) - unicode-display_width (1.8.0) - zeitwerk (2.6.0) + sass-embedded (1.69.7-aarch64-linux-android) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-aarch64-linux-gnu) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-aarch64-linux-musl) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-arm-linux-androideabi) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-arm-linux-gnueabihf) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-arm-linux-musleabihf) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-arm64-darwin) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86-linux-android) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86-linux-gnu) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86-linux-musl) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86_64-darwin) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86_64-linux-android) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86_64-linux-gnu) + google-protobuf (~> 3.25) + sass-embedded (1.69.7-x86_64-linux-musl) + google-protobuf (~> 3.25) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + unicode-display_width (2.5.0) + webrick (1.8.1) PLATFORMS aarch64-linux + aarch64-linux-android + aarch64-linux-gnu + aarch64-linux-musl + arm-linux-androideabi + arm-linux-gnueabihf + arm-linux-musleabihf + arm64-darwin + x86-linux + x86-linux-android + x86-linux-gnu + x86-linux-musl + x86_64-darwin + x86_64-linux-android + x86_64-linux-gnu + x86_64-linux-musl DEPENDENCIES - github-pages + jekyll + jekyll-compose + jekyll-redirect-from + jekyll-remote-theme BUNDLED WITH - 2.3.20 + 2.5.4 diff --git a/docs/_config.yml b/docs/_config.yml index c034fd7c6..1bec67a0b 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -15,7 +15,10 @@ baseurl: "" # the subpath of your site, e.g. /blog url: "http://www.stlab.cc" # the base hostname & protocol for your site twitter_username: SeanParent github_username: stlab -remote_theme: adobe/hyde-theme@v1.1.0 + +## To build locally, toggle these two. +remote_theme: adobe/hyde-theme@v2.0.1 +# theme: jekyll-theme-adobe-hyde exclude: - _source - build @@ -36,7 +39,8 @@ adobe_hyde: excerpt_separator: markdown: kramdown utterances: - repo: stlab/stlab.github.io + repo: stlab/stlab.github.io label: "utterance" plugins: - jekyll-redirect-from + - jekyll-remote-theme diff --git a/docs/about.md b/docs/about.md index 59fc3e0cf..f7da9d726 100644 --- a/docs/about.md +++ b/docs/about.md @@ -1,8 +1,9 @@ --- layout: page title: About -tab: About permalink: /about/ +hyde: + tab: About --- stlab is the ongoing work of what was Adobe's Software Technology Lab. The Adobe Source Libraries (ASL), Platform Libraries, and new stlab libraries are hosted on [github](https://github.com/stlab). diff --git a/docs/bs-config.js b/docs/bs-config.js index 50525171d..ee0ef0c55 100644 --- a/docs/bs-config.js +++ b/docs/bs-config.js @@ -44,7 +44,7 @@ module.exports = { "logFileChanges": true, "logSnippet": true, "rewriteRules": [], - "open": "local", + "open": "false", "browser": "default", "cors": false, "xip": false, diff --git a/docs/chat.md b/docs/chat.md index 3b38b9e6c..cd64707f9 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -1,8 +1,9 @@ --- layout: page title: Chat -tab: Chat permalink: /chat/ +hyde: + tab: Chat --- For video chats use the Google Hangout below (requires a Google account). diff --git a/docs/index.html b/docs/index.html index 56ee02198..de32ea08c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,18 +2,18 @@ layout: default --- -{% assign home_thumbs = site.pages | where_exp:"p","p.icon" | sort:"tab"%} +{% assign home_thumbs = site.pages | where_exp:"p","p.hyde.icon" | sort:"hyde.tab"%}
{% for page in home_thumbs %}
- {% if page.icon %} + {% if page.hyde.icon %}
-
-
{{page.tab}}
+
+
{{page.hyde.tab}}
 {% endif %} diff --git a/docs/legacy/index.md b/docs/legacy/index.md index f5ff9582a..46c6d45b2 100644 --- a/docs/legacy/index.md +++ b/docs/legacy/index.md @@ -1,9 +1,10 @@ --- title: Welcome to the stlab.adobe.com Wiki -tab: Legacy layout: page redirect_from: /legacy/index.php/Main_Page -icon: pagelines +hyde: + tab: Legacy + icon: leaf --- _These pages have been migrated from stlab.adobe.com/wiki for preservation. They may eventually be revised and moved into a more appropriate location on the site._ diff --git a/docs/libraries/algorithm/reverse.hpp/f_reverse.md b/docs/libraries/algorithm/reverse.hpp/f_reverse.md index b14ee1328..4ed5bc476 100644 --- a/docs/libraries/algorithm/reverse.hpp/f_reverse.md +++ b/docs/libraries/algorithm/reverse.hpp/f_reverse.md @@ -1,20 +1,27 @@ --- layout: function title: reverse -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: algorithm/reverse.hpp -overloads: - "template \nvoid reverse(BidirectionalRange &)": - arguments: - - description: __OPTIONAL__ - name: range - type: BidirectionalRange & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid reverse(BidirectionalRange & range)" -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: algorithm/reverse.hpp + overloads: + "template \nvoid reverse(BidirectionalRange &)": + arguments: + - description: __OPTIONAL__ + name: range + type: BidirectionalRange & + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nvoid reverse(BidirectionalRange & range)" + namespace: + - stlab --- diff --git a/docs/libraries/algorithm/reverse.hpp/f_reverse_copy.md b/docs/libraries/algorithm/reverse.hpp/f_reverse_copy.md index 0550325bd..de8f4aaaf 100644 --- a/docs/libraries/algorithm/reverse.hpp/f_reverse_copy.md +++ b/docs/libraries/algorithm/reverse.hpp/f_reverse_copy.md @@ -1,34 +1,35 @@ --- layout: function title: reverse_copy -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: algorithm/reverse.hpp -overloads: - "template \nvoid reverse_copy(BidirectionalRange &, OutputIterator)": - arguments: - - description: __OPTIONAL__ - name: range - type: BidirectionalRange & - - description: __OPTIONAL__ - name: result - type: OutputIterator - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid reverse_copy(BidirectionalRange & range, OutputIterator result)" - "template \nvoid reverse_copy(const BidirectionalRange &, OutputIterator)": - arguments: - - description: __OPTIONAL__ - name: range - type: const BidirectionalRange & - - description: __OPTIONAL__ - name: result - type: OutputIterator - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid reverse_copy(const BidirectionalRange & range, OutputIterator result)" -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: algorithm/reverse.hpp + overloads: + "template \nvoid reverse_copy(BidirectionalRange &, OutputIterator)": + arguments: + - description: __OPTIONAL__ + name: range + type: BidirectionalRange & + - description: __OPTIONAL__ + name: result + type: OutputIterator + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nvoid reverse_copy(BidirectionalRange & range, OutputIterator result)" + "template \nvoid reverse_copy(const BidirectionalRange &, OutputIterator)": + arguments: + - description: __OPTIONAL__ + name: range + type: const BidirectionalRange & + - description: __OPTIONAL__ + name: result + type: OutputIterator + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nvoid reverse_copy(const BidirectionalRange & range, OutputIterator result)" + namespace: + - stlab --- diff --git a/docs/libraries/algorithm/reverse.hpp/f_reverse_until.md b/docs/libraries/algorithm/reverse.hpp/f_reverse_until.md index 5854e9a36..f36e5d033 100644 --- a/docs/libraries/algorithm/reverse.hpp/f_reverse_until.md +++ b/docs/libraries/algorithm/reverse.hpp/f_reverse_until.md @@ -1,26 +1,33 @@ --- layout: function title: reverse_until -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: algorithm/reverse.hpp -overloads: - "template \nstd::pair reverse_until(I, I, I)": - arguments: - - description: __OPTIONAL__ - name: f - type: I - - description: __OPTIONAL__ - name: m - type: I - - description: __OPTIONAL__ - name: l - type: I - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nstd::pair reverse_until(I f, I m, I l)" -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: algorithm/reverse.hpp + overloads: + "template \nstd::pair reverse_until(I, I, I)": + arguments: + - description: __OPTIONAL__ + name: f + type: I + - description: __OPTIONAL__ + name: m + type: I + - description: __OPTIONAL__ + name: l + type: I + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nstd::pair reverse_until(I f, I m, I l)" + namespace: + - stlab --- diff --git a/docs/libraries/algorithm/reverse.hpp/index.md b/docs/libraries/algorithm/reverse.hpp/index.md index afde89223..db6bbc8c8 100644 --- a/docs/libraries/algorithm/reverse.hpp/index.md +++ b/docs/libraries/algorithm/reverse.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: algorithm/reverse.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/concurrency/await.hpp/f_await.md b/docs/libraries/concurrency/await.hpp/f_await.md index b22a520fb..8bb0a38a4 100644 --- a/docs/libraries/concurrency/await.hpp/f_await.md +++ b/docs/libraries/concurrency/await.hpp/f_await.md @@ -1,21 +1,22 @@ --- layout: function title: await -owner: sean-parent -brief: Waits until the future is ready and returns the future value. -tags: - - function -defined_in_file: concurrency/await.hpp -overloads: - "template \nT await(future)": - arguments: - - description: __OPTIONAL__ - name: x - type: future - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nT await(future x)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Waits until the future is ready and returns the future value. + tags: + - function + defined_in_file: concurrency/await.hpp + overloads: + "template \nT await(future)": + arguments: + - description: __OPTIONAL__ + name: x + type: future + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nT await(future x)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/await.hpp/f_await_for.md b/docs/libraries/concurrency/await.hpp/f_await_for.md index e0c4996cd..f19f85b60 100644 --- a/docs/libraries/concurrency/await.hpp/f_await_for.md +++ b/docs/libraries/concurrency/await.hpp/f_await_for.md @@ -1,25 +1,25 @@ --- layout: function title: await_for -owner: sean-parent -brief: | - Wait for the specified duration for the future to be ready and either returns a ready future or a new future which can be waited on. -tags: - - function -defined_in_file: concurrency/await.hpp -overloads: - "template \nauto await_for(future, const std::chrono::nanoseconds &) -> future": - arguments: - - description: __OPTIONAL__ - name: x - type: future - - description: __OPTIONAL__ - name: timeout - type: const std::chrono::nanoseconds & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto await_for(future x, const std::chrono::nanoseconds & timeout) -> future" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: "Wait for the specified duration for the future to be ready and either returns a ready future or a new future which can be waited on.\n" + tags: + - function + defined_in_file: concurrency/await.hpp + overloads: + "template \nauto await_for(future, const std::chrono::nanoseconds &) -> future": + arguments: + - description: __OPTIONAL__ + name: x + type: future + - description: __OPTIONAL__ + name: timeout + type: const std::chrono::nanoseconds & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nauto await_for(future x, const std::chrono::nanoseconds & timeout) -> future" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/await.hpp/f_blocking_get.md b/docs/libraries/concurrency/await.hpp/f_blocking_get.md index 8811b34dd..103cca03f 100644 --- a/docs/libraries/concurrency/await.hpp/f_blocking_get.md +++ b/docs/libraries/concurrency/await.hpp/f_blocking_get.md @@ -1,38 +1,45 @@ --- layout: function title: blocking_get -owner: sean-parent -brief: _Deprecated_ Use [`await()`](./f_await_for.html). -tags: - - function -defined_in_file: concurrency/await.hpp -overloads: - "template \nauto blocking_get(future, const std::chrono::nanoseconds &) -> decltype(x.get_try())": - annotation: - - deprecated (Use await_for instead.) - arguments: - - description: The future on which shall be waited until the result is ready - name: x - type: future - - description: __OPTIONAL__ - name: timeout - type: const std::chrono::nanoseconds & - description: Waits as long as the future is fulfilled, or throws the occurred exception - return: The result of the future x - signature_with_names: "template \nauto blocking_get(future x, const std::chrono::nanoseconds & timeout) -> decltype(x.get_try())" - "template \nT blocking_get(future)": - annotation: - - deprecated (Use await instead.) - arguments: - - description: The future on which shall be waited until the result is ready - name: x - type: future - description: Waits as long as the future is fulfilled, or throws the occurred exception - return: The result of the future x - signature_with_names: "template \nT blocking_get(future x)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: _Deprecated_ Use [`await()`](./f_await_for.html). + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: concurrency/await.hpp + overloads: + "template \nauto blocking_get(future, const std::chrono::nanoseconds &) -> decltype(x.get_try())": + annotation: + - deprecated("Use await_for instead.") + arguments: + - description: The future on which shall be waited until the result is ready + name: x + type: future + - description: __OPTIONAL__ + name: timeout + type: const std::chrono::nanoseconds & + description: Waits as long as the future is fulfilled, or throws the occurred exception + return: The result of the future x + signature_with_names: "template \nauto blocking_get(future x, const std::chrono::nanoseconds & timeout) -> decltype(x.get_try())" + "template \nT blocking_get(future)": + annotation: + - deprecated("Use await instead.") + arguments: + - description: The future on which shall be waited until the result is ready + name: x + type: future + description: Waits as long as the future is fulfilled, or throws the occurred exception + inline: + description: + - "***********************************************************************************************" + return: The result of the future x + signature_with_names: "template \nT blocking_get(future x)" + namespace: + - stlab + - v1 --- Waits until the passed future is ready. Using this function causes that one thread resource is consumed which increases contention and possibly causing a deadlock. As well any subsequent non-dependent calculations on the task are also blocked. It is strongly recommended to avoid using this function, but use continuations. diff --git a/docs/libraries/concurrency/await.hpp/f_blocking_get_for.md b/docs/libraries/concurrency/await.hpp/f_blocking_get_for.md index d986715c6..150c903a8 100644 --- a/docs/libraries/concurrency/await.hpp/f_blocking_get_for.md +++ b/docs/libraries/concurrency/await.hpp/f_blocking_get_for.md @@ -1,26 +1,27 @@ --- layout: function title: blocking_get_for -owner: sean-parent -brief: _Deprecated_ Use [`await_for()`](./f_await_for.html). -tags: - - function -defined_in_file: concurrency/await.hpp -overloads: - "template \nauto blocking_get_for(future, const std::chrono::nanoseconds &) -> future": - annotation: - - deprecated (Use await_for instead.) - arguments: - - description: __OPTIONAL__ - name: x - type: future - - description: __OPTIONAL__ - name: timeout - type: const std::chrono::nanoseconds & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto blocking_get_for(future x, const std::chrono::nanoseconds & timeout) -> future" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: _Deprecated_ Use [`await_for()`](./f_await_for.html). + tags: + - function + defined_in_file: concurrency/await.hpp + overloads: + "template \nauto blocking_get_for(future, const std::chrono::nanoseconds &) -> future": + annotation: + - deprecated("Use await_for instead.") + arguments: + - description: __OPTIONAL__ + name: x + type: future + - description: __OPTIONAL__ + name: timeout + type: const std::chrono::nanoseconds & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nauto blocking_get_for(future x, const std::chrono::nanoseconds & timeout) -> future" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/await.hpp/f_invoke_waiting.md b/docs/libraries/concurrency/await.hpp/f_invoke_waiting.md index c1ad198c0..c4066d64b 100644 --- a/docs/libraries/concurrency/await.hpp/f_invoke_waiting.md +++ b/docs/libraries/concurrency/await.hpp/f_invoke_waiting.md @@ -1,21 +1,28 @@ --- layout: function title: invoke_waiting -owner: sean-parent -brief: When calling a waiting operation, other than `await()` or `await_for()`, such as directly waiting on a `std::condition_variable`, the waiting operation should be invoked with `invoke_waiting()`. This will ensure that there are enough threads available in the portable default executor pool to resolve any pending dependent tasks. With the other default executors, this operation has no effect. Platform executors have similar capability but are hooked into blocking primitives to directly detect blocking calls. -tags: - - function -defined_in_file: concurrency/await.hpp -overloads: - "template \nauto invoke_waiting(F &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto invoke_waiting(F && f)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: When calling a waiting operation, other than `await()` or `await_for()`, such as directly waiting on a `std::condition_variable`, the waiting operation should be invoked with `invoke_waiting()`. This will ensure that there are enough threads available in the portable default executor pool to resolve any pending dependent tasks. With the other default executors, this operation has no effect. Platform executors have similar capability but are hooked into blocking primitives to directly detect blocking calls. + tags: + - function + inline: + brief: + - Assumes f _will wait_ and wakes or adds a thread to the thread pool (to the limit) before invoking f. + defined_in_file: concurrency/await.hpp + overloads: + "template \nauto invoke_waiting(F &&)": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __INLINED__ + inline: + description: + - Assumes f _will wait_ and wakes or adds a thread to the thread pool (to the limit) before invoking f. + return: __OPTIONAL__ + signature_with_names: "template \nauto invoke_waiting(F && f)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/await.hpp/index.md b/docs/libraries/concurrency/await.hpp/index.md index 53485562a..53785c309 100644 --- a/docs/libraries/concurrency/await.hpp/index.md +++ b/docs/libraries/concurrency/await.hpp/index.md @@ -1,12 +1,10 @@ --- layout: library title: concurrency/await.hpp -owner: sean-parent -brief: | - Await provides a way to await the value from a future and to notify the default executor that a task is waiting. Blocking calls are discouraged because they may lead to deadlocks or thread explosions. - - There is a good presentation of the issues [here](https://youtu.be/Z86b3Rd09sE). -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: sean-parent + brief: "Await provides a way to await the value from a future and to notify the default executor that a task is waiting. Blocking calls are discouraged because they may lead to deadlocks or thread explosions.\n\nThere is a good presentation of the issues [here](https://youtu.be/Z86b3Rd09sE).\n" + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/concurrency/channel.hpp/argument_of3CR2028Arg293E/index.md b/docs/libraries/concurrency/channel.hpp/argument_of3CR2028Arg293E/index.md index fee2358ea..a5c6bf1d7 100644 --- a/docs/libraries/concurrency/channel.hpp/argument_of3CR2028Arg293E/index.md +++ b/docs/libraries/concurrency/channel.hpp/argument_of3CR2028Arg293E/index.md @@ -1,19 +1,20 @@ --- layout: class title: argument_of -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "\nstruct stlab::argument_of;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: Arg - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/channel.hpp + declaration: "\nstruct stlab::argument_of;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: Arg + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/buffer_size/index.md b/docs/libraries/concurrency/channel.hpp/buffer_size/index.md index a263f6e99..791c5ebb7 100644 --- a/docs/libraries/concurrency/channel.hpp/buffer_size/index.md +++ b/docs/libraries/concurrency/channel.hpp/buffer_size/index.md @@ -1,20 +1,24 @@ --- layout: class title: buffer_size -owner: FelixPetriconi -brief: Encapsulates the buffer size of a process -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "\nstruct stlab::buffer_size;" -dtor: unspecified -fields: - _value: - description: __MISSING__ - type: std::size_t -namespace: - - stlab - - v1 +hyde: + owner: FelixPetriconi + brief: Encapsulates the buffer size of a process + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/channel.hpp + declaration: "\nstruct stlab::buffer_size;" + dtor: unspecified + fields: + _value: + description: __MISSING__ + type: std::size_t + namespace: + - stlab + - v1 --- The default size of an incomming queue of each process is 1. In case that one wants to change the queue size of a process, one can realize this by combining a `buffer_size` with a process by using an `operator&` before attaching it to a receiver. `buffer_size` of 0 means no limitation, beside the limitation of available memory. The purpose of the buffer size is flow control between processes. A processes will be allowed to run so long as it is yielding values until the buffer is full before it is suspended. If the processes awaits a value it may be suspended even if the buffer isn't full (if no value is available for the await). A buffer_size of 0 imposes no bounds. The default buffer_size is 1 (a value must be received before a process can yield the next value). \ No newline at end of file diff --git a/docs/libraries/concurrency/channel.hpp/buffer_size/m_buffer_size.md b/docs/libraries/concurrency/channel.hpp/buffer_size/m_buffer_size.md index d2e86ebe0..792269f6f 100644 --- a/docs/libraries/concurrency/channel.hpp/buffer_size/m_buffer_size.md +++ b/docs/libraries/concurrency/channel.hpp/buffer_size/m_buffer_size.md @@ -1,20 +1,19 @@ --- layout: method title: buffer_size -owner: FelixPetriconi -brief: buffer_size constructor -example: buffer_size_example.cpp -tags: - - method -defined_in_file: concurrency/channel.hpp -is_ctor: true -overloads: - buffer_size(std::size_t): - arguments: - - description: Specifies the size of the buffer - name: b - type: std::size_t - description: Constructs a new buffer_size object and initializes it with the value `b`. - return: A buffer_size object of size `b`. - signature_with_names: buffer_size(std::size_t b) +hyde: + owner: FelixPetriconi + brief: buffer_size constructor + tags: + - method + defined_in_file: concurrency/channel.hpp + is_ctor: true + overloads: + buffer_size(std::size_t): + arguments: + - description: Specifies the size of the buffer + name: b + type: std::size_t + description: Constructs a new buffer_size object and initializes it with the value `b`. + signature_with_names: buffer_size(std::size_t b) --- diff --git a/docs/libraries/concurrency/channel.hpp/channel_error/index.md b/docs/libraries/concurrency/channel.hpp/channel_error/index.md index d0df5fc3d..49f6bde8b 100644 --- a/docs/libraries/concurrency/channel.hpp/channel_error/index.md +++ b/docs/libraries/concurrency/channel.hpp/channel_error/index.md @@ -1,14 +1,18 @@ --- layout: class title: channel_error -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "\nclass stlab::channel_error;" -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - channel exception + defined_in_file: concurrency/channel.hpp + declaration: "\nclass stlab::channel_error;" + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/channel_error/m_channel_error.md b/docs/libraries/concurrency/channel.hpp/channel_error/m_channel_error.md index b04bbac75..1dcbbad81 100644 --- a/docs/libraries/concurrency/channel.hpp/channel_error/m_channel_error.md +++ b/docs/libraries/concurrency/channel.hpp/channel_error/m_channel_error.md @@ -1,37 +1,39 @@ --- layout: method title: channel_error -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -is_ctor: true -overloads: - channel_error(const stlab::channel_error &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::channel_error & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: channel_error(const stlab::channel_error &) - channel_error(stlab::channel_error &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::channel_error && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: channel_error(stlab::channel_error &&) - explicit channel_error(stlab::channel_error_codes): - arguments: - - description: __OPTIONAL__ - name: code - type: stlab::channel_error_codes - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: explicit channel_error(stlab::channel_error_codes code) +hyde: + owner: __MISSING__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + is_ctor: true + overloads: + channel_error(const stlab::channel_error &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::channel_error & + unnamed: true + description: __OPTIONAL__ + signature_with_names: channel_error(const stlab::channel_error &) + channel_error(stlab::channel_error &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::channel_error && + unnamed: true + description: __OPTIONAL__ + signature_with_names: channel_error(stlab::channel_error &&) + explicit channel_error(stlab::channel_error_codes): + arguments: + - description: __OPTIONAL__ + name: code + type: stlab::channel_error_codes + description: __MISSING__ + signature_with_names: explicit channel_error(stlab::channel_error_codes code) --- diff --git a/docs/libraries/concurrency/channel.hpp/channel_error/m_code.md b/docs/libraries/concurrency/channel.hpp/channel_error/m_code.md index 4299df03f..7afb3230c 100644 --- a/docs/libraries/concurrency/channel.hpp/channel_error/m_code.md +++ b/docs/libraries/concurrency/channel.hpp/channel_error/m_code.md @@ -1,14 +1,15 @@ --- layout: method title: code -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - const stlab::channel_error_codes & code() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: const stlab::channel_error_codes & code() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + const stlab::channel_error_codes & code() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: const stlab::channel_error_codes & code() const --- diff --git a/docs/libraries/concurrency/channel.hpp/channel_error/m_operator3D.md b/docs/libraries/concurrency/channel.hpp/channel_error/m_operator3D.md index eb6a38942..8f710dc01 100644 --- a/docs/libraries/concurrency/channel.hpp/channel_error/m_operator3D.md +++ b/docs/libraries/concurrency/channel.hpp/channel_error/m_operator3D.md @@ -1,28 +1,33 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - stlab::channel_error & operator=(const stlab::channel_error &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::channel_error & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::channel_error & operator=(const stlab::channel_error &) - stlab::channel_error & operator=(stlab::channel_error &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::channel_error && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::channel_error & operator=(stlab::channel_error &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + stlab::channel_error & operator=(const stlab::channel_error &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::channel_error & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::channel_error & operator=(const stlab::channel_error &) + stlab::channel_error & operator=(stlab::channel_error &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::channel_error && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::channel_error & operator=(stlab::channel_error &&) --- diff --git a/docs/libraries/concurrency/channel.hpp/channel_error/m_what.md b/docs/libraries/concurrency/channel.hpp/channel_error/m_what.md index 4daa37cb1..7b67d3364 100644 --- a/docs/libraries/concurrency/channel.hpp/channel_error/m_what.md +++ b/docs/libraries/concurrency/channel.hpp/channel_error/m_what.md @@ -1,14 +1,15 @@ --- layout: method title: what -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - const char * what() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: const char * what() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + const char * what() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: const char * what() const --- diff --git a/docs/libraries/concurrency/channel.hpp/channel_error/m_~channel_error.md b/docs/libraries/concurrency/channel.hpp/channel_error/m_~channel_error.md index 3c30b13bd..6eb3358cf 100644 --- a/docs/libraries/concurrency/channel.hpp/channel_error/m_~channel_error.md +++ b/docs/libraries/concurrency/channel.hpp/channel_error/m_~channel_error.md @@ -1,15 +1,17 @@ --- layout: method title: ~channel_error -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -is_dtor: true -overloads: - ~channel_error(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~channel_error() +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + is_dtor: true + overloads: + ~channel_error(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: ~channel_error() --- diff --git a/docs/libraries/concurrency/channel.hpp/f_channel.md b/docs/libraries/concurrency/channel.hpp/f_channel.md index 85f34790d..6fd7bff19 100644 --- a/docs/libraries/concurrency/channel.hpp/f_channel.md +++ b/docs/libraries/concurrency/channel.hpp/f_channel.md @@ -1,21 +1,28 @@ --- layout: function title: channel -owner: sean-parent -brief: Creates a pair that consists of a sender and a receiver -tags: - - function -defined_in_file: concurrency/channel.hpp -overloads: - "template \nauto channel(E)": - arguments: - - description: Executor which is used to send the passed values from the sender down to the receiver. - name: executor - type: E - description: Creates a channel that consists of a sending and a receiving part of the channel. - return: A pair of `sender` - `receiver` of type `T` that form a channel in case that `T` is not of type `void`. In case of type `void` it returns only a channel of type `void`. - signature_with_names: "template \nauto channel(E executor)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Creates a pair that consists of a sender and a receiver + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: concurrency/channel.hpp + overloads: + "template \nauto channel(E)": + arguments: + - description: Executor which is used to send the passed values from the sender down to the receiver. + name: executor + type: E + description: Creates a channel that consists of a sending and a receiving part of the channel. + inline: + description: + - "***********************************************************************************************" + return: A pair of `sender` - `receiver` of type `T` that form a channel in case that `T` is not of type `void`. In case of type `void` it returns only a channel of type `void`. + signature_with_names: "template \nauto channel(E executor)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/f_for_each_n.md b/docs/libraries/concurrency/channel.hpp/f_for_each_n.md index bf6211a90..3506dd2b2 100644 --- a/docs/libraries/concurrency/channel.hpp/f_for_each_n.md +++ b/docs/libraries/concurrency/channel.hpp/f_for_each_n.md @@ -1,27 +1,34 @@ --- layout: function title: for_each_n -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/channel.hpp -overloads: - "template \nI for_each_n(I, N, F)": - arguments: - - description: __OPTIONAL__ - name: p - type: I - - description: __OPTIONAL__ - name: n - type: N - - description: __OPTIONAL__ - name: f - type: F - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nI for_each_n(I p, N n, F f)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: concurrency/channel.hpp + overloads: + "template \nI for_each_n(I, N, F)": + arguments: + - description: __OPTIONAL__ + name: p + type: I + - description: __OPTIONAL__ + name: n + type: N + - description: __OPTIONAL__ + name: f + type: F + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nI for_each_n(I p, N n, F f)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/f_join.md b/docs/libraries/concurrency/channel.hpp/f_join.md index db55e710e..d6213b386 100644 --- a/docs/libraries/concurrency/channel.hpp/f_join.md +++ b/docs/libraries/concurrency/channel.hpp/f_join.md @@ -1,29 +1,36 @@ --- layout: function title: join -owner: sean-parent -brief: Creates a future that joins all passed arguments. This function is deprecated and it will soon be removed. Please use instead of `zip_with` -tags: - - function -defined_in_file: concurrency/channel.hpp -overloads: - "template \nauto join(S, F, R...)": - annotation: - - deprecated (Use zip_with) - arguments: - - description: Executor which shall be used to execute the task of `f`. - name: s - type: S - - description: Callable object that implements the task. Its parameters correspond to the results from the upstream receivers. It is called when all upstream receiver have provided its values. - name: f - type: F - - description: The upstream receiver. - name: upstream_receiver - type: R... - description: Creates a new receiver and attaches the process `f` to it. The values coming from the upstream receiver are the parameters of `f`. The incoming upstream values are not passed one after the other to this process, but they are passed as a complete set of arguments to the process. So the last incoming upstream value triggers the execution of `f`. - return: a future that joins all passed arguments - signature_with_names: "template \nauto join(S s, F f, R... upstream_receiver)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Creates a future that joins all passed arguments. This function is deprecated and it will soon be removed. Please use instead of `zip_with` + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: concurrency/channel.hpp + overloads: + "template \nauto join(S, F, R...)": + annotation: + - deprecated("Use zip_with") + arguments: + - description: Executor which shall be used to execute the task of `f`. + name: s + type: S + - description: Callable object that implements the task. Its parameters correspond to the results from the upstream receivers. It is called when all upstream receiver have provided its values. + name: f + type: F + - description: The upstream receiver. + name: upstream_receiver + type: R... + description: Creates a new receiver and attaches the process `f` to it. The values coming from the upstream receiver are the parameters of `f`. The incoming upstream values are not passed one after the other to this process, but they are passed as a complete set of arguments to the process. So the last incoming upstream value triggers the execution of `f`. + inline: + description: + - "***********************************************************************************************" + return: a future that joins all passed arguments + signature_with_names: "template \nauto join(S s, F f, R... upstream_receiver)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/f_merge.md b/docs/libraries/concurrency/channel.hpp/f_merge.md index b1db9ee04..19b10a5f6 100644 --- a/docs/libraries/concurrency/channel.hpp/f_merge.md +++ b/docs/libraries/concurrency/channel.hpp/f_merge.md @@ -1,29 +1,36 @@ --- layout: function title: merge -owner: sean-parent -brief: Creates a receiver that merges all passed arguments. This function is deprecated and will be removed soon. Please instead `merge_channel`. -tags: - - function -defined_in_file: concurrency/channel.hpp -overloads: - "template \nauto merge(S, F, R...)": - annotation: - - deprecated (Use merge_channel) - arguments: - - description: Executor which is used to schedule the resulting task - name: s - type: S - - description: Callable object that implements the process. All results from the upstream process must be convertible to the only argument of the provided function object's function operator or the argument of process' await function. - name: f - type: F - - description: The upstream receiver. - name: upstream_receiver - type: R... - description: Creates a process that executes the provided function object whenever an upstream process provides a value. There is no defined order in which the process `f` is called with the incoming upstream values. - return: a receiver that merges all passed arguments - signature_with_names: "template \nauto merge(S s, F f, R... upstream_receiver)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Creates a receiver that merges all passed arguments. This function is deprecated and will be removed soon. Please instead `merge_channel`. + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: concurrency/channel.hpp + overloads: + "template \nauto merge(S, F, R...)": + annotation: + - deprecated("Use merge_channel") + arguments: + - description: Executor which is used to schedule the resulting task + name: s + type: S + - description: Callable object that implements the process. All results from the upstream process must be convertible to the only argument of the provided function object's function operator or the argument of process' await function. + name: f + type: F + - description: The upstream receiver. + name: upstream_receiver + type: R... + description: Creates a process that executes the provided function object whenever an upstream process provides a value. There is no defined order in which the process `f` is called with the incoming upstream values. + inline: + description: + - "***********************************************************************************************" + return: a receiver that merges all passed arguments + signature_with_names: "template \nauto merge(S s, F f, R... upstream_receiver)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/f_merge_channel.md b/docs/libraries/concurrency/channel.hpp/f_merge_channel.md index 784a4da83..6ebb55764 100644 --- a/docs/libraries/concurrency/channel.hpp/f_merge_channel.md +++ b/docs/libraries/concurrency/channel.hpp/f_merge_channel.md @@ -1,27 +1,34 @@ --- layout: function title: merge_channel -owner: sean-parent -brief: Creates a channel that merges all passed arguments -tags: - - function -defined_in_file: concurrency/channel.hpp -overloads: - "template \nauto merge_channel(S, F, R...)": - arguments: - - description: Executor which is used to schedule the resulting task - name: s - type: S - - description: Callable object that implements the process. All results from the upstream process must be convertible to the only argument of the provided function object's function operator or the argument of process' await function. - name: f - type: F - - description: The upstream receiver. - name: upstream_receiver - type: R... - description: Creates a receiver with an attached process that executes the by `M`specified merge strategy whenever an upstream process provides a value. `M` can be of type `round_robin_t`, `unordered_t`, or `zip_with`. - return: a receiver that merges all passed arguments - signature_with_names: "template \nauto merge_channel(S s, F f, R... upstream_receiver)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Creates a channel that merges all passed arguments + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: concurrency/channel.hpp + overloads: + "template \nauto merge_channel(S, F, R...)": + arguments: + - description: Executor which is used to schedule the resulting task + name: s + type: S + - description: Callable object that implements the process. All results from the upstream process must be convertible to the only argument of the provided function object's function operator or the argument of process' await function. + name: f + type: F + - description: The upstream receiver. + name: upstream_receiver + type: R... + description: Creates a receiver with an attached process that executes the by `M`specified merge strategy whenever an upstream process provides a value. `M` can be of type `round_robin_t`, `unordered_t`, or `zip_with`. + inline: + description: + - "***********************************************************************************************" + return: a receiver that merges all passed arguments + signature_with_names: "template \nauto merge_channel(S s, F f, R... upstream_receiver)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/f_operator26.md b/docs/libraries/concurrency/channel.hpp/f_operator26.md index 001aa4473..e2ef276b3 100644 --- a/docs/libraries/concurrency/channel.hpp/f_operator26.md +++ b/docs/libraries/concurrency/channel.hpp/f_operator26.md @@ -1,145 +1,146 @@ --- layout: function title: operator& -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/channel.hpp -overloads: - detail::annotations operator&(const stlab::executor &, stlab::buffer_size): - arguments: - - description: __OPTIONAL__ - name: e - type: const stlab::executor & - - description: __OPTIONAL__ - name: bs - type: stlab::buffer_size - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: detail::annotations operator&(const stlab::executor & e, stlab::buffer_size bs) - detail::annotations operator&(stlab::buffer_size, const stlab::executor &): - arguments: - - description: __OPTIONAL__ - name: bs - type: stlab::buffer_size - - description: __OPTIONAL__ - name: e - type: const stlab::executor & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: detail::annotations operator&(stlab::buffer_size bs, const stlab::executor & e) - detail::annotations operator&(stlab::buffer_size, stlab::executor &&): - arguments: - - description: __OPTIONAL__ - name: bs - type: stlab::buffer_size - - description: __OPTIONAL__ - name: e - type: stlab::executor && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: detail::annotations operator&(stlab::buffer_size bs, stlab::executor && e) - detail::annotations operator&(stlab::executor &&, stlab::buffer_size): - arguments: - - description: __OPTIONAL__ - name: e - type: stlab::executor && - - description: __OPTIONAL__ - name: bs - type: stlab::buffer_size - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: detail::annotations operator&(stlab::executor && e, stlab::buffer_size bs) - "template \ndetail::annotated_process operator&(F &&, detail::annotations &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - - description: __OPTIONAL__ - name: a - type: detail::annotations && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ndetail::annotated_process operator&(F && f, detail::annotations && a)" - "template \ndetail::annotated_process operator&(F &&, stlab::buffer_size)": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - - description: __OPTIONAL__ - name: bs - type: stlab::buffer_size - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ndetail::annotated_process operator&(F && f, stlab::buffer_size bs)" - "template \ndetail::annotated_process operator&(detail::annotated_process &&, stlab::buffer_size)": - arguments: - - description: __OPTIONAL__ - name: a - type: detail::annotated_process && - - description: __OPTIONAL__ - name: bs - type: stlab::buffer_size - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ndetail::annotated_process operator&(detail::annotated_process && a, stlab::buffer_size bs)" - "template \ndetail::annotated_process operator&(detail::annotated_process &&, stlab::executor &&)": - arguments: - - description: __OPTIONAL__ - name: a - type: detail::annotated_process && - - description: __OPTIONAL__ - name: e - type: stlab::executor && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ndetail::annotated_process operator&(detail::annotated_process && a, stlab::executor && e)" - "template \ndetail::annotated_process operator&(detail::annotations &&, F &&)": - arguments: - - description: __OPTIONAL__ - name: a - type: detail::annotations && - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ndetail::annotated_process operator&(detail::annotations && a, F && f)" - "template \ndetail::annotated_process operator&(executor_task_pair &&, stlab::buffer_size)": - arguments: - - description: __OPTIONAL__ - name: etp - type: executor_task_pair && - - description: __OPTIONAL__ - name: bs - type: stlab::buffer_size - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ndetail::annotated_process operator&(executor_task_pair && etp, stlab::buffer_size bs)" - "template \ndetail::annotated_process operator&(stlab::buffer_size, F &&)": - arguments: - - description: __OPTIONAL__ - name: bs - type: stlab::buffer_size - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ndetail::annotated_process operator&(stlab::buffer_size bs, F && f)" - "template \ndetail::annotated_process operator&(stlab::buffer_size, executor_task_pair &&)": - arguments: - - description: __OPTIONAL__ - name: bs - type: stlab::buffer_size - - description: __OPTIONAL__ - name: etp - type: executor_task_pair && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ndetail::annotated_process operator&(stlab::buffer_size bs, executor_task_pair && etp)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/channel.hpp + overloads: + detail::annotations operator&(const stlab::executor &, stlab::buffer_size): + arguments: + - description: __OPTIONAL__ + name: e + type: const stlab::executor & + - description: __OPTIONAL__ + name: bs + type: stlab::buffer_size + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: detail::annotations operator&(const stlab::executor & e, stlab::buffer_size bs) + detail::annotations operator&(stlab::buffer_size, const stlab::executor &): + arguments: + - description: __OPTIONAL__ + name: bs + type: stlab::buffer_size + - description: __OPTIONAL__ + name: e + type: const stlab::executor & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: detail::annotations operator&(stlab::buffer_size bs, const stlab::executor & e) + detail::annotations operator&(stlab::buffer_size, stlab::executor &&): + arguments: + - description: __OPTIONAL__ + name: bs + type: stlab::buffer_size + - description: __OPTIONAL__ + name: e + type: stlab::executor && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: detail::annotations operator&(stlab::buffer_size bs, stlab::executor && e) + detail::annotations operator&(stlab::executor &&, stlab::buffer_size): + arguments: + - description: __OPTIONAL__ + name: e + type: stlab::executor && + - description: __OPTIONAL__ + name: bs + type: stlab::buffer_size + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: detail::annotations operator&(stlab::executor && e, stlab::buffer_size bs) + "template \ndetail::annotated_process operator&(F &&, detail::annotations &&)": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + - description: __OPTIONAL__ + name: a + type: detail::annotations && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \ndetail::annotated_process operator&(F && f, detail::annotations && a)" + "template \ndetail::annotated_process operator&(F &&, stlab::buffer_size)": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + - description: __OPTIONAL__ + name: bs + type: stlab::buffer_size + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \ndetail::annotated_process operator&(F && f, stlab::buffer_size bs)" + "template \ndetail::annotated_process operator&(detail::annotated_process &&, stlab::buffer_size)": + arguments: + - description: __OPTIONAL__ + name: a + type: detail::annotated_process && + - description: __OPTIONAL__ + name: bs + type: stlab::buffer_size + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \ndetail::annotated_process operator&(detail::annotated_process && a, stlab::buffer_size bs)" + "template \ndetail::annotated_process operator&(detail::annotated_process &&, stlab::executor &&)": + arguments: + - description: __OPTIONAL__ + name: a + type: detail::annotated_process && + - description: __OPTIONAL__ + name: e + type: stlab::executor && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \ndetail::annotated_process operator&(detail::annotated_process && a, stlab::executor && e)" + "template \ndetail::annotated_process operator&(detail::annotations &&, F &&)": + arguments: + - description: __OPTIONAL__ + name: a + type: detail::annotations && + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \ndetail::annotated_process operator&(detail::annotations && a, F && f)" + "template \ndetail::annotated_process operator&(executor_task_pair &&, stlab::buffer_size)": + arguments: + - description: __OPTIONAL__ + name: etp + type: executor_task_pair && + - description: __OPTIONAL__ + name: bs + type: stlab::buffer_size + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \ndetail::annotated_process operator&(executor_task_pair && etp, stlab::buffer_size bs)" + "template \ndetail::annotated_process operator&(stlab::buffer_size, F &&)": + arguments: + - description: __OPTIONAL__ + name: bs + type: stlab::buffer_size + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \ndetail::annotated_process operator&(stlab::buffer_size bs, F && f)" + "template \ndetail::annotated_process operator&(stlab::buffer_size, executor_task_pair &&)": + arguments: + - description: __OPTIONAL__ + name: bs + type: stlab::buffer_size + - description: __OPTIONAL__ + name: etp + type: executor_task_pair && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \ndetail::annotated_process operator&(stlab::buffer_size bs, executor_task_pair && etp)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/f_zip.md b/docs/libraries/concurrency/channel.hpp/f_zip.md index 4e905cae7..1fb7a48dd 100644 --- a/docs/libraries/concurrency/channel.hpp/f_zip.md +++ b/docs/libraries/concurrency/channel.hpp/f_zip.md @@ -1,24 +1,31 @@ --- layout: function title: zip -owner: sean-parent -brief: Zips the values in step from all upstream receivers. (The functionality has changed after release 1.2.0!) -tags: - - function -defined_in_file: concurrency/channel.hpp -overloads: - "template \nauto zip(S, R...)": - arguments: - - description: Executor which is used to schedule the resulting task - name: s - type: S - - description: The upstream receiver(s). - name: r - type: R... - description: Creates a receiver of type `tuple` where `T...` are the `result_type`s of the passed `upstream_receiver`. Whenever a complete set of values from each upstream receiver has arrived, it passes the tuple with the values downstream. - return: a `tuple` where `T...` are the `result_types` of all `upstream_receiver`. - signature_with_names: "template \nauto zip(S s, R... r)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Zips the values in step from all upstream receivers. (The functionality has changed after release 1.2.0!) + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: concurrency/channel.hpp + overloads: + "template \nauto zip(S, R...)": + arguments: + - description: Executor which is used to schedule the resulting task + name: s + type: S + - description: The upstream receiver(s). + name: r + type: R... + description: Creates a receiver of type `tuple` where `T...` are the `result_type`s of the passed `upstream_receiver`. Whenever a complete set of values from each upstream receiver has arrived, it passes the tuple with the values downstream. + inline: + description: + - "***********************************************************************************************" + return: a `tuple` where `T...` are the `result_types` of all `upstream_receiver`. + signature_with_names: "template \nauto zip(S s, R... r)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/f_zip_with.md b/docs/libraries/concurrency/channel.hpp/f_zip_with.md index 6b9dfc9d1..86b92c631 100644 --- a/docs/libraries/concurrency/channel.hpp/f_zip_with.md +++ b/docs/libraries/concurrency/channel.hpp/f_zip_with.md @@ -1,28 +1,34 @@ --- layout: function title: zip_with -owner: sean-parent -brief: Creates a channel that zips multiple channels into a single one -example: zip_with_example.cpp -tags: - - function -defined_in_file: concurrency/channel.hpp -overloads: - "template \nauto zip_with(S, F, R...)": - arguments: - - description: Executor which shall be used to combine the upstream values. - name: s - type: S - - description: The attached process that is invoked with a new set of values. - name: f - type: F - - description: The upstream receiver. - name: upstream_receiver - type: R... - description: Creates a new receiver. The values coming from the upstream receiver collected and when from each upstream receiver a values is available, then it passes them to the process `f`. - return: a `receiver` where `T is the result type of `f` - signature_with_names: "template \nauto zip_with(S s, F f, R... upstream_receiver)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Creates a channel that zips multiple channels into a single one + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: concurrency/channel.hpp + overloads: + "template \nauto zip_with(S, F, R...)": + arguments: + - description: Executor which shall be used to combine the upstream values. + name: s + type: S + - description: The attached process that is invoked with a new set of values. + name: f + type: F + - description: The upstream receiver. + name: upstream_receiver + type: R... + description: Creates a new receiver. The values coming from the upstream receiver collected and when from each upstream receiver a values is available, then it passes them to the process `f`. + inline: + description: + - "***********************************************************************************************" + return: a `receiver` where `T is the result type of `f` + signature_with_names: "template \nauto zip_with(S s, F f, R... upstream_receiver)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/first_3CT12C20T3E/index.md b/docs/libraries/concurrency/channel.hpp/first_3CT12C20T3E/index.md index 397dd0c33..cb0346239 100644 --- a/docs/libraries/concurrency/channel.hpp/first_3CT12C20T3E/index.md +++ b/docs/libraries/concurrency/channel.hpp/first_3CT12C20T3E/index.md @@ -1,19 +1,20 @@ --- layout: class title: first_ -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "template \nstruct stlab::first_;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: T1 - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/channel.hpp + declaration: "template \nstruct stlab::first_;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: T1 + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/index.md b/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/index.md index 17ba23b94..331816510 100644 --- a/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/index.md +++ b/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/index.md @@ -1,28 +1,29 @@ --- layout: class title: function_process -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "\nstruct stlab::function_process;" -dtor: unspecified -typedefs: - signature: - definition: R (Args...) - description: __MISSING__ -fields: - _bound: - description: __MISSING__ - type: std::function - _done: - description: __MISSING__ - type: bool - _f: - description: __MISSING__ - type: std::function -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/channel.hpp + declaration: "\nstruct stlab::function_process;" + dtor: unspecified + typedefs: + signature: + definition: R (Args...) + description: __MISSING__ + fields: + _bound: + description: __MISSING__ + type: std::function + _done: + description: __MISSING__ + type: bool + _f: + description: __MISSING__ + type: std::function + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_await.md b/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_await.md index 27ffc1b0c..eaad8ef68 100644 --- a/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_await.md +++ b/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_await.md @@ -1,18 +1,19 @@ --- layout: method title: await -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - "template \nvoid await(A &&...)": - arguments: - - description: __OPTIONAL__ - name: args - type: A &&... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid await(A &&... args)" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + "template \nvoid await(A &&...)": + arguments: + - description: __OPTIONAL__ + name: args + type: A &&... + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nvoid await(A &&... args)" --- diff --git a/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_function_process3CR2028Args293E.md b/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_function_process3CR2028Args293E.md index 3c9363995..1bbc7874e 100644 --- a/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_function_process3CR2028Args293E.md +++ b/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_function_process3CR2028Args293E.md @@ -1,19 +1,19 @@ --- layout: method title: function_process -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -is_ctor: true -overloads: - "template \nfunction_process(F &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nfunction_process(F && f)" +hyde: + owner: __MISSING__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + is_ctor: true + overloads: + "template \nfunction_process(F &&)": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __OPTIONAL__ + signature_with_names: "template \nfunction_process(F && f)" --- diff --git a/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_state.md b/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_state.md index 6b39973d0..97cc2d9aa 100644 --- a/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_state.md +++ b/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_state.md @@ -1,14 +1,15 @@ --- layout: method title: state -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - stlab::process_state_scheduled state() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::process_state_scheduled state() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + stlab::process_state_scheduled state() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::process_state_scheduled state() const --- diff --git a/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_yield.md b/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_yield.md index b34d51b55..9fba0b13c 100644 --- a/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_yield.md +++ b/docs/libraries/concurrency/channel.hpp/function_process3CR2028.9cd1ac2f/m_yield.md @@ -1,14 +1,15 @@ --- layout: method title: yield -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - R yield(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: R yield() +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + R yield(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: R yield() --- diff --git a/docs/libraries/concurrency/channel.hpp/identity/index.md b/docs/libraries/concurrency/channel.hpp/identity/index.md index 0d1030027..20e31fc30 100644 --- a/docs/libraries/concurrency/channel.hpp/identity/index.md +++ b/docs/libraries/concurrency/channel.hpp/identity/index.md @@ -1,15 +1,16 @@ --- layout: class title: identity -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "\nstruct stlab::identity;" -ctor: unspecified -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/channel.hpp + declaration: "\nstruct stlab::identity;" + ctor: unspecified + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/identity/m_identity.md b/docs/libraries/concurrency/channel.hpp/identity/m_identity.md index c9be4cacb..615965592 100644 --- a/docs/libraries/concurrency/channel.hpp/identity/m_identity.md +++ b/docs/libraries/concurrency/channel.hpp/identity/m_identity.md @@ -1,33 +1,37 @@ --- layout: method title: identity -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -is_ctor: true -overloads: - identity(): - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: identity() - identity(const stlab::identity &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::identity & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: identity(const stlab::identity &) - identity(stlab::identity &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::identity && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: identity(stlab::identity &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + is_ctor: true + overloads: + identity(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: identity() + identity(const stlab::identity &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::identity & + unnamed: true + description: __OPTIONAL__ + signature_with_names: identity(const stlab::identity &) + identity(stlab::identity &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::identity && + unnamed: true + description: __OPTIONAL__ + signature_with_names: identity(stlab::identity &&) --- diff --git a/docs/libraries/concurrency/channel.hpp/identity/m_operator2829.md b/docs/libraries/concurrency/channel.hpp/identity/m_operator2829.md index d72014d57..284c70078 100644 --- a/docs/libraries/concurrency/channel.hpp/identity/m_operator2829.md +++ b/docs/libraries/concurrency/channel.hpp/identity/m_operator2829.md @@ -1,18 +1,19 @@ --- layout: method title: operator() -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - "template \nT operator()(T &&) const": - arguments: - - description: __OPTIONAL__ - name: x - type: T && - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nT operator()(T && x) const" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + "template \nT operator()(T &&) const": + arguments: + - description: __OPTIONAL__ + name: x + type: T && + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nT operator()(T && x) const" --- diff --git a/docs/libraries/concurrency/channel.hpp/identity/m_~identity.md b/docs/libraries/concurrency/channel.hpp/identity/m_~identity.md index ec07172da..c433311aa 100644 --- a/docs/libraries/concurrency/channel.hpp/identity/m_~identity.md +++ b/docs/libraries/concurrency/channel.hpp/identity/m_~identity.md @@ -1,15 +1,17 @@ --- layout: method title: ~identity -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -is_dtor: true -overloads: - ~identity(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~identity() +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + is_dtor: true + overloads: + ~identity(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: ~identity() --- diff --git a/docs/libraries/concurrency/channel.hpp/index.md b/docs/libraries/concurrency/channel.hpp/index.md index 9b58a8ce5..0cd530224 100644 --- a/docs/libraries/concurrency/channel.hpp/index.md +++ b/docs/libraries/concurrency/channel.hpp/index.md @@ -1,24 +1,28 @@ --- layout: library title: concurrency/channel.hpp -owner: sean-parent -brief: This library implements the channel model of interprocess communication. -tags: - - sourcefile -library-type: sourcefile -typedefs: - argument_of_t: - definition: typename argument_of::type - description: __MISSING__ - first_t: - definition: typename first_::type - description: __MISSING__ - process_state_scheduled: - definition: std::pair - description: __MISSING__ - result_of_t_: - definition: typename result_of_::type - description: __MISSING__ +hyde: + owner: sean-parent + brief: This library implements the channel model of interprocess communication. + tags: + - sourcefile + library-type: sourcefile + typedefs: + argument_of_t: + definition: typename argument_of::type + description: __MISSING__ + first_t: + definition: typename first_::type + description: __MISSING__ + process_state_scheduled: + definition: std::pair + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + result_of_t_: + definition: typename result_of_::type + description: __MISSING__ --- [Channels](https://en.wikipedia.org/wiki/Channel_(programming)) are one model of interprocess communication that has its roots in [communicating sequential process](https://en.wikipedia.org/wiki/Communicating_sequential_processes) (CSP). diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_operator213D.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_operator213D.md index 65f8e012d..616f3aeeb 100644 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_operator213D.md +++ b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_operator213D.md @@ -1,46 +1,47 @@ --- layout: function title: operator!= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/channel.hpp -overloads: - bool operator!=(const receiver &, const receiver &): - arguments: - - description: __OPTIONAL__ - name: x - type: const receiver & - - description: __OPTIONAL__ - name: y - type: const receiver & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const receiver & x, const receiver & y) - bool operator!=(const sender, void>::type> &, const sender, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const sender, void>::type> & - - description: __OPTIONAL__ - name: y - type: const sender, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const sender, void>::type> & x, const sender, void>::type> & y) - bool operator!=(const sender, void>::type> &, const sender, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const sender, void>::type> & - - description: __OPTIONAL__ - name: y - type: const sender, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const sender, void>::type> & x, const sender, void>::type> & y) -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/channel.hpp + overloads: + bool operator!=(const receiver &, const receiver &): + arguments: + - description: __OPTIONAL__ + name: x + type: const receiver & + - description: __OPTIONAL__ + name: y + type: const receiver & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const receiver & x, const receiver & y) + bool operator!=(const sender, void>::type> &, const sender, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: const sender, void>::type> & + - description: __OPTIONAL__ + name: y + type: const sender, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const sender, void>::type> & x, const sender, void>::type> & y) + bool operator!=(const sender, void>::type> &, const sender, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: const sender, void>::type> & + - description: __OPTIONAL__ + name: y + type: const sender, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const sender, void>::type> & x, const sender, void>::type> & y) + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_operator3D3D.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_operator3D3D.md index 8b90e7213..6b1a5109a 100644 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_operator3D3D.md +++ b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_operator3D3D.md @@ -1,46 +1,47 @@ --- layout: function title: operator== -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/channel.hpp -overloads: - bool operator==(const receiver &, const receiver &): - arguments: - - description: __OPTIONAL__ - name: x - type: const receiver & - - description: __OPTIONAL__ - name: y - type: const receiver & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const receiver & x, const receiver & y) - bool operator==(const sender, void>::type> &, const sender, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const sender, void>::type> & - - description: __OPTIONAL__ - name: y - type: const sender, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const sender, void>::type> & x, const sender, void>::type> & y) - bool operator==(const sender, void>::type> &, const sender, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const sender, void>::type> & - - description: __OPTIONAL__ - name: y - type: const sender, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const sender, void>::type> & x, const sender, void>::type> & y) -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/channel.hpp + overloads: + bool operator==(const receiver &, const receiver &): + arguments: + - description: __OPTIONAL__ + name: x + type: const receiver & + - description: __OPTIONAL__ + name: y + type: const receiver & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const receiver & x, const receiver & y) + bool operator==(const sender, void>::type> &, const sender, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: const sender, void>::type> & + - description: __OPTIONAL__ + name: y + type: const sender, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const sender, void>::type> & x, const sender, void>::type> & y) + bool operator==(const sender, void>::type> &, const sender, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: const sender, void>::type> & + - description: __OPTIONAL__ + name: y + type: const sender, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const sender, void>::type> & x, const sender, void>::type> & y) + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_swap.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_swap.md index 5bbbdec9d..9f265ad27 100644 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_swap.md +++ b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/f_swap.md @@ -1,46 +1,47 @@ --- layout: function title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/channel.hpp -overloads: - void swap(receiver &, receiver &): - arguments: - - description: __OPTIONAL__ - name: x - type: receiver & - - description: __OPTIONAL__ - name: y - type: receiver & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(receiver & x, receiver & y) - void swap(sender, void>::type> &, sender, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: sender, void>::type> & - - description: __OPTIONAL__ - name: y - type: sender, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(sender, void>::type> & x, sender, void>::type> & y) - void swap(sender, void>::type> &, sender, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: sender, void>::type> & - - description: __OPTIONAL__ - name: y - type: sender, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(sender, void>::type> & x, sender, void>::type> & y) -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/channel.hpp + overloads: + void swap(receiver &, receiver &): + arguments: + - description: __OPTIONAL__ + name: x + type: receiver & + - description: __OPTIONAL__ + name: y + type: receiver & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: void swap(receiver & x, receiver & y) + void swap(sender, void>::type> &, sender, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: sender, void>::type> & + - description: __OPTIONAL__ + name: y + type: sender, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: void swap(sender, void>::type> & x, sender, void>::type> & y) + void swap(sender, void>::type> &, sender, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: sender, void>::type> & + - description: __OPTIONAL__ + name: y + type: sender, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: void swap(sender, void>::type> & x, sender, void>::type> & y) + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/index.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/index.md index 36eb8bcee..98f142bee 100644 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/index.md +++ b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/index.md @@ -1,19 +1,23 @@ --- layout: class title: receiver -owner: FelixPetriconi -brief: Implements the receiving part of a CSP channel -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "template \nclass stlab::receiver;" -typedefs: - result_type: - definition: T - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: FelixPetriconi + brief: Implements the receiving part of a CSP channel + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/channel.hpp + declaration: "template \nclass stlab::receiver;" + typedefs: + result_type: + definition: T + description: __MISSING__ + namespace: + - stlab + - v1 --- Each receiver has an attached process that gets executed when a value is send through the sender into the channel. This attached process must either be an n-ary function object - n depends on the number of attached upstream receiver - or it must be of a type that implements an `await()` and `yield()` method. diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_operator3D.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_operator3D.md index d1a947186..a35f50731 100644 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_operator3D.md +++ b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_operator3D.md @@ -1,28 +1,29 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - receiver & operator=(const receiver &): - arguments: - - description: __OPTIONAL__ - name: x - type: const receiver & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: receiver & operator=(const receiver & x) - receiver & operator=(receiver &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: x - type: receiver && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: receiver & operator=(receiver && x) +hyde: + owner: FelixPetriconi + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + receiver & operator=(const receiver &): + arguments: + - description: __OPTIONAL__ + name: x + type: const receiver & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: receiver & operator=(const receiver & x) + receiver & operator=(receiver &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: x + type: receiver && + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: receiver & operator=(receiver && x) --- diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_operator7C.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_operator7C.md index 589d274a1..6bf3af7d4 100644 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_operator7C.md +++ b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_operator7C.md @@ -1,45 +1,45 @@ --- layout: method title: operator| -owner: FelixPetriconi -brief: Attaches a new process to the channel. -example: operator_pipe_example.cpp -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - auto operator|(sender): - arguments: - - description: __OPTIONAL__ - name: send - type: sender - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: auto operator|(sender send) - "template \nauto operator|(F &&) const": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: Attaches the given process to the receiver and returns a new receiver. It can either be a function object with a single parameter or a process that has an `await()` and a `yield()` method. L-value processes can be attached when they are wrapped within `std::reference_wrapper`. - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(F && f) const" - "template \nauto operator|(detail::annotated_process)": - arguments: - - description: The process to be executed. - name: ap - type: detail::annotated_process - description: Attaches the given annotated process to the receiver and returns a new receiver. It can either be a function object with a single parameter or a process that follows this signature. An `annotated_process` should not be explicitly instantiated but it gets implicitly created as soon as one combines a function object with an `operator&` and an `executor` or a `buffer_size` or both. L-value processes can be attached when they are wrapped within `std::reference_wrapper`. - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(detail::annotated_process ap)" - "template \nauto operator|(executor_task_pair)": - arguments: - - description: __OPTIONAL__ - name: etp - type: executor_task_pair - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(executor_task_pair etp)" +hyde: + owner: FelixPetriconi + brief: Attaches a new process to the channel. + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + auto operator|(sender): + arguments: + - description: __OPTIONAL__ + name: send + type: sender + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: auto operator|(sender send) + "template \nauto operator|(F &&) const": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: Attaches the given process to the receiver and returns a new receiver. It can either be a function object with a single parameter or a process that has an `await()` and a `yield()` method. L-value processes can be attached when they are wrapped within `std::reference_wrapper`. + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(F && f) const" + "template \nauto operator|(detail::annotated_process)": + arguments: + - description: The process to be executed. + name: ap + type: detail::annotated_process + description: Attaches the given annotated process to the receiver and returns a new receiver. It can either be a function object with a single parameter or a process that follows this signature. An `annotated_process` should not be explicitly instantiated but it gets implicitly created as soon as one combines a function object with an `operator&` and an `executor` or a `buffer_size` or both. L-value processes can be attached when they are wrapped within `std::reference_wrapper`. + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(detail::annotated_process ap)" + "template \nauto operator|(executor_task_pair)": + arguments: + - description: __OPTIONAL__ + name: etp + type: executor_task_pair + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(executor_task_pair etp)" --- `operator|` creates a new receiver, attaches the given process as downstream to it and returns this new receiver. The new receiver inherits the executor from its upstream receiver if not an alternative executor is attached. In case that `T` of `receiver` is a move only type, repeated calls of this operator overwrite the previous attached downstream channel. \ No newline at end of file diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_ready.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_ready.md index 906b70212..93dec574d 100644 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_ready.md +++ b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_ready.md @@ -1,14 +1,15 @@ --- layout: method title: ready -owner: FelixPetriconi -brief: Returns `true` if the receiver is ready, otherwise `false`. -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - bool ready() const: - description: If the receiver was set to ready, it returns `true`, otherwise `false`; the initial value is `false`. - return: "`true` if this receiver is ready to receive values." - signature_with_names: bool ready() const +hyde: + owner: FelixPetriconi + brief: Returns `true` if the receiver is ready, otherwise `false`. + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + bool ready() const: + description: If the receiver was set to ready, it returns `true`, otherwise `false`; the initial value is `false`. + return: "`true` if this receiver is ready to receive values." + signature_with_names: bool ready() const --- diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_receiver3CT3E.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_receiver3CT3E.md index d82573841..a3e047909 100644 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_receiver3CT3E.md +++ b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_receiver3CT3E.md @@ -1,36 +1,34 @@ --- layout: method title: receiver -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -is_ctor: true -overloads: - receiver(): - annotation: - - default - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: receiver() - receiver(const receiver &): - arguments: - - description: __OPTIONAL__ - name: x - type: const receiver & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: receiver(const receiver & x) - receiver(receiver &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: receiver && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: receiver(receiver &&) +hyde: + owner: FelixPetriconi + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + is_ctor: true + overloads: + receiver(): + annotation: + - defaulted + description: __OPTIONAL__ + signature_with_names: receiver() + receiver(const receiver &): + arguments: + - description: __OPTIONAL__ + name: x + type: const receiver & + description: __MISSING__ + signature_with_names: receiver(const receiver & x) + receiver(receiver &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: receiver && + unnamed: true + description: __OPTIONAL__ + signature_with_names: receiver(receiver &&) --- diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_set_ready.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_set_ready.md index a150952a9..5811331c3 100644 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_set_ready.md +++ b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_set_ready.md @@ -1,14 +1,15 @@ --- layout: method title: set_ready -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - void set_ready(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void set_ready() +hyde: + owner: FelixPetriconi + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + void set_ready(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void set_ready() --- diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_swap.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_swap.md index e24d879dd..e4d13e3dc 100644 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_swap.md +++ b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_swap.md @@ -1,18 +1,19 @@ --- layout: method title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - void swap(receiver &): - arguments: - - description: __OPTIONAL__ - name: x - type: receiver & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void swap(receiver & x) +hyde: + owner: FelixPetriconi + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + void swap(receiver &): + arguments: + - description: __OPTIONAL__ + name: x + type: receiver & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void swap(receiver & x) --- diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_~receiver3CT3E.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_~receiver3CT3E.md index 82b9c00ed..b1296e1a9 100644 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_~receiver3CT3E.md +++ b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/m_~receiver3CT3E.md @@ -1,15 +1,15 @@ --- layout: method title: ~receiver -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -is_dtor: true -overloads: - ~receiver(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~receiver() +hyde: + owner: FelixPetriconi + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + is_dtor: true + overloads: + ~receiver(): + description: __OPTIONAL__ + signature_with_names: ~receiver() --- diff --git a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/set_ready.md b/docs/libraries/concurrency/channel.hpp/receiver3CT3E/set_ready.md deleted file mode 100644 index 4a79fd2c8..000000000 --- a/docs/libraries/concurrency/channel.hpp/receiver3CT3E/set_ready.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: method -title: set_ready -tags: [library] -scope: receiver -pure-name: set_ready -defined-in-header: stlab/concurrency/channel.hpp -declaration: set_ready -brief: Sets the receiver ready to receive values. -description: Sets the receiver ready to receive values. -example: set_ready_example.cpp -entities: - - kind: methods - list: - - name: stlab::receiver::set_ready - pure-name: set_ready - defined-in-header: stlab/concurrency/channel.hpp - declaration: void set_ready() - description: Sets this receiver ready to receiver values. That implies that no more downstream processes can be attached. - - kind: parameters - - kind: result ---- diff --git a/docs/libraries/concurrency/channel.hpp/result_of_3CR2028Args293E/index.md b/docs/libraries/concurrency/channel.hpp/result_of_3CR2028Args293E/index.md index 59dbc6e02..c50f0b4b3 100644 --- a/docs/libraries/concurrency/channel.hpp/result_of_3CR2028Args293E/index.md +++ b/docs/libraries/concurrency/channel.hpp/result_of_3CR2028Args293E/index.md @@ -1,19 +1,20 @@ --- layout: class title: result_of_ -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "\nstruct stlab::result_of_;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: R - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/channel.hpp + declaration: "\nstruct stlab::result_of_;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: R + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/round_robin_t/index.md b/docs/libraries/concurrency/channel.hpp/round_robin_t/index.md index 157e5057a..92496a49f 100644 --- a/docs/libraries/concurrency/channel.hpp/round_robin_t/index.md +++ b/docs/libraries/concurrency/channel.hpp/round_robin_t/index.md @@ -1,15 +1,16 @@ --- layout: class title: round_robin_t -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "\nstruct stlab::round_robin_t;" -ctor: unspecified -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/channel.hpp + declaration: "\nstruct stlab::round_robin_t;" + ctor: unspecified + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/index.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/index.md index a47688e61..c10caeec4 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/index.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/index.md @@ -1,13 +1,14 @@ --- layout: class title: sender> -owner: sean-parent -brief: The sending part of a CSP channel, where T is not copyable. -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "\nclass stlab::sender;" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: The sending part of a CSP channel, where T is not copyable. + tags: + - class + defined_in_file: concurrency/channel.hpp + declaration: "\nclass stlab::sender;" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_close.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_close.md index 53e295657..58707e5c1 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_close.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_close.md @@ -1,14 +1,15 @@ --- layout: method title: close -owner: FelixPetriconi -brief: Close this side of the channel. -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - void close(): - description: Closes this side of the channel, so it is not possible to send new values into it. It does not destruct the channel; already sent values will be processed. - return: __OPTIONAL__ - signature_with_names: void close() +hyde: + owner: FelixPetriconi + brief: Close this side of the channel. + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + void close(): + description: Closes this side of the channel, so it is not possible to send new values into it. It does not destruct the channel; already sent values will be processed. + return: __OPTIONAL__ + signature_with_names: void close() --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_free_buffer.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_free_buffer.md index 1f4f0d3b5..2abb690a5 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_free_buffer.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_free_buffer.md @@ -1,14 +1,15 @@ --- layout: method title: free_buffer -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - optional free_buffer() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: optional free_buffer() const +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + std::optional free_buffer() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: std::optional free_buffer() const --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_operator2829.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_operator2829.md index ce131f843..fb740f94d 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_operator2829.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_operator2829.md @@ -1,19 +1,19 @@ --- layout: method title: operator() -owner: FelixPetriconi -brief: Send a new value into the channel. -example: call_operator_example.cpp -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - "template \nvoid operator()(A &&...) const": - arguments: - - description: The input values of the channel that is defined by this sender - name: args - type: A &&... - description: Sends a new value into the channel. This function never blocks, even if the buffer of the associated reveiver has reached its limits, defined by a `buffer_size`. So even if a limit is given, it will be ignored on an explicit send() and grow the queue however large is required. - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(A &&... args) const" +hyde: + owner: FelixPetriconi + brief: Send a new value into the channel. + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + "template \nvoid operator()(A &&...) const": + arguments: + - description: The input values of the channel that is defined by this sender + name: args + type: A &&... + description: Sends a new value into the channel. This function never blocks, even if the buffer of the associated reveiver has reached its limits, defined by a `buffer_size`. So even if a limit is given, it will be ignored on an explicit send() and grow the queue however large is required. + return: __OPTIONAL__ + signature_with_names: "template \nvoid operator()(A &&... args) const" --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_operator3D.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_operator3D.md index e5b0a69e7..749da0f74 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_operator3D.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_operator3D.md @@ -1,31 +1,32 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - sender, void>::type> & operator=(const sender, void>::type> &): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: x - type: const sender, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: sender, void>::type> & operator=(const sender, void>::type> & x) - sender, void>::type> & operator=(sender, void>::type> &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: sender, void>::type> && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: sender, void>::type> & operator=(sender, void>::type> &&) +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + sender, void>::type> & operator=(const sender, void>::type> &): + annotation: + - deleted + arguments: + - description: __OPTIONAL__ + name: x + type: const sender, void>::type> & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: sender, void>::type> & operator=(const sender, void>::type> & x) + sender, void>::type> & operator=(sender, void>::type> &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: sender, void>::type> && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: sender, void>::type> & operator=(sender, void>::type> &&) --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_sender3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_sender3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md index d6c16e5fe..2cffc510c 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_sender3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_sender3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md @@ -1,38 +1,36 @@ --- layout: method title: sender, void>::type> -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -is_ctor: true -overloads: - sender, void>::type>(): - annotation: - - default - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: sender, void>::type>() - sender, void>::type>(const sender, void>::type> &): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: x - type: const sender, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: sender, void>::type>(const sender, void>::type> & x) - sender, void>::type>(sender, void>::type> &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: sender, void>::type> && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: sender, void>::type>(sender, void>::type> &&) +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + is_ctor: true + overloads: + sender, void>::type>(): + annotation: + - defaulted + description: __OPTIONAL__ + signature_with_names: sender, void>::type>() + sender, void>::type>(const sender, void>::type> &): + annotation: + - deleted + arguments: + - description: __OPTIONAL__ + name: x + type: const sender, void>::type> & + description: __OPTIONAL__ + signature_with_names: sender, void>::type>(const sender, void>::type> & x) + sender, void>::type>(sender, void>::type> &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: sender, void>::type> && + unnamed: true + description: __OPTIONAL__ + signature_with_names: sender, void>::type>(sender, void>::type> &&) --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_swap.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_swap.md index f86e4f812..2b759db36 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_swap.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_swap.md @@ -1,18 +1,19 @@ --- layout: method title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - void swap(sender, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: sender, void>::type> & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void swap(sender, void>::type> & x) +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + void swap(sender, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: sender, void>::type> & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void swap(sender, void>::type> & x) --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_~sender3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_~sender3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md index ef2808627..97547db25 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_~sender3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.8709540a/m_~sender3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md @@ -1,15 +1,15 @@ --- layout: method title: ~sender, void>::type> -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -is_dtor: true -overloads: - ~sender, void>::type>(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~sender, void>::type>() +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + is_dtor: true + overloads: + ~sender, void>::type>(): + description: __OPTIONAL__ + signature_with_names: ~sender, void>::type>() --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/index.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/index.md index 43c6715cd..7004d60e0 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/index.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/index.md @@ -1,13 +1,17 @@ --- layout: class title: sender> -owner: sean-parent -brief: The sending part of a CSP channel, where T is copyable. -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "\nclass stlab::sender;" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: The sending part of a CSP channel, where T is copyable. + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/channel.hpp + declaration: "\nclass stlab::sender;" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_close.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_close.md index 53e295657..58707e5c1 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_close.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_close.md @@ -1,14 +1,15 @@ --- layout: method title: close -owner: FelixPetriconi -brief: Close this side of the channel. -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - void close(): - description: Closes this side of the channel, so it is not possible to send new values into it. It does not destruct the channel; already sent values will be processed. - return: __OPTIONAL__ - signature_with_names: void close() +hyde: + owner: FelixPetriconi + brief: Close this side of the channel. + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + void close(): + description: Closes this side of the channel, so it is not possible to send new values into it. It does not destruct the channel; already sent values will be processed. + return: __OPTIONAL__ + signature_with_names: void close() --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_free_buffer.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_free_buffer.md index 1f4f0d3b5..2abb690a5 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_free_buffer.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_free_buffer.md @@ -1,14 +1,15 @@ --- layout: method title: free_buffer -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - optional free_buffer() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: optional free_buffer() const +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + std::optional free_buffer() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: std::optional free_buffer() const --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_operator2829.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_operator2829.md index b8f4feccf..1593d9e4a 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_operator2829.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_operator2829.md @@ -1,19 +1,20 @@ --- layout: method title: operator() -owner: __MISSING__ -brief: Sends a new value into the channel -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - "template \nvoid operator()(A &&...) const": - arguments: - - description: __OPTIONAL__ - name: args - type: A &&... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(A &&... args) const" +hyde: + owner: sean-parent + brief: Sends a new value into the channel + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + "template \nvoid operator()(A &&...) const": + arguments: + - description: __OPTIONAL__ + name: args + type: A &&... + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nvoid operator()(A &&... args) const" --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_operator3D.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_operator3D.md index 7d069cc8b..7a26696ee 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_operator3D.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_operator3D.md @@ -1,29 +1,30 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - sender, void>::type> & operator=(const sender, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const sender, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: sender, void>::type> & operator=(const sender, void>::type> & x) - sender, void>::type> & operator=(sender, void>::type> &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: sender, void>::type> && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: sender, void>::type> & operator=(sender, void>::type> &&) +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + sender, void>::type> & operator=(const sender, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: const sender, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: sender, void>::type> & operator=(const sender, void>::type> & x) + sender, void>::type> & operator=(sender, void>::type> &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: sender, void>::type> && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: sender, void>::type> & operator=(sender, void>::type> &&) --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_sender3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_sender3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md index 17f67eeb0..4ea6fa1f4 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_sender3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_sender3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md @@ -1,36 +1,34 @@ --- layout: method title: sender, void>::type> -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -is_ctor: true -overloads: - sender, void>::type>(): - annotation: - - default - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: sender, void>::type>() - sender, void>::type>(const sender, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const sender, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: sender, void>::type>(const sender, void>::type> & x) - sender, void>::type>(sender, void>::type> &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: sender, void>::type> && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: sender, void>::type>(sender, void>::type> &&) +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + is_ctor: true + overloads: + sender, void>::type>(): + annotation: + - defaulted + description: __OPTIONAL__ + signature_with_names: sender, void>::type>() + sender, void>::type>(const sender, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: const sender, void>::type> & + description: __MISSING__ + signature_with_names: sender, void>::type>(const sender, void>::type> & x) + sender, void>::type>(sender, void>::type> &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: sender, void>::type> && + unnamed: true + description: __OPTIONAL__ + signature_with_names: sender, void>::type>(sender, void>::type> &&) --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_swap.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_swap.md index ac52b1187..1d0d8ec78 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_swap.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_swap.md @@ -1,18 +1,19 @@ --- layout: method title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -overloads: - void swap(sender, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: sender, void>::type> & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void swap(sender, void>::type> & x) +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/channel.hpp + overloads: + void swap(sender, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: sender, void>::type> & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void swap(sender, void>::type> & x) --- diff --git a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_~sender3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_~sender3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md index 6987963e4..96d601d8b 100644 --- a/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_~sender3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md +++ b/docs/libraries/concurrency/channel.hpp/sender3CT2C20enable_if_.a01d6424/m_~sender3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md @@ -1,15 +1,15 @@ --- layout: method title: ~sender, void>::type> -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/channel.hpp -is_dtor: true -overloads: - ~sender, void>::type>(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~sender, void>::type>() +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/channel.hpp + is_dtor: true + overloads: + ~sender, void>::type>(): + description: __OPTIONAL__ + signature_with_names: ~sender, void>::type>() --- diff --git a/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Achannel_error_codes.md b/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Achannel_error_codes.md index 52b5d0f4c..73855520d 100644 --- a/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Achannel_error_codes.md +++ b/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Achannel_error_codes.md @@ -1,19 +1,23 @@ --- layout: enumeration title: channel_error_codes -owner: __MISSING__ -brief: __MISSING__ -tags: - - enumeration -defined_in_file: concurrency/channel.hpp -namespace: - - stlab - - v1 -values: - - description: __MISSING__ - name: broken_channel - - description: __MISSING__ - name: process_already_running - - description: __MISSING__ - name: no_state +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - enumeration + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/channel.hpp + namespace: + - stlab + - v1 + values: + - description: __MISSING__ + name: broken_channel + - description: __MISSING__ + name: process_already_running + - description: __MISSING__ + name: no_state --- diff --git a/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Amessage_t.md b/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Amessage_t.md index 6df7f817f..431da469b 100644 --- a/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Amessage_t.md +++ b/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Amessage_t.md @@ -1,17 +1,18 @@ --- layout: enumeration title: message_t -owner: __MISSING__ -brief: __MISSING__ -tags: - - enumeration -defined_in_file: concurrency/channel.hpp -namespace: - - stlab - - v1 -values: - - description: __MISSING__ - name: argument - - description: __MISSING__ - name: error +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - enumeration + defined_in_file: concurrency/channel.hpp + namespace: + - stlab + - v1 + values: + - description: __MISSING__ + name: argument + - description: __MISSING__ + name: error --- diff --git a/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Aprocess_state.md b/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Aprocess_state.md index 2aaed41bc..d31d016f3 100644 --- a/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Aprocess_state.md +++ b/docs/libraries/concurrency/channel.hpp/stlab3A3Av13A3Aprocess_state.md @@ -1,17 +1,22 @@ --- layout: enumeration title: process_state -owner: __MISSING__ -brief: __MISSING__ -tags: - - enumeration -defined_in_file: concurrency/channel.hpp -namespace: - - stlab - - v1 -values: - - description: __MISSING__ - name: await - - description: __MISSING__ - name: yield +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - enumeration + inline: + description: + - "***********************************************************************************************" + - close on a process is called when a process is in an await state to signal that no more data is coming. In response to a close, a process can switch to a yield state to yield values, otherwise it is destructed. await_try is await if a value is available, otherwise yield (allowing for an interruptible task). + defined_in_file: concurrency/channel.hpp + namespace: + - stlab + - v1 + values: + - description: __MISSING__ + name: await + - description: __MISSING__ + name: yield --- diff --git a/docs/libraries/concurrency/channel.hpp/unordered_t/index.md b/docs/libraries/concurrency/channel.hpp/unordered_t/index.md index 09b2a3204..df2905c38 100644 --- a/docs/libraries/concurrency/channel.hpp/unordered_t/index.md +++ b/docs/libraries/concurrency/channel.hpp/unordered_t/index.md @@ -1,15 +1,16 @@ --- layout: class title: unordered_t -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "\nstruct stlab::unordered_t;" -ctor: unspecified -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/channel.hpp + declaration: "\nstruct stlab::unordered_t;" + ctor: unspecified + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/channel.hpp/zip_with_t/index.md b/docs/libraries/concurrency/channel.hpp/zip_with_t/index.md index d19b364fb..c807bf5da 100644 --- a/docs/libraries/concurrency/channel.hpp/zip_with_t/index.md +++ b/docs/libraries/concurrency/channel.hpp/zip_with_t/index.md @@ -1,15 +1,16 @@ --- layout: class title: zip_with_t -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/channel.hpp -declaration: "\nstruct stlab::zip_with_t;" -ctor: unspecified -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/channel.hpp + declaration: "\nstruct stlab::zip_with_t;" + ctor: unspecified + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/concurrency.hpp/index.md b/docs/libraries/concurrency/concurrency.hpp/index.md index 27a94a5a0..026846045 100644 --- a/docs/libraries/concurrency/concurrency.hpp/index.md +++ b/docs/libraries/concurrency/concurrency.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: concurrency/concurrency.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/index.md b/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/index.md deleted file mode 100644 index 2d087021a..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: class -title: executor_type

-owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/default_executor.hpp -declaration: "template \nstruct stlab::detail::executor_type;" -ctor: unspecified -dtor: unspecified -typedefs: - result_type: - definition: void - description: __MISSING__ -namespace: - - stlab - - v1 - - detail ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/m_operator2829.md b/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/m_operator2829.md deleted file mode 100644 index 2c12169b2..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/m_operator2829.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: operator() -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/default_executor.hpp -overloads: - "template \nvoid operator()(F) const": - arguments: - - description: __OPTIONAL__ - name: f - type: F - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(F f) const" ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/f_group.md b/docs/libraries/concurrency/default_executor.hpp/f_group.md deleted file mode 100644 index 93765ff47..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/f_group.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: function -title: group -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/default_executor.hpp -overloads: - stlab::detail::group_t & group(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::detail::group_t & group() -namespace: - - stlab - - v1 - - detail ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/f_platform_priority.md b/docs/libraries/concurrency/default_executor.hpp/f_platform_priority.md deleted file mode 100644 index f16e04260..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/f_platform_priority.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: function -title: platform_priority -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/default_executor.hpp -overloads: - constexpr int platform_priority(stlab::detail::executor_priority): - arguments: - - description: __OPTIONAL__ - name: p - type: stlab::detail::executor_priority - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: constexpr int platform_priority(stlab::detail::executor_priority p) -namespace: - - stlab - - v1 - - detail ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/group_t/index.md b/docs/libraries/concurrency/default_executor.hpp/group_t/index.md deleted file mode 100644 index 311b21904..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/group_t/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: class -title: group_t -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/default_executor.hpp -declaration: "\nstruct stlab::detail::group_t;" -ctor: unspecified -fields: - _group: - description: __MISSING__ - type: dispatch_group_t -namespace: - - stlab - - v1 - - detail ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/group_t/m_group_t.md b/docs/libraries/concurrency/default_executor.hpp/group_t/m_group_t.md deleted file mode 100644 index c2022394b..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/group_t/m_group_t.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: method -title: group_t -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/default_executor.hpp -is_ctor: true -overloads: - group_t(): - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: group_t() - group_t(const stlab::detail::group_t &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::detail::group_t & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: group_t(const stlab::detail::group_t &) ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/group_t/m_~group_t.md b/docs/libraries/concurrency/default_executor.hpp/group_t/m_~group_t.md deleted file mode 100644 index d9964d2e0..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/group_t/m_~group_t.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: method -title: ~group_t -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/default_executor.hpp -is_dtor: true -overloads: - ~group_t(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~group_t() ---- diff --git a/docs/libraries/concurrency/default_executor.hpp/index.md b/docs/libraries/concurrency/default_executor.hpp/index.md index 153c5b326..910b7859d 100644 --- a/docs/libraries/concurrency/default_executor.hpp/index.md +++ b/docs/libraries/concurrency/default_executor.hpp/index.md @@ -1,11 +1,12 @@ --- layout: library title: concurrency/default_executor.hpp -owner: sean-parent -brief: Interface to the system's thread pool -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: sean-parent + brief: Interface to the system's thread pool + tags: + - sourcefile + library-type: sourcefile --- The `stlab.concurrency` library provides an abstraction to the OS's system thread pool. It provides its own implementation if the OS does not provide one. diff --git a/docs/libraries/concurrency/default_executor.hpp/stlab3A3Av13A3Adetail3A3Aexecutor_priority.md b/docs/libraries/concurrency/default_executor.hpp/stlab3A3Av13A3Adetail3A3Aexecutor_priority.md deleted file mode 100644 index 88217701d..000000000 --- a/docs/libraries/concurrency/default_executor.hpp/stlab3A3Av13A3Adetail3A3Aexecutor_priority.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: enumeration -title: executor_priority -owner: __MISSING__ -brief: __MISSING__ -tags: - - enumeration -defined_in_file: concurrency/default_executor.hpp -namespace: - - stlab - - v1 - - detail -values: - - description: __MISSING__ - name: high - - description: __MISSING__ - name: medium - - description: __MISSING__ - name: low ---- diff --git a/docs/libraries/concurrency/executor_base.hpp/executor/index.md b/docs/libraries/concurrency/executor_base.hpp/executor/index.md index e2ff50c75..d7467d2ce 100644 --- a/docs/libraries/concurrency/executor_base.hpp/executor/index.md +++ b/docs/libraries/concurrency/executor_base.hpp/executor/index.md @@ -1,19 +1,20 @@ --- layout: class title: executor -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/executor_base.hpp -declaration: "\nstruct stlab::executor;" -ctor: unspecified -dtor: unspecified -fields: - _executor: - description: __MISSING__ - type: stlab::executor_t -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/executor_base.hpp + declaration: "\nstruct stlab::executor;" + ctor: unspecified + dtor: unspecified + fields: + _executor: + description: __MISSING__ + type: stlab::executor_t + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/executor_base.hpp/executor/m_executor.md b/docs/libraries/concurrency/executor_base.hpp/executor/m_executor.md index 5a798383a..caa07799a 100644 --- a/docs/libraries/concurrency/executor_base.hpp/executor/m_executor.md +++ b/docs/libraries/concurrency/executor_base.hpp/executor/m_executor.md @@ -1,29 +1,32 @@ --- layout: method title: executor -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/executor_base.hpp -is_ctor: true -overloads: - executor(const stlab::executor &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::executor & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: executor(const stlab::executor &) - executor(stlab::executor &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::executor && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: executor(stlab::executor &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/executor_base.hpp + is_ctor: true + overloads: + executor(const stlab::executor &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::executor & + unnamed: true + description: __OPTIONAL__ + signature_with_names: executor(const stlab::executor &) + executor(stlab::executor &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::executor && + unnamed: true + description: __OPTIONAL__ + signature_with_names: executor(stlab::executor &&) --- diff --git a/docs/libraries/concurrency/executor_base.hpp/executor/m_operator3D.md b/docs/libraries/concurrency/executor_base.hpp/executor/m_operator3D.md index d21a6dc04..e57340931 100644 --- a/docs/libraries/concurrency/executor_base.hpp/executor/m_operator3D.md +++ b/docs/libraries/concurrency/executor_base.hpp/executor/m_operator3D.md @@ -1,28 +1,33 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/executor_base.hpp -overloads: - stlab::executor & operator=(const stlab::executor &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::executor & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::executor & operator=(const stlab::executor &) - stlab::executor & operator=(stlab::executor &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::executor && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::executor & operator=(stlab::executor &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/executor_base.hpp + overloads: + stlab::executor & operator=(const stlab::executor &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::executor & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::executor & operator=(const stlab::executor &) + stlab::executor & operator=(stlab::executor &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::executor && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::executor & operator=(stlab::executor &&) --- diff --git a/docs/libraries/concurrency/executor_base.hpp/executor/m_~executor.md b/docs/libraries/concurrency/executor_base.hpp/executor/m_~executor.md index e59c5b234..d1548132a 100644 --- a/docs/libraries/concurrency/executor_base.hpp/executor/m_~executor.md +++ b/docs/libraries/concurrency/executor_base.hpp/executor/m_~executor.md @@ -1,15 +1,17 @@ --- layout: method title: ~executor -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/executor_base.hpp -is_dtor: true -overloads: - ~executor(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~executor() +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/executor_base.hpp + is_dtor: true + overloads: + ~executor(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: ~executor() --- diff --git a/docs/libraries/concurrency/executor_base.hpp/executor_task_pair3CF3E/index.md b/docs/libraries/concurrency/executor_base.hpp/executor_task_pair3CF3E/index.md index d3f89f7b1..0eaff4848 100644 --- a/docs/libraries/concurrency/executor_base.hpp/executor_task_pair3CF3E/index.md +++ b/docs/libraries/concurrency/executor_base.hpp/executor_task_pair3CF3E/index.md @@ -1,22 +1,23 @@ --- layout: class title: executor_task_pair -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/executor_base.hpp -declaration: "template \nstruct stlab::executor_task_pair;" -ctor: unspecified -dtor: unspecified -fields: - _executor: - description: __MISSING__ - type: stlab::executor_t - _f: - description: __MISSING__ - type: F -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/executor_base.hpp + declaration: "template \nstruct stlab::executor_task_pair;" + ctor: unspecified + dtor: unspecified + fields: + _executor: + description: __MISSING__ + type: stlab::executor_t + _f: + description: __MISSING__ + type: F + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/executor_base.hpp/f_execute_at.md b/docs/libraries/concurrency/executor_base.hpp/f_execute_at.md index 473781f69..85d8b6160 100644 --- a/docs/libraries/concurrency/executor_base.hpp/f_execute_at.md +++ b/docs/libraries/concurrency/executor_base.hpp/f_execute_at.md @@ -1,48 +1,57 @@ --- layout: function title: execute_at -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/executor_base.hpp -overloads: - stlab::executor_t execute_at(std::chrono::duration>, stlab::executor_t): - arguments: - - description: __OPTIONAL__ - name: duration - type: std::chrono::duration> - - description: __OPTIONAL__ - name: executor - type: stlab::executor_t - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::executor_t execute_at(std::chrono::duration> duration, stlab::executor_t executor) - stlab::executor_t execute_at(std::chrono::steady_clock::time_point, stlab::executor_t): - annotation: - - deprecated (Use chrono::duration as parameter instead) - arguments: - - description: __OPTIONAL__ - name: when - type: std::chrono::steady_clock::time_point - - description: __OPTIONAL__ - name: executor - type: stlab::executor_t - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::executor_t execute_at(std::chrono::steady_clock::time_point when, stlab::executor_t executor) - "template \nstlab::executor_t execute_at(std::chrono::duration, stlab::executor_t)": - arguments: - - description: __OPTIONAL__ - name: duration - type: std::chrono::duration - - description: __OPTIONAL__ - name: executor - type: stlab::executor_t - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nstlab::executor_t execute_at(std::chrono::duration duration, stlab::executor_t executor)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: _multiple descriptions_ + defined_in_file: concurrency/executor_base.hpp + overloads: + stlab::executor_t execute_at(std::chrono::duration>, stlab::executor_t): + arguments: + - description: __OPTIONAL__ + name: duration + type: std::chrono::duration> + - description: __OPTIONAL__ + name: executor + type: stlab::executor_t + description: __INLINED__ + inline: + description: + - returns an executor that will schedule any passed task to it to execute at the given time point on the executor provided + return: __OPTIONAL__ + signature_with_names: stlab::executor_t execute_at(std::chrono::duration> duration, stlab::executor_t executor) + stlab::executor_t execute_at(std::chrono::steady_clock::time_point, stlab::executor_t): + annotation: + - deprecated("Use chrono::duration as parameter instead") + arguments: + - description: __OPTIONAL__ + name: when + type: std::chrono::steady_clock::time_point + - description: __OPTIONAL__ + name: executor + type: stlab::executor_t + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: stlab::executor_t execute_at(std::chrono::steady_clock::time_point when, stlab::executor_t executor) + "template \nstlab::executor_t execute_at(std::chrono::duration, stlab::executor_t)": + arguments: + - description: __OPTIONAL__ + name: duration + type: std::chrono::duration + - description: __OPTIONAL__ + name: executor + type: stlab::executor_t + description: __INLINED__ + inline: + description: + - returns an executor that will schedule any passed task to it to execute at the given time point on the executor provided + return: __OPTIONAL__ + signature_with_names: "template \nstlab::executor_t execute_at(std::chrono::duration duration, stlab::executor_t executor)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/executor_base.hpp/f_execute_delayed.md b/docs/libraries/concurrency/executor_base.hpp/f_execute_delayed.md index 1f405edd1..b950c6135 100644 --- a/docs/libraries/concurrency/executor_base.hpp/f_execute_delayed.md +++ b/docs/libraries/concurrency/executor_base.hpp/f_execute_delayed.md @@ -1,24 +1,31 @@ --- layout: function title: execute_delayed -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/executor_base.hpp -overloads: - "template \nauto execute_delayed(std::chrono::duration, E)": - arguments: - - description: __OPTIONAL__ - name: duration - type: std::chrono::duration - - description: __OPTIONAL__ - name: executor - type: E - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto execute_delayed(std::chrono::duration duration, E executor)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - returns an executor that will schedule the task to execute on the provided executor duration after it is invoked + defined_in_file: concurrency/executor_base.hpp + overloads: + "template \nauto execute_delayed(std::chrono::duration, E)": + arguments: + - description: __OPTIONAL__ + name: duration + type: std::chrono::duration + - description: __OPTIONAL__ + name: executor + type: E + description: __INLINED__ + inline: + description: + - returns an executor that will schedule the task to execute on the provided executor duration after it is invoked + return: __OPTIONAL__ + signature_with_names: "template \nauto execute_delayed(std::chrono::duration duration, E executor)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/executor_base.hpp/f_operator26.md b/docs/libraries/concurrency/executor_base.hpp/f_operator26.md index 4231d7ebd..18d0c519e 100644 --- a/docs/libraries/concurrency/executor_base.hpp/f_operator26.md +++ b/docs/libraries/concurrency/executor_base.hpp/f_operator26.md @@ -1,35 +1,36 @@ --- layout: function title: operator& -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/executor_base.hpp -overloads: - "template \nexecutor_task_pair operator&(F &&, stlab::executor)": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - - description: __OPTIONAL__ - name: e - type: stlab::executor - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nexecutor_task_pair operator&(F && f, stlab::executor e)" - "template \nexecutor_task_pair operator&(stlab::executor, F &&)": - arguments: - - description: __OPTIONAL__ - name: e - type: stlab::executor - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nexecutor_task_pair operator&(stlab::executor e, F && f)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/executor_base.hpp + overloads: + "template \nexecutor_task_pair operator&(F &&, stlab::executor)": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + - description: __OPTIONAL__ + name: e + type: stlab::executor + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nexecutor_task_pair operator&(F && f, stlab::executor e)" + "template \nexecutor_task_pair operator&(stlab::executor, F &&)": + arguments: + - description: __OPTIONAL__ + name: e + type: stlab::executor + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nexecutor_task_pair operator&(stlab::executor e, F && f)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/executor_base.hpp/index.md b/docs/libraries/concurrency/executor_base.hpp/index.md index ff6b8c3b0..915259789 100644 --- a/docs/libraries/concurrency/executor_base.hpp/index.md +++ b/docs/libraries/concurrency/executor_base.hpp/index.md @@ -1,13 +1,17 @@ --- layout: library title: concurrency/executor_base.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile -typedefs: - executor_t: - definition: std::function)> - description: __MISSING__ +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile + typedefs: + executor_t: + definition: std::function)> + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" --- diff --git a/docs/libraries/concurrency/future.hpp/f_async.md b/docs/libraries/concurrency/future.hpp/f_async.md index 5fc4045cb..0c902ee51 100644 --- a/docs/libraries/concurrency/future.hpp/f_async.md +++ b/docs/libraries/concurrency/future.hpp/f_async.md @@ -1,27 +1,34 @@ --- layout: function title: async -owner: sean-parent -brief: Creates a future running on a given executor -tags: - - function -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto async(E, F &&, Args &&...) -> future, std::decay_t...>>": - arguments: - - description: The executor that shall be used to run the given callable f. - name: executor - type: E - - description: The callable object - name: f - type: F && - - description: All arguments that are needed to call f, if needed. - name: args - type: Args &&... - description: The template function creates future that runs the callable object f on the specified executor. - return: The future on the for the underlying task f - signature_with_names: "template \nauto async(E executor, F && f, Args &&... args) -> future, std::decay_t...>>" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Creates a future running on a given executor + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto async(E, F &&, Args &&...) -> detail::reduced_t, std::decay_t...>>>": + arguments: + - description: __OPTIONAL__ + name: executor + type: E + - description: __OPTIONAL__ + name: f + type: F && + - description: __OPTIONAL__ + name: args + type: Args &&... + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto async(E executor, F && f, Args &&... args) -> detail::reduced_t, std::decay_t...>>>" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/future.hpp/f_when_all.md b/docs/libraries/concurrency/future.hpp/f_when_all.md index ef07564fd..7e5d221ff 100644 --- a/docs/libraries/concurrency/future.hpp/f_when_all.md +++ b/docs/libraries/concurrency/future.hpp/f_when_all.md @@ -1,42 +1,50 @@ --- layout: function title: when_all -owner: sean-parent -brief: Creates a joining future -example: [ when_all_example.cpp, when_all_void_example.cpp ] -tags: - - function -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto when_all(E, F, std::pair)": - arguments: - - description: Executor which is used to schedule the resulting task - name: executor - type: E - - description: Callable object that implements the continuing task - name: f - type: F - - description: Describes the range of futures. If an empty range is provided then an stlab::future_exception with code stlab::future_errc::broken_promise is thrown. - name: range - type: std::pair - description: Creates a joining future. When all passed `args` futures are fulfilled, then the continuation tasks defined with `f` is scheduled on the executor `executor`. - return: __OPTIONAL__ - signature_with_names: "template \nauto when_all(E executor, F f, std::pair range)" - "template \nauto when_all(E, F, future...)": - arguments: - - description: Executor which is used to schedule the resulting task - name: executor - type: E - - description: Callable object that implements the continuing task - name: f - type: F - - description: __OPTIONAL__ - name: args - type: future... - description: Creates a joining future out of the given range. In case that it is a range of futures of move-only types, the futures are moved internally out of the range into the function. - return: The continuation on the group of passed futures. - signature_with_names: "template \nauto when_all(E executor, F f, future... args)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Creates a joining future + tags: + - function + inline: + brief: _multiple descriptions_ + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto when_all(E, F, std::pair)": + arguments: + - description: Executor which is used to schedule the resulting task + name: executor + type: E + - description: Callable object that implements the continuing task + name: f + type: F + - description: Describes the range of futures. If an empty range is provided then an stlab::future_exception with code stlab::future_errc::broken_promise is thrown. + name: range + type: std::pair + description: Creates a joining future. When all passed `args` futures are fulfilled, then the continuation tasks defined with `f` is scheduled on the executor `executor`. + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto when_all(E executor, F f, std::pair range)" + "template \nauto when_all(E, F, future...)": + arguments: + - description: Executor which is used to schedule the resulting task + name: executor + type: E + - description: Callable object that implements the continuing task + name: f + type: F + - description: __OPTIONAL__ + name: args + type: future... + description: Creates a joining future out of the given range. In case that it is a range of futures of move-only types, the futures are moved internally out of the range into the function. + inline: + description: + - "***********************************************************************************************" + return: The continuation on the group of passed futures. + signature_with_names: "template \nauto when_all(E executor, F f, future... args)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/future.hpp/f_when_any.md b/docs/libraries/concurrency/future.hpp/f_when_any.md index 28c30052b..148886a1f 100644 --- a/docs/libraries/concurrency/future.hpp/f_when_any.md +++ b/docs/libraries/concurrency/future.hpp/f_when_any.md @@ -1,45 +1,54 @@ --- layout: function title: when_any -owner: sean-parent -brief: Creates a future that continues on the first success of any futures passed -tags: - - function -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto when_any(E, F &&, std::pair)": - arguments: - - description: Executor which is used to schedule the resulting task - name: executor - type: E - - description: Callable object that implements the continuing task - name: f - type: F && - - description: Describes the range of futures. If an empty range is provided then an stlab::future_exception with code stlab::future_errc::broken_promise is thrown. - name: range - type: std::pair - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto when_any(E executor, F && f, std::pair range)" - "template \nauto when_any(E, F &&, future, future...)": - arguments: - - description: Executor which is used to schedule the resulting task - name: executor - type: E - - description: Callable object that implements the continuing task - name: f - type: F && - - description: __OPTIONAL__ - name: arg - type: future - - description: __OPTIONAL__ - name: args - type: future... - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto when_any(E executor, F && f, future arg, future... args)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Creates a future that continues on the first success of any futures passed + tags: + - function + inline: + brief: _multiple descriptions_ + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto when_any(E, F &&, std::pair)": + arguments: + - description: Executor which is used to schedule the resulting task + name: executor + type: E + - description: Callable object that implements the continuing task + name: f + type: F && + - description: Describes the range of futures. If an empty range is provided then an stlab::future_exception with code stlab::future_errc::broken_promise is thrown. + name: range + type: std::pair + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto when_any(E executor, F && f, std::pair range)" + "template \nauto when_any(E, F &&, future, future...)": + arguments: + - description: Executor which is used to schedule the resulting task + name: executor + type: E + - description: Callable object that implements the continuing task + name: f + type: F && + - description: __OPTIONAL__ + name: arg + type: future + - description: __OPTIONAL__ + name: args + type: future... + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto when_any(E executor, F && f, future arg, future... args)" + namespace: + - stlab + - v1 --- Creates a future that continues on the first success of any futures passed. The results of all passed futures must be convertible to the first parameter of the continuing function. The function must accept the a second parameter of std::size_t. It will receive the index of the future that succeeded first. diff --git a/docs/libraries/concurrency/future.hpp/future/f_operator213D.md b/docs/libraries/concurrency/future.hpp/future/f_operator213D.md deleted file mode 100644 index d6b7e107a..000000000 --- a/docs/libraries/concurrency/future.hpp/future/f_operator213D.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: function -title: operator!= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/future.hpp -overloads: - bool operator!=(const future, void>::type> &, const future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const future, void>::type> & - - description: __OPTIONAL__ - name: y - type: const future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const future, void>::type> & x, const future, void>::type> & y) - bool operator!=(const future, void>::type> &, const future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const future, void>::type> & - - description: __OPTIONAL__ - name: y - type: const future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const future, void>::type> & x, const future, void>::type> & y) - bool operator!=(const stlab::future> &, const stlab::future> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::future> & - - description: __OPTIONAL__ - name: y - type: const stlab::future> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const stlab::future> & x, const stlab::future> & y) - bool operator!=(const stlab::future &, const stlab::future &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::future & - - description: __OPTIONAL__ - name: y - type: const stlab::future & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const stlab::future & x, const stlab::future & y) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/future.hpp/future/f_operator3D3D.md b/docs/libraries/concurrency/future.hpp/future/f_operator3D3D.md deleted file mode 100644 index a0ead32fe..000000000 --- a/docs/libraries/concurrency/future.hpp/future/f_operator3D3D.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: function -title: operator== -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/future.hpp -overloads: - bool operator==(const future, void>::type> &, const future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const future, void>::type> & - - description: __OPTIONAL__ - name: y - type: const future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const future, void>::type> & x, const future, void>::type> & y) - bool operator==(const future, void>::type> &, const future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const future, void>::type> & - - description: __OPTIONAL__ - name: y - type: const future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const future, void>::type> & x, const future, void>::type> & y) - bool operator==(const stlab::future> &, const stlab::future> &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::future> & - - description: __OPTIONAL__ - name: y - type: const stlab::future> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const stlab::future> & x, const stlab::future> & y) - bool operator==(const stlab::future &, const stlab::future &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::future & - - description: __OPTIONAL__ - name: y - type: const stlab::future & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const stlab::future & x, const stlab::future & y) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/future.hpp/future/f_swap.md b/docs/libraries/concurrency/future.hpp/future/f_swap.md deleted file mode 100644 index 208a87582..000000000 --- a/docs/libraries/concurrency/future.hpp/future/f_swap.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: function -title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/future.hpp -overloads: - void swap(future, void>::type> &, future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: future, void>::type> & - - description: __OPTIONAL__ - name: y - type: future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(future, void>::type> & x, future, void>::type> & y) - void swap(future, void>::type> &, future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: future, void>::type> & - - description: __OPTIONAL__ - name: y - type: future, void>::type> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(future, void>::type> & x, future, void>::type> & y) - void swap(stlab::future> &, stlab::future> &): - arguments: - - description: __OPTIONAL__ - name: x - type: stlab::future> & - - description: __OPTIONAL__ - name: y - type: stlab::future> & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(stlab::future> & x, stlab::future> & y) - void swap(stlab::future &, stlab::future &): - arguments: - - description: __OPTIONAL__ - name: x - type: stlab::future & - - description: __OPTIONAL__ - name: y - type: stlab::future & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(stlab::future & x, stlab::future & y) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/future.hpp/future/index.md b/docs/libraries/concurrency/future.hpp/future/index.md deleted file mode 100644 index 3bf16b0a0..000000000 --- a/docs/libraries/concurrency/future.hpp/future/index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -layout: directory -title: future_error ---- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/index.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/index.md index 7e0ffc2f8..f29769f05 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/index.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/index.md @@ -1,18 +1,22 @@ --- layout: class title: future> -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/future.hpp -declaration: "\nclass stlab::future;" -dtor: unspecified -typedefs: - result_type: - definition: T - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/future.hpp + declaration: "\nclass stlab::future;" + dtor: unspecified + typedefs: + result_type: + definition: T + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_detach.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_detach.md index 8f534329e..b0fb9baaf 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_detach.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_detach.md @@ -1,14 +1,15 @@ --- layout: method title: detach -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - void detach() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void detach() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + void detach() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void detach() const --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_error.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_error.md index 7ee024e10..60e696c65 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_error.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_error.md @@ -1,16 +1,17 @@ --- layout: method title: error -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - std::optional error() const &: - annotation: - - deprecated (Use exception() instead) - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: std::optional error() const & +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + std::optional error() const &: + annotation: + - deprecated("Use exception() instead") + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: std::optional error() const & --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_exception.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_exception.md index 5f4434663..4b57e6050 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_exception.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_exception.md @@ -1,14 +1,15 @@ --- layout: method title: exception -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - std::exception_ptr exception() const &: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: std::exception_ptr exception() const & +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + std::exception_ptr exception() const &: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: std::exception_ptr exception() const & --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_future3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_future3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md index 65485dcdb..ce0b3314e 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_future3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_future3CT2C20typename20enable_if3C21smart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md @@ -1,28 +1,27 @@ --- layout: method title: future, void>::type> -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -is_ctor: true -overloads: - future, void>::type>(): - annotation: - - default - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: future, void>::type>() - future, void>::type>(future, void>::type> &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: future, void>::type> && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: future, void>::type>(future, void>::type> &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/future.hpp + is_ctor: true + overloads: + future, void>::type>(): + annotation: + - defaulted + description: __OPTIONAL__ + signature_with_names: future, void>::type>() + future, void>::type>(future, void>::type> &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: future, void>::type> && + unnamed: true + description: __OPTIONAL__ + signature_with_names: future, void>::type>(future, void>::type> &&) --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_get_try.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_get_try.md index ebbfdff7b..02b23c2fd 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_get_try.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_get_try.md @@ -1,18 +1,19 @@ --- layout: method title: get_try -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - auto get_try() &&: - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: auto get_try() && - auto get_try() const &: - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: auto get_try() const & +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + auto get_try() &&: + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: auto get_try() && + auto get_try() const &: + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: auto get_try() const & --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_is_ready.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_is_ready.md index c87d0cedd..c27f89520 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_is_ready.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_is_ready.md @@ -1,14 +1,15 @@ --- layout: method title: is_ready -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - bool is_ready() const &: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool is_ready() const & +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + bool is_ready() const &: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool is_ready() const & --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator3D.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator3D.md index c6546acfb..0553038a8 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator3D.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator3D.md @@ -1,32 +1,33 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - future, void>::type> & operator=(const future, void>::type> &): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const future, void>::type> & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: future, void>::type> & operator=(const future, void>::type> &) - future, void>::type> & operator=(future, void>::type> &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: future, void>::type> && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: future, void>::type> & operator=(future, void>::type> &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + future, void>::type> & operator=(const future, void>::type> &): + annotation: + - deleted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const future, void>::type> & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: future, void>::type> & operator=(const future, void>::type> &) + future, void>::type> & operator=(future, void>::type> &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: future, void>::type> && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: future, void>::type> & operator=(future, void>::type> &&) --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator5E.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator5E.md index b915046a7..3edf586b1 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator5E.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator5E.md @@ -1,26 +1,27 @@ --- layout: method title: operator^ -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto operator^(F &&) &&": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator^(F && f) &&" - "template \nauto operator^(executor_task_pair) &&": - arguments: - - description: __OPTIONAL__ - name: etp - type: executor_task_pair - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator^(executor_task_pair etp) &&" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto operator^(F &&) &&": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator^(F && f) &&" + "template \nauto operator^(executor_task_pair) &&": + arguments: + - description: __OPTIONAL__ + name: etp + type: executor_task_pair + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator^(executor_task_pair etp) &&" --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator7C.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator7C.md index 8d38b09b9..0800656f7 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator7C.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_operator7C.md @@ -1,26 +1,27 @@ --- layout: method title: operator| -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto operator|(F &&) &&": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(F && f) &&" - "template \nauto operator|(executor_task_pair) &&": - arguments: - - description: __OPTIONAL__ - name: etp - type: executor_task_pair - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(executor_task_pair etp) &&" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto operator|(F &&) &&": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(F && f) &&" + "template \nauto operator|(executor_task_pair) &&": + arguments: + - description: __OPTIONAL__ + name: etp + type: executor_task_pair + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(executor_task_pair etp) &&" --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_recover.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_recover.md index b36a7d5cf..83a7c9e01 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_recover.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_recover.md @@ -1,29 +1,30 @@ --- layout: method title: recover -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto recover(E &&, F &&) &&": - arguments: - - description: __OPTIONAL__ - name: executor - type: E && - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto recover(E && executor, F && f) &&" - "template \nauto recover(F &&) &&": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto recover(F && f) &&" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto recover(E &&, F &&) &&": + arguments: + - description: __OPTIONAL__ + name: executor + type: E && + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto recover(E && executor, F && f) &&" + "template \nauto recover(F &&) &&": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto recover(F && f) &&" --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_reset.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_reset.md index ed36350e9..4988ea2dd 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_reset.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_reset.md @@ -1,14 +1,15 @@ --- layout: method title: reset -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - void reset(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void reset() +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + void reset(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void reset() --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_swap.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_swap.md index 4ef69f7de..322a22748 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_swap.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_swap.md @@ -1,18 +1,19 @@ --- layout: method title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - void swap(future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: future, void>::type> & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void swap(future, void>::type> & x) +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + void swap(future, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: future, void>::type> & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void swap(future, void>::type> & x) --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_then.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_then.md index c413b9544..e77703674 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_then.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_then.md @@ -1,29 +1,30 @@ --- layout: method title: then -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto then(E &&, F &&) &&": - arguments: - - description: __OPTIONAL__ - name: executor - type: E && - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto then(E && executor, F && f) &&" - "template \nauto then(F &&) &&": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto then(F && f) &&" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto then(E &&, F &&) &&": + arguments: + - description: __OPTIONAL__ + name: executor + type: E && + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto then(E && executor, F && f) &&" + "template \nauto then(F &&) &&": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto then(F && f) &&" --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_valid.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_valid.md index 2292a6765..c8695d1cd 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_valid.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.6354105c/m_valid.md @@ -1,14 +1,15 @@ --- layout: method title: valid -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - bool valid() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool valid() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + bool valid() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool valid() const --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/f_operator213D.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/f_operator213D.md new file mode 100644 index 000000000..7808b8b9c --- /dev/null +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/f_operator213D.md @@ -0,0 +1,47 @@ +--- +layout: function +title: operator!= +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/future.hpp + overloads: + bool operator!=(const future, void>::type> &, const future, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: const future, void>::type> & + - description: __OPTIONAL__ + name: y + type: const future, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const future, void>::type> & x, const future, void>::type> & y) + bool operator!=(const future, void>::type> &, const future, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: const future, void>::type> & + - description: __OPTIONAL__ + name: y + type: const future, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const future, void>::type> & x, const future, void>::type> & y) + bool operator!=(const stlab::future &, const stlab::future &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::future & + - description: __OPTIONAL__ + name: y + type: const stlab::future & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const stlab::future & x, const stlab::future & y) + namespace: + - stlab + - v1 +--- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/f_operator3D3D.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/f_operator3D3D.md new file mode 100644 index 000000000..efc454e85 --- /dev/null +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/f_operator3D3D.md @@ -0,0 +1,47 @@ +--- +layout: function +title: operator== +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/future.hpp + overloads: + bool operator==(const future, void>::type> &, const future, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: const future, void>::type> & + - description: __OPTIONAL__ + name: y + type: const future, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const future, void>::type> & x, const future, void>::type> & y) + bool operator==(const future, void>::type> &, const future, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: const future, void>::type> & + - description: __OPTIONAL__ + name: y + type: const future, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const future, void>::type> & x, const future, void>::type> & y) + bool operator==(const stlab::future &, const stlab::future &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::future & + - description: __OPTIONAL__ + name: y + type: const stlab::future & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const stlab::future & x, const stlab::future & y) + namespace: + - stlab + - v1 +--- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/f_swap.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/f_swap.md new file mode 100644 index 000000000..90f37abac --- /dev/null +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/f_swap.md @@ -0,0 +1,47 @@ +--- +layout: function +title: swap +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/future.hpp + overloads: + void swap(future, void>::type> &, future, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: future, void>::type> & + - description: __OPTIONAL__ + name: y + type: future, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: void swap(future, void>::type> & x, future, void>::type> & y) + void swap(future, void>::type> &, future, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: future, void>::type> & + - description: __OPTIONAL__ + name: y + type: future, void>::type> & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: void swap(future, void>::type> & x, future, void>::type> & y) + void swap(stlab::future &, stlab::future &): + arguments: + - description: __OPTIONAL__ + name: x + type: stlab::future & + - description: __OPTIONAL__ + name: y + type: stlab::future & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: void swap(stlab::future & x, stlab::future & y) + namespace: + - stlab + - v1 +--- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/index.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/index.md index be0130ef9..7a9966d0d 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/index.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/index.md @@ -1,20 +1,24 @@ --- layout: class title: future> -owner: sean-parent -brief: An alternative `future` implementation with support for continuations, splits, and joins -tags: - - class -defined_in_file: concurrency/future.hpp -declaration: "\nclass stlab::future;" -dtor: unspecified -typedefs: - result_type: - definition: T - description: result type -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: An alternative `future` implementation with support for continuations, splits, and joins + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/future.hpp + declaration: "\nclass stlab::future;" + dtor: unspecified + typedefs: + result_type: + definition: T + description: result type + namespace: + - stlab + - v1 --- `stlab::future` differs from `std::future` in several ways: diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_detach.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_detach.md index d6617164c..a613ee7b4 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_detach.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_detach.md @@ -1,16 +1,17 @@ --- layout: method title: detach -owner: sean-parent -brief: Detaches the associated tasks from this instance. -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - void detach() const: - description: Lets the current task run and detaches it from this instance. - return: __OPTIONAL__ - signature_with_names: void detach() const +hyde: + owner: sean-parent + brief: Detaches the associated tasks from this instance. + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + void detach() const: + description: Lets the current task run and detaches it from this instance. + return: __OPTIONAL__ + signature_with_names: void detach() const --- Detaches the associated tasks from this instance. So it will be executed even when this instance get destructed. diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_error.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_error.md index ed3d12513..0216a5023 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_error.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_error.md @@ -1,18 +1,18 @@ --- layout: method title: error -owner: sean-parent -brief: In case an error occurred, it returns the stored exception pointer. -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - std::optional error() const &: - annotation: - - deprecated (Use exception() instead) - description: Iff an error occurred, returns the stored exception pointer. - return: __OPTIONAL__ - signature_with_names: std::optional error() const & +hyde: + owner: sean-parent + brief: In case an error occurred, it returns the stored exception pointer. + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + std::optional error() const &: + annotation: + - deprecated("Use exception() instead") + description: Iff an error occurred, returns the stored exception pointer. + return: __OPTIONAL__ + signature_with_names: std::optional error() const & --- Returns a potentially stored exception pointer. This function will be removed in future versions of the library. Use `exception()` instead. - diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_exception.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_exception.md index 5e4d0857f..614ffa1bc 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_exception.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_exception.md @@ -1,14 +1,15 @@ --- layout: method title: exception -owner: sean-parent -brief: Returns a potentially stored exception pointer. -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - std::exception_ptr exception() const &: - description: Iff an error occurred, it returns the stored exception pointer. - return: The exception pointer if an exception has occurred. - signature_with_names: std::exception_ptr exception() const & +hyde: + owner: sean-parent + brief: Returns a potentially stored exception pointer. + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + std::exception_ptr exception() const &: + description: Iff an error occurred, it returns the stored exception pointer. + return: The exception pointer if an exception has occurred. + signature_with_names: std::exception_ptr exception() const & --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_future3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_future3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md index 88c003b58..44457ee83 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_future3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_future3CT2C20typename20enable_if3Csmart_is_copy_constructible_v3CT3E2C20void3E3A3Atype3E.md @@ -1,17 +1,17 @@ --- layout: method title: future, void>::type> -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -is_ctor: true -overloads: - future, void>::type>(): - annotation: - - default - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: future, void>::type>() +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/future.hpp + is_ctor: true + overloads: + future, void>::type>(): + annotation: + - defaulted + description: __OPTIONAL__ + signature_with_names: future, void>::type>() --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_get_try.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_get_try.md index 3aa28496f..f3627eadb 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_get_try.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_get_try.md @@ -1,19 +1,20 @@ --- layout: method title: get_try -owner: sean-parent -brief: Returns the result of the future. -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - auto get_try() &&: - description: If `T` is not `void`, returns an initialized `optional` if the future has succeeded, otherwise an empty `optional`. Rethrows any caught exceptions if an error occurred. - return: __OPTIONAL__ - signature_with_names: auto get_try() && - auto get_try() const &: - description: If `T` is void, returns `true` if the future succeeded, otherwise `false`. Rethrows any caught exceptions if an error occurred. - return: __OPTIONAL__ - signature_with_names: auto get_try() const & +hyde: + owner: sean-parent + brief: Returns the result of the future. + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + auto get_try() &&: + description: If `T` is not `void`, returns an initialized `optional` if the future has succeeded, otherwise an empty `optional`. Rethrows any caught exceptions if an error occurred. + return: __OPTIONAL__ + signature_with_names: auto get_try() && + auto get_try() const &: + description: If `T` is void, returns `true` if the future succeeded, otherwise `false`. Rethrows any caught exceptions if an error occurred. + return: __OPTIONAL__ + signature_with_names: auto get_try() const & --- If `T` is of type `void`, it returns `true` if the future is fulfilled; if `T` is a non-`void` type then it returns an `optional` with the result of the future if the future is already fulfilled, otherwise an empty `optional` diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_is_ready.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_is_ready.md index 879d653c7..6b2ca90b1 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_is_ready.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_is_ready.md @@ -1,14 +1,15 @@ --- layout: method title: is_ready -owner: sean-parent -brief: Returns `true` if the future is ready. -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - bool is_ready() const &: - description: Returns `true` if the future is ready, otherwise `false`. - return: __OPTIONAL__ - signature_with_names: bool is_ready() const & +hyde: + owner: sean-parent + brief: Returns `true` if the future is ready. + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + bool is_ready() const &: + description: Returns `true` if the future is ready, otherwise `false`. + return: __OPTIONAL__ + signature_with_names: bool is_ready() const & --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_operator5E.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_operator5E.md index 8c2c2d7b4..157967f05 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_operator5E.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_operator5E.md @@ -1,45 +1,45 @@ --- layout: method title: operator^ -owner: sean-parent -brief: Creates a recoverable future on the current object. -example: recover_example.cpp -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto operator^(F &&) &&": - arguments: - - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. - name: f - type: F && - description: Constructs a recoverable continuation on an r-value future. It gets a `future` passed. - return: __OPTIONAL__ - signature_with_names: "template \nauto operator^(F && f) &&" - "template \nauto operator^(F &&) const &": - arguments: - - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. - name: f - type: F && - description: Constructs a recoverable continuation that gets a `future` passed. - return: __OPTIONAL__ - signature_with_names: "template \nauto operator^(F && f) const &" - "template \nauto operator^(executor_task_pair) &&": - arguments: - - description: __OPTIONAL__ - name: etp - type: executor_task_pair - description: Constructs a recoverable continuation that gets a `future` passed. It uses the provided executor. - return: __OPTIONAL__ - signature_with_names: "template \nauto operator^(executor_task_pair etp) &&" - "template \nauto operator^(executor_task_pair) const &": - arguments: - - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. - name: etp - type: executor_task_pair - description: Constructs a recoverable continuation that gets a `future` passed. It uses the provided executor. - return: __OPTIONAL__ - signature_with_names: "template \nauto operator^(executor_task_pair etp) const &" +hyde: + owner: sean-parent + brief: Creates a recoverable future on the current object. + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto operator^(F &&) &&": + arguments: + - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. + name: f + type: F && + description: Constructs a recoverable continuation on an r-value future. It gets a `future` passed. + return: __OPTIONAL__ + signature_with_names: "template \nauto operator^(F && f) &&" + "template \nauto operator^(F &&) const &": + arguments: + - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. + name: f + type: F && + description: Constructs a recoverable continuation that gets a `future` passed. + return: __OPTIONAL__ + signature_with_names: "template \nauto operator^(F && f) const &" + "template \nauto operator^(executor_task_pair) &&": + arguments: + - description: __OPTIONAL__ + name: etp + type: executor_task_pair + description: Constructs a recoverable continuation that gets a `future` passed. It uses the provided executor. + return: __OPTIONAL__ + signature_with_names: "template \nauto operator^(executor_task_pair etp) &&" + "template \nauto operator^(executor_task_pair) const &": + arguments: + - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. + name: etp + type: executor_task_pair + description: Constructs a recoverable continuation that gets a `future` passed. It uses the provided executor. + return: __OPTIONAL__ + signature_with_names: "template \nauto operator^(executor_task_pair etp) const &" --- Since the futures are value based, the recover method should be used to do the error handling. Its functionality is identical to `.recover()`. diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_operator7C.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_operator7C.md index 04972b28b..811653526 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_operator7C.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_operator7C.md @@ -1,45 +1,45 @@ --- layout: method title: operator| -owner: sean-parent -brief: Creates a continuation on the current future. -example: [then_continuation_example.cpp, then_split_example.cpp] -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto operator|(F &&) &&": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: Constructs a continuation with the passed callable object using the provided executor. - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(F && f) &&" - "template \nauto operator|(F &&) const &": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: Constructs a continuation on a r-value with the passed callable object using the same. - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(F && f) const &" - "template \nauto operator|(executor_task_pair) &&": - arguments: - - description: __OPTIONAL__ - name: etp - type: executor_task_pair - description: Constructs a continuation on a r-value with the passed callable object using the provided executor. - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(executor_task_pair etp) &&" - "template \nauto operator|(executor_task_pair) const &": - arguments: - - description: __OPTIONAL__ - name: etp - type: executor_task_pair - description: Constructs a continuation with the passed callable object using the provided executor. - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(executor_task_pair etp) const &" +hyde: + owner: sean-parent + brief: Creates a continuation on the current future. + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto operator|(F &&) &&": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: Constructs a continuation with the passed callable object using the provided executor. + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(F && f) &&" + "template \nauto operator|(F &&) const &": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: Constructs a continuation on a r-value with the passed callable object using the same. + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(F && f) const &" + "template \nauto operator|(executor_task_pair) &&": + arguments: + - description: __OPTIONAL__ + name: etp + type: executor_task_pair + description: Constructs a continuation on a r-value with the passed callable object using the provided executor. + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(executor_task_pair etp) &&" + "template \nauto operator|(executor_task_pair) const &": + arguments: + - description: __OPTIONAL__ + name: etp + type: executor_task_pair + description: Constructs a continuation with the passed callable object using the provided executor. + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(executor_task_pair etp) const &" --- Creates a new continuation on the current object. diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_recover.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_recover.md index df89c74d5..7981d2110 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_recover.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_recover.md @@ -1,49 +1,50 @@ --- layout: method title: recover -owner: sean-parent -brief: Creates a recoverable future on the current object. -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto recover(E &&, F &&) &&": - arguments: - - description: Executor which is used to schedule the resulting task - name: executor - type: E && - - description: Callable object that implements the `recover()` function. Its parameter must be of type of this `future` instance. - name: f - type: F && - description: Constructs a recoverable continuation on an r-value future. It gets a `future` passed. It uses the the provided executor. - return: __OPTIONAL__ - signature_with_names: "template \nauto recover(E && executor, F && f) &&" - "template \nauto recover(E &&, F &&) const &": - arguments: - - description: Executor which is used to schedule the resulting task - name: executor - type: E && - - description: Callable object that implements the `recover()` function. Its parameter must be of type of this `future` instance. - name: f - type: F && - description: Constructs a recoverable continuation that gets a `future` passed. It uses the provided executor. - return: __OPTIONAL__ - signature_with_names: "template \nauto recover(E && executor, F && f) const &" - "template \nauto recover(F &&) &&": - arguments: - - description: Callable object that implements the `recover()` function. Its parameter must be of type of this `future` instance. - name: f - type: F && - description: Constructs a recoverable continuation on an r-value future. It gets a `future` passed. It uses the same executor as this. - return: __OPTIONAL__ - signature_with_names: "template \nauto recover(F && f) &&" - "template \nauto recover(F &&) const &": - arguments: - - description: Callable object that implements the `recover()` function. Its parameter must be of type of this `future` instance. - name: f - type: F && - description: Constructs a recoverable continuation that gets a `future` passed. It uses the same executor as this. - return: __OPTIONAL__ - signature_with_names: "template \nauto recover(F && f) const &" +hyde: + owner: sean-parent + brief: Creates a recoverable future on the current object. + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto recover(E &&, F &&) &&": + arguments: + - description: Executor which is used to schedule the resulting task + name: executor + type: E && + - description: Callable object that implements the `recover()` function. Its parameter must be of type of this `future` instance. + name: f + type: F && + description: Constructs a recoverable continuation on an r-value future. It gets a `future` passed. It uses the the provided executor. + return: __OPTIONAL__ + signature_with_names: "template \nauto recover(E && executor, F && f) &&" + "template \nauto recover(E &&, F &&) const &": + arguments: + - description: Executor which is used to schedule the resulting task + name: executor + type: E && + - description: Callable object that implements the `recover()` function. Its parameter must be of type of this `future` instance. + name: f + type: F && + description: Constructs a recoverable continuation that gets a `future` passed. It uses the provided executor. + return: __OPTIONAL__ + signature_with_names: "template \nauto recover(E && executor, F && f) const &" + "template \nauto recover(F &&) &&": + arguments: + - description: Callable object that implements the `recover()` function. Its parameter must be of type of this `future` instance. + name: f + type: F && + description: Constructs a recoverable continuation on an r-value future. It gets a `future` passed. It uses the same executor as this. + return: __OPTIONAL__ + signature_with_names: "template \nauto recover(F && f) &&" + "template \nauto recover(F &&) const &": + arguments: + - description: Callable object that implements the `recover()` function. Its parameter must be of type of this `future` instance. + name: f + type: F && + description: Constructs a recoverable continuation that gets a `future` passed. It uses the same executor as this. + return: __OPTIONAL__ + signature_with_names: "template \nauto recover(F && f) const &" --- Since the futures are value based, the recover method should be used to do the error handling. diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_reset.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_reset.md index a468b1f68..2c845ddb8 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_reset.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_reset.md @@ -1,14 +1,15 @@ --- layout: method title: reset -owner: sean-parent -brief: Cancels this future -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - void reset(): - description: Cancels this future. If the task is already running, its result will be abandoned and no subsequent continuation will be started. - return: __OPTIONAL__ - signature_with_names: void reset() +hyde: + owner: sean-parent + brief: Cancels this future + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + void reset(): + description: Cancels this future. If the task is already running, its result will be abandoned and no subsequent continuation will be started. + return: __OPTIONAL__ + signature_with_names: void reset() --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_swap.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_swap.md index 7ca538de4..cd243b266 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_swap.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_swap.md @@ -1,18 +1,19 @@ --- layout: method title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - void swap(future, void>::type> &): - arguments: - - description: __OPTIONAL__ - name: x - type: future, void>::type> & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void swap(future, void>::type> & x) +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + void swap(future, void>::type> &): + arguments: + - description: __OPTIONAL__ + name: x + type: future, void>::type> & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void swap(future, void>::type> & x) --- diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_then.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_then.md index 4b2a73e59..77f445249 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_then.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_then.md @@ -1,51 +1,51 @@ --- layout: method title: then -owner: sean-parent -brief: Creates a continuation on the current future. -example: [then_continuation_example.cpp, then_split_example.cpp] -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto then(E &&, F &&) &&": - arguments: - - description: Executor which is used to schedule the resulting task. - name: executor - type: E && - - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. - name: f - type: F && - description: Constructs a continuation on an r-value with the passed callable object using the provided executor. - return: a future of the type of the result type of the passed function object. - signature_with_names: "template \nauto then(E && executor, F && f) &&" - "template \nauto then(E &&, F &&) const &": - arguments: - - description: Executor which is used to schedule the resulting task. - name: executor - type: E && - - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. - name: f - type: F && - description: Constructs a continuation with the passed callable object using the provided executor. - return: a future of the type of the result type of the passed function object. - signature_with_names: "template \nauto then(E && executor, F && f) const &" - "template \nauto then(F &&) &&": - arguments: - - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. - name: f - type: F && - description: Constructs a continuation on a r-value with the passed callable object using the same executor as this. - return: a future of the type of the result type of the passed function object. - signature_with_names: "template \nauto then(F && f) &&" - "template \nauto then(F &&) const &": - arguments: - - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. - name: f - type: F && - description: Constructs a continuation with the passed callable object using the same executor as this. - return: a future of the type of the result type of the passed function object. - signature_with_names: "template \nauto then(F && f) const &" +hyde: + owner: sean-parent + brief: Creates a continuation on the current future. + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto then(E &&, F &&) &&": + arguments: + - description: Executor which is used to schedule the resulting task. + name: executor + type: E && + - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. + name: f + type: F && + description: Constructs a continuation on an r-value with the passed callable object using the provided executor. + return: a future of the type of the result type of the passed function object. + signature_with_names: "template \nauto then(E && executor, F && f) &&" + "template \nauto then(E &&, F &&) const &": + arguments: + - description: Executor which is used to schedule the resulting task. + name: executor + type: E && + - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. + name: f + type: F && + description: Constructs a continuation with the passed callable object using the provided executor. + return: a future of the type of the result type of the passed function object. + signature_with_names: "template \nauto then(E && executor, F && f) const &" + "template \nauto then(F &&) &&": + arguments: + - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. + name: f + type: F && + description: Constructs a continuation on a r-value with the passed callable object using the same executor as this. + return: a future of the type of the result type of the passed function object. + signature_with_names: "template \nauto then(F && f) &&" + "template \nauto then(F &&) const &": + arguments: + - description: Callable object that implements the continuation. `T` of this must be convertible to the parameter of `f`. + name: f + type: F && + description: Constructs a continuation with the passed callable object using the same executor as this. + return: a future of the type of the result type of the passed function object. + signature_with_names: "template \nauto then(F && f) const &" --- Creates a new continuation on the current object. diff --git a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_valid.md b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_valid.md index 43337a539..9e7699629 100644 --- a/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_valid.md +++ b/docs/libraries/concurrency/future.hpp/future3CT2C20enable_if_.e055d50a/m_valid.md @@ -1,14 +1,15 @@ --- layout: method title: valid -owner: sean-parent -brief: Returns `true` if the future is valid. -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - bool valid() const: - description: Returns `true` if the future is connected with a valid task. A default constructed object or a canceled one returns `false`. - return: "`true` if the future has an associated function object, otherwise `false`; after a reset, it returns `false`" - signature_with_names: bool valid() const +hyde: + owner: sean-parent + brief: Returns `true` if the future is valid. + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + bool valid() const: + description: Returns `true` if the future is connected with a valid task. A default constructed object or a canceled one returns `false`. + return: "`true` if the future has an associated function object, otherwise `false`; after a reset, it returns `false`" + signature_with_names: bool valid() const --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/index.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/index.md index 9e121b350..74696f7b9 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/index.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/index.md @@ -1,18 +1,22 @@ --- layout: class title: future -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/future.hpp -declaration: "\nclass stlab::future;" -dtor: unspecified -typedefs: - result_type: - definition: void - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/future.hpp + declaration: "\nclass stlab::future;" + dtor: unspecified + typedefs: + result_type: + definition: void + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_detach.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_detach.md index 8f534329e..b0fb9baaf 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_detach.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_detach.md @@ -1,14 +1,15 @@ --- layout: method title: detach -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - void detach() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void detach() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + void detach() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void detach() const --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_error.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_error.md index 7ee024e10..60e696c65 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_error.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_error.md @@ -1,16 +1,17 @@ --- layout: method title: error -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - std::optional error() const &: - annotation: - - deprecated (Use exception() instead) - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: std::optional error() const & +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + std::optional error() const &: + annotation: + - deprecated("Use exception() instead") + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: std::optional error() const & --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_exception.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_exception.md index 5f4434663..4b57e6050 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_exception.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_exception.md @@ -1,14 +1,15 @@ --- layout: method title: exception -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - std::exception_ptr exception() const &: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: std::exception_ptr exception() const & +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + std::exception_ptr exception() const &: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: std::exception_ptr exception() const & --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_future.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_future.md index f337e55f6..3b2a12c59 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_future.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_future.md @@ -1,35 +1,37 @@ --- layout: method title: future -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -is_ctor: true -overloads: - future(): - annotation: - - default - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: future() - future(const stlab::future &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::future & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: future(const stlab::future &) - future(stlab::future &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::future && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: future(stlab::future &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/future.hpp + is_ctor: true + overloads: + future(): + annotation: + - defaulted + description: __OPTIONAL__ + signature_with_names: future() + future(const stlab::future &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::future & + unnamed: true + description: __OPTIONAL__ + signature_with_names: future(const stlab::future &) + future(stlab::future &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::future && + unnamed: true + description: __OPTIONAL__ + signature_with_names: future(stlab::future &&) --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_get_try.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_get_try.md index c151491d8..e0e2560ea 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_get_try.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_get_try.md @@ -1,14 +1,15 @@ --- layout: method title: get_try -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - bool get_try() const &: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool get_try() const & +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + bool get_try() const &: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool get_try() const & --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_is_ready.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_is_ready.md index c87d0cedd..c27f89520 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_is_ready.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_is_ready.md @@ -1,14 +1,15 @@ --- layout: method title: is_ready -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - bool is_ready() const &: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool is_ready() const & +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + bool is_ready() const &: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool is_ready() const & --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator3D.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator3D.md index 37096b06a..7abe4925a 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator3D.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator3D.md @@ -1,28 +1,33 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - stlab::future & operator=(const stlab::future &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::future & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::future & operator=(const stlab::future &) - stlab::future & operator=(stlab::future &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::future && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::future & operator=(stlab::future &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + stlab::future & operator=(const stlab::future &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::future & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::future & operator=(const stlab::future &) + stlab::future & operator=(stlab::future &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::future && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::future & operator=(stlab::future &&) --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator5E.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator5E.md index a0ff56d27..803a7a55a 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator5E.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator5E.md @@ -1,42 +1,43 @@ --- layout: method title: operator^ -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto operator^(F &&) &&": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator^(F && f) &&" - "template \nauto operator^(F &&) const &": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator^(F && f) const &" - "template \nauto operator^(executor_task_pair) &&": - arguments: - - description: __OPTIONAL__ - name: etp - type: executor_task_pair - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator^(executor_task_pair etp) &&" - "template \nauto operator^(executor_task_pair) const &": - arguments: - - description: __OPTIONAL__ - name: etp - type: executor_task_pair - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator^(executor_task_pair etp) const &" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto operator^(F &&) &&": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator^(F && f) &&" + "template \nauto operator^(F &&) const &": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator^(F && f) const &" + "template \nauto operator^(executor_task_pair) &&": + arguments: + - description: __OPTIONAL__ + name: etp + type: executor_task_pair + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator^(executor_task_pair etp) &&" + "template \nauto operator^(executor_task_pair) const &": + arguments: + - description: __OPTIONAL__ + name: etp + type: executor_task_pair + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator^(executor_task_pair etp) const &" --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator7C.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator7C.md index 9dfc9fd5e..996122d4a 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator7C.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_operator7C.md @@ -1,42 +1,43 @@ --- layout: method title: operator| -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto operator|(F &&) &&": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(F && f) &&" - "template \nauto operator|(F &&) const &": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(F && f) const &" - "template \nauto operator|(executor_task_pair) &&": - arguments: - - description: __OPTIONAL__ - name: etp - type: executor_task_pair - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(executor_task_pair etp) &&" - "template \nauto operator|(executor_task_pair) const &": - arguments: - - description: __OPTIONAL__ - name: etp - type: executor_task_pair - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator|(executor_task_pair etp) const &" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto operator|(F &&) &&": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(F && f) &&" + "template \nauto operator|(F &&) const &": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(F && f) const &" + "template \nauto operator|(executor_task_pair) &&": + arguments: + - description: __OPTIONAL__ + name: etp + type: executor_task_pair + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(executor_task_pair etp) &&" + "template \nauto operator|(executor_task_pair) const &": + arguments: + - description: __OPTIONAL__ + name: etp + type: executor_task_pair + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator|(executor_task_pair etp) const &" --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_recover.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_recover.md index 6f5e2ef5c..766461e37 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_recover.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_recover.md @@ -1,48 +1,49 @@ --- layout: method title: recover -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto recover(E &&, F &&) &&": - arguments: - - description: __OPTIONAL__ - name: executor - type: E && - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto recover(E && executor, F && f) &&" - "template \nauto recover(E &&, F &&) const &": - arguments: - - description: __OPTIONAL__ - name: executor - type: E && - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto recover(E && executor, F && f) const &" - "template \nauto recover(F &&) &&": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto recover(F && f) &&" - "template \nauto recover(F &&) const &": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto recover(F && f) const &" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto recover(E &&, F &&) &&": + arguments: + - description: __OPTIONAL__ + name: executor + type: E && + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto recover(E && executor, F && f) &&" + "template \nauto recover(E &&, F &&) const &": + arguments: + - description: __OPTIONAL__ + name: executor + type: E && + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto recover(E && executor, F && f) const &" + "template \nauto recover(F &&) &&": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto recover(F && f) &&" + "template \nauto recover(F &&) const &": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto recover(F && f) const &" --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_reset.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_reset.md index ed36350e9..4988ea2dd 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_reset.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_reset.md @@ -1,14 +1,15 @@ --- layout: method title: reset -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - void reset(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void reset() +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + void reset(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void reset() --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_swap.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_swap.md index e24a9066c..afc67acba 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_swap.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_swap.md @@ -1,18 +1,19 @@ --- layout: method title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - void swap(stlab::future &): - arguments: - - description: __OPTIONAL__ - name: x - type: stlab::future & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void swap(stlab::future & x) +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + void swap(stlab::future &): + arguments: + - description: __OPTIONAL__ + name: x + type: stlab::future & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void swap(stlab::future & x) --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_then.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_then.md index 1ad4c44ec..a00cc4e24 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_then.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_then.md @@ -1,48 +1,49 @@ --- layout: method title: then -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto then(E &&, F &&) &&": - arguments: - - description: __OPTIONAL__ - name: executor - type: E && - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto then(E && executor, F && f) &&" - "template \nauto then(E &&, F &&) const &": - arguments: - - description: __OPTIONAL__ - name: executor - type: E && - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto then(E && executor, F && f) const &" - "template \nauto then(F &&) &&": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto then(F && f) &&" - "template \nauto then(F &&) const &": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto then(F && f) const &" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto then(E &&, F &&) &&": + arguments: + - description: __OPTIONAL__ + name: executor + type: E && + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto then(E && executor, F && f) &&" + "template \nauto then(E &&, F &&) const &": + arguments: + - description: __OPTIONAL__ + name: executor + type: E && + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto then(E && executor, F && f) const &" + "template \nauto then(F &&) &&": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto then(F && f) &&" + "template \nauto then(F &&) const &": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto then(F && f) const &" --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_valid.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_valid.md index 2292a6765..c8695d1cd 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_valid.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_valid.md @@ -1,14 +1,15 @@ --- layout: method title: valid -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - bool valid() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool valid() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + bool valid() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool valid() const --- diff --git a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_~future.md b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_~future.md index 16916d35e..dd9c6c8b7 100644 --- a/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_~future.md +++ b/docs/libraries/concurrency/future.hpp/future3Cvoid2C20void3E/m_~future.md @@ -1,15 +1,17 @@ --- layout: method title: ~future -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -is_dtor: true -overloads: - ~future(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~future() +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/future.hpp + is_dtor: true + overloads: + ~future(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: ~future() --- diff --git a/docs/libraries/concurrency/future.hpp/future_error/index.md b/docs/libraries/concurrency/future.hpp/future_error/index.md index 0b93736dd..55536682b 100644 --- a/docs/libraries/concurrency/future.hpp/future_error/index.md +++ b/docs/libraries/concurrency/future.hpp/future_error/index.md @@ -1,14 +1,18 @@ --- layout: class title: future_error -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/future.hpp -declaration: "\nclass stlab::future_error;" -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - future exception + defined_in_file: concurrency/future.hpp + declaration: "\nclass stlab::future_error;" + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/future.hpp/future_error/m_code.md b/docs/libraries/concurrency/future.hpp/future_error/m_code.md index 15939e289..3f593e71c 100644 --- a/docs/libraries/concurrency/future.hpp/future_error/m_code.md +++ b/docs/libraries/concurrency/future.hpp/future_error/m_code.md @@ -1,14 +1,15 @@ --- layout: method title: code -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - const stlab::future_error_codes & code() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: const stlab::future_error_codes & code() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + const stlab::future_error_codes & code() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: const stlab::future_error_codes & code() const --- diff --git a/docs/libraries/concurrency/future.hpp/future_error/m_future_error.md b/docs/libraries/concurrency/future.hpp/future_error/m_future_error.md index 81015c8fe..7b5ff1d24 100644 --- a/docs/libraries/concurrency/future.hpp/future_error/m_future_error.md +++ b/docs/libraries/concurrency/future.hpp/future_error/m_future_error.md @@ -1,37 +1,39 @@ --- layout: method title: future_error -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -is_ctor: true -overloads: - explicit future_error(stlab::future_error_codes): - arguments: - - description: __OPTIONAL__ - name: code - type: stlab::future_error_codes - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: explicit future_error(stlab::future_error_codes code) - future_error(const stlab::future_error &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::future_error & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: future_error(const stlab::future_error &) - future_error(stlab::future_error &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::future_error && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: future_error(stlab::future_error &&) +hyde: + owner: __MISSING__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/future.hpp + is_ctor: true + overloads: + explicit future_error(stlab::future_error_codes): + arguments: + - description: __OPTIONAL__ + name: code + type: stlab::future_error_codes + description: __MISSING__ + signature_with_names: explicit future_error(stlab::future_error_codes code) + future_error(const stlab::future_error &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::future_error & + unnamed: true + description: __OPTIONAL__ + signature_with_names: future_error(const stlab::future_error &) + future_error(stlab::future_error &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::future_error && + unnamed: true + description: __OPTIONAL__ + signature_with_names: future_error(stlab::future_error &&) --- diff --git a/docs/libraries/concurrency/future.hpp/future_error/m_operator3D.md b/docs/libraries/concurrency/future.hpp/future_error/m_operator3D.md index c8533f3b4..0aa3485b6 100644 --- a/docs/libraries/concurrency/future.hpp/future_error/m_operator3D.md +++ b/docs/libraries/concurrency/future.hpp/future_error/m_operator3D.md @@ -1,28 +1,33 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - stlab::future_error & operator=(const stlab::future_error &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::future_error & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::future_error & operator=(const stlab::future_error &) - stlab::future_error & operator=(stlab::future_error &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::future_error && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::future_error & operator=(stlab::future_error &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + stlab::future_error & operator=(const stlab::future_error &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::future_error & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::future_error & operator=(const stlab::future_error &) + stlab::future_error & operator=(stlab::future_error &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::future_error && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::future_error & operator=(stlab::future_error &&) --- diff --git a/docs/libraries/concurrency/future.hpp/future_error/m_what.md b/docs/libraries/concurrency/future.hpp/future_error/m_what.md index e94673933..80cfe377c 100644 --- a/docs/libraries/concurrency/future.hpp/future_error/m_what.md +++ b/docs/libraries/concurrency/future.hpp/future_error/m_what.md @@ -1,14 +1,15 @@ --- layout: method title: what -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - const char * what() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: const char * what() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + const char * what() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: const char * what() const --- diff --git a/docs/libraries/concurrency/future.hpp/future_error/m_~future_error.md b/docs/libraries/concurrency/future.hpp/future_error/m_~future_error.md index aaa1f2ac5..dfe40f95e 100644 --- a/docs/libraries/concurrency/future.hpp/future_error/m_~future_error.md +++ b/docs/libraries/concurrency/future.hpp/future_error/m_~future_error.md @@ -1,15 +1,17 @@ --- layout: method title: ~future_error -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -is_dtor: true -overloads: - ~future_error(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~future_error() +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/future.hpp + is_dtor: true + overloads: + ~future_error(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: ~future_error() --- diff --git a/docs/libraries/concurrency/future.hpp/index.md b/docs/libraries/concurrency/future.hpp/index.md index c5f09c1c9..d0be7ec86 100644 --- a/docs/libraries/concurrency/future.hpp/index.md +++ b/docs/libraries/concurrency/future.hpp/index.md @@ -1,31 +1,32 @@ --- layout: library title: concurrency/future.hpp -owner: sean-parent -brief: Futures class and related functions -tags: - - sourcefile -library-type: sourcefile -typedefs: - context_result_t: - definition: std::conditional_t::value, void, param_t> - description: __MISSING__ - context_t: - definition: detail::common_context, F, detail::single_trigger, detail::all_trigger> - description: __MISSING__ - opt_t: - definition: optional_placeholder_tuple - description: __MISSING__ - param_t: - definition: typename std::iterator_traits::value_type::result_type - description: __MISSING__ - result_t: - definition: typename detail::result_of_when_any_t::result_type - description: __MISSING__ - result_type: - definition: detail::result_t, std::decay_t...> - description: __MISSING__ - vt_t: - definition: voidless_tuple - description: __MISSING__ +hyde: + owner: sean-parent + brief: Futures class and related functions + tags: + - sourcefile + library-type: sourcefile + typedefs: + context_result_t: + definition: std::conditional_t::value, void, param_t> + description: __MISSING__ + context_t: + definition: detail::common_context, F, detail::single_trigger, detail::all_trigger> + description: __MISSING__ + opt_t: + definition: optional_placeholder_tuple + description: __MISSING__ + param_t: + definition: typename std::iterator_traits::value_type::result_type + description: __MISSING__ + result_t: + definition: typename detail::result_of_when_any_t::result_type + description: __MISSING__ + result_type: + definition: detail::result_t, std::decay_t...> + description: __MISSING__ + vt_t: + definition: voidless_tuple + description: __MISSING__ --- diff --git a/docs/libraries/concurrency/future.hpp/make_when_any3CT3E/index.md b/docs/libraries/concurrency/future.hpp/make_when_any3CT3E/index.md index 0ed1ca42a..38f9ed75a 100644 --- a/docs/libraries/concurrency/future.hpp/make_when_any3CT3E/index.md +++ b/docs/libraries/concurrency/future.hpp/make_when_any3CT3E/index.md @@ -1,15 +1,19 @@ --- layout: class title: make_when_any -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/future.hpp -declaration: "template \nstruct stlab::make_when_any;" -ctor: unspecified -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/future.hpp + declaration: "template \nstruct stlab::make_when_any;" + ctor: unspecified + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/future.hpp/make_when_any3CT3E/m_make.md b/docs/libraries/concurrency/future.hpp/make_when_any3CT3E/m_make.md index 0e52bb553..4687a0249 100644 --- a/docs/libraries/concurrency/future.hpp/make_when_any3CT3E/m_make.md +++ b/docs/libraries/concurrency/future.hpp/make_when_any3CT3E/m_make.md @@ -1,27 +1,28 @@ --- layout: method title: make -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nstatic auto make(E, F, future, future...)": - arguments: - - description: __OPTIONAL__ - name: executor - type: E - - description: __OPTIONAL__ - name: f - type: F - - description: __OPTIONAL__ - name: arg - type: future - - description: __OPTIONAL__ - name: args - type: future... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nstatic auto make(E executor, F f, future arg, future... args)" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nstatic auto make(E, F, future, future...)": + arguments: + - description: __OPTIONAL__ + name: executor + type: E + - description: __OPTIONAL__ + name: f + type: F + - description: __OPTIONAL__ + name: arg + type: future + - description: __OPTIONAL__ + name: args + type: future... + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nstatic auto make(E executor, F f, future arg, future... args)" --- diff --git a/docs/libraries/concurrency/future.hpp/make_when_any3Cvoid3E/index.md b/docs/libraries/concurrency/future.hpp/make_when_any3Cvoid3E/index.md index 42d99e64b..9d37428e4 100644 --- a/docs/libraries/concurrency/future.hpp/make_when_any3Cvoid3E/index.md +++ b/docs/libraries/concurrency/future.hpp/make_when_any3Cvoid3E/index.md @@ -1,15 +1,19 @@ --- layout: class title: make_when_any -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/future.hpp -declaration: "\nstruct stlab::make_when_any;" -ctor: unspecified -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/future.hpp + declaration: "\nstruct stlab::make_when_any;" + ctor: unspecified + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/future.hpp/make_when_any3Cvoid3E/m_make.md b/docs/libraries/concurrency/future.hpp/make_when_any3Cvoid3E/m_make.md index c60be190c..61e63b011 100644 --- a/docs/libraries/concurrency/future.hpp/make_when_any3Cvoid3E/m_make.md +++ b/docs/libraries/concurrency/future.hpp/make_when_any3Cvoid3E/m_make.md @@ -1,24 +1,25 @@ --- layout: method title: make -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nstatic auto make(E, F &&, future...)": - arguments: - - description: __OPTIONAL__ - name: executor - type: E - - description: __OPTIONAL__ - name: f - type: F && - - description: __OPTIONAL__ - name: args - type: future... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nstatic auto make(E executor, F && f, future... args)" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nstatic auto make(E, F &&, future...)": + arguments: + - description: __OPTIONAL__ + name: executor + type: E + - description: __OPTIONAL__ + name: f + type: F && + - description: __OPTIONAL__ + name: args + type: future... + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nstatic auto make(E executor, F && f, future... args)" --- diff --git a/docs/libraries/concurrency/future.hpp/packaged_task/f_package.md b/docs/libraries/concurrency/future.hpp/packaged_task/f_package.md index 892f93276..20b45c80e 100644 --- a/docs/libraries/concurrency/future.hpp/packaged_task/f_package.md +++ b/docs/libraries/concurrency/future.hpp/packaged_task/f_package.md @@ -1,50 +1,48 @@ --- layout: function title: package -owner: sean-parent -brief: Create a promise/future pair -tags: - - function -defined_in_file: concurrency/future.hpp -overloads: - auto package(stlab::detail::immediate_executor_type, __lambda) -> std::pair, future>>: - arguments: - - description: __OPTIONAL__ - name: executor - type: stlab::detail::immediate_executor_type - - description: __OPTIONAL__ - name: f - type: __lambda - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: auto package(stlab::detail::immediate_executor_type executor, __lambda f) -> std::pair, future>> - "template \nauto package(E, F &&) -> std::pair, future>>": - arguments: - - description: __OPTIONAL__ - name: executor - type: E - unnamed: true - - description: __OPTIONAL__ - name: f - type: F && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto package(E executor, F && f) -> std::pair, future>>" - "template \nauto package(E, F &&) -> std::pair, future>>": - arguments: - - description: The executor is the default executor for a possible attached continuation - name: unnamed-0 - type: E - unnamed: true - - description: Callable object to call - name: unnamed-1 - type: F && - unnamed: true - description: The template function package creates a pair of a promise and a future. Calling the promise will be invoked immediately, not on the provided `executor`. The purpose of the passed `executor` is to have already an executor for an attached continuation. If the promise is destructed and have not been called, then the associated future contains a std::exception with the error code `stlab::broken_promise`. - return: A std::pair of a promise and the associated future. - signature_with_names: "template \nauto package(E, F &&) -> std::pair, future>>" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Create a promise/future pair + tags: + - function + inline: + brief: _multiple descriptions_ + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto package(E, F &&) -> std::pair, future>>": + arguments: + - description: __OPTIONAL__ + name: executor + type: E + unnamed: true + - description: __OPTIONAL__ + name: f + type: F && + unnamed: true + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto package(E executor, F && f) -> std::pair, future>>" + "template \nauto package(E, F &&) -> std::pair, future>>": + arguments: + - description: The executor is the default executor for a possible attached continuation + name: unnamed-0 + type: E + unnamed: true + - description: Callable object to call + name: unnamed-1 + type: F && + unnamed: true + description: The template function package creates a pair of a promise and a future. Calling the promise will be invoked immediately, not on the provided `executor`. The purpose of the passed `executor` is to have already an executor for an attached continuation. If the promise is destructed and have not been called, then the associated future contains a std::exception with the error code `stlab::broken_promise`. + inline: + description: + - "***********************************************************************************************" + return: A std::pair of a promise and the associated future. + signature_with_names: "template \nauto package(E, F &&) -> std::pair, future>>" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/future.hpp/packaged_task/f_package_with_broken_promise.md b/docs/libraries/concurrency/future.hpp/packaged_task/f_package_with_broken_promise.md index 02c5cda6a..7610dd2ab 100644 --- a/docs/libraries/concurrency/future.hpp/packaged_task/f_package_with_broken_promise.md +++ b/docs/libraries/concurrency/future.hpp/packaged_task/f_package_with_broken_promise.md @@ -1,37 +1,38 @@ --- layout: function title: package_with_broken_promise -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/future.hpp -overloads: - "template \nauto package_with_broken_promise(E, F &&) -> std::pair, future>>": - arguments: - - description: __OPTIONAL__ - name: executor - type: E - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto package_with_broken_promise(E executor, F && f) -> std::pair, future>>" - "template \nauto package_with_broken_promise(E, F &&) -> std::pair, future>>": - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: E - unnamed: true - - description: __OPTIONAL__ - name: unnamed-1 - type: F && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto package_with_broken_promise(E, F &&) -> std::pair, future>>" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/future.hpp + overloads: + "template \nauto package_with_broken_promise(E, F &&) -> std::pair, future>>": + arguments: + - description: __OPTIONAL__ + name: executor + type: E + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto package_with_broken_promise(E executor, F && f) -> std::pair, future>>" + "template \nauto package_with_broken_promise(E, F &&) -> std::pair, future>>": + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: E + unnamed: true + - description: __OPTIONAL__ + name: unnamed-1 + type: F && + unnamed: true + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto package_with_broken_promise(E, F &&) -> std::pair, future>>" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/index.md b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/index.md index da22fdbd3..3089dfde5 100644 --- a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/index.md +++ b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/index.md @@ -1,13 +1,17 @@ --- layout: class title: packaged_task -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/future.hpp -declaration: "template \nclass stlab::packaged_task;" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/future.hpp + declaration: "template \nclass stlab::packaged_task;" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_canceled.md b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_canceled.md index f6d5f7191..7d0150c6c 100644 --- a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_canceled.md +++ b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_canceled.md @@ -1,14 +1,15 @@ --- layout: method title: canceled -owner: sean-parent -brief: Returns true if there are no longer any futures attached to the task. -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - bool canceled() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool canceled() const +hyde: + owner: sean-parent + brief: Returns true if there are no longer any futures attached to the task. + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + bool canceled() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool canceled() const --- diff --git a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_operator2829.md b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_operator2829.md index 6539bae11..3edb479b6 100644 --- a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_operator2829.md +++ b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_operator2829.md @@ -1,18 +1,19 @@ --- layout: method title: operator() -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - "template \nvoid operator()(A &&...) const": - arguments: - - description: __OPTIONAL__ - name: args - type: A &&... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(A &&... args) const" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + "template \nvoid operator()(A &&...) const": + arguments: + - description: __OPTIONAL__ + name: args + type: A &&... + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nvoid operator()(A &&... args) const" --- diff --git a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_operator3D.md b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_operator3D.md index 7153f54f5..ab121d7ca 100644 --- a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_operator3D.md +++ b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_operator3D.md @@ -1,28 +1,29 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - packaged_task & operator=(const packaged_task &): - arguments: - - description: __OPTIONAL__ - name: x - type: const packaged_task & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: packaged_task & operator=(const packaged_task & x) - packaged_task & operator=(packaged_task &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: x - type: packaged_task && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: packaged_task & operator=(packaged_task && x) +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + packaged_task & operator=(const packaged_task &): + arguments: + - description: __OPTIONAL__ + name: x + type: const packaged_task & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: packaged_task & operator=(const packaged_task & x) + packaged_task & operator=(packaged_task &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: x + type: packaged_task && + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: packaged_task & operator=(packaged_task && x) --- diff --git a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_packaged_task3CArgs3E.md b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_packaged_task3CArgs3E.md index dab1622d1..41f68abe3 100644 --- a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_packaged_task3CArgs3E.md +++ b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_packaged_task3CArgs3E.md @@ -1,36 +1,34 @@ --- layout: method title: packaged_task -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -is_ctor: true -overloads: - packaged_task(): - annotation: - - default - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: packaged_task() - packaged_task(const packaged_task &): - arguments: - - description: __OPTIONAL__ - name: x - type: const packaged_task & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: packaged_task(const packaged_task & x) - packaged_task(packaged_task &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: packaged_task && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: packaged_task(packaged_task &&) +hyde: + owner: __MISSING__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/future.hpp + is_ctor: true + overloads: + packaged_task(): + annotation: + - defaulted + description: __OPTIONAL__ + signature_with_names: packaged_task() + packaged_task(const packaged_task &): + arguments: + - description: __OPTIONAL__ + name: x + type: const packaged_task & + description: __MISSING__ + signature_with_names: packaged_task(const packaged_task & x) + packaged_task(packaged_task &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: packaged_task && + unnamed: true + description: __OPTIONAL__ + signature_with_names: packaged_task(packaged_task &&) --- diff --git a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_set_exception.md b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_set_exception.md index 912b249b4..d9feb1809 100644 --- a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_set_exception.md +++ b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_set_exception.md @@ -1,18 +1,19 @@ --- layout: method title: set_exception -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -overloads: - void set_exception(std::exception_ptr) const: - arguments: - - description: __OPTIONAL__ - name: error - type: std::exception_ptr - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void set_exception(std::exception_ptr error) const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/future.hpp + overloads: + void set_exception(std::exception_ptr) const: + arguments: + - description: __OPTIONAL__ + name: error + type: std::exception_ptr + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void set_exception(std::exception_ptr error) const --- diff --git a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_~packaged_task3CArgs3E.md b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_~packaged_task3CArgs3E.md index 4f5c9017a..5de545ae6 100644 --- a/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_~packaged_task3CArgs3E.md +++ b/docs/libraries/concurrency/future.hpp/packaged_task3CArgs3E/m_~packaged_task3CArgs3E.md @@ -1,15 +1,15 @@ --- layout: method title: ~packaged_task -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/future.hpp -is_dtor: true -overloads: - ~packaged_task(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~packaged_task() +hyde: + owner: __MISSING__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/future.hpp + is_dtor: true + overloads: + ~packaged_task(): + description: __OPTIONAL__ + signature_with_names: ~packaged_task() --- diff --git a/docs/libraries/concurrency/future.hpp/stlab3A3Av13A3Afuture_error_codes.md b/docs/libraries/concurrency/future.hpp/stlab3A3Av13A3Afuture_error_codes.md index ad21ec95c..52d95ae96 100644 --- a/docs/libraries/concurrency/future.hpp/stlab3A3Av13A3Afuture_error_codes.md +++ b/docs/libraries/concurrency/future.hpp/stlab3A3Av13A3Afuture_error_codes.md @@ -1,19 +1,23 @@ --- layout: enumeration title: future_error_codes -owner: __MISSING__ -brief: __MISSING__ -tags: - - enumeration -defined_in_file: concurrency/future.hpp -namespace: - - stlab - - v1 -values: - - description: __MISSING__ - name: broken_promise - - description: __MISSING__ - name: reduction_failed - - description: __MISSING__ - name: no_state +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - enumeration + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/future.hpp + namespace: + - stlab + - v1 + values: + - description: __MISSING__ + name: broken_promise + - description: __MISSING__ + name: reduction_failed + - description: __MISSING__ + name: no_state --- diff --git a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/index.md b/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/index.md deleted file mode 100644 index 2cda613a0..000000000 --- a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: class -title: immediate_executor_type -owner: sean-parent -brief: Executes tasks immediately -tags: - - class -defined_in_file: concurrency/immediate_executor.hpp -declaration: "\nstruct stlab::detail::immediate_executor_type;" -ctor: unspecified -dtor: unspecified -namespace: - - stlab - - v1 - - detail ---- diff --git a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_operator2829.md b/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_operator2829.md deleted file mode 100644 index 510afb3e8..000000000 --- a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_operator2829.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: method -title: operator() -owner: sean-parent -brief: Call operator to schedule a task -tags: - - method -defined_in_file: concurrency/immediate_executor.hpp -overloads: - "template \nvoid operator()(F &&) const": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: The task that shall now be executed. - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(F && f) const" - "template \nvoid operator()(std::chrono::steady_clock::time_point, F &&) const": - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: std::chrono::steady_clock::time_point - unnamed: true - - description: __OPTIONAL__ - name: f - type: F && - description: Execute the given task immediately. - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(std::chrono::steady_clock::time_point, F && f) const" ---- - -Executes the given function on this executor \ No newline at end of file diff --git a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_~immediate_executor_type.md b/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_~immediate_executor_type.md deleted file mode 100644 index 1838e3e34..000000000 --- a/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_~immediate_executor_type.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: method -title: ~immediate_executor_type -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/immediate_executor.hpp -is_dtor: true -overloads: - ~immediate_executor_type(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~immediate_executor_type() ---- diff --git a/docs/libraries/concurrency/immediate_executor.hpp/index.md b/docs/libraries/concurrency/immediate_executor.hpp/index.md index bbdd59c22..4385aac50 100644 --- a/docs/libraries/concurrency/immediate_executor.hpp/index.md +++ b/docs/libraries/concurrency/immediate_executor.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: concurrency/immediate_executor.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/concurrency/index.md b/docs/libraries/concurrency/index.md index 36988f9d8..f646c748a 100644 --- a/docs/libraries/concurrency/index.md +++ b/docs/libraries/concurrency/index.md @@ -1,17 +1,18 @@ --- -layout: library -title: Concurrency -tags: [library] -library-type: library -brief: This library provides high level abstractions for implementing algorithms that eases the use of multiple CPU cores while minimizing the contention. -description: | - The future implementation differs in several aspects compared to the C++11/14/17 standard futures: - It provides continuations and joins, which were just added in a C++17 TS. But more important this futures propagate values through the graph and not futures. This allows an easy way of creating splits. That means a single future can have multiple continuations into different directions. - - An other important difference is that the futures support cancellation. So if one is not anymore interested in the result of a future, then one can destroy the future without the need to wait until the future is fulfilled, as it is the case with `std::future` (and `boost::future`). An already started future will run until its end, but will not trigger any continuation. So in all these cases, all chained continuations will never be triggered. Additionally the future interface is designed in a way, that one can use build in or custom build executors. - This implies too, that the user has to take more care, that all references used inside the task associated with the future must either exist, or their meanwhile absence must be taken into account. (One appropriate mechanism here are weak and shared pointer.) +layout: directory +title: concurrency +hyde: + owner: sean-parent + brief: This library provides high level abstractions for implementing algorithms that eases the use of multiple CPU cores while minimizing the contention. - Since one can create with futures only graphs for single use, this library provides as well channels. With these channels one can build graphs, that can be used for multiple invocations. + description: | + The future implementation differs in several aspects compared to the C++11/14/17 standard futures: + It provides continuations and joins, which were just added in a C++17 TS. But more important this futures propagate values through the graph and not futures. This allows an easy way of creating splits. That means a single future can have multiple continuations into different directions. + + An other important difference is that the futures support cancellation. So if one is not anymore interested in the result of a future, then one can destroy the future without the need to wait until the future is fulfilled, as it is the case with `std::future` (and `boost::future`). An already started future will run until its end, but will not trigger any continuation. So in all these cases, all chained continuations will never be triggered. Additionally the future interface is designed in a way, that one can use build in or custom build executors. + This implies too, that the user has to take more care, that all references used inside the task associated with the future must either exist, or their meanwhile absence must be taken into account. (One appropriate mechanism here are weak and shared pointer.) + + Since one can create with futures only graphs for single use, this library provides as well channels. With these channels one can build graphs, that can be used for multiple invocations. --- ### Requirements @@ -21,5 +22,3 @@ description: | ### Authors Sean Parent, Foster Brereton, Felix Petriconi and other contributors. - -{% include example_table.html %} diff --git a/docs/libraries/concurrency/main_executor.hpp/index.md b/docs/libraries/concurrency/main_executor.hpp/index.md index b651bb275..5b0069b0b 100644 --- a/docs/libraries/concurrency/main_executor.hpp/index.md +++ b/docs/libraries/concurrency/main_executor.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: concurrency/main_executor.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/concurrency/main_executor.hpp/main_executor_type/index.md b/docs/libraries/concurrency/main_executor.hpp/main_executor_type/index.md deleted file mode 100644 index 2f5ae82c9..000000000 --- a/docs/libraries/concurrency/main_executor.hpp/main_executor_type/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: class -title: main_executor_type -owner: sean-parent -brief: Executes tasks on the application's main loop. -tags: - - class -defined_in_file: concurrency/main_executor.hpp -declaration: "\nstruct stlab::detail::main_executor_type;" -ctor: unspecified -dtor: unspecified -typedefs: - result_type: - definition: void - description: __MISSING__ -namespace: - - stlab - - v1 - - detail ---- - -All tasks that are passed to an instance of this instance are executed in-order on the application's main loop. - -Upon destruction of the main_executor, the underlying main loop is _not_ destroyed. Likewise, all functions submitted to the executor will be executed regardless of destruction state. - -So far no main_executor is implemented for Windows. If `STLAB_MAIN_EXECUTOR` is `qt5` or `qt6`, a main executor is instantiated that executes the tasks on the Qt main loop. \ No newline at end of file diff --git a/docs/libraries/concurrency/main_executor.hpp/main_executor_type/m_operator2829.md b/docs/libraries/concurrency/main_executor.hpp/main_executor_type/m_operator2829.md deleted file mode 100644 index 2a75544e1..000000000 --- a/docs/libraries/concurrency/main_executor.hpp/main_executor_type/m_operator2829.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: operator() -owner: sean-parent -brief: Executes the given function on the application's main loop. -tags: - - method -defined_in_file: concurrency/main_executor.hpp -overloads: - "template \nvoid operator()(F) const": - arguments: - - description: The function object that shall be executed on the main loop. - name: f - type: F - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(F f) const" ---- diff --git a/docs/libraries/concurrency/main_executor.hpp/main_executor_type/m_~main_executor_type.md b/docs/libraries/concurrency/main_executor.hpp/main_executor_type/m_~main_executor_type.md deleted file mode 100644 index 4b9cb82a9..000000000 --- a/docs/libraries/concurrency/main_executor.hpp/main_executor_type/m_~main_executor_type.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: method -title: ~main_executor_type -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/main_executor.hpp -is_dtor: true -overloads: - ~main_executor_type(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~main_executor_type() ---- diff --git a/docs/libraries/concurrency/progress.hpp/index.md b/docs/libraries/concurrency/progress.hpp/index.md index 19762d084..2f4ee1073 100644 --- a/docs/libraries/concurrency/progress.hpp/index.md +++ b/docs/libraries/concurrency/progress.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: concurrency/progress.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/concurrency/progress.hpp/progress_tracker/index.md b/docs/libraries/concurrency/progress.hpp/progress_tracker/index.md index 892134035..463592edc 100644 --- a/docs/libraries/concurrency/progress.hpp/progress_tracker/index.md +++ b/docs/libraries/concurrency/progress.hpp/progress_tracker/index.md @@ -1,13 +1,14 @@ --- layout: class title: progress_tracker -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/progress.hpp -declaration: "\nclass stlab::progress_tracker;" -dtor: unspecified -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/progress.hpp + declaration: "\nclass stlab::progress_tracker;" + dtor: unspecified + namespace: + - stlab --- diff --git a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_completed.md b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_completed.md index 100e780f0..5e4f1ef95 100644 --- a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_completed.md +++ b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_completed.md @@ -1,14 +1,15 @@ --- layout: method title: completed -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/progress.hpp -overloads: - size_t completed() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: size_t completed() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/progress.hpp + overloads: + size_t completed() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: size_t completed() const --- diff --git a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_operator2829.md b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_operator2829.md index 000807532..264c15e2c 100644 --- a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_operator2829.md +++ b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_operator2829.md @@ -1,18 +1,19 @@ --- layout: method title: operator() -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/progress.hpp -overloads: - "template \nauto operator()(F &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator()(F && f)" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/progress.hpp + overloads: + "template \nauto operator()(F &&)": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator()(F && f)" --- diff --git a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_operator3D.md b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_operator3D.md index 5c3b61b73..658a4cf4e 100644 --- a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_operator3D.md +++ b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_operator3D.md @@ -1,32 +1,33 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/progress.hpp -overloads: - stlab::progress_tracker & operator=(const stlab::progress_tracker &): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::progress_tracker & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::progress_tracker & operator=(const stlab::progress_tracker &) - stlab::progress_tracker & operator=(stlab::progress_tracker &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::progress_tracker && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::progress_tracker & operator=(stlab::progress_tracker &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/progress.hpp + overloads: + stlab::progress_tracker & operator=(const stlab::progress_tracker &): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::progress_tracker & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::progress_tracker & operator=(const stlab::progress_tracker &) + stlab::progress_tracker & operator=(stlab::progress_tracker &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::progress_tracker && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::progress_tracker & operator=(stlab::progress_tracker &&) --- diff --git a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_progress_tracker.md b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_progress_tracker.md index 38e744c89..7bebd3755 100644 --- a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_progress_tracker.md +++ b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_progress_tracker.md @@ -1,45 +1,42 @@ --- layout: method title: progress_tracker -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/progress.hpp -is_ctor: true -overloads: - progress_tracker(): - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: progress_tracker() - progress_tracker(const stlab::progress_tracker &): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::progress_tracker & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: progress_tracker(const stlab::progress_tracker &) - progress_tracker(std::function): - arguments: - - description: __OPTIONAL__ - name: f - type: std::function - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: progress_tracker(std::function f) - progress_tracker(stlab::progress_tracker &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::progress_tracker && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: progress_tracker(stlab::progress_tracker &&) +hyde: + owner: __MISSING__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/progress.hpp + is_ctor: true + overloads: + progress_tracker(): + description: __MISSING__ + signature_with_names: progress_tracker() + progress_tracker(const stlab::progress_tracker &): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::progress_tracker & + unnamed: true + description: __OPTIONAL__ + signature_with_names: progress_tracker(const stlab::progress_tracker &) + progress_tracker(std::function): + arguments: + - description: __OPTIONAL__ + name: f + type: std::function + description: __MISSING__ + signature_with_names: progress_tracker(std::function f) + progress_tracker(stlab::progress_tracker &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::progress_tracker && + unnamed: true + description: __OPTIONAL__ + signature_with_names: progress_tracker(stlab::progress_tracker &&) --- diff --git a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_steps.md b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_steps.md index 61a23cb58..1419d9e7e 100644 --- a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_steps.md +++ b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_steps.md @@ -1,14 +1,15 @@ --- layout: method title: steps -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/progress.hpp -overloads: - size_t steps() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: size_t steps() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/progress.hpp + overloads: + size_t steps() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: size_t steps() const --- diff --git a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_~progress_tracker.md b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_~progress_tracker.md index 789b7fa9c..8f9dc3e8b 100644 --- a/docs/libraries/concurrency/progress.hpp/progress_tracker/m_~progress_tracker.md +++ b/docs/libraries/concurrency/progress.hpp/progress_tracker/m_~progress_tracker.md @@ -1,15 +1,17 @@ --- layout: method title: ~progress_tracker -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/progress.hpp -is_dtor: true -overloads: - ~progress_tracker(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~progress_tracker() +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/progress.hpp + is_dtor: true + overloads: + ~progress_tracker(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: ~progress_tracker() --- diff --git a/docs/libraries/concurrency/ready_future.hpp/f_make_exceptional_future.md b/docs/libraries/concurrency/ready_future.hpp/f_make_exceptional_future.md index 79d53c7b3..e458c6a29 100644 --- a/docs/libraries/concurrency/ready_future.hpp/f_make_exceptional_future.md +++ b/docs/libraries/concurrency/ready_future.hpp/f_make_exceptional_future.md @@ -1,25 +1,26 @@ --- layout: function title: make_exceptional_future -owner: sean-parent -brief: Creates a future that is fulfilled as failed -tags: - - function -defined_in_file: concurrency/ready_future.hpp -overloads: - "template \nfuture make_exceptional_future(std::exception_ptr, E)": - arguments: - - description: The exception pointer - name: error - type: std::exception_ptr - - description: The executor that will be used for an attached continuation - name: executor - type: E - description: This function creates a future that is fulfilled as failed. - return: A future that is ready in an error state. - signature_with_names: "template \nfuture make_exceptional_future(std::exception_ptr error, E executor)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Creates a future that is fulfilled as failed + tags: + - function + defined_in_file: concurrency/ready_future.hpp + overloads: + "template \nfuture make_exceptional_future(std::exception_ptr, E)": + arguments: + - description: The exception pointer + name: error + type: std::exception_ptr + - description: The executor that will be used for an attached continuation + name: executor + type: E + description: This function creates a future that is fulfilled as failed. + return: A future that is ready in an error state. + signature_with_names: "template \nfuture make_exceptional_future(std::exception_ptr error, E executor)" + namespace: + - stlab + - v1 --- Creates a future that is fulfilled as failed diff --git a/docs/libraries/concurrency/ready_future.hpp/f_make_ready_future.md b/docs/libraries/concurrency/ready_future.hpp/f_make_ready_future.md index 49ec71225..0ff21a121 100644 --- a/docs/libraries/concurrency/ready_future.hpp/f_make_ready_future.md +++ b/docs/libraries/concurrency/ready_future.hpp/f_make_ready_future.md @@ -1,33 +1,40 @@ --- layout: function title: make_ready_future -owner: sean-parent -brief: Creates a future that is already fulfilled -tags: - - function -defined_in_file: concurrency/ready_future.hpp -overloads: - "template \nfuture make_ready_future(E)": - arguments: - - description: The executor that will be used for an attached continuation - name: executor - type: E - description: This function creates a future that is already fulfilled. - return: __OPTIONAL__ - signature_with_names: "template \nfuture make_ready_future(E executor)" - "template \nfuture> make_ready_future(T &&, E)": - arguments: - - description: The result value of the future - name: x - type: T && - - description: The executor that will be used for an attached continuation - name: executor - type: E - description: This function creates a future that is already fulfilled. - return: __OPTIONAL__ - signature_with_names: "template \nfuture> make_ready_future(T && x, E executor)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Creates a future that is already fulfilled + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: concurrency/ready_future.hpp + overloads: + "template \nfuture make_ready_future(E)": + arguments: + - description: The executor that will be used for an attached continuation + name: executor + type: E + description: This function creates a future that is already fulfilled. + return: __OPTIONAL__ + signature_with_names: "template \nfuture make_ready_future(E executor)" + "template \nfuture> make_ready_future(T &&, E)": + arguments: + - description: The result value of the future + name: x + type: T && + - description: The executor that will be used for an attached continuation + name: executor + type: E + description: This function creates a future that is already fulfilled. + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nfuture> make_ready_future(T && x, E executor)" + namespace: + - stlab + - v1 --- Creates a future that is already fulfilled diff --git a/docs/libraries/concurrency/ready_future.hpp/index.md b/docs/libraries/concurrency/ready_future.hpp/index.md index aed70499f..c024a0edd 100644 --- a/docs/libraries/concurrency/ready_future.hpp/index.md +++ b/docs/libraries/concurrency/ready_future.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: concurrency/ready_future.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/concurrency/serial_queue.hpp/index.md b/docs/libraries/concurrency/serial_queue.hpp/index.md index 0de0c64b8..516431123 100644 --- a/docs/libraries/concurrency/serial_queue.hpp/index.md +++ b/docs/libraries/concurrency/serial_queue.hpp/index.md @@ -1,10 +1,10 @@ --- layout: library title: concurrency/serial_queue.hpp -owner: sean-parent -brief: An executor wrapper that causes enqueued tasks to be run serially. -example: serial_queue_example.cpp -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: sean-parent + brief: An executor wrapper that causes enqueued tasks to be run serially. + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/index.md b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/index.md index 5d5f2d7f2..f2fce81a7 100644 --- a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/index.md +++ b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/index.md @@ -1,14 +1,18 @@ --- layout: class title: serial_queue_t -owner: sean-parent -brief: An executor wrapper that causes enqueued tasks to be run serially. -tags: - - class -defined_in_file: concurrency/serial_queue.hpp -declaration: "\nclass stlab::serial_queue_t;" -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: An executor wrapper that causes enqueued tasks to be run serially. + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/serial_queue.hpp + declaration: "\nclass stlab::serial_queue_t;" + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_executor.md b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_executor.md index a752db917..29e182430 100644 --- a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_executor.md +++ b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_executor.md @@ -1,16 +1,17 @@ --- layout: method title: executor -owner: sean-parent -brief: Constructs an executor from the serial queue -tags: - - method -defined_in_file: concurrency/serial_queue.hpp -overloads: - __lambda executor() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: __lambda executor() const +hyde: + owner: sean-parent + brief: Constructs an executor from the serial queue + tags: + - method + defined_in_file: concurrency/serial_queue.hpp + overloads: + __lambda executor() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: __lambda executor() const --- Like other executors, this routine returns an executor whose `operator()` returns `void`. As such, the tasks enqueued to the serial queue this way are not cancelable, nor is there a future through which their results are returned. diff --git a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_operator2829.md b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_operator2829.md index dc5124a5c..5444d3461 100644 --- a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_operator2829.md +++ b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_operator2829.md @@ -1,23 +1,24 @@ --- layout: method title: operator() -owner: sean-parent -brief: Passes the task to the serial_queue for scheduling and execution -tags: - - method -defined_in_file: concurrency/serial_queue.hpp -overloads: - "template \nauto operator()(F &&, Args &&...) const": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - - description: __OPTIONAL__ - name: args - type: Args &&... - description: Returns a future that will contain the result of the executed task. - return: __OPTIONAL__ - signature_with_names: "template \nauto operator()(F && f, Args &&... args) const" +hyde: + owner: sean-parent + brief: Passes the task to the serial_queue for scheduling and execution + tags: + - method + defined_in_file: concurrency/serial_queue.hpp + overloads: + "template \nauto operator()(F &&, Args &&...) const": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + - description: __OPTIONAL__ + name: args + type: Args &&... + description: Returns a future that will contain the result of the executed task. + return: __OPTIONAL__ + signature_with_names: "template \nauto operator()(F && f, Args &&... args) const" --- The `stlab::future` returned by this routine must be retained, or the task it is associated with will be cancelled if it has not already been executed. diff --git a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_operator3D.md b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_operator3D.md index 5961ba166..aea8e25af 100644 --- a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_operator3D.md +++ b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_operator3D.md @@ -1,28 +1,33 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/serial_queue.hpp -overloads: - stlab::serial_queue_t & operator=(const stlab::serial_queue_t &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::serial_queue_t & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::serial_queue_t & operator=(const stlab::serial_queue_t &) - stlab::serial_queue_t & operator=(stlab::serial_queue_t &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::serial_queue_t && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::serial_queue_t & operator=(stlab::serial_queue_t &&) +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/serial_queue.hpp + overloads: + stlab::serial_queue_t & operator=(const stlab::serial_queue_t &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::serial_queue_t & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::serial_queue_t & operator=(const stlab::serial_queue_t &) + stlab::serial_queue_t & operator=(stlab::serial_queue_t &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::serial_queue_t && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::serial_queue_t & operator=(stlab::serial_queue_t &&) --- diff --git a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_serial_queue_t.md b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_serial_queue_t.md index bec58d566..a27b6a41c 100644 --- a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_serial_queue_t.md +++ b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_serial_queue_t.md @@ -1,44 +1,42 @@ --- layout: method title: serial_queue_t -owner: sean-parent -brief: Constructs a serial queue -tags: - - method -defined_in_file: concurrency/serial_queue.hpp -is_ctor: true -overloads: - serial_queue_t(const stlab::serial_queue_t &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::serial_queue_t & - unnamed: true - description: Constructs the serial queue backed by the passed executor and using the supplied schedule mode. - return: __OPTIONAL__ - signature_with_names: serial_queue_t(const stlab::serial_queue_t &) - serial_queue_t(stlab::serial_queue_t &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::serial_queue_t && - unnamed: true - description: Constructs a serial_queue from another serial_queue. - return: __OPTIONAL__ - signature_with_names: serial_queue_t(stlab::serial_queue_t &&) - "template \nexplicit serial_queue_t(Executor, stlab::schedule_mode)": - arguments: - - description: The executor the serial queue will use to run tasks - name: e - type: Executor - - description: | - Specify the mode by which the serial queue runs tasks: - - - `schedule_mode::single` — Yield to the executor between runs of individual tasks. This mode is preferrable if you are expecting tasks to take a long amount of time. - - `schedule_mode::all` — Yield to the executor once all tasks available at the start of processing have been run. This mode is preferrable if you are expecting tasks to take a short amount of time. - name: mode - type: stlab::schedule_mode - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nexplicit serial_queue_t(Executor e, stlab::schedule_mode mode)" +hyde: + owner: sean-parent + brief: Constructs a serial queue + tags: + - method + defined_in_file: concurrency/serial_queue.hpp + is_ctor: true + overloads: + serial_queue_t(const stlab::serial_queue_t &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::serial_queue_t & + unnamed: true + description: Constructs the serial queue backed by the passed executor and using the supplied schedule mode. + signature_with_names: serial_queue_t(const stlab::serial_queue_t &) + serial_queue_t(stlab::serial_queue_t &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::serial_queue_t && + unnamed: true + description: Constructs a serial_queue from another serial_queue. + signature_with_names: serial_queue_t(stlab::serial_queue_t &&) + "template \nexplicit serial_queue_t(Executor, stlab::schedule_mode)": + arguments: + - description: The executor the serial queue will use to run tasks + name: e + type: Executor + - description: "Specify the mode by which the serial queue runs tasks:\n\n- `schedule_mode::single` — Yield to the executor between runs of individual tasks. This mode is preferrable if you are expecting tasks to take a long amount of time.\n- `schedule_mode::all` — Yield to the executor once all tasks available at the start of processing have been run. This mode is preferrable if you are expecting tasks to take a short amount of time.\n" + name: mode + type: stlab::schedule_mode + description: __MISSING__ + signature_with_names: "template \nexplicit serial_queue_t(Executor e, stlab::schedule_mode mode)" --- diff --git a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_~serial_queue_t.md b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_~serial_queue_t.md index 17123344c..00f5ff6c5 100644 --- a/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_~serial_queue_t.md +++ b/docs/libraries/concurrency/serial_queue.hpp/serial_queue_t/m_~serial_queue_t.md @@ -1,15 +1,17 @@ --- layout: method title: ~serial_queue_t -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/serial_queue.hpp -is_dtor: true -overloads: - ~serial_queue_t(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~serial_queue_t() +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/serial_queue.hpp + is_dtor: true + overloads: + ~serial_queue_t(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: ~serial_queue_t() --- diff --git a/docs/libraries/concurrency/serial_queue.hpp/stlab3A3Av13A3Aschedule_mode.md b/docs/libraries/concurrency/serial_queue.hpp/stlab3A3Av13A3Aschedule_mode.md index 48de695bd..888613256 100644 --- a/docs/libraries/concurrency/serial_queue.hpp/stlab3A3Av13A3Aschedule_mode.md +++ b/docs/libraries/concurrency/serial_queue.hpp/stlab3A3Av13A3Aschedule_mode.md @@ -1,17 +1,21 @@ --- layout: enumeration title: schedule_mode -owner: __MISSING__ -brief: __MISSING__ -tags: - - enumeration -defined_in_file: concurrency/serial_queue.hpp -namespace: - - stlab - - v1 -values: - - description: __MISSING__ - name: single - - description: __MISSING__ - name: all +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - enumeration + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/serial_queue.hpp + namespace: + - stlab + - v1 + values: + - description: __MISSING__ + name: single + - description: __MISSING__ + name: all --- diff --git a/docs/libraries/concurrency/set_current_thread_name.hpp/f_set_current_thread_name.md b/docs/libraries/concurrency/set_current_thread_name.hpp/f_set_current_thread_name.md index be936e869..6e2a5454a 100644 --- a/docs/libraries/concurrency/set_current_thread_name.hpp/f_set_current_thread_name.md +++ b/docs/libraries/concurrency/set_current_thread_name.hpp/f_set_current_thread_name.md @@ -1,20 +1,21 @@ --- layout: function title: set_current_thread_name -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/set_current_thread_name.hpp -overloads: - void set_current_thread_name(const char *): - arguments: - - description: __OPTIONAL__ - name: name - type: const char * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void set_current_thread_name(const char * name) -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/set_current_thread_name.hpp + overloads: + void set_current_thread_name(const char *): + arguments: + - description: __OPTIONAL__ + name: name + type: const char * + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void set_current_thread_name(const char * name) + namespace: + - stlab --- diff --git a/docs/libraries/concurrency/set_current_thread_name.hpp/index.md b/docs/libraries/concurrency/set_current_thread_name.hpp/index.md index a3d5a2ff4..a58ce37ae 100644 --- a/docs/libraries/concurrency/set_current_thread_name.hpp/index.md +++ b/docs/libraries/concurrency/set_current_thread_name.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: concurrency/set_current_thread_name.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/concurrency/system_timer.hpp/index.md b/docs/libraries/concurrency/system_timer.hpp/index.md index 0eaf41acd..e42c89dc3 100644 --- a/docs/libraries/concurrency/system_timer.hpp/index.md +++ b/docs/libraries/concurrency/system_timer.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: concurrency/system_timer.hpp -owner: sean-parent -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/index.md b/docs/libraries/concurrency/system_timer.hpp/system_timer_type/index.md deleted file mode 100644 index 432341ceb..000000000 --- a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: class -title: system_timer_type -owner: sean-parent -brief: Executes a function after a specified duration. -tags: - - class -defined_in_file: concurrency/system_timer.hpp -declaration: "\nstruct stlab::detail::system_timer_type;" -ctor: unspecified -dtor: unspecified -typedefs: - result_type: - definition: void - description: __MISSING__ -namespace: - - stlab - - v1 - - detail ---- - -All functions that are passed to an instance of this class are executed after a specified duration. - -`[deprecated]` All functions that are passed to an instance of this class are executed at the specified time. - -Upon destruction of `system_timer`, the underlying main loop is _not_ destroyed. Likewise, all functions submitted to the executor will be executed regardless of destruction state. \ No newline at end of file diff --git a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_operator2829.md b/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_operator2829.md deleted file mode 100644 index 7be65d082..000000000 --- a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_operator2829.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: method -title: operator() -owner: sean-parent -brief: Executes the given task after the specified duration. -tags: - - method -defined_in_file: concurrency/system_timer.hpp -overloads: - "template \nvoid operator()(std::chrono::duration, F) const": - arguments: - - description: The waiting duration after the task shall be executed. - name: duration - type: std::chrono::duration - - description: __OPTIONAL__ - name: f - type: F - description: This executors executes the given task after the given duration. - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(std::chrono::duration duration, F f) const" - "template \nvoid operator()(std::chrono::steady_clock::time_point, F) const": - annotation: - - deprecated (Use chrono::duration as parameter instead) - arguments: - - description: The time point when the task shall be executed. - name: when - type: std::chrono::steady_clock::time_point - - description: The task that shall be executed on the given executor. - name: f - type: F - description: Executes the given task at the given time. - return: __OPTIONAL__ - signature_with_names: "template \nvoid operator()(std::chrono::steady_clock::time_point when, F f) const" ---- - -Executes the given task after the specified duration. - -[deprecated] Executes the given task at the specified time point. -When the time point is in the past, then the task will be executed immediately. - -In case that the previous task takes longer as the time difference between its starting point and the start of the next task. Then the next task may be executed delayed. So a task can be executed later as specified, but never earlier. \ No newline at end of file diff --git a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_~system_timer_type.md b/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_~system_timer_type.md deleted file mode 100644 index 19facd725..000000000 --- a/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_~system_timer_type.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: method -title: ~system_timer_type -owner: sean-parent -brief: system_timer_type destructor. -tags: - - method -defined_in_file: concurrency/system_timer.hpp -is_dtor: true -overloads: - ~system_timer_type(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~system_timer_type() ---- diff --git a/docs/libraries/concurrency/task.hpp/f_operator213D.md b/docs/libraries/concurrency/task.hpp/f_operator213D.md deleted file mode 100644 index ac1ae7756..000000000 --- a/docs/libraries/concurrency/task.hpp/f_operator213D.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: function -title: stlab::operator!= -tags: [library] -scope: stlab -pure-name: operator!= -brief: Compares a task for not equal an empty task -description: Compares a task for not equal an empty task -defined-in-header: stlab/concurrency/task.hpp -entities: - - kind: overloads - list: - - name: operator!= - pure-name: operator!= - declaration: | - bool operator!=(const task& x, std::nullptr_t) - description: Checks if the given task `x` is not equal an empty task - - name: operator!= - pure-name: when_all - declaration: | - bool operator!=(std::nullptr_t, const task& x) - description: Checks if the given task `x` is not equal an empty task - - kind: parameters - list: - - name: x - description: The task that shall be compared against an empty task - - kind: result - description: Returns true, if the given task is not equal an empty task. ---- diff --git a/docs/libraries/concurrency/task.hpp/index.md b/docs/libraries/concurrency/task.hpp/index.md index b7257ea3f..599be3ca5 100644 --- a/docs/libraries/concurrency/task.hpp/index.md +++ b/docs/libraries/concurrency/task.hpp/index.md @@ -1,9 +1,14 @@ --- layout: library title: concurrency/task.hpp -owner: sean-parent -brief: Task class and related functions -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: sean-parent + brief: Task class and related functions + tags: + - sourcefile + library-type: sourcefile + typedefs: + task: + definition: typename noexcept_deducer::type + description: __MISSING__ --- diff --git a/docs/libraries/concurrency/task.hpp/m_operator2829.md b/docs/libraries/concurrency/task.hpp/m_operator2829.md deleted file mode 100644 index c5d5d7d24..000000000 --- a/docs/libraries/concurrency/task.hpp/m_operator2829.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: method -title: stlab::task::operator() -tags: [library] -scope: task -pure-name: operator() -defined-in-header: stlab/concurrency/task.hpp -brief: Invoke the task -entities: - - kind: methods - list: - - name: stlab::task::operator() - pure-name: operator() - defined-in-header: stlab/concurrency/task.hpp - declaration: | - void operator()(Args... args) noexcept - description: Invokes the task - - kind: parameters - list: - - name: args - description: The arguments for calling the stored function. - ---- diff --git a/docs/libraries/concurrency/task.hpp/m_operator3D3D.md b/docs/libraries/concurrency/task.hpp/m_operator3D3D.md deleted file mode 100644 index 24907c49e..000000000 --- a/docs/libraries/concurrency/task.hpp/m_operator3D3D.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: function -title: stlab::operator== -tags: [library] -scope: stlab -pure-name: operator== -brief: Checks if a given task is equal to an empty task -description: Checks if a given task is equal to an empty task -annotation: template function -defined-in-header: stlab/concurrency/task.hpp -entities: - - kind: overloads - list: - - name: operator== - pure-name: operator== - declaration: | - bool operator==(const task& x, std::nullptr_t) - description: Checks if the given task `x` is equal to an empty task - - name: operator== - pure-name: when_all - declaration: | - bool operator==(std::nullptr_t, const task& x) - description: Checks if the given task `x` is equal to an empty task - - kind: parameters - list: - - name: x - description: The task that shall be compared against an empty task - - kind: result - description: Returns true, if the given task is equal to an empty task. ---- diff --git a/docs/libraries/concurrency/task.hpp/m_swap.md b/docs/libraries/concurrency/task.hpp/m_swap.md deleted file mode 100644 index 7642e22de..000000000 --- a/docs/libraries/concurrency/task.hpp/m_swap.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: function -title: stlab::swap -tags: [library] -scope: stlab -pure-name: swap -brief: Exchanges two tasks -description: Exchanges two task -defined-in-header: stlab/concurrency/task.hpp -entities: - - kind: overloads - list: - - name: swap - pure-name: swap - declaration: | - void swap(task& x, task& y) - description: Swaps task x and task y - - kind: parameters - list: - - name: x - description: The one task that shall be exchanged - - name: y - description: The other task that shall be exchanged ---- diff --git a/docs/libraries/concurrency/task.hpp/noexcept_deducer3CT2C20.26423853/index.md b/docs/libraries/concurrency/task.hpp/noexcept_deducer3CT2C20.26423853/index.md new file mode 100644 index 000000000..86992078f --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/noexcept_deducer3CT2C20.26423853/index.md @@ -0,0 +1,20 @@ +--- +layout: class +title: noexcept_deducer +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/task.hpp + declaration: "\nstruct stlab::noexcept_deducer;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: T + description: __MISSING__ + namespace: + - stlab + - v1 +--- diff --git a/docs/libraries/concurrency/task.hpp/noexcept_deducer3CT2C20.5812342b/index.md b/docs/libraries/concurrency/task.hpp/noexcept_deducer3CT2C20.5812342b/index.md new file mode 100644 index 000000000..a1da2b7b7 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/noexcept_deducer3CT2C20.5812342b/index.md @@ -0,0 +1,20 @@ +--- +layout: class +title: noexcept_deducer +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/task.hpp + declaration: "\nstruct stlab::noexcept_deducer;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: T + description: __MISSING__ + namespace: + - stlab + - v1 +--- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator213D.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator213D.md deleted file mode 100644 index d67d0ee0a..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator213D.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: function -title: operator!= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/task.hpp -overloads: - bool operator!=(const task &, std::nullptr_t): - arguments: - - description: __OPTIONAL__ - name: x - type: const task & - - description: __OPTIONAL__ - name: unnamed-1 - type: std::nullptr_t - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const task & x, std::nullptr_t) - bool operator!=(std::nullptr_t, const task &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: std::nullptr_t - unnamed: true - - description: __OPTIONAL__ - name: x - type: const task & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(std::nullptr_t, const task & x) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator3D3D.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator3D3D.md deleted file mode 100644 index d35fd5938..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_operator3D3D.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: function -title: operator== -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/task.hpp -overloads: - bool operator==(const task &, std::nullptr_t): - arguments: - - description: __OPTIONAL__ - name: x - type: const task & - - description: __OPTIONAL__ - name: unnamed-1 - type: std::nullptr_t - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const task & x, std::nullptr_t) - bool operator==(std::nullptr_t, const task &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: std::nullptr_t - unnamed: true - - description: __OPTIONAL__ - name: x - type: const task & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(std::nullptr_t, const task & x) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_swap.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_swap.md deleted file mode 100644 index 6776d0c91..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/f_swap.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: function -title: swap -owner: sean-parent -brief: Swaps an other task with this -tags: - - function -defined_in_file: concurrency/task.hpp -overloads: - void swap(task &, task &): - arguments: - - description: __OPTIONAL__ - name: x - type: task & - - description: __OPTIONAL__ - name: y - type: task & - description: Exchanges this task with the passed one. - return: __OPTIONAL__ - signature_with_names: void swap(task & x, task & y) -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/index.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/index.md deleted file mode 100644 index f7019802a..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: class -title: task -owner: sean-parent -brief: General-purpose polymorphic function wrapper. -tags: - - class -defined_in_file: concurrency/task.hpp -declaration: "\nclass stlab::task;" -typedefs: - result_type: - definition: R - description: __MISSING__ -fields: - _invoke: - description: __MISSING__ - type: const stlab::task::invoke_t - _vtable: - description: __MISSING__ - type: const stlab::task::concept_t -namespace: - - stlab - - v1 ---- - -Class template `stlab::task` is a general-purpose polymorphic function wrapper. Instances of `stlab::task` can store, move, and invoke any [Callable](http://en.cppreference.com/w/cpp/named_req/Callable) target -- functions, lambda expressions, bind expressions, or other function objects, as well as pointers to member functions and pointers to data members. - -The stored callable object is called the target of `stlab::task`. If an `stlab::task` contains no target, it is called _empty_. Invoking the target of an empty `stlab::task` results in [`std::bad_function_call`](http://en.cppreference.com/w/cpp/utility/functional/bad_function_call) exception being thrown. - -`stlab::task` is Similar to [`std::function`](http://en.cppreference.com/w/cpp/utility/functional/function) except it is not copyable and supports move-only and mutable callable targets which is especially useful for targets that may only be invoked once, often useful to deliver a message or payload in tasking or messaging system. - -`stlab::task` satisfies the requirements of [MoveConstructible](http://en.cppreference.com/w/cpp/named_req/MoveConstructible) and [MoveAssignable](http://en.cppreference.com/w/cpp/named_req/MoveAssignable). \ No newline at end of file diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator20bool.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator20bool.md deleted file mode 100644 index 48799c491..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator20bool.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: method -title: operator bool -owner: sean-parent -brief: Check if the task can be invoked -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - explicit operator bool() const: - description: Used to determine if the task can be invoked - return: __OPTIONAL__ - signature_with_names: explicit operator bool() const ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator2829.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator2829.md deleted file mode 100644 index 7c0601530..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator2829.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: operator() -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - "template \nauto operator()(Brgs &&...)": - arguments: - - description: __OPTIONAL__ - name: brgs - type: Brgs &&... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator()(Brgs &&... brgs)" ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator3D.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator3D.md deleted file mode 100644 index 3b0c3d9a9..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator3D.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: method -title: operator= -owner: sean-parent -brief: Move assignment operator -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - task & operator=(const task &): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const task & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: task & operator=(const task &) - task & operator=(std::nullptr_t): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: std::nullptr_t - unnamed: true - description: Destroys the current function and creates a new empty one. - return: __OPTIONAL__ - signature_with_names: task & operator=(std::nullptr_t) - task & operator=(task &&): - arguments: - - description: __OPTIONAL__ - name: x - type: task && - description: Moves the given task `x` into `this`. - return: __OPTIONAL__ - signature_with_names: task & operator=(task && x) - "template \ntask & operator=(F &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ntask & operator=(F && f)" ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_swap.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_swap.md deleted file mode 100644 index e53e65375..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_swap.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - void swap(task &): - arguments: - - description: __OPTIONAL__ - name: x - type: task & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void swap(task & x) ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target.md deleted file mode 100644 index 8c0293d8e..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: target -owner: sean-parent -brief: Get the underlying function -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - "template \nT * target()": - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: "template \nT * target()" - "template \nconst T * target() const": - description: Const variant - return: A pointer to the underlying function, if `target_type() == typeid(T)`. Otherwise, `nullptr`. - signature_with_names: "template \nconst T * target() const" ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target_type.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target_type.md deleted file mode 100644 index 645d6fcb2..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target_type.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: method -title: target_type -owner: sean-parent -brief: Get type information about the underlying function -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - const std::type_info & target_type() const: - description: Gives type information about the underlying function - return: __OPTIONAL__ - signature_with_names: const std::type_info & target_type() const ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_task3CR2028Args293E.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_task3CR2028Args293E.md deleted file mode 100644 index e0d4b463e..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_task3CR2028Args293E.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: method -title: task -owner: sean-parent -brief: Constructs an `stlab::task` from a variety of sources. -tags: - - method -defined_in_file: concurrency/task.hpp -is_ctor: true -overloads: - task(): - annotation: - - default - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: task() - task(const task &): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const task & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: task(const task &) - task(std::nullptr_t): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: std::nullptr_t - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: task(std::nullptr_t) - task(task &&): - arguments: - - description: __OPTIONAL__ - name: x - type: task && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: task(task && x) - "template , task>::value, bool> >\ntask(F &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template , task>::value, bool> >\ntask(F && f)" ---- - -When the target is a function pointer or std::reference_wrapper, small object optimization is -guaranteed, that is, these targets are always directly stored inside the `stlab::task` object, no dynamic allocation takes place. Other large objects may be constructed in dynamic allocated storage and accessed by the `stlab::task` object through a pointer. \ No newline at end of file diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_~task3CR2028Args293E.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_~task3CR2028Args293E.md deleted file mode 100644 index 43f6d1156..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_~task3CR2028Args293E.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: method -title: ~task -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -is_dtor: true -overloads: - ~task(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~task() ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/index.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/index.md deleted file mode 100644 index 78d1e25fc..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: class -title: model -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/task.hpp -declaration: "\nstruct stlab::task::model;" -dtor: unspecified -fields: - _invoke: - description: __MISSING__ - type: const stlab::task::invoke_t - _p: - description: __MISSING__ - type: std::unique_ptr - _vtable: - description: __MISSING__ - type: const stlab::task::concept_t -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_const_pointer.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_const_pointer.md deleted file mode 100644 index 6c2ec25b1..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_const_pointer.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: const_pointer -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto const_pointer(const void *) -> const void *: - arguments: - - description: __OPTIONAL__ - name: self - type: const void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto const_pointer(const void * self) -> const void * ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_dtor.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_dtor.md deleted file mode 100644 index db6500d97..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_dtor.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: dtor -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static void dtor(void *): - arguments: - - description: __OPTIONAL__ - name: self - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static void dtor(void * self) ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_invoke.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_invoke.md deleted file mode 100644 index 726118359..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_invoke.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: method -title: invoke -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto invoke(void *, Args...) -> R: - arguments: - - description: __OPTIONAL__ - name: self - type: void * - - description: __OPTIONAL__ - name: args - type: Args... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto invoke(void * self, Args... args) -> R ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_model3CF2C20false3E.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_model3CF2C20false3E.md deleted file mode 100644 index d08fbb72b..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_model3CF2C20false3E.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: method -title: model -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -is_ctor: true -overloads: - model(model &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: model && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: model(model &&) - "template \nmodel(G &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: G && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nmodel(G && f)" ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_move_ctor.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_move_ctor.md deleted file mode 100644 index 423e7b00b..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_move_ctor.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: method -title: move_ctor -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static void move_ctor(void *, void *): - arguments: - - description: __OPTIONAL__ - name: self - type: void * - - description: __OPTIONAL__ - name: p - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static void move_ctor(void * self, void * p) ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_pointer.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_pointer.md deleted file mode 100644 index 87b86d0b7..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_pointer.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: pointer -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto pointer(void *) -> void *: - arguments: - - description: __OPTIONAL__ - name: self - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto pointer(void * self) -> void * ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_target_type.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_target_type.md deleted file mode 100644 index db136860f..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_target_type.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: method -title: target_type -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto target_type() -> const std::type_info &: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto target_type() -> const std::type_info & ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/index.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/index.md deleted file mode 100644 index ce042eb18..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: class -title: model -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/task.hpp -declaration: "\nstruct stlab::task::model;" -dtor: unspecified -fields: - _f: - description: __MISSING__ - type: F - _invoke: - description: __MISSING__ - type: const stlab::task::invoke_t - _vtable: - description: __MISSING__ - type: const stlab::task::concept_t -namespace: - - stlab - - v1 ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_const_pointer.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_const_pointer.md deleted file mode 100644 index 6c2ec25b1..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_const_pointer.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: const_pointer -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto const_pointer(const void *) -> const void *: - arguments: - - description: __OPTIONAL__ - name: self - type: const void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto const_pointer(const void * self) -> const void * ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_dtor.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_dtor.md deleted file mode 100644 index db6500d97..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_dtor.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: dtor -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static void dtor(void *): - arguments: - - description: __OPTIONAL__ - name: self - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static void dtor(void * self) ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_invoke.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_invoke.md deleted file mode 100644 index 726118359..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_invoke.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: method -title: invoke -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto invoke(void *, Args...) -> R: - arguments: - - description: __OPTIONAL__ - name: self - type: void * - - description: __OPTIONAL__ - name: args - type: Args... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto invoke(void * self, Args... args) -> R ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_model3CF2C20true3E.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_model3CF2C20true3E.md deleted file mode 100644 index 52d0475e9..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_model3CF2C20true3E.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: method -title: model -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -is_ctor: true -overloads: - model(model &&): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: model && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: model(model &&) - "template \nmodel(G &&)": - arguments: - - description: __OPTIONAL__ - name: f - type: G && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nmodel(G && f)" ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_move_ctor.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_move_ctor.md deleted file mode 100644 index 423e7b00b..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_move_ctor.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -layout: method -title: move_ctor -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static void move_ctor(void *, void *): - arguments: - - description: __OPTIONAL__ - name: self - type: void * - - description: __OPTIONAL__ - name: p - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static void move_ctor(void * self, void * p) ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_pointer.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_pointer.md deleted file mode 100644 index 87b86d0b7..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_pointer.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: method -title: pointer -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto pointer(void *) -> void *: - arguments: - - description: __OPTIONAL__ - name: self - type: void * - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto pointer(void * self) -> void * ---- diff --git a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_target_type.md b/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_target_type.md deleted file mode 100644 index db136860f..000000000 --- a/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_target_type.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: method -title: target_type -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/task.hpp -overloads: - static auto target_type() -> const std::type_info &: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: static auto target_type() -> const std::type_info & ---- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/f_operator213D.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/f_operator213D.md new file mode 100644 index 000000000..a683ae3f6 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/f_operator213D.md @@ -0,0 +1,38 @@ +--- +layout: function +title: operator!= +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/task.hpp + overloads: + bool operator!=(const task_ &, std::nullptr_t): + arguments: + - description: __OPTIONAL__ + name: x + type: const task_ & + - description: __OPTIONAL__ + name: unnamed-1 + type: std::nullptr_t + unnamed: true + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const task_ & x, std::nullptr_t) + bool operator!=(std::nullptr_t, const task_ &): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: std::nullptr_t + unnamed: true + - description: __OPTIONAL__ + name: x + type: const task_ & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(std::nullptr_t, const task_ & x) + namespace: + - stlab + - v1 +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/f_operator3D3D.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/f_operator3D3D.md new file mode 100644 index 000000000..72f2e9caa --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/f_operator3D3D.md @@ -0,0 +1,38 @@ +--- +layout: function +title: operator== +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/task.hpp + overloads: + bool operator==(const task_ &, std::nullptr_t): + arguments: + - description: __OPTIONAL__ + name: x + type: const task_ & + - description: __OPTIONAL__ + name: unnamed-1 + type: std::nullptr_t + unnamed: true + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const task_ & x, std::nullptr_t) + bool operator==(std::nullptr_t, const task_ &): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: std::nullptr_t + unnamed: true + - description: __OPTIONAL__ + name: x + type: const task_ & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(std::nullptr_t, const task_ & x) + namespace: + - stlab + - v1 +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/f_swap.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/f_swap.md new file mode 100644 index 000000000..f40b8cc57 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/f_swap.md @@ -0,0 +1,25 @@ +--- +layout: function +title: swap +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: concurrency/task.hpp + overloads: + void swap(task_ &, task_ &): + arguments: + - description: __OPTIONAL__ + name: x + type: task_ & + - description: __OPTIONAL__ + name: y + type: task_ & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void swap(task_ & x, task_ & y) + namespace: + - stlab + - v1 +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/index.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/index.md new file mode 100644 index 000000000..9ed3e5c6e --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/index.md @@ -0,0 +1,28 @@ +--- +layout: class +title: task_ +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - tasks are functions with a mutable call operator to support moving items through for single invocations. + defined_in_file: concurrency/task.hpp + declaration: "template \nclass stlab::task_;" + typedefs: + result_type: + definition: R + description: __MISSING__ + fields: + _invoke: + description: __MISSING__ + type: const stlab::task_::invoke_t + _vtable: + description: __MISSING__ + type: const stlab::task_::concept_t + namespace: + - stlab + - v1 +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_operator20bool.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_operator20bool.md new file mode 100644 index 000000000..6f7029eef --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_operator20bool.md @@ -0,0 +1,15 @@ +--- +layout: method +title: operator bool +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + explicit operator bool() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: explicit operator bool() const +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_operator2829.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_operator2829.md new file mode 100644 index 000000000..2b7e31a28 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_operator2829.md @@ -0,0 +1,19 @@ +--- +layout: method +title: operator() +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + "template \nauto operator()(Brgs &&...)": + arguments: + - description: __OPTIONAL__ + name: brgs + type: Brgs &&... + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator()(Brgs &&... brgs)" +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_operator3D.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_operator3D.md new file mode 100644 index 000000000..8141853af --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_operator3D.md @@ -0,0 +1,47 @@ +--- +layout: method +title: operator= +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + task_ & operator=(const task_ &): + annotation: + - deleted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const task_ & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: task_ & operator=(const task_ &) + task_ & operator=(std::nullptr_t): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: std::nullptr_t + unnamed: true + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: task_ & operator=(std::nullptr_t) + task_ & operator=(task_ &&): + arguments: + - description: __OPTIONAL__ + name: x + type: task_ && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: task_ & operator=(task_ && x) + "template \nauto operator=(F &&) -> std::enable_if_t, task_ &>": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator=(F && f) -> std::enable_if_t, task_ &>" +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_swap.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_swap.md new file mode 100644 index 000000000..d8f201109 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_swap.md @@ -0,0 +1,19 @@ +--- +layout: method +title: swap +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + void swap(task_ &): + arguments: + - description: __OPTIONAL__ + name: x + type: task_ & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void swap(task_ & x) +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_target.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_target.md new file mode 100644 index 000000000..b9212db69 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_target.md @@ -0,0 +1,19 @@ +--- +layout: method +title: target +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + "template \nT * target()": + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nT * target()" + "template \nconst T * target() const": + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconst T * target() const" +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_target_type.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_target_type.md new file mode 100644 index 000000000..35ea44d9a --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_target_type.md @@ -0,0 +1,15 @@ +--- +layout: method +title: target_type +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + const std::type_info & target_type() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: const std::type_info & target_type() const +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_task_3CNoExcept2C20R2C20Args3E.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_task_3CNoExcept2C20R2C20Args3E.md new file mode 100644 index 000000000..622040492 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_task_3CNoExcept2C20R2C20Args3E.md @@ -0,0 +1,49 @@ +--- +layout: method +title: task_ +hyde: + owner: __MISSING__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/task.hpp + is_ctor: true + overloads: + task_(): + annotation: + - defaulted + description: __OPTIONAL__ + signature_with_names: task_() + task_(const task_ &): + annotation: + - deleted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const task_ & + unnamed: true + description: __OPTIONAL__ + signature_with_names: task_(const task_ &) + task_(std::nullptr_t): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: std::nullptr_t + unnamed: true + description: __MISSING__ + signature_with_names: task_(std::nullptr_t) + task_(task_ &&): + arguments: + - description: __OPTIONAL__ + name: x + type: task_ && + description: __MISSING__ + signature_with_names: task_(task_ && x) + "template , bool> >\ntask_(F &&)": + arguments: + - description: __OPTIONAL__ + name: f + type: F && + description: __MISSING__ + signature_with_names: "template , bool> >\ntask_(F && f)" +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_~task_3CNoExcept2C20R2C20Args3E.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_~task_3CNoExcept2C20R2C20Args3E.md new file mode 100644 index 000000000..a93451b44 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/m_~task_3CNoExcept2C20R2C20Args3E.md @@ -0,0 +1,15 @@ +--- +layout: method +title: ~task_ +hyde: + owner: __MISSING__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/task.hpp + is_dtor: true + overloads: + ~task_(): + description: __OPTIONAL__ + signature_with_names: ~task_() +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/index.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/index.md new file mode 100644 index 000000000..d6f8134fa --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/index.md @@ -0,0 +1,25 @@ +--- +layout: class +title: model +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/task.hpp + declaration: "\nstruct stlab::task_::model;" + dtor: unspecified + fields: + _invoke: + description: __MISSING__ + type: const stlab::task_::invoke_t + _p: + description: __MISSING__ + type: std::unique_ptr + _vtable: + description: __MISSING__ + type: const stlab::task_::concept_t + namespace: + - stlab + - v1 +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_const_pointer.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_const_pointer.md new file mode 100644 index 000000000..1cd9b7010 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_const_pointer.md @@ -0,0 +1,19 @@ +--- +layout: method +title: const_pointer +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + static auto const_pointer(const void *) -> const void *: + arguments: + - description: __OPTIONAL__ + name: self + type: const void * + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: static auto const_pointer(const void * self) -> const void * +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_dtor.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_dtor.md new file mode 100644 index 000000000..75031da7e --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_dtor.md @@ -0,0 +1,19 @@ +--- +layout: method +title: dtor +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + static void dtor(void *): + arguments: + - description: __OPTIONAL__ + name: self + type: void * + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: static void dtor(void * self) +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_invoke.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_invoke.md new file mode 100644 index 000000000..541df70c5 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_invoke.md @@ -0,0 +1,28 @@ +--- +layout: method +title: invoke +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - "NOTE (sean-parent): `Args` are _not_ universal references. This is a `concrete` interface for the model. Do not add ` & & `, that would make it an rvalue reference. The `forward ` here is correct. We are forwarding from the client defined signature to the actual captured model." + defined_in_file: concurrency/task.hpp + overloads: + static auto invoke(void *, Args...) -> R: + arguments: + - description: __OPTIONAL__ + name: self + type: void * + - description: __OPTIONAL__ + name: args + type: Args... + description: __INLINED__ + inline: + description: + - "NOTE (sean-parent): `Args` are _not_ universal references. This is a `concrete` interface for the model. Do not add ` & & `, that would make it an rvalue reference. The `forward ` here is correct. We are forwarding from the client defined signature to the actual captured model." + return: __OPTIONAL__ + signature_with_names: static auto invoke(void * self, Args... args) -> R +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_model3CF2C20false3E.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_model3CF2C20false3E.md new file mode 100644 index 000000000..1f9148577 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_model3CF2C20false3E.md @@ -0,0 +1,29 @@ +--- +layout: method +title: model +hyde: + owner: __MISSING__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/task.hpp + is_ctor: true + overloads: + model(model &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: model && + unnamed: true + description: __OPTIONAL__ + signature_with_names: model(model &&) + "template \nmodel(G &&)": + arguments: + - description: __OPTIONAL__ + name: f + type: G && + description: __MISSING__ + signature_with_names: "template \nmodel(G && f)" +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_move_ctor.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_move_ctor.md new file mode 100644 index 000000000..c34742a4c --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_move_ctor.md @@ -0,0 +1,22 @@ +--- +layout: method +title: move_ctor +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + static void move_ctor(void *, void *): + arguments: + - description: __OPTIONAL__ + name: self + type: void * + - description: __OPTIONAL__ + name: p + type: void * + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: static void move_ctor(void * self, void * p) +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_pointer.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_pointer.md new file mode 100644 index 000000000..7ee89d439 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_pointer.md @@ -0,0 +1,19 @@ +--- +layout: method +title: pointer +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + static auto pointer(void *) -> void *: + arguments: + - description: __OPTIONAL__ + name: self + type: void * + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: static auto pointer(void * self) -> void * +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_target_type.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_target_type.md new file mode 100644 index 000000000..cab823b6f --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20false3E/m_target_type.md @@ -0,0 +1,15 @@ +--- +layout: method +title: target_type +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + static auto target_type() -> const std::type_info &: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: static auto target_type() -> const std::type_info & +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/index.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/index.md new file mode 100644 index 000000000..f033960f7 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/index.md @@ -0,0 +1,25 @@ +--- +layout: class +title: model +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/task.hpp + declaration: "\nstruct stlab::task_::model;" + dtor: unspecified + fields: + _f: + description: __MISSING__ + type: F + _invoke: + description: __MISSING__ + type: const stlab::task_::invoke_t + _vtable: + description: __MISSING__ + type: const stlab::task_::concept_t + namespace: + - stlab + - v1 +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_const_pointer.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_const_pointer.md new file mode 100644 index 000000000..1cd9b7010 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_const_pointer.md @@ -0,0 +1,19 @@ +--- +layout: method +title: const_pointer +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + static auto const_pointer(const void *) -> const void *: + arguments: + - description: __OPTIONAL__ + name: self + type: const void * + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: static auto const_pointer(const void * self) -> const void * +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_dtor.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_dtor.md new file mode 100644 index 000000000..75031da7e --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_dtor.md @@ -0,0 +1,19 @@ +--- +layout: method +title: dtor +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + static void dtor(void *): + arguments: + - description: __OPTIONAL__ + name: self + type: void * + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: static void dtor(void * self) +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_invoke.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_invoke.md new file mode 100644 index 000000000..541df70c5 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_invoke.md @@ -0,0 +1,28 @@ +--- +layout: method +title: invoke +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - "NOTE (sean-parent): `Args` are _not_ universal references. This is a `concrete` interface for the model. Do not add ` & & `, that would make it an rvalue reference. The `forward ` here is correct. We are forwarding from the client defined signature to the actual captured model." + defined_in_file: concurrency/task.hpp + overloads: + static auto invoke(void *, Args...) -> R: + arguments: + - description: __OPTIONAL__ + name: self + type: void * + - description: __OPTIONAL__ + name: args + type: Args... + description: __INLINED__ + inline: + description: + - "NOTE (sean-parent): `Args` are _not_ universal references. This is a `concrete` interface for the model. Do not add ` & & `, that would make it an rvalue reference. The `forward ` here is correct. We are forwarding from the client defined signature to the actual captured model." + return: __OPTIONAL__ + signature_with_names: static auto invoke(void * self, Args... args) -> R +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_model3CF2C20true3E.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_model3CF2C20true3E.md new file mode 100644 index 000000000..6af76a109 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_model3CF2C20true3E.md @@ -0,0 +1,29 @@ +--- +layout: method +title: model +hyde: + owner: __MISSING__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/task.hpp + is_ctor: true + overloads: + model(model &&): + annotation: + - deleted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: model && + unnamed: true + description: __OPTIONAL__ + signature_with_names: model(model &&) + "template \nmodel(G &&)": + arguments: + - description: __OPTIONAL__ + name: f + type: G && + description: __MISSING__ + signature_with_names: "template \nmodel(G && f)" +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_move_ctor.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_move_ctor.md new file mode 100644 index 000000000..c34742a4c --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_move_ctor.md @@ -0,0 +1,22 @@ +--- +layout: method +title: move_ctor +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + static void move_ctor(void *, void *): + arguments: + - description: __OPTIONAL__ + name: self + type: void * + - description: __OPTIONAL__ + name: p + type: void * + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: static void move_ctor(void * self, void * p) +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_pointer.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_pointer.md new file mode 100644 index 000000000..7ee89d439 --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_pointer.md @@ -0,0 +1,19 @@ +--- +layout: method +title: pointer +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + static auto pointer(void *) -> void *: + arguments: + - description: __OPTIONAL__ + name: self + type: void * + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: static auto pointer(void * self) -> void * +--- diff --git a/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_target_type.md b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_target_type.md new file mode 100644 index 000000000..cab823b6f --- /dev/null +++ b/docs/libraries/concurrency/task.hpp/task_3CNoExcept2C20R2C20Args3E/model3CF2C20true3E/m_target_type.md @@ -0,0 +1,15 @@ +--- +layout: method +title: target_type +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: concurrency/task.hpp + overloads: + static auto target_type() -> const std::type_info &: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: static auto target_type() -> const std::type_info & +--- diff --git a/docs/libraries/concurrency/traits.hpp/detector3CDefault2C202C.c8fba2e1/index.md b/docs/libraries/concurrency/traits.hpp/detector3CDefault2C202C.c8fba2e1/index.md index e9a73667b..8bea9252f 100644 --- a/docs/libraries/concurrency/traits.hpp/detector3CDefault2C202C.c8fba2e1/index.md +++ b/docs/libraries/concurrency/traits.hpp/detector3CDefault2C202C.c8fba2e1/index.md @@ -1,22 +1,26 @@ --- layout: class title: detector -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/traits.hpp -declaration: "template class Op, class... Args>\nstruct stlab::detector;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: Default - description: __MISSING__ - value_t: - definition: std::false_type - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "primary template handles all types not supporting the archetypal Op:" + defined_in_file: concurrency/traits.hpp + declaration: "template class Op, class... Args>\nstruct stlab::detector;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: Default + description: __MISSING__ + value_t: + definition: std::false_type + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/traits.hpp/detector3CDefault2C20vo.a25dd5ae/index.md b/docs/libraries/concurrency/traits.hpp/detector3CDefault2C20vo.a25dd5ae/index.md index a5c786266..339d4986f 100644 --- a/docs/libraries/concurrency/traits.hpp/detector3CDefault2C20vo.a25dd5ae/index.md +++ b/docs/libraries/concurrency/traits.hpp/detector3CDefault2C20vo.a25dd5ae/index.md @@ -1,22 +1,26 @@ --- layout: class title: detector>, Op, Args...> -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/traits.hpp -declaration: "\nstruct stlab::detector;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: Op - description: __MISSING__ - value_t: - definition: std::true_type - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "the specialization recognizes and handles only types supporting Op:" + defined_in_file: concurrency/traits.hpp + declaration: "\nstruct stlab::detector;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: Op + description: __MISSING__ + value_t: + definition: std::true_type + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/traits.hpp/index.md b/docs/libraries/concurrency/traits.hpp/index.md index ff9e56553..01aea8edc 100644 --- a/docs/libraries/concurrency/traits.hpp/index.md +++ b/docs/libraries/concurrency/traits.hpp/index.md @@ -1,31 +1,35 @@ --- layout: library title: concurrency/traits.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile -typedefs: - all_true: - definition: std::is_same, bool_pack> - description: __MISSING__ - detected_t: - definition: typename detector::type - description: __MISSING__ - enable_if_copyable: - definition: std::enable_if_t> - description: __MISSING__ - enable_if_not_copyable: - definition: std::enable_if_t> - description: __MISSING__ - is_detected: - definition: typename detector::value_t - description: __MISSING__ - smart_is_copy_constructible: - definition: smart_test - description: __MISSING__ - void_t: - definition: void - description: __MISSING__ +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile + typedefs: + all_true: + definition: std::is_same, bool_pack> + description: __MISSING__ + detected_t: + definition: typename detector::type + description: __MISSING__ + enable_if_copyable: + definition: std::enable_if_t> + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + enable_if_not_copyable: + definition: std::enable_if_t> + description: __MISSING__ + is_detected: + definition: typename detector::value_t + description: __MISSING__ + smart_is_copy_constructible: + definition: smart_test + description: __MISSING__ + void_t: + definition: void + description: __MISSING__ --- diff --git a/docs/libraries/concurrency/traits.hpp/nonesuch/index.md b/docs/libraries/concurrency/traits.hpp/nonesuch/index.md index 77ed2a4c2..d24ee3ac7 100644 --- a/docs/libraries/concurrency/traits.hpp/nonesuch/index.md +++ b/docs/libraries/concurrency/traits.hpp/nonesuch/index.md @@ -1,13 +1,14 @@ --- layout: class title: nonesuch -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/traits.hpp -declaration: "\nstruct stlab::nonesuch;" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: concurrency/traits.hpp + declaration: "\nstruct stlab::nonesuch;" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/traits.hpp/nonesuch/m_nonesuch.md b/docs/libraries/concurrency/traits.hpp/nonesuch/m_nonesuch.md index d8d289433..64ac2f8ba 100644 --- a/docs/libraries/concurrency/traits.hpp/nonesuch/m_nonesuch.md +++ b/docs/libraries/concurrency/traits.hpp/nonesuch/m_nonesuch.md @@ -1,28 +1,27 @@ --- layout: method title: nonesuch -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/traits.hpp -is_ctor: true -overloads: - nonesuch(): - annotation: - - delete - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: nonesuch() - nonesuch(const stlab::nonesuch &): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::nonesuch & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: nonesuch(const stlab::nonesuch &) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/traits.hpp + is_ctor: true + overloads: + nonesuch(): + annotation: + - deleted + description: __OPTIONAL__ + signature_with_names: nonesuch() + nonesuch(const stlab::nonesuch &): + annotation: + - deleted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::nonesuch & + unnamed: true + description: __OPTIONAL__ + signature_with_names: nonesuch(const stlab::nonesuch &) --- diff --git a/docs/libraries/concurrency/traits.hpp/nonesuch/m_operator3D.md b/docs/libraries/concurrency/traits.hpp/nonesuch/m_operator3D.md index ba075da23..08690a1c6 100644 --- a/docs/libraries/concurrency/traits.hpp/nonesuch/m_operator3D.md +++ b/docs/libraries/concurrency/traits.hpp/nonesuch/m_operator3D.md @@ -1,21 +1,22 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/traits.hpp -overloads: - void operator=(const stlab::nonesuch &): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::nonesuch & - unnamed: true - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void operator=(const stlab::nonesuch &) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/traits.hpp + overloads: + void operator=(const stlab::nonesuch &): + annotation: + - deleted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::nonesuch & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void operator=(const stlab::nonesuch &) --- diff --git a/docs/libraries/concurrency/traits.hpp/nonesuch/m_~nonesuch.md b/docs/libraries/concurrency/traits.hpp/nonesuch/m_~nonesuch.md index e7532c36f..3b2f7dd0f 100644 --- a/docs/libraries/concurrency/traits.hpp/nonesuch/m_~nonesuch.md +++ b/docs/libraries/concurrency/traits.hpp/nonesuch/m_~nonesuch.md @@ -1,17 +1,17 @@ --- layout: method title: ~nonesuch -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: concurrency/traits.hpp -is_dtor: true -overloads: - ~nonesuch(): - annotation: - - delete - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~nonesuch() +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: concurrency/traits.hpp + is_dtor: true + overloads: + ~nonesuch(): + annotation: + - deleted + description: __OPTIONAL__ + signature_with_names: ~nonesuch() --- diff --git a/docs/libraries/concurrency/traits.hpp/smart_test3Ctest2C20T3E/index.md b/docs/libraries/concurrency/traits.hpp/smart_test3Ctest2C20T3E/index.md index ecd82a464..f4ae1fd69 100644 --- a/docs/libraries/concurrency/traits.hpp/smart_test3Ctest2C20T3E/index.md +++ b/docs/libraries/concurrency/traits.hpp/smart_test3Ctest2C20T3E/index.md @@ -1,15 +1,19 @@ --- layout: class title: smart_test -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: concurrency/traits.hpp -declaration: "template class test, typename T>\nstruct stlab::smart_test;" -ctor: unspecified -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: concurrency/traits.hpp + declaration: "template class test, typename T>\nstruct stlab::smart_test;" + ctor: unspecified + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/tuple_algorithm.hpp/f_get_i.md b/docs/libraries/concurrency/tuple_algorithm.hpp/f_get_i.md index e292bbd95..16915de30 100644 --- a/docs/libraries/concurrency/tuple_algorithm.hpp/f_get_i.md +++ b/docs/libraries/concurrency/tuple_algorithm.hpp/f_get_i.md @@ -1,30 +1,37 @@ --- layout: function title: get_i -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/tuple_algorithm.hpp -overloads: - "template \nauto get_i(T &, std::size_t, F, D &&)": - arguments: - - description: __OPTIONAL__ - name: t - type: T & - - description: __OPTIONAL__ - name: index - type: std::size_t - - description: __OPTIONAL__ - name: f - type: F - - description: __OPTIONAL__ - name: default_v - type: D && - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto get_i(T & t, std::size_t index, F f, D && default_v)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - Gets from the tuple element at position index the value by applying the given predicate The default value is returned, if the index is equal or greater to tuple_size + defined_in_file: concurrency/tuple_algorithm.hpp + overloads: + "template \nauto get_i(T &, std::size_t, F, D &&)": + arguments: + - description: __OPTIONAL__ + name: t + type: T & + - description: __OPTIONAL__ + name: index + type: std::size_t + - description: __OPTIONAL__ + name: f + type: F + - description: __OPTIONAL__ + name: default_v + type: D && + description: __INLINED__ + inline: + description: + - Gets from the tuple element at position index the value by applying the given predicate The default value is returned, if the index is equal or greater to tuple_size + return: __OPTIONAL__ + signature_with_names: "template \nauto get_i(T & t, std::size_t index, F f, D && default_v)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/tuple_algorithm.hpp/f_tuple_find.md b/docs/libraries/concurrency/tuple_algorithm.hpp/f_tuple_find.md index f99fa22f7..534bc4f61 100644 --- a/docs/libraries/concurrency/tuple_algorithm.hpp/f_tuple_find.md +++ b/docs/libraries/concurrency/tuple_algorithm.hpp/f_tuple_find.md @@ -1,24 +1,33 @@ --- layout: function title: tuple_find -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/tuple_algorithm.hpp -overloads: - "template \nstd::size_t tuple_find(const T &, Op)": - arguments: - - description: __OPTIONAL__ - name: t - type: const T & - - description: __OPTIONAL__ - name: op - type: Op - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nstd::size_t tuple_find(const T & t, Op op)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + - Finds in a tuple an element that satisfies the given predicate and returns the tuple index. It returns an index beyond the last element if no element satisfies the predicate. + defined_in_file: concurrency/tuple_algorithm.hpp + overloads: + "template \nstd::size_t tuple_find(const T &, Op)": + arguments: + - description: __OPTIONAL__ + name: t + type: const T & + - description: __OPTIONAL__ + name: op + type: Op + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + - Finds in a tuple an element that satisfies the given predicate and returns the tuple index. It returns an index beyond the last element if no element satisfies the predicate. + return: __OPTIONAL__ + signature_with_names: "template \nstd::size_t tuple_find(const T & t, Op op)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/tuple_algorithm.hpp/f_tuple_for_each.md b/docs/libraries/concurrency/tuple_algorithm.hpp/f_tuple_for_each.md index 0f6c15db9..c142057cf 100644 --- a/docs/libraries/concurrency/tuple_algorithm.hpp/f_tuple_for_each.md +++ b/docs/libraries/concurrency/tuple_algorithm.hpp/f_tuple_for_each.md @@ -1,24 +1,31 @@ --- layout: function title: tuple_for_each -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/tuple_algorithm.hpp -overloads: - "template \nvoid tuple_for_each(T &, Op)": - arguments: - - description: __OPTIONAL__ - name: t - type: T & - - description: __OPTIONAL__ - name: op - type: Op - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid tuple_for_each(T & t, Op op)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - Applies the given predicate on all tuple elements + defined_in_file: concurrency/tuple_algorithm.hpp + overloads: + "template \nvoid tuple_for_each(T &, Op)": + arguments: + - description: __OPTIONAL__ + name: t + type: T & + - description: __OPTIONAL__ + name: op + type: Op + description: __INLINED__ + inline: + description: + - Applies the given predicate on all tuple elements + return: __OPTIONAL__ + signature_with_names: "template \nvoid tuple_for_each(T & t, Op op)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/tuple_algorithm.hpp/f_void_i.md b/docs/libraries/concurrency/tuple_algorithm.hpp/f_void_i.md index 8aa05c9eb..25d8276ad 100644 --- a/docs/libraries/concurrency/tuple_algorithm.hpp/f_void_i.md +++ b/docs/libraries/concurrency/tuple_algorithm.hpp/f_void_i.md @@ -1,27 +1,34 @@ --- layout: function title: void_i -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: concurrency/tuple_algorithm.hpp -overloads: - "template \nauto void_i(T &, std::size_t, F &&)": - arguments: - - description: __OPTIONAL__ - name: t - type: T & - - description: __OPTIONAL__ - name: index - type: std::size_t - - description: __OPTIONAL__ - name: f - type: F && - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto void_i(T & t, std::size_t index, F && f)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - Applies at the tuple element at position index the the given predicate + defined_in_file: concurrency/tuple_algorithm.hpp + overloads: + "template \nauto void_i(T &, std::size_t, F &&)": + arguments: + - description: __OPTIONAL__ + name: t + type: T & + - description: __OPTIONAL__ + name: index + type: std::size_t + - description: __OPTIONAL__ + name: f + type: F && + description: __INLINED__ + inline: + description: + - Applies at the tuple element at position index the the given predicate + return: __OPTIONAL__ + signature_with_names: "template \nauto void_i(T & t, std::size_t index, F && f)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/concurrency/tuple_algorithm.hpp/index.md b/docs/libraries/concurrency/tuple_algorithm.hpp/index.md index dd1bd621d..a5d303ed6 100644 --- a/docs/libraries/concurrency/tuple_algorithm.hpp/index.md +++ b/docs/libraries/concurrency/tuple_algorithm.hpp/index.md @@ -1,22 +1,39 @@ --- layout: library title: concurrency/tuple_algorithm.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile -typedefs: - optional_placeholder_tuple: - definition: std::tuple::value, detail::placeholder, Ts>::type>...> - description: __MISSING__ - placeholder_tuple: - definition: std::tuple::value, detail::placeholder, Ts>::type...> - description: __MISSING__ - tuple_cat_t: - definition: decltype(std::tuple_cat(std::declval()...)) - description: __MISSING__ - voidless_tuple: - definition: tuple_cat_t::value, std::tuple<>, std::tuple>::type...> - description: __MISSING__ +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile + typedefs: + optional_placeholder_tuple: + definition: std::tuple::value, detail::placeholder, Ts>::type>...> + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + - type-function that takes a parameter pack and returns a std::tuple where all T[i] = void have been replaced with stlab::placeholder. + placeholder_tuple: + definition: std::tuple::value, detail::placeholder, Ts>::type...> + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + - type-function that takes a parameter pack and returns a std::tuple where all T[i] = void have been replaced with stlab::placeholder. + tuple_cat_t: + definition: decltype(std::tuple_cat(std::declval()...)) + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + - type-function variant of std::tuple_cat + voidless_tuple: + definition: tuple_cat_t::value, std::tuple<>, std::tuple>::type...> + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + - type-function that takes a parameter pack and returns a std::tuple where all T[i] = void have been removed. --- diff --git a/docs/libraries/concurrency/utility.hpp/index.md b/docs/libraries/concurrency/utility.hpp/index.md index a468e9422..38279b61d 100644 --- a/docs/libraries/concurrency/utility.hpp/index.md +++ b/docs/libraries/concurrency/utility.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: concurrency/utility.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator213D.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator213D.md index 4cf8c08b4..32d116eeb 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator213D.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator213D.md @@ -1,45 +1,46 @@ --- layout: function title: operator!= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: copy_on_write.hpp -overloads: - bool operator!=(const copy_on_write &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const copy_on_write & x, const copy_on_write & y) - bool operator!=(const copy_on_write &, const stlab::copy_on_write::element_type &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const stlab::copy_on_write::element_type & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const copy_on_write & x, const stlab::copy_on_write::element_type & y) - bool operator!=(const stlab::copy_on_write::element_type &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::copy_on_write::element_type & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const stlab::copy_on_write::element_type & x, const copy_on_write & y) -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: copy_on_write.hpp + overloads: + bool operator!=(const copy_on_write &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const copy_on_write & x, const copy_on_write & y) + bool operator!=(const copy_on_write &, const stlab::copy_on_write::element_type &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const stlab::copy_on_write::element_type & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const copy_on_write & x, const stlab::copy_on_write::element_type & y) + bool operator!=(const stlab::copy_on_write::element_type &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::copy_on_write::element_type & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const stlab::copy_on_write::element_type & x, const copy_on_write & y) + namespace: + - stlab --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3C.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3C.md index bee637f98..70ced88d3 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3C.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3C.md @@ -1,45 +1,46 @@ --- layout: function title: operator< -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: copy_on_write.hpp -overloads: - bool operator<(const copy_on_write &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator<(const copy_on_write & x, const copy_on_write & y) - bool operator<(const copy_on_write &, const stlab::copy_on_write::element_type &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const stlab::copy_on_write::element_type & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator<(const copy_on_write & x, const stlab::copy_on_write::element_type & y) - bool operator<(const stlab::copy_on_write::element_type &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::copy_on_write::element_type & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator<(const stlab::copy_on_write::element_type & x, const copy_on_write & y) -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: copy_on_write.hpp + overloads: + bool operator<(const copy_on_write &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator<(const copy_on_write & x, const copy_on_write & y) + bool operator<(const copy_on_write &, const stlab::copy_on_write::element_type &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const stlab::copy_on_write::element_type & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator<(const copy_on_write & x, const stlab::copy_on_write::element_type & y) + bool operator<(const stlab::copy_on_write::element_type &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::copy_on_write::element_type & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator<(const stlab::copy_on_write::element_type & x, const copy_on_write & y) + namespace: + - stlab --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3C3D.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3C3D.md index 06d022eb9..1c12858d5 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3C3D.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3C3D.md @@ -1,45 +1,46 @@ --- layout: function title: operator<= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: copy_on_write.hpp -overloads: - bool operator<=(const copy_on_write &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator<=(const copy_on_write & x, const copy_on_write & y) - bool operator<=(const copy_on_write &, const stlab::copy_on_write::element_type &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const stlab::copy_on_write::element_type & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator<=(const copy_on_write & x, const stlab::copy_on_write::element_type & y) - bool operator<=(const stlab::copy_on_write::element_type &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::copy_on_write::element_type & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator<=(const stlab::copy_on_write::element_type & x, const copy_on_write & y) -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: copy_on_write.hpp + overloads: + bool operator<=(const copy_on_write &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator<=(const copy_on_write & x, const copy_on_write & y) + bool operator<=(const copy_on_write &, const stlab::copy_on_write::element_type &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const stlab::copy_on_write::element_type & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator<=(const copy_on_write & x, const stlab::copy_on_write::element_type & y) + bool operator<=(const stlab::copy_on_write::element_type &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::copy_on_write::element_type & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator<=(const stlab::copy_on_write::element_type & x, const copy_on_write & y) + namespace: + - stlab --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3D3D.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3D3D.md index 638d86d84..fc4358cf4 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3D3D.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3D3D.md @@ -1,45 +1,46 @@ --- layout: function title: operator== -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: copy_on_write.hpp -overloads: - bool operator==(const copy_on_write &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const copy_on_write & x, const copy_on_write & y) - bool operator==(const copy_on_write &, const stlab::copy_on_write::element_type &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const stlab::copy_on_write::element_type & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const copy_on_write & x, const stlab::copy_on_write::element_type & y) - bool operator==(const stlab::copy_on_write::element_type &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::copy_on_write::element_type & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const stlab::copy_on_write::element_type & x, const copy_on_write & y) -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: copy_on_write.hpp + overloads: + bool operator==(const copy_on_write &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const copy_on_write & x, const copy_on_write & y) + bool operator==(const copy_on_write &, const stlab::copy_on_write::element_type &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const stlab::copy_on_write::element_type & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const copy_on_write & x, const stlab::copy_on_write::element_type & y) + bool operator==(const stlab::copy_on_write::element_type &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::copy_on_write::element_type & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const stlab::copy_on_write::element_type & x, const copy_on_write & y) + namespace: + - stlab --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3E.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3E.md index c00e8442e..da76e3c33 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3E.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3E.md @@ -1,45 +1,46 @@ --- layout: function title: operator> -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: copy_on_write.hpp -overloads: - bool operator>(const copy_on_write &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator>(const copy_on_write & x, const copy_on_write & y) - bool operator>(const copy_on_write &, const stlab::copy_on_write::element_type &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const stlab::copy_on_write::element_type & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator>(const copy_on_write & x, const stlab::copy_on_write::element_type & y) - bool operator>(const stlab::copy_on_write::element_type &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::copy_on_write::element_type & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator>(const stlab::copy_on_write::element_type & x, const copy_on_write & y) -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: copy_on_write.hpp + overloads: + bool operator>(const copy_on_write &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator>(const copy_on_write & x, const copy_on_write & y) + bool operator>(const copy_on_write &, const stlab::copy_on_write::element_type &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const stlab::copy_on_write::element_type & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator>(const copy_on_write & x, const stlab::copy_on_write::element_type & y) + bool operator>(const stlab::copy_on_write::element_type &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::copy_on_write::element_type & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator>(const stlab::copy_on_write::element_type & x, const copy_on_write & y) + namespace: + - stlab --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3E3D.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3E3D.md index c6f8fc77b..51da2d476 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3E3D.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_operator3E3D.md @@ -1,45 +1,46 @@ --- layout: function title: operator>= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: copy_on_write.hpp -overloads: - bool operator>=(const copy_on_write &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator>=(const copy_on_write & x, const copy_on_write & y) - bool operator>=(const copy_on_write &, const stlab::copy_on_write::element_type &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - - description: __OPTIONAL__ - name: y - type: const stlab::copy_on_write::element_type & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator>=(const copy_on_write & x, const stlab::copy_on_write::element_type & y) - bool operator>=(const stlab::copy_on_write::element_type &, const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::copy_on_write::element_type & - - description: __OPTIONAL__ - name: y - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator>=(const stlab::copy_on_write::element_type & x, const copy_on_write & y) -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: copy_on_write.hpp + overloads: + bool operator>=(const copy_on_write &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator>=(const copy_on_write & x, const copy_on_write & y) + bool operator>=(const copy_on_write &, const stlab::copy_on_write::element_type &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + - description: __OPTIONAL__ + name: y + type: const stlab::copy_on_write::element_type & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator>=(const copy_on_write & x, const stlab::copy_on_write::element_type & y) + bool operator>=(const stlab::copy_on_write::element_type &, const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::copy_on_write::element_type & + - description: __OPTIONAL__ + name: y + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator>=(const stlab::copy_on_write::element_type & x, const copy_on_write & y) + namespace: + - stlab --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_swap.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_swap.md index f91c85dd7..4d9168131 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_swap.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/f_swap.md @@ -1,23 +1,24 @@ --- layout: function title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: copy_on_write.hpp -overloads: - void swap(copy_on_write &, copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: copy_on_write & - - description: __OPTIONAL__ - name: y - type: copy_on_write & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void swap(copy_on_write & x, copy_on_write & y) -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: copy_on_write.hpp + overloads: + void swap(copy_on_write &, copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: copy_on_write & + - description: __OPTIONAL__ + name: y + type: copy_on_write & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void swap(copy_on_write & x, copy_on_write & y) + namespace: + - stlab --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/index.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/index.md index a7d59e0d1..5994215fc 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/index.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/index.md @@ -1,25 +1,32 @@ --- layout: class title: copy_on_write -owner: sean-parent -brief: A copy-on-write wrapper for any type that models `RegularType` -tags: - - class -defined_in_file: copy_on_write.hpp -declaration: "template \nclass stlab::copy_on_write;" -typedefs: - element_type: - definition: T - description: The type of value stored - value_type: - definition: T - description: The type of value stored -fields: - default_s: - description: Shared, empty model instance - type: stlab::copy_on_write::model -namespace: - - stlab +hyde: + owner: sean-parent + brief: A copy-on-write wrapper for any type that models `RegularType` + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: copy_on_write.hpp + declaration: "template \nclass stlab::copy_on_write;" + typedefs: + element_type: + definition: T + description: The type of value stored + value_type: + definition: T + description: The type of value stored + inline: + description: + - "[[deprecated]]" + fields: + default_s: + description: Shared, empty model instance + type: stlab::copy_on_write::model + namespace: + - stlab --- Copy-on-write semantics allow for an object to be lazily copied - only creating a copy when 1) the value is modified, and 2) there is more than one reference to the value. diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_copy_on_write3CT3E.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_copy_on_write3CT3E.md index d091b7f59..fe5dcb151 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_copy_on_write3CT3E.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_copy_on_write3CT3E.md @@ -1,57 +1,53 @@ --- layout: method title: copy_on_write -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: copy_on_write.hpp -is_ctor: true -overloads: - copy_on_write(): - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: copy_on_write() - copy_on_write(const copy_on_write &): - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: copy_on_write(const copy_on_write & x) - copy_on_write(copy_on_write &&): - arguments: - - description: __OPTIONAL__ - name: x - type: copy_on_write && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: copy_on_write(copy_on_write && x) - "template \ncopy_on_write(U &&, V &&, Args &&...)": - arguments: - - description: __OPTIONAL__ - name: x - type: U && - - description: __OPTIONAL__ - name: y - type: V && - - description: __OPTIONAL__ - name: args - type: Args &&... - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ncopy_on_write(U && x, V && y, Args &&... args)" - "template \ncopy_on_write(U &&, disable_copy)": - arguments: - - description: __OPTIONAL__ - name: x - type: U && - - description: __OPTIONAL__ - name: unnamed-1 - type: disable_copy - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \ncopy_on_write(U && x, disable_copy)" +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: copy_on_write.hpp + is_ctor: true + overloads: + copy_on_write(): + description: __MISSING__ + signature_with_names: copy_on_write() + copy_on_write(const copy_on_write &): + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + description: __MISSING__ + signature_with_names: copy_on_write(const copy_on_write & x) + copy_on_write(copy_on_write &&): + arguments: + - description: __OPTIONAL__ + name: x + type: copy_on_write && + description: __MISSING__ + signature_with_names: copy_on_write(copy_on_write && x) + "template \ncopy_on_write(U &&, V &&, Args &&...)": + arguments: + - description: __OPTIONAL__ + name: x + type: U && + - description: __OPTIONAL__ + name: y + type: V && + - description: __OPTIONAL__ + name: args + type: Args &&... + description: __MISSING__ + signature_with_names: "template \ncopy_on_write(U && x, V && y, Args &&... args)" + "template \ncopy_on_write(U &&, disable_copy)": + arguments: + - description: __OPTIONAL__ + name: x + type: U && + - description: __OPTIONAL__ + name: unnamed-1 + type: disable_copy + unnamed: true + description: __MISSING__ + signature_with_names: "template \ncopy_on_write(U && x, disable_copy)" --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_identity.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_identity.md index c9c7e1ef0..41c49881a 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_identity.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_identity.md @@ -1,18 +1,19 @@ --- layout: method title: identity -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: copy_on_write.hpp -overloads: - bool identity(const copy_on_write &) const: - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool identity(const copy_on_write & x) const +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: copy_on_write.hpp + overloads: + bool identity(const copy_on_write &) const: + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool identity(const copy_on_write & x) const --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator-3E.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator-3E.md index e4525bbe2..1befb0520 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator-3E.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator-3E.md @@ -1,16 +1,17 @@ --- layout: method title: operator-> -owner: sean-parent -brief: Obtain a `const` pointer to the underlying object -tags: - - method -defined_in_file: copy_on_write.hpp -overloads: - auto operator->() const -> const stlab::copy_on_write::element_type *: - description: Singular variant - return: A const pointer to the underlying element - signature_with_names: auto operator->() const -> const stlab::copy_on_write::element_type * +hyde: + owner: sean-parent + brief: Obtain a `const` pointer to the underlying object + tags: + - method + defined_in_file: copy_on_write.hpp + overloads: + auto operator->() const -> const stlab::copy_on_write::element_type *: + description: Singular variant + return: A const pointer to the underlying element + signature_with_names: auto operator->() const -> const stlab::copy_on_write::element_type * --- This is provided because you cannot override `operator.()`. It allows `copy_on_write` to be used with common transformation techniques, such as boost's `indirect_iterator` and `transform_iterator`. diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator20const20element_type2026.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator20const20element_type2026.md index f31b25069..5f0f87445 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator20const20element_type2026.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator20const20element_type2026.md @@ -1,14 +1,15 @@ --- layout: method title: operator const element_type & -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: copy_on_write.hpp -overloads: - operator const stlab::copy_on_write::element_type &() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: operator const stlab::copy_on_write::element_type &() const +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: copy_on_write.hpp + overloads: + operator const stlab::copy_on_write::element_type &() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: operator const stlab::copy_on_write::element_type &() const --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator2A.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator2A.md index 11ab903bf..5200f8bee 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator2A.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator2A.md @@ -1,16 +1,17 @@ --- layout: method title: operator* -owner: sean-parent -brief: Dereference operator -tags: - - method -defined_in_file: copy_on_write.hpp -overloads: - auto operator*() const -> const stlab::copy_on_write::element_type &: - description: Singular variant - return: A const reference to the element type - signature_with_names: auto operator*() const -> const stlab::copy_on_write::element_type & +hyde: + owner: sean-parent + brief: Dereference operator + tags: + - method + defined_in_file: copy_on_write.hpp + overloads: + auto operator*() const -> const stlab::copy_on_write::element_type &: + description: Singular variant + return: A const reference to the element type + signature_with_names: auto operator*() const -> const stlab::copy_on_write::element_type & --- This is provided because you cannot override `operator.()`. It allows `copy_on_write` to be used with common transformation techniques, such as boost's `indirect_iterator` and `transform_iterator`. diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator3D.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator3D.md index 606590c67..4e9e7b303 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator3D.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_operator3D.md @@ -1,34 +1,35 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: copy_on_write.hpp -overloads: - auto operator=(const copy_on_write &) -> copy_on_write &: - arguments: - - description: __OPTIONAL__ - name: x - type: const copy_on_write & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: auto operator=(const copy_on_write & x) -> copy_on_write & - auto operator=(copy_on_write &&) -> copy_on_write &: - arguments: - - description: __OPTIONAL__ - name: x - type: copy_on_write && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: auto operator=(copy_on_write && x) -> copy_on_write & - "template \nauto operator=(U &&) -> disable_copy_assign": - arguments: - - description: __OPTIONAL__ - name: x - type: U && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto operator=(U && x) -> disable_copy_assign" +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: copy_on_write.hpp + overloads: + auto operator=(const copy_on_write &) -> copy_on_write &: + arguments: + - description: __OPTIONAL__ + name: x + type: const copy_on_write & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: auto operator=(const copy_on_write & x) -> copy_on_write & + auto operator=(copy_on_write &&) -> copy_on_write &: + arguments: + - description: __OPTIONAL__ + name: x + type: copy_on_write && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: auto operator=(copy_on_write && x) -> copy_on_write & + "template \nauto operator=(U &&) -> disable_copy_assign": + arguments: + - description: __OPTIONAL__ + name: x + type: U && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto operator=(U && x) -> disable_copy_assign" --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_read.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_read.md index dd735ea99..5ce49b9bf 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_read.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_read.md @@ -1,14 +1,15 @@ --- layout: method title: read -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: copy_on_write.hpp -overloads: - auto read() const -> const stlab::copy_on_write::element_type &: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: auto read() const -> const stlab::copy_on_write::element_type & +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: copy_on_write.hpp + overloads: + auto read() const -> const stlab::copy_on_write::element_type &: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: auto read() const -> const stlab::copy_on_write::element_type & --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_unique.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_unique.md index ef5ed78f1..3748ace06 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_unique.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_unique.md @@ -1,16 +1,17 @@ --- layout: method title: unique -owner: sean-parent -brief: Returns if the object instance reference count is one -tags: - - method -defined_in_file: copy_on_write.hpp -overloads: - bool unique() const: - description: Singular variant - return: "`true` iff the object instance reference count is one. `false` otherwise." - signature_with_names: bool unique() const +hyde: + owner: sean-parent + brief: Returns if the object instance reference count is one + tags: + - method + defined_in_file: copy_on_write.hpp + overloads: + bool unique() const: + description: Singular variant + return: "`true` iff the object instance reference count is one. `false` otherwise." + signature_with_names: bool unique() const --- This is useful to determine if writing will cause a copy. diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_unique_instance.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_unique_instance.md index b9c773f4e..722ec7647 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_unique_instance.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_unique_instance.md @@ -1,16 +1,17 @@ --- layout: method title: unique_instance -owner: sean-parent -brief: Forwarding routine for `unique` -tags: - - method -defined_in_file: copy_on_write.hpp -overloads: - bool unique_instance() const: - annotation: - - deprecated - description: Singular variant - return: "`true` iff the object instance reference count is one. `false` otherwise." - signature_with_names: bool unique_instance() const +hyde: + owner: sean-parent + brief: Forwarding routine for `unique` + tags: + - method + defined_in_file: copy_on_write.hpp + overloads: + bool unique_instance() const: + annotation: + - deprecated + description: Singular variant + return: "`true` iff the object instance reference count is one. `false` otherwise." + signature_with_names: bool unique_instance() const --- diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_write.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_write.md index 937b0622d..588633cef 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_write.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_write.md @@ -1,16 +1,17 @@ --- layout: method title: write -owner: sean-parent -brief: Obtain a non-`const` reference to the underlying value -tags: - - method -defined_in_file: copy_on_write.hpp -overloads: - auto write() -> stlab::copy_on_write::element_type &: - description: Singular variant - return: A reference to the underlying object - signature_with_names: auto write() -> stlab::copy_on_write::element_type & +hyde: + owner: sean-parent + brief: Obtain a non-`const` reference to the underlying value + tags: + - method + defined_in_file: copy_on_write.hpp + overloads: + auto write() -> stlab::copy_on_write::element_type &: + description: Singular variant + return: A reference to the underlying object + signature_with_names: auto write() -> stlab::copy_on_write::element_type & --- Obtain a reference to the value the object is referencing. This will copy the underlying value (if necessary) so changes to the value do not affect other `copy_on_write` objects. diff --git a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_~copy_on_write3CT3E.md b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_~copy_on_write3CT3E.md index 68b8e3f73..9d52a5b9c 100644 --- a/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_~copy_on_write3CT3E.md +++ b/docs/libraries/copy_on_write.hpp/copy_on_write3CT3E/m_~copy_on_write3CT3E.md @@ -1,15 +1,15 @@ --- layout: method title: ~copy_on_write -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: copy_on_write.hpp -is_dtor: true -overloads: - ~copy_on_write(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~copy_on_write() +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: copy_on_write.hpp + is_dtor: true + overloads: + ~copy_on_write(): + description: __OPTIONAL__ + signature_with_names: ~copy_on_write() --- diff --git a/docs/libraries/copy_on_write.hpp/index.md b/docs/libraries/copy_on_write.hpp/index.md index 9f208d316..d439f8982 100644 --- a/docs/libraries/copy_on_write.hpp/index.md +++ b/docs/libraries/copy_on_write.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: copy_on_write.hpp -owner: sean-parent -brief: A copy-on-write wrapper for any type that models `RegularType` -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: sean-parent + brief: A copy-on-write wrapper for any type that models `RegularType` + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/enum_ops.hpp/f_operator--.md b/docs/libraries/enum_ops.hpp/f_operator--.md index 4546dfd4d..8be223461 100644 --- a/docs/libraries/enum_ops.hpp/f_operator--.md +++ b/docs/libraries/enum_ops.hpp/f_operator--.md @@ -1,30 +1,31 @@ --- layout: function title: operator-- -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator--(T &) -> std::enable_if_t, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator--(T & lhs) -> std::enable_if_t, T &>" - "template \nconstexpr auto operator--(T &, int) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: unnamed-1 - type: int - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator--(T & lhs, int) -> std::enable_if_t, T>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator--(T &) -> std::enable_if_t, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator--(T & lhs) -> std::enable_if_t, T &>" + "template \nconstexpr auto operator--(T &, int) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: unnamed-1 + type: int + unnamed: true + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator--(T & lhs, int) -> std::enable_if_t, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator-.md b/docs/libraries/enum_ops.hpp/f_operator-.md index 9a53494a9..7dd4bf503 100644 --- a/docs/libraries/enum_ops.hpp/f_operator-.md +++ b/docs/libraries/enum_ops.hpp/f_operator-.md @@ -1,40 +1,41 @@ --- layout: function title: operator- -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator-(T, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: U - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator-(T lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>" - "template \nconstexpr auto operator-(T) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: a - type: T - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator-(T a) -> std::enable_if_t, T>" - "template \nconstexpr auto operator-(T, T) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: T - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator-(T lhs, T rhs) -> std::enable_if_t, T>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator-(T, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: U + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator-(T lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>" + "template \nconstexpr auto operator-(T) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: a + type: T + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator-(T a) -> std::enable_if_t, T>" + "template \nconstexpr auto operator-(T, T) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: T + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator-(T lhs, T rhs) -> std::enable_if_t, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator-3D.md b/docs/libraries/enum_ops.hpp/f_operator-3D.md index e3b92e2f2..c0b936cb6 100644 --- a/docs/libraries/enum_ops.hpp/f_operator-3D.md +++ b/docs/libraries/enum_ops.hpp/f_operator-3D.md @@ -1,21 +1,22 @@ --- layout: function title: operator-= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator-=(T &, T) -> std::enable_if_t, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: rhs - type: T - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator-=(T & lhs, T rhs) -> std::enable_if_t, T &>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator-=(T &, T) -> std::enable_if_t, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: rhs + type: T + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator-=(T & lhs, T rhs) -> std::enable_if_t, T &>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator21.md b/docs/libraries/enum_ops.hpp/f_operator21.md index 41d884385..11d1f3d98 100644 --- a/docs/libraries/enum_ops.hpp/f_operator21.md +++ b/docs/libraries/enum_ops.hpp/f_operator21.md @@ -1,18 +1,19 @@ --- layout: function title: operator! -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator!(T) -> stlab::implementation::enable_if_bitmask_or_arithmetic": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator!(T lhs) -> stlab::implementation::enable_if_bitmask_or_arithmetic" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator!(T) -> stlab::implementation::enable_if_bitmask_or_arithmetic": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator!(T lhs) -> stlab::implementation::enable_if_bitmask_or_arithmetic" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator213D.md b/docs/libraries/enum_ops.hpp/f_operator213D.md index f039f44eb..76a64c9fc 100644 --- a/docs/libraries/enum_ops.hpp/f_operator213D.md +++ b/docs/libraries/enum_ops.hpp/f_operator213D.md @@ -1,32 +1,33 @@ --- layout: function title: operator!= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator!=(T, std::nullptr_t) -> stlab::implementation::enable_if_bitmask_or_arithmetic": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: std::nullptr_t - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator!=(T lhs, std::nullptr_t rhs) -> stlab::implementation::enable_if_bitmask_or_arithmetic" - "template \nconstexpr auto operator!=(std::nullptr_t, T) -> stlab::implementation::enable_if_bitmask_or_arithmetic": - arguments: - - description: __OPTIONAL__ - name: lhs - type: std::nullptr_t - - description: __OPTIONAL__ - name: rhs - type: T - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator!=(std::nullptr_t lhs, T rhs) -> stlab::implementation::enable_if_bitmask_or_arithmetic" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator!=(T, std::nullptr_t) -> stlab::implementation::enable_if_bitmask_or_arithmetic": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: std::nullptr_t + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator!=(T lhs, std::nullptr_t rhs) -> stlab::implementation::enable_if_bitmask_or_arithmetic" + "template \nconstexpr auto operator!=(std::nullptr_t, T) -> stlab::implementation::enable_if_bitmask_or_arithmetic": + arguments: + - description: __OPTIONAL__ + name: lhs + type: std::nullptr_t + - description: __OPTIONAL__ + name: rhs + type: T + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator!=(std::nullptr_t lhs, T rhs) -> stlab::implementation::enable_if_bitmask_or_arithmetic" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator25.md b/docs/libraries/enum_ops.hpp/f_operator25.md index f3e7d3bdd..73d4d32b6 100644 --- a/docs/libraries/enum_ops.hpp/f_operator25.md +++ b/docs/libraries/enum_ops.hpp/f_operator25.md @@ -1,21 +1,22 @@ --- layout: function title: operator% -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator%(T, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: U - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator%(T lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator%(T, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: U + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator%(T lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator253D.md b/docs/libraries/enum_ops.hpp/f_operator253D.md index 454334295..ad4ac61e2 100644 --- a/docs/libraries/enum_ops.hpp/f_operator253D.md +++ b/docs/libraries/enum_ops.hpp/f_operator253D.md @@ -1,21 +1,22 @@ --- layout: function title: operator%= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator%=(T &, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: rhs - type: U - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator%=(T & lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator%=(T &, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: rhs + type: U + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator%=(T & lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator26.md b/docs/libraries/enum_ops.hpp/f_operator26.md index fc1d7f925..365130ab0 100644 --- a/docs/libraries/enum_ops.hpp/f_operator26.md +++ b/docs/libraries/enum_ops.hpp/f_operator26.md @@ -1,21 +1,28 @@ --- layout: function title: operator& -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator&(T, T) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: T - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator&(T lhs, T rhs) -> std::enable_if_t, T>" +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator&(T, T) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: T + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator&(T lhs, T rhs) -> std::enable_if_t, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator263D.md b/docs/libraries/enum_ops.hpp/f_operator263D.md index 56c1da0c4..ffe8ce278 100644 --- a/docs/libraries/enum_ops.hpp/f_operator263D.md +++ b/docs/libraries/enum_ops.hpp/f_operator263D.md @@ -1,21 +1,22 @@ --- layout: function title: operator&= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator&=(T &, T) -> std::enable_if_t, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: rhs - type: T - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator&=(T & lhs, T rhs) -> std::enable_if_t, T &>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator&=(T &, T) -> std::enable_if_t, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: rhs + type: T + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator&=(T & lhs, T rhs) -> std::enable_if_t, T &>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator2A.md b/docs/libraries/enum_ops.hpp/f_operator2A.md index 258279185..6ae885545 100644 --- a/docs/libraries/enum_ops.hpp/f_operator2A.md +++ b/docs/libraries/enum_ops.hpp/f_operator2A.md @@ -1,32 +1,33 @@ --- layout: function title: operator* -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator*(T, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: U - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator*(T lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>" - "template \nconstexpr auto operator*(U, T) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: U - - description: __OPTIONAL__ - name: rhs - type: T - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator*(U lhs, T rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator*(T, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: U + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator*(T lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>" + "template \nconstexpr auto operator*(U, T) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: U + - description: __OPTIONAL__ + name: rhs + type: T + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator*(U lhs, T rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator2A3D.md b/docs/libraries/enum_ops.hpp/f_operator2A3D.md index f649a2cb0..c4050be75 100644 --- a/docs/libraries/enum_ops.hpp/f_operator2A3D.md +++ b/docs/libraries/enum_ops.hpp/f_operator2A3D.md @@ -1,21 +1,22 @@ --- layout: function title: operator*= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator*=(T &, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: rhs - type: U - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator*=(T & lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator*=(T &, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: rhs + type: U + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator*=(T & lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator2B.md b/docs/libraries/enum_ops.hpp/f_operator2B.md index e94071f58..1b62b697e 100644 --- a/docs/libraries/enum_ops.hpp/f_operator2B.md +++ b/docs/libraries/enum_ops.hpp/f_operator2B.md @@ -1,29 +1,36 @@ --- layout: function title: operator+ -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator+(T) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: a - type: T - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator+(T a) -> std::enable_if_t, T>" - "template \nconstexpr auto operator+(T, T) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: T - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator+(T lhs, T rhs) -> std::enable_if_t, T>" +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator+(T) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: a + type: T + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator+(T a) -> std::enable_if_t, T>" + "template \nconstexpr auto operator+(T, T) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: T + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator+(T lhs, T rhs) -> std::enable_if_t, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator2B2B.md b/docs/libraries/enum_ops.hpp/f_operator2B2B.md index 167c6a142..7aeba165c 100644 --- a/docs/libraries/enum_ops.hpp/f_operator2B2B.md +++ b/docs/libraries/enum_ops.hpp/f_operator2B2B.md @@ -1,30 +1,31 @@ --- layout: function title: operator++ -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator++(T &) -> std::enable_if_t, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator++(T & lhs) -> std::enable_if_t, T &>" - "template \nconstexpr auto operator++(T &, int) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: unnamed-1 - type: int - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator++(T & lhs, int) -> std::enable_if_t, T>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator++(T &) -> std::enable_if_t, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator++(T & lhs) -> std::enable_if_t, T &>" + "template \nconstexpr auto operator++(T &, int) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: unnamed-1 + type: int + unnamed: true + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator++(T & lhs, int) -> std::enable_if_t, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator2B3D.md b/docs/libraries/enum_ops.hpp/f_operator2B3D.md index 8573f5c19..39a16e4a2 100644 --- a/docs/libraries/enum_ops.hpp/f_operator2B3D.md +++ b/docs/libraries/enum_ops.hpp/f_operator2B3D.md @@ -1,21 +1,22 @@ --- layout: function title: operator+= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator+=(T &, T) -> std::enable_if_t, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: rhs - type: T - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator+=(T & lhs, T rhs) -> std::enable_if_t, T &>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator+=(T &, T) -> std::enable_if_t, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: rhs + type: T + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator+=(T & lhs, T rhs) -> std::enable_if_t, T &>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator2F.md b/docs/libraries/enum_ops.hpp/f_operator2F.md index 61f21342a..96efcbeec 100644 --- a/docs/libraries/enum_ops.hpp/f_operator2F.md +++ b/docs/libraries/enum_ops.hpp/f_operator2F.md @@ -1,21 +1,22 @@ --- layout: function title: operator/ -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator/(T, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: U - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator/(T lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator/(T, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: U + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator/(T lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator2F3D.md b/docs/libraries/enum_ops.hpp/f_operator2F3D.md index 7b1d52913..75369161e 100644 --- a/docs/libraries/enum_ops.hpp/f_operator2F3D.md +++ b/docs/libraries/enum_ops.hpp/f_operator2F3D.md @@ -1,21 +1,22 @@ --- layout: function title: operator/= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator/=(T &, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: rhs - type: U - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator/=(T & lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator/=(T &, U) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: rhs + type: U + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator/=(T & lhs, U rhs) -> std::enable_if_t && stlab::implementation::is_convertible_to_underlying::value, T &>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator3C3C.md b/docs/libraries/enum_ops.hpp/f_operator3C3C.md index e754d3e83..2ceddcfb7 100644 --- a/docs/libraries/enum_ops.hpp/f_operator3C3C.md +++ b/docs/libraries/enum_ops.hpp/f_operator3C3C.md @@ -1,21 +1,22 @@ --- layout: function title: operator<< -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator<<(T, std::size_t) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: std::size_t - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator<<(T lhs, std::size_t rhs) -> std::enable_if_t, T>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator<<(T, std::size_t) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: std::size_t + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator<<(T lhs, std::size_t rhs) -> std::enable_if_t, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator3C3C3D.md b/docs/libraries/enum_ops.hpp/f_operator3C3C3D.md index 20ed271a5..cab10ae03 100644 --- a/docs/libraries/enum_ops.hpp/f_operator3C3C3D.md +++ b/docs/libraries/enum_ops.hpp/f_operator3C3C3D.md @@ -1,21 +1,22 @@ --- layout: function title: operator<<= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator<<=(T &, std::size_t) -> std::enable_if_t, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: rhs - type: std::size_t - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator<<=(T & lhs, std::size_t rhs) -> std::enable_if_t, T &>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator<<=(T &, std::size_t) -> std::enable_if_t, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: rhs + type: std::size_t + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator<<=(T & lhs, std::size_t rhs) -> std::enable_if_t, T &>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator3D3D.md b/docs/libraries/enum_ops.hpp/f_operator3D3D.md index eab153dec..56a55a503 100644 --- a/docs/libraries/enum_ops.hpp/f_operator3D3D.md +++ b/docs/libraries/enum_ops.hpp/f_operator3D3D.md @@ -1,34 +1,41 @@ --- layout: function title: operator== -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator==(T, std::nullptr_t) -> stlab::implementation::enable_if_bitmask_or_arithmetic": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: unnamed-1 - type: std::nullptr_t - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator==(T lhs, std::nullptr_t) -> stlab::implementation::enable_if_bitmask_or_arithmetic" - "template \nconstexpr auto operator==(std::nullptr_t, T) -> stlab::implementation::enable_if_bitmask_or_arithmetic": - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: std::nullptr_t - unnamed: true - - description: __OPTIONAL__ - name: rhs - type: T - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator==(std::nullptr_t, T rhs) -> stlab::implementation::enable_if_bitmask_or_arithmetic" +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator==(T, std::nullptr_t) -> stlab::implementation::enable_if_bitmask_or_arithmetic": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: unnamed-1 + type: std::nullptr_t + unnamed: true + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator==(T lhs, std::nullptr_t) -> stlab::implementation::enable_if_bitmask_or_arithmetic" + "template \nconstexpr auto operator==(std::nullptr_t, T) -> stlab::implementation::enable_if_bitmask_or_arithmetic": + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: std::nullptr_t + unnamed: true + - description: __OPTIONAL__ + name: rhs + type: T + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator==(std::nullptr_t, T rhs) -> stlab::implementation::enable_if_bitmask_or_arithmetic" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator3E3E.md b/docs/libraries/enum_ops.hpp/f_operator3E3E.md index 3c415f3c3..f51271445 100644 --- a/docs/libraries/enum_ops.hpp/f_operator3E3E.md +++ b/docs/libraries/enum_ops.hpp/f_operator3E3E.md @@ -1,21 +1,22 @@ --- layout: function title: operator>> -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator>>(T, std::size_t) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: std::size_t - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator>>(T lhs, std::size_t rhs) -> std::enable_if_t, T>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator>>(T, std::size_t) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: std::size_t + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator>>(T lhs, std::size_t rhs) -> std::enable_if_t, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator3E3E3D.md b/docs/libraries/enum_ops.hpp/f_operator3E3E3D.md index 3d9c14a77..d5fdb91de 100644 --- a/docs/libraries/enum_ops.hpp/f_operator3E3E3D.md +++ b/docs/libraries/enum_ops.hpp/f_operator3E3E3D.md @@ -1,21 +1,22 @@ --- layout: function title: operator>>= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator>>=(T &, std::size_t) -> std::enable_if_t, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: rhs - type: std::size_t - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator>>=(T & lhs, std::size_t rhs) -> std::enable_if_t, T &>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator>>=(T &, std::size_t) -> std::enable_if_t, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: rhs + type: std::size_t + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator>>=(T & lhs, std::size_t rhs) -> std::enable_if_t, T &>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator5E.md b/docs/libraries/enum_ops.hpp/f_operator5E.md index cc0dd5c2d..9f8e19d28 100644 --- a/docs/libraries/enum_ops.hpp/f_operator5E.md +++ b/docs/libraries/enum_ops.hpp/f_operator5E.md @@ -1,21 +1,22 @@ --- layout: function title: operator^ -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator^(T, T) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: T - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator^(T lhs, T rhs) -> std::enable_if_t, T>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator^(T, T) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: T + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator^(T lhs, T rhs) -> std::enable_if_t, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator5E3D.md b/docs/libraries/enum_ops.hpp/f_operator5E3D.md index fda9740d0..372d43a45 100644 --- a/docs/libraries/enum_ops.hpp/f_operator5E3D.md +++ b/docs/libraries/enum_ops.hpp/f_operator5E3D.md @@ -1,21 +1,22 @@ --- layout: function title: operator^= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator^=(T &, T) -> std::enable_if_t, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: rhs - type: T - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator^=(T & lhs, T rhs) -> std::enable_if_t, T &>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator^=(T &, T) -> std::enable_if_t, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: rhs + type: T + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator^=(T & lhs, T rhs) -> std::enable_if_t, T &>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator7C.md b/docs/libraries/enum_ops.hpp/f_operator7C.md index 29e2f0457..efe777217 100644 --- a/docs/libraries/enum_ops.hpp/f_operator7C.md +++ b/docs/libraries/enum_ops.hpp/f_operator7C.md @@ -1,21 +1,22 @@ --- layout: function title: operator| -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator|(T, T) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T - - description: __OPTIONAL__ - name: rhs - type: T - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator|(T lhs, T rhs) -> std::enable_if_t, T>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator|(T, T) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T + - description: __OPTIONAL__ + name: rhs + type: T + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator|(T lhs, T rhs) -> std::enable_if_t, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator7C3D.md b/docs/libraries/enum_ops.hpp/f_operator7C3D.md index f46d980cf..c60c5121c 100644 --- a/docs/libraries/enum_ops.hpp/f_operator7C3D.md +++ b/docs/libraries/enum_ops.hpp/f_operator7C3D.md @@ -1,21 +1,22 @@ --- layout: function title: operator|= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator|=(T &, T) -> std::enable_if_t, T &>": - arguments: - - description: __OPTIONAL__ - name: lhs - type: T & - - description: __OPTIONAL__ - name: rhs - type: T - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator|=(T & lhs, T rhs) -> std::enable_if_t, T &>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator|=(T &, T) -> std::enable_if_t, T &>": + arguments: + - description: __OPTIONAL__ + name: lhs + type: T & + - description: __OPTIONAL__ + name: rhs + type: T + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator|=(T & lhs, T rhs) -> std::enable_if_t, T &>" --- diff --git a/docs/libraries/enum_ops.hpp/f_operator~.md b/docs/libraries/enum_ops.hpp/f_operator~.md index e53b39607..97e41b5fd 100644 --- a/docs/libraries/enum_ops.hpp/f_operator~.md +++ b/docs/libraries/enum_ops.hpp/f_operator~.md @@ -1,18 +1,19 @@ --- layout: function title: operator~ -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - "template \nconstexpr auto operator~(T) -> std::enable_if_t, T>": - arguments: - - description: __OPTIONAL__ - name: a - type: T - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr auto operator~(T a) -> std::enable_if_t, T>" +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + "template \nconstexpr auto operator~(T) -> std::enable_if_t, T>": + arguments: + - description: __OPTIONAL__ + name: a + type: T + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr auto operator~(T a) -> std::enable_if_t, T>" --- diff --git a/docs/libraries/enum_ops.hpp/f_stlab_enable_arithmetic_enum.md b/docs/libraries/enum_ops.hpp/f_stlab_enable_arithmetic_enum.md index c1b014d62..7822743d8 100644 --- a/docs/libraries/enum_ops.hpp/f_stlab_enable_arithmetic_enum.md +++ b/docs/libraries/enum_ops.hpp/f_stlab_enable_arithmetic_enum.md @@ -1,16 +1,17 @@ --- layout: function title: stlab_enable_arithmetic_enum -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - auto stlab_enable_arithmetic_enum(, ...) -> std::false_type: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: auto stlab_enable_arithmetic_enum(, ...) -> std::false_type -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: enum_ops.hpp + overloads: + auto stlab_enable_arithmetic_enum(, ...) -> std::false_type: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: auto stlab_enable_arithmetic_enum(, ...) -> std::false_type + namespace: + - stlab --- diff --git a/docs/libraries/enum_ops.hpp/f_stlab_enable_bitmask_enum.md b/docs/libraries/enum_ops.hpp/f_stlab_enable_bitmask_enum.md index 91b81c15d..2d2c4575b 100644 --- a/docs/libraries/enum_ops.hpp/f_stlab_enable_bitmask_enum.md +++ b/docs/libraries/enum_ops.hpp/f_stlab_enable_bitmask_enum.md @@ -1,16 +1,23 @@ --- layout: function title: stlab_enable_bitmask_enum -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: enum_ops.hpp -overloads: - auto stlab_enable_bitmask_enum(, ...) -> std::false_type: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: auto stlab_enable_bitmask_enum(, ...) -> std::false_type -namespace: - - stlab +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: enum_ops.hpp + overloads: + auto stlab_enable_bitmask_enum(, ...) -> std::false_type: + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: auto stlab_enable_bitmask_enum(, ...) -> std::false_type + namespace: + - stlab --- diff --git a/docs/libraries/enum_ops.hpp/index.md b/docs/libraries/enum_ops.hpp/index.md index faa97cf2e..eb85e0cc4 100644 --- a/docs/libraries/enum_ops.hpp/index.md +++ b/docs/libraries/enum_ops.hpp/index.md @@ -1,28 +1,32 @@ --- layout: library title: enum_ops.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile -typedefs: - enable_if_bitmask_or_arithmetic: - definition: std::enable_if_t, stlab::implementation::has_enabled_arithmetic_t>, U> - description: __MISSING__ - has_enabled_arithmetic_t: - definition: decltype(stlab_enable_arithmetic_enum(std::declval())) - description: __MISSING__ - has_enabled_bitmask_t: - definition: decltype(stlab_enable_bitmask_enum(std::declval())) - description: __MISSING__ - is_convertible_to_underlying: - definition: std::is_convertible> - description: __MISSING__ - safe_underlying_type_t: - definition: typename safe_underlying_type::value>::type - description: __MISSING__ - underlying: - definition: std::underlying_type_t - description: __MISSING__ +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile + typedefs: + enable_if_bitmask_or_arithmetic: + definition: std::enable_if_t, stlab::implementation::has_enabled_arithmetic_t>, U> + description: __MISSING__ + has_enabled_arithmetic_t: + definition: decltype(stlab_enable_arithmetic_enum(std::declval())) + description: __MISSING__ + has_enabled_bitmask_t: + definition: decltype(stlab_enable_bitmask_enum(std::declval())) + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + is_convertible_to_underlying: + definition: std::is_convertible> + description: __MISSING__ + safe_underlying_type_t: + definition: typename safe_underlying_type::value>::type + description: __MISSING__ + underlying: + definition: std::underlying_type_t + description: __MISSING__ --- diff --git a/docs/libraries/enum_ops.hpp/safe_underlying_type3CT.399d3431/index.md b/docs/libraries/enum_ops.hpp/safe_underlying_type3CT.399d3431/index.md index cc0643e8c..4e58d9a06 100644 --- a/docs/libraries/enum_ops.hpp/safe_underlying_type3CT.399d3431/index.md +++ b/docs/libraries/enum_ops.hpp/safe_underlying_type3CT.399d3431/index.md @@ -1,19 +1,20 @@ --- layout: class title: safe_underlying_type -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: enum_ops.hpp -declaration: "\nstruct stlab::implementation::safe_underlying_type;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: void - description: __MISSING__ -namespace: - - stlab - - implementation +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: enum_ops.hpp + declaration: "\nstruct stlab::implementation::safe_underlying_type;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: void + description: __MISSING__ + namespace: + - stlab + - implementation --- diff --git a/docs/libraries/enum_ops.hpp/safe_underlying_type3CT.af98cac6/index.md b/docs/libraries/enum_ops.hpp/safe_underlying_type3CT.af98cac6/index.md index bc5cc413c..2d8ebdbd8 100644 --- a/docs/libraries/enum_ops.hpp/safe_underlying_type3CT.af98cac6/index.md +++ b/docs/libraries/enum_ops.hpp/safe_underlying_type3CT.af98cac6/index.md @@ -1,19 +1,20 @@ --- layout: class title: safe_underlying_type -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: enum_ops.hpp -declaration: "\nstruct stlab::implementation::safe_underlying_type;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: std::underlying_type_t - description: __MISSING__ -namespace: - - stlab - - implementation +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: enum_ops.hpp + declaration: "\nstruct stlab::implementation::safe_underlying_type;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: std::underlying_type_t + description: __MISSING__ + namespace: + - stlab + - implementation --- diff --git a/docs/libraries/forest.hpp/child_adaptor3CForest3E/index.md b/docs/libraries/forest.hpp/child_adaptor3CForest3E/index.md index c6115fdf2..f0d741ac0 100644 --- a/docs/libraries/forest.hpp/child_adaptor3CForest3E/index.md +++ b/docs/libraries/forest.hpp/child_adaptor3CForest3E/index.md @@ -1,35 +1,39 @@ --- layout: class title: child_adaptor -owner: fosterbrereton -brief: Adaptor to more easily manipulate a node's immediate children -tags: - - class -defined_in_file: forest.hpp -declaration: "template \nclass stlab::child_adaptor;" -dtor: unspecified -typedefs: - const_reference: - definition: typename Forest::const_reference - description: const reference type - difference_type: - definition: typename Forest::difference_type - description: difference type - forest_type: - definition: Forest - description: Forest type - iterator: - definition: typename Forest::child_iterator - description: child iterator type - iterator_type: - definition: typename Forest::iterator - description: iterator type - reference: - definition: typename Forest::reference - description: reference type - value_type: - definition: typename Forest::value_type - description: value type -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Adaptor to more easily manipulate a node's immediate children + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: forest.hpp + declaration: "template \nclass stlab::child_adaptor;" + dtor: unspecified + typedefs: + const_reference: + definition: typename Forest::const_reference + description: const reference type + difference_type: + definition: typename Forest::difference_type + description: difference type + forest_type: + definition: Forest + description: Forest type + iterator: + definition: typename Forest::child_iterator + description: child iterator type + iterator_type: + definition: typename Forest::iterator + description: iterator type + reference: + definition: typename Forest::reference + description: reference type + value_type: + definition: typename Forest::value_type + description: value type + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_back.md b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_back.md index 8f96680ef..2bc276e6e 100644 --- a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_back.md +++ b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_back.md @@ -1,14 +1,15 @@ --- layout: method title: back -owner: fosterbrereton -brief: Return the last node in the set of child nodes -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::child_adaptor::value_type & back(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::child_adaptor::value_type & back() +hyde: + owner: fosterbrereton + brief: Return the last node in the set of child nodes + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::child_adaptor::value_type & back(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::child_adaptor::value_type & back() --- diff --git a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_child_adaptor3CForest3E.md b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_child_adaptor3CForest3E.md index 3091d5b9f..2f638351c 100644 --- a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_child_adaptor3CForest3E.md +++ b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_child_adaptor3CForest3E.md @@ -1,22 +1,22 @@ --- layout: method title: child_adaptor -owner: fosterbrereton -brief: Constructor -tags: - - method -defined_in_file: forest.hpp -is_ctor: true -overloads: - child_adaptor(stlab::child_adaptor::forest_type &, stlab::child_adaptor::iterator_type &): - arguments: - - description: __OPTIONAL__ - name: f - type: stlab::child_adaptor::forest_type & - - description: __OPTIONAL__ - name: i - type: stlab::child_adaptor::iterator_type & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: child_adaptor(stlab::child_adaptor::forest_type & f, stlab::child_adaptor::iterator_type & i) +hyde: + owner: fosterbrereton + brief: Constructor + tags: + - method + defined_in_file: forest.hpp + is_ctor: true + overloads: + child_adaptor(stlab::child_adaptor::forest_type &, stlab::child_adaptor::iterator_type &): + arguments: + - description: __OPTIONAL__ + name: f + type: stlab::child_adaptor::forest_type & + - description: __OPTIONAL__ + name: i + type: stlab::child_adaptor::iterator_type & + description: __OPTIONAL__ + signature_with_names: child_adaptor(stlab::child_adaptor::forest_type & f, stlab::child_adaptor::iterator_type & i) --- diff --git a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_front.md b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_front.md index 0fa141d7f..fb1db48c7 100644 --- a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_front.md +++ b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_front.md @@ -1,14 +1,15 @@ --- layout: method title: front -owner: fosterbrereton -brief: Return the first node in the set of child nodes -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::child_adaptor::value_type & front(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::child_adaptor::value_type & front() +hyde: + owner: fosterbrereton + brief: Return the first node in the set of child nodes + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::child_adaptor::value_type & front(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::child_adaptor::value_type & front() --- diff --git a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_pop_back.md b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_pop_back.md index bbe35ab54..ff397d3d8 100644 --- a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_pop_back.md +++ b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_pop_back.md @@ -1,14 +1,15 @@ --- layout: method title: pop_back -owner: fosterbrereton -brief: Remove the last node in a set of child nodes -tags: - - method -defined_in_file: forest.hpp -overloads: - void pop_back(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void pop_back() +hyde: + owner: fosterbrereton + brief: Remove the last node in a set of child nodes + tags: + - method + defined_in_file: forest.hpp + overloads: + void pop_back(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void pop_back() --- diff --git a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_pop_front.md b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_pop_front.md index eac195bfd..d0b004763 100644 --- a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_pop_front.md +++ b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_pop_front.md @@ -1,14 +1,15 @@ --- layout: method title: pop_front -owner: fosterbrereton -brief: Remove the first node in a set of child nodes -tags: - - method -defined_in_file: forest.hpp -overloads: - void pop_front(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void pop_front() +hyde: + owner: fosterbrereton + brief: Remove the first node in a set of child nodes + tags: + - method + defined_in_file: forest.hpp + overloads: + void pop_front(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void pop_front() --- diff --git a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_push_back.md b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_push_back.md index bef5d5aac..3656d74ad 100644 --- a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_push_back.md +++ b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_push_back.md @@ -1,18 +1,19 @@ --- layout: method title: push_back -owner: fosterbrereton -brief: Insert a new node as the last child -tags: - - method -defined_in_file: forest.hpp -overloads: - void push_back(const stlab::child_adaptor::value_type &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::child_adaptor::value_type & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void push_back(const stlab::child_adaptor::value_type & x) +hyde: + owner: fosterbrereton + brief: Insert a new node as the last child + tags: + - method + defined_in_file: forest.hpp + overloads: + void push_back(const stlab::child_adaptor::value_type &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::child_adaptor::value_type & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void push_back(const stlab::child_adaptor::value_type & x) --- diff --git a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_push_front.md b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_push_front.md index 2d7de9e5f..76d823c54 100644 --- a/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_push_front.md +++ b/docs/libraries/forest.hpp/child_adaptor3CForest3E/m_push_front.md @@ -1,18 +1,19 @@ --- layout: method title: push_front -owner: fosterbrereton -brief: Insert a new node as the first child -tags: - - method -defined_in_file: forest.hpp -overloads: - void push_front(const stlab::child_adaptor::value_type &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::child_adaptor::value_type & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void push_front(const stlab::child_adaptor::value_type & x) +hyde: + owner: fosterbrereton + brief: Insert a new node as the first child + tags: + - method + defined_in_file: forest.hpp + overloads: + void push_front(const stlab::child_adaptor::value_type &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::child_adaptor::value_type & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void push_front(const stlab::child_adaptor::value_type & x) --- diff --git a/docs/libraries/forest.hpp/child_iterator3CI3E/f_operator213D.md b/docs/libraries/forest.hpp/child_iterator3CI3E/f_operator213D.md index 8098a3ae4..68d1737ba 100644 --- a/docs/libraries/forest.hpp/child_iterator3CI3E/f_operator213D.md +++ b/docs/libraries/forest.hpp/child_iterator3CI3E/f_operator213D.md @@ -1,78 +1,79 @@ --- layout: function title: operator!= -owner: fosterbrereton -brief: Inequality comparator -tags: - - function -defined_in_file: forest.hpp -overloads: - bool operator!=(const child_iterator &, const child_iterator &): - arguments: - - description: __OPTIONAL__ - name: a - type: const child_iterator & - - description: __OPTIONAL__ - name: b - type: const child_iterator & - description: child_iterator variant - return: __OPTIONAL__ - signature_with_names: bool operator!=(const child_iterator & a, const child_iterator & b) - bool operator!=(const depth_fullorder_iterator &, const depth_fullorder_iterator &): - arguments: - - description: __OPTIONAL__ - name: a - type: const depth_fullorder_iterator & - - description: __OPTIONAL__ - name: b - type: const depth_fullorder_iterator & - description: depth_fullorder_iterator variant - return: __OPTIONAL__ - signature_with_names: bool operator!=(const depth_fullorder_iterator & a, const depth_fullorder_iterator & b) - bool operator!=(const edge_iterator &, const edge_iterator &): - arguments: - - description: __OPTIONAL__ - name: a - type: const edge_iterator & - - description: __OPTIONAL__ - name: b - type: const edge_iterator & - description: edge_iterator variant - return: __OPTIONAL__ - signature_with_names: bool operator!=(const edge_iterator & a, const edge_iterator & b) - bool operator!=(const filter_fullorder_iterator &, const filter_fullorder_iterator &): - arguments: - - description: __OPTIONAL__ - name: a - type: const filter_fullorder_iterator & - - description: __OPTIONAL__ - name: b - type: const filter_fullorder_iterator & - description: filter_fullorder_iterator variant - return: __OPTIONAL__ - signature_with_names: bool operator!=(const filter_fullorder_iterator & a, const filter_fullorder_iterator & b) - bool operator!=(const reverse_fullorder_iterator &, const reverse_fullorder_iterator &): - arguments: - - description: __OPTIONAL__ - name: a - type: const reverse_fullorder_iterator & - - description: __OPTIONAL__ - name: b - type: const reverse_fullorder_iterator & - description: reverse_fullorder_iterator variant - return: __OPTIONAL__ - signature_with_names: bool operator!=(const reverse_fullorder_iterator & a, const reverse_fullorder_iterator & b) - "template \nbool operator!=(const forest &, const forest &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const forest & - - description: __OPTIONAL__ - name: y - type: const forest & - description: forest variant - return: __OPTIONAL__ - signature_with_names: "template \nbool operator!=(const forest & x, const forest & y)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Inequality comparator + tags: + - function + defined_in_file: forest.hpp + overloads: + bool operator!=(const child_iterator &, const child_iterator &): + arguments: + - description: __OPTIONAL__ + name: a + type: const child_iterator & + - description: __OPTIONAL__ + name: b + type: const child_iterator & + description: child_iterator variant + return: __OPTIONAL__ + signature_with_names: bool operator!=(const child_iterator & a, const child_iterator & b) + bool operator!=(const depth_fullorder_iterator &, const depth_fullorder_iterator &): + arguments: + - description: __OPTIONAL__ + name: a + type: const depth_fullorder_iterator & + - description: __OPTIONAL__ + name: b + type: const depth_fullorder_iterator & + description: depth_fullorder_iterator variant + return: __OPTIONAL__ + signature_with_names: bool operator!=(const depth_fullorder_iterator & a, const depth_fullorder_iterator & b) + bool operator!=(const edge_iterator &, const edge_iterator &): + arguments: + - description: __OPTIONAL__ + name: a + type: const edge_iterator & + - description: __OPTIONAL__ + name: b + type: const edge_iterator & + description: edge_iterator variant + return: __OPTIONAL__ + signature_with_names: bool operator!=(const edge_iterator & a, const edge_iterator & b) + bool operator!=(const filter_fullorder_iterator &, const filter_fullorder_iterator &): + arguments: + - description: __OPTIONAL__ + name: a + type: const filter_fullorder_iterator & + - description: __OPTIONAL__ + name: b + type: const filter_fullorder_iterator & + description: filter_fullorder_iterator variant + return: __OPTIONAL__ + signature_with_names: bool operator!=(const filter_fullorder_iterator & a, const filter_fullorder_iterator & b) + bool operator!=(const reverse_fullorder_iterator &, const reverse_fullorder_iterator &): + arguments: + - description: __OPTIONAL__ + name: a + type: const reverse_fullorder_iterator & + - description: __OPTIONAL__ + name: b + type: const reverse_fullorder_iterator & + description: reverse_fullorder_iterator variant + return: __OPTIONAL__ + signature_with_names: bool operator!=(const reverse_fullorder_iterator & a, const reverse_fullorder_iterator & b) + "template \nbool operator!=(const forest &, const forest &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const forest & + - description: __OPTIONAL__ + name: y + type: const forest & + description: forest variant + return: __OPTIONAL__ + signature_with_names: "template \nbool operator!=(const forest & x, const forest & y)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/child_iterator3CI3E/f_operator3D3D.md b/docs/libraries/forest.hpp/child_iterator3CI3E/f_operator3D3D.md index 92c74385e..38c25f500 100644 --- a/docs/libraries/forest.hpp/child_iterator3CI3E/f_operator3D3D.md +++ b/docs/libraries/forest.hpp/child_iterator3CI3E/f_operator3D3D.md @@ -1,78 +1,85 @@ --- layout: function title: operator== -owner: fosterbrereton -brief: Equality comparator -tags: - - function -defined_in_file: forest.hpp -overloads: - bool operator==(const child_iterator &, const child_iterator &): - arguments: - - description: __OPTIONAL__ - name: a - type: const child_iterator & - - description: __OPTIONAL__ - name: b - type: const child_iterator & - description: child_iterator variant - return: __OPTIONAL__ - signature_with_names: bool operator==(const child_iterator & a, const child_iterator & b) - bool operator==(const depth_fullorder_iterator &, const depth_fullorder_iterator &): - arguments: - - description: __OPTIONAL__ - name: a - type: const depth_fullorder_iterator & - - description: __OPTIONAL__ - name: b - type: const depth_fullorder_iterator & - description: depth_fullorder_iterator variant - return: __OPTIONAL__ - signature_with_names: bool operator==(const depth_fullorder_iterator & a, const depth_fullorder_iterator & b) - bool operator==(const edge_iterator &, const edge_iterator &): - arguments: - - description: __OPTIONAL__ - name: a - type: const edge_iterator & - - description: __OPTIONAL__ - name: b - type: const edge_iterator & - description: edge_iterator variant - return: __OPTIONAL__ - signature_with_names: bool operator==(const edge_iterator & a, const edge_iterator & b) - bool operator==(const filter_fullorder_iterator &, const filter_fullorder_iterator &): - arguments: - - description: __OPTIONAL__ - name: a - type: const filter_fullorder_iterator & - - description: __OPTIONAL__ - name: b - type: const filter_fullorder_iterator & - description: filter_fullorder_iterator variant - return: __OPTIONAL__ - signature_with_names: bool operator==(const filter_fullorder_iterator & a, const filter_fullorder_iterator & b) - bool operator==(const reverse_fullorder_iterator &, const reverse_fullorder_iterator &): - arguments: - - description: __OPTIONAL__ - name: a - type: const reverse_fullorder_iterator & - - description: __OPTIONAL__ - name: b - type: const reverse_fullorder_iterator & - description: reverse_fullorder_iterator variant - return: __OPTIONAL__ - signature_with_names: bool operator==(const reverse_fullorder_iterator & a, const reverse_fullorder_iterator & b) - "template \nbool operator==(const forest &, const forest &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const forest & - - description: __OPTIONAL__ - name: y - type: const forest & - description: forest variant - return: __OPTIONAL__ - signature_with_names: "template \nbool operator==(const forest & x, const forest & y)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Equality comparator + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + bool operator==(const child_iterator &, const child_iterator &): + arguments: + - description: __OPTIONAL__ + name: a + type: const child_iterator & + - description: __OPTIONAL__ + name: b + type: const child_iterator & + description: child_iterator variant + return: __OPTIONAL__ + signature_with_names: bool operator==(const child_iterator & a, const child_iterator & b) + bool operator==(const depth_fullorder_iterator &, const depth_fullorder_iterator &): + arguments: + - description: __OPTIONAL__ + name: a + type: const depth_fullorder_iterator & + - description: __OPTIONAL__ + name: b + type: const depth_fullorder_iterator & + description: depth_fullorder_iterator variant + return: __OPTIONAL__ + signature_with_names: bool operator==(const depth_fullorder_iterator & a, const depth_fullorder_iterator & b) + bool operator==(const edge_iterator &, const edge_iterator &): + arguments: + - description: __OPTIONAL__ + name: a + type: const edge_iterator & + - description: __OPTIONAL__ + name: b + type: const edge_iterator & + description: edge_iterator variant + return: __OPTIONAL__ + signature_with_names: bool operator==(const edge_iterator & a, const edge_iterator & b) + bool operator==(const filter_fullorder_iterator &, const filter_fullorder_iterator &): + arguments: + - description: __OPTIONAL__ + name: a + type: const filter_fullorder_iterator & + - description: __OPTIONAL__ + name: b + type: const filter_fullorder_iterator & + description: filter_fullorder_iterator variant + return: __OPTIONAL__ + signature_with_names: bool operator==(const filter_fullorder_iterator & a, const filter_fullorder_iterator & b) + bool operator==(const reverse_fullorder_iterator &, const reverse_fullorder_iterator &): + arguments: + - description: __OPTIONAL__ + name: a + type: const reverse_fullorder_iterator & + - description: __OPTIONAL__ + name: b + type: const reverse_fullorder_iterator & + description: reverse_fullorder_iterator variant + return: __OPTIONAL__ + signature_with_names: bool operator==(const reverse_fullorder_iterator & a, const reverse_fullorder_iterator & b) + "template \nbool operator==(const forest &, const forest &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const forest & + - description: __OPTIONAL__ + name: y + type: const forest & + description: forest variant + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nbool operator==(const forest & x, const forest & y)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/child_iterator3CI3E/index.md b/docs/libraries/forest.hpp/child_iterator3CI3E/index.md index 557d1e8cf..345f67304 100644 --- a/docs/libraries/forest.hpp/child_iterator3CI3E/index.md +++ b/docs/libraries/forest.hpp/child_iterator3CI3E/index.md @@ -1,29 +1,33 @@ --- layout: class title: child_iterator -owner: fosterbrereton -brief: Iterator type for traversing the children of a forest node -tags: - - class -defined_in_file: forest.hpp -declaration: "template \nstruct stlab::child_iterator;" -dtor: unspecified -typedefs: - difference_type: - definition: typename std::iterator_traits::difference_type - description: difference type - iterator_category: - definition: typename std::iterator_traits::iterator_category - description: iterator category - pointer: - definition: typename std::iterator_traits::pointer - description: pointer type - reference: - definition: typename std::iterator_traits::reference - description: reference type - value_type: - definition: typename std::iterator_traits::value_type - description: value type -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Iterator type for traversing the children of a forest node + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: forest.hpp + declaration: "template \nstruct stlab::child_iterator;" + dtor: unspecified + typedefs: + difference_type: + definition: typename std::iterator_traits::difference_type + description: difference type + iterator_category: + definition: typename std::iterator_traits::iterator_category + description: iterator category + pointer: + definition: typename std::iterator_traits::pointer + description: pointer type + reference: + definition: typename std::iterator_traits::reference + description: reference type + value_type: + definition: typename std::iterator_traits::value_type + description: value type + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/child_iterator3CI3E/m_base.md b/docs/libraries/forest.hpp/child_iterator3CI3E/m_base.md index 5b7f91934..491b08d89 100644 --- a/docs/libraries/forest.hpp/child_iterator3CI3E/m_base.md +++ b/docs/libraries/forest.hpp/child_iterator3CI3E/m_base.md @@ -1,14 +1,15 @@ --- layout: method title: base -owner: fosterbrereton -brief: Utility routine to retrieve the underlying iterator -tags: - - method -defined_in_file: forest.hpp -overloads: - I base() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: I base() const +hyde: + owner: fosterbrereton + brief: Utility routine to retrieve the underlying iterator + tags: + - method + defined_in_file: forest.hpp + overloads: + I base() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: I base() const --- diff --git a/docs/libraries/forest.hpp/child_iterator3CI3E/m_child_iterator3CI3E.md b/docs/libraries/forest.hpp/child_iterator3CI3E/m_child_iterator3CI3E.md index b8e3b36e7..a92bd9d08 100644 --- a/docs/libraries/forest.hpp/child_iterator3CI3E/m_child_iterator3CI3E.md +++ b/docs/libraries/forest.hpp/child_iterator3CI3E/m_child_iterator3CI3E.md @@ -1,33 +1,31 @@ --- layout: method title: child_iterator -owner: fosterbrereton -brief: Constructor -tags: - - method -defined_in_file: forest.hpp -is_ctor: true -overloads: - child_iterator(): - annotation: - - default - description: Default ctor - return: __OPTIONAL__ - signature_with_names: child_iterator() - explicit child_iterator(I): - arguments: - - description: __OPTIONAL__ - name: x - type: I - description: Iterator ctor - return: __OPTIONAL__ - signature_with_names: explicit child_iterator(I x) - "template \nchild_iterator(const child_iterator &)": - arguments: - - description: __OPTIONAL__ - name: u - type: const child_iterator & - description: Rebase ctor - return: __OPTIONAL__ - signature_with_names: "template \nchild_iterator(const child_iterator & u)" +hyde: + owner: fosterbrereton + brief: Constructor + tags: + - method + defined_in_file: forest.hpp + is_ctor: true + overloads: + child_iterator(): + annotation: + - defaulted + description: Default ctor + signature_with_names: child_iterator() + explicit child_iterator(I): + arguments: + - description: __OPTIONAL__ + name: x + type: I + description: Iterator ctor + signature_with_names: explicit child_iterator(I x) + "template \nchild_iterator(const child_iterator &)": + arguments: + - description: __OPTIONAL__ + name: u + type: const child_iterator & + description: Rebase ctor + signature_with_names: "template \nchild_iterator(const child_iterator & u)" --- diff --git a/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator--.md b/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator--.md index d48c1d335..ecc8908ed 100644 --- a/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator--.md +++ b/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator--.md @@ -1,23 +1,24 @@ --- layout: method title: operator-- -owner: fosterbrereton -brief: Decrement operator -tags: - - method -defined_in_file: forest.hpp -overloads: - auto & operator--(): - description: predecrement - return: __OPTIONAL__ - signature_with_names: auto & operator--() - auto operator--(int): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: int - unnamed: true - description: postdecrement - return: __OPTIONAL__ - signature_with_names: auto operator--(int) +hyde: + owner: fosterbrereton + brief: Decrement operator + tags: + - method + defined_in_file: forest.hpp + overloads: + auto & operator--(): + description: predecrement + return: __OPTIONAL__ + signature_with_names: auto & operator--() + auto operator--(int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: int + unnamed: true + description: postdecrement + return: __OPTIONAL__ + signature_with_names: auto operator--(int) --- diff --git a/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator-3E.md b/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator-3E.md index 9abb199fd..56d783203 100644 --- a/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator-3E.md +++ b/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator-3E.md @@ -1,14 +1,15 @@ --- layout: method title: operator-> -owner: fosterbrereton -brief: Pointer-based dereference -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::child_iterator::pointer operator->(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::child_iterator::pointer operator->() +hyde: + owner: fosterbrereton + brief: Pointer-based dereference + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::child_iterator::pointer operator->(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::child_iterator::pointer operator->() --- diff --git a/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator2A.md b/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator2A.md index 5a4b48245..928e0e8f6 100644 --- a/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator2A.md +++ b/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator2A.md @@ -1,14 +1,15 @@ --- layout: method title: operator* -owner: fosterbrereton -brief: Dereference -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::child_iterator::reference operator*(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::child_iterator::reference operator*() +hyde: + owner: fosterbrereton + brief: Dereference + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::child_iterator::reference operator*(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::child_iterator::reference operator*() --- diff --git a/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator2B2B.md b/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator2B2B.md index ec0fd7573..5b58da256 100644 --- a/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator2B2B.md +++ b/docs/libraries/forest.hpp/child_iterator3CI3E/m_operator2B2B.md @@ -1,23 +1,24 @@ --- layout: method title: operator++ -owner: fosterbrereton -brief: Increment operator -tags: - - method -defined_in_file: forest.hpp -overloads: - auto & operator++(): - description: preincrement - return: __OPTIONAL__ - signature_with_names: auto & operator++() - auto operator++(int): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: int - unnamed: true - description: postincrement - return: __OPTIONAL__ - signature_with_names: auto operator++(int) +hyde: + owner: fosterbrereton + brief: Increment operator + tags: + - method + defined_in_file: forest.hpp + overloads: + auto & operator++(): + description: preincrement + return: __OPTIONAL__ + signature_with_names: auto & operator++() + auto operator++(int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: int + unnamed: true + description: postincrement + return: __OPTIONAL__ + signature_with_names: auto operator++(int) --- diff --git a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/index.md b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/index.md index 299d8b162..2c5665324 100644 --- a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/index.md +++ b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/index.md @@ -1,29 +1,33 @@ --- layout: class title: depth_fullorder_iterator -owner: fosterbrereton -brief: Fullorder iterator that keeps track of its depth in the forest -tags: - - class -defined_in_file: forest.hpp -declaration: "template \nstruct stlab::depth_fullorder_iterator;" -dtor: unspecified -typedefs: - difference_type: - definition: typename std::iterator_traits::difference_type - description: difference type - iterator_category: - definition: typename std::iterator_traits::iterator_category - description: iterator category - pointer: - definition: typename std::iterator_traits::pointer - description: pointer type - reference: - definition: typename std::iterator_traits::reference - description: reference type - value_type: - definition: typename std::iterator_traits::value_type - description: value type -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Fullorder iterator that keeps track of its depth in the forest + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: forest.hpp + declaration: "template \nstruct stlab::depth_fullorder_iterator;" + dtor: unspecified + typedefs: + difference_type: + definition: typename std::iterator_traits::difference_type + description: difference type + iterator_category: + definition: typename std::iterator_traits::iterator_category + description: iterator category + pointer: + definition: typename std::iterator_traits::pointer + description: pointer type + reference: + definition: typename std::iterator_traits::reference + description: reference type + value_type: + definition: typename std::iterator_traits::value_type + description: value type + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_base.md b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_base.md index 5b7f91934..491b08d89 100644 --- a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_base.md +++ b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_base.md @@ -1,14 +1,15 @@ --- layout: method title: base -owner: fosterbrereton -brief: Utility routine to retrieve the underlying iterator -tags: - - method -defined_in_file: forest.hpp -overloads: - I base() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: I base() const +hyde: + owner: fosterbrereton + brief: Utility routine to retrieve the underlying iterator + tags: + - method + defined_in_file: forest.hpp + overloads: + I base() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: I base() const --- diff --git a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_depth.md b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_depth.md index b57c71299..e7f2dd72c 100644 --- a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_depth.md +++ b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_depth.md @@ -1,14 +1,15 @@ --- layout: method title: depth -owner: fosterbrereton -brief: Gets the current depth of the iterator -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::depth_fullorder_iterator::difference_type depth() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::depth_fullorder_iterator::difference_type depth() const +hyde: + owner: fosterbrereton + brief: Gets the current depth of the iterator + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::depth_fullorder_iterator::difference_type depth() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::depth_fullorder_iterator::difference_type depth() const --- diff --git a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_depth_fullorder_iterator3CI3E.md b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_depth_fullorder_iterator3CI3E.md index 5df0f59b2..5cb911369 100644 --- a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_depth_fullorder_iterator3CI3E.md +++ b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_depth_fullorder_iterator3CI3E.md @@ -1,38 +1,36 @@ --- layout: method title: depth_fullorder_iterator -owner: fosterbrereton -brief: Constructor -tags: - - method -defined_in_file: forest.hpp -is_ctor: true -overloads: - depth_fullorder_iterator(stlab::depth_fullorder_iterator::difference_type): - arguments: - - description: __OPTIONAL__ - name: d - type: stlab::depth_fullorder_iterator::difference_type - description: Starting depth ctor - return: __OPTIONAL__ - signature_with_names: depth_fullorder_iterator(stlab::depth_fullorder_iterator::difference_type d) - explicit depth_fullorder_iterator(I, stlab::depth_fullorder_iterator::difference_type): - arguments: - - description: __OPTIONAL__ - name: x - type: I - - description: __OPTIONAL__ - name: d - type: stlab::depth_fullorder_iterator::difference_type - description: Iterator ctor - return: __OPTIONAL__ - signature_with_names: explicit depth_fullorder_iterator(I x, stlab::depth_fullorder_iterator::difference_type d) - "template \ndepth_fullorder_iterator(const depth_fullorder_iterator &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const depth_fullorder_iterator & - description: Rebase ctor - return: __OPTIONAL__ - signature_with_names: "template \ndepth_fullorder_iterator(const depth_fullorder_iterator & x)" +hyde: + owner: fosterbrereton + brief: Constructor + tags: + - method + defined_in_file: forest.hpp + is_ctor: true + overloads: + depth_fullorder_iterator(stlab::depth_fullorder_iterator::difference_type): + arguments: + - description: __OPTIONAL__ + name: d + type: stlab::depth_fullorder_iterator::difference_type + description: Starting depth ctor + signature_with_names: depth_fullorder_iterator(stlab::depth_fullorder_iterator::difference_type d) + explicit depth_fullorder_iterator(I, stlab::depth_fullorder_iterator::difference_type): + arguments: + - description: __OPTIONAL__ + name: x + type: I + - description: __OPTIONAL__ + name: d + type: stlab::depth_fullorder_iterator::difference_type + description: Iterator ctor + signature_with_names: explicit depth_fullorder_iterator(I x, stlab::depth_fullorder_iterator::difference_type d) + "template \ndepth_fullorder_iterator(const depth_fullorder_iterator &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const depth_fullorder_iterator & + description: Rebase ctor + signature_with_names: "template \ndepth_fullorder_iterator(const depth_fullorder_iterator & x)" --- diff --git a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_edge.md b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_edge.md index cdffbd6f3..8c568ced6 100644 --- a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_edge.md +++ b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_edge.md @@ -1,18 +1,19 @@ --- layout: method title: edge -owner: fosterbrereton -brief: Get or set the iterator's node edge -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest_edge & edge(): - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: stlab::forest_edge & edge() - stlab::forest_edge edge() const: - description: Const variant - return: __OPTIONAL__ - signature_with_names: stlab::forest_edge edge() const +hyde: + owner: fosterbrereton + brief: Get or set the iterator's node edge + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::forest_edge & edge(): + description: Mutable variant + return: __OPTIONAL__ + signature_with_names: stlab::forest_edge & edge() + stlab::forest_edge edge() const: + description: Const variant + return: __OPTIONAL__ + signature_with_names: stlab::forest_edge edge() const --- diff --git a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_equal_node.md b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_equal_node.md index bb5edc0d4..6282fb464 100644 --- a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_equal_node.md +++ b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_equal_node.md @@ -1,18 +1,19 @@ --- layout: method title: equal_node -owner: fosterbrereton -brief: Node equality operator -tags: - - method -defined_in_file: forest.hpp -overloads: - bool equal_node(const depth_fullorder_iterator &) const: - arguments: - - description: __OPTIONAL__ - name: y - type: const depth_fullorder_iterator & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool equal_node(const depth_fullorder_iterator & y) const +hyde: + owner: fosterbrereton + brief: Node equality operator + tags: + - method + defined_in_file: forest.hpp + overloads: + bool equal_node(const depth_fullorder_iterator &) const: + arguments: + - description: __OPTIONAL__ + name: y + type: const depth_fullorder_iterator & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool equal_node(const depth_fullorder_iterator & y) const --- diff --git a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator--.md b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator--.md index d48c1d335..ecc8908ed 100644 --- a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator--.md +++ b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator--.md @@ -1,23 +1,24 @@ --- layout: method title: operator-- -owner: fosterbrereton -brief: Decrement operator -tags: - - method -defined_in_file: forest.hpp -overloads: - auto & operator--(): - description: predecrement - return: __OPTIONAL__ - signature_with_names: auto & operator--() - auto operator--(int): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: int - unnamed: true - description: postdecrement - return: __OPTIONAL__ - signature_with_names: auto operator--(int) +hyde: + owner: fosterbrereton + brief: Decrement operator + tags: + - method + defined_in_file: forest.hpp + overloads: + auto & operator--(): + description: predecrement + return: __OPTIONAL__ + signature_with_names: auto & operator--() + auto operator--(int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: int + unnamed: true + description: postdecrement + return: __OPTIONAL__ + signature_with_names: auto operator--(int) --- diff --git a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator-3E.md b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator-3E.md index 16aff59c6..e3942a61f 100644 --- a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator-3E.md +++ b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator-3E.md @@ -1,14 +1,15 @@ --- layout: method title: operator-> -owner: fosterbrereton -brief: Pointer dereference -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::depth_fullorder_iterator::pointer operator->(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::depth_fullorder_iterator::pointer operator->() +hyde: + owner: fosterbrereton + brief: Pointer dereference + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::depth_fullorder_iterator::pointer operator->(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::depth_fullorder_iterator::pointer operator->() --- diff --git a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator2A.md b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator2A.md index a9490d599..3b98b6c09 100644 --- a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator2A.md +++ b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator2A.md @@ -1,14 +1,15 @@ --- layout: method title: operator* -owner: fosterbrereton -brief: Dereference -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::depth_fullorder_iterator::reference operator*(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::depth_fullorder_iterator::reference operator*() +hyde: + owner: fosterbrereton + brief: Dereference + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::depth_fullorder_iterator::reference operator*(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::depth_fullorder_iterator::reference operator*() --- diff --git a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator2B2B.md b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator2B2B.md index ec0fd7573..5b58da256 100644 --- a/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator2B2B.md +++ b/docs/libraries/forest.hpp/depth_fullorder_iterator3CI3E/m_operator2B2B.md @@ -1,23 +1,24 @@ --- layout: method title: operator++ -owner: fosterbrereton -brief: Increment operator -tags: - - method -defined_in_file: forest.hpp -overloads: - auto & operator++(): - description: preincrement - return: __OPTIONAL__ - signature_with_names: auto & operator++() - auto operator++(int): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: int - unnamed: true - description: postincrement - return: __OPTIONAL__ - signature_with_names: auto operator++(int) +hyde: + owner: fosterbrereton + brief: Increment operator + tags: + - method + defined_in_file: forest.hpp + overloads: + auto & operator++(): + description: preincrement + return: __OPTIONAL__ + signature_with_names: auto & operator++() + auto operator++(int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: int + unnamed: true + description: postincrement + return: __OPTIONAL__ + signature_with_names: auto operator++(int) --- diff --git a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/index.md b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/index.md index 02b97721b..24ac21835 100644 --- a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/index.md +++ b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/index.md @@ -1,29 +1,33 @@ --- layout: class title: edge_iterator -owner: fosterbrereton -brief: Iterator that only visits either leading or trailing edges -tags: - - class -defined_in_file: forest.hpp -declaration: "template \nstruct stlab::edge_iterator;" -dtor: unspecified -typedefs: - difference_type: - definition: typename std::iterator_traits::difference_type - description: difference type - iterator_category: - definition: typename std::iterator_traits::iterator_category - description: iterator category - pointer: - definition: typename std::iterator_traits::pointer - description: pointer type - reference: - definition: typename std::iterator_traits::reference - description: reference type - value_type: - definition: typename std::iterator_traits::value_type - description: value type -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Iterator that only visits either leading or trailing edges + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: forest.hpp + declaration: "template \nstruct stlab::edge_iterator;" + dtor: unspecified + typedefs: + difference_type: + definition: typename std::iterator_traits::difference_type + description: difference type + iterator_category: + definition: typename std::iterator_traits::iterator_category + description: iterator category + pointer: + definition: typename std::iterator_traits::pointer + description: pointer type + reference: + definition: typename std::iterator_traits::reference + description: reference type + value_type: + definition: typename std::iterator_traits::value_type + description: value type + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_base.md b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_base.md index 5b7f91934..491b08d89 100644 --- a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_base.md +++ b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_base.md @@ -1,14 +1,15 @@ --- layout: method title: base -owner: fosterbrereton -brief: Utility routine to retrieve the underlying iterator -tags: - - method -defined_in_file: forest.hpp -overloads: - I base() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: I base() const +hyde: + owner: fosterbrereton + brief: Utility routine to retrieve the underlying iterator + tags: + - method + defined_in_file: forest.hpp + overloads: + I base() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: I base() const --- diff --git a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_edge_iterator3CI2C20Edge3E.md b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_edge_iterator3CI2C20Edge3E.md index 77e60ab86..182cc4812 100644 --- a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_edge_iterator3CI2C20Edge3E.md +++ b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_edge_iterator3CI2C20Edge3E.md @@ -1,33 +1,31 @@ --- layout: method title: edge_iterator -owner: fosterbrereton -brief: Constructor -tags: - - method -defined_in_file: forest.hpp -is_ctor: true -overloads: - edge_iterator(): - annotation: - - default - description: Default ctor - return: __OPTIONAL__ - signature_with_names: edge_iterator() - explicit edge_iterator(I): - arguments: - - description: __OPTIONAL__ - name: x - type: I - description: Iterator ctor - return: __OPTIONAL__ - signature_with_names: explicit edge_iterator(I x) - "template \nedge_iterator(const edge_iterator &)": - arguments: - - description: __OPTIONAL__ - name: u - type: const edge_iterator & - description: Rebase ctor - return: __OPTIONAL__ - signature_with_names: "template \nedge_iterator(const edge_iterator & u)" +hyde: + owner: fosterbrereton + brief: Constructor + tags: + - method + defined_in_file: forest.hpp + is_ctor: true + overloads: + edge_iterator(): + annotation: + - defaulted + description: Default ctor + signature_with_names: edge_iterator() + explicit edge_iterator(I): + arguments: + - description: __OPTIONAL__ + name: x + type: I + description: Iterator ctor + signature_with_names: explicit edge_iterator(I x) + "template \nedge_iterator(const edge_iterator &)": + arguments: + - description: __OPTIONAL__ + name: u + type: const edge_iterator & + description: Rebase ctor + signature_with_names: "template \nedge_iterator(const edge_iterator & u)" --- diff --git a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator--.md b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator--.md index d48c1d335..ecc8908ed 100644 --- a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator--.md +++ b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator--.md @@ -1,23 +1,24 @@ --- layout: method title: operator-- -owner: fosterbrereton -brief: Decrement operator -tags: - - method -defined_in_file: forest.hpp -overloads: - auto & operator--(): - description: predecrement - return: __OPTIONAL__ - signature_with_names: auto & operator--() - auto operator--(int): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: int - unnamed: true - description: postdecrement - return: __OPTIONAL__ - signature_with_names: auto operator--(int) +hyde: + owner: fosterbrereton + brief: Decrement operator + tags: + - method + defined_in_file: forest.hpp + overloads: + auto & operator--(): + description: predecrement + return: __OPTIONAL__ + signature_with_names: auto & operator--() + auto operator--(int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: int + unnamed: true + description: postdecrement + return: __OPTIONAL__ + signature_with_names: auto operator--(int) --- diff --git a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator-3E.md b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator-3E.md index 23323d12e..69039218c 100644 --- a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator-3E.md +++ b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator-3E.md @@ -1,14 +1,15 @@ --- layout: method title: operator-> -owner: fosterbrereton -brief: Pointer dereference -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::edge_iterator::pointer operator->(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::edge_iterator::pointer operator->() +hyde: + owner: fosterbrereton + brief: Pointer dereference + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::edge_iterator::pointer operator->(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::edge_iterator::pointer operator->() --- diff --git a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator2A.md b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator2A.md index 5a6c9afd1..b3c3f9a72 100644 --- a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator2A.md +++ b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator2A.md @@ -1,14 +1,15 @@ --- layout: method title: operator* -owner: fosterbrereton -brief: Dereference -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::edge_iterator::reference operator*(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::edge_iterator::reference operator*() +hyde: + owner: fosterbrereton + brief: Dereference + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::edge_iterator::reference operator*(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::edge_iterator::reference operator*() --- diff --git a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator2B2B.md b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator2B2B.md index ec0fd7573..5b58da256 100644 --- a/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator2B2B.md +++ b/docs/libraries/forest.hpp/edge_iterator3CI2C20Edge3E/m_operator2B2B.md @@ -1,23 +1,24 @@ --- layout: method title: operator++ -owner: fosterbrereton -brief: Increment operator -tags: - - method -defined_in_file: forest.hpp -overloads: - auto & operator++(): - description: preincrement - return: __OPTIONAL__ - signature_with_names: auto & operator++() - auto operator++(int): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: int - unnamed: true - description: postincrement - return: __OPTIONAL__ - signature_with_names: auto operator++(int) +hyde: + owner: fosterbrereton + brief: Increment operator + tags: + - method + defined_in_file: forest.hpp + overloads: + auto & operator++(): + description: preincrement + return: __OPTIONAL__ + signature_with_names: auto & operator++() + auto operator++(int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: int + unnamed: true + description: postincrement + return: __OPTIONAL__ + signature_with_names: auto operator++(int) --- diff --git a/docs/libraries/forest.hpp/f_child_begin.md b/docs/libraries/forest.hpp/f_child_begin.md index 2cf153dbc..013e11a6f 100644 --- a/docs/libraries/forest.hpp/f_child_begin.md +++ b/docs/libraries/forest.hpp/f_child_begin.md @@ -1,20 +1,27 @@ --- layout: function title: child_begin -owner: fosterbrereton -brief: Gets a child iterator to the first child of the given parent -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nchild_iterator child_begin(const I &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const I & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nchild_iterator child_begin(const I & x)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Gets a child iterator to the first child of the given parent + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nchild_iterator child_begin(const I &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const I & + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nchild_iterator child_begin(const I & x)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_child_end.md b/docs/libraries/forest.hpp/f_child_end.md index 15485ee59..de95fbbdb 100644 --- a/docs/libraries/forest.hpp/f_child_end.md +++ b/docs/libraries/forest.hpp/f_child_end.md @@ -1,20 +1,27 @@ --- layout: function title: child_end -owner: fosterbrereton -brief: Gets a child iterator to the one-past-the-last child of the given parent -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nchild_iterator child_end(const I &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const I & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nchild_iterator child_end(const I & x)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Gets a child iterator to the one-past-the-last child of the given parent + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nchild_iterator child_end(const I &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const I & + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nchild_iterator child_end(const I & x)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_child_range.md b/docs/libraries/forest.hpp/f_child_range.md index fff7d0cb6..a1ba47ef3 100644 --- a/docs/libraries/forest.hpp/f_child_range.md +++ b/docs/libraries/forest.hpp/f_child_range.md @@ -1,20 +1,27 @@ --- layout: function title: child_range -owner: fosterbrereton -brief: Get a range of child iterators for a given parent node -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nauto child_range(const I &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const I & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto child_range(const I & x)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Get a range of child iterators for a given parent node + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nauto child_range(const I &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const I & + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto child_range(const I & x)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_depth_range.md b/docs/libraries/forest.hpp/f_depth_range.md index 23c7c0615..518e68d51 100644 --- a/docs/libraries/forest.hpp/f_depth_range.md +++ b/docs/libraries/forest.hpp/f_depth_range.md @@ -1,28 +1,35 @@ --- layout: function title: depth_range -owner: fosterbrereton -brief: Get a range of depth iterators for a given range -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nauto depth_range(R &)": - arguments: - - description: __OPTIONAL__ - name: x - type: R & - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: "template \nauto depth_range(R & x)" - "template \nauto depth_range(const R &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const R & - description: Const variant - return: __OPTIONAL__ - signature_with_names: "template \nauto depth_range(const R & x)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Get a range of depth iterators for a given range + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nauto depth_range(R &)": + arguments: + - description: __OPTIONAL__ + name: x + type: R & + description: Mutable variant + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto depth_range(R & x)" + "template \nauto depth_range(const R &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const R & + description: Const variant + return: __OPTIONAL__ + signature_with_names: "template \nauto depth_range(const R & x)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_filter_fullorder_range.md b/docs/libraries/forest.hpp/f_filter_fullorder_range.md index b6aa3f15d..8dffe4656 100644 --- a/docs/libraries/forest.hpp/f_filter_fullorder_range.md +++ b/docs/libraries/forest.hpp/f_filter_fullorder_range.md @@ -1,34 +1,41 @@ --- layout: function title: filter_fullorder_range -owner: fosterbrereton -brief: Get a range of filter iterators for a given range -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nauto filter_fullorder_range(R &, P)": - arguments: - - description: __OPTIONAL__ - name: x - type: R & - - description: __OPTIONAL__ - name: p - type: P - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: "template \nauto filter_fullorder_range(R & x, P p)" - "template \nauto filter_fullorder_range(const R &, P)": - arguments: - - description: __OPTIONAL__ - name: x - type: const R & - - description: __OPTIONAL__ - name: p - type: P - description: Const variant - return: __OPTIONAL__ - signature_with_names: "template \nauto filter_fullorder_range(const R & x, P p)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Get a range of filter iterators for a given range + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nauto filter_fullorder_range(R &, P)": + arguments: + - description: __OPTIONAL__ + name: x + type: R & + - description: __OPTIONAL__ + name: p + type: P + description: Mutable variant + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto filter_fullorder_range(R & x, P p)" + "template \nauto filter_fullorder_range(const R &, P)": + arguments: + - description: __OPTIONAL__ + name: x + type: const R & + - description: __OPTIONAL__ + name: p + type: P + description: Const variant + return: __OPTIONAL__ + signature_with_names: "template \nauto filter_fullorder_range(const R & x, P p)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_find_edge.md b/docs/libraries/forest.hpp/f_find_edge.md index 20015dbf2..737efd71b 100644 --- a/docs/libraries/forest.hpp/f_find_edge.md +++ b/docs/libraries/forest.hpp/f_find_edge.md @@ -1,23 +1,30 @@ --- layout: function title: find_edge -owner: fosterbrereton -brief: Return a successive iterator matching an edge value -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nI find_edge(I, stlab::forest_edge)": - arguments: - - description: __OPTIONAL__ - name: x - type: I - - description: __OPTIONAL__ - name: edge - type: stlab::forest_edge - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nI find_edge(I x, stlab::forest_edge edge)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Return a successive iterator matching an edge value + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nI find_edge(I, stlab::forest_edge)": + arguments: + - description: __OPTIONAL__ + name: x + type: I + - description: __OPTIONAL__ + name: edge + type: stlab::forest_edge + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nI find_edge(I x, stlab::forest_edge edge)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_find_edge_reverse.md b/docs/libraries/forest.hpp/f_find_edge_reverse.md index 3400f64ff..6a22c4113 100644 --- a/docs/libraries/forest.hpp/f_find_edge_reverse.md +++ b/docs/libraries/forest.hpp/f_find_edge_reverse.md @@ -1,23 +1,24 @@ --- layout: function title: find_edge_reverse -owner: fosterbrereton -brief: Return a predecessive iterator matching an edge value -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nI find_edge_reverse(I, stlab::forest_edge)": - arguments: - - description: __OPTIONAL__ - name: x - type: I - - description: __OPTIONAL__ - name: edge - type: stlab::forest_edge - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nI find_edge_reverse(I x, stlab::forest_edge edge)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Return a predecessive iterator matching an edge value + tags: + - function + defined_in_file: forest.hpp + overloads: + "template \nI find_edge_reverse(I, stlab::forest_edge)": + arguments: + - description: __OPTIONAL__ + name: x + type: I + - description: __OPTIONAL__ + name: edge + type: stlab::forest_edge + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nI find_edge_reverse(I x, stlab::forest_edge edge)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_find_parent.md b/docs/libraries/forest.hpp/f_find_parent.md index 52444b0ca..e37e85a5d 100644 --- a/docs/libraries/forest.hpp/f_find_parent.md +++ b/docs/libraries/forest.hpp/f_find_parent.md @@ -1,22 +1,29 @@ --- layout: function title: find_parent -owner: fosterbrereton -brief: Get the parent node of a child node -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nI find_parent(I)": - arguments: - - description: __OPTIONAL__ - name: i - type: I - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nI find_parent(I i)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Get the parent node of a child node + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nI find_parent(I)": + arguments: + - description: __OPTIONAL__ + name: i + type: I + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nI find_parent(I i)" + namespace: + - stlab --- The time complexity for this operation is $O(N)$, where $N$ is the number of child nodes of the parent. diff --git a/docs/libraries/forest.hpp/f_has_children.md b/docs/libraries/forest.hpp/f_has_children.md index a33185de6..d20d05c54 100644 --- a/docs/libraries/forest.hpp/f_has_children.md +++ b/docs/libraries/forest.hpp/f_has_children.md @@ -1,20 +1,27 @@ --- layout: function title: has_children -owner: fosterbrereton -brief: Determine if a node has children or not -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nbool has_children(const I &)": - arguments: - - description: __OPTIONAL__ - name: i - type: const I & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nbool has_children(const I & i)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Determine if a node has children or not + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nbool has_children(const I &)": + arguments: + - description: __OPTIONAL__ + name: i + type: const I & + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nbool has_children(const I & i)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_is_leading.md b/docs/libraries/forest.hpp/f_is_leading.md index 7ddc3c18d..f980b8b8a 100644 --- a/docs/libraries/forest.hpp/f_is_leading.md +++ b/docs/libraries/forest.hpp/f_is_leading.md @@ -1,36 +1,43 @@ --- layout: function title: is_leading -owner: fosterbrereton -brief: Determine if an iterator is on the leading edge of a node -tags: - - function -defined_in_file: forest.hpp -overloads: - auto is_leading(const stlab::forest_edge &): - arguments: - - description: __OPTIONAL__ - name: i - type: const stlab::forest_edge & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: auto is_leading(const stlab::forest_edge & i) - constexpr bool is_leading(stlab::forest_edge): - arguments: - - description: __OPTIONAL__ - name: e - type: stlab::forest_edge - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: constexpr bool is_leading(stlab::forest_edge e) - "template \nauto is_leading(const I &)": - arguments: - - description: __OPTIONAL__ - name: i - type: const I & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto is_leading(const I & i)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Determine if an iterator is on the leading edge of a node + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + auto is_leading(const stlab::forest_edge &): + arguments: + - description: __OPTIONAL__ + name: i + type: const stlab::forest_edge & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: auto is_leading(const stlab::forest_edge & i) + constexpr bool is_leading(stlab::forest_edge): + arguments: + - description: __OPTIONAL__ + name: e + type: stlab::forest_edge + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: constexpr bool is_leading(stlab::forest_edge e) + "template \nauto is_leading(const I &)": + arguments: + - description: __OPTIONAL__ + name: i + type: const I & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto is_leading(const I & i)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_is_trailing.md b/docs/libraries/forest.hpp/f_is_trailing.md index e2bd299f0..a6b37db3e 100644 --- a/docs/libraries/forest.hpp/f_is_trailing.md +++ b/docs/libraries/forest.hpp/f_is_trailing.md @@ -1,28 +1,29 @@ --- layout: function title: is_trailing -owner: fosterbrereton -brief: Determine if an iterator is on the trailing edge of a node -tags: - - function -defined_in_file: forest.hpp -overloads: - constexpr bool is_trailing(stlab::forest_edge): - arguments: - - description: __OPTIONAL__ - name: e - type: stlab::forest_edge - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: constexpr bool is_trailing(stlab::forest_edge e) - "template \nauto is_trailing(const I &)": - arguments: - - description: __OPTIONAL__ - name: i - type: const I & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto is_trailing(const I & i)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Determine if an iterator is on the trailing edge of a node + tags: + - function + defined_in_file: forest.hpp + overloads: + constexpr bool is_trailing(stlab::forest_edge): + arguments: + - description: __OPTIONAL__ + name: e + type: stlab::forest_edge + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: constexpr bool is_trailing(stlab::forest_edge e) + "template \nauto is_trailing(const I &)": + arguments: + - description: __OPTIONAL__ + name: i + type: const I & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto is_trailing(const I & i)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_leading_of.md b/docs/libraries/forest.hpp/f_leading_of.md index 015bc953c..78c031101 100644 --- a/docs/libraries/forest.hpp/f_leading_of.md +++ b/docs/libraries/forest.hpp/f_leading_of.md @@ -1,20 +1,27 @@ --- layout: function title: leading_of -owner: fosterbrereton -brief: Get an iterator on the leading edge of a node -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nauto leading_of(I)": - arguments: - - description: __OPTIONAL__ - name: i - type: I - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto leading_of(I i)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Get an iterator on the leading edge of a node + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nauto leading_of(I)": + arguments: + - description: __OPTIONAL__ + name: i + type: I + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto leading_of(I i)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_pivot.md b/docs/libraries/forest.hpp/f_pivot.md index 4b71f1583..1c308a2f2 100644 --- a/docs/libraries/forest.hpp/f_pivot.md +++ b/docs/libraries/forest.hpp/f_pivot.md @@ -1,36 +1,43 @@ --- layout: function title: pivot -owner: fosterbrereton -brief: Flip the edge of an iterator -tags: - - function -defined_in_file: forest.hpp -overloads: - constexpr stlab::forest_edge pivot(stlab::forest_edge): - arguments: - - description: __OPTIONAL__ - name: e - type: stlab::forest_edge - description: Returns the alternate edge from the one passed - return: __OPTIONAL__ - signature_with_names: constexpr stlab::forest_edge pivot(stlab::forest_edge e) - "template \nvoid pivot(I &)": - arguments: - - description: __OPTIONAL__ - name: i - type: I & - description: Changes the edge of an iterator to its alternate - return: __OPTIONAL__ - signature_with_names: "template \nvoid pivot(I & i)" - void pivot(stlab::forest_edge &): - arguments: - - description: __OPTIONAL__ - name: i - type: stlab::forest_edge & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void pivot(stlab::forest_edge & i) -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Flip the edge of an iterator + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + constexpr stlab::forest_edge pivot(stlab::forest_edge): + arguments: + - description: __OPTIONAL__ + name: e + type: stlab::forest_edge + description: Returns the alternate edge from the one passed + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: constexpr stlab::forest_edge pivot(stlab::forest_edge e) + "template \nvoid pivot(I &)": + arguments: + - description: __OPTIONAL__ + name: i + type: I & + description: Changes the edge of an iterator to its alternate + return: __OPTIONAL__ + signature_with_names: "template \nvoid pivot(I & i)" + void pivot(stlab::forest_edge &): + arguments: + - description: __OPTIONAL__ + name: i + type: stlab::forest_edge & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: void pivot(stlab::forest_edge & i) + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_pivot_of.md b/docs/libraries/forest.hpp/f_pivot_of.md index e9ddbeb61..62ba9586e 100644 --- a/docs/libraries/forest.hpp/f_pivot_of.md +++ b/docs/libraries/forest.hpp/f_pivot_of.md @@ -1,20 +1,21 @@ --- layout: function title: pivot_of -owner: fosterbrereton -brief: Returns an iterator to the same node pointing to the alternate edge -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nauto pivot_of(I)": - arguments: - - description: __OPTIONAL__ - name: i - type: I - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto pivot_of(I i)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Returns an iterator to the same node pointing to the alternate edge + tags: + - function + defined_in_file: forest.hpp + overloads: + "template \nauto pivot_of(I)": + arguments: + - description: __OPTIONAL__ + name: i + type: I + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nauto pivot_of(I i)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_postorder_range.md b/docs/libraries/forest.hpp/f_postorder_range.md index 1e74281e6..8a7ff204b 100644 --- a/docs/libraries/forest.hpp/f_postorder_range.md +++ b/docs/libraries/forest.hpp/f_postorder_range.md @@ -1,28 +1,35 @@ --- layout: function title: postorder_range -owner: fosterbrereton -brief: Get a range of postorder iterators for a given range -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nauto postorder_range(R &)": - arguments: - - description: __OPTIONAL__ - name: x - type: R & - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: "template \nauto postorder_range(R & x)" - "template \nauto postorder_range(const R &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const R & - description: Const variant - return: __OPTIONAL__ - signature_with_names: "template \nauto postorder_range(const R & x)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Get a range of postorder iterators for a given range + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nauto postorder_range(R &)": + arguments: + - description: __OPTIONAL__ + name: x + type: R & + description: Mutable variant + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto postorder_range(R & x)" + "template \nauto postorder_range(const R &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const R & + description: Const variant + return: __OPTIONAL__ + signature_with_names: "template \nauto postorder_range(const R & x)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_preorder_range.md b/docs/libraries/forest.hpp/f_preorder_range.md index 5463686b7..7dc27a4e6 100644 --- a/docs/libraries/forest.hpp/f_preorder_range.md +++ b/docs/libraries/forest.hpp/f_preorder_range.md @@ -1,28 +1,35 @@ --- layout: function title: preorder_range -owner: fosterbrereton -brief: Get a range of preorder iterators for a given range -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nauto preorder_range(R &)": - arguments: - - description: __OPTIONAL__ - name: x - type: R & - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: "template \nauto preorder_range(R & x)" - "template \nauto preorder_range(const R &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const R & - description: Const variant - return: __OPTIONAL__ - signature_with_names: "template \nauto preorder_range(const R & x)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Get a range of preorder iterators for a given range + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nauto preorder_range(R &)": + arguments: + - description: __OPTIONAL__ + name: x + type: R & + description: Mutable variant + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto preorder_range(R & x)" + "template \nauto preorder_range(const R &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const R & + description: Const variant + return: __OPTIONAL__ + signature_with_names: "template \nauto preorder_range(const R & x)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_reverse_fullorder_range.md b/docs/libraries/forest.hpp/f_reverse_fullorder_range.md index 036a6568e..cae899073 100644 --- a/docs/libraries/forest.hpp/f_reverse_fullorder_range.md +++ b/docs/libraries/forest.hpp/f_reverse_fullorder_range.md @@ -1,28 +1,35 @@ --- layout: function title: reverse_fullorder_range -owner: fosterbrereton -brief: Get a range of reverse iterators for a given range -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nauto reverse_fullorder_range(R &)": - arguments: - - description: __OPTIONAL__ - name: x - type: R & - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: "template \nauto reverse_fullorder_range(R & x)" - "template \nauto reverse_fullorder_range(const R &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const R & - description: Const variant - return: __OPTIONAL__ - signature_with_names: "template \nauto reverse_fullorder_range(const R & x)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Get a range of reverse iterators for a given range + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + "template \nauto reverse_fullorder_range(R &)": + arguments: + - description: __OPTIONAL__ + name: x + type: R & + description: Mutable variant + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto reverse_fullorder_range(R & x)" + "template \nauto reverse_fullorder_range(const R &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const R & + description: Const variant + return: __OPTIONAL__ + signature_with_names: "template \nauto reverse_fullorder_range(const R & x)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/f_trailing_of.md b/docs/libraries/forest.hpp/f_trailing_of.md index 097cc4386..9d05fc37e 100644 --- a/docs/libraries/forest.hpp/f_trailing_of.md +++ b/docs/libraries/forest.hpp/f_trailing_of.md @@ -1,20 +1,21 @@ --- layout: function title: trailing_of -owner: fosterbrereton -brief: Get an iterator on the trailing edge of a node -tags: - - function -defined_in_file: forest.hpp -overloads: - "template \nauto trailing_of(I)": - arguments: - - description: __OPTIONAL__ - name: i - type: I - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto trailing_of(I i)" -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Get an iterator on the trailing edge of a node + tags: + - function + defined_in_file: forest.hpp + overloads: + "template \nauto trailing_of(I)": + arguments: + - description: __OPTIONAL__ + name: i + type: I + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nauto trailing_of(I i)" + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/index.md b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/index.md index 8b9c15696..6a092af92 100644 --- a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/index.md +++ b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/index.md @@ -1,29 +1,33 @@ --- layout: class title: filter_fullorder_iterator -owner: fosterbrereton -brief: Fullorder iterator that visits nodes that adhere to a predicate -tags: - - class -defined_in_file: forest.hpp -declaration: "template \nstruct stlab::filter_fullorder_iterator;" -dtor: unspecified -typedefs: - difference_type: - definition: typename std::iterator_traits::difference_type - description: difference type - iterator_category: - definition: typename std::iterator_traits::iterator_category - description: iterator category - pointer: - definition: typename std::iterator_traits::pointer - description: pointer type - reference: - definition: typename std::iterator_traits::reference - description: reference type - value_type: - definition: typename std::iterator_traits::value_type - description: value type -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Fullorder iterator that visits nodes that adhere to a predicate + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: forest.hpp + declaration: "template \nstruct stlab::filter_fullorder_iterator;" + dtor: unspecified + typedefs: + difference_type: + definition: typename std::iterator_traits::difference_type + description: difference type + iterator_category: + definition: typename std::iterator_traits::iterator_category + description: iterator category + pointer: + definition: typename std::iterator_traits::pointer + description: pointer type + reference: + definition: typename std::iterator_traits::reference + description: reference type + value_type: + definition: typename std::iterator_traits::value_type + description: value type + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_base.md b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_base.md index 5b7f91934..491b08d89 100644 --- a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_base.md +++ b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_base.md @@ -1,14 +1,15 @@ --- layout: method title: base -owner: fosterbrereton -brief: Utility routine to retrieve the underlying iterator -tags: - - method -defined_in_file: forest.hpp -overloads: - I base() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: I base() const +hyde: + owner: fosterbrereton + brief: Utility routine to retrieve the underlying iterator + tags: + - method + defined_in_file: forest.hpp + overloads: + I base() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: I base() const --- diff --git a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_edge.md b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_edge.md index c61322c9d..0b0ac45ba 100644 --- a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_edge.md +++ b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_edge.md @@ -1,18 +1,19 @@ --- layout: method title: edge -owner: fosterbrereton -brief: Get or set the iterator’s node edge -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest_edge & edge(): - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: stlab::forest_edge & edge() - stlab::forest_edge edge() const: - description: Const variant - return: __OPTIONAL__ - signature_with_names: stlab::forest_edge edge() const +hyde: + owner: fosterbrereton + brief: Get or set the iterator’s node edge + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::forest_edge & edge(): + description: Mutable variant + return: __OPTIONAL__ + signature_with_names: stlab::forest_edge & edge() + stlab::forest_edge edge() const: + description: Const variant + return: __OPTIONAL__ + signature_with_names: stlab::forest_edge edge() const --- diff --git a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_equal_node.md b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_equal_node.md index 52c32c187..5db55854f 100644 --- a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_equal_node.md +++ b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_equal_node.md @@ -1,18 +1,19 @@ --- layout: method title: equal_node -owner: fosterbrereton -brief: Node equality operator -tags: - - method -defined_in_file: forest.hpp -overloads: - bool equal_node(const filter_fullorder_iterator &) const: - arguments: - - description: __OPTIONAL__ - name: y - type: const filter_fullorder_iterator & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool equal_node(const filter_fullorder_iterator & y) const +hyde: + owner: fosterbrereton + brief: Node equality operator + tags: + - method + defined_in_file: forest.hpp + overloads: + bool equal_node(const filter_fullorder_iterator &) const: + arguments: + - description: __OPTIONAL__ + name: y + type: const filter_fullorder_iterator & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool equal_node(const filter_fullorder_iterator & y) const --- diff --git a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_filter_fullorder_iterator3CI2C20P3E.md b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_filter_fullorder_iterator3CI2C20P3E.md index c28563bd2..b230bf538 100644 --- a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_filter_fullorder_iterator3CI2C20P3E.md +++ b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_filter_fullorder_iterator3CI2C20P3E.md @@ -1,50 +1,47 @@ --- layout: method title: filter_fullorder_iterator -owner: fosterbrereton -brief: Constructor -tags: - - method -defined_in_file: forest.hpp -is_ctor: true -overloads: - filter_fullorder_iterator(): - annotation: - - default - description: Default ctor - return: __OPTIONAL__ - signature_with_names: filter_fullorder_iterator() - filter_fullorder_iterator(I, I): - arguments: - - description: __OPTIONAL__ - name: f - type: I - - description: __OPTIONAL__ - name: l - type: I - description: Iterator ctor - return: __OPTIONAL__ - signature_with_names: filter_fullorder_iterator(I f, I l) - filter_fullorder_iterator(I, I, P): - arguments: - - description: __OPTIONAL__ - name: f - type: I - - description: __OPTIONAL__ - name: l - type: I - - description: __OPTIONAL__ - name: p - type: P - description: Iterator/predicate ctor - return: __OPTIONAL__ - signature_with_names: filter_fullorder_iterator(I f, I l, P p) - "template \nfilter_fullorder_iterator(const filter_fullorder_iterator &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const filter_fullorder_iterator & - description: Rebase ctor - return: __OPTIONAL__ - signature_with_names: "template \nfilter_fullorder_iterator(const filter_fullorder_iterator & x)" +hyde: + owner: fosterbrereton + brief: Constructor + tags: + - method + defined_in_file: forest.hpp + is_ctor: true + overloads: + filter_fullorder_iterator(): + annotation: + - defaulted + description: Default ctor + signature_with_names: filter_fullorder_iterator() + filter_fullorder_iterator(I, I): + arguments: + - description: __OPTIONAL__ + name: f + type: I + - description: __OPTIONAL__ + name: l + type: I + description: Iterator ctor + signature_with_names: filter_fullorder_iterator(I f, I l) + filter_fullorder_iterator(I, I, P): + arguments: + - description: __OPTIONAL__ + name: f + type: I + - description: __OPTIONAL__ + name: l + type: I + - description: __OPTIONAL__ + name: p + type: P + description: Iterator/predicate ctor + signature_with_names: filter_fullorder_iterator(I f, I l, P p) + "template \nfilter_fullorder_iterator(const filter_fullorder_iterator &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const filter_fullorder_iterator & + description: Rebase ctor + signature_with_names: "template \nfilter_fullorder_iterator(const filter_fullorder_iterator & x)" --- diff --git a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator--.md b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator--.md index d48c1d335..ecc8908ed 100644 --- a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator--.md +++ b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator--.md @@ -1,23 +1,24 @@ --- layout: method title: operator-- -owner: fosterbrereton -brief: Decrement operator -tags: - - method -defined_in_file: forest.hpp -overloads: - auto & operator--(): - description: predecrement - return: __OPTIONAL__ - signature_with_names: auto & operator--() - auto operator--(int): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: int - unnamed: true - description: postdecrement - return: __OPTIONAL__ - signature_with_names: auto operator--(int) +hyde: + owner: fosterbrereton + brief: Decrement operator + tags: + - method + defined_in_file: forest.hpp + overloads: + auto & operator--(): + description: predecrement + return: __OPTIONAL__ + signature_with_names: auto & operator--() + auto operator--(int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: int + unnamed: true + description: postdecrement + return: __OPTIONAL__ + signature_with_names: auto operator--(int) --- diff --git a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator-3E.md b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator-3E.md index 9aae5fbb8..5d9bb9de7 100644 --- a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator-3E.md +++ b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator-3E.md @@ -1,14 +1,15 @@ --- layout: method title: operator-> -owner: fosterbrereton -brief: Pointer dereference -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::filter_fullorder_iterator::pointer operator->(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::filter_fullorder_iterator::pointer operator->() +hyde: + owner: fosterbrereton + brief: Pointer dereference + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::filter_fullorder_iterator::pointer operator->(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::filter_fullorder_iterator::pointer operator->() --- diff --git a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator2A.md b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator2A.md index cdaa82e34..ef484ea56 100644 --- a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator2A.md +++ b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator2A.md @@ -1,14 +1,15 @@ --- layout: method title: operator* -owner: fosterbrereton -brief: Dereference -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::filter_fullorder_iterator::reference operator*(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::filter_fullorder_iterator::reference operator*() +hyde: + owner: fosterbrereton + brief: Dereference + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::filter_fullorder_iterator::reference operator*(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::filter_fullorder_iterator::reference operator*() --- diff --git a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator2B2B.md b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator2B2B.md index ec0fd7573..5b58da256 100644 --- a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator2B2B.md +++ b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_operator2B2B.md @@ -1,23 +1,24 @@ --- layout: method title: operator++ -owner: fosterbrereton -brief: Increment operator -tags: - - method -defined_in_file: forest.hpp -overloads: - auto & operator++(): - description: preincrement - return: __OPTIONAL__ - signature_with_names: auto & operator++() - auto operator++(int): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: int - unnamed: true - description: postincrement - return: __OPTIONAL__ - signature_with_names: auto operator++(int) +hyde: + owner: fosterbrereton + brief: Increment operator + tags: + - method + defined_in_file: forest.hpp + overloads: + auto & operator++(): + description: preincrement + return: __OPTIONAL__ + signature_with_names: auto & operator++() + auto operator++(int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: int + unnamed: true + description: postincrement + return: __OPTIONAL__ + signature_with_names: auto operator++(int) --- diff --git a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_predicate.md b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_predicate.md index cdce4b23f..200d5d0cb 100644 --- a/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_predicate.md +++ b/docs/libraries/forest.hpp/filter_fullorder_iterat.e37adade/m_predicate.md @@ -1,14 +1,15 @@ --- layout: method title: predicate -owner: fosterbrereton -brief: Get the predicate of the filter iterator -tags: - - method -defined_in_file: forest.hpp -overloads: - P predicate() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: P predicate() const +hyde: + owner: fosterbrereton + brief: Get the predicate of the filter iterator + tags: + - method + defined_in_file: forest.hpp + overloads: + P predicate() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: P predicate() const --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/index.md b/docs/libraries/forest.hpp/forest3CT3E/index.md index e323bd2a6..8b1c4e643 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/index.md +++ b/docs/libraries/forest.hpp/forest3CT3E/index.md @@ -1,67 +1,77 @@ --- layout: class title: forest -owner: fosterbrereton -brief: A hierarchical, node-based data structure that supports a number of different traversal iterators (forward, reverse, fullorder, preorder, postorder, and more). -tags: - - class -defined_in_file: forest.hpp -declaration: "template \nclass stlab::forest;" -typedefs: - child_iterator: - definition: stlab::child_iterator - description: child iterator type - const_child_iterator: - definition: stlab::child_iterator - description: const child iterator type - const_iterator: - definition: detail::forest_const_iterator - description: const fullorder iterator type - const_pointer: - definition: const T * - description: const pointer type - const_postorder_iterator: - definition: edge_iterator - description: const postorder iterator type - const_preorder_iterator: - definition: edge_iterator - description: const preorder iterator type - const_reference: - definition: const T & - description: const reference type - const_reverse_iterator: - definition: reverse_fullorder_iterator - description: const reverse fullorder iterator type - difference_type: - definition: std::ptrdiff_t - description: difference type - iterator: - definition: detail::forest_iterator - description: fullorder iterator type - pointer: - definition: T * - description: pointer type - postorder_iterator: - definition: edge_iterator - description: postorder iterator type - preorder_iterator: - definition: edge_iterator - description: preorder iterator type - reference: - definition: T & - description: reference type - reverse_child_iterator: - definition: std::reverse_iterator - description: reverse child iterator type - reverse_iterator: - definition: reverse_fullorder_iterator - description: reverse fullorder iterator type - size_type: - definition: std::size_t - description: size type - value_type: - definition: T - description: value type -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: A hierarchical, node-based data structure that supports a number of different traversal iterators (forward, reverse, fullorder, preorder, postorder, and more). + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: forest.hpp + declaration: "template \nclass stlab::forest;" + typedefs: + child_iterator: + definition: stlab::child_iterator + description: child iterator type + inline: + description: + - "qualification needed since: A name N used in a class S shall refer to the same declaration in its context and when re-evaluated in the completed scope of S." + const_child_iterator: + definition: stlab::child_iterator + description: const child iterator type + const_iterator: + definition: detail::forest_const_iterator + description: const fullorder iterator type + const_pointer: + definition: const T * + description: const pointer type + const_postorder_iterator: + definition: edge_iterator + description: const postorder iterator type + const_preorder_iterator: + definition: edge_iterator + description: const preorder iterator type + const_reference: + definition: const T & + description: const reference type + const_reverse_iterator: + definition: reverse_fullorder_iterator + description: const reverse fullorder iterator type + difference_type: + definition: std::ptrdiff_t + description: difference type + iterator: + definition: detail::forest_iterator + description: fullorder iterator type + pointer: + definition: T * + description: pointer type + postorder_iterator: + definition: edge_iterator + description: postorder iterator type + preorder_iterator: + definition: edge_iterator + description: preorder iterator type + reference: + definition: T & + description: reference type + inline: + description: + - types + reverse_child_iterator: + definition: std::reverse_iterator + description: reverse child iterator type + reverse_iterator: + definition: reverse_fullorder_iterator + description: reverse fullorder iterator type + size_type: + definition: std::size_t + description: size type + value_type: + definition: T + description: value type + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_back.md b/docs/libraries/forest.hpp/forest3CT3E/m_back.md index f2e0fdaa2..678230aaf 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_back.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_back.md @@ -1,18 +1,19 @@ --- layout: method title: back -owner: fosterbrereton -brief: Get the last element in the forest -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::const_reference back() const: - description: Const variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::const_reference back() const - stlab::forest::reference back(): - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::reference back() +hyde: + owner: fosterbrereton + brief: Get the last element in the forest + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::forest::const_reference back() const: + description: Const variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::const_reference back() const + stlab::forest::reference back(): + description: Mutable variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::reference back() --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_begin.md b/docs/libraries/forest.hpp/forest3CT3E/m_begin.md index 094f36bf0..05af873f9 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_begin.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_begin.md @@ -1,18 +1,19 @@ --- layout: method title: begin -owner: fosterbrereton -brief: Get a fullorder iterator to the first node -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::const_iterator begin() const: - description: Const variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::const_iterator begin() const - stlab::forest::iterator begin(): - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator begin() +hyde: + owner: fosterbrereton + brief: Get a fullorder iterator to the first node + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::forest::const_iterator begin() const: + description: Const variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::const_iterator begin() const + stlab::forest::iterator begin(): + description: Mutable variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator begin() --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_clear.md b/docs/libraries/forest.hpp/forest3CT3E/m_clear.md index 7956a527e..975f5fc5e 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_clear.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_clear.md @@ -1,14 +1,21 @@ --- layout: method title: clear -owner: fosterbrereton -brief: Erase all nodes -tags: - - method -defined_in_file: forest.hpp -overloads: - void clear(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void clear() +hyde: + owner: fosterbrereton + brief: Erase all nodes + tags: + - method + inline: + brief: + - modifiers + defined_in_file: forest.hpp + overloads: + void clear(): + description: __INLINED__ + inline: + description: + - modifiers + return: __OPTIONAL__ + signature_with_names: void clear() --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_empty.md b/docs/libraries/forest.hpp/forest3CT3E/m_empty.md index 1cd45f712..5bf4dbffc 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_empty.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_empty.md @@ -1,14 +1,15 @@ --- layout: method title: empty -owner: fosterbrereton -brief: Determine if the forest has any nodes -tags: - - method -defined_in_file: forest.hpp -overloads: - bool empty() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool empty() const +hyde: + owner: fosterbrereton + brief: Determine if the forest has any nodes + tags: + - method + defined_in_file: forest.hpp + overloads: + bool empty() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool empty() const --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_end.md b/docs/libraries/forest.hpp/forest3CT3E/m_end.md index 858dc37e2..d7a9f705e 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_end.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_end.md @@ -1,18 +1,19 @@ --- layout: method title: end -owner: fosterbrereton -brief: Get a fullorder iterator to the one-past-the-last node -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::const_iterator end() const: - description: Const variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::const_iterator end() const - stlab::forest::iterator end(): - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator end() +hyde: + owner: fosterbrereton + brief: Get a fullorder iterator to the one-past-the-last node + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::forest::const_iterator end() const: + description: Const variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::const_iterator end() const + stlab::forest::iterator end(): + description: Mutable variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator end() --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_erase.md b/docs/libraries/forest.hpp/forest3CT3E/m_erase.md index 12e0b8965..6a3b73b9a 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_erase.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_erase.md @@ -1,31 +1,40 @@ --- layout: method title: erase -owner: fosterbrereton -brief: Remove one or more nodes -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::iterator erase(const stlab::forest::iterator &): - arguments: - - description: __OPTIONAL__ - name: position - type: const stlab::forest::iterator & - description: Single node erasing - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator erase(const stlab::forest::iterator & position) - stlab::forest::iterator erase(const stlab::forest::iterator &, const stlab::forest::iterator &): - arguments: - - description: __OPTIONAL__ - name: first - type: const stlab::forest::iterator & - - description: __OPTIONAL__ - name: last - type: const stlab::forest::iterator & - description: Multi-node erasing - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator erase(const stlab::forest::iterator & first, const stlab::forest::iterator & last) +hyde: + owner: fosterbrereton + brief: Remove one or more nodes + tags: + - method + inline: + brief: _multiple descriptions_ + defined_in_file: forest.hpp + overloads: + stlab::forest::iterator erase(const stlab::forest::iterator &): + arguments: + - description: __OPTIONAL__ + name: position + type: const stlab::forest::iterator & + description: Single node erasing + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator erase(const stlab::forest::iterator & position) + stlab::forest::iterator erase(const stlab::forest::iterator &, const stlab::forest::iterator &): + arguments: + - description: __OPTIONAL__ + name: first + type: const stlab::forest::iterator & + - description: __OPTIONAL__ + name: last + type: const stlab::forest::iterator & + description: Multi-node erasing + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator erase(const stlab::forest::iterator & first, const stlab::forest::iterator & last) --- The single-node variant lets you remove a node from anywhere within the forest. Removing a parent node will cause its children to become peers of the former parent's siblings. diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_forest3CT3E.md b/docs/libraries/forest.hpp/forest3CT3E/m_forest3CT3E.md index 15d906827..c489d076c 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_forest3CT3E.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_forest3CT3E.md @@ -1,33 +1,31 @@ --- layout: method title: forest -owner: fosterbrereton -brief: Constructor -tags: - - method -defined_in_file: forest.hpp -is_ctor: true -overloads: - forest(): - annotation: - - default - description: Default ctor - return: __OPTIONAL__ - signature_with_names: forest() - forest(const forest &): - arguments: - - description: __OPTIONAL__ - name: x - type: const forest & - description: Copy ctor - return: __OPTIONAL__ - signature_with_names: forest(const forest & x) - forest(forest &&): - arguments: - - description: __OPTIONAL__ - name: x - type: forest && - description: Move ctor - return: __OPTIONAL__ - signature_with_names: forest(forest && x) +hyde: + owner: fosterbrereton + brief: Constructor + tags: + - method + defined_in_file: forest.hpp + is_ctor: true + overloads: + forest(): + annotation: + - defaulted + description: Default ctor + signature_with_names: forest() + forest(const forest &): + arguments: + - description: __OPTIONAL__ + name: x + type: const forest & + description: Copy ctor + signature_with_names: forest(const forest & x) + forest(forest &&): + arguments: + - description: __OPTIONAL__ + name: x + type: forest && + description: Move ctor + signature_with_names: forest(forest && x) --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_front.md b/docs/libraries/forest.hpp/forest3CT3E/m_front.md index 5f3c15505..0b28a34e1 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_front.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_front.md @@ -1,18 +1,19 @@ --- layout: method title: front -owner: fosterbrereton -brief: Get the first element in the forest -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::const_reference front() const: - description: Const variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::const_reference front() const - stlab::forest::reference front(): - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::reference front() +hyde: + owner: fosterbrereton + brief: Get the first element in the forest + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::forest::const_reference front() const: + description: Const variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::const_reference front() const + stlab::forest::reference front(): + description: Mutable variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::reference front() --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_insert.md b/docs/libraries/forest.hpp/forest3CT3E/m_insert.md index 68dcda488..62da03b38 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_insert.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_insert.md @@ -1,35 +1,42 @@ --- layout: method title: insert -owner: fosterbrereton -brief: Insert a node -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::iterator insert(const stlab::forest::iterator &, T): - arguments: - - description: __OPTIONAL__ - name: position - type: const stlab::forest::iterator & - - description: __OPTIONAL__ - name: x - type: T - description: Single value variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator insert(const stlab::forest::iterator & position, T x) - stlab::forest::iterator insert(stlab::forest::iterator, stlab::forest::const_child_iterator, stlab::forest::const_child_iterator): - arguments: - - description: __OPTIONAL__ - name: position - type: stlab::forest::iterator - - description: __OPTIONAL__ - name: first - type: stlab::forest::const_child_iterator - - description: __OPTIONAL__ - name: last - type: stlab::forest::const_child_iterator - description: Multi-node variant. Children will be spliced from their current position into children of `position`. - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator insert(stlab::forest::iterator position, stlab::forest::const_child_iterator first, stlab::forest::const_child_iterator last) +hyde: + owner: fosterbrereton + brief: Insert a node + tags: + - method + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + stlab::forest::iterator insert(const stlab::forest::iterator &, T): + arguments: + - description: __OPTIONAL__ + name: position + type: const stlab::forest::iterator & + - description: __OPTIONAL__ + name: x + type: T + description: Single value variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator insert(const stlab::forest::iterator & position, T x) + stlab::forest::iterator insert(stlab::forest::iterator, stlab::forest::const_child_iterator, stlab::forest::const_child_iterator): + arguments: + - description: __OPTIONAL__ + name: position + type: stlab::forest::iterator + - description: __OPTIONAL__ + name: first + type: stlab::forest::const_child_iterator + - description: __OPTIONAL__ + name: last + type: stlab::forest::const_child_iterator + description: Multi-node variant. Children will be spliced from their current position into children of `position`. + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator insert(stlab::forest::iterator position, stlab::forest::const_child_iterator first, stlab::forest::const_child_iterator last) --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_insert_parent.md b/docs/libraries/forest.hpp/forest3CT3E/m_insert_parent.md index 1f2cf84d2..a2b157519 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_insert_parent.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_insert_parent.md @@ -1,24 +1,31 @@ --- layout: method title: insert_parent -owner: fosterbrereton -brief: Insert a node as a parent of child nodes -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::iterator insert_parent(stlab::forest::child_iterator, stlab::forest::child_iterator, const T &): - arguments: - - description: __OPTIONAL__ - name: front - type: stlab::forest::child_iterator - - description: __OPTIONAL__ - name: back - type: stlab::forest::child_iterator - - description: __OPTIONAL__ - name: x - type: const T & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator insert_parent(stlab::forest::child_iterator front, stlab::forest::child_iterator back, const T & x) +hyde: + owner: fosterbrereton + brief: Insert a node as a parent of child nodes + tags: + - method + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + stlab::forest::iterator insert_parent(stlab::forest::child_iterator, stlab::forest::child_iterator, const T &): + arguments: + - description: __OPTIONAL__ + name: front + type: stlab::forest::child_iterator + - description: __OPTIONAL__ + name: back + type: stlab::forest::child_iterator + - description: __OPTIONAL__ + name: x + type: const T & + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator insert_parent(stlab::forest::child_iterator front, stlab::forest::child_iterator back, const T & x) --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_max_size.md b/docs/libraries/forest.hpp/forest3CT3E/m_max_size.md index dfe2cfae2..a5ac9fba4 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_max_size.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_max_size.md @@ -1,14 +1,15 @@ --- layout: method title: max_size -owner: fosterbrereton -brief: Get the maximum allowed size (number of nodes) -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::size_type max_size() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::forest::size_type max_size() const +hyde: + owner: fosterbrereton + brief: Get the maximum allowed size (number of nodes) + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::forest::size_type max_size() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::forest::size_type max_size() const --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_operator3D.md b/docs/libraries/forest.hpp/forest3CT3E/m_operator3D.md index 35016dd02..17d6f3a30 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_operator3D.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_operator3D.md @@ -1,26 +1,27 @@ --- layout: method title: operator= -owner: fosterbrereton -brief: Assignment operator -tags: - - method -defined_in_file: forest.hpp -overloads: - forest & operator=(const forest &): - arguments: - - description: __OPTIONAL__ - name: x - type: const forest & - description: Copy assignment - return: __OPTIONAL__ - signature_with_names: forest & operator=(const forest & x) - forest & operator=(forest &&): - arguments: - - description: __OPTIONAL__ - name: x - type: forest && - description: Move assignment - return: __OPTIONAL__ - signature_with_names: forest & operator=(forest && x) +hyde: + owner: fosterbrereton + brief: Assignment operator + tags: + - method + defined_in_file: forest.hpp + overloads: + forest & operator=(const forest &): + arguments: + - description: __OPTIONAL__ + name: x + type: const forest & + description: Copy assignment + return: __OPTIONAL__ + signature_with_names: forest & operator=(const forest & x) + forest & operator=(forest &&): + arguments: + - description: __OPTIONAL__ + name: x + type: forest && + description: Move assignment + return: __OPTIONAL__ + signature_with_names: forest & operator=(forest && x) --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_pop_back.md b/docs/libraries/forest.hpp/forest3CT3E/m_pop_back.md index 1429e3620..0075737d6 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_pop_back.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_pop_back.md @@ -1,14 +1,15 @@ --- layout: method title: pop_back -owner: fosterbrereton -brief: Erase the last node -tags: - - method -defined_in_file: forest.hpp -overloads: - void pop_back(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void pop_back() +hyde: + owner: fosterbrereton + brief: Erase the last node + tags: + - method + defined_in_file: forest.hpp + overloads: + void pop_back(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void pop_back() --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_pop_front.md b/docs/libraries/forest.hpp/forest3CT3E/m_pop_front.md index 55f6f52c9..6fa7c8ac2 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_pop_front.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_pop_front.md @@ -1,14 +1,15 @@ --- layout: method title: pop_front -owner: fosterbrereton -brief: Erase the first node -tags: - - method -defined_in_file: forest.hpp -overloads: - void pop_front(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void pop_front() +hyde: + owner: fosterbrereton + brief: Erase the first node + tags: + - method + defined_in_file: forest.hpp + overloads: + void pop_front(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void pop_front() --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_push_back.md b/docs/libraries/forest.hpp/forest3CT3E/m_push_back.md index 6a3a34e7f..1665e9beb 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_push_back.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_push_back.md @@ -1,18 +1,19 @@ --- layout: method title: push_back -owner: fosterbrereton -brief: Insert a node as the last node -tags: - - method -defined_in_file: forest.hpp -overloads: - void push_back(const T &): - arguments: - - description: __OPTIONAL__ - name: x - type: const T & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void push_back(const T & x) +hyde: + owner: fosterbrereton + brief: Insert a node as the last node + tags: + - method + defined_in_file: forest.hpp + overloads: + void push_back(const T &): + arguments: + - description: __OPTIONAL__ + name: x + type: const T & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void push_back(const T & x) --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_push_front.md b/docs/libraries/forest.hpp/forest3CT3E/m_push_front.md index f23ec66bd..9b6213b98 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_push_front.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_push_front.md @@ -1,18 +1,19 @@ --- layout: method title: push_front -owner: fosterbrereton -brief: Insert a node as the first node -tags: - - method -defined_in_file: forest.hpp -overloads: - void push_front(const T &): - arguments: - - description: __OPTIONAL__ - name: x - type: const T & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void push_front(const T & x) +hyde: + owner: fosterbrereton + brief: Insert a node as the first node + tags: + - method + defined_in_file: forest.hpp + overloads: + void push_front(const T &): + arguments: + - description: __OPTIONAL__ + name: x + type: const T & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void push_front(const T & x) --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_rbegin.md b/docs/libraries/forest.hpp/forest3CT3E/m_rbegin.md index 7a3df9d5d..bfd203f22 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_rbegin.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_rbegin.md @@ -1,18 +1,19 @@ --- layout: method title: rbegin -owner: fosterbrereton -brief: Get a reverse fullorder iterator to the first node -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::const_reverse_iterator rbegin() const: - description: Const variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::const_reverse_iterator rbegin() const - stlab::forest::reverse_iterator rbegin(): - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::reverse_iterator rbegin() +hyde: + owner: fosterbrereton + brief: Get a reverse fullorder iterator to the first node + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::forest::const_reverse_iterator rbegin() const: + description: Const variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::const_reverse_iterator rbegin() const + stlab::forest::reverse_iterator rbegin(): + description: Mutable variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::reverse_iterator rbegin() --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_rend.md b/docs/libraries/forest.hpp/forest3CT3E/m_rend.md index 59dcb5768..11417a5ad 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_rend.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_rend.md @@ -1,18 +1,19 @@ --- layout: method title: rend -owner: fosterbrereton -brief: Get a reverse fullorder iterator to one-past-the-last node -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::const_reverse_iterator rend() const: - description: Const variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::const_reverse_iterator rend() const - stlab::forest::reverse_iterator rend(): - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::reverse_iterator rend() +hyde: + owner: fosterbrereton + brief: Get a reverse fullorder iterator to one-past-the-last node + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::forest::const_reverse_iterator rend() const: + description: Const variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::const_reverse_iterator rend() const + stlab::forest::reverse_iterator rend(): + description: Mutable variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::reverse_iterator rend() --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_reverse.md b/docs/libraries/forest.hpp/forest3CT3E/m_reverse.md index 75bcfbb3c..e215ded13 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_reverse.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_reverse.md @@ -1,21 +1,28 @@ --- layout: method title: reverse -owner: fosterbrereton -brief: Reverse a range of child nodes -tags: - - method -defined_in_file: forest.hpp -overloads: - void reverse(stlab::forest::child_iterator, stlab::forest::child_iterator): - arguments: - - description: __OPTIONAL__ - name: first - type: stlab::forest::child_iterator - - description: __OPTIONAL__ - name: last - type: stlab::forest::child_iterator - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void reverse(stlab::forest::child_iterator first, stlab::forest::child_iterator last) +hyde: + owner: fosterbrereton + brief: Reverse a range of child nodes + tags: + - method + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + void reverse(stlab::forest::child_iterator, stlab::forest::child_iterator): + arguments: + - description: __OPTIONAL__ + name: first + type: stlab::forest::child_iterator + - description: __OPTIONAL__ + name: last + type: stlab::forest::child_iterator + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: void reverse(stlab::forest::child_iterator first, stlab::forest::child_iterator last) --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_root.md b/docs/libraries/forest.hpp/forest3CT3E/m_root.md index 83df847e3..216391f6f 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_root.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_root.md @@ -1,18 +1,25 @@ --- layout: method title: root -owner: fosterbrereton -brief: Get a fullorder iterator to the root node on the leading edge -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::const_iterator root() const: - description: Const variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::const_iterator root() const - stlab::forest::iterator root(): - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator root() +hyde: + owner: fosterbrereton + brief: Get a fullorder iterator to the root node on the leading edge + tags: + - method + inline: + brief: + - iterators + defined_in_file: forest.hpp + overloads: + stlab::forest::const_iterator root() const: + description: Const variant + return: __OPTIONAL__ + signature_with_names: stlab::forest::const_iterator root() const + stlab::forest::iterator root(): + description: Mutable variant + inline: + description: + - iterators + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator root() --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_size.md b/docs/libraries/forest.hpp/forest3CT3E/m_size.md index 63b31fb32..15b7e8261 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_size.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_size.md @@ -1,16 +1,23 @@ --- layout: method title: size -owner: fosterbrereton -brief: Compute the number of nodes -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::size_type size() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::forest::size_type size() const +hyde: + owner: fosterbrereton + brief: Compute the number of nodes + tags: + - method + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest.hpp + overloads: + stlab::forest::size_type size() const: + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: stlab::forest::size_type size() const --- If the size of the forest is known (valid), this routine will return in constant time. Otherwise, it will perform a linear walk of the entire forest to derive its size. diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_size_valid.md b/docs/libraries/forest.hpp/forest3CT3E/m_size_valid.md index da27c0f21..30e5d6be3 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_size_valid.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_size_valid.md @@ -1,14 +1,15 @@ --- layout: method title: size_valid -owner: fosterbrereton -brief: Reports if the current size is known (valid) -tags: - - method -defined_in_file: forest.hpp -overloads: - bool size_valid() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool size_valid() const +hyde: + owner: fosterbrereton + brief: Reports if the current size is known (valid) + tags: + - method + defined_in_file: forest.hpp + overloads: + bool size_valid() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool size_valid() const --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_splice.md b/docs/libraries/forest.hpp/forest3CT3E/m_splice.md index 45e138906..cd8925bae 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_splice.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_splice.md @@ -1,72 +1,87 @@ --- layout: method title: splice -owner: fosterbrereton -brief: Move one or more nodes from one forest to another -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest::iterator splice(stlab::forest::iterator, forest &): - arguments: - - description: __OPTIONAL__ - name: position - type: stlab::forest::iterator - - description: __OPTIONAL__ - name: x - type: forest & - description: Full-forest splicing - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator splice(stlab::forest::iterator position, forest & x) - stlab::forest::iterator splice(stlab::forest::iterator, forest &, stlab::forest::child_iterator, stlab::forest::child_iterator): - arguments: - - description: __OPTIONAL__ - name: position - type: stlab::forest::iterator - - description: __OPTIONAL__ - name: x - type: forest & - - description: __OPTIONAL__ - name: first - type: stlab::forest::child_iterator - - description: __OPTIONAL__ - name: last - type: stlab::forest::child_iterator - description: Child range splicing. The size of the source and destination forest will be invalidated. - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator splice(stlab::forest::iterator position, forest & x, stlab::forest::child_iterator first, stlab::forest::child_iterator last) - stlab::forest::iterator splice(stlab::forest::iterator, forest &, stlab::forest::child_iterator, stlab::forest::child_iterator, stlab::forest::size_type): - arguments: - - description: __OPTIONAL__ - name: position - type: stlab::forest::iterator - - description: __OPTIONAL__ - name: x - type: forest & - - description: __OPTIONAL__ - name: first - type: stlab::forest::child_iterator - - description: __OPTIONAL__ - name: last - type: stlab::forest::child_iterator - - description: __OPTIONAL__ - name: count - type: stlab::forest::size_type - description: Child range splicing. If `count` is zero, the size of the source and destination forest will be invalidated. - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator splice(stlab::forest::iterator position, forest & x, stlab::forest::child_iterator first, stlab::forest::child_iterator last, stlab::forest::size_type count) - stlab::forest::iterator splice(stlab::forest::iterator, forest &, stlab::forest::iterator): - arguments: - - description: __OPTIONAL__ - name: position - type: stlab::forest::iterator - - description: __OPTIONAL__ - name: x - type: forest & - - description: __OPTIONAL__ - name: i - type: stlab::forest::iterator - description: Parent-node splice. The children of the passed iterator will be spliced into this forest. - return: __OPTIONAL__ - signature_with_names: stlab::forest::iterator splice(stlab::forest::iterator position, forest & x, stlab::forest::iterator i) +hyde: + owner: fosterbrereton + brief: Move one or more nodes from one forest to another + tags: + - method + inline: + brief: _multiple descriptions_ + defined_in_file: forest.hpp + overloads: + stlab::forest::iterator splice(stlab::forest::iterator, forest &): + arguments: + - description: __OPTIONAL__ + name: position + type: stlab::forest::iterator + - description: __OPTIONAL__ + name: x + type: forest & + description: Full-forest splicing + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator splice(stlab::forest::iterator position, forest & x) + stlab::forest::iterator splice(stlab::forest::iterator, forest &, stlab::forest::child_iterator, stlab::forest::child_iterator): + arguments: + - description: __OPTIONAL__ + name: position + type: stlab::forest::iterator + - description: __OPTIONAL__ + name: x + type: forest & + - description: __OPTIONAL__ + name: first + type: stlab::forest::child_iterator + - description: __OPTIONAL__ + name: last + type: stlab::forest::child_iterator + description: Child range splicing. The size of the source and destination forest will be invalidated. + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator splice(stlab::forest::iterator position, forest & x, stlab::forest::child_iterator first, stlab::forest::child_iterator last) + stlab::forest::iterator splice(stlab::forest::iterator, forest &, stlab::forest::child_iterator, stlab::forest::child_iterator, stlab::forest::size_type): + arguments: + - description: __OPTIONAL__ + name: position + type: stlab::forest::iterator + - description: __OPTIONAL__ + name: x + type: forest & + - description: __OPTIONAL__ + name: first + type: stlab::forest::child_iterator + - description: __OPTIONAL__ + name: last + type: stlab::forest::child_iterator + - description: __OPTIONAL__ + name: count + type: stlab::forest::size_type + description: Child range splicing. If `count` is zero, the size of the source and destination forest will be invalidated. + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator splice(stlab::forest::iterator position, forest & x, stlab::forest::child_iterator first, stlab::forest::child_iterator last, stlab::forest::size_type count) + stlab::forest::iterator splice(stlab::forest::iterator, forest &, stlab::forest::iterator): + arguments: + - description: __OPTIONAL__ + name: position + type: stlab::forest::iterator + - description: __OPTIONAL__ + name: x + type: forest & + - description: __OPTIONAL__ + name: i + type: stlab::forest::iterator + description: Parent-node splice. The children of the passed iterator will be spliced into this forest. + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: stlab::forest::iterator splice(stlab::forest::iterator position, forest & x, stlab::forest::iterator i) --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_swap.md b/docs/libraries/forest.hpp/forest3CT3E/m_swap.md index 1ff8e2f59..4048e0a2b 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_swap.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_swap.md @@ -1,18 +1,19 @@ --- layout: method title: swap -owner: fosterbrereton -brief: Swap the contents this forest with another -tags: - - method -defined_in_file: forest.hpp -overloads: - void swap(forest &): - arguments: - - description: __OPTIONAL__ - name: x - type: forest & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void swap(forest & x) +hyde: + owner: fosterbrereton + brief: Swap the contents this forest with another + tags: + - method + defined_in_file: forest.hpp + overloads: + void swap(forest &): + arguments: + - description: __OPTIONAL__ + name: x + type: forest & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void swap(forest & x) --- diff --git a/docs/libraries/forest.hpp/forest3CT3E/m_~forest3CT3E.md b/docs/libraries/forest.hpp/forest3CT3E/m_~forest3CT3E.md index 2bb335dde..547a0c3a8 100644 --- a/docs/libraries/forest.hpp/forest3CT3E/m_~forest3CT3E.md +++ b/docs/libraries/forest.hpp/forest3CT3E/m_~forest3CT3E.md @@ -1,15 +1,15 @@ --- layout: method title: ~forest -owner: fosterbrereton -brief: Destructor -tags: - - method -defined_in_file: forest.hpp -is_dtor: true -overloads: - ~forest(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~forest() +hyde: + owner: fosterbrereton + brief: Destructor + tags: + - method + defined_in_file: forest.hpp + is_dtor: true + overloads: + ~forest(): + description: __OPTIONAL__ + signature_with_names: ~forest() --- diff --git a/docs/libraries/forest.hpp/forest_range3CI3E/index.md b/docs/libraries/forest.hpp/forest_range3CI3E/index.md index 7cca9a987..b32c34457 100644 --- a/docs/libraries/forest.hpp/forest_range3CI3E/index.md +++ b/docs/libraries/forest.hpp/forest_range3CI3E/index.md @@ -1,21 +1,25 @@ --- layout: class title: forest_range -owner: fosterbrereton -brief: Utility class denoting a range composed of two iterators -tags: - - class -defined_in_file: forest.hpp -declaration: "template \nstruct stlab::forest_range;" -ctor: unspecified -dtor: unspecified -fields: - _f: - description: Iterator to the first element of the range - type: I - _l: - description: Iterator to one-past-the-last element of the range - type: I -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Utility class denoting a range composed of two iterators + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: forest.hpp + declaration: "template \nstruct stlab::forest_range;" + ctor: unspecified + dtor: unspecified + fields: + _f: + description: Iterator to the first element of the range + type: I + _l: + description: Iterator to one-past-the-last element of the range + type: I + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/forest_range3CI3E/m_begin.md b/docs/libraries/forest.hpp/forest_range3CI3E/m_begin.md index 90775403b..b35225702 100644 --- a/docs/libraries/forest.hpp/forest_range3CI3E/m_begin.md +++ b/docs/libraries/forest.hpp/forest_range3CI3E/m_begin.md @@ -1,14 +1,15 @@ --- layout: method title: begin -owner: fosterbrereton -brief: Get an iterator to the first element of the range -tags: - - method -defined_in_file: forest.hpp -overloads: - auto begin() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: auto begin() const +hyde: + owner: fosterbrereton + brief: Get an iterator to the first element of the range + tags: + - method + defined_in_file: forest.hpp + overloads: + auto begin() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: auto begin() const --- diff --git a/docs/libraries/forest.hpp/forest_range3CI3E/m_end.md b/docs/libraries/forest.hpp/forest_range3CI3E/m_end.md index 062a114d8..9976a717e 100644 --- a/docs/libraries/forest.hpp/forest_range3CI3E/m_end.md +++ b/docs/libraries/forest.hpp/forest_range3CI3E/m_end.md @@ -1,14 +1,15 @@ --- layout: method title: end -owner: fosterbrereton -brief: Get an iterator to one-past-the-last element of the range -tags: - - method -defined_in_file: forest.hpp -overloads: - auto end() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: auto end() const +hyde: + owner: fosterbrereton + brief: Get an iterator to one-past-the-last element of the range + tags: + - method + defined_in_file: forest.hpp + overloads: + auto end() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: auto end() const --- diff --git a/docs/libraries/forest.hpp/index.md b/docs/libraries/forest.hpp/index.md index b224b8447..29144e0da 100644 --- a/docs/libraries/forest.hpp/index.md +++ b/docs/libraries/forest.hpp/index.md @@ -1,13 +1,14 @@ --- layout: library title: forest.hpp -owner: fosterbrereton -brief: Header file for the Forest data structure -tags: - - sourcefile -library-type: sourcefile -typedefs: - iterator: - definition: edge_iterator - description: __MISSING__ +hyde: + owner: fosterbrereton + brief: Header file for the Forest data structure + tags: + - sourcefile + library-type: sourcefile + typedefs: + iterator: + definition: edge_iterator + description: __MISSING__ --- diff --git a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/index.md b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/index.md index 7688fa946..44194b918 100644 --- a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/index.md +++ b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/index.md @@ -1,32 +1,36 @@ --- layout: class title: reverse_fullorder_iterator -owner: fosterbrereton -brief: Fullorder iterator that visits forest nodes in reverse -tags: - - class -defined_in_file: forest.hpp -declaration: "template \nstruct stlab::reverse_fullorder_iterator;" -dtor: unspecified -typedefs: - difference_type: - definition: typename std::iterator_traits::difference_type - description: difference type - iterator_category: - definition: typename std::iterator_traits::iterator_category - description: iterator category - iterator_type: - definition: I - description: iterator type - pointer: - definition: typename std::iterator_traits::pointer - description: pointer type - reference: - definition: typename std::iterator_traits::reference - description: reference type - value_type: - definition: typename std::iterator_traits::value_type - description: value type -namespace: - - stlab +hyde: + owner: fosterbrereton + brief: Fullorder iterator that visits forest nodes in reverse + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: forest.hpp + declaration: "template \nstruct stlab::reverse_fullorder_iterator;" + dtor: unspecified + typedefs: + difference_type: + definition: typename std::iterator_traits::difference_type + description: difference type + iterator_category: + definition: typename std::iterator_traits::iterator_category + description: iterator category + iterator_type: + definition: I + description: iterator type + pointer: + definition: typename std::iterator_traits::pointer + description: pointer type + reference: + definition: typename std::iterator_traits::reference + description: reference type + value_type: + definition: typename std::iterator_traits::value_type + description: value type + namespace: + - stlab --- diff --git a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_base.md b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_base.md index c9e7a3465..98e874fc1 100644 --- a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_base.md +++ b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_base.md @@ -1,14 +1,15 @@ --- layout: method title: base -owner: fosterbrereton -brief: Utility routine to retrieve the underlying iterator -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::reverse_fullorder_iterator::iterator_type base() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::reverse_fullorder_iterator::iterator_type base() const +hyde: + owner: fosterbrereton + brief: Utility routine to retrieve the underlying iterator + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::reverse_fullorder_iterator::iterator_type base() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::reverse_fullorder_iterator::iterator_type base() const --- diff --git a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_edge.md b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_edge.md index c61322c9d..0b0ac45ba 100644 --- a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_edge.md +++ b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_edge.md @@ -1,18 +1,19 @@ --- layout: method title: edge -owner: fosterbrereton -brief: Get or set the iterator’s node edge -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::forest_edge & edge(): - description: Mutable variant - return: __OPTIONAL__ - signature_with_names: stlab::forest_edge & edge() - stlab::forest_edge edge() const: - description: Const variant - return: __OPTIONAL__ - signature_with_names: stlab::forest_edge edge() const +hyde: + owner: fosterbrereton + brief: Get or set the iterator’s node edge + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::forest_edge & edge(): + description: Mutable variant + return: __OPTIONAL__ + signature_with_names: stlab::forest_edge & edge() + stlab::forest_edge edge() const: + description: Const variant + return: __OPTIONAL__ + signature_with_names: stlab::forest_edge edge() const --- diff --git a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_equal_node.md b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_equal_node.md index 12fa2458a..524db39e5 100644 --- a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_equal_node.md +++ b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_equal_node.md @@ -1,18 +1,19 @@ --- layout: method title: equal_node -owner: fosterbrereton -brief: Node equality operator -tags: - - method -defined_in_file: forest.hpp -overloads: - bool equal_node(const reverse_fullorder_iterator &) const: - arguments: - - description: __OPTIONAL__ - name: y - type: const reverse_fullorder_iterator & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool equal_node(const reverse_fullorder_iterator & y) const +hyde: + owner: fosterbrereton + brief: Node equality operator + tags: + - method + defined_in_file: forest.hpp + overloads: + bool equal_node(const reverse_fullorder_iterator &) const: + arguments: + - description: __OPTIONAL__ + name: y + type: const reverse_fullorder_iterator & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool equal_node(const reverse_fullorder_iterator & y) const --- diff --git a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator--.md b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator--.md index d48c1d335..ecc8908ed 100644 --- a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator--.md +++ b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator--.md @@ -1,23 +1,24 @@ --- layout: method title: operator-- -owner: fosterbrereton -brief: Decrement operator -tags: - - method -defined_in_file: forest.hpp -overloads: - auto & operator--(): - description: predecrement - return: __OPTIONAL__ - signature_with_names: auto & operator--() - auto operator--(int): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: int - unnamed: true - description: postdecrement - return: __OPTIONAL__ - signature_with_names: auto operator--(int) +hyde: + owner: fosterbrereton + brief: Decrement operator + tags: + - method + defined_in_file: forest.hpp + overloads: + auto & operator--(): + description: predecrement + return: __OPTIONAL__ + signature_with_names: auto & operator--() + auto operator--(int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: int + unnamed: true + description: postdecrement + return: __OPTIONAL__ + signature_with_names: auto operator--(int) --- diff --git a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator-3E.md b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator-3E.md index 8542382df..95bc826b5 100644 --- a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator-3E.md +++ b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator-3E.md @@ -1,14 +1,15 @@ --- layout: method title: operator-> -owner: fosterbrereton -brief: Pointer dereference -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::reverse_fullorder_iterator::pointer operator->(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::reverse_fullorder_iterator::pointer operator->() +hyde: + owner: fosterbrereton + brief: Pointer dereference + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::reverse_fullorder_iterator::pointer operator->(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::reverse_fullorder_iterator::pointer operator->() --- diff --git a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator2A.md b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator2A.md index a629fe717..61f898c86 100644 --- a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator2A.md +++ b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator2A.md @@ -1,14 +1,15 @@ --- layout: method title: operator* -owner: fosterbrereton -brief: Dereference -tags: - - method -defined_in_file: forest.hpp -overloads: - stlab::reverse_fullorder_iterator::reference operator*(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: stlab::reverse_fullorder_iterator::reference operator*() +hyde: + owner: fosterbrereton + brief: Dereference + tags: + - method + defined_in_file: forest.hpp + overloads: + stlab::reverse_fullorder_iterator::reference operator*(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::reverse_fullorder_iterator::reference operator*() --- diff --git a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator2B2B.md b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator2B2B.md index ec0fd7573..5b58da256 100644 --- a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator2B2B.md +++ b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_operator2B2B.md @@ -1,23 +1,24 @@ --- layout: method title: operator++ -owner: fosterbrereton -brief: Increment operator -tags: - - method -defined_in_file: forest.hpp -overloads: - auto & operator++(): - description: preincrement - return: __OPTIONAL__ - signature_with_names: auto & operator++() - auto operator++(int): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: int - unnamed: true - description: postincrement - return: __OPTIONAL__ - signature_with_names: auto operator++(int) +hyde: + owner: fosterbrereton + brief: Increment operator + tags: + - method + defined_in_file: forest.hpp + overloads: + auto & operator++(): + description: preincrement + return: __OPTIONAL__ + signature_with_names: auto & operator++() + auto operator++(int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: int + unnamed: true + description: postincrement + return: __OPTIONAL__ + signature_with_names: auto operator++(int) --- diff --git a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_reverse_fullorder_iterator3CI3E.md b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_reverse_fullorder_iterator3CI3E.md index 73f829bb6..372320b6e 100644 --- a/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_reverse_fullorder_iterator3CI3E.md +++ b/docs/libraries/forest.hpp/reverse_fullorder_iterator3CI3E/m_reverse_fullorder_iterator3CI3E.md @@ -1,31 +1,29 @@ --- layout: method title: reverse_fullorder_iterator -owner: fosterbrereton -brief: Constructor -tags: - - method -defined_in_file: forest.hpp -is_ctor: true -overloads: - explicit reverse_fullorder_iterator(I): - arguments: - - description: __OPTIONAL__ - name: x - type: I - description: Iterator ctor - return: __OPTIONAL__ - signature_with_names: explicit reverse_fullorder_iterator(I x) - reverse_fullorder_iterator(): - description: Default ctor - return: __OPTIONAL__ - signature_with_names: reverse_fullorder_iterator() - "template \nreverse_fullorder_iterator(const reverse_fullorder_iterator &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const reverse_fullorder_iterator & - description: Rebase ctor - return: __OPTIONAL__ - signature_with_names: "template \nreverse_fullorder_iterator(const reverse_fullorder_iterator & x)" +hyde: + owner: fosterbrereton + brief: Constructor + tags: + - method + defined_in_file: forest.hpp + is_ctor: true + overloads: + explicit reverse_fullorder_iterator(I): + arguments: + - description: __OPTIONAL__ + name: x + type: I + description: Iterator ctor + signature_with_names: explicit reverse_fullorder_iterator(I x) + reverse_fullorder_iterator(): + description: Default ctor + signature_with_names: reverse_fullorder_iterator() + "template \nreverse_fullorder_iterator(const reverse_fullorder_iterator &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const reverse_fullorder_iterator & + description: Rebase ctor + signature_with_names: "template \nreverse_fullorder_iterator(const reverse_fullorder_iterator & x)" --- diff --git a/docs/libraries/forest.hpp/stlab3A3Aforest_edge.md b/docs/libraries/forest.hpp/stlab3A3Aforest_edge.md index e18e6ffcb..f853c60e2 100644 --- a/docs/libraries/forest.hpp/stlab3A3Aforest_edge.md +++ b/docs/libraries/forest.hpp/stlab3A3Aforest_edge.md @@ -1,16 +1,20 @@ --- layout: enumeration title: forest_edge -owner: fosterbrereton -brief: Forest iterator edge enumerator -tags: - - enumeration -defined_in_file: forest.hpp -namespace: - - stlab -values: - - description: Iterator is on the trailing edge of the node - name: trailing - - description: Iterator is on the leading edge of the node - name: leading +hyde: + owner: fosterbrereton + brief: Forest iterator edge enumerator + tags: + - enumeration + inline: + description: + - "***********************************************************************************************" + defined_in_file: forest.hpp + namespace: + - stlab + values: + - description: Iterator is on the trailing edge of the node + name: trailing + - description: Iterator is on the leading edge of the node + name: leading --- diff --git a/docs/libraries/forest_algorithms.hpp/f_equal_shape.md b/docs/libraries/forest_algorithms.hpp/f_equal_shape.md index f182a20c1..2614b29a7 100644 --- a/docs/libraries/forest_algorithms.hpp/f_equal_shape.md +++ b/docs/libraries/forest_algorithms.hpp/f_equal_shape.md @@ -1,24 +1,33 @@ --- layout: function title: equal_shape -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: forest_algorithms.hpp -overloads: - "template \nbool equal_shape(const Forest1 &, const Forest2 &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const Forest1 & - - description: __OPTIONAL__ - name: y - type: const Forest2 & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nbool equal_shape(const Forest1 & x, const Forest2 & y)" -namespace: - - stlab - - forests +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + - "\"Congruent\" would be a nice name here, but in geometry that also implies reflection." + defined_in_file: forest_algorithms.hpp + overloads: + "template \nbool equal_shape(const Forest1 &, const Forest2 &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const Forest1 & + - description: __OPTIONAL__ + name: y + type: const Forest2 & + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + - "\"Congruent\" would be a nice name here, but in geometry that also implies reflection." + return: __OPTIONAL__ + signature_with_names: "template \nbool equal_shape(const Forest1 & x, const Forest2 & y)" + namespace: + - stlab + - forests --- diff --git a/docs/libraries/forest_algorithms.hpp/f_flatten.md b/docs/libraries/forest_algorithms.hpp/f_flatten.md index b95001b96..0e57c3dd3 100644 --- a/docs/libraries/forest_algorithms.hpp/f_flatten.md +++ b/docs/libraries/forest_algorithms.hpp/f_flatten.md @@ -1,27 +1,34 @@ --- layout: function title: flatten -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: forest_algorithms.hpp -overloads: - "template \nauto flatten(I, I, O)": - arguments: - - description: __OPTIONAL__ - name: first - type: I - - description: __OPTIONAL__ - name: last - type: I - - description: __OPTIONAL__ - name: out - type: O - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto flatten(I first, I last, O out)" -namespace: - - stlab - - forests +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest_algorithms.hpp + overloads: + "template \nauto flatten(I, I, O)": + arguments: + - description: __OPTIONAL__ + name: first + type: I + - description: __OPTIONAL__ + name: last + type: I + - description: __OPTIONAL__ + name: out + type: O + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto flatten(I first, I last, O out)" + namespace: + - stlab + - forests --- diff --git a/docs/libraries/forest_algorithms.hpp/f_transcribe.md b/docs/libraries/forest_algorithms.hpp/f_transcribe.md index 6f2ce5f06..237ae8366 100644 --- a/docs/libraries/forest_algorithms.hpp/f_transcribe.md +++ b/docs/libraries/forest_algorithms.hpp/f_transcribe.md @@ -1,81 +1,88 @@ --- layout: function title: transcribe -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: forest_algorithms.hpp -overloads: - "template \nauto transcribe(I, I, O, P, UP)": - arguments: - - description: __OPTIONAL__ - name: first - type: I - - description: __OPTIONAL__ - name: last - type: I - - description: __OPTIONAL__ - name: out - type: O - - description: __OPTIONAL__ - name: proj - type: P - - description: __OPTIONAL__ - name: pred - type: UP - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto transcribe(I first, I last, O out, P proj, UP pred)" - "template \nauto transcribe(I, I, O, P)": - arguments: - - description: __OPTIONAL__ - name: first - type: I - - description: __OPTIONAL__ - name: last - type: I - - description: __OPTIONAL__ - name: out - type: O - - description: __OPTIONAL__ - name: proj - type: P - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto transcribe(I first, I last, O out, P proj)" - "template \nauto transcribe(const R &, O, P, UP)": - arguments: - - description: __OPTIONAL__ - name: range - type: const R & - - description: __OPTIONAL__ - name: out - type: O - - description: __OPTIONAL__ - name: proj - type: P - - description: __OPTIONAL__ - name: pred - type: UP - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto transcribe(const R & range, O out, P proj, UP pred)" - "template \nauto transcribe(const R &, O, P)": - arguments: - - description: __OPTIONAL__ - name: range - type: const R & - - description: __OPTIONAL__ - name: out - type: O - - description: __OPTIONAL__ - name: proj - type: P - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto transcribe(const R & range, O out, P proj)" -namespace: - - stlab - - forests +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest_algorithms.hpp + overloads: + "template \nauto transcribe(I, I, O, P, UP)": + arguments: + - description: __OPTIONAL__ + name: first + type: I + - description: __OPTIONAL__ + name: last + type: I + - description: __OPTIONAL__ + name: out + type: O + - description: __OPTIONAL__ + name: proj + type: P + - description: __OPTIONAL__ + name: pred + type: UP + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto transcribe(I first, I last, O out, P proj, UP pred)" + "template \nauto transcribe(I, I, O, P)": + arguments: + - description: __OPTIONAL__ + name: first + type: I + - description: __OPTIONAL__ + name: last + type: I + - description: __OPTIONAL__ + name: out + type: O + - description: __OPTIONAL__ + name: proj + type: P + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto transcribe(I first, I last, O out, P proj)" + "template \nauto transcribe(const R &, O, P, UP)": + arguments: + - description: __OPTIONAL__ + name: range + type: const R & + - description: __OPTIONAL__ + name: out + type: O + - description: __OPTIONAL__ + name: proj + type: P + - description: __OPTIONAL__ + name: pred + type: UP + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto transcribe(const R & range, O out, P proj, UP pred)" + "template \nauto transcribe(const R &, O, P)": + arguments: + - description: __OPTIONAL__ + name: range + type: const R & + - description: __OPTIONAL__ + name: out + type: O + - description: __OPTIONAL__ + name: proj + type: P + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nauto transcribe(const R & range, O out, P proj)" + namespace: + - stlab + - forests --- diff --git a/docs/libraries/forest_algorithms.hpp/f_transcriber.md b/docs/libraries/forest_algorithms.hpp/f_transcriber.md index 0990b11c0..2e1957520 100644 --- a/docs/libraries/forest_algorithms.hpp/f_transcriber.md +++ b/docs/libraries/forest_algorithms.hpp/f_transcriber.md @@ -1,21 +1,22 @@ --- layout: function title: transcriber -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: forest_algorithms.hpp -overloads: - "template \nauto transcriber(Container &)": - arguments: - - description: __OPTIONAL__ - name: c - type: Container & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto transcriber(Container & c)" -namespace: - - stlab - - forests +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: forest_algorithms.hpp + overloads: + "template \nauto transcriber(Container &)": + arguments: + - description: __OPTIONAL__ + name: c + type: Container & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: "template \nauto transcriber(Container & c)" + namespace: + - stlab + - forests --- diff --git a/docs/libraries/forest_algorithms.hpp/f_unflatten.md b/docs/libraries/forest_algorithms.hpp/f_unflatten.md index a38a3304a..a86f6a49a 100644 --- a/docs/libraries/forest_algorithms.hpp/f_unflatten.md +++ b/docs/libraries/forest_algorithms.hpp/f_unflatten.md @@ -1,27 +1,34 @@ --- layout: function title: unflatten -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: forest_algorithms.hpp -overloads: - "template \nauto unflatten(I, I, F &)": - arguments: - - description: __OPTIONAL__ - name: first - type: I - - description: __OPTIONAL__ - name: last - type: I - - description: __OPTIONAL__ - name: f - type: F & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto unflatten(I first, I last, F & f)" -namespace: - - stlab - - forests +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: forest_algorithms.hpp + overloads: + "template \nauto unflatten(I, I, F &)": + arguments: + - description: __OPTIONAL__ + name: first + type: I + - description: __OPTIONAL__ + name: last + type: I + - description: __OPTIONAL__ + name: f + type: F & + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto unflatten(I first, I last, F & f)" + namespace: + - stlab + - forests --- diff --git a/docs/libraries/forest_algorithms.hpp/index.md b/docs/libraries/forest_algorithms.hpp/index.md index 54a0b56a1..7d1b14896 100644 --- a/docs/libraries/forest_algorithms.hpp/index.md +++ b/docs/libraries/forest_algorithms.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: forest_algorithms.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/index.md b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/index.md index 11021ea5f..103e35aa9 100644 --- a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/index.md +++ b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/index.md @@ -1,33 +1,37 @@ --- layout: class title: transcribe_iterator -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: forest_algorithms.hpp -declaration: "template \nstruct stlab::forests::transcribe_iterator;" -dtor: unspecified -typedefs: - container_type: - definition: Container - description: __MISSING__ - difference_type: - definition: void - description: __MISSING__ - iterator_category: - definition: std::output_iterator_tag - description: __MISSING__ - pointer: - definition: void - description: __MISSING__ - reference: - definition: void - description: __MISSING__ - value_type: - definition: void - description: __MISSING__ -namespace: - - stlab - - forests +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: forest_algorithms.hpp + declaration: "template \nstruct stlab::forests::transcribe_iterator;" + dtor: unspecified + typedefs: + container_type: + definition: Container + description: __MISSING__ + difference_type: + definition: void + description: __MISSING__ + iterator_category: + definition: std::output_iterator_tag + description: __MISSING__ + pointer: + definition: void + description: __MISSING__ + reference: + definition: void + description: __MISSING__ + value_type: + definition: void + description: __MISSING__ + namespace: + - stlab + - forests --- diff --git a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator2A.md b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator2A.md index b5472ec13..4cc9c10e4 100644 --- a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator2A.md +++ b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator2A.md @@ -1,14 +1,15 @@ --- layout: method title: operator* -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: forest_algorithms.hpp -overloads: - constexpr auto & operator*(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: constexpr auto & operator*() +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: forest_algorithms.hpp + overloads: + constexpr auto & operator*(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: constexpr auto & operator*() --- diff --git a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator2B2B.md b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator2B2B.md index d68e3297c..872c90392 100644 --- a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator2B2B.md +++ b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator2B2B.md @@ -1,23 +1,24 @@ --- layout: method title: operator++ -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: forest_algorithms.hpp -overloads: - constexpr auto & operator++(): - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: constexpr auto & operator++() - constexpr auto operator++(int): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: int - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: constexpr auto operator++(int) +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: forest_algorithms.hpp + overloads: + constexpr auto & operator++(): + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: constexpr auto & operator++() + constexpr auto operator++(int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: int + unnamed: true + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: constexpr auto operator++(int) --- diff --git a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator3D.md b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator3D.md index 27110c2e6..9713110e5 100644 --- a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator3D.md +++ b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_operator3D.md @@ -1,26 +1,27 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: forest_algorithms.hpp -overloads: - constexpr auto & operator=(const typename Container::value_type &): - arguments: - - description: __OPTIONAL__ - name: value - type: const typename Container::value_type & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: constexpr auto & operator=(const typename Container::value_type & value) - constexpr auto & operator=(typename Container::value_type &&): - arguments: - - description: __OPTIONAL__ - name: value - type: typename Container::value_type && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: constexpr auto & operator=(typename Container::value_type && value) +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: forest_algorithms.hpp + overloads: + constexpr auto & operator=(const typename Container::value_type &): + arguments: + - description: __OPTIONAL__ + name: value + type: const typename Container::value_type & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: constexpr auto & operator=(const typename Container::value_type & value) + constexpr auto & operator=(typename Container::value_type &&): + arguments: + - description: __OPTIONAL__ + name: value + type: typename Container::value_type && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: constexpr auto & operator=(typename Container::value_type && value) --- diff --git a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_trailing.md b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_trailing.md index af0c40a92..0a8e98809 100644 --- a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_trailing.md +++ b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_trailing.md @@ -1,14 +1,15 @@ --- layout: method title: trailing -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: forest_algorithms.hpp -overloads: - constexpr auto trailing(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: constexpr auto trailing() +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: forest_algorithms.hpp + overloads: + constexpr auto trailing(): + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: constexpr auto trailing() --- diff --git a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_transcribe_iterator3CContainer3E.md b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_transcribe_iterator3CContainer3E.md index 2a55951e9..01b72725b 100644 --- a/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_transcribe_iterator3CContainer3E.md +++ b/docs/libraries/forest_algorithms.hpp/transcribe_iterator3CContainer3E/m_transcribe_iterator3CContainer3E.md @@ -1,22 +1,22 @@ --- layout: method title: transcribe_iterator -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: forest_algorithms.hpp -is_ctor: true -overloads: - transcribe_iterator(Container &, typename Container::iterator): - arguments: - - description: __OPTIONAL__ - name: c - type: Container & - - description: __OPTIONAL__ - name: i - type: typename Container::iterator - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: transcribe_iterator(Container & c, typename Container::iterator i) +hyde: + owner: __MISSING__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: forest_algorithms.hpp + is_ctor: true + overloads: + transcribe_iterator(Container &, typename Container::iterator): + arguments: + - description: __OPTIONAL__ + name: c + type: Container & + - description: __OPTIONAL__ + name: i + type: typename Container::iterator + description: __OPTIONAL__ + signature_with_names: transcribe_iterator(Container & c, typename Container::iterator i) --- diff --git a/docs/libraries/functional.hpp/f_unwrap.md b/docs/libraries/functional.hpp/f_unwrap.md index f51a57326..1164cf03d 100644 --- a/docs/libraries/functional.hpp/f_unwrap.md +++ b/docs/libraries/functional.hpp/f_unwrap.md @@ -1,45 +1,52 @@ --- layout: function title: unwrap -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: functional.hpp -overloads: - "template \nT & unwrap(T &)": - arguments: - - description: __OPTIONAL__ - name: val - type: T & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nT & unwrap(T & val)" - "template \nT & unwrap(std::reference_wrapper &)": - arguments: - - description: __OPTIONAL__ - name: val - type: std::reference_wrapper & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nT & unwrap(std::reference_wrapper & val)" - "template \nconst T & unwrap(const T &)": - arguments: - - description: __OPTIONAL__ - name: val - type: const T & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconst T & unwrap(const T & val)" - "template \nconst T & unwrap(const std::reference_wrapper &)": - arguments: - - description: __OPTIONAL__ - name: val - type: const std::reference_wrapper & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nconst T & unwrap(const std::reference_wrapper & val)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: functional.hpp + overloads: + "template \nT & unwrap(T &)": + arguments: + - description: __OPTIONAL__ + name: val + type: T & + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nT & unwrap(T & val)" + "template \nT & unwrap(std::reference_wrapper &)": + arguments: + - description: __OPTIONAL__ + name: val + type: std::reference_wrapper & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nT & unwrap(std::reference_wrapper & val)" + "template \nconst T & unwrap(const T &)": + arguments: + - description: __OPTIONAL__ + name: val + type: const T & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconst T & unwrap(const T & val)" + "template \nconst T & unwrap(const std::reference_wrapper &)": + arguments: + - description: __OPTIONAL__ + name: val + type: const std::reference_wrapper & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: "template \nconst T & unwrap(const std::reference_wrapper & val)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/functional.hpp/index.md b/docs/libraries/functional.hpp/index.md index 1a49af9ba..d6a7d4d29 100644 --- a/docs/libraries/functional.hpp/index.md +++ b/docs/libraries/functional.hpp/index.md @@ -1,13 +1,14 @@ --- layout: library title: functional.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile -typedefs: - unwrap_reference_t: - definition: typename unwrap_reference::type - description: __MISSING__ +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile + typedefs: + unwrap_reference_t: + definition: typename unwrap_reference::type + description: __MISSING__ --- diff --git a/docs/libraries/functional.hpp/is_reference_wrapper3CT3E/index.md b/docs/libraries/functional.hpp/is_reference_wrapper3CT3E/index.md index 543f56348..4aad53240 100644 --- a/docs/libraries/functional.hpp/is_reference_wrapper3CT3E/index.md +++ b/docs/libraries/functional.hpp/is_reference_wrapper3CT3E/index.md @@ -1,15 +1,19 @@ --- layout: class title: is_reference_wrapper -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: functional.hpp -declaration: "template \nstruct stlab::is_reference_wrapper;" -ctor: unspecified -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: functional.hpp + declaration: "template \nstruct stlab::is_reference_wrapper;" + ctor: unspecified + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/functional.hpp/is_reference_wrapper3Cs.63c6d6bf/index.md b/docs/libraries/functional.hpp/is_reference_wrapper3Cs.63c6d6bf/index.md index 54c32b4dd..a6697d237 100644 --- a/docs/libraries/functional.hpp/is_reference_wrapper3Cs.63c6d6bf/index.md +++ b/docs/libraries/functional.hpp/is_reference_wrapper3Cs.63c6d6bf/index.md @@ -1,15 +1,16 @@ --- layout: class title: is_reference_wrapper> -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: functional.hpp -declaration: "\nstruct stlab::is_reference_wrapper;" -ctor: unspecified -dtor: unspecified -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: functional.hpp + declaration: "\nstruct stlab::is_reference_wrapper;" + ctor: unspecified + dtor: unspecified + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/functional.hpp/unwrap_reference3CT3E/index.md b/docs/libraries/functional.hpp/unwrap_reference3CT3E/index.md index 0a944b032..091bef9a9 100644 --- a/docs/libraries/functional.hpp/unwrap_reference3CT3E/index.md +++ b/docs/libraries/functional.hpp/unwrap_reference3CT3E/index.md @@ -1,19 +1,23 @@ --- layout: class title: unwrap_reference -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: functional.hpp -declaration: "template \nstruct stlab::unwrap_reference;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: T - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: functional.hpp + declaration: "template \nstruct stlab::unwrap_reference;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: T + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/functional.hpp/unwrap_reference3Cstd3A.d26820ce/index.md b/docs/libraries/functional.hpp/unwrap_reference3Cstd3A.d26820ce/index.md index 2900dab82..b50c790d4 100644 --- a/docs/libraries/functional.hpp/unwrap_reference3Cstd3A.d26820ce/index.md +++ b/docs/libraries/functional.hpp/unwrap_reference3Cstd3A.d26820ce/index.md @@ -1,19 +1,20 @@ --- layout: class title: unwrap_reference> -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: functional.hpp -declaration: "\nstruct stlab::unwrap_reference;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: T - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: functional.hpp + declaration: "\nstruct stlab::unwrap_reference;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: T + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/index.md b/docs/libraries/index.md index 4aecf3056..7c784de8d 100644 --- a/docs/libraries/index.md +++ b/docs/libraries/index.md @@ -1,14 +1,15 @@ --- layout: library title: API Documentation -owner: fbrereto -brief: The stlab libraries -tags: - - library -library-type: library -icon: book -short_title: __OPTIONAL__ -tab: API Docs +hyde: + owner: fbrereto + brief: The stlab libraries + tags: + - library + library-type: library + icon: book + short_title: __OPTIONAL__ + tab: API Docs --- ### Source Code diff --git a/docs/libraries/iterator/set_next.hpp/index.md b/docs/libraries/iterator/set_next.hpp/index.md index 653ff8812..62c83d894 100644 --- a/docs/libraries/iterator/set_next.hpp/index.md +++ b/docs/libraries/iterator/set_next.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: iterator/set_next.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/memory.hpp/f_make_weak_ptr.md b/docs/libraries/memory.hpp/f_make_weak_ptr.md index 979523c29..353679506 100644 --- a/docs/libraries/memory.hpp/f_make_weak_ptr.md +++ b/docs/libraries/memory.hpp/f_make_weak_ptr.md @@ -1,21 +1,28 @@ --- layout: function title: make_weak_ptr -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: memory.hpp -overloads: - "template \nauto make_weak_ptr(const std::shared_ptr &)": - arguments: - - description: __OPTIONAL__ - name: x - type: const std::shared_ptr & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nauto make_weak_ptr(const std::shared_ptr & x)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: memory.hpp + overloads: + "template \nauto make_weak_ptr(const std::shared_ptr &)": + arguments: + - description: __OPTIONAL__ + name: x + type: const std::shared_ptr & + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto make_weak_ptr(const std::shared_ptr & x)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/memory.hpp/index.md b/docs/libraries/memory.hpp/index.md index 6111d3cf9..42bc3e074 100644 --- a/docs/libraries/memory.hpp/index.md +++ b/docs/libraries/memory.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: memory.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/pre_exit.hpp/f_at_pre_exit.md b/docs/libraries/pre_exit.hpp/f_at_pre_exit.md index 5f66726b5..158fb432e 100644 --- a/docs/libraries/pre_exit.hpp/f_at_pre_exit.md +++ b/docs/libraries/pre_exit.hpp/f_at_pre_exit.md @@ -1,21 +1,28 @@ --- layout: function title: at_pre_exit -owner: sean-parent -brief: Register the `pre_exit_handler` to be called on [`pre_exit()`](./f_pre_exit.html). -tags: - - function -defined_in_file: pre_exit.hpp -overloads: - void at_pre_exit(stlab::pre_exit_handler): - arguments: - - description: __OPTIONAL__ - name: f - type: stlab::pre_exit_handler - description: Register the `pre_exit_handler` to be called on [`pre_exit()`](./f_pre_exit.html). The functions are called in the reverse order that they are registered. - return: __OPTIONAL__ - signature_with_names: void at_pre_exit(stlab::pre_exit_handler f) -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Register the `pre_exit_handler` to be called on [`pre_exit()`](./f_pre_exit.html). + tags: + - function + inline: + brief: + - Register a pre-exit handler. The pre-exit-handler may not throw. With C++17 or later it is required to be `noexcept`. + defined_in_file: pre_exit.hpp + overloads: + void at_pre_exit(stlab::pre_exit_handler): + arguments: + - description: __OPTIONAL__ + name: f + type: stlab::pre_exit_handler + description: Register the `pre_exit_handler` to be called on [`pre_exit()`](./f_pre_exit.html). The functions are called in the reverse order that they are registered. + inline: + description: + - Register a pre-exit handler. The pre-exit-handler may not throw. With C++17 or later it is required to be `noexcept`. + return: __OPTIONAL__ + signature_with_names: void at_pre_exit(stlab::pre_exit_handler f) + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/pre_exit.hpp/f_pre_exit.md b/docs/libraries/pre_exit.hpp/f_pre_exit.md index 8be92bc7f..1222ee9b7 100644 --- a/docs/libraries/pre_exit.hpp/f_pre_exit.md +++ b/docs/libraries/pre_exit.hpp/f_pre_exit.md @@ -1,17 +1,24 @@ --- layout: function title: pre_exit -owner: sean-parent -brief: Invokes `pre_exit_handler`s registered with [`at_pre_exit`](./f_at_pre_exit.html). -tags: - - function -defined_in_file: pre_exit.hpp -overloads: - void pre_exit(): - description: Invokes `pre_exit_handler`s registered with [`at_pre_exit`](./f_at_pre_exit.html) in the reverse order they where registered. - return: __OPTIONAL__ - signature_with_names: void pre_exit() -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Invokes `pre_exit_handler`s registered with [`at_pre_exit`](./f_at_pre_exit.html). + tags: + - function + inline: + brief: + - Invoke all registered pre-exit handlers in the reverse order they are registered. It is safe to register additional handlers during this operation. Must be invoked exactly once prior to program exit. + defined_in_file: pre_exit.hpp + overloads: + void pre_exit(): + description: Invokes `pre_exit_handler`s registered with [`at_pre_exit`](./f_at_pre_exit.html) in the reverse order they where registered. + inline: + description: + - Invoke all registered pre-exit handlers in the reverse order they are registered. It is safe to register additional handlers during this operation. Must be invoked exactly once prior to program exit. + return: __OPTIONAL__ + signature_with_names: void pre_exit() + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/pre_exit.hpp/index.md b/docs/libraries/pre_exit.hpp/index.md index f479bf220..f74c7b2aa 100644 --- a/docs/libraries/pre_exit.hpp/index.md +++ b/docs/libraries/pre_exit.hpp/index.md @@ -1,15 +1,16 @@ --- layout: library title: pre_exit.hpp -owner: sean-parent -brief: Utilities to handle the invocation of operations that must happen prior to program exit. -tags: - - sourcefile -library-type: sourcefile -typedefs: - pre_exit_handler: - definition: void (*)() noexcept - description: A function to be invoked prior on `pre_exit()`. +hyde: + owner: sean-parent + brief: Utilities to handle the invocation of operations that must happen prior to program exit. + tags: + - sourcefile + library-type: sourcefile + typedefs: + pre_exit_handler: + definition: void (*)() noexcept + description: A function to be invoked prior on `pre_exit()`. --- Utilities to register and invoke operations that must be executed prior to exit. `pre_exit()` must be invoked explicitely before program exit (via `std::exit()` or exiting `main()`). diff --git a/docs/libraries/scope.hpp/f_scope.md b/docs/libraries/scope.hpp/f_scope.md index 9374ee938..dcca23303 100644 --- a/docs/libraries/scope.hpp/f_scope.md +++ b/docs/libraries/scope.hpp/f_scope.md @@ -1,36 +1,41 @@ --- layout: function title: scope -owner: sean-parent -brief: Explicitly scope the lifetime of an object -example: [ scope_example.cpp, scope_example_return.cpp ] -tags: - - function -defined_in_file: scope.hpp -overloads: - "template \nauto scope(std::mutex &, F &&)": - arguments: - - description: __OPTIONAL__ - name: m - type: std::mutex & - - description: __OPTIONAL__ - name: f - type: F && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: "template \nauto scope(std::mutex & m, F && f)" - "template \nauto scope(Args &&...)": - arguments: - - description: Range of parameters forwarded to the constructor of `T` - name: | - [ args[0], args[N-1] ) - type: Args &&... - - description: A callable nullary function - name: args[N-1] - description: Scopes the lifetime of an instance of `T`. All but the last parameters are used to construct `T`, while the last parameter is assumed to be a nullary function, and is called. After the nullary function goes out of scope, `T` is destroyed. - return: __OPTIONAL__ - signature_with_names: "template \nauto scope(Args &&... args)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Explicitly scope the lifetime of an object + tags: + - function + inline: + brief: _multiple descriptions_ + defined_in_file: scope.hpp + overloads: + "template \nauto scope(std::mutex &, F &&)": + arguments: + - description: __OPTIONAL__ + name: m + type: std::mutex & + - description: __OPTIONAL__ + name: f + type: F && + description: __INLINED__ + inline: + description: + - Workaround until VS2017 bug is fixed + return: __OPTIONAL__ + signature_with_names: "template \nauto scope(std::mutex & m, F && f)" + "template \nauto scope(Args &&...)": + arguments: + - description: __OPTIONAL__ + name: args + type: Args &&... + description: Scopes the lifetime of an instance of `T`. All but the last parameters are used to construct `T`, while the last parameter is assumed to be a nullary function, and is called. After the nullary function goes out of scope, `T` is destroyed. + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nauto scope(Args &&... args)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/scope.hpp/index.md b/docs/libraries/scope.hpp/index.md index 31c38d3a6..ea69828d5 100644 --- a/docs/libraries/scope.hpp/index.md +++ b/docs/libraries/scope.hpp/index.md @@ -1,11 +1,12 @@ --- layout: library title: scope.hpp -owner: sean-parent -brief: Explicitly scope the lifetime of an object -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: sean-parent + brief: Explicitly scope the lifetime of an object + tags: + - sourcefile + library-type: sourcefile --- Oftentimes developers will add scopes to code where they want to limit the lifetime of an object. For example: diff --git a/docs/libraries/test/model.hpp/annotate/f_operator213D.md b/docs/libraries/test/model.hpp/annotate/f_operator213D.md index 310f73a88..45176e141 100644 --- a/docs/libraries/test/model.hpp/annotate/f_operator213D.md +++ b/docs/libraries/test/model.hpp/annotate/f_operator213D.md @@ -1,35 +1,36 @@ --- layout: function title: operator!= -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: test/model.hpp -overloads: - bool operator!=(const stlab::annotate &, const stlab::annotate &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::annotate & - - description: __OPTIONAL__ - name: y - type: const stlab::annotate & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const stlab::annotate & x, const stlab::annotate & y) - bool operator!=(const stlab::regular &, const stlab::regular &): - arguments: - - description: __OPTIONAL__ - name: lhs - type: const stlab::regular & - - description: __OPTIONAL__ - name: rhs - type: const stlab::regular & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator!=(const stlab::regular & lhs, const stlab::regular & rhs) -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: test/model.hpp + overloads: + bool operator!=(const stlab::annotate &, const stlab::annotate &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::annotate & + - description: __OPTIONAL__ + name: y + type: const stlab::annotate & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const stlab::annotate & x, const stlab::annotate & y) + bool operator!=(const stlab::regular &, const stlab::regular &): + arguments: + - description: __OPTIONAL__ + name: lhs + type: const stlab::regular & + - description: __OPTIONAL__ + name: rhs + type: const stlab::regular & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator!=(const stlab::regular & lhs, const stlab::regular & rhs) + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/test/model.hpp/annotate/f_operator3D3D.md b/docs/libraries/test/model.hpp/annotate/f_operator3D3D.md index 4409e3d91..c0b026230 100644 --- a/docs/libraries/test/model.hpp/annotate/f_operator3D3D.md +++ b/docs/libraries/test/model.hpp/annotate/f_operator3D3D.md @@ -1,35 +1,36 @@ --- layout: function title: operator== -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: test/model.hpp -overloads: - bool operator==(const stlab::annotate &, const stlab::annotate &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::annotate & - - description: __OPTIONAL__ - name: y - type: const stlab::annotate & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const stlab::annotate & x, const stlab::annotate & y) - bool operator==(const stlab::regular &, const stlab::regular &): - arguments: - - description: __OPTIONAL__ - name: lhs - type: const stlab::regular & - - description: __OPTIONAL__ - name: rhs - type: const stlab::regular & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: bool operator==(const stlab::regular & lhs, const stlab::regular & rhs) -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: test/model.hpp + overloads: + bool operator==(const stlab::annotate &, const stlab::annotate &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::annotate & + - description: __OPTIONAL__ + name: y + type: const stlab::annotate & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const stlab::annotate & x, const stlab::annotate & y) + bool operator==(const stlab::regular &, const stlab::regular &): + arguments: + - description: __OPTIONAL__ + name: lhs + type: const stlab::regular & + - description: __OPTIONAL__ + name: rhs + type: const stlab::regular & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: bool operator==(const stlab::regular & lhs, const stlab::regular & rhs) + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/test/model.hpp/annotate/f_swap.md b/docs/libraries/test/model.hpp/annotate/f_swap.md index f4d31b6bd..0314b7ae4 100644 --- a/docs/libraries/test/model.hpp/annotate/f_swap.md +++ b/docs/libraries/test/model.hpp/annotate/f_swap.md @@ -1,35 +1,36 @@ --- layout: function title: swap -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: test/model.hpp -overloads: - void swap(stlab::annotate &, stlab::annotate &): - arguments: - - description: __OPTIONAL__ - name: x - type: stlab::annotate & - - description: __OPTIONAL__ - name: y - type: stlab::annotate & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(stlab::annotate & x, stlab::annotate & y) - void swap(stlab::regular &, stlab::regular &): - arguments: - - description: __OPTIONAL__ - name: lhs - type: stlab::regular & - - description: __OPTIONAL__ - name: rhs - type: stlab::regular & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: void swap(stlab::regular & lhs, stlab::regular & rhs) -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: test/model.hpp + overloads: + void swap(stlab::annotate &, stlab::annotate &): + arguments: + - description: __OPTIONAL__ + name: x + type: stlab::annotate & + - description: __OPTIONAL__ + name: y + type: stlab::annotate & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: void swap(stlab::annotate & x, stlab::annotate & y) + void swap(stlab::regular &, stlab::regular &): + arguments: + - description: __OPTIONAL__ + name: lhs + type: stlab::regular & + - description: __OPTIONAL__ + name: rhs + type: stlab::regular & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: void swap(stlab::regular & lhs, stlab::regular & rhs) + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/test/model.hpp/annotate/index.md b/docs/libraries/test/model.hpp/annotate/index.md index 8dd98885a..89354ec81 100644 --- a/docs/libraries/test/model.hpp/annotate/index.md +++ b/docs/libraries/test/model.hpp/annotate/index.md @@ -1,20 +1,20 @@ --- layout: class title: annotate -owner: sean-parent -brief: A class used to illustrate compiler and object behavior -example: annotate_rvo_example.cpp -tags: - - class -defined_in_file: test/model.hpp -declaration: "\nstruct stlab::annotate;" -fields: - _counters: - description: __MISSING__ - type: stlab::annotate_counters * -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: A class used to illustrate compiler and object behavior + tags: + - class + defined_in_file: test/model.hpp + declaration: "\nstruct stlab::annotate;" + fields: + _counters: + description: __MISSING__ + type: stlab::annotate_counters * + namespace: + - stlab + - v1 --- `annotate` will increase a passed operation counter when one of these operations happen to an instance: diff --git a/docs/libraries/test/model.hpp/annotate/m_annotate.md b/docs/libraries/test/model.hpp/annotate/m_annotate.md index 10d11fba6..ae233d2d6 100644 --- a/docs/libraries/test/model.hpp/annotate/m_annotate.md +++ b/docs/libraries/test/model.hpp/annotate/m_annotate.md @@ -1,35 +1,33 @@ --- layout: method title: annotate -owner: sean-parent -brief: Constructs an annotate -tags: - - method -defined_in_file: test/model.hpp -is_ctor: true -overloads: - annotate(const stlab::annotate &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::annotate & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: annotate(const stlab::annotate & x) - annotate(stlab::annotate &&): - arguments: - - description: __OPTIONAL__ - name: x - type: stlab::annotate && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: annotate(stlab::annotate && x) - explicit annotate(stlab::annotate_counters &): - arguments: - - description: The instance of counters in which all events are recorded - name: counters - type: stlab::annotate_counters & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: explicit annotate(stlab::annotate_counters & counters) +hyde: + owner: sean-parent + brief: Constructs an annotate + tags: + - method + defined_in_file: test/model.hpp + is_ctor: true + overloads: + annotate(const stlab::annotate &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::annotate & + description: __MISSING__ + signature_with_names: annotate(const stlab::annotate & x) + annotate(stlab::annotate &&): + arguments: + - description: __OPTIONAL__ + name: x + type: stlab::annotate && + description: __MISSING__ + signature_with_names: annotate(stlab::annotate && x) + explicit annotate(stlab::annotate_counters &): + arguments: + - description: The instance of counters in which all events are recorded + name: counters + type: stlab::annotate_counters & + description: __MISSING__ + signature_with_names: explicit annotate(stlab::annotate_counters & counters) --- diff --git a/docs/libraries/test/model.hpp/annotate/m_operator3D.md b/docs/libraries/test/model.hpp/annotate/m_operator3D.md index 5df736053..88d7a4ee7 100644 --- a/docs/libraries/test/model.hpp/annotate/m_operator3D.md +++ b/docs/libraries/test/model.hpp/annotate/m_operator3D.md @@ -1,26 +1,27 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -overloads: - stlab::annotate & operator=(const stlab::annotate &): - arguments: - - description: __OPTIONAL__ - name: x - type: const stlab::annotate & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::annotate & operator=(const stlab::annotate & x) - stlab::annotate & operator=(stlab::annotate &&): - arguments: - - description: __OPTIONAL__ - name: x - type: stlab::annotate && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::annotate & operator=(stlab::annotate && x) +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: test/model.hpp + overloads: + stlab::annotate & operator=(const stlab::annotate &): + arguments: + - description: __OPTIONAL__ + name: x + type: const stlab::annotate & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: stlab::annotate & operator=(const stlab::annotate & x) + stlab::annotate & operator=(stlab::annotate &&): + arguments: + - description: __OPTIONAL__ + name: x + type: stlab::annotate && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: stlab::annotate & operator=(stlab::annotate && x) --- diff --git a/docs/libraries/test/model.hpp/annotate/m_~annotate.md b/docs/libraries/test/model.hpp/annotate/m_~annotate.md index 3dc96437c..f37090221 100644 --- a/docs/libraries/test/model.hpp/annotate/m_~annotate.md +++ b/docs/libraries/test/model.hpp/annotate/m_~annotate.md @@ -1,15 +1,15 @@ --- layout: method title: ~annotate -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -is_dtor: true -overloads: - ~annotate(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~annotate() +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: test/model.hpp + is_dtor: true + overloads: + ~annotate(): + description: __OPTIONAL__ + signature_with_names: ~annotate() --- diff --git a/docs/libraries/test/model.hpp/annotate_counters/f_operator3C3C.md b/docs/libraries/test/model.hpp/annotate_counters/f_operator3C3C.md index c8fba4bd5..664a6182d 100644 --- a/docs/libraries/test/model.hpp/annotate_counters/f_operator3C3C.md +++ b/docs/libraries/test/model.hpp/annotate_counters/f_operator3C3C.md @@ -1,24 +1,25 @@ --- layout: function title: operator<< -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: test/model.hpp -overloads: - std::ostream & operator<<(std::ostream &, const stlab::annotate_counters &): - arguments: - - description: __OPTIONAL__ - name: out - type: std::ostream & - - description: __OPTIONAL__ - name: x - type: const stlab::annotate_counters & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: std::ostream & operator<<(std::ostream & out, const stlab::annotate_counters & x) -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: test/model.hpp + overloads: + std::ostream & operator<<(std::ostream &, const stlab::annotate_counters &): + arguments: + - description: __OPTIONAL__ + name: out + type: std::ostream & + - description: __OPTIONAL__ + name: x + type: const stlab::annotate_counters & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: std::ostream & operator<<(std::ostream & out, const stlab::annotate_counters & x) + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/test/model.hpp/annotate_counters/index.md b/docs/libraries/test/model.hpp/annotate_counters/index.md index 393b5dc79..a9e873cbf 100644 --- a/docs/libraries/test/model.hpp/annotate_counters/index.md +++ b/docs/libraries/test/model.hpp/annotate_counters/index.md @@ -1,49 +1,53 @@ --- layout: class title: annotate_counters -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: test/model.hpp -declaration: "\nstruct stlab::annotate_counters;" -ctor: unspecified -dtor: unspecified -fields: - _condition: - description: __MISSING__ - type: std::condition_variable - _copy_assign_lhs: - description: __MISSING__ - type: std::atomic_size_t - _copy_assign_rhs: - description: __MISSING__ - type: std::atomic_size_t - _copy_ctor: - description: __MISSING__ - type: std::atomic_size_t - _dtor: - description: __MISSING__ - type: std::atomic_size_t - _equality: - description: __MISSING__ - type: std::atomic_size_t - _move_assign_lhs: - description: __MISSING__ - type: std::atomic_size_t - _move_assign_rhs: - description: __MISSING__ - type: std::atomic_size_t - _move_ctor: - description: __MISSING__ - type: std::atomic_size_t - _mutex: - description: __MISSING__ - type: std::mutex - _swap: - description: __MISSING__ - type: std::atomic_size_t -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: test/model.hpp + declaration: "\nstruct stlab::annotate_counters;" + ctor: unspecified + dtor: unspecified + fields: + _condition: + description: __MISSING__ + type: std::condition_variable + _copy_assign_lhs: + description: __MISSING__ + type: std::atomic_size_t + _copy_assign_rhs: + description: __MISSING__ + type: std::atomic_size_t + _copy_ctor: + description: __MISSING__ + type: std::atomic_size_t + _dtor: + description: __MISSING__ + type: std::atomic_size_t + _equality: + description: __MISSING__ + type: std::atomic_size_t + _move_assign_lhs: + description: __MISSING__ + type: std::atomic_size_t + _move_assign_rhs: + description: __MISSING__ + type: std::atomic_size_t + _move_ctor: + description: __MISSING__ + type: std::atomic_size_t + _mutex: + description: __MISSING__ + type: std::mutex + _swap: + description: __MISSING__ + type: std::atomic_size_t + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/test/model.hpp/annotate_counters/m_annotate_counters.md b/docs/libraries/test/model.hpp/annotate_counters/m_annotate_counters.md index 8d1d1b4e7..81c3e1123 100644 --- a/docs/libraries/test/model.hpp/annotate_counters/m_annotate_counters.md +++ b/docs/libraries/test/model.hpp/annotate_counters/m_annotate_counters.md @@ -1,29 +1,32 @@ --- layout: method title: annotate_counters -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -is_ctor: true -overloads: - annotate_counters(const stlab::annotate_counters &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::annotate_counters & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: annotate_counters(const stlab::annotate_counters &) - annotate_counters(stlab::annotate_counters &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::annotate_counters && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: annotate_counters(stlab::annotate_counters &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: test/model.hpp + is_ctor: true + overloads: + annotate_counters(const stlab::annotate_counters &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::annotate_counters & + unnamed: true + description: __OPTIONAL__ + signature_with_names: annotate_counters(const stlab::annotate_counters &) + annotate_counters(stlab::annotate_counters &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::annotate_counters && + unnamed: true + description: __OPTIONAL__ + signature_with_names: annotate_counters(stlab::annotate_counters &&) --- diff --git a/docs/libraries/test/model.hpp/annotate_counters/m_operator3D.md b/docs/libraries/test/model.hpp/annotate_counters/m_operator3D.md index ca5c0cfcf..1cd10e1a0 100644 --- a/docs/libraries/test/model.hpp/annotate_counters/m_operator3D.md +++ b/docs/libraries/test/model.hpp/annotate_counters/m_operator3D.md @@ -1,28 +1,33 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -overloads: - stlab::annotate_counters & operator=(const stlab::annotate_counters &): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::annotate_counters & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::annotate_counters & operator=(const stlab::annotate_counters &) - stlab::annotate_counters & operator=(stlab::annotate_counters &&): - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::annotate_counters && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::annotate_counters & operator=(stlab::annotate_counters &&) +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: test/model.hpp + overloads: + stlab::annotate_counters & operator=(const stlab::annotate_counters &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::annotate_counters & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::annotate_counters & operator=(const stlab::annotate_counters &) + stlab::annotate_counters & operator=(stlab::annotate_counters &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::annotate_counters && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::annotate_counters & operator=(stlab::annotate_counters &&) --- diff --git a/docs/libraries/test/model.hpp/annotate_counters/m_remaining.md b/docs/libraries/test/model.hpp/annotate_counters/m_remaining.md index c68da7852..2c87413a8 100644 --- a/docs/libraries/test/model.hpp/annotate_counters/m_remaining.md +++ b/docs/libraries/test/model.hpp/annotate_counters/m_remaining.md @@ -1,14 +1,15 @@ --- layout: method title: remaining -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -overloads: - std::size_t remaining() const: - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: std::size_t remaining() const +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: test/model.hpp + overloads: + std::size_t remaining() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: std::size_t remaining() const --- diff --git a/docs/libraries/test/model.hpp/annotate_counters/m_wait.md b/docs/libraries/test/model.hpp/annotate_counters/m_wait.md index 63bd5082f..5ce464f2c 100644 --- a/docs/libraries/test/model.hpp/annotate_counters/m_wait.md +++ b/docs/libraries/test/model.hpp/annotate_counters/m_wait.md @@ -1,18 +1,19 @@ --- layout: method title: wait -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -overloads: - void wait(std::size_t): - arguments: - - description: __OPTIONAL__ - name: count - type: std::size_t - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: void wait(std::size_t count) +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - method + defined_in_file: test/model.hpp + overloads: + void wait(std::size_t): + arguments: + - description: __OPTIONAL__ + name: count + type: std::size_t + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: void wait(std::size_t count) --- diff --git a/docs/libraries/test/model.hpp/annotate_counters/m_~annotate_counters.md b/docs/libraries/test/model.hpp/annotate_counters/m_~annotate_counters.md index d8b7576eb..634628e17 100644 --- a/docs/libraries/test/model.hpp/annotate_counters/m_~annotate_counters.md +++ b/docs/libraries/test/model.hpp/annotate_counters/m_~annotate_counters.md @@ -1,15 +1,17 @@ --- layout: method title: ~annotate_counters -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -is_dtor: true -overloads: - ~annotate_counters(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~annotate_counters() +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: test/model.hpp + is_dtor: true + overloads: + ~annotate_counters(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: ~annotate_counters() --- diff --git a/docs/libraries/test/model.hpp/index.md b/docs/libraries/test/model.hpp/index.md index b33da3618..a066f1622 100644 --- a/docs/libraries/test/model.hpp/index.md +++ b/docs/libraries/test/model.hpp/index.md @@ -1,9 +1,10 @@ --- layout: library title: test/model.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile --- diff --git a/docs/libraries/test/model.hpp/move_only/index.md b/docs/libraries/test/model.hpp/move_only/index.md index 4ff0bf128..546661fcf 100644 --- a/docs/libraries/test/model.hpp/move_only/index.md +++ b/docs/libraries/test/model.hpp/move_only/index.md @@ -1,16 +1,19 @@ --- layout: class title: move_only -owner: sean-parent -brief: A class used to illustrate and test move-only semantics -example: move_only_rvo_example.cpp -tags: - - class -defined_in_file: test/model.hpp -declaration: "\nclass stlab::move_only;" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: A class used to illustrate and test move-only semantics + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: test/model.hpp + declaration: "\nclass stlab::move_only;" + namespace: + - stlab + - v1 --- A `move_only` instance is limited to move-only assignment and construction. It contains an integer that can be used for identification and is read with the `member()` function. \ No newline at end of file diff --git a/docs/libraries/test/model.hpp/move_only/m_member.md b/docs/libraries/test/model.hpp/move_only/m_member.md index ab8701f9d..c1b12a081 100644 --- a/docs/libraries/test/model.hpp/move_only/m_member.md +++ b/docs/libraries/test/model.hpp/move_only/m_member.md @@ -1,18 +1,19 @@ --- layout: method title: member -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -overloads: - int member(): - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: int member() - int member() const: - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: int member() const +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: test/model.hpp + overloads: + int member(): + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: int member() + int member() const: + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: int member() const --- diff --git a/docs/libraries/test/model.hpp/move_only/m_move_only.md b/docs/libraries/test/model.hpp/move_only/m_move_only.md index ce5ec3b06..c4cd806b8 100644 --- a/docs/libraries/test/model.hpp/move_only/m_move_only.md +++ b/docs/libraries/test/model.hpp/move_only/m_move_only.md @@ -1,45 +1,42 @@ --- layout: method title: move_only -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -is_ctor: true -overloads: - move_only(): - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: move_only() - move_only(const stlab::move_only &): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::move_only & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: move_only(const stlab::move_only &) - move_only(int): - arguments: - - description: __OPTIONAL__ - name: member - type: int - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: move_only(int member) - move_only(stlab::move_only &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::move_only && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: move_only(stlab::move_only &&) +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: test/model.hpp + is_ctor: true + overloads: + move_only(): + description: __MISSING__ + signature_with_names: move_only() + move_only(const stlab::move_only &): + annotation: + - deleted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::move_only & + unnamed: true + description: __OPTIONAL__ + signature_with_names: move_only(const stlab::move_only &) + move_only(int): + arguments: + - description: __OPTIONAL__ + name: member + type: int + description: __MISSING__ + signature_with_names: move_only(int member) + move_only(stlab::move_only &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::move_only && + unnamed: true + description: __OPTIONAL__ + signature_with_names: move_only(stlab::move_only &&) --- diff --git a/docs/libraries/test/model.hpp/move_only/m_operator3D.md b/docs/libraries/test/model.hpp/move_only/m_operator3D.md index 0a6c9c55d..f96173598 100644 --- a/docs/libraries/test/model.hpp/move_only/m_operator3D.md +++ b/docs/libraries/test/model.hpp/move_only/m_operator3D.md @@ -1,32 +1,33 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -overloads: - stlab::move_only & operator=(const stlab::move_only &): - annotation: - - delete - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: const stlab::move_only & - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::move_only & operator=(const stlab::move_only &) - stlab::move_only & operator=(stlab::move_only &&): - annotation: - - default - arguments: - - description: __OPTIONAL__ - name: unnamed-0 - type: stlab::move_only && - unnamed: true - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::move_only & operator=(stlab::move_only &&) +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: test/model.hpp + overloads: + stlab::move_only & operator=(const stlab::move_only &): + annotation: + - deleted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const stlab::move_only & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::move_only & operator=(const stlab::move_only &) + stlab::move_only & operator=(stlab::move_only &&): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: stlab::move_only && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: stlab::move_only & operator=(stlab::move_only &&) --- diff --git a/docs/libraries/test/model.hpp/move_only/m_~move_only.md b/docs/libraries/test/model.hpp/move_only/m_~move_only.md index dc177eb97..8d7b13da7 100644 --- a/docs/libraries/test/model.hpp/move_only/m_~move_only.md +++ b/docs/libraries/test/model.hpp/move_only/m_~move_only.md @@ -1,17 +1,17 @@ --- layout: method title: ~move_only -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -is_dtor: true -overloads: - ~move_only(): - annotation: - - default - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~move_only() +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: test/model.hpp + is_dtor: true + overloads: + ~move_only(): + annotation: + - defaulted + description: __OPTIONAL__ + signature_with_names: ~move_only() --- diff --git a/docs/libraries/test/model.hpp/regular/f_operator3C.md b/docs/libraries/test/model.hpp/regular/f_operator3C.md index 62373f588..0b577b3e8 100644 --- a/docs/libraries/test/model.hpp/regular/f_operator3C.md +++ b/docs/libraries/test/model.hpp/regular/f_operator3C.md @@ -1,24 +1,25 @@ --- layout: function title: operator< -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: test/model.hpp -overloads: - bool operator<(const stlab::regular &, const stlab::regular &): - arguments: - - description: __OPTIONAL__ - name: lhs - type: const stlab::regular & - - description: __OPTIONAL__ - name: rhs - type: const stlab::regular & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: bool operator<(const stlab::regular & lhs, const stlab::regular & rhs) -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - function + defined_in_file: test/model.hpp + overloads: + bool operator<(const stlab::regular &, const stlab::regular &): + arguments: + - description: __OPTIONAL__ + name: lhs + type: const stlab::regular & + - description: __OPTIONAL__ + name: rhs + type: const stlab::regular & + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: bool operator<(const stlab::regular & lhs, const stlab::regular & rhs) + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/test/model.hpp/regular/index.md b/docs/libraries/test/model.hpp/regular/index.md index 33bdbe7da..e5b218409 100644 --- a/docs/libraries/test/model.hpp/regular/index.md +++ b/docs/libraries/test/model.hpp/regular/index.md @@ -1,20 +1,23 @@ --- layout: class title: regular -owner: sean-parent -brief: A class used to illustrate compiler and object behavior -example: regular_example.cpp -tags: - - class -defined_in_file: test/model.hpp -declaration: "\nstruct stlab::regular;" -fields: - _x: - description: __MISSING__ - type: int -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: A class used to illustrate compiler and object behavior + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: test/model.hpp + declaration: "\nstruct stlab::regular;" + fields: + _x: + description: __MISSING__ + type: int + namespace: + - stlab + - v1 --- `regular` will write to `std::cout` when the following events happen to an instance: diff --git a/docs/libraries/test/model.hpp/regular/m_operator3D.md b/docs/libraries/test/model.hpp/regular/m_operator3D.md index 159b82bba..9bdd38122 100644 --- a/docs/libraries/test/model.hpp/regular/m_operator3D.md +++ b/docs/libraries/test/model.hpp/regular/m_operator3D.md @@ -1,26 +1,27 @@ --- layout: method title: operator= -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -overloads: - stlab::regular & operator=(const stlab::regular &): - arguments: - - description: __OPTIONAL__ - name: rhs - type: const stlab::regular & - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::regular & operator=(const stlab::regular & rhs) - stlab::regular & operator=(stlab::regular &&): - arguments: - - description: __OPTIONAL__ - name: rhs - type: stlab::regular && - description: __MISSING__ - return: __OPTIONAL__ - signature_with_names: stlab::regular & operator=(stlab::regular && rhs) +hyde: + owner: sean-parent + brief: __MISSING__ + tags: + - method + defined_in_file: test/model.hpp + overloads: + stlab::regular & operator=(const stlab::regular &): + arguments: + - description: __OPTIONAL__ + name: rhs + type: const stlab::regular & + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: stlab::regular & operator=(const stlab::regular & rhs) + stlab::regular & operator=(stlab::regular &&): + arguments: + - description: __OPTIONAL__ + name: rhs + type: stlab::regular && + description: __MISSING__ + return: __OPTIONAL__ + signature_with_names: stlab::regular & operator=(stlab::regular && rhs) --- diff --git a/docs/libraries/test/model.hpp/regular/m_regular.md b/docs/libraries/test/model.hpp/regular/m_regular.md index 5a5a90ed9..f9d8f0212 100644 --- a/docs/libraries/test/model.hpp/regular/m_regular.md +++ b/docs/libraries/test/model.hpp/regular/m_regular.md @@ -1,35 +1,33 @@ --- layout: method title: regular -owner: sean-parent -brief: Constructs a regular -tags: - - method -defined_in_file: test/model.hpp -is_ctor: true -overloads: - explicit regular(int): - arguments: - - description: The value the instance should take - name: x - type: int - description: Constructs the regular instance - return: __OPTIONAL__ - signature_with_names: explicit regular(int x) - regular(const stlab::regular &): - arguments: - - description: __OPTIONAL__ - name: rhs - type: const stlab::regular & - description: Constructs the regular instance - return: __OPTIONAL__ - signature_with_names: regular(const stlab::regular & rhs) - regular(stlab::regular &&): - arguments: - - description: __OPTIONAL__ - name: rhs - type: stlab::regular && - description: Constructs the regular instance - return: __OPTIONAL__ - signature_with_names: regular(stlab::regular && rhs) +hyde: + owner: sean-parent + brief: Constructs a regular + tags: + - method + defined_in_file: test/model.hpp + is_ctor: true + overloads: + explicit regular(int): + arguments: + - description: The value the instance should take + name: x + type: int + description: Constructs the regular instance + signature_with_names: explicit regular(int x) + regular(const stlab::regular &): + arguments: + - description: __OPTIONAL__ + name: rhs + type: const stlab::regular & + description: Constructs the regular instance + signature_with_names: regular(const stlab::regular & rhs) + regular(stlab::regular &&): + arguments: + - description: __OPTIONAL__ + name: rhs + type: stlab::regular && + description: Constructs the regular instance + signature_with_names: regular(stlab::regular && rhs) --- diff --git a/docs/libraries/test/model.hpp/regular/m_~regular.md b/docs/libraries/test/model.hpp/regular/m_~regular.md index 16f8ebc31..2b39d936a 100644 --- a/docs/libraries/test/model.hpp/regular/m_~regular.md +++ b/docs/libraries/test/model.hpp/regular/m_~regular.md @@ -1,15 +1,15 @@ --- layout: method title: ~regular -owner: __MISSING__ -brief: __MISSING__ -tags: - - method -defined_in_file: test/model.hpp -is_dtor: true -overloads: - ~regular(): - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: ~regular() +hyde: + owner: sean-parent + brief: __OPTIONAL__ + tags: + - method + defined_in_file: test/model.hpp + is_dtor: true + overloads: + ~regular(): + description: __OPTIONAL__ + signature_with_names: ~regular() --- diff --git a/docs/libraries/utility.hpp/f_copy.md b/docs/libraries/utility.hpp/f_copy.md index a00bd6331..c018ec574 100644 --- a/docs/libraries/utility.hpp/f_copy.md +++ b/docs/libraries/utility.hpp/f_copy.md @@ -1,23 +1,30 @@ --- layout: function title: copy -owner: sean-parent -brief: Returns a copy of the argument -tags: - - function -defined_in_file: utility.hpp -overloads: - "template \nT copy(const T &)": - arguments: - - description: __OPTIONAL__ - name: a - type: const T & - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nT copy(const T & a)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Returns a copy of the argument + tags: + - function + inline: + brief: + - Returns a copy of the argument. Used to pass an lvalue to function taking an rvalue or to copy a type with an `explicit` copy-constructor. + defined_in_file: utility.hpp + overloads: + "template \nconstexpr std::decay_t copy(T &&)": + arguments: + - description: __OPTIONAL__ + name: value + type: T && + description: __INLINED__ + inline: + description: + - Returns a copy of the argument. Used to pass an lvalue to function taking an rvalue or to copy a type with an `explicit` copy-constructor. + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr std::decay_t copy(T && value)" + namespace: + - stlab + - v1 --- Useful for functions that only take an rvalue reference or that have an explicit copy constructor. diff --git a/docs/libraries/utility.hpp/f_for_each_argument.md b/docs/libraries/utility.hpp/f_for_each_argument.md index c49cdfad9..1dc3c23d9 100644 --- a/docs/libraries/utility.hpp/f_for_each_argument.md +++ b/docs/libraries/utility.hpp/f_for_each_argument.md @@ -1,25 +1,31 @@ --- layout: function title: for_each_argument -owner: sean-parent -brief: Execute a function for each passed argument -example: [ for_each_argument_example.cpp ] -tags: - - function -defined_in_file: utility.hpp -overloads: - "template \nvoid for_each_argument(F &&, Args &&...)": - arguments: - - description: Unary function that can take all arguments of type `Args` - name: f - type: F && - - description: Arguments to be passed one-by-one to `f` - name: args - type: Args &&... - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nvoid for_each_argument(F && f, Args &&... args)" -namespace: - - stlab - - v1 +hyde: + owner: sean-parent + brief: Execute a function for each passed argument + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: utility.hpp + overloads: + "template \nvoid for_each_argument(F &&, Args &&...)": + arguments: + - description: Unary function that can take all arguments of type `Args` + name: f + type: F && + - description: Arguments to be passed one-by-one to `f` + name: args + type: Args &&... + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nvoid for_each_argument(F && f, Args &&... args)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/utility.hpp/f_move_if.md b/docs/libraries/utility.hpp/f_move_if.md index f9446e0ef..b7dd36cd6 100644 --- a/docs/libraries/utility.hpp/f_move_if.md +++ b/docs/libraries/utility.hpp/f_move_if.md @@ -1,21 +1,28 @@ --- layout: function title: move_if -owner: __MISSING__ -brief: __MISSING__ -tags: - - function -defined_in_file: utility.hpp -overloads: - "template \nconstexpr detail::move_if_helper_t move_if(T &&)": - arguments: - - description: __OPTIONAL__ - name: t - type: T && - description: __OPTIONAL__ - return: __OPTIONAL__ - signature_with_names: "template \nconstexpr detail::move_if_helper_t move_if(T && t)" -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - "***********************************************************************************************" + defined_in_file: utility.hpp + overloads: + "template \nconstexpr detail::move_if_helper_t move_if(T &&)": + arguments: + - description: __OPTIONAL__ + name: t + type: T && + description: __INLINED__ + inline: + description: + - "***********************************************************************************************" + return: __OPTIONAL__ + signature_with_names: "template \nconstexpr detail::move_if_helper_t move_if(T && t)" + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/utility.hpp/index.md b/docs/libraries/utility.hpp/index.md index 493ee93f7..5dbfd4684 100644 --- a/docs/libraries/utility.hpp/index.md +++ b/docs/libraries/utility.hpp/index.md @@ -1,16 +1,17 @@ --- layout: library title: utility.hpp -owner: __MISSING__ -brief: __MISSING__ -tags: - - sourcefile -library-type: sourcefile -typedefs: - index_sequence_cat_t: - definition: typename index_sequence_cat::type - description: __MISSING__ - index_sequence_transform_t: - definition: typename index_sequence_transform::type - description: __MISSING__ +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile + typedefs: + index_sequence_cat_t: + definition: typename index_sequence_cat::type + description: __MISSING__ + index_sequence_transform_t: + definition: typename index_sequence_transform::type + description: __MISSING__ --- diff --git a/docs/libraries/utility.hpp/index_sequence_cat3Cstd.a7253ebe/index.md b/docs/libraries/utility.hpp/index_sequence_cat3Cstd.a7253ebe/index.md index ceac8473e..2709a1acc 100644 --- a/docs/libraries/utility.hpp/index_sequence_cat3Cstd.a7253ebe/index.md +++ b/docs/libraries/utility.hpp/index_sequence_cat3Cstd.a7253ebe/index.md @@ -1,19 +1,20 @@ --- layout: class title: index_sequence_cat, std::index_sequence> -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: utility.hpp -declaration: "\nstruct stlab::index_sequence_cat;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: std::index_sequence - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: utility.hpp + declaration: "\nstruct stlab::index_sequence_cat;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: std::index_sequence + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/utility.hpp/index_sequence_to_array.aa88b8ea/index.md b/docs/libraries/utility.hpp/index_sequence_to_array.aa88b8ea/index.md index 430e61fb0..9586fa7f4 100644 --- a/docs/libraries/utility.hpp/index_sequence_to_array.aa88b8ea/index.md +++ b/docs/libraries/utility.hpp/index_sequence_to_array.aa88b8ea/index.md @@ -1,19 +1,20 @@ --- layout: class title: index_sequence_to_array> -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: utility.hpp -declaration: "\nstruct stlab::index_sequence_to_array;" -ctor: unspecified -dtor: unspecified -fields: - value: - description: __MISSING__ - type: const std::array -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: utility.hpp + declaration: "\nstruct stlab::index_sequence_to_array;" + ctor: unspecified + dtor: unspecified + fields: + value: + description: __MISSING__ + type: const std::array + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/utility.hpp/index_sequence_transfor.3fb0d0a1/index.md b/docs/libraries/utility.hpp/index_sequence_transfor.3fb0d0a1/index.md index 8110adc28..55fe19a38 100644 --- a/docs/libraries/utility.hpp/index_sequence_transfor.3fb0d0a1/index.md +++ b/docs/libraries/utility.hpp/index_sequence_transfor.3fb0d0a1/index.md @@ -1,19 +1,23 @@ --- layout: class title: index_sequence_transform -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: utility.hpp -declaration: "template class F, std::size_t Index, std::size_t Count>\nstruct stlab::index_sequence_transform;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: index_sequence_cat_t, index_sequence_transform_t> - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + inline: + description: + - "***********************************************************************************************" + defined_in_file: utility.hpp + declaration: "template class F, std::size_t Index, std::size_t Count>\nstruct stlab::index_sequence_transform;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: index_sequence_cat_t, index_sequence_transform_t> + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/utility.hpp/index_sequence_transfor.e996655e/index.md b/docs/libraries/utility.hpp/index_sequence_transfor.e996655e/index.md index b189383ed..71fef1f75 100644 --- a/docs/libraries/utility.hpp/index_sequence_transfor.e996655e/index.md +++ b/docs/libraries/utility.hpp/index_sequence_transfor.e996655e/index.md @@ -1,19 +1,20 @@ --- layout: class title: index_sequence_transform -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: utility.hpp -declaration: "\nstruct stlab::index_sequence_transform;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: std::index_sequence<> - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: utility.hpp + declaration: "\nstruct stlab::index_sequence_transform;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: std::index_sequence<> + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/utility.hpp/index_sequence_transfor.eee092e1/index.md b/docs/libraries/utility.hpp/index_sequence_transfor.eee092e1/index.md index 4bbe12702..7299e4c71 100644 --- a/docs/libraries/utility.hpp/index_sequence_transfor.eee092e1/index.md +++ b/docs/libraries/utility.hpp/index_sequence_transfor.eee092e1/index.md @@ -1,19 +1,20 @@ --- layout: class title: index_sequence_transform -owner: __MISSING__ -brief: __MISSING__ -tags: - - class -defined_in_file: utility.hpp -declaration: "\nstruct stlab::index_sequence_transform;" -ctor: unspecified -dtor: unspecified -typedefs: - type: - definition: typename F::value[Index]>::type - description: __MISSING__ -namespace: - - stlab - - v1 +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - class + defined_in_file: utility.hpp + declaration: "\nstruct stlab::index_sequence_transform;" + ctor: unspecified + dtor: unspecified + typedefs: + type: + definition: typename F::value[Index]>::type + description: __MISSING__ + namespace: + - stlab + - v1 --- diff --git a/docs/libraries/version.hpp/index.md b/docs/libraries/version.hpp/index.md index 91abd2e74..e38899d3c 100644 --- a/docs/libraries/version.hpp/index.md +++ b/docs/libraries/version.hpp/index.md @@ -1,11 +1,12 @@ --- layout: library title: version.hpp -owner: sean-parent -brief: Preprocessor macros containing version information. -tags: - - sourcefile -library-type: sourcefile +hyde: + owner: sean-parent + brief: Preprocessor macros containing version information. + tags: + - sourcefile + library-type: sourcefile --- Caution: this is the only stlab header that is guaranteed to change with every stlab release. Including this header will cause a recompile every time a new stlab version is used. diff --git a/docs/tips/index.md b/docs/tips/index.md index 16c80db81..eb91d3964 100644 --- a/docs/tips/index.md +++ b/docs/tips/index.md @@ -1,8 +1,9 @@ --- title: Tips layout: page -tab: Tips -icon: thumb-tack +hyde: + tab: Tips + icon: thumb-tack --- From time to time I've posted programming tips (often these have been internal emails), blog posts, or other short form writings. I'm gathering ones that might be of general interest here, updating them in the process. diff --git a/docs/tools/docker-tools/Dockerfile b/docs/tools/docker-tools/Dockerfile index cffec71f2..0fd1a202e 100644 --- a/docs/tools/docker-tools/Dockerfile +++ b/docs/tools/docker-tools/Dockerfile @@ -11,15 +11,17 @@ RUN apt-get update && apt-get install -y \ git \ libreadline-dev \ make \ + nodejs \ npm \ rbenv \ wget \ - zlib1g-dev \ - patch \ -&& rm -rf /var/lib/apt/lists/* + zlib1g-dev + +RUN apt-get install -y libyaml-dev RUN npm install -g n -RUN n latest +# Turn off XZ compression because 20.5.1 had a broken link +RUN export N_USE_XZ=0; n latest RUN npm install -g npm@latest RUN npm install -g browser-sync @@ -67,7 +69,7 @@ RUN (eval "$(rbenv init -)"; \ rbenv install `cat .ruby-version`; \ gem install bundler; \ rbenv rehash; \ - bundle install) + bundle install --frozen) WORKDIR /home/app diff --git a/docs/tools/docker-tools/README.md b/docs/tools/docker-tools/README.md index 83a1d49f9..234fb4131 100644 --- a/docs/tools/docker-tools/README.md +++ b/docs/tools/docker-tools/README.md @@ -3,38 +3,53 @@ ## Setup ### Install Docker -If you don't already have docker installed, [install Docker](https://docs.docker.com/get-docker/). +If you don't already have Docker installed, [install Docker](https://docs.docker.com/get-docker/). ### Building the docker image To build the docker image, first, update the VERSION variable below (please use semantic versioning). Add a [release note](#release-notes). +Specify the ruby version to match the latest stable - https://www.ruby-lang.org/en/downloads/ + +macOS and Linux: + +```bash +VERSION="1.0.3" +VOLUME="stlab.libraries" +RUBY_VERSION="3.2.2" ``` -VERSION="1.0.1" -echo $VERSION > ./docs/tools/docker-tools/VERSION -VOLUME="stlab.github.io" +Windows: -# Specify the ruby version to match https://pages.github.com/versions/ +```powershell +$VERSION="1.0.3" +$VOLUME="stlab.libraries" +$RUBY_VERSION="3.2.2" -RUBY_VERSION="2.7.4" +$PSDefaultParameterValues = @{'Out-File:Encoding' = 'Ascii'} +``` + +``` +echo $VERSION > ./docs/tools/docker-tools/VERSION echo $RUBY_VERSION > ./docs/.ruby-version # build the base image, no-cache is used so the latest tools are installed -docker build --build-arg RUBY_VERSION=$RUBY_VERSION --file ./docs/tools/docker-tools/Dockerfile \ - --target base --tag $VOLUME . \ - --no-cache +docker build --build-arg RUBY_VERSION=$RUBY_VERSION --file ./docs/tools/docker-tools/Dockerfile --target base --tag $VOLUME . --no-cache -# update the docs environment +# update the docs environment (see below for using local theme) docker run --mount type=bind,source="$(pwd)",target=/mnt/host --tty --interactive $VOLUME bash +``` + +At the docker prompt, execute the following: +``` cd /mnt/host +git config --global --add safe.directory /mnt/host ./docs/tools/docs/update.sh --lock exit # build the final image -docker build --build-arg RUBY_VERSION=$RUBY_VERSION \ - --file ./docs/tools/docker-tools/Dockerfile --target full --tag $VOLUME . +docker build --build-arg RUBY_VERSION=$RUBY_VERSION --file ./docs/tools/docker-tools/Dockerfile --target full --tag $VOLUME . ``` ## Running the Docker image @@ -42,23 +57,20 @@ docker build --build-arg RUBY_VERSION=$RUBY_VERSION \ To run the docker image, execute the following. ``` -VOLUME="stlab.github.io" -docker run --mount type=bind,source="$(pwd)",target=/mnt/host \ - --tty --interactive --publish 3000-3001:3000-3001 \ - $VOLUME bash +docker run --mount type=bind,source="$(pwd)",target=/mnt/host --tty --interactive --publish 3000-3001:3000-3001 $VOLUME bash ``` -This should leave you at bash prompt that looks like: +This should leave you at a bash prompt that looks like this: ``` app@fc7590a63ba3:~$ ``` -The hex number is the docker image container ID and may be different. Going forward I refer to this as the _docker_ prompt to distinguish it from the _local_ prompt. +The hex number is the docker image container ID and may be different. Going foreward I refer to this as the _docker_ prompt to distinguish it from the _local_ prompt. ## Build the documentation site -To build or rebuild the complete documentation site locally execute the following from the docker prompt: +To build or rebuild the complete documentation site locally, execute the following from the docker prompt: ``` cd /mnt/host @@ -85,7 +97,10 @@ docker ps docker exec -it bash ``` -To test a local copy of the Jekyll theme, edit the Gemfile and use: +To test a local copy of the Jekyll theme + +Edit Gemfile +Edit _config.yml ``` docker run --mount type=bind,source="$(pwd)",target=/mnt/host \ @@ -97,4 +112,6 @@ docker run --mount type=bind,source="$(pwd)",target=/mnt/host \ ### Release Notes - 1.0.0 - Initial release for Jekyll -- 1.0.1 - Updating toolset +- 1.0.1 - Updating tool set +- 1.0.2 - Updating in for Hyde 2.0 +- 1.0.3 - Updating Jekyll to 4.2.0 for new Hyde and moving to GitHub Actions. diff --git a/docs/tools/docker-tools/VERSION b/docs/tools/docker-tools/VERSION index 7dea76edb..21e8796a0 100644 --- a/docs/tools/docker-tools/VERSION +++ b/docs/tools/docker-tools/VERSION @@ -1 +1 @@ -1.0.1 +1.0.3 diff --git a/extraneous-files.txt b/extraneous-files.txt new file mode 100644 index 000000000..d51de9640 --- /dev/null +++ b/extraneous-files.txt @@ -0,0 +1,57 @@ +/mnt/host/stlab-libraries/docs/libraries/concurrency/channel.hpp/receiver3CT3E/set_ready.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/index.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/default_executor.hpp/executor_type3CP3E/m_operator2829.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/default_executor.hpp/f_group.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/default_executor.hpp/f_platform_priority.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/default_executor.hpp/group_t: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/default_executor.hpp/group_t/index.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/default_executor.hpp/group_t/m_group_t.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/default_executor.hpp/group_t/m_~group_t.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/default_executor.hpp/stlab3A3Av13A3Adetail3A3Aexecutor_priority.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/future.hpp/future: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/future.hpp/future/f_operator213D.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/future.hpp/future/f_operator3D3D.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/future.hpp/future/f_swap.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/future.hpp/future/index.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/index.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_operator2829.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/immediate_executor.hpp/immediate_executor_type/m_~immediate_executor_type.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/main_executor.hpp/main_executor_type: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/main_executor.hpp/main_executor_type/index.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/main_executor.hpp/main_executor_type/m_operator2829.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/main_executor.hpp/main_executor_type/m_~main_executor_type.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/system_timer.hpp/system_timer_type: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/system_timer.hpp/system_timer_type/index.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_operator2829.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/system_timer.hpp/system_timer_type/m_~system_timer_type.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/f_operator213D.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/m_operator2829.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/m_operator3D3D.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/m_swap.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/index.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_const_pointer.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_dtor.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_invoke.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_model3CF2C20false3E.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_move_ctor.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_pointer.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20false3E/m_target_type.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/index.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_const_pointer.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_dtor.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_invoke.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_model3CF2C20true3E.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_move_ctor.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_pointer.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/model3CF2C20true3E/m_target_type.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator20bool.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator2829.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_operator3D.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_swap.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_target_type.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_task3CR2028Args293E.md: extraneous file +/mnt/host/stlab-libraries/docs/libraries/concurrency/task.hpp/task3CR2028Args293E/m_~task3CR2028Args293E.md: extraneous file diff --git a/stlab/algorithm/reverse.hpp b/stlab/algorithm/reverse.hpp index 15cd29fc7..6dcc65558 100644 --- a/stlab/algorithm/reverse.hpp +++ b/stlab/algorithm/reverse.hpp @@ -3,7 +3,7 @@ Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) */ -/*************************************************************************************************/ +/**************************************************************************************************/ #ifndef STLAB_ALGORITHM_REVERSE_HPP #define STLAB_ALGORITHM_REVERSE_HPP @@ -13,15 +13,15 @@ #include -/*************************************************************************************************/ +/**************************************************************************************************/ namespace stlab { -/*************************************************************************************************/ +/**************************************************************************************************/ namespace unsafe { -/*************************************************************************************************/ +/**************************************************************************************************/ template // I models NodeIterator I reverse_append(I first, I last, I result) { @@ -50,11 +50,11 @@ inline typename R::iterator reverse_nodes(R& range) { return stlab::unsafe::reverse_nodes(std::begin(range), std::end(range)); } -/*************************************************************************************************/ +/**************************************************************************************************/ } // namspace unsafe -/*************************************************************************************************/ +/**************************************************************************************************/ template inline void reverse(BidirectionalRange& range) { @@ -71,7 +71,7 @@ inline void reverse_copy(const BidirectionalRange& range, OutputIterator result) std::reverse_copy(std::begin(range), std::end(range), result); } -/*************************************************************************************************/ +/**************************************************************************************************/ template // I models BidirectionalIterator std::pair reverse_until(I f, I m, I l) { @@ -86,12 +86,12 @@ std::pair reverse_until(I f, I m, I l) { return std::pair(f, l); } -/*************************************************************************************************/ +/**************************************************************************************************/ } // namespace stlab -/*************************************************************************************************/ +/**************************************************************************************************/ #endif // STLAB_ALGORITHM_REVERSE_HPP -/*************************************************************************************************/ +/**************************************************************************************************/ diff --git a/stlab/concurrency/channel.hpp b/stlab/concurrency/channel.hpp index 4d71fc715..ab778bbbe 100755 --- a/stlab/concurrency/channel.hpp +++ b/stlab/concurrency/channel.hpp @@ -15,6 +15,7 @@ #include #include #include +#include #include #include #include @@ -1522,7 +1523,7 @@ class STLAB_NODISCARD() receiver { if (_ready) throw channel_error(channel_error_codes::process_already_running); - auto executor = std::move(ap._annotations._executor.value_or(_p->executor())); + auto executor = ap._annotations._executor.value_or(_p->executor()); auto p = std::make_shared, F, detail::yield_type, T>, T>>( executor, std::move(ap._f), _p); diff --git a/stlab/concurrency/future.hpp b/stlab/concurrency/future.hpp index f94c6741e..17b297d53 100755 --- a/stlab/concurrency/future.hpp +++ b/stlab/concurrency/future.hpp @@ -14,6 +14,7 @@ #include #include #include +#include #include #include #include @@ -294,7 +295,8 @@ struct shared_base> : std::enable_shared_from_this lock(_mutex); - if (!_ready) _then.emplace_back([](auto&&) {}, [_p = this->shared_from_this()]() noexcept {}); + if (!_ready) + _then.emplace_back([](auto&&) {}, [_p = this->shared_from_this()]() noexcept {}); } void set_exception(std::exception_ptr error) { @@ -399,7 +401,7 @@ struct shared_base> : std::enable_shared_from_this< void _detach() { std::unique_lock lock(_mutex); - if (!_ready) _then = then_t([](auto&&) {}, [_p = this->shared_from_this()] () noexcept {}); + if (!_ready) _then = then_t([](auto&&) {}, [_p = this->shared_from_this()]() noexcept {}); } void set_exception(std::exception_ptr error) { @@ -461,7 +463,8 @@ struct shared_base : std::enable_shared_from_this> { void _detach() { std::unique_lock lock(_mutex); - if (!_ready) _then.emplace_back([](auto&&) {}, [_p = this->shared_from_this()]() noexcept {}); + if (!_ready) + _then.emplace_back([](auto&&) {}, [_p = this->shared_from_this()]() noexcept {}); } void set_exception(std::exception_ptr error) { @@ -734,8 +737,7 @@ class STLAB_NODISCARD() future> { auto get_try() && { return _p->get_try_r(unique_usage(_p)); } [[deprecated("Use exception() instead")]] std::optional error() const& { - return _p->_exception ? std::optional{_p->_exception} : - std::nullopt; + return _p->_exception ? std::optional{_p->_exception} : std::nullopt; } std::exception_ptr exception() const& { return _p->_exception; } @@ -882,8 +884,7 @@ class STLAB_NODISCARD() future { bool get_try() const& { return _p->get_try(); } [[deprecated("Use exception() instead")]] std::optional error() const& { - return _p->_exception ? std::optional{_p->_exception} : - std::nullopt; + return _p->_exception ? std::optional{_p->_exception} : std::nullopt; } std::exception_ptr exception() const& { return _p->_exception; } @@ -987,8 +988,7 @@ class STLAB_NODISCARD() future> { auto get_try() && { return _p->get_try_r(unique_usage(_p)); } [[deprecated("Use exception() instead")]] std::optional error() const& { - return _p->_exception ? std::optional{_p->_exception} : - std::nullopt; + return _p->_exception ? std::optional{_p->_exception} : std::nullopt; } std::exception_ptr exception() const& { return _p->_exception; } @@ -1560,28 +1560,30 @@ struct _reduce_coroutine : std::enable_shared_from_this<_reduce_coroutine> _reduce_coroutine(P&& p) : _promise{std::move(p)} {} void start(future>&& r) { // ... co_await r; - _tmp0 = std::move(r).recover([_this = this->shared_from_this()](auto&& a) mutable { - if (auto e = a.exception()) { - _this->_promise.set_exception(e); - return; - } - _this->stage_0(std::move(a)); - }); + _tmp0 = std::move(r).recover(immediate_executor, + [_this = this->shared_from_this()](auto&& a) mutable { + if (auto e = a.exception()) { + _this->_promise.set_exception(e); + return; + } + _this->stage_0(std::move(a)); + }); } void stage_0(future>&& r) { // co_return co_await ...; _tmp1 = - std::move(*r.get_try()).recover([_this = this->shared_from_this()](auto&& a) mutable { - if (auto e = a.exception()) { - _this->_promise.set_exception(e); - return; - } - if constexpr (std::is_same_v) { - _this->_promise(); // co_return - } else { - _this->_promise(*a.get_try()); // co_return - } - }); + std::move(*r.get_try()) + .recover(immediate_executor, [_this = this->shared_from_this()](auto&& a) mutable { + if (auto e = a.exception()) { + _this->_promise.set_exception(e); + return; + } + if constexpr (std::is_same_v) { + _this->_promise(); // co_return + } else { + _this->_promise(*a.get_try()); // co_return + } + }); } }; diff --git a/stlab/concurrency/task.hpp b/stlab/concurrency/task.hpp index b29b5c1ee..93fafa0de 100644 --- a/stlab/concurrency/task.hpp +++ b/stlab/concurrency/task.hpp @@ -185,7 +185,7 @@ class task_ { const concept_t* _vtable_ptr = &_vtable; invoke_t _invoke = invoke; - std::aligned_storage_t _model; + alignas(std::max_align_t) unsigned char _model[small_size]; public: using result_type = R; diff --git a/stlab/iterator/set_next.hpp b/stlab/iterator/set_next.hpp index 38264428f..df8653678 100644 --- a/stlab/iterator/set_next.hpp +++ b/stlab/iterator/set_next.hpp @@ -3,34 +3,34 @@ Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) */ -/*************************************************************************************************/ +/**************************************************************************************************/ #ifndef STLAB_ITERATOR_SET_NEXT_HPP #define STLAB_ITERATOR_SET_NEXT_HPP #include -/*************************************************************************************************/ +/**************************************************************************************************/ namespace stlab { -/*************************************************************************************************/ +/**************************************************************************************************/ namespace unsafe { -/*************************************************************************************************/ +/**************************************************************************************************/ template // I models NodeIterator struct set_next_fn; // Must be specialized -/*************************************************************************************************/ +/**************************************************************************************************/ template // I models NodeIterator inline void set_next(I x, I y) { set_next_fn()(x, y); } -/*************************************************************************************************/ +/**************************************************************************************************/ template // T models ForwardNodeIterator inline void splice_node_range(I location, I first, I last) { @@ -49,16 +49,16 @@ inline void skip_node(I location) { set_next(std::prev(location), std::next(location)); } -/*************************************************************************************************/ +/**************************************************************************************************/ } // namespace unsafe -/*************************************************************************************************/ +/**************************************************************************************************/ } // namespace stlab -/*************************************************************************************************/ +/**************************************************************************************************/ #endif // STLAB_ITERATOR_SET_NEXT_HPP -/*************************************************************************************************/ +/**************************************************************************************************/ diff --git a/stlab/test/model.hpp b/stlab/test/model.hpp index 1879593a8..21a5aaaa4 100644 --- a/stlab/test/model.hpp +++ b/stlab/test/model.hpp @@ -19,10 +19,8 @@ /**************************************************************************************************/ namespace stlab { - -/**************************************************************************************************/ - inline namespace v1 { + /**************************************************************************************************/ struct annotate_counters { @@ -164,9 +162,6 @@ class move_only { /**************************************************************************************************/ } // namespace v1 - -/**************************************************************************************************/ - } // namespace stlab /**************************************************************************************************/ diff --git a/test/channel_merge_zip_with_tests.cpp b/test/channel_merge_zip_with_tests.cpp index dcf4bcb0f..665093a09 100644 --- a/test/channel_merge_zip_with_tests.cpp +++ b/test/channel_merge_zip_with_tests.cpp @@ -274,8 +274,8 @@ BOOST_FIXTURE_TEST_CASE(int_zip_with_channel_2_different_type_void_functor_async std::atomic_int result{0}; auto check = stlab::zip(stlab::default_executor, receive<0>(), receive<1>()) | - [&](std::tuple v) { - result += std::get<0>(v) + static_cast(std::get<1>(v).size()); + [&](std::tuple v) { + result += std::get<0>(v) + static_cast(std::get<1>(v).size()); }; receive<0>().set_ready(); diff --git a/test/channel_test_helper.hpp b/test/channel_test_helper.hpp index f90128e86..b3c831747 100644 --- a/test/channel_test_helper.hpp +++ b/test/channel_test_helper.hpp @@ -75,8 +75,8 @@ struct channel_test_fixture : channel_test_fixture_base { channel_test_fixture() { test_reset(); - } - + } + void test_reset() { for (std::size_t i = 0; i < N; i++) std::tie(_send[i], _receive[i]) = stlab::channel(stlab::default_executor); diff --git a/test/channel_tests.cpp b/test/channel_tests.cpp index 674787a0e..423bc7e62 100755 --- a/test/channel_tests.cpp +++ b/test/channel_tests.cpp @@ -13,6 +13,7 @@ #endif #include + #include #include #include diff --git a/test/future_recover_tests.cpp b/test/future_recover_tests.cpp index 20c3e77f8..bd3b94ff0 100644 --- a/test/future_recover_tests.cpp +++ b/test/future_recover_tests.cpp @@ -28,10 +28,10 @@ using namespace future_test_helper; BOOST_FIXTURE_TEST_SUITE(future_recover_void, test_fixture) BOOST_AUTO_TEST_CASE(future_recover_failure_before_recover_initialized_on_rvalue) { BOOST_TEST_MESSAGE("running future recover, failure before recover initialized on r-value"); - - /* + + /* combining the tests as in future_then_tests is not possible because of a bug in gcc - + using task_t = function)>; using op_t = future(future::*)(task_t&&)&&; diff --git a/test/future_test_helper.cpp b/test/future_test_helper.cpp index 2ae9f2bd2..70dcbc0f7 100644 --- a/test/future_test_helper.cpp +++ b/test/future_test_helper.cpp @@ -17,4 +17,3 @@ test_exception::test_exception(const char* error) : _error(error) {} const char* test_exception::what() const noexcept { return _error.c_str(); } } // namespace future_test_helper - diff --git a/test/future_tests.cpp b/test/future_tests.cpp index 3a61d686c..7b75d27ed 100644 --- a/test/future_tests.cpp +++ b/test/future_tests.cpp @@ -47,7 +47,8 @@ BOOST_AUTO_TEST_CASE(async_lambda_arguments) { BOOST_TEST_MESSAGE("running async lambda argument of type rvalue -> value"); annotate_counters counters; - (void)async(immediate_executor, [](annotate) {}, annotate(counters)); + (void)async( + immediate_executor, [](annotate) {}, annotate(counters)); BOOST_REQUIRE(counters.remaining() == 0); BOOST_REQUIRE(counters._copy_ctor == 0); } @@ -57,7 +58,8 @@ BOOST_AUTO_TEST_CASE(async_lambda_arguments) { annotate_counters counters; annotate x(counters); - (void)async(immediate_executor, [](annotate) {}, x); + (void)async( + immediate_executor, [](annotate) {}, x); BOOST_REQUIRE(counters.remaining() == 1); BOOST_REQUIRE(counters._copy_ctor == 1); } @@ -67,7 +69,8 @@ BOOST_AUTO_TEST_CASE(async_lambda_arguments) { annotate_counters counters; annotate x(counters); - (void)async(immediate_executor, [](annotate) {}, std::ref(x)); + (void)async( + immediate_executor, [](annotate) {}, std::ref(x)); BOOST_REQUIRE(counters.remaining() == 1); BOOST_REQUIRE(counters._copy_ctor == 1); } @@ -77,7 +80,8 @@ BOOST_AUTO_TEST_CASE(async_lambda_arguments) { annotate_counters counters; annotate x(counters); - (void)async(immediate_executor, [](annotate) {}, std::cref(x)); + (void)async( + immediate_executor, [](annotate) {}, std::cref(x)); BOOST_REQUIRE(counters.remaining() == 1); BOOST_REQUIRE(counters._copy_ctor == 1); } @@ -109,7 +113,8 @@ BOOST_AUTO_TEST_CASE(async_lambda_arguments) { annotate_counters counters; annotate x(counters); - (void)async(immediate_executor, [](annotate&) {}, std::ref(x)); + (void)async( + immediate_executor, [](annotate&) {}, std::ref(x)); BOOST_REQUIRE(counters.remaining() == 1); BOOST_REQUIRE(counters._copy_ctor == 0); } @@ -131,7 +136,8 @@ BOOST_AUTO_TEST_CASE(async_lambda_arguments) { BOOST_TEST_MESSAGE("running async lambda argument of type rvalue -> const&"); annotate_counters counters; - (void)async(immediate_executor, [](const annotate&) {}, annotate(counters)); + (void)async( + immediate_executor, [](const annotate&) {}, annotate(counters)); BOOST_REQUIRE(counters.remaining() == 0); BOOST_REQUIRE(counters._copy_ctor == 0); } @@ -141,7 +147,8 @@ BOOST_AUTO_TEST_CASE(async_lambda_arguments) { annotate_counters counters; annotate x(counters); - (void)async(immediate_executor, [](const annotate&) {}, x); + (void)async( + immediate_executor, [](const annotate&) {}, x); BOOST_REQUIRE(counters.remaining() == 1); BOOST_REQUIRE(counters._copy_ctor == 1); } @@ -151,7 +158,8 @@ BOOST_AUTO_TEST_CASE(async_lambda_arguments) { annotate_counters counters; annotate x(counters); - (void)async(immediate_executor, [](const annotate&) {}, std::ref(x)); + (void)async( + immediate_executor, [](const annotate&) {}, std::ref(x)); BOOST_REQUIRE(counters.remaining() == 1); BOOST_REQUIRE(counters._copy_ctor == 0); } @@ -161,7 +169,8 @@ BOOST_AUTO_TEST_CASE(async_lambda_arguments) { annotate_counters counters; annotate x(counters); - (void)async(immediate_executor, [](const annotate&) {}, std::cref(x)); + (void)async( + immediate_executor, [](const annotate&) {}, std::cref(x)); BOOST_REQUIRE(counters.remaining() == 1); BOOST_REQUIRE(counters._copy_ctor == 0); } @@ -170,7 +179,8 @@ BOOST_AUTO_TEST_CASE(async_lambda_arguments) { BOOST_TEST_MESSAGE("running async lambda argument of type rvalue -> &&"); annotate_counters counters; - (void)async(immediate_executor, [](annotate&&) {}, annotate(counters)); + (void)async( + immediate_executor, [](annotate&&) {}, annotate(counters)); BOOST_REQUIRE(counters.remaining() == 0); BOOST_REQUIRE(counters._copy_ctor == 0); } @@ -180,7 +190,8 @@ BOOST_AUTO_TEST_CASE(async_lambda_arguments) { annotate_counters counters; annotate x(counters); - (void)async(immediate_executor, [](annotate&&) {}, x); + (void)async( + immediate_executor, [](annotate&&) {}, x); BOOST_REQUIRE(counters.remaining() == 1); BOOST_REQUIRE(counters._copy_ctor == 1); } @@ -247,7 +258,8 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(future_constructed_minimal_fn_with_parameters, test_setup setup; { - auto sut = async(make_executor<0>(), [](auto x) -> T { return x + T(0); }, T(42)); + auto sut = async( + make_executor<0>(), [](auto x) -> T { return x + T(0); }, T(42)); BOOST_REQUIRE(sut.valid() == true); BOOST_REQUIRE(!sut.exception()); @@ -265,8 +277,7 @@ BOOST_AUTO_TEST_CASE(future_constructed_minimal_fn_moveonly) { test_setup setup; { - auto sut = - async(make_executor<0>(), []() -> v1::move_only { return v1::move_only{42}; }); + auto sut = async(make_executor<0>(), []() -> v1::move_only { return v1::move_only{42}; }); BOOST_REQUIRE(sut.valid() == true); BOOST_REQUIRE(!sut.exception()); @@ -377,16 +388,18 @@ BOOST_FIXTURE_TEST_SUITE(future_then_void, test_fixture) BOOST_AUTO_TEST_CASE(future_get_try_refref) { BOOST_TEST_MESSAGE("future get_try()&& accessor test"); - sut = async(default_executor, [] { return 42; }) - .then([](int) -> int { throw test_exception("failure"); }) - .recover([](auto&& f) { - try { - std::forward(f).get_try(); - return 0; - } catch (const test_exception&) { - return 42; - } - }); + sut = async(default_executor, [] { + return 42; + }).then([](int) -> int { + throw test_exception("failure"); + }).recover([](auto&& f) { + try { + std::forward(f).get_try(); + return 0; + } catch (const test_exception&) { + return 42; + } + }); wait_until_future_completed(sut); BOOST_REQUIRE_EQUAL(42, *sut.get_try()); @@ -436,9 +449,7 @@ BOOST_AUTO_TEST_CASE(future_wait_void_with_timeout) { BOOST_AUTO_TEST_CASE(future_wait_void_with_timeout_reached) { BOOST_TEST_MESSAGE("future wait with void with a timeout"); - auto answer = [&] { - std::this_thread::sleep_for(std::chrono::milliseconds(500)); - }; + auto answer = [&] { std::this_thread::sleep_for(std::chrono::milliseconds(500)); }; stlab::future f = stlab::async(stlab::default_executor, answer); f = stlab::await_for(std::move(f), std::chrono::milliseconds(100)); @@ -579,7 +590,8 @@ BOOST_AUTO_TEST_CASE(future_move_only_detach_without_execution) { bool check = true; { auto p = package(immediate_executor, [] { return move_only{42}; }); - auto r = std::move(p.second).then([a = annotate(counter), &_check = check](auto&&) { _check = false; }); + auto r = std::move(p.second).then( + [a = annotate(counter), &_check = check](auto&&) { _check = false; }); r.detach(); } std::cout << counter; @@ -602,14 +614,14 @@ BOOST_AUTO_TEST_CASE(future_void_detach_without_execution) { BOOST_REQUIRE(check); } - BOOST_AUTO_TEST_CASE(future_int_detach_with_execution) { BOOST_TEST_MESSAGE("future int detach with execution"); annotate_counters counter; int result = 0; { auto p = package(stlab::immediate_executor, [] { return 42; }); - p.second.then([a = stlab::annotate(counter), &_result = result](int x) { _result = x; }).detach(); + p.second.then([a = stlab::annotate(counter), &_result = result](int x) { _result = x; }) + .detach(); p.first(); } std::cout << counter; @@ -624,7 +636,8 @@ BOOST_AUTO_TEST_CASE(future_void_detach_with_execution) { bool check = false; { auto p = package(stlab::immediate_executor, [] {}); - p.second.then([a = stlab::annotate(counter), &_check = check]() { _check = true; }).detach(); + p.second.then([a = stlab::annotate(counter), &_check = check]() { _check = true; }) + .detach(); p.first(); } std::cout << counter; @@ -639,7 +652,8 @@ BOOST_AUTO_TEST_CASE(future_move_only_detach_with_execution) { int result = 0; { auto p = package(stlab::immediate_executor, [] { return move_only{42}; }); - auto r = std::move(p.second).then([a = stlab::annotate(counter), &_result = result](auto&& x) { _result = x.member(); }); + auto r = std::move(p.second).then( + [a = stlab::annotate(counter), &_result = result](auto&& x) { _result = x.member(); }); r.detach(); p.first(); } @@ -671,9 +685,7 @@ BOOST_AUTO_TEST_CASE(future_reduction_with_mutable_void_task) { BOOST_TEST_MESSAGE("future reduction with mutable task"); std::atomic_int check{0}; - auto func = [&check]() mutable { - ++check; - }; + auto func = [&check]() mutable { ++check; }; auto result = stlab::async(stlab::default_executor, [func = std::move(func)]() mutable { func(); @@ -725,3 +737,30 @@ BOOST_AUTO_TEST_CASE(future_reduction_with_move_only_mutable_void_task) { BOOST_REQUIRE_EQUAL(3, check); } + +BOOST_AUTO_TEST_CASE(future_reduction_executor) { + BOOST_TEST_MESSAGE("future reduction executor should propagate from outermost future"); + + size_t outer_count{0}; + size_t inner_count{0}; + auto outer_executor{[&](auto&& f) { + ++outer_count; + std::forward(f)(); + }}; + auto inner_executor{[&](auto&& f) { + ++inner_count; + std::forward(f)(); + }}; + + auto f = make_ready_future(5, outer_executor) | + [&](int x) { return make_ready_future(x, inner_executor); }; + + BOOST_REQUIRE_EQUAL(1, outer_count); + BOOST_REQUIRE_EQUAL(0, inner_count); + + auto f1 = f | [](int x) { return x; }; + + BOOST_REQUIRE_EQUAL(2, outer_count); + BOOST_REQUIRE_EQUAL(0, inner_count); + BOOST_REQUIRE_EQUAL(5, *f1.get_try()); +} diff --git a/test/future_when_all_arguments_tests.cpp b/test/future_when_all_arguments_tests.cpp index 1f434fcc5..91600636d 100644 --- a/test/future_when_all_arguments_tests.cpp +++ b/test/future_when_all_arguments_tests.cpp @@ -100,8 +100,8 @@ BOOST_AUTO_TEST_CASE(future_when_all_args_int_with_two_ready_element) { BOOST_AUTO_TEST_CASE(future_when_all_args) { auto main_thread_id = std::this_thread::get_id(); - auto sut = when_all(make_executor<1>(), [] { - return std::this_thread::get_id(); + auto sut = when_all(make_executor<1>(), [] { + return std::this_thread::get_id(); }, make_ready_future(stlab::immediate_executor)); wait_until_future_completed(sut); @@ -189,7 +189,7 @@ BOOST_AUTO_TEST_CASE(future_when_all_args_move_only_with_many_elements) { sut = when_all( make_executor<1>(), - [](auto x1, auto x2, auto x3, auto x4) { return move_only(7 * x1.member() + 11 * x2.member() + 13 * x3.member() + 17 * x4.member()); }, + [](auto x1, auto x2, auto x3, auto x4) { return move_only(7 * x1.member() + 11 * x2.member() + 13 * x3.member() + 17 * x4.member()); }, std::move(f1), std::move(f2), std::move(f3), std::move(f4)); check_valid_future(sut); diff --git a/test/future_when_any_range_tests.cpp b/test/future_when_any_range_tests.cpp index 484770d68..8e27a7668 100644 --- a/test/future_when_any_range_tests.cpp +++ b/test/future_when_any_range_tests.cpp @@ -643,4 +643,4 @@ BOOST_AUTO_TEST_CASE(future_when_any_move_only_range_with_diamond_formation_elem BOOST_REQUIRE_LE(1, custom_scheduler<1>::usage_counter()); } -BOOST_AUTO_TEST_SUITE_END() \ No newline at end of file +BOOST_AUTO_TEST_SUITE_END() diff --git a/test/task_test.cpp b/test/task_test.cpp index e4b3c0e74..0033cd143 100644 --- a/test/task_test.cpp +++ b/test/task_test.cpp @@ -65,7 +65,7 @@ BOOST_AUTO_TEST_CASE(task_argument_test) { const regular b{42}; t(b); // const lvalue->value } - + // These test mismatched task signature to lambda signature { task t([](regular a) { diff --git a/test/traits_test.cpp b/test/traits_test.cpp index 1253d386d..840725dd8 100644 --- a/test/traits_test.cpp +++ b/test/traits_test.cpp @@ -36,4 +36,4 @@ BOOST_AUTO_TEST_CASE(check_smart_is_copy_constructible_v) { BOOST_REQUIRE(smart_is_copy_constructible_v == false); BOOST_REQUIRE(smart_is_copy_constructible_v> == false); BOOST_REQUIRE(smart_is_copy_constructible_v>> == false); -} \ No newline at end of file +} diff --git a/validate_docs.sh b/validate_docs.sh index 27133fb5b..cafd0b1c0 100755 --- a/validate_docs.sh +++ b/validate_docs.sh @@ -9,6 +9,8 @@ # Constants # +CC=/usr/bin/clang +CXX=/usr/bin/clang++ CMAKE_BUILD_DIR=../BUILD-DOCS # XCODE_TOOLCHAIN=$(xcode-select -p) @@ -106,14 +108,14 @@ then fi # -# Invoke CMake, iff: +# Invoke CMake, iff: # - the build directory does not exist, or # - the user specified `--force` # if [ -d $CMAKE_BUILD_DIR ] && [ $FORCE -eq 0 ] then - echo "$CMAKE_BUILD_DIR already exists. Please delete it or use -f." + echo "$CMAKE_BUILD_DIR already exists. Please delete it or use -f." exit 1 else cmake -S. -B $CMAKE_BUILD_DIR $CMAKE_ARGS