net.sf.javagimmicks.math.sequence.NumberSequence Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gimmicks Show documentation

Utility classes, APIs and tools for Java

There is a newer version: 0.99-alpha1

package net.sf.javagimmicks.math.sequence;

import java.math.BigInteger;

/**
 * A generic interface for {@link Number} sequences.
 * 
 * @param 
 *           the type of {@link Number}s that this {@link NumberSequence}
 *           generates.
 */
public interface NumberSequence
{
   /**
    * Returns the {@link Number} at the given index
    * 
    * @param index
    *           the index of the {@link Number} to retrieve from this instance
    * @return the resulting {@link Number}
    * @throws IndexOutOfBoundsException
    *            if the given index is invalid for this {@link NumberSequence}
    */
   N get(BigInteger index) throws IndexOutOfBoundsException;
}