SMatDMatSchurExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_SMATDMATSCHUREXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_SMATDMATSCHUREXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <iterator>
44 #include <blaze/math/Aliases.h>
50 #include <blaze/math/Exception.h>
72 #include <blaze/util/Assert.h>
73 #include <blaze/util/DisableIf.h>
74 #include <blaze/util/EnableIf.h>
76 #include <blaze/util/mpl/And.h>
77 #include <blaze/util/mpl/If.h>
78 #include <blaze/util/mpl/Maximum.h>
79 #include <blaze/util/mpl/Or.h>
80 #include <blaze/util/Types.h>
81 #include <blaze/util/Unused.h>
82 
83 
84 namespace blaze {
85 
86 //=================================================================================================
87 //
88 // CLASS SMATDMATSCHUREXPR
89 //
90 //=================================================================================================
91 
92 //*************************************************************************************************
99 template< typename MT1 // Type of the left-hand side sparse matrix
100  , typename MT2 > // Type of the right-hand side dense matrix
101 class SMatDMatSchurExpr
102  : public SchurExpr< SparseMatrix< SMatDMatSchurExpr<MT1,MT2>, false > >
103  , private Computation
104 {
105  private:
106  //**Type definitions****************************************************************************
113  //**********************************************************************************************
114 
115  //**Return type evaluation**********************************************************************
117 
122  enum : bool { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value };
123 
126  //**********************************************************************************************
127 
128  //**Evaluation strategy*************************************************************************
130 
136  enum : bool { useAssign = ( RequiresEvaluation<MT1>::value || RequiresEvaluation<MT2>::value ) };
137 
139  template< typename VT >
141  struct UseAssign {
142  enum : bool { value = useAssign };
143  };
145  //**********************************************************************************************
146 
147  public:
148  //**Type definitions****************************************************************************
154 
157 
160 
162  using LeftOperand = If_< IsExpression<MT1>, const MT1, const MT1& >;
163 
165  using RightOperand = If_< IsExpression<MT2>, const MT2, const MT2& >;
166  //**********************************************************************************************
167 
168  //**ConstIterator class definition**************************************************************
172  {
173  public:
174  //**Type definitions*************************************************************************
177 
180 
181  using IteratorCategory = std::forward_iterator_tag;
182  using ValueType = Element;
186 
187  // STL iterator requirements
193  //*******************************************************************************************
194 
195  //**Constructor******************************************************************************
202  inline ConstIterator( LeftIterator left, RightOperand right, size_t row )
203  : left_ ( left ) // Iterator over the elements of the left-hand side sparse matrix expression
204  , right_( right ) // Right-hand side dense matrix expression
205  , row_ ( row ) // The row index of the iterator
206  {}
207  //*******************************************************************************************
208 
209  //**Prefix increment operator****************************************************************
215  ++left_;
216  return *this;
217  }
218  //*******************************************************************************************
219 
220  //**Element access operator******************************************************************
225  inline const Element operator*() const {
226  return Element( left_->value() * right_(row_,left_->index()), left_->index() );
227  }
228  //*******************************************************************************************
229 
230  //**Element access operator******************************************************************
235  inline const ConstIterator* operator->() const {
236  return this;
237  }
238  //*******************************************************************************************
239 
240  //**Value function***************************************************************************
245  inline ReturnType value() const {
246  return left_->value() * right_(row_,left_->index());
247  }
248  //*******************************************************************************************
249 
250  //**Index function***************************************************************************
255  inline size_t index() const {
256  return left_->index();
257  }
258  //*******************************************************************************************
259 
260  //**Equality operator************************************************************************
266  inline bool operator==( const ConstIterator& rhs ) const {
267  return left_ == rhs.left_;
268  }
269  //*******************************************************************************************
270 
271  //**Inequality operator**********************************************************************
277  inline bool operator!=( const ConstIterator& rhs ) const {
278  return left_ != rhs.left_;
279  }
280  //*******************************************************************************************
281 
282  //**Subtraction operator*********************************************************************
288  inline DifferenceType operator-( const ConstIterator& rhs ) const {
289  return left_ - rhs.left_;
290  }
291  //*******************************************************************************************
292 
293  private:
294  //**Member variables*************************************************************************
297  size_t row_;
298  //*******************************************************************************************
299  };
300  //**********************************************************************************************
301 
302  //**Compilation flags***************************************************************************
304  enum : bool { smpAssignable = false };
305  //**********************************************************************************************
306 
307  //**Constructor*********************************************************************************
313  explicit inline SMatDMatSchurExpr( const MT1& lhs, const MT2& rhs ) noexcept
314  : lhs_( lhs ) // Left-hand side sparse matrix of the Schur product expression
315  , rhs_( rhs ) // Right-hand side dense matrix of the Schur product expression
316  {
317  BLAZE_INTERNAL_ASSERT( lhs.rows() == rhs.rows() , "Invalid number of rows" );
318  BLAZE_INTERNAL_ASSERT( lhs.columns() == rhs.columns(), "Invalid number of columns" );
319  }
320  //**********************************************************************************************
321 
322  //**Access operator*****************************************************************************
329  inline ReturnType operator()( size_t i, size_t j ) const {
330  BLAZE_INTERNAL_ASSERT( i < lhs_.rows() , "Invalid row access index" );
331  BLAZE_INTERNAL_ASSERT( j < lhs_.columns(), "Invalid column access index" );
332  return lhs_(i,j) * rhs_(i,j);
333  }
334  //**********************************************************************************************
335 
336  //**At function*********************************************************************************
344  inline ReturnType at( size_t i, size_t j ) const {
345  if( i >= lhs_.rows() ) {
346  BLAZE_THROW_OUT_OF_RANGE( "Invalid row access index" );
347  }
348  if( j >= lhs_.columns() ) {
349  BLAZE_THROW_OUT_OF_RANGE( "Invalid column access index" );
350  }
351  return (*this)(i,j);
352  }
353  //**********************************************************************************************
354 
355  //**Begin function******************************************************************************
361  inline ConstIterator begin( size_t i ) const {
362  return ConstIterator( lhs_.begin(i), rhs_, i );
363  }
364  //**********************************************************************************************
365 
366  //**End function********************************************************************************
372  inline ConstIterator end( size_t i ) const {
373  return ConstIterator( lhs_.end(i), rhs_, i );
374  }
375  //**********************************************************************************************
376 
377  //**Rows function*******************************************************************************
382  inline size_t rows() const noexcept {
383  return lhs_.rows();
384  }
385  //**********************************************************************************************
386 
387  //**Columns function****************************************************************************
392  inline size_t columns() const noexcept {
393  return lhs_.columns();
394  }
395  //**********************************************************************************************
396 
397  //**NonZeros function***************************************************************************
402  inline size_t nonZeros() const {
403  return lhs_.nonZeros();
404  }
405  //**********************************************************************************************
406 
407  //**NonZeros function***************************************************************************
413  inline size_t nonZeros( size_t i ) const {
414  return lhs_.nonZeros(i);
415  }
416  //**********************************************************************************************
417 
418  //**Find function*******************************************************************************
425  inline ConstIterator find( size_t i, size_t j ) const {
427  return ConstIterator( lhs_.find( i, j ), rhs_, i );
428  }
429  //**********************************************************************************************
430 
431  //**LowerBound function*************************************************************************
438  inline ConstIterator lowerBound( size_t i, size_t j ) const {
440  return ConstIterator( lhs_.lowerBound( i, j ), rhs_, i );
441  }
442  //**********************************************************************************************
443 
444  //**UpperBound function*************************************************************************
451  inline ConstIterator upperBound( size_t i, size_t j ) const {
453  return ConstIterator( lhs_.upperBound( i, j ), rhs_, i );
454  }
455  //**********************************************************************************************
456 
457  //**Left operand access*************************************************************************
462  inline LeftOperand leftOperand() const noexcept {
463  return lhs_;
464  }
465  //**********************************************************************************************
466 
467  //**Right operand access************************************************************************
472  inline RightOperand rightOperand() const noexcept {
473  return rhs_;
474  }
475  //**********************************************************************************************
476 
477  //**********************************************************************************************
483  template< typename T >
484  inline bool canAlias( const T* alias ) const noexcept {
485  return ( lhs_.canAlias( alias ) || rhs_.canAlias( alias ) );
486  }
487  //**********************************************************************************************
488 
489  //**********************************************************************************************
495  template< typename T >
496  inline bool isAliased( const T* alias ) const noexcept {
497  return ( lhs_.isAliased( alias ) || rhs_.isAliased( alias ) );
498  }
499  //**********************************************************************************************
500 
501  private:
502  //**Member variables****************************************************************************
505  //**********************************************************************************************
506 
507  //**Assignment to dense matrices****************************************************************
519  template< typename MT // Type of the target dense matrix
520  , bool SO2 > // Storage order of the target dense matrix
521  friend inline EnableIf_< UseAssign<MT> >
522  assign( DenseMatrix<MT,SO2>& lhs, const SMatDMatSchurExpr& rhs )
523  {
525 
526  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
527  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
528 
530 
531  CT1 A( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse matrix operand
532  CT2 B( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense matrix operand
533 
534  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.lhs_.rows() , "Invalid number of rows" );
535  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.lhs_.columns(), "Invalid number of columns" );
536  BLAZE_INTERNAL_ASSERT( B.rows() == rhs.rhs_.rows() , "Invalid number of rows" );
537  BLAZE_INTERNAL_ASSERT( B.columns() == rhs.rhs_.columns(), "Invalid number of columns" );
538  BLAZE_INTERNAL_ASSERT( A.rows() == (~lhs).rows() , "Invalid number of rows" );
539  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).columns() , "Invalid number of columns" );
540 
541  for( size_t i=0UL; i<(~lhs).rows(); ++i ) {
542  for( ConstIterator element=A.begin(i); element!=A.end(i); ++element )
543  (~lhs)(i,element->index()) = element->value() * B(i,element->index());
544  }
545  }
547  //**********************************************************************************************
548 
549  //**Assignment to row-major sparse matrices*****************************************************
561  template< typename MT > // Type of the target sparse matrix
562  friend inline EnableIf_< UseAssign<MT> >
563  assign( SparseMatrix<MT,false>& lhs, const SMatDMatSchurExpr& rhs )
564  {
566 
567  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
568  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
569 
571 
572  CT1 A( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse matrix operand
573  CT2 B( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense matrix operand
574 
575  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.lhs_.rows() , "Invalid number of rows" );
576  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.lhs_.columns(), "Invalid number of columns" );
577  BLAZE_INTERNAL_ASSERT( B.rows() == rhs.rhs_.rows() , "Invalid number of rows" );
578  BLAZE_INTERNAL_ASSERT( B.columns() == rhs.rhs_.columns(), "Invalid number of columns" );
579  BLAZE_INTERNAL_ASSERT( A.rows() == (~lhs).rows() , "Invalid number of rows" );
580  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).columns() , "Invalid number of columns" );
581 
582  // Final memory allocation (based on the evaluated operands)
583  (~lhs).reserve( A.nonZeros() );
584 
585  // Performing the Schur product
586  for( size_t i=0UL; i<(~lhs).rows(); ++i ) {
587  for( ConstIterator element=A.begin(i); element!=A.end(i); ++element )
588  (~lhs).append( i, element->index(), element->value() * B(i,element->index()) );
589  (~lhs).finalize( i );
590  }
591  }
593  //**********************************************************************************************
594 
595  //**Assignment to column-major sparse matrices**************************************************
608  template< typename MT > // Type of the target sparse matrix
609  friend inline EnableIf_< UseAssign<MT> >
610  assign( SparseMatrix<MT,true>& lhs, const SMatDMatSchurExpr& rhs )
611  {
613 
614  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
615  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
616 
618 
619  CT1 A( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse matrix operand
620  CT2 B( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense matrix operand
621 
622  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.lhs_.rows() , "Invalid number of rows" );
623  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.lhs_.columns(), "Invalid number of columns" );
624  BLAZE_INTERNAL_ASSERT( B.rows() == rhs.rhs_.rows() , "Invalid number of rows" );
625  BLAZE_INTERNAL_ASSERT( B.columns() == rhs.rhs_.columns(), "Invalid number of columns" );
626  BLAZE_INTERNAL_ASSERT( A.rows() == (~lhs).rows() , "Invalid number of rows" );
627  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).columns() , "Invalid number of columns" );
628 
629  const size_t m( rhs.rows() );
630  const size_t n( rhs.columns() );
631 
632  // Counting the number of elements per column
633  std::vector<size_t> nonzeros( n, 0UL );
634  for( size_t i=0UL; i<m; ++i ) {
635  const ConstIterator lend( A.end(i) );
636  for( ConstIterator l=A.begin(i); l!=lend; ++l ) {
637  ++nonzeros[l->index()];
638  }
639  }
640 
641  // Resizing the left-hand side sparse matrix
642  for( size_t j=0UL; j<n; ++j ) {
643  (~lhs).reserve( j, nonzeros[j] );
644  }
645 
646  // Performing the Schur product
647  for( size_t i=0UL; i<m; ++i ) {
648  for( ConstIterator element=A.begin(i); element!=A.end(i); ++element )
649  (~lhs).append( i, element->index(), element->value() * B(i,element->index()) );
650  }
651  }
653  //**********************************************************************************************
654 
655  //**Addition assignment to dense matrices*******************************************************
667  template< typename MT // Type of the target dense matrix
668  , bool SO2 > // Storage order of the target dense matrix
669  friend inline EnableIf_< UseAssign<MT> >
670  addAssign( DenseMatrix<MT,SO2>& lhs, const SMatDMatSchurExpr& rhs )
671  {
673 
674  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
675  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
676 
678 
679  CT1 A( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse matrix operand
680  CT2 B( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense matrix operand
681 
682  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.lhs_.rows() , "Invalid number of rows" );
683  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.lhs_.columns(), "Invalid number of columns" );
684  BLAZE_INTERNAL_ASSERT( B.rows() == rhs.rhs_.rows() , "Invalid number of rows" );
685  BLAZE_INTERNAL_ASSERT( B.columns() == rhs.rhs_.columns(), "Invalid number of columns" );
686  BLAZE_INTERNAL_ASSERT( A.rows() == (~lhs).rows() , "Invalid number of rows" );
687  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).columns() , "Invalid number of columns" );
688 
689  for( size_t i=0UL; i<(~lhs).rows(); ++i ) {
690  for( ConstIterator element=A.begin(i); element!=A.end(i); ++element )
691  (~lhs)(i,element->index()) += element->value() * B(i,element->index());
692  }
693  }
695  //**********************************************************************************************
696 
697  //**Addition assignment to sparse matrices******************************************************
698  // No special implementation for the addition assignment to sparse matrices.
699  //**********************************************************************************************
700 
701  //**Subtraction assignment to dense matrices****************************************************
713  template< typename MT // Type of the target dense matrix
714  , bool SO2 > // Storage order of the target dense matrix
715  friend inline EnableIf_< UseAssign<MT> >
716  subAssign( DenseMatrix<MT,SO2>& lhs, const SMatDMatSchurExpr& rhs )
717  {
719 
720  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
721  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
722 
724 
725  CT1 A( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse matrix operand
726  CT2 B( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense matrix operand
727 
728  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.lhs_.rows() , "Invalid number of rows" );
729  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.lhs_.columns(), "Invalid number of columns" );
730  BLAZE_INTERNAL_ASSERT( B.rows() == rhs.rhs_.rows() , "Invalid number of rows" );
731  BLAZE_INTERNAL_ASSERT( B.columns() == rhs.rhs_.columns(), "Invalid number of columns" );
732  BLAZE_INTERNAL_ASSERT( A.rows() == (~lhs).rows() , "Invalid number of rows" );
733  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).columns() , "Invalid number of columns" );
734 
735  for( size_t i=0UL; i<(~lhs).rows(); ++i ) {
736  for( ConstIterator element=A.begin(i); element!=A.end(i); ++element )
737  (~lhs)(i,element->index()) -= element->value() * B(i,element->index());
738  }
739  }
741  //**********************************************************************************************
742 
743  //**Subtraction assignment to sparse matrices***************************************************
744  // No special implementation for the subtraction assignment to sparse matrices.
745  //**********************************************************************************************
746 
747  //**Schur product assignment to dense matrices**************************************************
760  template< typename MT // Type of the target dense matrix
761  , bool SO2 > // Storage order of the target dense matrix
762  friend inline void schurAssign( DenseMatrix<MT,SO2>& lhs, const SMatDMatSchurExpr& rhs )
763  {
765 
766  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
767  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
768 
770 
771  CT1 A( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse matrix operand
772  CT2 B( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense matrix operand
773 
774  BLAZE_INTERNAL_ASSERT( A.rows() == rhs.lhs_.rows() , "Invalid number of rows" );
775  BLAZE_INTERNAL_ASSERT( A.columns() == rhs.lhs_.columns(), "Invalid number of columns" );
776  BLAZE_INTERNAL_ASSERT( B.rows() == rhs.rhs_.rows() , "Invalid number of rows" );
777  BLAZE_INTERNAL_ASSERT( B.columns() == rhs.rhs_.columns(), "Invalid number of columns" );
778  BLAZE_INTERNAL_ASSERT( A.rows() == (~lhs).rows() , "Invalid number of rows" );
779  BLAZE_INTERNAL_ASSERT( A.columns() == (~lhs).columns() , "Invalid number of columns" );
780 
781  for( size_t i=0UL; i<(~lhs).rows(); ++i )
782  {
783  const ConstIterator end( A.end(i) );
784  ConstIterator begin( A.begin(i) );
785  size_t j( 0UL );
786 
787  for( ; begin!=end; ++begin ) {
788  const size_t index( begin->index() );
789  for( ; j<index; ++j )
790  reset( (~lhs)(i,j) );
791  (~lhs)(i,index) *= begin->value() * B(i,index);
792  ++j;
793  }
794 
795  for( ; j<(~lhs).columns(); ++j )
796  reset( (~lhs)(i,j) );
797  }
798  }
800  //**********************************************************************************************
801 
802  //**Schur product assignment to sparse matrices*************************************************
803  // No special implementation for the Schur product assignment to sparse matrices.
804  //**********************************************************************************************
805 
806  //**Multiplication assignment to dense matrices*************************************************
807  // No special implementation for the multiplication assignment to dense matrices.
808  //**********************************************************************************************
809 
810  //**Multiplication assignment to sparse matrices************************************************
811  // No special implementation for the multiplication assignment to sparse matrices.
812  //**********************************************************************************************
813 
814  //**SMP assignment to dense matrices************************************************************
815  // No special implementation for the SMP assignment to dense matrices.
816  //**********************************************************************************************
817 
818  //**SMP assignment to sparse matrices***********************************************************
819  // No special implementation for the SMP assignment to sparse matrices.
820  //**********************************************************************************************
821 
822  //**SMP addition assignment to dense matrices***************************************************
823  // No special implementation for the SMP addition assignment to dense matrices.
824  //**********************************************************************************************
825 
826  //**SMP addition assignment to sparse matrices**************************************************
827  // No special implementation for the SMP addition assignment to sparse matrices.
828  //**********************************************************************************************
829 
830  //**SMP subtraction assignment to dense matrices************************************************
831  // No special implementation for the SMP subtraction assignment to dense matrices.
832  //**********************************************************************************************
833 
834  //**SMP subtraction assignment to sparse matrices***********************************************
835  // No special implementation for the SMP subtraction assignment to sparse matrices.
836  //**********************************************************************************************
837 
838  //**SMP Schur product assignment to dense matrices**********************************************
851  template< typename MT // Type of the target dense matrix
852  , bool SO > // Storage order of the target dense matrix
853  friend inline void smpSchurAssign( DenseMatrix<MT,SO>& lhs, const SMatDMatSchurExpr& rhs )
854  {
856 
857  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
858  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
859 
860  smpSchurAssign( ~lhs, rhs.lhs_ );
861  smpSchurAssign( ~lhs, rhs.rhs_ );
862  }
864  //**********************************************************************************************
865 
866  //**SMP Schur product assignment to sparse matrices*********************************************
867  // No special implementation for the SMP Schur product assignment to sparse matrices.
868  //**********************************************************************************************
869 
870  //**SMP multiplication assignment to dense matrices*********************************************
871  // No special implementation for the SMP multiplication assignment to dense matrices.
872  //**********************************************************************************************
873 
874  //**SMP multiplication assignment to sparse matrices********************************************
875  // No special implementation for the SMP multiplication assignment to sparse matrices.
876  //**********************************************************************************************
877 
878  //**Compile time checks*************************************************************************
885  //**********************************************************************************************
886 };
887 //*************************************************************************************************
888 
889 
890 
891 
892 //=================================================================================================
893 //
894 // GLOBAL BINARY ARITHMETIC OPERATORS
895 //
896 //=================================================================================================
897 
898 //*************************************************************************************************
911 template< typename MT1 // Type of the left-hand side sparse matrix
912  , typename MT2 // Type of the right-hand side dense matrix
915 inline const SMatDMatSchurExpr<MT1,MT2>
916  smatdmatschur( const SparseMatrix<MT1,false>& lhs, const DenseMatrix<MT2,false>& rhs )
917 {
919 
920  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == (~rhs).rows() , "Invalid number of rows" );
921  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == (~rhs).columns(), "Invalid number of columns" );
922 
923  return SMatDMatSchurExpr<MT1,MT2>( ~lhs, ~rhs );
924 }
926 //*************************************************************************************************
927 
928 
929 //*************************************************************************************************
942 template< typename MT1 // Type of the left-hand side sparse matrix
943  , typename MT2 // Type of the right-hand side dense matrix
944  , typename = EnableIf_< Or< And< IsUniLower<MT1>, IsUniUpper<MT2> >
945  , And< IsUniUpper<MT1>, IsUniLower<MT2> > > > >
947  smatdmatschur( const SparseMatrix<MT1,false>& lhs, const DenseMatrix<MT2,false>& rhs )
948 {
950 
951  UNUSED_PARAMETER( rhs );
952 
953  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == (~rhs).rows() , "Invalid number of rows" );
954  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == (~rhs).columns(), "Invalid number of columns" );
955 
956  return IdentityMatrix< MultTrait_< ElementType_<MT1>, ElementType_<MT2> >, false >( (~lhs).rows() );
957 }
959 //*************************************************************************************************
960 
961 
962 //*************************************************************************************************
991 template< typename MT1 // Type of the left-hand side sparse matrix
992  , typename MT2 > // Type of the right-hand side dense matrix
993 inline decltype(auto)
994  operator%( const SparseMatrix<MT1,false>& lhs, const DenseMatrix<MT2,false>& rhs )
995 {
997 
998  if( (~lhs).rows() != (~rhs).rows() || (~lhs).columns() != (~rhs).columns() ) {
999  BLAZE_THROW_INVALID_ARGUMENT( "Matrix sizes do not match" );
1000  }
1001 
1002  return smatdmatschur( ~lhs, ~rhs );
1003 }
1004 //*************************************************************************************************
1005 
1006 
1007 //*************************************************************************************************
1020 template< typename MT1 // Type of the left-hand side sparse matrix
1021  , typename MT2 // Type of the right-hand side dense matrix
1024 inline const SMatDMatSchurExpr<MT1,MT2>
1025  smattdmatschur( const SparseMatrix<MT1,false>& lhs, const DenseMatrix<MT2,true>& rhs )
1026 {
1028 
1029  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == (~rhs).rows() , "Invalid number of rows" );
1030  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == (~rhs).columns(), "Invalid number of columns" );
1031 
1032  return SMatDMatSchurExpr<MT1,MT2>( ~lhs, ~rhs );
1033 }
1035 //*************************************************************************************************
1036 
1037 
1038 //*************************************************************************************************
1051 template< typename MT1 // Type of the left-hand side sparse matrix
1052  , typename MT2 // Type of the right-hand side dense matrix
1056  smattdmatschur( const SparseMatrix<MT1,false>& lhs, const DenseMatrix<MT2,true>& rhs )
1057 {
1059 
1060  UNUSED_PARAMETER( rhs );
1061 
1062  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == (~rhs).rows() , "Invalid number of rows" );
1063  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == (~rhs).columns(), "Invalid number of columns" );
1064 
1066 }
1068 //*************************************************************************************************
1069 
1070 
1071 //*************************************************************************************************
1101 template< typename MT1 // Type of the left-hand side sparse matrix
1102  , typename MT2 > // Type of the right-hand side dense matrix
1103 inline decltype(auto)
1104  operator%( const SparseMatrix<MT1,false>& lhs, const DenseMatrix<MT2,true>& rhs )
1105 {
1107 
1108  if( (~lhs).rows() != (~rhs).rows() || (~lhs).columns() != (~rhs).columns() ) {
1109  BLAZE_THROW_INVALID_ARGUMENT( "Matrix sizes do not match" );
1110  }
1111 
1112  return smattdmatschur( ~lhs, ~rhs );
1113 }
1114 //*************************************************************************************************
1115 
1116 
1117 
1118 
1119 //=================================================================================================
1120 //
1121 // SIZE SPECIALIZATIONS
1122 //
1123 //=================================================================================================
1124 
1125 //*************************************************************************************************
1127 template< typename MT1, typename MT2 >
1128 struct Size< SMatDMatSchurExpr<MT1,MT2>, 0UL >
1129  : public Maximum< Size<MT1,0UL>, Size<MT2,0UL> >
1130 {};
1131 
1132 template< typename MT1, typename MT2 >
1133 struct Size< SMatDMatSchurExpr<MT1,MT2>, 1UL >
1134  : public Maximum< Size<MT1,1UL>, Size<MT2,1UL> >
1135 {};
1137 //*************************************************************************************************
1138 
1139 
1140 
1141 
1142 //=================================================================================================
1143 //
1144 // ISSYMMETRIC SPECIALIZATIONS
1145 //
1146 //=================================================================================================
1147 
1148 //*************************************************************************************************
1150 template< typename MT1, typename MT2 >
1151 struct IsSymmetric< SMatDMatSchurExpr<MT1,MT2> >
1152  : public And< IsSymmetric<MT1>, IsSymmetric<MT2> >
1153 {};
1155 //*************************************************************************************************
1156 
1157 
1158 
1159 
1160 //=================================================================================================
1161 //
1162 // ISHERMITIAN SPECIALIZATIONS
1163 //
1164 //=================================================================================================
1165 
1166 //*************************************************************************************************
1168 template< typename MT1, typename MT2 >
1169 struct IsHermitian< SMatDMatSchurExpr<MT1,MT2> >
1170  : public And< IsHermitian<MT1>, IsHermitian<MT2> >
1171 {};
1173 //*************************************************************************************************
1174 
1175 
1176 
1177 
1178 //=================================================================================================
1179 //
1180 // ISLOWER SPECIALIZATIONS
1181 //
1182 //=================================================================================================
1183 
1184 //*************************************************************************************************
1186 template< typename MT1, typename MT2 >
1187 struct IsLower< SMatDMatSchurExpr<MT1,MT2> >
1188  : public Or< IsLower<MT1>, IsLower<MT2> >
1189 {};
1191 //*************************************************************************************************
1192 
1193 
1194 
1195 
1196 //=================================================================================================
1197 //
1198 // ISUNILOWER SPECIALIZATIONS
1199 //
1200 //=================================================================================================
1201 
1202 //*************************************************************************************************
1204 template< typename MT1, typename MT2 >
1205 struct IsUniLower< SMatDMatSchurExpr<MT1,MT2> >
1206  : public And< IsUniLower<MT1>, IsUniLower<MT2> >
1207 {};
1209 //*************************************************************************************************
1210 
1211 
1212 
1213 
1214 //=================================================================================================
1215 //
1216 // ISSTRICTLYLOWER SPECIALIZATIONS
1217 //
1218 //=================================================================================================
1219 
1220 //*************************************************************************************************
1222 template< typename MT1, typename MT2 >
1223 struct IsStrictlyLower< SMatDMatSchurExpr<MT1,MT2> >
1224  : public Or< IsStrictlyLower<MT1>, IsStrictlyLower<MT2> >
1225 {};
1227 //*************************************************************************************************
1228 
1229 
1230 
1231 
1232 //=================================================================================================
1233 //
1234 // ISUPPER SPECIALIZATIONS
1235 //
1236 //=================================================================================================
1237 
1238 //*************************************************************************************************
1240 template< typename MT1, typename MT2 >
1241 struct IsUpper< SMatDMatSchurExpr<MT1,MT2> >
1242  : public Or< IsUpper<MT1>, IsUpper<MT2> >
1243 {};
1245 //*************************************************************************************************
1246 
1247 
1248 
1249 
1250 //=================================================================================================
1251 //
1252 // ISUNIUPPER SPECIALIZATIONS
1253 //
1254 //=================================================================================================
1255 
1256 //*************************************************************************************************
1258 template< typename MT1, typename MT2 >
1259 struct IsUniUpper< SMatDMatSchurExpr<MT1,MT2> >
1260  : public And< IsUniUpper<MT1>, IsUniUpper<MT2> >
1261 {};
1263 //*************************************************************************************************
1264 
1265 
1266 
1267 
1268 //=================================================================================================
1269 //
1270 // ISSTRICTLYUPPER SPECIALIZATIONS
1271 //
1272 //=================================================================================================
1273 
1274 //*************************************************************************************************
1276 template< typename MT1, typename MT2 >
1277 struct IsStrictlyUpper< SMatDMatSchurExpr<MT1,MT2> >
1278  : public Or< IsStrictlyUpper<MT1>, IsStrictlyUpper<MT2> >
1279 {};
1281 //*************************************************************************************************
1282 
1283 } // namespace blaze
1284 
1285 #endif
LeftOperand leftOperand() const noexcept
Returns the left-hand side sparse matrix operand.
Definition: SMatDMatSchurExpr.h:462
ElementType_< ResultType > ElementType
Resulting element type.
Definition: SMatDMatSchurExpr.h:153
#define BLAZE_THROW_INVALID_ARGUMENT(MESSAGE)
Macro for the emission of a std::invalid_argument exception.This macro encapsulates the default way o...
Definition: Exception.h:235
Pointer difference type of the Blaze library.
RightOperand rightOperand() const noexcept
Returns the right-hand side dense matrix operand.
Definition: SMatDMatSchurExpr.h:472
Header file for auxiliary alias declarations.
size_t rows() const noexcept
Returns the current number of rows of the matrix.
Definition: SMatDMatSchurExpr.h:382
Header file for the Schur product trait.
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 the UNUSED_PARAMETER function template.
Header file for the IsUniUpper type trait.
EnableIf_< IsDenseMatrix< MT1 > > smpSchurAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the SMP Schur product assignment of a matrix to dense matrix.
Definition: DenseMatrix.h:196
ResultType_< MT2 > RT2
Result type of the right-hand side dense matrix expression.
Definition: SMatDMatSchurExpr.h:108
ConstIterator find(size_t i, size_t j) const
Searches for a specific matrix element.
Definition: SMatDMatSchurExpr.h:425
Header file for basic type definitions.
bool operator!=(const ConstIterator &rhs) const
Inequality comparison between two ConstIterator objects.
Definition: SMatDMatSchurExpr.h:277
Header file for the serial shim.
ReturnType at(size_t i, size_t j) const
Checked access to the matrix elements.
Definition: SMatDMatSchurExpr.h:344
size_t columns() const noexcept
Returns the current number of columns of the matrix.
Definition: SMatDMatSchurExpr.h:392
#define BLAZE_CONSTRAINT_MUST_BE_DENSE_MATRIX_TYPE(T)
Constraint on the data type.In case the given data type T is not a dense, N-dimensional matrix type...
Definition: DenseMatrix.h:61
DifferenceType operator-(const ConstIterator &rhs) const
Calculating the number of elements between two expression iterators.
Definition: SMatDMatSchurExpr.h:288
bool operator==(const ConstIterator &rhs) const
Equality comparison between two ConstIterator objects.
Definition: SMatDMatSchurExpr.h:266
SMatDMatSchurExpr(const MT1 &lhs, const MT2 &rhs) noexcept
Constructor for the SMatDMatSchurExpr class.
Definition: SMatDMatSchurExpr.h:313
ResultType_< MT1 > RT1
Result type of the left-hand side sparse matrix expression.
Definition: SMatDMatSchurExpr.h:107
void reset(const DiagonalProxy< MT > &proxy)
Resetting the represented element to the default initial values.
Definition: DiagonalProxy.h:588
typename DisableIf< Condition, T >::Type DisableIf_
Auxiliary type for the DisableIf class template.The DisableIf_ alias declaration provides a convenien...
Definition: DisableIf.h:224
CompositeType_< MT1 > CT1
Composite type of the left-hand side sparse matrix expression.
Definition: SMatDMatSchurExpr.h:111
Header file for the And class template.
Compile time value evaluation.The Maximum alias declaration selects the larger of the two given templ...
Definition: Maximum.h:73
Compile time check for lower triangular matrices.This type trait tests whether or not the given templ...
Definition: IsLower.h:87
Header file for the Computation base class.
ConstIterator_< RemoveReference_< LeftOperand > > LeftIterator
Iterator type of the sparse matrix expression.
Definition: SMatDMatSchurExpr.h:179
Compile time check for upper triangular matrices.This type trait tests whether or not the given templ...
Definition: IsUpper.h:87
Constraints on the storage order of matrix types.
Header file for the IsUniLower type trait.
typename T::ResultType ResultType_
Alias declaration for nested ResultType type definitions.The ResultType_ alias declaration provides a...
Definition: Aliases.h:343
size_t index() const
Access to the current index of the sparse element.
Definition: SMatDMatSchurExpr.h:255
#define BLAZE_CONSTRAINT_MUST_FORM_VALID_SCHUREXPR(T1, T2)
Constraint on the data type.In case the given data types T1 and T2 do not form a valid matrix/matrix ...
Definition: SchurExpr.h:107
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:80
Base class for sparse matrices.The SparseMatrix class is a base class for all sparse matrix classes...
Definition: Forward.h:129
Header file for all forward declarations for sparse vectors and matrices.
RightOperand rhs_
Right-hand side dense matrix of the Schur product expression.
Definition: SMatDMatSchurExpr.h:504
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
typename T::ReturnType ReturnType_
Alias declaration for nested ReturnType type definitions.The ReturnType_ alias declaration provides a...
Definition: Aliases.h:363
MultExprTrait_< RN1, RN2 > ExprReturnType
Expression return type for the subscript operator.
Definition: SMatDMatSchurExpr.h:125
Header file for the SparseMatrix base class.
LeftIterator left_
Iterator over the elements of the left-hand side sparse matrix expression.
Definition: SMatDMatSchurExpr.h:295
If_< IsExpression< MT1 >, const MT1, const MT1 &> LeftOperand
Composite type of the left-hand side sparse matrix expression.
Definition: SMatDMatSchurExpr.h:162
Constraint on the data type.
Constraint on the data type.
Header file for the Maximum class template.
typename MultExprTrait< T1, T2 >::Type MultExprTrait_
Auxiliary alias declaration for the MultExprTrait class template.The MultExprTrait_ alias declaration...
Definition: MultExprTrait.h:112
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:71
typename T::CompositeType CompositeType_
Alias declaration for nested CompositeType type definitions.The CompositeType_ alias declaration prov...
Definition: Aliases.h:83
Compile time check for upper unitriangular matrices.This type trait tests whether or not the given te...
Definition: IsUniUpper.h:86
Header file for the ValueIndexPair class.
Efficient implementation of an identity matrix.The IdentityMatrix class template is the representati...
Definition: Forward.h:49
Header file for the DisableIf class template.
Header file for the IsTemporary type trait class.
size_t row_
The row index of the iterator.
Definition: SMatDMatSchurExpr.h:297
Header file for the multiplication trait.
Header file for the IsStrictlyUpper type trait.
Header file for the IsSymmetric type trait.
ReturnType value() const
Access to the current value of the sparse element.
Definition: SMatDMatSchurExpr.h:245
Namespace of the Blaze C++ math library.
Definition: Blaze.h:58
std::forward_iterator_tag IteratorCategory
The iterator category.
Definition: SMatDMatSchurExpr.h:181
Header file for the If class template.
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
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
Header file for the IsLower type trait.
ConstIterator upperBound(size_t i, size_t j) const
Returns an iterator to the first index greater then the given index.
Definition: SMatDMatSchurExpr.h:451
typename SchurTrait< T1, T2 >::Type SchurTrait_
Auxiliary alias declaration for the SchurTrait class template.The SchurTrait_ alias declaration provi...
Definition: SchurTrait.h:208
LeftOperand lhs_
Left-hand side sparse matrix of the Schur product expression.
Definition: SMatDMatSchurExpr.h:503
bool isAliased(const T *alias) const noexcept
Returns whether the expression is aliased with the given address alias.
Definition: SMatDMatSchurExpr.h:496
Compile time check for symmetric matrices.This type trait tests whether or not the given template par...
Definition: IsSymmetric.h:85
Header file for the exception macros of the math module.
Compile time check for strictly upper triangular matrices.This type trait tests whether or not the gi...
Definition: IsStrictlyUpper.h:86
RightOperand right_
Right-hand side dense matrix expression.
Definition: SMatDMatSchurExpr.h:296
Constraint on the data type.
Header file for all forward declarations for expression class templates.
Header file for the EnableIf class template.
Header file for the IsStrictlyLower type trait.
Compile time check for lower unitriangular matrices.This type trait tests whether or not the given te...
Definition: IsUniLower.h:86
If_< IsExpression< MT2 >, const MT2, const MT2 &> RightOperand
Composite type of the right-hand side dense matrix expression.
Definition: SMatDMatSchurExpr.h:165
const ConstIterator * operator->() const
Direct access to the sparse matrix element at the current iterator position.
Definition: SMatDMatSchurExpr.h:235
CompositeType_< MT2 > CT2
Composite type of the right-hand side dense matrix expression.
Definition: SMatDMatSchurExpr.h:112
#define BLAZE_CONSTRAINT_MUST_BE_ROW_MAJOR_MATRIX_TYPE(T)
Constraint on the data type.In case the given data type T is not a row-major dense or sparse matrix t...
Definition: RowMajorMatrix.h:61
size_t nonZeros() const
Returns the number of non-zero elements in the sparse matrix.
Definition: SMatDMatSchurExpr.h:402
Header file for run time assertion macros.
ConstIterator(LeftIterator left, RightOperand right, size_t row)
Constructor for the ConstIterator class.
Definition: SMatDMatSchurExpr.h:202
Header file for the SchurExpr base class.
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
OppositeType_< ResultType > OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: SMatDMatSchurExpr.h:151
decltype(auto) row(Matrix< MT, SO > &, RRAs...)
Creating a view on a specific row of the given matrix.
Definition: Row.h:131
ConstIterator end(size_t i) const
Returns an iterator just past the last non-zero element of row i.
Definition: SMatDMatSchurExpr.h:372
ReturnType_< MT1 > RN1
Return type of the left-hand side sparse matrix expression.
Definition: SMatDMatSchurExpr.h:109
ReturnType_< MT2 > RN2
Return type of the right-hand side dense matrix expression.
Definition: SMatDMatSchurExpr.h:110
#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
TransposeType_< ResultType > TransposeType
Transpose type for expression template evaluations.
Definition: SMatDMatSchurExpr.h:152
const IfTrue_< returnExpr, ExprReturnType, ElementType > ReturnType
Return type for expression template evaluations.
Definition: SMatDMatSchurExpr.h:156
Compile time check for Hermitian matrices.This type trait tests whether or not the given template par...
Definition: IsHermitian.h:85
ConstIterator & operator++()
Pre-increment operator.
Definition: SMatDMatSchurExpr.h:214
decltype(auto) serial(const DenseMatrix< MT, SO > &dm)
Forces the serial evaluation of the given dense matrix expression dm.
Definition: DMatSerialExpr.h:816
const Element operator*() const
Direct access to the sparse matrix element at the current iterator position.
Definition: SMatDMatSchurExpr.h:225
#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
typename EnableIf< Condition, T >::Type EnableIf_
Auxiliary alias declaration for the EnableIf class template.The EnableIf_ alias declaration provides ...
Definition: EnableIf.h:224
typename T::OppositeType OppositeType_
Alias declaration for nested OppositeType type definitions.The OppositeType_ alias declaration provid...
Definition: Aliases.h:263
IfTrue_< useAssign, const ResultType, const SMatDMatSchurExpr &> CompositeType
Data type for composite expression templates.
Definition: SMatDMatSchurExpr.h:159
Compile time check for strictly lower triangular matrices.This type trait tests whether or not the gi...
Definition: IsStrictlyLower.h:86
typename T::ConstIterator ConstIterator_
Alias declaration for nested ConstIterator type definitions.The ConstIterator_ alias declaration prov...
Definition: Aliases.h:103
Iterator over the elements of the sparse matrix/dense matrix Schur product expression.
Definition: SMatDMatSchurExpr.h:171
Index-value-pair for sparse vectors and matrices.The ValueIndexPair class represents a single index-v...
Definition: ValueIndexPair.h:73
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
size_t nonZeros(size_t i) const
Returns the number of non-zero elements in the specified row.
Definition: SMatDMatSchurExpr.h:413
bool canAlias(const T *alias) const noexcept
Returns whether the expression can alias with the given address alias.
Definition: SMatDMatSchurExpr.h:484
Compile time logical &#39;and&#39; evaluation.The And alias declaration performs at compile time a logical &#39;a...
Definition: And.h:76
typename T::TransposeType TransposeType_
Alias declaration for nested TransposeType type definitions.The TransposeType_ alias declaration prov...
Definition: Aliases.h:423
Header file for the IsUpper type trait.
void UNUSED_PARAMETER(const Args &...)
Suppression of unused parameter warnings.
Definition: Unused.h:81
Header file for the IsHermitian type trait.
Header file for the Size type trait.
IteratorCategory iterator_category
The iterator category.
Definition: SMatDMatSchurExpr.h:188
Expression object for sparse matrix-dense matrix Schur product.The SMatDMatSchurExpr class represents...
Definition: Forward.h:108
ConstIterator begin(size_t i) const
Returns an iterator to the first non-zero element of row i.
Definition: SMatDMatSchurExpr.h:361
SchurTrait_< RT1, RT2 > ResultType
Result type for expression template evaluations.
Definition: SMatDMatSchurExpr.h:150
#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
ReturnType operator()(size_t i, size_t j) const
2D-access to the matrix elements.
Definition: SMatDMatSchurExpr.h:329
#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 function trace functionality.
Constraint on the data type.
ConstIterator lowerBound(size_t i, size_t j) const
Returns an iterator to the first index not less then the given index.
Definition: SMatDMatSchurExpr.h:438