Class template Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>

template<class ScalarImp, Common::StorageLayout layout>
class Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>

A sparse matrix implementation of the MatrixInterface with row major memory layout.

Method Dune::XT::LA::CommonSparseMatrix::operator=

template<class ScalarImp, Common::StorageLayout layout>
ThisType &Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::operator=(const ThisType &other)

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::clear

template<class ScalarImp, Common::StorageLayout layout>
void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::clear()

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::copy

template<class ScalarImp, Common::StorageLayout layout>
inline ThisType Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::copy() const

\ {

Required by ContainerInterface.

Method Dune::XT::LA::CommonSparseMatrix::scal

template<class ScalarImp, Common::StorageLayout layout>
inline void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::scal(const ScalarType &alpha)

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::axpy

template<class ScalarImp, Common::StorageLayout layout>
inline void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::axpy(const ScalarType &alpha, const ThisType &xx)

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::has_equal_shape

template<class ScalarImp, Common::StorageLayout layout>
inline bool Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::has_equal_shape(const ThisType &other) const

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::rows

template<class ScalarImp, Common::StorageLayout layout>
inline size_t Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::rows() const

\ }

Required by MatrixInterface.

\ {

Method Dune::XT::LA::CommonSparseMatrix::cols

template<class ScalarImp, Common::StorageLayout layout>
inline size_t Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::cols() const

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::add_to_entry

template<class ScalarImp, Common::StorageLayout layout>
inline void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::add_to_entry(const size_t rr, const size_t cc, const ScalarType &value)

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::get_entry

template<class ScalarImp, Common::StorageLayout layout>
inline ScalarType Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::get_entry(const size_t rr, const size_t cc) const

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::set_entry

template<class ScalarImp, Common::StorageLayout layout>
inline void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::set_entry(const size_t rr, const size_t cc, const ScalarType value)

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::start_row

template<class ScalarImp, Common::StorageLayout layout>
inline void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::start_row()

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::end_row

template<class ScalarImp, Common::StorageLayout layout>
inline void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::end_row()

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::push_entry

template<class ScalarImp, Common::StorageLayout layout>
inline void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::push_entry(const size_t cc, const ScalarType value)

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::clear_row

template<class ScalarImp, Common::StorageLayout layout>
inline void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::clear_row(const size_t rr)

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::clear_col

template<class ScalarImp, Common::StorageLayout layout>
inline void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::clear_col(const size_t cc)

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::unit_row

template<class ScalarImp, Common::StorageLayout layout>
inline void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::unit_row(const size_t rr)

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::unit_col

template<class ScalarImp, Common::StorageLayout layout>
inline void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::unit_col(const size_t cc)

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::valid

template<class ScalarImp, Common::StorageLayout layout>
bool Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::valid() const

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::non_zeros

template<class ScalarImp, Common::StorageLayout layout>
size_t Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::non_zeros() const final

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::pattern

template<class ScalarImp, Common::StorageLayout layout>
SparsityPatternDefault Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::pattern(const bool prune = false, const EpsType eps = Common::FloatCmp::DefaultEpsilon<ScalarType>::value() / 1000.) const override

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::entries

template<class ScalarImp, Common::StorageLayout layout>
ScalarType *Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::entries()

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::entries

template<class ScalarImp, Common::StorageLayout layout>
const ScalarType *Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::entries() const

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::outer_index_ptr

template<class ScalarImp, Common::StorageLayout layout>
size_t *Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::outer_index_ptr()

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::outer_index_ptr

template<class ScalarImp, Common::StorageLayout layout>
const size_t *Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::outer_index_ptr() const

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::inner_index_ptr

template<class ScalarImp, Common::StorageLayout layout>
size_t *Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::inner_index_ptr()

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::inner_index_ptr

template<class ScalarImp, Common::StorageLayout layout>
const size_t *Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::inner_index_ptr() const

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::eps

template<class ScalarImp, Common::StorageLayout layout>
const EpsType &Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::eps()

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::get_entry_index

template<class ScalarImp, Common::StorageLayout layout>
size_t Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::get_entry_index(const size_t rr, const size_t cc, const bool throw_if_not_in_pattern = true) const

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::is_zero

template<class ScalarImp, Common::StorageLayout layout>
bool Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::is_zero(const ScalarType val, const ScalarType eps) const

No documentation provided.

Constructor Dune::XT::LA::CommonSparseMatrix::CommonSparseMatrix

template<class ScalarImp, Common::StorageLayout layout>
Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::CommonSparseMatrix(const size_t rr, const size_t cc, const SparsityPatternDefault &patt, const size_t num_mutexes = 1, const EpsType eps = Common::FloatCmp::DefaultEpsilon<ScalarType>::value() / 1000.)

This is the constructor of interest which creates a sparse matrix.

Constructor Dune::XT::LA::CommonSparseMatrix::CommonSparseMatrix

template<class ScalarImp, Common::StorageLayout layout>
explicit Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::CommonSparseMatrix(const size_t rr = 0, const size_t cc = 0, const ScalarType &value = ScalarType(0), const size_t num_mutexes = 1, const EpsType eps = Common::FloatCmp::DefaultEpsilon<ScalarType>::value() / 1000.)

No documentation provided.

Constructor Dune::XT::LA::CommonSparseMatrix::CommonSparseMatrix

template<class ScalarImp, Common::StorageLayout layout>
Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::CommonSparseMatrix(const ThisType &other)

No documentation provided.

Field Dune::XT::LA::CommonSparseMatrix::num_cols_

template<class ScalarImp, Common::StorageLayout layout>
size_t Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::num_cols_

No documentation provided.

Field Dune::XT::LA::CommonSparseMatrix::num_rows_

template<class ScalarImp, Common::StorageLayout layout>
size_t Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::num_rows_

No documentation provided.

Field Dune::XT::LA::CommonSparseMatrix::entries_

template<class ScalarImp, Common::StorageLayout layout>
std::shared_ptr<EntriesVectorType> Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::entries_

No documentation provided.

Field Dune::XT::LA::CommonSparseMatrix::row_pointers_

template<class ScalarImp, Common::StorageLayout layout>
std::shared_ptr<IndexVectorType> Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::row_pointers_

No documentation provided.

Field Dune::XT::LA::CommonSparseMatrix::column_indices_

template<class ScalarImp, Common::StorageLayout layout>
std::shared_ptr<IndexVectorType> Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::column_indices_

No documentation provided.

Field Dune::XT::LA::CommonSparseMatrix::mutexes_

template<class ScalarImp, Common::StorageLayout layout>
std::unique_ptr<MutexesType> Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::mutexes_

No documentation provided.

Field Dune::XT::LA::CommonSparseMatrix::eps_

template<class ScalarImp, Common::StorageLayout layout>
EpsType Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::eps_

No documentation provided.

Type alias Dune::XT::LA::CommonSparseMatrix::ThisType

template<class ScalarImp, Common::StorageLayout layout>
using Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::ThisType = CommonSparseMatrix<ScalarImp, layout>

No documentation provided.

Type alias Dune::XT::LA::CommonSparseMatrix::InterfaceType

template<class ScalarImp, Common::StorageLayout layout>
using Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::InterfaceType = MatrixInterface<internal::CommonSparseMatrixTraits<ScalarImp, layout>, ScalarImp>

No documentation provided.

Type alias Dune::XT::LA::CommonSparseMatrix::EntriesVectorType

template<class ScalarImp, Common::StorageLayout layout>
using Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::EntriesVectorType = typename Traits::EntriesVectorType

No documentation provided.

Type alias Dune::XT::LA::CommonSparseMatrix::EpsType

template<class ScalarImp, Common::StorageLayout layout>
using Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::EpsType = typename Traits::EpsType

No documentation provided.

Type alias Dune::XT::LA::CommonSparseMatrix::IndexVectorType

template<class ScalarImp, Common::StorageLayout layout>
using Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::IndexVectorType = typename Traits::IndexVectorType

No documentation provided.

Type alias Dune::XT::LA::CommonSparseMatrix::MutexesType

template<class ScalarImp, Common::StorageLayout layout>
using Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::MutexesType = typename Traits::MutexesType

No documentation provided.

Function template Dune::XT::LA::CommonSparseMatrix::CommonSparseMatrix

template<class ScalarImp, Common::StorageLayout layout>
template<class OtherMatrixType>
explicit Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::CommonSparseMatrix(const OtherMatrixType &mat, const typename std::enable_if<Common::MatrixAbstraction<OtherMatrixType>::is_matrix, bool>::type prune = false, const EpsType eps = Common::FloatCmp::DefaultEpsilon<ScalarType>::value() / 1000., const size_t num_mutexes = 1)

No documentation provided.

Function template Dune::XT::LA::CommonSparseMatrix::CommonSparseMatrix

template<class ScalarImp, Common::StorageLayout layout>
template<class OtherMatrixType>
explicit Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::CommonSparseMatrix(const OtherMatrixType &mat, const typename std::enable_if<Common::MatrixAbstraction<OtherMatrixType>::is_matrix, bool>::type prune, const size_t num_mutexes)

No documentation provided.

Function template Dune::XT::LA::CommonSparseMatrix::copy_to_densematrix

template<class ScalarImp, Common::StorageLayout layout>
template<class DenseMatrixImp>
void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::copy_to_densematrix(DenseMatrixImp &ret) const

No documentation provided.

Function template Dune::XT::LA::CommonSparseMatrix::assign

template<class ScalarImp, Common::StorageLayout layout>
template<class OtherMatrixImp>
ThisType &Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::assign(const OtherMatrixImp &other, const SparsityPatternDefault &pattern)

No documentation provided.

Function template Dune::XT::LA::CommonSparseMatrix::operator=

template<class ScalarImp, Common::StorageLayout layout>
template<class OtherMatrixImp>
typename std::enable_if_t<XT::Common::MatrixAbstraction<OtherMatrixImp>::is_matrix, ThisType> &Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::operator=(const OtherMatrixImp &other)

No documentation provided.

Function template Dune::XT::LA::CommonSparseMatrix::mv

template<class ScalarImp, Common::StorageLayout layout>
template<class XX, class YY>
inline std::enable_if_t<XT::Common::VectorAbstraction<XX>::is_vector && XT::Common::VectorAbstraction<YY>::is_vector, void> Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::mv(const XX &xx, YY &yy) const

Matrix-Vector multiplication for arbitrary vectors that support operator[]

Function template Dune::XT::LA::CommonSparseMatrix::mtv

template<class ScalarImp, Common::StorageLayout layout>
template<class XX, class YY>
inline std::enable_if_t<XT::Common::VectorAbstraction<XX>::is_vector && XT::Common::VectorAbstraction<YY>::is_vector, void> Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::mtv(const XX &xx, YY &yy) const

TransposedMatrix-Vector multiplication for arbitrary vectors that support operator[]

Function template Dune::XT::LA::CommonSparseMatrix::rightmultiply

template<class ScalarImp, Common::StorageLayout layout>
template<class MatrixType>
void Dune::XT::LA::CommonSparseMatrix<ScalarImp, layout>::rightmultiply(const MatrixType &other)

\ }