dune-istl: Dune::base_array< B, A > Class Template Reference

dune-istl 2.2.1

This container extends base_array_unmanaged by memory management with the usual copy semantics providing the full range of copy constructor, destructor and assignment operators. More...

#include <dune/istl/basearray.hh>

Inheritance diagram for Dune::base_array< B, A >:

Public Types
typedef B	member_type
	export the type representing the components More...

typedef A	allocator_type
	export the allocator type More...

typedef base_array_unmanaged < B, A >::iterator	iterator
	make iterators available as types More...

typedef base_array_unmanaged < B, A >::const_iterator	const_iterator
	make iterators available as types More...

typedef base_array_unmanaged < B, A >::size_type	size_type
	The type used for the index access. More...

typedef A::difference_type	difference_type
	The type used for the difference between two iterator positions. More...

Public Member Functions
	base_array ()
	makes empty array More...

	base_array (size_type _n)
	make array with _n components More...

	base_array (const base_array &a)
	copy constructor More...

	base_array (const base_array_unmanaged< B, A > &_a)
	construct from base class object More...

	~base_array ()
	free dynamic memory More...

void	resize (size_type _n)
	reallocate array to given size, any data is lost More...

base_array &	operator= (const base_array &a)
	assignment More...

base_array &	operator= (const base_array_unmanaged< B, A > &a)
	assign from base class object More...

B &	operator[] (size_type i)
	random access to blocks More...

const B &	operator[] (size_type i) const
	same for read only access More...

iterator	begin ()
	begin iterator More...

const_iterator	begin () const
	begin const_iterator More...

iterator	end ()
	end iterator More...

const_iterator	end () const
	end const_iterator More...

iterator	beforeEnd ()

const_iterator	beforeEnd () const

iterator	beforeBegin ()

const_iterator	beforeBegin () const

iterator	find (size_type i)
	random access returning iterator (end if not contained) More...

const_iterator	find (size_type i) const
	random access returning iterator (end if not contained) More...

size_type	size () const
	number of blocks in the array (are of size 1 here) More...

Protected Attributes
A	allocator_

size_type	n

B *	p

Detailed Description

template<class B, class A = std::allocator<B>>
class Dune::base_array< B, A >

This container extends base_array_unmanaged by memory management with the usual copy semantics providing the full range of copy constructor, destructor and assignment operators.

You can make

empty array
array with n components dynamically allocated
resize an array with complete loss of data
assign/construct from a base_array_window to make a copy of the data

Error checking: no error checking is provided normally. Setting the compile time switch DUNE_ISTL_WITH_CHECKING enables error checking.

Member Typedef Documentation

template<class B, class A = std::allocator<B>>

typedef A Dune::base_array< B, A >::allocator_type

export the allocator type

template<class B, class A = std::allocator<B>>

typedef base_array_unmanaged<B,A>::const_iterator Dune::base_array< B, A >::const_iterator

make iterators available as types

template<class B, class A = std::allocator<B>>

typedef A::difference_type Dune::base_array< B, A >::difference_type

The type used for the difference between two iterator positions.

template<class B, class A = std::allocator<B>>

typedef base_array_unmanaged<B,A>::iterator Dune::base_array< B, A >::iterator

make iterators available as types

template<class B, class A = std::allocator<B>>

typedef B Dune::base_array< B, A >::member_type

export the type representing the components

template<class B, class A = std::allocator<B>>

typedef base_array_unmanaged<B,A>::size_type Dune::base_array< B, A >::size_type

The type used for the index access.

Constructor & Destructor Documentation

template<class B, class A = std::allocator<B>>

Dune::base_array< B, A >::base_array ( )

inline

makes empty array

template<class B, class A = std::allocator<B>>

Dune::base_array< B, A >::base_array ( size_type _n )

inline

make array with _n components

References Dune::base_array< B, A >::allocator_, Dune::base_array_unmanaged< B, A >::n, and Dune::base_array_unmanaged< B, A >::p.

template<class B, class A = std::allocator<B>>

Dune::base_array< B, A >::base_array ( const base_array< B, A > & a )

inline

copy constructor

References Dune::base_array< B, A >::allocator_, Dune::base_array_unmanaged< B, A >::n, and Dune::base_array_unmanaged< B, A >::p.

template<class B, class A = std::allocator<B>>

Dune::base_array< B, A >::base_array ( const base_array_unmanaged< B, A > & _a )

