MacroAdjustmentIterationLog Class Reference

Public Member Functions
	MacroAdjustmentIterationLog ()
uint	nOuterIterations () const
uint	nGradientIterations (const uint iOuterIteration)
bool	contains (const uint iOuterIteration) const
bool	contains (const uint iOuterIteration, const uint iGradientIteration) const
OuterIterationValidationData	read (const uint iOuterIteration) const
GradientIterationValidationData	read (const uint iOuterIteration, const uint iGradientIteration) const

Detailed Description

A container of iteration info for the Static OD Adjustment. It contains validation data from the outer and gradient iterations. Iterations are counted starting from 1 to N.

Constructor & Destructor Documentation

MacroAdjustmentIterationLog()

MacroAdjustmentIterationLog::MacroAdjustmentIterationLog

(

)

Member Function Documentation

contains() [1/2]

bool MacroAdjustmentIterationLog::contains

(

const uint

iOuterIteration

)

const

Checks whether it contains data from the specified outer iteration.

contains() [2/2]

bool MacroAdjustmentIterationLog::contains	(	const uint	iOuterIteration,
		const uint	iGradientIteration
	)		const

Checks whether it contains data from the specified gradient iteration in the specified outer iteration.

nGradientIterations()

uint MacroAdjustmentIterationLog::nGradientIterations

(

const uint

iOuterIteration

)

Gets the number of gradient descent iterations for the specified outer iterations.

nOuterIterations()

uint MacroAdjustmentIterationLog::nOuterIterations

(

)

const

Gets the number of outer iterations logged.

read() [1/2]

OuterIterationValidationData MacroAdjustmentIterationLog::read

(

const uint

iOuterIteration

)

const

Gets the OuterIterationValidationData for the specified outer iteration. If not found, returns a default OuterIterationValidationData.

read() [2/2]

GradientIterationValidationData MacroAdjustmentIterationLog::read	(	const uint	iOuterIteration,
		const uint	iGradientIteration
	)		const

Gets the GradientIterationValidationData for the specified gradient iteration and outer iteration. If not found, returns a default GradientIterationValidationData.