Generated on Tue Apr 18 10:23:26 2017 for Gecode by doxygen 1.6.3
Gecode::FlatZinc::FlatZincSpace

Gecode::FlatZinc::FlatZincSpace Class Reference

A space that can be initialized with a FlatZinc model. More...

#include <flatzinc.hh>

List of all members.

Public Types

enum  Meth { SAT, MIN, MAX }

Public Member Functions

 FlatZincSpace (FznRnd *random=NULL)
 Construct empty space.
 ~FlatZincSpace (void)
 Destructor.
void init (int intVars, int boolVars, int setVars, int floatVars)
 Initialize space with given number of variables.
void newIntVar (IntVarSpec *vs)
 Create new integer variable from specification.
void aliasBool2Int (int iv, int bv)
 Link integer variable iv to Boolean variable bv.
int aliasBool2Int (int iv)
 Return linked Boolean variable for integer variable iv.
void newBoolVar (BoolVarSpec *vs)
 Create new Boolean variable from specification.
void newSetVar (SetVarSpec *vs)
 Create new set variable from specification.
void newFloatVar (FloatVarSpec *vs)
 Create new float variable from specification.
void postConstraints (std::vector< ConExpr * > &ces)
 Post a constraint specified by ce.
void solve (AST::Array *annotation)
 Post the solve item.
void minimize (int var, bool isInt, AST::Array *annotation)
 Post that integer variable var should be minimized.
void maximize (int var, bool isInt, AST::Array *annotation)
 Post that integer variable var should be maximized.
void run (std::ostream &out, const Printer &p, const FlatZincOptions &opt, Gecode::Support::Timer &t_total)
 Run the search.
void print (std::ostream &out, const Printer &p) const
 Produce output on out using p.
void compare (const Space &s, std::ostream &out) const
 Compare this space with space s and print the differences on out.
void compare (const FlatZincSpace &s, std::ostream &out, const Printer &p) const
 Compare this space with space s and print the differences on out using p.
void shrinkArrays (Printer &p)
 Remove all variables not needed for output.
Meth method (void) const
 Return whether to solve a satisfaction or optimization problem.
int optVar (void) const
 Return index of variable used for optimization.
bool optVarIsInt (void) const
 Return whether variable used for optimization is integer (or float).
void createBranchers (Printer &p, AST::Node *ann, int seed, double decay, bool ignoreUnknown, std::ostream &err=std::cerr)
 Create branchers corresponding to the solve item annotations.
AST::Array * solveAnnotations (void) const
 Return the solve item annotations.
virtual void constrain (const Space &s)
 Implement optimization.
virtual Gecode::Space * copy (bool share)
 Copy function.
virtual bool slave (const MetaInfo &mi)
 Slave function for restarts.

Public Attributes

Gecode::IntVarArray iv
 The integer variables.
Gecode::IntVarArray iv_aux
 The introduced integer variables.
Gecode::IntVarArray iv_lns
 The integer variables used in LNS.
std::vector< bool > iv_introduced
 Indicates whether an integer variable is introduced by mzn2fzn.
int * iv_boolalias
 Indicates whether an integer variable aliases a Boolean variable.
Gecode::BoolVarArray bv
 The Boolean variables.
Gecode::BoolVarArray bv_aux
 The introduced Boolean variables.
std::vector< bool > bv_introduced
 Indicates whether a Boolean variable is introduced by mzn2fzn.
Gecode::SetVarArray sv
 The set variables.
Gecode::SetVarArray sv_aux
 The introduced set variables.
std::vector< bool > sv_introduced
 Indicates whether a set variable is introduced by mzn2fzn.
Gecode::FloatVarArray fv
 The float variables.
Gecode::FloatVarArray fv_aux
 The introduced float variables.
std::vector< bool > fv_introduced
 Indicates whether a float variable is introduced by mzn2fzn.
Gecode::FloatNum step
 Step by which a next solution has to have lower cost.
bool needAuxVars
 Whether the introduced variables still need to be copied.
BranchInformation branchInfo
 Information for printing branches.

