Blaze  3.6
Classes | Public Types | Public Member Functions | Static Public Attributes | Private Types | Private Attributes | Static Private Attributes | List of all members
blaze::SMatScalarDivExpr< MT, ST, SO > Class Template Reference

Expression object for sparse matrix-scalar divisions.The SMatScalarMult class represents the compile time expression for divisions between a sparse matrix and a scalar value. More...

#include <SMatScalarDivExpr.h>

Inherits blaze::MatScalarDivExpr< SparseMatrix< SMatScalarDivExpr< MT, ST, SO >, SO > >, and blaze::Computation.

Classes

class  ConstIterator
 Iterator over the elements of the sparse matrix/scalar division expression. More...
 

Public Types

using This = SMatScalarDivExpr< MT, ST, SO >
 Type of this SMatScalarDivExpr instance.
 
using BaseType = SparseMatrix< This, SO >
 Base type of this SMatScalarDivExpr instance.
 
using ResultType = MultTrait_t< RT, ST >
 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 = If_t< useAssign, const ResultType, const SMatScalarDivExpr & >
 Data type for composite expression templates.
 
using LeftOperand = If_t< IsExpression_v< MT >, const MT, const MT & >
 Composite data type of the sparse matrix expression.
 
using RightOperand = ST
 Composite type of the right-hand side scalar value.
 
using MatrixType = SMatScalarDivExpr< MT, ST, SO >
 Type of the matrix.
 

Public Member Functions

 SMatScalarDivExpr (const MT &matrix, ST scalar) noexcept
 Constructor for the SMatScalarDivExpr 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...
 
ConstIterator begin (size_t i) const
 Returns an iterator to the first non-zero element of row i. More...
 
ConstIterator end (size_t i) const
 Returns an iterator just past the last non-zero element of row i. 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...
 
ConstIterator find (size_t i, size_t j) const
 Searches for a specific matrix element. More...
 
ConstIterator lowerBound (size_t i, size_t j) const
 Returns an iterator to the first index not less then the given index. More...
 
ConstIterator upperBound (size_t i, size_t j) const
 Returns an iterator to the first index greater then the given index. More...
 
LeftOperand leftOperand () const noexcept
 Returns the left-hand side sparse matrix operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side scalar 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 RT = ResultType_t< MT >
 Result type of the sparse matrix expression.
 
using RN = ReturnType_t< MT >
 Return type of the sparse matrix expression.
 
using CT = CompositeType_t< MT >
 Composite type of the sparse matrix expression.
 
using ExprReturnType = decltype(std::declval< RN >()/std::declval< ST >())
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand matrix_
 Left-hand side sparse matrix of the division expression.
 
RightOperand scalar_
 Right-hand side scalar of the division expression.
 

Static Private Attributes

static constexpr bool returnExpr = !IsTemporary_v<RN>
 Compilation switch for the selection of the subscript operator return type. More...
 
static constexpr bool useAssign = RequiresEvaluation_v<MT>
 Compilation switch for the serial evaluation strategy of the division expression. More...
 

Detailed Description

template<typename MT, typename ST, bool SO>
class blaze::SMatScalarDivExpr< MT, ST, SO >

Expression object for sparse matrix-scalar divisions.

The SMatScalarMult class represents the compile time expression for divisions between a sparse matrix and a scalar value.

Constructor & Destructor Documentation

◆ SMatScalarDivExpr()

template<typename MT , typename ST , bool SO>
blaze::SMatScalarDivExpr< MT, ST, SO >::SMatScalarDivExpr ( const MT &  matrix,
ST  scalar 
)
inlineexplicitnoexcept

Constructor for the SMatScalarDivExpr class.

Parameters
matrixThe left-hand side sparse matrix of the division expression.
scalarThe right-hand side scalar of the division expression.

Member Function Documentation

◆ at()

template<typename MT , typename ST , bool SO>
ReturnType blaze::SMatScalarDivExpr< MT, ST, SO >::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.

◆ begin()

template<typename MT , typename ST , bool SO>
ConstIterator blaze::SMatScalarDivExpr< MT, ST, SO >::begin ( size_t  i) const
inline

Returns an iterator to the first non-zero element of row i.

