BCESolve
BCEException Class Reference

Exception class for BCESolve. More...

#include <bceexception.hpp>

Inheritance diagram for BCEException:
Collaboration diagram for BCEException:

Public Types

enum  ErrorType {
  OutOfBounds , ConditionFailed , BCECounterConditionFailed , BCEAbstractGameConditionFailed ,
  NoEquilibria , MapFrontierNotOptimal , FailedOpen , NotProbDistr ,
  BadArgument , BadArgumentBCEComparator , BadArgumentBCEUtilities , BadArgumentBCEAbstractGame ,
  InvalidParameterName , InvalidParameterValue , ICConstraintViolated , WrongDistnSize ,
  WrongWeightSize , AlreadyPopulated
}
 Type of error. More...
 

Public Member Functions

 BCEException (ErrorType errorTypeArg)
 Constructor. More...
 
const char * what () const throw ()
 Reimplements std::exception::what().
 
string getMessage ()
 Returns an error message. More...
 

Public Attributes

ErrorType errorType
 Gives the error code for this BCEException.
 

Detailed Description

Exception class for BCESolve.

This class derives from std::exception and implements special error codes.

Examples
allpayauction.cpp, fpaknown.cpp, and fpaunknown.cpp.

Member Enumeration Documentation

◆ ErrorType

Type of error.

Enumerator
OutOfBounds 

Index out of bounds.

ConditionFailed 

A condition was not met.

BCECounterConditionFailed 

A condition was not met in BCECounter.

BCEAbstractGameConditionFailed 

Condition not met in BCEAbstractGame.

NoEquilibria 

No equilibria.

MapFrontierNotOptimal 

Gurobi was not able to calculate an optimum during the BCESolver::mapBoundary routine.

FailedOpen 

Could not open file.

NotProbDistr 

Argument was not a probability distribution, probably because some variable was negative or probabilities did not sum to one.

BadArgument 

Generic error code for a bad argument.

BadArgumentBCEComparator 

Bad argument in BCEComparator

BadArgumentBCEUtilities 

Bad argument in BCEUtilities

BadArgumentBCEAbstractGame 

Bad argument in BCEAbstractGame

InvalidParameterName 

Unrecognized parameter name.

InvalidParameterValue 

Parameter value was invalid.

ICConstraintViolated 

Incentive constraint violated.

WrongDistnSize 

Size of Distn doesn't reflect the number of actions.

AlreadyPopulated 

Size of Weights given in BCESolver::solve() doesn't match number of objs. Solver is already populated

Constructor & Destructor Documentation

◆ BCEException()

BCEException::BCEException ( ErrorType  errorTypeArg)
inline

Constructor.

Initializes a new exception with the given ErrorType.

Member Function Documentation

◆ getMessage()

string BCEException::getMessage ( )
inline

Returns an error message.

Has not been fully implemented.

Examples
allpayauction.cpp, and fpaunknown.cpp.

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