Protected Member Functions

 FlatZincSpace (bool share, FlatZincSpace &)
 Copy constructor.

Protected Attributes

int intVarCount
 Number of integer variables.
int boolVarCount
 Number of Boolean variables.
int floatVarCount
 Number of float variables.
int setVarCount
 Number of set variables.
int _optVar
 Index of the variable to optimize.
bool _optVarIsInt
 Whether variable to optimize is integer (or float).
Meth _method
 Whether to solve as satisfaction or optimization problem.
unsigned int _lns
 Percentage of variables to keep in LNS (or 0 for no LNS).
IntSharedArray _lnsInitialSolution
 Initial solution to start the LNS (or NULL for no LNS).
FznRnd * _random
 Random number generator.
AST::Array * _solveAnnotations
 Annotations on the solve item.

AST to variable and value conversion



IntArgs arg2intargs (AST::Node *arg, int offset=0)
 Convert arg (array of integers) to IntArgs.
IntArgs arg2boolargs (AST::Node *arg, int offset=0)
 Convert arg (array of Booleans) to IntArgs.
IntSet arg2intset (AST::Node *n)
 Convert n to IntSet.
IntSetArgs arg2intsetargs (AST::Node *arg, int offset=0)
 Convert arg to IntSetArgs.
IntVarArgs arg2intvarargs (AST::Node *arg, int offset=0)
 Convert arg to IntVarArgs.
BoolVarArgs arg2boolvarargs (AST::Node *arg, int offset=0, int siv=-1)
 Convert arg to BoolVarArgs.
BoolVar arg2BoolVar (AST::Node *n)
 Convert n to BoolVar.
IntVar arg2IntVar (AST::Node *n)
 Convert n to IntVar.
bool isBoolArray (AST::Node *b, int &singleInt)
 Check if b is array of Booleans (or has a single integer).
SetVar arg2SetVar (AST::Node *n)
 Convert n to SetVar.
SetVarArgs arg2setvarargs (AST::Node *arg, int offset=0, int doffset=0, const IntSet &od=IntSet::empty)
 Convert n to SetVarArgs.
FloatValArgs arg2floatargs (AST::Node *arg, int offset=0)
 Convert n to FloatValArgs.
FloatVar arg2FloatVar (AST::Node *n)
 Convert n to FloatVar.
FloatVarArgs arg2floatvarargs (AST::Node *arg, int offset=0)
 Convert n to FloatVarArgs.
IntPropLevel ann2ipl (AST::Node *ann)
 Convert ann to integer propagation level.

Detailed Description

A space that can be initialized with a FlatZinc model.

Definition at line 401 of file flatzinc.hh.

Member Enumeration Documentation

enum Gecode::FlatZinc::FlatZincSpace::Meth
Enumerator:
SAT 
MIN 
MAX 

Definition at line 403 of file flatzinc.hh.

Constructor & Destructor Documentation

Gecode::FlatZinc::FlatZincSpace::FlatZincSpace ( bool  share,
FlatZincSpace &  f 
) [protected]

Copy constructor.

Definition at line 726 of file flatzinc.cpp.

Gecode::FlatZinc::FlatZincSpace::FlatZincSpace ( FznRnd *  random = NULL  ) 

Construct empty space.

Definition at line 797 of file flatzinc.cpp.

Gecode::FlatZinc::FlatZincSpace::~FlatZincSpace ( void   ) 

Destructor.

Definition at line 1549 of file flatzinc.cpp.

Member Function Documentation

void Gecode::FlatZinc::FlatZincSpace::init ( int  intVars,
int  boolVars,
int  setVars,
int  floatVars 
)

Initialize space with given number of variables.

Definition at line 806 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::newIntVar ( IntVarSpec *  vs  ) 

Create new integer variable from specification.

Definition at line 831 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::aliasBool2Int ( int  iv,
int  bv 
)

Link integer variable iv to Boolean variable bv.

Definition at line 849 of file flatzinc.cpp.

