KASKADE 7 development version: Kaskade::SparseLinearSystem Class Reference

KASKADE 7 development version

Abstract base class for a sparse linear system. More...

#include <linearsystem.hh>

Detailed Description

Abstract base class for a sparse linear system.

Definition at line 29 of file linearsystem.hh.

Inheritance diagram for Kaskade::SparseLinearSystem:

Public Member Functions
virtual void	getMatrix (MatrixAsTriplet< double > &mat) const
	Return the matrix of the linear system in triplet format. More...

virtual void	getRHS (std::vector< double > &rhs) const
	Return the right hand side of the linear system. More...

virtual int	size () const
	Return the number of variables of the linear system. More...

virtual int	rows (int rbegin, int rend) const =0

virtual int	cols (int colbegin, int colend) const =0

virtual void	getMatrixBlocks (MatrixAsTriplet< double > &mat, int rbegin, int rend, int colbegin, int colend) const =0
	Return matrix blocks of the linear system in triplet format. More...

virtual double	getValue () const =0
	value of function More...

virtual void	getRHSBlocks (std::vector< double > &rhs, int rbegin, int rend) const =0
	Return components of the right hand side of the linear system. More...

virtual int	nColBlocks () const =0
	number of column blocks More...

virtual int	nRowBlocks () const =0
	number of row blocks More...

virtual	~SparseLinearSystem ()

Constructor & Destructor Documentation

◆ ~SparseLinearSystem()

virtual Kaskade::SparseLinearSystem::~SparseLinearSystem ( )

inlinevirtual

Definition at line 59 of file linearsystem.hh.

Member Function Documentation

◆ cols()

virtual int Kaskade::SparseLinearSystem::cols	(	int	colbegin,
		int	colend
	)		const

pure virtual

Implemented in Kaskade::Bridge::KaskadeLinearization< Functional >, and Kaskade::SimpleSparseLinearSystem.

Referenced by size(), and Kaskade::Bridge::DirectInnerSolver< DirectSolver >::solveAdjAndNormal().

◆ getMatrix()

virtual void Kaskade::SparseLinearSystem::getMatrix ( MatrixAsTriplet< double > & mat ) const

inlinevirtual

Return the matrix of the linear system in triplet format.

Definition at line 33 of file linearsystem.hh.

Referenced by Kaskade::DirectLinearSolver< Scalar, SparseInt >::solve(), and Kaskade::Bridge::DirectInnerSolver< DirectSolver >::solveAdjAndNormal().

◆ getMatrixBlocks()

virtual void Kaskade::SparseLinearSystem::getMatrixBlocks	(	MatrixAsTriplet< double > &	mat,
		int	rbegin,
		int	rend,
		int	colbegin,
		int	colend
	)		const

pure virtual

Return matrix blocks of the linear system in triplet format.

Implemented in Kaskade::SimpleSparseLinearSystem.

Referenced by getMatrix(), Kaskade::EnergyScalarProduct< X >::setOrigin(), and Kaskade::Bridge::DirectInnerSolver< DirectSolver >::solveAdjAndNormal().

◆ getRHS()

virtual void Kaskade::SparseLinearSystem::getRHS ( std::vector< double > & rhs ) const

inlinevirtual

Return the right hand side of the linear system.

Definition at line 36 of file linearsystem.hh.

Referenced by Kaskade::DirectLinearSolver< Scalar, SparseInt >::resolve().

◆ getRHSBlocks()

virtual void Kaskade::SparseLinearSystem::getRHSBlocks	(	std::vector< double > &	rhs,
		int	rbegin,
		int	rend
	)		const

pure virtual

Return components of the right hand side of the linear system.

Implemented in Kaskade::SimpleSparseLinearSystem.

Referenced by Kaskade::DirectBlockSchurSolver< Factorization, VariableSet >::computeCorrectionAndAdjointCorrection(), Kaskade::DirectBlockSchurSolver< Factorization, VariableSet >::computeSimplifiedCorrection(), getRHS(), Kaskade::Bridge::DirectInnerSolver< DirectSolver >::resolveNormal(), and Kaskade::Bridge::DirectInnerSolver< DirectSolver >::solveAdjAndNormal().

◆ getValue()

virtual double Kaskade::SparseLinearSystem::getValue ( ) const

pure virtual

value of function

Implemented in Kaskade::Bridge::KaskadeLinearization< Functional >, and Kaskade::SimpleSparseLinearSystem.

◆ nColBlocks()

virtual int Kaskade::SparseLinearSystem::nColBlocks ( ) const

pure virtual

number of column blocks

Implemented in Kaskade::Bridge::KaskadeLinearization< Functional >, and Kaskade::SimpleSparseLinearSystem.

Referenced by getMatrix(), size(), and Kaskade::Bridge::DirectInnerSolver< DirectSolver >::solveAdjAndNormal().

◆ nRowBlocks()

virtual int Kaskade::SparseLinearSystem::nRowBlocks ( ) const

pure virtual

number of row blocks

Implemented in Kaskade::Bridge::KaskadeLinearization< Functional >, and Kaskade::SimpleSparseLinearSystem.

Referenced by getMatrix(), getRHS(), Kaskade::Bridge::DirectInnerSolver< DirectSolver >::resolveNormal(), and Kaskade::Bridge::DirectInnerSolver< DirectSolver >::solveAdjAndNormal().

◆ rows()

virtual int Kaskade::SparseLinearSystem::rows	(	int	rbegin,
		int	rend
	)		const

pure virtual

Implemented in Kaskade::Bridge::KaskadeLinearization< Functional >, and Kaskade::SimpleSparseLinearSystem.

Referenced by Kaskade::Bridge::DirectInnerSolver< DirectSolver >::resolveNormal().

◆ size()

virtual int Kaskade::SparseLinearSystem::size ( ) const

inlinevirtual

Return the number of variables of the linear system.

Definition at line 39 of file linearsystem.hh.

Referenced by Kaskade::Bridge::DirectInnerSolver< DirectSolver >::solveAdjAndNormal().

The documentation for this class was generated from the following file:

linearsystem.hh