This is the mutable interface to GSL vector. More...

#include <yat/utility/VectorMutable.h>

Inheritance diagram for theplu::yat::utility::VectorMutable:

Public Types
typedef double &	reference

typedef StrideIterator< double * >	iterator
	mutable iterator

typedef double	value_type

typedef const double &	const_reference

typedef StrideIterator< const double * >	const_iterator
	VectorBase::const_iterator.

Public Member Functions
	VectorMutable (void)
	default constructor

	VectorMutable (gsl_vector *)
	Constructor.

	VectorMutable (const gsl_vector *)
	Constructor.

virtual	~VectorMutable (void)

void	all (double value)

iterator	begin (void)

void	div (const VectorBase &other)
	This function performs element-wise division, $this_i = this_i / other_i \; \forall i$ . More...

iterator	end (void)

gsl_vector *	gsl_vector_p (void)

virtual bool	isview (void) const =0

void	mul (const VectorBase &other)
	This function performs element-wise multiplication, $this_i = this_i * other_i \; \forall i$ . More...

void	reverse (void)
	Reverse the order of elements in the VectorMutable.

void	swap (size_t i, size_t j)
	Exchange elements i and j.

double &	operator() (size_t i)
	Element access operator. More...

const VectorMutable &	operator+= (const VectorBase &)
	Addition and assign operator. VectorBase addition, $this_i = this_i + other_i \; \forall i$ . More...

const VectorMutable &	operator+= (double d)
	Add a constant to a VectorBase, $this_i = this_i + d \; \forall i$ . More...

const VectorMutable &	operator-= (const VectorBase &)
	Subtract and assign operator. VectorBase subtraction, $this_i = this_i - other_i \; \forall i$ . More...

const VectorMutable &	operator-= (double d)
	Subtract a constant to a VectorBase, $this_i = this_i - d \; \forall i$ . More...

const VectorMutable &	operator*= (double d)
	Multiply with scalar and assign operator, $this_i = this_i * d \; \forall i$ . More...

const VectorMutable &	operator= (const VectorMutable &)
	assignment More...

const VectorMutable &	operator= (const VectorBase &)
	assignment More...

const_iterator	begin (void) const

const_iterator	end (void) const

bool	equal (const VectorBase &, const double precision=0) const
	Check whether VectorBases are equal within a user defined precision, set by precision. More...

const gsl_vector *	gsl_vector_p (void) const

size_t	size (void) const

const double &	operator() (size_t i) const
	Element access operator. More...

bool	operator== (const VectorBase &) const
	Comparison operator. Takes linear time. More...

bool	operator!= (const VectorBase &) const
	Comparison operator. Takes linear time. More...

double	operator* (const VectorBase &) const

Protected Attributes
gsl_vector *	vec_

const gsl_vector *	const_vec_
	pointer to underlying GSL vector

Related Functions
(Note that these are not member functions.)
Vector	operator* (const VectorBase &, const Matrix &)
	Matrix Vector multiplication.

bool	isnull (const VectorBase &)
	Check if all elements of the VectorBase are zero. More...

double	max (const VectorBase &)
	Get the maximum value of the VectorBase. More...

size_t	max_index (const VectorBase &)
	Locate the maximum value in the VectorBase. More...

double	min (const VectorBase &)
	Get the minimum value of the VectorBase. More...

size_t	min_index (const VectorBase &)
	Locate the minimum value in the VectorBase. More...

bool	nan (const VectorBase &templat, Vector &flag)
	Create a VectorBase flag indicating NaN's in another VectorBase templat. More...

void	sort_index (std::vector< size_t > &sort_index, const VectorBase &invec)

void	sort_smallest_index (std::vector< size_t > &sort_index, size_t k, const VectorBase &invec)

void	sort_largest_index (std::vector< size_t > &sort_index, size_t k, const VectorBase &invec)

double	sum (const VectorBase &)
	Calculate the sum of all VectorBase elements. More...

std::ostream &	operator<< (std::ostream &s, const VectorBase &v)
	The output operator for the VectorBase class. More...

Detailed Description

This is the mutable interface to GSL vector.

