Safe arrays of data objects.Class DataArray provides safe arrays of Data Objects. For general C++ objects (in contrast to data objects) class Array is provided which manages memory in a C++ compliant way. More...

#include <dataarray.h>

Public Member Functions
T &	operator[] (int n)
	reference `n` 'th element. More...

const T &	operator[] (int n) const
	reference `n` 'th const element. More...

T &	last ()
	reference last element. More...

const T &	last () const
	reference last const element. More...

T *	get_ptr ()
	get a C pointer to the data. More...

const T *	get_const_ptr () const
	get a const C pointer to the data. More...

void	append (const T &t)
	append element `t`. More...

void	append (int n, const T &t)
	append `n` elements with value `t`. More...

void	append (int n, const T t[])
	append `n` elements from `t`. More...

void	append (const DataArray< T > &t)
	append all elements from `t`. More...

void	insert (int i, int n)
	insert `n` uninitialized elements before `i` 'th element. More...

void	insert (int i, int n, const T &t)
	insert `n` elements with value `t` before `i` 'the element. More...

void	insert (int i, int n, const T t[])
	insert `n` elements from `t` before `i` 'the element. More...

void	insert (int i, const DataArray< T > &t)
	insert all elements from `t` before `i` 'th element. More...

void	remove (int n=0, int m=1)
	remove `m` elements starting at `n`. More...

void	removeLast (int m=1)
	remove `m` last elements. More...

void	clear ()
	remove all elements. More...

int	size () const
	return nr. of elements. More...

void	reSize (int newsize)
	reset size to `newsize`. More...

int	max () const
	return maximum number of elements. More...

void	reMax (int newMax=1, int newSize=-1)
	reset maximum number of elements. More...

DataArray &	operator= (const DataArray &rhs)
	assignment operator More...

bool	isConsistent () const
	consistency check More...

	DataArray (const DataArray &old)
	copy constructor More...

	DataArray (int p_size=0, int p_max=0, Real p_fac=1.2)
	default constructor. More...

	~DataArray ()
	destructor More...

Protected Attributes
Real	memFactor
	memory extension factor. More...

Private Attributes
int	thesize
	number of used elements in array data More...

int	themax
	the length of array data and More...

T *	data
	the array of elements More...

Detailed Description

template<class T>
class soplex::DataArray< T >

Safe arrays of data objects.

Class DataArray provides safe arrays of Data Objects. For general C++ objects (in contrast to data objects) class Array is provided which manages memory in a C++ compliant way.

The elements of an instance of DataArray can be accessed just like ordinary C++ array elements by means of the index operator[](). Safety is provided by

automatic memory management in constructor and destructor preventing memory leaks
checking of array bounds when accessing elements with the indexing operator[]() (only when compiled without -DNDEBUG).

Moreover, DataArrays may easily be extended by inserting or appending elements to the DataArray or shrunken by removing elements. Method reSize(int n) resets the DataArrays length to n thereby possibly appending elements or truncating the DataArray to the required size.

A DataArray may be used as arguments for standard C functions requiring pointers through the use of get_ptr() and get_const_ptr().

Internally, a DataArray object allocates a block of memory that fits up to max() elements, only size() of them are used. This makes extension and shrinking methods perform better.

See also: Array, Data Objects

Definition at line 74 of file dataarray.h.

Constructor & Destructor Documentation

◆ DataArray() [1/2]

DataArray ( const DataArray< T > & old )

copy constructor

Definition at line 328 of file dataarray.h.

◆ DataArray() [2/2]

DataArray	(	int	p_size = `0`,
		int	p_max = `0`,
		Real	p_fac = `1.2`
	)

explicit

default constructor.

The constructor allocates an Array containing size uninitialized elements. The internal array is allocated to have max nonzeros, and the memory extension factor is set to fac.

Parameters

p_size	number of unitialised elements.
p_max	maximum number of elements the array can hold.
p_fac	value for memFactor.

Definition at line 353 of file dataarray.h.

◆ ~DataArray()

~DataArray ( )

destructor

Definition at line 370 of file dataarray.h.

Member Function Documentation

◆ append() [1/4]

void append ( const T & t )

append element t.

Definition at line 134 of file dataarray.h.

◆ append() [2/4]

void append	(	int	n,
		const T &	t
	)

append n elements with value t.

Definition at line 139 of file dataarray.h.

◆ append() [3/4]

void append	(	int	n,
		const T	t[]
	)

append n elements from t.

Definition at line 144 of file dataarray.h.

◆ append() [4/4]

void append ( const DataArray< T > & t )

append all elements from t.

Definition at line 149 of file dataarray.h.

◆ clear()

void clear ( )

remove all elements.

Definition at line 221 of file dataarray.h.

Referenced by LPColSetBase< Rational >::clear(), and LPRowSetBase< R >::clear().

◆ get_const_ptr()

const T* get_const_ptr ( ) const

get a const C pointer to the data.

Definition at line 128 of file dataarray.h.

Referenced by SPxBasisBase< R >::Desc::colStatus(), SPxBasisBase< R >::Desc::coStatus(), SPxBasisBase< R >::Desc::rowStatus(), and SPxBasisBase< R >::Desc::status().

◆ get_ptr()

T* get_ptr ( )

get a C pointer to the data.

Definition at line 123 of file dataarray.h.

Referenced by SPxLPBase< BP >::added2Set(), ClassSet< soplex::SVSetBase::DLPSV >::remove(), DataSet< int >::remove(), LPColSetBase< Rational >::remove(), LPRowSetBase< R >::remove(), SVSetBase< BP >::remove(), SPxLPBase< BP >::removeColRange(), SPxLPBase< BP >::removeCols(), SPxLPBase< BP >::removeRowRange(), and SPxLPBase< BP >::removeRows().

