spot/buddy/src/cppext.cxx
Alexandre Duret-Lutz cf5dd46350 Initial revision
2003-05-05 10:57:53 +00:00

624 lines
14 KiB
C++

/*========================================================================
Copyright (C) 1996-2002 by Jorn Lind-Nielsen
All rights reserved
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, reproduce, prepare derivative
works, distribute, and display this software and its documentation
for any purpose, provided that (1) the above copyright notice and
the following two paragraphs appear in all copies of the source code
and (2) redistributions, including without limitation binaries,
reproduce these notices in the supporting documentation. Substantial
modifications to this software may be copyrighted by their authors
and need not follow the licensing terms described here, provided
that the new terms are clearly indicated in all files where they apply.
IN NO EVENT SHALL JORN LIND-NIELSEN, OR DISTRIBUTORS OF THIS
SOFTWARE BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL,
INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF THIS
SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE AUTHORS OR ANY OF THE
ABOVE PARTIES HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
JORN LIND-NIELSEN SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO
OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
MODIFICATIONS.
========================================================================*/
/*************************************************************************
$Header: /Volumes/CVS/repository/spot/spot/buddy/src/cppext.cxx,v 1.1 2003/05/05 10:57:56 aduret Exp $
FILE: cppext.cxx
DESCR: C++ extension of BDD package
AUTH: Jorn Lind
DATE: (C) august 1997
*************************************************************************/
#include <string.h>
#include <stdlib.h>
#include <iomanip>
#include "kernel.h"
#include "bvec.h"
using namespace std;
/* Formatting objects for iostreams */
#define IOFORMAT_SET 0
#define IOFORMAT_TABLE 1
#define IOFORMAT_DOT 2
#define IOFORMAT_ALL 3
#define IOFORMAT_FDDSET 4
int bdd_ioformat::curformat = IOFORMAT_SET;
bdd_ioformat bddset(IOFORMAT_SET);
bdd_ioformat bddtable(IOFORMAT_TABLE);
bdd_ioformat bdddot(IOFORMAT_DOT);
bdd_ioformat bddall(IOFORMAT_ALL);
bdd_ioformat fddset(IOFORMAT_FDDSET);
/* Constant true and false extension */
const bdd bddtruepp = bdd_true();
const bdd bddfalsepp = bdd_false();
/* Internal prototypes */
static void bdd_printset_rec(ostream&, int, int*);
static void bdd_printdot_rec(ostream&, int);
static void fdd_printset_rec(ostream &, int, int *);
static bddstrmhandler strmhandler_bdd;
static bddstrmhandler strmhandler_fdd;
// Avoid calling C++ version of anodecount
#undef bdd_anodecount
/*************************************************************************
Setup (and shutdown)
*************************************************************************/
#undef bdd_init
int bdd_cpp_init(int n, int c)
{
int ok = bdd_init(n,c);
strmhandler_bdd = NULL;
strmhandler_fdd = NULL;
return ok;
}
/*************************************************************************
BDD C++ functions
*************************************************************************/
bdd bdd_buildcube(int val, int width, const bdd *variables)
{
BDD *var = NEW(BDD,width);
BDD res;
int n;
// No need for ref.cou. since variables[n] holds the reference
for (n=0 ; n<width ; n++)
var[n] = variables[n].root;
res = bdd_buildcube(val, width, var);
free(var);
return res;
}
int bdd_setbddpairs(bddPair *pair, int *oldvar, const bdd *newvar, int size)
{
if (pair == NULL)
return 0;
for (int n=0,e=0 ; n<size ; n++)
if ((e=bdd_setbddpair(pair, oldvar[n], newvar[n].root)) < 0)
return e;
return 0;
}
int bdd_anodecountpp(const bdd *r, int num)
{
BDD *cpr = NEW(BDD,num);
int cou;
int n;
// No need for ref.cou. since r[n] holds the reference
for (n=0 ; n<num ; n++)
cpr[n] = r[n].root;
cou = bdd_anodecount(cpr,num);
free(cpr);
return cou;
}
/*************************************************************************
BDD class functions
*************************************************************************/
bdd bdd::operator=(const bdd &r)
{
if (root != r.root)
{
bdd_delref(root);
root = r.root;
bdd_addref(root);
}
return *this;
}
bdd bdd::operator=(int r)
{
if (root != r)
{
bdd_delref(root);
root = r;
bdd_addref(root);
}
return *this;
}
/*************************************************************************
C++ iostream operators
*************************************************************************/
/*
NAME {* bdd\_strm\_hook *}
SECTION {* kernel *}
SHORT {* Specifies a printing callback handler *}
PROTO {* bddstrmhandler bdd_strm_hook(bddstrmhandler handler) *}
DESCR {* A printing callback handler for use with BDDs is used to
convert the BDD variable number into something readable by the
end user. Typically the handler will print a string name
instead of the number. A handler could look like this:
\begin{verbatim}
void printhandler(ostream &o, int var)
{
extern char **names;
o << names[var];
}
\end{verbatim}
\noindent
The handler can then be passed to BuDDy like this:
{\tt bdd\_strm\_hook(printhandler)}.
No default handler is supplied. The argument {\tt handler} may be
NULL if no handler is needed. *}
RETURN {* The old handler *}
ALSO {* bdd\_printset, bdd\_file\_hook, fdd\_strm\_hook *}
*/
bddstrmhandler bdd_strm_hook(bddstrmhandler handler)
{
bddstrmhandler old = strmhandler_bdd;
strmhandler_bdd = handler;
return old;
}
ostream &operator<<(ostream &o, const bdd &r)
{
if (bdd_ioformat::curformat == IOFORMAT_SET)
{
if (r.root < 2)
{
o << (r.root == 0 ? "F" : "T");
return o;
}
int *set = new int[bddvarnum];
if (set == NULL)
{
bdd_error(BDD_MEMORY);
return o;
}
memset(set, 0, sizeof(int) * bddvarnum);
bdd_printset_rec(o, r.root, set);
delete[] set;
}
else
if (bdd_ioformat::curformat == IOFORMAT_TABLE)
{
o << "ROOT: " << r.root << "\n";
if (r.root < 2)
return o;
bdd_mark(r.root);
for (int n=0 ; n<bddnodesize ; n++)
{
if (LEVEL(n) & MARKON)
{
BddNode *node = &bddnodes[n];
LEVELp(node) &= MARKOFF;
o << "[" << setw(5) << n << "] ";
if (strmhandler_bdd)
strmhandler_bdd(o,bddlevel2var[LEVELp(node)]);
else
o << setw(3) << bddlevel2var[LEVELp(node)];
o << " :";
o << " " << setw(3) << LOWp(node);
o << " " << setw(3) << HIGHp(node);
o << "\n";
}
}
}
else
if (bdd_ioformat::curformat == IOFORMAT_DOT)
{
o << "digraph G {\n";
o << "0 [shape=box, label=\"0\", style=filled, shape=box, height=0.3, width=0.3];\n";
o << "1 [shape=box, label=\"1\", style=filled, shape=box, height=0.3, width=0.3];\n";
bdd_printdot_rec(o, r.root);
o << "}\n";
bdd_unmark(r.root);
}
else
if (bdd_ioformat::curformat == IOFORMAT_FDDSET)
{
if (ISCONST(r.root))
{
o << (r == 0 ? "F" : "T");
return o;
}
int *set = new int[bddvarnum];
if (set == NULL)
{
bdd_error(BDD_MEMORY);
return o;
}
memset(set, 0, sizeof(int) * bddvarnum);
fdd_printset_rec(o, r.root, set);
delete[] set;
}
return o;
}
/*
NAME {* operator{\tt<<} *}
SECTION {* fileio *}
SHORT {* C++ output operator for BDDs *}
PROTO {* ostream &operator<<(ostream &o, const bdd_ioformat &f)
ostream &operator<<(ostream &o, const bdd &r) *}
DESCR {* BDDs can be printed in various formats using the C++ iostreams
library. The formats are the those used in {\tt bdd\_printset},
{\tt bdd\_printtable}, {\tt fdd\_printset} and {\tt bdd\_printdot}.
The format can be specified with the following format objects:
\begin{tabular}{ll}\\
{\tt bddset } & BDD level set format \\
{\tt bddtable } & BDD level table format \\
{\tt bdddot } & Output for use with Dot \\
{\tt bddall } & The whole node table \\
{\tt fddset } & FDD level set format \\
\end{tabular}\\
\noindent
So a BDD {\tt x} can for example be printed as a table with the
command\\
\indent {\tt cout << bddtable << x << endl}.
*}
RETURN {* The specified output stream *}
ALSO {* bdd\_strm\_hook, fdd\_strm\_hook *}
*/
ostream &operator<<(ostream &o, const bdd_ioformat &f)
{
if (f.format == IOFORMAT_SET || f.format == IOFORMAT_TABLE ||
f.format == IOFORMAT_DOT || f.format == IOFORMAT_FDDSET)
bdd_ioformat::curformat = f.format;
else
if (f.format == IOFORMAT_ALL)
{
for (int n=0 ; n<bddnodesize ; n++)
{
const BddNode *node = &bddnodes[n];
if (LOWp(node) != -1)
{
o << "[" << setw(5) << n << "] ";
if (strmhandler_bdd)
strmhandler_bdd(o,bddlevel2var[LEVELp(node)]);
else
o << setw(3) << bddlevel2var[LEVELp(node)] << " :";
o << " " << setw(3) << LOWp(node);
o << " " << setw(3) << HIGHp(node);
o << "\n";
}
}
}
return o;
}
static void bdd_printset_rec(ostream& o, int r, int* set)
{
int n;
int first;
if (r == 0)
return;
else
if (r == 1)
{
o << "<";
first = 1;
for (n=0 ; n<bddvarnum ; n++)
{
if (set[n] > 0)
{
if (!first)
o << ", ";
first = 0;
if (strmhandler_bdd)
strmhandler_bdd(o,bddlevel2var[n]);
else
o << bddlevel2var[n];
o << ":" << (set[n]==2 ? 1 : 0);
}
}
o << ">";
}
else
{
set[LEVEL(r)] = 1;
bdd_printset_rec(o, LOW(r), set);
set[LEVEL(r)] = 2;
bdd_printset_rec(o, HIGH(r), set);
set[LEVEL(r)] = 0;
}
}
static void bdd_printdot_rec(ostream& o, int r)
{
if (ISCONST(r) || MARKED(r))
return;
o << r << "[label=\"";
if (strmhandler_bdd)
strmhandler_bdd(o,bddlevel2var[LEVEL(r)]);
else
o << bddlevel2var[LEVEL(r)];
o << "\"];\n";
o << r << " -> " << LOW(r) << "[style=dotted];\n";
o << r << " -> " << HIGH(r) << "[style=filled];\n";
SETMARK(r);
bdd_printdot_rec(o, LOW(r));
bdd_printdot_rec(o, HIGH(r));
}
static void fdd_printset_rec(ostream &o, int r, int *set)
{
int n,m,i;
int used = 0;
int *binval;
int ok, first;
if (r == 0)
return;
else
if (r == 1)
{
o << "<";
first=1;
int fdvarnum = fdd_domainnum();
for (n=0 ; n<fdvarnum ; n++)
{
int firstval=1;
used = 0;
int binsize = fdd_varnum(n);
int *vars = fdd_vars(n);
for (m=0 ; m<binsize ; m++)
if (set[vars[m]] != 0)
used = 1;
if (used)
{
if (!first)
o << ", ";
first = 0;
if (strmhandler_fdd)
strmhandler_fdd(o, n);
else
o << n;
o << ":";
for (m=0 ; m<(1<<binsize) ; m++)
{
binval = fdddec2bin(n, m);
ok=1;
for (i=0 ; i<binsize && ok ; i++)
if (set[vars[i]] == 1 && binval[i] != 0)
ok = 0;
else
if (set[vars[i]] == 2 && binval[i] != 1)
ok = 0;
if (ok)
{
if (firstval)
o << m;
else
o << "/" << m;
firstval = 0;
}
free(binval);
}
}
}
o << ">";
}
else
{
set[bddlevel2var[LEVEL(r)]] = 1;
fdd_printset_rec(o, LOW(r), set);
set[bddlevel2var[LEVEL(r)]] = 2;
fdd_printset_rec(o, HIGH(r), set);
set[bddlevel2var[LEVEL(r)]] = 0;
}
}
/*=[ FDD I/O functions ]================================================*/
/*
NAME {* fdd\_strm\_hook *}
SECTION {* fdd *}
SHORT {* Specifies a printing callback handler *}
PROTO {* bddstrmhandler fdd_strm_hook(bddstrmhandler handler) *}
DESCR {* A printing callback handler for use with FDDs is used to
convert the FDD integer identifier into something readable by the
end user. Typically the handler will print a string name
instead of the identifier. A handler could look like this:
\begin{verbatim}
void printhandler(ostream &o, int var)
{
extern char **names;
o << names[var];
}
\end{verbatim}
\noindent
The handler can then be passed to BuDDy like this:
{\tt fdd\_strm\_hook(printhandler)}.
No default handler is supplied. The argument {\tt handler} may be
NULL if no handler is needed. *}
RETURN {* The old handler *}
ALSO {* fdd\_printset, bdd\_file\_hook *}
*/
bddstrmhandler fdd_strm_hook(bddstrmhandler handler)
{
bddstrmhandler old = strmhandler_fdd;
strmhandler_fdd = handler;
return old;
}
/*************************************************************************
bvec functions
*************************************************************************/
bvec bvec::operator=(const bvec &src)
{
if (&src != this)
{
bvec_free(roots);
roots = bvec_copy(src.roots);
}
return *this;
}
void bvec::set(int bitnum, const bdd &b)
{
bdd_delref(roots.bitvec[bitnum]);
roots.bitvec[bitnum] = b.root;
bdd_addref(roots.bitvec[bitnum]);
}
/*======================================================================*/
bvec bvec_map1(const bvec &a,
bdd (*fun)(const bdd &))
{
bvec res;
int n;
res = bvec_false(a.bitnum());
for (n=0 ; n < a.bitnum() ; n++)
res.set(n, fun(a[n]));
return res;
}
bvec bvec_map2(const bvec &a, const bvec &b,
bdd (*fun)(const bdd &, const bdd &))
{
bvec res;
int n;
if (a.bitnum() != b.bitnum())
{
bdd_error(BVEC_SIZE);
return res;
}
res = bvec_false(a.bitnum());
for (n=0 ; n < a.bitnum() ; n++)
res.set(n, fun(a[n], b[n]));
return res;
}
bvec bvec_map3(const bvec &a, const bvec &b, const bvec &c,
bdd (*fun)(const bdd &, const bdd &, const bdd &))
{
bvec res;
int n;
if (a.bitnum() != b.bitnum() || b.bitnum() != c.bitnum())
{
bdd_error(BVEC_SIZE);
return res;
}
res = bvec_false(a.bitnum());
for (n=0 ; n < a.bitnum() ; n++)
res.set(n, fun(a[n], b[n], c[n]) );
return res;
}
ostream &operator<<(ostream &o, const bvec &v)
{
for (int i=0 ; i<v.bitnum() ; ++i)
{
o << "B" << i << ":\n"
<< v[i] << "\n";
}
return o;
}
/* EOF */