001// ***** This file is automatically generated from IntComparisons.java.jpp 002 003package daikon.inv.binary.twoScalar; 004 005import daikon.*; 006import daikon.derive.binary.*; 007import daikon.derive.unary.*; 008import daikon.inv.*; 009import daikon.inv.binary.twoScalar.*; 010import daikon.inv.binary.twoSequence.*; 011import daikon.inv.unary.scalar.*; 012import daikon.inv.unary.sequence.*; 013import daikon.inv.unary.string.*; 014import daikon.suppress.*; 015import java.util.*; 016import java.util.logging.Level; 017import java.util.logging.Logger; 018import org.checkerframework.checker.interning.qual.Interned; 019import org.checkerframework.checker.lock.qual.GuardSatisfied; 020import org.checkerframework.checker.nullness.qual.NonNull; 021import org.checkerframework.checker.nullness.qual.Nullable; 022import org.checkerframework.dataflow.qual.Pure; 023import org.checkerframework.dataflow.qual.SideEffectFree; 024import org.plumelib.util.Intern; 025import typequals.prototype.qual.NonPrototype; 026import typequals.prototype.qual.Prototype; 027 028/** 029 * Represents an invariant of ≥ between two long scalars. Prints as {@code x >= y}. 030 */ 031public final class IntGreaterEqual extends TwoScalar { 032 033 static final long serialVersionUID = 20030822L; 034 035 // Variables starting with dkconfig_ should only be set via the 036 // daikon.config.Configuration interface. 037 /** Boolean. True iff IntGreaterEqual invariants should be considered. */ 038 public static boolean dkconfig_enabled = Invariant.invariantEnabledDefault; 039 040 public static final Logger debug = Logger.getLogger("daikon.inv.binary.twoScalar.IntGreaterEqual"); 041 042 IntGreaterEqual(PptSlice ppt) { 043 super(ppt); 044 } 045 046 @Prototype IntGreaterEqual() { 047 super(); 048 } 049 050 private static @Prototype IntGreaterEqual proto = new @Prototype IntGreaterEqual(); 051 052 /** Returns the prototype invariant for IntGreaterEqual. */ 053 public static @Prototype IntGreaterEqual get_proto() { 054 return proto; 055 } 056 057 @Override 058 public boolean enabled() { 059 return dkconfig_enabled; 060 } 061 062 /** Returns whether or not the specified var types are valid for IntGreaterEqual. */ 063 @Override 064 public boolean instantiate_ok(VarInfo[] vis) { 065 066 if (!valid_types(vis)) { 067 return false; 068 } 069 070 return (vis[0].file_rep_type.isIntegral() 071 && vis[1].file_rep_type.isIntegral()); 072 073 } 074 075 @Override 076 protected IntGreaterEqual instantiate_dyn(@Prototype IntGreaterEqual this, PptSlice slice) { 077 078 return new IntGreaterEqual(slice); 079 } 080 081 @Override 082 protected Invariant resurrect_done_swapped() { 083 084 // we have no non-static member data, so we only need care about our type 085 // As of now, the constructor chain is side-effect free; 086 // let's hope it stays that way. 087 IntLessEqual result = new IntLessEqual(ppt); 088 return result; 089 } 090 091 /** Returns the class that corresponds to this class with its variable order swapped. */ 092 public static Class<? extends Invariant> swap_class() { 093 return IntLessEqual.class; 094 } 095 096 // JHP: this should be removed in favor of checks in PptTopLevel 097 // such as is_equal, is_lessequal, etc. 098 // Look up a previously instantiated IntGreaterEqual relationship. 099 // Should this implementation be made more efficient? 100 public static @Nullable IntGreaterEqual find(PptSlice ppt) { 101 assert ppt.arity() == 2; 102 for (Invariant inv : ppt.invs) { 103 if (inv instanceof IntGreaterEqual) { 104 return (IntGreaterEqual) inv; 105 } 106 } 107 108 // If the invariant is suppressed, create it 109 if ((suppressions != null) && suppressions.suppressed(ppt)) { 110 IntGreaterEqual inv = proto.instantiate_dyn(ppt); 111 // System.out.printf("%s is suppressed in ppt %s%n", inv.format(), ppt.name()); 112 return inv; 113 } 114 115 return null; 116 } 117 118 @Override 119 public String repr(@GuardSatisfied IntGreaterEqual this) { 120 return "IntGreaterEqual" + varNames(); 121 } 122 123 @SideEffectFree 124 @Override 125 public String format_using(@GuardSatisfied IntGreaterEqual this, OutputFormat format) { 126 127 String var1name = var1().name_using(format); 128 String var2name = var2().name_using(format); 129 130 if ((format == OutputFormat.DAIKON) || (format == OutputFormat.ESCJAVA)) { 131 String comparator = ">="; 132 return var1name + " " + comparator + " " + var2name; 133 } 134 135 if (format == OutputFormat.CSHARPCONTRACT) { 136 137 String comparator = ">="; 138 return var1name + " " + comparator + " " + var2name; 139 } 140 141 if (format.isJavaFamily()) { 142 143 if ((var1name.indexOf("daikon.Quant.collectObject") != -1) 144 || (var2name.indexOf("daikon.Quant.collectObject") != -1)) { 145 return "(warning: it is meaningless to compare hashcodes for values obtained through daikon.Quant.collect... methods:" 146 + var1name + " >= " + var2name + ")"; 147 } 148 return var1name + " >= " + var2name; 149 } 150 151 if (format == OutputFormat.SIMPLIFY) { 152 153 String comparator = ">="; 154 155 return "(" 156 + comparator 157 + " " 158 + var1().simplifyFixup(var1name) 159 + " " 160 + var2().simplifyFixup(var2name) 161 + ")"; 162 } 163 164 return format_unimplemented(format); 165 } 166 167 @Override 168 public InvariantStatus check_modified(long v1, long v2, int count) { 169 if (!(v1 >= v2)) { 170 return InvariantStatus.FALSIFIED; 171 } 172 return InvariantStatus.NO_CHANGE; 173 } 174 175 @Override 176 public InvariantStatus add_modified(long v1, long v2, int count) { 177 if (logDetail() || debug.isLoggable(Level.FINE)) { 178 log( 179 debug, 180 "add_modified (" + v1 + ", " + v2 + ", ppt.num_values = " + ppt.num_values() + ")"); 181 } 182 if ((logOn() || debug.isLoggable(Level.FINE)) 183 && check_modified(v1, v2, count) == InvariantStatus.FALSIFIED) 184 log(debug, "destroy in add_modified (" + v1 + ", " + v2 + ", " + count + ")"); 185 186 return check_modified(v1, v2, count); 187 } 188 189 // This is very tricky, because whether two variables are equal should 190 // presumably be transitive, but it's not guaranteed to be so when using 191 // this method and not dropping out all variables whose values are ever 192 // missing. 193 @Override 194 protected double computeConfidence() { 195 // Should perhaps check number of samples and be unjustified if too few 196 // samples. 197 198 // // The reason for this multiplication is that there might be only a 199 // // very few possible values. Example: towers of hanoi has only 6 200 // // possible (pegA, pegB) pairs. 201 // return 1 - (Math.pow(.5, ppt.num_values()) 202 // * Math.pow(.99, ppt.num_mod_samples())); 203 return 1 - Math.pow(.5, ppt.num_samples()); 204 } 205 206 @Pure 207 @Override 208 public boolean isExact() { 209 210 return false; 211 } 212 213 // // Temporary, for debugging 214 // public void destroy() { 215 // if (debug.isLoggable(Level.FINE)) { 216 // System.out.println("IntGreaterEqual.destroy(" + ppt.name() + ")"); 217 // System.out.println(repr()); 218 // (new Error()).printStackTrace(); 219 // } 220 // super.destroy(); 221 // } 222 223 @Override 224 public InvariantStatus add( 225 @Interned Object v1, @Interned Object v2, int mod_index, int count) { 226 if (debug.isLoggable(Level.FINE)) { 227 debug.fine( 228 "IntGreaterEqual" 229 + ppt.varNames() 230 + ".add(" 231 + v1 232 + "," 233 + v2 234 + ", mod_index=" 235 + mod_index 236 + "), count=" 237 + count 238 + ")"); 239 } 240 return super.add(v1, v2, mod_index, count); 241 } 242 243 @Pure 244 @Override 245 public boolean isSameFormula(Invariant other) { 246 return true; 247 } 248 249 @Pure 250 @Override 251 public boolean isExclusiveFormula(Invariant other) { 252 253 // Also ought to check against LinearBinary, etc. 254 255 if (other instanceof IntLessThan) { 256 return true; 257 } 258 259 return false; 260 } 261 262 @Override 263 public @Nullable DiscardInfo isObviousStatically(VarInfo[] vis) { 264 final VarInfo var1 = vis[0]; 265 final VarInfo var2 = vis[1]; 266 267 if (var1.aux.hasValue(VarInfoAux.MINIMUM_VALUE) 268 && var2.aux.hasValue(VarInfoAux.MAXIMUM_VALUE)) { 269 int maxB = var2.aux.getInt(VarInfoAux.MAXIMUM_VALUE), 270 minA = var1.aux.getInt(VarInfoAux.MINIMUM_VALUE); 271 272 if (minA >= maxB) { 273 return new DiscardInfo( 274 this, 275 DiscardCode.obvious, 276 var1.name() + " DISCARD_OP " + var2.name() + " is already known"); 277 } 278 } 279 280 return super.isObviousStatically(vis); 281 } 282 283 @Pure 284 @Override 285 public @Nullable DiscardInfo isObviousDynamically(VarInfo[] vis) { 286 287 // JHP: We might consider adding a check over bounds. If 288 // x < c and y > c then we know that x < y. Similarly for 289 // x > c and y < c. We could also substitute oneof for 290 // one or both of the bound checks. 291 292 DiscardInfo super_result = super.isObviousDynamically(vis); 293 if (super_result != null) { 294 return super_result; 295 } 296 297 VarInfo var1 = vis[0]; 298 VarInfo var2 = vis[1]; 299 300 @SuppressWarnings("UnusedVariable") // generated code, variable is sometimes used 301 DiscardInfo di; 302 303 // Check for the same invariant over enclosing arrays 304 di = pairwise_implies(vis); 305 if (di != null) { 306 return di; 307 } 308 309 { // Sequence length tests 310 SequenceLength sl1 = null; 311 if (var1.isDerived() && (var1.derived instanceof SequenceLength)) { 312 sl1 = (SequenceLength) var1.derived; 313 } 314 SequenceLength sl2 = null; 315 if (var2.isDerived() && (var2.derived instanceof SequenceLength)) { 316 sl2 = (SequenceLength) var2.derived; 317 } 318 319 // "size(a)-1 cmp size(b)-1" is never even instantiated; 320 // use "size(a) cmp size(b)" instead. 321 322 // This might never get invoked, as equality is printed out specially. 323 VarInfo s1 = (sl1 == null) ? null : sl1.base; 324 VarInfo s2 = (sl2 == null) ? null : sl2.base; 325 if ((s1 != null) && (s2 != null) && (s1.equalitySet == s2.equalitySet)) { 326 // lengths of equal arrays being compared 327 String n1 = var1.name(); 328 String n2 = var2.name(); 329 return new DiscardInfo( 330 this, 331 DiscardCode.obvious, 332 n1 + " and " + n2 + " are equal arrays, so equal size is implied"); 333 } 334 335 } 336 337 return null; 338 } // isObviousDynamically 339 340 /** 341 * If both variables are subscripts and the underlying arrays have the same invariant, then this 342 * invariant is implied: 343 * 344 * <pre>(x[] op y[]) ^ (i == j) ⇒ (x[i] op y[j])</pre> 345 */ 346 private @Nullable DiscardInfo pairwise_implies(VarInfo[] vis) { 347 348 VarInfo v1 = vis[0]; 349 VarInfo v2 = vis[1]; 350 351 // Make sure v1 and v2 are SequenceScalarSubscript with the same shift 352 if (!v1.isDerived() || !(v1.derived instanceof SequenceScalarSubscript)) { 353 return null; 354 } 355 if (!v2.isDerived() || !(v2.derived instanceof SequenceScalarSubscript)) { 356 return null; 357 } 358 @NonNull SequenceScalarSubscript der1 = (SequenceScalarSubscript) v1.derived; 359 @NonNull SequenceScalarSubscript der2 = (SequenceScalarSubscript) v2.derived; 360 if (der1.index_shift != der2.index_shift) { 361 return null; 362 } 363 364 // Make sure that the indices are equal 365 if (!ppt.parent.is_equal(der1.sclvar().canonicalRep(), der2.sclvar().canonicalRep())) { 366 return null; 367 } 368 369 // See if the same relationship holds over the arrays 370 Invariant proto = PairwiseIntGreaterEqual.get_proto(); 371 DiscardInfo di = ppt.parent.check_implied_canonical(this, der1.seqvar(), der2.seqvar(), proto); 372 return di; 373 } 374 375 /** NI suppressions, initialized in get_ni_suppressions() */ 376 private static @Nullable NISuppressionSet suppressions = null; 377 378 /** Returns the non-instantiating suppressions for this invariant. */ 379 @Pure 380 @Override 381 public NISuppressionSet get_ni_suppressions() { 382 if (suppressions == null) { 383 384 NISuppressee suppressee = new NISuppressee(IntGreaterEqual.class, 2); 385 386 // suppressor definitions (used in suppressions below) 387 388 NISuppressor v1_eq_v2 = new NISuppressor(0, 1, IntEqual.class); 389 390 NISuppressor v1_gt_v2 = new NISuppressor(0, 1, IntGreaterThan.class); 391 392 suppressions = 393 new NISuppressionSet( 394 new NISuppression[] { 395 396 // v1 == v2 => v1 >= v2 397 new NISuppression(v1_eq_v2, suppressee), 398 // v1 > v2 => v1 >= v2 399 new NISuppression(v1_gt_v2, suppressee), 400 401 }); 402 } 403 return suppressions; 404 } 405 406}