int Gecode::FlatZinc::FlatZincSpace::aliasBool2Int ( int  iv  ) 

Return linked Boolean variable for integer variable iv.

Definition at line 853 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::newBoolVar ( BoolVarSpec *  vs  ) 

Create new Boolean variable from specification.

Definition at line 858 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::newSetVar ( SetVarSpec *  vs  ) 

Create new set variable from specification.

Definition at line 870 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::newFloatVar ( FloatVarSpec *  vs  ) 

Create new float variable from specification.

Definition at line 917 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::postConstraints ( std::vector< ConExpr * > &  ces  ) 

Post a constraint specified by ce.

Definition at line 954 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::solve ( AST::Array *  annotation  ) 

Post the solve item.

Definition at line 1528 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::minimize ( int  var,
bool  isInt,
AST::Array *  annotation 
)

Post that integer variable var should be minimized.

Definition at line 1534 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::maximize ( int  var,
bool  isInt,
AST::Array *  annotation 
)

Post that integer variable var should be maximized.

Definition at line 1542 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::run ( std::ostream &  out,
const Printer &  p,
const FlatZincOptions &  opt,
Gecode::Support::Timer &  t_total 
)

Run the search.

Definition at line 1797 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::print ( std::ostream &  out,
const Printer &  p 
) const

Produce output on out using p.

Definition at line 1876 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::compare ( const Space &  s,
std::ostream &  out 
) const

Compare this space with space s and print the differences on out.

Definition at line 1888 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::compare ( const FlatZincSpace &  s,
std::ostream &  out,
const Printer &  p 
) const

Compare this space with space s and print the differences on out using p.

Definition at line 1928 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::shrinkArrays ( Printer &  p  ) 

Remove all variables not needed for output.

After calling this function, no new constraints can be posted through FlatZinc variable references, and the createBranchers method must not be called again.

Definition at line 1941 of file flatzinc.cpp.

FlatZincSpace::Meth Gecode::FlatZinc::FlatZincSpace::method ( void   )  const

Return whether to solve a satisfaction or optimization problem.

Definition at line 1861 of file flatzinc.cpp.

int Gecode::FlatZinc::FlatZincSpace::optVar ( void   )  const

Return index of variable used for optimization.

Definition at line 1866 of file flatzinc.cpp.

bool Gecode::FlatZinc::FlatZincSpace::optVarIsInt ( void   )  const

Return whether variable used for optimization is integer (or float).

Definition at line 1871 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::createBranchers ( Printer &  p,
AST::Node *  ann,
int  seed,
double  decay,
bool  ignoreUnknown,
std::ostream &  err = std::cerr 
)

Create branchers corresponding to the solve item annotations.

If ignoreUnknown is true, unknown solve item annotations will be ignored, otherwise a warning is written to err.

The seed for random branchers is given by the seed parameter.

Definition at line 987 of file flatzinc.cpp.

AST::Array * Gecode::FlatZinc::FlatZincSpace::solveAnnotations ( void   )  const

Return the solve item annotations.

Definition at line 1523 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::constrain ( const Space &  s  )  [virtual]

Implement optimization.

Reimplemented from Gecode::Space.

Definition at line 1811 of file flatzinc.cpp.

Space * Gecode::FlatZinc::FlatZincSpace::copy ( bool  share  )  [virtual]

Copy function.

Implements Gecode::Space.

Definition at line 1856 of file flatzinc.cpp.

bool Gecode::FlatZinc::FlatZincSpace::slave ( const MetaInfo &  mi  )  [virtual]

Slave function for restarts.

Reimplemented from Gecode::Space.

Definition at line 1832 of file flatzinc.cpp.

IntArgs Gecode::FlatZinc::FlatZincSpace::arg2intargs ( AST::Node *  arg,
int  offset = 0 
)

Convert arg (array of integers) to IntArgs.

Definition at line 1953 of file flatzinc.cpp.

IntArgs Gecode::FlatZinc::FlatZincSpace::arg2boolargs ( AST::Node *  arg,
int  offset = 0 
)

