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

Numeric value. More...

#include <Number.h>

Inheritance diagram for utl::Number< T >:

Public Member Functions

 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...
 
virtual Number< T > & set (const String &)
 Set from a string representation. More...
 
 operator T () const
 Conversion to built-in type. More...
 
Operations (non-const)
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)
 
Operations (const)
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...
 
virtual size_t hash (size_t size) const
 Get the hash code for the object. 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::Number< T >

Numeric value.

Author
Adam McKee

Definition at line 23 of file Number.h.

Constructor & Destructor Documentation

◆ Number()

template<class T>
utl::Number< T >::Number ( n)
inline

Constructor.

Parameters
ninitial value

Definition at line 32 of file Number.h.

Member Function Documentation

◆ copy()

template<class T >
void utl::Number< T >::copy ( const Object rhs)
virtual

Copy another instance.

When you override copy(), you should usually call the superclass's copy().

Parameters
rhsobject to copy

Reimplemented from utl::Object.

Definition at line 230 of file Number.h.

◆ compare()

template<class T >
int utl::Number< T >::compare ( const Object rhs) const
virtual

Compare with another object.

If no overridden version succeeds in doing the comparison, then an attempt will be made to re-start the comparison process using one or both of the objects' keys. Usually, an override of compare() should call the superclass's compare() if it doesn't know how to compare itself with the rhs object.

See also
getKey
Returns
< 0 if self < rhs, 0 if self = rhs, > 0 if self > rhs
Parameters
rhsobject to compare with

Reimplemented from utl::Object.

Reimplemented in utl::Float.

Definition at line 241 of file Number.h.

◆ serialize()

template<class T >
void utl::Number< T >::serialize ( Stream stream,
uint_t  io,
uint_t  mode = ser_default 
)
virtual

Serialize to or from a stream.

This is the only virtual method for serialization. You must override this in any class that has data to be serialized, and ensure that the superclass's serialize() gets called.

Parameters
streamstream to serialize from/to
iosee utl::io_t
modesee utl::serialize_t

Reimplemented from utl::Object.

Reimplemented in utl::Uint, utl::Char, utl::Float, and utl::Int.

Definition at line 260 of file Number.h.

◆ toString() [1/2]

template<class T >
String utl::Number< T >::toString ( ) const
virtual

Return a string representation of self.

Reimplemented from utl::Object.

Definition at line 279 of file Number.h.

◆ toString() [2/2]

template<class T >
String utl::Number< T >::toString ( const char *  fmt) const

Convert to string.

Parameters
fmtsprintf(3) format string

Definition at line 290 of file Number.h.

◆ get()

template<class T>
T utl::Number< T >::get ( ) const
inline

Get the value.

Definition at line 53 of file Number.h.

Referenced by utl::Time::operator+(), utl::Time::operator+=(), utl::Time::operator-(), and utl::Time::operator-=().

◆ set() [1/2]

template<class T>
void utl::Number< T >::set ( n)
inline

Set the value.

Definition at line 60 of file Number.h.

◆ set() [2/2]

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

Set from a string representation.

Reimplemented in utl::Duration, utl::Integer< T >, utl::Integer< int64_t >, utl::Integer< char >, utl::Integer< uint64_t >, and utl::Float.

Definition at line 67 of file Number.h.

◆ operator T()

template<class T>
utl::Number< T >::operator T ( ) const
inline

Conversion to built-in type.

Definition at line 74 of file Number.h.

References utl::deInit(), utl::init(), and UTL_CLASS_IMPL_TPL.


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