Dynamic arrays indexed with nodes. More...

#include <ogdf/basic/NodeArray.h>

Inheritance diagram for ogdf::NodeArray< T >:

Public Types
using	const_iterator = internal::GraphArrayConstIterator< NodeArray< T > >
	The type for node array const iterators.

using	iterator = internal::GraphArrayIterator< NodeArray< T > >
	The type for node array iterators.

using	key_type = node
	The type for array keys.

using	value_type = T
	The type for array entries.

Public Member Functions
	NodeArray ()
	Constructs an empty node array associated with no graph.

	NodeArray (const Graph &G)
	Constructs a node array associated with `G`.

	NodeArray (const Graph &G, const T &x)
	Constructs a node array associated with `G`.

	NodeArray (const NodeArray< T > &A)
	Constructs a node array that is a copy of `A`.

	NodeArray (NodeArray< T > &&A)
	Constructs a node array containing the elements of `A` (move semantics).

Access methods
These methods provide access to elements and the corresponding graph.
bool	valid () const
	Returns true iff the array is associated with a graph.

const Graph *	graphOf () const
	Returns a pointer to the associated graph.

const T &	operator[] (node v) const
	Returns a reference to the element with index `v`.

T &	operator[] (node v)
	Returns a reference to the element with index `v`.

const T &	operator() (node v) const
	Returns a reference to the element with index `v`.

T &	operator() (node v)
	Returns a reference to the element with index `v`.

const T &	operator[] (int index) const
	Returns a reference to the element with index `index`.

T &	operator[] (int index)
	Returns a reference to the element with index `index`.

Iterators
These methods return bidirectional iterators to elements in the array.
iterator	begin ()
	Returns an iterator to the first entry in the node array.

const_iterator	begin () const
	Returns a const iterator to the first entry in the node array.

const_iterator	cbegin () const
	Returns a const iterator to the first entry in the node array.

iterator	end ()
	Returns an iterator to one-past-last entry in the node array.

const_iterator	end () const
	Returns a const iterator to one-past-last entry in the node array.

const_iterator	cend () const
	Returns a const iterator to one-past-last entry in the node array.

Initialization and assignment
These methods can be used to reinitialize the array, or to initialize all elements with a given value.
void	init ()
	Reinitializes the array. Associates the array with no graph.

void	init (const Graph &G)
	Reinitializes the array. Associates the array with `G`.

void	init (const Graph &G, const T &x)
	Reinitializes the array. Associates the array with `G`.

void	fill (const T &x)
	Sets all array elements to `x`.

NodeArray< T > &	operator= (const NodeArray< T > &a)
	Assignment operator.

NodeArray< T > &	operator= (NodeArray< T > &&a)
	Assignment operator (move semantics).

Static Public Member Functions
Helper functions
These methods are mainly intended for internal use.
static key_type	findSuccKey (key_type key)

static key_type	findPredKey (key_type key)

Private Member Functions
virtual void	disconnect ()
	Virtual function called when array is disconnected from the graph.

virtual void	enlargeTable (int newTableSize)
	Virtual function called when table size has to be enlarged.

virtual void	reinit (int initTableSize)
	Virtual function called when table has to be reinitialized.

Private Member Functions inherited from ogdf::Array< T >
	Array ()
	Creates an array with empty index set.

	Array (Array< T, int > &&A)
	Creates an array containing the elements of `A` (move semantics).

	Array (const Array< T, int > &A)
	Creates an array that is a copy of `A`.

	Array (const ArrayBuffer< T, int > &A)
	Creates an array that is a copy of `A`. The array-size is set to be the number of elements (not the capacity) of the buffer.

	Array (int a, int b)
	Creates an array with index set [`a`..`b`].

	Array (int a, int b, const T &x)
	Creates an array with index set [`a`..`b`] and initializes each element with `x`.

	Array (int s)
	Creates an array with index set [0..`s-1`].

	Array (std::initializer_list< T > initList)
	Creates an array containing the elements in the initializer list `initList`.

	~Array ()
	Destruction.

