Skip to content

Commit 28f6f96

Browse files
committed
Updating SYCL docs for pipes extension
1 parent 98b74a7 commit 28f6f96

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

sycl/doc/extensions/supported/sycl_ext_intel_dataflow_pipes.asciidoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,10 @@ class pipe {
183183
// Non-blocking
184184
static dataT read( bool &success_code );
185185
static void write( const dataT &data, bool &success_code );
186+
187+
// Static members
188+
using value_type = dataT;
189+
size_t min_capacity = min_capacity;
186190
}
187191
----
188192

@@ -191,8 +195,8 @@ The read and write member functions may be invoked within device code, or within
191195
The template parameters of the device type are defined as:
192196

193197
* `name`: Type that is the basis of pipe identification. Typically a user-defined class, in a user namespace. Forward declaration of the type is sufficient, and the type does not need to be defined.
194-
* `dataT`: The type of data word/packet contained within a pipe. This is the data type that is read during a successful `pipe::read` operation, or written during a successful `pipe::write` operation. The type must be standard layout and trivially copyable.
195-
* `min_capacity`: User defined minimum number of words in units of `dataT` that the pipe must be able to store without any being read out. A minimum capacity is required in some algorithms to avoid deadlock, or for performance tuning. An implementation can include more capacity than this parameter, but not less.
198+
* `dataT`: The type of data word/packet contained within a pipe. This is the data type that is read during a successful `pipe::read` operation, or written during a successful `pipe::write` operation. The type must be standard layout and trivially copyable. This template parameter can be queried by using the `value_type` static member.
199+
* `min_capacity`: User defined minimum number of words in units of `dataT` that the pipe must be able to store without any being read out. A minimum capacity is required in some algorithms to avoid deadlock, or for performance tuning. An implementation can include more capacity than this parameter, but not less. This template parameter can be queried by using the `min_capacity` static member.
196200

197201
== Pipe types and {cpp} scope
198202

0 commit comments

Comments
 (0)