◆ insert() [1/4]

void insert	(	int	i,
		int	n
	)

insert n uninitialized elements before i 'th element.

move n elements in memory from insert position i to the back

Definition at line 155 of file dataarray.h.

Referenced by DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::append(), and DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::insert().

◆ insert() [2/4]

void insert	(	int	i,
		int	n,
		const T &	t
	)

insert n elements with value t before i 'the element.

Definition at line 170 of file dataarray.h.

◆ insert() [3/4]

void insert	(	int	i,
		int	n,
		const T	t[]
	)

insert n elements from t before i 'the element.

Definition at line 182 of file dataarray.h.

◆ insert() [4/4]

void insert	(	int	i,
		const DataArray< T > &	t
	)

insert all elements from t before i 'th element.

Definition at line 192 of file dataarray.h.

◆ isConsistent()

bool isConsistent ( ) const

consistency check

Definition at line 311 of file dataarray.h.

Referenced by DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::DataArray(), and DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::operator=().

◆ last() [1/2]

T& last ( )

reference last element.

Definition at line 110 of file dataarray.h.

◆ last() [2/2]

const T& last ( ) const

reference last const element.

Definition at line 116 of file dataarray.h.

◆ max()

int max ( ) const

return maximum number of elements.

Even though the DataArray currently holds no more than size() elements, up to max() elements could be added without need to reallocated free store.

Definition at line 256 of file dataarray.h.

Referenced by DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::DataArray().

◆ operator=()

DataArray& operator= ( const DataArray< T > & rhs )

assignment operator

Definition at line 297 of file dataarray.h.

◆ operator[]() [1/2]

T& operator[] ( int n )

reference n 'th element.

Definition at line 95 of file dataarray.h.

◆ operator[]() [2/2]

const T& operator[] ( int n ) const

reference n 'th const element.

Definition at line 102 of file dataarray.h.

◆ reMax()

void reMax	(	int	newMax = `1`,
		int	newSize = `-1`
	)

reset maximum number of elements.

The value of max() is reset to newMax thereby setting size() to newSize. However, if newSize has a value < 0 (as the default argument does) size() remains unchanged and max() is set to MIN(size(), newMax). Hence, calling reMax() without the default arguments, will reduce the memory consumption to a minimum. In no instance max() will be set to a value less than 1 (even if specified).

Definition at line 271 of file dataarray.h.

Referenced by DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::reSize().

◆ remove()

void remove	(	int	n = `0`,
		int	m = `1`
	)

remove m elements starting at n.

Definition at line 202 of file dataarray.h.

◆ removeLast()

void removeLast ( int m = 1 )

remove m last elements.

Definition at line 215 of file dataarray.h.

◆ reSize()

void reSize ( int newsize )

reset size to newsize.

Resizing a DataArray to less than the previous size, involves discarding its last elements. Resizing to a larger value involves adding uninitialized elements (similar to append()). If neccessary, also memory will be reallocated.

Parameters

newsize the new number of elements the array can hold.

Definition at line 239 of file dataarray.h.

Referenced by LPColSetBase< Rational >::add(), LPRowSetBase< R >::add(), LPColSetBase< Rational >::create(), LPRowSetBase< R >::create(), SPxLPBase< BP >::doAddCols(), SPxLPBase< BP >::doAddRows(), DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::insert(), DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::operator=(), LPColSetBase< Rational >::reMax(), LPRowSetBase< R >::reMax(), LPColSetBase< Rational >::remove(), and LPRowSetBase< R >::remove().

◆ size()

int size ( ) const

return nr. of elements.

Definition at line 227 of file dataarray.h.

Referenced by SPxBasisBase< R >::Desc::coDim(), SPxBasisBase< R >::Desc::dim(), Presol< BP >::getBasis(), SPxMainSM< BP >::getBasis(), DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::insert(), SPxBasisBase< R >::Desc::nCols(), SPxBasisBase< R >::Desc::nRows(), DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::operator=(), DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::remove(), and DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::removeLast().

Member Data Documentation

◆ data

T* data

private

the array of elements

Definition at line 81 of file dataarray.h.

Referenced by DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::DataArray(), DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::get_const_ptr(), DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::get_ptr(), DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::insert(), and DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::operator=().

◆ memFactor

Real memFactor

protected

memory extension factor.

When a DataArray is reSize()d to more than max() elements, the new value for max() is not just set to the new size but rather to memFactor * size. This makes reSizeing perform better in codes where a DataArray is extended often by a small number of elements only.

Definition at line 90 of file dataarray.h.

◆ themax

int themax

private

the length of array data and

Definition at line 80 of file dataarray.h.

Referenced by DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::max().

◆ thesize

int thesize

private

number of used elements in array data

Definition at line 77 of file dataarray.h.

Referenced by DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::insert(), and DataArray< typename soplex::SPxSolverBase< BP >::VarStatus >::size().

SoPlex

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

template<class T> class soplex::DataArray< T >

Constructor & Destructor Documentation

◆ DataArray() [1/2]

◆ DataArray() [2/2]

◆ ~DataArray()

Member Function Documentation

◆ append() [1/4]

◆ append() [2/4]

◆ append() [3/4]

◆ append() [4/4]

◆ clear()

◆ get_const_ptr()

◆ get_ptr()

◆ insert() [1/4]

◆ insert() [2/4]

◆ insert() [3/4]

◆ insert() [4/4]

◆ isConsistent()

◆ last() [1/2]

◆ last() [2/2]

◆ max()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ reMax()

◆ remove()

◆ removeLast()

◆ reSize()

◆ size()

Member Data Documentation

◆ data

◆ memFactor

◆ themax

◆ thesize

template<class T>
class soplex::DataArray< T >