int	low () const
	Returns the minimal array index.

int	high () const
	Returns the maximal array index.

int	size () const
	Returns the size (number of elements) of the array.

bool	empty () const
	Returns `true` iff there are no elements in the array.

const_reference	operator[] (int i) const
	Returns a reference to the element at position `i`.

reference	operator[] (int i)
	Returns a reference to the element at position `i`.

iterator	begin ()
	Returns an iterator to the first element.

const_iterator	begin () const
	Returns a const iterator to the first element.

const_iterator	cbegin () const
	Returns a const iterator to the first element.

iterator	end ()
	Returns an iterator to one past the last element.

const_iterator	end () const
	Returns a const iterator to one past the last element.

const_iterator	cend () const
	Returns a const iterator to one past the last element.

reverse_iterator	rbegin ()
	Returns an reverse iterator to the last element.

const_reverse_iterator	rbegin () const
	Returns a const reverse iterator to the last element.

const_reverse_iterator	crbegin () const
	Returns a const reverse iterator to the last element.

reverse_iterator	rend ()
	Returns an reverse iterator to one before the first element.

const_reverse_iterator	rend () const
	Returns a const reverse iterator to one before the first element.

const_reverse_iterator	crend () const
	Returns a const reverse iterator to one before the first element.

void	init ()
	Reinitializes the array to an array with empty index set.

void	init (int s)
	Reinitializes the array to an array with index set [0..`s-1`].

void	init (int a, int b)
	Reinitializes the array to an array with index set [`a`..`b`].

void	init (int a, int b, const T &x)
	Reinitializes the array to an array with index set [`a`..`b`] and sets all entries to `x`.

void	fill (const T &x)
	Sets all elements to `x`.

void	fill (int i, int j, const T &x)
	Sets elements in the intervall [`i`..`j`] to `x`.

void	grow (int add, const T &x)
	Enlarges the array by `add` elements and sets new elements to `x`.

void	grow (int add)
	Enlarges the array by `add` elements.

void	resize (int newSize, const T &x)
	Resizes (enlarges or shrinks) the array to hold `newSize` elements and sets new elements to `x`.

void	resize (int newSize)
	Resizes (enlarges or shrinks) the array to hold `newSize` elements.

Array< T, int > &	operator= (const Array< T, int > &A)
	Assignment operator.

Array< T, int > &	operator= (Array< T, int > &&A)
	Assignment operator (move semantics).

bool	operator== (const Array< T, int > &L) const
	Equality operator.

bool	operator!= (const Array< T, int > &L) const
	Inequality operator.

void	swap (int i, int j)
	Swaps the elements at position `i` and `j`.

void	permute (int l, int r)
	Randomly permutes the subarray with index set [`l`..`r`].

void	permute ()
	Randomly permutes the array.

void	permute (int l, int r, RNG &rng)
	Randomly permutes the subarray with index set [`l`..`r`] using random number generator `rng`.

void	permute (RNG &rng)
	Randomly permutes the array using random number generator `rng`.

int	binarySearch (const T &e) const
	Performs a binary search for element `e`.

int	binarySearch (int l, int r, const T &e) const
	Performs a binary search for element `e` within the array section [`l`, ..., `r`] .

int	binarySearch (const T &e, const COMPARER &comp) const
	Performs a binary search for element `e` with comparer `comp`.

int	binarySearch (int l, int r, const T &e, const COMPARER &comp) const
	Performs a binary search for element `e` within the array section [`l`, ..., `r`] with comparer `comp`.

int	linearSearch (const T &e) const
	Performs a linear search for element `e`.

int	linearSearch (const T &e, const COMPARER &comp) const
	Performs a linear search for element `e` with comparer `comp`.

void	quicksort ()
	Sorts array using Quicksort.

void	quicksort (int l, int r)
	Sorts subarray with index set [`l`, ..., `r`] using Quicksort.

void	quicksort (const COMPARER &comp)
	Sorts array using Quicksort and a user-defined comparer `comp`.

void	quicksort (int l, int r, const COMPARER &comp)
	Sorts the subarray with index set [`l`, ..., `r`] using Quicksort and a user-defined comparer `comp`.

void	leftShift (ArrayBuffer< int, int > &ind)
	Removes the components listed in `ind` by shifting the remaining components to the left.

void	leftShift (ArrayBuffer< int, int > &ind, const T &val)
	Removes the components listed in `ind` by shifting the remaining components to the left.

Private Attributes
T	m_x
	The default value for array elements.

Additional Inherited Members
Protected Member Functions inherited from ogdf::NodeArrayBase
	NodeArrayBase ()
	Initializes an node array not associated with a graph.

	NodeArrayBase (const Graph *pG)
	Initializes an node array associated with `pG`.

	NodeArrayBase (NodeArrayBase &base)
	Moves node array `base` to this node array.

virtual	~NodeArrayBase ()

void	moveRegister (NodeArrayBase &base)
	Moves array registration from `base` to this array.

void	reregister (const Graph *pG)
	Associates the array with a new graph.

Protected Attributes inherited from ogdf::NodeArrayBase
const Graph *	m_pGraph
	The associated graph.

Private Types inherited from ogdf::Array< T >
using	const_iterator = ArrayConstIterator< T >
	Provides a random-access iterator that can read a const element in an array.

using	const_reference = const T &
	Provides a reference to a const element stored in an array for reading and performing const operations.

using	const_reverse_iterator = ArrayConstReverseIterator< T >
	Provides a reverse random-access iterator that can read a const element in an array.

using	iterator = ArrayIterator< T >
	Provides a random-access iterator that can read or modify any element in an array.

using	reference = T &
	Provides a reference to an element stored in an array.

using	reverse_iterator = ArrayReverseIterator< T >
	Provides a reverse random-access iterator that can read or modify any element in an array.

using	value_type = T
	Represents the data type stored in an array element.

Static Private Attributes inherited from ogdf::Array< T >
static const int	maxSizeInsertionSort
	Threshold used by quicksort() such that insertion sort is called for instances smaller than maxSizeInsertionSort.

Detailed Description

template<class T>
class ogdf::NodeArray< T >

Dynamic arrays indexed with nodes.

NodeArrays represent a mapping from nodes to data of type T. They adjust their table size automatically when the graph grows.

Warning: Undefined behavior can occur when the array is used in the left-hand side of an assignment and the observed graph is changed in the right-hand side. To resolve the issue, use:

auto tmp = RHS; LHS = std::move(tmp);

getDoubleFactoredZeroAdjustedMerger
static MultilevelBuilder * getDoubleFactoredZeroAdjustedMerger()
Definition multilevelmixer.cpp:36

Template Parameters

T	is the element type.

Definition at line 125 of file NodeArray.h.

Member Typedef Documentation

◆ const_iterator

template<class T >

using ogdf::NodeArray< T >::const_iterator = internal::GraphArrayConstIterator<NodeArray<T> >

The type for node array const iterators.

Definition at line 134 of file NodeArray.h.

◆ iterator

template<class T >

using ogdf::NodeArray< T >::iterator = internal::GraphArrayIterator<NodeArray<T> >

The type for node array iterators.

Definition at line 132 of file NodeArray.h.

◆ key_type

template<class T >

using ogdf::NodeArray< T >::key_type = node

The type for array keys.

Definition at line 129 of file NodeArray.h.

◆ value_type

template<class T >

using ogdf::NodeArray< T >::value_type = T

The type for array entries.

Definition at line 130 of file NodeArray.h.

Constructor & Destructor Documentation

◆ NodeArray() [1/5]

template<class T >

ogdf::NodeArray< T >::NodeArray ( )

inline

Constructs an empty node array associated with no graph.

Definition at line 138 of file NodeArray.h.

◆ NodeArray() [2/5]

template<class T >

ogdf::NodeArray< T >::NodeArray ( const Graph & G )

inline

Constructs a node array associated with G.

