libUTL++
utl::Integer< T > Class Template Reference

Integer value. More...

#include <Integer.h>

Inheritance diagram for utl::Integer< T >:

Public Member Functions

 Integer (T i)
 Constructor. More...
 
virtual size_t hash (size_t size) const
 Get the hash code for the object. More...
 
Integer< T > mod (const Integer< T > &rhs) const
 Get the result of self modulo rhs. More...
 
bool isDivisibleBy (T num) const
 Determine whether self is divisible by the given number. More...
 
Integer< T > nextMultiple (T target) const
 Determine the smallest number n, s.t. More...
 
virtual Number< T > & set (const String &str)
 Set from a decimal string representation. More...
 
Integer< T > & setBinary (const String &str)
 Set from a binary string representation. More...
 
Integer< T > & setHex (const String &str)
 Set from a hexadecimal string representation. More...
 
String toBinary (uint_t numDigits=0) const
 Get a binary string representation of the number. More...
 
String toOctal (uint_t numDigits=0) const
 Get octal representation of the number. More...
 
String toDecimal (uint_t numDigits=0) const
 Get a binary string representation of the number. More...
 
String toHex (uint_t numDigits=0) const
 Get a hexadecimal string representation of the number. More...
 
- Public Member Functions inherited from utl::Number< T >
 Number (T n)
 Constructor. More...
 
virtual void copy (const Object &rhs)
 Copy another instance. More...
 
virtual int compare (const Object &rhs) const
 Compare with another object. More...
 
virtual void serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
 Serialize to or from a stream. More...
 
String toString () const
 Return a string representation of self. More...
 
String toString (const char *fmt) const
 Convert to string. More...
 
get () const
 Get the value. More...
 
void set (T n)
 Set the value. More...
 
 operator T () const
 Conversion to built-in type. More...
 
Number< T > & operator+= (T rhs)
 
Number< T > & operator-= (T rhs)
 
Number< T > & operator*= (T rhs)
 
Number< T > & operator/= (T rhs)
 
Number< T > & operator+= (const Number< T > &rhs)
 
Number< T > & operator-= (const Number< T > &rhs)
 
Number< T > & operator*= (const Number< T > &rhs)
 
Number< T > & operator/= (const Number< T > &rhs)
 
operator+ (T rhs) const
 
operator- (T rhs) const
 
operator* (T rhs) const
 
operator/ (T rhs) const
 
operator+ (const Number< T > &rhs) const
 
operator- (const Number< T > &rhs) const
 
Number< T > operator* (const Number< T > &rhs) const
 
Number< T > operator/ (const Number< T > &rhs) const
 
Number< T > & operator++ ()
 
Number< T > & operator-- ()
 
operator++ (int)
 
operator-- (int)
 
- Public Member Functions inherited from utl::Object
void clear ()
 Revert to initial state. More...
 
virtual void vclone (const Object &rhs)
 Make an exact copy of another instance. More...
 
virtual void steal (Object &rhs)
 "Steal" the internal representation from another instance. More...
 
virtual void dump (Stream &os, uint_t level=uint_t_max) const
 Dump a human-readable representation of self to the given output stream. More...
 
void dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
 Front-end for dump() that prints the object's class name. More...
 
virtual const ObjectgetKey () const
 Get the key for this object. More...
 
bool hasKey () const
 Determine whether or not the object has a key. More...
 
virtual const ObjectgetProxiedObject () const
 Get the proxied object (= self if none). More...
 
virtual ObjectgetProxiedObject ()
 Get the proxied object (= self if none). More...
 
bool _isA (const RunTimeClass *runTimeClass) const
 Determine whether self's class is a descendent of the given class. More...
 
 operator String () const
 Conversion to String. More...
 
size_t allocatedSize () const
 Get the total allocated size of this object. More...
 
virtual size_t innerAllocatedSize () const
 Get the "inner" allocated size. More...
 
virtual void addOwnedIt (const class FwdIt *it) const
 Notify self that it owns the given iterator. More...
 
virtual void removeOwnedIt (const class FwdIt *it) const
 Notify self that the given owned iterator has been destroyed. More...
 
bool operator< (const Object &rhs) const
 Less-than operator. More...
 
