spla
Public Member Functions | Static Public Member Functions | List of all members
spla::Matrix Class Referenceabstract

Generalized M x N dimensional matrix object. More...

#include <matrix.hpp>

Inheritance diagram for spla::Matrix:
Inheritance graph
[legend]
Collaboration diagram for spla::Matrix:
Collaboration graph
[legend]

Public Member Functions

 ~Matrix () override=default
 
virtual uint get_n_rows ()=0
 
virtual uint get_n_cols ()=0
 
virtual ref_ptr< Typeget_type ()=0
 
virtual Status set_format (FormatMatrix format)=0
 
virtual Status set_fill_value (const ref_ptr< Scalar > &value)=0
 
virtual Status set_reduce (ref_ptr< OpBinary > resolve_duplicates)=0
 
virtual Status set_int (uint row_id, uint col_id, std::int32_t value)=0
 
virtual Status set_uint (uint row_id, uint col_id, std::uint32_t value)=0
 
virtual Status set_float (uint row_id, uint col_id, float value)=0
 
virtual Status get_int (uint row_id, uint col_id, std::int32_t &value)=0
 
virtual Status get_uint (uint row_id, uint col_id, std::uint32_t &value)=0
 
virtual Status get_float (uint row_id, uint col_id, float &value)=0
 
virtual Status build (const ref_ptr< MemView > &keys1, const ref_ptr< MemView > &keys2, const ref_ptr< MemView > &values)=0
 
virtual Status read (ref_ptr< MemView > &keys1, ref_ptr< MemView > &keys2, ref_ptr< MemView > &values)=0
 
virtual Status clear ()=0
 
- Public Member Functions inherited from spla::Object
 ~Object () override=default
 
virtual void set_label (std::string label)=0
 
virtual const std::string & get_label () const =0
 
- Public Member Functions inherited from spla::RefCnt
virtual ~RefCnt ()
 
bool is_unique () const
 
std::int32_t get_refs () const
 
std::int32_t add_ref () const
 
std::int32_t rel_ref () const
 

Static Public Member Functions

static ref_ptr< Matrixmake (uint n_rows, uint n_cols, const ref_ptr< Type > &type)
 Make new matrix instance with specified dim and values type. More...
 

Detailed Description

Generalized M x N dimensional matrix object.

Constructor & Destructor Documentation

◆ ~Matrix()

spla::Matrix::~Matrix ( )
overridedefault

Member Function Documentation

◆ build()

virtual Status spla::Matrix::build ( const ref_ptr< MemView > &  keys1,
const ref_ptr< MemView > &  keys2,
const ref_ptr< MemView > &  values 
)
pure virtual

Implemented in spla::TMatrix< T >.

◆ clear()

virtual Status spla::Matrix::clear ( )
pure virtual

Implemented in spla::TMatrix< T >.

◆ get_float()

virtual Status spla::Matrix::get_float ( uint  row_id,
uint  col_id,
float &  value 
)
pure virtual

Implemented in spla::TMatrix< T >.

◆ get_int()

virtual Status spla::Matrix::get_int ( uint  row_id,
uint  col_id,
std::int32_t &  value 
)
pure virtual

◆ get_n_cols()

virtual uint spla::Matrix::get_n_cols ( )
pure virtual

Implemented in spla::TMatrix< T >.

◆ get_n_rows()

virtual uint spla::Matrix::get_n_rows ( )
pure virtual

Implemented in spla::TMatrix< T >.

◆ get_type()

virtual ref_ptr<Type> spla::Matrix::get_type ( )
pure virtual

Implemented in spla::TMatrix< T >.

◆ get_uint()

virtual Status spla::Matrix::get_uint ( uint  row_id,
uint  col_id,
std::uint32_t &  value 
)
pure virtual

◆ make()

ref_ptr< Matrix > spla::Matrix::make ( uint  n_rows,
uint  n_cols,
const ref_ptr< Type > &  type 
)
static

Make new matrix instance with specified dim and values type.

Parameters
n_rowsNumber of matrix rows; must be > 0;
n_colsNumber of matrix columns; must be > 0;
typeType of matrix elements
Returns
New matrix instance or null if failed to create

◆ read()

virtual Status spla::Matrix::read ( ref_ptr< MemView > &  keys1,
ref_ptr< MemView > &  keys2,
ref_ptr< MemView > &  values 
)
pure virtual

Implemented in spla::TMatrix< T >.

◆ set_fill_value()

virtual Status spla::Matrix::set_fill_value ( const ref_ptr< Scalar > &  value)
pure virtual

Implemented in spla::TMatrix< T >.

◆ set_float()

virtual Status spla::Matrix::set_float ( uint  row_id,
uint  col_id,
float  value 
)
pure virtual

Implemented in spla::TMatrix< T >.

◆ set_format()

virtual Status spla::Matrix::set_format ( FormatMatrix  format)
pure virtual

Implemented in spla::TMatrix< T >.

◆ set_int()

virtual Status spla::Matrix::set_int ( uint  row_id,
uint  col_id,
std::int32_t  value 
)
pure virtual

Implemented in spla::TMatrix< T >.

◆ set_reduce()

virtual Status spla::Matrix::set_reduce ( ref_ptr< OpBinary resolve_duplicates)
pure virtual

Implemented in spla::TMatrix< T >.

◆ set_uint()

virtual Status spla::Matrix::set_uint ( uint  row_id,
uint  col_id,
std::uint32_t  value 
)
pure virtual

Implemented in spla::TMatrix< T >.


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