bceexception.hpp

// This file is part of the BCESolve library for games of incomplete
// information
// Copyright (C) 2022 Benjamin A. Brooks
// 
// BCESolve free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// BCESolve is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see
// <http://www.gnu.org/licenses/>.
// 
// Benjamin A. Brooks
// ben@benjaminbrooks.net
// Chicago, IL
 
#ifndef BCEEXCEPTION_HPP
#define BCEEXCEPTION_HPP
 
 
class BCEException: public std::exception
{
public:
  enum ErrorType
    {
      OutOfBounds, 
      ConditionFailed, 
      BCECounterConditionFailed, 
      BCEAbstractGameConditionFailed, 
      NoEquilibria, 
      MapFrontierNotOptimal, 
      FailedOpen, 
      NotProbDistr, 
      BadArgument, 
      BadArgumentBCEComparator, 
      BadArgumentBCEUtilities, 
      BadArgumentBCEAbstractGame, 
      InvalidParameterName, 
      InvalidParameterValue, 
      ICConstraintViolated, 
      WrongDistnSize, 
      WrongWeightSize, 
      AlreadyPopulated 
    };
 
  ErrorType errorType;
 
 
  BCEException(ErrorType errorTypeArg): errorType(errorTypeArg)
  { }
 
  const char* what() const throw()
  {
    return "BCEException was thrown";
  }
 
 
  string getMessage()
  {
    switch (errorType)
      {
      case OutOfBounds: 
    return "An index was out of the provided bounds.";
      case ConditionFailed: 
    return "A condition we imposed failed.";
      case BCECounterConditionFailed:
    return "A condition we imposed in bcecounter.cpp failed.";
      case BCEAbstractGameConditionFailed:
    return "A condition we imposed in bceabstractgame.cpp failed.";
      case NoEquilibria: 
    return "There are no equilibria.";
      case MapFrontierNotOptimal: 
    return "Map frontier is not optimal.";
      case FailedOpen: 
    return "The file failed to open.";
      case NotProbDistr: 
    return "Probabilities are misbehaving. At least one is negative or greater than 1, or they do not sum to 1.";
      case BadArgument: 
    return "A bad argument was received.";
      case BadArgumentBCEComparator:
    return "A bad argument was received in bcecomparator.cpp.";
      case BadArgumentBCEUtilities:
    return "A bad argument was received in bceutilities.cpp.";
      case BadArgumentBCEAbstractGame:
    return "A bad argument was received in bceabstractgame.cpp.";
      case InvalidParameterName: 
    return "Parameter name wasn't recognized.";
      case InvalidParameterValue: 
    return "A parameter value is invalid.";
      case ICConstraintViolated:
    return "An incentive constraint was violated.";
      case WrongDistnSize:
    return "Distribution given in solution data does not reflect the correct number of actions.";
      case WrongWeightSize: 
    return "Size of the weight vector supplied as an argument to BCESolver::solve(weights) does not match the number of objectives. Check your specification in the example file.";
      case AlreadyPopulated:
    return "Solver is already populated.";      
      } // switch
  }
};
 
#endif