mfem::Table Class Reference

#include <table.hpp>

Inheritance diagram for mfem::Table:

Public Member Functions
	Table ()
	Creates an empty table. More...
	Table (const Table &)
	Copy constructor. More...
	Table (int dim, int connections_per_row=3)
	Create a table with an upper limit for the number of connections. More...
	Table (int nrows, Array< Connection > &list)
	Table (int nrows, int *partitioning)
void	MakeI (int nrows)
	Next 7 methods are used together with the default constructor. More...
void	AddAColumnInRow (int r)
void	AddColumnsInRow (int r, int ncol)
void	MakeJ ()
void	AddConnection (int r, int c)
void	AddConnections (int r, const int *c, int nc)
void	ShiftUpI ()
void	SetSize (int dim, int connections_per_row)
	Set the size and the number of connections for the table. More...
void	SetDims (int rows, int nnz)
int	Size () const
	Returns the number of TYPE I elements. More...
int	Size_of_connections () const
int	operator() (int i, int j) const
void	GetRow (int i, Array< int > &row) const
	Return row i in array row (the Table must be finalized) More...
int	RowSize (int i) const
const int *	GetRow (int i) const
int *	GetRow (int i)
int *	GetI ()
int *	GetJ ()
const int *	GetI () const
const int *	GetJ () const
void	SortRows ()
	Sort the column (TYPE II) indices in each row. More...
void	SetIJ (int *newI, int *newJ, int newsize=-1)
int	Push (int i, int j)
void	Finalize ()
void	MakeFromList (int nrows, const Array< Connection > &list)
int	Width () const
	Returns the number of TYPE II elements (after Finalize() is called). More...
void	LoseData ()
	Call this if data has been stolen. More...
void	Print (std::ostream &out=std::cout, int width=4) const
	Prints the table to stream out. More...
void	PrintMatlab (std::ostream &out) const
void	Save (std::ostream &out) const
void	Load (std::istream &in)
void	Copy (Table &copy) const
void	Swap (Table &other)
void	Clear ()
long	MemoryUsage () const
	~Table ()
	Destroys Table. More...

Protected Attributes
int	size
	size is the number of TYPE I elements. More...
int *	I
int *	J

Detailed Description

Data type Table. Table stores the connectivity of elements of TYPE I to elements of TYPE II, for example, it may be Element-To-Face connectivity table, etc.

Definition at line 39 of file table.hpp.

Constructor & Destructor Documentation

mfem::Table::Table ( )

inline

Creates an empty table.

Definition at line 53 of file table.hpp.

mfem::Table::Table

(

const Table &

table

)

Copy constructor.

Definition at line 26 of file table.cpp.

mfem::Table::Table ( int  dim, int  connections_per_row = 3  )

explicit

Create a table with an upper limit for the number of connections.

Definition at line 43 of file table.cpp.

mfem::Table::Table ( int  nrows, Array< Connection > &  list  )

inline

Create a table from a list of connections, see MakeFromList.

Definition at line 62 of file table.hpp.

mfem::Table::Table	(	int	nrows,
		int *	partitioning
	)

Create a table with one entry per row with column indices given by 'partitioning'.

Definition at line 59 of file table.cpp.

mfem::Table::~Table

(

)

Destroys Table.

Definition at line 402 of file table.cpp.

Member Function Documentation

void mfem::Table::AddAColumnInRow ( int  r )

inline

Definition at line 71 of file table.hpp.

void mfem::Table::AddColumnsInRow ( int  r, int  ncol  )

inline

Definition at line 72 of file table.hpp.

void mfem::Table::AddConnection ( int  r, int  c  )

inline

Definition at line 74 of file table.hpp.

void mfem::Table::AddConnections	(	int	r,
		const int *	c,
		int	nc
	)

Definition at line 96 of file table.cpp.

void mfem::Table::Clear

(

)

Definition at line 363 of file table.cpp.

void mfem::Table::Copy

(

Table &

copy

)

const

Definition at line 371 of file table.cpp.

void mfem::Table::Finalize

(

)

