mtr.h File Reference

Go to the source code of this file.

Classes
struct	MtrNode

Macros
#define	SIZEOF_VOID_P   4
#define	SIZEOF_INT   4
#define	MTR_INLINE
#define	MTR_UNUSED
#define	MTR_DEFAULT   0x00000000
#define	MTR_TERMINAL   0x00000001
#define	MTR_SOFT   0x00000002
#define	MTR_FIXED   0x00000004
#define	MTR_NEWNODE   0x00000008
#define	MTR_MAXHIGH   ((MtrHalfWord) ~0)
#define	MTR_SET(node, flag)   (node->flags |= (flag))
#define	MTR_RESET(node, flag)   (node->flags &= ~ (flag))
#define	MTR_TEST(node, flag)   (node->flags & (flag))

Typedefs
typedef unsigned short	MtrHalfWord
typedef struct MtrNode	MtrNode

Functions
MtrNode *	Mtr_AllocNode (void)
void	Mtr_DeallocNode (MtrNode *node)
MtrNode *	Mtr_InitTree (void)
void	Mtr_FreeTree (MtrNode *node)
MtrNode *	Mtr_CopyTree (MtrNode *node, int expansion)
void	Mtr_MakeFirstChild (MtrNode *parent, MtrNode *child)
void	Mtr_MakeLastChild (MtrNode *parent, MtrNode *child)
MtrNode *	Mtr_CreateFirstChild (MtrNode *parent)
MtrNode *	Mtr_CreateLastChild (MtrNode *parent)
void	Mtr_MakeNextSibling (MtrNode *first, MtrNode *second)
void	Mtr_PrintTree (MtrNode *node)
MtrNode *	Mtr_InitGroupTree (int lower, int size)
MtrNode *	Mtr_MakeGroup (MtrNode *root, unsigned int low, unsigned int high, unsigned int flags)
MtrNode *	Mtr_DissolveGroup (MtrNode *group)
MtrNode *	Mtr_FindGroup (MtrNode *root, unsigned int low, unsigned int high)
int	Mtr_SwapGroups (MtrNode *first, MtrNode *second)
void	Mtr_ReorderGroups (MtrNode *treenode, int *permutation)
void	Mtr_PrintGroups (MtrNode *root, int silent)
int	Mtr_PrintGroupedOrder (MtrNode *root, int *invperm, FILE *fp)
MtrNode *	Mtr_ReadGroups (FILE *fp, int nleaves)

Macro Definition Documentation

MTR_DEFAULT

#define MTR_DEFAULT   0x00000000

Definition at line 94 of file mtr.h.

MTR_FIXED

#define MTR_FIXED   0x00000004

Definition at line 97 of file mtr.h.

MTR_INLINE

#define MTR_INLINE

Definition at line 89 of file mtr.h.

MTR_MAXHIGH

#define MTR_MAXHIGH   ((MtrHalfWord) ~0)

Definition at line 107 of file mtr.h.

MTR_NEWNODE

#define MTR_NEWNODE   0x00000008

Definition at line 98 of file mtr.h.

MTR_RESET

#define MTR_RESET	(		node,
			flag
	)		(node->flags &= ~ (flag))

Definition at line 149 of file mtr.h.

MTR_SET

#define MTR_SET	(		node,
			flag
	)		(node->flags |= (flag))

Definition at line 148 of file mtr.h.

MTR_SOFT

#define MTR_SOFT   0x00000002

Definition at line 96 of file mtr.h.

MTR_TERMINAL

#define MTR_TERMINAL   0x00000001

Definition at line 95 of file mtr.h.

MTR_TEST

#define MTR_TEST	(		node,
			flag
	)		(node->flags & (flag))

Definition at line 150 of file mtr.h.

MTR_UNUSED

#define MTR_UNUSED

Definition at line 90 of file mtr.h.

SIZEOF_INT

#define SIZEOF_INT   4

Definition at line 78 of file mtr.h.

SIZEOF_VOID_P

#define SIZEOF_VOID_P   4

CHeaderFile*****************************************************************

FileName [mtr.h]

PackageName [mtr]

Synopsis [Multiway-branch tree manipulation]

Description [This package provides two layers of functions. Functions of the lower level manipulate multiway-branch trees, implemented according to the classical scheme whereby each node points to its first child and its previous and next siblings. These functions are collected in mtrBasic.c.

Functions of the upper layer deal with group trees, that is the trees used by group sifting to represent the grouping of variables. These functions are collected in mtrGroup.c.]

