All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
DVecSVecSubExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_DVECSVECSUBEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_DVECSVECSUBEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <stdexcept>
64 #include <blaze/util/Assert.h>
67 #include <blaze/util/SelectType.h>
68 #include <blaze/util/Types.h>
69 
70 
71 namespace blaze {
72 
73 //=================================================================================================
74 //
75 // CLASS DVECSVECSUBEXPR
76 //
77 //=================================================================================================
78 
79 //*************************************************************************************************
86 template< typename VT1 // Type of the left-hand side dense vector
87  , typename VT2 // Type of the right-hand side sparse vector
88  , bool TF > // Transpose flag
89 class DVecSVecSubExpr : public DenseVector< DVecSVecSubExpr<VT1,VT2,TF>, TF >
90  , private VecVecSubExpr
91  , private Computation
92 {
93  private:
94  //**Type definitions****************************************************************************
95  typedef typename VT1::ResultType RT1;
96  typedef typename VT2::ResultType RT2;
97  typedef typename VT1::ReturnType RN1;
98  typedef typename VT2::ReturnType RN2;
99  typedef typename VT1::CompositeType CT1;
100  typedef typename VT2::CompositeType CT2;
101  typedef typename VT1::TransposeType TT1;
102  typedef typename VT2::TransposeType TT2;
103  //**********************************************************************************************
104 
105  //**Return type evaluation**********************************************************************
107 
112  enum { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value };
113 
116  //**********************************************************************************************
117 
118  public:
119  //**Type definitions****************************************************************************
124 
127 
129  typedef const ResultType CompositeType;
130 
132  typedef typename SelectType< IsExpression<VT1>::value, const VT1, const VT1& >::Type LeftOperand;
133 
135  typedef typename SelectType< IsExpression<VT2>::value, const VT2, const VT2& >::Type RightOperand;
136  //**********************************************************************************************
137 
138  //**Compilation flags***************************************************************************
140  enum { vectorizable = 0 };
141 
143  enum { smpAssignable = 0 };
144  //**********************************************************************************************
145 
146  //**Constructor*********************************************************************************
152  explicit inline DVecSVecSubExpr( const VT1& lhs, const VT2& rhs )
153  : lhs_( lhs ) // Left-hand side dense vector of the subtraction expression
154  , rhs_( rhs ) // Right-hand side sparse vector of the subtraction expression
155  {
156  BLAZE_INTERNAL_ASSERT( lhs.size() == rhs.size(), "Invalid vector sizes" );
157  }
158  //**********************************************************************************************
159 
160  //**Subscript operator**************************************************************************
166  inline ReturnType operator[]( size_t index ) const {
167  BLAZE_INTERNAL_ASSERT( index < lhs_.size(), "Invalid vector access index" );
168  return lhs_[index] - rhs_[index];
169  }
170  //**********************************************************************************************
171 
172  //**Size function*******************************************************************************
177  inline size_t size() const {
178  return lhs_.size();
179  }
180  //**********************************************************************************************
181 
182  //**Left operand access*************************************************************************
187  inline LeftOperand leftOperand() const {
188  return lhs_;
189  }
190  //**********************************************************************************************
191 
192  //**Right operand access************************************************************************
197  inline RightOperand rightOperand() const {
198  return rhs_;
199  }
200  //**********************************************************************************************
201 
202  //**********************************************************************************************
208  template< typename T >
209  inline bool canAlias( const T* alias ) const {
210  return ( IsComputation<VT1>::value && lhs_.canAlias( alias ) ) ||
211  ( rhs_.canAlias( alias ) );
212  }
213  //**********************************************************************************************
214 
215  //**********************************************************************************************
221  template< typename T >
222  inline bool isAliased( const T* alias ) const {
223  return ( lhs_.isAliased( alias ) || rhs_.isAliased( alias ) );
224  }
225  //**********************************************************************************************
226 
227  private:
228  //**Member variables****************************************************************************
231  //**********************************************************************************************
232 
233  //**Assignment to dense vectors*****************************************************************
245  template< typename VT > // Type of the target dense vector
246  friend inline void assign( DenseVector<VT,TF>& lhs, const DVecSVecSubExpr& rhs )
247  {
249 
250  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
251 
252  if( !IsComputation<VT1>::value && (~lhs).isAliased( &rhs.lhs_ ) ) {
253  smpSubAssign( ~lhs, rhs.rhs_ );
254  }
255  else {
256  smpAssign ( ~lhs, rhs.lhs_ );
257  smpSubAssign( ~lhs, rhs.rhs_ );
258  }
259  }
261  //**********************************************************************************************
262 
263  //**Assignment to sparse vectors****************************************************************
275  template< typename VT > // Type of the target sparse vector
276  friend inline void assign( SparseVector<VT,TF>& lhs, const DVecSVecSubExpr& rhs )
277  {
279 
283 
284  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
285 
286  const ResultType tmp( rhs );
287  smpAssign( ~lhs, tmp );
288  }
290  //**********************************************************************************************
291 
292  //**Addition assignment to dense vectors********************************************************
304  template< typename VT > // Type of the target dense vector
305  friend inline void addAssign( DenseVector<VT,TF>& lhs, const DVecSVecSubExpr& rhs )
306  {
308 
309  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
310 
311  smpAddAssign( ~lhs, rhs.lhs_ );
312  smpSubAssign( ~lhs, rhs.rhs_ );
313  }
315  //**********************************************************************************************
316 
317  //**Addition assignment to sparse vectors*******************************************************
318  // No special implementation for the addition assignment to sparse vectors.
319  //**********************************************************************************************
320 
321  //**Subtraction assignment to dense vectors*****************************************************
333  template< typename VT > // Type of the target dense vector
334  friend inline void subAssign( DenseVector<VT,TF>& lhs, const DVecSVecSubExpr& rhs )
335  {
337 
338  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
339 
340  smpSubAssign( ~lhs, rhs.lhs_ );
341  smpAddAssign( ~lhs, rhs.rhs_ );
342  }
344  //**********************************************************************************************
345 
346  //**Subtraction assignment to sparse vectors****************************************************
347  // No special implementation for the subtraction assignment to sparse vectors.
348  //**********************************************************************************************
349 
350  //**Multiplication assignment to dense vectors**************************************************
362  template< typename VT > // Type of the target dense vector
363  friend inline void multAssign( DenseVector<VT,TF>& lhs, const DVecSVecSubExpr& rhs )
364  {
366 
370 
371  BLAZE_INTERNAL_ASSERT( (~lhs).size() == rhs.size(), "Invalid vector sizes" );
372 
373  const ResultType tmp( rhs );
374  smpMultAssign( ~lhs, tmp );
375  }
377  //**********************************************************************************************
378 
379  //**Multiplication assignment to sparse vectors*************************************************
380  // No special implementation for the multiplication assignment to sparse vectors.
381  //**********************************************************************************************
382 
383  //**Compile time checks*************************************************************************
390  //**********************************************************************************************
391 };
392 //*************************************************************************************************
393 
394 
395 
396 
397 //=================================================================================================
398 //
399 // GLOBAL BINARY ARITHMETIC OPERATORS
400 //
401 //=================================================================================================
402 
403 //*************************************************************************************************
429 template< typename T1 // Type of the left-hand side dense vector
430  , typename T2 // Type of the right-hand side sparse vector
431  , bool TF > // Transpose flag
432 inline const DVecSVecSubExpr<T1,T2,TF>
434 {
436 
437  if( (~lhs).size() != (~rhs).size() )
438  throw std::invalid_argument( "Vector sizes do not match" );
439 
440  return DVecSVecSubExpr<T1,T2,TF>( ~lhs, ~rhs );
441 }
442 //*************************************************************************************************
443 
444 
445 
446 
447 //=================================================================================================
448 //
449 // GLOBAL RESTRUCTURING BINARY ARITHMETIC OPERATORS
450 //
451 //=================================================================================================
452 
453 //*************************************************************************************************
466 template< typename T1 // Type of the dense vector of the left-hand side expression
467  , typename T2 // Type of the sparse vector of the left-hand side expression
468  , bool TF // Transpose flag of the left-hand side expression
469  , typename T3 > // Type of the right-hand side dense vector
470 inline const typename AddExprTrait< DVecSVecSubExpr<T1,T2,TF>, T3 >::Type
471  operator+( const DVecSVecSubExpr<T1,T2,TF>& lhs, const DenseVector<T3,TF>& rhs )
472 {
474 
475  return ( lhs.leftOperand() + (~rhs) ) - lhs.rightOperand();
476 }
478 //*************************************************************************************************
479 
480 
481 //*************************************************************************************************
494 template< typename T1 // Type of the dense vector of the left-hand side expression
495  , typename T2 // Type of the sparse vector of the left-hand side expression
496  , bool TF // Transpose flag of the left-hand side expression
497  , typename T3 > // Type of the right-hand side dense vector
498 inline const typename SubExprTrait< DVecSVecSubExpr<T1,T2,TF>, T3 >::Type
499  operator-( const DVecSVecSubExpr<T1,T2,TF>& lhs, const DenseVector<T3,TF>& rhs )
500 {
502 
503  return ( lhs.leftOperand() - (~rhs) ) - lhs.rightOperand();
504 }
506 //*************************************************************************************************
507 
508 
509 
510 
511 //=================================================================================================
512 //
513 // EXPRESSION TRAIT SPECIALIZATIONS
514 //
515 //=================================================================================================
516 
517 //*************************************************************************************************
519 template< typename VT1, typename VT2, typename VT3 >
520 struct DVecDVecAddExprTrait< DVecSVecSubExpr<VT1,VT2,false>, VT3 >
521 {
522  public:
523  //**********************************************************************************************
525  typedef typename SelectType< IsDenseVector<VT1>::value && IsColumnVector<VT1>::value &&
526  IsSparseVector<VT2>::value && IsColumnVector<VT2>::value &&
527  IsDenseVector<VT3>::value && IsColumnVector<VT3>::value
528  , typename DVecSVecSubExprTrait< typename DVecDVecAddExprTrait<VT1,VT3>::Type, VT2 >::Type
529  , INVALID_TYPE >::Type Type;
531  //**********************************************************************************************
532 };
534 //*************************************************************************************************
535 
536 
537 //*************************************************************************************************
539 template< typename VT1, typename VT2, typename VT3 >
540 struct TDVecTDVecAddExprTrait< DVecSVecSubExpr<VT1,VT2,true>, VT3 >
541 {
542  public:
543  //**********************************************************************************************
545  typedef typename SelectType< IsDenseVector<VT1>::value && IsRowVector<VT1>::value &&
546  IsSparseVector<VT2>::value && IsRowVector<VT2>::value &&
547  IsDenseVector<VT3>::value && IsRowVector<VT3>::value
548  , typename TDVecTSVecSubExprTrait< typename TDVecTDVecAddExprTrait<VT1,VT3>::Type, VT2 >::Type
549  , INVALID_TYPE >::Type Type;
551  //**********************************************************************************************
552 };
554 //*************************************************************************************************
555 
556 
557 //*************************************************************************************************
559 template< typename VT1, typename VT2, typename VT3 >
560 struct DVecDVecSubExprTrait< DVecSVecSubExpr<VT1,VT2,false>, VT3 >
561 {
562  public:
563  //**********************************************************************************************
565  typedef typename SelectType< IsDenseVector<VT1>::value && IsColumnVector<VT1>::value &&
566  IsSparseVector<VT2>::value && IsColumnVector<VT2>::value &&
567  IsDenseVector<VT3>::value && IsColumnVector<VT3>::value
568  , typename DVecSVecSubExprTrait< typename DVecDVecSubExprTrait<VT1,VT3>::Type, VT2 >::Type
569  , INVALID_TYPE >::Type Type;
571  //**********************************************************************************************
572 };
574 //*************************************************************************************************
575 
576 
577 //*************************************************************************************************
579 template< typename VT1, typename VT2, typename VT3 >
580 struct TDVecTDVecSubExprTrait< DVecSVecSubExpr<VT1,VT2,true>, VT3 >
581 {
582  public:
583  //**********************************************************************************************
585  typedef typename SelectType< IsDenseVector<VT1>::value && IsRowVector<VT1>::value &&
586  IsSparseVector<VT2>::value && IsRowVector<VT2>::value &&
587  IsDenseVector<VT3>::value && IsRowVector<VT3>::value
588  , typename TDVecTSVecSubExprTrait< typename TDVecTDVecSubExprTrait<VT1,VT3>::Type, VT2 >::Type
589  , INVALID_TYPE >::Type Type;
591  //**********************************************************************************************
592 };
594 //*************************************************************************************************
595 
596 
597 //*************************************************************************************************
599 template< typename VT1, typename VT2, bool TF, bool AF >
600 struct SubvectorExprTrait< DVecSVecSubExpr<VT1,VT2,TF>, AF >
601 {
602  public:
603  //**********************************************************************************************
604  typedef typename SubExprTrait< typename SubvectorExprTrait<const VT1,AF>::Type
605  , typename SubvectorExprTrait<const VT2,AF>::Type >::Type Type;
606  //**********************************************************************************************
607 };
609 //*************************************************************************************************
610 
611 } // namespace blaze
612 
613 #endif
ResultType::ElementType ElementType
Resulting element type.
Definition: DVecSVecSubExpr.h:123
Compile time check whether the given type is a computational expression template.This type trait clas...
Definition: IsComputation.h:89
VT2::ReturnType RN2
Return type of the right-hand side sparse vector expression.
Definition: DVecSVecSubExpr.h:98
Compile time check whether the given type is a temporary vector or matrix type.This type trait class ...
Definition: IsTemporary.h:87
Header file for the subtraction trait.
VT1::ResultType RT1
Result type of the left-hand side dense vector expression.
Definition: DVecSVecSubExpr.h:95
RightOperand rightOperand() const
Returns the right-hand side sparse vector operand.
Definition: DVecSVecSubExpr.h:197
void smpSubAssign(DenseMatrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the SMP subtraction assignment of a matrix to dense matrix.
Definition: DenseMatrix.h:151
Efficient implementation of a compressed matrix.The CompressedMatrix class template is the represent...
Definition: CompressedMatrix.h:197
void smpMultAssign(DenseVector< 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:178
RightOperand rhs_
Right-hand side sparse vector of the subtraction expression.
Definition: DVecSVecSubExpr.h:230
const SelectType< returnExpr, ExprReturnType, ElementType >::Type ReturnType
Return type for expression template evaluations.
Definition: DVecSVecSubExpr.h:126
const This & CompositeType
Data type for composite expression templates.
Definition: CompressedMatrix.h:2384
Header file for the IsRowVector type trait.
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:249
Header file for the DenseVector base class.
Header file for the AddExprTrait class template.
DVecSVecSubExpr< VT1, VT2, TF > This
Type of this DVecSVecSubExpr instance.
Definition: DVecSVecSubExpr.h:120
SubTrait< RT1, RT2 >::Type ResultType
Result type for expression template evaluations.
Definition: DVecSVecSubExpr.h:121
Header file for the Computation base class.
Constraint on the data type.
Expression object for dense vector-sparse vector subtractions.The DVecSVecSubExpr class represents th...
Definition: DVecSVecSubExpr.h:89
void smpAddAssign(DenseMatrix< 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:121
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: DVecSVecSubExpr.h:209
const This & CompositeType
Data type for composite expression templates.
Definition: CompressedMatrix.h:251
Compile time type selection.The SelectType class template selects one of the two given types T1 and T...
Definition: SelectType.h:59
Header file for the IsTemporary type trait class.
Header file for the dense vector SMP implementation.
const ResultType CompositeType
Data type for composite expression templates.
Definition: DVecSVecSubExpr.h:129
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: DVecSVecSubExpr.h:122
VT2::TransposeType TT2
Transpose type of the right-hand side sparse vector expression.
Definition: DVecSVecSubExpr.h:102
void assign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the assignment of a matrix to a matrix.
Definition: Matrix.h:179
const DenseIterator< Type > operator+(const DenseIterator< Type > &it, ptrdiff_t inc)
Addition between a DenseIterator and an integral value.
Definition: DenseIterator.h:556
Base class for N-dimensional dense vectors.The DenseVector class is a base class for all arbitrarily ...
Definition: DenseVector.h:70
#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:79
Constraint on the data type.
#define BLAZE_CONSTRAINT_MUST_BE_REFERENCE_TYPE(T)
Constraint on the data type.In case the given data type T is not a reference type, a compilation error is created.
Definition: Reference.h:78
CompressedMatrix< Type, false > TransposeType
Transpose type for expression template evaluations.
Definition: CompressedMatrix.h:2381
Constraint on the data type.
Evaluation of the return type of a subtraction expression.Via this type trait it is possible to evalu...
Definition: SubExprTrait.h:103
SubExprTrait< RN1, RN2 >::Type ExprReturnType
Expression return type for the subscript operator.
Definition: DVecSVecSubExpr.h:115
VT2::CompositeType CT2
Composite type of the right-hand side sparse vector expression.
Definition: DVecSVecSubExpr.h:100
void multAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the multiplication assignment of a matrix to a matrix.
Definition: Matrix.h:269
Header file for the VecVecSubExpr base class.
Header file for the SelectType class template.
Header file for all forward declarations for expression class templates.
Constraint on the data type.
LeftOperand leftOperand() const
Returns the left-hand side dense vector operand.
Definition: DVecSVecSubExpr.h:187
VT1::TransposeType TT1
Transpose type of the left-hand side dense vector expression.
Definition: DVecSVecSubExpr.h:101
void smpAssign(DenseMatrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the SMP assignment of a matrix to a dense matrix.
Definition: DenseMatrix.h:91
DVecSVecSubExpr(const VT1 &lhs, const VT2 &rhs)
Constructor for the DVecSVecSubExpr class.
Definition: DVecSVecSubExpr.h:152
Header file for the IsSparseVector type trait.
const Type & ReturnType
Return type for expression template evaluations.
Definition: CompressedMatrix.h:2383
SelectType< IsExpression< VT2 >::value, const VT2, const VT2 & >::Type RightOperand
Composite type of the right-hand side sparse vector expression.
Definition: DVecSVecSubExpr.h:135
Header file for run time assertion macros.
void addAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the addition assignment of a matrix to a matrix.
Definition: Matrix.h:209
const DenseIterator< Type > operator-(const DenseIterator< Type > &it, ptrdiff_t inc)
Subtraction between a DenseIterator and an integral value.
Definition: DenseIterator.h:585
void subAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the subtraction assignment of a matrix to matrix.
Definition: Matrix.h:239
VT1::ReturnType RN1
Return type of the left-hand side dense vector expression.
Definition: DVecSVecSubExpr.h:97
SelectType< IsExpression< VT1 >::value, const VT1, const VT1 & >::Type LeftOperand
Composite type of the left-hand side dense vector expression.
Definition: DVecSVecSubExpr.h:132
Header file for the IsDenseVector type trait.
LeftOperand lhs_
Left-hand side dense vector of the subtraction expression.
Definition: DVecSVecSubExpr.h:229
#define BLAZE_CONSTRAINT_MUST_BE_DENSE_VECTOR_TYPE(T)
Constraint on the data type.In case the given data type T is not a dense, N-dimensional vector type...
Definition: DenseVector.h:79
size_t size() const
Returns the current size/dimension of the vector.
Definition: DVecSVecSubExpr.h:177
Header file for the IsComputation type trait class.
VT2::ResultType RT2
Result type of the right-hand side sparse vector expression.
Definition: DVecSVecSubExpr.h:96
Base class for all compute expression templates.The Computation class serves as a tag for all computa...
Definition: Computation.h:59
Header file for the sparse vector SMP implementation.
Base class for sparse vectors.The SparseVector class is a base class for all arbitrarily sized (N-dim...
Definition: Forward.h:105
#define BLAZE_FUNCTION_TRACE
Function trace macro.This macro can be used to reliably trace function calls. In case function tracin...
Definition: FunctionTrace.h:157
This ResultType
Result type for expression template evaluations.
Definition: CompressedMatrix.h:2379
Header file for basic type definitions.
Header file for the SubvectorExprTrait class template.
Base template for the SubTrait class.
Definition: SubTrait.h:141
Header file for the IsColumnVector type trait.
Base class for all vector/vector subtraction expression templates.The VecVecSubExpr class serves as a...
Definition: VecVecSubExpr.h:65
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: DVecSVecSubExpr.h:166
Header file for the SubExprTrait class template.
#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:238
#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
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: DVecSVecSubExpr.h:222
Header file for the IsExpression type trait class.
Header file for the FunctionTrace class.
VT1::CompositeType CT1
Composite type of the left-hand side dense vector expression.
Definition: DVecSVecSubExpr.h:99