archive/plugins/org.eclipse.app4mc.multicore.openmapping/src/org/eclipse/app4mc/multicore/openmapping/algorithms/AbstractILPBasedMappingAlgorithm.java

/*******************************************************************************
 * Copyright (c) 2015, 2020 Dortmund University of Applied Sciences and Arts and others.
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *  
 * SPDX-License-Identifier: EPL-2.0
 *  
 * Contributors:
 *   Dortmund University of Applied Sciences and Arts - initial API and implementation
 *******************************************************************************/

package org.eclipse.app4mc.multicore.openmapping.algorithms;

import org.eclipse.app4mc.multicore.openmapping.OMConstants;
import org.ojalgo.optimisation.ExpressionsBasedModel;

public abstract class AbstractILPBasedMappingAlgorithm extends AbstractMappingAlgorithm {
	private final ExpressionsBasedModel ebm = new ExpressionsBasedModel();
		
	public AbstractILPBasedMappingAlgorithm() {
		int iMaxItAbort, iMaxItSuffice, iMaxTimeAbort, iMaxTimeSuffice;
		final double fMaxGap;

		if ((iMaxItAbort = store.getInt(OMConstants.PRE_MAX_IT_ABORT)) == 0) {
			iMaxItAbort = Integer.MAX_VALUE;
		}
		if ((iMaxTimeAbort = store.getInt(OMConstants.PRE_MAX_TIME_ABORT)) == 0) {
			iMaxTimeAbort = Integer.MAX_VALUE;
		}
		if ((iMaxItSuffice = store.getInt(OMConstants.PRE_MAX_IT_SUFFICE)) == 0) {
			iMaxItSuffice = Integer.MAX_VALUE;
		}
		if ((iMaxTimeSuffice = store.getInt(OMConstants.PRE_MAX_TIME_SUFFICE)) == 0) {
			iMaxTimeSuffice = Integer.MAX_VALUE;
		}
		fMaxGap = store.getDouble(OMConstants.PRE_MAX_GAP);

		setMaxGap(fMaxGap);
		setMaxIterationsAbort(iMaxItAbort);
		setMaxTimeAbort(iMaxTimeAbort);
		setMaxIterationsSuffice(iMaxItSuffice);
		setMaxTimeSuffice(iMaxTimeSuffice);
	}

	/**
	 * Sets the max gap in relation to the LP relaxation, before the solve quits.
	 *
	 * @param gap
	 *            The maximum gap between the found solution and the LP Relaxation solution before the solver quits
	 * @see org.ojalgo.optimisation.Optimisation.Options#mip_gap
	 */
	public void setMaxGap(final double gap) {
		getEbm().options.mip_gap = gap;
	}

	/**
	 * Sets the maximum number of iterations that will be performed in order to improve a feasible solution. Once this
	 * number is reached, the solver will quit.
	 *
	 * @param iterations
	 *            The maximum number of iterations before the solver quits.
	 * @see org.ojalgo.optimisation.Optimisation.Options#mip_gap
	 */
	public void setMaxIterationsSuffice(final int iterations) {
		getEbm().options.iterations_suffice = iterations;
	}

	/**
	 * Sets the maximum total number of iterations before the solver quits.
	 *
	 * @param iterations
	 *            The maximum number of iterations before the solver quits.
	 * @see org.ojalgo.optimisation.Optimisation.Options#iterations_abort
	 */
	public void setMaxIterationsAbort(final int iterations) {
		getEbm().options.iterations_abort = iterations;
	}

	/**
	 * Sets the maximum time the solver will spend on improving a previously found feasible solution. Once this time has
	 * been reached, the solver quits.
	 *
	 * @param time
	 *            The maximum time the solver will spend on improving each of the feasible solutions before it quits.
	 *
	 * @see org.ojalgo.optimisation.Optimisation.Options#time_suffice
	 */
	public void setMaxTimeSuffice(final long time) {
		getEbm().options.time_suffice = time;
	}

	/**
	 * Sets the maximum total time the solver will be executed.
	 *
	 * @param time
	 *            The maximum total time the solver will spend on optimizing the solution.
	 *
	 * @see org.ojalgo.optimisation.Optimisation.Options#time_abort
	 */
	public void setMaxTimeAbort(final long time) {
		getEbm().options.time_abort = time;
	}

	/**
	 * Gets the mathematical Model
	 *
	 * @return ExpressionBasedModel
	 */
	public ExpressionsBasedModel getEbm() {
		return this.ebm;
	}
}