Class template Dune::XT::LA::CommonSparseMatrix

Inherits from Dune::XT::LA::MatrixInterface.

template<class ScalarImp>
class Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc> : public MatrixInterface<internal::CommonSparseMatrixTraits<ScalarImp, Common::StorageLayout::csc>, ScalarImp>

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

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

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

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::deep_copy

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

No documentation provided.

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

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

No documentation provided.

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

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

\ {

Required by ContainerInterface.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

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

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

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::mv

template<class ScalarImp>
void Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>::mv(const CommonSparseVector<ScalarType> &xx, CommonSparseVector<ScalarType> &yy) const

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::mtv

template<class ScalarImp>
void Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>::mtv(const CommonSparseVector<ScalarType> &xx, CommonSparseVector<ScalarType> &yy) const

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::start_column

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

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::end_column

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

template<class ScalarImp>
SparsityPatternDefault Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>::pattern(const bool prune = false, const EpsType eps) const override

No documentation provided.

Method Dune::XT::LA::CommonSparseMatrix::rightmultiply

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

Constructor Dune::XT::LA::CommonSparseMatrix::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>

template<>
template<class ScalarImp>
Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>(const int rr, const int cc, const SparsityPatternDefault &patt, const int num_mutexes = 1, const EpsType eps)

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

Constructor Dune::XT::LA::CommonSparseMatrix::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>

template<>
template<class ScalarImp>
explicit Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>(const int rr = 0, const int cc = 0, const ScalarType &value = ScalarType(0), const int num_mutexes = 1, const EpsType eps)

No documentation provided.

Constructor Dune::XT::LA::CommonSparseMatrix::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>

template<>
template<class ScalarImp>
Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>(const int rr, const int cc, const int num_mutexes)

No documentation provided.

Constructor Dune::XT::LA::CommonSparseMatrix::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>

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

No documentation provided.

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

int Dune::XT::LA::CommonSparseMatrix::num_cols_

No documentation provided.

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

int Dune::XT::LA::CommonSparseMatrix::num_rows_

No documentation provided.

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

std::shared_ptr<EntriesVectorType> Dune::XT::LA::CommonSparseMatrix::entries_

No documentation provided.

Field Dune::XT::LA::CommonSparseMatrix::column_pointers_

std::shared_ptr<IndexVectorType> Dune::XT::LA::CommonSparseMatrix::column_pointers_

No documentation provided.

Field Dune::XT::LA::CommonSparseMatrix::row_indices_

std::shared_ptr<IndexVectorType> Dune::XT::LA::CommonSparseMatrix::row_indices_

No documentation provided.

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

int Dune::XT::LA::CommonSparseMatrix::mutexes_

No documentation provided.

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

EpsType Dune::XT::LA::CommonSparseMatrix::eps_

No documentation provided.

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

type Dune::XT::LA::CommonSparseMatrix::ThisType

No documentation provided.

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

type Dune::XT::LA::CommonSparseMatrix::InterfaceType

No documentation provided.

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

type Dune::XT::LA::CommonSparseMatrix::EntriesVectorType

No documentation provided.

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

type Dune::XT::LA::CommonSparseMatrix::EpsType

No documentation provided.

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

type Dune::XT::LA::CommonSparseMatrix::IndexVectorType

No documentation provided.

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

type Dune::XT::LA::CommonSparseMatrix::MutexesType

No documentation provided.

Function template Dune::XT::LA::CommonSparseMatrix::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>

template<class ScalarImp>
template<class OtherMatrixType>
explicit Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>(const OtherMatrixType &mat, const typename std::enable_if<Common::MatrixAbstraction<OtherMatrixType>::is_matrix, bool>::type prune = false, const EpsType eps, const int num_mutexes = 1)

No documentation provided.

Function template Dune::XT::LA::CommonSparseMatrix::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>

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

No documentation provided.

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

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

No documentation provided.

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

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

No documentation provided.

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

template<class ScalarImp>
template<class XX, class YY>
inline int Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>::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>
template<class XX, class YY>
inline int Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>::mtv(const XX &xx, YY &yy) const

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

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

template<class ScalarImp>
template<class OtherMatrixImp>
ScalarType Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>::rightmultiply_entry(const OtherMatrixImp &other, const int rr, const int cc) const

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

template<class ScalarImp>
template<class OtherMatrixImp>
int Dune::XT::LA::CommonSparseMatrix<ScalarImp, Common::StorageLayout::csc>::rightmultiply(const OtherMatrixImp &other)

No documentation provided.