DVecDVecCrossExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_DVECDVECCROSSEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_DVECDVECCROSSEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <blaze/math/Aliases.h>
49 #include <blaze/math/Exception.h>
62 #include <blaze/util/Assert.h>
64 #include <blaze/util/mpl/If.h>
66 #include <blaze/util/Types.h>
67 
68 
69 namespace blaze {
70 
71 //=================================================================================================
72 //
73 // CLASS DVECDVECCROSSEXPR
74 //
75 //=================================================================================================
76 
77 //*************************************************************************************************
84 template< typename VT1 // Type of the left-hand side dense vector
85  , typename VT2 // Type of the right-hand side dense vector
86  , bool TF > // Transpose flag
88  : public CrossExpr< DenseVector< DVecDVecCrossExpr<VT1,VT2,TF>, TF > >
89  , private Computation
90 {
91  private:
92  //**Type definitions****************************************************************************
101  //**********************************************************************************************
102 
103  //**Return type evaluation**********************************************************************
105 
110  enum : bool { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value };
111 
114  //**********************************************************************************************
115 
116  public:
117  //**Type definitions****************************************************************************
122 
125 
127  using CompositeType = const ResultType;
128 
130  using LeftOperand = If_< IsExpression<VT1>, const VT1, const VT1& >;
131 
133  using RightOperand = If_< IsExpression<VT2>, const VT2, const VT2& >;
134 
137 
140  //**********************************************************************************************
141 
142  //**Compilation flags***************************************************************************
144  enum : bool { simdEnabled = false };
145 
147  enum : bool { smpAssignable = false };
148  //**********************************************************************************************
149 
150  //**Constructor*********************************************************************************
156  explicit inline DVecDVecCrossExpr( const VT1& lhs, const VT2& rhs ) noexcept
157  : lhs_( lhs ) // Left-hand side dense vector of the cross product expression
158  , rhs_( rhs ) // Right-hand side dense vector of the cross product expression
159  {
160  BLAZE_INTERNAL_ASSERT( lhs.size() == 3UL, "Invalid vector size" );
161  BLAZE_INTERNAL_ASSERT( rhs.size() == 3UL, "Invalid vector size" );
162  }
163  //**********************************************************************************************
164 
165  //**Subscript operator**************************************************************************
171  inline ReturnType operator[]( size_t index ) const {
172  BLAZE_INTERNAL_ASSERT( index < 3UL, "Invalid vector access index" );
173 
174  if( index == 0UL )
175  return lhs_[1UL] * rhs_[2UL] - lhs_[2UL] * rhs_[1UL];
176  else if( index == 1UL )
177  return lhs_[2UL] * rhs_[0UL] - lhs_[0UL] * rhs_[2UL];
178  else
179  return lhs_[0UL] * rhs_[1UL] - lhs_[1UL] * rhs_[0UL];
180  }
181  //**********************************************************************************************
182 
183  //**At function*********************************************************************************
190  inline ReturnType at( size_t index ) const {
191  if( index >= 3UL ) {
192  BLAZE_THROW_OUT_OF_RANGE( "Invalid vector access index" );
193  }
194  return (*this)[index];
195  }
196  //**********************************************************************************************
197 
198  //**Size function*******************************************************************************
203  inline constexpr size_t size() const noexcept {
204  return 3UL;
205  }
206  //**********************************************************************************************
207 
208  //**Left operand access*************************************************************************
213  inline LeftOperand leftOperand() const noexcept {
214  return lhs_;
215  }
216  //**********************************************************************************************
217 
218  //**Right operand access************************************************************************
223  inline RightOperand rightOperand() const noexcept {
224  return rhs_;
225  }
226  //**********************************************************************************************
227 
228  //**********************************************************************************************
234  template< typename T >
235  inline bool canAlias( const T* alias ) const noexcept {
236  return ( lhs_.canAlias( alias ) || rhs_.canAlias( alias ) );
237  }
238  //**********************************************************************************************
239 
240  //**********************************************************************************************
246  template< typename T >
247  inline bool isAliased( const T* alias ) const noexcept {
248  return ( lhs_.isAliased( alias ) || rhs_.isAliased( alias ) );
249  }
250  //**********************************************************************************************
251 
252  private:
253  //**Member variables****************************************************************************
256  //**********************************************************************************************
257 
258  //**Assignment to dense vectors*****************************************************************
270  template< typename VT > // Type of the target dense vector
271  friend inline void assign( DenseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
272  {
274 
275  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
276  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
277 
278  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side dense vector operand
279  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
280 
281  (~lhs)[0] = x[1UL]*y[2UL] - x[2UL]*y[1UL];
282  (~lhs)[1] = x[2UL]*y[0UL] - x[0UL]*y[2UL];
283  (~lhs)[2] = x[0UL]*y[1UL] - x[1UL]*y[0UL];
284  }
286  //**********************************************************************************************
287 
288  //**Assignment to sparse vectors****************************************************************
300  template< typename VT > // Type of the target sparse vector
301  friend inline void assign( SparseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
302  {
304 
308 
309  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
310  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
311 
312  const ResultType tmp( serial( rhs ) );
313  assign( ~lhs, tmp );
314  }
316  //**********************************************************************************************
317 
318  //**Addition assignment to dense vectors********************************************************
330  template< typename VT > // Type of the target dense vector
331  friend inline void addAssign( DenseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
332  {
334 
335  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
336  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
337 
338  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side dense vector operand
339  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
340 
341  (~lhs)[0] += x[1UL]*y[2UL] - x[2UL]*y[1UL];
342  (~lhs)[1] += x[2UL]*y[0UL] - x[0UL]*y[2UL];
343  (~lhs)[2] += x[0UL]*y[1UL] - x[1UL]*y[0UL];
344  }
346  //**********************************************************************************************
347 
348  //**Addition assignment to sparse vectors*******************************************************
349  // No special implementation for the addition assignment to sparse vectors.
350  //**********************************************************************************************
351 
352  //**Subtraction assignment to dense vectors*****************************************************
364  template< typename VT > // Type of the target dense vector
365  friend inline void subAssign( DenseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
366  {
368 
369  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
370  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
371 
372  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side dense vector operand
373  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
374 
375  (~lhs)[0] -= x[1UL]*y[2UL] - x[2UL]*y[1UL];
376  (~lhs)[1] -= x[2UL]*y[0UL] - x[0UL]*y[2UL];
377  (~lhs)[2] -= x[0UL]*y[1UL] - x[1UL]*y[0UL];
378  }
380  //**********************************************************************************************
381 
382  //**Subtraction assignment to sparse vectors****************************************************
383  // No special implementation for the subtraction assignment to sparse vectors.
384  //**********************************************************************************************
385 
386  //**Multiplication assignment to dense vectors**************************************************
398  template< typename VT > // Type of the target dense vector
399  friend inline void multAssign( DenseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
400  {
402 
403  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
404  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
405 
406  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side dense vector operand
407  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
408 
409  (~lhs)[0] *= x[1UL]*y[2UL] - x[2UL]*y[1UL];
410  (~lhs)[1] *= x[2UL]*y[0UL] - x[0UL]*y[2UL];
411  (~lhs)[2] *= x[0UL]*y[1UL] - x[1UL]*y[0UL];
412  }
414  //**********************************************************************************************
415 
416  //**Multiplication assignment to sparse vectors*************************************************
417  // No special implementation for the multiplication assignment to sparse vectors.
418  //**********************************************************************************************
419 
420  //**Division assignment to dense vectors********************************************************
432  template< typename VT > // Type of the target dense vector
433  friend inline void divAssign( DenseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
434  {
436 
437  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
438  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
439 
440  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side dense vector operand
441  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
442 
443  (~lhs)[0] /= x[1UL]*y[2UL] - x[2UL]*y[1UL];
444  (~lhs)[1] /= x[2UL]*y[0UL] - x[0UL]*y[2UL];
445  (~lhs)[2] /= x[0UL]*y[1UL] - x[1UL]*y[0UL];
446  }
448  //**********************************************************************************************
449 
450  //**Division assignment to sparse vectors*******************************************************
451  // No special implementation for the division assignment to sparse vectors.
452  //**********************************************************************************************
453 
454  //**Compile time checks*************************************************************************
461  //**********************************************************************************************
462 };
463 //*************************************************************************************************
464 
465 
466 
467 
468 //=================================================================================================
469 //
470 // GLOBAL BINARY ARITHMETIC OPERATORS
471 //
472 //=================================================================================================
473 
474 //*************************************************************************************************
499 template< typename VT1 // Type of the left-hand side dense vector
500  , typename VT2 // Type of the right-hand side dense vector
501  , bool TF > // Transpose flag
502 inline decltype(auto)
503  operator%( const DenseVector<VT1,TF>& lhs, const DenseVector<VT2,TF>& rhs )
504 {
506 
507  if( (~lhs).size() != 3UL || (~rhs).size() != 3UL ) {
508  BLAZE_THROW_INVALID_ARGUMENT( "Invalid vector size for cross product" );
509  }
510 
512  return ReturnType( ~lhs, ~rhs );
513 }
514 //*************************************************************************************************
515 
516 
517 //*************************************************************************************************
542 template< typename VT1 // Type of the left-hand side dense vector
543  , typename VT2 // Type of the right-hand side dense vector
544  , bool TF > // Transpose flag
545 inline decltype(auto) cross( const DenseVector<VT1,TF>& lhs, const DenseVector<VT2,TF>& rhs )
546 {
547  return lhs % rhs;
548 }
549 //*************************************************************************************************
550 
551 
552 
553 
554 //=================================================================================================
555 //
556 // SIZE SPECIALIZATIONS
557 //
558 //=================================================================================================
559 
560 //*************************************************************************************************
562 template< typename VT1, typename VT2, bool TF >
563 struct Size< DVecDVecCrossExpr<VT1,VT2,TF>, 0UL >
564  : public PtrdiffT<3L>
565 {};
567 //*************************************************************************************************
568 
569 } // namespace blaze
570 
571 #endif
#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
RightOperand rhs_
Right-hand side dense vector of the cross product expression.
Definition: DVecDVecCrossExpr.h:255
Header file for auxiliary alias declarations.
Compile time check whether the given type is a temporary vector or matrix type.This type trait class ...
Definition: IsTemporary.h:69
Header file for basic type definitions.
ElementType_< VT1 > ET1
Element type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:99
ResultType_< VT2 > RT2
Result type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:94
Header file for the serial shim.
DVecDVecCrossExpr(const VT1 &lhs, const VT2 &rhs) noexcept
Constructor for the DVecDVecCrossExpr class.
Definition: DVecDVecCrossExpr.h:156
Base class for all cross product expression templates.The CrossExpr class serves as a tag for all exp...
Definition: CrossExpr.h:66
Header file for the DenseVector base class.
Expression object for dense vector-dense vector cross products.The DVecDVecCrossExpr class represents...
Definition: DVecDVecCrossExpr.h:87
Header file for the Computation base class.
const ResultType CompositeType
Data type for composite expression templates.
Definition: DVecDVecCrossExpr.h:127
ReturnType_< VT1 > RN1
Return type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:95
typename T::ResultType ResultType_
Alias declaration for nested ResultType type definitions.The ResultType_ alias declaration provides a...
Definition: Aliases.h:343
CompositeType_< VT2 > CT2
Composite type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:98
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
Efficient implementation of a fixed-sized vector.The StaticVector class template is the representatio...
Definition: Forward.h:61
typename T::ReturnType ReturnType_
Alias declaration for nested ReturnType type definitions.The ReturnType_ alias declaration provides a...
Definition: Aliases.h:363
LeftOperand leftOperand() const noexcept
Returns the left-hand side dense vector operand.
Definition: DVecDVecCrossExpr.h:213
TransposeType_< ResultType > TransposeType
Transpose type for expression template evaluations.
Definition: DVecDVecCrossExpr.h:120
Constraint on the transpose flag of vector types.
If_< IsExpression< VT1 >, const VT1, const VT1 &> LeftOperand
Composite type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:130
typename SubExprTrait< T1, T2 >::Type SubExprTrait_
Auxiliary alias declaration for the SubExprTrait class template.The SubExprTrait_ alias declaration p...
Definition: SubExprTrait.h:112
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.
typename T::CompositeType CompositeType_
Alias declaration for nested CompositeType type definitions.The CompositeType_ alias declaration prov...
Definition: Aliases.h:83
If_< IsComputation< VT2 >, const StaticVector< ET2, 3UL, TF >, CT2 > RT
Composite type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:139
Header file for the IsTemporary type trait class.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:58
Header file for the If class template.
CrossTrait_< RT1, RT2 > ResultType
Result type for expression template evaluations.
Definition: DVecDVecCrossExpr.h:119
ElementType_< VT2 > ET2
Element type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:100
#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
ReturnType_< VT2 > RN2
Return type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:96
typename T::ElementType ElementType_
Alias declaration for nested ElementType type definitions.The ElementType_ alias declaration provides...
Definition: Aliases.h:163
Base class for N-dimensional dense vectors.The DenseVector class is a base class for all arbitrarily ...
Definition: DenseVector.h:76
RightOperand rightOperand() const noexcept
Returns the right-hand side dense vector operand.
Definition: DVecDVecCrossExpr.h:223
ReturnType at(size_t index) const
Checked access to the vector elements.
Definition: DVecDVecCrossExpr.h:190
Constraint on the data type.
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: DVecDVecCrossExpr.h:171
Constraint on the data type.
Header file for the exception macros of the math module.
typename CrossTrait< T1, T2 >::Type CrossTrait_
Auxiliary alias declaration for the CrossTrait class template.The CrossTrait_ alias declaration provi...
Definition: CrossTrait.h:209
Constraint on the data type.
Header file for all forward declarations for expression class templates.
Header file for the CrossExpr base class.
Header file for the PtrdiffT class template.
Header file for all forward declarations for dense vectors and matrices.
bool canAlias(const T *alias) const noexcept
Returns whether the expression can alias with the given address alias.
Definition: DVecDVecCrossExpr.h:235
If_< IsExpression< VT2 >, const VT2, const VT2 &> RightOperand
Composite type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:133
const IfTrue_< returnExpr, ExprReturnType, ElementType > ReturnType
Return type for expression template evaluations.
Definition: DVecDVecCrossExpr.h:124
Header file for run time assertion macros.
constexpr size_t size() const noexcept
Returns the current size/dimension of the vector.
Definition: DVecDVecCrossExpr.h:203
Header file for the cross product trait.
typename If< T1, T2, T3 >::Type If_
Auxiliary alias declaration for the If class template.The If_ alias declaration provides a convenient...
Definition: If.h:154
ElementType_< ResultType > ElementType
Resulting element type.
Definition: DVecDVecCrossExpr.h:121
Compile time integral constant wrapper for ptrdiff_t.The PtrdiffT class template represents an integr...
Definition: PtrdiffT.h:72
#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
decltype(auto) serial(const DenseMatrix< MT, SO > &dm)
Forces the serial evaluation of the given dense matrix expression dm.
Definition: DMatSerialExpr.h:816
#define BLAZE_CONSTRAINT_MUST_NOT_REQUIRE_EVALUATION(T)
Constraint on the data type.In case the given data type T requires an intermediate evaluation within ...
Definition: RequiresEvaluation.h:81
ResultType_< VT1 > RT1
Result type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:93
If_< IsComputation< VT1 >, const StaticVector< ET1, 3UL, TF >, CT1 > LT
Composite type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:136
const Type & ReturnType
Return type for expression template evaluations.
Definition: CompressedMatrix.h:3080
#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:61
Header file for the IsComputation type trait class.
Base class for all compute expression templates.The Computation class serves as a tag for all computa...
Definition: Computation.h:66
Compile time evaluation of the size of vectors and matrices.The Size type trait evaluates the size of...
Definition: Size.h:80
Base class for sparse vectors.The SparseVector class is a base class for all arbitrarily sized (N-dim...
Definition: Forward.h:130
LeftOperand lhs_
Left-hand side dense vector of the cross product expression.
Definition: DVecDVecCrossExpr.h:254
bool isAliased(const T *alias) const noexcept
Returns whether the expression is aliased with the given address alias.
Definition: DVecDVecCrossExpr.h:247
typename T::TransposeType TransposeType_
Alias declaration for nested TransposeType type definitions.The TransposeType_ alias declaration prov...
Definition: Aliases.h:423
Header file for the SubExprTrait class template.
Header file for the Size type trait.
#define BLAZE_CONSTRAINT_MUST_BE_VECTOR_WITH_TRANSPOSE_FLAG(T, TF)
Constraint on the data type.In case the given data type T is not a dense or sparse vector type and in...
Definition: TransposeFlag.h:63
#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
CompositeType_< VT1 > CT1
Composite type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:97
Header file for the IsExpression type trait class.
SubExprTrait_< MultExprTrait_< RN1, RN2 >, MultExprTrait_< RN1, RN2 > > ExprReturnType
Expression return type for the subscript operator.
Definition: DVecDVecCrossExpr.h:113
Header file for the function trace functionality.
decltype(auto) cross(const DenseVector< VT1, TF > &lhs, const DenseVector< VT2, TF > &rhs)
Cross product of two dense vectors ( ).
Definition: DVecDVecCrossExpr.h:545