cudd/nanotrav/ntrZddTest.c

/**
  @file

  @ingroup nanotrav

  @brief %ZDD test functions.

  @author Fabio Somenzi
   
  @copyright@parblock
  Copyright (c) 1995-2015, Regents of the University of Colorado

  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions
  are met:

  Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

  Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

  Neither the name of the University of Colorado nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  POSSIBILITY OF SUCH DAMAGE.
  @endparblock

*/

#include "ntr.h"
#include "cuddInt.h"

/*---------------------------------------------------------------------------*/
/* Constant declarations                                                     */
/*---------------------------------------------------------------------------*/

/*---------------------------------------------------------------------------*/
/* Stucture declarations                                                     */
/*---------------------------------------------------------------------------*/

/*---------------------------------------------------------------------------*/
/* Type declarations                                                         */
/*---------------------------------------------------------------------------*/

/*---------------------------------------------------------------------------*/
/* Variable declarations                                                     */
/*---------------------------------------------------------------------------*/


/*---------------------------------------------------------------------------*/
/* Macro declarations                                                        */
/*---------------------------------------------------------------------------*/

/** \cond */

/*---------------------------------------------------------------------------*/
/* Static function prototypes                                                */
/*---------------------------------------------------------------------------*/

static int reorderZdd (BnetNetwork *net, DdManager *dd, NtrOptions *option);

/** \endcond */


/*---------------------------------------------------------------------------*/
/* Definition of exported functions                                          */
/*---------------------------------------------------------------------------*/