inline

construct from base class object

References Dune::base_array< B, A >::allocator_, Dune::base_array_unmanaged< B, A >::n, and Dune::base_array_unmanaged< B, A >::p.

template<class B, class A = std::allocator<B>>

Dune::base_array< B, A >::~base_array ( )

inline

free dynamic memory

References Dune::base_array< B, A >::allocator_, Dune::base_array_unmanaged< B, A >::n, and Dune::base_array_unmanaged< B, A >::p.

Member Function Documentation

template<class B, class A = std::allocator<B>>

iterator Dune::base_array_unmanaged< B, A >::beforeBegin ( )

inlineinherited

Returns: an iterator that is positioned before the first entry of the vector.

template<class B, class A = std::allocator<B>>

const_iterator Dune::base_array_unmanaged< B, A >::beforeBegin ( ) const

inlineinherited

Returns: an iterator that is positioned before the first entry of the vector.

template<class B, class A = std::allocator<B>>

iterator Dune::base_array_unmanaged< B, A >::beforeEnd ( )

inlineinherited

Returns: an iterator that is positioned before the end iterator of the vector, i.e. at the last entry.

template<class B, class A = std::allocator<B>>

const_iterator Dune::base_array_unmanaged< B, A >::beforeEnd ( ) const

inlineinherited

Returns: an iterator that is positioned before the end iterator of the vector. i.e. at the last element.

template<class B, class A = std::allocator<B>>

iterator Dune::base_array_unmanaged< B, A >::begin ( )

inlineinherited

begin iterator

Referenced by test_basearray(), and test_IO().

template<class B, class A = std::allocator<B>>

const_iterator Dune::base_array_unmanaged< B, A >::begin ( ) const

inlineinherited

begin const_iterator

template<class B, class A = std::allocator<B>>

iterator Dune::base_array_unmanaged< B, A >::end ( )

inlineinherited

end iterator

Referenced by test_basearray(), and test_IO().

template<class B, class A = std::allocator<B>>

const_iterator Dune::base_array_unmanaged< B, A >::end ( ) const

inlineinherited

end const_iterator

template<class B, class A = std::allocator<B>>

iterator Dune::base_array_unmanaged< B, A >::find ( size_type i )

inlineinherited

random access returning iterator (end if not contained)

template<class B, class A = std::allocator<B>>

const_iterator Dune::base_array_unmanaged< B, A >::find ( size_type i ) const

inlineinherited

random access returning iterator (end if not contained)

template<class B, class A = std::allocator<B>>

base_array& Dune::base_array< B, A >::operator= ( const base_array< B, A > & a )

inline

assignment

References Dune::base_array< B, A >::allocator_, Dune::base_array_unmanaged< B, A >::n, and Dune::base_array_unmanaged< B, A >::p.

Referenced by Dune::base_array< B, A >::operator=().

template<class B, class A = std::allocator<B>>

base_array& Dune::base_array< B, A >::operator= ( const base_array_unmanaged< B, A > & a )

inline

assign from base class object

References Dune::base_array< B, A >::operator=().

template<class B, class A = std::allocator<B>>

B& Dune::base_array_unmanaged< B, A >::operator[] ( size_type i )

inlineinherited

random access to blocks

template<class B, class A = std::allocator<B>>

const B& Dune::base_array_unmanaged< B, A >::operator[] ( size_type i ) const

inlineinherited

same for read only access

template<class B, class A = std::allocator<B>>

void Dune::base_array< B, A >::resize ( size_type _n )

inline

reallocate array to given size, any data is lost

References Dune::base_array< B, A >::allocator_, Dune::base_array_unmanaged< B, A >::n, and Dune::base_array_unmanaged< B, A >::p.

template<class B, class A = std::allocator<B>>

size_type Dune::base_array_unmanaged< B, A >::size ( ) const

inlineinherited

number of blocks in the array (are of size 1 here)

Referenced by Dune::Matrix< T, A >::coldim(), and Dune::BlockVector< FieldVector< T, n >, A >::resize().

Member Data Documentation

template<class B, class A = std::allocator<B>>

A Dune::base_array< B, A >::allocator_

protected

Referenced by Dune::base_array< B, A >::base_array(), Dune::base_array< B, A >::operator=(), Dune::base_array< B, A >::resize(), and Dune::base_array< B, A >::~base_array().

template<class B, class A = std::allocator<B>>

