001package es.ucm.fdi.gaia.jcolibri.method.retrieve.NNretrieval.similarity.local.recommenders;
002
003import es.ucm.fdi.gaia.jcolibri.exception.NoApplicableSimilarityFunctionException;
004import es.ucm.fdi.gaia.jcolibri.method.retrieve.NNretrieval.similarity.LocalSimilarityFunction;
005
006/**
007 * This function returns the similarity of two numbers following 
008 * the McSherry - More is Better formulae
009 * 
010 * sim(c.a,q.a)= 1 - ((max(a) - c.a) / (max(a)-min(a)))
011 * 
012 * min(a) and max(a) must be defined by the designer. q.a is not taken into account.
013 */
014public class McSherryMoreIsBetter implements LocalSimilarityFunction {
015
016        /** InrecaLessIsBetter. */
017        double maxValue;
018        double minValue;
019
020        /**
021         * Constructor. max and min values are ignored for enum types.
022         * 
023         */
024        
025        public McSherryMoreIsBetter(double maxAttributeValue, double minAttributeValue) {
026            this.maxValue = maxAttributeValue;
027            this.minValue = minAttributeValue;
028        }
029
030        /**
031         * Applies the similarity function.
032         * 
033         * @param caseObject is a Number
034         * @param queryObject is a Number
035         * @return result of apply the similarity function.
036         */
037        public double compute(Object caseObject, Object queryObject) throws NoApplicableSimilarityFunctionException {
038                if ((caseObject == null))
039                        return 0;
040                if (! ((caseObject instanceof Number)||(caseObject instanceof Enum)))
041                        throw new
042                                        NoApplicableSimilarityFunctionException(this.getClass(), caseObject.getClass());
043
044                double caseValue;
045                double max;
046                double min;
047                if(caseObject instanceof Number)
048                {
049                    Number n1  = (Number) caseObject;
050                    caseValue  = n1.doubleValue();
051                    max = maxValue;
052                    min = minValue;
053                }
054                else
055                {
056                    Enum<?> enum1 = (Enum<?>)caseObject;
057                    caseValue  = enum1.ordinal();
058                    max = caseObject.getClass().getEnumConstants().length;
059                    min = 0;
060                }
061                
062                
063                return 1 - ( (max-caseValue) / (max - min) );
064                
065        }
066        
067        /** Applicable to any Number subinstance */
068        public boolean isApplicable(Object o1, Object o2)
069        {
070                if((o1==null)&&(o2==null))
071                        return true;
072                else if(o1==null)
073                        return (o2 instanceof Number)||(o2 instanceof Enum);
074                else if(o2==null)
075                        return (o1 instanceof Number)||(o1 instanceof Enum);
076                else
077                        return ((o1 instanceof Number)&&(o2 instanceof Number)) ||
078                                ((o1 instanceof Enum)&&(o2 instanceof Enum));
079        }
080
081}