/**
  @brief Tests ZDDs.

  @return 1 if successful; 0 otherwise.

  @sideeffect Creates %ZDD variables in the manager.

*/
int
Ntr_testZDD(
  DdManager * dd,
  BnetNetwork * net,
  NtrOptions * option)
{
    DdNode **zdd;		/* array of converted outputs */
    int nz;			/* actual number of ZDDs */
    int result;
    int i, j;
    BnetNode *node;		/* auxiliary pointer to network node */
    int pr = option->verb;
    int level;			/* aux. var. used to print variable orders */
    char **names;		/* array used to print variable orders */
    int nvars;

    /* Build an array of ZDDs for the output functions or for the
    ** specified node. */
    Cudd_AutodynDisable(dd);
    Cudd_AutodynDisableZdd(dd);
    zdd = ALLOC(DdNode *,net->noutputs);
    result = Cudd_zddVarsFromBddVars(dd,1);
    if (result == 0) return(0);
    if (option->node == NULL) {
	for (nz = 0; nz < net->noutputs; nz++) {
	    if (!st_lookup(net->hash,net->outputs[nz],(void **)&node)) {
		return(0);
	    }
	    zdd[nz] = Cudd_zddPortFromBdd(dd, node->dd);
	    if (zdd[nz]) {
		Cudd_Ref(zdd[nz]);
		(void) printf("%s", node->name);
		result = Cudd_zddPrintDebug(dd,zdd[nz],Cudd_ReadZddSize(dd),pr);
		if (result == 0) return(0);
	    } else {
		(void) printf("Conversion to ZDD failed.\n");
	    }
	}
    } else {
	if (!st_lookup(net->hash,option->node,(void **)&node)) {
	    return(0);
	}
	zdd[0] = Cudd_zddPortFromBdd(dd, node->dd);
	if (zdd[0]) {
	    Cudd_Ref(zdd[0]);
	    (void) printf("%s", node->name);
	    result = Cudd_zddPrintDebug(dd,zdd[0],Cudd_ReadZddSize(dd),pr);
	    if (result == 0) return(0);
	} else {
	    (void) printf("Conversion to ZDD failed.\n");
	}
	nz = 1;
    }

#ifdef DD_DEBUG
    result = Cudd_CheckKeys(dd);
    if (result != 0) {
	(void) fprintf(stderr,"Error reported by Cudd_CheckKeys\n");
	return(0);
    }
#endif

    if (option->autoDyn & 1) {
	Cudd_AutodynEnable(dd,CUDD_REORDER_SAME);
    }
    if (option->autoDyn & 2) {
	Cudd_AutodynEnableZdd(dd,CUDD_REORDER_SAME);
    }

    /* Convert the ZDDs back to BDDs and check identity. */
    for (i = 0; i < nz; i++) {
	DdNode *checkBdd;
	checkBdd = Cudd_zddPortToBdd(dd,zdd[i]);
	if (checkBdd) {
	    Cudd_Ref(checkBdd);
	    if (option->node == NULL) {
		if (!st_lookup(net->hash,net->outputs[i],(void **)&node)) {
		    return(0);
		}
	    } else {
		if (!st_lookup(net->hash,option->node,(void **)&node)) {
		    return(0);
		}
	    }
	    if (checkBdd != node->dd) {
		(void) fprintf(stdout,"Equivalence failed at node %s",
			       node->name);
		result = Cudd_PrintDebug(dd,checkBdd,Cudd_ReadZddSize(dd),pr);
		if (result == 0) return(0);
	    }
	    Cudd_RecursiveDeref(dd,checkBdd);
	} else {
	    (void) printf("Conversion to BDD failed.\n");
	}
    }

#ifdef DD_DEBUG
    result = Cudd_CheckKeys(dd);
    if (result != 0) {
	(void) fprintf(stderr,"Error reported by Cudd_CheckKeys\n");
	return(0);
    }
#endif

    /* Play with the ZDDs a little. */
    if (nz > 2) {
	DdNode *f;
	DdNode *g1, *g2, *g;
	f = Cudd_zddIte(dd,zdd[0],zdd[1],zdd[2]);
	if (f == NULL) return(0);
	cuddRef(f);
	g1 = Cudd_zddIntersect(dd,zdd[0],zdd[1]);
	if (g1 == NULL) {
	    Cudd_RecursiveDerefZdd(dd,f);
	    return(0);
	}
	cuddRef(g1);
	g2 = Cudd_zddDiff(dd,zdd[2],zdd[0]);
	if (g2 == NULL) {
	    Cudd_RecursiveDerefZdd(dd,f);
	    Cudd_RecursiveDerefZdd(dd,g1);
	    return(0);
	}
	cuddRef(g2);
	g = Cudd_zddUnion(dd,g1,g2);
	if (g == NULL) {
	    Cudd_RecursiveDerefZdd(dd,f);
	    Cudd_RecursiveDerefZdd(dd,g1);
	    Cudd_RecursiveDerefZdd(dd,g2);
	    return(0);
	}
	cuddRef(g);
	Cudd_RecursiveDerefZdd(dd,g1);
	Cudd_RecursiveDerefZdd(dd,g2);
	if (g != f) {
	    (void) fprintf(stderr,"f != g!\n");
	}
	Cudd_RecursiveDerefZdd(dd,g);
	Cudd_RecursiveDerefZdd(dd,f);
    }

#ifdef DD_DEBUG
    result = Cudd_CheckKeys(dd);
    if (result != 0) {
	(void) fprintf(stderr,"Error reported by Cudd_CheckKeys\n");
	return(0);
    }
#endif

    /* Perform ZDD reordering. */
    result = reorderZdd(net,dd,option);
    if (result == 0) {
	(void) fprintf(stderr,"Error during ZDD reordering\n");
        return(0);
    }

    /* Print final ZDD order. */
    nvars = Cudd_ReadZddSize(dd);
    names = ALLOC(char *, nvars);
    if (names == NULL) return(0);
    for (i = 0; i < nvars; i++) {
	names[i] = NULL;
    }
    if (option->reordering != CUDD_REORDER_NONE) {
	for (i = 0; i < net->npis; i++) {
	    if (!st_lookup(net->hash,net->inputs[i],(void **)&node)) {
		FREE(names);
		return(0);
	    }
	    level = Cudd_ReadPermZdd(dd,node->var);
	    names[level] = node->name;
	}
	for (i = 0; i < net->nlatches; i++) {
	    if (!st_lookup(net->hash,net->latches[i][1],(void **)&node)) {
		FREE(names);
		return(0);
	    }
	    level = Cudd_ReadPermZdd(dd,node->var);
	    names[level] = node->name;
	}
	(void) printf("New order\n");
	for (i = 0, j = 0; i < nvars; i++) {
	    if (names[i] == NULL) continue;
	    if((j%8 == 0)&&j) (void) printf("\n");
	    (void) printf("%s ",names[i]);
	    j++;
	}
	(void) printf("\n");
    }
    FREE(names);

    /* Dispose of ZDDs. */
    for (i = 0; i < nz; i++) {
	Cudd_RecursiveDerefZdd(dd,zdd[i]);
    }
    FREE(zdd);
    return(1);

} /* end of Ntr_testZDD */


