gko::Transposable Class Reference

Linear operators which support transposition should implement the Transposable interface. More...

#include <ginkgo/core/base/lin_op.hpp>

Inheritance diagram for gko::Transposable:

Public Member Functions
virtual std::unique_ptr< LinOp >	transpose () const =0
	Returns a LinOp representing the transpose of the Transposable object. More...
virtual std::unique_ptr< LinOp >	conj_transpose () const =0
	Returns a LinOp representing the conjugate transpose of the Transposable object. More...

Detailed Description

Linear operators which support transposition should implement the Transposable interface.

It provides two functionalities, the normal transpose and the conjugate transpose.

The normal transpose returns the transpose of the linear operator without changing any of its elements representing the operation, .

The conjugate transpose returns the conjugate of each of the elements and additionally transposes the linear operator representing the operation, .

Example: Transposing a Csr matrix:

 {c++}
//Transposing an object of LinOp type.
//The object you want to transpose.
auto op = matrix::Csr::create(exec);
//Transpose the object by first converting it to a transposable type.
auto trans = op->transpose();

Member Function Documentation

conj_transpose()

virtual std::unique_ptr<LinOp> gko::Transposable::conj_transpose ( ) const

pure virtual

Returns a LinOp representing the conjugate transpose of the Transposable object.

Returns

a pointer to the new conjugate transposed object

Implemented in gko::matrix::Csr< ValueType, IndexType >, gko::matrix::Dense< ValueType >, gko::matrix::Dense< value_type >, gko::preconditioner::Ilu< LSolverType, USolverType, ReverseApply, IndexType >, gko::preconditioner::Jacobi< ValueType, IndexType >, gko::matrix::Fft3, gko::preconditioner::Ic< LSolverType, IndexType >, gko::solver::UpperTrs< ValueType, IndexType >, gko::preconditioner::Isai< IsaiType, ValueType, IndexType >, gko::matrix::Fbcsr< ValueType, IndexType >, gko::matrix::Fft2, gko::solver::Ir< ValueType >, gko::matrix::SparsityCsr< ValueType, IndexType >, gko::solver::LowerTrs< ValueType, IndexType >, gko::matrix::Diagonal< ValueType >, gko::solver::Idr< ValueType >, gko::solver::Bicg< ValueType >, gko::solver::Bicgstab< ValueType >, gko::solver::Fcg< ValueType >, gko::Combination< ValueType >, gko::matrix::Fft, gko::solver::Gmres< ValueType >, gko::Composition< ValueType >, gko::solver::Gcr< ValueType >, gko::solver::Cg< ValueType >, gko::solver::Cgs< ValueType >, gko::experimental::solver::Direct< ValueType, IndexType >, and gko::matrix::Identity< ValueType >.

transpose()

virtual std::unique_ptr<LinOp> gko::Transposable::transpose ( ) const

pure virtual

Returns a LinOp representing the transpose of the Transposable object.

Returns

a pointer to the new transposed object

Implemented in gko::matrix::Csr< ValueType, IndexType >, gko::matrix::Dense< ValueType >, gko::matrix::Dense< value_type >, gko::preconditioner::Ilu< LSolverType, USolverType, ReverseApply, IndexType >, gko::preconditioner::Jacobi< ValueType, IndexType >, gko::matrix::Fft3, gko::solver::UpperTrs< ValueType, IndexType >, gko::preconditioner::Ic< LSolverType, IndexType >, gko::preconditioner::Isai< IsaiType, ValueType, IndexType >, gko::matrix::Fbcsr< ValueType, IndexType >, gko::matrix::Fft2, gko::solver::Ir< ValueType >, gko::matrix::SparsityCsr< ValueType, IndexType >, gko::solver::LowerTrs< ValueType, IndexType >, gko::matrix::Diagonal< ValueType >, gko::solver::Idr< ValueType >, gko::solver::Bicg< ValueType >, gko::solver::Bicgstab< ValueType >, gko::solver::Fcg< ValueType >, gko::Combination< ValueType >, gko::matrix::Fft, gko::solver::Gmres< ValueType >, gko::Composition< ValueType >, gko::solver::Gcr< ValueType >, gko::solver::Cg< ValueType >, gko::solver::Cgs< ValueType >, gko::experimental::solver::Direct< ValueType, IndexType >, and gko::matrix::Identity< ValueType >.

---

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

• ginkgo/core/base/lin_op.hpp