This class contains the mutable interface to vector classes.

The non-mutable interface is inherited from VectorBase. When dealing with const vectors, it is preferable to use the VectorBase signature because this allows usage of VectorConstView too.

Member Typedef Documentation

typedef const double& theplu::yat::utility::VectorBase::const_reference

inherited

const_reference type is const double&

Since: New in yat 0.5

typedef double& theplu::yat::utility::VectorMutable::reference

reference type is double&

Since: New in yat 0.5

typedef double theplu::yat::utility::VectorBase::value_type

inherited

value_type is double

Since: New in yat 0.5

Constructor & Destructor Documentation

virtual theplu::yat::utility::VectorMutable::~VectorMutable ( void )

virtual

The destructor.

Member Function Documentation

void theplu::yat::utility::VectorMutable::all ( double value )

Set all elements to value.

const_iterator theplu::yat::utility::VectorBase::begin ( void ) const

inherited

Returns: read-only iterator to start of VectorBase

iterator theplu::yat::utility::VectorMutable::begin ( void )

Returns: mutable iterator to start of VectorMutable

void theplu::yat::utility::VectorMutable::div ( const VectorBase & other )

This function performs element-wise division, $this_i = this_i / other_i \; \forall i$ .

Exceptions

GSL_error if dimensions mis-match.

const_iterator theplu::yat::utility::VectorBase::end ( void ) const

inherited

Returns: read-only iterator to end of VectorBase

iterator theplu::yat::utility::VectorMutable::end ( void )

Returns: mutable iterator to end of VectorMutable

bool theplu::yat::utility::VectorBase::equal	(	const VectorBase &	,
		const double	precision = `0`
	)		const

inherited

Check whether VectorBases are equal within a user defined precision, set by precision.

Returns: True if each element deviates less or equal than d. If any VectorBase contain a NaN, false is always returned.

See Also: operator== and operator!=

const gsl_vector* theplu::yat::utility::VectorBase::gsl_vector_p ( void ) const

inherited

Returns: A const pointer to the internal GSL vector,

gsl_vector* theplu::yat::utility::VectorMutable::gsl_vector_p ( void )

Returns: A pointer to the internal GSL vector,

virtual bool theplu::yat::utility::VectorMutable::isview ( void ) const

pure virtual

Check if the vector object is a view (sub-vector) to another vector.

Returns: True if the object is a view, false othwerwise.

Implements theplu::yat::utility::VectorBase.

Implemented in theplu::yat::utility::VectorView, and theplu::yat::utility::Vector.

void theplu::yat::utility::VectorMutable::mul ( const VectorBase & other )

This function performs element-wise multiplication, $this_i = this_i * other_i \; \forall i$ .

Exceptions

GSL_error if dimensions mis-match.

bool theplu::yat::utility::VectorBase::operator!= ( const VectorBase & ) const

inherited

Comparison operator. Takes linear time.

Checks are performed with exact matching, i.e., rounding off effects may destroy comparison. Use the equal function for comparing elements within a user defined precision.

Returns: False if all elements are equal otherwise true.

See Also: equal(const VectorBase&, const double precision=0)

const double& theplu::yat::utility::VectorBase::operator() ( size_t i ) const

inherited

Element access operator.

Returns: Const reference to element i.

Exceptions

If	GSL range checks are enabled in the underlying GSL library a GSL_error exception is thrown if either index is out of range.

double& theplu::yat::utility::VectorMutable::operator() ( size_t i )

Element access operator.

Returns: Reference to element i.

Exceptions

If	GSL range checks are enabled in the underlying GSL library a GSL_error exception is thrown if either index is out of range.

double theplu::yat::utility::VectorBase::operator* ( const VectorBase & ) const

inherited

Returns: The dot product.

const VectorMutable& theplu::yat::utility::VectorMutable::operator*= ( double d )

Multiply with scalar and assign operator, $this_i = this_i * d \; \forall i$ .

Returns: A const reference to the resulting VectorBase.

const VectorMutable& theplu::yat::utility::VectorMutable::operator+= ( const VectorBase & )

