GeneOpsRunnerParameters.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2019 Marco Foscato <marco.foscato@uib.no>
 * 
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Affero General Public License as published
 *   by the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program 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 Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package denoptim.programs.genetweeker;
 
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;
 
import denoptim.exception.DENOPTIMException;
import denoptim.files.FileUtils;
import denoptim.programs.RunTimeParameters;
import denoptim.programs.denovo.GAParameters;
import denoptim.utils.CrossoverType;
import denoptim.utils.MutationType;
 
 
public class GeneOpsRunnerParameters extends RunTimeParameters
{   
    protected enum Operator {MUTATION,XOVER,CROSSOVER}
    
    protected Operator operatorToTest = Operator.XOVER;
 
    protected int[] mutationTarget;
    
    protected int idTargetAP = -1;
    
    protected MutationType mutationType;
    
    protected int idNewVrt = -1;
    
    protected int idNewAP = -1;
    
    protected String inpFileM;
 
    protected String inpFileF;
    
    protected CrossoverType xoverType = CrossoverType.BRANCH;
    
    protected int maxSwappableChainLength = Integer.MAX_VALUE;
 
    protected int[] xoverSrcMale;
    
    protected List<int[]> xoverSubGraphEndMale = new ArrayList<int[]>();
 
    protected int mapid;
 
    protected int[] xoverSrcFemale;
    
    protected List<int[]> xoverSubGraphEndFemale = new ArrayList<int[]>();
 
    protected int fapid;
 
    protected String outFileM;
 
    protected String outFileF;
    
//-----------------------------------------------------------------------------
    
    public GeneOpsRunnerParameters()
    {
        super(ParametersType.GO_PARAMS);
    }
 
//-----------------------------------------------------------------------------
 
    public void interpretKeyword(String key, String value)
            throws DENOPTIMException
    {
        String msg = "";        
        switch (key.toUpperCase())
        {
            case "OP=":
                operatorToTest = Operator.valueOf(value.toUpperCase());
                break;
            case "INPFILE=":
                inpFileM = value;
                break;
            case "OUTFILE=":
                outFileM = value;
                break;
            case "MUTATIONTARGET=":
            {
                String[] parts = value.split(",");
                mutationTarget = new int[parts.length];
                for (int i=0; i<parts.length; i++)
                {
                    mutationTarget[i] = Integer.parseInt(parts[i].trim());
                }
                break;
            }
            case "APIDONTARGETVERTEX=":
                idTargetAP = Integer.parseInt(value);
                break;
            case "MUTATIONTYPE=":
                mutationType = MutationType.valueOf(value);
                break;
            case "NEWVERTEXMOLID=":
                idNewVrt = Integer.parseInt(value);
                break;
            case "NEWAPID=":
                idNewAP = Integer.parseInt(value);
                break;
            case "WORKDIR=":
                workDir = value;
                break;
            case "INPFILEMALE=":
                inpFileM = value;
                break;
            case "INPFILEFEMALE=":
                inpFileF = value;
                break;
            case "VERTEXMALE=":
            {
                String[] parts = value.split(",");
                xoverSrcMale = new int[parts.length];
                for (int i=0; i<parts.length; i++)
                {
                    xoverSrcMale[i] = Integer.parseInt(parts[i].trim());
                }
                break;
            }
            case "SUBGRAPHENDMALE=":
            {
                String[] parts = value.split(",");
                int[] idList = new int[parts.length];
                for (int i=0; i<parts.length; i++)
                {
                    idList[i] = Integer.parseInt(parts[i].trim());
                }
                xoverSubGraphEndMale.add(idList);
                break;
            }
            case "SUBGRAPHENDFEMALE=":
            {
                String[] parts = value.split(",");
                int[] idList = new int[parts.length];
                for (int i=0; i<parts.length; i++)
                {
                    idList[i] = Integer.parseInt(parts[i].trim());
                }
                xoverSubGraphEndFemale.add(idList);
                break;
            }
            case "APMALE=":
                mapid = Integer.parseInt(value);
                break;
            case "XOVERTYPE=":
                xoverType = CrossoverType.valueOf(value);
                break;
            case "CROSSOVERTYPE=":
                xoverType = CrossoverType.valueOf(value);
                break;
            case "VERTEXFEMALE=":
            {
                String[] parts = value.split(",");
                xoverSrcFemale = new int[parts.length];
                for (int i=0; i<parts.length; i++)
                {
                    xoverSrcFemale[i] = Integer.parseInt(parts[i].trim());
                }
                break;
            }
            case "APFEMALE=":
                fapid = Integer.parseInt(value);
                break;
            case "OUTFILEMALE=":
                outFileM = value;
                break;
            case "OUTFILEFEMALE=":
                outFileF = value;
                break;
            default:
                 msg = "Keyword " + key + " is not a known TestOperator-"
                                       + "related keyword. Check input files.";
                 throw new DENOPTIMException(msg);
        }
    }
 
//-----------------------------------------------------------------------------
 
    public void checkParameters() throws DENOPTIMException
    {
        String msg = "";
        if (!workDir.equals(".") && !FileUtils.checkExists(workDir))
        {
           msg = "Directory " + workDir + " not found. Please specify an "
             + "existing directory.";
           throw new DENOPTIMException(msg);
        }
 
        if (!FileUtils.checkExists(inpFileM))
        {
            msg = "Input file '" + inpFileM + "' not found.";
            throw new DENOPTIMException(msg);
        }
 
        if (operatorToTest == Operator.XOVER
                && !FileUtils.checkExists(inpFileF))
        {
            msg = "Input file '" + inpFileF + "' not found.";
            throw new DENOPTIMException(msg);
        }
 
        checkOtherParameters();
    }
 
//----------------------------------------------------------------------------
 
    public void processParameters() throws DENOPTIMException
    {
        if (!this.containsParameters(ParametersType.GA_PARAMS))
        {
            GAParameters gaPars = new GAParameters();
            setParameters(gaPars);
        }
        processOtherParameters();
    }
    
//------------------------------------------------------------------------------
 
    public String getPrintedList()
    {
        StringBuilder sb = new StringBuilder(1024);
        sb.append(" " + paramTypeName() + " ").append(NL);
        for (Field f : this.getClass().getDeclaredFields()) 
        {
            try
            {
                sb.append(f.getName()).append(" = ").append(
                            f.get(this)).append(NL);
            }
            catch (Throwable t)
            {
                sb.append("ERROR! Unable to print " + paramTypeName() 
                        + " parameters. Cause: " + t);
                break;
            }
        }
        for (RunTimeParameters otherCollector : otherParameters.values())
        {
            sb.append(otherCollector.getPrintedList());
        }
        return sb.toString();
    }
 
//----------------------------------------------------------------------------
 
}