GAParameters.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2019 Vishwesh Venkatraman <vishwesh.venkatraman@ntnu.no> and
 *   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.denovo;
 
import java.lang.reflect.Field;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.logging.Level;
 
import denoptim.constants.DENOPTIMConstants;
import denoptim.exception.DENOPTIMException;
import denoptim.files.FileFormat;
import denoptim.graph.rings.RingClosureParameters;
import denoptim.logging.Monitor;
import denoptim.logging.StaticLogger;
import denoptim.programs.RunTimeParameters;
import denoptim.programs.RunTimeParameters.ParametersType;
import denoptim.utils.MutationType;
 
 
public class GAParameters extends RunTimeParameters
{
    public String timeStamp = "NOTIMESTAMP";
    
    private String dataDir = System.getProperty("user.dir");
    
    private String interfaceDir = dataDir 
            + System.getProperty("file.separator") + "interface";
 
    protected String initPoplnFile = "";
    
    protected String initMolsToFragmentFile = null;
    
    protected String uidFileIn = "";
 
    protected String uidFileOut = "";
    
    private String monitorFile = "";
    
    private boolean recordMateSelection = false;
 
    private final String DEFUIDFILEOUTNAME = "MOLUID.txt";
 
    protected String visitedGraphsFile = "GRAPHS.txt";
 
    protected int populationSize = 50;
 
    protected int numOfChildren = 5;
 
    protected int numConvGen = 5;
 
    protected int numGenerations = 100;
 
    protected int maxTriesPerPop = 25;
    
    protected int maxGeneticOpAttempts = 100;
 
    protected int replacementStrategy = 1;
    
    protected boolean parentsSurvive = true;
 
    protected int lvlGrowthProbabilityScheme = 0;
 
    protected double lvlGrowthMultiplier = 0.5;
 
    protected double lvlGrowthSigmaSteepness = 1.0;
 
    protected double lvlGrowthSigmaMiddle = 2.5;
    
    protected boolean useLevelBasedProb = false;
    
    protected boolean useMolSizeBasedProb = false;
    
    protected int molGrowthProbabilityScheme = 2;
 
    protected double molGrowthMultiplier = 0.5;
 
    protected double molGrowthSigmaSteepness = 0.2;
 
    protected double molGrowthSigmaMiddle = 25;
    
    protected int crowdingProbabilityScheme = 3;
 
    protected double crowdingMultiplier = 0.5;
 
    protected double crowdingSigmaSteepness = 1.0;
 
    protected double crowdingSigmaMiddle = 2.5;
 
    protected double symmetricSubProbability = 0.8;
    
    protected double mutationWeight = 1.0;
    
    protected boolean coupleMutationAndCrossover = false;
    
    protected double builtAnewWeight = 1.0;
    
    protected double crossoverWeight = 1.0;
 
    protected int xoverSelectionMode = 3;
 
    protected String strXoverSelectionMode = xoverSelectionMode+"";
    
    protected int selectivePressure = -1;
    
    protected int maxOffsprintFromXover = 1;
    
    protected boolean keepBestSibling = false;
 
    List<MutationType> excludedMutationTypes = new ArrayList<MutationType>();
    
    protected long seed = 0L;
   
    protected int parallelizationScheme = 1;
 
    protected int numParallelTasks = 0;
 
    protected boolean sortOrderDecreasing = true;
 
    protected boolean nanFitnessKillsExperiment = false;
 
    protected int precisionLevel = 3;
 
    protected int monitorDumpStep = 50;
    
    protected boolean dumpMonitor = false;
    
    protected double minFitnessSD = 0.000001;
    
    protected int maxRingsAddedByMutation = 1;
    
    protected boolean saveRingSystemsAsTemplatesScaffolds = false;
    
    protected boolean saveRingSystemsAsTemplatesNonScaff = false;
 
    protected double saveRingSystemsFitnessThreshold = 0.10;
 
    private double[] mutliSiteMutationWeights = new double[]{0,10,1};
 
    public int maxUIDMemory = 1000000;
 
    public String uidMemoryOnDisk = "memory_UIDs.txt";
    
    public boolean mutatedGraphFailedEvalTolerant = true;
    
    public boolean xoverGraphFailedEvalTolerant = true;
    
    public boolean xoverFailureTolerant = true;
    
    public boolean mutationFailureTolerant = true;
    
    public boolean buildAnewFailureTolerant = true;
    
