source: java2python/geniuswebtranslator/geniuswebsrc/geniusweb/profile/utilityspace/UtilitySpace.java@ 805

package geniusweb.profile.utilityspace;

import java.math.BigDecimal;

import org.eclipse.jdt.annotation.NonNull;

import geniusweb.issuevalue.Bid;
import geniusweb.profile.FullOrdering;

/**
 * A utilityspace defines a profile in terms of a utility of a bid. Bids with
 * higher utility are preferred over bids with less utility.
 */
public interface UtilitySpace extends FullOrdering {
        /**
         * @param bid the {@link Bid} to be evaluated
         * @return the utility value of this bid. This MUST return a number in the
         *         range [0,1]. 0 means preferred the least and 1 means preferred
         *         the most.
         */
        @NonNull
        BigDecimal getUtility(final @NonNull Bid bid);

        @Override
        default boolean isPreferredOrEqual(final @NonNull Bid bid1,
                        final @NonNull Bid bid2) {
                if (bid1 == null || bid2 == null)
                        throw new NullPointerException("bid1, bid2 must be not null");
                return getUtility(bid1).compareTo(getUtility(bid2)) >= 0;
        }

}