Utilities.h File Reference

#include <iostream>

Include dependency graph for Utilities.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	vsnprintf_s(buffer, bufSize, count, format, argptr)   vsnprintf(buffer, count, format, argptr)
	Macro to define vsnprintf_s if not defined.
#define	_fileno   fileno
	Macro to define _fileno if not defined.
#define	ctime_s(buffer, size, time)   ctime_r(time, buffer);
	Macro to define ctime_s if not defined.
#define	ASSERT(x)
	Define a convenient macro for using c asserts.
#define	VALIDATE(x)
	Define a convenient macro for extra checks that can be easily compiled out to improve performance.
Functions
char *	getTimeStamp (const char *fileName, char *buffer)
char *	getTime (char *buffer, const time_t *codedTime=NULL)

---

Define Documentation

#define _fileno   fileno

Macro to define _fileno if not defined.

This macro provides a replacement for the _fileno function defined in Windows but is absent in Unix/Linux. This macro simply defines _fileno as fileno in Unix and Linux.

Definition at line 155 of file Utilities.h.

Referenced by ResultLog::~ResultLog().

#define ASSERT

(

x

)

Define a convenient macro for using c asserts.

Define a custom macro ASSERT (note the all caps) method to be used instead of the c assert method to enable compiling ASSERT usages in and out of the source code. When the compiler flag DEVELOPER_ASSERTIONS is specified then the ASSERT call defaults to the normal assert method. For example ASSERT (<boolean expression>)} will be mapped to assert (<boolean expression>). If the compiler flag DEVELOPER_ASSERTIONS is not specified then the ASSERT simply gets compiled out.

Definition at line 191 of file Utilities.h.

Referenced by MSTCluster::add(), FilterChain::addFilter(), HeuristicChain::addHeuristic(), PMSTClusterMaker::addMoreChildESTs(), MSTClusterMaker::addMoreChildESTs(), FilterChain::allToAllBroadcast(), TransMSTClusterMaker::analyze(), FilterChain::applyFilters(), CLU::buildHashMaps(), D2Zim::buildWordTable(), UVSampleHeuristic::computeHash(), NewUVHeuristic::computeHash(), CLU::createCLUHashMap(), D2Zim::getMetric(), CLU::getMetric(), CLU::getSimilarity(), MSTCluster::guiPrintClusterTree(), LengthFilter::initialize(), LCFilter::initialize(), InteractiveConsole::InteractiveConsole(), PMSTClusterMaker::makeClusters(), MSTClusterMaker::makeClusters(), MSTCluster::makeClusters(), MSTCluster::makeMergedClusters(), PMSTClusterMaker::manager(), MSTClusterMaker::manager(), MSTMultiListCache::mergeList(), PMSTClusterMaker::mergeManager(), MSTCluster::MSTCluster(), PMSTClusterMaker::populateCache(), MSTClusterMaker::populateCache(), MSTClusterMaker::populateMST(), LengthFilter::runFilter(), LCFilter::runFilter(), UVSampleHeuristic::setReferenceEST(), NewUVHeuristic::setReferenceEST(), CLU::setReferenceEST(), ESTCodec::setRevCompTable(), HeuristicChain::setupChain(), FilterChain::setupChain(), ParameterSetManager::setupParameters(), and TwoPassD2::updateParameters().

#define ctime_s	(	buffer,
		size,
		time		)	ctime_r(time, buffer);

Macro to define ctime_s if not defined.

This macro provides a replacement for the ctime_s function defined in Windows but is absent in Unix/Linux. This macro simply defines ctime_s as ctime_r in Unix and Linux.

Definition at line 167 of file Utilities.h.

Referenced by getTime().

#define VALIDATE

(

x

)

Define a convenient macro for extra checks that can be easily compiled out to improve performance.

Define a custom macro VALIDATE (note the all caps) to be used around additional extra checks that can be easily compiled out to improve performance. When the compiler flag ENABLE_VALIDATES is specified then the VALIDATE call defaults to the normal operation and are included in the source code. If the compiler flag ENABLE_VALIDATES is not specified then the VALIDATE code simply gets compiled out.

Definition at line 216 of file Utilities.h.

Referenced by TwoPassD2::getMetric(), D2::getMetric(), UVSampleHeuristic::runHeuristic(), and NewUVHeuristic::runHeuristic().

#define vsnprintf_s	(	buffer,
		bufSize,
		count,
		format,
		argptr		)	vsnprintf(buffer, count, format, argptr)

Macro to define vsnprintf_s if not defined.

This macro provides a replacement for the vsnprintf_s function defined in Windows but is absent in Unix/Linux. This macro simply defines vsnprintf_s as vsnprinf in Unix and Linux.

Definition at line 143 of file Utilities.h.

Referenced by ResultLog::report(), and ResultLog::reportLine().

---

Function Documentation

char* getTime	(	char *	buffer,
		const time_t *	codedTime = NULL
	)

Definition at line 70 of file Utilities.cpp.

References ctime_s.

Referenced by FWAnalyzer::dumpHeader(), getTimeStamp(), MSTCluster::guiPrintClusterTree(), and MST::serialize().

char* getTimeStamp	(	const char *	fileName,
		char *	buffer
	)

Definition at line 43 of file Utilities.cpp.

References getTime().

Referenced by MSTCluster::guiPrintClusterTree(), and MST::serialize().