Definition at line 141 of file NodeArray.h.

◆ NodeArray() [3/5]

template<class T >

ogdf::NodeArray< T >::NodeArray	(	const Graph &	G,
		const T &	x
	)

inline

Constructs a node array associated with G.

Parameters

G	is the associated graph.
x	is the default value for all array elements.

Definition at line 148 of file NodeArray.h.

◆ NodeArray() [4/5]

template<class T >

ogdf::NodeArray< T >::NodeArray ( const NodeArray< T > & A )

inline

Constructs a node array that is a copy of A.

Associates the array with the same graph as A and copies all elements.

Definition at line 155 of file NodeArray.h.

◆ NodeArray() [5/5]

template<class T >

ogdf::NodeArray< T >::NodeArray ( NodeArray< T > && A )

inline

Constructs a node array containing the elements of A (move semantics).

NodeArray A is empty afterwards and not associated with any graph.

Definition at line 161 of file NodeArray.h.

Member Function Documentation

◆ begin() [1/2]

template<class T >

iterator ogdf::NodeArray< T >::begin ( )

inline

Returns an iterator to the first entry in the node array.

If the node array is empty, an invalid iterator is returned.

Definition at line 226 of file NodeArray.h.

◆ begin() [2/2]

template<class T >

const_iterator ogdf::NodeArray< T >::begin ( ) const

inline

Returns a const iterator to the first entry in the node array.

If the node array is empty, an invalid iterator is returned.

Definition at line 232 of file NodeArray.h.

◆ cbegin()

template<class T >

const_iterator ogdf::NodeArray< T >::cbegin ( ) const

inline

Returns a const iterator to the first entry in the node array.

If the node array is empty, an invalid iterator is returned.

Definition at line 238 of file NodeArray.h.

◆ cend()

template<class T >

const_iterator ogdf::NodeArray< T >::cend ( ) const

inline

Returns a const iterator to one-past-last entry in the node array.

This is always an invalid iterator.

Definition at line 256 of file NodeArray.h.

◆ disconnect()

template<class T >

virtual void ogdf::NodeArray< T >::disconnect ( )

inlineprivatevirtual

Virtual function called when array is disconnected from the graph.

Implements ogdf::NodeArrayBase.

Definition at line 332 of file NodeArray.h.

◆ end() [1/2]

template<class T >

iterator ogdf::NodeArray< T >::end ( )

inline

Returns an iterator to one-past-last entry in the node array.

This is always an invalid iterator.

Definition at line 244 of file NodeArray.h.

◆ end() [2/2]

template<class T >

const_iterator ogdf::NodeArray< T >::end ( ) const

inline

Returns a const iterator to one-past-last entry in the node array.

This is always an invalid iterator.

Definition at line 250 of file NodeArray.h.

◆ enlargeTable()

template<class T >

virtual void ogdf::NodeArray< T >::enlargeTable ( int newTableSize )

inlineprivatevirtual

Virtual function called when table size has to be enlarged.

Implements ogdf::NodeArrayBase.

Definition at line 328 of file NodeArray.h.

◆ fill()

template<class T >

void ogdf::NodeArray< T >::fill ( const T & x )

inline

Sets all array elements to x.

Definition at line 288 of file NodeArray.h.

◆ findPredKey()

template<class T >

static key_type ogdf::NodeArray< T >::findPredKey ( key_type key )

inlinestatic

Definition at line 323 of file NodeArray.h.

◆ findSuccKey()

template<class T >

static key_type ogdf::NodeArray< T >::findSuccKey ( key_type key )

inlinestatic

Definition at line 321 of file NodeArray.h.

◆ graphOf()

template<class T >

const Graph * ogdf::NodeArray< T >::graphOf ( ) const

inline

Returns a pointer to the associated graph.

Definition at line 173 of file NodeArray.h.

◆ init() [1/3]

template<class T >

void ogdf::NodeArray< T >::init ( )

inline

Reinitializes the array. Associates the array with no graph.

Definition at line 266 of file NodeArray.h.

