tracer.cpp
Go to the documentation of this file.
/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
* Main authors:
* Christian Schulte <schulte@gecode.org>
*
* Copyright:
* Christian Schulte, 2017
*
* This file is part of Gecode, the generic constraint
* development environment:
* http://www.gecode.org
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
#include <gecode/search.hh>
namespace Gecode {
const char*
StdSearchTracer::t2s[SearchTracer::EngineType::AOE + 1] = {
"DFS", "BAB", "LDS",
"RBS", "PBS",
"AOE"
};
StdSearchTracer::StdSearchTracer(std::ostream& os0)
: os(os0) {}
void
StdSearchTracer::init(void) {
os << "trace<Search>::init()" << std::endl;
for (unsigned int e=0U; e<engines(); e++) {
os << "\t" << e << ": "
<< t2s[engine(e).type()];
if (engine(e).meta()) {
os << ", engines: {";
for (unsigned int i=engine(e).efst(); i<engine(e).elst(); i++) {
os << i; if (i+1 < engine(e).elst()) os << ",";
}
} else {
os << ", workers: {";
for (unsigned int i=engine(e).wfst(); i<engine(e).wlst(); i++) {
os << i; if (i+1 < engine(e).wlst()) os << ",";
}
}
os << "}" << std::endl;
}
}
void
StdSearchTracer::round(unsigned int eid) {
os << "trace<Search>::round(e:" << eid << ")" << std::endl;
}
void
StdSearchTracer::skip(const EdgeInfo& ei) {
os << "trace<Search>Search::skip(w:" << ei.wid()
<< ",n:" << ei.nid()
<< ",a:" << ei.alternative() << ")" << std::endl;
}
void
StdSearchTracer::node(const EdgeInfo& ei, const NodeInfo& ni) {
os << "trace<Search>::node(";
switch (ni.type()) {
case NodeType::FAILED:
os << "FAILED";
break;
case NodeType::SOLVED:
os << "SOLVED";
break;
case NodeType::BRANCH:
os << "BRANCH(" << ni.choice().alternatives() << ")";
break;
}
if (!ei)
os << ",root";
os << ",w:" << ni.wid() << ',';
if (ei)
os << "p:" << ei.nid() << ',';
os << "n:" << ni.nid() << ')';
if (ei) {
if (ei.wid() != ni.wid())
os << " [stolen from w:" << ei.wid() << "]";
os << std::endl
<< '\t' << ei.string()
<< std::endl;
} else {
os << std::endl;
}
}
void
StdSearchTracer::done(void) {
os << "trace<Search>::done()" << std::endl;
}
StdSearchTracer::~StdSearchTracer(void) {}
StdSearchTracer StdSearchTracer::def;
}
// STATISTICS: search-trace
Gecode::Choice::alternatives
unsigned int alternatives(void) const
Return number of alternatives.
Definition core.hpp:3770
Gecode::SearchTracer::EdgeInfo
Edge information.
Definition search.hh:242
Gecode::SearchTracer::EdgeInfo::alternative
unsigned int alternative(void) const
Return number of alternative.
Definition tracer.hpp:148
Gecode::SearchTracer::EdgeInfo::wid
unsigned int wid(void) const
Return parent worker id.
Definition tracer.hpp:136
Gecode::SearchTracer::EdgeInfo::string
std::string string(void) const
Return string for alternative.
Definition tracer.hpp:154
Gecode::SearchTracer::EdgeInfo::nid
unsigned int nid(void) const
Return parent node id.
Definition tracer.hpp:142
Gecode::SearchTracer::NodeInfo
Node information.
Definition search.hh:282
Gecode::SearchTracer::NodeInfo::type
NodeType type(void) const
Return node type.
Definition tracer.hpp:171
Gecode::SearchTracer::NodeInfo::choice
const Choice & choice(void) const
Return corresponding choice.
Definition tracer.hpp:191
Gecode::SearchTracer::NodeInfo::nid
unsigned int nid(void) const
Return node id.
Definition tracer.hpp:181
Gecode::SearchTracer::NodeInfo::wid
unsigned int wid(void) const
Return worker id.
Definition tracer.hpp:176
Gecode::SearchTracer::eid
unsigned int eid(unsigned int wid) const
Return the engine id of a worker with id wid.
Definition tracer.hpp:278
Gecode::SearchTracer::FAILED
@ FAILED
A solution node.
Definition search.hh:278
Gecode::SearchTracer::BRANCH
@ BRANCH
A failed node.
Definition search.hh:279
Gecode::SearchTracer::SOLVED
@ SOLVED
Definition search.hh:277
Gecode::SearchTracer::AOE
@ AOE
Unspecified engine (any other engine).
Definition search.hh:199
Gecode::SearchTracer::engines
unsigned int engines(void) const
Return number of engines.
Definition tracer.hpp:266
Gecode::StdSearchTracer
Definition search.hh:371
Gecode::StdSearchTracer::t2s
static const char * t2s[EngineType::AOE+1]
Map engine type to string.
Definition search.hh:376
Gecode::StdSearchTracer::StdSearchTracer
StdSearchTracer(std::ostream &os=std::cerr)
Initialize with output stream os.
Definition tracer.cpp:45
Gecode::StdSearchTracer::done
virtual void done(void)
All workers are done.
Definition tracer.cpp:113
Gecode::StdSearchTracer::init
virtual void init(void)
The search engine initializes.
Definition tracer.cpp:49
Gecode::StdSearchTracer::~StdSearchTracer
virtual ~StdSearchTracer(void)
Delete.
Definition tracer.cpp:117
Gecode::StdSearchTracer::node
virtual void node(const EdgeInfo &ei, const NodeInfo &ni)
The engine creates a new node with information ei and ni.
Definition tracer.cpp:82
Gecode::StdSearchTracer::def
static StdSearchTracer def
Default tracer (printing to std::cerr).
Definition search.hh:393
Gecode::StdSearchTracer::round
virtual void round(unsigned int eid)
The engine with id eid goes to a next round (restart or next iteration in LDS).
Definition tracer.cpp:70
Gecode::StdSearchTracer::os
std::ostream & os
Output stream to use.
Definition search.hh:374
Gecode::StdSearchTracer::skip
virtual void skip(const EdgeInfo &ei)
The engine skips an edge.
Definition tracer.cpp:75
Gecode
Gecode toplevel namespace
search.hh