/** 
** AnySidedDie is a class each instance of which models an n-sided
** (and possibly unfair) die, such as is used in games of chance and
** board games.
**
** @author Bob McCloskey
** @author < your name >
**
*/

public class AnySidedDie {

   /*   c o n s t r u c t o r s   */

   /**
   ** Class constructor that produces an n-sided die, where n is the
   ** length of the array argument.  Each side's probability of being
   ** the result of a toss is given by the ratio of its corresponding
   ** element in the array to the sum of the array elements.  For example,
   ** suppose that freq[1] = 3 and that the sum of the elemements in 
   ** freq[] is 10.  Then the probability of tossing a 2 is 3/10 (i.e.,
   ** three tenths).  (Note that the array indices begin at 0 but that
   ** the number of dots on the sides of the die begin at 1.)
   **
   ** @param freq the i-th element indicates the relative frequency with
   **        which i+1 should occur as the result of a toss
   **
   ** @pre freq.length > 0  &  for all i, freq[i] >= 0  &  sum(freq) > 0
   ** @post die is initialized so that, for each k satisfying 0<k<=freq.length,
   **       the probability of tossing k is freq[k-1] / sum(freq)
   */
   public AnySidedDie(double[] freq) {
      ...
   }


   /**
   ** Class constructor that produces an n-sided fair die.
   **
   ** @param n  the number of sides of the die
   ** @pre n > 0
   ** @post die created is such that, for each k satisfying 0<k<=n,
   **       the probability of tossing k is 1/n
   */
   public AnySidedDie(int n) {
      ...
   }



   /*   o b s e r v e r s   */

   /**
   ** Returns the result (i.e., number of dots on the upward-facing side)
   ** of the die's most recent toss.
   **
   ** @return  number of dots on the die's upward facing side
   */
   public int result() { 
      ...
   }


   /** Reports how many sides the die has.
   **
   **  @return the number of sides on the die
   */
   public int numberOfSides() {
      ... 
   }

   /** Returns the number of times that the specified result (which must
   **  be in the range 1..numberOfSides()) has been tossed on the die.
   **  @param k the result whose frequency is sought
   **  @return the # of times that k has been the result of tossing the die
   */
   public int tossCount(int k) {
      ...
   }


   /** Returns the probability with which the specified result (which must
   **  be in the range 1..numberOfSides()) can be expected to be tossed
   **  on this die.  Note that the sum of these probabilities, over all
   **  possible results 1 through numberOfSides(), should be 1.0 (or
   **  something very close to it, allowing for representation error).
   **
   **  @param k the result whose probability is sought
   **  @return the probability with which k can be expected to be the
   **     result of tossing the die
   */
   public double probability(int k) {
      ...
   }


   /*   m u t a t o r   */

   /**
   ** Tosses the die.
   */
   public void toss() {
      ...
   }

}