neighborListOps.h

Go to the documentation of this file.

#ifndef NEIGHBORLISTOPS_H_
#define NEIGHBORLISTOPS_H_


void nbrListCreate(NbrList* nbrListPtr);


//TODO: implement or delete?
void groupList(NbrList* partialList, int group);
void groupTestList(NbrList* partialList, int group, NbrList* full);

//TODO: Functions from neighbors.c - move or not?
void nbrListClear(NbrList* nbrListPtr);


/*
 * @brief Gets the size of the input neighbor list
 *
 * @param nbrListPtr pointer for the neighbor list
 * @returns size of neighbor list
 */
uint8 nbrListGetSize(NbrList* nbrListPtr);


/*
 * @brief Gets the neighbor at a given index in neighbor list
 *
 * @param nbrListPtr pointer for the neighbor list
 * @param idx index
 * @returns pointer to the neighbor at the input index
 */
Nbr* nbrListGetNbr(NbrList* nbrListPtr, uint8 idx);


/*
 * @brief Prints the IDs of all robots in the neighbor list.
 *
 * Formated as follows:
 * {name, ID, ID, ID, ...}
 * @param nbrListPtr pointer for the neighbor list
 * @param name for the list name
 * @returns void
 */
void nbrListPrint(NbrList* nbrListPtr, char* name);


void nbrListPrintDebug(NbrList* nbrListPtr, char* name);
//TODO: End neighbors.c functions

void nbrListAddNbr(NbrList* nbrListPtr, Nbr* nbrPtr);


void nbrListRemoveNbr(NbrList* nbrListPtr, Nbr* nbrPtr);


void nbrListCopy(NbrList* nbrListDstPtr, NbrList* nbrListSrcPtr);


int16 nbrListAverageBearing(NbrList* nbrListPtr);


Nbr* nbrListGetFirst(NbrList* nbrListPtr);


Nbr* nbrListGetSecond(NbrList* nbrListPtr);


Nbr* nbrListGetNbrWithID(NbrList* nbrListPtr, uint8 ID);


Nbr* nbrListGetSmallestAngleDeviation2(NbrList* nbrListPtr, Nbr* nbrPtr);


Nbr* nbrListGetClosestNbrToBearing(NbrList* nbrListPtr, int16 bearing);


NbrList* nbrListUnion(NbrList* nbrListOutPtr, NbrList* nbrList1Ptr, NbrList* nbrList2Ptr);


NbrList* nbrListFindNbrsWithDataEqual(NbrList* nbrListOutPtr, NbrList* nbrListInPtr, NbrData* nbrDataPtr, uint8 val);


NbrList* nbrListFindNbrsWithDataEqual2(NbrList* nbrListOutPtr, NbrList* nbrListInPtr, NbrData* nbrDataPtr, uint8 val1, uint8 val2);


Nbr* nbrListGetNbrMinBearing(NbrList* nbrListInPtr);


NbrList* nbrListSortByBearing(NbrList* nbrListOutPtr, NbrList* nbrListInPtr);


NbrList* nbrListIncludeSectorInclusive(NbrList* nbrListOutPtr, NbrList* nbrListInPtr, int16 angleStart,  int16 angleEnd);


NbrList* nbrListIncludeSectorExclusive(NbrList* nbrListOutPtr, NbrList* nbrListInPtr, int16 angleStart,  int16 angleEnd);


NbrList* nbrListGetRobots(NbrList* nbrListOutPtr, NbrList* nbrListInPtr);


void nbrListMakeCloneExcept(NbrList* nbrListOutPtr, uint8 nbrID);

#endif /* NEIGHBORLISTOPS_H_ */