Markus Mottl avatar Markus Mottl committed e16e1a5

Improved documentation

Comments (0)

Files changed (1)

lib/impl_SDCZ.mli

   ?ac : int ->
   mat ->
   unit
-(** [getri ?n ?ipiv ?work ?ar ?ac a]
+(** [getri ?n ?ipiv ?work ?ar ?ac a]. Note that matrix [a] will be passed to
+    [getrf] if [ipiv] was not provided.
     @raise Failure if the matrix is singular.
     @param n default = number of columns in matrix [a]
     @param ipiv default = vec of length [m] from getri
   ?bc : int ->
   mat ->
   unit
-(** [sytrs ?n ?up ?ipiv ?ar ?ac a ?nrhs ?br ?bc b]
+(** [sytrs ?n ?up ?ipiv ?ar ?ac a ?nrhs ?br ?bc b]. Note that matrix [a] will be
+    passed to [sytrf] if [ipiv] was not provided.
     @raise Failure if the matrix is singular.
     @param n default = number of columns in matrix [a]
     @param up default = true (store upper triangle in [a])
   ?ac : int ->
   mat ->
   unit
-(** [sytri ?n ?up ?ipiv ?work ?ar ?ac a]
+(** [sytri ?n ?up ?ipiv ?work ?ar ?ac a]. Note that matrix [a] will be
+    passed to [sytrf] if [ipiv] was not provided.
     @raise Failure if the matrix is singular.
     @param n default = number of columns in matrix [a]
     @param up default = true (store upper triangle in [a])
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.