/**
  @brief Builds %ZDD covers.

  @sideeffect Creates %ZDD variables in the manager.

*/
int
Ntr_testISOP(
  DdManager * dd,
  BnetNetwork * net,
  NtrOptions * option)
{
    DdNode **zdd;		/* array of converted outputs */
    DdNode *bdd;		/* return value of Cudd_zddIsop */
    int nz;			/* actual number of ZDDs */
    int result;
    int i;
    BnetNode *node;		/* auxiliary pointer to network node */
    int pr = option->verb;

    /* Build an array of ZDDs for the output functions or the specified
    ** node. */
    Cudd_zddRealignEnable(dd);
    Cudd_AutodynDisableZdd(dd);
    zdd = ALLOC(DdNode *,net->noutputs);
    result = Cudd_zddVarsFromBddVars(dd,2);
    if (result == 0) return(0);
    if (option->node == NULL) {
	nz = net->noutputs;
	for (i = 0; i < nz; i++) {
	    if (!st_lookup(net->hash,net->outputs[i],(void **)&node)) {
		return(0);
	    }
	    bdd = Cudd_zddIsop(dd, node->dd, node->dd, &zdd[i]);
	    if (bdd != node->dd) return(0);
	    Cudd_Ref(bdd);
	    Cudd_RecursiveDeref(dd,bdd);
	    if (zdd[i]) {
		Cudd_Ref(zdd[i]);
		(void) printf("%s", node->name);
		result = Cudd_zddPrintDebug(dd,zdd[i],Cudd_ReadZddSize(dd),pr);
		if (result == 0) return(0);
		if (option->printcover) {
		    int *path;
		    DdGen *gen;
		    char *str = ALLOC(char,Cudd_ReadSize(dd)+1);
		    if (str == NULL) return(0);
		    (void) printf("Testing iterator on ZDD paths:\n");
		    Cudd_zddForeachPath(dd,zdd[i],gen,path) {
			str = Cudd_zddCoverPathToString(dd,path,str);
			(void) printf("%s 1\n", str);
		    }
		    (void) printf("\n");
		    FREE(str);
		    result = Cudd_zddPrintCover(dd,zdd[i]);

		    if (result == 0) return(0);
		}
	    } else {
		(void) printf("Conversion to ISOP failed.\n");
		return(0);
	    }
	}
    } else {
	nz = 1;
	if (!st_lookup(net->hash,option->node,(void **)&node)) {
	    return(0);
	}
	bdd = Cudd_zddIsop(dd, node->dd, node->dd, &zdd[0]);
	if (bdd != node->dd) return(0);
	Cudd_Ref(bdd);
	Cudd_RecursiveDeref(dd,bdd);
	if (zdd[0]) {
	    Cudd_Ref(zdd[0]);
	    (void) printf("%s", node->name);
	    result = Cudd_zddPrintDebug(dd,zdd[0],Cudd_ReadZddSize(dd),pr);
	    if (result == 0) return(0);
	    if (option->printcover) {
		int *path;
		DdGen *gen;
		char *str = ALLOC(char,Cudd_ReadSize(dd)+1);
		if (str == NULL) return(0);
		(void) printf("Testing iterator on ZDD paths:\n");
		Cudd_zddForeachPath(dd,zdd[0],gen,path) {
		    str = Cudd_zddCoverPathToString(dd,path,str);
		    (void) printf("%s 1\n", str);
		}
		(void) printf("\n");
		FREE(str);

		result = Cudd_zddPrintCover(dd,zdd[0]);
		if (result == 0) return(0);
	    }
	} else {
	    (void) printf("Conversion to ISOP failed.\n");
	    return(0);
	}
    }
    if (option->autoDyn) {
	Cudd_AutodynEnableZdd(dd,CUDD_REORDER_SAME);
    }

    /* Perform ZDD reordering. */
    result = reorderZdd(net,dd,option);
    if (result == 0) return(0);

    /* Dispose of ZDDs. */
    for (i = 0; i < nz; i++) {
	Cudd_RecursiveDerefZdd(dd,zdd[i]);
    }
    FREE(zdd);

    return(1);

} /* end of Ntr_testISOP */


/*---------------------------------------------------------------------------*/
/* Definition of internal functions                                          */
/*---------------------------------------------------------------------------*/

/*---------------------------------------------------------------------------*/
/* Definition of static functions                                            */
/*---------------------------------------------------------------------------*/


/**
  @brief Applies reordering to the ZDDs.

  @details Explicitly applies reordering to the ZDDs.

  @return 1 if successful; 0 otherwise.

  @sideeffect None

*/
static int
reorderZdd(
  BnetNetwork * net /**< boolean network */,
  DdManager * dd /**< DD Manager */,
  NtrOptions * option /**< options */)
{
    int result;			/* return value from functions */

    /* Perform the final reordering. */
    if (option->reordering != CUDD_REORDER_NONE) {
	(void) printf("Number of inputs = %d\n",net->ninputs);

	dd->siftMaxVar = 1000000; 
	result = Cudd_zddReduceHeap(dd,option->reordering,1);
	if (result == 0) return(0);

	/* Print symmetry stats if pertinent */
	if (option->reordering == CUDD_REORDER_SYMM_SIFT ||
	    option->reordering == CUDD_REORDER_SYMM_SIFT_CONV)
	    Cudd_zddSymmProfile(dd, 0, dd->sizeZ - 1);
    }

    return(1);

} /* end of reorderZdd */