Convert arg (array of Booleans) to IntArgs.

Definition at line 1963 of file flatzinc.cpp.

IntSet Gecode::FlatZinc::FlatZincSpace::arg2intset ( AST::Node *  n  ) 

Convert n to IntSet.

Definition at line 1973 of file flatzinc.cpp.

IntSetArgs Gecode::FlatZinc::FlatZincSpace::arg2intsetargs ( AST::Node *  arg,
int  offset = 0 
)

Convert arg to IntSetArgs.

Definition at line 1988 of file flatzinc.cpp.

IntVarArgs Gecode::FlatZinc::FlatZincSpace::arg2intvarargs ( AST::Node *  arg,
int  offset = 0 
)

Convert arg to IntVarArgs.

Definition at line 2003 of file flatzinc.cpp.

BoolVarArgs Gecode::FlatZinc::FlatZincSpace::arg2boolvarargs ( AST::Node *  arg,
int  offset = 0,
int  siv = -1 
)

Convert arg to BoolVarArgs.

Definition at line 2024 of file flatzinc.cpp.

BoolVar Gecode::FlatZinc::FlatZincSpace::arg2BoolVar ( AST::Node *  n  ) 

Convert n to BoolVar.

Definition at line 2050 of file flatzinc.cpp.

IntVar Gecode::FlatZinc::FlatZincSpace::arg2IntVar ( AST::Node *  n  ) 

Convert n to IntVar.

Definition at line 2061 of file flatzinc.cpp.

bool Gecode::FlatZinc::FlatZincSpace::isBoolArray ( AST::Node *  b,
int &  singleInt 
)

Check if b is array of Booleans (or has a single integer).

Definition at line 2071 of file flatzinc.cpp.

SetVar Gecode::FlatZinc::FlatZincSpace::arg2SetVar ( AST::Node *  n  ) 

Convert n to SetVar.

Definition at line 2093 of file flatzinc.cpp.

SetVarArgs Gecode::FlatZinc::FlatZincSpace::arg2setvarargs ( AST::Node *  arg,
int  offset = 0,
int  doffset = 0,
const IntSet &  od = IntSet::empty 
)

Convert n to SetVarArgs.

Definition at line 2104 of file flatzinc.cpp.

FloatValArgs Gecode::FlatZinc::FlatZincSpace::arg2floatargs ( AST::Node *  arg,
int  offset = 0 
)

Convert n to FloatValArgs.

Definition at line 2120 of file flatzinc.cpp.

FloatVar Gecode::FlatZinc::FlatZincSpace::arg2FloatVar ( AST::Node *  n  ) 

Convert n to FloatVar.

Definition at line 2151 of file flatzinc.cpp.

FloatVarArgs Gecode::FlatZinc::FlatZincSpace::arg2floatvarargs ( AST::Node *  arg,
int  offset = 0 
)

Convert n to FloatVarArgs.

Definition at line 2130 of file flatzinc.cpp.

IntPropLevel Gecode::FlatZinc::FlatZincSpace::ann2ipl ( AST::Node *  ann  ) 

Convert ann to integer propagation level.

Definition at line 2162 of file flatzinc.cpp.

Member Data Documentation

int Gecode::FlatZinc::FlatZincSpace::intVarCount [protected]

Number of integer variables.

Definition at line 410 of file flatzinc.hh.

int Gecode::FlatZinc::FlatZincSpace::boolVarCount [protected]

Number of Boolean variables.

Definition at line 412 of file flatzinc.hh.

int Gecode::FlatZinc::FlatZincSpace::floatVarCount [protected]

Number of float variables.

Definition at line 414 of file flatzinc.hh.

int Gecode::FlatZinc::FlatZincSpace::setVarCount [protected]

Number of set variables.

Definition at line 416 of file flatzinc.hh.

int Gecode::FlatZinc::FlatZincSpace::_optVar [protected]

Index of the variable to optimize.

Definition at line 419 of file flatzinc.hh.

bool Gecode::FlatZinc::FlatZincSpace::_optVarIsInt [protected]

