sbrt.kernel.fba.proc
Class CdHarFluxVectorProcess<F extends Fluxome>

java.lang.Object
  extended by sbrt.kernel.fba.proc.FbaProcess<F,CdHarFluxComp.Results>
      extended by sbrt.kernel.fba.proc.CdHarFluxVectorProcess<F>
Type Parameters:
F - the fluxome type.
All Implemented Interfaces:
KernelProcess<CdHarFluxComp.Results>, MonitoredProcess<CdHarFluxComp.Results>

public final class CdHarFluxVectorProcess<F extends Fluxome>
extends FbaProcess<F,CdHarFluxComp.Results>
implements MonitoredProcess<CdHarFluxComp.Results>

This class is used to perform coordinate direction hit-and-run flux vector processes.

Author:
This class was written and documented by Jeremiah Wright while in the Wagner lab.

Constructor Summary
CdHarFluxVectorProcess(CdHarFluxComp<F> computer)
          Constructs a new coordinate direction hit-and-run flux vector process.
 
Method Summary
 F getFluxome()
          Returns the fluxome for which flux vectors are to be generated.
 int getIterations()
          Returns the total number of flux vectors to be generated.
 int getMaxWastedMoves()
          Returns the allowed number of wasted moves.
 int getPointsPerPoint()
          Returns the number of points generated per points returned.
 ProgressMonitor getProgress()
          Returns a progress monitor for this process.
 void run(ResultsManager<CdHarFluxComp.Results> resultsManager)
          Generates the specified number of random flux vectors and adds each to the provided results manager.
 void setIterations(int iterations)
          Sets the total number of flux vectors to be generated.
 void setMaxWastedMoves(int maxWastedMoves)
          Sets the maximum number of wasted moves to allow.
 void setPointsPerPoint(int pointsPerPoint)
          Sets the number of points to generate for each point added to the specified results manager.
 
Methods inherited from class sbrt.kernel.fba.proc.FbaProcess
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CdHarFluxVectorProcess

public CdHarFluxVectorProcess(CdHarFluxComp<F> computer)
Constructs a new coordinate direction hit-and-run flux vector process.

Parameters:
computer - the computer with which all flux vectors will be generated.
Method Detail

setIterations

public void setIterations(int iterations)
Sets the total number of flux vectors to be generated.

Parameters:
iterations - the total number of flux vector to be generated.

setMaxWastedMoves

public void setMaxWastedMoves(int maxWastedMoves)
Sets the maximum number of wasted moves to allow.

Parameters:
maxWastedMoves - the number of wasted moves to allow.

setPointsPerPoint

public void setPointsPerPoint(int pointsPerPoint)
Sets the number of points to generate for each point added to the specified results manager.

Parameters:
pointsPerPoint - the number of points to generate for each point added to the specified results manager.

getIterations

public int getIterations()
Returns the total number of flux vectors to be generated.

Returns:
the total number of flux vectors to be generated.

getMaxWastedMoves

public int getMaxWastedMoves()
Returns the allowed number of wasted moves.

Returns:
the allowed number of wasted moves.

getPointsPerPoint

public int getPointsPerPoint()
Returns the number of points generated per points returned.

Returns:
the number of points generated per points returned.

getFluxome

public F getFluxome()
Returns the fluxome for which flux vectors are to be generated.

Specified by:
getFluxome in class FbaProcess<F extends Fluxome,CdHarFluxComp.Results>
Returns:
the fluxome for which flux vectors are to be generated.

getProgress

public ProgressMonitor getProgress()
Returns a progress monitor for this process.

Specified by:
getProgress in interface MonitoredProcess<CdHarFluxComp.Results>
Returns:
a progress monitor for this process.

run

public void run(ResultsManager<CdHarFluxComp.Results> resultsManager)
Generates the specified number of random flux vectors and adds each to the provided results manager.

Specified by:
run in interface KernelProcess<CdHarFluxComp.Results>
Parameters:
resultsManager - the results manager to which all computed vectors will be added.