This is the yat interface to gsl_vector_view. More...

#include <yat/utility/VectorView.h>

Inheritance diagram for theplu::yat::utility::VectorView:

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.

typedef VectorBase	derived_type

Public Member Functions
	VectorView (void)
	Default constructor. More...

	VectorView (VectorView &other)
	The copy constructor. More...

	VectorView (VectorMutable &other)
	copy another VectorMutable More...

	VectorView (VectorMutable &v, size_t offset, size_t n, size_t stride=1)
	VectorView constructor. More...

	VectorView (MatrixMutable &m, size_t i, bool row=true)

	VectorView (gsl_vector *v)

	VectorView (double *v, size_t size, size_t stride=1)

	~VectorView (void)

bool	isview (void) const

const VectorView &	operator= (const VectorView &)
	The assignment operator. More...

const VectorView &	operator= (const VectorBase &)
	The assignment operator. More...

template<class T >
VectorView &	operator= (const VectorExpression< T > &rhs)
	assignment from vector expression

	VectorView (proxy p)
	create VectorView from proxy class

	operator proxy ()

void	all (double value)

iterator	begin (void)

const_iterator	begin (void) const

const_iterator	begin (void) const

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

iterator	end (void)

const_iterator	end (void) const

const_iterator	end (void) const

gsl_vector *	gsl_vector_p (void)

const gsl_vector *	gsl_vector_p (void) const

const gsl_vector *	gsl_vector_p (void) const

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 double &	operator() (size_t i) const
	Element access operator. More...

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

template<class T >
VectorMutable &	operator+= (const VectorExpression< T > &rhs)
	Addition and assign operator. 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...

template<class T >
VectorMutable &	operator-= (const VectorExpression< T > &rhs)
	Subtraction and assign operator. 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...

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

size_t	size (void) const

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.)
template<class Derived1 , class Derived2 >
double	operator* (const BasicVector< Derived1 > &lhs, const BasicVector< Derived2 > &rhs)

template<typename T >
expression::ScaledVector< T >	operator* (double k, const BasicVector< T > &vec)
	scale a vector expression More...

template<typename T >
expression::ScaledVector< T >	operator* (const BasicVector< T > &vec, double k)
	scale a vector expression More...

template<class MATRIX , class VECTOR >
expression::MatrixVector< MATRIX, VECTOR >	operator* (const BasicMatrix< MATRIX > &lhs, const BasicVector< VECTOR > &rhs)

template<class MATRIX , class VECTOR >
expression::MatrixVector< MatrixExpression< expression::TransposedMatrix< MATRIX > >, VECTOR >	operator* (const BasicVector< VECTOR > &lhs, const BasicMatrix< MATRIX > &rhs)

template<class Derived1 , class Derived2 >
expression::VectorBinary< Derived1, Derived2, expression::Plus >	operator+ (const BasicVector< Derived1 > &lhs, const BasicVector< Derived2 > &rhs)

template<class Derived1 , class Derived2 >
expression::VectorBinary< Derived1, Derived2, expression::Minus >	operator- (const BasicVector< Derived1 > &lhs, const BasicVector< Derived2 > &rhs)

template<typename T >
expression::ScaledVector< T >	operator- (const BasicVector< T > &vec)
	negation operator More...

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...

double	norm2_squared (const VectorBase &v)

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 yat interface to gsl_vector_view.

This class can be used to create a vector view into a Matrix or a VectorMutable. Modifying a view will also modify the underlying data, i.e., the Matrix or VectorMutable that is viewed into. For that reason all constructors are taking non-const references to disallow mutable views into a const objects.

The fact that there is no copy constructor with const argument, but only a so-called move constructor (copying a non-const reference), implies that temporary objects such as objects returned from functions can not be copied directly. Instead the copying is done via a proxy class. Also since we can not bind a temporary to a non-const reference, a VectorView returned from a function cannot be sent directly to a function. For example

Matrix m(10,10);

sum(m.row_view(0));

but you need to create a dummie object

Matrix m(10,10);
VectorView vv = m.row_view(0);
sum(vv);

or since sum is a const function, you can use VectorConstView

Matrix m(10,10);

sum(m.row_const_view(0));

Note that VectorView does not own underlying data, and a VectorView is not valid if Vector/Matrix owning the data is deallocated.

Member Typedef Documentation

◆ const_reference

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

inherited

const_reference type is const double&

Since: New in yat 0.5

◆ derived_type

typedef VectorBase theplu::yat::utility::BasicVector< VectorBase >::derived_type

inherited

Class that inherits from BasicVector

◆ reference

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

inherited

reference type is double&

Since: New in yat 0.5

◆ value_type

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

inherited

value_type is double

Since: New in yat 0.5

Constructor & Destructor Documentation

◆ VectorView() [1/7]

theplu::yat::utility::VectorView::VectorView ( void )

Default constructor.

Creates a view into nothing and behaves like an empty Vector.

◆ VectorView() [2/7]

theplu::yat::utility::VectorView::VectorView ( VectorView & other )

