diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 171 |
1 files changed, 170 insertions, 1 deletions
@@ -26,6 +26,175 @@ make test Much like the `.gitignore` file, you can put the files/directory to ignore when compiling. -### School turn in +## Documentation + +### mem + + + + + +| Name | prototype | description | tested | +|------|-----------|-------------|--------| +| ft_bzero | `void ft_bzero(void *s, size_t n)` | fill `n` bytes of `s` with 0 | [x] | +| ft_calloc | `void *ft_calloc(size_t count, size_t size)` | allocate `count` element of `size` and initialize them to 0 | [ ] | +| ft_memccpy | `void *ft_memccpy(void *dest, const void *src, int c, size_t n)` | copy `n` byte from `src` to `dest` until `c` is reached | [ ] | +| ft_memchr | `void *ft_memchr(const void *s, int c, size_t n)` | return the address of the first occurance of `c` in `s` or NULL if `c` isn't found | [ ] | +| ft_memcmp | `int ft_memcmp(const void *s1, const void *s2, size_t n)` | compare `n` byte of `s1` and `s2` | [ ] | +| ft_memcpy | `void *ft_memcpy(void *dest, const void *src, size_t n)` | copy `n` byte from `src` to `dest` | [x] | +| ft_memmem | `void *ft_memmem(const void *big, size_t big_len, const void *little, size_t little_len)` | search `little` in `big` | [ ] | +| ft_memmove | `void *ft_memmove(void *dst, const void *src, size_t len)` | copy `len` byte from `src` to `dst` and the copied memory can overlap | [ ] | +| ft_memset | `void *ft_memset(void *s, int c, size_t n)` | set `n` byte of `s` to `c` | [x] | +| ft_memset_pattern4 | `void ft_memset_pattern4(void *b, const void *pattern4, size_t len)` | set `len` byte of `b` to a reapeated pattern of 4 bytes | [ ] | +| ft_memswap | `void ft_memswap(void *a, void *b, size_t size)` | swap `a` and `b` memory | [x] | + +### algo + +| Name | prototype | description | tested | +|------|-----------|-------------|--------| +| ft_bsearch | | | | +| ft_compar_int | | | | +| ft_heapsort | | | | +| ft_is_set | | | | +| ft_lfind | | | | +| ft_lsearch | | | | +| ft_mergesort | | | | +| ft_qsort | | | | +| ft_reverse | | | | + +### bt + +| Name | prototype | description | tested | +|------|-----------|-------------|--------| +| ft_btdestroy | | | | +| ft_btnew | | | | + +### ctype + +| Name | prototype | description | tested | +|------|-----------|-------------|--------| +| ft_isalnum | | | | +| ft_isalpha | | | | +| ft_isascii | | | | +| ft_isblank | | | | +| ft_isdigit | | | | +| ft_isprint | | | | +| ft_isspace | | | | +| ft_todigit | | | | +| ft_tolower | | | | +| ft_toupper | | | | + +### ht + +| Name | prototype | description | tested | +|------|-----------|-------------|--------| +| ft_htcontent_new | | | | +| ft_htdelone | | | | +| ft_htdelone_key | | | | +| ft_htdestroy | | | | +| ft_htdestroy_all | | | | +| ft_htdestroy_key | | | | +| ft_htget | | | | +| ft_hthash | | | | +| ft_htnew | | | | +| ft_htset | | | | + +### io + +| Name | prototype | description | tested | +|------|-----------|-------------|--------| +| ft_getchar | | | | +| ft_next_line | | | | +| ft_asprintf | | | | +| ft_dprintf | | | | +| ft_printf | | | | +| ft_snprintf | | | | +| ft_sprintf | | | | +| ft_vasprintf | | | | +| ft_vdprintf | | | | +| ft_vprintf | | | | +| ft_vsnprintf | | | | +| ft_vsprintf | | | | +| ft_putchar | | | | | +| ft_putchar_fd | | | | | +| ft_putendl | | | | | +| ft_putendl_fd | | | | | +| ft_putnbr | | | | | +| ft_putnbr_fd | | | | | +| ft_putstr | | | | | +| ft_putstr_fd | | | | | + +### lst + +| Name | prototype | description | tested | +|------|-----------|-------------|--------| +| ft_lstadd_back | | | | | +| ft_lstadd_front | | | | | +| ft_lstbsearch | | | | | +| ft_lstclear | | | | | +| ft_lstdelone | | | | | +| ft_lstiter | | | | | +| ft_lstlast | | | | | +| ft_lstmap | | | | | +| ft_lstnew | | | | | +| ft_lstpop_front | | | | | +| ft_lstremove_if | | | | | +| ft_lstreverse | | | | | +| ft_lstreverse_ret | | | | | +| ft_lstsize | | | | | +| ft_lstsort | | | | | +| ft_lstsorted_merge | | | | | + +### str + +| Name | prototype | description | tested | +|------|-----------|-------------|--------| +| ft_atoi | | | | | +| ft_atoi_strict | | | | | +| ft_itoa | | | | | +| ft_split | | | | | +| ft_strcasecmp | | | | | +| ft_strcat | | | | | +| ft_strchr | | | | | +| ft_strclr | | | | | +| ft_strcmp | | | | | +| ft_strcount | | | | | +| ft_strcpy | | | | | +| ft_strcspn | | | | | +| ft_strdel | | | | | +| ft_strdup | | | | | +| ft_strequ | | | | | +| ft_striter | | | | | +| ft_striteri | | | | | +| ft_strjoin | | | | | +| ft_strjoin_free | | | | | +| ft_strjoin_free_snd | | | | | +| ft_strlcat | | | | | +| ft_strlcpy | | | | | +| ft_strlen | | | | | +| ft_strmap | | | | | +| ft_strmapi | | | | | +| ft_strncasecmp | | | | | +| ft_strncat | | | | | +| ft_strncmp | | | | | +| ft_strncpy | | | | | +| ft_strndup | | | | | +| ft_strnequ | | | | | +| ft_strnew | | | | | +| ft_strnlen | | | | | +| ft_strnstr | | | | | +| ft_strpbrk | | | | | +| ft_strrchr | | | | | +| ft_strsep | | | | | +| ft_strspn | | | | | +| ft_strstr | | | | | +| ft_strtol | | | | | +| ft_strtolower | | | | | +| ft_strtoupper | | | | | +| ft_strtrim | | | | | +| ft_substr | | | | | + +## School correction state The state of this project when I turned it in for correction is [here](http://github.com/HappyTramp/libft/tree/raw). + |