    public int maxXOverableSubGraphSize = 20;
    
    protected boolean writePopOnDisk = false;
 
//------------------------------------------------------------------------------
    
    public GAParameters()
    {
        super(ParametersType.GA_PARAMS);
    }
 
//------------------------------------------------------------------------------
 
    public String getUIDFileIn()
    {
        return uidFileIn;
    }
 
//------------------------------------------------------------------------------
 
    public String getUIDFileOut()
    {
        return uidFileOut;
    }
 
//------------------------------------------------------------------------------
 
    public String getVisitedGraphsFile()
    {
        return visitedGraphsFile;
    }
    
//------------------------------------------------------------------------------
    
    public String getInterfaceDir()
    {
        return interfaceDir;
    }
    
//------------------------------------------------------------------------------
 
    public String getMonitorFile()
    {
        return monitorFile;
    }
    
//------------------------------------------------------------------------------
    
    public int getMonitorDumpStep()
    {
        return monitorDumpStep;
    }
  
//------------------------------------------------------------------------------
 
    public boolean recordMateSelection()
    {
        return recordMateSelection;
    } 
 
//------------------------------------------------------------------------------
 
    public int getPrecisionLevel()
    {
        return precisionLevel;
    }
    
//------------------------------------------------------------------------------
 
    public int getNumberOfCPU()
    {
        return numParallelTasks;
    }    
 
//------------------------------------------------------------------------------
 
    public boolean isSortOrderDecreasing()
    {
        return sortOrderDecreasing;
    }   
 
//------------------------------------------------------------------------------
 
    public boolean isNanFitnessKillsExperiment()
    {
        return nanFitnessKillsExperiment;
    }
    
//------------------------------------------------------------------------------
 
    public int getMaxTriesFactor()
    {
        return maxTriesPerPop;
    }
    
//------------------------------------------------------------------------------
 
    public int getMaxGeneticOpAttempts()
    {
        return maxGeneticOpAttempts;
    }
 
//------------------------------------------------------------------------------
 
    public String getDataDirectory()
    {
        return dataDir;
    }
    
//------------------------------------------------------------------------------
    
    public void setWorkingDirectory(String pathName)
    {
        dataDir = pathName;
        monitorFile = dataDir + ".eaMonitor";
        interfaceDir = pathName + DENOPTIMConstants.FSEP + "interface";
        
        logFile = dataDir + ".log";
 
        if (uidFileOut.equals(""))
        {
            uidFileOut = dataDir + DENOPTIMConstants.FSEP + DEFUIDFILEOUTNAME;
        }
    }
 
//------------------------------------------------------------------------------
 
    public int getReplacementStrategy()
    {
        return replacementStrategy;
    }
    
//------------------------------------------------------------------------------
    
    public boolean parentsSurvive()
    {
        return parentsSurvive;
    }
 
//------------------------------------------------------------------------------
 
    public double getCrowdingFactorSteepSigma()
    {
        return crowdingSigmaSteepness;
    }
 
//------------------------------------------------------------------------------
 
    public double getCrowdingFactorMiddleSigma()
    {
        return crowdingSigmaMiddle;
    }
 
//------------------------------------------------------------------------------
 
    public double getCrowdingMultiplier()
    {
        return crowdingMultiplier;
    }
 
//------------------------------------------------------------------------------
 
    public int getCrowdingProbabilityScheme()
    {
        return crowdingProbabilityScheme;
    }
    
//------------------------------------------------------------------------------
 
    public double getGrowthFactorSteepSigma()
    {
        return lvlGrowthSigmaSteepness;
    }
 
//------------------------------------------------------------------------------
 
    public double getGrowthFactorMiddleSigma()
    {
        return lvlGrowthSigmaMiddle;
    }
 
//------------------------------------------------------------------------------
 
    public double getGrowthMultiplier()
    {
        return lvlGrowthMultiplier;
    }
 
//------------------------------------------------------------------------------
 
    public int getGrowthProbabilityScheme()
    {
        return lvlGrowthProbabilityScheme;
    }
    
//------------------------------------------------------------------------------
 
    public double getMolGrowthFactorSteepSigma()
    {
        return molGrowthSigmaSteepness;
    }
 
//------------------------------------------------------------------------------
 
    public double getMolGrowthFactorMiddleSigma()
    {
        return molGrowthSigmaMiddle;
    }
 
//------------------------------------------------------------------------------
 
