Documented mutator functions in BLISObjectAPI.md.

Details:
- Added documentation for commonly-used object mutator functions in
  BLISObjectAPI.md. Previously, only accessor functions were documented.
  Thanks to Jeff Diamond for pointing out this omission.
- Explicitly set the 'diag' property of objects in oapi example modules
  (08level2.c and 09level3.c).
This commit is contained in:
Field G. Van Zee
2020-08-06 17:14:01 -05:00
parent 6e522e5823
commit adedb893ae
3 changed files with 114 additions and 33 deletions

View File

@@ -246,10 +246,11 @@ int main( int argc, char** argv )
// displaying junk values in the unstored triangle.
bli_setm( &BLIS_ZERO, &a );
// Mark matrix 'a' as triangular and stored in the lower triangle, and
// then randomize that lower triangle.
// Mark matrix 'a' as triangular, stored in the lower triangle, and
// having a non-unit diagonal. Then randomize that lower triangle.
bli_obj_set_struc( BLIS_TRIANGULAR, &a );
bli_obj_set_uplo( BLIS_LOWER, &a );
bli_obj_set_diag( BLIS_NONUNIT_DIAG, &a );
bli_randm( &a );
bli_printm( "a: randomized (zeros in upper triangle)", &a, "%4.1f", "" );
@@ -288,10 +289,11 @@ int main( int argc, char** argv )
// displaying junk values in the unstored triangle.
bli_setm( &BLIS_ZERO, &a );
// Mark matrix 'a' as triangular and stored in the lower triangle, and
// then randomize that lower triangle.
// Mark matrix 'a' as triangular, stored in the lower triangle, and
// having a non-unit diagonal. Then randomize that lower triangle.
bli_obj_set_struc( BLIS_TRIANGULAR, &a );
bli_obj_set_uplo( BLIS_LOWER, &a );
bli_obj_set_diag( BLIS_NONUNIT_DIAG, &a );
bli_randm( &a );
// Load the diagonal. By setting the diagonal to something of greater

View File

@@ -244,10 +244,11 @@ int main( int argc, char** argv )
// displaying junk values in the unstored triangle.
bli_setm( &BLIS_ZERO, &a );
// Mark matrix 'a' as triangular and stored in the lower triangle, and
// then randomize that lower triangle.
// Mark matrix 'a' as triangular, stored in the lower triangle, and
// having a non-unit diagonal. Then randomize that lower triangle.
bli_obj_set_struc( BLIS_TRIANGULAR, &a );
bli_obj_set_uplo( BLIS_LOWER, &a );
bli_obj_set_diag( BLIS_NONUNIT_DIAG, &a );
bli_randm( &a );
bli_printm( "a: randomized (zeros in upper triangle)", &a, "%4.1f", "" );
@@ -290,10 +291,11 @@ int main( int argc, char** argv )
// displaying junk values in the unstored triangle.
bli_setm( &BLIS_ZERO, &a );
// Mark matrix 'a' as triangular and stored in the lower triangle, and
// then randomize that lower triangle.
// Mark matrix 'a' as triangular, stored in the lower triangle, and
// having a non-unit diagonal. Then randomize that lower triangle.
bli_obj_set_struc( BLIS_TRIANGULAR, &a );
bli_obj_set_uplo( BLIS_LOWER, &a );
bli_obj_set_diag( BLIS_NONUNIT_DIAG, &a );
bli_randm( &a );
// Load the diagonal. By setting the diagonal to something of greater