All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SVecTransposer.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_SVECTRANSPOSER_H_
36 #define _BLAZE_MATH_EXPRESSIONS_SVECTRANSPOSER_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
47 #include <blaze/math/Functions.h>
50 #include <blaze/util/Assert.h>
51 #include <blaze/util/EnableIf.h>
52 #include <blaze/util/Types.h>
54 
55 
56 namespace blaze {
57 
58 //=================================================================================================
59 //
60 // CLASS SVECTRANSPOSER
61 //
62 //=================================================================================================
63 
64 //*************************************************************************************************
70 template< typename VT // Type of the sparse vector
71  , bool TF > // Transpose flag
72 class SVecTransposer : public SparseVector< SVecTransposer<VT,TF>, TF >
73 {
74  public:
75  //**Type definitions****************************************************************************
77  typedef typename VT::TransposeType ResultType;
78  typedef typename VT::ResultType TransposeType;
79  typedef typename VT::ElementType ElementType;
80  typedef typename VT::ReturnType ReturnType;
81  typedef const This& CompositeType;
82  typedef typename VT::Reference Reference;
84  typedef typename VT::Iterator Iterator;
85  typedef typename VT::ConstIterator ConstIterator;
86  //**********************************************************************************************
87 
88  //**Compilation flags***************************************************************************
90 
93  enum { smpAssignable = VT::smpAssignable };
94  //**********************************************************************************************
95 
96  //**Constructor*********************************************************************************
101  explicit inline SVecTransposer( VT& sv )
102  : sv_( sv ) // The sparse vector operand
103  {}
104  //**********************************************************************************************
105 
106  //**Subscript operator**************************************************************************
112  inline ConstReference operator[]( size_t index ) const {
113  BLAZE_USER_ASSERT( index < sv_.size(), "Invalid vector access index" );
114  return sv_[index];
115  }
116  //**********************************************************************************************
117 
118  //**Begin function******************************************************************************
123  inline ConstIterator begin() const {
124  return sv_.cbegin();
125  }
126  //**********************************************************************************************
127 
128  //**Cbegin function*****************************************************************************
133  inline ConstIterator cbegin() const {
134  return sv_.cbegin();
135  }
136  //**********************************************************************************************
137 
138  //**End function********************************************************************************
143  inline ConstIterator end() const {
144  return sv_.cend();
145  }
146  //**********************************************************************************************
147 
148  //**Cend function*******************************************************************************
153  inline ConstIterator cend() const {
154  return sv_.cend();
155  }
156  //**********************************************************************************************
157 
158  //**Multiplication assignment operator**********************************************************
165  template< typename Other > // Data type of the right-hand side scalar
166  inline typename EnableIf< IsNumeric<Other>, SVecTransposer >::Type& operator*=( Other rhs )
167  {
168  (~sv_) *= rhs;
169  return *this;
170  }
171  //**********************************************************************************************
172 
173  //**Division assignment operator****************************************************************
182  template< typename Other > // Data type of the right-hand side scalar
183  inline typename EnableIf< IsNumeric<Other>, SVecTransposer >::Type& operator/=( Other rhs )
184  {
185  BLAZE_USER_ASSERT( rhs != Other(0), "Division by zero detected" );
186 
187  (~sv_) /= rhs;
188  return *this;
189  }
190  //**********************************************************************************************
191 
192  //**Size function*******************************************************************************
197  inline size_t size() const {
198  return sv_.size();
199  }
200  //**********************************************************************************************
201 
202  //**Reset function******************************************************************************
207  inline void reset() {
208  return sv_.reset();
209  }
210  //**********************************************************************************************
211 
212  //**Insert function*****************************************************************************
224  inline Iterator insert( size_t index, const ElementType& value ) {
225  return sv_.insert( index, value );
226  }
227  //**********************************************************************************************
228 
229  //**Find function*******************************************************************************
242  inline Iterator find( size_t index ) {
243  return sv_.find( index );
244  }
245  //**********************************************************************************************
246 
247  //**Reserve function****************************************************************************
256  inline void reserve( size_t nonzeros ) {
257  sv_.reserve( nonzeros );
258  }
259  //**********************************************************************************************
260 
261  //**Append function*****************************************************************************
286  inline void append( size_t index, const ElementType& value, bool check=false ) {
287  sv_.append( index, value, check );
288  }
289  //**********************************************************************************************
290 
291  //**IsAliased function**************************************************************************
297  template< typename Other > // Data type of the foreign expression
298  inline bool canAlias( const Other* alias ) const
299  {
300  return sv_.canAlias( alias );
301  }
302  //**********************************************************************************************
303 
304  //**IsAliased function**************************************************************************
310  template< typename Other > // Data type of the foreign expression
311  inline bool isAliased( const Other* alias ) const
312  {
313  return sv_.isAliased( alias );
314  }
315  //**********************************************************************************************
316 
317  //**Transpose assignment of dense vectors*******************************************************
328  template< typename VT2 > // Type of the right-hand side dense vector
329  inline void assign( const DenseVector<VT2,TF>& rhs )
330  {
332 
333  BLAZE_INTERNAL_ASSERT( sv_.size() == (~rhs).size(), "Invalid vector sizes" );
334 
335  size_t nonzeros( 0UL );
336 
337  for( size_t i=0UL; i<sv_.size(); ++i ) {
338  if( !isDefault( (~rhs)[i] ) ) {
339  if( nonzeros++ == sv_.capacity() )
340  sv_.reserve( extendCapacity() );
341  sv_.append( i, (~rhs)[i] );
342  }
343  }
344  }
345  //**********************************************************************************************
346 
347  //**Transpose assignment of sparse vectors******************************************************
358  template< typename VT2 > // Type of the right-hand side sparse vector
359  inline void assign( const SparseVector<VT2,TF>& rhs )
360  {
362 
363  BLAZE_INTERNAL_ASSERT( sv_.size() == (~rhs).size(), "Invalid vector sizes" );
364 
365  // Using the following formulation instead of a std::copy function call of the form
366  //
367  // end_ = std::copy( (~rhs).begin(), (~rhs).end(), begin_ );
368  //
369  // results in much less requirements on the ConstIterator type provided from the right-hand
370  // sparse vector type
371  for( typename VT2::ConstIterator element=(~rhs).begin(); element!=(~rhs).end(); ++element )
372  sv_.append( element->index(), element->value() );
373  }
374  //**********************************************************************************************
375 
376  private:
377  //**********************************************************************************************
385  inline size_t extendCapacity() const
386  {
387  using blaze::max;
388  using blaze::min;
389 
390  size_t nonzeros( 2UL*sv_.capacity()+1UL );
391  nonzeros = max( nonzeros, 7UL );
392  nonzeros = min( nonzeros, sv_.size() );
393 
394  BLAZE_INTERNAL_ASSERT( nonzeros > sv_.capacity(), "Invalid capacity value" );
395 
396  return nonzeros;
397  }
398  //**********************************************************************************************
399 
400  //**Member variables****************************************************************************
401  VT& sv_;
402  //**********************************************************************************************
403 
404  //**Compile time checks*************************************************************************
410  //**********************************************************************************************
411 };
412 //*************************************************************************************************
413 
414 
415 
416 
417 //=================================================================================================
418 //
419 // GLOBAL OPERATORS
420 //
421 //=================================================================================================
422 
423 //*************************************************************************************************
431 template< typename VT // Type of the sparse vector
432  , bool TF > // Transpose flag
433 inline void reset( SVecTransposer<VT,TF>& v )
434 {
435  v.reset();
436 }
438 //*************************************************************************************************
439 
440 
441 
442 
443 //=================================================================================================
444 //
445 // SUBVECTORTRAIT SPECIALIZATIONS
446 //
447 //=================================================================================================
448 
449 //*************************************************************************************************
451 template< typename VT, bool TF >
452 struct SubvectorTrait< SVecTransposer<VT,TF> >
453 {
455 };
457 //*************************************************************************************************
458 
459 } // namespace blaze
460 
461 #endif
Constraint on the data type.
Header file for mathematical functions.
void reset(DynamicMatrix< Type, SO > &m)
Resetting the given dense matrix.
Definition: DynamicMatrix.h:4579
#define BLAZE_USER_ASSERT(expr, msg)
Run time assertion macro for user checks.In case of an invalid run time expression, the program execution is terminated. The BLAZE_USER_ASSERT macro can be disabled by setting the BLAZE_USER_ASSERT flag to zero or by defining NDEBUG during the compilation.
Definition: Assert.h:117
Header file for the SparseVector base class.
bool canAlias(const Other *alias) const
Returns whether the vector can alias with the given address alias.
Definition: SVecTransposer.h:298
void assign(const DenseVector< VT2, TF > &rhs)
Implementation of the transpose assignment of a dense vector.
Definition: SVecTransposer.h:329
size_t size() const
Returns the current size/dimension of the vector.
Definition: SVecTransposer.h:197
ConstIterator begin() const
Returns an iterator to the first non-zero element of the sparse vector.
Definition: SVecTransposer.h:123
bool isDefault(const DynamicMatrix< Type, SO > &m)
Returns whether the given dense matrix is in default state.
Definition: DynamicMatrix.h:4622
VT::ElementType ElementType
Resulting element type.
Definition: SVecTransposer.h:79
ConstIterator cend() const
Returns an iterator just past the last non-zero element of the sparse vector.
Definition: SVecTransposer.h:153
#define BLAZE_CONSTRAINT_MUST_NOT_BE_COMPUTATION_TYPE(T)
Constraint on the data type.In case the given data type T is a computational expression (i...
Definition: Computation.h:118
Iterator find(size_t index)
Inserting an element into the sparse vector.
Definition: SVecTransposer.h:242
VT::TransposeType ResultType
Result type for expression template evaluations.
Definition: SVecTransposer.h:77
VT & sv_
The sparse vector operand.
Definition: SVecTransposer.h:401
void append(size_t index, const ElementType &value, bool check=false)
Appending an element to the sparse vector.
Definition: SVecTransposer.h:286
void reserve(size_t nonzeros)
Setting the minimum capacity of the sparse vector.
Definition: SVecTransposer.h:256
bool isAliased(const Other *alias) const
Returns whether the vector is aliased with the given address alias.
Definition: SVecTransposer.h:311
EnableIf< IsNumeric< Other >, SVecTransposer >::Type & operator/=(Other rhs)
Division assignment operator for the division of a vector by a scalar value ( ).
Definition: SVecTransposer.h:183
void assign(const SparseVector< VT2, TF > &rhs)
Implementation of the transpose assignment of a sparse vector.
Definition: SVecTransposer.h:359
ConstIterator cbegin() const
Returns an iterator to the first non-zero element of the sparse vector.
Definition: SVecTransposer.h:133
const Element * ConstIterator
Iterator over constant elements.
Definition: CompressedMatrix.h:2388
Header file for the subvector trait.
Expression object for the transposition of a sparse vector.The SVecTransposer class is a wrapper obje...
Definition: Forward.h:119
VT::ReturnType ReturnType
Return type for expression template evaluations.
Definition: SVecTransposer.h:80
Base class for N-dimensional dense vectors.The DenseVector class is a base class for all arbitrarily ...
Definition: DenseVector.h:70
#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:79
Constraint on the data type.
CompressedMatrix< Type, false > TransposeType
Transpose type for expression template evaluations.
Definition: CompressedMatrix.h:2381
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:2382
SVecTransposer(VT &sv)
Constructor for the SVecTransposer class.
Definition: SVecTransposer.h:101
VT::ConstReference ConstReference
Reference to a constant matrix value.
Definition: SVecTransposer.h:83
Constraint on the data type.
const Type & ConstReference
Reference to a constant matrix value.
Definition: CompressedMatrix.h:2386
Header file for the EnableIf class template.
Header file for the IsNumeric type trait.
Iterator insert(size_t index, const ElementType &value)
Inserting an element into the sparse vector.
Definition: SVecTransposer.h:224
VT::ConstIterator ConstIterator
Iterator over constant elements.
Definition: SVecTransposer.h:85
const Type & ReturnType
Return type for expression template evaluations.
Definition: CompressedMatrix.h:2383
Header file for run time assertion macros.
Substitution Failure Is Not An Error (SFINAE) class.The EnableIf class template is an auxiliary tool ...
Definition: EnableIf.h:184
EnableIf< IsNumeric< Other >, SVecTransposer >::Type & operator*=(Other rhs)
Multiplication assignment operator for the multiplication between a vector and a scalar value ( )...
Definition: SVecTransposer.h:166
const VT::ElementType max(const SparseVector< VT, TF > &sv)
Returns the largest element of the sparse vector.
Definition: SparseVector.h:405
Element * Iterator
Iterator over non-constant elements.
Definition: CompressedMatrix.h:2387
Header file for the isDefault shim.
SVecTransposer< VT, TF > This
Type of this SVecTransposer instance.
Definition: SVecTransposer.h:76
VT::Reference Reference
Reference to a non-constant matrix value.
Definition: SVecTransposer.h:82
void reset()
Resets the vector elements.
Definition: SVecTransposer.h:207
VT::ResultType TransposeType
Transpose type for expression template evaluations.
Definition: SVecTransposer.h:78
ConstReference operator[](size_t index) const
Subscript operator for the direct access to the vector elements.
Definition: SVecTransposer.h:112
VT::Iterator Iterator
Iterator over non-constant elements.
Definition: SVecTransposer.h:84
Base class for sparse vectors.The SparseVector class is a base class for all arbitrarily sized (N-dim...
Definition: Forward.h:105
This ResultType
Result type for expression template evaluations.
Definition: CompressedMatrix.h:2379
Header file for basic type definitions.
MatrixAccessProxy< This > Reference
Reference to a non-constant matrix value.
Definition: CompressedMatrix.h:2385
const VT::ElementType min(const SparseVector< VT, TF > &sv)
Returns the smallest element of the sparse vector.
Definition: SparseVector.h:348
const This & CompositeType
Data type for composite expression templates.
Definition: SVecTransposer.h:81
ConstIterator end() const
Returns an iterator just past the last non-zero element of the sparse vector.
Definition: SVecTransposer.h:143
#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:238
#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
size_t extendCapacity() const
Calculating a new vector capacity.
Definition: SVecTransposer.h:385