    public double getMolGrowthMultiplier()
    {
        return molGrowthMultiplier;
    }
 
//------------------------------------------------------------------------------
 
    public int getMolGrowthProbabilityScheme()
    {
        return molGrowthProbabilityScheme;
    }
 
//------------------------------------------------------------------------------
 
    public void setPopulationSize(int size)
    {
        populationSize = size;
    }
    
//------------------------------------------------------------------------------
 
    public int getPopulationSize()
    {
        return populationSize;
    }
 
//------------------------------------------------------------------------------
 
    public int getNumberOfGenerations()
    {
        return numGenerations;
    }
 
//------------------------------------------------------------------------------
 
    public String getSelectionStrategy()
    {
        return strXoverSelectionMode;
    }
    
 //------------------------------------------------------------------------------
 
    public int getSelectivePressure()
    {
        return selectivePressure;
    }
    
//------------------------------------------------------------------------------
    
    public List<MutationType> getExcludedMutationTypes()
    {
        return excludedMutationTypes;
    }
 
//------------------------------------------------------------------------------
 
    public int getSelectionStrategyType()
    {
        return xoverSelectionMode;
    }
 
//------------------------------------------------------------------------------
 
    public int getNumberOfConvergenceGenerations()
    {
        return numConvGen;
    }
 
//------------------------------------------------------------------------------
 
    public int getNumberOfChildren()
    {
        return numOfChildren;
    }
    
//------------------------------------------------------------------------------
    
    public double getCrossoverWeight()
    {
        return crossoverWeight;
    }
    
//------------------------------------------------------------------------------
    
    public int maxOffsprintFromXover()
    {
        return maxOffsprintFromXover;
    }
    
//------------------------------------------------------------------------------
    
    public boolean keepBestSibling()
    {
        return keepBestSibling;
    }
 
//------------------------------------------------------------------------------
 
    public double getMutationWeight()
    {
        return mutationWeight;
    }
    
//------------------------------------------------------------------------------
 
    public double getConstructionWeight()
    {
        return builtAnewWeight;
    }
 
//------------------------------------------------------------------------------
 
    public double getSymmetryProbability()
    {
        return symmetricSubProbability;
    }
    
//------------------------------------------------------------------------------
 
    public String getInitialPopulationFile()
    {
        return initPoplnFile;
    }
    
//------------------------------------------------------------------------------
    
    public String getInitMolsToFragmentFile()
    {
        return initMolsToFragmentFile;
    }
 
//------------------------------------------------------------------------------
      
    public double[] getMultiSiteMutationWeights()
    {
        return mutliSiteMutationWeights;
    }
 
//------------------------------------------------------------------------------
   
    public boolean useMolSizeBasedProb()
    {
        return useMolSizeBasedProb;
    }
    
//------------------------------------------------------------------------------
   
    public boolean useLevelBasedProb()
    {
        return useLevelBasedProb;
    }
    
//-----------------------------------------------------------------------------
    
    public int getParallelizationScheme()
    {
        return parallelizationScheme;
    }
    
//-----------------------------------------------------------------------------
    
    public double getMinFitnessSD()
    {
        return minFitnessSD;
    }
    
//-----------------------------------------------------------------------------
    
    public boolean dumpMonitor()
    {
        return dumpMonitor;
    }
    
//-----------------------------------------------------------------------------
    
    public double getSaveRingSystemsFitnessThreshold()
    {
        return saveRingSystemsFitnessThreshold;
    }
    
//-----------------------------------------------------------------------------
    
    public boolean getSaveRingSystemsAsTemplatesNonScaff()
    {
        return saveRingSystemsAsTemplatesNonScaff;
    }
    
//-----------------------------------------------------------------------------
    
    public boolean getSaveRingSystemsAsTemplatesScaff()
    {
        return saveRingSystemsAsTemplatesScaffolds;
    }
    
//-----------------------------------------------------------------------------
 
    public boolean coupleMutationAndCrossover()
    {
        return coupleMutationAndCrossover;
    }
 
//------------------------------------------------------------------------------
 