Addition and assign operator. VectorBase addition, $this_i = this_i + other_i \; \forall i$ .

Returns: A const reference to the resulting VectorBase.

Exceptions

GSL_error if dimensions mis-match.

const VectorMutable& theplu::yat::utility::VectorMutable::operator+= ( double d )

Add a constant to a VectorBase, $this_i = this_i + d \; \forall i$ .

Returns: A const reference to the resulting VectorBase.

const VectorMutable& theplu::yat::utility::VectorMutable::operator-= ( const VectorBase & )

Subtract and assign operator. VectorBase subtraction, $this_i = this_i - other_i \; \forall i$ .

Returns: A const reference to the resulting VectorBase.

Exceptions

GSL_error if dimensions mis-match.

const VectorMutable& theplu::yat::utility::VectorMutable::operator-= ( double d )

Subtract a constant to a VectorBase, $this_i = this_i - d \; \forall i$ .

Returns: A const reference to the resulting VectorBase.

const VectorMutable& theplu::yat::utility::VectorMutable::operator= ( const VectorMutable & )

assignment

Since: New in yat 0.14

const VectorMutable& theplu::yat::utility::VectorMutable::operator= ( const VectorBase & )

assignment

Since: New in yat 0.14

bool theplu::yat::utility::VectorBase::operator== ( const VectorBase & ) const

inherited

Comparison operator. Takes linear time.

Checks are performed with exact matching, i.e., rounding off effects may destroy comparison. Use the equal function for comparing elements within a user defined precision.

Returns: True if all elements are equal otherwise false.

See Also: equal(const VectorBase&, const double precision=0)

size_t theplu::yat::utility::VectorBase::size ( void ) const

inherited

Returns: number of elements in the VectorBase.

Friends And Related Function Documentation

bool isnull ( const VectorBase & )

Returns: True if all elements in the VectorBase is zero, false othwerwise.

double max ( const VectorBase & )

Returns: The maximum value of the VectorBase.

size_t max_index ( const VectorBase & )

Returns: The index to the maximum value of the VectorBase.

Note: Lower index has precedence.

double min ( const VectorBase & )

Returns: The minimum value of the VectorBase.

size_t min_index ( const VectorBase & )

Returns: The index to the minimum value of the VectorBase.

Note: Lower index has precedence.

bool nan	(	const VectorBase &	templat,
		Vector &	flag
	)

The flag VectorBase is changed to contain 1's and 0's only. A 1 means that the corresponding element in the templat VectorBase is valid and a zero means that the corresponding element is a NaN.

Note: Space for vector flag is reallocated to fit the size of VectorBase templat if sizes mismatch.

Returns: True if the templat VectorBase contains at least one NaN.

std::ostream & operator<<	(	std::ostream &	s,
		const VectorBase &	v
	)

Elements in VectorBase v are sent to ostream s and separated with the fill character of stream s, s.fill(). If you, for example, want to print the VectorBase v with the elements separated by a ':', you do so by:

s << setfill(':') << v;

void sort_index	(	std::vector< size_t > &	sort_index,
		const VectorBase &	invec
	)

Create a vector sort_index containing the indeces of elements in a another VectorBase invec. The elements of sort_index give the index of the VectorBase element which would have been stored in that position if the VectorBase had been sorted in place. The first element of sort_index gives the index of the least element in invec, and the last element of sort_index gives the index of the greatest element in invec . The VectorBase invec is not changed.

void sort_largest_index	(	std::vector< size_t > &	sort_index,
		size_t	k,
		const VectorBase &	invec
	)

void sort_smallest_index	(	std::vector< size_t > &	sort_index,
		size_t	k,
		const VectorBase &	invec
	)

double sum ( const VectorBase & )

Returns: The sum.

Member Data Documentation

gsl_vector* theplu::yat::utility::VectorMutable::vec_

protected

pointer to underlying GSL vector. Should always point to same gsl_vector as const_vec_ in base class does. This pointer should by used for mutable operations. Do not use this in const functions; use const_vec_ inherited from BaseVector.

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

yat/utility/VectorMutable.h

Public Types

Public Member Functions

Protected Attributes

Related Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation