This represents the overall linked list. More...
#include <pm_list.h>
Collaboration diagram for pm_list_t:
Public Member Functions | |
| PRISM_EXPORTED_FUNCTION bool | pm_list_empty_p (pm_list_t *list) |
| Returns true if the given list is empty. | |
| PRISM_EXPORTED_FUNCTION size_t | pm_list_size (pm_list_t *list) |
| Returns the size of the list. | |
| PRISM_EXPORTED_FUNCTION void | pm_list_free (pm_list_t *list) |
| Deallocate the internal state of the given list. | |
Data Fields | |
| size_t | size |
| The size of the list. | |
| pm_list_node_t * | head |
| A pointer to the head of the list. | |
| pm_list_node_t * | tail |
| A pointer to the tail of the list. | |
Detailed Description
This represents the overall linked list.
It keeps a pointer to the head and tail so that iteration is easy and pushing new nodes is easy.
Member Function Documentation
◆ pm_list_empty_p()
| PRISM_EXPORTED_FUNCTION bool pm_list_empty_p | ( | pm_list_t * | list | ) |
Returns true if the given list is empty.
- Parameters
-
list The list to check.
- Returns
- True if the given list is empty, otherwise false.
◆ pm_list_size()
| PRISM_EXPORTED_FUNCTION size_t pm_list_size | ( | pm_list_t * | list | ) |
Returns the size of the list.
- Parameters
-
list The list to check.
- Returns
- The size of the list.
◆ pm_list_free()
| PRISM_EXPORTED_FUNCTION void pm_list_free | ( | pm_list_t * | list | ) |
Deallocate the internal state of the given list.
- Parameters
-
list The list to free.
The documentation for this struct was generated from the following file:
- include/prism/util/pm_list.h
