org.norther.tammi.spray.engine.tool
Class MathTool

java.lang.Object
  org.norther.tammi.core.pool.RecyclableSupport
      org.norther.tammi.core.pool.PoolableSupport
          org.norther.tammi.spray.engine.tool.GlobalTool
              org.norther.tammi.spray.engine.tool.MathTool

All Implemented Interfaces:

Serializable, Cloneable, EventListener, Poolable, Recyclable, ContextBindingListener

public class MathTool
extends GlobalTool

A global context tool for math operations.

Author:

Ilkka Priha

See Also:

Serialized Form

Constructor Summary

MathTool()
Constructs a new tool.

Method Summary

Number	abs(Number number) Gets an absolute value.
int	and(Number number1, Number number2) Returns a bitwise and of two numbers.
Object	average(Object object1, Object object2) Returns an average.
int	ceil(Number number1, Number number2) Returns ceil of a quotient.
int	count() Returns a shared count.
int	count(int denom) Returns a shared count reminder.
double	div(Number number1, Number number2) Divides two numbers.
boolean	eq(Number number1, Number number2) Checks whether a number is equal to another number.
int	floor(Number number1, Number number2) Returns floor of a quotient.
boolean	ge(Number number1, Number number2) Checks whether a number is greater than or equal to another number.
boolean	get(int bit, Number number) Gets the indexed bit of a number.
boolean	gt(Number number1, Number number2) Checks whether a number is greater than another number.
boolean	le(Number number1, Number number2) Checks whether a number is less than or equal to another number.
int	left(Number number, int shift) Returns a bitwise left shift of a number.
boolean	lt(Number number1, Number number2) Checks whether a number is less than another number.
Number	max(Number number1, Number number2) Returns a maximum.
Number	min(Number number1, Number number2) Returns a minimum.
int	mod(Number number1, Number number2) Returns modulus of a quotient.
double	mul(Number number1, Number number2) Multiplies two numbers.
boolean	ne(Number number1, Number number2) Checks whether a number is not equal to another number.
int	not(Number number) Returns a bitwise not of a number.
int	or(Number number1, Number number2) Returns a bitwise or of two numbers.
int	random() Returns a random int.
int	random(int n) Returns a random int within 0 - n.
int	right(Number number, int shift) Returns a bitwise right shift of a number.
int	round(Number number1, Number number2) Returns round of a quotient.
int	set(int bit, Number number, boolean on) Sets the indexed bit of a number.
double	sqrt(Number number) Returns a square root.
double	sub(Number number1, Number number2) Subtracts two numbers.
double	sum(Number number1, Number number2) Sums up two numbers.
int	trunc(Number number1, Number number2) Returns trunc of a quotient.

Methods inherited from class org.norther.tammi.spray.engine.tool.GlobalTool

clone, dispose, getContext, getContextToolFilter, getMBeanServer, getName, isBound, nop, toString, valueBound, valueUnbound

Methods inherited from class org.norther.tammi.core.pool.PoolableSupport

disposed, recycled

Methods inherited from class org.norther.tammi.core.pool.RecyclableSupport

isDisposed, recycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.norther.tammi.core.pool.Recyclable

isDisposed, recycle

Constructor Detail

MathTool

public MathTool()

Constructs a new tool.

Method Detail

get

public boolean get(int bit,
                   Number number)

Gets the indexed bit of a number.

Parameters:

bit - the bit index.

number - the number.

Returns:

true if set, false otherwise.

set

public int set(int bit,
               Number number,
               boolean on)

Sets the indexed bit of a number.

Parameters:

bit - the bit index.

number - the number.

on - true to set, 0 to clear.

Returns:

the updated number.

and

public int and(Number number1,
               Number number2)

Returns a bitwise and of two numbers.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

the bitwise and as an int.

or

public int or(Number number1,
              Number number2)

Returns a bitwise or of two numbers.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

the bitwise or as an int.

not

public int not(Number number)

Returns a bitwise not of a number.

Parameters:

number - the number.

Returns:

the bitwise not as an int.

left

public int left(Number number,
                int shift)

Returns a bitwise left shift of a number.

Parameters:

number - the number.

shift - the shift.

Returns:

the bitwise left shift as an int.

right

public int right(Number number,
                 int shift)

Returns a bitwise right shift of a number.

Parameters:

number - the number.

shift - the shift.

Returns:

the bitwise right shift as an int.

sum

public double sum(Number number1,
                  Number number2)

Sums up two numbers.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

the result as a double.

sub

public double sub(Number number1,
                  Number number2)

Subtracts two numbers.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

the result as a double.

mul

public double mul(Number number1,
                  Number number2)

Multiplies two numbers.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

the result as a double.

div

public double div(Number number1,
                  Number number2)

Divides two numbers.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

the result as a double.

abs

public Number abs(Number number)

Gets an absolute value.

Parameters:

number - the argument.

Returns:

true the absolute number.

eq

public boolean eq(Number number1,
                  Number number2)

Checks whether a number is equal to another number.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

true if equal, otherwise false.

ne

public boolean ne(Number number1,
                  Number number2)

Checks whether a number is not equal to another number.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

true if equal, otherwise false.

ge

public boolean ge(Number number1,
                  Number number2)

Checks whether a number is greater than or equal to another number.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

true if greater or equal, otherwise false.

le

public boolean le(Number number1,
                  Number number2)

Checks whether a number is less than or equal to another number.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

true if less or equal, otherwise false.

gt

public boolean gt(Number number1,
                  Number number2)

Checks whether a number is greater than another number.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

true if greater, otherwise false.

lt

public boolean lt(Number number1,
                  Number number2)

Checks whether a number is less than another number.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

true if less, otherwise false.

mod

public int mod(Number number1,
               Number number2)

Returns modulus of a quotient.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

mod(n1/n2).

round

public int round(Number number1,
                 Number number2)

Returns round of a quotient.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

round(n1/n2).

ceil

public int ceil(Number number1,
                Number number2)

Returns ceil of a quotient.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

ceil(n1/n2).

floor

public int floor(Number number1,
                 Number number2)

Returns floor of a quotient.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

floor(n1/n2).

trunc

public int trunc(Number number1,
                 Number number2)

Returns trunc of a quotient.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

trunc(n1/n2).

sqrt

public double sqrt(Number number)

Returns a square root.

Parameters:

number - the number.

Returns:

sqrt(n).

max

public Number max(Number number1,
                  Number number2)

Returns a maximum.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

max(n1, n2).

min

public Number min(Number number1,
                  Number number2)

Returns a minimum.

Parameters:

number1 - the first number.

number2 - the second number.

Returns:

min(n1, n2).

average

public Object average(Object object1,
                      Object object2)

Returns an average.

Parameters:

object1 - the first object.

object2 - the second object.

Returns:

the average.

count

public int count()

Returns a shared count.

Returns:

the count.

count

public int count(int denom)

Returns a shared count reminder.

Parameters:

denom - the denominator.

Returns:

the count.

random

public int random()

Returns a random int.

Returns:

the int.

random

public int random(int n)

Returns a random int within 0 - n.

Parameters:

n - the limit.

Returns:

the int.