main page modules namespaces classes files
Gecode/J home

Propagator.java

Go to the documentation of this file.

/*
 *  Main authors:
 *     Mikael Lagerkvist <lagerkvist@gecode.org>
 *     Guido Tack <tack@gecode.org>
 *
 *  Copyright:
 *     Mikael Lagerkvist, 2006
 *     Guido Tack, 2006
 *
 *  Last modified:
 *     $Date: 2006-09-26 16:51:04 +0200 (Tue, 26 Sep 2006) $ by $Author: zayenz $
 *     $Revision: 3706 $
 *
 *  This file is part of Gecode, the generic constraint
 *  development environment:
 *     http://www.gecode.org
 *
 *  See the file "LICENSE" for information on usage and
 *  redistribution of this file, and for a
 *     DISCLAIMER OF ALL WARRANTIES.
 *
 */

package org.gecode;

import java.lang.reflect.*;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;

public abstract class Propagator 
  extends JavaPropagator 
  implements GecodeEnumConstants {

    public Propagator() {
        swigReleaseOwnership();
    }

    public void dispose(Space home) {}

    public final void dispose_internal(JavaSpace home) {
        dispose(new DummySpace(home.getCPtr(home),
                               home.swigCMemOwn));
    }

    public Propagator copy(Space home, boolean share) {
        try {
            Constructor ctors[] = this.getClass().getDeclaredConstructors();
            if (this.getClass().getEnclosingClass() == null) {
                for (int i = 0; i < ctors.length; ++i) {
                    Class<?> args[] = ctors[i].getParameterTypes();
                    if (args.length != 3) continue;
                    if (args[0] != Space.class) continue;
                    if (args[1] != Boolean.class) continue;
                    if (args[2] != this.getClass()) continue;
                    ctors[i].setAccessible(true);
                    return (Propagator)ctors[i].newInstance(home, share, this);
                }
            } else {
                throw new FatalException("Nested classes must override " +
                                         "the copy(Space home, boolean share) method");
            }
            throw new NoSuchMethodException();
        } catch(NoSuchMethodException ex) {
            throw new FatalException("No suitable copy-constructor defined for " 
                                     + this.getClass().getName(), ex);
        } catch(InstantiationException ex) {
            throw new FatalException("No suitable copy-constructor defined for " 
                                     + this.getClass().getName(), ex);
        } catch(IllegalAccessException ex) {
            throw new FatalException("No suitable copy-constructor defined for " 
                                     + this.getClass().getName(), ex);
        } catch(InvocationTargetException ex) {
            throw new FatalException("No suitable copy-constructor defined for " 
                                     + this.getClass().getName(), ex);
        }
    }
    public final JavaPropagator copy_internal(JavaSpace home, boolean share) {
        JavaPropagator ret = null;
        try {
            ret = copy(new DummySpace(home.getCPtr(home),
                                      home.swigCMemOwn), share);
        } catch (Throwable e) {
            System.err.println("Exception while copying a propagator:");
            System.err.println(e.getMessage());
            e.printStackTrace();
            System.err.println("Exit.");
            System.exit(2);
        }
        return ret;
    }
    public abstract ExecStatus propagate(Space home);
    public final ExecStatus propagate_internal(JavaSpace home) {
        ExecStatus ret = null;
        try {
            ret = propagate(new DummySpace(home.getCPtr(home),
                                           home.swigCMemOwn));
        } catch (Throwable e) {
            System.err.println("Exception while propagating.");
            System.err.println(e.getMessage());
            e.printStackTrace();
            System.err.println("Exit.");
            System.exit(2);
        }
        return ret;
    }
    public abstract PropCost cost();
    public final PropCost cost_internal() {
        PropCost ret = null;
        try {
            ret = cost();
        } catch (Throwable e) {
            System.err.println("Exception in a propagator:");
            System.err.println(e.getMessage());
            e.printStackTrace();
            System.err.println("Exit.");
            System.exit(2);
        }
        return ret;
    }
    public abstract ExecStatus setup(Space home);
    public final ExecStatus setup_internal(JavaSpace home) {
        ExecStatus ret = null;
        try {
            ret = setup(new DummySpace(home.getCPtr(home),
                                       home.swigCMemOwn));
        } catch (Throwable e) {
            System.err.println("Exception while setting up a propagator:");
            System.err.println(e.getMessage());
            e.printStackTrace();
            System.err.println("Exit.");
            System.exit(2);
        }
        return ret;
    }

    protected ExecStatus t(ModEvent me, ExecStatus es) {
        return me.failed() ? ExecStatus.ES_FAILED : es;
    }

    final protected PropCost cost_lo(int n, PropCost pc) {
        if (n > 3) return pc;
        if (n < 2) return PropCost.PC_UNARY_LO;
        return (n > 2) ? PropCost.PC_TERNARY_LO : PropCost.PC_BINARY_LO;
    }

    final protected PropCost cost_hi(int n, PropCost pc) {
        if (n > 3) return pc;
        if (n < 2) return PropCost.PC_UNARY_HI;
        return (n > 2) ? PropCost.PC_TERNARY_HI : PropCost.PC_BINARY_HI;
    }
}