Overview  Package   Class  Use  Deprecated  Index
Home >> All >> [ cgsuite overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

cgsuite
Class CooledGame  

java.lang.Object
  cgsuite.CooledGame

All Implemented Interfaces:

java.lang.Comparable, Game, java.io.Serializable

---

public class CooledGame

extends java.lang.Object

implements Game, java.lang.Comparable

A game cooled by its temperature (frozen) or by a specified temperature t.

Version:

0.1.1

---

Field Summary
(package private)  Game	g
(package private)  DyadicRational	t

 

Fields inherited from interface cgsuite.Game

SIMPLIFY_COOL, SIMPLIFY_FREEZE, SIMPLIFY_HEAT, SIMPLIFY_ORDINAL_SUM_G, SIMPLIFY_ORDINAL_SUM_H, SIMPLIFY_OVERHEAT, SIMPLIFY_PRODUCT_G, SIMPLIFY_PRODUCT_U, SIMPLIFY_SUM

 

Constructor Summary

CooledGame(Game g)           Constructs a new CooledGame obtained by freezing the game g (that is, cooling g by its temperature.)

CooledGame(Game g, DyadicRational t)           Constructs a new CooledGame obtained by cooling the game g by the specified temperature t.

 

Method Summary
CanonicalGame	canonicalize()           Calculates the canonical form of this game.
int	compareTo(java.lang.Object o)           Compares this object with another, and returns a numerical result based on the comparison.
boolean	equals(java.lang.Object o)           Determine whether this Object is semantically equal to another Object.
Game	getG()           Gets the game being cooled.
Game	getInverse()           Gets the inverse of this game.
java.util.Collection	getLeftOptions()           Gets a Collection containing all left options of this game.
java.util.Collection	getRightOptions()           Gets a Collection containing all right options of this game.
DyadicRational	getT()           Gets the temperature by which g is cooled.
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
boolean	isShortGame()           Returns true if this game is a short game.
Game	simplify()           Calculates a simplified form of this game.
Game	simplifyExpression(int simplifyType, Game[] args)           Calculates a simplified form of the indicated expression.
java.lang.String	toString()           Convert this Object to a human-readable String.

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

g

Game g

---

t

DyadicRational t

Constructor Detail

CooledGame

public CooledGame(Game g)

Constructs a new CooledGame obtained by freezing the game g (that is, cooling g by its temperature.)

---

CooledGame

public CooledGame(Game g,
                  DyadicRational t)

Constructs a new CooledGame obtained by cooling the game g by the specified temperature t.

Method Detail

equals

public boolean equals(java.lang.Object o)

Description copied from class: java.lang.Object

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

---

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

---

compareTo

public int compareTo(java.lang.Object o)

Description copied from interface: java.lang.Comparable

Compares this object with another, and returns a numerical result based on the comparison. If the result is negative, this object sorts less than the other; if 0, the two are equal, and if positive, this object sorts greater than the other. To translate this into boolean, simply perform o1.compareTo(o2) <op> 0, where op is one of <, <=, =, !=, >, or >=.

You must make sure that the comparison is mutual, ie. sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) (where sgn() is defined as -1, 0, or 1 based on the sign). This includes throwing an exception in either direction if the two are not comparable; hence, compareTo(null) should always throw an Exception.

You should also ensure transitivity, in two forms: x.compareTo(y) > 0 && y.compareTo(z) > 0 implies x.compareTo(z) > 0; and x.compareTo(y) == 0 implies x.compareTo(z) == y.compareTo(z).

Specified by:

compareTo in interface java.lang.Comparable

---

getLeftOptions

public java.util.Collection getLeftOptions()

Description copied from interface: Game

Gets a Collection containing all left options of this game.

Specified by:

getLeftOptions in interface Game

---

getRightOptions

public java.util.Collection getRightOptions()

Description copied from interface: Game

Gets a Collection containing all right options of this game.

Specified by:

getRightOptions in interface Game

---

getInverse

public Game getInverse()

Description copied from interface: Game

Gets the inverse of this game.

Specified by:

getInverse in interface Game

---

isShortGame

public boolean isShortGame()

Description copied from interface: Game

Returns true if this game is a short game.

Specified by:

isShortGame in interface Game

---

canonicalize

public CanonicalGame canonicalize()
                           throws NotShortGameException

Description copied from interface: Game

Calculates the canonical form of this game. The canonical form is the unique CanonicalGame that is canonically equal to this game.

Specified by:

canonicalize in interface Game

---

simplify

public Game simplify()

Description copied from interface: Game

Calculates a simplified form of this game. The simplified form need not be canonical or "simplest." This method is used by the Combinatorial Game Suite interface to determine the best way to display output. As an example, the ExplicitGame given by {1,1/2|-1} would be simplified to the CanonicalGame given by {1|-1}.

There are two key differences between simplify and canonicalize 55 . First, canonicalize always returns a CanonicalGame, while simplify may return any game at all. Second, simplify is called automatically by the Combinatorial Game Suite user interface when output is ready to be displayed, while canonicalize is usually called only by explicit user request. For this reason, it is advisable for simplify to execute rapidly in most circumstances.

It is permissible for simplify to return this when no obvious simplifications are possible, but it should never return null.

Specified by:

simplify in interface Game

---

simplifyExpression

public Game simplifyExpression(int simplifyType,
                               Game[] args)

Description copied from interface: Game

Calculates a simplified form of the indicated expression. This method is for advanced users and is rarely needed by plug-ins. Most implementations of Game should simply return null.

Specified by:

simplifyExpression in interface Game

---

getG

public Game getG()

Gets the game being cooled.

---

getT

public DyadicRational getT()

Gets the temperature by which g is cooled.

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> [ cgsuite overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---