/******************************************************************************
* NOMAD -  Nonlinear Optimization for Mixed vAriables and Derivatives.        *
* Copyright (C) 2001-2004  Gilles Couture - Ecole Polytechnique,              *
*                          Charles Audet - Ecole Polytechnique,               *
*		           John Dennis - Rice University.                     *
*                                                                             *
* Author: Gilles Couture                                                      *
* École Polytechnique de Montréal - GERAD                                     *
* C.P. 6079, Succ. Centre-ville, Montréal (Québec) H3C 3A7 Canada             *
* Tel:  (514) 340-6053 x6928                                                  *
* Email: Gilles.Couture@gerad.ca                                              *
* Fax: (514) 340-5665                                                         *
*                                                                             *
* This program is 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. You can find the              *
* GNU General Public License at:                                              *
*             http://www.gnu.org/copyleft/gpl.html                            *
*                                                                             *
* This program 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, write to the Free Software                 *
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. *
*                                                                             *
* You can find information on the NOMAD software at:                          *
*             http://www.gerad.ca/NOMAD/                                      *
******************************************************************************/

// generalconstraints.h -- class definition for GeneralConstraints.

#ifndef _GENERALCONSTRAINTS_H_
#define _GENERALCONSTRAINTS_H_
#include <vector>
using namespace std;

class AugmentedPoint;
class Description;
class Parameters;

class GeneralConstraints
{
  // GeneralConstraints has the following variables:
  // -
 private:
  char * input_file, * output_file;
  double hmax;
  int display_factor;
  std::vector<const char *> gen_constraints_boxes;
  std::vector<const char *>::iterator current;
  const Description * const description;
  const Parameters * const parameters;

  // The class methods are described in "generalconstraints.cpp".
  char * createBoxString(char * file, const char * box) const;
  double calculateHx(const double * coord, bool startingPoint, int pos) const;
  void blackBoxRoutine(AugmentedPoint & ap, int pos);
  void captureBlackBoxes();
  void initialize();
  void userRoutine(AugmentedPoint & ap, int) const;

 public:
  GeneralConstraints(const Description * const des,
		     const Parameters * const par, const char * input,
		     const char * output);
  ~GeneralConstraints();
  void evaluate(AugmentedPoint & ap, bool startingPoint = false);
  void showInput(ofstream & fout) const;

  // Inline methods.
  // ---------------

  // This method returns hmax.
  double getHmax() const {return hmax;}
  // The display factor is reset.
  void setDisplay(const int display) {display_factor = display;}
};
#endif
