stdme is fully normed !

This commit is contained in:
Maieul BOYER 2024-08-01 07:34:51 +02:00
parent 2c9a3ee834
commit 4e72b48b4a
No known key found for this signature in database
21 changed files with 281 additions and 278 deletions

View file

@ -1,123 +1,140 @@
/* ************************************************************************** */
/* */
/* ::: :::::::: */
/* vec_buf_str.h :+: :+: :+: */
/* vec_buf_str.h :+: :+: :+: */
/* +:+ +:+ +:+ */
/* By: maiboyer <maiboyer@student.42.fr> +#+ +:+ +#+ */
/* +#+#+#+#+#+ +#+ */
/* Created: 2023/12/04 18:46:53 by maiboyer #+# #+# */
/* Updated: 2023/12/09 17:53:00 by maiboyer ### ########.fr */
/* Updated: 2024/08/01 07:33:44 by maiboyer ### ########.fr */
/* */
/* ************************************************************************** */
#ifndef VEC_BUF_STR_H
#define VEC_BUF_STR_H
# define VEC_BUF_STR_H
#include "me/string/string.h"
#include "me/types.h"
# include "me/string/string.h"
# include "me/types.h"
/// @brief A function that takes two t_string and compare them
typedef bool (*t_vec_buf_str_sort_fn)(t_string *, t_string *);
typedef bool (*t_vec_buf_str_sort_fn)(t_string *, t_string *);
/// @brief A function that free an t_string
typedef void (*t_free_buf_str_item)(t_string);
typedef void (*t_free_buf_str_item)(t_string);
/// @brief A dynamic array of t_string
typedef struct s_vec_buf_str
{
t_free_buf_str_item free_func;
t_usize len;
t_usize capacity;
t_string *buffer;
} t_vec_buf_str;
t_free_buf_str_item free_func;
t_usize len;
t_usize capacity;
t_string *buffer;
} t_vec_buf_str;
/// @brief Create a new vec_buf_str with a given capacity
/// @param capacity The capacity of the new vec_buf_str (in terms of elements)
/// @param free_function The function that will be used to free the elements of the vec_buf_str
t_vec_buf_str vec_buf_str_new(t_usize capacity, t_free_buf_str_item free_function);
/// @param free_function The function that will be used to free the elements of
/// the vec_buf_str
t_vec_buf_str vec_buf_str_new(t_usize capacity,
t_free_buf_str_item free_function);
/// @brief Push an element to the last position of the vec_buf_str
/// @param vec The vec_buf_str to push the element to
/// @param element The element to push
t_error vec_buf_str_push(t_vec_buf_str *vec, t_string element);
t_error vec_buf_str_push(t_vec_buf_str *vec, t_string element);
/// @brief Push an element to the first position of the vec_buf_str
/// @param vec The vec_buf_str to push the element to
/// @param element The element to push
/// @note This operation is O(n)
t_error vec_buf_str_push_front(t_vec_buf_str *vec, t_string element);
t_error vec_buf_str_push_front(t_vec_buf_str *vec,
t_string element);
/// @brief Get the last element from the vec_buf_str, and remove it from the vec_buf_str
/// @brief Get the last element from the vec_buf_str,
/// and remove it from the vec_buf_str
/// @param vec The vec_buf_str to get the element from
/// @param[out] out The last element of the vec_buf_str
/// @return true if the operation failed, false otherwise
t_error vec_buf_str_pop(t_vec_buf_str *vec, t_string *value);
t_error vec_buf_str_pop(t_vec_buf_str *vec, t_string *value);
/// @brief Get the first element from the vec_buf_str, and remove it from the vec_buf_str
/// @brief Get the first element from the vec_buf_str,
/// and remove it from the vec_buf_str
/// @param vec The vec_buf_str to get the element from
/// @param[out] out The first element of the vec_buf_str
/// @return true if the operation failed, false otherwise
/// @note This operation is O(n)
t_error vec_buf_str_pop_front(t_vec_buf_str *vec, t_string *value);
t_error vec_buf_str_pop_front(t_vec_buf_str *vec,
t_string *value);
/// @brief Free the vector and all its elements
/// @param vec The vec_buf_str to free
void vec_buf_str_free(t_vec_buf_str vec);
void vec_buf_str_free(t_vec_buf_str vec);
/// @brief Make the vec_buf_str at least the given capacity
/// @param vec The vec_buf_str to reserve
/// @param wanted_capacity The minimum capacity to reserve
/// @return true if the operation failed, false otherwise
t_error vec_buf_str_reserve(t_vec_buf_str *vec, t_usize wanted_capacity);
t_error vec_buf_str_reserve(t_vec_buf_str *vec,
t_usize wanted_capacity);
/// @brief Run the function and returns the index of the first element that returns true
/// @brief Run the function and returns the index of the first element that
/// returns true
/// @param vec The vec_buf_str to search in
/// @param fn The function to run on each element
/// @param[out] index The index of the first element that returns true
t_error vec_buf_str_find(t_vec_buf_str *vec, bool (*fn)(const t_string *), t_usize *index);
t_error vec_buf_str_find(t_vec_buf_str *vec,
bool (*fn)(const t_string *), t_usize *index);
/// @brief Run the function and returns the index of the first element that returns true, but starting at index starting_index
/// @brief Run the function and returns the index of the first element that
/// returns true, but starting at index starting_index
/// @param vec The vec_buf_str to search in
/// @param fn The function to run on each element
/// @param starting_index The index to start the search from
/// @param[out] index The index of the first element that returns true
t_error vec_buf_str_find_starting(t_vec_buf_str *vec, bool (*fn)(const t_string *), t_usize starting_index, t_usize *index);
t_error vec_buf_str_find_starting(t_vec_buf_str *vec,
bool (*fn)(const t_string *),
t_usize starting_index, t_usize *index);
/// @brief Run the function on every element of the vec_buf_str and returns if all elements returned true
/// @brief Run the function on every element of the vec_buf_str and returns if
/// all elements returned true
/// @param vec The vec_buf_str to search in
/// @param fn The function to run on each element
/// @param[out] result The result of the operation
/// @return true if the operation failed, false otherwise
/// @note If the vec_buf_str is empty, result will be true
t_error vec_buf_str_all(t_vec_buf_str *vec, bool (*fn)(const t_string *), bool *result);
t_error vec_buf_str_all(t_vec_buf_str *vec,
bool (*fn)(const t_string *), bool *result);
/// @brief Run the function on every element of the vec_buf_str and returns if any element returned true
/// @brief Run the function on every element of the vec_buf_str and returns if
/// any element returned true
/// @param vec The vec_buf_str to search in
/// @param fn The function to run on each element
/// @param[out] result The result of the operation
/// @return true if the operation failed, false otherwise
/// @note If the vec_buf_str is empty, result will be false
t_error vec_buf_str_any(t_vec_buf_str *vec, bool (*fn)(const t_string *), bool *result);
t_error vec_buf_str_any(t_vec_buf_str *vec,
bool (*fn)(const t_string *), bool *result);
/// @brief Run the function on every element of the vec_buf_str
/// @param vec The vec_buf_str to iterate over
/// @param fn The function to run on each element
/// @param state The state to pass to the function
void vec_buf_str_iter(t_vec_buf_str *vec, void (*fn)(t_usize index, t_string *value, void *state), void *state);
void vec_buf_str_iter(t_vec_buf_str *vec,
void (*fn)(t_usize index, t_string *value,
void *state), void *state);
/// @brief Reverse the order of the elements in the vec_buf_str
/// @param vec The vec_buf_str to reverse
void vec_buf_str_reverse(t_vec_buf_str *vec);
void vec_buf_str_reverse(t_vec_buf_str *vec);
/// @brief Sort the elements of the vec_buf_str
/// @param vec The vec_buf_str to sort
/// @param is_sorted The function to use to compare the elements
void vec_buf_str_sort(t_vec_buf_str *vec, t_vec_buf_str_sort_fn is_sorted);
void vec_buf_str_sort(t_vec_buf_str *vec,
t_vec_buf_str_sort_fn is_sorted);
/// @brief Get a pointer to the last element of the vec_buf_str
/// @param vec The vec_buf_str to get the element from
/// @param[out] out A pointer to the last element of the vec_buf_str
/// @return true if the operation failed, false otherwise
t_error vec_buf_str_back(t_vec_buf_str *vec, t_string **out);
t_error vec_buf_str_back(t_vec_buf_str *vec, t_string **out);
#endif