SeeAlso [The CUDD package documentation; specifically on group sifting.]

Author [Fabio Somenzi]

Copyright [Copyright (c) 1995-2012, 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.]

Revision [

Id

mtr.h,v 1.17 2012/02/05 01:06:19 fabio Exp

]

Definition at line 75 of file mtr.h.

Typedef Documentation

MtrHalfWord

typedef unsigned short MtrHalfWord

Definition at line 123 of file mtr.h.

MtrNode

typedef struct MtrNode MtrNode

Function Documentation

Mtr_AllocNode()

MtrNode* Mtr_AllocNode

(

void

)

AutomaticStart

AutomaticStart AutomaticEnd Function********************************************************************

Synopsis [Allocates new tree node.]

Description [Allocates new tree node. Returns pointer to node.]

SideEffects [None]

SeeAlso [Mtr_DeallocNode]

Definition at line 117 of file mtrBasic.c.

{
    MtrNode *node;

    node = ALLOC(MtrNode,1);
    return node;

} /* Mtr_AllocNode */

Mtr_CopyTree()

MtrNode* Mtr_CopyTree	(	MtrNode *	node,
		int	expansion
	)

Function********************************************************************

Synopsis [Makes a copy of tree.]

Description [Makes a copy of tree. If parameter expansion is greater than 1, it will expand the tree by that factor. It is an error for expansion to be less than 1. Returns a pointer to the copy if successful; NULL otherwise.]

SideEffects [None]

SeeAlso [Mtr_InitTree]

Definition at line 214 of file mtrBasic.c.

{
    MtrNode *copy;

    if (node == NULL) return(NULL);
    if (expansion < 1) return(NULL);
    copy = Mtr_AllocNode();
    if (copy == NULL) return(NULL);
    copy->parent = copy->elder = copy->child = copy->younger = NULL;
    if (node->child != NULL) {
    copy->child = Mtr_CopyTree(node->child, expansion);
    if (copy->child == NULL) {
        Mtr_DeallocNode(copy);
        return(NULL);
    }
    }
    if (node->younger != NULL) {
    copy->younger = Mtr_CopyTree(node->younger, expansion);
    if (copy->younger == NULL) {
        Mtr_FreeTree(copy);
        return(NULL);
    }
    }
    copy->flags = node->flags;
    copy->low = node->low * expansion;
    copy->size = node->size * expansion;
    copy->index = node->index * expansion;
    if (copy->younger) copy->younger->elder = copy;
    if (copy->child) {
    MtrNode *auxnode = copy->child;
    while (auxnode != NULL) {
        auxnode->parent = copy;
        auxnode = auxnode->younger;
    }
    }
    return(copy);

} /* end of Mtr_CopyTree */

Mtr_CreateFirstChild()

MtrNode* Mtr_CreateFirstChild

(

MtrNode *

parent

)

Function********************************************************************

Synopsis [Creates a new node and makes it the first child of parent.]

Description [Creates a new node and makes it the first child of parent. Returns pointer to new child.]

SideEffects [None]

SeeAlso [Mtr_MakeFirstChild Mtr_CreateLastChild]

Definition at line 336 of file mtrBasic.c.

{
    MtrNode *child;

    child = Mtr_AllocNode();
    if (child == NULL) return(NULL);

    child->child = NULL;
    child->flags = 0;
    Mtr_MakeFirstChild(parent,child);
    return(child);

} /* end of Mtr_CreateFirstChild */

Mtr_CreateLastChild()

MtrNode* Mtr_CreateLastChild

(

MtrNode *

parent

)

Function********************************************************************

Synopsis [Creates a new node and makes it the last child of parent.]

Description [Creates a new node and makes it the last child of parent. Returns pointer to new child.]

SideEffects [None]

SeeAlso [Mtr_MakeLastChild Mtr_CreateFirstChild]

Definition at line 365 of file mtrBasic.c.

{
    MtrNode *child;

    child = Mtr_AllocNode();
    if (child == NULL) return(NULL);

    child->child = NULL;
    child->flags = 0;
    Mtr_MakeLastChild(parent,child);
    return(child);

} /* end of Mtr_CreateLastChild */

Mtr_DeallocNode()

void Mtr_DeallocNode

