This class defines integer numbers with overflow control and with some specific properties of an Euclidean domain. More...

#include <integer.h>

Public Member Functions
integer &	operator= (int n)

int	delta (void) const

integer	normalized () const

integer	operator- () const

integer &	operator+= (const integer &n)

integer &	operator*= (const integer &n)

integer	operator+ (const integer &n) const

integer	operator* (const integer &n) const

integer	operator/ (const integer &n) const

integer	operator% (const integer &n) const

int	operator== (const integer &n) const

Static Public Member Functions
static int	initialize (int n)

static const char *	ringname ()

static const char *	ringsymbol ()

Static Protected Member Functions
static int	cut_down (int n)

static int	is_prime (int n)

static int	prime_number (int n)

static unsigned	invert (unsigned n, unsigned q)

Protected Attributes
numbertype	num

Static Protected Attributes
static int	p

Friends
std::ostream &	operator<< (std::ostream &out, const integer &n)

bool	operator< (const integer &x, const integer &y)

bool	operator> (const integer &x, const integer &y)

Detailed Description

This class defines integer numbers with overflow control and with some specific properties of an Euclidean domain.

Note that this class has very few features which are limited on purpose to optimize it for application in a chain complex class for homology computation.

Definition at line 133 of file integer.h.

Member Function Documentation

◆ cut_down()

int chomp::homology::integer::cut_down ( int n )

inlinestaticprotected

Definition at line 194 of file integer.h.

{
        if (n >= 0)
                if (n < p)
                        return n;
                else
                        return (n % p);
        else
        {
                int num = p - ((-n) % p);
                if (num == p)
                        return 0;
                else
                        return num;
        }
} /* cut_down */

References num, and p.

Referenced by operator=().

◆ delta()

int chomp::homology::integer::delta ( void ) const

inline

Definition at line 393 of file integer.h.

{
        if (p)
                return (num ? 1 : 0);
        else
                return ((num >= 0) ? num : -num);
} /* integer::delta */

References num, and p.

◆ initialize()

int chomp::homology::integer::initialize ( int n )

inlinestatic

Definition at line 387 of file integer.h.

{
        p = prime_number (n);
        return p;
} /* integer::initialize */

References p, and prime_number().

◆ invert()

static unsigned chomp::homology::integer::invert	(	unsigned	n,
		unsigned	q
	)

staticprotected

Referenced by operator/().

◆ is_prime()

static int chomp::homology::integer::is_prime ( int n )

staticprotected

◆ normalized()

integer chomp::homology::integer::normalized ( void ) const

inline

Definition at line 401 of file integer.h.

{
        integer n;
        if (num < 0)
                n. num = (numbertype) (-num);
        else
                n. num = num;
        return n;
} /* integer::normalized */

References num.

◆ operator%()

integer chomp::homology::integer::operator% ( const integer & n ) const

inline

Definition at line 264 of file integer.h.

{
        integer result;
        if (p)
                result. num = 0;
        else
                result = num % n. num;
        return result;
} /* operator % */

References num, and p.

◆ operator*()

integer chomp::homology::integer::operator* ( const integer & n ) const

inline

Definition at line 337 of file integer.h.

{
        integer m (n);
        m *= *this;
        return m;
} /* operator * */

◆ operator*=()

integer & chomp::homology::integer::operator*= ( const integer & n )

inline

Definition at line 306 of file integer.h.

{
        if (p)
        {
                long result = (long) num * (long) n. num;
                if (result >= 0)
                        num = (numbertype) (result % p);
                else
                {
                        num = (numbertype) (p - ((-result) % p));
                        if (num == p)
                                num = 0;
                }
        }
        else
        {
                long result = (long) num * (long) (n. num);
                num = (numbertype) result;
                if ((long) num != result)
                        throw "Number out of range (*).";
        }
        return *this;
} /* integer::operator *= */

References num, and p.

◆ operator+()

integer chomp::homology::integer::operator+ ( const integer & n ) const

