Blaze  3.6
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 <utility>
44 #include <blaze/math/Aliases.h>
50 #include <blaze/math/Exception.h>
60 #include <blaze/util/Assert.h>
62 #include <blaze/util/mpl/If.h>
63 #include <blaze/util/Types.h>
64 
65 
66 namespace blaze {
67 
68 //=================================================================================================
69 //
70 // CLASS DVECDVECCROSSEXPR
71 //
72 //=================================================================================================
73 
74 //*************************************************************************************************
81 template< typename VT1 // Type of the left-hand side dense vector
82  , typename VT2 // Type of the right-hand side dense vector
83  , bool TF > // Transpose flag
85  : public CrossExpr< DenseVector< DVecDVecCrossExpr<VT1,VT2,TF>, TF > >
86  , private Computation
87 {
88  private:
89  //**Type definitions****************************************************************************
98  //**********************************************************************************************
99 
100  //**Return type evaluation**********************************************************************
102 
107  static constexpr bool returnExpr = ( !IsTemporary_v<RN1> && !IsTemporary_v<RN2> );
108 
110  using ExprReturnType = decltype( ( std::declval<RN1>() * std::declval<RN2>() ) -
111  ( std::declval<RN1>() * std::declval<RN2>() ) );
112  //**********************************************************************************************
113 
114  public:
115  //**Type definitions****************************************************************************
121 
124 
126  using CompositeType = const ResultType;
127 
129  using LeftOperand = If_t< IsExpression_v<VT1>, const VT1, const VT1& >;
130 
132  using RightOperand = If_t< IsExpression_v<VT2>, const VT2, const VT2& >;
133 
136 
139  //**********************************************************************************************
140 
141  //**Compilation flags***************************************************************************
143  static constexpr bool simdEnabled = false;
144 
146  static constexpr bool smpAssignable = false;
147  //**********************************************************************************************
148 
149  //**Constructor*********************************************************************************
155  explicit inline DVecDVecCrossExpr( const VT1& lhs, const VT2& rhs ) noexcept
156  : lhs_( lhs ) // Left-hand side dense 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  //**At function*********************************************************************************
189  inline ReturnType at( size_t index ) const {
190  if( index >= 3UL ) {
191  BLAZE_THROW_OUT_OF_RANGE( "Invalid vector access index" );
192  }
193  return (*this)[index];
194  }
195  //**********************************************************************************************
196 
197  //**Size function*******************************************************************************
202  inline constexpr size_t size() const noexcept {
203  return 3UL;
204  }
205  //**********************************************************************************************
206 
207  //**Left operand access*************************************************************************
212  inline LeftOperand leftOperand() const noexcept {
213  return lhs_;
214  }
215  //**********************************************************************************************
216 
217  //**Right operand access************************************************************************
222  inline RightOperand rightOperand() const noexcept {
223  return rhs_;
224  }
225  //**********************************************************************************************
226 
227  //**********************************************************************************************
233  template< typename T >
234  inline bool canAlias( const T* alias ) const noexcept {
235  return ( lhs_.canAlias( alias ) || rhs_.canAlias( alias ) );
236  }
237  //**********************************************************************************************
238 
239  //**********************************************************************************************
245  template< typename T >
246  inline bool isAliased( const T* alias ) const noexcept {
247  return ( lhs_.isAliased( alias ) || rhs_.isAliased( alias ) );
248  }
249  //**********************************************************************************************
250 
251  private:
252  //**Member variables****************************************************************************
255  //**********************************************************************************************
256 
257  //**Assignment to dense vectors*****************************************************************
269  template< typename VT > // Type of the target dense vector
270  friend inline void assign( DenseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
271  {
273 
274  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
275  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
276 
277  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side dense vector operand
278  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
279 
280  (~lhs)[0] = x[1UL]*y[2UL] - x[2UL]*y[1UL];
281  (~lhs)[1] = x[2UL]*y[0UL] - x[0UL]*y[2UL];
282  (~lhs)[2] = x[0UL]*y[1UL] - x[1UL]*y[0UL];
283  }
285  //**********************************************************************************************
286 
287  //**Assignment to sparse vectors****************************************************************
299  template< typename VT > // Type of the target sparse vector
300  friend inline void assign( SparseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
301  {
303 
307 
308  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
309  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
310 
311  const ResultType tmp( serial( rhs ) );
312  assign( ~lhs, tmp );
313  }
315  //**********************************************************************************************
316 
317  //**Addition assignment to dense vectors********************************************************
329  template< typename VT > // Type of the target dense vector
330  friend inline void addAssign( DenseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
331  {
333 
334  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
335  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
336 
337  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side dense vector operand
338  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
339 
340  (~lhs)[0] += x[1UL]*y[2UL] - x[2UL]*y[1UL];
341  (~lhs)[1] += x[2UL]*y[0UL] - x[0UL]*y[2UL];
342  (~lhs)[2] += x[0UL]*y[1UL] - x[1UL]*y[0UL];
343  }
345  //**********************************************************************************************
346 
347  //**Addition assignment to sparse vectors*******************************************************
348  // No special implementation for the addition assignment to sparse vectors.
349  //**********************************************************************************************
350 
351  //**Subtraction assignment to dense vectors*****************************************************
363  template< typename VT > // Type of the target dense vector
364  friend inline void subAssign( DenseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
365  {
367 
368  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
369  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
370 
371  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side dense vector operand
372  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
373 
374  (~lhs)[0] -= x[1UL]*y[2UL] - x[2UL]*y[1UL];
375  (~lhs)[1] -= x[2UL]*y[0UL] - x[0UL]*y[2UL];
376  (~lhs)[2] -= x[0UL]*y[1UL] - x[1UL]*y[0UL];
377  }
379  //**********************************************************************************************
380 
381  //**Subtraction assignment to sparse vectors****************************************************
382  // No special implementation for the subtraction assignment to sparse vectors.
383  //**********************************************************************************************
384 
385  //**Multiplication assignment to dense vectors**************************************************
397  template< typename VT > // Type of the target dense vector
398  friend inline void multAssign( DenseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
399  {
401 
402  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
403  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
404 
405  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side dense vector operand
406  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
407 
408  (~lhs)[0] *= x[1UL]*y[2UL] - x[2UL]*y[1UL];
409  (~lhs)[1] *= x[2UL]*y[0UL] - x[0UL]*y[2UL];
410  (~lhs)[2] *= x[0UL]*y[1UL] - x[1UL]*y[0UL];
411  }
413  //**********************************************************************************************
414 
415  //**Multiplication assignment to sparse vectors*************************************************
416  // No special implementation for the multiplication assignment to sparse vectors.
417  //**********************************************************************************************
418 
419  //**Division assignment to dense vectors********************************************************
431  template< typename VT > // Type of the target dense vector
432  friend inline void divAssign( DenseVector<VT,TF>& lhs, const DVecDVecCrossExpr& rhs )
433  {
435 
436  BLAZE_INTERNAL_ASSERT( (~lhs).size() == 3UL, "Invalid vector size" );
437  BLAZE_INTERNAL_ASSERT( (~rhs).size() == 3UL, "Invalid vector size" );
438 
439  LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side dense vector operand
440  RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
441 
442  (~lhs)[0] /= x[1UL]*y[2UL] - x[2UL]*y[1UL];
443  (~lhs)[1] /= x[2UL]*y[0UL] - x[0UL]*y[2UL];
444  (~lhs)[2] /= x[0UL]*y[1UL] - x[1UL]*y[0UL];
445  }
447  //**********************************************************************************************
448 
449  //**Division assignment to sparse vectors*******************************************************
450  // No special implementation for the division assignment to sparse vectors.
451  //**********************************************************************************************
452 
453  //**Compile time checks*************************************************************************
460  //**********************************************************************************************
461 };
462 //*************************************************************************************************
463 
464 
465 
466 
467 //=================================================================================================
468 //
469 // GLOBAL BINARY ARITHMETIC OPERATORS
470 //
471 //=================================================================================================
472 
473 //*************************************************************************************************
498 template< typename VT1 // Type of the left-hand side dense vector
499  , typename VT2 // Type of the right-hand side dense vector
500  , bool TF > // Transpose flag
501 inline decltype(auto)
502  operator%( const DenseVector<VT1,TF>& lhs, const DenseVector<VT2,TF>& rhs )
503 {
505 
506  if( (~lhs).size() != 3UL || (~rhs).size() != 3UL ) {
507  BLAZE_THROW_INVALID_ARGUMENT( "Invalid vector size for cross product" );
508  }
509 
510  using ReturnType = const DVecDVecCrossExpr<VT1,VT2,TF>;
511  return ReturnType( ~lhs, ~rhs );
512 }
513 //*************************************************************************************************
514 
515 
516 //*************************************************************************************************
541 template< typename VT1 // Type of the left-hand side dense vector
542  , typename VT2 // Type of the right-hand side dense vector
543  , bool TF > // Transpose flag
544 inline decltype(auto) cross( const DenseVector<VT1,TF>& lhs, const DenseVector<VT2,TF>& rhs )
545 {
546  return lhs % rhs;
547 }
548 //*************************************************************************************************
549 
550 } // namespace blaze
551 
552 #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:254
Header file for auxiliary alias declarations.
If_t< IsComputation_v< VT2 >, const StaticVector< ET2, 3UL, TF >, CT2 > RT
Composite type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:138
Header file for basic type definitions.
typename If< Condition, T1, T2 >::Type If_t
Auxiliary alias template for the If class template.The If_t alias template provides a convenient shor...
Definition: If.h:109
typename T::ResultType ResultType_t
Alias declaration for nested ResultType type definitions.The ResultType_t alias declaration provides ...
Definition: Aliases.h:390
Header file for the serial shim.
DVecDVecCrossExpr(const VT1 &lhs, const VT2 &rhs) noexcept
Constructor for the DVecDVecCrossExpr class.
Definition: DVecDVecCrossExpr.h:155
CompositeType_t< VT1 > CT1
Composite type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:94
Base class for all cross product expression templates.The CrossExpr class serves as a tag for all exp...
Definition: CrossExpr.h:66
static constexpr bool returnExpr
Compilation switch for the selection of the subscript operator return type.
Definition: DVecDVecCrossExpr.h:107
ElementType_t< ResultType > ElementType
Resulting element type.
Definition: DVecDVecCrossExpr.h:120
Header file for the DenseVector base class.
Expression object for dense vector-dense vector cross products.The DVecDVecCrossExpr class represents...
Definition: DVecDVecCrossExpr.h:84
Header file for the Computation base class.
const ResultType CompositeType
Data type for composite expression templates.
Definition: DVecDVecCrossExpr.h:126
typename T::ReturnType ReturnType_t
Alias declaration for nested ReturnType type definitions.The ReturnType_t alias declaration provides ...
Definition: Aliases.h:410
typename T::ElementType ElementType_t
Alias declaration for nested ElementType type definitions.The ElementType_t alias declaration provide...
Definition: Aliases.h:170
ReturnType_t< VT2 > RN2
Return type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:93
Efficient implementation of a fixed-sized vector.The StaticVector class template is the representatio...
Definition: Forward.h:61
LeftOperand leftOperand() const noexcept
Returns the left-hand side dense vector operand.
Definition: DVecDVecCrossExpr.h:212
Constraint on the transpose flag of vector types.
ElementType_t< VT2 > ET2
Element type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:97
If_t< IsExpression_v< VT1 >, const VT1, const VT1 & > LeftOperand
Composite type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:129
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.
#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
Header file for all forward declarations for dense vectors and matrices.
If_t< IsComputation_v< VT1 >, const StaticVector< ET1, 3UL, TF >, CT1 > LT
Composite type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:135
CompositeType_t< VT2 > CT2
Composite type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:95
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:222
ReturnType at(size_t index) const
Checked access to the vector elements.
Definition: DVecDVecCrossExpr.h:189
Constraint on the data type.
static constexpr bool smpAssignable
Compilation switch for the expression template assignment strategy.
Definition: DVecDVecCrossExpr.h:146
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: DVecDVecCrossExpr.h:170
CrossTrait_t< RT1, RT2 > ResultType
Result type for expression template evaluations.
Definition: DVecDVecCrossExpr.h:118
Constraint on the data type.
static constexpr bool simdEnabled
Compilation switch for the expression template evaluation strategy.
Definition: DVecDVecCrossExpr.h:143
Header file for the exception macros of the math module.
Constraint on the data type.
If_t< IsExpression_v< VT2 >, const VT2, const VT2 & > RightOperand
Composite type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:132
typename CrossTrait< T1, T2 >::Type CrossTrait_t
Auxiliary alias declaration for the CrossTrait class template.The CrossTrait_t alias declaration prov...
Definition: CrossTrait.h:164
Header file for the CrossExpr base class.
bool canAlias(const T *alias) const noexcept
Returns whether the expression can alias with the given address alias.
Definition: DVecDVecCrossExpr.h:234
typename T::TransposeType TransposeType_t
Alias declaration for nested TransposeType type definitions.The TransposeType_t alias declaration pro...
Definition: Aliases.h:470
Header file for run time assertion macros.
ReturnType_t< VT1 > RN1
Return type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:92
constexpr size_t size() const noexcept
Returns the current size/dimension of the vector.
Definition: DVecDVecCrossExpr.h:202
typename T::CompositeType CompositeType_t
Alias declaration for nested CompositeType type definitions.The CompositeType_t alias declaration pro...
Definition: Aliases.h:90
Header file for the cross product trait.
const If_t< returnExpr, ExprReturnType, ElementType > ReturnType
Return type for expression template evaluations.
Definition: DVecDVecCrossExpr.h:123
#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
Header file for all forward declarations for expression class templates.
constexpr size_t size(const Matrix< MT, SO > &matrix) noexcept
Returns the total number of elements of the matrix.
Definition: Matrix.h:530
decltype(auto) serial(const DenseMatrix< MT, SO > &dm)
Forces the serial evaluation of the given dense matrix expression dm.
Definition: DMatSerialExpr.h:808
#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
TransposeType_t< ResultType > TransposeType
Transpose type for expression template evaluations.
Definition: DVecDVecCrossExpr.h:119
ResultType_t< VT1 > RT1
Result type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:90
#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
ResultType_t< VT2 > RT2
Result type of the right-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:91
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
Base class for sparse vectors.The SparseVector class is a base class for all arbitrarily sized (N-dim...
Definition: Forward.h:146
ElementType_t< VT1 > ET1
Element type of the left-hand side dense vector expression.
Definition: DVecDVecCrossExpr.h:96
LeftOperand lhs_
Left-hand side dense vector of the cross product expression.
Definition: DVecDVecCrossExpr.h:253
bool isAliased(const T *alias) const noexcept
Returns whether the expression is aliased with the given address alias.
Definition: DVecDVecCrossExpr.h:246
decltype((std::declval< RN1 >() *std::declval< RN2 >()) -(std::declval< RN1 >() *std::declval< RN2 >())) ExprReturnType
Expression return type for the subscript operator.
Definition: DVecDVecCrossExpr.h:111
#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,...
Definition: Assert.h:101
Header file for the IsExpression type trait class.
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:544