Skip to content

Commit 5034bf1

Browse files
committed
Add documentation for dpctl.tensor._flags.Flags class
1 parent 7b64374 commit 5034bf1

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _Flags_class:
2+
3+
``Flags`` class
4+
===================
5+
6+
Helper class for querying information about the memory layout of an array.
7+
8+
.. autoclass:: dpctl.tensor._flags.Flags
9+
:members:
10+
11+
Note that dictionary-like access to some members is permitted:
12+
13+
"C", "C_CONTIGUOUS":
14+
Equivalent to `c_contiguous`
15+
"F", "F_CONTIGUOUS":
16+
Equivalent to `f_contiguous`
17+
"W", "WRITABLE":
18+
Equivalent to `writable`
19+
"FC":
20+
Equivalent to `fc`
21+
"FNC":
22+
Equivalent to `fnc`
23+
"FORC", "CONTIGUOUS":
24+
Equivalent to `forc` and `contiguous`

docs/doc_sources/api_reference/dpctl/tensor.usm_ndarray.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,8 @@ Implementation of :py:class:`usm_ndarray` conforms to
2323
.. _dpctl_tensor_usm_ndarray_to_device_example:
2424

2525
.. include:: examples/usm_ndarray.rst
26+
27+
.. toctree::
28+
:hidden:
29+
30+
flags

0 commit comments

Comments
 (0)