From 6403d870385f2496c31113d8f5ce82061e5e1a67 Mon Sep 17 00:00:00 2001 From: Doc CI Action Date: Fri, 28 Jul 2023 11:55:28 +0000 Subject: [PATCH] Doc Add `MatrixRef` to take a sub-matrix from an existing `Matrix` (#934) --- master/annotated.html | 45 +- ...af_1_1matrix_1_1_distribution-members.html | 27 +- .../classdlaf_1_1matrix_1_1_distribution.html | 143 ++- ...1_1matrix_1_1internal_1_1_matrix_base.html | 3 +- ..._1_1matrix_1_1internal_1_1_matrix_base.png | Bin 781 -> 1294 bytes ...ix_1_1internal_1_1_matrix_ref-members.html | 95 ++ ..._1_1matrix_1_1internal_1_1_matrix_ref.html | 253 ++++++ ...f_3_01const_01_t_00_01_d_01_4-members.html | 113 +++ ...atrix_ref_3_01const_01_t_00_01_d_01_4.html | 325 +++++++ ...matrix_ref_3_01const_01_t_00_01_d_01_4.png | Bin 0 -> 886 bytes master/classes.html | 4 +- .../dir_21834082df7a318c018c9cc963be86ec.html | 2 + master/distribution_8h.html | 3 + master/distribution_8h_source.html | 851 +++++++++--------- ...lver_2band__to__tridiag_2mc_8h_source.html | 10 +- ...bt__band__to__tridiag_2impl_8h_source.html | 14 +- ...__reduction__to__band_2impl_8h_source.html | 2 +- ..._2reduction__to__band_2impl_8h_source.html | 2 +- master/files.html | 15 +- master/functions_func_g.html | 3 + master/functions_func_m.html | 6 +- master/functions_func_r.html | 8 +- master/functions_func_t.html | 3 + master/functions_g.html | 3 + master/functions_m.html | 6 +- master/functions_r.html | 8 +- master/functions_t.html | 3 + master/hierarchy.html | 201 +++-- master/layout__info_8h_source.html | 2 +- master/matrix_8h_source.html | 2 +- master/matrix__base_8h_source.html | 8 +- master/matrix__ref_8h.html | 146 +++ master/matrix__ref_8h_source.html | 259 ++++++ master/panel_8h_source.html | 2 +- ...permutations_2general_2impl_8h_source.html | 8 +- master/rot_8h_source.html | 2 +- master/search/all_10.js | 62 +- master/search/all_11.js | 138 +-- master/search/all_12.js | 105 +-- master/search/all_13.js | 48 +- master/search/all_14.js | 14 +- master/search/all_15.js | 8 +- master/search/all_16.js | 12 +- master/search/all_3.js | 4 +- master/search/all_6.js | 3 +- master/search/all_7.js | 36 +- master/search/all_8.js | 62 +- master/search/all_9.js | 2 +- master/search/all_a.js | 32 +- master/search/all_b.js | 79 +- master/search/all_c.js | 22 +- master/search/all_d.js | 28 +- master/search/all_e.js | 56 +- master/search/all_f.js | 6 +- master/search/classes_0.js | 20 +- master/search/classes_1.js | 14 +- master/search/classes_10.js | 40 +- master/search/classes_11.js | 32 +- master/search/classes_12.js | 8 +- master/search/classes_13.js | 6 +- master/search/classes_2.js | 60 +- master/search/classes_3.js | 32 +- master/search/classes_4.js | 6 +- master/search/classes_5.js | 2 +- master/search/classes_6.js | 14 +- master/search/classes_7.js | 24 +- master/search/classes_8.js | 30 +- master/search/classes_9.js | 2 +- master/search/classes_a.js | 44 +- master/search/classes_b.js | 10 +- master/search/classes_c.js | 30 +- master/search/classes_d.js | 4 +- master/search/classes_e.js | 6 +- master/search/classes_f.js | 43 +- master/search/defines_0.js | 2 +- master/search/defines_1.js | 2 +- master/search/enums_0.js | 2 +- master/search/files_0.js | 4 +- master/search/files_1.js | 12 +- master/search/files_10.js | 10 +- master/search/files_11.js | 18 +- master/search/files_12.js | 14 +- master/search/files_13.js | 4 +- master/search/files_2.js | 12 +- master/search/files_3.js | 8 +- master/search/files_4.js | 6 +- master/search/files_5.js | 6 +- master/search/files_6.js | 6 +- master/search/files_7.js | 2 +- master/search/files_8.js | 6 +- master/search/files_9.js | 2 +- master/search/files_a.js | 2 +- master/search/files_b.js | 13 +- master/search/files_c.js | 2 +- master/search/files_d.js | 14 +- master/search/files_e.js | 2 +- master/search/files_f.js | 10 +- master/search/functions_0.js | 6 +- master/search/functions_1.js | 16 +- master/search/functions_10.js | 51 +- master/search/functions_11.js | 2 +- master/search/functions_12.js | 4 +- master/search/functions_13.js | 2 +- master/search/functions_14.js | 12 +- master/search/functions_2.js | 52 +- master/search/functions_3.js | 26 +- master/search/functions_4.js | 12 +- master/search/functions_5.js | 6 +- master/search/functions_6.js | 37 +- master/search/functions_7.js | 10 +- master/search/functions_8.js | 22 +- master/search/functions_9.js | 30 +- master/search/functions_a.js | 35 +- master/search/functions_b.js | 10 +- master/search/functions_c.js | 26 +- master/search/functions_d.js | 16 +- master/search/functions_e.js | 46 +- master/search/functions_f.js | 82 +- master/search/related_0.js | 2 +- master/search/related_1.js | 2 +- master/search/related_2.js | 2 +- master/search/typedefs_0.js | 4 +- master/search/typedefs_1.js | 4 +- master/search/typedefs_2.js | 3 +- master/search/variables_0.js | 2 +- master/search/variables_1.js | 4 +- master/search/variables_2.js | 6 +- master/search/variables_3.js | 4 +- master/search/variables_4.js | 2 +- master/search/variables_5.js | 4 +- ...rix_1_1_sub_distribution_spec-members.html | 83 ++ ...f_1_1matrix_1_1_sub_distribution_spec.html | 101 +++ master/tile__collector_8h_source.html | 4 +- master/util__matrix_8h_source.html | 8 +- master/views_8h_source.html | 12 +- 135 files changed, 3118 insertions(+), 1512 deletions(-) create mode 100644 master/classdlaf_1_1matrix_1_1internal_1_1_matrix_ref-members.html create mode 100644 master/classdlaf_1_1matrix_1_1internal_1_1_matrix_ref.html create mode 100644 master/classdlaf_1_1matrix_1_1internal_1_1_matrix_ref_3_01const_01_t_00_01_d_01_4-members.html create mode 100644 master/classdlaf_1_1matrix_1_1internal_1_1_matrix_ref_3_01const_01_t_00_01_d_01_4.html create mode 100644 master/classdlaf_1_1matrix_1_1internal_1_1_matrix_ref_3_01const_01_t_00_01_d_01_4.png create mode 100644 master/matrix__ref_8h.html create mode 100644 master/matrix__ref_8h_source.html create mode 100644 master/structdlaf_1_1matrix_1_1_sub_distribution_spec-members.html create mode 100644 master/structdlaf_1_1matrix_1_1_sub_distribution_spec.html diff --git a/master/annotated.html b/master/annotated.html index 2af7c85d4a..e162759f0c 100644 --- a/master/annotated.html +++ b/master/annotated.html @@ -222,32 +222,35 @@  CCopyTile< T, Device::GPU, Device::GPU >  CTilePipeline  CMatrixBase - Cnumpy_datatype - Cnumpy_datatype< std::complex< T > > - CTileData - CView + CMatrixRef + CMatrixRef< const T, D > + Cnumpy_datatype + Cnumpy_datatype< std::complex< T > > + CTileData + CView  Nutil  Ninternal  Cgetter_randomCallable that returns random values in the range [-1, 1]  Cgetter_random< std::complex< T > >Callable that returns random complex numbers whose absolute values are less than 1  CDuplicateNoCopy - CDistribution - CLayoutInfo - CMatrix - CMatrix< const T, D > - CSubPipelineTag - CMatrixMirror - CMatrixMirror< const T, SourceTarget, SourceTarget > - CMatrixMirror< T, SourceTarget, SourceTarget > - CMatrixMirror< const T, Target, Source > - CPanel - CPanel< axis, const T, D, StoreTransposed::No > - CPanel< axis, const T, D, StoreTransposed::Yes > - CSubTileSpecContains the information to create a subtile - CTile - CTile< const T, D > - CSubMatrixView - CSubPanelView + CSubDistributionSpecContains information to create a sub-distribution + CDistribution + CLayoutInfo + CMatrix + CMatrix< const T, D > + CSubPipelineTag + CMatrixMirror + CMatrixMirror< const T, SourceTarget, SourceTarget > + CMatrixMirror< T, SourceTarget, SourceTarget > + CMatrixMirror< const T, Target, Source > + CPanel + CPanel< axis, const T, D, StoreTransposed::No > + CPanel< axis, const T, D, StoreTransposed::Yes > + CSubTileSpecContains the information to create a subtile + CTile + CTile< const T, D > + CSubMatrixView + CSubPanelView  Nmemory  CMemoryChunkThe class MemoryChunk represents a layer of abstraction over the underlying device memory  CMemoryView diff --git a/master/classdlaf_1_1matrix_1_1_distribution-members.html b/master/classdlaf_1_1matrix_1_1_distribution-members.html index 153908ba1d..59dacaec25 100644 --- a/master/classdlaf_1_1matrix_1_1_distribution-members.html +++ b/master/classdlaf_1_1matrix_1_1_distribution-members.html @@ -84,15 +84,17 @@ Distribution(const GlobalElementSize &size, const TileElementSize &block_size, const TileElementSize &tile_size, const comm::Size2D &grid_size, const comm::Index2D &rank_index, const comm::Index2D &source_rank_index, const GlobalTileIndex &tile_offset, const GlobalElementIndex &element_offset={0, 0})dlaf::matrix::Distribution Distribution(const Distribution &rhs)=default (defined in dlaf::matrix::Distribution)dlaf::matrix::Distribution Distribution(Distribution &&rhs) noexcept (defined in dlaf::matrix::Distribution)dlaf::matrix::Distribution - globalElementFromGlobalTileAndTileElement(SizeType global_tile, SizeType tile_element) const noexceptdlaf::matrix::Distributioninline - globalElementFromLocalTileAndTileElement(SizeType local_tile, SizeType tile_element) const noexceptdlaf::matrix::Distributioninline - globalElementIndex(const GlobalTileIndex &global_tile, const TileElementIndex &tile_element) const noexceptdlaf::matrix::Distributioninline - globalTileElementDistance(SizeType i_begin, SizeType i_end) const noexceptdlaf::matrix::Distributioninline - globalTileElementDistance(GlobalTileIndex begin, GlobalTileIndex end) const noexcept (defined in dlaf::matrix::Distribution)dlaf::matrix::Distributioninline - globalTileFromGlobalElement(SizeType global_element) const noexceptdlaf::matrix::Distributioninline - globalTileFromLocalTile(SizeType local_tile) const noexceptdlaf::matrix::Distributioninline - globalTileIndex(const GlobalElementIndex &global_element) const noexceptdlaf::matrix::Distributioninline - globalTileIndex(const LocalTileIndex &local_tile) const noexceptdlaf::matrix::Distributioninline + Distribution(Distribution dist, const SubDistributionSpec &spec)dlaf::matrix::Distribution + globalElementFromGlobalTileAndTileElement(SizeType global_tile, SizeType tile_element) const noexceptdlaf::matrix::Distributioninline + globalElementFromLocalTileAndTileElement(SizeType local_tile, SizeType tile_element) const noexceptdlaf::matrix::Distributioninline + globalElementIndex(const GlobalTileIndex &global_tile, const TileElementIndex &tile_element) const noexceptdlaf::matrix::Distributioninline + globalTileElementDistance(SizeType i_begin, SizeType i_end) const noexceptdlaf::matrix::Distributioninline + globalTileElementDistance(GlobalTileIndex begin, GlobalTileIndex end) const noexcept (defined in dlaf::matrix::Distribution)dlaf::matrix::Distributioninline + globalTileFromGlobalElement(SizeType global_element) const noexceptdlaf::matrix::Distributioninline + globalTileFromLocalTile(SizeType local_tile) const noexceptdlaf::matrix::Distributioninline + globalTileIndex(const GlobalElementIndex &global_element) const noexceptdlaf::matrix::Distributioninline + globalTileIndex(const LocalTileIndex &local_tile) const noexceptdlaf::matrix::Distributioninline + globalTileIndexFromSubDistribution(const GlobalElementIndex &sub_offset, const Distribution &sub_distribution, const GlobalTileIndex &sub_index) const noexceptdlaf::matrix::Distributioninline globalTileLinearIndex(GlobalElementIndex i_gl) const noexceptdlaf::matrix::Distributioninline localElementDistanceFromGlobalTile(SizeType i_begin, SizeType i_end) const noexceptdlaf::matrix::Distributioninline localElementDistanceFromGlobalTile(GlobalTileIndex begin, GlobalTileIndex end) const noexceptdlaf::matrix::Distributioninline @@ -119,9 +121,10 @@ sourceRankIndex() const noexcept (defined in dlaf::matrix::Distribution)dlaf::matrix::Distributioninline tileElementFromGlobalElement(SizeType global_element) const noexceptdlaf::matrix::Distributioninline tileElementIndex(const GlobalElementIndex &global_element) const noexceptdlaf::matrix::Distributioninline - tileSize(SizeType global_tile) const noexcept (defined in dlaf::matrix::Distribution)dlaf::matrix::Distributioninline - tileSize(const GlobalTileIndex &index) const noexceptdlaf::matrix::Distributioninline - tileSizeFromGlobalElement(SizeType i_gl) const noexceptdlaf::matrix::Distributioninline + tileElementOffsetFromSubDistribution(const GlobalElementIndex &sub_offset, const Distribution &sub_distribution, const GlobalTileIndex &sub_index) const noexceptdlaf::matrix::Distributioninline + tileSize(SizeType global_tile) const noexcept (defined in dlaf::matrix::Distribution)dlaf::matrix::Distributioninline + tileSize(const GlobalTileIndex &index) const noexceptdlaf::matrix::Distributioninline + tileSizeFromGlobalElement(SizeType i_gl) const noexceptdlaf::matrix::Distributioninline