The copy constructor.

Modifications to created VectorView will also modify other. Created VectorView is not dependent on other, but if underlying data (Vector or Matrix) is deallocated VectorView is invalid.

◆ VectorView() [3/7]

theplu::yat::utility::VectorView::VectorView ( VectorMutable & other )

explicit

copy another VectorMutable

Note: If the object viewed by the view goes out of scope or is deleted, the view becomes invalid and the result of further use is undefined.

◆ VectorView() [4/7]

theplu::yat::utility::VectorView::VectorView	(	VectorMutable &	v,
		size_t	offset,
		size_t	n,
		size_t	stride = `1`
	)

VectorView constructor.

Create a view of VectorMutable v, with starting index offset, size n, and an optional stride.

Note: If the object viewed by the view goes out of scope or is deleted, the view becomes invalid and the result of further use is undefined.

◆ VectorView() [5/7]

theplu::yat::utility::VectorView::VectorView	(	MatrixMutable &	m,
		size_t	i,
		bool	row = `true`
	)

Matrix row/column view constructor.

Create a row/column VectorView view of matrix m, pointing at row/column i. The parameter row is used to set whether the view should be a row or column view. If row is set to true, the view will be a row view (default behaviour), and, naturally, a column view otherwise.

A VectorView view can be used as any VectorMutable with the difference that changes made to the view will also change the object that is viewed.

Note: If the object viewed by the view goes out of scope or is deleted, the view becomes invalid and the result of further use is undefined.

◆ VectorView() [6/7]

theplu::yat::utility::VectorView::VectorView ( gsl_vector * v )

explicit

Create a view into v

Since: New in yat 0.20

◆ VectorView() [7/7]

theplu::yat::utility::VectorView::VectorView	(	double *	v,
		size_t	size,
		size_t	stride = `1`
	)

Create a view with size size and stride stride such that view(0) = v[0] and view(1) = v[stride].

Since: New in yat 0.20

◆ ~VectorView()

theplu::yat::utility::VectorView::~VectorView ( void )

The destructor.

Member Function Documentation

◆ all()

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

inherited

Set all elements to value.

◆ begin() [1/3]

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

inherited

Returns: read-only iterator to start of VectorBase

◆ begin() [2/3]

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

inherited

Returns: mutable iterator to start of VectorMutable

◆ begin() [3/3]

const_iterator theplu::yat::utility::VectorBase::begin

inherited

Returns: read-only iterator to start of VectorBase

◆ div()

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

inherited

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

Exceptions

GSL_error if dimensions mis-match.

◆ end() [1/3]

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

inherited

Returns: read-only iterator to end of VectorBase

◆ end() [2/3]

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

inherited

Returns: mutable iterator to end of VectorMutable

◆ end() [3/3]

const_iterator theplu::yat::utility::VectorBase::end

inherited

Returns: read-only iterator to end of VectorBase

◆ equal()

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!=

◆ gsl_vector_p() [1/3]

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

inherited

Returns: A const pointer to the internal GSL vector,

◆ gsl_vector_p() [2/3]

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

inherited

Returns: A pointer to the internal GSL vector,

◆ gsl_vector_p() [3/3]

const gsl_vector* theplu::yat::utility::VectorBase::gsl_vector_p

inherited

Returns: A const pointer to the internal GSL vector,

◆ isview()

bool theplu::yat::utility::VectorView::isview ( void ) const

virtual

Returns: true

Implements theplu::yat::utility::VectorMutable.

◆ mul()

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

inherited

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

Exceptions

GSL_error if dimensions mis-match.

◆ operator proxy()

theplu::yat::utility::VectorView::operator proxy ( )

conversion operator to private proxy class.

◆ operator!=()

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)

◆ operator()() [1/2]

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.

◆ operator()() [2/2]

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

inherited

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.

◆ operator*()

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

inherited

Returns: The dot product.

◆ operator*=()

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

inherited

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

Returns: A const reference to the resulting VectorBase.

◆ operator+=() [1/3]

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

inherited

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

Returns: A const reference to the resulting VectorMutable.

Exceptions

GSL_error if dimensions mis-match.

◆ operator+=() [2/3]

template<class T >

VectorMutable& theplu::yat::utility::VectorMutable::operator+= ( const VectorExpression< T > & rhs )

inlineinherited

Addition and assign operator.

Returns: A reference to the resulting VectorMutable.

◆ operator+=() [3/3]

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

inherited

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

Returns: A const reference to the resulting VectorBase.

◆ operator-=() [1/3]

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

inherited

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.

◆ operator-=() [2/3]

template<class T >

VectorMutable& theplu::yat::utility::VectorMutable::operator-= ( const VectorExpression< T > & rhs )

inlineinherited

Subtraction and assign operator.

Returns: A reference to the resulting VectorMutable.

◆ operator-=() [3/3]

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

inherited

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

Returns: A const reference to the resulting VectorBase.

◆ operator=() [1/2]

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

The assignment operator.

Returns: A const reference to the resulting vector.

