FitnessParameters.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.fitness;
 
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;
 
public class FitnessParameters extends RunTimeParameters
{
    private boolean useExternalFitness = true;
 
    private String externalExe = "";
 
    private String interpreterExternalExe = "bash";
 
    private String fitnessExpression = "";
    
    private List<String> customVarDescExpressions = 
            new ArrayList<String>();
    
    private List<DescriptorForFitness> descriptors = 
            new ArrayList<DescriptorForFitness>();
    
    private boolean makePictures = false;
    
    private boolean make3DTrees = true;
    
    private boolean checkPreFitnessUID = true;
    
    private boolean checkPreFitnessUIDFromInput = false;
    
    private boolean writeCandidatesOnDisk = true;
    
    
//------------------------------------------------------------------------------
 
    public FitnessParameters()
    {
        super(ParametersType.FIT_PARAMS);
    }
 
//------------------------------------------------------------------------------
 
    public boolean useExternalFitness()
    {
        return useExternalFitness;
    }
    
//------------------------------------------------------------------------------
 
    public boolean makePictures()
    {
        return makePictures;
    }
    
//------------------------------------------------------------------------------
    
    public boolean make3dTree()
    {
        return make3DTrees;
    }
 
//------------------------------------------------------------------------------
    
    public boolean checkPreFitnessUID()
    {
        return checkPreFitnessUID;
    }
    
//------------------------------------------------------------------------------
 
    public String getExternalFitnessProvider()
    {
        return externalExe;
    }
    
//------------------------------------------------------------------------------
 
    public String getExternalFitnessProviderInterpreter()
    {
        return interpreterExternalExe;
    }
    
//------------------------------------------------------------------------------
    
    public String getFitnessExpression()
    {
        return fitnessExpression;
    }
    
//------------------------------------------------------------------------------
    
    public List<DescriptorForFitness> getDescriptors()
    {
        return descriptors;
    }
 
//------------------------------------------------------------------------------
 
    public void interpretKeyword(String key, String value) throws DENOPTIMException
    {
        String msg = "";
        switch (key.toUpperCase())
        {
            case "SOURCE=":
                externalExe = value;
                break;
                
            case "INTERPRETER=":
                interpreterExternalExe = value;
                break;
                
            case "EQUATION=":
                fitnessExpression = value;
                useExternalFitness = false;
                break;
                
            case "DESCRIPTORSPECS=":
                customVarDescExpressions.add(value);
                break;
                
            case "MAKEPICTURES":
                makePictures = true;
                break;
                
            case "NO3DTREEMODEL":
                make3DTrees = false;
                break;
                
            case "DONTWRITECANDIDATESONDISK":
                writeCandidatesOnDisk = false;
                break;
                
            case "CHECKUIDBEFOREFITNESS=":
                checkPreFitnessUID = readYesNoTrueFalse(value);
                checkPreFitnessUIDFromInput = true;
                break;
    
            default:
                 msg = "Keyword " + key + " is not a known fitness-related "
                        + "keyword. Check input files.";
                throw new DENOPTIMException(msg);
        }
    }
 
//------------------------------------------------------------------------------
 
    public void checkParameters() throws DENOPTIMException
    {
        String msg = "";
        if ((externalExe.length() != 0) 
            && (!FileUtils.checkExists(externalExe)))
        {
            msg = "Cannot find the fitness provider: " + externalExe;
            throw new DENOPTIMException(msg);
        }
        checkOtherParameters();
    }
 
//------------------------------------------------------------------------------
 
    public void processParameters() throws DENOPTIMException
    {
        if (!fitnessExpression.equals(""))
        {
            FitnessExpressionParser fep = new FitnessExpressionParser();
            fep.parse(fitnessExpression, customVarDescExpressions);
            descriptors = fep.getDescriptors();
        }
        if (!checkPreFitnessUIDFromInput && useExternalFitness)
            checkPreFitnessUID = false;
            
        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();
    }
    
//------------------------------------------------------------------------------
 
    public boolean writeCandidatesOnDisk()
    {
        return writeCandidatesOnDisk;
    }
    
//------------------------------------------------------------------------------
 
}