Number Class

The Number class handles limited-precision signed base 10 numbers. A Number guarantees 38 decimal digits of precision. All positive numbers in the range displayed here can be represented to a full 38-digit precision:

10^-130

and

9.99999999999999999999999999999999999999*10^125 

The range of representable negative numbers is symmetrical.

The number zero can be represented exactly. Also, Oracle numbers have representations for positive and negative infinity. These are generally used to indicate overflow.

The internal storage type is opaque and private. Scale is not preserved when Number instances are created.

Number does not support the concept of NaN and is not IEEE-754-85 compliant. Number does support +Infinity and -Infinity.

Objects from the Number class can be used as standalone class objects in client side numerical computations. They can also be used to fetch from and set to the database.

/* Create a connection */
Environment *env = Environment::createEnvironment(Environment::DEFAULT);
Connection *conn = env->createConnection(user, passwd, db);

/* Create a statement and associate a select clause with it */
string sqlStmt = "SELECT department_id FROM DEPARTMENTS";
Statement *stmt = conn->createStatement(sqlStmt);

/* Run the statement to get a result set */
ResultSet *rset = stmt->executeQuery();
while(rset->next())
{
   Number deptId = rset->getNumber(1);
   /* Display the department id with the format string 9,999 */
   cout << "Department Id" << deptId.toText(env, "9,999");

   /* Use the number obtained as a bind value in the following query */
   stmt->setSQL("SELECT * FROM EMPLOYEES WHERE department_id = :x");
   stmt->setNumber(1, deptId);
   ResultSet *rset2 = stmt->executeQuery();
   .
   .
}
/* Using a Number object as a standalone and the operations on them */

/* Create a number to a double value */
double value = 2345.123;
Number nu1 (value);

/* Some common Number methods */
Number abs = nu1.abs();    /* absolute value */
Number sqrt = nu1.squareroot();    /* square root */
Environment *env = Environment::createEnvironment();

//create a null year-month interval
IntervalYM ym
if(ym.isNull())
   cout << "\n ym is null";

//assign a non null value to ym
IntervalYM anotherYM(env, "10-30");
ym = anotherYM;

//now all operations are valid on ym
int yr = ym.getYear();

Number()

Number class constructor.

Number();

Number(
   const Number &srcNum);

Number(
   long double &val);

Number(
   double val);

Number(
   float val);

Number(
   long val);

Number(
   int val);

Number(
   shot val);

Number(
   char val);

Number(
   signed char val);

Number(
   unsigned long val);

Number(
   unsigned int val);

Number(
   unsigned short val);

Number(
   unsigned char val);

srcNum

val

abs()

This method returns the absolute value of the Number object.

Syntax

const Number abs() const;

arcCos()

This method returns the arccosine of the Number object.

Syntax

const Number arcCos() const;

arcSin()

This method returns the arcsine of the Number object.

Syntax

const Number arcSin() const;

arcTan()

This method returns the arctangent of the Number object.

Syntax

const Number arcTan() const;

arcTan2()

This method returns the arctangent of the Number object with the parameter specified. It returns atan2 (val, x) where val is the parameter specified and x is the current number object.

Syntax

const Number arcTan2(
   const Number &val) const;

val

ceil()

This method returns the smallest integer that is greater than or equal to the Number object.

Syntax

const Number ceil() const;

cos()

This method returns the cosine of the Number object.

Syntax

const Number cos() const;

exp()

This method returns the natural exponential of the Number object.

Syntax

const Number exp() const;

floor()

This method returns the largest integer that is less than or equal to the Number object.

Syntax

const Number floor() const;

fromBytes()

This method returns a Number object represented by the byte string specified.

Syntax

void fromBytes(
   const Bytes &str);

str

fromText()

Sets Number object to value represented by a string or UString.

The value is interpreted based on the fmt and nlsParam parameters. In cases where nlsParam is not passed, the Globalization Support settings of the envp parameter are used.

void fromText(
   const Environment *envp,
   const string &number,
   const string &fmt,
   const string &nlsParam = "");

