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 (or Enums) following 009 * the INRECA - More is Better formulae 010 * 011 * sim(c.a,q.a)= if(c.a > q.a) then 1 else jump * (1- (q.a - c.a) / q.a)) 012 * 013 * jump must be defined by the designer. 014 */ 015public class InrecaMoreIsBetter implements LocalSimilarityFunction { 016 017 double jump; 018 019 /** 020 * Constructor. 021 */ 022 public InrecaMoreIsBetter(double jumpSimilarity) { 023 this.jump = jumpSimilarity; 024 } 025 026 /** 027 * Applies the similarity function. 028 * 029 * @param caseObject is a Number 030 * @param queryObject is a Number 031 * @return result of apply the similarity function. 032 */ 033 public double compute(Object caseObject, Object queryObject) throws NoApplicableSimilarityFunctionException { 034 if ((caseObject == null) || (queryObject == null)) 035 return 0; 036 if (! ((caseObject instanceof Number)||(caseObject instanceof Enum))) 037 throw new NoApplicableSimilarityFunctionException(this.getClass(), caseObject.getClass()); 038 if (! ((queryObject instanceof Number)||(queryObject instanceof Enum))) 039 throw new NoApplicableSimilarityFunctionException(this.getClass(), queryObject.getClass()); 040 041 double caseValue; 042 double queryValue; 043 044 if(caseObject instanceof Number) 045 { 046 Number n1 = (Number) caseObject; 047 Number n2 = (Number) queryObject; 048 caseValue = n1.doubleValue(); 049 queryValue = n2.doubleValue(); 050 } 051 else 052 { 053 Enum<?> enum1 = (Enum<?>)caseObject; 054 Enum<?> enum2 = (Enum<?>)queryObject; 055 caseValue = enum1.ordinal(); 056 queryValue = enum2.ordinal(); 057 } 058 059 if(caseValue >= queryValue) 060 return 1; 061 062 else return jump * (1- ((queryValue - caseValue) / queryValue) ); 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}