View file

@ -1,123 +1,133 @@
/* ************************************************************************** */
/* */
/* ::: :::::::: */
/* vec_str.h :+: :+: :+: */
/* vec_str.h :+: :+: :+: */
/* +:+ +:+ +:+ */
/* By: maiboyer <maiboyer@student.42.fr> +#+ +:+ +#+ */
/* +#+#+#+#+#+ +#+ */
/* Created: 2023/12/04 18:46:53 by maiboyer #+# #+# */
/* Updated: 2023/12/09 17:53:00 by maiboyer ### ########.fr */
/* Updated: 2024/08/01 07:34:19 by maiboyer ### ########.fr */
/* */
/* ************************************************************************** */
#ifndef VEC_STR_H
#define VEC_STR_H
# define VEC_STR_H
#include "me/types.h"
# include "me/types.h"
/// @brief A function that takes two t_str and compare them
typedef bool (*t_vec_str_sort_fn)(t_str *, t_str *);
typedef bool (*t_vec_str_sort_fn)(t_str *, t_str *);
/// @brief A function that free an t_str
typedef void (*t_free_str_item)(t_str);
typedef void (*t_free_str_item)(t_str);
/// @brief A dynamic array of t_str
typedef struct s_vec_str
{
t_free_str_item free_func;
t_usize len;
t_usize capacity;
t_str *buffer;
} t_vec_str;
t_free_str_item free_func;
t_usize len;
t_usize capacity;
t_str *buffer;
} t_vec_str;
/// @brief Create a new vec_str with a given capacity
/// @param capacity The capacity of the new vec_str (in terms of elements)
/// @param free_function The function that will be used to free the elements of the vec_str
t_vec_str vec_str_new(t_usize capacity, t_free_str_item free_function);
/// @param free_function The function that will be used to free the elements of
/// the vec_str
t_vec_str vec_str_new(t_usize capacity,
t_free_str_item free_function);
/// @brief Push an element to the last position of the vec_str
/// @param vec The vec_str to push the element to
/// @param element The element to push
t_error vec_str_push(t_vec_str *vec, t_str element);
t_error vec_str_push(t_vec_str *vec, t_str element);
/// @brief Push an element to the first position of the vec_str
/// @param vec The vec_str to push the element to
/// @param element The element to push
/// @note This operation is O(n)
t_error vec_str_push_front(t_vec_str *vec, t_str element);
t_error vec_str_push_front(t_vec_str *vec, t_str element);
/// @brief Get the last element from the vec_str, and remove it from the vec_str
/// @param vec The vec_str to get the element from
/// @param[out] out The last element of the vec_str
/// @return true if the operation failed, false otherwise
t_error vec_str_pop(t_vec_str *vec, t_str *value);
t_error vec_str_pop(t_vec_str *vec, t_str *value);
/// @brief Get the first element from the vec_str, and remove it from the vec_str
/// @brief Get the first element from the vec_str,
/// and remove it from the vec_str
/// @param vec The vec_str to get the element from
/// @param[out] out The first element of the vec_str
/// @return true if the operation failed, false otherwise
/// @note This operation is O(n)
t_error vec_str_pop_front(t_vec_str *vec, t_str *value);
t_error vec_str_pop_front(t_vec_str *vec, t_str *value);
/// @brief Free the vector and all its elements
/// @param vec The vec_str to free
void vec_str_free(t_vec_str vec);
void vec_str_free(t_vec_str vec);
/// @brief Make the vec_str at least the given capacity
/// @param vec The vec_str to reserve
/// @param wanted_capacity The minimum capacity to reserve
/// @return true if the operation failed, false otherwise
t_error vec_str_reserve(t_vec_str *vec, t_usize wanted_capacity);
t_error vec_str_reserve(t_vec_str *vec, t_usize wanted_capacity);
/// @brief Run the function and returns the index of the first element that returns true
/// @brief Run the function and returns the index of the first element that
/// returns true
/// @param vec The vec_str to search in
/// @param fn The function to run on each element
/// @param[out] index The index of the first element that returns true
t_error vec_str_find(t_vec_str *vec, bool (*fn)(const t_str *), t_usize *index);
t_error vec_str_find(t_vec_str *vec, bool (*fn)(const t_str *),
t_usize *index);
/// @brief Run the function and returns the index of the first element that returns true, but starting at index starting_index
/// @brief Run the function and returns the index of the first element that
/// returns true, but starting at index starting_index
/// @param vec The vec_str to search in
/// @param fn The function to run on each element
/// @param starting_index The index to start the search from
/// @param[out] index The index of the first element that returns true
t_error vec_str_find_starting(t_vec_str *vec, bool (*fn)(const t_str *), t_usize starting_index, t_usize *index);
t_error vec_str_find_starting(t_vec_str *vec,
bool (*fn)(const t_str *), t_usize starting_index,
t_usize *index);
/// @brief Run the function on every element of the vec_str and returns if all elements returned true
/// @brief Run the function on every element of the vec_str and returns if all
/// elements returned true
/// @param vec The vec_str to search in
/// @param fn The function to run on each element
/// @param[out] result The result of the operation
/// @return true if the operation failed, false otherwise
/// @note If the vec_str is empty, result will be true
t_error vec_str_all(t_vec_str *vec, bool (*fn)(const t_str *), bool *result);
t_error vec_str_all(t_vec_str *vec, bool (*fn)(const t_str *),
bool *result);
/// @brief Run the function on every element of the vec_str and returns if any element returned true
/// @brief Run the function on every element of the vec_str and returns if any
/// element returned true
/// @param vec The vec_str to search in
/// @param fn The function to run on each element
/// @param[out] result The result of the operation
/// @return true if the operation failed, false otherwise
/// @note If the vec_str is empty, result will be false
t_error vec_str_any(t_vec_str *vec, bool (*fn)(const t_str *), bool *result);
t_error vec_str_any(t_vec_str *vec, bool (*fn)(const t_str *),
bool *result);
/// @brief Run the function on every element of the vec_str
/// @param vec The vec_str to iterate over
/// @param fn The function to run on each element
/// @param state The state to pass to the function
void vec_str_iter(t_vec_str *vec, void (*fn)(t_usize index, t_str *value, void *state), void *state);
void vec_str_iter(t_vec_str *vec, void (*fn)(t_usize index,
t_str *value, void *state), void *state);
/// @brief Reverse the order of the elements in the vec_str
/// @param vec The vec_str to reverse
void vec_str_reverse(t_vec_str *vec);
void vec_str_reverse(t_vec_str *vec);
/// @brief Sort the elements of the vec_str
/// @param vec The vec_str to sort
/// @param is_sorted The function to use to compare the elements
void vec_str_sort(t_vec_str *vec, t_vec_str_sort_fn is_sorted);
void vec_str_sort(t_vec_str *vec, t_vec_str_sort_fn is_sorted);
/// @brief Get a pointer to the last element of the vec_str
/// @param vec The vec_str to get the element from
/// @param[out] out A pointer to the last element of the vec_str
/// @return true if the operation failed, false otherwise
t_error vec_str_back(t_vec_str *vec, t_str **out);
t_error vec_str_back(t_vec_str *vec, t_str **out);
#endif