bool operator<= (const Object &rhs) const
 Less-than-or-equal-to operator. More...
 
bool operator> (const Object &rhs) const
 Greater-than operator. More...
 
bool operator>= (const Object &rhs) const
 Greater-than-or-equal-to operator. More...
 
bool operator== (const Object &rhs) const
 Equal-to operator. More...
 
bool operator!= (const Object &rhs) const
 Unequal-to operator. More...
 
void serializeIn (Stream &is, uint_t mode=ser_default)
 Serialize from an input stream. More...
 
void serializeOut (Stream &os, uint_t mode=ser_default) const
 Serialize to an output stream. More...
 
void serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
 Serialize a boxed object to an output stream. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from utl::Object
static ObjectserializeInNullable (Stream &is, uint_t mode=ser_default)
 Serialize a nullptr-able object from an input stream. More...
 
static void serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
 Serialize a nullptr-able object to an output stream. More...
 
static void serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
 Serialize a nullptr-able object to or from a stream. More...
 
static ObjectserializeInBoxed (Stream &is, uint_t mode=ser_default)
 Serialize a boxed object from an input stream. More...
 
static void serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
 Serialize a boxed object to or from a stream. More...
 

Detailed Description

template<class T>
class utl::Integer< T >

Integer value.

Author
Adam McKee

Definition at line 23 of file Integer.h.

Constructor & Destructor Documentation

◆ Integer()

template<class T>
utl::Integer< T >::Integer ( i)
inline

Constructor.

Parameters
iinitial value

Definition at line 33 of file Integer.h.

Member Function Documentation

◆ hash()

template<class T >
size_t utl::Integer< T >::hash ( size_t  size) const
virtual

Get the hash code for the object.

The default implementation will return the hash code of the object's key, or abort if the object has none.

Returns
the hash code
Parameters
sizehash table size

Reimplemented from utl::Object.

Definition at line 112 of file Integer.h.

◆ mod()

template<class T>
Integer<T> utl::Integer< T >::mod ( const Integer< T > &  rhs) const
inline

Get the result of self modulo rhs.

Definition at line 42 of file Integer.h.

◆ isDivisibleBy()

template<class T>
bool utl::Integer< T >::isDivisibleBy ( num) const
inline

Determine whether self is divisible by the given number.

Definition at line 49 of file Integer.h.

◆ nextMultiple()

template<class T>
Integer<T> utl::Integer< T >::nextMultiple ( target) const
inline

Determine the smallest number n, s.t.

n is a multiple of self, and n >= target.

Definition at line 59 of file Integer.h.

◆ set()

template<class T>
Number< T > & utl::Integer< T >::set ( const String str)
virtual

Set from a decimal string representation.

Reimplemented from utl::Number< T >.

Definition at line 121 of file Integer.h.

◆ setBinary()

template<class T >
Integer< T > & utl::Integer< T >::setBinary ( const String str)

Set from a binary string representation.

Definition at line 144 of file Integer.h.

◆ setHex()

template<class T >
Integer< T > & utl::Integer< T >::setHex ( const String str)

Set from a hexadecimal string representation.

Definition at line 167 of file Integer.h.

◆ toBinary()

template<class T >
String utl::Integer< T >::toBinary ( uint_t  numDigits = 0) const

Get a binary string representation of the number.

Returns
binary string representation
Parameters
numDigitsnumber of digits

Definition at line 190 of file Integer.h.

◆ toOctal()

template<class T >
String utl::Integer< T >::toOctal ( uint_t  numDigits = 0) const

Get octal representation of the number.

Returns
binary string representation
Parameters
numDigitsnumber of digits

Definition at line 244 of file Integer.h.

◆ toDecimal()

template<class T >
String utl::Integer< T >::toDecimal ( uint_t  numDigits = 0) const

Get a binary string representation of the number.

Returns
binary string representation
Parameters
numDigitsnumber of digits

Definition at line 230 of file Integer.h.

◆ toHex()

template<class T >
String utl::Integer< T >::toHex ( uint_t  numDigits = 0) const

Get a hexadecimal string representation of the number.

Returns
hex string representation
Parameters
numDigitsnumber of digits

Definition at line 265 of file Integer.h.


The documentation for this class was generated from the following file: