heros.MeetLattice Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2012 Eric Bodden.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser Public License v2.1
 * which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * 
 * Contributors:
 *     Eric Bodden - initial API and implementation
 ******************************************************************************/
package heros;

/**
 * This class defines a lattice in terms of its top and bottom elements
 * and a meet operation. This is meant to be a complete lattice, with a unique top and bottom element. 
 *
 * @param  The domain type for this lattice.
 */
public interface MeetLattice {
	
	/**
	 * Returns the unique top element of this lattice.
	 */
	V topElement();
	
	/**
	 * Returns the unique bottom element of this lattice.
	 */
	V bottomElement();
	
	/**
	 * Computes the meet of left and right. Note that meet(top,x) = meet(x,top) = x and
	 * meet(bottom,x) = meet(x,bottom) = bottom. 
	 */
	V meet(V left, V right);

}