CEBLParameters.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.combinatorial;
 
import java.io.File;
import java.lang.reflect.Field;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.logging.Level;
 
import denoptim.combinatorial.CEBLUtils;
import denoptim.combinatorial.CheckPoint;
import denoptim.constants.DENOPTIMConstants;
import denoptim.exception.DENOPTIMException;
import denoptim.files.FileFormat;
import denoptim.files.FileUtils;
import denoptim.fitness.FitnessParameters;
import denoptim.graph.DGraph;
import denoptim.io.DenoptimIO;
import denoptim.logging.StaticLogger;
import denoptim.programs.RunTimeParameters;
 
 
public class CEBLParameters extends RunTimeParameters
{
    private String rootGraphsFile = null;
    
    private boolean useGivenRoots = false;
   
    private ArrayList<DGraph> rootGraphs;
 
    private String uidFile = "UID.txt";
 
    private boolean runFitnessTask = false;
 
    private String dbRootDir = ".";
 
    private int numCPU = 1;
 
    private long maxWait = 600000L; //Default 10 min
 
    private long waitStep = 5000L; //Default 5 sec
 
    private int maxLevel = 2;
 
    private int chkptStep = 100;
 
    private CheckPoint chkpt = null;
 
    private String chkptFile = null;
 
    private boolean chkptRestart = false;
 
    private boolean prepareChkAndSerForTests = false;
 
//-----------------------------------------------------------------------------
    
    public CEBLParameters()
    {
        super(ParametersType.CEBL_PARAMS);
    }
 
//-----------------------------------------------------------------------------
 
    public ArrayList<DGraph> getRootGraphs()
    {
        return rootGraphs;
    }
 
//-----------------------------------------------------------------------------
 
    public String getUIDFileName()
    {
        return uidFile;
    }
 
//-----------------------------------------------------------------------------
 
    public boolean submitFitnessTask()
    {
        return runFitnessTask;
    }
 
//-----------------------------------------------------------------------------
 
    public String getDBRoot()
    {
        return dbRootDir;
    }
    
//-----------------------------------------------------------------------------
    
    public void setDBRoot(String pathname)
    {
        this.dbRootDir = pathname;
    }
 
//-----------------------------------------------------------------------------
 
    public int getNumberOfCPU()
    {
        return numCPU;
    }
 
//-----------------------------------------------------------------------------
 
    public long getMaxWait()
    {
        return maxWait;
    }
 
//-----------------------------------------------------------------------------
 
    public long getWaitStep()
    {
        return waitStep;
    }
 
//-----------------------------------------------------------------------------
 
    public int getMaxLevel()
    {
        return maxLevel;
    }
 
//-----------------------------------------------------------------------------
 
    public boolean useGivenRoots()
    {
        return useGivenRoots;
    }
 
//-----------------------------------------------------------------------------
 
    public int getCheckPointStep()
    {
        return chkptStep;
    }
 
//-----------------------------------------------------------------------------
 
    public String getCheckPointName()
    {
        return chkptFile;
    }
 
//-----------------------------------------------------------------------------
 
    public CheckPoint getCheckPoint()
    {
        return chkpt;
    }
 
//-----------------------------------------------------------------------------
 
    public boolean restartFromCheckPoint()
    {
        return chkptRestart;
    }
 
//-----------------------------------------------------------------------------
 
    public boolean prepareFilesForTests()
    {
        return prepareChkAndSerForTests;
    }
 
//-----------------------------------------------------------------------------
 
    public void interpretKeyword(String key, String value)
            throws DENOPTIMException
    {
        String msg = "";
        switch (key.toUpperCase())
        {
        case "WORKDIR=":
            workDir = value;
            break;
        case "ROOTGRAPHS=":
            rootGraphsFile = value;
            useGivenRoots = true;
            break;
        case "UIDFILE=":
            uidFile = value;
            break;
        case "RESTARTFROMCHECKPOINT=":
            chkptFile = value;
            chkptRestart = true;
            break;
        case "DEVEL-PREPAREFILESFORTESTS=":
            prepareChkAndSerForTests = true;
            break;
        case "CHECKPOINTSTEPLENGTH=":
            try
            {
                chkptStep = Integer.parseInt(value);
            }
            catch (Throwable t)
            {
                msg = "Unable to understand value " + key + "'" + value + "'";
                throw new DENOPTIMException(msg);
            }
            break;
        case "DBROOTFOLDER=":
            //NB: this key 'DBROOTFOLDER' is hard coded also in CombinatorialExplorerByLayer
            dbRootDir = value;
            break;
        case "NUMOFPROCESSORS=":
            try
            {
                numCPU = Integer.parseInt(value);
            }
            catch (Throwable t)
            {
                msg = "Unable to understand value " + key + "'" + value + "'";
                throw new DENOPTIMException(msg);
            }
            break;
        case "MAXWAIT=":
            try
            {
                maxWait = Long.parseLong(value, 10) * 1000L;
            }
            catch (Throwable t)
            {
                msg = "Unable to understand value " + key + "'" + value + "'";
                throw new DENOPTIMException(msg);
            }
            break;
        case "WAITSTEP=":
            try
            {
                waitStep = Long.parseLong(value, 10) * 1000L;
            }
            catch (Throwable t)
            {
                msg = "Unable to understand value " + key + "'" + value + "'";
                throw new DENOPTIMException(msg);
            }
            break;
        case "MAXLEVEL=":
            try
            {
                maxLevel = Integer.parseInt(value);
            }
            catch (Throwable t)
            {
                msg = "Unable to understand value " + key + "'" + value + "'";
                throw new DENOPTIMException(msg);
            }
            break;
        case "VERBOSITY=":
            try
            {
                verbosity = Integer.parseInt(value);
            }
            catch (Throwable t)
            {
                msg = "Unable to understand value " + key + "'" + value + "'";
                throw new DENOPTIMException(msg);
            }
            break;
        default:
             msg = "Keyword " + key + " is not a known FragmentSpaceExplorer-" 
                     + "related keyword. Check input files.";
            throw new DENOPTIMException(msg);
        }
    }
 
//-----------------------------------------------------------------------------
 