Note: modifies underlying data.

Exceptions

GSL_error if dimensions mis-match or if assignment fails

◆ operator=() [2/2]

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

The assignment operator.

Returns: A const reference to the resulting vector.

Note: modifies underlying data.

Exceptions

GSL_error if dimensions mis-match or if assignment fails

◆ operator==()

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()

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

inherited

Returns: number of elements in the VectorBase.

Friends And Related Function Documentation

◆ isnull()

bool isnull ( const VectorBase & )

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

◆ max()

double max ( const VectorBase & )

Returns: The maximum value of the VectorBase.

◆ max_index()

size_t max_index ( const VectorBase & )

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

Note: Lower index has precedence.

◆ min()

double min ( const VectorBase & )

Returns: The minimum value of the VectorBase.

◆ min_index()

size_t min_index ( const VectorBase & )

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

Note: Lower index has precedence.

◆ nan()

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.

◆ norm2_squared()

double norm2_squared ( const VectorBase & v )

Returns: L2 norm squared, or the dot product of v with itself

Since: New in yat 0.18

◆ operator*() [1/5]

template<class MATRIX , class VECTOR >

expression::MatrixVector< MATRIX, VECTOR > operator*	(	const BasicMatrix< MATRIX > &	lhs,
		const BasicVector< VECTOR > &	rhs
	)

Since: new in yat 0.15

◆ operator*() [2/5]

template<class MATRIX , class VECTOR >

expression::MatrixVector< MatrixExpression< expression::TransposedMatrix< MATRIX > >, VECTOR > operator*	(	const BasicVector< VECTOR > &	lhs,
		const BasicMatrix< MATRIX > &	rhs
	)

Since: new in yat 0.15

◆ operator*() [3/5]

template<class Derived1 , class Derived2 >

double operator*	(	const BasicVector< Derived1 > &	lhs,
		const BasicVector< Derived2 > &	rhs
	)

Since: New in yat 0.15

◆ operator*() [4/5]

template<typename T >

expression::ScaledVector< T > operator*	(	double	k,
		const BasicVector< T > &	vec
	)

Since: new in yat 0.15

◆ operator*() [5/5]

template<typename T >

expression::ScaledVector< T > operator*	(	const BasicVector< T > &	vec,
		double	k
	)

Since: new in yat 0.15

◆ operator+()

template<class Derived1 , class Derived2 >

expression::VectorBinary< Derived1, Derived2, expression::Plus > operator+	(	const BasicVector< Derived1 > &	lhs,
		const BasicVector< Derived2 > &	rhs
	)

Since: new in yat 0.15

◆ operator-() [1/2]

template<class Derived1 , class Derived2 >

expression::VectorBinary< Derived1, Derived2, expression::Minus > operator-	(	const BasicVector< Derived1 > &	lhs,
		const BasicVector< Derived2 > &	rhs
	)

Since: new in yat 0.15

◆ operator-() [2/2]

template<typename T >

expression::ScaledVector< T > operator- ( const BasicVector< T > & vec )

Since: new in yat 0.15

◆ operator<<()

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;

◆ sort_index()

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.

◆ sort_largest_index()

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

◆ sort_smallest_index()

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

◆ sum()

double sum ( const VectorBase & )

Returns: The sum.

Member Data Documentation

◆ vec_

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

protectedinherited

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/VectorView.h

Public Types

Public Member Functions

Protected Attributes

Related Functions

Detailed Description

Member Typedef Documentation

◆ const_reference

◆ derived_type

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ VectorView() [1/7]

◆ VectorView() [2/7]

◆ VectorView() [3/7]

◆ VectorView() [4/7]

◆ VectorView() [5/7]

◆ VectorView() [6/7]

◆ VectorView() [7/7]

◆ ~VectorView()

Member Function Documentation

◆ all()

◆ begin() [1/3]

◆ begin() [2/3]

◆ begin() [3/3]

◆ div()

◆ end() [1/3]

◆ end() [2/3]

◆ end() [3/3]

◆ equal()

◆ gsl_vector_p() [1/3]

◆ gsl_vector_p() [2/3]

◆ gsl_vector_p() [3/3]

◆ isview()

◆ mul()

◆ operator proxy()

◆ operator!=()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator*()

◆ operator*=()

◆ operator+=() [1/3]

◆ operator+=() [2/3]

◆ operator+=() [3/3]

◆ operator-=() [1/3]

◆ operator-=() [2/3]

◆ operator-=() [3/3]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ size()

Friends And Related Function Documentation

◆ isnull()

◆ max()

◆ max_index()

◆ min()

◆ min_index()

◆ nan()

◆ norm2_squared()

◆ operator*() [1/5]

◆ operator*() [2/5]

◆ operator*() [3/5]

◆ operator*() [4/5]

◆ operator*() [5/5]

◆ operator+()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator<<()

◆ sort_index()

◆ sort_largest_index()

◆ sort_smallest_index()

◆ sum()

Member Data Documentation

◆ vec_