Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.ojalgo.scalar
Class PrimitiveScalar

java.lang.Object
  extended by java.lang.Number
      extended by org.ojalgo.scalar.PrimitiveScalar
All Implemented Interfaces:
Serializable, Comparable<Double>, Scalar<Double>
public final class PrimitiveScalar
extends Number

See Also:
Serialized Form

Field Summary
static PrimitiveScalar NaN
           
static PrimitiveScalar NEGATIVE_INFINITY
           
static PrimitiveScalar ONE
           
static PrimitiveScalar POSITIVE_INFINITY
           
static PrimitiveScalar ZERO
           
 
Constructor Summary
PrimitiveScalar(double aNmbr)
           
PrimitiveScalar(Number aNmbr)
           
 
Method Summary
 Scalar<Double> add(double aNmbr)
           
 PrimitiveScalar add(Double aNmbr)
           
 int compareTo(Double aNmbr)
           
 PrimitiveScalar conjugate()
           
 PrimitiveScalar divide(double aNmbr)
           
 PrimitiveScalar divide(Double aNmbr)
           
 double doubleValue()
           
 PrimitiveScalar enforce(NumberContext aCntxt)
           
 float floatValue()
           
 double getArgument()
           
 double getImaginary()
           
 double getModulus()
           
 Double getNumber()
           
 double getReal()
           
 int intValue()
           
 PrimitiveScalar invert()
           
 boolean isAbsolute()
           
 boolean isInfinite()
           
 boolean isNaN()
           
 boolean isReal()
           
 boolean isZero()
           
 long longValue()
           
 PrimitiveScalar multiply(double aNmbr)
           
 PrimitiveScalar multiply(Double aNmbr)
           
 PrimitiveScalar negate()
           
 PrimitiveScalar power(int anExp)
           
 PrimitiveScalar root(int anExp)
           
 Scalar<Double> round(NumberContext aCntxt)
           
 PrimitiveScalar subtract(double aNmbr)
           
 PrimitiveScalar subtract(Double aNmbr)
           
 BigDecimal toBigDecimal()
           
 ComplexNumber toComplexNumber()
           
 String toString()
           
 
Methods inherited from class java.lang.Number
byteValue, shortValue
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NaN

public static final PrimitiveScalar NaN

NEGATIVE_INFINITY

public static final PrimitiveScalar NEGATIVE_INFINITY

ONE

public static final PrimitiveScalar ONE

POSITIVE_INFINITY

public static final PrimitiveScalar POSITIVE_INFINITY

ZERO

public static final PrimitiveScalar ZERO
Constructor Detail

PrimitiveScalar

public PrimitiveScalar(double aNmbr)

PrimitiveScalar

public PrimitiveScalar(Number aNmbr)
Method Detail

add

public Scalar<Double> add(double aNmbr)
See Also:
Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

add

public PrimitiveScalar add(Double aNmbr)
See Also:
Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

compareTo

public int compareTo(Double aNmbr)

conjugate

public PrimitiveScalar conjugate()
See Also:
Scalar.conjugate(), Scalar.invert(), Scalar.negate()

divide

public PrimitiveScalar divide(double aNmbr)
See Also:
Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

divide

public PrimitiveScalar divide(Double aNmbr)
See Also:
Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

doubleValue

public double doubleValue()
Specified by:
doubleValue in class Number

enforce

public PrimitiveScalar enforce(NumberContext aCntxt)

floatValue

public float floatValue()
Specified by:
floatValue in class Number

getArgument

public double getArgument()
See Also:
Scalar.getArgument(), Scalar.getImaginary(), Scalar.getModulus(), Scalar.getReal()

getImaginary

public double getImaginary()
See Also:
Scalar.getArgument(), Scalar.getImaginary(), Scalar.getModulus(), Scalar.getReal()

getModulus

public double getModulus()
See Also:
Scalar.getArgument(), Scalar.getImaginary(), Scalar.getModulus(), Scalar.getReal()

getNumber

public Double getNumber()

getReal

public double getReal()
See Also:
Scalar.getArgument(), Scalar.getImaginary(), Scalar.getModulus(), Scalar.getReal()

intValue

public int intValue()
Specified by:
intValue in class Number

invert

public PrimitiveScalar invert()
See Also:
Scalar.conjugate(), Scalar.invert(), Scalar.negate()

isInfinite

public boolean isInfinite()
See Also:
Scalar.isAbsolute(), Scalar.isInfinite(), Scalar.isNaN(), Scalar.isReal(), Scalar.isZero()

isNaN

public boolean isNaN()
See Also:
Scalar.isAbsolute(), Scalar.isInfinite(), Scalar.isNaN(), Scalar.isReal(), Scalar.isZero()

isReal

public boolean isReal()
Returns:
true if the absolute value of the imaginary part is less than or equal to PrimitiveMath.IS_ZERO; otherwise false.
See Also:
Scalar.isAbsolute(), Scalar.isInfinite(), Scalar.isNaN(), Scalar.isReal(), Scalar.isZero()

longValue

public long longValue()
Specified by:
longValue in class Number

multiply

public PrimitiveScalar multiply(double aNmbr)
See Also:
Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

multiply

public PrimitiveScalar multiply(Double aNmbr)
See Also:
Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

negate

public PrimitiveScalar negate()
See Also:
Scalar.conjugate(), Scalar.invert(), Scalar.negate()

power

public PrimitiveScalar power(int anExp)
See Also:
Scalar.power(int), Scalar.root(int)

root

public PrimitiveScalar root(int anExp)
See Also:
Scalar.power(int), Scalar.root(int)

round

public Scalar<Double> round(NumberContext aCntxt)

subtract

public PrimitiveScalar subtract(double aNmbr)
See Also:
Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

subtract

public PrimitiveScalar subtract(Double aNmbr)
See Also:
Scalar.add(double), Scalar.add(Number), Scalar.divide(double), Scalar.divide(Number), Scalar.multiply(double), Scalar.multiply(Number), Scalar.subtract(double), Scalar.subtract(Number)

toBigDecimal

public BigDecimal toBigDecimal()

toComplexNumber

public ComplexNumber toComplexNumber()

toString

public String toString()
Overrides:
toString in class Object

isAbsolute

public final boolean isAbsolute()
Specified by:
isAbsolute in interface Scalar<N extends Number>
Returns:
true if this is equal to its own modulus (non-negative real part and no imaginary part); otherwise false.
See Also:
Scalar.isAbsolute(), Scalar.isInfinite(), Scalar.isNaN(), Scalar.isReal(), Scalar.isZero()

isZero

public final boolean isZero()
Specified by:
isZero in interface Scalar<N extends Number>
Returns:
true if the modulus is less than or equal to PrimitiveMath.IS_ZERO; otherwise false.
See Also:
Scalar.isAbsolute(), Scalar.isInfinite(), Scalar.isNaN(), Scalar.isReal(), Scalar.isZero()
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD