Blaze  3.6
Public Types | Public Member Functions | Static Public Attributes | Private Types | Private Attributes | Static Private Attributes | List of all members
blaze::TSMatTSMatAddExpr< MT1, MT2 > Class Template Reference

Expression object for transpose sparse matrix-transpose sparse matrix additions.The TSMatTSMatAddExpr class represents the compile time expression for additions between two column-major sparse matrices. More...

#include <TSMatTSMatAddExpr.h>

Inherits blaze::MatMatAddExpr< SparseMatrix< TSMatTSMatAddExpr< MT1, MT2 >, true > >, and blaze::Computation.

Public Types

using This = TSMatTSMatAddExpr< MT1, MT2 >
 Type of this TSMatTSMatAddExpr instance.
 
using BaseType = SparseMatrix< This, true >
 Base type of this TSMatTSMatAddExpr instance.
 
using ResultType = AddTrait_t< RT1, RT2 >
 Result type for expression template evaluations.
 
using OppositeType = OppositeType_t< ResultType >
 Result type with opposite storage order for expression template evaluations.
 
using TransposeType = TransposeType_t< ResultType >
 Transpose type for expression template evaluations.
 
using ElementType = ElementType_t< ResultType >
 Resulting element type.
 
using ReturnType = const If_t< returnExpr, ExprReturnType, ElementType >
 Return type for expression template evaluations.
 
using CompositeType = const ResultType
 Data type for composite expression templates.
 
using LeftOperand = If_t< IsExpression_v< MT1 >, const MT1, const MT1 & >
 Composite type of the left-hand side sparse matrix expression.
 
using RightOperand = If_t< IsExpression_v< MT2 >, const MT2, const MT2 & >
 Composite type of the right-hand side sparse matrix expression.
 
using MatrixType = TSMatTSMatAddExpr< MT1, MT2 >
 Type of the matrix.
 

Public Member Functions

 TSMatTSMatAddExpr (const MT1 &lhs, const MT2 &rhs) noexcept
 Constructor for the TSMatTSMatAddExpr class. More...
 
ReturnType operator() (size_t i, size_t j) const
 2D-access to the matrix elements. More...
 
ReturnType at (size_t i, size_t j) const
 Checked access to the matrix elements. More...
 
size_t rows () const noexcept
 Returns the current number of rows of the matrix. More...
 
size_t columns () const noexcept
 Returns the current number of columns of the matrix. More...
 
size_t nonZeros () const
 Returns the number of non-zero elements in the sparse matrix. More...
 
size_t nonZeros (size_t i) const
 Returns the number of non-zero elements in the specified row. More...
 
LeftOperand leftOperand () const noexcept
 Returns the left-hand side transpose sparse matrix operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side transpose sparse matrix operand. More...
 
template<typename T >
bool canAlias (const T *alias) const noexcept
 Returns whether the expression can alias with the given address alias. More...
 
template<typename T >
bool isAliased (const T *alias) const noexcept
 Returns whether the expression is aliased with the given address alias. More...
 
BLAZE_ALWAYS_INLINE constexpr MatrixTypeoperator~ () noexcept
 Conversion operator for non-constant matrices. More...
 
BLAZE_ALWAYS_INLINE constexpr const MatrixTypeoperator~ () const noexcept
 Conversion operator for constant matrices. More...
 

Static Public Attributes

static constexpr bool smpAssignable = false
 Compilation switch for the expression template assignment strategy.
 
static constexpr bool storageOrder
 Storage order of the matrix.
 

Private Types

using RT1 = ResultType_t< MT1 >
 Result type of the left-hand side sparse matrix expression.
 
using RT2 = ResultType_t< MT2 >
 Result type of the right-hand side sparse matrix expression.
 
using RN1 = ReturnType_t< MT1 >
 Return type of the left-hand side sparse matrix expression.
 
using RN2 = ReturnType_t< MT2 >
 Return type of the right-hand side sparse matrix expression.
 
using CT1 = CompositeType_t< MT1 >
 Composite type of the left-hand side sparse matrix expression.
 
using CT2 = CompositeType_t< MT2 >
 Composite type of the right-hand side sparse matrix expression.
 
using ExprReturnType = decltype(std::declval< RN1 >()+std::declval< RN2 >())
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand lhs_
 Left-hand side sparse matrix of the addition expression.
 
RightOperand rhs_
 Right-hand side sparse matrix of the addition expression.
 

Static Private Attributes

static constexpr bool returnExpr = ( !IsTemporary_v<RN1> && !IsTemporary_v<RN2> )
 Compilation switch for the selection of the subscript operator return type. More...
 

Detailed Description

template<typename MT1, typename MT2>
class blaze::TSMatTSMatAddExpr< MT1, MT2 >

Expression object for transpose sparse matrix-transpose sparse matrix additions.

The TSMatTSMatAddExpr class represents the compile time expression for additions between two column-major sparse matrices.

