Logo  0.95.0-final
Finite Element Embedded Library and Language in C++
Feel++ Feel++ on Github Feel++ community
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Feel::VectorValue< T > Class Template Reference

#include <vectorvalue.hpp>

Detailed Description

template<typename T>
class Feel::VectorValue< T >

interface to vector

VectorValue<T> m;
Author
Christophe Prud'homme
See Also

Public Types

Typedefs
typedef T value_type
 
typedef value_type vector_type
 

Public Member Functions

Constructors, destructor
 VectorValue (value_type acc=value_type(0))
 
 VectorValue (VectorValue const &m)
 
 ~VectorValue ()
 
Operator overloads
value_type & operator() (size_type)
 
Accessors
unsigned int size () const
 
unsigned int rowStart () const
 
unsigned int rowStop () const
 
bool isInitialized () const
 
void close () const
 
bool closed () const
 
vector_type const & vec () const
 
vector_type & vec ()
 
Methods
void clear ()
 
void zero ()
 
void zero (size_type, size_type)
 
void add (const unsigned int, const value_type value)
 
void set (const unsigned int, const value_type value)
 
void printMatlab (const std::string name="NULL", bool renumber=false) const
 

Member Function Documentation

template<typename T >
void Feel::VectorValue< T >::add ( const unsigned  int,
const value_type  value 
)
inline

Add value to the value already accumulated

template<typename T >
void Feel::VectorValue< T >::clear ( )
inline

Release all memory and return to a state just like after having called the default constructor.

template<typename T >
void Feel::VectorValue< T >::close ( ) const

close the gmm vector, that will copy the content of write optimized vector into a read optimized vector

template<typename T >
bool Feel::VectorValue< T >::closed ( ) const
inline

see if vector has been closed and fully assembled yet

template<typename T >
bool Feel::VectorValue< T >::isInitialized ( ) const
inline
Returns
true if vector is initialized/usable, false otherwise
template<typename T >
value_type& Feel::VectorValue< T >::operator() ( size_type  )
inline
Returns
the value
template<typename T >
void Feel::VectorValue< T >::printMatlab ( const std::string  name = "NULL",
bool  renumber = false 
) const

Print the contents of the vector in Matlab's sparse vector forvec. Optionally prints the vector to the file named name. If name is not specified it is dumped to the screen.

template<typename T >
unsigned int Feel::VectorValue< T >::rowStart ( ) const
inline

return row_start, the index of the first vector row stored on this processor

template<typename T >
unsigned int Feel::VectorValue< T >::rowStop ( ) const
inline

return row_stop, the index of the last vector row (+1) stored on this processor

template<typename T >
void Feel::VectorValue< T >::set ( const unsigned  int,
const value_type  value 
)
inline

set to value

template<typename T >
unsigned int Feel::VectorValue< T >::size ( ) const
inline
Returns
m, the row-dimension of the vector where the marix is $ M \times N $.
template<typename T >
vector_type const& Feel::VectorValue< T >::vec ( ) const
inline

Returns the read optimized gmm vector.

template<typename T >
vector_type& Feel::VectorValue< T >::vec ( )
inline

Returns the read optimized gmm vector.

template<typename T >
void Feel::VectorValue< T >::zero ( )
inline

Set all entries to 0. This method retains sparsity structure.


The documentation for this class was generated from the following file:

Generated on Sun Oct 20 2013 08:25:09 for Feel++ by doxygen 1.8.4