Mercurial > hg > graal-jvmci-8
view graal/com.oracle.jvmci.meta/src/com/oracle/jvmci/meta/AbstractProfiledItem.java @ 21643:2081f8f294fe
Fixed some javadoc
author | Tom Rodriguez <tom.rodriguez@oracle.com> |
---|---|
date | Mon, 01 Jun 2015 11:49:57 -0700 |
parents | 48c1ebd24120 |
children |
line wrap: on
line source
/* * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. * * This code 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 General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package com.oracle.jvmci.meta; /** * A profiled type that has a probability. Profiled types are naturally sorted in descending order * of their probabilities. */ public abstract class AbstractProfiledItem<T> implements Comparable<AbstractProfiledItem<?>> { protected final T item; protected final double probability; public AbstractProfiledItem(T item, double probability) { assert item != null; assert probability >= 0.0D && probability <= 1.0D; this.item = item; this.probability = probability; } protected T getItem() { return item; } /** * Returns the estimated probability of {@link #getItem()}. * * @return double value ≥ 0.0 and ≤ 1.0 */ public double getProbability() { return probability; } @Override public int compareTo(AbstractProfiledItem<?> o) { if (getProbability() > o.getProbability()) { return -1; } else if (getProbability() < o.getProbability()) { return 1; } return 0; } @Override public int hashCode() { final int prime = 31; int result = 1; long temp; temp = Double.doubleToLongBits(probability); result = prime * result + (int) (temp ^ (temp >>> 32)); result = prime * result + item.hashCode(); return result; } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj == null) { return false; } if (getClass() != obj.getClass()) { return false; } AbstractProfiledItem<?> other = (AbstractProfiledItem<?>) obj; if (Double.doubleToLongBits(probability) != Double.doubleToLongBits(other.probability)) { return false; } return item.equals(other.item); } @Override public abstract String toString(); }