frodo2.algorithms.StatsReporterWithConvergence< Val extends Addable< Val > >.CurrentAssignment< Val > Class Template Reference

A convenience class to store an assignment. More...

Public Member Functions
	CurrentAssignment (long timeStamp, Val assignment)
	A constructor.
	CurrentAssignment (long timeStamp, long cycleCount, Val assignment)
	A constructor.
long	getTimeStamp (boolean time)
Val	getAssignment ()
String	toString ()

Private Attributes
final long	timeStamp
	The time stamp (in nanoseconds).
final long	cycleCount
	When dealing with synchronous algorithms, the cycle count can be stored in this field.
final Val	assignment
	The current assignment.

Detailed Description

A convenience class to store an assignment.

Used to determine convergence speed of an algorithm

Author

brammert

Parameters

<Val>

type used for variable values

Constructor & Destructor Documentation

CurrentAssignment() [1/2]

frodo2.algorithms.StatsReporterWithConvergence< Val extends Addable< Val > >.CurrentAssignment< Val >.CurrentAssignment	(	long	timeStamp,
		Val	assignment )

A constructor.

Parameters

timeStamp	The absolute time at which this assignment was set (in nanoseconds)
assignment	The assignment

References assignment, and timeStamp.

CurrentAssignment() [2/2]

frodo2.algorithms.StatsReporterWithConvergence< Val extends Addable< Val > >.CurrentAssignment< Val >.CurrentAssignment	(	long	timeStamp,
		long	cycleCount,
		Val	assignment )

A constructor.

Parameters

timeStamp	The absolute time at which this assignment was set (in nanoseconds)
cycleCount	The cycle count time stamp
assignment	The assignment

References assignment, cycleCount, and timeStamp.

Member Function Documentation

getAssignment()

Val frodo2.algorithms.StatsReporterWithConvergence< Val extends Addable< Val > >.CurrentAssignment< Val >.getAssignment

(

)

Returns

the assignment

getTimeStamp()

long frodo2.algorithms.StatsReporterWithConvergence< Val extends Addable< Val > >.CurrentAssignment< Val >.getTimeStamp

(

boolean

time

)

Parameters

time	true when the time stamp must be returned, and false when the cycle count must be returned

Returns

the time stamp

References cycleCount.

toString()

String frodo2.algorithms.StatsReporterWithConvergence< Val extends Addable< Val > >.CurrentAssignment< Val >.toString

(

)

See also

java.lang.Object#toString()

References assignment, and timeStamp.

Member Data Documentation

assignment

final Val frodo2.algorithms.StatsReporterWithConvergence< Val extends Addable< Val > >.CurrentAssignment< Val >.assignment

private

The current assignment.

Referenced by CurrentAssignment(), CurrentAssignment(), and toString().

cycleCount

final long frodo2.algorithms.StatsReporterWithConvergence< Val extends Addable< Val > >.CurrentAssignment< Val >.cycleCount

private

When dealing with synchronous algorithms, the cycle count can be stored in this field.

Referenced by CurrentAssignment(), and getTimeStamp().

timeStamp

final long frodo2.algorithms.StatsReporterWithConvergence< Val extends Addable< Val > >.CurrentAssignment< Val >.timeStamp

private

The time stamp (in nanoseconds).

Referenced by CurrentAssignment(), CurrentAssignment(), and toString().

---

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

• src/frodo2/algorithms/StatsReporterWithConvergence.java