Whether variable to optimize is integer (or float).

Definition at line 421 of file flatzinc.hh.

Meth Gecode::FlatZinc::FlatZincSpace::_method [protected]

Whether to solve as satisfaction or optimization problem.

Definition at line 424 of file flatzinc.hh.

unsigned int Gecode::FlatZinc::FlatZincSpace::_lns [protected]

Percentage of variables to keep in LNS (or 0 for no LNS).

Definition at line 427 of file flatzinc.hh.

IntSharedArray Gecode::FlatZinc::FlatZincSpace::_lnsInitialSolution [protected]

Initial solution to start the LNS (or NULL for no LNS).

Definition at line 430 of file flatzinc.hh.

FznRnd* Gecode::FlatZinc::FlatZincSpace::_random [protected]

Random number generator.

Definition at line 433 of file flatzinc.hh.

AST::Array* Gecode::FlatZinc::FlatZincSpace::_solveAnnotations [protected]

Annotations on the solve item.

Definition at line 436 of file flatzinc.hh.

Gecode::IntVarArray Gecode::FlatZinc::FlatZincSpace::iv

The integer variables.

Definition at line 456 of file flatzinc.hh.

Gecode::IntVarArray Gecode::FlatZinc::FlatZincSpace::iv_aux

The introduced integer variables.

Definition at line 458 of file flatzinc.hh.

Gecode::IntVarArray Gecode::FlatZinc::FlatZincSpace::iv_lns

The integer variables used in LNS.

Definition at line 461 of file flatzinc.hh.

std::vector<bool> Gecode::FlatZinc::FlatZincSpace::iv_introduced

Indicates whether an integer variable is introduced by mzn2fzn.

Definition at line 464 of file flatzinc.hh.

int* Gecode::FlatZinc::FlatZincSpace::iv_boolalias

Indicates whether an integer variable aliases a Boolean variable.

Definition at line 466 of file flatzinc.hh.

Gecode::BoolVarArray Gecode::FlatZinc::FlatZincSpace::bv

The Boolean variables.

Definition at line 468 of file flatzinc.hh.

Gecode::BoolVarArray Gecode::FlatZinc::FlatZincSpace::bv_aux

The introduced Boolean variables.

Definition at line 470 of file flatzinc.hh.

std::vector<bool> Gecode::FlatZinc::FlatZincSpace::bv_introduced

Indicates whether a Boolean variable is introduced by mzn2fzn.

Definition at line 472 of file flatzinc.hh.

Gecode::SetVarArray Gecode::FlatZinc::FlatZincSpace::sv

The set variables.

Definition at line 475 of file flatzinc.hh.

Gecode::SetVarArray Gecode::FlatZinc::FlatZincSpace::sv_aux

The introduced set variables.

Definition at line 477 of file flatzinc.hh.

std::vector<bool> Gecode::FlatZinc::FlatZincSpace::sv_introduced

Indicates whether a set variable is introduced by mzn2fzn.

Definition at line 479 of file flatzinc.hh.

Gecode::FloatVarArray Gecode::FlatZinc::FlatZincSpace::fv

The float variables.

Definition at line 483 of file flatzinc.hh.

Gecode::FloatVarArray Gecode::FlatZinc::FlatZincSpace::fv_aux

The introduced float variables.

Definition at line 485 of file flatzinc.hh.

std::vector<bool> Gecode::FlatZinc::FlatZincSpace::fv_introduced

Indicates whether a float variable is introduced by mzn2fzn.

Definition at line 487 of file flatzinc.hh.

Gecode::FloatNum Gecode::FlatZinc::FlatZincSpace::step

Step by which a next solution has to have lower cost.

Definition at line 489 of file flatzinc.hh.

bool Gecode::FlatZinc::FlatZincSpace::needAuxVars

Whether the introduced variables still need to be copied.

Definition at line 492 of file flatzinc.hh.

BranchInformation Gecode::FlatZinc::FlatZincSpace::branchInfo

Information for printing branches.

Definition at line 576 of file flatzinc.hh.

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