Sitemap | Search || Zen Spider Website / Satori / Satori Class Index / Class UInteger

Class UInteger

• 	class UInteger
  	Programmer: Ryan Davis

• • Description:

• • Define a "plug & play" unsigned integer class in order to

• catch any and all improper arithmetic errors such as
• overflow, underflow, division by zero, etc...
• Methods
• Constructors
• • • Public Methods:

  • • • • UInteger
      • (unsigned long value = 0L);
      • This constructer assigns the object 'value' which defaults to zero.
• • 
    
  • 
    
  • • UInteger
  • (const SInteger &);
  • This is the conversion constructor and allows the compiler to make a copy
• of an SInteger object.
• • 
    
  • 
    
  • • UInteger
  • (const UInteger &);
  • This is the copy constructor and allows the compiler to make a copy
• of another UInteger object.
• • 
    
  • 
    
  • • ~UInteger
  • ();
  • This is the destuctor for the class UInteger. It sets the object's
• value to zero.
• Assignment & Conversions
• • 
    
  • 
    
  • UInteger &
  • • operator =
  • (const UInteger & rhs);
  • The operator equal assigns the value of one UInteger to this
• UInteger.
• • 
    
  • 
    
  • UInteger &
  • • operator =
  • (const SInteger & rhs);
  • The operator equal assigns the value of one SInteger to this
• UInteger.
• • 
    
  • 
    
  • unsigned long
  • • asULong
  • ();
  • This returns the objects value as an unsigned long.
• Simple Arithmetic
• • 
    
  • 
    
  • const UInteger operator
  • (const UInteger & rhs);
  • The '+' operator checks for overflow, then adds two UIntegers.
• • 
    
  • 
    
  • const UInteger operator
  • • -
  • (const UInteger & rhs);
  • The '-' operator checks for underflow, then subtracts two UIntegers.
• • 
    
  • 
    
  • const UInteger operator
  • • *
  • (const UInteger & rhs);
  • The '*' operator checks for overflow, then multplies two UIntegers.
• • 
    
  • 
    
  • const UInteger operator
  • • /
  • (const UInteger & rhs);
  • The '/' operator checks for division by zero, then divides two
• UIntegers.
• • 
    
  • 
    
  • const UInteger operator
  • • %
  • (const UInteger & rhs);
  • The modulo operator checks for division by zero, then Mods two
• UIntegers.
• Bitwise Arithmetic
• • 
    
  • 
    
  • const UInteger operator
  • • <<
  • (const UInteger & rhs);
  • The shift left operator asserts that the shift is not larger than
• the number of bits in an an unsigned long. It returns a UInteger.
• shifted left by the desired amount.
• • 
    
  • 
    
  • const UInteger operator
  • • >>
  • (const UInteger & rhs);
  • The shift right operator asserts that the shift is not larger than
• the number of bits in an an unsigned long. It returns a UInteger.
• shifted right by the desired amount.
• Arithmetic Assignment
• • 
    
  • 
    
  • UInteger &
  • • operator +=
  • (const UInteger & rhs);
  • The '+=' operator adds and assigns a UInteger to the this UInteger.
• • 
    
  • 
    
  • UInteger &
  • • operator -=
  • (const UInteger & rhs);
  • The '-=' operator subtracts and assigns a UInteger to the this
• UInteger.
• • 
    
  • 
    
  • UInteger &
  • • operator *=
  • (const UInteger & rhs);
  • The '*=' operator multplies and assigns a UInteger to the this
• UInteger.
• • 
    
  • 
    
  • UInteger &
  • • operator /=
  • (const UInteger & rhs);
  • The '/=' operator divides and assigns a UInteger to the this
• UInteger.
• • 
    
  • 
    
  • UInteger &
  • • operator %=
  • (const UInteger & rhs);
  • The '%=' operator takes the result of the division of two UIntegers
• and assigns the result to the this UInteger.
• Bitwise Arithmetic Assignment
• • 
    
  • 
    
  • UInteger &
  • • operator <<=
  • (const UInteger & rhs);
  • The '<<=' operator shifts left a UInteger and assigns the result to
• the this UInteger. This asserts that the shift is not larger than
• the number of bits in an an unsigned long.
• • 
    
  • 
    
  • UInteger &
  • • operator >>=
  • (const UInteger & rhs);
  • The '>>=' operator shifts right a UInteger and assigns the result to
• the this UInteger. This asserts that the shift is not larger than
• the number of bits in an an unsigned long.
• Increment & Decrement:
• • 
    
  • 
    
  • UInteger &
  • • operator ++
  • ();
  • The Prefix increment takes no arguments. It increases the UInteger
• by one before the object is used. This asserts that myValue is not
• max.
• • 
    
  • 
    
  • const UInteger operator
  • • +
  • (int x);
  • The Postfix increment takes no arguments. It increases the UInteger
• by one after the object is used. This asserts that myValue is not
• max.
• • 
    
  • 
    
  • UInteger &
  • • operator --
  • ();
  • The Prefix decrement takes no arguments. It decreases the UInteger
• by one before the object is used. This asserts that myValue is not
• zero.
• • 
    
  • 
    
  • const UInteger operator
  • • --
  • (int x);
  • The Postfix decrement takes no arguments. It decreases the UInteger
• by one after the object is used. This asserts that myValue is not
• zero.
• Boolean Logic
• • 
    
  • 
    
  • const Boolean operator
  • • <
  • (const UInteger & rhs);
  • The less than operator compares two UIntegers and returns a Boolean.
• The Boolean is true if this UInteger is less than 'rhs', false
• otherwise.
• • 
    
  • 
    
  • const Boolean operator
  • • >
  • (const UInteger & rhs);
  • The greater than operator compares two UIntegers and returns a
• Boolean. The Boolean is true if this UInteger is greater than than
• 'rhs', false otherwise.
• • 
    
  • 
    
  • const Boolean operator
  • • <=
  • (const UInteger & rhs);
  • The less than or equal to operator compares two UIntegers and
• returns a Boolean. The Boolean is true if this UInteger is less than
• or equal to 'rhs', false otherwise.
• • 
    
  • 
    
  • const Boolean operator
  • • >=
  • (const UInteger & rhs);
  • The greater than or equal to operator compares two UIntegers and
• returns a Boolean. The Boolean is true if this UInteger is greater
• than or equal to 'rhs', false otherwise.
• • 
    
  • 
    
  • const Boolean operator
  • • =
  • (const UInteger & rhs);
  • The equality operartor compares two UIntegers and returns a Boolean.
• The Boolean is true if this UInteger is equal to 'rhs', false
• otherwise.
• • 
    
  • 
    
  • const Boolean operator
  • • !=
  • (const UInteger & rhs);
  • The not equals to operator compares two UIntegers and returns a
• Boolean. The Boolean is true if this UInteger is not equal to 'rhs',
• false otherwise.
• This is the test driver. It massages every possible use of UInteger,
• both good input and bad...
• Static Data
• • 
    
  • 
    
  • • Protected Methods:

  • • Protected Members:

  • • • 
        
      • unsigned long
      • • myValue;
      • myValue is an unsigned long. It is accessed only inside the
• UInteger because it is protected data.
• • 
    
  • 
    

Sitemap | Search || Zen Spider Website / Satori / Satori Class Index / Class UInteger