Public member functions documentation

virtual NzaeNumericField* abs() const

Gets the absolute value.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException: Returns one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumericField* add(const NzaeNumericField &other) const

Add.

Parameters

NzaeNumericField other: The field to add by.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException: Returns one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumericField* ceil() const

Gets the ceiling.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException: Returns one of the three NzaeNumericField-derived classes based on the field size.

virtual int32_t cmp(const NzaeNumericField &other) const

Compare.

Parameters

NzaeNumericField other: The field to compare.

Retruns

: Value of 0 if equal, -1 if one field is less than the other, 1 if one field is greater than the other.

Exceptions

NzaeException

virtual NzaeNumericField* div(const NzaeNumericField &other) const

Divide.

Parameters

NzaeNumericField other: The field to divide by.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException: Returns one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumericField* exp() const

Gets the exponent.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException

Returns the value of e (the base of natural logarithms) raised to the power of the value of object. Returns one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumericField* floor() const

Gets the floor.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException: Returs one of the three NzaeNumericField-derived classes based on the field size.

virtual int32_t getsign() const

Gets the sign.

Returns

: A value of 0 if the value is 0, -1 if it is negative, 1 if it is positive.

Returns the sign of the value.

virtual NzaeNumericField* ln() const

Gets the natural Log.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException: Returs one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumericField* log() const

Get the base 10 log.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException: Returs one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumericField* log(const NzaeNumericField &base) const

Gets the Log.

Parameters

NzaeNumericField base: Numeric Field base of the log.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException: Returs one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumericField* mod(const NzaeNumericField &other) const

Gets the modulus.

Parameters

NzaeNumericField other: Field to modulus by.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException: Returs one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumericField* mul(const NzaeNumericField &other) const

Multiply.

Parameters

NzaeNumericField other: Field to multiply by.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException: Returs one of the three NzaeNumericField-derived classes based on the field size.

NzaeNumericField()

Constructs a numeric field with precision and scale of 0.

operator double() const

Returns the value, converted to a double.

Returns

: The converted double value.

bool operator!=(const NzaeNumericField &x) const

Not Equal.

Parameters

NzaeNumericField x: The field to compare.

Returns

: TRUE if the field is not equal to x.

Exceptions

NzaeException

NzaeNumericField& operator%=(const NzaeNumericField &x)

Assignment by modulo.

Parameters

NzaeNumericField x: The field to modulus into the current field.

Returns

NzaeNumericField

Exceptions

NzaeException

NzaeNumericField& operator*=(const NzaeNumericField &x)

Assignment by multiplication.

Parameters

NzaeNumericField x: The field to multiply into the current field.

Returns

NzaeNumericField

Exceptions

NzaeException

NzaeNumericField& operator++()

Increment.

Returns

NzaeNumericField

Exceptions

NzaeException

NzaeNumericField& operator+=(const NzaeNumericField &x)

Assignment by addition.

Parameters

NzaeNumericField x: The field to add into the current field.

Returns

NzaeNumericField

Exceptions

NzaeException

NzaeNumericField& operator--()

Decrement.

Returns

NzaeNumericField

Exceptions

NzaeException

NzaeNumericField& operator-=(const NzaeNumericField &x)

Assignment by subtraction.

Returns

NzaeNumericField x: The field to subtract into the current field.

Exceptions

NzaeException

NzaeNumericField& operator/=(const NzaeNumericField &x)

Assignment by division.

Parameters

NzaeNumericField x: The field to divide into the current field.

Returns

NzaeNumericField

Exceptions

NzaeException

bool operator<(const NzaeNumericField &x) const

Less than.

Parameters

NzaeNumericField x: The field to compare.

Returns

: TRUE if the field is less than x.

Exceptions

NzaeException

bool operator<=(const NzaeNumericField &x) const

Less than or equal.

Parameters

NzaeNumericField x: The field to compare.

Returns

: TRUE if the field is less than or equal to x.

