Induces a block order by fully traversing an SBDTree. More...

#include <BlockOrderer.hpp>

Inheritance diagram for BlockOrderer< T >:

Collaboration diagram for BlockOrderer< T >:

Public Member Functions
	BlockOrderer ()
	Base constructor.

virtual	~BlockOrderer ()
	Base destructor.

std::vector< std::vector < Triplet< T > > >	induce (const std::vector< Triplet< T > > &input, std::vector< unsigned long int > &r_hierarchy, std::vector< unsigned long int > &c_hierarchy, std::vector< unsigned long int > &r_bounds, std::vector< unsigned long int > &c_bounds, std::vector< signed char > *datatype)
	Induces this ordering on a set of nonzeroes.

Protected Member Functions
void	prefix (const unsigned long int index)
	Prefix operation during SBD tree traversal. More...

void	infix (const unsigned long int index)
	Infix operation during SBD tree traversal. More...

void	postfix (const unsigned long int index)
	Postfix operation during SBD tree traversal. More...

void	traverse ()
	Traverses the SBD tree, makes call to prefix, infix, and postfix during traversal. More...

void	pre_height (const unsigned long int index)
	Prefix code for height-determining traversal. More...

void	in_height (const unsigned long int index)
	Infix code for height-determining traversal. More...

void	post_height (const unsigned long int index)
	Postfix code for height-determining traversal. More...

virtual void	pre_readout (const unsigned long int index)=0
	Prefix traversal code. More...

virtual void	in_readout (const unsigned long int index)=0
	Infix traversal code. More...

virtual void	post_readout (const unsigned long int index)=0
	Postfix traversal code. More...

bool	left_horizontal (const unsigned long int index, const Triplet< T > triplet)
	Helper function for determining place of a nonzero within a separator cross.

bool	right_horizontal (const unsigned long int index, const Triplet< T > triplet)
	Helper function for determining place of a nonzero within a separator cross.

bool	upper_vertical (const unsigned long int index, const Triplet< T > triplet)
	Helper function for determining place of a nonzero within a separator cross.

bool	lower_vertical (const unsigned long int index, const Triplet< T > triplet)
	Helper function for determining place of a nonzero within a separator cross.

bool	middle (const unsigned long int index, const Triplet< T > triplet)
	Helper function for determining place of a nonzero within a separator cross.

Protected Attributes
SBDTree *	tree
	The SBD tree to order the blocks of. More...

std::vector< char >	leftpass
	Stores whether a node has been traversed from the left. More...

std::vector< char >	rightpass
	Stores whether a node has been traversed from the right. More...

char	traverse_mode
	Sets the traversal mode. More...

unsigned long int *	height
	Stores the height of a SBD node. More...

unsigned long int	cur_height
	The current height at the traversal position. More...

std::vector< Triplet< T > > *	items
	Nonzero storage at each node. More...

std::vector< std::vector < Triplet< T > > > *	output
	Output structure after SBD readout (series of blocks in the correct order). More...

std::vector< signed char > *	datatype
	The data type of each block. More...

Static Protected Attributes
static const char	TRAVERSE_HEIGHT = 0
	Mode flag for height-determining traversal. More...

static const char	READOUT = 1
	Mode flag for SBD tree readouts. More...

Detailed Description

template<typename T>
class BlockOrderer< T >

Induces a block order by fully traversing an SBDTree.

Member Function Documentation

template<typename T>

void BlockOrderer< T >::in_height ( const unsigned long int index )

protected

Infix code for height-determining traversal.

template<typename T>

virtual void BlockOrderer< T >::in_readout ( const unsigned long int index )

protectedpure virtual

Infix traversal code.

Implemented in MinCCS< T >, MinCRS< T >, BlockCRS< T >, U2< T >, Duck< T >, and SepLast< T >.

Referenced by BlockOrderer< T >::infix().

template<typename T>

void BlockOrderer< T >::infix ( const unsigned long int index )

inlineprotected

Infix operation during SBD tree traversal.

References BlockOrderer< T >::cur_height, BlockOrderer< T >::height, BlockOrderer< T >::in_readout(), BlockOrderer< T >::READOUT, BlockOrderer< T >::TRAVERSE_HEIGHT, and BlockOrderer< T >::traverse_mode.

Referenced by BlockOrderer< T >::traverse().

template<typename T>

void BlockOrderer< T >::post_height ( const unsigned long int index )

protected

Postfix code for height-determining traversal.

template<typename T>

virtual void BlockOrderer< T >::post_readout ( const unsigned long int index )

protectedpure virtual

Postfix traversal code.

Implemented in MinCCS< T >, MinCRS< T >, BlockCRS< T >, U2< T >, Duck< T >, and SepLast< T >.

Referenced by BlockOrderer< T >::postfix().

template<typename T>

void BlockOrderer< T >::postfix ( const unsigned long int index )

inlineprotected

Postfix operation during SBD tree traversal.

References BlockOrderer< T >::cur_height, BlockOrderer< T >::post_readout(), BlockOrderer< T >::READOUT, BlockOrderer< T >::TRAVERSE_HEIGHT, and BlockOrderer< T >::traverse_mode.

Referenced by BlockOrderer< T >::traverse().

template<typename T>

void BlockOrderer< T >::pre_height ( const unsigned long int index )

protected

Prefix code for height-determining traversal.

template<typename T>

virtual void BlockOrderer< T >::pre_readout ( const unsigned long int index )

protectedpure virtual

Prefix traversal code.