size_type Dune::base_array_unmanaged< B, A >::n

protectedinherited

Referenced by Dune::base_array_window< B, A >::advance(), Dune::block_vector_unmanaged< T, A >::axpy(), Dune::base_array< B, A >::base_array(), Dune::base_array_unmanaged< T, A >::beforeEnd(), Dune::BlockVector< FieldVector< T, n >, A >::BlockVector(), Dune::BlockVectorWindow< B, A >::BlockVectorWindow(), Dune::block_vector_unmanaged< T, A >::dim(), Dune::base_array_unmanaged< T, A >::end(), Dune::base_array_unmanaged< T, A >::find(), Dune::BlockVectorWindow< B, A >::getsize(), Dune::block_vector_unmanaged< T, A >::infinity_norm(), Dune::block_vector_unmanaged< T, A >::infinity_norm_real(), Dune::base_array_window< B, A >::move(), Dune::block_vector_unmanaged< T, A >::N(), Dune::block_vector_unmanaged< T, A >::one_norm(), Dune::block_vector_unmanaged< T, A >::one_norm_real(), Dune::block_vector_unmanaged< T, A >::operator*(), Dune::block_vector_unmanaged< T, A >::operator*=(), Dune::VariableBlockVector< B, A >::CreateIterator::operator++(), Dune::block_vector_unmanaged< T, A >::operator+=(), Dune::block_vector_unmanaged< T, A >::operator-=(), Dune::block_vector_unmanaged< T, A >::operator/=(), Dune::block_vector_unmanaged< T, A >::operator=(), Dune::VariableBlockVector< T, A >::operator=(), Dune::BlockVector< FieldVector< T, n >, A >::operator=(), Dune::base_array< B, A >::operator=(), Dune::BlockVectorWindow< B, A >::operator=(), Dune::base_array_unmanaged< T, A >::operator[](), Dune::VariableBlockVector< T, A >::resize(), Dune::BlockVector< FieldVector< T, n >, A >::resize(), Dune::base_array< B, A >::resize(), Dune::base_array_window< B, A >::set(), Dune::BlockVectorWindow< B, A >::set(), Dune::BlockVectorWindow< B, A >::setsize(), Dune::base_array_unmanaged< T, A >::size(), Dune::block_vector_unmanaged< T, A >::two_norm(), Dune::block_vector_unmanaged< T, A >::two_norm2(), Dune::VariableBlockVector< T, A >::VariableBlockVector(), Dune::base_array< B, A >::~base_array(), and Dune::VariableBlockVector< T, A >::~VariableBlockVector().

template<class B, class A = std::allocator<B>>

B* Dune::base_array_unmanaged< B, A >::p

protectedinherited

Referenced by Dune::base_array_window< B, A >::advance(), Dune::base_array< B, A >::base_array(), Dune::base_array_unmanaged< T, A >::beforeBegin(), Dune::base_array_unmanaged< T, A >::beforeEnd(), Dune::base_array_unmanaged< T, A >::begin(), Dune::BlockVector< FieldVector< T, n >, A >::BlockVector(), Dune::BlockVectorWindow< B, A >::BlockVectorWindow(), Dune::base_array_unmanaged< T, A >::end(), Dune::base_array_unmanaged< T, A >::find(), Dune::base_array_window< B, A >::getptr(), Dune::BlockVectorWindow< B, A >::getptr(), Dune::base_array_window< B, A >::move(), Dune::VariableBlockVector< B, A >::CreateIterator::operator++(), Dune::VariableBlockVector< T, A >::operator=(), Dune::BlockVector< FieldVector< T, n >, A >::operator=(), Dune::base_array< B, A >::operator=(), Dune::BlockVectorWindow< B, A >::operator=(), Dune::base_array_unmanaged< T, A >::operator[](), Dune::BlockVector< FieldVector< T, n >, A >::reserve(), Dune::VariableBlockVector< T, A >::resize(), Dune::base_array< B, A >::resize(), Dune::base_array_window< B, A >::set(), Dune::BlockVectorWindow< B, A >::set(), Dune::BlockVectorWindow< B, A >::setptr(), Dune::VariableBlockVector< T, A >::VariableBlockVector(), Dune::base_array< B, A >::~base_array(), Dune::BlockVector< FieldVector< T, n >, A >::~BlockVector(), and Dune::VariableBlockVector< T, A >::~VariableBlockVector().

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

basearray.hh