Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 717c1db6 authored by Mathieu Faverge's avatar Mathieu Faverge
Browse files

Minor on documentation

parent 68c516a4
No related branches found
No related tags found
No related merge requests found
This commit is part of merge request !19. Comments created here will be created in the context of that merge request.
...@@ -41,7 +41,7 @@ static int nbdesc = 0; ...@@ -41,7 +41,7 @@ static int nbdesc = 0;
/** /**
****************************************************************************** ******************************************************************************
* *
* @ingroup internal_descriptor * @ingroup Descriptor
* *
* morse_desc_init_user - Internal function to create tiled matrix descriptor * morse_desc_init_user - Internal function to create tiled matrix descriptor
* with generic function for data distribution and storage format. * with generic function for data distribution and storage format.
...@@ -559,11 +559,13 @@ int MORSE_Desc_Create_User(MORSE_desc_t **descptr, void *mat, MORSE_enum dtyp, i ...@@ -559,11 +559,13 @@ int MORSE_Desc_Create_User(MORSE_desc_t **descptr, void *mat, MORSE_enum dtyp, i
return MORSE_SUCCESS; return MORSE_SUCCESS;
} }
/** *************************************************************************** /**
*****************************************************************************
* *
* @ingroup Descriptor * @ingroup Descriptor
* *
* MORSE_Desc_Create_OOC - Create matrix descriptor for matrix which may not fit memory * MORSE_Desc_Create_OOC - Create matrix descriptor for tiled matrix which may
* not fit memory.
* *
****************************************************************************** ******************************************************************************
* *
...@@ -652,7 +654,8 @@ int MORSE_Desc_Create_OOC(MORSE_desc_t **descptr, MORSE_enum dtyp, int mb, int n ...@@ -652,7 +654,8 @@ int MORSE_Desc_Create_OOC(MORSE_desc_t **descptr, MORSE_enum dtyp, int mb, int n
#endif #endif
} }
/** *************************************************************************** /**
*****************************************************************************
* *
* @ingroup Descriptor * @ingroup Descriptor
* *
...@@ -690,7 +693,8 @@ int MORSE_Desc_Destroy(MORSE_desc_t **desc) ...@@ -690,7 +693,8 @@ int MORSE_Desc_Destroy(MORSE_desc_t **desc)
return MORSE_SUCCESS; return MORSE_SUCCESS;
} }
/** *************************************************************************** /**
*****************************************************************************
* *
* @ingroup Descriptor * @ingroup Descriptor
* *
...@@ -712,7 +716,8 @@ int MORSE_Desc_Acquire (MORSE_desc_t *desc) { ...@@ -712,7 +716,8 @@ int MORSE_Desc_Acquire (MORSE_desc_t *desc) {
return RUNTIME_desc_acquire( desc ); return RUNTIME_desc_acquire( desc );
} }
/** *************************************************************************** /**
*****************************************************************************
* *
* @ingroup Descriptor * @ingroup Descriptor
* *
...@@ -735,7 +740,8 @@ int MORSE_Desc_Release (MORSE_desc_t *desc) { ...@@ -735,7 +740,8 @@ int MORSE_Desc_Release (MORSE_desc_t *desc) {
return RUNTIME_desc_release( desc ); return RUNTIME_desc_release( desc );
} }
/** *************************************************************************** /**
*****************************************************************************
* *
* @ingroup Descriptor * @ingroup Descriptor
* *
...@@ -757,14 +763,15 @@ int MORSE_Desc_Getoncpu(MORSE_desc_t *desc) { ...@@ -757,14 +763,15 @@ int MORSE_Desc_Getoncpu(MORSE_desc_t *desc) {
return RUNTIME_desc_getoncpu( desc ); return RUNTIME_desc_getoncpu( desc );
} }
/** *************************************************************************** /**
*****************************************************************************
* *
* @ingroup Descriptor * @ingroup Descriptor
* *
* MORSE_user_tag_size - Set the sizes for the MPI tags * MORSE_user_tag_size - Set the sizes for the MPI tags
* Default value: tag_width=31, tag_sep=24, meaning that the MPI tag is stored in 31 bits, * Default value: tag_width=31, tag_sep=24, meaning that the MPI tag is stored
* with 24 bits for the tile tag and 7 for the descriptor. * in 31 bits, with 24 bits for the tile tag and 7 for the descriptor. This
* This function must be called before any descriptor creation. * function must be called before any descriptor creation.
* *
****************************************************************************** ******************************************************************************
* *
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment