Monday, July 7, 2014

New API andDocumentation Standards

The API of M1RI has been updated for the better.  Names across m3d, m5d, and m7d, have been synchronized.   Documentation in format for generation in doxygen is being added.  New Basic functions that were not planned before have been added.

Until now m1ri_die, which displays an error message, has been underused up until this point.  Many functions have simply done nothing if improper data is entered.   This is being remedied.    For example, in  m3d_strassen, if  the matrix to be written to is already allocated, and of improper dimensions, it outputs "m3d_strassen: Provided return matrix has wrong dimensions.", while calling m1ri_die (forces the m1ri to close).

Many void functions now return pointers.   This also coincides with several functions not  requiring preallocated pointers.    An example is m3d_create, which returns an m3d_t * instead of void.  









No comments:

Post a Comment