Skip to content

Commit

Permalink
Added documentation that this is intended to replace std::array
Browse files Browse the repository at this point in the history
  • Loading branch information
nliber committed Jan 29, 2025
1 parent 5c9686e commit fce73aa
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/API/core/stl-compat/Array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Description

``Array`` is a contiguous aggregate owning container storing a fixed size sequence of objects (models holding exactly N elements).

* This is intended as a replacement for ``std::array<T, N>``.
* This container is an owning container (the data is embeddded in the container itself).
* This container is an aggregate type with the same semantics as a struct holding a C-style array ``T[N]`` as its only non-static data member when ``N > 0``; otherwise, it is an empty container.
* Unlike a C-style array, it doesn't decay to ``T*`` automatically.
Expand Down

0 comments on commit fce73aa

Please sign in to comment.