net.sf.jga.fn.arithmetic
Class Modulus<T extends java.lang.Number>

java.lang.Object
  net.sf.jga.fn.Functor<R>
      net.sf.jga.fn.BinaryFunctor<T,T,T>
          net.sf.jga.fn.arithmetic.Modulus<T>

All Implemented Interfaces:

java.io.Serializable, Visitable

public class Modulus<T extends java.lang.Number>
extends BinaryFunctor<T,T,T>

Returns the remainder of the division of two integral arguments.

Copyright © 2003-2005 David A. Hall

Author:

David A. Hall

See Also:

Serialized Form

Nested Class Summary

static interface

Modulus.Visitor Interface for classes that may interpret a Modulus functor.

Constructor Summary

Modulus(java.lang.Class<T> c)
Builds Modulus functor for the given class.

Method Summary

void	accept(Visitor v) Calls the Visitor's visit(Modulus) method, if it implements the nested Visitor interface.
T	fn(T x, T y) Given integral arguments x and y, returns x % y
java.lang.Class<T>	getType() Returns the type of operands this instance supports
java.lang.String	toString()

Methods inherited from class net.sf.jga.fn.BinaryFunctor

bind, bind0th, bind1st, bind2nd, bindNth, compose, compose, composeNth, distribute, eval, generate, generate1st, generate2nd, generateNth

Methods inherited from class net.sf.jga.fn.Functor

composeNth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Modulus

public Modulus(java.lang.Class<T> c)

Builds Modulus functor for the given class. The class argument must be the same as the generic class argument (when generics are in use) or else a ClassCastException will be thrown when the functor is used.

Throws:

java.lang.IllegalArgumentException - if the given class has no Arithmetic implementation registered with the ArithmeticFactory

Method Detail

getType

public java.lang.Class<T> getType()

Returns the type of operands this instance supports

fn

public T fn(T x,
            T y)

Given integral arguments x and y, returns x % y

Specified by:

fn in class BinaryFunctor<T extends java.lang.Number,T extends java.lang.Number,T extends java.lang.Number>

Returns:

the quotient of two numeric arguments

accept

public void accept(Visitor v)

Calls the Visitor's visit(Modulus) method, if it implements the nested Visitor interface.

Specified by:

accept in interface Visitable

Overrides:

accept in class Functor<T extends java.lang.Number>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object