BigSurd

java.lang.Object
- etomica.veos.bigdecimal.BigSurd

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<BigSurd>
```
public class BigSurd
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<BigSurd>
```
Square roots on the real line. These represent numbers which are a product of a (signed) fraction by a square root of a non-negative fraction. This might be extended to values on the imaginary axis by allowing negative values underneath the square root, but this is not yet implemented.

Since:

2011-02-12

Field Summary

Fields
Modifier and Type Field Description

static BigSurd ONE
The value of one.

static BigSurd ZERO
The value of zero.

Fields
Modifier and Type	Field	Description
`static BigSurd`	`ONE`	The value of one.
`static BigSurd`	`ZERO`	The value of zero.

Constructor Summary

Constructors
Constructor	Description
`BigSurd()`	Default ctor, which represents the zero.
`BigSurd(int a, int b)`	ctor given the numerator and denominator of the root.
`BigSurd(Rational a, Rational b)`	ctor given the prefactor and the basis of the root.
`BigSurd(java.math.BigInteger a)`	ctor given the value under the root.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BigSurd`	`abs()`	Absolute value.
`BigSurdVec`	`add(BigSurd val)`	Add two surds of compatible discriminant.
`java.math.BigDecimal`	`BigDecimalValue(java.math.MathContext mc)`	Return the approximate floating point representation.
`BigSurd`	`clone()`	Create a deep copy.
`int`	`compareTo(BigSurd val)`	Compares the value of this with another constant.
`BigSurd`	`divide(int val)`	Divide by an integer.
`BigSurd`	`divide(BigSurd val)`	Divide by another square root.
`BigSurd`	`divide(java.math.BigInteger val)`	Divide by an integer.
`double`	`doubleValue()`	Return a double value representation.
`float`	`floatValue()`	Return a float value representation.
`boolean`	`isBigInteger()`	True if the value is integer.
`boolean`	`isRational()`	True if the value is rational.
`BigSurd`	`multiply(int val)`	Multiply by an integer.
`BigSurd`	`multiply(BigSurd val)`	Multiply by another square root.
`BigSurd`	`multiply(Rational val)`	Multiply by a rational number.
`BigSurd`	`multiply(java.math.BigInteger val)`	Multiply by a BigInteger.
`BigSurd`	`negate()`	Compute the negative.
`protected void`	`normalize()`	Normalize to squarefree discriminant.
`protected void`	`normalizeG()`	Normalize to coprime numerator and denominator in prefactor and discriminant
`int`	`signum()`	The sign: 1 if the number is >0, 0 if ==0, -1 if <0
`Rational`	`sqr()`	Compute the square.
`Rational`	`toRational()`	Convert to a rational value if possible
`java.lang.String`	`toString()`	Return a string in the format (number/denom)*()^(1/2).

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ZERO
```
public static BigSurd ZERO
```
    The value of zero.
  - ONE
```
public static BigSurd ONE
```
    The value of one.
- Constructor Detail
  - BigSurd
```
public BigSurd()
```
    Default ctor, which represents the zero.
    
    Since:
    
    2011-02-12
  - BigSurd
```
public BigSurd(Rational a,
               Rational b)
```
    ctor given the prefactor and the basis of the root. This creates an object of value a*sqrt(b).
    
    Parameters:
    
    a - the prefactor.
    
    b - the discriminant.
    
    Since:
    
    2011-02-12
  - BigSurd
```
public BigSurd(int a,
               int b)