Parameters
iThe row index.
Returns
Iterator to the first non-zero element of row i.

◆ canAlias()

template<typename MT , typename ST , bool SO>
template<typename T >
bool blaze::SMatScalarDivExpr< MT, ST, SO >::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 MT , typename ST , bool SO>
size_t blaze::SMatScalarDivExpr< MT, ST, SO >::columns ( ) const
inlinenoexcept

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.

◆ end()

template<typename MT , typename ST , bool SO>
ConstIterator blaze::SMatScalarDivExpr< MT, ST, SO >::end ( size_t  i) const
inline

Returns an iterator just past the last non-zero element of row i.

Parameters
iThe row index.
Returns
Iterator just past the last non-zero element of row i.

◆ find()

template<typename MT , typename ST , bool SO>
ConstIterator blaze::SMatScalarDivExpr< MT, ST, SO >::find ( size_t  i,
size_t  j 
) const
inline

Searches for a specific matrix element.

Parameters
iThe row index of the search element.
jThe column index of the search element.
Returns
Iterator to the element in case the index is found, end() iterator otherwise.

◆ isAliased()

template<typename MT , typename ST , bool SO>
template<typename T >
bool blaze::SMatScalarDivExpr< MT, ST, SO >::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 MT , typename ST , bool SO>
LeftOperand blaze::SMatScalarDivExpr< MT, ST, SO >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side sparse matrix operand.

Returns
The left-hand side sparse matrix operand.

◆ lowerBound()

template<typename MT , typename ST , bool SO>
ConstIterator blaze::SMatScalarDivExpr< MT, ST, SO >::lowerBound ( size_t  i,
size_t  j 
) const
inline

Returns an iterator to the first index not less then the given index.

Parameters
iThe row index of the search element.
jThe column index of the search element.
Returns
Iterator to the first index not less then the given index, end() iterator otherwise.

◆ nonZeros() [1/2]

template<typename MT , typename ST , bool SO>
size_t blaze::SMatScalarDivExpr< MT, ST, SO >::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 MT , typename ST , bool SO>
size_t blaze::SMatScalarDivExpr< MT, ST, SO >::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 MT , typename ST , bool SO>
ReturnType blaze::SMatScalarDivExpr< MT, ST, SO >::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< SMatScalarDivExpr< MT, ST, SO > , 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< SMatScalarDivExpr< MT, ST, SO > , SO >::operator~ ( ) const
inlinenoexceptinherited

Conversion operator for constant matrices.

Returns
Constant reference of the actual type of the matrix.

◆ rightOperand()

template<typename MT , typename ST , bool SO>
RightOperand blaze::SMatScalarDivExpr< MT, ST, SO >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side scalar operand.

Returns
The right-hand side scalar operand.

◆ rows()

template<typename MT , typename ST , bool SO>
size_t blaze::SMatScalarDivExpr< MT, ST, SO >::rows ( ) const
inlinenoexcept

Returns the current number of rows of the matrix.

Returns
The number of rows of the matrix.

◆ upperBound()

template<typename MT , typename ST , bool SO>
ConstIterator blaze::SMatScalarDivExpr< MT, ST, SO >::upperBound ( size_t  i,
size_t  j 
) const
inline

Returns an iterator to the first index greater then the given index.

Parameters
iThe row index of the search element.
jThe column index of the search element.
Returns
Iterator to the first index greater then the given index, end() iterator otherwise.

Member Data Documentation

◆ returnExpr

template<typename MT , typename ST , bool SO>
constexpr bool blaze::SMatScalarDivExpr< MT, ST, SO >::returnExpr = !IsTemporary_v<RN>
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 the 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.

◆ useAssign

template<typename MT , typename ST , bool SO>
constexpr bool blaze::SMatScalarDivExpr< MT, ST, SO >::useAssign = RequiresEvaluation_v<MT>
staticprivate

Compilation switch for the serial evaluation strategy of the division expression.

The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the division expression. In case the given sparse matrix expression of type MT requires an intermediate evaluation, useAssign will be set to 1 and the division expression will be evaluated via the assign function family. Otherwise Otherwise useAssign will be set to 0 and the expression will be evaluated via the function call operator.


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