astra.lang.Math Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of astra-apis Show documentation

Base project for ASTRA applications

There is a newer version: 1.4.3

package astra.lang;

import java.util.Random;

import astra.core.Module;
import astra.formula.Formula;
import astra.formula.Predicate;

/**
 * Mathematical support for ASTRA.
 * 
 * @author Rem Collier
 *
 */
public class Math extends Module {
	Random random = new Random();

	/**
	 * Formula that evaluates a boolean value.
	 * 
	 * @param value a boolean value
	 * @return the formula TRUE or the formula FALSE
	 */
	@FORMULA
	public Formula evaluate(boolean value) {
		return value ? Predicate.TRUE:Predicate.FALSE;
	}
	
	/**
	 * Term that returns the max of two values.
	 * 
	 * @param A an integer
	 * @param B another integer
	 * @return the maximum of the two integers
	 */
	@TERM
	public int max(int A, int B) {
		return java.lang.Math.max(A,B);
	}
	
	/**
	 * Term that returns the min of two values.
	 * 
	 * @param A an integer
	 * @param B another integer
	 * @return the minimum of the two integers
	 */
	@TERM
	public int min(int A, int B) {
		return java.lang.Math.min(A,B);
	}
	
	/**
	 * Term that converts a string to an int.
	 * 
	 * @param X a string
	 * @return the integer value of the string
	 */
	@TERM
	public int intValue(String X) {
		return Integer.parseInt(X);
	}

	/**
	 * Term that converts a string to a long.
	 * 
	 * @param X a string
	 * @return the long value of the string
	 */
	@TERM
	public long longValue(String X) {
		return Long.parseLong(X);
	}

	/**
	 * Term that converts a string to a float.
	 * 
	 * @param X a string
	 * @return the float value of the string
	 */
	@TERM
	public float floatValue(String X) {
		return Float.parseFloat(X);
	}
	
	/**
	 * Term that converts a string to a double.
	 * 
	 * @param X a string
	 * @return the double  value of the string
	 */
	@TERM
	public double doubleValue(String X) {
		return Double.parseDouble(X);
	}
	
	/**
	 * Term that returns a randomly generated int value.
	 * 
	 * @return a positive random integer number
	 */
	@TERM
	public int randomInt() {
		return java.lang.Math.abs(random.nextInt());
	}
	
	/**
	 * Term that returns the absolute value of the given integer.
	 * 
	 * @param i a value
	 * @return the absolute value of the parameter
	 */

	@TERM
	public int abs(int i) {
		return java.lang.Math.abs(i);
	}
}