Exceptions

NzaeException

NzaeNumericField& operator=(int64_t val)

Assigns the value of the argument to a field object.

Parameters

val: The int64_t value to assign.

Returns

NzaeNumericField

NzaeNumericField& operator=(int32_t val)

Assigns the value of the argument to a field object.

Parameters

val: The int32_t value to assign.

Returns

NzaeNumericField

NzaeNumericField& operator=(const NzaeNumericField &val)

Assigns the value of the argument to a field object. The field argument may be a different type, as long as it is compatible.

Parameters

NzaeNumericField val: The field to assign.

Returns

NzaeNumericField

NzaeNumericField& operator=(double val)

Assigns the value of the argument to a field object.

Parameters

val: The double value to assign.

Returns

NzaeNumericField

bool operator==(const NzaeNumericField &x) const

Equal to.

Parameters

NzaeNumericField x: The field to compare.

Returns

: TRUE if the field is equal to x.

Exceptions

NzaeException

bool operator>(const NzaeNumericField &x) const

Greater than.

Parameters

NzaeNumericField x: The field to compare.

Returns

: TRUE if the field is greater than x.

Exceptions

NzaeException

bool operator>=(const NzaeNumericField &x) const

Greater than or equal.

Parameters

NzaeNumericField x: The field to compare with.

Returns

: TRUE if the field is greater than or equal to x.

Exception

NzaeException

virtual NzaeNumericField* power(const NzaeNumericField &exponent) const

Raise to a power.

Parameters

NzaeNumericField exponent: The power to raise field by.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exception

NzaeException

Returns one of the three NzaeNumericField-derived classes based on the field size.

int precision() const

Returns the precision.

Returns

: Returns the precision.

virtual NzaeNumericField* round(int scale=0) const

Rounds the value.

Parameters

scale: The number of integer places to the right of decimal point.

Returns

NzaeNumericField: The NzaeNumericField object.

Exceptions

NzaeException

int scale() const

Returns the scale.

Returns

: The scale.

void setPrecision(int prec)

Sets the precision.

Parameters

prec: The precision.

void setScale(int scale)

Sets the scale.

Parameters

scale: The scale.

virtual NzaeNumericField* sqrt() const

Gets the square root.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException

Returns one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumericField* sub(const NzaeNumericField &other) const

Subtract.

Parameters

NzaeNumericField other: The field to subtract by.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException

Returns one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumeric128Field* toNumeric128(int precision, int scale) const

Constructs a NzaeNumeric128Field from the current field.

Parameters

precision: The desired precision.

scale: The desired scale.

Returns

NzaeNumeric128Field: The new NzaeNumeric128Field object.

Exceptions

NzaeException

Uses the specified precision and scale for the new field.

virtual NzaeNumeric32Field* toNumeric32(int precision, int scale) const

Constructs a NzaeNumeric32Field from the current field.

Parameters

precision: The desired precision.

scale: The desired scale.

Returns

NzaeNumeric32Field: The new NzaeNumeric32Field object.

Exceptions

NzaeException

Uses the specified precision and scale for the new field.

virtual NzaeNumeric64Field* toNumeric64(int precision, int scale) const

Constructs a NzaeNumeric64Field from the current field.

Parameters

precision: The desired precision.

scale: The desired scale.

Returns

NzaeNumeric64Field: The new NzaeNumeric64Field object.

Exceptions

NzaeException

Uses the specified precision and scale for the new field.

virtual NzaeNumericField* trunc(int scale=0) const

Truncates the value.

Parameters

scale: The number of decimal places to truncate to.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException

Returns one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumericField* uminus() const

Unary minus.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException

Returns one of the three NzaeNumericField-derived classes based on the field size.

virtual NzaeNumericField* uplus() const

Unary plus.

Returns

NzaeNumericField: The new NzaeNumericField object.

Exceptions

NzaeException

Returns one of the three NzaeNumericField-derived classes based on the field size.

virtual ~NzaeNumericField()