From f30e968e0a880c4eacd80419db726d057f16fbc1 Mon Sep 17 00:00:00 2001 From: Naej Date: Sat, 24 Dec 2016 16:41:06 +0100 Subject: [PATCH] added some doc --- LibAutomaton/matrix.h | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/LibAutomaton/matrix.h b/LibAutomaton/matrix.h index 797f5c8..92aca29 100644 --- a/LibAutomaton/matrix.h +++ b/LibAutomaton/matrix.h @@ -64,17 +64,48 @@ cellElement * FindMatrixElem(Matrix matrix, int ColPos, int RowPos); *@param ColPos an int indicating the column of the cell *@param RowPos an int indicating the row of the cell * -*@return void +*@return a bool (error code) * */ bool CreateMatrixElem(Matrix matrix, int ColPos, int RowPos); +/** +*Delete the cell in the given matrix +* +*@param matrix the Matrix +*@param ColPos an int indicating the column of the cell +*@param RowPos an int indicating the row of the cell +* +*@return an error code (int) +* +*/ int SupprMatrixElem(Matrix matrix, int ColPos, int RowPos); +/** +*Delete or create the cell in the given matrix to fit the value +* +*@param matrix the Matrix +*@param ColPos an int indicating the column of the cell +*@param RowPos an int indicating the row of the cell +* +*@return an error code (bool) +* +*/ bool SetCellValue(Matrix matrix, int ColPos, int RowPos, bool value); +/** +*Checks out the value of the cell in the given matrix +* +*@param matrix the Matrix +*@param ColPos an int indicating the column of the cell +*@param RowPos an int indicating the row of the cell +* +*@return the value (bool) +* +*/ bool GetCellValue(Matrix matrix, int ColPos, int RowPos); + Matrix SetMatrixDim(Matrix matrix,int nbCols,int nbRows); void BasicPrintMatrix(Matrix matrix);