(

MtrNode *

node

)

Function********************************************************************

Synopsis [Deallocates tree node.]

Description []

SideEffects [None]

SeeAlso [Mtr_AllocNode]

Definition at line 139 of file mtrBasic.c.

{
    FREE(node);
    return;

} /* end of Mtr_DeallocNode */

Mtr_DissolveGroup()

MtrNode* Mtr_DissolveGroup

(

MtrNode *

group

)

Function********************************************************************

Synopsis [Merges the children of `group' with the children of its parent.]

Description [Merges the children of `group' with the children of its parent. Disposes of the node pointed by group. If group is the root of the group tree, this procedure leaves the tree unchanged. Returns the pointer to the parent of `group' upon successful termination; NULL otherwise.]

SideEffects [None]

SeeAlso [Mtr_MakeGroup]

Definition at line 349 of file mtrGroup.c.

{
    MtrNode *parent;
    MtrNode *last;

    parent = group->parent;

    if (parent == NULL) return(NULL);
    if (MTR_TEST(group,MTR_TERMINAL) || group->child == NULL) return(NULL);

    /* Make all children of group children of its parent, and make
    ** last point to the last child of group. */
    for (last = group->child; last->younger != NULL; last = last->younger) {
    last->parent = parent;
    }
    last->parent = parent;

    last->younger = group->younger;
    if (group->younger != NULL) {
    group->younger->elder = last;
    }

    group->child->elder = group->elder;
    if (group == parent->child) {
    parent->child = group->child;
    } else {
    group->elder->younger = group->child;
    }

    Mtr_DeallocNode(group);
    return(parent);

} /* end of Mtr_DissolveGroup */

Mtr_FindGroup()

MtrNode* Mtr_FindGroup	(	MtrNode *	root,
		unsigned int	low,
		unsigned int	size
	)

Function********************************************************************

Synopsis [Finds a group with size leaves starting at low, if it exists.]

Description [Finds a group with size leaves starting at low, if it exists. This procedure relies on the low and size fields of each node. It also assumes that the children of each node are sorted in order of increasing low. Returns the pointer to the root of the group upon successful termination; NULL otherwise.]

SideEffects [None]

SeeAlso []

Definition at line 401 of file mtrGroup.c.

{
    MtrNode *node;

#ifdef MTR_DEBUG
    /* We cannot have a non-empty proper subgroup of a singleton set. */
    assert(!MTR_TEST(root,MTR_TERMINAL));
#endif

    /* Sanity check. */
    if (size < 1) return(NULL);

    /* Check whether current group includes the group sought.  This
    ** check is necessary at the top-level call.  In the subsequent
    ** calls it is redundant. */
    if (low < (unsigned int) root->low ||
    low + size > (unsigned int) (root->low + root->size))
    return(NULL);

    if (root->size == size && root->low == low)
    return(root);

    if (root->child == NULL)
    return(NULL);

    /* Find all chidren of root that are included in the new group. If
    ** the group of any child entirely contains the new group, call
    ** Mtr_MakeGroup recursively.  */
    node = root->child;
    while (low >= (unsigned int) (node->low + node->size)) {
    node = node->younger;
    }
    if (low + size <= (unsigned int) (node->low + node->size)) {
    /* The group is contained in the group of node. */
    node = Mtr_FindGroup(node, low, size);
    return(node);
    } else {
    return(NULL);
    }

} /* end of Mtr_FindGroup */

Mtr_FreeTree()

void Mtr_FreeTree

(

MtrNode *

node

)

Function********************************************************************

Synopsis [Disposes of tree rooted at node.]

Description []

SideEffects [None]

SeeAlso [Mtr_InitTree]

Definition at line 187 of file mtrBasic.c.

{
    if (node == NULL) return;
    if (! MTR_TEST(node,MTR_TERMINAL)) Mtr_FreeTree(node->child);
    Mtr_FreeTree(node->younger);
    Mtr_DeallocNode(node);
    return;

} /* end of Mtr_FreeTree */

Mtr_InitGroupTree()

MtrNode* Mtr_InitGroupTree	(	int	lower,
		int	size
	)

AutomaticEnd Function********************************************************************

Synopsis [Allocate new tree.]

Description [Allocate new tree with one node, whose low and size fields are specified by the lower and size parameters. Returns pointer to tree root.]

SideEffects [None]

SeeAlso [Mtr_InitTree Mtr_FreeTree]