    public void checkParameters() throws DENOPTIMException
    {
        String msg = "";
 
        if (otherParameters.containsKey(ParametersType.FIT_PARAMS))
        {
            runFitnessTask = true;
        } else {
            // We ensure there is a fitness parameters because we'll take the 
            // logger and default settings from there in GraphBuildingTask
            otherParameters.put(ParametersType.FIT_PARAMS, 
                    new FitnessParameters());
        }
 
        if (!workDir.equals(".") && !FileUtils.checkExists(workDir))
        {
            msg = "Directory '" + workDir + "' not found. Please specify an "
             + "existing directory.";
            throw new DENOPTIMException(msg);
        }
    
        if (!dbRootDir.equals(workDir) && !FileUtils.checkExists(dbRootDir))
        {
            msg = "Directory '" + dbRootDir + "' not found. "
              + "Please specify an existing directory where to put "
                      + "the DB of generated DENOPTIMGraphs.";
           throw new DENOPTIMException(msg);
        }
    
        if (rootGraphsFile != null && !FileUtils.checkExists(rootGraphsFile))
        {
            msg = "File with root graphs not found. Check " + rootGraphsFile;
                throw new DENOPTIMException(msg);
        }
    
        if (numCPU <= 0 )
        {
            msg = "Number of processors (" + numCPU + ") is not valid. "
              + "Setting its value to 1.";
            numCPU = 1;
            StaticLogger.appLogger.info(msg);
        }
 
        if (maxLevel < 0)
        {
            msg = "The maximum level must be larger than zero.";
            throw new DENOPTIMException(msg);
        }
 
        if (chkptFile != null && !FileUtils.checkExists(chkptFile))
        {
            msg = "Checkpoint file " + chkptFile + " not found. ";
            throw new DENOPTIMException(msg);
        }
 
        if (chkptStep < 2)
        {
            msg = "The minimum acceptable value for the number of submitted "
                + "tasks between two checkpoint files is 2. Change your "
                + "input";
            throw new DENOPTIMException(msg);
        }
        
        checkOtherParameters();
    }
 
//----------------------------------------------------------------------------
 
    public void processParameters() throws DENOPTIMException
    {
        if (isMaster)
            createWorkingDirectory();
        
        processOtherParameters();
        
        if (useGivenRoots)
        {
            try
            {
                rootGraphs = DenoptimIO.readDENOPTIMGraphsFromFile(
                        new File(rootGraphsFile));
            }
            catch (Throwable t)
            {
                String msg = "Cannot read root graphs from " + rootGraphsFile;
                throw new Error(msg,t);
            }
        }
    
        if (chkptRestart)
        {
            chkpt = CEBLUtils.deserializeCheckpoint(chkptFile);
        }
        else
        {
            chkpt = new CheckPoint();
            chkptFile = workDir + ".chk";
        }
 
        if (isMaster)
        {
            StaticLogger.appLogger.log(Level.INFO, "Program log file: " 
                    + logFile + DENOPTIMConstants.EOL 
                    + "Output files associated with the current run are "
                    + "located in " + workDir);
        }
    }
    
//------------------------------------------------------------------------------
    
    private void createWorkingDirectory()
    {
        String curDir = workDir;
        String fileSep = System.getProperty("file.separator");
        boolean success = false;
        while (!success)
        {
            SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMddkkmmss");
            String str = "FSE" + sdf.format(new Date());
            workDir = curDir + fileSep + str;
            success = FileUtils.createDirectory(workDir);
        }
        FileUtils.addToRecentFiles(workDir, FileFormat.FSE_RUN);
        if (dbRootDir.equals(".") || dbRootDir.equals(""))
        {
            dbRootDir = workDir;
        }
        logFile = workDir + ".log";
    }
 
//------------------------------------------------------------------------------
 
    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();
    }
 
//----------------------------------------------------------------------------
 
}