    public void interpretKeyword(String key, String value)
                                                      throws DENOPTIMException
    {
        String msg = "";
        switch (key.toUpperCase())
        {
            case "VERBOSITY=":
            {
                verbosity = Integer.parseInt(value);
                break;
            }
            
            case "NUMPARALLELTASKS=":
            {
                if (value.length() > 0)
                {
                    numParallelTasks = Integer.parseInt(value);
                }
                break;
            }
            
            case "PARALLELIZATION=":
            {
                switch (value.toUpperCase())
                {
                    case "SYNCHRONOUS":
                        parallelizationScheme = 1;
                        break;
                    case "ASYNCHRONOUS":
                        parallelizationScheme = 2;
                        break;
                    default:
                        throw new DENOPTIMException("Unknown parallelization scheme.");
                }
                break;
            }
        
            case "PRECISIONLEVEL=":
            {
                if (value.length() > 0)
                {
                    precisionLevel = Integer.parseInt(value);
                }
                break;
            }
        
            case "UIDFILEIN=":
            {
                if (value.length() > 0)
                {
                    uidFileIn = value;
                }
                break;
            }
        
            case "UIDFILEOUT=":
            {
                if (value.length() > 0)
                {
                    uidFileOut = value;
                }
                break;
            }
            
            case "MONITORFILE=":
            {
                if (value.length() > 0)
                {
                    monitorFile = value;
                }
                break;
            }
            
            case "RECORDMATESELECTION=":
            {
                if (value.length() > 0)
                {
                    recordMateSelection = readYesNoTrueFalse(value);
                }
                break;
            }
            
            case "MONITORDUMPSTEP=":
            {
                if (value.length() > 0)
                {
                    monitorDumpStep = Integer.parseInt(value);
                    dumpMonitor = true;
                }
                break;
            }
            
            case "RANDOMSEED=":
            {
                if (value.length() > 0)
                {
                    seed = Long.parseLong(value);
                }
                break;
            }
            
            case "MAXTRIESPERPOPULATION=":
            {
                if (value.length() > 0)
                    maxTriesPerPop  = Integer.parseInt(value);
                break;
            }
            
            case "MAXGENETICOPSATTEMPTS=":
            {
                if (value.length() > 0)
                    maxGeneticOpAttempts  = Integer.parseInt(value);
                break;
            }
        
            case "INITPOPLNFILE=":
            {
                if (value.length() > 0)
                {
                    initPoplnFile = value;
                }
                break;
            }
            
            case "INITMOLSTOFRAGMENTFILE=":
            {
                if (value.length() > 0)
                {
                    initMolsToFragmentFile = value;
                }
                break;
            }
        
            case "SORTBYINCREASINGFITNESS":
            {
                sortOrderDecreasing = false;
                break;
            }
            
            case "NANFITNESSKILLSEXPERIMENT":
            {
                nanFitnessKillsExperiment = true;
            }
        
            case "LEVELGROWTHMULTIPLIER=":
            {
                if (value.length() > 0)
                {
                    lvlGrowthMultiplier = Double.parseDouble(value);
                    useLevelBasedProb = true;
                }
                break;
            }
        
            case "LEVELGROWTHSIGMASTEEPNESS=":
            {
                if (value.length() > 0)
                {
                    lvlGrowthSigmaSteepness = Double.parseDouble(value);
                    useLevelBasedProb = true;
                }
                break;
            }
        
            case "LEVELGROWTHSIGMAMIDDLE=":
            {
                if (value.length() > 0)
                {
                    lvlGrowthSigmaMiddle = Double.parseDouble(value);
                    useLevelBasedProb = true;
                }
                break;
            }
        
            case "LEVELGROWTHPROBSCHEME=":
            {
                lvlGrowthProbabilityScheme = convertProbabilityScheme(value);
                useLevelBasedProb = true;
                break;
            }
            
            case "MOLGROWTHMULTIPLIER=":
            {
                if (value.length() > 0)
                {
                    molGrowthMultiplier = Double.parseDouble(value);
                    useMolSizeBasedProb = true;
                }
                break;
            }
        
            case "MOLGROWTHSIGMASTEEPNESS=":
            {
                if (value.length() > 0)
                {
                    molGrowthSigmaSteepness = Double.parseDouble(value);
                    useMolSizeBasedProb = true;
                }
                break;
            }
        
            case "MOLGROWTHSIGMAMIDDLE=":
            {
                if (value.length() > 0)
                {
                    molGrowthSigmaMiddle = Double.parseDouble(value);
                    useMolSizeBasedProb = true;
                }
                break;
            }
        
            case "MOLGROWTHPROBSCHEME=":
            {
                molGrowthProbabilityScheme = convertProbabilityScheme(value);
                useMolSizeBasedProb = true;
                break;
            }
            
            case "CROWDMULTIPLIER=":
            {
                if (value.length() > 0)
                {
                    crowdingMultiplier = Double.parseDouble(value);
                }
                break;
            }
        
            case "CROWDSIGMASTEEPNESS=":
            {
                if (value.length() > 0)
                {
                    crowdingSigmaSteepness = Double.parseDouble(value);
                }
                break;
            }
        
            case "CROWDSIGMAMIDDLE=":
            {
                if (value.length() > 0)
                {
                    crowdingSigmaMiddle = Double.parseDouble(value);
                }
                break;
            }
            
            case "SYMMETRYPROBABILITY=":
            {
                if (value.length() > 0)
                {
                    symmetricSubProbability = Double.parseDouble(value);
                }
                break;
            }
        
            case "CROWDPROBSCHEME=":
            {
                crowdingProbabilityScheme = convertProbabilityScheme(value);
                break;
            }
        
            case "NUMGENERATIONS=":
            {
                if (value.length() > 0)
                {
                    numGenerations = Integer.parseInt(value);
                }
                break;
            }
        
            case "NUMCHILDREN=":
            {
                if (value.length() > 0)
                {
                    numOfChildren = Integer.parseInt(value);
                }
                break;
            }
        
            case "CROSSOVERWEIGHT=":
            {
                if (value.length() > 0)
                {
                    crossoverWeight = Double.parseDouble(value);
                }
                break;
            }
        
            case "MUTATIONWEIGHT=":
            {
                if (value.length() > 0)
                {
                    mutationWeight = Double.parseDouble(value);
                }
                break;
            }
            
            case "COUPLEMUTATIONTOCROSSOVER=":
            {
                if (value.length() > 0)
                {
                    coupleMutationAndCrossover = readYesNoTrueFalse(value);
                }
                break;
            }
            
            case "PARENTSSURVIVE=":
            {
                if (value.length() > 0)
                {
                    parentsSurvive = readYesNoTrueFalse(value);
                }
                break;
            }
            
            case "EXCLUDEMUTATIONTYPE=":
            {
                if (value.length() > 0)
                {
                    excludedMutationTypes.add(MutationType.valueOf(value));
                }
                break;
            }
            
            case "CONSTRUCTIONWEIGHT=":
            {
                if (value.length() > 0)
                {
                    builtAnewWeight = Double.parseDouble(value);
                }
                break;
            }
            
            case "REPLACEMENTSTRATEGY=":
            {
                switch (value.toUpperCase())
                {
                    case "NONE":
                        replacementStrategy = 2;
                        break;
                    case "ELITIST":
                        replacementStrategy = 1;
                        break;
                    default:
                        throw new DENOPTIMException("Unknown replacement strategy.");
                }
                break;
            }
        
            case "POPULATIONSIZE=":
            {
                if (value.length() > 0)
                {
                    populationSize = Integer.parseInt(value);
                }
                break;
            }
        
            case "NUMCONVGEN=":
            {
                if (value.length() > 0)
                {
                    numConvGen = Integer.parseInt(value);
                }
                break;
            }
            
            case "MAXRINGSADDEDBYMUTATION=":
            {
                if (value.length() > 0)
                {
                    maxRingsAddedByMutation = Integer.parseInt(value);
                }
                break;
            }
            
            case "KEEPNEWRINGSYSTEMVERTEXES":
            {
                saveRingSystemsAsTemplatesNonScaff = true;
                break;
            }
            
            case "KEEPNEWRINGSYSTEMSCAFFOLDS":
            {
                saveRingSystemsAsTemplatesScaffolds = true;
                break;
            }
            
            case "KEEPNEWRINGSYSTEMFITNESSTRSH=":
            {
                if (value.length() > 0)
                {
                    saveRingSystemsFitnessThreshold = Double.parseDouble(value);
                }
                break;
            }
            
            case "MULTISITEMUTATIONWEIGHTS=":
            {
                String[] ws = value.split(",|\\s+");
                List<Double> lst = new ArrayList<Double>();
                for (String w : ws)
                {
                    if (!w.trim().equals(""))
                        lst.add(Double.parseDouble(w));
                }
                mutliSiteMutationWeights = new double[lst.size()];
                for (int i=0; i<lst.size(); i++)
                {
                    mutliSiteMutationWeights[i] = lst.get(i);
                }
                break;
            }
        
            case "XOVERSELECTIONMODE=":
            {
                if (value.length() > 0)
                {
                    xoverSelectionMode = -1;
                    if (value.compareToIgnoreCase("TS") == 0)
                    {
                        xoverSelectionMode = 1;
                        strXoverSelectionMode = "TOURNAMENT";
                    } else if (value.compareToIgnoreCase("RW") == 0)
                    {
                        xoverSelectionMode = 2;
                        strXoverSelectionMode = "ROULETTE WHEEL";
                    } else if (value.compareToIgnoreCase("SUS") == 0)
                    {
                        xoverSelectionMode = 3;
                        strXoverSelectionMode = "STOCHASTIC UNIVERSAL SAMPLING";
                    } else if (value.compareToIgnoreCase("RANDOM") == 0)
                    {
                        xoverSelectionMode = 4;
                        strXoverSelectionMode = "RANDOM";
                    } else {
                        throw new DENOPTIMException("ERROR! String '"
                                + value + "' cannot be interpreted as a "
                                + "parent selection strategy.");
                    }
                }
                break;
            }
            
            case "SELECTIVEPRESSURE=":
            {
                if (value.length() > 0)
                {
                    selectivePressure = Integer.parseInt(value);
                }
                break;
            }
            
            
            case "NUMOFFSPRINGFROMXOVER=":
            {
                if (value.length() > 0)
                {
                    maxOffsprintFromXover = Integer.parseInt(value);
                    if (maxOffsprintFromXover>2)
                        throw new DENOPTIMException("ERROR! Can only generate "
                                + "up to 2 offspring from crossover, but you "
                                + "required " + maxOffsprintFromXover);
                }
                break;
            }
            
            case "KEEPBESTSIBLING=":
            {
                keepBestSibling = readYesNoTrueFalse(value);
                break;
            }
            
            case "MUTATEDGRAPHCHECKFAILTOLERANT=":
            {
                mutatedGraphFailedEvalTolerant = readYesNoTrueFalse(value);
                break;
            }
            
            case "XOVERGRAPHCHECKFAILTOLERANT=":
            {
                xoverGraphFailedEvalTolerant = readYesNoTrueFalse(value);
                break;
            }
            
            case "MUTATIONFAILURETOLERANT=":
            {
                mutationFailureTolerant = readYesNoTrueFalse(value);
                break;
            }
            
            case "XOVERFAILURETOLERANT=":
            {
                xoverFailureTolerant = readYesNoTrueFalse(value);
                break;
            }
            
            case "BUILDFAILURETOLERANT=":
            {
                buildAnewFailureTolerant = readYesNoTrueFalse(value);
                break;
            }
            
            case "MAXXOVERSUBGRAPHSIZE=":
            {
                if (value.length() > 0)
                {
                    maxXOverableSubGraphSize = Integer.parseInt(value);
                }
                break;
            }
            
            case "WRITEPOPULATIONTOFILE":
            {
                writePopOnDisk = true;
                break;
            }
            
            default:
                msg = "Keyword " + key + " is not a known GeneticAlgorithm-" 
                        + "related keyword. Check input files.";
               throw new DENOPTIMException(msg);
        }
    }
    
//------------------------------------------------------------------------------
    
