Namespace for enumerations associated with SGSolve. More...

Enumerations
enum	EXCEPTION_TYPE { DEFAULT, FAILED_OPEN, PROB_SUM_NOT1, TOO_MANY_PIVOT_UPDATES, NO_ADMISSIBLE_DIRECTION, UNKNOWN_PARAM, BAD_PARAM_VALUE, TUPLE_SIZE_MISMATCH, EMPTY_TUPLE, OUT_OF_BOUNDS, DIVIDE_BY_ZERO, INCONSISTENT_INPUTS, SIMERROR, NOFEASIBLETUPLE, NOEDGES, NOACTIONS, NOOPTIMALPOLICIES, WRONG_NUMBER_OF_PLAYERS, MAX_ITERATIONS_REACHED, NO_ITERATIONS }
	Code for the type of error. More...

enum	DBL_PARAM { ERRORTOL, DIRECTIONTOL, PASTTHREATTOL, UPDATEPIVOTTOL, POLICYITERTOL, ICTOL, NORMTOL, FLATTOL, LEVELTOL, IMPROVETOL, ROUNDTOL, BACKBENDINGTOL, MOVEMENTTOL, INTERSECTTOL, BNDRYPNTTOL, SUBGENFACTOR, TRANSITION_PROB_TOL, LEXIMPROVETOL, LEXSUBOPTOL, NUMDOUBLEPARAMS }
	Double parameters. More...

enum	BOOL_PARAM { BACKBENDINGWARNING, MERGETUPLES, PRINTTOLOG, PRINTTOCOUT, STOREACTIONS, CHECKSUFFICIENT, NUMBOOLPARAMS }
	Boolean parameters. More...

enum	INT_PARAM { MAXITERATIONS, MAXPOLICYITERATIONS, MAXUPDATEPIVOTPASSES, STOREITERATIONS, TUPLERESERVESIZE, NUMINTPARAMS }
	Integer parameters. More...

enum	Regime { NonBinding, Binding, Binding0, Binding1, Binding01 }
	Indicates which incentive constraints are binding.

Detailed Description

Namespace for enumerations associated with SGSolve.

Enumeration Type Documentation

◆ BOOL_PARAM

enum SG::BOOL_PARAM

Boolean parameters.

An enumeration type for boolean parameters. Used with SGEnv::setParam to set boolean parameter values.

Enumerator
BACKBENDINGWARNING	If true, the algorithm will issue a warning to stdout when a back-bending direction is detected.
MERGETUPLES	If true, the algorithm will replace the last extreme tuple with the new pivot when either a flat has been detected or the movement in the pivot is too small.
PRINTTOLOG	If true, the algorithm will print progress to a log file.
PRINTTOCOUT	If true, the algorithm will print progress to cout.
STOREACTIONS	If true, the algorithm will store all actions available at the given iteration.
CHECKSUFFICIENT	If true, the algorithm will check a sufficient condition for the pivot to not cut into the equilibrium payoff correspondence.
NUMBOOLPARAMS	Used internally to indicate the number of enumerated bool parameters.

◆ DBL_PARAM

enum SG::DBL_PARAM

Double parameters.

An enumeration type for parameters of type double. Pass this argment to SGEnv::setParam, along with the new value, to change the parameter.

Enumerator
ERRORTOL	The algorithm stops when the distance between successive revolutions is below this level.
DIRECTIONTOL	Threshold for changing cardinal directions.
PASTTHREATTOL	Minimum increase in the threat tuple at which the minimum IC continuation values are rebuilt.
UPDATEPIVOTTOL	The algorithm stops updating the pivot when successive updates are below this level.
ICTOL	Tolerance for convergence in policy function iteration Maximum allowable violation of IC constraints.
NORMTOL	Vectors with a Euclidean norm below this level are considered zero.
FLATTOL	When the cosine of an angle is below this level, it is considered to be zero.
LEVELTOL	Maximum cosine for a binding direction to be considered below the non-binding direction.
IMPROVETOL	Minimum cosine relative to the current best direction for the new direction to be considered an improvement.
ROUNDTOL	When positive, the algorithm will round off the pivot coordinates to this degree of accuracy.
BACKBENDINGTOL	When the cosine of a direction relative to the current direction is above this threshold, the direction is considered "back-bending".
MOVEMENTTOL	If the movement of the pivot in multiples of the current direction is below this threshold, the new pivot will replace the current last extreme point.
BNDRYPNTTOL	Controls the length of segment that is sufficient to take an intersection in SGAction.
SUBGENFACTOR	Distance below which extreme binding continuation values are considered equal .
TRANSITION_PROB_TOL	Scaling of the hyperplanes to test for supergeneration.
LEXIMPROVETOL	Tolerance for difference bteween sum of transition prob and one
LEXSUBOPTOL	Tolerance used to measure an improvement for lexicographic comparison
NUMDOUBLEPARAMS	Tolerance used to measure optimality for lexicographic comparison Used internally to indicate the number of enumerated double parameters.

◆ EXCEPTION_TYPE

enum SG::EXCEPTION_TYPE

Code for the type of error.

Enumerator
DEFAULT	No specific error
FAILED_OPEN	SGData was not able to open the given file.
PROB_SUM_NOT1	Probabilities did not sum to 1.
TOO_MANY_PIVOT_UPDATES	Pivot did not converge within the allowed number of updates.
NO_ADMISSIBLE_DIRECTION	SGApprox::findBestDirection() was not able to find an admissible direction.
UNKNOWN_PARAM	Parameter name does not correspond to any in SGEnv.
BAD_PARAM_VALUE	Parameter value is not admissible.
TUPLE_SIZE_MISMATCH	Tried to perform arithmetic operation on SGTuples or vectors of different sizes.
EMPTY_TUPLE	Tried to perform arithmetic operation on an empty tuple.
OUT_OF_BOUNDS	Passed an argument that was out of bounds, e.g., player < 0 or state >= numStates.
DIVIDE_BY_ZERO	Encountered an attempt to divide by zero.
INCONSISTENT_INPUTS	Inputs are incompatible or inconsistent with one another, e.g., arrays that should be the same size are not.
SIMERROR	Simulator error.
NOFEASIBLETUPLE	Could not find a feasible tuple for APS.
NOEDGES	Could not find an edge in a product policy.
NOACTIONS	Could not find an action.
NOOPTIMALPOLICIES	Could not find an optimal policy for some state.
WRONG_NUMBER_OF_PLAYERS	Number of players is incomaptible with viewer
MAX_ITERATIONS_REACHED	The maximum number of iterations was reached
NO_ITERATIONS	Cannot load a solution with no iterations

◆ INT_PARAM

enum SG::INT_PARAM

Integer parameters.

An enumeration type for int parameters. Used with SGEnv::setParam to set integer parameter values.