```
    ctor given the numerator and denominator of the root. This creates an object of value sqrt(a/b).
    
    Parameters:
    
    a - the numerator
    
    b - the denominator.
    
    Since:
    
    2011-02-12
  - BigSurd
```
public BigSurd(java.math.BigInteger a)
```
    ctor given the value under the root. This creates an object of value sqrt(a).
    
    Parameters:
    
    a - the discriminant.
    
    Since:
    
    2011-02-12
- Method Detail
  - clone
```
public BigSurd clone()
```
    Create a deep copy.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Since:
    
    2011-02-12
  - add
```
public BigSurdVec add(BigSurd val)
```
    Add two surds of compatible discriminant.
    
    Parameters:
    
    val - The value to be added to this.
  - multiply
```
public BigSurd multiply(BigSurd val)
```
    Multiply by another square root.
    
    Parameters:
    
    val - a second number of this type.
    
    Returns:
    
    the product of this with the val.
    
    Since:
    
    2011-02-12
  - multiply
```
public BigSurd multiply(Rational val)
```
    Multiply by a rational number.
    
    Parameters:
    
    val - the factor.
    
    Returns:
    
    the product of this with the val.
    
    Since:
    
    2011-02-15
  - multiply
```
public BigSurd multiply(java.math.BigInteger val)
```
    Multiply by a BigInteger.
    
    Parameters:
    
    val - a second number.
    
    Returns:
    
    the product of this with the value.
    
    Since:
    
    2011-02-12
  - multiply
```
public BigSurd multiply(int val)
```
    Multiply by an integer.
    
    Parameters:
    
    val - a second number.
    
    Returns:
    
    the product of this with the value.
    
    Since:
    
    2011-02-12
  - sqr
```
public Rational sqr()
```
    Compute the square.
    
    Returns:
    
    this value squared.
    
    Since:
    
    2011-02-12
  - divide
```
public BigSurd divide(BigSurd val)
```
    Divide by another square root.
    
    Parameters:
    
    val - A second number of this type.
    
    Returns:
    
    The value of this/val
    
    Since:
    
    2011-02-12
  - divide
```
public BigSurd divide(java.math.BigInteger val)
```
    Divide by an integer.
    
    Parameters:
    
    val - a second number.
    
    Returns:
    
    the value of this/val
    
    Since:
    
    2011-02-12
  - divide
```
public BigSurd divide(int val)
```
    Divide by an integer.
    
    Parameters:
    
    val - A second number.
    
    Returns:
    
    The value of this/val
    
    Since:
    
    2011-02-12
  - negate
```
public BigSurd negate()
```
    Compute the negative.
    
    Returns:
    
    -this.
    
    Since:
    
    2011-02-12
  - abs
```
public BigSurd abs()
```
    Absolute value.
    
    Returns:
    
    The absolute (non-negative) value of this.
    
    Since:
    
    2011-02-12
  - compareTo
```
public int compareTo(BigSurd val)
```
    Compares the value of this with another constant.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<BigSurd>
    
    Parameters:
    
    val - the other constant to compare with
    
    Returns:
    
    -1, 0 or 1 if this number is numerically less than, equal to, or greater than val.
    
    Since:
    
    2011-02-12
  - toString
```
public java.lang.String toString()
```
    Return a string in the format (number/denom)*()^(1/2). If the discriminant equals 1, print just the prefactor.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the human-readable version in base 10
    
    Since:
    
    2011-02-12
  - doubleValue
```
public double doubleValue()
```
    Return a double value representation.
    
    Returns:
    
    The value with double precision.
    
    Since:
    
    2011-02-12
  - floatValue
```
public float floatValue()
```
    Return a float value representation.
    
    Returns:
    
    The value with single precision.
    
    Since:
    
    2011-02-12
  - isBigInteger
```
public boolean isBigInteger()
```
    True if the value is integer. Equivalent to the indication whether a conversion to an integer can be exact.
    
    Since:
    
    2011-02-12
  - isRational
```
public boolean isRational()
```
    True if the value is rational. Equivalent to the indication whether a conversion to a Rational can be exact.
    
    Since:
    
    2011-02-12
  - toRational
```
public Rational toRational()
```
    Convert to a rational value if possible
    
    Since:
    
    2012-02-15
  - signum
```
public int signum()
```
    The sign: 1 if the number is >0, 0 if ==0, -1 if <0
    
    Returns:
    
    the signum of the value.
    
    Since:
    
    2011-02-12
  - normalize
```
protected void normalize()
```
    Normalize to squarefree discriminant.
    
    Since:
    
    2011-02-12
  - normalizeG
```
protected void normalizeG()
```
    Normalize to coprime numerator and denominator in prefactor and discriminant
    
    Since:
    
    2011-02-12
  - BigDecimalValue
```
public java.math.BigDecimal BigDecimalValue(java.math.MathContext mc)
```
    Return the approximate floating point representation.
    
    Parameters:
    
    mc - Description of the accuracy needed.
    
    Returns:
    
    A representation with digits valid as described by mc
    
    Since:
    
    2012-02-15

Class BigSurd

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

ONE

Constructor Detail

BigSurd

BigSurd

BigSurd

BigSurd

Method Detail

clone

add

multiply

multiply

multiply

multiply

sqr

divide

divide

divide

negate

abs

compareTo

toString

doubleValue

floatValue

isBigInteger

isRational

toRational

signum

normalize

normalizeG

BigDecimalValue