SVecScalarDivExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_SVECSCALARDIVEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_SVECSCALARDIVEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <iterator>
44 #include <blaze/math/Aliases.h>
48 #include <blaze/math/Exception.h>
67 #include <blaze/util/Assert.h>
71 #include <blaze/util/EnableIf.h>
73 #include <blaze/util/mpl/And.h>
74 #include <blaze/util/mpl/If.h>
75 #include <blaze/util/mpl/Or.h>
76 #include <blaze/util/Types.h>
82 
83 
84 namespace blaze {
85 
86 //=================================================================================================
87 //
88 // CLASS SVECSCALARDIVEXPR
89 //
90 //=================================================================================================
91 
92 //*************************************************************************************************
99 template< typename VT // Type of the left-hand side sparse vector
100  , typename ST // Type of the right-hand side scalar value
101  , bool TF > // Transpose flag
102 class SVecScalarDivExpr
103  : public VecScalarDivExpr< SparseVector< SVecScalarDivExpr<VT,ST,TF>, TF > >
104  , private Computation
105 {
106  private:
107  //**Type definitions****************************************************************************
108  using RT = ResultType_<VT>;
109  using RN = ReturnType_<VT>;
111  //**********************************************************************************************
112 
113  //**Return type evaluation**********************************************************************
115 
120  enum : bool { returnExpr = !IsTemporary<RN>::value };
121 
124  //**********************************************************************************************
125 
126  //**Serial evaluation strategy******************************************************************
128 
134  enum : bool { useAssign = RequiresEvaluation<VT>::value };
135 
137  template< typename VT2 >
139  struct UseAssign {
140  enum : bool { value = useAssign };
141  };
143  //**********************************************************************************************
144 
145  //**Parallel evaluation strategy****************************************************************
147 
153  template< typename VT2 >
154  struct UseSMPAssign {
155  enum : bool { value = ( !VT2::smpAssignable || !VT::smpAssignable ) && useAssign };
156  };
158  //**********************************************************************************************
159 
160  public:
161  //**Type definitions****************************************************************************
166 
169 
172 
174  using LeftOperand = If_< IsExpression<VT>, const VT, const VT& >;
175 
177  using RightOperand = ST;
178  //**********************************************************************************************
179 
180  //**Compilation flags***************************************************************************
182  enum : bool { smpAssignable = false };
183  //**********************************************************************************************
184 
185  //**ConstIterator class definition**************************************************************
189  {
190  public:
191  //**Type definitions*************************************************************************
194 
197 
198  using IteratorCategory = std::forward_iterator_tag;
199  using ValueType = Element;
203 
204  // STL iterator requirements
210  //*******************************************************************************************
211 
212  //**Constructor******************************************************************************
215  inline ConstIterator( IteratorType vector, RightOperand scalar )
216  : vector_( vector ) // Iterator over the elements of the left-hand side sparse vector expression
217  , scalar_( scalar ) // Right hand side scalar of the multiplication expression
218  {}
219  //*******************************************************************************************
220 
221  //**Prefix increment operator****************************************************************
227  ++vector_;
228  return *this;
229  }
230  //*******************************************************************************************
231 
232  //**Element access operator******************************************************************
237  inline const Element operator*() const {
238  return Element( vector_->value() / scalar_, vector_->index() );
239  }
240  //*******************************************************************************************
241 
242  //**Element access operator******************************************************************
247  inline const ConstIterator* operator->() const {
248  return this;
249  }
250  //*******************************************************************************************
251 
252  //**Value function***************************************************************************
257  inline ReturnType value() const {
258  return vector_->value() / scalar_;
259  }
260  //*******************************************************************************************
261 
262  //**Index function***************************************************************************
267  inline size_t index() const {
268  return vector_->index();
269  }
270  //*******************************************************************************************
271 
272  //**Equality operator************************************************************************
278  inline bool operator==( const ConstIterator& rhs ) const {
279  return vector_ == rhs.vector_;
280  }
281  //*******************************************************************************************
282 
283  //**Inequality operator**********************************************************************
289  inline bool operator!=( const ConstIterator& rhs ) const {
290  return vector_ != rhs.vector_;
291  }
292  //*******************************************************************************************
293 
294  //**Subtraction operator*********************************************************************
300  inline DifferenceType operator-( const ConstIterator& rhs ) const {
301  return vector_ - rhs.vector_;
302  }
303  //*******************************************************************************************
304 
305  private:
306  //**Member variables*************************************************************************
309  //*******************************************************************************************
310  };
311  //**********************************************************************************************
312 
313  //**Constructor*********************************************************************************
319  explicit inline SVecScalarDivExpr( const VT& vector, ST scalar ) noexcept
320  : vector_( vector ) // Left-hand side sparse vector of the division expression
321  , scalar_( scalar ) // Right-hand side scalar of the division expression
322  {}
323  //**********************************************************************************************
324 
325  //**Subscript operator**************************************************************************
331  inline ReturnType operator[]( size_t index ) const {
332  BLAZE_INTERNAL_ASSERT( index < vector_.size(), "Invalid vector access index" );
333  return vector_[index] / scalar_;
334  }
335  //**********************************************************************************************
336 
337  //**At function*********************************************************************************
344  inline ReturnType at( size_t index ) const {
345  if( index >= vector_.size() ) {
346  BLAZE_THROW_OUT_OF_RANGE( "Invalid vector access index" );
347  }
348  return (*this)[index];
349  }
350  //**********************************************************************************************
351 
352  //**Begin function******************************************************************************
357  inline ConstIterator begin() const {
358  return ConstIterator( vector_.begin(), scalar_ );
359  }
360  //**********************************************************************************************
361 
362  //**End function********************************************************************************
367  inline ConstIterator end() const {
368  return ConstIterator( vector_.end(), scalar_ );
369  }
370  //**********************************************************************************************
371 
372  //**Size function*******************************************************************************
377  inline size_t size() const noexcept {
378  return vector_.size();
379  }
380  //**********************************************************************************************
381 
382  //**NonZeros function***************************************************************************
387  inline size_t nonZeros() const {
388  return vector_.nonZeros();
389  }
390  //**********************************************************************************************
391 
392  //**Find function*******************************************************************************
398  inline ConstIterator find( size_t index ) const {
400  return ConstIterator( vector_.find( index ), scalar_ );
401  }
402  //**********************************************************************************************
403 
404  //**LowerBound function*************************************************************************
410  inline ConstIterator lowerBound( size_t index ) const {
412  return ConstIterator( vector_.lowerBound( index ), scalar_ );
413  }
414  //**********************************************************************************************
415 
416  //**UpperBound function*************************************************************************
422  inline ConstIterator upperBound( size_t index ) const {
424  return ConstIterator( vector_.upperBound( index ), scalar_ );
425  }
426  //**********************************************************************************************
427 
428  //**Left operand access*************************************************************************
433  inline LeftOperand leftOperand() const noexcept {
434  return vector_;
435  }
436  //**********************************************************************************************
437 
438  //**Right operand access************************************************************************
443  inline RightOperand rightOperand() const noexcept {
444  return scalar_;
445  }
446  //**********************************************************************************************
447 
448  //**********************************************************************************************
454  template< typename T >
455  inline bool canAlias( const T* alias ) const noexcept {
456  return vector_.canAlias( alias );
457  }
458  //**********************************************************************************************
459 
460  //**********************************************************************************************
466  template< typename T >
467  inline bool isAliased( const T* alias ) const noexcept {
468  return vector_.isAliased( alias );
469  }
470  //**********************************************************************************************
471 
472  private:
473  //**Member variables****************************************************************************
476  //**********************************************************************************************
477 
478  //**Assignment to dense vectors*****************************************************************
492  template< typename VT2 > // Type of the target dense vector
493  friend inline EnableIf_< UseAssign<VT2> >
494  assign( DenseVector<VT2,TF>& lhs, const SVecScalarDivExpr& rhs )
495  {
497 
498  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
499 
500  assign( ~lhs, rhs.vector_ );
501  (~lhs) /= rhs.scalar_;
502  }
504  //**********************************************************************************************
505 
506  //**Assignment to sparse vectors****************************************************************
520  template< typename VT2 > // Type of the target sparse vector
521  friend inline EnableIf_< UseAssign<VT2> >
522  assign( SparseVector<VT2,TF>& lhs, const SVecScalarDivExpr& rhs )
523  {
525 
526  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
527 
528  assign( ~lhs, rhs.vector_ );
529  (~lhs) /= rhs.scalar_;
530  }
532  //**********************************************************************************************
533 
534  //**Addition assignment to dense vectors********************************************************
548  template< typename VT2 > // Type of the target dense vector
549  friend inline EnableIf_< UseAssign<VT2> >
550  addAssign( DenseVector<VT2,TF>& lhs, const SVecScalarDivExpr& rhs )
551  {
553 
557 
558  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
559 
560  const ResultType tmp( serial( rhs ) );
561  addAssign( ~lhs, tmp );
562  }
564  //**********************************************************************************************
565 
566  //**Addition assignment to sparse vectors*******************************************************
567  // No special implementation for the addition assignment to sparse vectors.
568  //**********************************************************************************************
569 
570  //**Subtraction assignment to dense vectors*****************************************************
584  template< typename VT2 > // Type of the target dense vector
585  friend inline EnableIf_< UseAssign<VT2> >
586  subAssign( DenseVector<VT2,TF>& lhs, const SVecScalarDivExpr& rhs )
587  {
589 
593 
594  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
595 
596  const ResultType tmp( serial( rhs ) );
597  subAssign( ~lhs, tmp );
598  }
600  //**********************************************************************************************
601 
602  //**Subtraction assignment to sparse vectors****************************************************
603  // No special implementation for the subtraction assignment to sparse vectors.
604  //**********************************************************************************************
605 
606  //**Multiplication assignment to dense vectors**************************************************
620  template< typename VT2 > // Type of the target dense vector
621  friend inline EnableIf_< UseAssign<VT2> >
622  multAssign( DenseVector<VT2,TF>& lhs, const SVecScalarDivExpr& rhs )
623  {
625 
629 
630  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
631 
632  const ResultType tmp( serial( rhs ) );
633  multAssign( ~lhs, tmp );
634  }
636  //**********************************************************************************************
637 
638  //**Multiplication assignment to sparse vectors*************************************************
639  // No special implementation for the multiplication assignment to sparse vectors.
640  //**********************************************************************************************
641 
642  //**SMP assignment to dense vectors*************************************************************
643  // No special implementation for the SMP assignment to dense vectors.
644  //**********************************************************************************************
645 
646  //**SMP assignment to sparse vectors************************************************************
647  // No special implementation for the SMP assignment to sparse vectors.
648  //**********************************************************************************************
649 
650  //**SMP addition assignment to dense vectors****************************************************
664  template< typename VT2 > // Type of the target dense vector
665  friend inline EnableIf_< UseSMPAssign<VT2> >
666  smpAddAssign( DenseVector<VT2,TF>& lhs, const SVecScalarDivExpr& rhs )
667  {
669 
673 
674  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
675 
676  const ResultType tmp( rhs );
677  smpAddAssign( ~lhs, tmp );
678  }
680  //**********************************************************************************************
681 
682  //**SMP addition assignment to sparse vectors***************************************************
683  // No special implementation for the SMP addition assignment to sparse vectors.
684  //**********************************************************************************************
685 
686  //**SMP subtraction assignment to dense vectors*************************************************
700  template< typename VT2 > // Type of the target dense vector
701  friend inline EnableIf_< UseSMPAssign<VT2> >
702  smpSubAssign( DenseVector<VT2,TF>& lhs, const SVecScalarDivExpr& rhs )
703  {
705 
709 
710  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
711 
712  const ResultType tmp( rhs );
713  smpSubAssign( ~lhs, tmp );
714  }
716  //**********************************************************************************************
717 
718  //**SMP subtraction assignment to sparse vectors************************************************
719  // No special implementation for the SMP subtraction assignment to sparse vectors.
720  //**********************************************************************************************
721 
722  //**SMP multiplication assignment to dense vectors**********************************************
736  template< typename VT2 > // Type of the target dense vector
737  friend inline EnableIf_< UseSMPAssign<VT2> >
738  smpMultAssign( DenseVector<VT2,TF>& lhs, const SVecScalarDivExpr& rhs )
739  {
741 
745 
746  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
747 
748  const ResultType tmp( rhs );
749  smpMultAssign( ~lhs, tmp );
750  }
752  //**********************************************************************************************
753 
754  //**SMP multiplication assignment to sparse vectors*********************************************
755  // No special implementation for the SMP multiplication assignment to sparse vectors.
756  //**********************************************************************************************
757 
758  //**Compile time checks*************************************************************************
767  //**********************************************************************************************
768 };
769 //*************************************************************************************************
770 
771 
772 
773 
774 //=================================================================================================
775 //
776 // GLOBAL BINARY ARITHMETIC OPERATORS
777 //
778 //=================================================================================================
779 
780 //*************************************************************************************************
785 template< typename VT // Type of the left-hand side sparse vector
786  , typename ST // Type of the right-hand side scalar
787  , bool TF > // Transpose flag
788 struct SVecScalarDivExprHelper
789 {
790  private:
791  //**********************************************************************************************
792  using ScalarType = If_< Or< IsFloatingPoint< UnderlyingBuiltin_<VT> >
793  , IsFloatingPoint< UnderlyingBuiltin_<ST> > >
794  , If_< And< IsComplex< UnderlyingNumeric_<VT> >
795  , IsBuiltin<ST> >
796  , DivTrait_< UnderlyingBuiltin_<VT>, ST >
797  , DivTrait_< UnderlyingNumeric_<VT>, ST > >
798  , ST >;
799  //**********************************************************************************************
800 
801  public:
802  //**********************************************************************************************
803  using Type = If_< IsInvertible<ScalarType>
804  , SVecScalarMultExpr<VT,ScalarType,TF>
805  , SVecScalarDivExpr<VT,ScalarType,TF> >;
806  //**********************************************************************************************
807 };
809 //*************************************************************************************************
810 
811 
812 //*************************************************************************************************
835 template< typename VT // Type of the left-hand side sparse vector
836  , typename ST // Type of the right-hand side scalar
837  , bool TF // Transpose flag
838  , typename = EnableIf_< IsNumeric<ST> > >
839 inline decltype(auto) operator/( const SparseVector<VT,TF>& vec, ST scalar )
840 {
842 
843  BLAZE_USER_ASSERT( scalar != ST(0), "Division by zero detected" );
844 
845  using ReturnType = typename SVecScalarDivExprHelper<VT,ST,TF>::Type;
846  using ScalarType = RightOperand_<ReturnType>;
847 
849  return ReturnType( ~vec, ScalarType(1)/ScalarType(scalar) );
850  }
851  else {
852  return ReturnType( ~vec, scalar );
853  }
854 }
855 //*************************************************************************************************
856 
857 
858 
859 
860 //=================================================================================================
861 //
862 // GLOBAL RESTRUCTURING BINARY ARITHMETIC OPERATORS
863 //
864 //=================================================================================================
865 
866 //*************************************************************************************************
879 template< typename VT // Type of the sparse vector of the left-hand side expression
880  , typename ST1 // Type of the scalar of the left-hand side expression
881  , bool TF // Transpose flag of the sparse vector
882  , typename ST2 // Type of the right-hand side scalar
884 inline decltype(auto) operator*( const SVecScalarDivExpr<VT,ST1,TF>& vec, ST2 scalar )
885 {
887 
888  return vec.leftOperand() * ( scalar / vec.rightOperand() );
889 }
891 //*************************************************************************************************
892 
893 
894 //*************************************************************************************************
907 template< typename ST1 // Type of the left-hand side scalar
908  , typename VT // Type of the sparse vector of the right-hand side expression
909  , typename ST2 // Type of the scalar of the right-hand side expression
910  , bool TF // Transpose flag of the sparse vector
911  , typename = EnableIf_< And< IsNumeric<ST1>, Or< IsInvertible<ST1>, IsInvertible<ST2> > > > >
912 inline decltype(auto) operator*( ST1 scalar, const SVecScalarDivExpr<VT,ST2,TF>& vec )
913 {
915 
916  return vec.leftOperand() * ( scalar / vec.rightOperand() );
917 }
919 //*************************************************************************************************
920 
921 
922 //*************************************************************************************************
935 template< typename VT // Type of the sparse vector of the left-hand side expression
936  , typename ST1 // Type of the scalar of the left-hand side expression
937  , bool TF // Transpose flag of the sparse vector
938  , typename ST2 // Type of the right-hand side scalar
939  , typename = EnableIf_< IsNumeric<ST2> > >
940 inline decltype(auto) operator/( const SVecScalarDivExpr<VT,ST1,TF>& vec, ST2 scalar )
941 {
943 
944  BLAZE_USER_ASSERT( scalar != ST2(0), "Division by zero detected" );
945 
946  using MultType = MultTrait_<ST1,ST2>;
947  using ReturnType = typename SVecScalarDivExprHelper<VT,MultType,TF>::Type;
948  using ScalarType = RightOperand_<ReturnType>;
949 
951  return ReturnType( vec.leftOperand(), ScalarType(1)/( vec.rightOperand() * scalar ) );
952  }
953  else {
954  return ReturnType( vec.leftOperand(), vec.rightOperand() * scalar );
955  }
956 }
958 //*************************************************************************************************
959 
960 
961 
962 
963 //=================================================================================================
964 //
965 // SIZE SPECIALIZATIONS
966 //
967 //=================================================================================================
968 
969 //*************************************************************************************************
971 template< typename VT, typename ST, bool TF >
972 struct Size< SVecScalarDivExpr<VT,ST,TF>, 0UL >
973  : public Size<VT,0UL>
974 {};
976 //*************************************************************************************************
977 
978 } // namespace blaze
979 
980 #endif
Header file for the UnderlyingNumeric type trait.
Pointer difference type of the Blaze library.
Header file for auxiliary alias declarations.
Data type constraint.
Constraint on the data type.
ConstIterator(IteratorType vector, RightOperand scalar)
Constructor for the ConstIterator class.
Definition: SVecScalarDivExpr.h:215
size_t size() const noexcept
Returns the current size/dimension of the vector.
Definition: SVecScalarDivExpr.h:377
#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:69
Header file for basic type definitions.
Header file for the SparseVector base class.
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 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:97
decltype(auto) operator/(const DenseMatrix< MT, SO > &mat, ST scalar)
Division operator for the division of a dense matrix by a scalar value ( ).
Definition: DMatScalarDivExpr.h:1070
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:164
Header file for the serial shim.
ConstIterator_< RemoveReference_< LeftOperand > > IteratorType
Iterator type of the sparse vector expression.
Definition: SVecScalarDivExpr.h:196
size_t index() const
Access to the current index of the sparse element.
Definition: SVecScalarDivExpr.h:267
Header file for the VecScalarDivExpr base class.
EnableIf_< IsDenseVector< VT1 > > smpMultAssign(Vector< VT1, TF1 > &lhs, const Vector< VT2, TF2 > &rhs)
Default implementation of the SMP multiplication assignment of a vector to a dense vector...
Definition: DenseVector.h:193
Header file for the And class template.
ConstIterator end() const
Returns an iterator just past the last non-zero element of the sparse vector.
Definition: SVecScalarDivExpr.h:367
If_< IsExpression< VT >, const VT, const VT &> LeftOperand
Composite type of the left-hand side sparse vector expression.
Definition: SVecScalarDivExpr.h:174
typename MultTrait< T1, T2 >::Type MultTrait_
Auxiliary alias declaration for the MultTrait class template.The MultTrait_ alias declaration provide...
Definition: MultTrait.h:291
Header file for the Computation base class.
Header file for the RequiresEvaluation type trait.
IteratorCategory iterator_category
The iterator category.
Definition: SVecScalarDivExpr.h:205
const ConstIterator * operator->() const
Direct access to the sparse vector element at the current iterator position.
Definition: SVecScalarDivExpr.h:247
typename T::ResultType ResultType_
Alias declaration for nested ResultType type definitions.The ResultType_ alias declaration provides a...
Definition: Aliases.h:343
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:133
const IfTrue_< returnExpr, ExprReturnType, ElementType > ReturnType
Return type for expression template evaluations.
Definition: SVecScalarDivExpr.h:168
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
ST RightOperand
Composite type of the right-hand side scalar value.
Definition: SVecScalarDivExpr.h:177
typename T::ReturnType ReturnType_
Alias declaration for nested ReturnType type definitions.The ReturnType_ alias declaration provides a...
Definition: Aliases.h:363
Header file for the DivExprTrait class template.
DivExprTrait_< RN, ST > ExprReturnType
Expression return type for the subscript operator.
Definition: SVecScalarDivExpr.h:123
SVecScalarDivExpr(const VT &vector, ST scalar) noexcept
Constructor for the SVecScalarDivExpr class.
Definition: SVecScalarDivExpr.h:319
DivTrait_< RT, ST > ResultType
Result type for expression template evaluations.
Definition: SVecScalarDivExpr.h:163
DifferenceType operator-(const ConstIterator &rhs) const
Calculating the number of elements between two expression iterators.
Definition: SVecScalarDivExpr.h:300
Compile time check to query the requirement to evaluate an expression.Via this type trait it is possi...
Definition: RequiresEvaluation.h:71
RightOperand scalar_
Right hand side scalar of the multiplication expression.
Definition: SVecScalarDivExpr.h:308
ReturnType_< VT > RN
Return type of the sparse vector expression.
Definition: SVecScalarDivExpr.h:109
typename T::CompositeType CompositeType_
Alias declaration for nested CompositeType type definitions.The CompositeType_ alias declaration prov...
Definition: Aliases.h:83
ConstIterator upperBound(size_t index) const
Returns an iterator to the first index greater then the given index.
Definition: SVecScalarDivExpr.h:422
IfTrue_< useAssign, const ResultType, const SVecScalarDivExpr &> CompositeType
Data type for composite expression templates.
Definition: SVecScalarDivExpr.h:171
Header file for the ValueIndexPair class.
Header file for the IsTemporary type trait class.
Header file for the multiplication trait.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:58
Header file for the If class template.
Header file for the IsFloatingPoint type trait.
IteratorType vector_
Iterator over the elements of the left-hand side sparse vector expression.
Definition: SVecScalarDivExpr.h:307
Header file for the UnderlyingBuiltin type trait.
Header file for the IsMultExpr type trait class.
Header file for the Or class template.
Iterator over the elements of the sparse vector/scalar multiplication expression. ...
Definition: SVecScalarDivExpr.h:188
#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
const Element * ConstIterator
Iterator over constant elements.
Definition: CompressedMatrix.h:3085
typename T::ElementType ElementType_
Alias declaration for nested ElementType type definitions.The ElementType_ alias declaration provides...
Definition: Aliases.h:163
Base class for N-dimensional dense vectors.The DenseVector class is a base class for all arbitrarily ...
Definition: DenseVector.h:76
#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
#define BLAZE_CONSTRAINT_MUST_BE_SPARSE_VECTOR_TYPE(T)
Constraint on the data type.In case the given data type T is not a sparse, N-dimensional vector type...
Definition: SparseVector.h:61
Constraint on the data type.
ReturnType value() const
Access to the current value of the sparse element.
Definition: SVecScalarDivExpr.h:257
bool isAliased(const T *alias) const noexcept
Returns whether the expression is aliased with the given address alias.
Definition: SVecScalarDivExpr.h:467
Header file for the exception macros of the math module.
decltype(auto) operator*(const DenseMatrix< MT1, false > &lhs, const DenseMatrix< MT2, false > &rhs)
Multiplication operator for the multiplication of two row-major dense matrices ( ).
Definition: DMatDMatMultExpr.h:8893
Constraint on the data type.
Header file for all forward declarations for expression class templates.
ConstIterator & operator++()
Pre-increment operator.
Definition: SVecScalarDivExpr.h:226
Constraint on the data type.
Header file for the EnableIf class template.
size_t nonZeros() const
Returns the number of non-zero elements in the sparse vector.
Definition: SVecScalarDivExpr.h:387
ConstIterator find(size_t index) const
Searches for a specific vector element.
Definition: SVecScalarDivExpr.h:398
RightOperand scalar_
Right-hand side scalar of the division expression.
Definition: SVecScalarDivExpr.h:475
typename DivTrait< T1, T2 >::Type DivTrait_
Auxiliary alias declaration for the DivTrait class template.The DivTrait_ alias declaration provides ...
Definition: DivTrait.h:292
CompositeType_< VT > CT
Composite type of the sparse vector expression.
Definition: SVecScalarDivExpr.h:110
Header file for the IsNumeric type trait.
bool canAlias(const T *alias) const noexcept
Returns whether the expression can alias with the given address alias.
Definition: SVecScalarDivExpr.h:455
ConstIterator begin() const
Returns an iterator to the first non-zero element of the sparse vector.
Definition: SVecScalarDivExpr.h:357
const Element operator*() const
Direct access to the sparse vector element at the current iterator position.
Definition: SVecScalarDivExpr.h:237
std::forward_iterator_tag IteratorCategory
The iterator category.
Definition: SVecScalarDivExpr.h:198
RightOperand rightOperand() const noexcept
Returns the right-hand side scalar operand.
Definition: SVecScalarDivExpr.h:443
Header file for run time assertion macros.
Header file for the division trait.
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:154
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
#define BLAZE_FUNCTION_TRACE
Function trace macro.This macro can be used to reliably trace function calls. In case function tracin...
Definition: FunctionTrace.h:94
ElementType_< ResultType > ElementType
Resulting element type.
Definition: SVecScalarDivExpr.h:165
Compile time check for data types.This type trait tests whether or not the given template parameter i...
Definition: IsInvertible.h:82
LeftOperand leftOperand() const noexcept
Returns the left-hand side sparse vector operand.
Definition: SVecScalarDivExpr.h:433
decltype(auto) serial(const DenseMatrix< MT, SO > &dm)
Forces the serial evaluation of the given dense matrix expression dm.
Definition: DMatSerialExpr.h:816
#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
Expression object for divisions of a sparse vector by a scalar.The SVecScalarDivExpr class represents...
Definition: Forward.h:138
ResultType_< VT > RT
Result type of the sparse vector expression.
Definition: SVecScalarDivExpr.h:108
LeftOperand vector_
Left-hand side sparse vector of the division expression.
Definition: SVecScalarDivExpr.h:474
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:224
#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
const Type & ReturnType
Return type for expression template evaluations.
Definition: CompressedMatrix.h:3080
typename T::ConstIterator ConstIterator_
Alias declaration for nested ConstIterator type definitions.The ConstIterator_ alias declaration prov...
Definition: Aliases.h:103
ConstIterator lowerBound(size_t index) const
Returns an iterator to the first index not less then the given index.
Definition: SVecScalarDivExpr.h:410
Index-value-pair for sparse vectors and matrices.The ValueIndexPair class represents a single index-v...
Definition: ValueIndexPair.h:73
bool operator==(const ConstIterator &rhs) const
Equality comparison between two ConstIterator objects.
Definition: SVecScalarDivExpr.h:278
Header file for the IsComputation type trait class.
Header file for the IsBuiltin type trait.
typename DivExprTrait< T1, T2 >::Type DivExprTrait_
Auxiliary alias declaration for the DivExprTrait class template.The DivExprTrait_ alias declaration p...
Definition: DivExprTrait.h:112
Compile time logical &#39;or&#39; evaluation.The Or alias declaration performs at compile time a logical &#39;or&#39;...
Definition: Or.h:76
Compile time evaluation of the size of vectors and matrices.The Size type trait evaluates the size of...
Definition: Size.h:80
Base class for sparse vectors.The SparseVector class is a base class for all arbitrarily sized (N-dim...
Definition: Forward.h:130
ReturnType at(size_t index) const
Checked access to the vector elements.
Definition: SVecScalarDivExpr.h:344
bool operator!=(const ConstIterator &rhs) const
Inequality comparison between two ConstIterator objects.
Definition: SVecScalarDivExpr.h:289
Header file for the IsComplex type trait.
typename T::RightOperand RightOperand_
Alias declaration for nested RightOperand type definitions.The RightOperand_ alias declaration provid...
Definition: Aliases.h:383
typename T::TransposeType TransposeType_
Alias declaration for nested TransposeType type definitions.The TransposeType_ alias declaration prov...
Definition: Aliases.h:423
TransposeType_< ResultType > TransposeType
Transpose type for expression template evaluations.
Definition: SVecScalarDivExpr.h:164
Header file for the Size type trait.
#define BLAZE_CONSTRAINT_MUST_BE_VECTOR_WITH_TRANSPOSE_FLAG(T, TF)
Constraint on the data type.In case the given data type T is not a dense or sparse vector type and in...
Definition: TransposeFlag.h:63
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: SVecScalarDivExpr.h:331
#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
Header file for the IsExpression type trait class.
Header file for the function trace functionality.