Changeset dea6384f in OpenModelica


Ignore:
Timestamp:
2022-05-17T15:02:38+02:00 (23 months ago)
Author:
Philip Hannebohm <phannebohm@…>
Parents:
58677f97
Message:

Add function descriptions

File:
1 edited

Legend:

Unmodified
Added
Removed
  • OMCompiler/SimulationRuntime/c/util/list.c

    r58677f97 rdea6384f  
    4242
    4343
     44/**
     45 * @brief Allocates memory for a new empty list
     46 *
     47 * @param itemSize    Size of data
     48 * @return list       Pointer to list
     49 */
    4450LIST *allocList(unsigned int itemSize)
    4551{
     
    5561}
    5662
     63/**
     64 * @brief Frees list and everything inside it
     65 *
     66 * @param list    Pointer to list
     67 */
    5768void freeList(LIST *list)
    5869{
     
    6475}
    6576
     77/**
     78 * @brief Frees node and data inside node
     79 *
     80 * @param node    Pointer to node
     81 */
    6682void freeNode(LIST_NODE *node)
    6783{
     
    7086}
    7187
     88/**
     89 * @brief Copies data into new tmpNode and pushes tmpNode to the front of list
     90 *
     91 * @param list    Pointer to list
     92 * @param data    Pointer to data (copied)
     93 */
    7294void listPushFront(LIST *list, const void *data)
    7395{
     
    94116 *
    95117 * @param list    Pointer to list
    96  * @param node    Pointer to node (will not be copied)
     118 * @param node    Pointer to node (not copied)
    97119 */
    98120void listPushFrontNodeNoCopy(LIST *list, LIST_NODE *node)
     
    108130}
    109131
     132/**
     133 * @brief Copies data into new tmpNode and pushes tmpNode to the back of list
     134 *
     135 * @param list    Pointer to list
     136 * @param data    Pointer to data (copied)
     137 */
    110138void listPushBack(LIST *list, const void *data)
    111139{
     
    132160}
    133161
     162/**
     163 * @brief Copies data into new tmpNode and inserts tmpNode into list after prevNode
     164 *
     165 * @param list       Pointer to list
     166 * @param prevNode   Pointer to previous node
     167 * @param data       Pointer to data (copied)
     168 */
    134169void listInsert(LIST *list, LIST_NODE* prevNode, const void *data)
    135170{
     
    149184}
    150185
     186/**
     187 * @brief Returns the length of list
     188 *
     189 * @param list    Pointer to list
     190 * @return        length of list
     191 */
    151192int listLen(LIST *list)
    152193{
     
    155196}
    156197
     198/**
     199 * @brief Returns data of first node in list
     200 *
     201 * @param list    Pointer to list
     202 * @return        Pointer to data of first node in list
     203 */
    157204void *listFirstData(LIST *list)
    158205{
     
    162209}
    163210
     211/**
     212 * @brief Returns data of last node in list
     213 *
     214 * @param list    Pointer to list
     215 * @return        Pointer to data of last node in list
     216 */
    164217void *listLastData(LIST *list)
    165218{
     
    170223
    171224/**
    172  * @brief Return first node and pop from list
     225 * @brief Returns first node and pops node from list
    173226 *
    174227 * @param list    Pointer to list
     
    190243
    191244/**
    192  * @brief Remove and free first node from list
     245 * @brief Removes and frees first node from list
    193246 *
    194247 * @param list    Pointer to list
     
    209262}
    210263
     264/**
     265 * @brief Frees all nodes and their data in list
     266 *
     267 * @param list    Pointer to list
     268 */
    211269void listClear(LIST *list)
    212270{
     
    229287}
    230288
     289/**
     290 * @brief Removes and frees nodes from list starting from node
     291 *
     292 * used only in simulation/solver/nonlinearValuesList
     293 *
     294 * @param list    Pointer to list
     295 * @param node    Pointer to node
     296 */
    231297void removeNodes(LIST* list, LIST_NODE *node)
    232298{
     
    240306}
    241307
     308/**
     309 * @brief Retruns first node of list
     310 *
     311 * @param list    Pointer to list
     312 * @return        Pointer to first node
     313 */
    242314LIST_NODE *listFirstNode(LIST *list)
    243315{
     
    247319}
    248320
     321/**
     322 * @brief Returns next node after node (used for iterating over list)
     323 *
     324 * @param node    Pointer to node
     325 * @return        Pointer to next node
     326 */
    249327LIST_NODE *listNextNode(LIST_NODE *node)
    250328{
     
    255333}
    256334
     335/**
     336 * @brief Returns node data
     337 *
     338 * @param node    Pointer to node
     339 * @return        Pointer to data
     340 */
    257341void *listNodeData(LIST_NODE *node)
    258342{
     
    262346}
    263347
     348/* not sure about this, looks dangerous */
    264349void updateNodeData(LIST *list, LIST_NODE *node, const void *data)
    265350{
     
    271356}
    272357
     358/* not sure about this, looks dangerous */
    273359LIST_NODE* updateNodeNext(LIST *list, LIST_NODE *node, LIST_NODE *newNext)
    274360{
     
    281367}
    282368
     369/* not sure about this, looks dangerous */
    283370void updatelistFirst(LIST* list, LIST_NODE *node)
    284371{
     
    288375}
    289376
     377/* not sure about this, looks dangerous */
    290378void updatelistLength(LIST* list, unsigned int newLength)
    291379{
Note: See TracChangeset for help on using the changeset viewer.