Definition at line 120 of file mtrGroup.c.

{
    MtrNode *root;

    root = Mtr_InitTree();
    if (root == NULL) return(NULL);
    root->flags = MTR_DEFAULT;
    root->low = lower;
    root->size = size;
    return(root);

} /* end of Mtr_InitGroupTree */

Mtr_InitTree()

MtrNode* Mtr_InitTree

(

void

)

Function********************************************************************

Synopsis [Initializes tree with one node.]

Description [Initializes tree with one node. Returns pointer to node.]

SideEffects [None]

SeeAlso [Mtr_FreeTree Mtr_InitGroupTree]

Definition at line 160 of file mtrBasic.c.

{
    MtrNode *node;

    node = Mtr_AllocNode();
    if (node == NULL) return(NULL);

    node->parent = node->child = node->elder = node->younger = NULL;
    node->flags = 0;

    return(node);

} /* end of Mtr_InitTree */

Mtr_MakeFirstChild()

void Mtr_MakeFirstChild	(	MtrNode *	parent,
		MtrNode *	child
	)

Function********************************************************************

Synopsis [Makes child the first child of parent.]

Description []

SideEffects [None]

SeeAlso [Mtr_MakeLastChild Mtr_CreateFirstChild]

Definition at line 268 of file mtrBasic.c.

{
    child->parent = parent;
    child->younger = parent->child;
    child->elder = NULL;
    if (parent->child != NULL) {
#ifdef MTR_DEBUG
    assert(parent->child->elder == NULL);
#endif
    parent->child->elder = child;
    }
    parent->child = child;
    return;

} /* end of Mtr_MakeFirstChild */

Mtr_MakeGroup()

MtrNode* Mtr_MakeGroup	(	MtrNode *	root,
		unsigned int	low,
		unsigned int	size,
		unsigned int	flags
	)

Function********************************************************************

Synopsis [Makes a new group with size leaves starting at low.]

