All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SVecDVecCrossExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_SVECDVECCROSSEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_SVECDVECCROSSEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <stdexcept>
60 #include <blaze/util/Assert.h>
63 #include <blaze/util/mpl/SizeT.h>
64 #include <blaze/util/SelectType.h>
65 #include <blaze/util/Types.h>
66 
67 
68 namespace blaze {
69 
70 //=================================================================================================
71 //
72 // CLASS SVECDVECCROSSEXPR
73 //
74 //=================================================================================================
75 
76 //*************************************************************************************************
83 template< typename VT1 // Type of the left-hand side sparse vector
84  , typename VT2 > // Type of the right-hand side dense vector
85 class SVecDVecCrossExpr : public DenseVector< SVecDVecCrossExpr<VT1,VT2>, false >
86  , private CrossExpr
87  , private Computation
88 {
89  private:
90  //**Type definitions****************************************************************************
91  typedef typename VT1::ResultType RT1;
92  typedef typename VT2::ResultType RT2;
93  typedef typename VT1::ReturnType RN1;
94  typedef typename VT2::ReturnType RN2;
95  typedef typename VT1::CompositeType CT1;
96  typedef typename VT2::CompositeType CT2;
97  typedef typename VT1::ElementType ET1;
98  typedef typename VT2::ElementType ET2;
99  //**********************************************************************************************
100 
101  //**Return type evaluation**********************************************************************
103 
108  enum { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value };
109 
113  //**********************************************************************************************
114 
115  public:
116  //**Type definitions****************************************************************************
121 
124 
126  typedef const ResultType CompositeType;
127 
129  typedef typename SelectType< IsExpression<VT1>::value, const VT1, const VT1& >::Type LeftOperand;
130 
132  typedef typename SelectType< IsExpression<VT2>::value, const VT2, const VT2& >::Type RightOperand;
133 
136 
139  //**********************************************************************************************
140 
141  //**Compilation flags***************************************************************************
143  enum { vectorizable = 0 };
144 
146  enum { smpAssignable = 0 };
147  //**********************************************************************************************
148 
149  //**Constructor*********************************************************************************
155  explicit inline SVecDVecCrossExpr( const VT1& lhs, const VT2& rhs )
156  : lhs_( lhs ) // Left-hand side sparse vector of the cross product expression
157  , rhs_( rhs ) // Right-hand side dense vector of the cross product expression
158  {
159  BLAZE_INTERNAL_ASSERT( lhs.size() == 3UL, "Invalid vector size" );
160  BLAZE_INTERNAL_ASSERT( rhs.size() == 3UL, "Invalid vector size" );
161  }
162  //**********************************************************************************************
163 
164  //**Subscript operator**************************************************************************
170  inline ReturnType operator[]( size_t index ) const {
171  BLAZE_INTERNAL_ASSERT( index < 3UL, "Invalid vector access index" );
172 
173  if( index == 0UL )
174  return lhs_[1UL] * rhs_[2UL] - lhs_[2UL] * rhs_[1UL];
175  else if( index == 1UL )
176  return lhs_[2UL] * rhs_[0UL] - lhs_[0UL] * rhs_[2UL];
177  else
178  return lhs_[0UL] * rhs_[1UL] - lhs_[1UL] * rhs_[0UL];
179  }
180  //**********************************************************************************************
181 
182  //**Size function*******************************************************************************
187  inline size_t size() const {
188  return 3UL;
189  }
190  //**********************************************************************************************
191 
192  //**Left operand access*************************************************************************
197  inline LeftOperand leftOperand() const {
198  return lhs_;
199  }
200  //**********************************************************************************************
201 
202  //**Right operand access************************************************************************
207  inline RightOperand rightOperand() const {
208  return rhs_;
209  }
210  //**********************************************************************************************
211 
212  //**********************************************************************************************
218  template< typename T >
219  inline bool canAlias( const T* alias ) const {
220  return ( lhs_.canAlias( alias ) || rhs_.canAlias( alias ) );
221  }
222  //**********************************************************************************************
223 
224  //**********************************************************************************************
230  template< typename T >
231  inline bool isAliased( const T* alias ) const {
232  return ( lhs_.isAliased( alias ) || rhs_.isAliased( alias ) );
233  }
234  //**********************************************************************************************
235 
236  private:
237  //**Member variables****************************************************************************
240  //**********************************************************************************************
241 
242  //**Assignment to dense vectors*****************************************************************
254  template< typename VT > // Type of the target dense vector
255  friend inline void assign( DenseVector<VT,false>& lhs, const SVecDVecCrossExpr& rhs )
256  {
258 
259  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
260  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
261 
262  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
263  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
264 
265  (~lhs)[0] = x[1UL]*y[2UL] - x[2UL]*y[1UL];
266  (~lhs)[1] = x[2UL]*y[0UL] - x[0UL]*y[2UL];
267  (~lhs)[2] = x[0UL]*y[1UL] - x[1UL]*y[0UL];
268  }
270  //**********************************************************************************************
271 
272  //**Assignment to sparse vectors****************************************************************
284  template< typename VT > // Type of the target sparse vector
285  friend inline void assign( SparseVector<VT,false>& lhs, const SVecDVecCrossExpr& rhs )
286  {
288 
292 
293  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
294  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
295 
296  const ResultType tmp( serial( rhs ) );
297  assign( ~lhs, tmp );
298  }
300  //**********************************************************************************************
301 
302  //**Addition assignment to dense vectors********************************************************
314  template< typename VT > // Type of the target dense vector
315  friend inline void addAssign( DenseVector<VT,false>& lhs, const SVecDVecCrossExpr& rhs )
316  {
318 
319  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
320  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
321 
322  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
323  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
324 
325  (~lhs)[0] += x[1UL]*y[2UL] - x[2UL]*y[1UL];
326  (~lhs)[1] += x[2UL]*y[0UL] - x[0UL]*y[2UL];
327  (~lhs)[2] += x[0UL]*y[1UL] - x[1UL]*y[0UL];
328  }
330  //**********************************************************************************************
331 
332  //**Addition assignment to sparse vectors*******************************************************
333  // No special implementation for the addition assignment to sparse vectors.
334  //**********************************************************************************************
335 
336  //**Subtraction assignment to dense vectors*****************************************************
348  template< typename VT > // Type of the target dense vector
349  friend inline void subAssign( DenseVector<VT,false>& lhs, const SVecDVecCrossExpr& rhs )
350  {
352 
353  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
354  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
355 
356  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
357  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
358 
359  (~lhs)[0] -= x[1UL]*y[2UL] - x[2UL]*y[1UL];
360  (~lhs)[1] -= x[2UL]*y[0UL] - x[0UL]*y[2UL];
361  (~lhs)[2] -= x[0UL]*y[1UL] - x[1UL]*y[0UL];
362  }
364  //**********************************************************************************************
365 
366  //**Subtraction assignment to sparse vectors****************************************************
367  // No special implementation for the subtraction assignment to sparse vectors.
368  //**********************************************************************************************
369 
370  //**Multiplication assignment to dense vectors**************************************************
382  template< typename VT > // Type of the target dense vector
383  friend inline void multAssign( DenseVector<VT,false>& lhs, const SVecDVecCrossExpr& rhs )
384  {
386 
387  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
388  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
389 
390  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
391  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
392 
393  (~lhs)[0] *= x[1UL]*y[2UL] - x[2UL]*y[1UL];
394  (~lhs)[1] *= x[2UL]*y[0UL] - x[0UL]*y[2UL];
395  (~lhs)[2] *= x[0UL]*y[1UL] - x[1UL]*y[0UL];
396  }
398  //**********************************************************************************************
399 
400  //**Multiplication assignment to sparse vectors*************************************************
401  // No special implementation for the multiplication assignment to sparse vectors.
402  //**********************************************************************************************
403 
404  //**Compile time checks*************************************************************************
411  //**********************************************************************************************
412 };
413 //*************************************************************************************************
414 
415 
416 
417 
418 //=================================================================================================
419 //
420 // GLOBAL BINARY ARITHMETIC OPERATORS
421 //
422 //=================================================================================================
423 
424 //*************************************************************************************************
451 template< typename T1 // Type of the left-hand side sparse vector
452  , typename T2 > // Type of the right-hand side dense vector
453 inline const SVecDVecCrossExpr<T1,T2>
455 {
457 
458  if( (~lhs).size() != 3UL || (~rhs).size() != 3UL )
459  throw std::invalid_argument( "Invalid vector size for cross product" );
460 
461  return SVecDVecCrossExpr<T1,T2>( ~lhs, ~rhs );
462 }
463 //*************************************************************************************************
464 
465 
466 
467 
468 //=================================================================================================
469 //
470 // SIZE SPECIALIZATIONS
471 //
472 //=================================================================================================
473 
474 //*************************************************************************************************
476 template< typename VT1, typename VT2 >
477 struct Size< SVecDVecCrossExpr<VT1,VT2> >
478  : public SizeT<3UL>
479 {};
481 //*************************************************************************************************
482 
483 } // namespace blaze
484 
485 #endif
BLAZE_ALWAYS_INLINE 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:879
Compile time check whether the given type is a temporary vector or matrix type.This type trait class ...
Definition: IsTemporary.h:87
SVecDVecCrossExpr(const VT1 &lhs, const VT2 &rhs)
Constructor for the SVecDVecCrossExpr class.
Definition: SVecDVecCrossExpr.h:155
BLAZE_ALWAYS_INLINE size_t size(const Vector< VT, TF > &vector)
Returns the current size/dimension of the vector.
Definition: Vector.h:258
#define BLAZE_CONSTRAINT_MUST_BE_COLUMN_VECTOR_TYPE(T)
Constraint on the data type.In case the given data type T is not a column dense or sparse vector type...
Definition: TransposeFlag.h:159
Efficient implementation of a compressed matrix.The CompressedMatrix class template is the represent...
Definition: CompressedMatrix.h:205
RightOperand rhs_
Right-hand side dense vector of the cross product expression.
Definition: SVecDVecCrossExpr.h:239
VT2::ReturnType RN2
Return type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:94
Expression object for sparse vector-dense vector cross products.The SVecDVecCrossExpr class represent...
Definition: Forward.h:110
const This & CompositeType
Data type for composite expression templates.
Definition: CompressedMatrix.h:2478
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:257
Header file for the DenseVector base class.
VT1::ReturnType RN1
Return type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:93
const DMatSerialExpr< MT, SO > serial(const DenseMatrix< MT, SO > &dm)
Forces the serial evaluation of the given dense matrix expression dm.
Definition: DMatSerialExpr.h:695
Header file for the Computation base class.
Header file for the SizeT class template.
SubExprTrait< typename MultExprTrait< RN1, RN2 >::Type, typename MultExprTrait< RN1, RN2 >::Type >::Type ExprReturnType
Expression return type for the subscript operator.
Definition: SVecDVecCrossExpr.h:112
VT1::ResultType RT1
Result type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:91
Constraint on the data type.
Base template for the CrossTrait class.
Definition: CrossTrait.h:110
Efficient implementation of a fixed-sized vector.The StaticVector class template is the representatio...
Definition: Forward.h:59
VT2::CompositeType CT2
Composite type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:96
Header file for the MultExprTrait class template.
VT2::ResultType RT2
Result type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:92
Compile time type selection.The SelectType class template selects one of the two given types T1 and T...
Definition: SelectType.h:59
const StaticVector< ET1, 3UL, false > LT
Composite type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:135
Header file for the IsTemporary type trait class.
VT1::CompositeType CT1
Composite type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:95
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: SVecDVecCrossExpr.h:231
LeftOperand lhs_
Left-hand side sparse vector of the cross product expression.
Definition: SVecDVecCrossExpr.h:238
BLAZE_ALWAYS_INLINE 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:635
const DVecDVecCrossExpr< T1, T2 > operator%(const DenseVector< T1, false > &lhs, const DenseVector< T2, false > &rhs)
Operator for the cross product of two dense vectors ( ).
Definition: DVecDVecCrossExpr.h:451
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
SelectType< IsComputation< VT2 >::value, const StaticVector< ET2, 3UL, false >, CT2 >::Type RT
Composite type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:138
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
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:104
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:2476
Header file for the SelectType class template.
Header file for all forward declarations for expression class templates.
Constraint on the data type.
Header file for the serial shim.
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: SVecDVecCrossExpr.h:219
const ResultType CompositeType
Data type for composite expression templates.
Definition: SVecDVecCrossExpr.h:126
Header file for the CrossExpr base class.
const SelectType< returnExpr, ExprReturnType, ElementType >::Type ReturnType
Return type for expression template evaluations.
Definition: SVecDVecCrossExpr.h:123
ResultType::ElementType ElementType
Resulting element type.
Definition: SVecDVecCrossExpr.h:120
Header file for all forward declarations for dense vectors and matrices.
SelectType< IsExpression< VT1 >::value, const VT1, const VT1 & >::Type LeftOperand
Composite type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:129
const Type & ReturnType
Return type for expression template evaluations.
Definition: CompressedMatrix.h:2477
Header file for run time assertion macros.
Header file for the cross product trait.
BLAZE_ALWAYS_INLINE 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:742
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: SVecDVecCrossExpr.h:119
VT1::ElementType ET1
Element type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:97
SelectType< IsExpression< VT2 >::value, const VT2, const VT2 & >::Type RightOperand
Composite type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:132
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: SVecDVecCrossExpr.h:170
#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
CrossTrait< RT1, RT2 >::Type ResultType
Result type for expression template evaluations.
Definition: SVecDVecCrossExpr.h:118
Header file for the IsComputation type trait class.
size_t size() const
Returns the current size/dimension of the vector.
Definition: SVecDVecCrossExpr.h:187
Base class for sparse vectors.The SparseVector class is a base class for all arbitrarily sized (N-dim...
Definition: Forward.h:108
#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:2473
Header file for basic type definitions.
Header file for the SubExprTrait class template.
SVecDVecCrossExpr< VT1, VT2 > This
Type of this SVecDVecCrossExpr instance.
Definition: SVecDVecCrossExpr.h:117
RightOperand rightOperand() const
Returns the right-hand side dense vector operand.
Definition: SVecDVecCrossExpr.h:207
Header file for the Size type trait.
Evaluation of the resulting expression type of a multiplication.Via this type trait it is possible to...
Definition: MultExprTrait.h:137
#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
LeftOperand leftOperand() const
Returns the left-hand side sparse vector operand.
Definition: SVecDVecCrossExpr.h:197
Header file for the IsExpression type trait class.
VT2::ElementType ET2
Element type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:98
Header file for the FunctionTrace class.
BLAZE_ALWAYS_INLINE 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:849