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::Coo< ValueType, IndexType > Class Template Reference

COO stores a matrix in the coordinate matrix format. More...

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

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

Public Types

using value_type = ValueType
 
using index_type = IndexType
 
using mat_data = matrix_data< ValueType, IndexType >
 
- Public Types inherited from gko::EnablePolymorphicAssignment< Coo< ValueType, IndexType > >
using result_type = Coo< ValueType, IndexType >
 
- Public Types inherited from gko::ConvertibleTo< Coo< ValueType, IndexType > >
using result_type = Coo< ValueType, IndexType >
 
- Public Types inherited from gko::ConvertibleTo< Coo< next_precision< ValueType >, IndexType > >
using result_type = Coo< next_precision< ValueType >, IndexType >
 
- Public Types inherited from gko::ConvertibleTo< Csr< ValueType, IndexType > >
using result_type = Csr< ValueType, IndexType >
 
- Public Types inherited from gko::ConvertibleTo< Dense< ValueType > >
using result_type = Dense< ValueType >
 

Public Member Functions

void convert_to (Coo< next_precision< ValueType >, IndexType > *result) const override
 
void move_to (Coo< next_precision< ValueType >, IndexType > *result) override
 
void convert_to (Csr< ValueType, IndexType > *other) const override
 
void move_to (Csr< ValueType, IndexType > *other) override
 
void convert_to (Dense< ValueType > *other) const override
 
void move_to (Dense< ValueType > *other) override
 
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...
 
value_type * get_values () noexcept
 Returns the values of the matrix. More...
 
const value_type * get_const_values () const noexcept
 Returns the values of the matrix. More...
 
index_type * get_col_idxs () noexcept
 Returns the column indexes of the matrix. More...
 
const index_type * get_const_col_idxs () const noexcept
 Returns the column indexes of the matrix. More...
 
index_type * get_row_idxs () noexcept
 Returns the row indexes of the matrix. More...
 
const index_type * get_const_row_idxs () const noexcept
 
size_type get_num_stored_elements () const noexcept
 Returns the number of elements explicitly stored in the matrix. More...
 
LinOpapply2 (const LinOp *b, LinOp *x)
 Applies Coo matrix axpy to a vector (or a sequence of vectors). More...
 
const LinOpapply2 (const LinOp *b, LinOp *x) const
 
LinOpapply2 (const LinOp *alpha, const LinOp *b, LinOp *x)
 Performs the operation x = alpha * Coo * b + x. More...
 
const LinOpapply2 (const LinOp *alpha, const LinOp *b, LinOp *x) const
 Performs the operation x = alpha * Coo * b + x. More...
 
- Public Member Functions inherited from gko::EnableLinOp< Coo< ValueType, IndexType > >
const Coo< ValueType, IndexType > * apply (const LinOp *b, LinOp *x) const
 
Coo< ValueType, IndexType > * apply (const LinOp *b, LinOp *x)
 
const Coo< ValueType, IndexType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x) const
 
Coo< ValueType, IndexType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Coo< ValueType, IndexType >, LinOp >
std::unique_ptr< Coo< ValueType, IndexType > > create_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Coo< ValueType, IndexType > > create_default () const
 
std::unique_ptr< Coo< ValueType, IndexType > > clone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Coo< ValueType, IndexType > > clone () const
 
Coo< ValueType, IndexType > * copy_from (const PolymorphicObject *other)
 
Coo< ValueType, IndexType > * copy_from (std::unique_ptr< PolymorphicObject > other)
 
Coo< 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< Coo< 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...
 
- Public Member Functions inherited from gko::ConvertibleTo< Coo< next_precision< ValueType >, IndexType > >
virtual void convert_to (result_type *result) const=0
 Converts the implementer to an object of type result_type. More...
 
virtual void move_to (result_type *result)=0
 Converts the implementer to an object of type result_type by moving data from this object. More...
 
