A packed storage of objects of type <T> using an offset table for access. More...

#include <CompactListList.H>

Inheritance diagram for CompactListList< T >:

Public Types
typedef T	value_type
	The value type the list contains.
typedef T *	pointer
	The pointer type for non-const access to value_type items.
typedef const T *	const_pointer
	The pointer type for const access to value_type items.
typedef T &	reference
	The type used for storing into value_type objects.
typedef const T &	const_reference
	The type used for reading from constant value_type objects.
typedef label	size_type
	The type to represent the size of a CompactListList.

Public Member Functions
	CompactListList () noexcept=default
	Default construct.
	CompactListList (const CompactListList< T > &list)
	Copy construct.
	CompactListList (CompactListList< T > &&list)
	Move construct.
	CompactListList (CompactListList< T > &list, bool reuse)
	Copy/move construct as specified.
	CompactListList (const label mRows, const label nVals)
	Construct from number of rows and number of values.
	CompactListList (const label mRows, const label nVals, Foam::zero)
	Construct from number of rows, number of values initializing all elements to zero.
	CompactListList (const label mRows, const label nVals, const T &)
	Construct from number of rows, number of values and uniform value for all elements.
	CompactListList (const labelUList &listSizes)
	Construct given list of row-sizes.
	CompactListList (const labelUList &listSizes, const T &val)
	Construct given list of row-sizes and a uniform value.
	CompactListList (Istream &is)
	Construct from Istream.
autoPtr< CompactListList< T > >	clone () const
	Clone.
bool	empty () const noexcept
	True if the number of rows/sublists is zero.
bool	single () const noexcept
	True if content is a single row/sublist only. Such content could be flattened out into a straight list (for example).
label	length () const noexcept
	The primary size (the number of rows/sublists).
label	size () const noexcept
	The primary size (the number of rows/sublists).
label	totalSize () const noexcept
	The total addressed size, which corresponds to the end (back) offset and also the sum of all localSizes.
const labelList &	offsets () const noexcept
	Return the offset table (= size()+1).
labelList &	offsets () noexcept
	Return non-const access to the offset table.
const List< T > &	values () const noexcept
	Return the packed values.
List< T > &	values () noexcept
	Return non-const access to the packed values.
const T *	cdata () const noexcept
	Return const pointer to the first data in values().
T *	data () noexcept
	Return pointer to the first data in values().
const char *	cdata_bytes () const noexcept
	Return const pointer to underlying values storage, reinterpreted as byte data.
char *	data_bytes () noexcept
	Return pointer to underlying values storage, reinterpreted as byte data.
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the values data, no runtime check that the type is actually contiguous.
std::streamsize	byteSize () const
	Number of contiguous bytes for the values data, runtime FatalError if type is not contiguous.
labelList	sizes () const
	The local row sizes. Same as localSizes.
const labelUList	localStarts () const
	The local row starts.
labelList	localSizes () const
	The local row sizes.
label	localStart (const label i) const
	Starting offset for given row.
label	localEnd (const label i) const
	End offset (exclusive) for given row.
label	localSize (const label i) const
	Size of given row.
List< labelRange >	ranges () const
	Return start/size ranges for all sub-lists.
labelRange	range (const label i) const
	Return start/size range for given sub-list.
label	maxSize () const
	The max row length used.
void	clear ()
	Clear addressing and contents.
void	resize (const label mRows)
	Reset size of CompactListList.
void	resize (const label mRows, const label nVals)
	Redimension CompactListList.
void	resize_nocopy (const label mRows, const label nVals)
	Redimension without preserving existing content.
void	resize (const label mRows, const label nVals, const T &)
	Redimension CompactListList and fill new elements with value.
void	resize (const labelUList &listSizes)
	Reset dimensions of CompactListList.
void	resize_nocopy (const labelUList &listSizes)
	Reset dimensions of CompactListList without preserving existing content.
void	setLocalSize (const label rowi, const label len)
	Alter local addressing size for given row, does not change content.
void	swap (CompactListList< T > &other)
	Swap contents.
void	transfer (CompactListList< T > &list)
	Transfer contents into this and annul the argument.
label	toGlobal (const label rowi, const label i) const
	From local index on rowi to global (flat) indexing into packed values.
label	toLocal (const label rowi, const label i) const
	From global to local index on rowi.
label	findRow (const label i) const
	Find row where global index comes from. Binary search.
label	whichRow (const label i) const
	Which row does global index come from? Binary search.
