35 #ifndef _BLAZE_MATH_EXPRESSIONS_SMATSCALARDIVEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_SMATSCALARDIVEXPR_H_
111 template<
typename MT
114 class SMatScalarDivExpr :
public SparseMatrix< SMatScalarDivExpr<MT,ST,SO>, SO >
115 ,
private MatScalarDivExpr
116 ,
private Computation
149 template<
typename MT2 >
152 enum :
bool { value = useAssign };
165 template<
typename MT2 >
166 struct UseSMPAssign {
167 enum :
bool { value = ( !MT2::smpAssignable || !MT::smpAssignable ) && useAssign };
323 enum :
bool { smpAssignable =
false };
360 inline ReturnType
at(
size_t i,
size_t j )
const {
398 inline size_t rows() const noexcept {
499 template<
typename T >
500 inline bool canAlias(
const T* alias )
const noexcept {
501 return matrix_.canAlias( alias );
511 template<
typename T >
512 inline bool isAliased(
const T* alias )
const noexcept {
513 return matrix_.isAliased( alias );
537 template<
typename MT2
547 assign( ~lhs, rhs.matrix_ );
548 (~lhs) /= rhs.scalar_;
567 template<
typename MT2
577 assign( ~lhs, rhs.matrix_ );
578 (~lhs) /= rhs.scalar_;
597 template<
typename MT2
599 friend inline EnableIf_< UseAssign<MT2> >
610 const ResultType tmp(
serial( rhs ) );
611 addAssign( ~lhs, tmp );
634 template<
typename MT2
636 friend inline EnableIf_< UseAssign<MT2> >
647 const ResultType tmp(
serial( rhs ) );
648 subAssign( ~lhs, tmp );
687 template<
typename MT2
689 friend inline EnableIf_< UseSMPAssign<MT2> >
700 const ResultType tmp( rhs );
724 template<
typename MT2
726 friend inline EnableIf_< UseSMPAssign<MT2> >
737 const ResultType tmp( rhs );
799 template<
typename T1
802 inline const EnableIf_< IsNumeric<T2>, DivExprTrait_<T1,T2> >
813 return ReturnType( ~mat, ScalarType(1)/ScalarType(scalar) );
843 template<
typename MT
847 inline const EnableIf_< And< IsNumeric<ST2>, Or< IsInvertible<ST1>, IsInvertible<ST2> > >
848 , MultExprTrait_< SMatScalarDivExpr<MT,ST1,SO>, ST2 > >
849 operator*(
const SMatScalarDivExpr<MT,ST1,SO>& mat, ST2 scalar )
853 return mat.leftOperand() * ( scalar / mat.rightOperand() );
872 template<
typename ST1
876 inline const EnableIf_< And< IsNumeric<ST1>, Or< IsInvertible<ST1>, IsInvertible<ST2> > >
877 , MultExprTrait_< ST1, SMatScalarDivExpr<MT,ST2,SO> > >
878 operator*( ST1 scalar,
const SMatScalarDivExpr<MT,ST2,SO>& mat )
882 return mat.leftOperand() * ( scalar / mat.rightOperand() );
901 template<
typename MT
905 inline const EnableIf_< IsNumeric<ST2>
906 , DivExprTrait_< MT, MultTrait_<ST1,ST2> > >
907 operator/(
const SMatScalarDivExpr<MT,ST1,SO>& mat, ST2 scalar )
913 typedef MultTrait_<ST1,ST2> MultType;
914 typedef DivExprTrait_<MT,MultType>
ReturnType;
915 typedef RightOperand_<ReturnType> ScalarType;
917 if( IsMultExpr<ReturnType>::value ) {
918 return ReturnType( mat.leftOperand(), ScalarType(1)/( mat.rightOperand() * scalar ) );
921 return ReturnType( mat.leftOperand(), mat.rightOperand() * scalar );
938 template<
typename MT,
typename ST,
bool SO >
955 template<
typename MT,
typename ST,
bool SO >
972 template<
typename MT,
typename ST,
bool SO >
990 template<
typename MT,
typename ST,
bool SO >
1008 template<
typename MT,
typename ST,
bool SO >
1026 template<
typename MT,
typename ST,
bool SO >
1044 template<
typename MT,
typename ST,
bool SO >
1062 template<
typename MT,
typename ST,
bool SO >
1080 template<
typename MT,
typename ST1,
typename ST2 >
1085 using ScalarType = DivTrait_<ST2,ST1>;
1090 using Type = If_< And< IsSparseMatrix<MT>, IsRowMajorMatrix<MT>
1091 , IsNumeric<ST1>, IsNumeric<ST2> >
1092 , If_< IsInvertible<ScalarType>
1093 , SMatScalarMultExprTrait_<MT,ScalarType>
1094 , SMatScalarMultExpr< SMatScalarDivExpr<MT,ST1,false>, ST2,
false > >
1112 template<
typename MT,
typename ST1,
typename ST2 >
1117 using ScalarType = DivTrait_<ST2,ST1>;
1122 using Type = If_< And< IsSparseMatrix<MT>, IsColumnMajorMatrix<MT>
1123 , IsNumeric<ST1>, IsNumeric<ST2> >
1124 , If_< IsInvertible<ScalarType>
1125 , SMatScalarMultExprTrait_<MT,ScalarType>
1126 , SMatScalarMultExpr< SMatScalarDivExpr<MT,ST1,true>, ST2,
true > >
1144 template<
typename MT,
typename ST,
bool SO,
bool AF >
1149 using Type = DivExprTrait_< SubmatrixExprTrait_<const MT,AF>, ST >;
1166 template<
typename MT,
typename ST,
bool SO >
1171 using Type = DivExprTrait_< RowExprTrait_<const MT>, ST >;
1188 template<
typename MT,
typename ST,
bool SO >
1193 using Type = DivExprTrait_< ColumnExprTrait_<const MT>, ST >;
IteratorType matrix_
Iterator over the elements of the left-hand side sparse matrix expression.
Definition: SMatScalarDivExpr.h:315
Pointer difference type of the Blaze library.
Header file for auxiliary alias declarations.
ConstIterator(IteratorType matrix, RightOperand scalar)
Constructor for the ConstIterator class.
Definition: SMatScalarDivExpr.h:223
Constraint on the data type.
ReturnType_< MT > RN
Return type of the sparse matrix expression.
Definition: SMatScalarDivExpr.h:121
#define BLAZE_USER_ASSERT(expr, msg)
Run time assertion macro for user checks.In case of an invalid run time expression, the program execution is terminated. The BLAZE_USER_ASSERT macro can be disabled by setting the BLAZE_USER_ASSERT flag to zero or by defining NDEBUG during the compilation.
Definition: Assert.h:117
Compile time check whether the given type is a temporary vector or matrix type.This type trait class ...
Definition: IsTemporary.h:70
Header file for the Rows type trait.
const DMatDMatMultExpr< T1, T2 > operator*(const DenseMatrix< T1, false > &lhs, const DenseMatrix< T2, false > &rhs)
Multiplication operator for the multiplication of two row-major dense matrices ( ).
Definition: DMatDMatMultExpr.h:7800
PointerType pointer
Pointer return type.
Definition: SMatScalarDivExpr.h:215
Header file for basic type definitions.
const IfTrue_< returnExpr, ExprReturnType, ElementType > ReturnType
Return type for expression template evaluations.
Definition: SMatScalarDivExpr.h:181
Compile time check whether the given type is a multiplication expression template.This type trait class tests whether or not the given type Type is a multiplication expression template (i.e. an expression representing an element-wise vector multiplication, a matrix/vector multiplication, a vector/matrix multiplication, or a matrix multiplication). In order to qualify as a valid multiplication expression template, the given type has to derive (publicly or privately) from the MultExpr base class. In case the given type is a valid multiplication expression template, the value member constant is set to true, the nested type definition Type is TrueType, and the class derives from TrueType. Otherwise value is set to false, Type is FalseType, and the class derives from FalseType.
Definition: IsMultExpr.h:73
ElementType_< ResultType > ElementType
Resulting element type.
Definition: SMatScalarDivExpr.h:178
RightOperand rightOperand() const noexcept
Returns the right-hand side scalar operand.
Definition: SMatScalarDivExpr.h:488
EnableIf_< IsDenseMatrix< MT1 > > smpSubAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the SMP subtraction assignment of a matrix to dense matrix.
Definition: DenseMatrix.h:160
Header file for the IsSparseMatrix type trait.
Header file for the serial shim.
#define BLAZE_CONSTRAINT_MUST_BE_MATRIX_WITH_STORAGE_ORDER(T, SO)
Constraint on the data type.In case the given data type T is not a dense or sparse matrix type and in...
Definition: StorageOrder.h:63
If_< IsExpression< MT >, const MT, const MT & > LeftOperand
Composite data type of the sparse matrix expression.
Definition: SMatScalarDivExpr.h:187
ConstIterator_< RemoveReference_< LeftOperand > > IteratorType
Iterator type of the sparse matrix expression.
Definition: SMatScalarDivExpr.h:204
Header file for the ColumnExprTrait class template.
Header file for the IsColumnMajorMatrix type trait.
size_t rows() const noexcept
Returns the current number of rows of the matrix.
Definition: SMatScalarDivExpr.h:398
DifferenceType operator-(const ConstIterator &rhs) const
Calculating the number of elements between two expression iterators.
Definition: SMatScalarDivExpr.h:308
bool isAliased(const T *alias) const noexcept
Returns whether the expression is aliased with the given address alias.
Definition: SMatScalarDivExpr.h:512
Header file for the And class template.
ST RightOperand
Composite type of the right-hand side scalar value.
Definition: SMatScalarDivExpr.h:190
const DMatSerialExpr< MT, SO > serial(const DenseMatrix< MT, SO > &dm)
Forces the serial evaluation of the given dense matrix expression dm.
Definition: DMatSerialExpr.h:723
ConstIterator upperBound(size_t i, size_t j) const
Returns an iterator to the first index greater then the given index.
Definition: SMatScalarDivExpr.h:467
typename MultTrait< T1, T2 >::Type MultTrait_
Auxiliary alias declaration for the MultTrait class template.The MultTrait_ alias declaration provide...
Definition: MultTrait.h:245
Header file for the Computation base class.
ResultType_< MT > RT
Result type of the sparse matrix expression.
Definition: SMatScalarDivExpr.h:120
ConstIterator lowerBound(size_t i, size_t j) const
Returns an iterator to the first index not less then the given index.
Definition: SMatScalarDivExpr.h:454
OppositeType_< ResultType > OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: SMatScalarDivExpr.h:176
Header file for the RequiresEvaluation type trait.
bool operator!=(const ConstIterator &rhs) const
Inequality comparison between two ConstIterator objects.
Definition: SMatScalarDivExpr.h:297
typename T::ResultType ResultType_
Alias declaration for nested ResultType type definitions.The ResultType_ alias declaration provides a...
Definition: Aliases.h:323
EnableIf_< IsDenseMatrix< MT1 > > smpAddAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the SMP addition assignment of a matrix to a dense matrix.
Definition: DenseMatrix.h:129
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:70
Base class for sparse matrices.The SparseMatrix class is a base class for all sparse matrix classes...
Definition: Forward.h:109
ValueType * PointerType
Pointer return type.
Definition: SMatScalarDivExpr.h:208
Constraint on the data type.
IfTrue_< useAssign, const ResultType, const SMatScalarDivExpr & > CompositeType
Data type for composite expression templates.
Definition: SMatScalarDivExpr.h:184
typename IfTrue< Condition, T1, T2 >::Type IfTrue_
Auxiliary alias declaration for the IfTrue class template.The IfTrue_ alias declaration provides a co...
Definition: If.h:109
const ConstIterator * operator->() const
Direct access to the sparse matrix element at the current iterator position.
Definition: SMatScalarDivExpr.h:255
typename T::ReturnType ReturnType_
Alias declaration for nested ReturnType type definitions.The ReturnType_ alias declaration provides a...
Definition: Aliases.h:343
size_t nonZeros() const
Returns the number of non-zero elements in the sparse matrix.
Definition: SMatScalarDivExpr.h:418
Header file for the SparseMatrix base class.
Header file for the DivExprTrait class template.
Constraint on the data type.
Header file for the MultExprTrait class template.
Compile time check to query the requirement to evaluate an expression.Via this type trait it is possi...
Definition: RequiresEvaluation.h:72
ReferenceType reference
Reference return type.
Definition: SMatScalarDivExpr.h:216
typename T::CompositeType CompositeType_
Alias declaration for nested CompositeType type definitions.The CompositeType_ alias declaration prov...
Definition: Aliases.h:83
const EnableIf_< IsNumeric< T2 >, DivExprTrait_< T1, T2 > > operator/(const DenseMatrix< T1, SO > &mat, T2 scalar)
Division operator for the division of a dense matrix by a scalar value ( ).
Definition: DMatScalarDivExpr.h:966
ConstIterator end(size_t i) const
Returns an iterator just past the last non-zero element of row i.
Definition: SMatScalarDivExpr.h:388
Header file for the ValueIndexPair class.
IteratorCategory iterator_category
The iterator category.
Definition: SMatScalarDivExpr.h:213
Header file for the IsTemporary type trait class.
Header file for the multiplication trait.
Header file for the IsStrictlyUpper type trait.
Header file for the IsSymmetric type trait.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
ReturnType value() const
Access to the current value of the sparse element.
Definition: SMatScalarDivExpr.h:265
Header file for the If class template.
Element ValueType
Type of the underlying pointers.
Definition: SMatScalarDivExpr.h:207
ConstIterator begin(size_t i) const
Returns an iterator to the first non-zero element of row i.
Definition: SMatScalarDivExpr.h:377
Iterator over the elements of the sparse matrix/scalar division expression.
Definition: SMatScalarDivExpr.h:196
Header file for the IsMultExpr type trait class.
const Element * ConstIterator
Iterator over constant elements.
Definition: CompressedMatrix.h:2647
Header file for the Or class template.
#define BLAZE_THROW_OUT_OF_RANGE(MESSAGE)
Macro for the emission of a std::out_of_range exception.This macro encapsulates the default way of Bl...
Definition: Exception.h:331
Header file for the Columns type trait.
SMatScalarDivExpr< MT, ST, SO > This
Type of this SMatScalarDivExpr instance.
Definition: SMatScalarDivExpr.h:174
typename T::ElementType ElementType_
Alias declaration for nested ElementType type definitions.The ElementType_ alias declaration provides...
Definition: Aliases.h:163
#define BLAZE_CONSTRAINT_MUST_BE_SAME_TYPE(A, B)
Data type constraint.In case the two types A and B are not the same (ignoring all cv-qualifiers of bo...
Definition: SameType.h:71
Header file for the IsLower type trait.
LeftOperand matrix_
Left-hand side sparse matrix of the division expression.
Definition: SMatScalarDivExpr.h:519
bool operator==(const ConstIterator &rhs) const
Equality comparison between two ConstIterator objects.
Definition: SMatScalarDivExpr.h:286
ptrdiff_t DifferenceType
Difference between two iterators.
Definition: SMatScalarDivExpr.h:210
RightOperand scalar_
Right-hand side scalar of the division expression.
Definition: SMatScalarDivExpr.h:316
#define BLAZE_CONSTRAINT_MUST_BE_REFERENCE_TYPE(T)
Constraint on the data type.In case the given data type T is not a reference type, a compilation error is created.
Definition: Reference.h:60
Constraints on the storage order of matrix types.
const Element operator*() const
Direct access to the sparse matrix element at the current iterator position.
Definition: SMatScalarDivExpr.h:245
Header file for the exception macros of the math module.
Constraint on the data type.
Header file for the RowExprTrait class template.
Header file for all forward declarations for expression class templates.
Header file for the EnableIf class template.
Header file for the IsStrictlyLower type trait.
Header file for the IsNumeric type trait.
ReturnType at(size_t i, size_t j) const
Checked access to the matrix elements.
Definition: SMatScalarDivExpr.h:360
Header file for the SubmatrixExprTrait class template.
ValueType value_type
Type of the underlying pointers.
Definition: SMatScalarDivExpr.h:214
Header file for run time assertion macros.
Utility type for generic codes.
Header file for the division trait.
ConstIterator & operator++()
Pre-increment operator.
Definition: SMatScalarDivExpr.h:234
Expression object for sparse matrix-scalar divisions.The SMatScalarMult class represents the compile ...
Definition: Forward.h:95
typename If< T1, T2, T3 >::Type If_
Auxiliary alias declaration for the If class template.The If_ alias declaration provides a convenient...
Definition: If.h:160
SMatScalarDivExpr(const MT &matrix, ST scalar) noexcept
Constructor for the SMatScalarDivExpr class.
Definition: SMatScalarDivExpr.h:332
Constraint on the data type.
#define BLAZE_CONSTRAINT_MUST_BE_NUMERIC_TYPE(T)
Constraint on the data type.In case the given data type T is not a numeric (integral or floating poin...
Definition: Numeric.h:61
bool canAlias(const T *alias) const noexcept
Returns whether the expression can alias with the given address alias.
Definition: SMatScalarDivExpr.h:500
ConstIterator find(size_t i, size_t j) const
Searches for a specific matrix element.
Definition: SMatScalarDivExpr.h:441
DivExprTrait_< RN, ST > ExprReturnType
Expression return type for the subscript operator.
Definition: SMatScalarDivExpr.h:135
#define BLAZE_CONSTRAINT_MUST_NOT_REQUIRE_EVALUATION(T)
Constraint on the data type.In case the given data type T requires an intermediate evaluation within ...
Definition: RequiresEvaluation.h:81
IntegralConstant< bool, B > BoolConstant
Generic wrapper for a compile time constant boolean value.The BoolConstant class template represents ...
Definition: IntegralConstant.h:100
Header file for the RemoveReference type trait.
Header file for the IsInvertible type trait.
typename EnableIf< Condition, T >::Type EnableIf_
Auxiliary alias declaration for the EnableIf class template.The EnableIf_ alias declaration provides ...
Definition: EnableIf.h:223
typename T::OppositeType OppositeType_
Alias declaration for nested OppositeType type definitions.The OppositeType_ alias declaration provid...
Definition: Aliases.h:243
#define BLAZE_CONSTRAINT_MUST_NOT_BE_FLOATING_POINT_TYPE(T)
Constraint on the data type.In case the given data type T is a floating point data type...
Definition: FloatingPoint.h:81
typename T::ConstIterator ConstIterator_
Alias declaration for nested ConstIterator type definitions.The ConstIterator_ alias declaration prov...
Definition: Aliases.h:103
ValueIndexPair< ElementType > Element
Element type of the sparse matrix expression.
Definition: SMatScalarDivExpr.h:201
ValueType & ReferenceType
Reference return type.
Definition: SMatScalarDivExpr.h:209
LeftOperand leftOperand() const noexcept
Returns the left-hand side sparse matrix operand.
Definition: SMatScalarDivExpr.h:478
Index-value-pair for sparse vectors and matrices.The ValueIndexPair class represents a single index-v...
Definition: ValueIndexPair.h:70
Header file for the IsRowMajorMatrix type trait.
Header file for the IsComputation type trait class.
typename DivExprTrait< T1, T2 >::Type DivExprTrait_
Auxiliary alias declaration for the DivExprTrait class template.The DivExprTrait_ alias declaration p...
Definition: DivExprTrait.h:196
CompositeType_< MT > CT
Composite type of the sparse matrix expression.
Definition: SMatScalarDivExpr.h:122
#define BLAZE_FUNCTION_TRACE
Function trace macro.This macro can be used to reliably trace function calls. In case function tracin...
Definition: FunctionTrace.h:157
Header file for the IntegralConstant class template.
std::forward_iterator_tag IteratorCategory
The iterator category.
Definition: SMatScalarDivExpr.h:206
size_t columns() const noexcept
Returns the current number of columns of the matrix.
Definition: SMatScalarDivExpr.h:408
RightOperand scalar_
Right-hand side scalar of the division expression.
Definition: SMatScalarDivExpr.h:520
typename T::RightOperand RightOperand_
Alias declaration for nested RightOperand type definitions.The RightOperand_ alias declaration provid...
Definition: Aliases.h:363
typename T::TransposeType TransposeType_
Alias declaration for nested TransposeType type definitions.The TransposeType_ alias declaration prov...
Definition: Aliases.h:403
Header file for the IsUpper type trait.
Header file for the MatScalarDivExpr base class.
MultTrait_< RT, ST > ResultType
Result type for expression template evaluations.
Definition: SMatScalarDivExpr.h:175
size_t nonZeros(size_t i) const
Returns the number of non-zero elements in the specified row.
Definition: SMatScalarDivExpr.h:429
DifferenceType difference_type
Difference between two iterators.
Definition: SMatScalarDivExpr.h:217
TransposeType_< ResultType > TransposeType
Transpose type for expression template evaluations.
Definition: SMatScalarDivExpr.h:177
Header file for the IsHermitian type trait.
ReturnType operator()(size_t i, size_t j) const
2D-access to the matrix elements.
Definition: SMatScalarDivExpr.h:345
#define BLAZE_INTERNAL_ASSERT(expr, msg)
Run time assertion macro for internal checks.In case of an invalid run time expression, the program execution is terminated. The BLAZE_INTERNAL_ASSERT macro can be disabled by setting the BLAZE_USER_ASSERTION flag to zero or by defining NDEBUG during the compilation.
Definition: Assert.h:101
#define BLAZE_CONSTRAINT_MUST_BE_SPARSE_MATRIX_TYPE(T)
Constraint on the data type.In case the given data type T is not a sparse, N-dimensional matrix type...
Definition: SparseMatrix.h:61
Header file for the IsExpression type trait class.
Header file for the FunctionTrace class.
size_t index() const
Access to the current index of the sparse element.
Definition: SMatScalarDivExpr.h:275