The Initialize_Data_Index procedure allocates and initializes a Data_Index object.
Calling syntax:
call Initialize (Index, Many_Structure, One_Structure, Many_of_One_Vector, Many_of_One_Array, Many_of_One_Ragged, status) |
Input variables:
Index | The Data_Index object to be initialized. | ||
Many_of_One_Array | The index vector, giving indices for the "Many" that correspond with each "One". Only the rows ("Ones") for this PE are included. Zero entries signify the lack of a reference. If this is specified, then Many_of_One_Vector and Many_of_One_Ragged should not be specified. [Optional] | ||
Many_of_One_Ragged | The index vector, giving indices for the "Many" that correspond with each "One". Only the rows ("Ones") for this PE are included. Zero entries signify the lack of a reference. If this is specified, then Many_of_One_Vector and Many_of_One_Array should not be specified. [Optional] - NOT IMPLEMENTED YET. | ||
Many_of_One_Vector | The index vector, giving indices for the "Many" that correspond with each "One". Only the rows ("Ones") for this PE are included. Zero entries signify the lack of a reference. If this is specified, then Many_of_One_Array and Many_of_One_Ragged should not be specified. [Optional] | ||
Many_Structure | A data structure that corresponds to the columns in the index array. | ||
One_Structure | A data structure that corresponds to the rows in the index array. |
Output variables:
Index | The Data_Index object has been allocated and initialized. | ||
status | If present, the status variable is set to either 'Memory Error' or 'Success' depending on program execution. If not present, the procedure aborts if unsuccessful when the DEBUG_LEVEL is set high enough. |
Internal variables:
allocate_status | Allocation Status. |
The Initialize_Data_Index code listing contains additional documentation.
Michael L. Hall