inline

Definition at line 330 of file integer.h.

{
        integer m (n);
        m += *this;
        return m;
} /* operator + */

◆ operator+=()

integer & chomp::homology::integer::operator+= ( const integer & n )

inline

Definition at line 293 of file integer.h.

{
        if (!p)
                if (((n. num >= 0) && (num + n. num < num)) ||
                        ((n. num < 0) && (num + n. num > num)))
                        throw "Number out of range (+).";
        num += n. num;
        if (p)
                if (num >= p)
                        num -= (numbertype) p;
        return *this;
} /* integer::operator += */

References num, and p.

◆ operator-()

integer chomp::homology::integer::operator- ( ) const

inline

Definition at line 274 of file integer.h.

{
        if (p)
        {
                integer negative;
                negative. num = (numbertype) (p - num);
                return negative;
        }
        else
        {
                numbertype result = (numbertype) -num;
                if ((long) result + (long) num != 0)
                        throw "Number out of range (unary -).";
                integer intresult;
                intresult = result;
                return intresult;
        }
} /* integer::operator - (unary) */

References num, and p.

◆ operator/()

integer chomp::homology::integer::operator/ ( const integer & n ) const

inline

Definition at line 254 of file integer.h.

{
        integer result;
        if (p)
                result = num * (int) invert (n. num, p);
        else
                result. num = (numbertype) (num / n. num);
        return result;
} /* integer::operator / */

References invert(), num, and p.

◆ operator=()

integer & chomp::homology::integer::operator= ( int n )

inline

Definition at line 241 of file integer.h.

{
        if (p)
                num = (numbertype) cut_down (n);
        else
        {
                num = (numbertype) n;
                if ((long) num != (long) n)
                        throw "Number out of range at assignment.";
        }
        return *this;
} /* integer::operator = */

References cut_down(), num, and p.

◆ operator==()

int chomp::homology::integer::operator== ( const integer & n ) const

inline

Definition at line 344 of file integer.h.

{
        return (n. num == num);
} /* operator == */

References num.

◆ prime_number()

static int chomp::homology::integer::prime_number ( int n )

staticprotected

Referenced by initialize().

◆ ringname()

static const char * chomp::homology::integer::ringname ( )

static

◆ ringsymbol()

static const char * chomp::homology::integer::ringsymbol ( )

static

Friends And Related Function Documentation

◆ operator<

bool operator<	(	const integer &	x,
		const integer &	y
	)

friend

Definition at line 411 of file integer.h.

{
        return (x. num < y. num);
} /* operator < */

◆ operator<<

std::ostream & operator<<	(	std::ostream &	out,
		const integer &	n
	)

friend

Definition at line 349 of file integer.h.

{
        out << (long) n. num;
        return out;
} /* operator << */

◆ operator>

bool operator>	(	const integer &	x,
		const integer &	y
	)

friend

Definition at line 416 of file integer.h.

{
        return (x. num > y. num);
} /* operator > */

Member Data Documentation

◆ num

numbertype chomp::homology::integer::num

protected

Definition at line 182 of file integer.h.

Referenced by cut_down(), delta(), normalized(), operator%(), operator*=(), operator+=(), operator-(), operator/(), operator=(), and operator==().

◆ p

int chomp::homology::integer::p

staticprotected

Definition at line 179 of file integer.h.

Referenced by cut_down(), delta(), initialize(), operator%(), operator*=(), operator+=(), operator-(), operator/(), and operator=().

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

chomp/struct/integer.h

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Function Documentation

◆ cut_down()

◆ delta()

◆ initialize()

◆ invert()

◆ is_prime()

◆ normalized()

◆ operator%()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator/()

◆ operator=()

◆ operator==()

◆ prime_number()

◆ ringname()

◆ ringsymbol()

Friends And Related Function Documentation

◆ operator<

◆ operator<<

◆ operator>

Member Data Documentation

◆ num

◆ p