Ginkgo  Generated from pipelines/164546034 branch based on develop. Ginkgo version 1.2.0
A numerical linear algebra library targeting many-core architectures
Public Types | Public Member Functions | Friends | List of all members
gko::matrix::SparsityCsr< ValueType, IndexType > Class Template Reference

SparsityCsr is a matrix format which stores only the sparsity pattern of a sparse matrix by compressing each row of the matrix (compressed sparse row format). More...

#include <ginkgo/core/matrix/sparsity_csr.hpp>

Collaboration diagram for gko::matrix::SparsityCsr< ValueType, IndexType >:
[legend]

Public Types

using value_type = ValueType
 
using index_type = IndexType
 
using transposed_type = SparsityCsr< IndexType, ValueType >
 
using mat_data = matrix_data< ValueType, IndexType >
 
- Public Types inherited from gko::EnablePolymorphicAssignment< SparsityCsr< ValueType, IndexType > >
using result_type = SparsityCsr< ValueType, IndexType >
 
- Public Types inherited from gko::ConvertibleTo< SparsityCsr< ValueType, IndexType > >
using result_type = SparsityCsr< ValueType, IndexType >
 

Public Member Functions

void read (const mat_data &data) override
 Reads a matrix from a matrix_data structure. More...
 
void write (mat_data &data) const override
 Writes a matrix to a matrix_data structure. More...
 
std::unique_ptr< LinOptranspose () const override
 Returns a LinOp representing the transpose of the Transposable object. More...
 
std::unique_ptr< LinOpconj_transpose () const override
 Returns a LinOp representing the conjugate transpose of the Transposable object. More...
 
std::unique_ptr< SparsityCsrto_adjacency_matrix () const
 Transforms the sparsity matrix to an adjacency matrix. More...
 
void sort_by_column_index ()
 Sorts each row by column index.
 
bool is_sorted_by_column_index () const
 
index_type * get_col_idxs () noexcept
 Returns the column indices of the matrix. More...
 
const index_type * get_const_col_idxs () const noexcept
 Returns the column indices of the matrix. More...
 
index_type * get_row_ptrs () noexcept
 Returns the row pointers of the matrix. More...
 
const index_type * get_const_row_ptrs () const noexcept
 Returns the row pointers of the matrix. More...
 
value_type * get_value () noexcept
 Returns the value stored in the matrix. More...
 
const value_type * get_const_value () const noexcept
 Returns the value stored in the matrix. More...
 
size_type get_num_nonzeros () const noexcept
 Returns the number of elements explicitly stored in the matrix. More...
 
- Public Member Functions inherited from gko::EnableLinOp< SparsityCsr< ValueType, IndexType > >
const SparsityCsr< ValueType, IndexType > * apply (const LinOp *b, LinOp *x) const
 
SparsityCsr< ValueType, IndexType > * apply (const LinOp *b, LinOp *x)
 
const SparsityCsr< ValueType, IndexType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x) const
 
SparsityCsr< ValueType, IndexType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< SparsityCsr< ValueType, IndexType >, LinOp >
std::unique_ptr< SparsityCsr< ValueType, IndexType > > create_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< SparsityCsr< ValueType, IndexType > > create_default () const
 
std::unique_ptr< SparsityCsr< ValueType, IndexType > > clone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< SparsityCsr< ValueType, IndexType > > clone () const
 
SparsityCsr< ValueType, IndexType > * copy_from (const PolymorphicObject *other)
 
SparsityCsr< ValueType, IndexType > * copy_from (std::unique_ptr< PolymorphicObject > other)
 
SparsityCsr< ValueType, IndexType > * clear ()
 
- Public Member Functions inherited from gko::LinOp
LinOpapply (const LinOp *b, LinOp *x)
 Applies a linear operator to a vector (or a sequence of vectors). More...
 
const LinOpapply (const LinOp *b, LinOp *x) const
 Applies a linear operator to a vector (or a sequence of vectors). More...
 
LinOpapply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
 Performs the operation x = alpha * op(b) + beta * x. More...
 
const LinOpapply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x) const
 Performs the operation x = alpha * op(b) + beta * x. More...
 
const dim< 2 > & get_size () const noexcept
 Returns the size of the operator. More...
 
virtual bool apply_uses_initial_guess () const
 Returns true if the linear operator uses the data given in x as an initial guess. More...
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< LinOp >
std::unique_ptr< LinOpcreate_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LinOpcreate_default () const
 
std::unique_ptr< LinOpclone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LinOpclone () const
 
LinOpcopy_from (const PolymorphicObject *other)
 
LinOpcopy_from (std::unique_ptr< PolymorphicObject > other)
 
LinOpclear ()
 
- Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObjectoperator= (const PolymorphicObject &)
 
std::unique_ptr< PolymorphicObjectcreate_default (std::shared_ptr< const Executor > exec) const
 Creates a new "default" object of the same dynamic type as this object. More...
 
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object. More...
 
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object. More...
 
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object. More...
 
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object. More...
 
PolymorphicObjectcopy_from (std::unique_ptr< PolymorphicObject > other)
 Moves another object into this object. More...
 
PolymorphicObjectclear ()
 Transforms the object into its default state. More...
 
std::shared_ptr< const Executorget_executor () const noexcept
 Returns the Executor of the object. More...
 
- Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void add_logger (std::shared_ptr< const Logger > logger) override
 Adds a new logger to the list of subscribed loggers. More...
 
void remove_logger (const Logger *logger) override
 Removes a logger from the list of subscribed loggers. More...
 
- Public Member Functions inherited from gko::EnablePolymorphicAssignment< SparsityCsr< ValueType, IndexType > >
void convert_to (result_type *result) const override
 Converts the implementer to an object of type result_type. More...
 
void move_to (result_type *result) override
 Converts the implementer to an object of type result_type by moving data from this object. More...
 

Friends

class EnableCreateMethod< SparsityCsr >
 
class EnablePolymorphicObject< SparsityCsr, LinOp >
 
class Csr< ValueType, IndexType >
 

Additional Inherited Members

- Static Public Member Functions inherited from gko::EnableCreateMethod< SparsityCsr< ValueType, IndexType > >
static std::unique_ptr< SparsityCsr< ValueType, IndexType > > create (Args &&... args)
 

Detailed Description

template<typename ValueType = default_precision, typename IndexType = int32>
class gko::matrix::SparsityCsr< ValueType, IndexType >

SparsityCsr is a matrix format which stores only the sparsity pattern of a sparse matrix by compressing each row of the matrix (compressed sparse row format).

The values of the nonzero elements are stored as a value array of length 1. All the values in the matrix are equal to this value. By default, this value is set to 1.0. A row pointer array also stores the linearized starting index of each row. An additional column index array is used to identify the column where a nonzero is present.

Template Parameters
ValueTypeprecision of vectors in apply
IndexTypeprecision of matrix indexes

Member Function Documentation

◆ conj_transpose()

template<typename ValueType = default_precision, typename IndexType = int32>
std::unique_ptr<LinOp> gko::matrix::SparsityCsr< ValueType, IndexType >::conj_transpose ( ) const
overridevirtual

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

Returns
a pointer to the new conjugate transposed object

Implements gko::Transposable.

◆ get_col_idxs()

template<typename ValueType = default_precision, typename IndexType = int32>
index_type* gko::matrix::SparsityCsr< ValueType, IndexType >::get_col_idxs ( )
inlinenoexcept

Returns the column indices of the matrix.

Returns
the column indices of the matrix.

References gko::Array< ValueType >::get_data().

◆ get_const_col_idxs()

template<typename ValueType = default_precision, typename IndexType = int32>
const index_type* gko::matrix::SparsityCsr< ValueType, IndexType >::get_const_col_idxs ( ) const
inlinenoexcept

Returns the column indices of the matrix.

Returns
the column indices of the matrix.
Note
This is the constant version of the function, which can be significantly more memory efficient than the non-constant version, so always prefer this version.

References gko::Array< ValueType >::get_const_data().

◆ get_const_row_ptrs()

template<typename ValueType = default_precision, typename IndexType = int32>
const index_type* gko::matrix::SparsityCsr< ValueType, IndexType >::get_const_row_ptrs ( ) const
inlinenoexcept

Returns the row pointers of the matrix.

Returns
the row pointers of the matrix.
Note
This is the constant version of the function, which can be significantly more memory efficient than the non-constant version, so always prefer this version.

References gko::Array< ValueType >::get_const_data().

◆ get_const_value()

template<typename ValueType = default_precision, typename IndexType = int32>
const value_type* gko::matrix::SparsityCsr< ValueType, IndexType >::get_const_value ( ) const
inlinenoexcept

Returns the value stored in the matrix.

Returns
the value of the matrix.
Note
This is the constant version of the function, which can be significantly more memory efficient than the non-constant version, so always prefer this version.

References gko::Array< ValueType >::get_const_data().

◆ get_num_nonzeros()

template<typename ValueType = default_precision, typename IndexType = int32>
size_type gko::matrix::SparsityCsr< ValueType, IndexType >::get_num_nonzeros ( ) const
inlinenoexcept

Returns the number of elements explicitly stored in the matrix.

Returns
the number of elements explicitly stored in the matrix

References gko::Array< ValueType >::get_num_elems().

◆ get_row_ptrs()

template<typename ValueType = default_precision, typename IndexType = int32>
index_type* gko::matrix::SparsityCsr< ValueType, IndexType >::get_row_ptrs ( )
inlinenoexcept

Returns the row pointers of the matrix.

Returns
the row pointers of the matrix.

References gko::Array< ValueType >::get_data().

◆ get_value()

template<typename ValueType = default_precision, typename IndexType = int32>
value_type* gko::matrix::SparsityCsr< ValueType, IndexType >::get_value ( )
inlinenoexcept

Returns the value stored in the matrix.

Returns
the value of the matrix.

References gko::Array< ValueType >::get_data().

◆ read()

template<typename ValueType = default_precision, typename IndexType = int32>
void gko::matrix::SparsityCsr< ValueType, IndexType >::read ( const mat_data data)
overridevirtual

Reads a matrix from a matrix_data structure.

Parameters
datathe matrix_data structure

Implements gko::ReadableFromMatrixData< ValueType, IndexType >.

◆ to_adjacency_matrix()

template<typename ValueType = default_precision, typename IndexType = int32>
std::unique_ptr<SparsityCsr> gko::matrix::SparsityCsr< ValueType, IndexType >::to_adjacency_matrix ( ) const

Transforms the sparsity matrix to an adjacency matrix.

As the adjacency matrix has to be square, the input SparsityCsr matrix for this function to work has to be square.

Note
The adjacency matrix in this case is the sparsity pattern but with the diagonal ones removed. This is mainly used for the reordering/partitioning as taken in by graph libraries such as METIS.

◆ transpose()

template<typename ValueType = default_precision, typename IndexType = int32>
std::unique_ptr<LinOp> gko::matrix::SparsityCsr< ValueType, IndexType >::transpose ( ) const
overridevirtual

Returns a LinOp representing the transpose of the Transposable object.

Returns
a pointer to the new transposed object

Implements gko::Transposable.

◆ write()

template<typename ValueType = default_precision, typename IndexType = int32>
void gko::matrix::SparsityCsr< ValueType, IndexType >::write ( mat_data data) const
overridevirtual

Writes a matrix to a matrix_data structure.

Parameters
datathe matrix_data structure

Implements gko::WritableToMatrixData< ValueType, IndexType >.


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