Description [Makes a new group with size leaves starting at low. If the new group intersects an existing group, it must either contain it or be contained by it. This procedure relies on the low and size fields of each node. It also assumes that the children of each node are sorted in order of increasing low. In case of a valid request, the flags of the new group are set to the value passed in `flags.' Returns the pointer to the root of the new group upon successful termination; NULL otherwise. If the group already exists, the pointer to its root is returned.]

SideEffects [None]

SeeAlso [Mtr_DissolveGroup Mtr_ReadGroups Mtr_FindGroup]

Definition at line 156 of file mtrGroup.c.

{
    MtrNode *node,
        *first,
        *last,
        *previous,
        *newn;

    /* Sanity check. */
    if (size == 0)
    return(NULL);

    /* Check whether current group includes new group.  This check is
    ** necessary at the top-level call.  In the subsequent calls it is
    ** redundant. */
    if (low < (unsigned int) root->low ||
    low + size > (unsigned int) (root->low + root->size))
    return(NULL);

    /* At this point we know that the new group is contained
    ** in the group of root. We have two possible cases here:
    **  - root is a terminal node;
    **  - root has children.       */

    /* Root has no children: create a new group. */
    if (root->child == NULL) {
    newn = Mtr_AllocNode();
    if (newn == NULL) return(NULL); /* out of memory */
    newn->low = low;
    newn->size = size;
    newn->flags = flags;
    newn->parent = root;
    newn->elder = newn->younger = newn->child = NULL;
    root->child = newn;
    return(newn);
    }

    /* Root has children: Find all children of root that are included
    ** in the new group.  If the group of any child entirely contains
    ** the new group, call Mtr_MakeGroup recursively. */
    previous = NULL;
    first = root->child; /* guaranteed to be non-NULL */
    while (first != NULL && low >= (unsigned int) (first->low + first->size)) {
    previous = first;
    first = first->younger;
    }
    if (first == NULL) {
    /* We have scanned the entire list and we need to append a new
    ** child at the end of it.  Previous points to the last child
    ** of root. */
    newn = Mtr_AllocNode();
    if (newn == NULL) return(NULL); /* out of memory */
    newn->low = low;
    newn->size = size;
    newn->flags = flags;
    newn->parent = root;
    newn->elder = previous;
    previous->younger = newn;
    newn->younger = newn->child = NULL;
    return(newn);
    }
    /* Here first is non-NULL and low < first->low + first->size. */
    if (low >= (unsigned int) first->low &&
    low + size <= (unsigned int) (first->low + first->size)) {
    /* The new group is contained in the group of first. */
    newn = Mtr_MakeGroup(first, low, size, flags);
    return(newn);
    } else if (low + size <= first->low) {
    /* The new group is entirely contained in the gap between
    ** previous and first. */
    newn = Mtr_AllocNode();
    if (newn == NULL) return(NULL); /* out of memory */
    newn->low = low;
    newn->size = size;
    newn->flags = flags;
    newn->child = NULL;
    newn->parent = root;
    newn->elder = previous;
    newn->younger = first;
    first->elder = newn;
    if (previous != NULL) {
        previous->younger = newn;
    } else {
        root->child = newn;
    }
    return(newn);
    } else if (low < (unsigned int) first->low &&
           low + size < (unsigned int) (first->low + first->size)) {
    /* Trying to cut an existing group: not allowed. */
    return(NULL);
    } else if (low > first->low) {
    /* The new group neither is contained in the group of first
    ** (this was tested above) nor contains it. It is therefore
    ** trying to cut an existing group: not allowed. */
    return(NULL);
    }

    /* First holds the pointer to the first child contained in the new
    ** group. Here low <= first->low and low + size >= first->low +
    ** first->size.  One of the two inequalities is strict. */
    last = first->younger;
    while (last != NULL &&
       (unsigned int) (last->low + last->size) < low + size) {
    last = last->younger;
    }
    if (last == NULL) {
    /* All the chilren of root from first onward become children
    ** of the new group. */
    newn = Mtr_AllocNode();
    if (newn == NULL) return(NULL); /* out of memory */
    newn->low = low;
    newn->size = size;
    newn->flags = flags;
    newn->child = first;
    newn->parent = root;
    newn->elder = previous;
    newn->younger = NULL;
    first->elder = NULL;
    if (previous != NULL) {
        previous->younger = newn;
    } else {
        root->child = newn;
    }
    last = first;
    while (last != NULL) {
        last->parent = newn;
        last = last->younger;
    }
    return(newn);
    }

    /* Here last != NULL and low + size <= last->low + last->size. */
    if (low + size - 1 >= (unsigned int) last->low &&
    low + size < (unsigned int) (last->low + last->size)) {
    /* Trying to cut an existing group: not allowed. */
    return(NULL);
    }

    /* First and last point to the first and last of the children of
    ** root that are included in the new group. Allocate a new node
    ** and make all children of root between first and last chidren of
    ** the new node.  Previous points to the child of root immediately
    ** preceeding first. If it is NULL, then first is the first child
    ** of root. */
    newn = Mtr_AllocNode();
    if (newn == NULL) return(NULL); /* out of memory */
    newn->low = low;
    newn->size = size;
    newn->flags = flags;
    newn->child = first;
    newn->parent = root;
    if (previous == NULL) {
    root->child = newn;
    } else {
    previous->younger = newn;
    }
    newn->elder = previous;
    newn->younger = last->younger;
    if (last->younger != NULL) {
    last->younger->elder = newn;
    }
    last->younger = NULL;
    first->elder = NULL;
    for (node = first; node != NULL; node = node->younger) {
    node->parent = newn;
    }

    return(newn);

} /* end of Mtr_MakeGroup */

Mtr_MakeLastChild()

void Mtr_MakeLastChild	(	MtrNode *	parent,
		MtrNode *	child
	)

Function********************************************************************

Synopsis [Makes child the last child of parent.]

Description []

SideEffects [None]

SeeAlso [Mtr_MakeFirstChild Mtr_CreateLastChild]

Definition at line 299 of file mtrBasic.c.

{
    MtrNode *node;

    child->younger = NULL;

    if (parent->child == NULL) {
    parent->child = child;
    child->elder = NULL;
    } else {
    for (node = parent->child;
         node->younger != NULL;
         node = node->younger);
    node->younger = child;
    child->elder = node;
    }
    child->parent = parent;
    return;

} /* end of Mtr_MakeLastChild */

Mtr_MakeNextSibling()

void Mtr_MakeNextSibling	(	MtrNode *	first,
		MtrNode *	second
	)

Function********************************************************************

Synopsis [Makes second the next sibling of first.]

Description [Makes second the next sibling of first. Second becomes a child of the parent of first.]

SideEffects [None]

SeeAlso []

Definition at line 394 of file mtrBasic.c.

{
    second->parent = first->parent;
    second->elder = first;
    second->younger = first->younger;
    if (first->younger != NULL) {
    first->younger->elder = second;
    }
    first->younger = second;
    return;

} /* end of Mtr_MakeNextSibling */

Mtr_PrintGroupedOrder()

int Mtr_PrintGroupedOrder	(	MtrNode *	root,
		int *	invperm,
		FILE *	fp
	)

Function********************************************************************

Synopsis [Prints the variable order as a parenthesized list.]

Description [Prints the variable order as a parenthesized list. After each group, the group's flag are printed, preceded by a `|'. For each flag (except MTR_TERMINAL) a character is printed.

• F: MTR_FIXED
• N: MTR_NEWNODE
• S: MTR_SOFT

The second argument, gives the map from levels to variable indices. ]