View file

@ -1,123 +1,131 @@
/* ************************************************************************** */
/* */
/* ::: :::::::: */
/* vec_u8.h :+: :+: :+: */
/* vec_u8.h :+: :+: :+: */
/* +:+ +:+ +:+ */
/* By: maiboyer <maiboyer@student.42.fr> +#+ +:+ +#+ */
/* +#+#+#+#+#+ +#+ */
/* Created: 2023/12/04 18:46:53 by maiboyer #+# #+# */
/* Updated: 2023/12/09 17:53:00 by maiboyer ### ########.fr */
/* Updated: 2024/08/01 07:33:13 by maiboyer ### ########.fr */
/* */
/* ************************************************************************** */
#ifndef VEC_U8_H
#define VEC_U8_H
# define VEC_U8_H
#include "me/types.h"
# include "me/types.h"
/// @brief A function that takes two t_u8 and compare them
typedef bool (*t_vec_u8_sort_fn)(t_u8 *, t_u8 *);
typedef bool (*t_vec_u8_sort_fn)(t_u8 *, t_u8 *);
/// @brief A function that free an t_u8
typedef void (*t_free_u8_item)(t_u8);
typedef void (*t_free_u8_item)(t_u8);
/// @brief A dynamic array of t_u8
typedef struct s_vec_u8
{
t_free_u8_item free_func;
t_usize len;
t_usize capacity;
t_u8 *buffer;
} t_vec_u8;
t_free_u8_item free_func;
t_usize len;
t_usize capacity;
t_u8 *buffer;
} t_vec_u8;
/// @brief Create a new vec_u8 with a given capacity
/// @param capacity The capacity of the new vec_u8 (in terms of elements)
/// @param free_function The function that will be used to free the elements of the vec_u8
t_vec_u8 vec_u8_new(t_usize capacity, t_free_u8_item free_function);
/// @param free_function The function that will be used to free the elements of
/// the vec_u8
t_vec_u8 vec_u8_new(t_usize capacity, t_free_u8_item free_function);
/// @brief Push an element to the last position of the vec_u8
/// @param vec The vec_u8 to push the element to
/// @param element The element to push
t_error vec_u8_push(t_vec_u8 *vec, t_u8 element);
t_error vec_u8_push(t_vec_u8 *vec, t_u8 element);
/// @brief Push an element to the first position of the vec_u8
/// @param vec The vec_u8 to push the element to
/// @param element The element to push
/// @note This operation is O(n)
t_error vec_u8_push_front(t_vec_u8 *vec, t_u8 element);
t_error vec_u8_push_front(t_vec_u8 *vec, t_u8 element);
/// @brief Get the last element from the vec_u8, and remove it from the vec_u8
/// @param vec The vec_u8 to get the element from
/// @param[out] out The last element of the vec_u8
/// @return true if the operation failed, false otherwise
t_error vec_u8_pop(t_vec_u8 *vec, t_u8 *value);
t_error vec_u8_pop(t_vec_u8 *vec, t_u8 *value);
/// @brief Get the first element from the vec_u8, and remove it from the vec_u8
/// @param vec The vec_u8 to get the element from
/// @param[out] out The first element of the vec_u8
/// @return true if the operation failed, false otherwise
/// @note This operation is O(n)
t_error vec_u8_pop_front(t_vec_u8 *vec, t_u8 *value);
t_error vec_u8_pop_front(t_vec_u8 *vec, t_u8 *value);
/// @brief Free the vector and all its elements
/// @param vec The vec_u8 to free
void vec_u8_free(t_vec_u8 vec);
void vec_u8_free(t_vec_u8 vec);
/// @brief Make the vec_u8 at least the given capacity
/// @param vec The vec_u8 to reserve
/// @param wanted_capacity The minimum capacity to reserve
/// @return true if the operation failed, false otherwise
t_error vec_u8_reserve(t_vec_u8 *vec, t_usize wanted_capacity);
t_error vec_u8_reserve(t_vec_u8 *vec, t_usize wanted_capacity);
/// @brief Run the function and returns the index of the first element that returns true
/// @brief Run the function and returns the index of the first element that
/// returns true
/// @param vec The vec_u8 to search in
/// @param fn The function to run on each element
/// @param[out] index The index of the first element that returns true
t_error vec_u8_find(t_vec_u8 *vec, bool (*fn)(const t_u8 *), t_usize *index);
t_error vec_u8_find(t_vec_u8 *vec, bool (*fn)(const t_u8 *),
t_usize *index);
/// @brief Run the function and returns the index of the first element that returns true, but starting at index starting_index
/// @brief Run the function and returns the index of the first element that
/// returns true, but starting at index starting_index
/// @param vec The vec_u8 to search in
/// @param fn The function to run on each element
/// @param starting_index The index to start the search from
/// @param[out] index The index of the first element that returns true
t_error vec_u8_find_starting(t_vec_u8 *vec, bool (*fn)(const t_u8 *), t_usize starting_index, t_usize *index);
t_error vec_u8_find_starting(t_vec_u8 *vec,
bool (*fn)(const t_u8 *), t_usize starting_index,
t_usize *index);
/// @brief Run the function on every element of the vec_u8 and returns if all elements returned true
/// @brief Run the function on every element of the vec_u8 and returns if all
/// elements returned true
/// @param vec The vec_u8 to search in
/// @param fn The function to run on each element
/// @param[out] result The result of the operation
/// @return true if the operation failed, false otherwise
/// @note If the vec_u8 is empty, result will be true
t_error vec_u8_all(t_vec_u8 *vec, bool (*fn)(const t_u8 *), bool *result);
t_error vec_u8_all(t_vec_u8 *vec, bool (*fn)(const t_u8 *),
bool *result);
/// @brief Run the function on every element of the vec_u8 and returns if any element returned true
/// @brief Run the function on every element of the vec_u8 and returns if any
/// element returned true
/// @param vec The vec_u8 to search in
/// @param fn The function to run on each element
/// @param[out] result The result of the operation
/// @return true if the operation failed, false otherwise
/// @note If the vec_u8 is empty, result will be false
t_error vec_u8_any(t_vec_u8 *vec, bool (*fn)(const t_u8 *), bool *result);
t_error vec_u8_any(t_vec_u8 *vec, bool (*fn)(const t_u8 *),
bool *result);
/// @brief Run the function on every element of the vec_u8
/// @param vec The vec_u8 to iterate over
/// @param fn The function to run on each element
/// @param state The state to pass to the function
void vec_u8_iter(t_vec_u8 *vec, void (*fn)(t_usize index, t_u8 *value, void *state), void *state);
void vec_u8_iter(t_vec_u8 *vec, void (*fn)(t_usize index,
t_u8 *value, void *state), void *state);
/// @brief Reverse the order of the elements in the vec_u8
/// @param vec The vec_u8 to reverse
void vec_u8_reverse(t_vec_u8 *vec);
void vec_u8_reverse(t_vec_u8 *vec);
/// @brief Sort the elements of the vec_u8
/// @param vec The vec_u8 to sort
/// @param is_sorted The function to use to compare the elements
void vec_u8_sort(t_vec_u8 *vec, t_vec_u8_sort_fn is_sorted);
void vec_u8_sort(t_vec_u8 *vec, t_vec_u8_sort_fn is_sorted);
/// @brief Get a pointer to the last element of the vec_u8
/// @param vec The vec_u8 to get the element from
/// @param[out] out A pointer to the last element of the vec_u8
/// @return true if the operation failed, false otherwise
t_error vec_u8_back(t_vec_u8 *vec, t_u8 **out);
t_error vec_u8_back(t_vec_u8 *vec, t_u8 **out);
#endif