Constructor & Destructor Documentation

◆ TSMatTSMatAddExpr()

template<typename MT1 , typename MT2 >
blaze::TSMatTSMatAddExpr< MT1, MT2 >::TSMatTSMatAddExpr ( const MT1 &  lhs,
const MT2 &  rhs 
)
inlineexplicitnoexcept

Constructor for the TSMatTSMatAddExpr class.

Parameters
lhsThe left-hand side sparse matrix operand of the addition expression.
rhsThe right-hand side sparse matrix operand of the addition expression.

Member Function Documentation

◆ at()

template<typename MT1 , typename MT2 >
ReturnType blaze::TSMatTSMatAddExpr< MT1, MT2 >::at ( size_t  i,
size_t  j 
) const
inline

Checked access to the matrix elements.

Parameters
iAccess index for the row. The index has to be in the range $[0..M-1]$.
jAccess index for the column. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.
Exceptions
std::out_of_rangeInvalid matrix access index.

◆ canAlias()

template<typename MT1 , typename MT2 >
template<typename T >
bool blaze::TSMatTSMatAddExpr< MT1, MT2 >::canAlias ( const T *  alias) const
inlinenoexcept

Returns whether the expression can alias with the given address alias.

Parameters
aliasThe alias to be checked.
Returns
true in case the expression can alias, false otherwise.

◆ columns()

template<typename MT1 , typename MT2 >
size_t blaze::TSMatTSMatAddExpr< MT1, MT2 >::columns ( ) const
inlinenoexcept

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.

◆ isAliased()

template<typename MT1 , typename MT2 >
template<typename T >
bool blaze::TSMatTSMatAddExpr< MT1, MT2 >::isAliased ( const T *  alias) const
inlinenoexcept

Returns whether the expression is aliased with the given address alias.

Parameters
aliasThe alias to be checked.
Returns
true in case an alias effect is detected, false otherwise.

◆ leftOperand()

template<typename MT1 , typename MT2 >
LeftOperand blaze::TSMatTSMatAddExpr< MT1, MT2 >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side transpose sparse matrix operand.

Returns
The left-hand side transpose sparse matrix operand.

◆ nonZeros() [1/2]

template<typename MT1 , typename MT2 >
size_t blaze::TSMatTSMatAddExpr< MT1, MT2 >::nonZeros ( ) const
inline

Returns the number of non-zero elements in the sparse matrix.

Returns
The number of non-zero elements in the sparse matrix.

◆ nonZeros() [2/2]

template<typename MT1 , typename MT2 >
size_t blaze::TSMatTSMatAddExpr< MT1, MT2 >::nonZeros ( size_t  i) const
inline

Returns the number of non-zero elements in the specified row.

Parameters
iThe index of the row.
Returns
The number of non-zero elements of row i.

◆ operator()()

template<typename MT1 , typename MT2 >
ReturnType blaze::TSMatTSMatAddExpr< MT1, MT2 >::operator() ( size_t  i,
size_t  j 
) const
inline

2D-access to the matrix elements.

Parameters
iAccess index for the row. The index has to be in the range $[0..M-1]$.
jAccess index for the column. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.

◆ operator~() [1/2]

BLAZE_ALWAYS_INLINE constexpr MatrixType& blaze::Matrix< TSMatTSMatAddExpr< MT1, MT2 > , SO >::operator~ ( )
inlinenoexceptinherited

Conversion operator for non-constant matrices.

Returns
Reference of the actual type of the matrix.

◆ operator~() [2/2]

BLAZE_ALWAYS_INLINE constexpr const MatrixType& blaze::Matrix< TSMatTSMatAddExpr< MT1, MT2 > , SO >::operator~ ( ) const
inlinenoexceptinherited

Conversion operator for constant matrices.

Returns
Constant reference of the actual type of the matrix.

◆ rightOperand()

template<typename MT1 , typename MT2 >
RightOperand blaze::TSMatTSMatAddExpr< MT1, MT2 >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side transpose sparse matrix operand.

Returns
The right-hand side transpose sparse matrix operand.

◆ rows()

template<typename MT1 , typename MT2 >
size_t blaze::TSMatTSMatAddExpr< MT1, MT2 >::rows ( ) const
inlinenoexcept

Returns the current number of rows of the matrix.

Returns
The number of rows of the matrix.

Member Data Documentation

◆ returnExpr

template<typename MT1 , typename MT2 >
constexpr bool blaze::TSMatTSMatAddExpr< MT1, MT2 >::returnExpr = ( !IsTemporary_v<RN1> && !IsTemporary_v<RN2> )
staticprivate

Compilation switch for the selection of the subscript operator return type.

The returnExpr compile time constant expression is a compilation switch for the selection of the ReturnType. If either matrix operand returns a temporary vector or matrix, returnExpr will be set to false and the subscript operator will return it's result by value. Otherwise returnExpr will be set to true and the subscript operator may return it's result as an expression.


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