/*
 *  RapidMiner
 *
 *  Copyright (C) 2001-2008 by Rapid-I and the contributors
 *
 *  Complete list of developers available at our web site:
 *
 *       http://rapid-i.com
 *
 *  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 com.rapidminer.operator.preprocessing.filter;

import java.util.List;

import com.rapidminer.example.Attribute;
import com.rapidminer.example.Example;
import com.rapidminer.operator.OperatorDescription;
import com.rapidminer.operator.OperatorException;
import com.rapidminer.parameter.ParameterType;
import com.rapidminer.parameter.ParameterTypeDouble;


/**
 * Converts all numerical attributes to binary ones. If the value of an
 * attribute is between the specified minimal and maximal value, it becomes <em>false</em>, 
 * otherwise <em>true</em>. If the value is missing, the new value will be missing. The default
 * boundaries are both set to 0, thus only 0.0 is mapped to false and all other values are 
 * mapped to true.
 * 
 * @author Sebastian Land, Ingo Mierswa, Shevek
 * @version $Id: NumericToBinominal.java,v 1.5 2008/05/09 19:22:58 ingomierswa Exp $
 */
public class NumericToBinominal extends NumericToNominal {
       
	/** The parameter name for "The minimal value which is mapped to false (included)." */
	public static final String PARAMETER_MIN = "min";

	/** The parameter name for "The maximal value which is mapped to false (included)." */
	public static final String PARAMETER_MAX = "max";
	
    public NumericToBinominal(OperatorDescription description) {
        super(description);
    }

    protected void setValue(Example example, Attribute newAttribute, double value) throws OperatorException {
        double min = getParameterAsDouble(PARAMETER_MIN);
        double max = getParameterAsDouble(PARAMETER_MAX);
        if (Double.isNaN(value)) {
            example.setValue(newAttribute, Double.NaN);
        } else if ((value < min) || (value > max)) {
            example.setValue(newAttribute, newAttribute.getMapping().mapString("true"));
        } else {
            example.setValue(newAttribute, newAttribute.getMapping().mapString("false"));
        }        
    }
    
    public List<ParameterType> getParameterTypes() {
        List<ParameterType> types = super.getParameterTypes();
        types.add(new ParameterTypeDouble(PARAMETER_MIN, "The minimal value which is mapped to false (included).", Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY, 0.0d));
        types.add(new ParameterTypeDouble(PARAMETER_MAX, "The maximal value which is mapped to false (included).", Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY, 0.0d));
        return types;
    }
}