1 files changed, 150 insertions, 0 deletions

diff --git a/Solvers/VIATRA-Solver/org.eclipse.viatra.dse/src/org/eclipse/viatra/dse/objectives/impl/BaseObjective.java b/Solvers/VIATRA-Solver/org.eclipse.viatra.dse/src/org/eclipse/viatra/dse/objectives/impl/BaseObjective.java
new file mode 100644
index 00000000..0a1de875
--- /dev/null
+++ b/Solvers/VIATRA-Solver/org.eclipse.viatra.dse/src/org/eclipse/viatra/dse/objectives/impl/BaseObjective.java
@@ -0,0 +1,150 @@
+/*******************************************************************************
+ * Copyright (c) 2010-2015, Andras Szabolcs Nagy, Abel Hegedus, Akos Horvath, Zoltan Ujhelyi and Daniel Varro
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-v20.html.
+ * 
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************/
+package org.eclipse.viatra.dse.objectives.impl;
+
+import java.util.Comparator;
+import java.util.Objects;
+
+import org.eclipse.viatra.dse.base.ThreadContext;
+import org.eclipse.viatra.dse.objectives.Comparators;
+import org.eclipse.viatra.dse.objectives.IObjective;
+
+/**
+ * This abstract class implements the basic functionality of an objective ({@link IObjective} namely its name,
+ * comparator, level and fitness hard constraint.
+ * 
+ * @author Andras Szabolcs Nagy
+ *
+ */
+public abstract class BaseObjective implements IObjective {
+
+    protected final String name;
+    protected Comparator<Double> comparator = Comparators.HIGHER_IS_BETTER;
+    protected int level = 0;
+
+    protected double fitnessConstraint;
+    protected boolean isThereFitnessConstraint = false;
+    protected Comparator<Double> fitnessConstraintComparator;
+
+    public BaseObjective(String name) {
+        Objects.requireNonNull(name, "Name of the objective cannot be null.");
+        this.name = name;
+    }
+
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    @Override
+    public void setComparator(Comparator<Double> comparator) {
+        this.comparator = comparator;
+    }
+
+    @Override
+    public Comparator<Double> getComparator() {
+        return comparator;
+    }
+
+    @Override
+    public void setLevel(int level) {
+        this.level = level;
+    }
+
+    @Override
+    public int getLevel() {
+        return level;
+    }
+
+    public BaseObjective withLevel(int level) {
+        setLevel(level);
+        return this;
+    }
+
+    public BaseObjective withComparator(Comparator<Double> comparator) {
+        setComparator(comparator);
+        return this;
+    }
+
+    /**
+     * Adds a hard constraint on the fitness value. For example, the fitness value must be better than 10 to accept the
+     * current state as a solution.
+     * 
+     * @param fitnessConstraint
+     *            Solutions should be better than this value.
+     * @param fitnessConstraintComparator
+     *            {@link Comparator} to determine if the current state is better than the given value.
+     * @return The actual instance to enable builder pattern like usage.
+     */
+    public BaseObjective withHardConstraintOnFitness(double fitnessConstraint,
+            Comparator<Double> fitnessConstraintComparator) {
+        this.fitnessConstraint = fitnessConstraint;
+        this.fitnessConstraintComparator = fitnessConstraintComparator;
+        this.isThereFitnessConstraint = true;
+        return this;
+    }
+
+    /**
+     * Adds a hard constraint on the fitness value. For example, the fitness value must be better than 10 to accept the
+     * current state as a solution. The provided comparator will be used.
+     * 
+     * @param fitnessConstraint
+     *            Solutions should be better than this value.
+     * @return The actual instance to enable builder pattern like usage.
+     */
+    public BaseObjective withHardConstraintOnFitness(double fitnessConstraint) {
+        return withHardConstraintOnFitness(fitnessConstraint, null);
+    }
+
+    @Override
+    public void init(ThreadContext context) {
+        if (fitnessConstraintComparator == null) {
+            fitnessConstraintComparator = comparator;
+        }   
+    }
+
+    @Override
+    public boolean isHardObjective() {
+        return isThereFitnessConstraint;
+    }
+    
+    @Override
+    public boolean satisifiesHardObjective(Double fitness) {
+        if (isThereFitnessConstraint) {
+            int compare = fitnessConstraintComparator.compare(fitness, fitnessConstraint);
+            if (compare < 0) {
+                return false;
+            }
+        }
+        return true;
+    }
+    
+    @Override
+    public int hashCode() {
+        return name.hashCode();
+    }
+    
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj instanceof BaseObjective) {
+            BaseObjective baseObjective = (BaseObjective) obj;
+            return name.equals(baseObjective.getName());
+        }
+        return false;
+    }
+
+    @Override
+    public String toString() {
+        return name;
+    }
+
+}