    public static int convertProbabilityScheme(String option) 
            throws DENOPTIMException 
    {
        int res = 0;
        switch (option.toUpperCase())
        {
            case "EXP_DIFF":
                res = 0;
                break;
            case "TANH":
                res = 1;
                break;
            case "SIGMA":
                res = 2;
                break;
            case "UNRESTRICTED":
                res = 3;
                break;
            default:
                throw new DENOPTIMException(
                        "Unknown growth probability scheme.");
        }
        return res;
    }
    
//-----------------------------------------------------------------------------
 
    private void createWorkingDirectory() throws DENOPTIMException
    {
        String cdataDir = dataDir;
        boolean success = false;
        while (!success)
        {
            SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMddkkmmss");
            timeStamp = sdf.format(new Date());
            String str = "RUN" + timeStamp;
            dataDir = cdataDir + DENOPTIMConstants.FSEP + str;
            success = denoptim.files.FileUtils.createDirectory(dataDir);
        }
        setWorkingDirectory(dataDir);
        if (!denoptim.files.FileUtils.createDirectory(interfaceDir))
        {
            throw new DENOPTIMException("ERROR! Unable to make interface "
                    + "folder '" + interfaceDir + "'");
        }
        denoptim.files.FileUtils.addToRecentFiles(dataDir, FileFormat.GA_RUN);
    }
 
//------------------------------------------------------------------------------
 
