Globals.h

// Globals.h -- Interface to global variables and functions in the csp
// namespace.

/*
 * Copyright (C) 1997, 1998, 2003 Tudor Hulubei <tudor@hulubei.net>.
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA,
 * 02111-1307, USA.
 */

/*
 * NOTE: This is an interal header file.
 * You should not attempt to use it directly.
 */

// $Id: Globals_8h-source.html,v 1.1 2005/05/25 12:37:18 tudor Exp $

#ifndef _CSP_KERNEL_Globals_H
#define _CSP_KERNEL_Globals_H


CSP_NAMESPACE_BEGIN(csp);


/*
 * If this variable is set, variables in the list of uninstantiated
 * variables (the list from which decompositions select variables),
 * and values in the domain of a variable are kept sorted.  Note that
 * sorting happens before propagate() and decompose().
 */
extern CSP_API bool g_predictable;

/*
 * This variable can be set by any object in the library that performs
 * debugging-related tasks, as a general mean of notifying the rest of
 * the library that statistics should not be updated.  For instance,
 * if consistency is enforced as part of a sanity-check routine that
 * is only executed during debugging, constraint checks and failures
 * should not be updated (or should be counted separately, if such a
 * need exists).
 */
extern CSP_API bool g_debugging;


template<class Container>
inline int
size_cmp(const Container& c1, const Container& c2)
{
    typename Container::const_iterator i1 = c1.begin();
    typename Container::const_iterator i2 = c2.begin();
    typename Container::const_iterator e1 = c1.end();
    typename Container::const_iterator e2 = c2.end();

    for (;; ++i1, ++i2)
        if (i1 == e1)
            return (i2 == e2) ? 0 : -1;
        else
            if (i2 == e2)
                return 1;

    // Not reached.
    return 0;
}


template<class Container>
inline bool
size_lt(const Container& c1, const Container& c2)
{
    return size_cmp(c1, c2) == -1;
}


template<class Container>
inline bool
size_le(const Container& c1, const Container& c2)
{
    return size_cmp(c1, c2) <= 0;
}


template<class Container>
inline bool
size_eq(const Container& c1, const Container& c2)
{
    return size_cmp(c1, c2) == 0;
}


template<class Container>
inline bool
size_ge(const Container& c1, const Container& c2)
{
    return size_cmp(c1, c2) >= 0;
}


template<class Container>
inline bool
size_gt(const Container& c1, const Container& c2)
{
    return size_cmp(c1, c2) == 1;
}


template<class Container>
inline int
size_cmp(const Container& c, size_t n)
{
    size_t cnt = 0;
    typename Container::const_iterator i = c.begin();
    typename Container::const_iterator e = c.end();

    for (; i != e; ++i)
        if (++cnt > n)
            return 1;

    return (cnt == n) ? 0 : -1;
}


template<class Container>
inline bool
size_lt(const Container& c, size_t n)
{
    return size_cmp(c, n) == -1;
}


template<class Container>
inline bool
size_le(const Container& c, size_t n)
{
    return size_cmp(c, n) <= 0;
}


template<class Container>
inline bool
size_eq(const Container& c, size_t n)
{
    return size_cmp(c, n) == 0;
}


template<class Container>
inline bool
size_ge(const Container& c, size_t n)
{
    return size_cmp(c, n) >= 0;
}


template<class Container>
inline bool
size_gt(const Container& c, size_t n)
{
    return size_cmp(c, n) == 1;
}


template<class Container>
inline int
size_cmp(
    const Container& c,
    size_t n,
    size_t& counted,
    typename Container::const_iterator& i)
{
    counted = 0;
    i = c.begin();
    typename Container::const_iterator e = c.end();

    for (; i != e; ++i)
        if (++counted > n)
        {
            counted--;
            return 1;
        }

    return (counted == n) ? 0 : -1;
}


template<class C, class O>
inline bool
member(const C& c, const O& o)
{
    return find(c.begin(), c.end(), &o) != c.end();
}


template<class T>
inline void
merge(list<T*>& dest, list<T*>& src)
{
    if (g_predictable)
        dest.merge(src, id_less<T>());
    else
        dest.splice(dest.begin(), src);
}


template<class T>
inline void
merge(list<T*>& dest, list<T*>& src, typename list<T*>::iterator i)
{
    if (g_predictable)
    {
        id_less<const T*> lessThan;
        typename list<T*>::iterator j = dest.begin();
        typename list<T*>::iterator e = dest.end();

        for (; (j != e) && lessThan(*j, *i); ++j)
            ;
        dest.splice(j, src, i);
    }
    else
        dest.splice(dest.end(), src, i);
}


template<class T>
inline void
insert(list<T*>& dest, T* element)
{
    if (g_predictable)
    {
        id_less<const T*> lessThan;
        typename list<T*>::iterator j = dest.begin();
        typename list<T*>::iterator e = dest.end();

        for (; (j != e) && lessThan(*j, element); ++j)
            ;
        dest.insert(j, element);
    }
    else
        dest.push_back(element);
}


template<class T>
bool
isSortedById(list<T*>& c)
{
    id_t previous = NoId;
    typename list<T*>::const_iterator i = c.begin();
    typename list<T*>::const_iterator e = c.end();

    for (; i != e; ++i)
    {
        id_t id = (*i)->id();
        if (id <= previous)
            return false;
        previous = id;
    }

    return true;
}



template<class Container>
inline wstring
print(const Container& c)
{
    wostringstream wos;
    typename Container::const_iterator i = c.begin();
    typename Container::const_iterator e = c.end();

    for (; i != e; ++i)
        wos << endl << L"    " << **i;

    return wos.str();
}


template<class Container>
inline wstring
printIds(const Container& c)
{
    wostringstream wos;
    typename Container::const_iterator i = c.begin();
    typename Container::const_iterator e = c.end();
    typename Container::const_iterator next;

    for (; i != e; i = next)
    {
        next = i;
        ++next;
        wos << (*i)->id();
        if (next != e)
            wos << L" ";
    }

    return wos.str();
}


CSP_NAMESPACE_END(csp);


#endif // _CSP_KERNEL_Globals_H

// Local Variables:
// mode: C++
// End:

---