Skip to content

Commit

Permalink
Simply front matter in extended api
Browse files Browse the repository at this point in the history
  • Loading branch information
wmaxey authored Oct 27, 2023
1 parent a743e85 commit 3aaefc8
Show file tree
Hide file tree
Showing 29 changed files with 87 additions and 58 deletions.
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Asynchronous Operations
has_children: true
has_toc: false
layout: default
---

## Asynchronous Operations
# Asynchronous Operations

| [`cuda::memcpy_async`] | Asynchronously copies one range to another. `(function template)` <br/><br/> 1.1.0 / CUDA 11.0 <br/> 1.2.0 / CUDA 11.1 (group & aligned overloads) |
| [`cuda::device::memcpy_async_tx`] | Asynchronously copies one range to another with manual transaction accounting. `(function)` |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
parent: Asynchronous Operations
has_children: false
has_toc: false
layout: default
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
parent: Asynchronous Operations
has_children: false
has_toc: false
layout: default
---

Expand Down Expand Up @@ -84,7 +85,7 @@ __global__ void example_kernel() {

[See it on Godbolt](https://godbolt.org/z/oK7Tazszx){: .btn }

[`cuda::thread_scope`]: ./memory_model.md
[`cuda::thread_scope`]: ../memory_model.md
[Tracking asynchronous operations by the mbarrier object]: https://docs.nvidia.com/cuda/parallel-thread-execution/index.html#tracking-asynchronous-operations-by-the-mbarrier-object
[`cp.async.bulk` PTX instruction]: https://docs.nvidia.com/cuda/parallel-thread-execution/index.html#data-movement-and-conversion-instructions-cp-async-bulk
[thread.barrier.class paragraph 12]: https://eel.is/c++draft/thread.barrier.class#12
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Functional
has_children: true
has_toc: false
layout: default
---

## Functional
# Functional

| [`cuda::proclaim_return_type`] | Creates a forwarding call wrapper that proclaims return type <br/><br/> 1.8.0 / CUDA 11.7 |

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
grand_parent: Extended API
parent: Functional
has_children: false
has_toc: false
layout: default
---

# `cuda::proclaim_return_type`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Memory Access Properties
has_children: true
has_toc: false
layout: default
---

## Memory Access Properties
# Memory Access Properties

| [`cuda::annotated_ptr`] | Binds an access property to a pointer. `(class template)` <br/><br/> 1.6.0 / CUDA 11.5 |
| [`cuda::access_property`] | Represents a memory access property. `(class)` <br/><br/> 1.6.0 / CUDA 11.5 |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
parent: Memory access properties
grand_parent: Extended API
nav_order: 2
parent: Memory Access Properties
has_children: false
has_toc: false
layout: default
---

# `cuda::access_property`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
parent: Memory access properties
grand_parent: Extended API
nav_order: 1
parent: Memory Access Properties
has_children: false
has_toc: false
layout: default
---

# `cuda::annotated_ptr`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
parent: Memory access properties
grand_parent: Extended API
nav_order: 3
parent: Memory Access Properties
has_children: false
has_toc: false
layout: default
---

# `cuda::apply_access_property`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
parent: Memory access properties
grand_parent: Extended API
nav_order: 4
parent: Memory Access Properties
has_children: false
has_toc: false
layout: default
---

# `cuda::associate_access_property`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
parent: Memory access properties
grand_parent: Extended API
nav_order: 5
parent: Memory Access Properties
has_children: false
has_toc: false
layout: default
---

# `cuda::discard_memory`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Memory Model
has_children: true
has_toc: false
layout: default
---

Expand Down
4 changes: 2 additions & 2 deletions libcudacxx/docs/jekyll/_collections/_extended_api/shapes.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Shapes
has_children: true
has_toc: false
layout: default
---

## Shapes
# Shapes

| [`cuda::std::size_t`] | Defines an extent of bytes. `(typedef)` <br/><br/> 1.0.0 / CUDA 10.2 |
| [`cuda::aligned_size_t`] | Defines an extent of bytes with a statically defined alignment. `(class template)` <br/><br/> 1.2.0 / CUDA 11.1 |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
grand_parent: Extended API
parent: Shapes
has_children: false
has_toc: false
layout: default
---

# `cuda::aligned_size_t`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
---
title: Synchronization Primitives
has_children: true
has_toc: false
layout: default
---

## Synchronization Primitives
# Synchronization Primitives

### Atomics
## Atomics

| [`cuda::atomic`] | System-wide [`cuda::std::atomic`] objects and operations. `(class template)` <br/><br/> 1.0.0 / CUDA 10.2 |
| [`cuda::atomic_ref`] | System-wide [`cuda::std::atomic_ref`] objects and operations. `(class template)` <br/><br/> 1.7.0 / CUDA 11.6 |

### Latches
## Latches

| [`cuda::latch`] | System-wide [`cuda::std::latch`] single-phase asynchronous thread coordination mechanism. `(class template)` <br/><br/> 1.1.0 / CUDA 11.0 |

### Barriers
## Barriers

| [`cuda::barrier`] | System-wide [`cuda::std::barrier`] multi-phase asynchronous thread coordination mechanism. `(class template)` <br/><br/> 1.1.0 / CUDA 11.0 |

### Semaphores
## Semaphores

| [`cuda::counting_semaphore`] | System-wide [`cuda::std::counting_semaphore`] primitive for constraining concurrent access. `(class template)` <br/><br/> 1.1.0 / CUDA 11.0 |
| [`cuda::binary_semaphore`] | System-wide [`cuda::std::binary_semaphore`] primitive for mutual exclusion. `(class template)` <br/><br/> 1.1.0 / CUDA 11.0 |

### Pipelines
## Pipelines

The pipeline library is included in the CUDA Toolkit, but is not part of the
open source libcu++ distribution.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
nav_order: 0
has_children: false
has_toc: false
layout: default
---

# `cuda::atomic`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
nav_order: 1
has_children: false
has_toc: false
layout: default
---

# `cuda::atomic_ref`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
nav_order: 3
has_children: false
has_toc: false
layout: default
---

# `cuda::barrier`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
nav_order: 5
has_children: false
has_toc: false
layout: default
---

# `cuda::binary_semaphore`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
nav_order: 4
has_children: false
has_toc: false
layout: default
---

# `cuda::counting_semaphore`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
nav_order: 2
has_children: false
has_toc: false
layout: default
---

# `cuda::latch`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
has_children: false
has_toc: false
layout: default
---

# `cuda::make_pipeline`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
has_children: false
has_toc: false
layout: default
---

# `cuda::pipeline`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
has_children: false
has_toc: false
layout: default
---

# `cuda::pipeline_consumer_wait_prior`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
has_children: false
has_toc: false
layout: default
---

# `cuda::pipeline_producer_commit`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
has_children: false
has_toc: false
layout: default
---

# `cuda::pipeline_role`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
grand_parent: Extended API
parent: Synchronization Primitives
has_children: false
has_toc: false
layout: default
---

# `cuda::pipeline_shared_state`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Thread Groups
has_children: true
has_toc: false
layout: default
---

Expand Down
10 changes: 5 additions & 5 deletions libcudacxx/docs/jekyll/extended_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ has_toc: false
| [Thread Scopes] | Defines the kind of threads that can synchronize using a primitive. `(enum)` <br/><br/> 1.0.0 / CUDA 10.2 |
| [Thread Groups] | Concepts for groups of cooperating threads. `(concept)` <br/><br/> 1.2.0 / CUDA 11.1 |

{% include_relative _collections/_extended_api/shapes.md %}
{% include_relative extended_api/shapes/index.html %}

{% include_relative _collections/_extended_api/synchronization_primitives.md %}
{% include_relative extended_api/synchronization_primitives/index.html %}

{% include_relative _collections/_extended_api/asynchronous_operations.md %}
{% include_relative extended_api/asynchronous_operations/index.html %}

{% include_relative _collections/_extended_api/memory_access_properties.md %}
{% include_relative extended_api/memory_access_properties/index.html %}

{% include_relative _collections/_extended_api/functional.md %}
{% include_relative extended_api/functional/index.html %}

[Thread Scopes]: ./extended_api/memory_model.md#thread-scopes
[Thread Groups]: ./extended_api/thread_groups.md
Expand Down

0 comments on commit 3aaefc8

Please sign in to comment.