SideEffects [None]

SeeAlso [Mtr_PrintGroups]

Definition at line 662 of file mtrGroup.c.

{
    MtrNode *child;
    MtrHalfWord level;
    int retval;

    assert(root != NULL);
    assert(root->younger == NULL || root->younger->elder == root);
    assert(root->elder == NULL || root->elder->younger == root);
    retval = fprintf(fp,"(");
    if (retval == EOF) return(0);
    level = root->low;
    child = root->child;
    while (child != NULL) {
        assert(child->low >= root->low && (child->low + child->size) <= (root->low + root->size));
        assert(child->parent == root);
        while (level < child->low) {
            retval = fprintf(fp,"%d%s", invperm[level], (level < root->low + root->size - 1) ? "," : "");
            if (retval == EOF) return(0);
            level++;
        }
        retval = Mtr_PrintGroupedOrder(child,invperm,fp);
        if (retval == 0) return(0);
        level += child->size;
        if (level < root->low + root->size - 1) {
            retval = fprintf(fp,",");
            if (retval == EOF) return(0);
        }
        child = child->younger;
    }
    while (level < root->low + root->size) {
        retval = fprintf(fp,"%d%s", invperm[level], (level < root->low + root->size - 1) ? "," : "");
        if (retval == EOF) return(0);
        level++;
    }
    if (root->flags != MTR_DEFAULT) {
      retval = fprintf(fp,"|");
      if (retval == EOF) return(0);
      if (MTR_TEST(root,MTR_FIXED)) {
          retval = fprintf(fp,"F");
          if (retval == EOF) return(0);
      }
      if (MTR_TEST(root,MTR_NEWNODE)) {
          retval = fprintf(fp,"N");
          if (retval == EOF) return(0);
      }
      if (MTR_TEST(root,MTR_SOFT)) {
          retval = fprintf(fp,"S");
          if (retval == EOF) return(0);
      }
    }
    retval = fprintf(fp,")");
    if (retval == EOF) return(0);
    if (root->parent == NULL) {
        retval = fprintf(fp,"\n");
        if (retval == EOF) return(0);
    }
    assert((root->flags &~(MTR_SOFT | MTR_FIXED | MTR_NEWNODE)) == 0);
    return(1);

} /* end of Mtr_PrintGroupedOrder */

Mtr_PrintGroups()

void Mtr_PrintGroups	(	MtrNode *	root,
		int	silent
	)

Function********************************************************************

Synopsis [Prints the groups as a parenthesized list.]

Description [Prints the groups as a parenthesized list. After each group, the group's flag are printed, preceded by a `|'. For each flag (except MTR_TERMINAL) a character is printed.

• F: MTR_FIXED
• N: MTR_NEWNODE
• S: MTR_SOFT

The second argument, silent, if different from 0, causes Mtr_PrintGroups to only check the syntax of the group tree. ]

SideEffects [None]

SeeAlso [Mtr_PrintTree]

Definition at line 595 of file mtrGroup.c.