Finalize the table initialization. The function may be called only once, after the table has been initialized, in order to compress array J (by getting rid of -1's in array J). Calling this function will "freeze" the table and function Push will work no more. Note: The table is functional even without calling Finalize().

Definition at line 229 of file table.cpp.

int* mfem::Table::GetI ( )

inline

Definition at line 107 of file table.hpp.

const int* mfem::Table::GetI ( ) const

inline

Definition at line 109 of file table.hpp.

int* mfem::Table::GetJ ( )

inline

Definition at line 108 of file table.hpp.

const int* mfem::Table::GetJ ( ) const

inline

Definition at line 110 of file table.hpp.

void mfem::Table::GetRow	(	int	i,
		Array< int > &	row
	)		const

Return row i in array row (the Table must be finalized)

Definition at line 179 of file table.cpp.

const int* mfem::Table::GetRow ( int  i ) const

inline

Definition at line 104 of file table.hpp.

int* mfem::Table::GetRow ( int  i )

inline

Definition at line 105 of file table.hpp.

void mfem::Table::Load

(

std::istream &

in

)

Definition at line 344 of file table.cpp.

void mfem::Table::LoseData ( )

inline

Call this if data has been stolen.

Definition at line 141 of file table.hpp.

void mfem::Table::MakeFromList	(	int	nrows,
		const Array< Connection > &	list
	)

Create the table from a list of connections {(from, to)}, where 'from' is a TYPE I index and 'to' is a TYPE II index. The list is assumed to be sorted and free of duplicities, i.e., you need to call Array::Sort and Array::Unique before calling this method.

Definition at line 264 of file table.cpp.

void mfem::Table::MakeI

(

int

nrows

)

Next 7 methods are used together with the default constructor.

Definition at line 74 of file table.cpp.

void mfem::Table::MakeJ

(

)

Definition at line 84 of file table.cpp.

long mfem::Table::MemoryUsage

(

)

const

Definition at line 396 of file table.cpp.

int mfem::Table::operator()	(	int	i,
		int	j
	)		const

Returns index of the connection between element i of TYPE I and element j of TYPE II. If there is no connection between element i and element j established in the table, then the return value is -1.

Definition at line 157 of file table.cpp.

void mfem::Table::Print	(	std::ostream &	out = std::cout,
		int	width = 4
	)		const

Prints the table to stream out.

Definition at line 295 of file table.cpp.

void mfem::Table::PrintMatlab

(

std::ostream &

out

)

const

Definition at line 317 of file table.cpp.

int mfem::Table::Push	(	int	i,
		int	j
	)

Establish connection between element i and element j in the table. The return value is the index of the connection. It returns -1 if it fails to establish the connection. Possibilities are there is not enough memory on row i to establish connection to j, an attempt to establish new connection after calling Finalize().

Definition at line 208 of file table.cpp.

int mfem::Table::RowSize ( int  i ) const

inline

Definition at line 102 of file table.hpp.

void mfem::Table::Save

(

std::ostream &

out

)

const

Definition at line 330 of file table.cpp.

void mfem::Table::SetDims	(	int	rows,
		int	nnz
	)

Set the rows and the number of all connections for the table. Does NOT initialize the whole array I ! (I[0]=0 and I[rows]=nnz only)

Definition at line 132 of file table.cpp.

void mfem::Table::SetIJ	(	int *	newI,
		int *	newJ,
		int	newsize = -1
	)

Definition at line 196 of file table.cpp.

void mfem::Table::SetSize	(	int	dim,
		int	connections_per_row
	)

Set the size and the number of connections for the table.

Definition at line 116 of file table.cpp.

void mfem::Table::ShiftUpI

(

)

Definition at line 107 of file table.cpp.

int mfem::Table::Size ( ) const

inline

Returns the number of TYPE I elements.

Definition at line 86 of file table.hpp.

int mfem::Table::Size_of_connections ( ) const

inline

Returns the number of connections in the table. If Finalize() is not called, it returns the number of possible connections established by the used constructor. Otherwise, it is exactly the number of established connections before calling Finalize().

Definition at line 92 of file table.hpp.

void mfem::Table::SortRows

(

)

Sort the column (TYPE II) indices in each row.

Definition at line 188 of file table.cpp.

void mfem::Table::Swap

(

Table &

other

)

Definition at line 389 of file table.cpp.

int mfem::Table::Width

(

)

const

Returns the number of TYPE II elements (after Finalize() is called).

Definition at line 285 of file table.cpp.

Member Data Documentation

int* mfem::Table::I

protected

Arrays for the connectivity information in the CSR storage. I is of size "size+1", J is of size the number of connections between TYPE I to TYPE II elements (actually stored I[size]).

Definition at line 49 of file table.hpp.

int * mfem::Table::J

protected

Definition at line 49 of file table.hpp.

int mfem::Table::size

protected

size is the number of TYPE I elements.

Definition at line 44 of file table.hpp.

---

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

• table.hpp
• table.cpp