Skip to content

Commit e0c0f8f

Browse files
alouane04alouane04
authored
Update README.md
done
1 parent b0a0f7a commit e0c0f8f

File tree

1 file changed

+247
-1
lines changed

1 file changed

+247
-1
lines changed

‎README.md

Lines changed: 247 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,247 @@
1-
# libft
1+
<p align="center">
2+
<img src="libft banner.png" align="center"/>
3+
</p>
4+
5+
<P align="center">
6+
your very own library recreated to help you in your cursus in 1337 you'll recreate some useful functions in the standard library
7+
</p>
8+
9+
<P align="center">
10+
<h1>Resources</h1>
11+
<ul>
12+
<li>1-the c standard book: https://b-ok.africa/book/633119/db5c78</li>
13+
<li>2-makefile: https://b-ok.africa/book/2548807/233dc2</li>
14+
<li>3-file descriptor: https://www.computerhope.com/jargon/f/file-descriptor.htm</li>
15+
<li>3-tester: https://github.com/xicodomingues/francinette</li>
16+
</ul>
17+
</p>
18+
19+
<h2> C standard library</h2>
20+
21+
<table>
22+
<thead>
23+
<tr>
24+
<th colspan=3><h4>C Library <a href="https://www.tutorialspoint.com/c_standard_library/ctype_h.htm">&lt;ctype.h&gt;</h4></a></th>
25+
</tr>
26+
<tr>
27+
<th>Libft</th>
28+
<th>Description</th>
29+
</tr>
30+
</thead>
31+
<tbody>
32+
<tr>
33+
<td><a href=ft_isalnum.c>ft_isalnum</a></td>
34+
<td>Checks whether the passed character is alphanumeric.</td>
35+
</tr>
36+
<tr>
37+
<td><a href=ft_isalpha.c>ft_isalpha</a></td>
38+
<td>Checks whether the passed character is alphabetic.</td>
39+
</tr>
40+
<tr>
41+
<td><a href=ft_isascii.c>ft_isascii</a></td>
42+
<td>Checks whether the passed character is ASCII.</td>
43+
</tr>
44+
<tr>
45+
<td><a href=ft_isdigit.c>ft_isdigit</a></td>
46+
<td>Checks whether the passed character is decimal digit.</td>
47+
</tr>
48+
<tr>
49+
<td><a href=ft_isprint.c>ft_isprint</a></td>
50+
<td>Checks whether the passed character is printable.</td>
51+
</tr>
52+
<tr>
53+
<td><a href=ft_tolower.c>ft_tolower</a></td>
54+
<td>Converts uppercase letters to lowercase.</td>
55+
</tr>
56+
<tr>
57+
<td><a href=ft_toupper.c>ft_toupper</a></td>
58+
<td>Converts lowercase letters to uppercase.</td>
59+
</tr>
60+
</tbody>
61+
<thead>
62+
<tr>
63+
<th colspan=3><h4>C Library <a href="https://www.tutorialspoint.com/c_standard_library/string_h.htm">&lt;string.h&gt;</h4></a></th>
64+
</tr>
65+
<tr>
66+
<th>Libft</th>
67+
<th>Description</th>
68+
</tr>
69+
</thead>
70+
<tbody>
71+
<tr>
72+
<td><a href=ft_bzero.c>ft_bzero</a></td>
73+
<td>Erases the data in the n bytes of the memory block. (Write zeroes)</td>
74+
</tr>
75+
<tr>
76+
<td><a href=ft_memchr.c>ft_memchr</a></td>
77+
<td>Searches for the first occurrence of the character c (an unsigned char) in the first n bytes of the string.</td>
78+
</tr>
79+
<tr>
80+
<td><a href=ft_memcmp.c>ft_memcmp</a></td>
81+
<td>Compares the first n bytes of str1 and str2.</td>
82+
</tr>
83+
<tr>
84+
<td><a href=ft_memcpy.c>ft_memcpy</a></td>
85+
<td>Copies n characters from src to dest.</td>
86+
</tr>
87+
<tr>
88+
<td><a href=ft_memmove.c>ft_memmove</a></td>
89+
<td>Copies n characters from src to dest. (Non destructive manner)</td>
90+
</tr>
91+
<tr>
92+
<td><a href=ft_memset.c>ft_memset</a></td>
93+
<td>Copies the character c (an unsigned char) to the first n characters of the string.</td>
94+
</tr>
95+
<tr>
96+
<td><a href=ft_strchr.c>ft_strchr</a></td>
97+
<td>Searches for the first occurrence of the character c (an unsigned char) in the string.</td>
98+
</tr>
99+
<tr>
100+
<td><a href=ft_strlcat.c>ft_strlcat</a></td>
101+
<td>Appends string src to the end of dst. It will append at most dstsize - strlen(dst) - 1 characters.</td>
102+
</tr>
103+
<tr>
104+
<td><a href=ft_strlcpy.c>ft_strlcpy</a></td>
105+
<td>Copies up to dstsize - 1 characters from the string src to dst.</td>
106+
</tr>
107+
<tr>
108+
<td><a href=ft_strlen.c>ft_strlen</a></td>
109+
<td>Computes the length of the string but not including the terminating null character.</td>
110+
</tr>
111+
<tr>
112+
<td><a href=ft_strncmp.c>ft_strncmp</a></td>
113+
<td>Compares at most the first n bytes of str1 and str2.</td>
114+
</tr>
115+
<tr>
116+
<td><a href=ft_strnstr.c>ft_strnstr</a></td>
117+
<td>Locates the first occurrence of the null-terminated string little in the string big, where not more than len characters are searched.</td>
118+
</tr>
119+
<tr>
120+
<td><a href=ft_strrchr.c>ft_strrchr</a></td>
121+
<td>Searches for the last occurrence of the character c (an unsigned char) in the string.</td>
122+
</tr>
123+
</tbody>
124+
<thead>
125+
<tr>
126+
<th colspan=3><h4>C Library <a href="https://www.tutorialspoint.com/c_standard_library/stdlib_h.htm">&lt;stdlib.h&gt;</h4></a></th>
127+
</tr>
128+
<tr>
129+
<th>Libft</th>
130+
<th>Description</th>
131+
</tr>
132+
</thead>
133+
<tbody>
134+
<tr>
135+
<td><a href=ft_atoi.c>ft_atoi</a></td>
136+
<td>Converts the string to an integer (type int).</td>
137+
</tr>
138+
<tr>
139+
<td><a href=ft_calloc.c>ft_calloc</a></td>
140+
<td>Allocates the requested memory initialized to zero bytes.</td>
141+
</tr>
142+
</tbody>
143+
<thead>
144+
<tr>
145+
<th colspan=3><h4>Non-stantard C Library</h4></a></th>
146+
</tr>
147+
<tr>
148+
<th>Libft</th>
149+
<th>Description</th>
150+
</tr>
151+
</thead>
152+
<tbody>
153+
<tr>
154+
<td><a href=ft_itoa.c>ft_itoa</a></td>
155+
<td>Converts the int to a string (type char *).</td>
156+
</tr>
157+
<tr>
158+
<td><a href=ft_putchar_fd.c>ft_putchar_fd</a></td>
159+
<td>Outputs the character 'c' to the given file descriptor.</td>
160+
</tr>
161+
<tr>
162+
<td><a href=ft_putendl_fd.c>ft_putendl_fd</a></td>
163+
<td>Outputs the string 's' to the given file descriptor, followed by a newline.</td>
164+
</tr>
165+
<tr>
166+
<td><a href=ft_putnbr_fd.c>ft_putnbr_fd</a></td>
167+
<td>Outputs the integer 'n' to the given file descriptor.</td>
168+
</tr>
169+
<tr>
170+
<td><a href=ft_putstr_fd.c>ft_putstr_fd</a></td>
171+
<td>Outputs the string 's' to the given file descriptor.</td>
172+
</tr>
173+
<tr>
174+
<td><a href=ft_strdup.c>ft_strdup</a></td>
175+
<td>Returns a pointer to a null-terminated byte string, which is a duplicate of the string.</td>
176+
</tr>
177+
<tr>
178+
<td><a href=ft_striteri.c>ft_striteri</a></td>
179+
<td>Applies a function to each character of the string.</td>
180+
</tr>
181+
<tr>
182+
<td><a href=ft_strjoin.c>ft_strjoin</a></td>
183+
<td>Returns a new string, which is the result of the concatenation of 's1' and 's2'.</td>
184+
</tr>
185+
<tr>
186+
<td><a href=ft_strmapi.c>ft_strmapi</a></td>
187+
<td>Applies a function to each character of the string 's' to create a new string.</td>
188+
</tr>
189+
<tr>
190+
<td><a href=ft_strtrim.c>ft_strtrim</a></td>
191+
<td>Returns a copy of 's1' with the characters specified in 'set' removed from the beginning and the end of the string.</td>
192+
</tr>
193+
<tr>
194+
<td><a href=ft_substr.c>ft_substr</a></td>
195+
<td>Returns a substring from the string 's'. The substring begins at index 'start' and is of maximum size 'len'.</td>
196+
</tr>
197+
</tbody>
198+
<thead>
199+
<tr>
200+
<th colspan=3><h4>Chained lists manipulation</h4></a></th>
201+
</tr>
202+
<tr>
203+
<th>Libft</th>
204+
<th>Description</th>
205+
</tr>
206+
</thead>
207+
<tbody>
208+
<tr>
209+
<td><a href=ft_lstadd_back.c>ft_lstadd_back</a></td>
210+
<td>Adds the element at the end of the list.</td>
211+
</tr>
212+
<tr>
213+
<td><a href=ft_lstadd_front.c>ft_lstadd_front</a></td>
214+
<td>Adds the element at the beginning of the list.</td>
215+
</tr>
216+
<tr>
217+
<td><a href=ft_lstclear.c>ft_lstclear</a></td>
218+
<td>Deletes and frees the given element and every successor of that element, using a given function and free.</td>
219+
</tr>
220+
<tr>
221+
<td><a href=ft_lstdelone.c>ft_lstdelone</a></td>
222+
<td>Takes as a parameter an element and frees the memory of the element’s content using a function given as a parameter and free the element.</td>
223+
</tr>
224+
<tr>
225+
<td><a href=ft_lstiter.c>ft_lstiter</a></td>
226+
<td>Iterates the list and applies a function to the content of each element.</td>
227+
</tr>
228+
<tr>
229+
<td><a href=ft_lstlast.c>ft_lstlast</a></td>
230+
<td>Returns the last element of the list.</td>
231+
</tr>
232+
<tr>
233+
<td><a href=ft_lstmap.c>ft_lstmap</a></td>
234+
<td>Iterates the list and applies a function to the content of each element. Creates a new list resulting of the successive applications of the function. A 'del' function is used to delete the content of an element if needed.</td>
235+
</tr>
236+
<tr>
237+
<td><a href=ft_lstnew.c>ft_lstnew</a></td>
238+
<td>Returns a new element.</td>
239+
</tr>
240+
<tr>
241+
<td><a href=ft_lstsize.c>ft_lstsize</a></td>
242+
<td>Counts the number of elements in a list.</td>
243+
</tr>
244+
</tbody>
245+
</table>
246+
247+
Footer

0 commit comments

Comments
 (0)