{
    MtrNode *node;

    assert(root != NULL);
    assert(root->younger == NULL || root->younger->elder == root);
    assert(root->elder == NULL || root->elder->younger == root);
#if SIZEOF_VOID_P == 8
    if (!silent) (void) printf("(%u",root->low);
#else
    if (!silent) (void) printf("(%hu",root->low);
#endif
    if (MTR_TEST(root,MTR_TERMINAL) || root->child == NULL) {
    if (!silent) (void) printf(",");
    } else {
    node = root->child;
    while (node != NULL) {
        assert(node->low >= root->low && (int) (node->low + node->size) <= (int) (root->low + root->size));
        assert(node->parent == root);
        Mtr_PrintGroups(node,silent);
        node = node->younger;
    }
    }
    if (!silent) {
#if SIZEOF_VOID_P == 8
    (void) printf("%u", root->low + root->size - 1);
#else
    (void) printf("%hu", root->low + root->size - 1);
#endif
    if (root->flags != MTR_DEFAULT) {
        (void) printf("|");
        if (MTR_TEST(root,MTR_FIXED)) (void) printf("F");
        if (MTR_TEST(root,MTR_NEWNODE)) (void) printf("N");
        if (MTR_TEST(root,MTR_SOFT)) (void) printf("S");
    }
    (void) printf(")");
    if (root->parent == NULL) (void) printf("\n");
    }
    assert((root->flags &~(MTR_TERMINAL | MTR_SOFT | MTR_FIXED | MTR_NEWNODE)) == 0);
    return;

} /* end of Mtr_PrintGroups */

Mtr_PrintTree()

void Mtr_PrintTree

(

MtrNode *

node

)

Function********************************************************************

Synopsis [Prints a tree, one node per line.]

Description []

SideEffects [None]

SeeAlso [Mtr_PrintGroups]

Definition at line 422 of file mtrBasic.c.

{
    if (node == NULL) return;
    (void) fprintf(stdout,
#if SIZEOF_VOID_P == 8
    "N=0x%-8lx C=0x%-8lx Y=0x%-8lx E=0x%-8lx P=0x%-8lx F=%x L=%u S=%u\n",
    (unsigned long) node, (unsigned long) node->child,
    (unsigned long) node->younger, (unsigned long) node->elder,
    (unsigned long) node->parent, node->flags, node->low, node->size);
#else
    "N=0x%-8x C=0x%-8x Y=0x%-8x E=0x%-8x P=0x%-8x F=%x L=%hu S=%hu\n",
    (unsigned) node, (unsigned) node->child,
    (unsigned) node->younger, (unsigned) node->elder,
    (unsigned) node->parent, node->flags, node->low, node->size);
#endif
    if (!MTR_TEST(node,MTR_TERMINAL)) Mtr_PrintTree(node->child);
    Mtr_PrintTree(node->younger);
    return;

} /* end of Mtr_PrintTree */

Mtr_ReadGroups()

MtrNode* Mtr_ReadGroups	(	FILE *	fp,
		int	nleaves
	)

Function********************************************************************

Synopsis [Reads groups from a file and creates a group tree.]

Description [Reads groups from a file and creates a group tree. Each group is specified by three fields: <xmp> low size flags. </xmp> Low and size are (short) integers. Flags is a string composed of the following characters (with associated translation):

• D: MTR_DEFAULT
• F: MTR_FIXED
• N: MTR_NEWNODE
• S: MTR_SOFT
• T: MTR_TERMINAL

Normally, the only flags that are needed are D and F. Groups and fields are separated by white space (spaces, tabs, and newlines). Returns a pointer to the group tree if successful; NULL otherwise.]

SideEffects [None]

SeeAlso [Mtr_InitGroupTree Mtr_MakeGroup]

Definition at line 756 of file mtrGroup.c.

{
    int low;
    int size;
    int err;
    unsigned int flags;
    MtrNode *root;
    MtrNode *node;
    char attrib[8*sizeof(unsigned int)+1];
    char *c;

    root = Mtr_InitGroupTree(0,nleaves);
    if (root == NULL) return NULL;

    while (! feof(fp)) {
    /* Read a triple and check for consistency. */
    err = fscanf(fp, "%d %d %s", &low, &size, attrib);
    if (err == EOF) {
        break;
    } else if (err != 3) {
        Mtr_FreeTree(root);
        return(NULL);
    } else if (low < 0 || low+size > nleaves || size < 1) {
        Mtr_FreeTree(root);
        return(NULL);
    } else if (strlen(attrib) > 8 * sizeof(MtrHalfWord)) {
        /* Not enough bits in the flags word to store these many
        ** attributes. */
        Mtr_FreeTree(root);
        return(NULL);
    }

    /* Parse the flag string. Currently all flags are permitted,
    ** to make debugging easier. Normally, specifying NEWNODE
    ** wouldn't be allowed. */
    flags = MTR_DEFAULT;
    for (c=attrib; *c != 0; c++) {
        switch (*c) {
        case 'D':
        break;
        case 'F':
        flags |= MTR_FIXED;
        break;
        case 'N':
        flags |= MTR_NEWNODE;
        break;
        case 'S':
        flags |= MTR_SOFT;
        break;
        case 'T':
        flags |= MTR_TERMINAL;
        break;
        default:
        return NULL;
        }
    }
    node = Mtr_MakeGroup(root, (MtrHalfWord) low, (MtrHalfWord) size,
                 flags);
    if (node == NULL) {
        Mtr_FreeTree(root);
        return(NULL);
    }
    }

    return(root);

} /* end of Mtr_ReadGroups */

