From 66e392b92258ab1f20fadf3225de6ba242cc3f84 Mon Sep 17 00:00:00 2001 From: Kevin Jerebica Date: Tue, 27 Aug 2024 18:53:04 +0200 Subject: [PATCH] repo: update docs --- README | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README b/README index 2e89972..a0569df 100644 --- a/README +++ b/README @@ -13,19 +13,27 @@ TECHNICALS struct nod * data structure that represents a node of the tree - struct nod *mknod(struct nod *prnt) - * create a child node below given parent node + void frenod(struct nod *nod) + * free memory of node and all of its children + struct nod *allocnod(void) + * allocate memory for a node and its pool size for + character hashmap + * returns: poiner to said node or NULL if function fails + struct nod *mknod(struct nod *nod, int loc) + * create a child node below given parent node + * loc is the character of the node (consult source code + of mkstr for more information) * returns: pointer to said node or NULL if function fails - int mkstr(struct nod *rot, char *str) + int mkstr(struct nod *nod, char *str) * fit string into tree if it does not already exist * warning: string has to be null-byte terminated * returns: the assigned ID of the string, 0 if string is already inside tree, or -1 if function fails - int gentree(struct nod *rot, char *strs) + int gentree(struct nod *nod, char *strs) * generate tree from character seperated strings * warning: seperation character is '\n' * returns: 0 if ok or -1 if function fails - int streecmp(struct nod *rot, char *str) + int streecmp(struct nod *nod, char *str) * traverse tree and search for str * returns: id of string or 0 if there is no match