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