Mtr_ReorderGroups()

void Mtr_ReorderGroups	(	MtrNode *	treenode,
		int *	permutation
	)

Function********************************************************************

Synopsis [Fix variable tree at the end of tree sifting.]

Description [Fix the levels in the variable tree sorting siblings according to them. It should be called on a non-NULL tree. It then maintains this invariant. It applies insertion sorting to the list of siblings The order is determined by permutation, which is used to find the new level of the node index. Index must refer to the first variable in the group.]

SideEffects [The tree is modified.]

SeeAlso []

Definition at line 524 of file mtrGroup.c.

{
    MtrNode *auxnode;
    /* Initialize sorted list to first element. */
    MtrNode *sorted = treenode;
    sorted->low = permutation[sorted->index];
    if (sorted->child != NULL)
      Mtr_ReorderGroups(sorted->child, permutation);

    auxnode = treenode->younger;
    while (auxnode != NULL) {
        MtrNode *rightplace;
        MtrNode *moving = auxnode;
    auxnode->low = permutation[auxnode->index];
    if (auxnode->child != NULL)
          Mtr_ReorderGroups(auxnode->child, permutation);
        rightplace = auxnode->elder;
        /* Find insertion point. */
        while (rightplace != NULL && auxnode->low < rightplace->low)
            rightplace = rightplace->elder;
        auxnode = auxnode->younger;
        if (auxnode != NULL) {
            auxnode->elder = moving->elder;
            auxnode->elder->younger = auxnode;
        } else {
            moving->elder->younger = NULL;
        }
        if (rightplace == NULL) { /* Move to head of sorted list. */
            sorted->elder = moving;
            moving->elder = NULL;
            moving->younger = sorted;
            sorted = moving;
        } else { /* Splice. */
            moving->elder = rightplace;
            moving->younger = rightplace->younger;
            if (rightplace->younger != NULL)
                rightplace->younger->elder = moving;
            rightplace->younger = moving;
        }
    }
    /* Fix parent. */
    if (sorted->parent != NULL)
        sorted->parent->child = sorted;

} /* end of Mtr_ReorderGroups */

Mtr_SwapGroups()

int Mtr_SwapGroups	(	MtrNode *	first,
		MtrNode *	second
	)

Function********************************************************************

Synopsis [Swaps two children of a tree node.]

Description [Swaps two children of a tree node. Adjusts the high and low fields of the two nodes and their descendants. The two children must be adjacent. However, first may be the younger sibling of second. Returns 1 in case of success; 0 otherwise.]

SideEffects [None]

SeeAlso []

Definition at line 462 of file mtrGroup.c.

{
    MtrNode *node;
    MtrNode *parent;
    int sizeFirst;
    int sizeSecond;

    if (second->younger == first) { /* make first first */
    node = first;
    first = second;
    second = node;
    } else if (first->younger != second) { /* non-adjacent */
    return(0);
    }

    sizeFirst = first->size;
    sizeSecond = second->size;

    /* Swap the two nodes. */
    parent = first->parent;
    if (parent == NULL || second->parent != parent) return(0);
    if (parent->child == first) {
    parent->child = second;
    } else { /* first->elder != NULL */
    first->elder->younger = second;
    }
    if (second->younger != NULL) {
    second->younger->elder = first;
    }
    first->younger = second->younger;
    second->elder = first->elder;
    first->elder = second;
    second->younger = first;

    /* Adjust the high and low fields. */
    if (!mtrShiftHL(first,sizeSecond)) return(0);
    if (!mtrShiftHL(second,-sizeFirst)) return(0);

    return(1);

} /* end of Mtr_SwapGroups */