/usr/include/trilinos/Amesos2_MatrixAdapter_decl.hpp is in libtrilinos-amesos2-dev 12.12.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 | // @HEADER
//
// ***********************************************************************
//
// Amesos2: Templated Direct Sparse Solver Package
// Copyright 2011 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef AMESOS2_MATRIXADAPTER_DECL_HPP
#define AMESOS2_MATRIXADAPTER_DECL_HPP
#include "Amesos2_config.h"
#include <Teuchos_Comm.hpp>
#include <Teuchos_ArrayView.hpp>
#include <Teuchos_VerbosityLevel.hpp>
#include <Teuchos_FancyOStream.hpp>
#include <Tpetra_ConfigDefs.hpp> // for global_size_t
// #include "Amesos2_ConcreteMatrixAdapter_decl.hpp"
#include "Amesos2_Util.hpp"
#include "Amesos2_MatrixTraits.hpp"
namespace Amesos2 {
template <class M> class ConcreteMatrixAdapter;
/**
* \brief A Matrix adapter interface for Amesos2.
*
* All Amesos2 solver interfaces are expected to use this matrix
* adapter interface to make their lives easier. The methods have
* been chosen to cater to a wide variety of third-party direct
* sparse solvers' needs.
*
* \ingroup amesos2_matrix_adapters
*/
template < class Matrix >
class MatrixAdapter {
public:
typedef typename MatrixTraits<Matrix>::scalar_t scalar_t;
typedef typename MatrixTraits<Matrix>::local_ordinal_t local_ordinal_t;
typedef typename MatrixTraits<Matrix>::global_ordinal_t global_ordinal_t;
typedef typename MatrixTraits<Matrix>::node_t node_t;
typedef Tpetra::global_size_t global_size_t;
typedef Matrix matrix_t;
typedef MatrixAdapter<Matrix> type;
typedef ConcreteMatrixAdapter<Matrix> adapter_t;
typedef typename MatrixTraits<Matrix>::local_matrix_t local_matrix_t;
typedef typename MatrixTraits<Matrix>::sparse_ptr_type spmtx_ptr_t;
typedef typename MatrixTraits<Matrix>::sparse_idx_type spmtx_idx_t;
typedef typename MatrixTraits<Matrix>::sparse_values_type spmtx_vals_t;
// template<typename S, typename GO, typename GS, typename Op>
// friend class Util::get_cxs_helper<MatrixAdapter<Matrix>,S,GO,GS,Op>;
// template<class M, typename S, typename GO, typename GS, typename Op>
// friend class Util::get_cxs_helper;
MatrixAdapter(Teuchos::RCP<Matrix> m);
/**
* \brief Gets a compressed-row storage summary of \c this
*
* Extracts a compressed-row storage format of the matrix and stores the
* information in the user-supplied containers.
*
* \param [out] nzval will hold the values of the nonzero entries of \c this
* \param [out] colind will hold the column indices of \c this for each row.
* \param [out] rowptr is of size <tt>nrow + 1</tt> and <tt>rowptr[j]</tt>
* stores the location in \c nzval and \c colind which starts
* row \c j of \c this. <tt>rowptr[nrow] = nnz</tt>, where \c
* nrow is the number of rows in this matrix.
* \param [out] nnz is the local number of nonzero entries in the
* representation of this matrix. For example, if this
* processor has 12 of the 23 nzvals in its rows, then \c nnz
* will be 12 on exit.
* \param [in] rowmap A Tpetra::Map describing the desired distribution of
* the rows of the CRS representation on the calling processors.
* \param [in] ordering
* \param [in] distribution (optional: default = ROOTED
* - only CONTIGUOUS_AND_ROOTED has an effect behavior)
*
* \exception std::length_error Thrown if \c nzval or \c colind is not
* large enough to hold the global number of nonzero values.
*
* \exception std::length_error Thrown if \c rowptr is not at least
* <tt>nrow + 1</tt> in size, the required size.
*
* \exception std::runtime_error Thrown if there is an error while extracting
* row values from the underlying matrix.
*/
void getCrs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> colind,
const Teuchos::ArrayView<global_size_t> rowptr,
global_size_t& nnz,
const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > rowmap,
EStorage_Ordering ordering=ARBITRARY,
EDistribution distribution=ROOTED) const; // This was placed as last argument to preserve API
/**
* Convenience overload for the getCrs function that uses an enum
* to describe some of the most basic distributions that could be
* desired.
*/
void getCrs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> colind,
const Teuchos::ArrayView<global_size_t> rowptr,
global_size_t& nnz,
EDistribution distribution,
EStorage_Ordering ordering=ARBITRARY) const;
/**
* \brief Gets a compressed-column storage summary of \c this
*
* Extracts a compressed-column storage format of the matrix and stores the
* information in the user-supplied containers.
*
* \param [out] nzval will hold the values of the nonzero entries of \c this
* \param [out] rowind will hold the row indices of \c this for each column.
* \param [out] colptr is of size <tt>ncol + 1</tt> and <tt>colptr[j]</tt>
* stores the location in \c nzval and \c rowind which starts
* column \c j of \c this. <tt>colptr[ncol] = nnz</tt>, where \c
* ncol is the number of columns in this matrix.
* \param [out] nnz is the number of nonzero entries in this matrix.
* \param [in] colmap A Tpetra::Map describing the desired distribution of
* the columns of the CCS representation on the calling processors.
* \param [in] ordering
* \param [in] distribution (optional: default = ROOTED
* - only CONTIGUOUS_AND_ROOTED has an effect behavior)
*
* \exception std::length_error Thrown if \c nzval or \c rowind is not
* large enough to hold the global number of nonzero values.
*
* \exception std::length_error Thrown if \c colptr is not at least
* <tt>ncol + 1</tt> in size, the required size.
*
* \exception std::runtime_error Thrown if there is an error while extracting
* row values from the underlying matrix.
*/
void getCcs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> rowind,
const Teuchos::ArrayView<global_size_t> colptr,
global_size_t& nnz,
const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > colmap,
EStorage_Ordering ordering=ARBITRARY,
EDistribution distribution=ROOTED) const; // This was placed as last argument to preserve API
/**
* Convenience overload for the getCcs function that uses an enum
* to describe some of the most basic distributions that could be
* desired.
*/
void getCcs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> rowind,
const Teuchos::ArrayView<global_size_t> colptr,
global_size_t& nnz,
EDistribution distribution,
EStorage_Ordering ordering=ARBITRARY) const;
/// Returns the Teuchos::Comm object associated with this matrix.
const Teuchos::RCP<const Teuchos::Comm<int> > getComm() const
{
return comm_;
}
/// Get the number of rows in this matrix
global_size_t getGlobalNumRows() const;
/// Get the number of columns in this matrix
global_size_t getGlobalNumCols() const;
/// Get the indexbase for the row map
global_size_t getRowIndexBase() const;
/// Get the indexbase for the column map
global_size_t getColumnIndexBase() const;
/// Get the global number of non-zeros in this sparse matrix
global_size_t getGlobalNNZ() const;
/// Get the number of rows local to the calling process
size_t getLocalNumRows() const;
/// Get the number of columns local to the calling process
size_t getLocalNumCols() const;
/// Get the local number of non-zeros on this processor
size_t getLocalNNZ() const;
Teuchos::RCP<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> >
getMap() const {
return static_cast<const adapter_t*>(this)->getMap_impl();
}
Teuchos::RCP<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> >
getRowMap() const {
return row_map_;
}
Teuchos::RCP<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> >
getColMap() const {
return col_map_;
}
Teuchos::RCP<const type> get(const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > map, EDistribution distribution = ROOTED) const;
/// Returns a short description of this Solver
std::string description() const;
/// Describes of this matrix adapter with some level of verbosity.
void describe(Teuchos::FancyOStream &out,
const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const;
/// Return raw pointer from CRS row pointer of matrixA_
spmtx_ptr_t returnRowPtr() const;
/// Return raw pointer from CRS column indices of matrixA_
spmtx_idx_t returnColInd() const;
/// Return raw pointer from CRS values of matrixA_
spmtx_vals_t returnValues() const;
private:
void help_getCrs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> colind,
const Teuchos::ArrayView<global_size_t> rowptr,
global_size_t& nnz,
const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > rowmap,
EDistribution distribution,
EStorage_Ordering ordering,
has_special_impl hsi) const;
void help_getCrs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> colind,
const Teuchos::ArrayView<global_size_t> rowptr,
global_size_t& nnz,
const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > rowmap,
EDistribution distribution,
EStorage_Ordering ordering,
no_special_impl nsi) const;
void do_getCrs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> colind,
const Teuchos::ArrayView<global_size_t> rowptr,
global_size_t& nnz,
const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > rowmap,
EDistribution distribution,
EStorage_Ordering ordering,
row_access ra) const;
void do_getCrs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> colind,
const Teuchos::ArrayView<global_size_t> rowptr,
global_size_t& nnz,
const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > rowmap,
EDistribution distribution,
EStorage_Ordering ordering,
col_access ca) const;
void help_getCcs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> rowind,
const Teuchos::ArrayView<global_size_t> colptr,
global_size_t& nnz,
const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > colmap,
EDistribution distribution,
EStorage_Ordering ordering,
has_special_impl hsi) const;
void help_getCcs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> rowind,
const Teuchos::ArrayView<global_size_t> colptr,
global_size_t& nnz,
const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > colmap,
EDistribution distribution,
EStorage_Ordering ordering,
no_special_impl nsi) const;
void do_getCcs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> rowind,
const Teuchos::ArrayView<global_size_t> colptr,
global_size_t& nnz,
const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > colmap,
EDistribution distribution,
EStorage_Ordering ordering,
row_access ra) const;
void do_getCcs(const Teuchos::ArrayView<scalar_t> nzval,
const Teuchos::ArrayView<global_ordinal_t> rowind,
const Teuchos::ArrayView<global_size_t> colptr,
global_size_t& nnz,
const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > colmap,
EDistribution distribution,
EStorage_Ordering ordering,
col_access ca) const;
protected:
// These methods will link to concrete implementations, and may
// also be used by them
/**
* \param [out] row the global matrix row
* \param [out] indices global column indices
* \param [out] vals the non-zero values in row \c row
* \param [out] nnz the number of nonzeros extracted from row \c row
*/
void getGlobalRowCopy(global_ordinal_t row,
const Teuchos::ArrayView<global_ordinal_t>& indices,
const Teuchos::ArrayView<scalar_t>& vals,
size_t& nnz) const;
/**
* \param [out] col the global matrix col
* \param [out] indices global column indices
* \param [out] vals the non-zero values in row \c row
* \param [out] nnz the number of nonzeros extracted from row \c row
*/
void getGlobalColCopy(global_ordinal_t col,
const Teuchos::ArrayView<global_ordinal_t>& indices,
const Teuchos::ArrayView<scalar_t>& vals,
size_t& nnz) const;
size_t getMaxRowNNZ() const;
size_t getMaxColNNZ() const;
size_t getGlobalRowNNZ(global_ordinal_t row) const;
size_t getLocalRowNNZ(local_ordinal_t row) const;
size_t getGlobalColNNZ(global_ordinal_t col) const;
size_t getLocalColNNZ(local_ordinal_t col) const;
bool isLocallyIndexed() const;
bool isGloballyIndexed() const;
protected:
const Teuchos::RCP<const Matrix> mat_;
mutable Teuchos::RCP<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > row_map_;
mutable Teuchos::RCP<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > col_map_;
mutable Teuchos::RCP<const Teuchos::Comm<int> > comm_;
}; // end class MatrixAdapter
// Factory creation method
template <class Matrix>
Teuchos::RCP<MatrixAdapter<Matrix> >
createMatrixAdapter(Teuchos::RCP<Matrix> m);
template <class Matrix>
Teuchos::RCP<const MatrixAdapter<Matrix> >
createConstMatrixAdapter(Teuchos::RCP<const Matrix> m);
} // end namespace Amesos2
#endif // AMESOS2_MATRIXADAPTER_DECL_HPP
|