Blaze 3.9
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 <utility>
44#include <blaze/math/Aliases.h>
63#include <blaze/util/Assert.h>
64#include <blaze/util/EnableIf.h>
67#include <blaze/util/mpl/If.h>
68#include <blaze/util/Types.h>
69
70
71namespace blaze {
72
73//=================================================================================================
74//
75// CLASS SVECSVECCROSSEXPR
76//
77//=================================================================================================
78
79//*************************************************************************************************
86template< typename VT1 // Type of the left-hand side sparse vector
87 , typename VT2 // Type of the right-hand side sparse vector
88 , bool TF > // Transpose flag
90 : public CrossExpr< DenseVector< SVecSVecCrossExpr<VT1,VT2,TF>, TF > >
91 , private Computation
92{
93 private:
94 //**Type definitions****************************************************************************
103 //**********************************************************************************************
104
105 //**Return type evaluation**********************************************************************
107
112 static constexpr bool returnExpr = ( !IsTemporary_v<RN1> && !IsTemporary_v<RN2> );
113
115 using ExprReturnType = decltype( ( std::declval<RN1>() * std::declval<RN2>() ) -
116 ( std::declval<RN1>() * std::declval<RN2>() ) );
117 //**********************************************************************************************
118
119 public:
120 //**Type definitions****************************************************************************
123
126
130
133
136
138 using LeftOperand = If_t< IsExpression_v<VT1>, const VT1, const VT1& >;
139
141 using RightOperand = If_t< IsExpression_v<VT2>, const VT2, const VT2& >;
142
145
148 //**********************************************************************************************
149
150 //**Compilation flags***************************************************************************
152 static constexpr bool simdEnabled = false;
153
155 static constexpr bool smpAssignable = false;
156 //**********************************************************************************************
157
158 //**Constructor*********************************************************************************
164 inline SVecSVecCrossExpr( const VT1& lhs, const VT2& rhs ) noexcept
165 : lhs_( lhs ) // Left-hand side sparse vector of the cross product expression
166 , rhs_( rhs ) // Right-hand side sparse vector of the cross product expression
167 {
168 BLAZE_INTERNAL_ASSERT( lhs.size() == 3UL, "Invalid vector size" );
169 BLAZE_INTERNAL_ASSERT( rhs.size() == 3UL, "Invalid vector size" );
170 }
171 //**********************************************************************************************
172
173 //**Subscript operator**************************************************************************
179 inline ReturnType operator[]( size_t index ) const {
180 BLAZE_INTERNAL_ASSERT( index < 3UL, "Invalid vector access index" );
181
182 if( index == 0UL )
183 return lhs_[1UL] * rhs_[2UL] - lhs_[2UL] * rhs_[1UL];
184 else if( index == 1UL )
185 return lhs_[2UL] * rhs_[0UL] - lhs_[0UL] * rhs_[2UL];
186 else
187 return lhs_[0UL] * rhs_[1UL] - lhs_[1UL] * rhs_[0UL];
188 }
189 //**********************************************************************************************
190
191 //**At function*********************************************************************************
198 inline ReturnType at( size_t index ) const {
199 if( index >= 3UL ) {
200 BLAZE_THROW_OUT_OF_RANGE( "Invalid vector access index" );
201 }
202 return (*this)[index];
203 }
204 //**********************************************************************************************
205
206 //**Size function*******************************************************************************
211 constexpr size_t size() const noexcept {
212 return 3UL;
213 }
214 //**********************************************************************************************
215
216 //**Left operand access*************************************************************************
221 inline LeftOperand leftOperand() const noexcept {
222 return lhs_;
223 }
224 //**********************************************************************************************
225
226 //**Right operand access************************************************************************
231 inline RightOperand rightOperand() const noexcept {
232 return rhs_;
233 }
234 //**********************************************************************************************
235
236 //**********************************************************************************************
242 template< typename T >
243 inline bool canAlias( const T* alias ) const noexcept {
244 return ( lhs_.canAlias( alias ) || rhs_.canAlias( alias ) );
245 }
246 //**********************************************************************************************
247
248 //**********************************************************************************************
254 template< typename T >
255 inline bool isAliased( const T* alias ) const noexcept {
256 return ( lhs_.isAliased( alias ) || rhs_.isAliased( alias ) );
257 }
258 //**********************************************************************************************
259
260 private:
261 //**Member variables****************************************************************************
264 //**********************************************************************************************
265
266 //**Assignment to dense vectors*****************************************************************
278 template< typename VT > // Type of the target dense vector
279 friend inline void assign( DenseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
280 {
282
283 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
284 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
285
286 LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
287 RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side sparse vector operand
288
289 (*lhs)[0] = x[1UL]*y[2UL] - x[2UL]*y[1UL];
290 (*lhs)[1] = x[2UL]*y[0UL] - x[0UL]*y[2UL];
291 (*lhs)[2] = x[0UL]*y[1UL] - x[1UL]*y[0UL];
292 }
294 //**********************************************************************************************
295
296 //**Assignment to sparse vectors****************************************************************
308 template< typename VT > // Type of the target sparse vector
309 friend inline void assign( SparseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
310 {
312
316
317 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
318 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
319
320 const ResultType tmp( serial( rhs ) );
321 assign( *lhs, tmp );
322 }
324 //**********************************************************************************************
325
326 //**Addition assignment to dense vectors********************************************************
338 template< typename VT > // Type of the target dense vector
339 friend inline void addAssign( DenseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
340 {
342
343 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
344 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
345
346 LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
347 RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side sparse vector operand
348
349 (*lhs)[0] += x[1UL]*y[2UL] - x[2UL]*y[1UL];
350 (*lhs)[1] += x[2UL]*y[0UL] - x[0UL]*y[2UL];
351 (*lhs)[2] += x[0UL]*y[1UL] - x[1UL]*y[0UL];
352 }
354 //**********************************************************************************************
355
356 //**Addition assignment to sparse vectors*******************************************************
357 // No special implementation for the addition assignment to sparse vectors.
358 //**********************************************************************************************
359
360 //**Subtraction assignment to dense vectors*****************************************************
372 template< typename VT > // Type of the target dense vector
373 friend inline void subAssign( DenseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
374 {
376
377 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
378 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
379
380 LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
381 RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side sparse vector operand
382
383 (*lhs)[0] -= x[1UL]*y[2UL] - x[2UL]*y[1UL];
384 (*lhs)[1] -= x[2UL]*y[0UL] - x[0UL]*y[2UL];
385 (*lhs)[2] -= x[0UL]*y[1UL] - x[1UL]*y[0UL];
386 }
388 //**********************************************************************************************
389
390 //**Subtraction assignment to sparse vectors****************************************************
391 // No special implementation for the subtraction assignment to sparse vectors.
392 //**********************************************************************************************
393
394 //**Multiplication assignment to dense vectors**************************************************
406 template< typename VT > // Type of the target dense vector
407 friend inline void multAssign( DenseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
408 {
410
411 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
412 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
413
414 LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
415 RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side sparse vector operand
416
417 (*lhs)[0] *= x[1UL]*y[2UL] - x[2UL]*y[1UL];
418 (*lhs)[1] *= x[2UL]*y[0UL] - x[0UL]*y[2UL];
419 (*lhs)[2] *= x[0UL]*y[1UL] - x[1UL]*y[0UL];
420 }
422 //**********************************************************************************************
423
424 //**Multiplication assignment to sparse vectors*************************************************
425 // No special implementation for the multiplication assignment to sparse vectors.
426 //**********************************************************************************************
427
428 //**Division assignment to dense vectors********************************************************
440 template< typename VT > // Type of the target dense vector
441 friend inline void divAssign( DenseVector<VT,TF>& lhs, const SVecSVecCrossExpr& rhs )
442 {
444
445 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
446 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
447
448 LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
449 RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side sparse vector operand
450
451 (*lhs)[0] /= x[1UL]*y[2UL] - x[2UL]*y[1UL];
452 (*lhs)[1] /= x[2UL]*y[0UL] - x[0UL]*y[2UL];
453 (*lhs)[2] /= x[0UL]*y[1UL] - x[1UL]*y[0UL];
454 }
456 //**********************************************************************************************
457
458 //**Division assignment to sparse vectors*******************************************************
459 // No special implementation for the division assignment to sparse vectors.
460 //**********************************************************************************************
461
462 //**Compile time checks*************************************************************************
471 //**********************************************************************************************
472};
473//*************************************************************************************************
474
475
476
477
478//=================================================================================================
479//
480// GLOBAL BINARY ARITHMETIC OPERATORS
481//
482//=================================================================================================
483
484//*************************************************************************************************
497template< typename VT1 // Type of the left-hand side sparse vector
498 , typename VT2 // Type of the right-hand side sparse vector
499 , bool TF // Transpose flag
500 , DisableIf_t< IsZero_v<VT1> || IsZero_v<VT2> >* = nullptr >
501inline const SVecSVecCrossExpr<VT1,VT2,TF>
502 svecsveccross( const SparseVector<VT1,TF>& lhs, const SparseVector<VT2,TF>& rhs )
503{
505
506 BLAZE_INTERNAL_ASSERT( (*lhs).size() == (*rhs).size(), "Invalid vector sizes" );
507
508 return SVecSVecCrossExpr<VT1,VT2,TF>( *lhs, *rhs );
509}
511//*************************************************************************************************
512
513
514//*************************************************************************************************
527template< typename VT1 // Type of the left-hand side sparse vector
528 , typename VT2 // Type of the right-hand side sparse vector
529 , bool TF // Transpose flag
530 , EnableIf_t< IsZero_v<VT1> || IsZero_v<VT2> >* = nullptr >
531inline decltype(auto)
532 svecsveccross( const SparseVector<VT1,TF>& lhs, const SparseVector<VT2,TF>& rhs )
533{
535
536 MAYBE_UNUSED( lhs, rhs );
537
538 BLAZE_INTERNAL_ASSERT( (*lhs).size() == (*rhs).size(), "Invalid vector sizes" );
539
540 using ReturnType = const CrossTrait_t< ResultType_t<VT1>, ResultType_t<VT2> >;
541
544
545 return ReturnType( 3UL );
546}
548//*************************************************************************************************
549
550
551//*************************************************************************************************
576template< typename VT1 // Type of the left-hand side sparse vector
577 , typename VT2 // Type of the right-hand side sparse vector
578 , bool TF > // Transpose flag
579inline decltype(auto)
580 operator%( const SparseVector<VT1,TF>& lhs, const SparseVector<VT2,TF>& rhs )
581{
583
584 if( (*lhs).size() != 3UL || (*rhs).size() != 3UL ) {
585 BLAZE_THROW_INVALID_ARGUMENT( "Invalid vector size for cross product" );
586 }
587
588 return svecsveccross( *lhs, *rhs );
589}
590//*************************************************************************************************
591
592} // namespace blaze
593
594#endif
Header file for auxiliary alias declarations.
typename T::CompositeType CompositeType_t
Alias declaration for nested CompositeType type definitions.
Definition: Aliases.h:110
typename T::ReturnType ReturnType_t
Alias declaration for nested ReturnType type definitions.
Definition: Aliases.h:470
typename T::ResultType ResultType_t
Alias declaration for nested ResultType type definitions.
Definition: Aliases.h:450
typename T::ElementType ElementType_t
Alias declaration for nested ElementType type definitions.
Definition: Aliases.h:190
typename T::TransposeType TransposeType_t
Alias declaration for nested TransposeType type definitions.
Definition: Aliases.h:550
Header file for run time assertion macros.
Constraint on the transpose flag of vector types.
Header file for the cross product trait.
Header file for the EnableIf class template.
Header file for the function trace functionality.
Header file for the If class template.
Header file for the IsExpression type trait class.
Header file for the IsTemporary type trait class.
Deactivation of problematic macros.
Header file for the MAYBE_UNUSED function template.
Constraint on the data type.
Base class for N-dimensional dense vectors.
Definition: DenseVector.h:77
Expression object for sparse vector-sparse vector cross products.
Definition: SVecSVecCrossExpr.h:92
const StaticVector< ET2, 3UL, TF > RT
Composite type of the right-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:147
ReturnType at(size_t index) const
Checked access to the vector elements.
Definition: SVecSVecCrossExpr.h:198
SVecSVecCrossExpr(const VT1 &lhs, const VT2 &rhs) noexcept
Constructor for the SVecSVecCrossExpr class.
Definition: SVecSVecCrossExpr.h:164
const StaticVector< ET1, 3UL, TF > LT
Composite type of the left-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:144
CompositeType_t< VT1 > CT1
Composite type of the left-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:99
RightOperand rhs_
Right-hand side sparse vector of the cross product expression.
Definition: SVecSVecCrossExpr.h:263
RightOperand rightOperand() const noexcept
Returns the right-hand side sparse vector operand.
Definition: SVecSVecCrossExpr.h:231
LeftOperand lhs_
Left-hand side sparse vector of the cross product expression.
Definition: SVecSVecCrossExpr.h:262
static constexpr bool returnExpr
Compilation switch for the selection of the subscript operator return type.
Definition: SVecSVecCrossExpr.h:112
decltype((std::declval< RN1 >() *std::declval< RN2 >()) -(std::declval< RN1 >() *std::declval< RN2 >())) ExprReturnType
Expression return type for the subscript operator.
Definition: SVecSVecCrossExpr.h:116
constexpr size_t size() const noexcept
Returns the current size/dimension of the vector.
Definition: SVecSVecCrossExpr.h:211
TransposeType_t< ResultType > TransposeType
Transpose type for expression template evaluations.
Definition: SVecSVecCrossExpr.h:128
CompositeType_t< VT2 > CT2
Composite type of the right-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:100
ElementType_t< ResultType > ElementType
Resulting element type.
Definition: SVecSVecCrossExpr.h:129
ReturnType_t< VT1 > RN1
Return type of the left-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:97
bool canAlias(const T *alias) const noexcept
Returns whether the expression can alias with the given address alias.
Definition: SVecSVecCrossExpr.h:243
bool isAliased(const T *alias) const noexcept
Returns whether the expression is aliased with the given address alias.
Definition: SVecSVecCrossExpr.h:255
LeftOperand leftOperand() const noexcept
Returns the left-hand side sparse vector operand.
Definition: SVecSVecCrossExpr.h:221
ResultType_t< VT2 > RT2
Result type of the right-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:96
const If_t< returnExpr, ExprReturnType, ElementType > ReturnType
Return type for expression template evaluations.
Definition: SVecSVecCrossExpr.h:132
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: SVecSVecCrossExpr.h:179
static constexpr bool simdEnabled
Compilation switch for the expression template evaluation strategy.
Definition: SVecSVecCrossExpr.h:152
If_t< IsExpression_v< VT1 >, const VT1, const VT1 & > LeftOperand
Composite type of the left-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:138
ElementType_t< VT1 > ET1
Element type of the left-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:101
If_t< IsExpression_v< VT2 >, const VT2, const VT2 & > RightOperand
Composite type of the right-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:141
ReturnType_t< VT2 > RN2
Return type of the right-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:98
ElementType_t< VT2 > ET2
Element type of the right-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:102
ResultType_t< VT1 > RT1
Result type of the left-hand side sparse vector expression.
Definition: SVecSVecCrossExpr.h:95
const ResultType CompositeType
Data type for composite expression templates.
Definition: SVecSVecCrossExpr.h:135
CrossTrait_t< RT1, RT2 > ResultType
Result type for expression template evaluations.
Definition: SVecSVecCrossExpr.h:127
static constexpr bool smpAssignable
Compilation switch for the expression template assignment strategy.
Definition: SVecSVecCrossExpr.h:155
Base class for sparse vectors.
Definition: SparseVector.h:72
Efficient implementation of a fixed-sized vector.
Definition: StaticVector.h:230
Constraint on the data type.
Constraint on the data type.
Constraint on the data type.
Header file for the Computation base class.
Header file for the CrossExpr base class.
Header file for the DenseVector base class.
decltype(auto) serial(const DenseMatrix< MT, SO > &dm)
Forces the serial evaluation of the given dense matrix expression dm.
Definition: DMatSerialExpr.h:812
#define BLAZE_CONSTRAINT_MUST_NOT_REQUIRE_EVALUATION(T)
Constraint on the data type.
Definition: RequiresEvaluation.h:81
#define BLAZE_CONSTRAINT_MUST_BE_VECTOR_WITH_TRANSPOSE_FLAG(T, TF)
Constraint on the data type.
Definition: TransposeFlag.h:63
#define BLAZE_CONSTRAINT_MUST_NOT_BE_ZERO_TYPE(T)
Constraint on the data type.
Definition: Zero.h:81
#define BLAZE_CONSTRAINT_MUST_BE_SPARSE_VECTOR_TYPE(T)
Constraint on the data type.
Definition: SparseVector.h:61
#define BLAZE_CONSTRAINT_MUST_BE_DENSE_VECTOR_TYPE(T)
Constraint on the data type.
Definition: DenseVector.h:61
#define BLAZE_CONSTRAINT_MUST_BE_ZERO_TYPE(T)
Constraint on the data type.
Definition: Zero.h:61
typename CrossTrait< T1, T2 >::Type CrossTrait_t
Auxiliary alias declaration for the CrossTrait class template.
Definition: CrossTrait.h:138
#define BLAZE_INTERNAL_ASSERT(expr, msg)
Run time assertion macro for internal checks.
Definition: Assert.h:101
constexpr void MAYBE_UNUSED(const Args &...)
Suppression of unused parameter warnings.
Definition: MaybeUnused.h:81
typename If< Condition >::template Type< T1, T2 > If_t
Auxiliary alias template for the If class template.
Definition: If.h:108
#define BLAZE_THROW_OUT_OF_RANGE(MESSAGE)
Macro for the emission of a std::out_of_range exception.
Definition: Exception.h:331
#define BLAZE_THROW_INVALID_ARGUMENT(MESSAGE)
Macro for the emission of a std::invalid_argument exception.
Definition: Exception.h:235
#define BLAZE_FUNCTION_TRACE
Function trace macro.
Definition: FunctionTrace.h:94
Header file for the exception macros of the math module.
Constraint on the data type.
Header file for all forward declarations for dense vectors and matrices.
Header file for all forward declarations for expression class templates.
Header file for the serial shim.
Base class for all compute expression templates.
Definition: Computation.h:68
Base class for all cross product expression templates.
Definition: CrossExpr.h:68
Header file for the IsZero type trait.
Header file for basic type definitions.