SVecSVecCrossExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_SVECSVECCROSSEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_SVECSVECCROSSEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <blaze/math/Aliases.h>
50 #include <blaze/math/Exception.h>
63 #include <blaze/util/Assert.h>
65 #include <blaze/util/mpl/If.h>
67 #include <blaze/util/Types.h>
68 
69 
70 namespace blaze {
71 
72 //=================================================================================================
73 //
74 // CLASS SVECSVECCROSSEXPR
75 //
76 //=================================================================================================
77 
78 //*************************************************************************************************
85 template< typename VT1 // Type of the left-hand side sparse vector
86  , typename VT2 // Type of the right-hand side sparse vector
87  , bool TF > // Transpose flag
88 class SVecSVecCrossExpr
89  : public CrossExpr< DenseVector< SVecSVecCrossExpr<VT1,VT2,TF>, TF > >
90  , private Computation
91 {
92  private:
93  //**Type definitions****************************************************************************
102  //**********************************************************************************************
103 
104  //**Return type evaluation**********************************************************************
106 
111  enum : bool { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value };
112 
115  //**********************************************************************************************
116 
117  public:
118  //**Type definitions****************************************************************************
123 
126 
128  using CompositeType = const ResultType;
129 
131  using LeftOperand = If_< IsExpression<VT1>, const VT1, const VT1& >;
132 
134  using RightOperand = If_< IsExpression<VT2>, const VT2, const VT2& >;
135 
138 
141  //**********************************************************************************************
142 
143  //**Compilation flags***************************************************************************
145  enum : bool { simdEnabled = false };
146 
148  enum : bool { smpAssignable = false };
149  //**********************************************************************************************
150 
151  //**Constructor*********************************************************************************
157  explicit inline SVecSVecCrossExpr( const VT1& lhs, const VT2& rhs ) noexcept
158  : lhs_( lhs ) // Left-hand side sparse vector of the cross product expression
159  , rhs_( rhs ) // Right-hand side sparse vector of the cross product expression
160  {
161  BLAZE_INTERNAL_ASSERT( lhs.size() == 3UL, "Invalid vector size" );
162  BLAZE_INTERNAL_ASSERT( rhs.size() == 3UL, "Invalid vector size" );
163  }
164  //**********************************************************************************************
165 
166  //**Subscript operator**************************************************************************
172  inline ReturnType operator[]( size_t index ) const {
173  BLAZE_INTERNAL_ASSERT( index < 3UL, "Invalid vector access index" );
174 
175  if( index == 0UL )
176  return lhs_[1UL] * rhs_[2UL] - lhs_[2UL] * rhs_[1UL];
177  else if( index == 1UL )
178  return lhs_[2UL] * rhs_[0UL] - lhs_[0UL] * rhs_[2UL];
179  else
180  return lhs_[0UL] * rhs_[1UL] - lhs_[1UL] * rhs_[0UL];
181  }
182  //**********************************************************************************************
183 
184  //**At function*********************************************************************************
191  inline ReturnType at( size_t index ) const {
192  if( index >= 3UL ) {
193  BLAZE_THROW_OUT_OF_RANGE( "Invalid vector access index" );
194  }
195  return (*this)[index];
196  }
197  //**********************************************************************************************
198 
199  //**Size function*******************************************************************************
204  inline constexpr size_t size() const noexcept {
205  return 3UL;
206  }
207  //**********************************************************************************************
208 
209  //**Left operand access*************************************************************************
214  inline LeftOperand leftOperand() const noexcept {
215  return lhs_;
216  }
217  //**********************************************************************************************
218 
219  //**Right operand access************************************************************************
224  inline RightOperand rightOperand() const noexcept {
225  return rhs_;
226  }
227  //**********************************************************************************************
228 
229  //**********************************************************************************************
235  template< typename T >
236  inline bool canAlias( const T* alias ) const noexcept {
237  return ( lhs_.canAlias( alias ) || rhs_.canAlias( alias ) );
238  }
239  //**********************************************************************************************
240 
241  //**********************************************************************************************
247  template< typename T >
248  inline bool isAliased( const T* alias ) const noexcept {
249  return ( lhs_.isAliased( alias ) || rhs_.isAliased( alias ) );
250  }
251  //**********************************************************************************************
252 
253  private:
254  //**Member variables****************************************************************************
257  //**********************************************************************************************
258 
259  //**Assignment to dense vectors*****************************************************************
271  template< typename VT > // Type of the target dense vector
272  friend inline void assign( DenseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
273  {
275 
276  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
277  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
278 
279  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
280  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side sparse vector operand
281 
282  (~lhs)[0] = x[1UL]*y[2UL] - x[2UL]*y[1UL];
283  (~lhs)[1] = x[2UL]*y[0UL] - x[0UL]*y[2UL];
284  (~lhs)[2] = x[0UL]*y[1UL] - x[1UL]*y[0UL];
285  }
287  //**********************************************************************************************
288 
289  //**Assignment to sparse vectors****************************************************************
301  template< typename VT > // Type of the target sparse vector
302  friend inline void assign( SparseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
303  {
305 
309 
310  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
311  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
312 
313  const ResultType tmp( serial( rhs ) );
314  assign( ~lhs, tmp );
315  }
317  //**********************************************************************************************
318 
319  //**Addition assignment to dense vectors********************************************************
331  template< typename VT > // Type of the target dense vector
332  friend inline void addAssign( DenseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
333  {
335 
336  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
337  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
338 
339  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
340  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side sparse vector operand
341 
342  (~lhs)[0] += x[1UL]*y[2UL] - x[2UL]*y[1UL];
343  (~lhs)[1] += x[2UL]*y[0UL] - x[0UL]*y[2UL];
344  (~lhs)[2] += x[0UL]*y[1UL] - x[1UL]*y[0UL];
345  }
347  //**********************************************************************************************
348 
349  //**Addition assignment to sparse vectors*******************************************************
350  // No special implementation for the addition assignment to sparse vectors.
351  //**********************************************************************************************
352 
353  //**Subtraction assignment to dense vectors*****************************************************
365  template< typename VT > // Type of the target dense vector
366  friend inline void subAssign( DenseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
367  {
369 
370  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
371  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
372 
373  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
374  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side sparse vector operand
375 
376  (~lhs)[0] -= x[1UL]*y[2UL] - x[2UL]*y[1UL];
377  (~lhs)[1] -= x[2UL]*y[0UL] - x[0UL]*y[2UL];
378  (~lhs)[2] -= x[0UL]*y[1UL] - x[1UL]*y[0UL];
379  }
381  //**********************************************************************************************
382 
383  //**Subtraction assignment to sparse vectors****************************************************
384  // No special implementation for the subtraction assignment to sparse vectors.
385  //**********************************************************************************************
386 
387  //**Multiplication assignment to dense vectors**************************************************
399  template< typename VT > // Type of the target dense vector
400  friend inline void multAssign( DenseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
401  {
403 
404  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
405  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
406 
407  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
408  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side sparse vector operand
409 
410  (~lhs)[0] *= x[1UL]*y[2UL] - x[2UL]*y[1UL];
411  (~lhs)[1] *= x[2UL]*y[0UL] - x[0UL]*y[2UL];
412  (~lhs)[2] *= x[0UL]*y[1UL] - x[1UL]*y[0UL];
413  }
415  //**********************************************************************************************
416 
417  //**Multiplication assignment to sparse vectors*************************************************
418  // No special implementation for the multiplication assignment to sparse vectors.
419  //**********************************************************************************************
420 
421  //**Division assignment to dense vectors********************************************************
433  template< typename VT > // Type of the target dense vector
434  friend inline void divAssign( DenseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
435  {
437 
438  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
439  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
440 
441  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
442  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side sparse vector operand
443 
444  (~lhs)[0] /= x[1UL]*y[2UL] - x[2UL]*y[1UL];
445  (~lhs)[1] /= x[2UL]*y[0UL] - x[0UL]*y[2UL];
446  (~lhs)[2] /= x[0UL]*y[1UL] - x[1UL]*y[0UL];
447  }
449  //**********************************************************************************************
450 
451  //**Division assignment to sparse vectors*******************************************************
452  // No special implementation for the division assignment to sparse vectors.
453  //**********************************************************************************************
454 
455  //**Compile time checks*************************************************************************
462  //**********************************************************************************************
463 };
464 //*************************************************************************************************
465 
466 
467 
468 
469 //=================================================================================================
470 //
471 // GLOBAL BINARY ARITHMETIC OPERATORS
472 //
473 //=================================================================================================
474 
475 //*************************************************************************************************
500 template< typename VT1 // Type of the left-hand side sparse vector
501  , typename VT2 // Type of the right-hand side sparse vector
502  , bool TF > // Transpose flag
503 inline decltype(auto)
504  operator%( const SparseVector<VT1,TF>& lhs, const SparseVector<VT2,TF>& rhs )
505 {
507 
508  if( (~lhs).size() != 3UL || (~rhs).size() != 3UL ) {
509  BLAZE_THROW_INVALID_ARGUMENT( "Invalid vector size for cross product" );
510  }
511 
513  return ReturnType( ~lhs, ~rhs );
514 }
515 //*************************************************************************************************
516 
517 
518 //*************************************************************************************************
543 template< typename VT1 // Type of the left-hand side sparse vector
544  , typename VT2 // Type of the right-hand side sparse vector
545  , bool TF > // Transpose flag
546 inline decltype(auto) cross( const SparseVector<VT1,TF>& lhs, const SparseVector<VT2,TF>& rhs )
547 {
548  return lhs % rhs;
549 }
550 //*************************************************************************************************
551 
552 
553 
554 
555 //=================================================================================================
556 //
557 // SIZE SPECIALIZATIONS
558 //
559 //=================================================================================================
560 
561 //*************************************************************************************************
563 template< typename VT1, typename VT2, bool TF >
564 struct Size< SVecSVecCrossExpr<VT1,VT2,TF> >
565  : public PtrdiffT<3L>
566 {};
568 //*************************************************************************************************
569 
570 } // namespace blaze
571 
572 #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
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:70
Header file for basic type definitions.
ElementType_< ResultType > ElementType
Resulting element type.
Definition: SVecSVecCrossExpr.h:122
RightOperand rightOperand() const noexcept
Returns the right-hand side sparse vector operand.
Definition: SVecSVecCrossExpr.h:224
Header file for the serial shim.
bool isAliased(const T *alias) const noexcept
Returns whether the expression is aliased with the given address alias.
Definition: SVecSVecCrossExpr.h:248
Header file for the DenseVector base class.
CompositeType_< VT1 > CT1
Composite type of the left-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:98
Header file for the Computation base class.
bool canAlias(const T *alias) const noexcept
Returns whether the expression can alias with the given address alias.
Definition: SVecSVecCrossExpr.h:236
CrossTrait_< RT1, RT2 > ResultType
Result type for expression template evaluations.
Definition: SVecSVecCrossExpr.h:120
ReturnType_< VT2 > RN2
Return type of the right-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:97
LeftOperand lhs_
Left-hand side sparse vector of the cross product expression.
Definition: SVecSVecCrossExpr.h:255
typename T::ResultType ResultType_
Alias declaration for nested ResultType type definitions.The ResultType_ alias declaration provides a...
Definition: Aliases.h:343
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
Constraint on the transpose flag of vector types.
CompositeType_< VT2 > CT2
Composite type of the right-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:99
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
ElementType_< VT2 > ET2
Element type of the right-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:101
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
Header file for the IsTemporary type trait class.
Namespace of the Blaze C++ math library.
Definition: Blaze.h:57
Header file for the If class template.
ReturnType_< VT1 > RN1
Return type of the left-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:96
#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
TransposeType_< ResultType > TransposeType
Transpose type for expression template evaluations.
Definition: SVecSVecCrossExpr.h:121
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:70
LeftOperand leftOperand() const noexcept
Returns the left-hand side sparse vector operand.
Definition: SVecSVecCrossExpr.h:214
#define BLAZE_CONSTRAINT_MUST_BE_SPARSE_VECTOR_TYPE(T)
Constraint on the data type.In case the given data type T is not a sparse, N-dimensional vector type...
Definition: SparseVector.h:61
Constraint on the data type.
ResultType_< VT1 > RT1
Result type of the left-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:94
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: SVecSVecCrossExpr.h:172
Constraint on the data type.
Header file for the exception macros of the math module.
If_< IsExpression< VT1 >, const VT1, const VT1 &> LeftOperand
Composite type of the left-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:131
RightOperand rhs_
Right-hand side sparse vector of the cross product expression.
Definition: SVecSVecCrossExpr.h:256
typename CrossTrait< T1, T2 >::Type CrossTrait_
Auxiliary alias declaration for the CrossTrait class template.The CrossTrait_ alias declaration provi...
Definition: CrossTrait.h:159
Constraint on the data type.
Header file for all forward declarations for expression class templates.
Constraint on the data type.
constexpr size_t size() const noexcept
Returns the current size/dimension of the vector.
Definition: SVecSVecCrossExpr.h:204
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.
Header file for run time assertion macros.
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
Compile time integral constant wrapper for ptrdiff_t.The PtrdiffT class template represents an integr...
Definition: PtrdiffT.h:72
ElementType_< VT1 > ET1
Element type of the left-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:100
#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:819
#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
const Type & ReturnType
Return type for expression template evaluations.
Definition: CompressedMatrix.h:3082
#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
const ResultType CompositeType
Data type for composite expression templates.
Definition: SVecSVecCrossExpr.h:128
ReturnType at(size_t index) const
Checked access to the vector elements.
Definition: SVecSVecCrossExpr.h:191
If_< IsExpression< VT2 >, const VT2, const VT2 &> RightOperand
Composite type of the right-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:134
Header file for the IsComputation type trait class.
Compile time evaluation of the size of a vector.The Size type trait evaluates the size of the given v...
Definition: Size.h:74
Base class for sparse vectors.The SparseVector class is a base class for all arbitrarily sized (N-dim...
Definition: Forward.h:130
typename T::TransposeType TransposeType_
Alias declaration for nested TransposeType type definitions.The TransposeType_ alias declaration prov...
Definition: Aliases.h:423
SVecSVecCrossExpr(const VT1 &lhs, const VT2 &rhs) noexcept
Constructor for the SVecSVecCrossExpr class.
Definition: SVecSVecCrossExpr.h:157
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
Expression object for sparse vector-sparse vector cross products.The SVecSVecCrossExpr class represen...
Definition: Forward.h:142
SubExprTrait_< MultExprTrait_< RN1, RN2 >, MultExprTrait_< RN1, RN2 > > ExprReturnType
Expression return type for the subscript operator.
Definition: SVecSVecCrossExpr.h:114
Header file for the IsExpression type trait class.
ResultType_< VT2 > RT2
Result type of the right-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:95
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
const IfTrue_< returnExpr, ExprReturnType, ElementType > ReturnType
Return type for expression template evaluations.
Definition: SVecSVecCrossExpr.h:125