obitools/obitools3
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 66 Wiki Activity

updated the documentation

Browse Source
This commit is contained in:
Celine Mercier
2015-05-28 17:03:50 +02:00
parent ff64d1b2e9
commit 27e246e709
3 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/containers.rst
View File

@ -2,28 +2,28 @@
Container types Container types
=============== ===============
Containers allow to manage collection of values of homogeneous type. Containers allow to manage collections of values of homogeneous type.
Three container types exist. Three container types exist.
A container is a non-mutable structure once it has been locked. A container is a non-mutable structure once it has been locked.
Consequently just insert procedure are needed Consequently, only insertion procedures are needed.
Lists Lists
----- -----
Correspond to an ordered collection of values belonging an elementary type. Correspond to an ordered collection of values belonging to an elementary type.
At its creation At its creation, ...
Sets Sets
---- ----
Correspond to an unordered collection of values belonging an elementary type. Correspond to an unordered collection of values belonging to an elementary type.
Dictionaries Dictionaries
------------ ------------
Dictionaries allow to associate a `key` to a `value`. Values can be retrieved through its associated key. Dictionaries allow to associate a `key` to a `value`. Values can be retrieved through their associated key.
Values must belong an elementary type and keys must be *OBIStr_t*. Values must belong to an elementary type and keys must be *OBIStr_t*.

2
doc/source/elementary.rst
View File

@ -12,7 +12,7 @@ Atomic types
========= ========= ============ ============================== ========= ========= ============ ==============================
integer int32_t OBIInt_t a signed integer value integer int32_t OBIInt_t a signed integer value
float double OBIFloat_t a floating value float double OBIFloat_t a floating value
boolean ? OBIBool_t a boolean true/false value boolean bool OBIBool_t a boolean true/false value
char char OBIChar_t a character char char OBIChar_t a character
index size_t OBIIdx_t an index in a data structure index size_t OBIIdx_t an index in a data structure
========= ========= ============ ============================== ========= ========= ============ ==============================

6
doc/source/pistes.rst
View File

@ -10,8 +10,7 @@ Ce que l'on veut pouvoir faire
* Gerer les valeurs manquantes * Gerer les valeurs manquantes
* Modifier une colonne en cours d'ecriture (mmap) * Modifier une colonne en cours d'ecriture (mmap)
* Ajouter des valeurs a la fin du fichier d'une colonne en cours d'ecriture (mmap) * Ajouter des valeurs a la fin du fichier d'une colonne en cours d'ecriture (mmap)
*
****** ******
Divers Divers
@ -19,3 +18,6 @@ Divers
* Si l'ordre d'une colonne est change, elle est reecrite (pas d'index). * Si l'ordre d'une colonne est change, elle est reecrite (pas d'index).
* Utilisation de semaphores pour la lecture * Utilisation de semaphores pour la lecture
* Utilisation de tas pour l'indexation des chaines de caracteres. Chaque colonne dont
le type est OBIStr_t est stockee dans 3 fichiers : un fichier contenant les chaines, un
fichier contenant les index, et un fichier contenant le tas.