XReal.java

//  XReal.java
//
//  Author:
//       Antonio J. Nebro <antonio@lcc.uma.es>
//       Juan J. Durillo <durillo@lcc.uma.es>
//
//  Copyright (c) 2011 Antonio J. Nebro, Juan J. Durillo
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
// 
//  You should have received a copy of the GNU Lesser General Public License
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.

package jmetal.util.wrapper;

import jmetal.core.Solution;
import jmetal.core.SolutionType;
import jmetal.encodings.solutionType.ArrayRealAndBinarySolutionType;
import jmetal.encodings.solutionType.ArrayRealSolutionType;
import jmetal.encodings.solutionType.BinaryRealSolutionType;
import jmetal.encodings.solutionType.RealSolutionType;
import jmetal.encodings.variable.ArrayReal;
import jmetal.util.Configuration;
import jmetal.util.JMException;

/**
 * Wrapper for accessing real-coded solutions
 */
public class XReal {
	private Solution solution_ ;
	private SolutionType type_ ;

	/**
	 * Constructor
	 */
	public XReal() {
	} // Constructor

	/**
	 * Constructor
	 * @param solution
	 */
	public XReal(Solution solution) {
		this() ;
		type_ = solution.getType() ;
		solution_ = solution ;
	}

	/**
	 * Gets value of a encodings.variable
	 * @param index Index of the encodings.variable
	 * @return The value of the encodings.variable
	 * @throws JMException
	 */
	public double getValue(int index) throws JMException {
		if ((type_.getClass() == RealSolutionType.class) ||
				(type_.getClass() == BinaryRealSolutionType.class)){
			return solution_.getDecisionVariables()[index].getValue() ;			
		} 
		else if (type_.getClass() == ArrayRealSolutionType.class) {
			return ((ArrayReal)(solution_.getDecisionVariables()[0])).array_[index] ;
		}
		else if (type_.getClass() == ArrayRealAndBinarySolutionType.class) {
			return ((ArrayReal)(solution_.getDecisionVariables()[0])).array_[index] ;
		}
		else {
			Configuration.logger_.severe("jmetal.util.wrapper.XReal.getValue, solution type " +
					type_ + "+ invalid") ;		
		}
		return 0.0 ;
	}

	/**
	 * Sets the value of a encodings.variable
	 * @param index Index of the encodings.variable
	 * @param value Value to be assigned
	 * @throws JMException
	 */
	public void setValue(int index, double value) throws JMException {
		if (type_.getClass() == RealSolutionType.class)
			solution_.getDecisionVariables()[index].setValue(value) ;
		else if (type_.getClass() == ArrayRealSolutionType.class)
			((ArrayReal)(solution_.getDecisionVariables()[0])).array_[index]=value ;
		else if (type_.getClass() == ArrayRealAndBinarySolutionType.class)
			((ArrayReal)(solution_.getDecisionVariables()[0])).array_[index]=value ;
		else
			Configuration.logger_.severe("jmetal.util.wrapper.XReal.setValue, solution type " +
					type_ + "+ invalid") ;		
	} // setValue	

	/**
	 * Gets the lower bound of a encodings.variable
	 * @param index Index of the encodings.variable
	 * @return The lower bound of the encodings.variable
	 * @throws JMException
	 */
	public double getLowerBound(int index) throws JMException {
		if ((type_.getClass() == RealSolutionType.class) ||
				(type_.getClass() == BinaryRealSolutionType.class))
			return solution_.getDecisionVariables()[index].getLowerBound() ;
		else if (type_.getClass() == ArrayRealSolutionType.class) 
			return ((ArrayReal)(solution_.getDecisionVariables()[0])).getLowerBound(index) ;
		else if (type_.getClass() == ArrayRealAndBinarySolutionType.class) 
			return ((ArrayReal)(solution_.getDecisionVariables()[0])).getLowerBound(index) ;
		else {
			Configuration.logger_.severe("jmetal.util.wrapper.XReal.getLowerBound, solution type " +
					type_ + "+ invalid") ;		

		}
		return 0.0 ;
	} // getLowerBound

	/**
	 * Gets the upper bound of a encodings.variable
	 * @param index Index of the encodings.variable
	 * @return The upper bound of the encodings.variable
	 * @throws JMException
	 */
	public double getUpperBound(int index) throws JMException {
		if ((type_.getClass() == RealSolutionType.class) ||
				(type_.getClass() == BinaryRealSolutionType.class))			
			return solution_.getDecisionVariables()[index].getUpperBound() ;
		else if (type_.getClass() == ArrayRealSolutionType.class) 
			return ((ArrayReal)(solution_.getDecisionVariables()[0])).getUpperBound(index) ;
		else if (type_.getClass() == ArrayRealAndBinarySolutionType.class) 
			return ((ArrayReal)(solution_.getDecisionVariables()[0])).getUpperBound(index) ;
		else
			Configuration.logger_.severe("jmetal.util.wrapper.XReal.getUpperBound, solution type " +
					type_ + "+ invalid") ;		

		return 0.0 ;
	} // getUpperBound

	/**
	 * Returns the number of variables of the solution
	 * @return
	 */
	public int getNumberOfDecisionVariables() {
		if ((type_.getClass() == RealSolutionType.class) ||
				(type_.getClass() == BinaryRealSolutionType.class))		
			return solution_.getDecisionVariables().length ;
		else if (type_.getClass() == ArrayRealSolutionType.class) 
			return ((ArrayReal)(solution_.getDecisionVariables()[0])).getLength() ;
		else
			Configuration.logger_.severe("jmetal.util.wrapper.XReal.size, solution type " +
					type_ + "+ invalid") ;		
		return 0 ;
	} // getNumberOfDecisionVariables
	
	/**
	 * Returns the number of variables of the solution
	 * @return
	 */
	public int size() {
		if ((type_.getClass().equals(RealSolutionType.class)) ||
				(type_.getClass().equals(BinaryRealSolutionType.class)))		
			return solution_.getDecisionVariables().length ;
		else if (type_.getClass().equals(ArrayRealSolutionType.class)) 
			return ((ArrayReal)(solution_.getDecisionVariables()[0])).getLength() ;
		else
			Configuration.logger_.severe("jmetal.util.wrapper.XReal.size, solution type " +
					type_ + "+ invalid") ;		
		return 0 ;
	} // size
} // XReal