void fromText(
   const Environment *envp,
   const UString &number,
   const UString &fmt,
   const UString &nlsParam);

envp

number

fmt

nlsParam

hypCos()

This method returns the hypercosine of the Number object.

Syntax

const Number hypCos() const;

hypSin()

This method returns the hypersine of the Number object.

Syntax

const Number hypSin() const;

hypTan()

This method returns the hypertangent of the Number object.

Syntax

const Number hypTan() const;

intPower()

This method returns a Number whose value is the number object raised to the power of the value specified.

Syntax

const Number intPower(
   int val) const;

val

isNull()

This method tests whether the Number object is NULL. If the Number object is NULL, then TRUE is returned; otherwise, FALSE is returned.

Syntax

bool isNull() const;

ln()

This method returns the natural logarithm of the Number object.

Syntax

const Number ln() const;

log()

This method returns the logarithm of the Number object with the base provided by the parameter specified.

Syntax

const Number log(
   const Number &val) const;

val

operator++()

Unary operator++(). This is a postfix operator.

Number& operator++();

const Number operator++(
   int incr);

incr

operator--()

Unary operator--(). This is a prefix operator.

Number& operator--();

const Number operator--(
   int decr);

decr

operator*()

This method returns the product of the parameters specified.

Syntax

Number operator*(
   const Number &first,

const Number &second);

first

second

operator/()

This method returns the quotient of the parameters specified.

Syntax

Number operator/(
   const Number &dividend,
   const Number &divisor);

dividend

divisor

operator%()

This method returns the remainder of the division of the parameters specified.

Syntax

Number operator%(
   const Number &dividend,
   const Number &divider);

dividend

divizor

operator+()

This method returns the sum of the parameters specified.

Syntax

Number operator+(
   const Number &first,
   const Number &second);

first

second

operator-()

Unary operator-(). This method returns the negated value of the Number object.

Syntax

const Number operator-();

operator-()

This method returns the difference between the parameters specified.

Syntax

Number operator-(
   const Number &subtrahend,
   const Number &subtractor);

subtrahend

subtractor

operator<()

This method checks whether the first parameter specified is less than the second parameter specified. If the first parameter is less than the second parameter, then TRUE is returned; otherwise, FALSE is returned. If either parameter is equal to infinity, then FALSE is returned.

Syntax

bool operator<(
   const Number &first,
   const Number &second);

first

second

operator<=()

This method checks whether the first parameter specified is less than or equal to the second parameter specified. If the first parameter is less than or equal to the second parameter, then TRUE is returned; otherwise, FALSE is returned. If either parameter is equal to infinity, then FALSE is returned.

Syntax

bool operator<=(
   const Number &first,
   const Number &second);

first

second

operator>()

This method checks whether the first parameter specified is greater than the second parameter specified. If the first parameter is greater than the second parameter, then TRUE is returned; otherwise, FALSE is returned. If either parameter is equal to infinity, then FALSE is returned.

Syntax

bool operator>(
   const Number &first,
   const Number &second);

first

second

operator>=()

This method checks whether the first parameter specified is greater than or equal to the second parameter specified. If the first parameter is greater than or equal to the second parameter, then TRUE is returned; otherwise, FALSE is returned. If either parameter is equal to infinity, then FALSE is returned.

Syntax

bool operator>=(
   const Number &first,
   const Number &second);

first

second

operator==()

This method checks whether the parameters specified are equal. If the parameters are equal, then TRUE is returned; otherwise, FALSE is returned. If either parameter is equal to +infinity or -infinity, then FALSE is returned.

Syntax

bool operator==(
   const Number &first,
   const Number &second);

first

second

operator!=()

This method checks whether the first parameter specified is equal to the second parameter specified. If the parameters are not equal, TRUE is returned; otherwise, FALSE is returned.

Syntax

bool operator!=(
   const Number &first,
   const Number &second);

first

second

operator=()

This method assigns the value of the parameter specified to the Number object.

