Package etomica.veos.bigdecimal

Class BigSurdVec

java.lang.Object

etomica.veos.bigdecimal.BigSurdVec

All Implemented Interfaces:

java.lang.Comparable<BigSurdVec>

public class BigSurdVec
extends java.lang.Object
implements java.lang.Comparable<BigSurdVec>

A BigSurdVec represents an algebraic sum or differences of values which each term an instance of BigSurd. This mainly means that sums or differences of two BigSurd (or two BigSurdVec) can be represented (exactly) as a BigSurdVec.

Since:

2012-02-15

Field Summary

Fields

Modifier and Type	Field	Description
static BigSurdVec	ONE	The value of one.
static BigSurdVec	ZERO	The value of zero.

Constructor Summary

Constructors

Constructor	Description
BigSurdVec()	Default ctor, which represents the zero.
BigSurdVec(BigSurd a)	ctor given the value of a BigSurd.
BigSurdVec(BigSurd a, BigSurd b)	ctor given two values, which (when added) represent this number a+b.

Method Summary

Modifier and Type	Method	Description
BigSurdVec	add(BigSurd val)	Add two vectors algebraically.
BigSurdVec	add(BigSurdVec val)	Add two vectors algebraically.
java.math.BigDecimal	BigDecimalValue(java.math.MathContext mc)	Construct an approximate floating point representation
int	compareTo(BigSurdVec oth)	Compare algebraic value with oth.
double	doubleValue()	Construct an approximate floating point representation
double	floatValue()	Construct an approximate floating point representation
BigSurdVec	multiply(BigSurd val)	Multiply by another square root.
BigSurdVec	negate()	Compute the negative.
protected void	normalize()	Combine terms that can be written as a single surd.
int	signum()	Sign function.
BigSurdVec	sqr()	Compute the square.
BigSurdVec	subtract(BigSurd val)	Subtract another number.
BigSurdVec	subtract(BigSurdVec val)	Subtract another number.
java.lang.String	toString()	Return a string in the format (number/denom)*()^(1/2).

Methods inherited from class java.lang.Object

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

Field Detail

ZERO

public static BigSurdVec ZERO

The value of zero.

ONE

public static BigSurdVec ONE

The value of one.

Constructor Detail

BigSurdVec

public BigSurdVec()

Default ctor, which represents the zero.

Since:

2012-02-15

BigSurdVec

public BigSurdVec(BigSurd a)

ctor given the value of a BigSurd.

Parameters:

a - The value to be represented by this vector.

Since:

2012-02-15

BigSurdVec

public BigSurdVec(BigSurd a,
                  BigSurd b)

ctor given two values, which (when added) represent this number a+b.

Parameters:

a - The value to be represented by the first term of the vector.

b - The value to be represented by the second term of the vector.

Since:

2012-02-15

Method Detail

normalize

protected void normalize()

Combine terms that can be written as a single surd. This unites for example the terms sqrt(90) and sqrt(10) to 4*sqrt(10).

Since:

2012-02-15

compareTo

public int compareTo(BigSurdVec oth)

Compare algebraic value with oth. Returns -1, 0 or +1 depending on whether this is smaller, equal to or larger than oth.

Specified by:

compareTo in interface java.lang.Comparable<BigSurdVec>

Parameters:

oth - The value with which this is to be compared.

Returns:

0 or +-1.

Since:

2012-02-15

signum

public int signum()

Sign function. Returns -1, 0 or +1 depending on whether this is smaller, equal to or larger than zero.

Returns:

0 or +-1.

Since:

2012-02-15

BigDecimalValue

public java.math.BigDecimal BigDecimalValue(java.math.MathContext mc)

Construct an approximate floating point representation

Parameters:

mc - The intended accuracy of the result.

Returns:

A truncated version with the precision described by mc

doubleValue

public double doubleValue()

Construct an approximate floating point representation

Returns:

A truncated version with the precision described by mc

floatValue

public double floatValue()

Construct an approximate floating point representation

Returns:

A truncated version with the precision described by mc

add

public BigSurdVec add(BigSurdVec val)

Add two vectors algebraically.

Parameters:

val - The value to be added to this.

Returns:

The new value representing this+val.

add

public BigSurdVec add(BigSurd val)

Add two vectors algebraically.

Parameters:

val - The value to be added to this.

Returns:

The new value representing this+val.

subtract

public BigSurdVec subtract(BigSurdVec val)

Subtract another number.

Parameters:

val - The value to be subtracted from this.

Returns:

The new value representing this-val.

subtract

public BigSurdVec subtract(BigSurd val)

Subtract another number.

Parameters:

val - The value to be subtracted from this.

Returns:

The new value representing this-val.

negate

public BigSurdVec negate()

Compute the negative.

Returns:

-this.

Since:

2012-02-15

sqr

public BigSurdVec sqr()

Compute the square.

Returns:

this value squared.

Since:

2012-02-15

multiply

public BigSurdVec 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

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:

2012-02-16