use sunindextype1d where needed

Author: balos1

include/sundials/sundials_types.h

@@ -150,6 +150,20 @@ typedef sunrealtype*** sunrealtype3d;
 
 typedef SUNDIALS_INDEX_TYPE sunindextype;
 
+
+/*
+ *-----------------------------------------------------------------------------
+ * Type(s): sunindextype1d, sunindextype2d, sunindextype3d
+ * These types are to be used in place of sunindextype*, sunindextype**, and
+ * sunindextype*** when semantically these map to arrays. I.e., if sunindextype*
+ * refers to an array, then use sunindextype1d. If it refers to a 
+ * a pointer to a singular value (for "out" params), use sunindextype*.
+ *-----------------------------------------------------------------------------
+ */
+typedef sunindextype* sunindextype1d;
+typedef sunindextype** sunindextype2d;
+typedef sunindextype*** sunindextype3d;
+
 /*
  *------------------------------------------------------------------
  * Type : suncountertype

include/sunmatrix/sunmatrix_band.h

@@ -108,9 +108,9 @@ SUNDIALS_EXPORT sunindextype SUNBandMatrix_UpperBandwidth(SUNMatrix A);
 SUNDIALS_EXPORT sunindextype SUNBandMatrix_StoredUpperBandwidth(SUNMatrix A);
 SUNDIALS_EXPORT sunindextype SUNBandMatrix_LDim(SUNMatrix A);
 SUNDIALS_EXPORT sunindextype SUNBandMatrix_LData(SUNMatrix A);
-SUNDIALS_EXPORT sunrealtype* SUNBandMatrix_Data(SUNMatrix A);
-SUNDIALS_EXPORT sunrealtype** SUNBandMatrix_Cols(SUNMatrix A);
-SUNDIALS_EXPORT sunrealtype* SUNBandMatrix_Column(SUNMatrix A, sunindextype j);
+SUNDIALS_EXPORT sunrealtype1d SUNBandMatrix_Data(SUNMatrix A);
+SUNDIALS_EXPORT sunrealtype2d SUNBandMatrix_Cols(SUNMatrix A);
+SUNDIALS_EXPORT sunrealtype1d SUNBandMatrix_Column(SUNMatrix A, sunindextype j);
 
 SUNDIALS_EXPORT SUNMatrix_ID SUNMatGetID_Band(SUNMatrix A);
 SUNDIALS_EXPORT SUNMatrix SUNMatClone_Band(SUNMatrix A);

include/sunmatrix/sunmatrix_dense.h

@@ -85,9 +85,9 @@ SUNDIALS_EXPORT void SUNDenseMatrix_Print(SUNMatrix A, FILE* outfile);
 SUNDIALS_EXPORT sunindextype SUNDenseMatrix_Rows(SUNMatrix A);
 SUNDIALS_EXPORT sunindextype SUNDenseMatrix_Columns(SUNMatrix A);
 SUNDIALS_EXPORT sunindextype SUNDenseMatrix_LData(SUNMatrix A);
-SUNDIALS_EXPORT sunrealtype* SUNDenseMatrix_Data(SUNMatrix A);
-SUNDIALS_EXPORT sunrealtype** SUNDenseMatrix_Cols(SUNMatrix A);
-SUNDIALS_EXPORT sunrealtype* SUNDenseMatrix_Column(SUNMatrix A, sunindextype j);
+SUNDIALS_EXPORT sunrealtype1d SUNDenseMatrix_Data(SUNMatrix A);
+SUNDIALS_EXPORT sunrealtype2d SUNDenseMatrix_Cols(SUNMatrix A);
+SUNDIALS_EXPORT sunrealtype1d SUNDenseMatrix_Column(SUNMatrix A, sunindextype j);
 
 SUNDIALS_EXPORT SUNMatrix_ID SUNMatGetID_Dense(SUNMatrix A);
 SUNDIALS_EXPORT SUNMatrix SUNMatClone_Dense(SUNMatrix A);

include/sunmatrix/sunmatrix_sparse.h

@@ -143,13 +143,13 @@ SUNDIALS_EXPORT
 int SUNSparseMatrix_SparseType(SUNMatrix A);
 
 SUNDIALS_EXPORT
-sunrealtype* SUNSparseMatrix_Data(SUNMatrix A);
+sunrealtype1d SUNSparseMatrix_Data(SUNMatrix A);
 
 SUNDIALS_EXPORT
-sunindextype* SUNSparseMatrix_IndexValues(SUNMatrix A);
+sunindextype1d SUNSparseMatrix_IndexValues(SUNMatrix A);
 
 SUNDIALS_EXPORT
-sunindextype* SUNSparseMatrix_IndexPointers(SUNMatrix A);
+sunindextype1d SUNSparseMatrix_IndexPointers(SUNMatrix A);
 
 SUNDIALS_EXPORT
 SUNMatrix_ID SUNMatGetID_Sparse(SUNMatrix A);