nce.base

Class NCE

java.lang.Object

nce.base.NCE

public final class NCE
extends java.lang.Object

The very basic class that contains all the setup and init routines

Version:

20160821

Author:

Carlo Tegano

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NCE.INTERNAL_UNITS Defines NCE internal measuring units for common variables

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	ERR
static GlobalErrorStack	GlobalErrorStack
static java.util.logging.Logger	LOG
static double	MACHINE_EPS
static double	NCE_INF
static double	NCE_NEG_INF
static double	NCE_POS_INF
static double	NCE_ZERO
static double	NOTCOMPUTED
static double	SQRT_MACHINE_EPS
static java.lang.String	VERSION
static java.lang.String	VERSION_DATE

Constructor Summary

Constructors

Constructor and Description
NCE()

Method Summary

Methods

Modifier and Type	Method and Description
static void	init() Initialization procedure for NCE environment.
static boolean	isError(double value) Check validity of argument
static boolean	isSortedAscending(double[] arr) Checks if an array of doubles is sorted ascending
static boolean	isZero(double d) Checks if argument is zero within system precision
static boolean	sumToOne(double[] x) Checks if argument sums to 1 within system precision
static void	swap(double a, double b) Swaps arguments
static java.lang.String	toStringDerivedInternalUnits() Returns a formatted list of NCE internal derived measuring units
static java.lang.String	toStringFundamentalInternalUnits() Returns a formatted list of NCE internal fundamental measuring units

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

VERSION_DATE

public static final java.lang.String VERSION_DATE

See Also:

Constant Field Values

MACHINE_EPS

public static final double MACHINE_EPS

SQRT_MACHINE_EPS

public static final double SQRT_MACHINE_EPS

NCE_ZERO

public static final double NCE_ZERO

NCE_INF

public static final double NCE_INF

NOTCOMPUTED

public static final double NOTCOMPUTED

See Also:

Constant Field Values

NCE_POS_INF

public static final double NCE_POS_INF

See Also:

Constant Field Values

NCE_NEG_INF

public static final double NCE_NEG_INF

See Also:

Constant Field Values

LOG

public static final java.util.logging.Logger LOG

ERR

public static final java.util.logging.Logger ERR

GlobalErrorStack

public static GlobalErrorStack GlobalErrorStack

Constructor Detail

NCE

public NCE()

Method Detail

init

public static void init()

Initialization procedure for NCE environment. MUST be called prior to any NCE calculation.

isZero

public static boolean isZero(double d)

Checks if argument is zero within system precision

Parameters:

d -

Returns:

true if argument is zero

sumToOne

public static boolean sumToOne(double[] x)

Checks if argument sums to 1 within system precision

Parameters:

x - array of doubles

Returns:

true if argument sums to 1

isError

public static boolean isError(double value)

Check validity of argument

Parameters:

value - value to be checked

Returns:

true if value is not acceptable

swap

public static void swap(double a,
        double b)

Swaps arguments

Parameters:

a -

b -

isSortedAscending

public static boolean isSortedAscending(double[] arr)

Checks if an array of doubles is sorted ascending

Parameters:

arr - array of doubles

Returns:

true if the array is sorted

toStringFundamentalInternalUnits

public static java.lang.String toStringFundamentalInternalUnits()

Returns a formatted list of NCE internal fundamental measuring units

Returns:

Formatted string with NCE internal units

toStringDerivedInternalUnits

public static java.lang.String toStringDerivedInternalUnits()

Returns a formatted list of NCE internal derived measuring units

Returns:

Formatted string with NCE internal units