- Public Member Functions inherited from gko::ConvertibleTo< Csr< ValueType, IndexType > >
virtual void convert_to (result_type *result) const=0
 Converts the implementer to an object of type result_type. More...
 
virtual void move_to (result_type *result)=0
 Converts the implementer to an object of type result_type by moving data from this object. More...
 
- Public Member Functions inherited from gko::ConvertibleTo< Dense< ValueType > >
virtual void convert_to (result_type *result) const=0
 Converts the implementer to an object of type result_type. More...
 
virtual void move_to (result_type *result)=0
 Converts the implementer to an object of type result_type by moving data from this object. More...
 

Friends

class EnableCreateMethod< Coo >
 
class EnablePolymorphicObject< Coo, LinOp >
 
class Csr< ValueType, IndexType >
 
class Dense< ValueType >
 
class CooBuilder< ValueType, IndexType >
 
class Coo< next_precision< ValueType >, IndexType >
 

Additional Inherited Members

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

Detailed Description

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

COO stores a matrix in the coordinate matrix format.

The nonzero elements are stored in an array row-wise (but not neccessarily sorted by column index within a row). Two extra arrays contain the row and column indexes of each nonzero element of the matrix.

Template Parameters
ValueTypeprecision of matrix elements
IndexTypeprecision of matrix indexes

Member Function Documentation

◆ apply2() [1/4]

template<typename ValueType = default_precision, typename IndexType = int32>
LinOp* gko::matrix::Coo< ValueType, IndexType >::apply2 ( const LinOp alpha,
const LinOp b,
LinOp x 
)
inline

Performs the operation x = alpha * Coo * b + x.

Parameters
alphascaling of the result of Coo * b
bvector(s) on which the operator is applied
xoutput vector(s)
Returns
this

References gko::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

◆ apply2() [2/4]

template<typename ValueType = default_precision, typename IndexType = int32>
const LinOp* gko::matrix::Coo< ValueType, IndexType >::apply2 ( const LinOp alpha,
const LinOp b,
LinOp x 
) const
inline

Performs the operation x = alpha * Coo * b + x.

Parameters
alphascaling of the result of Coo * b
bvector(s) on which the operator is applied
xoutput vector(s)
Returns
this

References gko::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

◆ apply2() [3/4]

template<typename ValueType = default_precision, typename IndexType = int32>
LinOp* gko::matrix::Coo< ValueType, IndexType >::apply2 ( const LinOp b,
LinOp x 
)
inline

Applies Coo matrix axpy to a vector (or a sequence of vectors).

Performs the operation x = Coo * b + x

Parameters
bthe input vector(s) on which the operator is applied
xthe output vector(s) where the result is stored
Returns
this

References gko::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

◆ apply2() [4/4]

template<typename ValueType = default_precision, typename IndexType = int32>
const LinOp* gko::matrix::Coo< ValueType, IndexType >::apply2 ( const LinOp b,
LinOp x 
) const
inline

◆ get_col_idxs()

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

Returns the column indexes of the matrix.

Returns
the column indexes 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::Coo< ValueType, IndexType >::get_const_col_idxs ( ) const
inlinenoexcept

Returns the column indexes of the matrix.

Returns
the column indexes 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_idxs()

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

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_values()

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

Returns the values of the matrix.

Returns
the values 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_stored_elements()

template<typename ValueType = default_precision, typename IndexType = int32>
size_type gko::matrix::Coo< ValueType, IndexType >::get_num_stored_elements ( ) 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_idxs()

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

Returns the row indexes of the matrix.

Returns
the row indexes of the matrix.

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

◆ get_values()

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

Returns the values of the matrix.

Returns
the values of the matrix.

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

◆ read()

template<typename ValueType = default_precision, typename IndexType = int32>
void gko::matrix::Coo< 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 >.

◆ write()

template<typename ValueType = default_precision, typename IndexType = int32>
void gko::matrix::Coo< 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 file: