Blaze 3.9
SVecDVecCrossExpr.h
Go to the documentation of this file.
1//=================================================================================================
33//=================================================================================================
34
35#ifndef _BLAZE_MATH_EXPRESSIONS_SVECDVECCROSSEXPR_H_
36#define _BLAZE_MATH_EXPRESSIONS_SVECDVECCROSSEXPR_H_
37
38
39//*************************************************************************************************
40// Includes
41//*************************************************************************************************
42
43#include <utility>
44#include <blaze/math/Aliases.h>
64#include <blaze/util/Assert.h>
65#include <blaze/util/EnableIf.h>
68#include <blaze/util/mpl/If.h>
69#include <blaze/util/Types.h>
70
71
72namespace blaze {
73
74//=================================================================================================
75//
76// CLASS SVECDVECCROSSEXPR
77//
78//=================================================================================================
79
80//*************************************************************************************************
87template< typename VT1 // Type of the left-hand side sparse vector
88 , typename VT2 // Type of the right-hand side dense vector
89 , bool TF > // Transpose flag
91 : public CrossExpr< DenseVector< SVecDVecCrossExpr<VT1,VT2,TF>, TF > >
92 , private Computation
93{
94 private:
95 //**Type definitions****************************************************************************
104 //**********************************************************************************************
105
106 //**Return type evaluation**********************************************************************
108
113 static constexpr bool returnExpr = ( !IsTemporary_v<RN1> && !IsTemporary_v<RN2> );
114
116 using ExprReturnType = decltype( ( std::declval<RN1>() * std::declval<RN2>() ) -
117 ( std::declval<RN1>() * std::declval<RN2>() ) );
118 //**********************************************************************************************
119
120 public:
121 //**Type definitions****************************************************************************
124
127
131
134
137
139 using LeftOperand = If_t< IsExpression_v<VT1>, const VT1, const VT1& >;
140
142 using RightOperand = If_t< IsExpression_v<VT2>, const VT2, const VT2& >;
143
146
149 //**********************************************************************************************
150
151 //**Compilation flags***************************************************************************
153 static constexpr bool simdEnabled = false;
154
156 static constexpr bool smpAssignable = false;
157 //**********************************************************************************************
158
159 //**Constructor*********************************************************************************
165 inline SVecDVecCrossExpr( const VT1& lhs, const VT2& rhs ) noexcept
166 : lhs_( lhs ) // Left-hand side sparse vector of the cross product expression
167 , rhs_( rhs ) // Right-hand side dense vector of the cross product expression
168 {
169 BLAZE_INTERNAL_ASSERT( lhs.size() == 3UL, "Invalid vector size" );
170 BLAZE_INTERNAL_ASSERT( rhs.size() == 3UL, "Invalid vector size" );
171 }
172 //**********************************************************************************************
173
174 //**Subscript operator**************************************************************************
180 inline ReturnType operator[]( size_t index ) const {
181 BLAZE_INTERNAL_ASSERT( index < 3UL, "Invalid vector access index" );
182
183 if( index == 0UL )
184 return lhs_[1UL] * rhs_[2UL] - lhs_[2UL] * rhs_[1UL];
185 else if( index == 1UL )
186 return lhs_[2UL] * rhs_[0UL] - lhs_[0UL] * rhs_[2UL];
187 else
188 return lhs_[0UL] * rhs_[1UL] - lhs_[1UL] * rhs_[0UL];
189 }
190 //**********************************************************************************************
191
192 //**At function*********************************************************************************
199 inline ReturnType at( size_t index ) const {
200 if( index >= 3UL ) {
201 BLAZE_THROW_OUT_OF_RANGE( "Invalid vector access index" );
202 }
203 return (*this)[index];
204 }
205 //**********************************************************************************************
206
207 //**Size function*******************************************************************************
212 constexpr size_t size() const noexcept {
213 return 3UL;
214 }
215 //**********************************************************************************************
216
217 //**Left operand access*************************************************************************
222 inline LeftOperand leftOperand() const noexcept {
223 return lhs_;
224 }
225 //**********************************************************************************************
226
227 //**Right operand access************************************************************************
232 inline RightOperand rightOperand() const noexcept {
233 return rhs_;
234 }
235 //**********************************************************************************************
236
237 //**********************************************************************************************
243 template< typename T >
244 inline bool canAlias( const T* alias ) const noexcept {
245 return ( lhs_.canAlias( alias ) || rhs_.canAlias( alias ) );
246 }
247 //**********************************************************************************************
248
249 //**********************************************************************************************
255 template< typename T >
256 inline bool isAliased( const T* alias ) const noexcept {
257 return ( lhs_.isAliased( alias ) || rhs_.isAliased( alias ) );
258 }
259 //**********************************************************************************************
260
261 private:
262 //**Member variables****************************************************************************
265 //**********************************************************************************************
266
267 //**Assignment to dense vectors*****************************************************************
279 template< typename VT > // Type of the target dense vector
280 friend inline void assign( DenseVector<VT,TF>& lhs, const SVecDVecCrossExpr& rhs )
281 {
283
284 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
285 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
286
287 LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
288 RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
289
290 (*lhs)[0] = x[1UL]*y[2UL] - x[2UL]*y[1UL];
291 (*lhs)[1] = x[2UL]*y[0UL] - x[0UL]*y[2UL];
292 (*lhs)[2] = x[0UL]*y[1UL] - x[1UL]*y[0UL];
293 }
295 //**********************************************************************************************
296
297 //**Assignment to sparse vectors****************************************************************
309 template< typename VT > // Type of the target sparse vector
310 friend inline void assign( SparseVector<VT,TF>& lhs, const SVecDVecCrossExpr& rhs )
311 {
313
317
318 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
319 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
320
321 const ResultType tmp( serial( rhs ) );
322 assign( *lhs, tmp );
323 }
325 //**********************************************************************************************
326
327 //**Addition assignment to dense vectors********************************************************
339 template< typename VT > // Type of the target dense vector
340 friend inline void addAssign( DenseVector<VT,TF>& lhs, const SVecDVecCrossExpr& rhs )
341 {
343
344 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
345 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
346
347 LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
348 RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
349
350 (*lhs)[0] += x[1UL]*y[2UL] - x[2UL]*y[1UL];
351 (*lhs)[1] += x[2UL]*y[0UL] - x[0UL]*y[2UL];
352 (*lhs)[2] += x[0UL]*y[1UL] - x[1UL]*y[0UL];
353 }
355 //**********************************************************************************************
356
357 //**Addition assignment to sparse vectors*******************************************************
358 // No special implementation for the addition assignment to sparse vectors.
359 //**********************************************************************************************
360
361 //**Subtraction assignment to dense vectors*****************************************************
373 template< typename VT > // Type of the target dense vector
374 friend inline void subAssign( DenseVector<VT,TF>& lhs, const SVecDVecCrossExpr& rhs )
375 {
377
378 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
379 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
380
381 LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
382 RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
383
384 (*lhs)[0] -= x[1UL]*y[2UL] - x[2UL]*y[1UL];
385 (*lhs)[1] -= x[2UL]*y[0UL] - x[0UL]*y[2UL];
386 (*lhs)[2] -= x[0UL]*y[1UL] - x[1UL]*y[0UL];
387 }
389 //**********************************************************************************************
390
391 //**Subtraction assignment to sparse vectors****************************************************
392 // No special implementation for the subtraction assignment to sparse vectors.
393 //**********************************************************************************************
394
395 //**Multiplication assignment to dense vectors**************************************************
407 template< typename VT > // Type of the target dense vector
408 friend inline void multAssign( DenseVector<VT,TF>& lhs, const SVecDVecCrossExpr& rhs )
409 {
411
412 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
413 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
414
415 LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
416 RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
417
418 (*lhs)[0] *= x[1UL]*y[2UL] - x[2UL]*y[1UL];
419 (*lhs)[1] *= x[2UL]*y[0UL] - x[0UL]*y[2UL];
420 (*lhs)[2] *= x[0UL]*y[1UL] - x[1UL]*y[0UL];
421 }
423 //**********************************************************************************************
424
425 //**Multiplication assignment to sparse vectors*************************************************
426 // No special implementation for the multiplication assignment to sparse vectors.
427 //**********************************************************************************************
428
429 //**Division assignment to dense vectors********************************************************
441 template< typename VT > // Type of the target dense vector
442 friend inline void divAssign( DenseVector<VT,TF>& lhs, const SVecDVecCrossExpr& rhs )
443 {
445
446 BLAZE_INTERNAL_ASSERT( (*lhs).size() == 3UL, "Invalid vector size" );
447 BLAZE_INTERNAL_ASSERT( (*rhs).size() == 3UL, "Invalid vector size" );
448
449 LT x( serial( rhs.lhs_ ) ); // Evaluation of the left-hand side sparse vector operand
450 RT y( serial( rhs.rhs_ ) ); // Evaluation of the right-hand side dense vector operand
451
452 (*lhs)[0] /= x[1UL]*y[2UL] - x[2UL]*y[1UL];
453 (*lhs)[1] /= x[2UL]*y[0UL] - x[0UL]*y[2UL];
454 (*lhs)[2] /= x[0UL]*y[1UL] - x[1UL]*y[0UL];
455 }
457 //**********************************************************************************************
458
459 //**Division assignment to sparse vectors*******************************************************
460 // No special implementation for the division assignment to sparse vectors.
461 //**********************************************************************************************
462
463 //**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 dense vector
499 , bool TF // Transpose flag
500 , DisableIf_t< IsZero_v<VT1> >* = nullptr >
501inline const SVecDVecCrossExpr<VT1,VT2,TF>
502 svecdveccross( const SparseVector<VT1,TF>& lhs, const DenseVector<VT2,TF>& rhs )
503{
505
506 BLAZE_INTERNAL_ASSERT( (*lhs).size() == (*rhs).size(), "Invalid vector sizes" );
507
508 return SVecDVecCrossExpr<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 dense vector
529 , bool TF // Transpose flag
530 , EnableIf_t< IsZero_v<VT1> >* = nullptr >
531inline decltype(auto)
532 svecdveccross( const SparseVector<VT1,TF>& lhs, const DenseVector<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//*************************************************************************************************
578template< typename VT1 // Type of the left-hand side sparse vector
579 , typename VT2 // Type of the right-hand side dense vector
580 , bool TF > // Transpose flag
581inline decltype(auto)
582 operator%( const SparseVector<VT1,TF>& lhs, const DenseVector<VT2,TF>& rhs )
583{
585
586 if( (*lhs).size() != 3UL || (*rhs).size() != 3UL ) {
587 BLAZE_THROW_INVALID_ARGUMENT( "Invalid vector size for cross product" );
588 }
589
590 return svecdveccross( *lhs, *rhs );
591}
592//*************************************************************************************************
593
594} // namespace blaze
595
596#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 IsComputation type trait class.
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-dense vector cross products.
Definition: SVecDVecCrossExpr.h:93
constexpr size_t size() const noexcept
Returns the current size/dimension of the vector.
Definition: SVecDVecCrossExpr.h:212
bool isAliased(const T *alias) const noexcept
Returns whether the expression is aliased with the given address alias.
Definition: SVecDVecCrossExpr.h:256
decltype((std::declval< RN1 >() *std::declval< RN2 >()) -(std::declval< RN1 >() *std::declval< RN2 >())) ExprReturnType
Expression return type for the subscript operator.
Definition: SVecDVecCrossExpr.h:117
SVecDVecCrossExpr(const VT1 &lhs, const VT2 &rhs) noexcept
Constructor for the SVecDVecCrossExpr class.
Definition: SVecDVecCrossExpr.h:165
ElementType_t< ResultType > ElementType
Resulting element type.
Definition: SVecDVecCrossExpr.h:130
If_t< IsExpression_v< VT2 >, const VT2, const VT2 & > RightOperand
Composite type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:142
If_t< IsExpression_v< VT1 >, const VT1, const VT1 & > LeftOperand
Composite type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:139
CrossTrait_t< RT1, RT2 > ResultType
Result type for expression template evaluations.
Definition: SVecDVecCrossExpr.h:128
LeftOperand lhs_
Left-hand side sparse vector of the cross product expression.
Definition: SVecDVecCrossExpr.h:263
RightOperand rightOperand() const noexcept
Returns the right-hand side dense vector operand.
Definition: SVecDVecCrossExpr.h:232
ElementType_t< VT2 > ET2
Element type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:103
bool canAlias(const T *alias) const noexcept
Returns whether the expression can alias with the given address alias.
Definition: SVecDVecCrossExpr.h:244
ReturnType at(size_t index) const
Checked access to the vector elements.
Definition: SVecDVecCrossExpr.h:199
CompositeType_t< VT2 > CT2
Composite type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:101
TransposeType_t< ResultType > TransposeType
Transpose type for expression template evaluations.
Definition: SVecDVecCrossExpr.h:129
static constexpr bool smpAssignable
Compilation switch for the expression template assignment strategy.
Definition: SVecDVecCrossExpr.h:156
CompositeType_t< VT1 > CT1
Composite type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:100
ResultType_t< VT2 > RT2
Result type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:97
ElementType_t< VT1 > ET1
Element type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:102
const ResultType CompositeType
Data type for composite expression templates.
Definition: SVecDVecCrossExpr.h:136
RightOperand rhs_
Right-hand side dense vector of the cross product expression.
Definition: SVecDVecCrossExpr.h:264
LeftOperand leftOperand() const noexcept
Returns the left-hand side sparse vector operand.
Definition: SVecDVecCrossExpr.h:222
const StaticVector< ET1, 3UL, TF > LT
Composite type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:145
ReturnType_t< VT2 > RN2
Return type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:99
static constexpr bool returnExpr
Compilation switch for the selection of the subscript operator return type.
Definition: SVecDVecCrossExpr.h:113
ResultType_t< VT1 > RT1
Result type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:96
If_t< IsComputation_v< VT2 >, const StaticVector< ET2, 3UL, TF >, CT2 > RT
Composite type of the right-hand side dense vector expression.
Definition: SVecDVecCrossExpr.h:148
static constexpr bool simdEnabled
Compilation switch for the expression template evaluation strategy.
Definition: SVecDVecCrossExpr.h:153
const If_t< returnExpr, ExprReturnType, ElementType > ReturnType
Return type for expression template evaluations.
Definition: SVecDVecCrossExpr.h:133
ReturnType_t< VT1 > RN1
Return type of the left-hand side sparse vector expression.
Definition: SVecDVecCrossExpr.h:98
ReturnType operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: SVecDVecCrossExpr.h:180
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.