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  //**Constructor*********************************************************************************
93  explicit inline SVecTransposer( VT& sv )
94  : sv_( sv ) // The sparse vector operand
95  {}
96  //**********************************************************************************************
97 
98  //**Subscript operator**************************************************************************
104  inline Reference operator[]( size_t index ) {
105  BLAZE_USER_ASSERT( index < sv_.size(), "Invalid vector access index" );
106  return sv_[index];
107  }
108  //**********************************************************************************************
109 
110  //**Begin function******************************************************************************
115  inline ConstIterator begin() const {
116  return sv_.begin();
117  }
118  //**********************************************************************************************
119 
120  //**End function********************************************************************************
125  inline ConstIterator end() const {
126  return sv_.end();
127  }
128  //**********************************************************************************************
129 
130  //**Multiplication assignment operator**********************************************************
137  template< typename Other > // Data type of the right-hand side scalar
138  inline typename EnableIf< IsNumeric<Other>, SVecTransposer >::Type& operator*=( Other rhs )
139  {
140  (~sv_) *= rhs;
141  return *this;
142  }
143  //**********************************************************************************************
144 
145  //**Division assignment operator****************************************************************
154  template< typename Other > // Data type of the right-hand side scalar
155  inline typename EnableIf< IsNumeric<Other>, SVecTransposer >::Type& operator/=( Other rhs )
156  {
157  BLAZE_USER_ASSERT( rhs != Other(0), "Division by zero detected" );
158 
159  (~sv_) /= rhs;
160  return *this;
161  }
162  //**********************************************************************************************
163 
164  //**Size function*******************************************************************************
169  inline size_t size() const {
170  return sv_.size();
171  }
172  //**********************************************************************************************
173 
174  //**Reset function******************************************************************************
179  inline void reset() {
180  return sv_.reset();
181  }
182  //**********************************************************************************************
183 
184  //**Insert function*****************************************************************************
196  inline Iterator insert( size_t index, const ElementType& value ) {
197  return sv_.insert( index, value );
198  }
199  //**********************************************************************************************
200 
201  //**Find function*******************************************************************************
214  inline Iterator find( size_t index ) {
215  return sv_.find( index );
216  }
217  //**********************************************************************************************
218 
219  //**Reserve function****************************************************************************
228  inline void reserve( size_t nonzeros ) {
229  sv_.reserve( nonzeros );
230  }
231  //**********************************************************************************************
232 
233  //**Append function*****************************************************************************
258  inline void append( size_t index, const ElementType& value, bool check=false ) {
259  sv_.append( index, value, check );
260  }
261  //**********************************************************************************************
262 
263  //**IsAliased function**************************************************************************
269  template< typename Other > // Data type of the foreign expression
270  inline bool canAlias( const Other* alias ) const
271  {
272  return sv_.canAlias( alias );
273  }
274  //**********************************************************************************************
275 
276  //**IsAliased function**************************************************************************
282  template< typename Other > // Data type of the foreign expression
283  inline bool isAliased( const Other* alias ) const
284  {
285  return sv_.isAliased( alias );
286  }
287  //**********************************************************************************************
288 
289  //**Transpose assignment of dense vectors*******************************************************
300  template< typename VT2 > // Type of the right-hand side dense vector
301  inline void assign( const DenseVector<VT2,TF>& rhs )
302  {
304 
305  BLAZE_INTERNAL_ASSERT( sv_.size() == (~rhs).size(), "Invalid vector sizes" );
306 
307  size_t nonzeros( 0UL );
308 
309  for( size_t i=0UL; i<sv_.size(); ++i ) {
310  if( !isDefault( (~rhs)[i] ) ) {
311  if( nonzeros++ == sv_.capacity() )
312  sv_.reserve( extendCapacity() );
313  sv_.append( i, (~rhs)[i] );
314  }
315  }
316  }
317  //**********************************************************************************************
318 
319  //**Transpose assignment of sparse vectors******************************************************
330  template< typename VT2 > // Type of the right-hand side sparse vector
331  inline void assign( const SparseVector<VT2,TF>& rhs )
332  {
334 
335  BLAZE_INTERNAL_ASSERT( sv_.size() == (~rhs).size(), "Invalid vector sizes" );
336 
337  // Using the following formulation instead of a std::copy function call of the form
338  //
339  // end_ = std::copy( (~rhs).begin(), (~rhs).end(), begin_ );
340  //
341  // results in much less requirements on the ConstIterator type provided from the right-hand
342  // sparse vector type
343  for( typename VT2::ConstIterator element=(~rhs).begin(); element!=(~rhs).end(); ++element )
344  sv_.append( element->index(), element->value() );
345  }
346  //**********************************************************************************************
347 
348  private:
349  //**********************************************************************************************
357  inline size_t extendCapacity() const
358  {
359  using blaze::max;
360  using blaze::min;
361 
362  size_t nonzeros( 2UL*sv_.capacity()+1UL );
363  nonzeros = max( nonzeros, 7UL );
364  nonzeros = min( nonzeros, sv_.size() );
365 
366  BLAZE_INTERNAL_ASSERT( nonzeros > sv_.capacity(), "Invalid capacity value" );
367 
368  return nonzeros;
369  }
370  //**********************************************************************************************
371 
372  //**Member variables****************************************************************************
373  VT& sv_;
374  //**********************************************************************************************
375 
376  //**Compile time checks*************************************************************************
382  //**********************************************************************************************
383 };
384 //*************************************************************************************************
385 
386 
387 
388 
389 //=================================================================================================
390 //
391 // GLOBAL OPERATORS
392 //
393 //=================================================================================================
394 
395 //*************************************************************************************************
403 template< typename VT // Type of the sparse vector
404  , bool TF > // Transpose flag
405 inline void reset( SVecTransposer<VT,TF>& v )
406 {
407  v.reset();
408 }
410 //*************************************************************************************************
411 
412 
413 
414 
415 //=================================================================================================
416 //
417 // SUBVECTORTRAIT SPECIALIZATIONS
418 //
419 //=================================================================================================
420 
421 //*************************************************************************************************
423 template< typename VT, bool TF >
424 struct SubvectorTrait< SVecTransposer<VT,TF> >
425 {
427 };
429 //*************************************************************************************************
430 
431 } // namespace blaze
432 
433 #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:4512
#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:270
void assign(const DenseVector< VT2, TF > &rhs)
Implementation of the transpose assignment of a dense vector.
Definition: SVecTransposer.h:301
size_t size() const
Returns the current size/dimension of the vector.
Definition: SVecTransposer.h:169
ConstIterator begin() const
Returns an iterator to the first non-zero element of the sparse vector.
Definition: SVecTransposer.h:115
bool isDefault(const DynamicMatrix< Type, SO > &m)
Returns whether the given dense matrix is in default state.
Definition: DynamicMatrix.h:4555
VT::ElementType ElementType
Resulting element type.
Definition: SVecTransposer.h:79
#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:214
VT::TransposeType ResultType
Result type for expression template evaluations.
Definition: SVecTransposer.h:77
VT & sv_
The sparse vector operand.
Definition: SVecTransposer.h:373
void append(size_t index, const ElementType &value, bool check=false)
Appending an element to the sparse vector.
Definition: SVecTransposer.h:258
void reserve(size_t nonzeros)
Setting the minimum capacity of the sparse vector.
Definition: SVecTransposer.h:228
bool isAliased(const Other *alias) const
Returns whether the vector is aliased with the given address alias.
Definition: SVecTransposer.h:283
EnableIf< IsNumeric< Other >, SVecTransposer >::Type & operator/=(Other rhs)
Division assignment operator for the division of a vector by a scalar value ( ).
Definition: SVecTransposer.h:155
void assign(const SparseVector< VT2, TF > &rhs)
Implementation of the transpose assignment of a sparse vector.
Definition: SVecTransposer.h:331
const Element * ConstIterator
Iterator over constant elements.
Definition: CompressedMatrix.h:2379
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:2372
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:2373
Reference operator[](size_t index)
Subscript operator for the direct access to the vector elements.
Definition: SVecTransposer.h:104
SVecTransposer(VT &sv)
Constructor for the SVecTransposer class.
Definition: SVecTransposer.h:93
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:2377
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:196
VT::ConstIterator ConstIterator
Iterator over constant elements.
Definition: SVecTransposer.h:85
const Type & ReturnType
Return type for expression template evaluations.
Definition: CompressedMatrix.h:2374
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:138
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:2378
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:179
VT::ResultType TransposeType
Transpose type for expression template evaluations.
Definition: SVecTransposer.h:78
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:2370
Header file for basic type definitions.
MatrixAccessProxy< This > Reference
Reference to a non-constant matrix value.
Definition: CompressedMatrix.h:2376
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:125
#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:357