template<class SubListType, class OutputIter>
OutputIter	copy_unpack (OutputIter d_iter, const label pos=0, label len=-1) const
	Unpack sub-list copies in the range defined by `pos` and `len` with bounding behaviour like List::slice() by copy constructing begin at the destination iterator `d_iter`.
template<class SubListType, class OutputIter>
OutputIter	copy_unpack (OutputIter d_iter, const labelRange &range) const
	Unpack sub-list copies in the specified range.
template<class SubListType, class OutputIter>
OutputIter	copy_unpack (OutputIter d_iter, const labelUList &indices) const
	Unpack sub-list copies for the specified indices.
template<class SubListType = List<T>>
List< SubListType >	unpack () const
	Return non-compact list of lists.
template<class SubListType = List<T>>
List< SubListType >	unpack (const labelRange &range) const
	Return non-compact list of lists for the range of sub-lists.
template<class SubListType = List<T>>
List< SubListType >	unpack (const labelUList &indices) const
	Return non-compact list of lists for specified indices.
void	operator= (const CompactListList< T > &list)
	Copy assignment.
void	operator= (CompactListList< T > &&list)
	Move assignment.
void	operator= (const T &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
const SubList< T >	localList (const label i) const
	Return const access to sub-list (no subscript checking).
SubList< T >	localList (const label i)
	Return non-const access to sub-list (no subscript checking).
const SubList< T >	operator[] (const label i) const
	Return const access to sub-list (no subscript checking).
SubList< T >	operator[] (const label i)
	Return non-const access to sub-list (no subscript checking).
T &	operator() (const label i, const label j)
	Return subscript-checked element.
const T &	operator() (const label i, const label j) const
	Return const subscript-checked element.
Istream &	readList (Istream &is)
	Read CompactListList as offsets/values pair from Istream, discards current list contents.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write CompactListList as offsets/values pair.
Ostream &	writeMatrix (Ostream &os, const label shortLen=0) const
	Write CompactListList as a formatted matrix of values (ASCII).
const List< T > &	m () const noexcept
	Const access to the packed values.
List< T > &	m () noexcept
	Non-const access to the packed values.
label	index (const label rowi, const label colj) const
	Return flat index into packed values.
label	whichColumn (const label rowi, const label i) const
	Get column within specified row that corresponds to global index.
void	setSize (const label mRows)
	Redimension - same as resize().
void	setSize (const label mRows, const label nVals)
	Redimension - same as resize().
void	setSize (const label mRows, const label nVals, const T &val)
	Redimension - same as resize().
void	setSize (const labelUList &listSizes)
	Reset sizes - same as resize().
template<class ListListType>
Foam::CompactListList< T >	pack_impl (const ListListType &lists, const bool checkOverflow)
template<class SubListType>
Foam::CompactListList< T >	pack (const UList< SubListType > &lists, const bool checkOverflow)
template<class SubListType, class Addr>
Foam::CompactListList< T >	pack (const IndirectListBase< SubListType, Addr > &lists, const bool checkOverflow)
template<class SubListType>
Foam::List< SubListType >	unpack () const
template<class SubListType>
Foam::List< SubListType >	unpack (const labelRange &range) const
template<class SubListType>
Foam::List< SubListType >	unpack (const labelUList &indices) const

Static Public Member Functions
static const CompactListList< T > &	null () noexcept
	Return a null CompactListList (reference to a nullObject).
template<class SubListType = List<T>>
static CompactListList< T >	pack (const UList< SubListType > &lists, const bool checkOverflow=false)
	Construct by packing together the list of lists.
template<class SubListType, class Addr>
static CompactListList< T >	pack (const IndirectListBase< SubListType, Addr > &lists, const bool checkOverflow=false)
	Construct by packing together an indirect list of lists.

Friends
Istream &	operator>> (Istream &is, CompactListList< T > &list)
	Read CompactListList offsets/values pair from Istream, discarding existing contents.
Ostream &	operator<< (Ostream &os, const CompactListList< T > &list)
	Write CompactListList as offsets/values pair.

Detailed Description

template<class T>
class Foam::CompactListList< T >

A packed storage of objects of type <T> using an offset table for access.

The offset table is the size of the number of rows+1 whose elements are the accumulated sizes of the rows, i.e.

offset[i] gives the index of first element of row i
offset[i+1] - offset[i] is the number of elements in row i

Note that an empty CompactListList should have empty offsets (not size 1).

Source files

Definition at line 72 of file CompactListList.H.

Member Typedef Documentation

◆ value_type

template<class T>

typedef T value_type

The value type the list contains.

Definition at line 137 of file CompactListList.H.

◆ pointer

template<class T>

typedef T* pointer

The pointer type for non-const access to value_type items.

Definition at line 142 of file CompactListList.H.

◆ const_pointer

template<class T>

typedef const T* const_pointer

The pointer type for const access to value_type items.

Definition at line 147 of file CompactListList.H.

◆ reference

template<class T>

typedef T& reference

The type used for storing into value_type objects.

Definition at line 152 of file CompactListList.H.

◆ const_reference

template<class T>

typedef const T& const_reference

The type used for reading from constant value_type objects.

Definition at line 157 of file CompactListList.H.

◆ size_type

template<class T>

typedef label size_type

The type to represent the size of a CompactListList.

Definition at line 162 of file CompactListList.H.

Constructor & Destructor Documentation

◆ CompactListList() [1/10]

template<class T>

CompactListList ( )

defaultnoexcept

Default construct.

Referenced by CompactListList(), CompactListList(), CompactListList(), operator<<, operator=(), operator=(), operator>>, swap(), transfer(), and writeMatrix().

Here is the caller graph for this function:

◆ CompactListList() [2/10]

template<class T>

CompactListList ( const CompactListList< T > & list )

inline

Copy construct.

Definition at line 44 of file CompactListListI.H.

References CompactListList().

Here is the call graph for this function:

◆ CompactListList() [3/10]

template<class T>

CompactListList ( CompactListList< T > && list )

inline

Move construct.

Definition at line 55 of file CompactListListI.H.

References CompactListList().

Here is the call graph for this function:

◆ CompactListList() [4/10]

template<class T>

CompactListList	(	CompactListList< T > &	list,
		bool	reuse )

inline

Copy/move construct as specified.

Definition at line 66 of file CompactListListI.H.

References CompactListList().

Here is the call graph for this function:

◆ CompactListList() [5/10]

template<class T>

CompactListList	(	const label	mRows,
		const label	nVals )

inline

Construct from number of rows and number of values.

Definition at line 78 of file CompactListListI.H.

◆ CompactListList() [6/10]

template<class T>

CompactListList	(	const label	mRows,
		const label	nVals,
		Foam::zero	)

inline

Construct from number of rows, number of values initializing all elements to zero.

Definition at line 92 of file CompactListListI.H.

◆ CompactListList() [7/10]

template<class T>

CompactListList	(	const label	mRows,
		const label	nVals,
		const T &	val )

inline

Construct from number of rows, number of values and uniform value for all elements.

Definition at line 107 of file CompactListListI.H.

References Foam::T().

Here is the call graph for this function:

◆ CompactListList() [8/10]

template<class T>

CompactListList ( const labelUList & listSizes )

explicit

Construct given list of row-sizes.

Definition at line 192 of file CompactListList.C.

◆ CompactListList() [9/10]

template<class T>

CompactListList	(	const labelUList &	listSizes,
		const T &	val )

Construct given list of row-sizes and a uniform value.

Definition at line 204 of file CompactListList.C.

References Foam::T().

Here is the call graph for this function:

◆ CompactListList() [10/10]

template<class T>

CompactListList ( Istream & is )

explicit

Construct from Istream.

Definition at line 27 of file CompactListListIO.C.

Member Function Documentation

◆ null()

template<class T>

const CompactListList< T > & null ( )

inlinestaticnoexcept

Return a null CompactListList (reference to a nullObject).

Definition at line 170 of file CompactListList.H.

◆ pack() [1/4]

template<class T>

template<class SubListType = List<T>>

CompactListList< T > pack	(	const UList< SubListType > &	lists,
		const bool	checkOverflow = false )

static

Construct by packing together the list of lists.

Referenced by metisLikeDecomp::decompose(), ptscotchDecomp::decompose(), and GAMGAgglomeration::procAgglomerateLduAddressing().

Here is the caller graph for this function:

◆ pack() [2/4]

template<class T>

template<class SubListType, class Addr>

CompactListList< T > pack	(	const IndirectListBase< SubListType, Addr > &	lists,
		const bool	checkOverflow = false )

static

Construct by packing together an indirect list of lists.

◆ clone()

template<class T>

Foam::autoPtr< Foam::CompactListList< T > > clone ( ) const

inline

Clone.

Definition at line 123 of file CompactListListI.H.

References Foam::New().

Here is the call graph for this function:

◆ empty()

template<class T>

bool empty ( ) const

inlinenoexcept

True if the number of rows/sublists is zero.

Definition at line 167 of file CompactListListI.H.

References Foam::noexcept.

Referenced by Foam::calcCellCellsImpl().

Here is the caller graph for this function:

◆ single()

template<class T>

bool single ( ) const

inlinenoexcept

True if content is a single row/sublist only. Such content could be flattened out into a straight list (for example).

Definition at line 177 of file CompactListListI.H.

References Foam::noexcept.

◆ length()

template<class T>

Foam::label length ( ) const

inlinenoexcept

The primary size (the number of rows/sublists).

Definition at line 184 of file CompactListListI.H.

References Foam::noexcept.

Referenced by writeMatrix().

Here is the caller graph for this function:

◆ size()

template<class T>

Foam::label size ( ) const

inlinenoexcept

The primary size (the number of rows/sublists).

Definition at line 192 of file CompactListListI.H.

References Foam::noexcept.

Referenced by Foam::calcCellCellsImpl(), copy_unpack(), metisLikeDecomp::decompose(), noDecomp::decompose(), ptscotchDecomp::decompose(), randomDecomp::decompose(), Foam::invertOneToManyCompact(), noRenumber::renumber(), randomRenumber::renumber(), SloanRenumber::renumber(), resize(), Foam::subsetAdjacency(), and Foam::subsetAdjacency().

Here is the caller graph for this function:

◆ totalSize()

template<class T>

Foam::label totalSize ( ) const

inlinenoexcept

The total addressed size, which corresponds to the end (back) offset and also the sum of all localSizes.

Definition at line 207 of file CompactListListI.H.

References Foam::noexcept.

Referenced by Foam::calcCellCellsImpl(), and findRow().

Here is the caller graph for this function:

◆ offsets() [1/2]

template<class T>

const labelList & offsets ( ) const

inlinenoexcept

Return the offset table (= size()+1).

Definition at line 294 of file CompactListList.H.

Referenced by Foam::calcCellCellsImpl(), metisLikeDecomp::decompose(), metisLikeDecomp::decompose(), metisLikeDecomp::decompose(), ptscotchDecomp::decompose(), ptscotchDecomp::decompose(), ptscotchDecomp::decompose(), Foam::ensightOutput::Detail::getPolysFacePoints(), Foam::invertOneToManyCompact(), decompositionGAMGAgglomeration::localCellCells(), decompositionGAMGAgglomeration::localCellCells(), GAMGAgglomeration::procAgglomerateLduAddressing(), Foam::subsetAdjacency(), and Foam::subsetAdjacency().

Here is the caller graph for this function:

◆ offsets() [2/2]

template<class T>

labelList & offsets ( )

inlinenoexcept

Return non-const access to the offset table.

Definition at line 299 of file CompactListList.H.

◆ values() [1/2]

template<class T>

const List< T > & values ( ) const

inlinenoexcept

Return the packed values.

Definition at line 304 of file CompactListList.H.

Referenced by Foam::calcCellCellsImpl(), metisLikeDecomp::decompose(), metisLikeDecomp::decompose(), metisLikeDecomp::decompose(), ptscotchDecomp::decompose(), ptscotchDecomp::decompose(), ptscotchDecomp::decompose(), Foam::ensightOutput::Detail::getPolysFacePoints(), Foam::invertOneToManyCompact(), decompositionGAMGAgglomeration::localCellCells(), decompositionGAMGAgglomeration::localCellCells(), localSizes(), GAMGAgglomeration::procAgglomerateLduAddressing(), ranges(), Foam::subsetAdjacency(), and Foam::subsetAdjacency().

Here is the caller graph for this function:

◆ values() [2/2]

template<class T>

List< T > & values ( )

inlinenoexcept

Return non-const access to the packed values.

Definition at line 309 of file CompactListList.H.

◆ cdata()

template<class T>

const T * cdata ( ) const

inlinenoexcept

Return const pointer to the first data in values().

Definition at line 132 of file CompactListListI.H.

References Foam::noexcept, and Foam::T().

Here is the call graph for this function:

◆ data()

template<class T>

T * data ( )

inlinenoexcept

Return pointer to the first data in values().

Definition at line 139 of file CompactListListI.H.

References Foam::noexcept, and Foam::T().

Here is the call graph for this function:

◆ cdata_bytes()

template<class T>

const char * cdata_bytes ( ) const

inlinenoexcept

Return const pointer to underlying values storage, reinterpreted as byte data.

Note: Only meaningful for contiguous data

Definition at line 146 of file CompactListListI.H.

References Foam::noexcept.

◆ data_bytes()

template<class T>

char * data_bytes ( )

inlinenoexcept

Return pointer to underlying values storage, reinterpreted as byte data.

Note: Only meaningful for contiguous data

Definition at line 153 of file CompactListListI.H.

References Foam::noexcept.

◆ size_bytes()

template<class T>

std::streamsize size_bytes ( ) const

inlinenoexcept

Number of contiguous bytes for the values data, no runtime check that the type is actually contiguous.

Note: Only meaningful for contiguous data

Definition at line 160 of file CompactListListI.H.

References Foam::noexcept.

Referenced by byteSize().

Here is the caller graph for this function:

◆ byteSize()

template<class T>

std::streamsize byteSize ( ) const

Number of contiguous bytes for the values data, runtime FatalError if type is not contiguous.

Definition at line 247 of file CompactListList.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::is_contiguous_v, and size_bytes().

Here is the call graph for this function:

◆ sizes()

template<class T>

Foam::labelList sizes ( ) const

inline

The local row sizes. Same as localSizes.

Definition at line 200 of file CompactListListI.H.

References localSizes().

Here is the call graph for this function:

◆ localStarts()

template<class T>

const Foam::labelUList localStarts ( ) const

inline

The local row starts.

Definition at line 222 of file CompactListListI.H.

References UList< label >::null().

Here is the call graph for this function:

◆ localSizes()

template<class T>

Foam::labelList localSizes ( ) const

The local row sizes.

Definition at line 334 of file CompactListList.C.

References values().

Referenced by GAMGAgglomeration::procAgglomerateLduAddressing(), and sizes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ localStart()

template<class T>

Foam::label localStart ( const label i ) const

inline

Starting offset for given row.

Definition at line 233 of file CompactListListI.H.

◆ localEnd()

template<class T>

Foam::label localEnd ( const label i ) const

inline

End offset (exclusive) for given row.

Definition at line 240 of file CompactListListI.H.

◆ localSize()

template<class T>

Foam::label localSize ( const label i ) const

inline

Size of given row.

Definition at line 247 of file CompactListListI.H.

◆ ranges()

template<class T>

Foam::List< Foam::labelRange > ranges ( ) const

Return start/size ranges for all sub-lists.

Definition at line 268 of file CompactListList.C.

References values().

Here is the call graph for this function:

◆ range()

template<class T>

Foam::labelRange range ( const label i ) const

Return start/size range for given sub-list.

Definition at line 260 of file CompactListList.C.

Referenced by copy_unpack().

Here is the caller graph for this function:

◆ maxSize()

template<class T>

Foam::label maxSize ( ) const

inline

The max row length used.

Definition at line 214 of file CompactListListI.H.

◆ clear()

template<class T>

void clear ( )

inline

Clear addressing and contents.

Definition at line 326 of file CompactListListI.H.

◆ resize() [1/4]

template<class T>

void resize ( const label mRows )

inline

Reset size of CompactListList.

Note: this form only allows truncation of the CompactListList.

Definition at line 334 of file CompactListListI.H.

References size().

Referenced by CompactListList< label >::setSize(), CompactListList< label >::setSize(), CompactListList< label >::setSize(), and CompactListList< label >::setSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resize() [2/4]

template<class T>

void resize	(	const label	mRows,
		const label	nVals )

inline

Redimension CompactListList.

Definition at line 359 of file CompactListListI.H.

◆ resize_nocopy() [1/2]

template<class T>

void resize_nocopy	(	const label	mRows,
		const label	nVals )

inline

Redimension without preserving existing content.

Definition at line 380 of file CompactListListI.H.

Referenced by Foam::calcCellCellsImpl(), decompositionGAMGAgglomeration::localCellCells(), and decompositionGAMGAgglomeration::localCellCells().

Here is the caller graph for this function:

◆ resize() [3/4]

template<class T>

void resize	(	const label	mRows,
		const label	nVals,
		const T &	val )

inline

Redimension CompactListList and fill new elements with value.

Definition at line 401 of file CompactListListI.H.

References Foam::T().

Here is the call graph for this function:

◆ resize() [4/4]

template<class T>

void resize ( const labelUList & listSizes )

Reset dimensions of CompactListList.

Definition at line 291 of file CompactListList.C.

◆ resize_nocopy() [2/2]

template<class T>

void resize_nocopy ( const labelUList & listSizes )

Reset dimensions of CompactListList without preserving existing content.

Definition at line 303 of file CompactListList.C.

◆ setLocalSize()

template<class T>

void setLocalSize	(	const label	rowi,
		const label	len )

Alter local addressing size for given row, does not change content.

Definition at line 315 of file CompactListList.C.

References delta.

◆ swap()

template<class T>

void swap ( CompactListList< T > & other )

Swap contents.

Definition at line 357 of file CompactListList.C.

References CompactListList().

Here is the call graph for this function:

◆ transfer()

template<class T>

void transfer ( CompactListList< T > & list )

Transfer contents into this and annul the argument.

Definition at line 373 of file CompactListList.C.

References CompactListList().

Here is the call graph for this function:

◆ toGlobal()

template<class T>

Foam::label toGlobal	(	const label	rowi,
		const label	i ) const

inline

From local index on rowi to global (flat) indexing into packed values.

Definition at line 270 of file CompactListListI.H.

Referenced by CompactListList< label >::index(), operator()(), and operator()().

Here is the caller graph for this function:

◆ toLocal()

template<class T>

Foam::label toLocal	(	const label	rowi,
		const label	i ) const

inline

From global to local index on rowi.

Definition at line 281 of file CompactListListI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Referenced by CompactListList< label >::whichColumn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findRow()

template<class T>

Foam::label findRow ( const label i ) const

inline

Find row where global index comes from. Binary search.

Returns: -1 if out-of-bounds

Definition at line 302 of file CompactListListI.H.

References Foam::findLower(), and totalSize().

Referenced by whichRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ whichRow()

template<class T>

Foam::label whichRow ( const label i ) const

inline

Which row does global index come from? Binary search.

FatalError if out-of-bounds

Definition at line 309 of file CompactListListI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, findRow(), and Foam::nl.

Here is the call graph for this function:

◆ copy_unpack() [1/3]

template<class T>

template<class SubListType, class OutputIter>

OutputIter copy_unpack	(	OutputIter	d_iter,
		const label	pos = 0,
		label	len = -1 ) const

Unpack sub-list copies in the range defined by pos and len with bounding behaviour like List::slice() by copy constructing begin at the destination iterator d_iter.

Returns: Output iterator to the element in the destination range, one past the last element copied.

Parameters

[out]	d_iter	The output destination
	pos	The start of sub-region to copy (no-op if -ve or out-of-range)
	len	The length of sub-region to copy (-ve = until the end)

Definition at line 390 of file CompactListList.C.

References localList(), Foam::pos(), and size().

Referenced by copy_unpack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copy_unpack() [2/3]

template<class T>

template<class SubListType, class OutputIter>

OutputIter copy_unpack	(	OutputIter	d_iter,
		const labelRange &	range ) const

Unpack sub-list copies in the specified range.

Returns: Output iterator to the element in the destination range, one past the last element copied.

Parameters

[out]	d_iter	The output destination
	range	The sub-region to copy

Definition at line 421 of file CompactListList.C.

References copy_unpack(), and range().

Here is the call graph for this function:

◆ copy_unpack() [3/3]

template<class T>

template<class SubListType, class OutputIter>

OutputIter copy_unpack	(	OutputIter	d_iter,
		const labelUList &	indices ) const

Unpack sub-list copies for the specified indices.

Returns: Output iterator to the element in the destination range, one past the last element copied.

Parameters

[out]	d_iter	The output destination
	indices	The sub-regions to copy

Definition at line 433 of file CompactListList.C.

References localList().

Here is the call graph for this function:

◆ unpack() [1/6]

template<class T>

template<class SubListType = List<T>>

List< SubListType > unpack ( ) const

Return non-compact list of lists.

Referenced by multiLevelDecomp::decompose(), and multiLevelDecomp::decompose().

Here is the caller graph for this function:

◆ unpack() [2/6]

template<class T>

template<class SubListType = List<T>>

List< SubListType > unpack ( const labelRange & range ) const

Return non-compact list of lists for the range of sub-lists.

◆ unpack() [3/6]

template<class T>

template<class SubListType = List<T>>

List< SubListType > unpack ( const labelUList & indices ) const

Return non-compact list of lists for specified indices.

◆ operator=() [1/4]

template<class T>

void operator= ( const CompactListList< T > & list )

inline

Copy assignment.

Definition at line 425 of file CompactListListI.H.

References CompactListList().

Here is the call graph for this function:

◆ operator=() [2/4]

template<class T>

void operator= ( CompactListList< T > && list )

inline

Move assignment.

Definition at line 441 of file CompactListListI.H.

References CompactListList().

Here is the call graph for this function:

◆ operator=() [3/4]

template<class T>

void operator= ( const T & val )

inline

Assignment of all entries to the given value.

Definition at line 457 of file CompactListListI.H.

References Foam::T().

Here is the call graph for this function:

◆ operator=() [4/4]

template<class T>

void operator= ( Foam::zero )

inline

Assignment of all entries to zero.

Definition at line 464 of file CompactListListI.H.

◆ localList() [1/2]

template<class T>

const Foam::SubList< T > localList ( const label i ) const

inline

Return const access to sub-list (no subscript checking).

Definition at line 255 of file CompactListListI.H.

Referenced by copy_unpack(), copy_unpack(), operator[](), operator[](), and writeMatrix().

Here is the caller graph for this function:

◆ localList() [2/2]

template<class T>

Foam::SubList< T > localList ( const label i )

inline

Return non-const access to sub-list (no subscript checking).

Definition at line 263 of file CompactListListI.H.

◆ operator[]() [1/2]

template<class T>

const Foam::SubList< T > operator[] ( const label i ) const

inline

Return const access to sub-list (no subscript checking).

Definition at line 472 of file CompactListListI.H.

References localList().

Here is the call graph for this function:

◆ operator[]() [2/2]

template<class T>

Foam::SubList< T > operator[] ( const label i )

inline

Return non-const access to sub-list (no subscript checking).

Definition at line 481 of file CompactListListI.H.

References localList().

Here is the call graph for this function:

◆ operator()() [1/2]

template<class T>

T & operator()	(	const label	i,
		const label	j )

inline

Return subscript-checked element.

Definition at line 489 of file CompactListListI.H.

References Foam::T(), and toGlobal().

Here is the call graph for this function:

◆ operator()() [2/2]

template<class T>

const T & operator()	(	const label	i,
		const label	j ) const

inline

Return const subscript-checked element.

Definition at line 500 of file CompactListListI.H.

References Foam::T(), and toGlobal().

Here is the call graph for this function:

◆ readList()

template<class T>

Foam::Istream & readList ( Istream & is )

Read CompactListList as offsets/values pair from Istream, discards current list contents.

Definition at line 39 of file CompactListListIO.C.

Referenced by operator>>.

Here is the caller graph for this function:

◆ writeList()

template<class T>

Foam::Ostream & writeList	(	Ostream &	os,
		const label	shortLen = 0 ) const

Write CompactListList as offsets/values pair.

Definition at line 49 of file CompactListListIO.C.

References os().

Referenced by operator<<.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeMatrix()

template<class T>

Foam::Ostream & writeMatrix	(	Ostream &	os,
		const label	shortLen = 0 ) const

Write CompactListList as a formatted matrix of values (ASCII).

Definition at line 62 of file CompactListListIO.C.

References IOstreamOption::ASCII, token::BEGIN_LIST, CompactListList(), token::END_LIST, length(), localList(), Foam::nl, and os().

Here is the call graph for this function:

◆ m() [1/2]

template<class T>

const List< T > & m ( ) const

inlinenoexcept

Const access to the packed values.

Definition at line 668 of file CompactListList.H.

◆ m() [2/2]

template<class T>

List< T > & m ( )

inlinenoexcept

Non-const access to the packed values.

Definition at line 674 of file CompactListList.H.

◆ index()

template<class T>

label index	(	const label	rowi,
		const label	colj ) const

inline

Return flat index into packed values.

Definition at line 679 of file CompactListList.H.

◆ whichColumn()

template<class T>

label whichColumn	(	const label	rowi,
		const label	i ) const

inline

Get column within specified row that corresponds to global index.

Definition at line 687 of file CompactListList.H.

◆ setSize() [1/4]

template<class T>

void setSize ( const label mRows )

inline

Redimension - same as resize().

Definition at line 695 of file CompactListList.H.

◆ setSize() [2/4]

template<class T>

void setSize	(	const label	mRows,
		const label	nVals )

inline

Redimension - same as resize().

Definition at line 703 of file CompactListList.H.

◆ setSize() [3/4]

template<class T>

void setSize	(	const label	mRows,
		const label	nVals,
		const T &	val )

inline

Redimension - same as resize().

Definition at line 711 of file CompactListList.H.

◆ setSize() [4/4]

template<class T>

void setSize ( const labelUList & listSizes )

inline

Reset sizes - same as resize().

Definition at line 719 of file CompactListList.H.

◆ pack_impl()

template<class T>

template<class ListListType>

Foam::CompactListList< T > pack_impl	(	const ListListType &	lists,
		const bool	checkOverflow )

Definition at line 60 of file CompactListList.C.

◆ pack() [3/4]

template<class T>

template<class SubListType>

Foam::CompactListList< T > pack	(	const UList< SubListType > &	lists,
		const bool	checkOverflow )

Definition at line 120 of file CompactListList.C.

◆ pack() [4/4]

template<class T>

template<class SubListType, class Addr>

Foam::CompactListList< T > pack	(	const IndirectListBase< SubListType, Addr > &	lists,
		const bool	checkOverflow )

Definition at line 136 of file CompactListList.C.

◆ unpack() [4/6]

template<class T>

template<class SubListType>

Foam::List< SubListType > unpack ( ) const

Definition at line 457 of file CompactListList.C.

◆ unpack() [5/6]

template<class T>

template<class SubListType>

Foam::List< SubListType > unpack ( const labelRange & range ) const

Definition at line 470 of file CompactListList.C.

◆ unpack() [6/6]

template<class T>

template<class SubListType>

Foam::List< SubListType > unpack ( const labelUList & indices ) const

Definition at line 483 of file CompactListList.C.

◆ operator>>

template<class T>

Istream & operator>>	(	Istream &	is,
		CompactListList< T > &	list )

friend

Read CompactListList offsets/values pair from Istream, discarding existing contents.

Definition at line 729 of file CompactListList.H.

References CompactListList(), and readList().

◆ operator<<

template<class T>

Ostream & operator<<	(	Ostream &	os,
		const CompactListList< T > &	list )

friend

Write CompactListList as offsets/values pair.

Definition at line 735 of file CompactListList.H.

References CompactListList(), os(), and writeList().

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

src/meshTools/polyTopoChange/polyTopoChange.H
src/OpenFOAM/containers/CompactLists/CompactListList/CompactListList.H
src/OpenFOAM/containers/CompactLists/CompactListList/CompactListList.C
src/OpenFOAM/containers/CompactLists/CompactListList/CompactListListI.H
src/OpenFOAM/containers/CompactLists/CompactListList/CompactListListIO.C

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ value_type

◆ pointer

◆ const_pointer

◆ reference

◆ const_reference

◆ size_type

Constructor & Destructor Documentation

◆ CompactListList() [1/10]

◆ CompactListList() [2/10]

◆ CompactListList() [3/10]

◆ CompactListList() [4/10]

◆ CompactListList() [5/10]

◆ CompactListList() [6/10]

◆ CompactListList() [7/10]

◆ CompactListList() [8/10]

◆ CompactListList() [9/10]

◆ CompactListList() [10/10]

Member Function Documentation

◆ null()

◆ pack() [1/4]

◆ pack() [2/4]

◆ clone()

◆ empty()

◆ single()

◆ length()

◆ size()

◆ totalSize()

◆ offsets() [1/2]

◆ offsets() [2/2]

◆ values() [1/2]

◆ values() [2/2]

◆ cdata()

◆ data()

◆ cdata_bytes()

◆ data_bytes()

◆ size_bytes()

◆ byteSize()

◆ sizes()

◆ localStarts()

◆ localSizes()

◆ localStart()

◆ localEnd()

◆ localSize()

◆ ranges()

◆ range()

◆ maxSize()

◆ clear()

◆ resize() [1/4]

◆ resize() [2/4]

◆ resize_nocopy() [1/2]

◆ resize() [3/4]

◆ resize() [4/4]

◆ resize_nocopy() [2/2]

◆ setLocalSize()

◆ swap()

◆ transfer()

◆ toGlobal()

◆ toLocal()

◆ findRow()

◆ whichRow()

◆ copy_unpack() [1/3]

◆ copy_unpack() [2/3]

◆ copy_unpack() [3/3]

◆ unpack() [1/6]

◆ unpack() [2/6]

◆ unpack() [3/6]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ localList() [1/2]

◆ localList() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]