From 284b2522edb42e8911d042c32556a3ee7771038f Mon Sep 17 00:00:00 2001 From: Doc CI Action Date: Tue, 10 Dec 2024 14:37:16 +0000 Subject: [PATCH] Doc: Add miniapps as tests (#1112) --- ...1_1comm_1_1_communicator_grid-members.html | 1 + ...assdlaf_1_1comm_1_1_communicator_grid.html | 21 ++++++++ master/communicator__grid_8h_source.html | 49 ++++++++++--------- master/functions_func_w.html | 1 + master/functions_w.html | 1 + master/search/all_16.js | 13 ++--- master/search/functions_13.js | 3 +- 7 files changed, 59 insertions(+), 30 deletions(-) diff --git a/master/classdlaf_1_1comm_1_1_communicator_grid-members.html b/master/classdlaf_1_1comm_1_1_communicator_grid-members.html index 94c8a3a6fe..5360a4a5e5 100644 --- a/master/classdlaf_1_1comm_1_1_communicator_grid-members.html +++ b/master/classdlaf_1_1comm_1_1_communicator_grid-members.html @@ -107,6 +107,7 @@ rowCommunicator() noexceptdlaf::comm::CommunicatorGridinline size() const noexceptdlaf::comm::CommunicatorGridinline subCommunicator(Coord cr) noexcept (defined in dlaf::comm::CommunicatorGrid)dlaf::comm::CommunicatorGridinline + wait_all_communicators()dlaf::comm::CommunicatorGrid
diff --git a/master/classdlaf_1_1comm_1_1_communicator_grid.html b/master/classdlaf_1_1comm_1_1_communicator_grid.html index d6ff62e8f5..6c3bb00af7 100644 --- a/master/classdlaf_1_1comm_1_1_communicator_grid.html +++ b/master/classdlaf_1_1comm_1_1_communicator_grid.html @@ -138,6 +138,8 @@ template<Coord C> CommunicatorPipeline< coord_to_communicator_type(C)> communicator_pipeline ()   +void wait_all_communicators () +  @@ -456,6 +458,25 @@

Return a Communicator grouping all ranks in the row (that includes the current process).

+ + + +

◆ wait_all_communicators()

+ +
+
+

Protected Types

+ + + + + + +
void dlaf::comm::CommunicatorGrid::wait_all_communicators ()
+
+

Synchronization barrier for all communicators in the grid

+

This function returns when all communications on the communicators in the grid have completed.

+
The documentation for this class was generated from the following file:
    diff --git a/master/communicator__grid_8h_source.html b/master/communicator__grid_8h_source.html index b68654328f..41ec34310b 100644 --- a/master/communicator__grid_8h_source.html +++ b/master/communicator__grid_8h_source.html @@ -203,38 +203,41 @@
    132 }
    133
    -
    -
    135 friend std::ostream& operator<<(std::ostream& out, const CommunicatorGrid& grid) {
    -
    136 return out << "position=" << grid.position_ << ", size=" << grid.grid_size_;
    -
    137 }
    -
    +
    137 void wait_all_communicators();
    138
    -
    139protected:
    -
    140 Communicator full_;
    -
    141 Communicator row_;
    -
    142 Communicator col_;
    +
    +
    140 friend std::ostream& operator<<(std::ostream& out, const CommunicatorGrid& grid) {
    +
    141 return out << "position=" << grid.position_ << ", size=" << grid.grid_size_;
    +
    142 }
    +
    143
    -
    144 template <CommunicatorType CT>
    -
    145 using RoundRobinPipeline = dlaf::common::RoundRobin<CommunicatorPipeline<CT>>;
    -
    146
    -
    147 RoundRobinPipeline<CommunicatorType::Full> full_pipelines_;
    -
    148 RoundRobinPipeline<CommunicatorType::Row> row_pipelines_;
    -
    149 RoundRobinPipeline<CommunicatorType::Col> col_pipelines_;
    -
    150
    -
    151 Index2D position_;
    -
    152 Size2D grid_size_ = Size2D(0, 0);
    -
    153};
    +
    144protected:
    +
    145 Communicator full_;
    +
    146 Communicator row_;
    +
    147 Communicator col_;
    +
    148
    +
    149 template <CommunicatorType CT>
    +
    150 using RoundRobinPipeline = dlaf::common::RoundRobin<CommunicatorPipeline<CT>>;
    +
    151
    +
    152 RoundRobinPipeline<CommunicatorType::Full> full_pipelines_;
    +
    153 RoundRobinPipeline<CommunicatorType::Row> row_pipelines_;
    +
    154 RoundRobinPipeline<CommunicatorType::Col> col_pipelines_;
    +
    155
    +
    156 Index2D position_;
    +
    157 Size2D grid_size_ = Size2D(0, 0);
    +
    158};
    -
    154
    -
    155} // namespace comm
    -
    156} // namespace dlaf
    +
    159
    +
    160} // namespace comm
    +
    161} // namespace dlaf
    dlaf::comm::CommunicatorGrid
    Definition communicator_grid.h:37
    dlaf::comm::CommunicatorGrid::CommunicatorGrid
    CommunicatorGrid(Communicator comm, const std::array< IndexT_MPI, 2 > &size, common::Ordering ordering, std::size_t npipelines=getTuneParameters().communicator_grid_num_pipelines)
    Definition communicator_grid.h:48
    dlaf::comm::CommunicatorGrid::communicator_pipeline
    CommunicatorPipeline< coord_to_communicator_type(C)> communicator_pipeline()
    Definition communicator_grid.h:127
    dlaf::comm::CommunicatorGrid::rank
    Index2D rank() const noexcept
    Definition communicator_grid.h:74
    dlaf::comm::CommunicatorGrid::colCommunicator
    Communicator & colCommunicator() noexcept
    Definition communicator_grid.h:96
    dlaf::comm::CommunicatorGrid::row_communicator_pipeline
    CommunicatorPipeline< CommunicatorType::Row > row_communicator_pipeline()
    Definition communicator_grid.h:114
    -
    dlaf::comm::CommunicatorGrid::operator<<
    friend std::ostream & operator<<(std::ostream &out, const CommunicatorGrid &grid)
    Prints information about the CommunicationGrid.
    Definition communicator_grid.h:135
    + +
    dlaf::comm::CommunicatorGrid::operator<<
    friend std::ostream & operator<<(std::ostream &out, const CommunicatorGrid &grid)
    Prints information about the CommunicationGrid.
    Definition communicator_grid.h:140
    dlaf::comm::CommunicatorGrid::size
    Size2D size() const noexcept
    Return the number of rows in the grid.
    Definition communicator_grid.h:79
    dlaf::comm::CommunicatorGrid::CommunicatorGrid
    CommunicatorGrid(Communicator comm, IndexT_MPI rows, IndexT_MPI cols, common::Ordering ordering, std::size_t npipelines=getTuneParameters().communicator_grid_num_pipelines)
    dlaf::comm::CommunicatorGrid::full_communicator_pipeline
    CommunicatorPipeline< CommunicatorType::Full > full_communicator_pipeline()
    Return a pipeline to a Communicator grouping all ranks in the grid.
    Definition communicator_grid.h:108
    diff --git a/master/functions_func_w.html b/master/functions_func_w.html index b3dfcd2a2d..1c357b7f1d 100644 --- a/master/functions_func_w.html +++ b/master/functions_func_w.html @@ -72,6 +72,7 @@
    Here is a list of all documented functions with links to the class documentation for each member:

    - w -

    diff --git a/master/functions_w.html b/master/functions_w.html index e9e0e7238a..f29e8dcab0 100644 --- a/master/functions_w.html +++ b/master/functions_w.html @@ -72,6 +72,7 @@
    Here is a list of all documented class members with links to the class documentation for each member:

    - w -

    diff --git a/master/search/all_16.js b/master/search/all_16.js index b86ff821b1..abd3da53f8 100644 --- a/master/search/all_16.js +++ b/master/search/all_16.js @@ -1,9 +1,10 @@ var searchData= [ - ['waitlocaltiles_0',['waitLocalTiles',['../classdlaf_1_1matrix_1_1_matrix_3_01const_01_t_00_01_d_01_4.html#abffc73bf079f7f7c23af3fca4dec329f',1,'dlaf::matrix::Matrix< const T, D >']]], - ['with_5fresult_5fof_2eh_1',['with_result_of.h',['../with__result__of_8h.html',1,'']]], - ['withresultof_2',['WithResultOf',['../classdlaf_1_1internal_1_1_with_result_of.html',1,'dlaf::internal']]], - ['workspace_3',['WorkSpace',['../structdlaf_1_1eigensolver_1_1internal_1_1_work_space.html',1,'dlaf::eigensolver::internal']]], - ['workspacehost_4',['WorkSpaceHost',['../structdlaf_1_1eigensolver_1_1internal_1_1_work_space_host.html',1,'dlaf::eigensolver::internal']]], - ['workspacehostmirror_5',['WorkSpaceHostMirror',['../structdlaf_1_1eigensolver_1_1internal_1_1_work_space_host_mirror.html',1,'dlaf::eigensolver::internal']]] + ['wait_5fall_5fcommunicators_0',['wait_all_communicators',['../classdlaf_1_1comm_1_1_communicator_grid.html#a5d81da35f8c4683dcdfbd9091d7d8f7e',1,'dlaf::comm::CommunicatorGrid']]], + ['waitlocaltiles_1',['waitLocalTiles',['../classdlaf_1_1matrix_1_1_matrix_3_01const_01_t_00_01_d_01_4.html#abffc73bf079f7f7c23af3fca4dec329f',1,'dlaf::matrix::Matrix< const T, D >']]], + ['with_5fresult_5fof_2eh_2',['with_result_of.h',['../with__result__of_8h.html',1,'']]], + ['withresultof_3',['WithResultOf',['../classdlaf_1_1internal_1_1_with_result_of.html',1,'dlaf::internal']]], + ['workspace_4',['WorkSpace',['../structdlaf_1_1eigensolver_1_1internal_1_1_work_space.html',1,'dlaf::eigensolver::internal']]], + ['workspacehost_5',['WorkSpaceHost',['../structdlaf_1_1eigensolver_1_1internal_1_1_work_space_host.html',1,'dlaf::eigensolver::internal']]], + ['workspacehostmirror_6',['WorkSpaceHostMirror',['../structdlaf_1_1eigensolver_1_1internal_1_1_work_space_host_mirror.html',1,'dlaf::eigensolver::internal']]] ]; diff --git a/master/search/functions_13.js b/master/search/functions_13.js index 6e012b5f41..8708a0aad9 100644 --- a/master/search/functions_13.js +++ b/master/search/functions_13.js @@ -1,4 +1,5 @@ var searchData= [ - ['waitlocaltiles_0',['waitLocalTiles',['../classdlaf_1_1matrix_1_1_matrix_3_01const_01_t_00_01_d_01_4.html#abffc73bf079f7f7c23af3fca4dec329f',1,'dlaf::matrix::Matrix< const T, D >']]] + ['wait_5fall_5fcommunicators_0',['wait_all_communicators',['../classdlaf_1_1comm_1_1_communicator_grid.html#a5d81da35f8c4683dcdfbd9091d7d8f7e',1,'dlaf::comm::CommunicatorGrid']]], + ['waitlocaltiles_1',['waitLocalTiles',['../classdlaf_1_1matrix_1_1_matrix_3_01const_01_t_00_01_d_01_4.html#abffc73bf079f7f7c23af3fca4dec329f',1,'dlaf::matrix::Matrix< const T, D >']]] ];