Function Documentation
◆ forward_list_add_all()
| bk_err forward_list_add_all | ( | forward_list | me, |
| void *const | arr, | ||
| const size_t | size | ||
| ) |
Copies elements from an array to the singly-linked list. The size specifies the number of elements to copy, starting from the beginning of the array. The size must be less than or equal to the size of the array.
- Parameters
-
me the singly-linked list to add data to arr the array to copy data from size the number of elements to copy
- Returns
- BK_OK if no error
- -BK_ENOMEM if out of memory
- -BK_ERANGE if size has reached representable limit
◆ forward_list_add_at()
| bk_err forward_list_add_at | ( | forward_list | me, |
| const size_t | index, | ||
| void *const | data | ||
| ) |
Adds data at a specified index in the singly-linked list. The pointer to the data being passed in should point to the data type which this singly-linked list holds. For example, if this singly-linked list holds integers, the data pointer should be a pointer to an integer. Since the data is being copied, the pointer only has to be valid when this function is called.
- Parameters
-
me the singly-linked list to add data to index the index to add the data at data the data to add to the singly-linked list
- Returns
- BK_OK if no error
- -BK_ENOMEM if out of memory
- -BK_EINVAL if invalid argument
◆ forward_list_add_first()
| bk_err forward_list_add_first | ( | forward_list | me, |
| void *const | data | ||
| ) |
Adds data at the first index in the singly-linked list. The pointer to the data being passed in should point to the data type which this singly-linked list holds. For example, if this singly-linked list holds integers, the data pointer should be a pointer to an integer. Since the data is being copied, the pointer only has to be valid when this function is called.
- Parameters
-
me the singly-linked list to add data to data the data to add to the singly-linked list
- Returns
- BK_OK if no error
- -BK_ENOMEM if out of memory
◆ forward_list_add_last()
| bk_err forward_list_add_last | ( | forward_list | me, |
| void *const | data | ||
| ) |
Adds data at the last index in the singly-linked list. The pointer to the data being passed in should point to the data type which this singly-linked list holds. For example, if this singly-linked list holds integers, the data pointer should be a pointer to an integer. Since the data is being copied, the pointer only has to be valid when this function is called.
- Parameters
-
me the singly-linked list to add data to data the data to add to the singly-linked list
- Returns
- BK_OK if no error
- -BK_ENOMEM if out of memory
◆ forward_list_clear()
| void forward_list_clear | ( | forward_list | me | ) |
Clears all elements from the singly-linked list.
- Parameters
-
me the singly-linked list to clear
◆ forward_list_copy_to_array()
| void forward_list_copy_to_array | ( | void *const | arr, |
| forward_list | me | ||
| ) |
Copies the nodes of the singly-linked list to an array. Since it is a copy, the array may be modified without causing side effects to the singly-linked list data structure. Memory is not allocated, thus the array being used for the copy must be allocated before this function is called. The size of the singly-linked list should be queried prior to calling this function, which also serves as the size of the newly-copied array.
- Parameters
-
arr the initialized array to copy the singly-linked list to me the singly-linked list to copy to the array
◆ forward_list_destroy()
| forward_list forward_list_destroy | ( | forward_list | me | ) |
Destroys the singly-linked list. Performing further operations after calling this function results in undefined behavior. Freeing NULL is legal, and causes no operation to be performed.
- Parameters
-
me the singly-linked list to destroy
- Returns
- NULL
◆ forward_list_get_at()
| bk_err forward_list_get_at | ( | void *const | data, |
| forward_list | me, | ||
| const size_t | index | ||
| ) |
Gets the data at the specified index in the singly-linked list. The pointer to the data being obtained should point to the data type which this singly- linked list holds. For example, if this singly-linked list holds integers, the data pointer should be a pointer to an integer. Since this data is being copied from the array to the data pointer, the pointer only has to be valid when this function is called.
- Parameters
-
data the data to get me the singly-linked list to get data from index the index to get data from
- Returns
- BK_OK if no error
- -BK_EINVAL if invalid argument
◆ forward_list_get_first()
| bk_err forward_list_get_first | ( | void *const | data, |
| forward_list | me | ||
| ) |
Gets the data at the first index in the singly-linked list. The pointer to the data being obtained should point to the data type which this singly- linked list holds. For example, if this singly-linked list holds integers, the data pointer should be a pointer to an integer. Since this data is being copied from the array to the data pointer, the pointer only has to be valid when this function is called.
- Parameters
-
data the data to get me the singly-linked list to get data from
- Returns
- BK_OK if no error
- -BK_EINVAL if invalid argument
◆ forward_list_get_last()
| bk_err forward_list_get_last | ( | void *const | data, |
| forward_list | me | ||
| ) |
Gets the data at the last index in the singly-linked list. The pointer to the data being obtained should point to the data type which this singly- linked list holds. For example, if this singly-linked list holds integers, the data pointer should be a pointer to an integer. Since this data is being copied from the array to the data pointer, the pointer only has to be valid when this function is called.
- Parameters
-
data the data to get me the singly-linked list to get data from
- Returns
- BK_OK if no error
- -BK_EINVAL if invalid argument
◆ forward_list_init()
| forward_list forward_list_init | ( | const size_t | data_size | ) |
Initializes a singly-linked list.
- Parameters
-
data_size the size of data to store; must be positive
- Returns
- the newly-initialized singly-linked list, or NULL if it was not successfully initialized due to either invalid input arguments or memory allocation error
◆ forward_list_is_empty()
| bk_bool forward_list_is_empty | ( | forward_list | me | ) |
Determines if the singly-linked list is empty.
- Parameters
-
me the singly-linked list to check
- Returns
- BK_TRUE if the singly-linked list is empty, otherwise BK_FALSE
◆ forward_list_remove_at()
| bk_err forward_list_remove_at | ( | forward_list | me, |
| const size_t | index | ||
| ) |
Removes data from the singly-linked list at the specified index.
- Parameters
-
me the singly-linked list to remove data from index the index to remove from
- Returns
- BK_OK if no error
- -BK_EINVAL if invalid argument
◆ forward_list_remove_first()
| bk_err forward_list_remove_first | ( | forward_list | me | ) |
Removes the first piece of data from the singly-linked list.
- Parameters
-
me the singly-linked list to remove data from
- Returns
- BK_OK if no error
- -BK_EINVAL if invalid argument
◆ forward_list_remove_last()
| bk_err forward_list_remove_last | ( | forward_list | me | ) |
Removes the last piece of data from the singly-linked list.
- Parameters
-
me the singly-linked list to remove data from
- Returns
- BK_OK if no error
- -BK_EINVAL if invalid argument
◆ forward_list_set_at()
| bk_err forward_list_set_at | ( | forward_list | me, |
| const size_t | index, | ||
| void *const | data | ||
| ) |
Sets the data at the specified index in the singly-linked list. The pointer to the data being passed in should point to the data type which this singly- linked list holds. For example, if this singly-linked list holds integers, the data pointer should be a pointer to an integer. Since the data is being copied, the pointer only has to be valid when this function is called.
- Parameters
-
me the singly-linked list to set data for index the index to set data in the singly-linked list data the data to set in the singly-linked list
- Returns
- BK_OK if no error
- -BK_EINVAL if invalid argument
◆ forward_list_set_first()
| bk_err forward_list_set_first | ( | forward_list | me, |
| void *const | data | ||
| ) |
Sets the data at the first index in the singly-linked list. The pointer to the data being passed in should point to the data type which this singly- linked list holds. For example, if this singly-linked list holds integers, the data pointer should be a pointer to an integer. Since the data is being copied, the pointer only has to be valid when this function is called.
- Parameters
-
me the singly-linked list to set data for data the data to set in the singly-linked list
- Returns
- BK_OK if no error
- -BK_EINVAL if invalid argument
◆ forward_list_set_last()
| bk_err forward_list_set_last | ( | forward_list | me, |
| void *const | data | ||
| ) |
Sets the data at the last index in the singly-linked list. The pointer to the data being passed in should point to the data type which this singly- linked list holds. For example, if this singly-linked list holds integers, the data pointer should be a pointer to an integer. Since the data is being copied, the pointer only has to be valid when this function is called.
- Parameters
-
me the singly-linked list to set data for data the data to set in the singly-linked list
- Returns
- BK_OK if no error
- -BK_EINVAL if invalid argument
◆ forward_list_size()
| size_t forward_list_size | ( | forward_list | me | ) |
Gets the number of elements in the singly-linked list.
- Parameters
-
me the singly-linked list to check
- Returns
- the number of elements