    public void processParameters() throws DENOPTIMException
    {
        if (isMaster)
            createWorkingDirectory();
 
        if (seed == 0)
        {
            startRandomizer();
            seed = getRandomSeed();
        } else {
            startRandomizer(seed);
        }
 
        int nproc = Runtime.getRuntime().availableProcessors();
        if (numParallelTasks == 0)
        {
            numParallelTasks = nproc;
        }
        
        if (selectivePressure<0)
            selectivePressure = (int) Math.round(populationSize * 0.2);
        
        processOtherParameters();
        
        if (containsParameters(ParametersType.RC_PARAMS))
        {
            RingClosureParameters rcParams = (RingClosureParameters) 
                    getParameters(ParametersType.RC_PARAMS);
            if (!rcParams.allowRingClosures())
            {
                excludedMutationTypes.add(MutationType.ADDRING);
                excludedMutationTypes.add(MutationType.ADDFUSEDRING);
            }
        }
        
        if (isMaster)
        {    
            StaticLogger.appLogger.log(Level.INFO, "Program log file: " 
                    + logFile + DENOPTIMConstants.EOL 
                    + "Output files associated with the current run are "
                    + "located in " + dataDir);
        }
    }
 
//------------------------------------------------------------------------------
 
    public void checkParameters() throws DENOPTIMException
    {
        String error = "";
        //TODO: use something like the following for checking the parameters:
        //ensureIsPositive("GA-NUMOFFSPRING", numOfChildren, "blabla");
        if (numOfChildren <= 0)
        {
            error = "Number of children must be a positive number.";
            throw new DENOPTIMException(error);
        }
        if (numGenerations <= 0)
        {
            error = "Number of generations must be a positive number.";
            throw new DENOPTIMException(error);
        }
        
        if (numConvGen <= 0)
        {
            error = "Number of convergence iterations must be a positive "
                    + "number.";
            throw new DENOPTIMException(error);
        }
        
        if (symmetricSubProbability < 0. ||
                            symmetricSubProbability > 1.)
        {
            error = "Symmetric molecule probability must be between 0 and 1.";
            throw new DENOPTIMException(error);
        }
        
        if (mutationWeight < 0.)
        {
            error = "Weight of mutation must be a positive number";
            throw new DENOPTIMException(error);
        }
        
        if (crossoverWeight < 0.)
        {
            error = "Weight of crossover must be a positive number";
            throw new DENOPTIMException(error);
        }
        
        if (builtAnewWeight < 0.)
        {
            error = "Weight of construction must be a positive number";
            throw new DENOPTIMException(error);
        }
 
        if (initPoplnFile.length() > 0)
        {
            if (!denoptim.files.FileUtils.checkExists(initPoplnFile))
            {
                error = "Cannot find initial population data: " + initPoplnFile;
                throw new DENOPTIMException(error);
            }
        }
        
        if (initMolsToFragmentFile!=null && initMolsToFragmentFile.length() > 0)
        {
            if (!denoptim.files.FileUtils.checkExists(initMolsToFragmentFile))
            {
                throw new DENOPTIMException("Cannot find initial molecules to "
                        + "fragment: " + initMolsToFragmentFile);
            }
        }
 
        if (replacementStrategy < 0 || replacementStrategy > 2)
        {
            error = "Allowed values for replacementStrategy (1-2)";
            throw new DENOPTIMException(error);
        }
        
        if (useMolSizeBasedProb && useLevelBasedProb)
        {
            error = "Cannot use both graph level or molecular size as criterion "
                    + "for controlling the growth of graphs. "
                    + "Please, use either of them.";
            throw new DENOPTIMException(error);
        } else if (!useMolSizeBasedProb && !useLevelBasedProb) {
            useMolSizeBasedProb = true;
        }
        checkOtherParameters();
    }
    
//------------------------------------------------------------------------------
 
    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();
    }
    
//------------------------------------------------------------------------------
    
    public boolean savePopFile()
    {
        return writePopOnDisk;
    }
 
//------------------------------------------------------------------------------
 
    public int getMaxRingsAddedByMutation()
    {
        return maxRingsAddedByMutation;
    }
 
//------------------------------------------------------------------------------
 
}