Syntax

Number& operator=(
   const Number &num);

num

operator*=()

This method multiplies the Number object by the parameter specified, and assigns the product to the Number object.

Syntax

Number& operator*=(
   const Number &num);

num

operator/=()

This method divides the Number object by the parameter specified, and assigns the quotient to the Number object.

Syntax

Number& operator/=(
   const Number &num);

num

operator%=()

This method divides the Number object by the parameter specified, and assigns the remainder to the Number object.

Syntax

Number& operator%=(
   const Number &num);

num

operator+=()

This method adds the Number object and the parameter specified, and assigns the sum to the Number object.

Syntax

Number& operator+=(
   const Number &num);

num

operator-=()

This method subtracts the parameter specified from the Number object, and assigns the difference to the Number object.

Syntax

Number& operator-=(
   const Number &num);

num

operator char()

This method returns the value of the Number object converted to a native char.

Syntax

operator char() const;

operator signed char()

This method returns the value of the Number object converted to a native signed char.

Syntax

operator signed char() const;

operator double()

This method returns the value of the Number object converted to a native double.

Syntax

operator double() const;

operator float()

This method returns the value of the Number object converted to a native float.

Syntax

operator float() const;

operator int()

This method returns the value of the Number object converted to a native int.

Syntax

operator int() const;

operator long()

This method returns the value of the Number object converted to a native long.

Syntax

operator long() const;

operator long double()

This method returns the value of the Number object converted to a native long double.

Syntax

operator long double() const;

operator short()

This method returns the value of the Number object converted to a native short integer.

Syntax

operator short() const;

operator unsigned char()

This method returns the value of the Number object converted to a native unsigned char.

Syntax

operator unsigned char() const;

operator unsigned int()

This method returns the value of the Number object converted to a native unsigned int.

Syntax

operator unsigned int() const;

operator unsigned long()

This method returns the value of the Number object converted to a native unsigned long.

Syntax

operator unsigned long() const;

operator unsigned short()

This method returns the value of the Number object converted to a native unsigned short integer.

Syntax

operator unsigned short() const;

power()

This method returns the value of the Number object raised to the power of the value provided by the parameter specified.

Syntax

const Number power(
   const Number &val) const;

val

prec()

This method returns the value of the Number object rounded to the digits of precision provided by the parameter specified.

Syntax

const Number prec(
   int digits) const;

digits

round()

This method returns the value of the Number object rounded to the decimal place provided by the parameter specified.

Syntax

const Number round(
   int decPlace) const;

decPlace

setNull()

This method sets the value of the Number object to NULL.

Syntax

void setNull();

shift()

This method returns the Number object multiplied by 10 to the power provided by the parameter specified.

Syntax

const Number shift(
   int val) const;

val

sign()

This method returns the sign of the value of the Number object. If the Number object is negative, then create a Date object using integer parameters is returned. If the Number object is equal to 0, then create a Date object using integer parameters is returned. If the Number object is positive, then 1 is returned.

Syntax

const int sign() const;

sin()

This method returns the sin of the Number object.

Syntax

const Number sin() const;

squareroot()

This method returns the square root of the Number object.

Syntax

const Number squareroot() const;

tan()

This method returns the tangent of the Number object.

Syntax

const Number tan() const;

toBytes()

This method converts the Number object into a Bytes object. The bytes representation is assumed to be in length excluded format, that is, the Byte.length() method gives the length of valid bytes and the 0th byte is the exponent byte.

Syntax

Bytes toBytes() const;

toText()

Convert the Number object to a formatted string or UString based on the parameters specified.

string toText(
   const Environment *envp,
   const string &fmt,
   const string &nlsParam = "") const;

UString toText(
   const Environment *envp,
   const UString &fmt,
   const UString &nlsParam) const;

envp

fmt

nlsParam

trunc()

This method returns the Number object truncated at the number of decimal places provided by the parameter specified.

Syntax

const Number trunc(
   int decPlace) const;

decPlace