Updated the documentation and restructured a bit because it wasn't
compiling (note: Breathe not working)
This commit is contained in:
29
doc/source/containers.rst
Normal file
29
doc/source/containers.rst
Normal file
@@ -0,0 +1,29 @@
|
||||
===============
|
||||
Container types
|
||||
===============
|
||||
|
||||
Containers allow to manage collections of values of homogeneous type.
|
||||
Three container types exist.
|
||||
|
||||
A container is a non-mutable structure once it has been locked.
|
||||
Consequently, only insertion procedures are needed.
|
||||
|
||||
Lists
|
||||
-----
|
||||
|
||||
Correspond to an ordered collection of values belonging to an elementary type.
|
||||
|
||||
At its creation, ...
|
||||
|
||||
|
||||
Sets
|
||||
----
|
||||
|
||||
Correspond to an unordered collection of values belonging to an elementary type.
|
||||
|
||||
|
||||
Dictionaries
|
||||
------------
|
||||
|
||||
Dictionaries allow to associate a `key` to a `value`. Values can be retrieved through their associated key.
|
||||
Values must belong to an elementary type and keys must be *OBIStr_t*.
|
Reference in New Issue
Block a user