◆ init() [2/3]

template<class T >

void ogdf::NodeArray< T >::init ( const Graph & G )

inline

Reinitializes the array. Associates the array with G.

Definition at line 272 of file NodeArray.h.

◆ init() [3/3]

template<class T >

void ogdf::NodeArray< T >::init	(	const Graph &	G,
		const T &	x
	)

inline

Reinitializes the array. Associates the array with G.

Parameters

G	is the associated graph.
x	is the default value.

Definition at line 282 of file NodeArray.h.

◆ operator()() [1/2]

template<class T >

T & ogdf::NodeArray< T >::operator() ( node v )

inline

Returns a reference to the element with index v.

Definition at line 197 of file NodeArray.h.

◆ operator()() [2/2]

template<class T >

const T & ogdf::NodeArray< T >::operator() ( node v ) const

inline

Returns a reference to the element with index v.

Definition at line 190 of file NodeArray.h.

◆ operator=() [1/2]

template<class T >

NodeArray< T > & ogdf::NodeArray< T >::operator= ( const NodeArray< T > & a )

inline

Assignment operator.

Definition at line 296 of file NodeArray.h.

◆ operator=() [2/2]

template<class T >

NodeArray< T > & ogdf::NodeArray< T >::operator= ( NodeArray< T > && a )

inline

Assignment operator (move semantics).

Nodearray a is empty afterwards and not associated with any graph.

Definition at line 307 of file NodeArray.h.

◆ operator[]() [1/4]

template<class T >

T & ogdf::NodeArray< T >::operator[] ( int index )

inline

Returns a reference to the element with index index.

Attention: Make sure that index is a valid index for a node in the associated graph!

Deprecated:: "NodeArrays should be indexed by a node, not an integer index."

Definition at line 213 of file NodeArray.h.

◆ operator[]() [2/4]

template<class T >

const T & ogdf::NodeArray< T >::operator[] ( int index ) const

inline

Returns a reference to the element with index index.

Attention: Make sure that index is a valid index for a node in the associated graph!

Deprecated:: "NodeArrays should be indexed by a node, not an integer index."

Definition at line 207 of file NodeArray.h.

◆ operator[]() [3/4]

template<class T >

T & ogdf::NodeArray< T >::operator[] ( node v )

inline

Returns a reference to the element with index v.

Definition at line 183 of file NodeArray.h.

◆ operator[]() [4/4]

template<class T >

const T & ogdf::NodeArray< T >::operator[] ( node v ) const

inline

Returns a reference to the element with index v.

Definition at line 176 of file NodeArray.h.

◆ reinit()

template<class T >

virtual void ogdf::NodeArray< T >::reinit ( int initTableSize )

inlineprivatevirtual

Virtual function called when table has to be reinitialized.

Implements ogdf::NodeArrayBase.

Definition at line 330 of file NodeArray.h.

◆ valid()

template<class T >

bool ogdf::NodeArray< T >::valid ( ) const

inline

Returns true iff the array is associated with a graph.

Definition at line 170 of file NodeArray.h.

Member Data Documentation

◆ m_x

template<class T >

T ogdf::NodeArray< T >::m_x

private

The default value for array elements.

Definition at line 126 of file NodeArray.h.

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

include/ogdf/basic/Graph_d.h
include/ogdf/basic/NodeArray.h

OpenGraph DrawingFramework

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ key_type

◆ value_type

Constructor & Destructor Documentation

◆ NodeArray() [1/5]

◆ NodeArray() [2/5]

◆ NodeArray() [3/5]

◆ NodeArray() [4/5]

◆ NodeArray() [5/5]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ disconnect()

◆ end() [1/2]

◆ end() [2/2]

◆ enlargeTable()

◆ fill()

◆ findPredKey()

◆ findSuccKey()

◆ graphOf()

◆ init() [1/3]

◆ init() [2/3]

◆ init() [3/3]

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ reinit()

◆ valid()

Member Data Documentation

◆ m_x

Open
Graph Drawing
Framework