Implemented in BlockCRS< T >, MinCCS< T >, MinCRS< T >, U2< T >, Duck< T >, and SepLast< T >.

Referenced by BlockOrderer< T >::prefix().

template<typename T>

void BlockOrderer< T >::prefix ( const unsigned long int index )

inlineprotected

Prefix operation during SBD tree traversal.

References BlockOrderer< T >::cur_height, BlockOrderer< T >::pre_readout(), BlockOrderer< T >::READOUT, BlockOrderer< T >::TRAVERSE_HEIGHT, and BlockOrderer< T >::traverse_mode.

Referenced by BlockOrderer< T >::traverse().

template<typename T>

void BlockOrderer< T >::traverse ( )

inlineprotected

Traverses the SBD tree, makes call to prefix, infix, and postfix during traversal.

References SBDTree::getRoot(), BlockOrderer< T >::infix(), SBDTree::isLeaf(), SBDTree::left(), BlockOrderer< T >::leftpass, BlockOrderer< T >::postfix(), BlockOrderer< T >::prefix(), SBDTree::right(), BlockOrderer< T >::rightpass, SBDTree::size(), BlockOrderer< T >::tree, and SBDTree::up().

Referenced by BlockOrderer< T >::induce().

Member Data Documentation

template<typename T>

unsigned long int BlockOrderer< T >::cur_height

protected

The current height at the traversal position.

Referenced by BlockOrderer< T >::induce(), BlockOrderer< T >::infix(), BlockOrderer< T >::postfix(), and BlockOrderer< T >::prefix().

template<typename T>

std::vector< signed char >* BlockOrderer< T >::datatype

protected

The data type of each block.

Referenced by Duck< T >::in_readout(), BlockCRS< T >::in_readout(), U2< T >::in_readout(), MinCCS< T >::in_readout(), MinCRS< T >::in_readout(), BlockOrderer< T >::induce(), SepLast< T >::post_readout(), Duck< T >::post_readout(), U2< T >::post_readout(), MinCCS< T >::post_readout(), MinCRS< T >::post_readout(), Duck< T >::pre_readout(), SepLast< T >::pre_readout(), MinCCS< T >::pre_readout(), MinCRS< T >::pre_readout(), U2< T >::pre_readout(), and BlockCRS< T >::pre_readout().

template<typename T>

unsigned long int* BlockOrderer< T >::height

protected

Stores the height of a SBD node.

Referenced by BlockOrderer< T >::induce(), and BlockOrderer< T >::infix().

template<typename T>

std::vector< Triplet< T > >* BlockOrderer< T >::items

protected

Nonzero storage at each node.

Referenced by Duck< T >::in_readout(), BlockCRS< T >::in_readout(), U2< T >::in_readout(), MinCCS< T >::in_readout(), MinCRS< T >::in_readout(), BlockOrderer< T >::induce(), SepLast< T >::post_readout(), Duck< T >::post_readout(), U2< T >::post_readout(), MinCCS< T >::post_readout(), MinCRS< T >::post_readout(), Duck< T >::pre_readout(), SepLast< T >::pre_readout(), MinCCS< T >::pre_readout(), MinCRS< T >::pre_readout(), U2< T >::pre_readout(), and BlockCRS< T >::pre_readout().

template<typename T>

std::vector< char > BlockOrderer< T >::leftpass

protected

Stores whether a node has been traversed from the left.

Referenced by BlockOrderer< T >::traverse().

template<typename T>

std::vector< std::vector< Triplet< T > > >* BlockOrderer< T >::output

protected

Output structure after SBD readout (series of blocks in the correct order).

Referenced by Duck< T >::in_readout(), U2< T >::in_readout(), BlockCRS< T >::in_readout(), MinCCS< T >::in_readout(), MinCRS< T >::in_readout(), BlockOrderer< T >::induce(), SepLast< T >::post_readout(), Duck< T >::post_readout(), U2< T >::post_readout(), MinCCS< T >::post_readout(), MinCRS< T >::post_readout(), SepLast< T >::pre_readout(), Duck< T >::pre_readout(), MinCCS< T >::pre_readout(), BlockCRS< T >::pre_readout(), MinCRS< T >::pre_readout(), U2< T >::pre_readout(), and BlockOrderer< T >::~BlockOrderer().

template<typename T>

const char BlockOrderer< T >::READOUT = 1

staticprotected

Mode flag for SBD tree readouts.

Referenced by BlockOrderer< T >::induce(), BlockOrderer< T >::infix(), BlockOrderer< T >::postfix(), and BlockOrderer< T >::prefix().

template<typename T>

std::vector< char > BlockOrderer< T >::rightpass

protected

Stores whether a node has been traversed from the right.

Referenced by BlockOrderer< T >::traverse().

template<typename T>

const char BlockOrderer< T >::TRAVERSE_HEIGHT = 0

staticprotected

Mode flag for height-determining traversal.

Referenced by BlockOrderer< T >::induce(), BlockOrderer< T >::infix(), BlockOrderer< T >::postfix(), and BlockOrderer< T >::prefix().

template<typename T>

char BlockOrderer< T >::traverse_mode

protected

Sets the traversal mode.

Referenced by BlockOrderer< T >::induce(), BlockOrderer< T >::infix(), BlockOrderer< T >::postfix(), and BlockOrderer< T >::prefix().

template<typename T>

SBDTree* BlockOrderer< T >::tree

protected

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

BlockOrderer.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

template<typename T> class BlockOrderer< T >

Member Function Documentation

Member Data Documentation

template<typename T>
class BlockOrderer< T >