changed: small changes especially cosmetic in documentation (commentaries)

changed: version of the library: now 0.8.2


git-svn-id: svn://ttmath.org/publicrep/ttmath/trunk@68 e52654a7-88a9-db11-a3e9-0013d4bc506e

CHANGELOG

@@ -1,122 +1,171 @@
+Version 0.8.2 (2008.06.18):
+    * added:   UInt::BitNot2() this method has been proposed by
+               Arek <kmicicc AnTispam users.sourceforge.net>
+    * changed: Int::FromInt(const Int<argument_size> & p), 
+               Int::FromInt(sint value) (it returns zero now)
+               Int::operator=(uint i)
+               Int::Int(uint i)
+    * added:   Int::FromUInt(const UInt<argument_size> & p),
+               Int::FromUInt(uint value)
+               and appropriate constructors and assignment 
+               operators as well
+    * changed: Big::FromInt(Int<int_size> value),
+    * added:   Big::FromUInt(UInt<int_size> value),
+               Big::operator=(const UInt<int_size> & value)
+               Big::Big(const UInt<int_size> & value)
+    * changed: the parser is allowed to recognize values which
+               begin with a dot, e.g '.5' is treated as '0.5'
+    * added:   a method Big::FromDouble(double) which converts from
+               standard double into a Big
+    * added:   uint Big::ToDouble(double&) - converting into double
+    * added:   Big::FromBig() and an operator= and a contructor
+               for converting from another kind of a Big class
+    * added:   to the parser: avg(), sum()
+    * added:   'decimal_point' parameter into Big::ToString(...)
+    * fixed:   Big::operator>> didn't use TTMATH_COMMA_CHARACTER_2 macro
+    * added:   a short form of multiplication (without the '*' character)
+               e.g. '5y', (it's used only if the second parameter
+               is a variable or function)
+    * changed: variables and functions are case-sensitive now
+    * added:   variables and functions can have underline characters
+               in their names
+    * changed: 'max_digit_after_comma' in Big::ToString()
+               remove the -2 state
+    * added:   'remove_trailing_zeroes' in Big::ToString()
+               it's either true or false
+    * fixed/changed: the way of using Big::SetSign()
+               the method do not check whether there is a zero or not now
+               (even if there's a zero the method can set a sign bit)
+               I changed this due to some prior errors
+               (errors corrected in revision 17, 49 and 58)
+
+
 Version 0.8.1 (2007.04.17):
-	* fixed: Big::PowFrac(..) didn't return a correct error code
-	  (when 'this' was negative)
-	* added: Root(x; index) (and to the parser as well)
-	* added: macro: TTMATH_PRERELEASE_VER (can be either zero or one)
-	* added: UInt::MulInt(int, UInt<int another_size>::&)
-	* added: Big::MulUInt(uint)
-	* changed: Big::MulInt(sint)
-	* added: Big::ToUInt(uint &)
-	* changed: Big::ToInt(sint&)
-	* changed: Factorial() it uses Big::MulUInt() at the beginning
-	  (faster now especially more on a 32bit platform)
-	* added: doxygen.cfg for generating a documentation from the doxygen
-	* changed: UInt::Rcl(uint c=0) and UInt::Rcr(uint c=0) into
-	  UInt::Rcl2(uint bits, uint c) and UInt::Rcr2(uint bits, uint c)
-	  now they can move more than one bit and they are only private
-	* fixed: UInt::Rcl(uint bits, uint c) and UInt::Rcr(uint bits, uint c)
-	  didn't correctly return a carry if the 'bits' were equal
-	  to 'value_size*TTMATH_BITS_PER_UINT'
-	* changed: UInt::Rcl(uint bits, uint c) and UInt::Rcr(uint bits, uint c)
-	  into UInt::Rcl(uint bits, uint c=0) and
-	  UInt::Rcr(uint bits, uint c=0)
-	  they are faster now when the bits is greater than a half of
-	  the TTMATH_BITS_PER_UINT
-	* changed: UInt::CompensationToLeft() it's faster now
-	* changed: more small changes where there were UInt::Rcl(uint c=0) and
-	  UInt::Rcr(uint c=0) used
-	* changed: as the Big type uses UInt::Rcl() and UInt::Rcr() a lot then
-	  it is much faster now (about 5-25%)
-	* added: ASinh(), ACosh(), ATanh() /ATgh()/, ACoth() /ACtgh()/
-	  and to the parser as well
-	* added: UInt::BitAnd(), UInt::BitOr(), UInt::BitXor(), UInt::BitNot(),
-	  Big::BitAnd(), Big::BitOr(), Big::BitXor()
-	* added: to the parser: bitand(), bitor(), bitxor()
-	  /band(), bor(), bxor()/
-	* changed: the way of parsing operators in the mathematical parser
-	  (the parser is not too much greedy now)
-	
+    * fixed:   Big::PowFrac(..) didn't return a correct error code
+               (when 'this' was negative)
+    * added:   Root(x; index) (and to the parser as well)
+    * added:   macro: TTMATH_PRERELEASE_VER (can be either zero or one)
+    * added:   UInt::MulInt(int, UInt<int another_size>::&)
+    * added:   Big::MulUInt(uint)
+    * changed: Big::MulInt(sint)
+    * added:   Big::ToUInt(uint &)
+    * changed: Big::ToInt(sint&)
+    * changed: Factorial() it uses Big::MulUInt() at the beginning
+               (faster now especially more on a 32bit platform)
+    * added:   doxygen.cfg for generating a documentation from the doxygen
+    * changed: UInt::Rcl(uint c=0) and UInt::Rcr(uint c=0) into
+               UInt::Rcl2(uint bits, uint c) and UInt::Rcr2(uint bits, uint c)
+               now they can move more than one bit and they are only private
+    * fixed:   UInt::Rcl(uint bits, uint c) and UInt::Rcr(uint bits, uint c)
+               didn't correctly return a carry if the 'bits' were equal
+               to 'value_size*TTMATH_BITS_PER_UINT'
+    * changed: UInt::Rcl(uint bits, uint c) and UInt::Rcr(uint bits, uint c)
+               into UInt::Rcl(uint bits, uint c=0) and
+               UInt::Rcr(uint bits, uint c=0)
+               they are faster now when the bits is greater than a half of
+               the TTMATH_BITS_PER_UINT
+    * changed: UInt::CompensationToLeft() it's faster now
+    * changed: more small changes where there were UInt::Rcl(uint c=0) and
+               UInt::Rcr(uint c=0) used
+    * changed: as the Big type uses UInt::Rcl() and UInt::Rcr() a lot then
+               it is much faster now (about 5-25%)
+    * added:   ASinh(), ACosh(), ATanh() /ATgh()/, ACoth() /ACtgh()/
+               and to the parser as well
+    * added:   UInt::BitAnd(), UInt::BitOr(), UInt::BitXor(), UInt::BitNot(),
+               Big::BitAnd(), Big::BitOr(), Big::BitXor()
+    * added:   to the parser: bitand(), bitor(), bitxor()
+               /band(), bor(), bxor()/
+    * changed: the way of parsing operators in the mathematical parser
+               (the parser is not too much greedy now)
+ 
+    
 Version 0.8.0 (2007.03.28):
-	* added: into the parser: SetFactorialMax()
-	* added: DegToDeg(deg, min, sec), DegToRad(deg), DegToRad(deg, min, sec),
-	  RadToDeg(rad), Ceil(x), Floor(x), Sqrt(x), Sinh(x), Cosh(x),
-	  Tanh(x) /Tgh(x)/, Coth(x) /Ctgh(x)/
-	* changed: class Objects in ttmathobjects.h has been completely rewritten,
-	  we can change the names of user-defined variables or functions, and the
-	  names are case-sensitive now
-	* added: class History which is used in functions which take a lot of time
-	  during calculating e.g. Factorial(x)
-	* added: Tg(x) a wrapper for Tan(x)
-	* changed: CTan(x) is Cot(x) now
-	* added: Ctg(x) a wrapper for Cot(x) 
-	* added: ATg(x) a wrapper for ATan(x)
-	* changed: ACTan(x) is ACot(x) now
-	* added: ACtg(x) a wrapper for ACot(x)
-	* added: UInt::PrintTable() (for debugging etc.)
-	* changed: the methods Big::SetPi() Big::SetE() and Big::SetLn2() have
-	  been rewritten, now they have 128 32bit words (it's about 1232 valid
-	  decimal digits)
-	* fixed: previous values from Big::SetPi() Big::SetE() and
-	  Big::SetLn2() were not too much accurate (last 2-3 words were wrong)
-	* added: Big::SetLn10() (128 32bit words as well)
-	* added: macro: TTMATH_BUILTIN_VARIABLES_SIZE which is equal 128u on
-	  32bit platforms and 64ul on 64bit platforms (128/2=64)
-	* added: macros: TTMATH_PLATFORM32 and TTMATH_PLATFORM64
-	* changed: a small optimisation in UInt::Mul2Big()
-	* added: at the end of ttmath.h: #include "ttmathparser.h"
-	  this is for convenience for a programmer, he can only use #include
-	  with ttmath.h even if he uses the parser
-	* added: to samples: big.cpp, parser.cpp
-	* added/changes/fixed: in copy-constructors and operators= in Int,
-	  Uint and Big (more info in the commit log)
-	* renamed Big::SetDotOne() into Big::Set05()
-	* changes: a few small optimisations in Big
-	* deleted: the word 'virtual' from destructors: UInt, Int, Big
-	  (types in this library are not projected to be base-classes for
-	  another ones derived from them)
-	* and more small changes (look at the commit log)	
+    * added:   into the parser: SetFactorialMax()
+    * added:   DegToDeg(deg, min, sec), DegToRad(deg), DegToRad(deg, min, sec),
+               RadToDeg(rad), Ceil(x), Floor(x), Sqrt(x), Sinh(x), Cosh(x),
+               Tanh(x) /Tgh(x)/, Coth(x) /Ctgh(x)/
+    * changed: class Objects in ttmathobjects.h has been completely rewritten,
+               we can change the names of user-defined variables or functions,
+               and the names are case-sensitive now
+    * added:   class History which is used in functions which take a lot of time
+               during calculating e.g. Factorial(x)
+    * added:   Tg(x) a wrapper for Tan(x)
+    * changed: CTan(x) is Cot(x) now
+    * added:   Ctg(x) a wrapper for Cot(x) 
+    * added:   ATg(x) a wrapper for ATan(x)
+    * changed: ACTan(x) is ACot(x) now
+    * added:   ACtg(x) a wrapper for ACot(x)
+    * added:   UInt::PrintTable() (for debugging etc.)
+    * changed: the methods Big::SetPi() Big::SetE() and Big::SetLn2() have
+               been rewritten, now they have 128 32bit words (it's about
+               1232 valid decimal digits)
+    * fixed:   previous values from Big::SetPi() Big::SetE() and
+               Big::SetLn2() were not too much accurate (last 2-3 words were wrong)
+    * added:   Big::SetLn10() (128 32bit words as well)
+    * added:   macro TTMATH_BUILTIN_VARIABLES_SIZE which is equal 128u on
+               32bit platforms and 64ul on 64bit platforms (128/2=64)
+    * added:   macros TTMATH_PLATFORM32 and TTMATH_PLATFORM64
+    * changed: a small optimisation in UInt::Mul2Big()
+    * added:   at the end of ttmath.h: #include "ttmathparser.h"
+               this is for convenience for a programmer, he can only use #include
+               with ttmath.h even if he uses the parser
+    * added:   to samples: big.cpp, parser.cpp
+    * added/changes/fixed: in copy-constructors and operators= in Int,
+               Uint and Big (more info in the commit log)
+    * renamed: Big::SetDotOne() into Big::Set05()
+    * changes: a few small optimisations in Big
+    * deleted: the word 'virtual' from destructors: UInt, Int, Big
+               (types in this library are not projected to be base-classes for
+               another ones derived from them)
+    * and more small changes (look at the commit log)    
+
 
 Version 0.7.2 (2007.03.09):
-	* added: Big::Mod - the remainder from a division
-	* added: Big::Sgn - the 'sign' from the value (-1,0,1)
-	* added: global functions Mod and Sgn too
-	* added: checking whether a user gives a correct value of a variable or function
-	  (user-defined variables/functions in the mathematical parser)
-	* added: into the parser: logical operators: > < >= <= == != && ||
-	* added: into the parser: logical functions: and() or() not() if()
-	* added: ErrorCode::err_unknown_operator when the parser couldn't read an operator
+    * added:   Big::Mod - the remainder from a division
+    * added:   Big::Sgn - the 'sign' from the value (-1,0,1)
+    * added:   global functions Mod and Sgn too
+    * added:   checking whether a user gives a correct value of a variable or function
+               (user-defined variables/functions in the mathematical parser)
+    * added:   into the parser: logical operators: > < >= <= == != && ||
+    * added:   into the parser: logical functions: and() or() not() if()
+    * added:   ErrorCode::err_unknown_operator when the parser couldn't read an operator
+
 
 Version 0.7.1 (2007.02.27):
-	* fixed the error 'overflow during printing' which was caused
-	  by Big::FromInt(Int<int_size> value) (the sign has to be set at the end)
-	* fixed many small errors
-	* added ATan (arctan), ACTan (arc ctan) functions
+    * fixed:   the error 'overflow during printing' which was caused
+               by Big::FromInt(Int<int_size> value) (the sign has to be set at the end)
+    * fixed:   many small errors
+    * added:   ATan (arctan), ACTan (arc ctan) functions
+
 
 Version 0.7.0 (2007.02.24):
-	* finished support for 64bit platforms
-	* added ASin (arcsin), ACos (arccos) functions
-	
+    * finished: support for 64bit platforms
+    * added:   ASin (arcsin), ACos (arccos) functions
+    
+    
 Version 0.6.4 (2007.01.29):
-	* fixed the problem with a sign in the mathematical parser /-(1) was 1/
-	* added UInt::AddInt and UInt::SubInt
-	* changed UInt::AddOne and UInt::SubOne (much faster now)
-	* added UInt::SetBitInWord
-	* changed UInt::SetBit (much faster now)
-	* UInt::AddTwoUints renamed to UInt::AddTwoInts
-	* UInt::FindLeadingBit32 renamed to UInt::FindLeadingBitInWord
-	* added UInt::SetBitInWord
-	* UInt::Mul64 renamed to UInt::MulTwoWords
-	* UInt::Div64 renamed to UInt::DivTwoWords
-	* and more small changes in UInt type
-	* start adding support for Amd64 (not finished yet) (added ttmathuint64.h)
-	
+    * fixed:   the problem with a sign in the mathematical parser /-(1) was 1/
+    * added:   UInt::AddInt and UInt::SubInt
+    * changed: UInt::AddOne and UInt::SubOne (much faster now)
+    * added:   UInt::SetBitInWord
+    * changed: UInt::SetBit (much faster now)
+               UInt::AddTwoUints renamed to UInt::AddTwoInts
+               UInt::FindLeadingBit32 renamed to UInt::FindLeadingBitInWord
+               UInt::Mul64 renamed to UInt::MulTwoWords
+               UInt::Div64 renamed to UInt::DivTwoWords
+    * added:   UInt::SetBitInWord
+    * and more small changes in UInt type
+    * start adding support for Amd64 (not finished yet) (added ttmathuint64.h)
+    
+    
 Version 0.6.3 (2007.01.22):
-	* position of arguments (x and base) in logarithm functions are swapped
-	* it's possible to use any multiplication algorithms in the same time
-	  (macros UINT_MUL_VERSION_'X' have gone)
-	* added ExceptionInfo, ReferenceError and RuntimeError classes
-	* the mess in macros has been cleaned up
-	* added TTMATH_RELEASE macro
+    * changed: position of arguments (x and base) in logarithm functions are swapped
+    * changed: it's possible to use any multiplication algorithms in the same time
+               (macros UINT_MUL_VERSION_'X' have gone)
+    * added:   ExceptionInfo, ReferenceError and RuntimeError classes
+    * changed: the mess in macros has been cleaned up
+    * added:   TTMATH_RELEASE macro
+
 
 Version 0.6.2 (2007.01.10):
-	* New division algorithm (radix b) where b is 2^32
+    * added:   New division algorithm (radix b) where b is 2^32

COPYRIGHT

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2007, Tomasz Sowa
+Copyright (c) 2006-2008, Tomasz Sowa
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README

@@ -7,18 +7,20 @@ subtracting, multiplying, dividing etc. With the library also goes
 a mathematical parser which helps you solving input formulas read directly
 from a user.
 
-TTMath is developed under the (new) BSD licence which means that it is free
-for both personal and commercial use but the library has some technical
-limitations: you can use it only on i386 and Amd64, another platforms are
-not supported (Intel 64bit platforms were not tested but should work as
-well), and you can use this library only with the C++ programming language. 
+TTMath is developed under the BSD licence which means that it is free
+for both personal and commercial use.
+
+The library has some technical limitations:
+ * there are only two platforms that are supported: x86 and x86_64,
+ * you can use this library only with the C++ programming language.
 
 The main goal of the library is to allow one to use big values in the same
 way as the standard types like int, float, etc. It does not need to be
 compiled first because the whole library is written as the C++ templates.
 This means only C++ developers can use this library and one thing they have
-to do is to use  'include' directive of the preprocessor. How big the
+to do is to use 'include' directive of the preprocessor. How big the
 values can be is set directly in the source code by the programmer.
 
-Author: Tomasz Sowa <t.sowa AnTispam slimaczek.pl>
-Project page: http://sourceforge.net/projects/ttmath
+Author: Tomasz Sowa <t.sowa@slimaczek.pl>
+Project pages: http://ttmath.slimaczek.pl
+http://sourceforge.net/projects/ttmath

TODO

@@ -1,5 +0,0 @@
-TODO TTMath Library
-===================
-
-* Add functions for generating random values
-* Add something like NaN to the Big<> type

doxygen.cfg

@@ -31,7 +31,7 @@ PROJECT_NAME           = TTMath
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 
-PROJECT_NUMBER         = 0.8.0
+PROJECT_NUMBER         = 0.8.2
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 

ttmath/ttmath.h

@@ -5,7 +5,7 @@
  */
 
 /* 
- * Copyright (c) 2006-2007, Tomasz Sowa
+ * Copyright (c) 2006-2008, Tomasz Sowa
  * All rights reserved.
  * 
  * Redistribution and use in source and binary forms, with or without
@@ -275,6 +275,11 @@ namespace ttmath
 	*
 	*/
 
+
+	/*
+		this namespace consists of auxiliary functions
+		(something like 'private' in a class)
+	*/
 	namespace auxiliaryfunctions
 	{
 
@@ -1536,7 +1541,7 @@ namespace ttmath
 			{
 				if( x.IsZero() )
 				{
-					// there isn't root(0;0)
+					// there isn't root(0;0) - we assume it's not defined
 					if( err )
 						*err = err_improper_argument;
 
@@ -1685,7 +1690,14 @@ namespace ttmath
 		c += x.PowFrac(newindex); // here can only be a carry
 
 		if( change_sign )
+		{
+			// the value of x should be different from zero
+			// (x is actually tested by RootCheckXZero)
+			TTMATH_ASSERT( x.IsZero() == false )
+
 			x.SetSign();
+		}
+
 
 		if( err )
 			*err = c ? err_overflow : err_ok;

ttmath/ttmathint.h

@@ -5,7 +5,7 @@
  */
 
 /* 
- * Copyright (c) 2006-2007, Tomasz Sowa
+ * Copyright (c) 2006-2008, Tomasz Sowa
  * All rights reserved.
  * 
  * Redistribution and use in source and binary forms, with or without
@@ -208,7 +208,7 @@ private:
 public:
 
 	/*!
-		this method adds two value with a sign and returns carry
+		this method adds two value with a sign and returns a carry
 
 		we're using methods from the base class because values are stored with U2
 		we must only make the carry correction
@@ -475,17 +475,14 @@ public:
 	*	convertion methods
 	*
 	*/
+private:
+
 
 	/*!
-		this method convert an UInt<another_size> type to this class
-
-		this operation has mainly sense if the value from p
-		can be held in this type
-
-		it returns a carry if the value 'p' is too big
+		an auxiliary method for converting both from UInt and Int
 	*/
 	template<uint argument_size>
-	uint FromInt(const Int<argument_size> & p)
+	uint FromUIntOrInt(const UInt<argument_size> & p, bool UInt_type)
 	{
 		uint min_size = (value_size < argument_size)? value_size : argument_size;
 		uint i;
@@ -496,15 +493,25 @@ public:
 
 		if( value_size > argument_size )
 		{	
-			// 'this' is longer than 'p'
-			uint fill = (p.table[argument_size-1] & TTMATH_UINT_HIGHEST_BIT)? TTMATH_UINT_MAX_VALUE : 0;
+			uint fill;
 
+			if( UInt_type )
+				fill = 0;
+			else
+				fill = (p.table[argument_size-1] & TTMATH_UINT_HIGHEST_BIT)?
+														TTMATH_UINT_MAX_VALUE : 0;
+
+			// 'this' is longer than 'p'
 			for( ; i<value_size ; ++i)
 				UInt<value_size>::table[i] = fill;
 		}
 		else
 		{
-			uint test = (UInt<value_size>::table[value_size-1] & TTMATH_UINT_HIGHEST_BIT)? TTMATH_UINT_MAX_VALUE : 0;
+			uint test = (UInt<value_size>::table[value_size-1] & TTMATH_UINT_HIGHEST_BIT)?
+																TTMATH_UINT_MAX_VALUE : 0;
+
+			if( UInt_type && test!=0 )
+				return 1;
 
 			for( ; i<argument_size ; ++i)
 				if( p.table[i] != test )
@@ -514,11 +521,27 @@ public:
 	return 0;
 	}
 
+public:
+
+	/*!
+		this method converts an Int<another_size> type into this class
+
+		this operation has mainly sense if the value from p
+		can be held in this type
+
+		it returns a carry if the value 'p' is too big
+	*/
+	template<uint argument_size>
+	uint FromInt(const Int<argument_size> & p)
+	{
+		return FromUIntOrInt(p, false);
+	}
+
 
 	/*!
 		this method converts the sint type into this class
 	*/
-	void FromInt(sint value)
+	uint FromInt(sint value)
 	{
 	uint fill = ( value<0 ) ? TTMATH_UINT_MAX_VALUE : 0;
 
@@ -526,16 +549,46 @@ public:
 			UInt<value_size>::table[i] = fill;
 
 		UInt<value_size>::table[0] = uint(value);
+	
+		// there'll never be a carry here
+	return 0;
 	}
 
 
 	/*!
-		this operator converts an UInt<another_size> type to this class
-
-		it doesn't return a carry
+		this method converts UInt<another_size> into this class
 	*/
 	template<uint argument_size>
-	Int<value_size> & operator=(const Int<argument_size> & p)
+	uint FromUInt(const UInt<argument_size> & p)
+	{
+		return FromUIntOrInt(p, true);
+	}
+
+
+	/*!
+		this method converts the uint type into this class
+	*/
+	uint FromUInt(uint value)
+	{
+		for(uint i=1 ; i<value_size ; ++i)
+			UInt<value_size>::table[i] = 0;
+
+		UInt<value_size>::table[0] = value;
+
+		// there can be a carry here when the size of this value is equal one word
+		// and the 'value' has the highest bit set
+		if( value_size==1 && (value & TTMATH_UINT_HIGHEST_BIT)!=0 )
+			return 1;
+
+	return 0;
+	}
+
+	// converting from Int
+
+	/*!
+		the default assignment operator
+	*/
+	Int<value_size> & operator=(const Int<value_size> & p)
 	{
 		FromInt(p);
 
@@ -544,9 +597,12 @@ public:
 
 
 	/*!
-		the default assignment operator
+		this operator converts an Int<another_size> type to this class
+
+		it doesn't return a carry
 	*/
-	Int<value_size> & operator=(const Int<value_size> & p)
+	template<uint argument_size>
+	Int<value_size> & operator=(const Int<argument_size> & p)
 	{
 		FromInt(p);
 
@@ -575,11 +631,47 @@ public:
 
 
 	/*!
-		this method converts the uint type to this class
+		a copy constructor
+	*/
+	Int(const Int<value_size> & u)
+	{
+		FromInt(u);
+	}
+
+
+	/*!
+		a constructor for copying from another types
+	*/
+	template<uint argument_size>
+	Int(const Int<argument_size> & u)
+	{
+		// look that 'size' we still set as 'value_size' and not as u.value_size
+		FromInt(u);
+	}
+
+
+	// converting from UInt
+
+	/*!
+		this operator converts an UInt<another_size> type to this class
+
+		it doesn't return a carry
+	*/
+	template<uint argument_size>
+	Int<value_size> & operator=(const UInt<argument_size> & p)
+	{
+		FromUInt(p);
+
+	return *this;
+	}
+
+
+	/*!
+		this method converts the Uint type to this class
 	*/
 	Int<value_size> & operator=(uint i)
 	{
-		UInt<value_size>::FromUInt(i);
+		FromUInt(i);
 
 	return *this;
 	}
@@ -590,10 +682,23 @@ public:
 	*/
 	Int(uint i)
 	{
-		UInt<value_size>::FromUInt(i);
+		FromUInt(i);
 	}
 
 
+	/*!
+		a constructor for copying from another types
+	*/
+	template<uint argument_size>
+	Int(const UInt<argument_size> & u)
+	{
+		// look that 'size' we still set as 'value_size' and not as u.value_size
+		FromUInt(u);
+	}
+
+	// 
+
+
 #ifdef TTMATH_PLATFORM64
 
 	/*!
@@ -630,7 +735,7 @@ public:
 	*/
 	Int<value_size> & operator=(unsigned int i)
 	{
-		UInt<value_size>::FromUInt(uint(i));
+		FromUInt(uint(i));
 
 	return *this;
 	}
@@ -644,7 +749,7 @@ public:
 	*/
 	Int(unsigned int i)
 	{
-		UInt<value_size>::FromUInt(uint(i));
+		FromUInt(uint(i));
 	}
 
 #endif
@@ -678,18 +783,6 @@ public:
 	}
 
 
-	/*!
-		the copy constructor
-	*/
-	template<uint argument_size>
-	Int(const Int<argument_size> & u) : UInt<value_size>::size(value_size)
-	{
-		// look that 'size' we still set as 'value_size' and not as u.value_size
-
-		operator=(u);
-	}
-
-
 	/*!
 		the destructor
 	*/
@@ -697,6 +790,7 @@ public:
 	{
 	}
 
+
 	/*!
 		this method returns the lowest value from table with a sign
 

ttmath/ttmathobjects.h

@@ -5,7 +5,7 @@
  */
 
 /* 
- * Copyright (c) 2006-2007, Tomasz Sowa
+ * Copyright (c) 2006-2008, Tomasz Sowa
  * All rights reserved.
  * 
  * Redistribution and use in source and binary forms, with or without
@@ -102,7 +102,7 @@ public:
 		if( (c>='a' && c<='z') || (c>='A' && c<='Z') )
 			return true;
 
-		if( can_be_digit && (c>='0' && c<='9') )
+		if( can_be_digit && ((c>='0' && c<='9') || c=='_') )
 			return true;
 
 	return false;

ttmath/ttmathparser.h

@@ -5,7 +5,7 @@
  */
 
 /* 
- * Copyright (c) 2006-2007, Tomasz Sowa
+ * Copyright (c) 2006-2008, Tomasz Sowa
  * All rights reserved.
  * 
  * Redistribution and use in source and binary forms, with or without
@@ -66,7 +66,7 @@ namespace ttmath
 	x = [+|-]Value[operator[+|-]Value][operator[+|-]Value]...
 	where:
 		an operator can be:
-			^ (pow)  (the highest priority)
+			^ (pow)  (almost the heighest priority, look below at 'short mul')
 
 			* (mul) 
 			/ (div)   (* and / have the same priority)
@@ -85,6 +85,12 @@ namespace ttmath
 
 			|| (logical or) (the lowest priority)
 
+		short mul:
+		or if the second Value (Var below) is either a variable or function there cannot be 
+		an operator between them, e.g.
+	        [+|-]ValueVar is treated as [+|-]Value * Var and the multiplication
+	        has the greatest priority:  2^3m equals 2^(3*m)
+	
 
 		and Value can be:
 			constant e.g. 100
@@ -106,6 +112,7 @@ namespace ttmath
 		                 for separating parameters
 	    "1 < 2"  (the result will be: 1)
 	    "4 < 3"  (the result will be: 0)
+		"2+x"  (of course if the variable 'x' is defined)
 		etc.
 
 	we can also use a semicolon for separating any 'x' input strings
@@ -122,13 +129,15 @@ class Parser
 private:
 
 /*!
-	there are 5 mathematical operators as follows:
+	there are 5 mathematical operators as follows (with their standard priorities):
 		add (+)
 		sub (-)
 		mul (*)
 		div (/)
 		pow (^)
-	with their standard priorities
+		and 'shortmul' used when there is no any operators between
+		a first parameter and a variable or function
+		(the 'shortmul' has the greatest priority e.g. '5^3m' equals '5^(3*m)' )
 */
 	class MatOperator
 	{
@@ -136,7 +145,7 @@ private:
 
 		enum Type
 		{
-			none,add,sub,mul,div,pow,lt,gt,let,get,eq,neq,lor,land
+			none,add,sub,mul,div,pow,lt,gt,let,get,eq,neq,lor,land,shortmul
 		};
 
 
@@ -181,6 +190,10 @@ private:
 				priority = 14;
 				break;
 
+			case shortmul:
+				priority = 20;
+				break;
+
 			default:
 				Error( err_internal_error );
 				break;
@@ -426,7 +439,7 @@ void SkipWhiteCharacters()
 
 
 /*!
-	a auxiliary method for RecurrenceParsingVariablesOrFunction(...)
+	an auxiliary method for RecurrenceParsingVariablesOrFunction(...)
 */
 void RecurrenceParsingVariablesOrFunction_CheckStopCondition(bool variable, const std::string & name)
 {
@@ -444,7 +457,7 @@ void RecurrenceParsingVariablesOrFunction_CheckStopCondition(bool variable, cons
 
 
 /*!
-	a auxiliary method for RecurrenceParsingVariablesOrFunction(...)
+	an auxiliary method for RecurrenceParsingVariablesOrFunction(...)
 */
 void RecurrenceParsingVariablesOrFunction_AddName(bool variable, const std::string & name)
 {
@@ -455,7 +468,7 @@ void RecurrenceParsingVariablesOrFunction_AddName(bool variable, const std::stri
 }
 
 /*!
-	a auxiliary method for RecurrenceParsingVariablesOrFunction(...)
+	an auxiliary method for RecurrenceParsingVariablesOrFunction(...)
 */
 void RecurrenceParsingVariablesOrFunction_DeleteName(bool variable, const std::string & name)
 {
@@ -1158,6 +1171,35 @@ void BitXor(int sindex, int amount_of_args, ValueType & result)
 	}
 }
 
+
+void Sum(int sindex, int amount_of_args, ValueType & result)
+{
+	if( amount_of_args == 0 )
+		Error( err_improper_amount_of_arguments );
+
+	result = stack[sindex].value;
+
+	for(int i=1 ; i<amount_of_args ; ++i )
+		if( result.Add( stack[ sindex + i*2 ].value ) )
+			Error( err_overflow );
+}	
+
+void Avg(int sindex, int amount_of_args, ValueType & result)
+{
+	if( amount_of_args == 0 )
+		Error( err_improper_amount_of_arguments );
+
+	result = stack[sindex].value;
+
+	for(int i=1 ; i<amount_of_args ; ++i )
+		if( result.Add( stack[ sindex + i*2 ].value ) )
+			Error( err_overflow );
+
+	if( result.Div( amount_of_args ) )
+		Error( err_overflow );
+}	
+
+
 /*!
 	this method returns the value from a user-defined function
 
@@ -1235,7 +1277,7 @@ void CallFunction(const std::string & function_name, int amount_of_args, int sin
 
 
 /*!
-	insert a function to the functions' table
+	inserting a function to the functions' table
 
 	function_name - name of the function
 	pf - pointer to the function (to the wrapper)
@@ -1247,7 +1289,7 @@ void InsertFunctionToTable(const std::string & function_name, pfunction pf)
 
 
 /*!
-	insert a function to the variables' table
+	inserting a function to the variables' table
 	(this function returns value of variable)
 
 	variable_name - name of the function
@@ -1319,11 +1361,13 @@ void CreateFunctionsTable()
 	InsertFunctionToTable(std::string("band"),		&Parser<ValueType>::BitAnd);
 	InsertFunctionToTable(std::string("bor"),		&Parser<ValueType>::BitOr);
 	InsertFunctionToTable(std::string("bxor"),		&Parser<ValueType>::BitXor);
+	InsertFunctionToTable(std::string("sum"),		&Parser<ValueType>::Sum);
+	InsertFunctionToTable(std::string("avg"),		&Parser<ValueType>::Avg);
 }
 
 
 /*!
-	this method create the table of variables
+	this method creates the table of variables
 */
 void CreateVariablesTable()
 {
@@ -1336,7 +1380,7 @@ void CreateVariablesTable()
 
 
 /*!
-	convert from a big letter to a small one
+	converting from a big letter to a small one
 */
 int ToLowerCase(int c)
 {
@@ -1347,8 +1391,6 @@ return c;
 }
 
 
-
-
 /*!
 	this method read the name of a variable or a function
 	
@@ -1365,29 +1407,31 @@ int character;
 
 
 	result.erase();
-	character = ToLowerCase(*pstring);
+	character = *pstring;
 
 	/*
-		the first letter must be from range 'a' - 'z'
+		the first letter must be from range 'a' - 'z' or 'A' - 'Z'
 	*/
-	if( character<'a' || character>'z' )
+	if( ! (( character>='a' && character<='z' ) || ( character>='A' && character<='Z' )) )
 		Error( err_unknown_character );
 
 
 	do
 	{
 		result   += character;
-		character = ToLowerCase( * ++pstring );
+		character = * ++pstring;
 	}
 	while(	(character>='a' && character<='z') ||
-			(character>='0' && character<='9')	);
+			(character>='A' && character<='Z') ||
+			(character>='0' && character<='9') ||
+			character=='_' );
 	
 
 	SkipWhiteCharacters();
 	
 
 	/*
-		if there's character '(' that means this name is a name of a function
+		if there's a character '(' that means this name is a name of a function
 	*/
 	if( *pstring == '(' )
 	{
@@ -1468,7 +1512,6 @@ const char * new_stack_pointer;
 }
 
 
-
 /*!
 	this method converts the character ascii c into the value in range <0;base-1>
 
@@ -1553,12 +1596,15 @@ int  character;
 	return 2;
 	}
 	else
-	if( character=='#' || character=='&' || CharToDigit(character, base)!=-1 )
+	if( character=='#' || character=='&' ||
+		character==TTMATH_COMMA_CHARACTER_1 ||
+		(character==TTMATH_COMMA_CHARACTER_2 && TTMATH_COMMA_CHARACTER_2 != 0) ||
+		CharToDigit(character, base)!=-1 )
 	{
 		/*
 			warning:
 			if we're using for example the base equal 16
-			we can find a first character like 'e' that is there is not e=2.71..
+			we can find a first character like 'e' that is not e=2.71..
 			but the value 14, for this case we must use something like var::e for variables
 			(not implemented yet)
 		*/
@@ -1598,6 +1644,7 @@ void InsertOperatorToTable(const std::string & name, typename MatOperator::Type
 	operators_table.insert( std::make_pair(name, type) );
 }
 
+
 /*!
 	this method creates the table of operators
 */
@@ -1698,6 +1745,14 @@ int ReadOperator(Item & result)
 		result.type = Item::semicolon;
 		++pstring;
 	}
+	else
+	if( (*pstring>='a' && *pstring<='z') || (*pstring>='A' && *pstring<='Z') )
+	{
+		// short mul (without any operators)
+
+		result.type = Item::mat_operator;
+		result.moperator.SetType( MatOperator::shortmul );
+	}
 	else
 		ReadMathematicalOperator(result);
 
@@ -1760,6 +1815,7 @@ int res;
 		break;
 
 	case MatOperator::mul:
+	case MatOperator::shortmul:
 		if( value1.Mul(value2) ) Error( err_overflow );
 		break;
 
@@ -1777,6 +1833,7 @@ int res;
 
 		break;
 
+
 	default:
 		/*
 			on the stack left an unknown operator but we had to recognize its before
@@ -1879,7 +1936,7 @@ return kod;
 
 /*!
 	this method calculate how many parameters there are on the stack
-	and index of the first parameter
+	and the index of the first parameter
 
 	if there aren't any parameters on the stack this method returns
 	'size' equals zero and 'index' pointing after the first bracket

ttmath/ttmathtypes.h

@@ -5,7 +5,7 @@
  */
 
 /* 
- * Copyright (c) 2006-2007, Tomasz Sowa
+ * Copyright (c) 2006-2008, Tomasz Sowa
  * All rights reserved.
  * 
  * Redistribution and use in source and binary forms, with or without
@@ -64,7 +64,7 @@
 */
 #define TTMATH_MAJOR_VER		0
 #define TTMATH_MINOR_VER		8
-#define TTMATH_REVISION_VER		1
+#define TTMATH_REVISION_VER		2
 #define TTMATH_PRERELEASE_VER	0
 
 
@@ -182,7 +182,7 @@ namespace ttmath
 /*!
 	characters which represent the comma operator
 
-	TTMATH_COMMA_CHARACTER_1 is used in reading (parsing) and in writing
+	TTMATH_COMMA_CHARACTER_1 is used in reading (parsing) and in writing (default, can be overwritten in ToString() function)
 	TTMATH_COMMA_CHARACTER_2 can be used in reading as an auxiliary comma character
 	that means you can input values for example 1.2345 and 1,2345 as well
 
@@ -197,6 +197,7 @@ namespace ttmath
 #define TTMATH_COMMA_CHARACTER_2 ','
 
 
+
 /*!
 	this variable defines how many iterations are performed
 	during some kind of calculating when we're making any long formulas
@@ -247,7 +248,8 @@ namespace ttmath
 		err_object_exists,
 		err_unknown_object,
 		err_still_calculating,
-		err_too_big_factorial
+		err_too_big_factorial,
+		err_in_short_form_used_function
 	};
 
 

ttmath/ttmathuint.h

@@ -5,7 +5,7 @@
  */
 
 /* 
- * Copyright (c) 2006-2007, Tomasz Sowa
+ * Copyright (c) 2006-2008, Tomasz Sowa
  * All rights reserved.
  * 
  * Redistribution and use in source and binary forms, with or without
@@ -52,6 +52,9 @@
 
 
 
+/*!
+    \brief a namespace for the TTMath library
+*/
 namespace ttmath
 {
 
@@ -69,8 +72,8 @@ class UInt
 public:
 
 	/*!
-		buffer for this integer value
-		the first value (index 0) means the lowest word of this value
+		buffer for the integer value
+		  table[0] - the lowest word of the value
 	*/
 	uint table[value_size];
 
@@ -117,7 +120,7 @@ public:
 
 
 	/*!
-		it returns the size of the table
+		this method returns the size of the table
 	*/
 	uint Size() const
 	{
@@ -126,17 +129,19 @@ public:
 
 
 	/*!
-		this method sets value zero
+		this method sets zero
 	*/
 	void SetZero()
 	{
+		// in the future here can be 'memset'
+
 		for(uint i=0 ; i<value_size ; ++i)
 			table[i] = 0;
 	}
 
 
 	/*!
-		this method sets value one
+		this method sets one
 	*/
 	void SetOne()
 	{
@@ -218,6 +223,8 @@ public:
 	}
 
 
+
+
 	/*!
 	*
 	*	basic mathematic functions
@@ -225,14 +232,12 @@ public:
 	*/
 
 
-
-
 	/*!
-		this method adding ss2 to the this and adding carry if it's defined
+		adding ss2 to the this and adding carry if it's defined
 		(this = this + ss2 + c)
 
 		c must be zero or one (might be a bigger value than 1)
-		function returns carry (1) (if it was)
+		function returns carry (1) (if it has been)
 	*/
 	uint Add(const UInt<value_size> & ss2, uint c=0)
 	{
@@ -339,8 +344,8 @@ public:
 
 
 	/*!
-		this method adds one word (at a specific position)
-		and returns a carry (if it was)
+		adding one word (at a specific position)
+		and returning a carry (if it has been)
 
 		e.g.
 
@@ -355,7 +360,7 @@ public:
 			table[1] = 30 + 2;
 			table[2] = 5;
 
-		of course if there was a carry from table[3] it would be returned
+		of course if there was a carry from table[2] it would be returned
 	*/
 	uint AddInt(uint value, uint index = 0)
 	{
@@ -462,7 +467,7 @@ public:
 
 
 	/*!
-		this method adds only two unsigned words to the existing value
+		adding only two unsigned words to the existing value
 		and these words begin on the 'index' position
 		(it's used in the multiplication algorithm 2)
 
@@ -630,12 +635,12 @@ public:
 
 
 	/*!
-		this method's subtracting ss2 from the 'this' and subtracting
+		subtracting ss2 from the 'this' and subtracting
 		carry if it has been defined
 		(this = this - ss2 - c)
 
 		c must be zero or one (might be a bigger value than 1)
-		function returns carry (1) (if it was)
+		function returns carry (1) (if it has been)
 	*/
 	uint Sub(const UInt<value_size> & ss2, uint c=0)
 	{
@@ -1115,11 +1120,11 @@ private:
 #endif
 
 
-	/*!    
-		an auxiliary method for moving bits into the left hand side
-
-		this method moves only words
-	*/
+	/*!    
+		an auxiliary method for moving bits into the left hand side
+
+		this method moves only words
+	*/
 	void RclMoveAllWords(	sint & all_words, uint & rest_bits, uint & last_c,
 							uint bits, uint c)
 	{	
@@ -1156,7 +1161,7 @@ private:
 public:
 
 	/*!
-		this method moving all bits into the left side 'bits' times
+		moving all bits into the left side 'bits' times
 		return value <- this <- C
 
 		bits is from a range of <0, man * TTMATH_BITS_PER_UINT>
@@ -1209,16 +1214,16 @@ public:
 	return last_c;
 	}
 
-private:
-
-	/*!    
-		an auxiliary method for moving bits into the right hand side
-
-		this method moves only words
-	*/
+private:
+
+	/*!    
+		an auxiliary method for moving bits into the right hand side
+
+		this method moves only words
+	*/
 	void RcrMoveAllWords(	sint & all_words, uint & rest_bits, uint & last_c,
 							uint bits, uint c)
-	{
+	{
 		rest_bits = sint(bits % TTMATH_BITS_PER_UINT);
 		all_words = sint(bits / TTMATH_BITS_PER_UINT);
 
@@ -1248,12 +1253,12 @@ private:
 			for( ; first<value_size ; ++first )
 				table[first] = mask;
 		}
-	}
-
+	}
+
 public:
 
 	/*!
-		this method moving all bits into the right side 'bits' times
+		moving all bits into the right side 'bits' times
 		c -> this -> return value
 
 		bits is from a range of <0, man * TTMATH_BITS_PER_UINT>
@@ -1473,7 +1478,7 @@ public:
 
 
 	/*!
-		it sets the bit bit_index
+		setting the 'bit_index' bit
 
 		bit_index bigger or equal zero
 	*/
@@ -1529,6 +1534,34 @@ public:
 	}
 
 
+	/*!
+		this method performs a bitwise operation NOT but only
+		on the range of <0, leading_bit>
+
+		for example:
+			BitNot2(8) = BitNot2( 1000(bin) ) = 111(bin) = 7
+	*/
+	void BitNot2()
+	{
+	uint table_id, index;
+
+		if( FindLeadingBit(table_id, index) )
+		{
+			for(uint x=0 ; x<table_id ; ++x)
+				table[x] = ~table[x];
+
+			uint mask  = TTMATH_UINT_MAX_VALUE;
+			uint shift = TTMATH_BITS_PER_UINT - index - 1;
+
+			if(shift)
+				mask >>= shift;
+
+			table[table_id] ^= mask;
+		}
+		else
+			table[0] = 1;
+	}
+
 
 
 	/*!
@@ -2631,7 +2664,7 @@ private:
 public:
 
 	/*!
-		this method sets n firt bits to value zero
+		this method sets n first bits to value zero
 
 		For example:
 		let n=2 then if there's a value 111 (bin) there'll be '100' (bin)
@@ -2667,7 +2700,7 @@ public:
 
 
 	/*!
-		it returns true if the highest bit of the value is set
+		this method returns true if the highest bit of the value is set
 	*/
 	bool IsTheHighestBitSet() const
 	{
@@ -2676,7 +2709,7 @@ public:
 
 
 	/*!
-		it returns true if the lowest bit of the value is set
+		this method returns true if the lowest bit of the value is set
 	*/
 	bool IsTheLowestBitSet() const
 	{
@@ -2685,7 +2718,7 @@ public:
 
 
 	/*!
-		it returns true if the value is equal zero
+		this method returns true if the value is equal zero
 	*/
 	bool IsZero() const
 	{
@@ -2718,7 +2751,7 @@ public:
 			A -> 10
 			f -> 15
 
-		this method don't check whether c 'is' correct or not
+		this method don't check whether c is correct or not
 	*/
 	static uint CharToDigit(uint c)
 	{
@@ -3088,6 +3121,8 @@ public:
 	}
 
 
+
+
 	/*!
 	*
 	*	methods for comparing
@@ -3095,6 +3130,14 @@ public:
 	*/
 
 
+	/*!
+		this method returns true if 'this' is smaller than 'l'
+
+		'index' is an index of the first word from will be the comparison performed
+		(note: we start the comparison from back - from the last word, when index is -1 /default/
+		it is automatically set into the last word)
+		I introduced it for some kind of optimization made in the second division algorithm (Div2)
+	*/
 	bool CmpSmaller(const UInt<value_size> & l, sint index = -1) const
 	{
 	sint i;
@@ -3117,6 +3160,15 @@ public:
 
 
 
+	/*!
+		this method returns true if 'this' is bigger than 'l'
+
+		'index' is an index of the first word from will be the comparison performed
+		(note: we start the comparison from back - from the last word, when index is -1 /default/
+		it is automatically set into the last word)
+
+		I introduced it for some kind of optimization made in the second division algorithm (Div2)
+	*/
 	bool CmpBigger(const UInt<value_size> & l, sint index = -1) const
 	{
 	sint i;
@@ -3138,6 +3190,13 @@ public:
 	}
 
 
+	/*!
+		this method returns true if 'this' is equal 'l'
+
+		'index' is an index of the first word from will be the comparison performed
+		(note: we start the comparison from back - from the last word, when index is -1 /default/
+		it is automatically set into the last word)
+	*/
 	bool CmpEqual(const UInt<value_size> & l, sint index = -1) const
 	{
 	sint i;
@@ -3155,6 +3214,15 @@ public:
 	return true;
 	}
 
+
+
+	/*!
+		this method returns true if 'this' is smaller than or equal 'l'
+
+		'index' is an index of the first word from will be the comparison performed
+		(note: we start the comparison from back - from the last word, when index is -1 /default/
+		it is automatically set into the last word)
+	*/
 	bool CmpSmallerEqual(const UInt<value_size> & l, sint index=-1) const
 	{
 	sint i;
@@ -3175,6 +3243,15 @@ public:
 	return true;
 	}
 
+
+
+	/*!
+		this method returns true if 'this' is bigger than or equal 'l'
+
+		'index' is an index of the first word from will be the comparison performed
+		(note: we start the comparison from back - from the last word, when index is -1 /default/
+		it is automatically set into the last word)
+	*/
 	bool CmpBiggerEqual(const UInt<value_size> & l, sint index=-1) const
 	{
 	sint i;
@@ -3196,7 +3273,9 @@ public:
 	}
 
 
-	//
+	/*
+		operators for comparising
+	*/
 
 	bool operator<(const UInt<value_size> & l) const
 	{
@@ -3204,7 +3283,6 @@ public:
 	}
 
 
-
 	bool operator>(const UInt<value_size> & l) const
 	{
 		return CmpBigger(l);
@@ -3217,7 +3295,6 @@ public:
 	}
 
 
-
 	bool operator!=(const UInt<value_size> & l) const
 	{
 		return !operator==(l);
@@ -3333,6 +3410,7 @@ public:
 	return *this;
 	}
 
+
 	/*!
 		Prefix operator e.g ++variable
 	*/

ttmath/ttmathuint64.h

@@ -5,7 +5,7 @@
  */
 
 /* 
- * Copyright (c) 2006-2007, Tomasz Sowa
+ * Copyright (c) 2006-2008, Tomasz Sowa
  * All rights reserved.
  * 
  * Redistribution and use in source and binary forms, with or without
@@ -983,4 +983,3 @@ namespace ttmath
 #endif
 
 } //namespace
-