Multiple source linear correlation model simulation. More...

#include <MulSourSim.h>

Inheritance diagram for MTMCSim::MulSourSim:

Classes
class	ESeq
	"Error" sequences. More...

class	MulSourCompRes
	The computed results from input parameters. More...

class	MulSourPara
	The parameters for the simulation. More...

class	MulSourSimuRes
	The simulation results. More...

class	ThreadWorkSpace
	Work space for each thread. More...

Public Member Functions
	MulSourSim (MulSourPara &para_, TextSaveUI &resFile_, TextSaveUI &tempFile_, DispUI &dispUI_)

virtual void	oneThread (shared_ptr< RNObj >, const MCThreadInfo &)
	The work to be done by a worker thread. More...

virtual shared_ptr< RNObj >	genRNObj ()
	Returns the random number object, usually they are random sequences. More...

virtual void	dumpOneResult (const MCThreadInfo &)
	Put the result from one thread to the final result object. More...

virtual bool	checkTerm ()
	Return true if the terminate condition satisfies. More...

void	prepare (const MCThreadInfo &threadInfo)
	This function will be called by the scheduler before the threads are created. More...

void	postProcess ()
	This function will be called after the RNG thread and worker threads are done. More...

void	setCompResMap (compResMap &compResM_) const
	Calls compRes.setMapping(compResM_);. More...

void	OneKnownFrame (const string &)

Public Member Functions inherited from MTMCSim::MTMCSimBase
void	singleThreadSim ()
	Single thread simulation. More...

virtual	~MTMCSimBase ()
	Virtual Destructor. More...

Detailed Description

Multiple source linear correlation model simulation.

Simulation only simulates the encoding and decoding of the "error" vectors.

Constructor & Destructor Documentation

MTMCSim::MulSourSim::MulSourSim	(	MulSourPara &	para_,
		TextSaveUI &	resFile_,
		TextSaveUI &	tempFile_,
		DispUI &	dispUI_
	)

Member Function Documentation

bool MTMCSim::MulSourSim::checkTerm ( )

virtual

Return true if the terminate condition satisfies.

Thread safty is partially guaranteed by the scheduler. The result object will be locked but only the result object will be locked. So, typically it only reads the parameter object (which is always safe) and reads the result object (because the result object is locked by the scheduler)

Implements MTMCSim::MTMCSimBase.

void MTMCSim::MulSourSim::dumpOneResult ( const MCThreadInfo & )

virtual

Put the result from one thread to the final result object.

It itself does not need to consider thread safty because a mutex will be locked before it is called.

Implements MTMCSim::MTMCSimBase.

shared_ptr< RNObj > MTMCSim::MulSourSim::genRNObj ( )

virtual

Returns the random number object, usually they are random sequences.

Each object is for one thread. The object is created by "new" inside the function and can be accessed througth the renturned shared_ptr.

Implements MTMCSim::MTMCSimBase.

void MTMCSim::MulSourSim::OneKnownFrame ( const string & seqFN)

void MTMCSim::MulSourSim::oneThread	(	shared_ptr< RNObj >	,
		const MCThreadInfo &
	)

virtual

The work to be done by a worker thread.

This function should be written in a thread-safe manner, i.e., no conflict. no critical section. This typically can be done by creating workspace for each thread, either as an automatic variable in the function, or as a data member in the simulator class.

Implements MTMCSim::MTMCSimBase.

void MTMCSim::MulSourSim::postProcess ( )

virtual

This function will be called after the RNG thread and worker threads are done.

Reimplemented from MTMCSim::MTMCSimBase.

void MTMCSim::MulSourSim::prepare ( const MCThreadInfo & )

virtual

This function will be called by the scheduler before the threads are created.

\ Typically do resource allocation here.

Reimplemented from MTMCSim::MTMCSimBase.

void MTMCSim::MulSourSim::setCompResMap ( compResMap & compResM_) const

inlinevirtual