Generated on Wed Nov 5 2014 05:18:40 for Gecode by doxygen 1.7.6.1
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 (void)
 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 postConstraint (const ConExpr &ce, AST::Node *annotation)
 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 (AST::Node *ann, int seed, double decay, bool ignoreUnknown, std::ostream &err=std::cerr)
 Create branchers corresponding to the solve item annotations.
AST::ArraysolveAnnotations (void) const
 Return the solve item annotations.
virtual void constrain (const Space &s)
 Implement optimization.
virtual Gecode::Spacecopy (bool share)
 Copy function.

Public Attributes

Gecode::IntVarArray iv
 The integer variables.
Gecode::IntVarArray iv_aux
 The introduced integer variables.
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.
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.
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.
IntConLevel ann2icl (AST::Node *ann)
 Convert ann to IntConLevel.

Detailed Description

A space that can be initialized with a FlatZinc model.

Definition at line 353 of file flatzinc.hh.


Member Enumeration Documentation

Enumerator:
SAT 
MIN 
MAX 

Definition at line 355 of file flatzinc.hh.


Constructor & Destructor Documentation

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

Copy constructor.

Definition at line 612 of file flatzinc.cpp.

Construct empty space.

Definition at line 676 of file flatzinc.cpp.

Destructor.

Definition at line 1297 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 684 of file flatzinc.cpp.

Create new integer variable from specification.

Definition at line 709 of file flatzinc.cpp.

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

Link integer variable iv to Boolean variable bv.

Definition at line 727 of file flatzinc.cpp.

Return linked Boolean variable for integer variable iv.

Definition at line 731 of file flatzinc.cpp.

Create new Boolean variable from specification.

Definition at line 736 of file flatzinc.cpp.

Create new set variable from specification.

Definition at line 748 of file flatzinc.cpp.

Create new float variable from specification.

Definition at line 795 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::postConstraint ( const ConExpr ce,
AST::Node annotation 
)

Post a constraint specified by ce.

Definition at line 824 of file flatzinc.cpp.

Post the solve item.

Definition at line 1232 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 1238 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 1268 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 1539 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 1594 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 1606 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 1646 of file flatzinc.cpp.

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 1659 of file flatzinc.cpp.

Return whether to solve a satisfaction or optimization problem.

Definition at line 1579 of file flatzinc.cpp.

Return index of variable used for optimization.

Definition at line 1584 of file flatzinc.cpp.

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

Definition at line 1589 of file flatzinc.cpp.

void Gecode::FlatZinc::FlatZincSpace::createBranchers ( 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 849 of file flatzinc.cpp.

Return the solve item annotations.

Definition at line 1227 of file flatzinc.cpp.

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

Implement optimization.

Reimplemented from Gecode::Space.

Definition at line 1553 of file flatzinc.cpp.

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

Copy function.

Implements Gecode::Space.

Definition at line 1574 of file flatzinc.cpp.

Convert arg (array of integers) to IntArgs.

Definition at line 1671 of file flatzinc.cpp.

Convert arg (array of Booleans) to IntArgs.

Definition at line 1681 of file flatzinc.cpp.

Convert n to IntSet.

Definition at line 1691 of file flatzinc.cpp.

Convert arg to IntSetArgs.

Definition at line 1706 of file flatzinc.cpp.

Convert arg to IntVarArgs.

Definition at line 1721 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 1742 of file flatzinc.cpp.

Convert n to BoolVar.

Definition at line 1768 of file flatzinc.cpp.

Convert n to IntVar.

Definition at line 1779 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 1789 of file flatzinc.cpp.

Convert n to SetVar.

Definition at line 1811 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 1822 of file flatzinc.cpp.

Convert n to FloatValArgs.

Definition at line 1838 of file flatzinc.cpp.

Convert n to FloatVar.

Definition at line 1869 of file flatzinc.cpp.

Convert n to FloatVarArgs.

Definition at line 1848 of file flatzinc.cpp.

Convert ann to IntConLevel.

Definition at line 1880 of file flatzinc.cpp.


Member Data Documentation

Number of integer variables.

Definition at line 362 of file flatzinc.hh.

Number of Boolean variables.

Definition at line 364 of file flatzinc.hh.

Number of float variables.

Definition at line 366 of file flatzinc.hh.

Number of set variables.

Definition at line 368 of file flatzinc.hh.

Index of the variable to optimize.

Definition at line 371 of file flatzinc.hh.

Whether variable to optimize is integer (or float)

Definition at line 373 of file flatzinc.hh.

Whether to solve as satisfaction or optimization problem.

Definition at line 376 of file flatzinc.hh.

Annotations on the solve item.

Definition at line 379 of file flatzinc.hh.

The integer variables.

Definition at line 399 of file flatzinc.hh.

The introduced integer variables.

Definition at line 401 of file flatzinc.hh.

Indicates whether an integer variable is introduced by mzn2fzn.

Definition at line 403 of file flatzinc.hh.

Indicates whether an integer variable aliases a Boolean variable.

Definition at line 405 of file flatzinc.hh.

The Boolean variables.

Definition at line 407 of file flatzinc.hh.

The introduced Boolean variables.

Definition at line 409 of file flatzinc.hh.

Indicates whether a Boolean variable is introduced by mzn2fzn.

Definition at line 411 of file flatzinc.hh.

The set variables.

Definition at line 414 of file flatzinc.hh.

The introduced set variables.

Definition at line 416 of file flatzinc.hh.

Indicates whether a set variable is introduced by mzn2fzn.

Definition at line 418 of file flatzinc.hh.

The float variables.

Definition at line 422 of file flatzinc.hh.

The introduced float variables.

Definition at line 424 of file flatzinc.hh.

Indicates whether a float variable is introduced by mzn2fzn.

Definition at line 426 of file flatzinc.hh.

Whether the introduced variables still need to be copied.

Definition at line 429 of file flatzinc.hh.

Information for printing branches.

Definition at line 513 of file flatzinc.hh.


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